test_shared_random.c 48 KB

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