test_shared_random.c 48 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412
  1. #define SHARED_RANDOM_PRIVATE
  2. #define SHARED_RANDOM_STATE_PRIVATE
  3. #define CONFIG_PRIVATE
  4. #define DIRVOTE_PRIVATE
  5. #include "or.h"
  6. #include "test.h"
  7. #include "config.h"
  8. #include "dirvote.h"
  9. #include "shared_random.h"
  10. #include "shared_random_state.h"
  11. #include "routerkeys.h"
  12. #include "routerlist.h"
  13. #include "router.h"
  14. #include "routerparse.h"
  15. #include "networkstatus.h"
  16. #include "log_test_helpers.h"
  17. static authority_cert_t *mock_cert;
  18. static authority_cert_t *
  19. get_my_v3_authority_cert_m(void)
  20. {
  21. tor_assert(mock_cert);
  22. return mock_cert;
  23. }
  24. static dir_server_t ds;
  25. static dir_server_t *
  26. trusteddirserver_get_by_v3_auth_digest_m(const char *digest)
  27. {
  28. (void) digest;
  29. /* The shared random code only need to know if a valid pointer to a dir
  30. * server object has been found so this is safe because it won't use the
  31. * pointer at all never. */
  32. return &ds;
  33. }
  34. /* Setup a minimal dirauth environment by initializing the SR state and
  35. * making sure the options are set to be an authority directory. */
  36. static void
  37. init_authority_state(void)
  38. {
  39. MOCK(get_my_v3_authority_cert, get_my_v3_authority_cert_m);
  40. or_options_t *options = get_options_mutable();
  41. mock_cert = authority_cert_parse_from_string(AUTHORITY_CERT_1, NULL);
  42. tt_assert(mock_cert);
  43. options->AuthoritativeDir = 1;
  44. tt_int_op(load_ed_keys(options, time(NULL)), OP_GE, 0);
  45. sr_state_init(0, 0);
  46. /* It's possible a commit has been generated in our state depending on
  47. * the phase we are currently in which uses "now" as the starting
  48. * timestamp. Delete it before we do any testing below. */
  49. sr_state_delete_commits();
  50. done:
  51. UNMOCK(get_my_v3_authority_cert);
  52. }
  53. static void
  54. test_get_sr_protocol_phase(void *arg)
  55. {
  56. time_t the_time;
  57. sr_phase_t phase;
  58. int retval;
  59. (void) arg;
  60. /* Initialize SR state */
  61. init_authority_state();
  62. {
  63. retval = parse_rfc1123_time("Wed, 20 Apr 2015 23:59:00 UTC", &the_time);
  64. tt_int_op(retval, OP_EQ, 0);
  65. phase = get_sr_protocol_phase(the_time);
  66. tt_int_op(phase, OP_EQ, SR_PHASE_REVEAL);
  67. }
  68. {
  69. retval = parse_rfc1123_time("Wed, 20 Apr 2015 00:00:00 UTC", &the_time);
  70. tt_int_op(retval, OP_EQ, 0);
  71. phase = get_sr_protocol_phase(the_time);
  72. tt_int_op(phase, OP_EQ, SR_PHASE_COMMIT);
  73. }
  74. {
  75. retval = parse_rfc1123_time("Wed, 20 Apr 2015 00:00:01 UTC", &the_time);
  76. tt_int_op(retval, OP_EQ, 0);
  77. phase = get_sr_protocol_phase(the_time);
  78. tt_int_op(phase, OP_EQ, SR_PHASE_COMMIT);
  79. }
  80. {
  81. retval = parse_rfc1123_time("Wed, 20 Apr 2015 11:59:00 UTC", &the_time);
  82. tt_int_op(retval, OP_EQ, 0);
  83. phase = get_sr_protocol_phase(the_time);
  84. tt_int_op(phase, OP_EQ, SR_PHASE_COMMIT);
  85. }
  86. {
  87. retval = parse_rfc1123_time("Wed, 20 Apr 2015 12:00:00 UTC", &the_time);
  88. tt_int_op(retval, OP_EQ, 0);
  89. phase = get_sr_protocol_phase(the_time);
  90. tt_int_op(phase, OP_EQ, SR_PHASE_REVEAL);
  91. }
  92. {
  93. retval = parse_rfc1123_time("Wed, 20 Apr 2015 12:00:01 UTC", &the_time);
  94. tt_int_op(retval, OP_EQ, 0);
  95. phase = get_sr_protocol_phase(the_time);
  96. tt_int_op(phase, OP_EQ, SR_PHASE_REVEAL);
  97. }
  98. {
  99. retval = parse_rfc1123_time("Wed, 20 Apr 2015 13:00:00 UTC", &the_time);
  100. tt_int_op(retval, OP_EQ, 0);
  101. phase = get_sr_protocol_phase(the_time);
  102. tt_int_op(phase, OP_EQ, SR_PHASE_REVEAL);
  103. }
  104. done:
  105. ;
  106. }
  107. static networkstatus_t *mock_consensus = NULL;
  108. static void
  109. test_get_state_valid_until_time(void *arg)
  110. {
  111. time_t current_time;
  112. time_t valid_until_time;
  113. char tbuf[ISO_TIME_LEN + 1];
  114. int retval;
  115. (void) arg;
  116. {
  117. /* Get the valid until time if called at 00:00:01 */
  118. retval = parse_rfc1123_time("Mon, 20 Apr 2015 00:00:01 UTC",
  119. &current_time);
  120. tt_int_op(retval, OP_EQ, 0);
  121. valid_until_time = get_state_valid_until_time(current_time);
  122. /* Compare it with the correct result */
  123. format_iso_time(tbuf, valid_until_time);
  124. tt_str_op("2015-04-21 00:00:00", OP_EQ, tbuf);
  125. }
  126. {
  127. retval = parse_rfc1123_time("Mon, 20 Apr 2015 19:22:00 UTC",
  128. &current_time);
  129. tt_int_op(retval, OP_EQ, 0);
  130. valid_until_time = get_state_valid_until_time(current_time);
  131. format_iso_time(tbuf, valid_until_time);
  132. tt_str_op("2015-04-21 00:00:00", OP_EQ, tbuf);
  133. }
  134. {
  135. retval = parse_rfc1123_time("Mon, 20 Apr 2015 23:59:00 UTC",
  136. &current_time);
  137. tt_int_op(retval, OP_EQ, 0);
  138. valid_until_time = get_state_valid_until_time(current_time);
  139. format_iso_time(tbuf, valid_until_time);
  140. tt_str_op("2015-04-21 00:00:00", OP_EQ, tbuf);
  141. }
  142. {
  143. retval = parse_rfc1123_time("Mon, 20 Apr 2015 00:00:00 UTC",
  144. &current_time);
  145. tt_int_op(retval, OP_EQ, 0);
  146. valid_until_time = get_state_valid_until_time(current_time);
  147. format_iso_time(tbuf, valid_until_time);
  148. tt_str_op("2015-04-21 00:00:00", OP_EQ, tbuf);
  149. }
  150. done:
  151. ;
  152. }
  153. /** Test the function that calculates the start time of the current SRV
  154. * protocol run. */
  155. static void
  156. test_get_start_time_of_current_run(void *arg)
  157. {
  158. int retval;
  159. char tbuf[ISO_TIME_LEN + 1];
  160. time_t current_time, run_start_time;
  161. (void) arg;
  162. {
  163. /* Get start time if called at 00:00:01 */
  164. retval = parse_rfc1123_time("Mon, 20 Apr 2015 00:00:01 UTC",
  165. &current_time);
  166. tt_int_op(retval, OP_EQ, 0);
  167. run_start_time =
  168. sr_state_get_start_time_of_current_protocol_run(current_time);
  169. /* Compare it with the correct result */
  170. format_iso_time(tbuf, run_start_time);
  171. tt_str_op("2015-04-20 00:00:00", OP_EQ, tbuf);
  172. }
  173. {
  174. retval = parse_rfc1123_time("Mon, 20 Apr 2015 23:59:59 UTC",
  175. &current_time);
  176. tt_int_op(retval, OP_EQ, 0);
  177. run_start_time =
  178. sr_state_get_start_time_of_current_protocol_run(current_time);
  179. /* Compare it with the correct result */
  180. format_iso_time(tbuf, run_start_time);
  181. tt_str_op("2015-04-20 00:00:00", OP_EQ, tbuf);
  182. }
  183. {
  184. retval = parse_rfc1123_time("Mon, 20 Apr 2015 00:00:00 UTC",
  185. &current_time);
  186. tt_int_op(retval, OP_EQ, 0);
  187. run_start_time =
  188. sr_state_get_start_time_of_current_protocol_run(current_time);
  189. /* Compare it with the correct result */
  190. format_iso_time(tbuf, run_start_time);
  191. tt_str_op("2015-04-20 00:00:00", OP_EQ, tbuf);
  192. }
  193. /* Now let's alter the voting schedule and check the correctness of the
  194. * function. Voting interval of 10 seconds, means that an SRV protocol run
  195. * takes 10 seconds * 24 rounds = 4 mins */
  196. {
  197. or_options_t *options = get_options_mutable();
  198. options->V3AuthVotingInterval = 10;
  199. options->TestingV3AuthInitialVotingInterval = 10;
  200. retval = parse_rfc1123_time("Mon, 20 Apr 2015 00:15:32 UTC",
  201. &current_time);
  202. tt_int_op(retval, OP_EQ, 0);
  203. run_start_time =
  204. sr_state_get_start_time_of_current_protocol_run(current_time);
  205. /* Compare it with the correct result */
  206. format_iso_time(tbuf, run_start_time);
  207. tt_str_op("2015-04-20 00:12:00", OP_EQ, tbuf);
  208. }
  209. done:
  210. ;
  211. }
  212. /** Do some rudimentary consistency checks between the functions that
  213. * understand the shared random protocol schedule */
  214. static void
  215. test_get_start_time_functions(void *arg)
  216. {
  217. (void) arg;
  218. time_t now = approx_time();
  219. time_t start_time_of_protocol_run =
  220. sr_state_get_start_time_of_current_protocol_run(now);
  221. tt_assert(start_time_of_protocol_run);
  222. /* Check that the round start time of the beginning of the run, is itself */
  223. tt_int_op(get_start_time_of_current_round(start_time_of_protocol_run), OP_EQ,
  224. start_time_of_protocol_run);
  225. /* Check that even if we increment the start time, we still get the start
  226. time of the run as the beginning of the round. */
  227. tt_int_op(get_start_time_of_current_round(start_time_of_protocol_run+1),
  228. OP_EQ, start_time_of_protocol_run);
  229. done: ;
  230. }
  231. static void
  232. test_get_sr_protocol_duration(void *arg)
  233. {
  234. (void) arg;
  235. /* Check that by default an SR phase is 12 hours */
  236. tt_int_op(sr_state_get_phase_duration(), OP_EQ, 12*60*60);
  237. tt_int_op(sr_state_get_protocol_run_duration(), OP_EQ, 24*60*60);
  238. /* Now alter the voting interval and check that the SR phase is 2 mins long
  239. * if voting happens every 10 seconds (10*12 seconds = 2 mins) */
  240. or_options_t *options = get_options_mutable();
  241. options->V3AuthVotingInterval = 10;
  242. tt_int_op(sr_state_get_phase_duration(), OP_EQ, 2*60);
  243. tt_int_op(sr_state_get_protocol_run_duration(), OP_EQ, 4*60);
  244. done: ;
  245. }
  246. /* Mock function to immediately return our local 'mock_consensus'. */
  247. static networkstatus_t *
  248. mock_networkstatus_get_live_consensus(time_t now)
  249. {
  250. (void) now;
  251. return mock_consensus;
  252. }
  253. /** Test the get_next_valid_after_time() function. */
  254. static void
  255. test_get_next_valid_after_time(void *arg)
  256. {
  257. time_t current_time;
  258. time_t valid_after_time;
  259. char tbuf[ISO_TIME_LEN + 1];
  260. int retval;
  261. (void) arg;
  262. {
  263. /* Setup a fake consensus just to get the times out of it, since
  264. get_next_valid_after_time() needs them. */
  265. mock_consensus = tor_malloc_zero(sizeof(networkstatus_t));
  266. retval = parse_rfc1123_time("Mon, 13 Jan 2016 16:00:00 UTC",
  267. &mock_consensus->fresh_until);
  268. tt_int_op(retval, OP_EQ, 0);
  269. retval = parse_rfc1123_time("Mon, 13 Jan 2016 15:00:00 UTC",
  270. &mock_consensus->valid_after);
  271. tt_int_op(retval, OP_EQ, 0);
  272. MOCK(networkstatus_get_live_consensus,
  273. mock_networkstatus_get_live_consensus);
  274. }
  275. {
  276. /* Get the valid after time if called at 00:00:00 */
  277. retval = parse_rfc1123_time("Mon, 20 Apr 2015 00:00:00 UTC",
  278. &current_time);
  279. tt_int_op(retval, OP_EQ, 0);
  280. valid_after_time = get_next_valid_after_time(current_time);
  281. /* Compare it with the correct result */
  282. format_iso_time(tbuf, valid_after_time);
  283. tt_str_op("2015-04-20 01:00:00", OP_EQ, tbuf);
  284. }
  285. {
  286. /* Get the valid until time if called at 00:00:01 */
  287. retval = parse_rfc1123_time("Mon, 20 Apr 2015 00:00:01 UTC",
  288. &current_time);
  289. tt_int_op(retval, OP_EQ, 0);
  290. valid_after_time = get_next_valid_after_time(current_time);
  291. /* Compare it with the correct result */
  292. format_iso_time(tbuf, valid_after_time);
  293. tt_str_op("2015-04-20 01:00:00", OP_EQ, tbuf);
  294. }
  295. {
  296. retval = parse_rfc1123_time("Mon, 20 Apr 2015 23:30:01 UTC",
  297. &current_time);
  298. tt_int_op(retval, OP_EQ, 0);
  299. valid_after_time = get_next_valid_after_time(current_time);
  300. /* Compare it with the correct result */
  301. format_iso_time(tbuf, valid_after_time);
  302. tt_str_op("2015-04-21 00:00:00", OP_EQ, tbuf);
  303. }
  304. done:
  305. networkstatus_vote_free(mock_consensus);
  306. }
  307. /* In this test we are going to generate a sr_commit_t object and validate
  308. * it. We first generate our values, and then we parse them as if they were
  309. * received from the network. After we parse both the commit and the reveal,
  310. * we verify that they indeed match. */
  311. static void
  312. test_sr_commit(void *arg)
  313. {
  314. authority_cert_t *auth_cert = NULL;
  315. time_t now = time(NULL);
  316. sr_commit_t *our_commit = NULL;
  317. smartlist_t *args = smartlist_new();
  318. sr_commit_t *parsed_commit = NULL;
  319. (void) arg;
  320. { /* Setup a minimal dirauth environment for this test */
  321. or_options_t *options = get_options_mutable();
  322. auth_cert = authority_cert_parse_from_string(AUTHORITY_CERT_1, NULL);
  323. tt_assert(auth_cert);
  324. options->AuthoritativeDir = 1;
  325. tt_int_op(load_ed_keys(options, time(NULL)), OP_GE, 0);
  326. }
  327. /* Generate our commit object and validate it has the appropriate field
  328. * that we can then use to build a representation that we'll find in a
  329. * vote coming from the network. */
  330. {
  331. sr_commit_t test_commit;
  332. our_commit = sr_generate_our_commit(now, auth_cert);
  333. tt_assert(our_commit);
  334. /* Default and only supported algorithm for now. */
  335. tt_assert(our_commit->alg == DIGEST_SHA3_256);
  336. /* We should have a reveal value. */
  337. tt_assert(commit_has_reveal_value(our_commit));
  338. /* We should have a random value. */
  339. tt_assert(!tor_mem_is_zero((char *) our_commit->random_number,
  340. sizeof(our_commit->random_number)));
  341. /* Commit and reveal timestamp should be the same. */
  342. tt_u64_op(our_commit->commit_ts, OP_EQ, our_commit->reveal_ts);
  343. /* We should have a hashed reveal. */
  344. tt_assert(!tor_mem_is_zero(our_commit->hashed_reveal,
  345. sizeof(our_commit->hashed_reveal)));
  346. /* Do we have a valid encoded commit and reveal. Note the following only
  347. * tests if the generated values are correct. Their could be a bug in
  348. * the decode function but we test them seperately. */
  349. tt_int_op(0, OP_EQ, reveal_decode(our_commit->encoded_reveal,
  350. &test_commit));
  351. tt_int_op(0, OP_EQ, commit_decode(our_commit->encoded_commit,
  352. &test_commit));
  353. tt_int_op(0, OP_EQ, verify_commit_and_reveal(our_commit));
  354. }
  355. /* Let's make sure our verify commit and reveal function works. We'll
  356. * make it fail a bit with known failure case. */
  357. {
  358. /* Copy our commit so we don't alter it for the rest of testing. */
  359. sr_commit_t test_commit;
  360. memcpy(&test_commit, our_commit, sizeof(test_commit));
  361. /* Timestamp MUST match. */
  362. test_commit.commit_ts = test_commit.reveal_ts - 42;
  363. setup_full_capture_of_logs(LOG_WARN);
  364. tt_int_op(-1, OP_EQ, verify_commit_and_reveal(&test_commit));
  365. expect_log_msg_containing("doesn't match reveal timestamp");
  366. teardown_capture_of_logs();
  367. memcpy(&test_commit, our_commit, sizeof(test_commit));
  368. tt_int_op(0, OP_EQ, verify_commit_and_reveal(&test_commit));
  369. /* Hashed reveal must match the H(encoded_reveal). */
  370. memset(test_commit.hashed_reveal, 'X',
  371. sizeof(test_commit.hashed_reveal));
  372. setup_full_capture_of_logs(LOG_WARN);
  373. tt_int_op(-1, OP_EQ, verify_commit_and_reveal(&test_commit));
  374. expect_single_log_msg_containing("doesn't match the commit value");
  375. teardown_capture_of_logs();
  376. memcpy(&test_commit, our_commit, sizeof(test_commit));
  377. tt_int_op(0, OP_EQ, verify_commit_and_reveal(&test_commit));
  378. }
  379. /* We'll build a list of values from our commit that our parsing function
  380. * takes from a vote line and see if we can parse it correctly. */
  381. {
  382. smartlist_add_strdup(args, "1");
  383. smartlist_add_strdup(args,
  384. crypto_digest_algorithm_get_name(our_commit->alg));
  385. smartlist_add_strdup(args, sr_commit_get_rsa_fpr(our_commit));
  386. smartlist_add_strdup(args, our_commit->encoded_commit);
  387. smartlist_add_strdup(args, our_commit->encoded_reveal);
  388. parsed_commit = sr_parse_commit(args);
  389. tt_assert(parsed_commit);
  390. /* That parsed commit should be _EXACTLY_ like our original commit (we
  391. * have to explicitly set the valid flag though). */
  392. parsed_commit->valid = 1;
  393. tt_mem_op(parsed_commit, OP_EQ, our_commit, sizeof(*parsed_commit));
  394. /* Cleanup */
  395. }
  396. done:
  397. teardown_capture_of_logs();
  398. SMARTLIST_FOREACH(args, char *, cp, tor_free(cp));
  399. smartlist_free(args);
  400. sr_commit_free(our_commit);
  401. sr_commit_free(parsed_commit);
  402. authority_cert_free(auth_cert);
  403. }
  404. /* Test the encoding and decoding function for commit and reveal values. */
  405. static void
  406. test_encoding(void *arg)
  407. {
  408. (void) arg;
  409. int ret;
  410. /* Random number is 32 bytes. */
  411. char raw_rand[32];
  412. time_t ts = 1454333590;
  413. char hashed_rand[DIGEST256_LEN], hashed_reveal[DIGEST256_LEN];
  414. sr_commit_t parsed_commit;
  415. /* Those values were generated by sr_commit_calc_ref.py where the random
  416. * value is 32 'A' and timestamp is the one in ts. */
  417. static const char *encoded_reveal =
  418. "AAAAAFavXpZJxbwTupvaJCTeIUCQmOPxAMblc7ChL5H2nZKuGchdaA==";
  419. static const char *encoded_commit =
  420. "AAAAAFavXpbkBMzMQG7aNoaGLFNpm2Wkk1ozXhuWWqL//GynltxVAg==";
  421. /* Set up our raw random bytes array. */
  422. memset(raw_rand, 'A', sizeof(raw_rand));
  423. /* Hash random number because we don't expose bytes of the RNG. */
  424. ret = crypto_digest256(hashed_rand, raw_rand,
  425. sizeof(raw_rand), SR_DIGEST_ALG);
  426. tt_int_op(0, OP_EQ, ret);
  427. /* Hash reveal value. */
  428. tt_int_op(SR_REVEAL_BASE64_LEN, OP_EQ, strlen(encoded_reveal));
  429. ret = crypto_digest256(hashed_reveal, encoded_reveal,
  430. strlen(encoded_reveal), SR_DIGEST_ALG);
  431. tt_int_op(0, OP_EQ, ret);
  432. tt_int_op(SR_COMMIT_BASE64_LEN, OP_EQ, strlen(encoded_commit));
  433. /* Test our commit/reveal decode functions. */
  434. {
  435. /* Test the reveal encoded value. */
  436. tt_int_op(0, OP_EQ, reveal_decode(encoded_reveal, &parsed_commit));
  437. tt_u64_op(ts, OP_EQ, parsed_commit.reveal_ts);
  438. tt_mem_op(hashed_rand, OP_EQ, parsed_commit.random_number,
  439. sizeof(hashed_rand));
  440. /* Test the commit encoded value. */
  441. memset(&parsed_commit, 0, sizeof(parsed_commit));
  442. tt_int_op(0, OP_EQ, commit_decode(encoded_commit, &parsed_commit));
  443. tt_u64_op(ts, OP_EQ, parsed_commit.commit_ts);
  444. tt_mem_op(encoded_commit, OP_EQ, parsed_commit.encoded_commit,
  445. sizeof(parsed_commit.encoded_commit));
  446. tt_mem_op(hashed_reveal, OP_EQ, parsed_commit.hashed_reveal,
  447. sizeof(hashed_reveal));
  448. }
  449. /* Test our commit/reveal encode functions. */
  450. {
  451. /* Test the reveal encode. */
  452. char encoded[SR_REVEAL_BASE64_LEN + 1];
  453. parsed_commit.reveal_ts = ts;
  454. memcpy(parsed_commit.random_number, hashed_rand,
  455. sizeof(parsed_commit.random_number));
  456. ret = reveal_encode(&parsed_commit, encoded, sizeof(encoded));
  457. tt_int_op(SR_REVEAL_BASE64_LEN, OP_EQ, ret);
  458. tt_mem_op(encoded_reveal, OP_EQ, encoded, strlen(encoded_reveal));
  459. }
  460. {
  461. /* Test the commit encode. */
  462. char encoded[SR_COMMIT_BASE64_LEN + 1];
  463. parsed_commit.commit_ts = ts;
  464. memcpy(parsed_commit.hashed_reveal, hashed_reveal,
  465. sizeof(parsed_commit.hashed_reveal));
  466. ret = commit_encode(&parsed_commit, encoded, sizeof(encoded));
  467. tt_int_op(SR_COMMIT_BASE64_LEN, OP_EQ, ret);
  468. tt_mem_op(encoded_commit, OP_EQ, encoded, strlen(encoded_commit));
  469. }
  470. done:
  471. ;
  472. }
  473. /** Setup some SRVs in our SR state. If <b>also_current</b> is set, then set
  474. * both current and previous SRVs.
  475. * Helper of test_vote() and test_sr_compute_srv(). */
  476. static void
  477. test_sr_setup_srv(int also_current)
  478. {
  479. sr_srv_t *srv = tor_malloc_zero(sizeof(sr_srv_t));
  480. srv->num_reveals = 42;
  481. memcpy(srv->value,
  482. "ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ",
  483. sizeof(srv->value));
  484. sr_state_set_previous_srv(srv);
  485. if (also_current) {
  486. srv = tor_malloc_zero(sizeof(sr_srv_t));
  487. srv->num_reveals = 128;
  488. memcpy(srv->value,
  489. "NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN",
  490. sizeof(srv->value));
  491. sr_state_set_current_srv(srv);
  492. }
  493. }
  494. /* Test anything that has to do with SR protocol and vote. */
  495. static void
  496. test_vote(void *arg)
  497. {
  498. int ret;
  499. time_t now = time(NULL);
  500. sr_commit_t *our_commit = NULL;
  501. (void) arg;
  502. MOCK(trusteddirserver_get_by_v3_auth_digest,
  503. trusteddirserver_get_by_v3_auth_digest_m);
  504. { /* Setup a minimal dirauth environment for this test */
  505. init_authority_state();
  506. /* Set ourself in reveal phase so we can parse the reveal value in the
  507. * vote as well. */
  508. set_sr_phase(SR_PHASE_REVEAL);
  509. }
  510. /* Generate our commit object and validate it has the appropriate field
  511. * that we can then use to build a representation that we'll find in a
  512. * vote coming from the network. */
  513. {
  514. sr_commit_t *saved_commit;
  515. our_commit = sr_generate_our_commit(now, mock_cert);
  516. tt_assert(our_commit);
  517. sr_state_add_commit(our_commit);
  518. /* Make sure it's there. */
  519. saved_commit = sr_state_get_commit(our_commit->rsa_identity);
  520. tt_assert(saved_commit);
  521. }
  522. /* Also setup the SRVs */
  523. test_sr_setup_srv(1);
  524. { /* Now test the vote generation */
  525. smartlist_t *chunks = smartlist_new();
  526. smartlist_t *tokens = smartlist_new();
  527. /* Get our vote line and validate it. */
  528. char *lines = sr_get_string_for_vote();
  529. tt_assert(lines);
  530. /* Split the lines. We expect 2 here. */
  531. ret = smartlist_split_string(chunks, lines, "\n", SPLIT_IGNORE_BLANK, 0);
  532. tt_int_op(ret, OP_EQ, 4);
  533. tt_str_op(smartlist_get(chunks, 0), OP_EQ, "shared-rand-participate");
  534. /* Get our commitment line and will validate it agains our commit. The
  535. * format is as follow:
  536. * "shared-rand-commitment" SP version SP algname SP identity
  537. * SP COMMIT [SP REVEAL] NL
  538. */
  539. char *commit_line = smartlist_get(chunks, 1);
  540. tt_assert(commit_line);
  541. ret = smartlist_split_string(tokens, commit_line, " ", 0, 0);
  542. tt_int_op(ret, OP_EQ, 6);
  543. tt_str_op(smartlist_get(tokens, 0), OP_EQ, "shared-rand-commit");
  544. tt_str_op(smartlist_get(tokens, 1), OP_EQ, "1");
  545. tt_str_op(smartlist_get(tokens, 2), OP_EQ,
  546. crypto_digest_algorithm_get_name(DIGEST_SHA3_256));
  547. char digest[DIGEST_LEN];
  548. base16_decode(digest, sizeof(digest), smartlist_get(tokens, 3),
  549. HEX_DIGEST_LEN);
  550. tt_mem_op(digest, OP_EQ, our_commit->rsa_identity, sizeof(digest));
  551. tt_str_op(smartlist_get(tokens, 4), OP_EQ, our_commit->encoded_commit);
  552. tt_str_op(smartlist_get(tokens, 5), OP_EQ, our_commit->encoded_reveal)
  553. ;
  554. /* Finally, does this vote line creates a valid commit object? */
  555. smartlist_t *args = smartlist_new();
  556. smartlist_add(args, smartlist_get(tokens, 1));
  557. smartlist_add(args, smartlist_get(tokens, 2));
  558. smartlist_add(args, smartlist_get(tokens, 3));
  559. smartlist_add(args, smartlist_get(tokens, 4));
  560. smartlist_add(args, smartlist_get(tokens, 5));
  561. sr_commit_t *parsed_commit = sr_parse_commit(args);
  562. tt_assert(parsed_commit);
  563. /* Set valid flag explicitly here to compare since it's not set by
  564. * simply parsing the commit. */
  565. parsed_commit->valid = 1;
  566. tt_mem_op(parsed_commit, OP_EQ, our_commit, sizeof(*our_commit));
  567. /* minor cleanup */
  568. SMARTLIST_FOREACH(tokens, char *, s, tor_free(s));
  569. smartlist_clear(tokens);
  570. /* Now test the previous SRV */
  571. char *prev_srv_line = smartlist_get(chunks, 2);
  572. tt_assert(prev_srv_line);
  573. ret = smartlist_split_string(tokens, prev_srv_line, " ", 0, 0);
  574. tt_int_op(ret, OP_EQ, 3);
  575. tt_str_op(smartlist_get(tokens, 0), OP_EQ, "shared-rand-previous-value");
  576. tt_str_op(smartlist_get(tokens, 1), OP_EQ, "42");
  577. tt_str_op(smartlist_get(tokens, 2), OP_EQ,
  578. "WlpaWlpaWlpaWlpaWlpaWlpaWlpaWlpaWlpaWlpaWlo=");
  579. /* minor cleanup */
  580. SMARTLIST_FOREACH(tokens, char *, s, tor_free(s));
  581. smartlist_clear(tokens);
  582. /* Now test the current SRV */
  583. char *current_srv_line = smartlist_get(chunks, 3);
  584. tt_assert(current_srv_line);
  585. ret = smartlist_split_string(tokens, current_srv_line, " ", 0, 0);
  586. tt_int_op(ret, OP_EQ, 3);
  587. tt_str_op(smartlist_get(tokens, 0), OP_EQ, "shared-rand-current-value");
  588. tt_str_op(smartlist_get(tokens, 1), OP_EQ, "128");
  589. tt_str_op(smartlist_get(tokens, 2), OP_EQ,
  590. "Tk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk4=");
  591. /* Clean up */
  592. sr_commit_free(parsed_commit);
  593. SMARTLIST_FOREACH(chunks, char *, s, tor_free(s));
  594. smartlist_free(chunks);
  595. SMARTLIST_FOREACH(tokens, char *, s, tor_free(s));
  596. smartlist_free(tokens);
  597. smartlist_clear(args);
  598. smartlist_free(args);
  599. tor_free(lines);
  600. }
  601. done:
  602. sr_commit_free(our_commit);
  603. UNMOCK(trusteddirserver_get_by_v3_auth_digest);
  604. }
  605. static const char *sr_state_str = "Version 1\n"
  606. "TorVersion 0.2.9.0-alpha-dev\n"
  607. "ValidAfter 2037-04-19 07:16:00\n"
  608. "ValidUntil 2037-04-20 07:16:00\n"
  609. "Commit 1 sha3-256 FA3CEC2C99DC68D3166B9B6E4FA21A4026C2AB1C "
  610. "7M8GdubCAAdh7WUG0DiwRyxTYRKji7HATa7LLJEZ/UAAAAAAVmfUSg== "
  611. "AAAAAFZn1EojfIheIw42bjK3VqkpYyjsQFSbv/dxNna3Q8hUEPKpOw==\n"
  612. "Commit 1 sha3-256 41E89EDFBFBA44983E21F18F2230A4ECB5BFB543 "
  613. "17aUsYuMeRjd2N1r8yNyg7aHqRa6gf4z7QPoxxAZbp0AAAAAVmfUSg==\n"
  614. "Commit 1 sha3-256 36637026573A04110CF3E6B1D201FB9A98B88734 "
  615. "DDDYtripvdOU+XPEUm5xpU64d9IURSds1xSwQsgeB8oAAAAAVmfUSg==\n"
  616. "SharedRandPreviousValue 4 qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqo=\n"
  617. "SharedRandCurrentValue 3 8dWeW12KEzTGEiLGgO1UVJ7Z91CekoRcxt6Q9KhnOFI=\n";
  618. /** Create an SR disk state, parse it and validate that the parsing went
  619. * well. Yes! */
  620. static void
  621. test_state_load_from_disk(void *arg)
  622. {
  623. int ret;
  624. char *dir = tor_strdup(get_fname("test_sr_state"));
  625. char *sr_state_path = tor_strdup(get_fname("test_sr_state/sr_state"));
  626. sr_state_t *the_sr_state = NULL;
  627. (void) arg;
  628. MOCK(trusteddirserver_get_by_v3_auth_digest,
  629. trusteddirserver_get_by_v3_auth_digest_m);
  630. /* First try with a nonexistent path. */
  631. ret = disk_state_load_from_disk_impl("NONEXISTENTNONEXISTENT");
  632. tt_int_op(ret, OP_EQ, -ENOENT);
  633. /* Now create a mock state directory and state file */
  634. #ifdef _WIN32
  635. ret = mkdir(dir);
  636. #else
  637. ret = mkdir(dir, 0700);
  638. #endif
  639. tt_int_op(ret, OP_EQ, 0);
  640. ret = write_str_to_file(sr_state_path, sr_state_str, 0);
  641. tt_int_op(ret, OP_EQ, 0);
  642. /* Try to load the directory itself. Should fail. */
  643. ret = disk_state_load_from_disk_impl(dir);
  644. tt_int_op(ret, OP_LT, 0);
  645. /* State should be non-existent at this point. */
  646. the_sr_state = get_sr_state();
  647. tt_ptr_op(the_sr_state, OP_EQ, NULL);
  648. /* Now try to load the correct file! */
  649. ret = disk_state_load_from_disk_impl(sr_state_path);
  650. tt_int_op(ret, OP_EQ, 0);
  651. /* Check the content of the state */
  652. /* XXX check more deeply!!! */
  653. the_sr_state = get_sr_state();
  654. tt_assert(the_sr_state);
  655. tt_assert(the_sr_state->version == 1);
  656. tt_assert(digestmap_size(the_sr_state->commits) == 3);
  657. tt_assert(the_sr_state->current_srv);
  658. tt_assert(the_sr_state->current_srv->num_reveals == 3);
  659. tt_assert(the_sr_state->previous_srv);
  660. /* XXX Now also try loading corrupted state files and make sure parsing
  661. fails */
  662. done:
  663. tor_free(dir);
  664. tor_free(sr_state_path);
  665. UNMOCK(trusteddirserver_get_by_v3_auth_digest);
  666. }
  667. /** Generate three specially crafted commits (based on the test
  668. * vector at sr_srv_calc_ref.py). Helper of test_sr_compute_srv(). */
  669. static void
  670. test_sr_setup_commits(void)
  671. {
  672. time_t now = time(NULL);
  673. sr_commit_t *commit_a, *commit_b, *commit_c, *commit_d;
  674. sr_commit_t *place_holder = tor_malloc_zero(sizeof(*place_holder));
  675. authority_cert_t *auth_cert = NULL;
  676. { /* Setup a minimal dirauth environment for this test */
  677. or_options_t *options = get_options_mutable();
  678. auth_cert = authority_cert_parse_from_string(AUTHORITY_CERT_1, NULL);
  679. tt_assert(auth_cert);
  680. options->AuthoritativeDir = 1;
  681. tt_int_op(0, OP_EQ, load_ed_keys(options, now));
  682. }
  683. /* Generate three dummy commits according to sr_srv_calc_ref.py . Then
  684. register them to the SR state. Also register a fourth commit 'd' with no
  685. reveal info, to make sure that it will get ignored during SRV
  686. calculation. */
  687. { /* Commit from auth 'a' */
  688. commit_a = sr_generate_our_commit(now, auth_cert);
  689. tt_assert(commit_a);
  690. /* Do some surgery on the commit */
  691. memset(commit_a->rsa_identity, 'A', sizeof(commit_a->rsa_identity));
  692. base16_encode(commit_a->rsa_identity_hex,
  693. sizeof(commit_a->rsa_identity_hex), commit_a->rsa_identity,
  694. sizeof(commit_a->rsa_identity));
  695. strlcpy(commit_a->encoded_reveal,
  696. "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  697. sizeof(commit_a->encoded_reveal));
  698. memcpy(commit_a->hashed_reveal,
  699. "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  700. sizeof(commit_a->hashed_reveal));
  701. }
  702. { /* Commit from auth 'b' */
  703. commit_b = sr_generate_our_commit(now, auth_cert);
  704. tt_assert(commit_b);
  705. /* Do some surgery on the commit */
  706. memset(commit_b->rsa_identity, 'B', sizeof(commit_b->rsa_identity));
  707. base16_encode(commit_b->rsa_identity_hex,
  708. sizeof(commit_b->rsa_identity_hex), commit_b->rsa_identity,
  709. sizeof(commit_b->rsa_identity));
  710. strlcpy(commit_b->encoded_reveal,
  711. "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB",
  712. sizeof(commit_b->encoded_reveal));
  713. memcpy(commit_b->hashed_reveal,
  714. "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB",
  715. sizeof(commit_b->hashed_reveal));
  716. }
  717. { /* Commit from auth 'c' */
  718. commit_c = sr_generate_our_commit(now, auth_cert);
  719. tt_assert(commit_c);
  720. /* Do some surgery on the commit */
  721. memset(commit_c->rsa_identity, 'C', sizeof(commit_c->rsa_identity));
  722. base16_encode(commit_c->rsa_identity_hex,
  723. sizeof(commit_c->rsa_identity_hex), commit_c->rsa_identity,
  724. sizeof(commit_c->rsa_identity));
  725. strlcpy(commit_c->encoded_reveal,
  726. "CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC",
  727. sizeof(commit_c->encoded_reveal));
  728. memcpy(commit_c->hashed_reveal,
  729. "CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC",
  730. sizeof(commit_c->hashed_reveal));
  731. }
  732. { /* Commit from auth 'd' */
  733. commit_d = sr_generate_our_commit(now, auth_cert);
  734. tt_assert(commit_d);
  735. /* Do some surgery on the commit */
  736. memset(commit_d->rsa_identity, 'D', sizeof(commit_d->rsa_identity));
  737. base16_encode(commit_d->rsa_identity_hex,
  738. sizeof(commit_d->rsa_identity_hex), commit_d->rsa_identity,
  739. sizeof(commit_d->rsa_identity));
  740. strlcpy(commit_d->encoded_reveal,
  741. "DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD",
  742. sizeof(commit_d->encoded_reveal));
  743. memcpy(commit_d->hashed_reveal,
  744. "DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD",
  745. sizeof(commit_d->hashed_reveal));
  746. /* Clean up its reveal info */
  747. memcpy(place_holder, commit_d, sizeof(*place_holder));
  748. memset(commit_d->encoded_reveal, 0, sizeof(commit_d->encoded_reveal));
  749. tt_assert(!commit_has_reveal_value(commit_d));
  750. }
  751. /* Register commits to state (during commit phase) */
  752. set_sr_phase(SR_PHASE_COMMIT);
  753. save_commit_to_state(commit_a);
  754. save_commit_to_state(commit_b);
  755. save_commit_to_state(commit_c);
  756. save_commit_to_state(commit_d);
  757. tt_int_op(digestmap_size(get_sr_state()->commits), OP_EQ, 4);
  758. /* Now during REVEAL phase save commit D by restoring its reveal. */
  759. set_sr_phase(SR_PHASE_REVEAL);
  760. save_commit_to_state(place_holder);
  761. tt_str_op(commit_d->encoded_reveal, OP_EQ,
  762. "DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD");
  763. /* Go back to an empty encoded reveal value. */
  764. memset(commit_d->encoded_reveal, 0, sizeof(commit_d->encoded_reveal));
  765. memset(commit_d->random_number, 0, sizeof(commit_d->random_number));
  766. tt_assert(!commit_has_reveal_value(commit_d));
  767. done:
  768. authority_cert_free(auth_cert);
  769. }
  770. /** Verify that the SRV generation procedure is proper by testing it against
  771. * the test vector from ./sr_srv_calc_ref.py. */
  772. static void
  773. test_sr_compute_srv(void *arg)
  774. {
  775. (void) arg;
  776. const sr_srv_t *current_srv = NULL;
  777. #define SRV_TEST_VECTOR \
  778. "2A9B1D6237DAB312A40F575DA85C147663E7ED3F80E9555395F15B515C74253D"
  779. MOCK(trusteddirserver_get_by_v3_auth_digest,
  780. trusteddirserver_get_by_v3_auth_digest_m);
  781. init_authority_state();
  782. /* Setup the commits for this unittest */
  783. test_sr_setup_commits();
  784. test_sr_setup_srv(0);
  785. /* Now switch to reveal phase */
  786. set_sr_phase(SR_PHASE_REVEAL);
  787. /* Compute the SRV */
  788. sr_compute_srv();
  789. /* Check the result against the test vector */
  790. current_srv = sr_state_get_current_srv();
  791. tt_assert(current_srv);
  792. tt_u64_op(current_srv->num_reveals, OP_EQ, 3);
  793. tt_str_op(hex_str((char*)current_srv->value, 32),
  794. OP_EQ,
  795. SRV_TEST_VECTOR);
  796. done:
  797. UNMOCK(trusteddirserver_get_by_v3_auth_digest);
  798. }
  799. /** Return a minimal vote document with a current SRV value set to
  800. * <b>srv</b>. */
  801. static networkstatus_t *
  802. get_test_vote_with_curr_srv(const char *srv)
  803. {
  804. networkstatus_t *vote = tor_malloc_zero(sizeof(networkstatus_t));
  805. vote->type = NS_TYPE_VOTE;
  806. vote->sr_info.participate = 1;
  807. vote->sr_info.current_srv = tor_malloc_zero(sizeof(sr_srv_t));
  808. vote->sr_info.current_srv->num_reveals = 42;
  809. memcpy(vote->sr_info.current_srv->value,
  810. srv,
  811. sizeof(vote->sr_info.current_srv->value));
  812. return vote;
  813. }
  814. /* Test the function that picks the right SRV given a bunch of votes. Make sure
  815. * that the function returns an SRV iff the majority/agreement requirements are
  816. * met. */
  817. static void
  818. test_sr_get_majority_srv_from_votes(void *arg)
  819. {
  820. sr_srv_t *chosen_srv;
  821. smartlist_t *votes = smartlist_new();
  822. #define SRV_1 "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
  823. #define SRV_2 "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB"
  824. (void) arg;
  825. init_authority_state();
  826. /* Make sure our SRV is fresh so we can consider the super majority with
  827. * the consensus params of number of agreements needed. */
  828. sr_state_set_fresh_srv();
  829. /* The test relies on the dirauth list being initialized. */
  830. clear_dir_servers();
  831. add_default_trusted_dir_authorities(V3_DIRINFO);
  832. { /* Prepare voting environment with just a single vote. */
  833. networkstatus_t *vote = get_test_vote_with_curr_srv(SRV_1);
  834. smartlist_add(votes, vote);
  835. }
  836. /* Since it's only one vote with an SRV, it should not achieve majority and
  837. hence no SRV will be returned. */
  838. chosen_srv = get_majority_srv_from_votes(votes, 1);
  839. tt_ptr_op(chosen_srv, OP_EQ, NULL);
  840. { /* Now put in 8 more votes. Let SRV_1 have majority. */
  841. int i;
  842. /* Now 7 votes believe in SRV_1 */
  843. for (i = 0; i < 3; i++) {
  844. networkstatus_t *vote = get_test_vote_with_curr_srv(SRV_1);
  845. smartlist_add(votes, vote);
  846. }
  847. /* and 2 votes believe in SRV_2 */
  848. for (i = 0; i < 2; i++) {
  849. networkstatus_t *vote = get_test_vote_with_curr_srv(SRV_2);
  850. smartlist_add(votes, vote);
  851. }
  852. for (i = 0; i < 3; i++) {
  853. networkstatus_t *vote = get_test_vote_with_curr_srv(SRV_1);
  854. smartlist_add(votes, vote);
  855. }
  856. tt_int_op(smartlist_len(votes), OP_EQ, 9);
  857. }
  858. /* Now we achieve majority for SRV_1, but not the AuthDirNumSRVAgreements
  859. requirement. So still not picking an SRV. */
  860. set_num_srv_agreements(8);
  861. chosen_srv = get_majority_srv_from_votes(votes, 1);
  862. tt_ptr_op(chosen_srv, OP_EQ, NULL);
  863. /* We will now lower the AuthDirNumSRVAgreements requirement by tweaking the
  864. * consensus parameter and we will try again. This time it should work. */
  865. set_num_srv_agreements(7);
  866. chosen_srv = get_majority_srv_from_votes(votes, 1);
  867. tt_assert(chosen_srv);
  868. tt_u64_op(chosen_srv->num_reveals, OP_EQ, 42);
  869. tt_mem_op(chosen_srv->value, OP_EQ, SRV_1, sizeof(chosen_srv->value));
  870. done:
  871. SMARTLIST_FOREACH(votes, networkstatus_t *, vote,
  872. networkstatus_vote_free(vote));
  873. smartlist_free(votes);
  874. }
  875. static void
  876. test_utils(void *arg)
  877. {
  878. (void) arg;
  879. /* Testing srv_dup(). */
  880. {
  881. sr_srv_t *srv = NULL, *dup_srv = NULL;
  882. const char *srv_value =
  883. "1BDB7C3E973936E4D13A49F37C859B3DC69C429334CF9412E3FEF6399C52D47A";
  884. srv = tor_malloc_zero(sizeof(*srv));
  885. srv->num_reveals = 42;
  886. memcpy(srv->value, srv_value, sizeof(srv->value));
  887. dup_srv = srv_dup(srv);
  888. tt_assert(dup_srv);
  889. tt_u64_op(dup_srv->num_reveals, OP_EQ, srv->num_reveals);
  890. tt_mem_op(dup_srv->value, OP_EQ, srv->value, sizeof(srv->value));
  891. tor_free(srv);
  892. tor_free(dup_srv);
  893. }
  894. /* Testing commitments_are_the_same(). Currently, the check is to test the
  895. * value of the encoded commit so let's make sure that actually works. */
  896. {
  897. /* Payload of 57 bytes that is the length of sr_commit_t->encoded_commit.
  898. * 56 bytes of payload and a NUL terminated byte at the end ('\x00')
  899. * which comes down to SR_COMMIT_BASE64_LEN + 1. */
  900. const char *payload =
  901. "\x5d\xb9\x60\xb6\xcc\x51\x68\x52\x31\xd9\x88\x88\x71\x71\xe0\x30"
  902. "\x59\x55\x7f\xcd\x61\xc0\x4b\x05\xb8\xcd\xc1\x48\xe9\xcd\x16\x1f"
  903. "\x70\x15\x0c\xfc\xd3\x1a\x75\xd0\x93\x6c\xc4\xe0\x5c\xbe\xe2\x18"
  904. "\xc7\xaf\x72\xb6\x7c\x9b\x52\x00";
  905. sr_commit_t commit1, commit2;
  906. memcpy(commit1.encoded_commit, payload, sizeof(commit1.encoded_commit));
  907. memcpy(commit2.encoded_commit, payload, sizeof(commit2.encoded_commit));
  908. tt_int_op(commitments_are_the_same(&commit1, &commit2), OP_EQ, 1);
  909. /* Let's corrupt one of them. */
  910. memset(commit1.encoded_commit, 'A', sizeof(commit1.encoded_commit));
  911. tt_int_op(commitments_are_the_same(&commit1, &commit2), OP_EQ, 0);
  912. }
  913. /* Testing commit_is_authoritative(). */
  914. {
  915. crypto_pk_t *k = crypto_pk_new();
  916. char digest[DIGEST_LEN];
  917. sr_commit_t commit;
  918. tt_assert(!crypto_pk_generate_key(k));
  919. tt_int_op(0, OP_EQ, crypto_pk_get_digest(k, digest));
  920. memcpy(commit.rsa_identity, digest, sizeof(commit.rsa_identity));
  921. tt_int_op(commit_is_authoritative(&commit, digest), OP_EQ, 1);
  922. /* Change the pubkey. */
  923. memset(commit.rsa_identity, 0, sizeof(commit.rsa_identity));
  924. tt_int_op(commit_is_authoritative(&commit, digest), OP_EQ, 0);
  925. crypto_pk_free(k);
  926. }
  927. /* Testing get_phase_str(). */
  928. {
  929. tt_str_op(get_phase_str(SR_PHASE_REVEAL), OP_EQ, "reveal");
  930. tt_str_op(get_phase_str(SR_PHASE_COMMIT), OP_EQ, "commit");
  931. }
  932. /* Testing phase transition */
  933. {
  934. init_authority_state();
  935. set_sr_phase(SR_PHASE_COMMIT);
  936. tt_int_op(is_phase_transition(SR_PHASE_REVEAL), OP_EQ, 1);
  937. tt_int_op(is_phase_transition(SR_PHASE_COMMIT), OP_EQ, 0);
  938. set_sr_phase(SR_PHASE_REVEAL);
  939. tt_int_op(is_phase_transition(SR_PHASE_REVEAL), OP_EQ, 0);
  940. tt_int_op(is_phase_transition(SR_PHASE_COMMIT), OP_EQ, 1);
  941. /* Junk. */
  942. tt_int_op(is_phase_transition(42), OP_EQ, 1);
  943. }
  944. done:
  945. return;
  946. }
  947. static void
  948. test_state_transition(void *arg)
  949. {
  950. sr_state_t *state = NULL;
  951. time_t now = time(NULL);
  952. (void) arg;
  953. { /* Setup a minimal dirauth environment for this test */
  954. init_authority_state();
  955. state = get_sr_state();
  956. tt_assert(state);
  957. }
  958. /* Test our state reset for a new protocol run. */
  959. {
  960. /* Add a commit to the state so we can test if the reset cleans the
  961. * commits. Also, change all params that we expect to be updated. */
  962. sr_commit_t *commit = sr_generate_our_commit(now, mock_cert);
  963. tt_assert(commit);
  964. sr_state_add_commit(commit);
  965. tt_int_op(digestmap_size(state->commits), OP_EQ, 1);
  966. /* Let's test our delete feature. */
  967. sr_state_delete_commits();
  968. tt_int_op(digestmap_size(state->commits), OP_EQ, 0);
  969. /* Add it back so we can continue the rest of the test because after
  970. * deletiong our commit will be freed so generate a new one. */
  971. commit = sr_generate_our_commit(now, mock_cert);
  972. tt_assert(commit);
  973. sr_state_add_commit(commit);
  974. tt_int_op(digestmap_size(state->commits), OP_EQ, 1);
  975. state->n_reveal_rounds = 42;
  976. state->n_commit_rounds = 43;
  977. state->n_protocol_runs = 44;
  978. reset_state_for_new_protocol_run(now);
  979. tt_int_op(state->n_reveal_rounds, OP_EQ, 0);
  980. tt_int_op(state->n_commit_rounds, OP_EQ, 0);
  981. tt_u64_op(state->n_protocol_runs, OP_EQ, 45);
  982. tt_int_op(digestmap_size(state->commits), OP_EQ, 0);
  983. }
  984. /* Test SRV rotation in our state. */
  985. {
  986. const sr_srv_t *cur, *prev;
  987. test_sr_setup_srv(1);
  988. cur = sr_state_get_current_srv();
  989. tt_assert(cur);
  990. /* After, current srv should be the previous and then set to NULL. */
  991. state_rotate_srv();
  992. prev = sr_state_get_previous_srv();
  993. tt_assert(prev == cur);
  994. tt_ptr_op(sr_state_get_current_srv(), OP_EQ, NULL);
  995. sr_state_clean_srvs();
  996. }
  997. /* New protocol run. */
  998. {
  999. const sr_srv_t *cur;
  1000. /* Setup some new SRVs so we can confirm that a new protocol run
  1001. * actually makes them rotate and compute new ones. */
  1002. test_sr_setup_srv(1);
  1003. cur = sr_state_get_current_srv();
  1004. tt_assert(cur);
  1005. set_sr_phase(SR_PHASE_REVEAL);
  1006. MOCK(get_my_v3_authority_cert, get_my_v3_authority_cert_m);
  1007. new_protocol_run(now);
  1008. UNMOCK(get_my_v3_authority_cert);
  1009. /* Rotation happened. */
  1010. tt_assert(sr_state_get_previous_srv() == cur);
  1011. /* We are going into COMMIT phase so we had to rotate our SRVs. Usually
  1012. * our current SRV would be NULL but a new protocol run should make us
  1013. * compute a new SRV. */
  1014. tt_assert(sr_state_get_current_srv());
  1015. /* Also, make sure we did change the current. */
  1016. tt_assert(sr_state_get_current_srv() != cur);
  1017. /* We should have our commitment alone. */
  1018. tt_int_op(digestmap_size(state->commits), OP_EQ, 1);
  1019. tt_int_op(state->n_reveal_rounds, OP_EQ, 0);
  1020. tt_int_op(state->n_commit_rounds, OP_EQ, 0);
  1021. /* 46 here since we were at 45 just before. */
  1022. tt_u64_op(state->n_protocol_runs, OP_EQ, 46);
  1023. }
  1024. /* Cleanup of SRVs. */
  1025. {
  1026. sr_state_clean_srvs();
  1027. tt_ptr_op(sr_state_get_current_srv(), OP_EQ, NULL);
  1028. tt_ptr_op(sr_state_get_previous_srv(), OP_EQ, NULL);
  1029. }
  1030. done:
  1031. return;
  1032. }
  1033. static void
  1034. test_keep_commit(void *arg)
  1035. {
  1036. char fp[FINGERPRINT_LEN + 1];
  1037. sr_commit_t *commit = NULL, *dup_commit = NULL;
  1038. sr_state_t *state;
  1039. time_t now = time(NULL);
  1040. crypto_pk_t *k = NULL;
  1041. (void) arg;
  1042. MOCK(trusteddirserver_get_by_v3_auth_digest,
  1043. trusteddirserver_get_by_v3_auth_digest_m);
  1044. {
  1045. k = pk_generate(1);
  1046. /* Setup a minimal dirauth environment for this test */
  1047. /* Have a key that is not the one from our commit. */
  1048. init_authority_state();
  1049. state = get_sr_state();
  1050. }
  1051. crypto_rand((char*)fp, sizeof(fp));
  1052. /* Test this very important function that tells us if we should keep a
  1053. * commit or not in our state. Most of it depends on the phase and what's
  1054. * in the commit so we'll change the commit as we go. */
  1055. commit = sr_generate_our_commit(now, mock_cert);
  1056. tt_assert(commit);
  1057. /* Set us in COMMIT phase for starter. */
  1058. set_sr_phase(SR_PHASE_COMMIT);
  1059. /* We should never keep a commit from a non authoritative authority. */
  1060. tt_int_op(should_keep_commit(commit, fp, SR_PHASE_COMMIT), OP_EQ, 0);
  1061. /* This should NOT be kept because it has a reveal value in it. */
  1062. tt_assert(commit_has_reveal_value(commit));
  1063. tt_int_op(should_keep_commit(commit, commit->rsa_identity,
  1064. SR_PHASE_COMMIT), OP_EQ, 0);
  1065. /* Add it to the state which should return to not keep it. */
  1066. sr_state_add_commit(commit);
  1067. tt_int_op(should_keep_commit(commit, commit->rsa_identity,
  1068. SR_PHASE_COMMIT), OP_EQ, 0);
  1069. /* Remove it from state so we can continue our testing. */
  1070. digestmap_remove(state->commits, commit->rsa_identity);
  1071. /* Let's remove our reveal value which should make it OK to keep it. */
  1072. memset(commit->encoded_reveal, 0, sizeof(commit->encoded_reveal));
  1073. tt_int_op(should_keep_commit(commit, commit->rsa_identity,
  1074. SR_PHASE_COMMIT), OP_EQ, 1);
  1075. /* Let's reset our commit and go into REVEAL phase. */
  1076. sr_commit_free(commit);
  1077. commit = sr_generate_our_commit(now, mock_cert);
  1078. tt_assert(commit);
  1079. /* Dup the commit so we have one with and one without a reveal value. */
  1080. dup_commit = tor_malloc_zero(sizeof(*dup_commit));
  1081. memcpy(dup_commit, commit, sizeof(*dup_commit));
  1082. memset(dup_commit->encoded_reveal, 0, sizeof(dup_commit->encoded_reveal));
  1083. set_sr_phase(SR_PHASE_REVEAL);
  1084. /* We should never keep a commit from a non authoritative authority. */
  1085. tt_int_op(should_keep_commit(commit, fp, SR_PHASE_REVEAL), OP_EQ, 0);
  1086. /* We shouldn't accept a commit that is not in our state. */
  1087. tt_int_op(should_keep_commit(commit, commit->rsa_identity,
  1088. SR_PHASE_REVEAL), OP_EQ, 0);
  1089. /* Important to add the commit _without_ the reveal here. */
  1090. sr_state_add_commit(dup_commit);
  1091. tt_int_op(digestmap_size(state->commits), OP_EQ, 1);
  1092. /* Our commit should be valid that is authoritative, contains a reveal, be
  1093. * in the state and commitment and reveal values match. */
  1094. tt_int_op(should_keep_commit(commit, commit->rsa_identity,
  1095. SR_PHASE_REVEAL), OP_EQ, 1);
  1096. /* The commit shouldn't be kept if it's not verified that is no matchin
  1097. * hashed reveal. */
  1098. {
  1099. /* Let's save the hash reveal so we can restore it. */
  1100. sr_commit_t place_holder;
  1101. memcpy(place_holder.hashed_reveal, commit->hashed_reveal,
  1102. sizeof(place_holder.hashed_reveal));
  1103. memset(commit->hashed_reveal, 0, sizeof(commit->hashed_reveal));
  1104. setup_full_capture_of_logs(LOG_WARN);
  1105. tt_int_op(should_keep_commit(commit, commit->rsa_identity,
  1106. SR_PHASE_REVEAL), OP_EQ, 0);
  1107. expect_log_msg_containing("doesn't match the commit value.");
  1108. expect_log_msg_containing("has an invalid reveal value.");
  1109. assert_log_predicate(mock_saved_log_n_entries() == 2,
  1110. "expected 2 log entries");
  1111. teardown_capture_of_logs();
  1112. memcpy(commit->hashed_reveal, place_holder.hashed_reveal,
  1113. sizeof(commit->hashed_reveal));
  1114. }
  1115. /* We shouldn't keep a commit that has no reveal. */
  1116. tt_int_op(should_keep_commit(dup_commit, dup_commit->rsa_identity,
  1117. SR_PHASE_REVEAL), OP_EQ, 0);
  1118. /* We must not keep a commit that is not the same from the commit phase. */
  1119. memset(commit->encoded_commit, 0, sizeof(commit->encoded_commit));
  1120. tt_int_op(should_keep_commit(commit, commit->rsa_identity,
  1121. SR_PHASE_REVEAL), OP_EQ, 0);
  1122. done:
  1123. teardown_capture_of_logs();
  1124. sr_commit_free(commit);
  1125. sr_commit_free(dup_commit);
  1126. crypto_pk_free(k);
  1127. UNMOCK(trusteddirserver_get_by_v3_auth_digest);
  1128. }
  1129. static void
  1130. test_state_update(void *arg)
  1131. {
  1132. time_t commit_phase_time = 1452076000;
  1133. time_t reveal_phase_time = 1452086800;
  1134. sr_state_t *state;
  1135. (void) arg;
  1136. {
  1137. init_authority_state();
  1138. state = get_sr_state();
  1139. set_sr_phase(SR_PHASE_COMMIT);
  1140. /* We'll cheat a bit here and reset the creation time of the state which
  1141. * will avoid us to compute a valid_after time that fits the commit
  1142. * phase. */
  1143. state->valid_after = 0;
  1144. state->n_reveal_rounds = 0;
  1145. state->n_commit_rounds = 0;
  1146. state->n_protocol_runs = 0;
  1147. }
  1148. /* We need to mock for the state update function call. */
  1149. MOCK(get_my_v3_authority_cert, get_my_v3_authority_cert_m);
  1150. /* We are in COMMIT phase here and we'll trigger a state update but no
  1151. * transition. */
  1152. sr_state_update(commit_phase_time);
  1153. tt_int_op(state->valid_after, OP_EQ, commit_phase_time);
  1154. tt_int_op(state->n_commit_rounds, OP_EQ, 1);
  1155. tt_int_op(state->phase, OP_EQ, SR_PHASE_COMMIT);
  1156. tt_int_op(digestmap_size(state->commits), OP_EQ, 1);
  1157. /* We are still in the COMMIT phase here but we'll trigger a state
  1158. * transition to the REVEAL phase. */
  1159. sr_state_update(reveal_phase_time);
  1160. tt_int_op(state->phase, OP_EQ, SR_PHASE_REVEAL);
  1161. tt_int_op(state->valid_after, OP_EQ, reveal_phase_time);
  1162. /* Only our commit should be in there. */
  1163. tt_int_op(digestmap_size(state->commits), OP_EQ, 1);
  1164. tt_int_op(state->n_reveal_rounds, OP_EQ, 1);
  1165. /* We can't update a state with a valid after _lower_ than the creation
  1166. * time so here it is. */
  1167. sr_state_update(commit_phase_time);
  1168. tt_int_op(state->valid_after, OP_EQ, reveal_phase_time);
  1169. /* Finally, let's go back in COMMIT phase so we can test the state update
  1170. * of a new protocol run. */
  1171. state->valid_after = 0;
  1172. sr_state_update(commit_phase_time);
  1173. tt_int_op(state->valid_after, OP_EQ, commit_phase_time);
  1174. tt_int_op(state->n_commit_rounds, OP_EQ, 1);
  1175. tt_int_op(state->n_reveal_rounds, OP_EQ, 0);
  1176. tt_u64_op(state->n_protocol_runs, OP_EQ, 1);
  1177. tt_int_op(state->phase, OP_EQ, SR_PHASE_COMMIT);
  1178. tt_int_op(digestmap_size(state->commits), OP_EQ, 1);
  1179. tt_assert(state->current_srv);
  1180. done:
  1181. sr_state_free();
  1182. UNMOCK(get_my_v3_authority_cert);
  1183. }
  1184. struct testcase_t sr_tests[] = {
  1185. { "get_sr_protocol_phase", test_get_sr_protocol_phase, TT_FORK,
  1186. NULL, NULL },
  1187. { "sr_commit", test_sr_commit, TT_FORK,
  1188. NULL, NULL },
  1189. { "keep_commit", test_keep_commit, TT_FORK,
  1190. NULL, NULL },
  1191. { "encoding", test_encoding, TT_FORK,
  1192. NULL, NULL },
  1193. { "get_next_valid_after_time", test_get_next_valid_after_time, TT_FORK,
  1194. NULL, NULL },
  1195. { "get_start_time_of_current_run", test_get_start_time_of_current_run,
  1196. TT_FORK, NULL, NULL },
  1197. { "get_start_time_functions", test_get_start_time_functions,
  1198. TT_FORK, NULL, NULL },
  1199. { "get_sr_protocol_duration", test_get_sr_protocol_duration, TT_FORK,
  1200. NULL, NULL },
  1201. { "get_state_valid_until_time", test_get_state_valid_until_time, TT_FORK,
  1202. NULL, NULL },
  1203. { "vote", test_vote, TT_FORK,
  1204. NULL, NULL },
  1205. { "state_load_from_disk", test_state_load_from_disk, TT_FORK,
  1206. NULL, NULL },
  1207. { "sr_compute_srv", test_sr_compute_srv, TT_FORK, NULL, NULL },
  1208. { "sr_get_majority_srv_from_votes", test_sr_get_majority_srv_from_votes,
  1209. TT_FORK, NULL, NULL },
  1210. { "utils", test_utils, TT_FORK, NULL, NULL },
  1211. { "state_transition", test_state_transition, TT_FORK, NULL, NULL },
  1212. { "state_update", test_state_update, TT_FORK,
  1213. NULL, NULL },
  1214. END_OF_TESTCASES
  1215. };