test_shared_random.c 48 KB

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