test_shared_random.c 48 KB

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