routerkeys.c 33 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076
  1. /* Copyright (c) 2014, The Tor Project, Inc. */
  2. /* See LICENSE for licensing information */
  3. #include "or.h"
  4. #include "config.h"
  5. #include "router.h"
  6. #include "crypto_pwbox.h"
  7. #include "routerkeys.h"
  8. #include "torcert.h"
  9. #define ENC_KEY_HEADER "Boxed Ed25519 key"
  10. #define ENC_KEY_TAG "master"
  11. static ssize_t
  12. do_getpass(const char *prompt, char *buf, size_t buflen,
  13. int twice, const or_options_t *options)
  14. {
  15. if (options->keygen_force_passphrase == FORCE_PASSPHRASE_OFF) {
  16. tor_assert(buflen);
  17. buf[0] = 0;
  18. return 0;
  19. }
  20. char *prompt2 = NULL;
  21. char *buf2 = NULL;
  22. int fd = -1;
  23. ssize_t length = -1;
  24. if (options->use_keygen_passphrase_fd) {
  25. twice = 0;
  26. fd = options->keygen_passphrase_fd;
  27. length = read_all(fd, buf, buflen-1, 0);
  28. if (length >= 0)
  29. buf[length] = 0;
  30. goto done_reading;
  31. }
  32. if (twice) {
  33. const char msg[] = "One more time:";
  34. size_t p2len = strlen(prompt) + 1;
  35. if (p2len < sizeof(msg))
  36. p2len = sizeof(msg);
  37. prompt2 = tor_malloc(strlen(prompt)+1);
  38. memset(prompt2, ' ', p2len);
  39. memcpy(prompt2 + p2len - sizeof(msg), msg, sizeof(msg));
  40. buf2 = tor_malloc_zero(buflen);
  41. }
  42. while (1) {
  43. length = tor_getpass(prompt, buf, buflen);
  44. if (length < 0)
  45. goto done_reading;
  46. if (! twice)
  47. break;
  48. ssize_t length2 = tor_getpass(prompt2, buf2, buflen);
  49. if (length != length2 || tor_memneq(buf, buf2, length)) {
  50. fprintf(stderr, "That didn't match.\n");
  51. } else {
  52. break;
  53. }
  54. }
  55. done_reading:
  56. if (twice) {
  57. tor_free(prompt2);
  58. memwipe(buf2, 0, buflen);
  59. tor_free(buf2);
  60. }
  61. if (options->keygen_force_passphrase == FORCE_PASSPHRASE_ON && length == 0)
  62. return -1;
  63. return length;
  64. }
  65. int
  66. read_encrypted_secret_key(ed25519_secret_key_t *out,
  67. const char *fname)
  68. {
  69. int r = -1;
  70. uint8_t *secret = NULL;
  71. size_t secret_len = 0;
  72. char pwbuf[256];
  73. uint8_t encrypted_key[256];
  74. char *tag = NULL;
  75. int saved_errno = 0;
  76. ssize_t encrypted_len = crypto_read_tagged_contents_from_file(fname,
  77. ENC_KEY_HEADER,
  78. &tag,
  79. encrypted_key,
  80. sizeof(encrypted_key));
  81. if (encrypted_len < 0) {
  82. saved_errno = errno;
  83. log_info(LD_OR, "%s is missing", fname);
  84. r = 0;
  85. goto done;
  86. }
  87. if (strcmp(tag, ENC_KEY_TAG)) {
  88. saved_errno = EINVAL;
  89. goto done;
  90. }
  91. while (1) {
  92. ssize_t pwlen =
  93. do_getpass("Enter pasphrase for master key:", pwbuf, sizeof(pwbuf), 0,
  94. get_options());
  95. if (pwlen < 0) {
  96. saved_errno = EINVAL;
  97. goto done;
  98. }
  99. const int r = crypto_unpwbox(&secret, &secret_len,
  100. encrypted_key, encrypted_len,
  101. pwbuf, pwlen);
  102. if (r == UNPWBOX_CORRUPTED) {
  103. log_err(LD_OR, "%s is corrupted.", fname);
  104. saved_errno = EINVAL;
  105. goto done;
  106. } else if (r == UNPWBOX_OKAY) {
  107. break;
  108. }
  109. /* Otherwise, passphrase is bad, so try again till user does ctrl-c or gets
  110. * it right. */
  111. }
  112. if (secret_len != ED25519_SECKEY_LEN) {
  113. log_err(LD_OR, "%s is corrupted.", fname);
  114. saved_errno = EINVAL;
  115. goto done;
  116. }
  117. memcpy(out->seckey, secret, ED25519_SECKEY_LEN);
  118. r = 1;
  119. done:
  120. memwipe(encrypted_key, 0, sizeof(encrypted_key));
  121. memwipe(pwbuf, 0, sizeof(pwbuf));
  122. tor_free(tag);
  123. if (secret) {
  124. memwipe(secret, 0, secret_len);
  125. tor_free(secret);
  126. }
  127. if (saved_errno)
  128. errno = saved_errno;
  129. return r;
  130. }
  131. int
  132. write_encrypted_secret_key(const ed25519_secret_key_t *key,
  133. const char *fname)
  134. {
  135. int r = -1;
  136. char pwbuf0[256];
  137. uint8_t *encrypted_key = NULL;
  138. size_t encrypted_len = 0;
  139. if (do_getpass("Enter new passphrase:", pwbuf0, sizeof(pwbuf0), 1,
  140. get_options()) < 0) {
  141. log_warn(LD_OR, "NO/failed passphrase");
  142. return -1;
  143. }
  144. if (strlen(pwbuf0) == 0) {
  145. if (get_options()->keygen_force_passphrase == FORCE_PASSPHRASE_ON)
  146. return -1;
  147. else
  148. return 0;
  149. }
  150. if (crypto_pwbox(&encrypted_key, &encrypted_len,
  151. key->seckey, sizeof(key->seckey),
  152. pwbuf0, strlen(pwbuf0), 0) < 0) {
  153. log_warn(LD_OR, "crypto_pwbox failed!?");
  154. goto done;
  155. }
  156. if (crypto_write_tagged_contents_to_file(fname,
  157. ENC_KEY_HEADER,
  158. ENC_KEY_TAG,
  159. encrypted_key, encrypted_len) < 0)
  160. goto done;
  161. r = 1;
  162. done:
  163. if (encrypted_key) {
  164. memwipe(encrypted_key, 0, encrypted_len);
  165. tor_free(encrypted_key);
  166. }
  167. memwipe(pwbuf0, 0, sizeof(pwbuf0));
  168. return r;
  169. }
  170. static int
  171. write_secret_key(const ed25519_secret_key_t *key, int encrypted,
  172. const char *fname,
  173. const char *fname_tag,
  174. const char *encrypted_fname)
  175. {
  176. if (encrypted) {
  177. int r = write_encrypted_secret_key(key, encrypted_fname);
  178. if (r != 0)
  179. return r; /* Either succeeded or failed unrecoverably */
  180. fprintf(stderr, "Not encrypting the secret key.\n");
  181. }
  182. return ed25519_seckey_write_to_file(key, fname, fname_tag);
  183. }
  184. /**
  185. * Read an ed25519 key and associated certificates from files beginning with
  186. * <b>fname</b>, with certificate type <b>cert_type</b>. On failure, return
  187. * NULL; on success return the keypair.
  188. *
  189. * If INIT_ED_KEY_CREATE is set in <b>flags</b>, then create the key (and
  190. * certificate if requested) if it doesn't exist, and save it to disk.
  191. *
  192. * If INIT_ED_KEY_NEEDCERT is set in <b>flags</b>, load/create a certificate
  193. * too and store it in *<b>cert_out</b>. Fail if the cert can't be
  194. * found/created. To create a certificate, <b>signing_key</b> must be set to
  195. * the key that should sign it; <b>now</b> to the current time, and
  196. * <b>lifetime</b> to the lifetime of the key.
  197. *
  198. * If INIT_ED_KEY_REPLACE is set in <b>flags</b>, then create and save new key
  199. * whether we can read the old one or not.
  200. *
  201. * If INIT_ED_KEY_EXTRA_STRONG is set in <b>flags</b>, set the extra_strong
  202. * flag when creating the secret key.
  203. *
  204. * If INIT_ED_KEY_INCLUDE_SIGNING_KEY_IN_CERT is set in <b>flags</b>, and
  205. * we create a new certificate, create it with the signing key embedded.
  206. *
  207. * If INIT_ED_KEY_SPLIT is set in <b>flags</b>, and we create a new key,
  208. * store the public key in a separate file from the secret key.
  209. *
  210. * If INIT_ED_KEY_MISSING_SECRET_OK is set in <b>flags</b>, and we find a
  211. * public key file but no secret key file, return successfully anyway.
  212. *
  213. * If INIT_ED_KEY_OMIT_SECRET is set in <b>flags</b>, do not even try to
  214. * load or return a secret key (but create and save one if needed).
  215. *
  216. * If INIT_ED_KEY_TRY_ENCRYPTED is set, we look for an encrypted secret key
  217. * and consider encrypting any new secret key.
  218. *
  219. * If INIT_ED_KEY_NO_REPAIR is set, and there is any issue loading the keys
  220. * from disk _other than their absence_ (full or partial), we do not try to
  221. * replace them.
  222. *
  223. * If INIT_ED_KEY_SUGGEST_KEYGEN is set, have log messages about failures
  224. * refer to the --keygen option.
  225. */
  226. ed25519_keypair_t *
  227. ed_key_init_from_file(const char *fname, uint32_t flags,
  228. int severity,
  229. const ed25519_keypair_t *signing_key,
  230. time_t now,
  231. time_t lifetime,
  232. uint8_t cert_type,
  233. struct tor_cert_st **cert_out)
  234. {
  235. char *secret_fname = NULL;
  236. char *encrypted_secret_fname = NULL;
  237. char *public_fname = NULL;
  238. char *cert_fname = NULL;
  239. const char *loaded_secret_fname = NULL;
  240. int created_pk = 0, created_sk = 0, created_cert = 0;
  241. const int try_to_load = ! (flags & INIT_ED_KEY_REPLACE);
  242. const int encrypt_key = !! (flags & INIT_ED_KEY_TRY_ENCRYPTED);
  243. const int norepair = !! (flags & INIT_ED_KEY_NO_REPAIR);
  244. const int split = !! (flags & INIT_ED_KEY_SPLIT);
  245. const int omit_secret = !! (flags & INIT_ED_KEY_OMIT_SECRET);
  246. /* we don't support setting both of these flags at once. */
  247. tor_assert((flags & (INIT_ED_KEY_NO_REPAIR|INIT_ED_KEY_NEEDCERT)) !=
  248. (INIT_ED_KEY_NO_REPAIR|INIT_ED_KEY_NEEDCERT));
  249. char tag[8];
  250. tor_snprintf(tag, sizeof(tag), "type%d", (int)cert_type);
  251. tor_cert_t *cert = NULL;
  252. char *got_tag = NULL;
  253. ed25519_keypair_t *keypair = tor_malloc_zero(sizeof(ed25519_keypair_t));
  254. tor_asprintf(&secret_fname, "%s_secret_key", fname);
  255. tor_asprintf(&encrypted_secret_fname, "%s_secret_key_encrypted", fname);
  256. tor_asprintf(&public_fname, "%s_public_key", fname);
  257. tor_asprintf(&cert_fname, "%s_cert", fname);
  258. /* Try to read the secret key. */
  259. int have_secret = 0;
  260. if (try_to_load && (!omit_secret || file_status(public_fname)==FN_NOENT )) {
  261. int rv = ed25519_seckey_read_from_file(&keypair->seckey,
  262. &got_tag, secret_fname);
  263. if (rv == 0) {
  264. have_secret = 1;
  265. loaded_secret_fname = secret_fname;
  266. tor_assert(got_tag);
  267. } else {
  268. if (errno != ENOENT && norepair) {
  269. tor_log(severity, LD_OR, "Unable to read %s: %s", secret_fname,
  270. strerror(errno));
  271. goto err;
  272. }
  273. }
  274. }
  275. /* Should we try for an encrypted key? */
  276. int have_encrypted_secret_file = 0;
  277. if (!have_secret && try_to_load && encrypt_key) {
  278. int r = read_encrypted_secret_key(&keypair->seckey,
  279. encrypted_secret_fname);
  280. if (r > 0) {
  281. have_secret = 1;
  282. have_encrypted_secret_file = 1;
  283. got_tag = tor_strdup(tag);
  284. loaded_secret_fname = encrypted_secret_fname;
  285. } else if (errno != ENOENT && norepair) {
  286. tor_log(severity, LD_OR, "Unable to read %s: %s",
  287. encrypted_secret_fname, strerror(errno));
  288. goto err;
  289. }
  290. } else {
  291. if (try_to_load) {
  292. /* Check if it's there anyway, so we don't replace it. */
  293. if (file_status(encrypted_secret_fname) != FN_NOENT)
  294. have_encrypted_secret_file = 1;
  295. }
  296. }
  297. if (have_secret) {
  298. if (strcmp(got_tag, tag)) {
  299. tor_log(severity, LD_OR, "%s has wrong tag", loaded_secret_fname);
  300. goto err;
  301. }
  302. /* Derive the public key */
  303. if (ed25519_public_key_generate(&keypair->pubkey, &keypair->seckey)<0) {
  304. tor_log(severity, LD_OR, "%s can't produce a public key",
  305. loaded_secret_fname);
  306. goto err;
  307. }
  308. }
  309. /* If we do split keys here, try to read the pubkey. */
  310. int found_public = 0;
  311. if (try_to_load && (!have_secret || split)) {
  312. ed25519_public_key_t pubkey_tmp;
  313. tor_free(got_tag);
  314. found_public = ed25519_pubkey_read_from_file(&pubkey_tmp,
  315. &got_tag, public_fname) == 0;
  316. if (!found_public && errno != ENOENT && norepair) {
  317. tor_log(severity, LD_OR, "Unable to read %s: %s", public_fname,
  318. strerror(errno));
  319. goto err;
  320. }
  321. if (found_public && strcmp(got_tag, tag)) {
  322. tor_log(severity, LD_OR, "%s has wrong tag", public_fname);
  323. goto err;
  324. }
  325. if (found_public) {
  326. if (have_secret) {
  327. /* If we have a secret key and we're reloading the public key,
  328. * the key must match! */
  329. if (! ed25519_pubkey_eq(&keypair->pubkey, &pubkey_tmp)) {
  330. tor_log(severity, LD_OR, "%s does not match %s! If you are trying "
  331. "to restore from backup, make sure you didn't mix up the "
  332. "key files. If you are absolutely sure that %s is the right "
  333. "key for this relay, delete %s or move it out of the way.",
  334. public_fname, loaded_secret_fname,
  335. loaded_secret_fname, public_fname);
  336. goto err;
  337. }
  338. } else {
  339. /* We only have the public key; better use that. */
  340. tor_assert(split);
  341. memcpy(&keypair->pubkey, &pubkey_tmp, sizeof(pubkey_tmp));
  342. }
  343. } else {
  344. /* We have no public key file, but we do have a secret key, make the
  345. * public key file! */
  346. if (have_secret) {
  347. if (ed25519_pubkey_write_to_file(&keypair->pubkey, public_fname, tag)
  348. < 0) {
  349. tor_log(severity, LD_OR, "Couldn't repair %s", public_fname);
  350. goto err;
  351. } else {
  352. tor_log(LOG_NOTICE, LD_OR,
  353. "Found secret key but not %s. Regenerating.",
  354. public_fname);
  355. }
  356. }
  357. }
  358. }
  359. /* If the secret key is absent and it's not allowed to be, fail. */
  360. if (!have_secret && found_public &&
  361. !(flags & INIT_ED_KEY_MISSING_SECRET_OK)) {
  362. if (have_encrypted_secret_file) {
  363. tor_log(severity, LD_OR, "We needed to load a secret key from %s, "
  364. "but it was encrypted. Try 'tor --keygen' instead, so you "
  365. "can enter the passphrase.",
  366. secret_fname);
  367. } else {
  368. tor_log(severity, LD_OR, "We needed to load a secret key from %s, "
  369. "but couldn't find it. %s", secret_fname,
  370. (flags & INIT_ED_KEY_SUGGEST_KEYGEN) ?
  371. "If you're keeping your master secret key offline, you will "
  372. "need to run 'tor --keygen' to generate new signing keys." :
  373. "Did you forget to copy it over when you copied the rest of the "
  374. "signing key material?");
  375. }
  376. goto err;
  377. }
  378. /* If it's absent, and we're not supposed to make a new keypair, fail. */
  379. if (!have_secret && !found_public && !(flags & INIT_ED_KEY_CREATE)) {
  380. if (split) {
  381. tor_log(severity, LD_OR, "No key found in %s or %s.",
  382. secret_fname, public_fname);
  383. } else {
  384. tor_log(severity, LD_OR, "No key found in %s.", secret_fname);
  385. }
  386. goto err;
  387. }
  388. /* If the secret key is absent, but the encrypted key would be present,
  389. * that's an error */
  390. if (!have_secret && !found_public && have_encrypted_secret_file) {
  391. tor_assert(!encrypt_key);
  392. tor_log(severity, LD_OR, "Found an encrypted secret key, "
  393. "but not public key file %s!", public_fname);
  394. goto err;
  395. }
  396. /* if it's absent, make a new keypair and save it. */
  397. if (!have_secret && !found_public) {
  398. tor_free(keypair);
  399. keypair = ed_key_new(signing_key, flags, now, lifetime,
  400. cert_type, &cert);
  401. if (!keypair) {
  402. tor_log(severity, LD_OR, "Couldn't create keypair");
  403. goto err;
  404. }
  405. created_pk = created_sk = created_cert = 1;
  406. if (write_secret_key(&keypair->seckey,
  407. encrypt_key,
  408. secret_fname, tag, encrypted_secret_fname) < 0
  409. ||
  410. (split &&
  411. ed25519_pubkey_write_to_file(&keypair->pubkey, public_fname, tag) < 0)
  412. ||
  413. (cert &&
  414. crypto_write_tagged_contents_to_file(cert_fname, "ed25519v1-cert",
  415. tag, cert->encoded, cert->encoded_len) < 0)) {
  416. tor_log(severity, LD_OR, "Couldn't write keys or cert to file.");
  417. goto err;
  418. }
  419. goto done;
  420. }
  421. /* If we're not supposed to get a cert, we're done. */
  422. if (! (flags & INIT_ED_KEY_NEEDCERT))
  423. goto done;
  424. /* Read a cert. */
  425. tor_free(got_tag);
  426. uint8_t certbuf[256];
  427. ssize_t cert_body_len = crypto_read_tagged_contents_from_file(
  428. cert_fname, "ed25519v1-cert",
  429. &got_tag, certbuf, sizeof(certbuf));
  430. if (cert_body_len >= 0 && !strcmp(got_tag, tag))
  431. cert = tor_cert_parse(certbuf, cert_body_len);
  432. /* If we got it, check it to the extent we can. */
  433. int bad_cert = 0;
  434. if (! cert) {
  435. tor_log(severity, LD_OR, "Cert was unparseable");
  436. bad_cert = 1;
  437. } else if (!tor_memeq(cert->signed_key.pubkey, keypair->pubkey.pubkey,
  438. ED25519_PUBKEY_LEN)) {
  439. tor_log(severity, LD_OR, "Cert was for wrong key");
  440. bad_cert = 1;
  441. } else if (signing_key &&
  442. tor_cert_checksig(cert, &signing_key->pubkey, now) < 0) {
  443. tor_log(severity, LD_OR, "Can't check certificate");
  444. bad_cert = 1;
  445. } else if (cert->cert_expired) {
  446. tor_log(severity, LD_OR, "Certificate is expired");
  447. bad_cert = 1;
  448. } else if (signing_key && cert->signing_key_included &&
  449. ! ed25519_pubkey_eq(&signing_key->pubkey, &cert->signing_key)) {
  450. tor_log(severity, LD_OR, "Certificate signed by unexpectd key!");
  451. bad_cert = 1;
  452. }
  453. if (bad_cert) {
  454. tor_cert_free(cert);
  455. cert = NULL;
  456. }
  457. /* If we got a cert, we're done. */
  458. if (cert)
  459. goto done;
  460. /* If we didn't get a cert, and we're not supposed to make one, fail. */
  461. if (!signing_key || !(flags & INIT_ED_KEY_CREATE)) {
  462. tor_log(severity, LD_OR, "Without signing key, can't create certificate");
  463. goto err;
  464. }
  465. /* We have keys but not a certificate, so make one. */
  466. uint32_t cert_flags = 0;
  467. if (flags & INIT_ED_KEY_INCLUDE_SIGNING_KEY_IN_CERT)
  468. cert_flags |= CERT_FLAG_INCLUDE_SIGNING_KEY;
  469. cert = tor_cert_create(signing_key, cert_type,
  470. &keypair->pubkey,
  471. now, lifetime,
  472. cert_flags);
  473. if (! cert) {
  474. tor_log(severity, LD_OR, "Couldn't create certificate");
  475. goto err;
  476. }
  477. /* Write it to disk. */
  478. created_cert = 1;
  479. if (crypto_write_tagged_contents_to_file(cert_fname, "ed25519v1-cert",
  480. tag, cert->encoded, cert->encoded_len) < 0) {
  481. tor_log(severity, LD_OR, "Couldn't write cert to disk.");
  482. goto err;
  483. }
  484. done:
  485. if (cert_out)
  486. *cert_out = cert;
  487. else
  488. tor_cert_free(cert);
  489. goto cleanup;
  490. err:
  491. if (keypair)
  492. memwipe(keypair, 0, sizeof(*keypair));
  493. tor_free(keypair);
  494. tor_cert_free(cert);
  495. if (cert_out)
  496. *cert_out = NULL;
  497. if (created_sk)
  498. unlink(secret_fname);
  499. if (created_pk)
  500. unlink(public_fname);
  501. if (created_cert)
  502. unlink(cert_fname);
  503. cleanup:
  504. tor_free(encrypted_secret_fname);
  505. tor_free(secret_fname);
  506. tor_free(public_fname);
  507. tor_free(cert_fname);
  508. tor_free(got_tag);
  509. return keypair;
  510. }
  511. /**
  512. * Create a new signing key and (optionally) certficiate; do not read or write
  513. * from disk. See ed_key_init_from_file() for more information.
  514. */
  515. ed25519_keypair_t *
  516. ed_key_new(const ed25519_keypair_t *signing_key,
  517. uint32_t flags,
  518. time_t now,
  519. time_t lifetime,
  520. uint8_t cert_type,
  521. struct tor_cert_st **cert_out)
  522. {
  523. if (cert_out)
  524. *cert_out = NULL;
  525. const int extra_strong = !! (flags & INIT_ED_KEY_EXTRA_STRONG);
  526. ed25519_keypair_t *keypair = tor_malloc_zero(sizeof(ed25519_keypair_t));
  527. if (ed25519_keypair_generate(keypair, extra_strong) < 0)
  528. goto err;
  529. if (! (flags & INIT_ED_KEY_NEEDCERT))
  530. return keypair;
  531. tor_assert(signing_key);
  532. tor_assert(cert_out);
  533. uint32_t cert_flags = 0;
  534. if (flags & INIT_ED_KEY_INCLUDE_SIGNING_KEY_IN_CERT)
  535. cert_flags |= CERT_FLAG_INCLUDE_SIGNING_KEY;
  536. tor_cert_t *cert = tor_cert_create(signing_key, cert_type,
  537. &keypair->pubkey,
  538. now, lifetime,
  539. cert_flags);
  540. if (! cert)
  541. goto err;
  542. *cert_out = cert;
  543. return keypair;
  544. err:
  545. tor_free(keypair);
  546. return NULL;
  547. }
  548. static ed25519_keypair_t *master_identity_key = NULL;
  549. static ed25519_keypair_t *master_signing_key = NULL;
  550. static ed25519_keypair_t *current_auth_key = NULL;
  551. static tor_cert_t *signing_key_cert = NULL;
  552. static tor_cert_t *link_cert_cert = NULL;
  553. static tor_cert_t *auth_key_cert = NULL;
  554. static uint8_t *rsa_ed_crosscert = NULL;
  555. static size_t rsa_ed_crosscert_len = 0;
  556. /**
  557. * Running as a server: load, reload, or refresh our ed25519 keys and
  558. * certificates, creating and saving new ones as needed.
  559. */
  560. int
  561. load_ed_keys(const or_options_t *options, time_t now)
  562. {
  563. ed25519_keypair_t *id = NULL;
  564. ed25519_keypair_t *sign = NULL;
  565. ed25519_keypair_t *auth = NULL;
  566. const ed25519_keypair_t *sign_signing_key_with_id = NULL;
  567. const ed25519_keypair_t *use_signing = NULL;
  568. const tor_cert_t *check_signing_cert = NULL;
  569. tor_cert_t *sign_cert = NULL;
  570. tor_cert_t *auth_cert = NULL;
  571. #define FAIL(msg) do { \
  572. log_warn(LD_OR, (msg)); \
  573. goto err; \
  574. } while (0)
  575. #define SET_KEY(key, newval) do { \
  576. if ((key) != (newval)) \
  577. ed25519_keypair_free(key); \
  578. key = (newval); \
  579. } while (0)
  580. #define SET_CERT(cert, newval) do { \
  581. if ((cert) != (newval)) \
  582. tor_cert_free(cert); \
  583. cert = (newval); \
  584. } while (0)
  585. #define EXPIRES_SOON(cert, interval) \
  586. (!(cert) || (cert)->valid_until < now + (interval))
  587. /* XXXX support encrypted identity keys fully */
  588. /* First try to get the signing key to see how it is. */
  589. {
  590. char *fname =
  591. options_get_datadir_fname2(options, "keys", "ed25519_signing");
  592. sign = ed_key_init_from_file(
  593. fname,
  594. INIT_ED_KEY_NEEDCERT|
  595. INIT_ED_KEY_INCLUDE_SIGNING_KEY_IN_CERT,
  596. LOG_INFO,
  597. NULL, 0, 0, CERT_TYPE_ID_SIGNING, &sign_cert);
  598. tor_free(fname);
  599. check_signing_cert = sign_cert;
  600. use_signing = sign;
  601. }
  602. if (!use_signing && master_signing_key) {
  603. check_signing_cert = signing_key_cert;
  604. use_signing = master_signing_key;
  605. }
  606. const int need_new_signing_key =
  607. NULL == use_signing ||
  608. EXPIRES_SOON(check_signing_cert, 0) ||
  609. options->command == CMD_KEYGEN;
  610. const int want_new_signing_key =
  611. need_new_signing_key ||
  612. EXPIRES_SOON(check_signing_cert, options->TestingSigningKeySlop);
  613. if (need_new_signing_key) {
  614. log_notice(LD_OR, "It looks like I need to generate and sign a new "
  615. "medium-term signing key, because %s. To do that, I need to "
  616. "load (or create) the permanent master identity key.",
  617. (NULL == use_signing) ? "I don't have one" :
  618. EXPIRES_SOON(check_signing_cert, 0) ? "the one I have is expired" :
  619. "you asked me to make one with --keygen");
  620. } else if (want_new_signing_key) {
  621. log_notice(LD_OR, "It looks like I should try to generate and sign a "
  622. "new medium-term signing key, because the one I have is "
  623. "going to expire soon. To do that, I'm going to have to try to "
  624. "load the permanent master identity key.");
  625. }
  626. {
  627. uint32_t flags =
  628. (INIT_ED_KEY_SPLIT|
  629. INIT_ED_KEY_EXTRA_STRONG|INIT_ED_KEY_NO_REPAIR);
  630. if (! use_signing)
  631. flags |= INIT_ED_KEY_CREATE;
  632. if (! need_new_signing_key)
  633. flags |= INIT_ED_KEY_MISSING_SECRET_OK;
  634. if (! want_new_signing_key)
  635. flags |= INIT_ED_KEY_OMIT_SECRET;
  636. if (options->command == CMD_KEYGEN)
  637. flags |= INIT_ED_KEY_TRY_ENCRYPTED;
  638. /* Check the key directory */
  639. if (check_private_dir(options->DataDirectory, CPD_CREATE, options->User)) {
  640. log_err(LD_OR, "Can't create/check datadirectory %s",
  641. options->DataDirectory);
  642. goto err;
  643. }
  644. char *fname = get_datadir_fname("keys");
  645. if (check_private_dir(fname, CPD_CREATE, options->User) < 0) {
  646. log_err(LD_OR, "Problem creating/checking key directory %s", fname);
  647. tor_free(fname);
  648. goto err;
  649. }
  650. tor_free(fname);
  651. fname = options_get_datadir_fname2(options, "keys", "ed25519_master_id");
  652. id = ed_key_init_from_file(
  653. fname,
  654. flags,
  655. LOG_WARN, NULL, 0, 0, 0, NULL);
  656. tor_free(fname);
  657. if (!id) {
  658. if (need_new_signing_key) {
  659. FAIL("Missing identity key");
  660. } else {
  661. log_warn(LD_OR, "Master public key was absent; inferring from "
  662. "public key in signing certificate and saving to disk.");
  663. tor_assert(check_signing_cert);
  664. id = tor_malloc_zero(sizeof(*id));
  665. memcpy(&id->pubkey, &check_signing_cert->signing_key,
  666. sizeof(ed25519_public_key_t));
  667. fname = options_get_datadir_fname2(options, "keys",
  668. "ed25519_master_id_public_key");
  669. if (ed25519_pubkey_write_to_file(&id->pubkey, fname, "type0") < 0) {
  670. log_warn(LD_OR, "Error while attempting to write master public key "
  671. "to disk");
  672. tor_free(fname);
  673. goto err;
  674. }
  675. tor_free(fname);
  676. }
  677. }
  678. if (tor_mem_is_zero((char*)id->seckey.seckey, sizeof(id->seckey)))
  679. sign_signing_key_with_id = NULL;
  680. else
  681. sign_signing_key_with_id = id;
  682. }
  683. if (master_identity_key &&
  684. !ed25519_pubkey_eq(&id->pubkey, &master_identity_key->pubkey)) {
  685. FAIL("Identity key on disk does not match key we loaded earlier!");
  686. }
  687. if (need_new_signing_key && NULL == sign_signing_key_with_id)
  688. FAIL("Can't load master key make a new signing key.");
  689. if (sign_cert) {
  690. if (! sign_cert->signing_key_included)
  691. FAIL("Loaded a signing cert with no key included!");
  692. if (! ed25519_pubkey_eq(&sign_cert->signing_key, &id->pubkey))
  693. FAIL("The signing cert we have was not signed with the master key "
  694. "we loaded!");
  695. if (tor_cert_checksig(sign_cert, &id->pubkey, 0) < 0)
  696. FAIL("The signing cert we loaded was not signed correctly!");
  697. }
  698. if (want_new_signing_key && sign_signing_key_with_id) {
  699. uint32_t flags = (INIT_ED_KEY_CREATE|
  700. INIT_ED_KEY_REPLACE|
  701. INIT_ED_KEY_EXTRA_STRONG|
  702. INIT_ED_KEY_NEEDCERT|
  703. INIT_ED_KEY_INCLUDE_SIGNING_KEY_IN_CERT);
  704. char *fname =
  705. options_get_datadir_fname2(options, "keys", "ed25519_signing");
  706. sign = ed_key_init_from_file(fname,
  707. flags, LOG_WARN,
  708. sign_signing_key_with_id, now,
  709. options->SigningKeyLifetime,
  710. CERT_TYPE_ID_SIGNING, &sign_cert);
  711. tor_free(fname);
  712. if (!sign)
  713. FAIL("Missing signing key");
  714. use_signing = sign;
  715. tor_assert(sign_cert->signing_key_included);
  716. tor_assert(ed25519_pubkey_eq(&sign_cert->signing_key, &id->pubkey));
  717. tor_assert(ed25519_pubkey_eq(&sign_cert->signed_key, &sign->pubkey));
  718. } else if (want_new_signing_key) {
  719. static ratelim_t missing_master = RATELIM_INIT(3600);
  720. log_fn_ratelim(&missing_master, LOG_WARN, LD_OR,
  721. "Signing key will expire soon, but I can't load the "
  722. "master key to sign a new one!");
  723. }
  724. tor_assert(use_signing);
  725. /* At this point we no longer need our secret identity key. So wipe
  726. * it, if we loaded it in the first place. */
  727. memwipe(id->seckey.seckey, 0, sizeof(id->seckey));
  728. if (options->command == CMD_KEYGEN)
  729. goto end;
  730. if (!rsa_ed_crosscert && server_mode(options)) {
  731. uint8_t *crosscert;
  732. ssize_t crosscert_len = tor_make_rsa_ed25519_crosscert(&id->pubkey,
  733. get_server_identity_key(),
  734. now+10*365*86400,/*XXXX*/
  735. &crosscert);
  736. rsa_ed_crosscert_len = crosscert_len;
  737. rsa_ed_crosscert = crosscert;
  738. }
  739. if (!current_auth_key ||
  740. EXPIRES_SOON(auth_key_cert, options->TestingAuthKeySlop)) {
  741. auth = ed_key_new(use_signing, INIT_ED_KEY_NEEDCERT,
  742. now,
  743. options->TestingAuthKeyLifetime,
  744. CERT_TYPE_SIGNING_AUTH, &auth_cert);
  745. if (!auth)
  746. FAIL("Can't create auth key");
  747. }
  748. /* We've generated or loaded everything. Put them in memory. */
  749. end:
  750. if (! master_identity_key) {
  751. SET_KEY(master_identity_key, id);
  752. } else {
  753. tor_free(id);
  754. }
  755. if (sign) {
  756. SET_KEY(master_signing_key, sign);
  757. SET_CERT(signing_key_cert, sign_cert);
  758. }
  759. if (auth) {
  760. SET_KEY(current_auth_key, auth);
  761. SET_CERT(auth_key_cert, auth_cert);
  762. }
  763. return 0;
  764. err:
  765. ed25519_keypair_free(id);
  766. ed25519_keypair_free(sign);
  767. ed25519_keypair_free(auth);
  768. tor_cert_free(sign_cert);
  769. tor_cert_free(auth_cert);
  770. return -1;
  771. }
  772. /**DOCDOC*/
  773. int
  774. generate_ed_link_cert(const or_options_t *options, time_t now)
  775. {
  776. const tor_x509_cert_t *link = NULL, *id = NULL;
  777. tor_cert_t *link_cert = NULL;
  778. if (tor_tls_get_my_certs(1, &link, &id) < 0 || link == NULL) {
  779. log_warn(LD_OR, "Can't get my x509 link cert.");
  780. return -1;
  781. }
  782. const digests_t *digests = tor_x509_cert_get_cert_digests(link);
  783. if (link_cert_cert &&
  784. ! EXPIRES_SOON(link_cert_cert, options->TestingLinkKeySlop) &&
  785. fast_memeq(digests->d[DIGEST_SHA256], link_cert_cert->signed_key.pubkey,
  786. DIGEST256_LEN)) {
  787. return 0;
  788. }
  789. ed25519_public_key_t dummy_key;
  790. memcpy(dummy_key.pubkey, digests->d[DIGEST_SHA256], DIGEST256_LEN);
  791. link_cert = tor_cert_create(get_master_signing_keypair(),
  792. CERT_TYPE_SIGNING_LINK,
  793. &dummy_key,
  794. now,
  795. options->TestingLinkCertLifetime, 0);
  796. if (link_cert) {
  797. SET_CERT(link_cert_cert, link_cert);
  798. }
  799. return 0;
  800. }
  801. #undef FAIL
  802. #undef SET_KEY
  803. #undef SET_CERT
  804. int
  805. should_make_new_ed_keys(const or_options_t *options, const time_t now)
  806. {
  807. if (!master_identity_key ||
  808. !master_signing_key ||
  809. !current_auth_key ||
  810. !link_cert_cert ||
  811. EXPIRES_SOON(signing_key_cert, options->TestingSigningKeySlop) ||
  812. EXPIRES_SOON(auth_key_cert, options->TestingAuthKeySlop) ||
  813. EXPIRES_SOON(link_cert_cert, options->TestingLinkKeySlop))
  814. return 1;
  815. const tor_x509_cert_t *link = NULL, *id = NULL;
  816. if (tor_tls_get_my_certs(1, &link, &id) < 0 || link == NULL)
  817. return 1;
  818. const digests_t *digests = tor_x509_cert_get_cert_digests(link);
  819. if (!fast_memeq(digests->d[DIGEST_SHA256],
  820. link_cert_cert->signed_key.pubkey,
  821. DIGEST256_LEN)) {
  822. return 1;
  823. }
  824. return 0;
  825. }
  826. #undef EXPIRES_SOON
  827. const ed25519_public_key_t *
  828. get_master_identity_key(void)
  829. {
  830. if (!master_identity_key)
  831. return NULL;
  832. return &master_identity_key->pubkey;
  833. }
  834. const ed25519_keypair_t *
  835. get_master_signing_keypair(void)
  836. {
  837. return master_signing_key;
  838. }
  839. const struct tor_cert_st *
  840. get_master_signing_key_cert(void)
  841. {
  842. return signing_key_cert;
  843. }
  844. const ed25519_keypair_t *
  845. get_current_auth_keypair(void)
  846. {
  847. return current_auth_key;
  848. }
  849. const tor_cert_t *
  850. get_current_link_cert_cert(void)
  851. {
  852. return link_cert_cert;
  853. }
  854. const tor_cert_t *
  855. get_current_auth_key_cert(void)
  856. {
  857. return auth_key_cert;
  858. }
  859. void
  860. get_master_rsa_crosscert(const uint8_t **cert_out,
  861. size_t *size_out)
  862. {
  863. *cert_out = rsa_ed_crosscert;
  864. *size_out = rsa_ed_crosscert_len;
  865. }
  866. /** Construct cross-certification for the master identity key with
  867. * the ntor onion key. Store the sign of the corresponding ed25519 public key
  868. * in *<b>sign_out</b>. */
  869. tor_cert_t *
  870. make_ntor_onion_key_crosscert(const curve25519_keypair_t *onion_key,
  871. const ed25519_public_key_t *master_id_key, time_t now, time_t lifetime,
  872. int *sign_out)
  873. {
  874. tor_cert_t *cert = NULL;
  875. ed25519_keypair_t ed_onion_key;
  876. if (ed25519_keypair_from_curve25519_keypair(&ed_onion_key, sign_out,
  877. onion_key) < 0)
  878. goto end;
  879. cert = tor_cert_create(&ed_onion_key, CERT_TYPE_ONION_ID, master_id_key,
  880. now, lifetime, 0);
  881. end:
  882. memwipe(&ed_onion_key, 0, sizeof(ed_onion_key));
  883. return cert;
  884. }
  885. /** Construct and return an RSA signature for the TAP onion key to
  886. * cross-certify the RSA and Ed25519 identity keys. Set <b>len_out</b> to its
  887. * length. */
  888. uint8_t *
  889. make_tap_onion_key_crosscert(const crypto_pk_t *onion_key,
  890. const ed25519_public_key_t *master_id_key,
  891. const crypto_pk_t *rsa_id_key,
  892. int *len_out)
  893. {
  894. uint8_t signature[PK_BYTES];
  895. uint8_t signed_data[DIGEST_LEN + ED25519_PUBKEY_LEN];
  896. *len_out = 0;
  897. crypto_pk_get_digest(rsa_id_key, (char*)signed_data);
  898. memcpy(signed_data + DIGEST_LEN, master_id_key->pubkey, ED25519_PUBKEY_LEN);
  899. int r = crypto_pk_private_sign(onion_key,
  900. (char*)signature, sizeof(signature),
  901. (const char*)signed_data, sizeof(signed_data));
  902. if (r < 0)
  903. return NULL;
  904. *len_out = r;
  905. return tor_memdup(signature, r);
  906. }
  907. /** Check whether an RSA-TAP cross-certification is correct. Return 0 if it
  908. * is, -1 if it isn't. */
  909. int
  910. check_tap_onion_key_crosscert(const uint8_t *crosscert,
  911. int crosscert_len,
  912. const crypto_pk_t *onion_pkey,
  913. const ed25519_public_key_t *master_id_pkey,
  914. const uint8_t *rsa_id_digest)
  915. {
  916. uint8_t *cc = tor_malloc(crypto_pk_keysize(onion_pkey));
  917. int cc_len =
  918. crypto_pk_public_checksig(onion_pkey,
  919. (char*)cc,
  920. crypto_pk_keysize(onion_pkey),
  921. (const char*)crosscert,
  922. crosscert_len);
  923. if (cc_len < 0) {
  924. goto err;
  925. }
  926. if (cc_len < DIGEST_LEN + ED25519_PUBKEY_LEN) {
  927. log_warn(LD_DIR, "Short signature on cross-certification with TAP key");
  928. goto err;
  929. }
  930. if (tor_memneq(cc, rsa_id_digest, DIGEST_LEN) ||
  931. tor_memneq(cc + DIGEST_LEN, master_id_pkey->pubkey,
  932. ED25519_PUBKEY_LEN)) {
  933. log_warn(LD_DIR, "Incorrect cross-certification with TAP key");
  934. goto err;
  935. }
  936. tor_free(cc);
  937. return 0;
  938. err:
  939. tor_free(cc);
  940. return -1;
  941. }
  942. void
  943. routerkeys_free_all(void)
  944. {
  945. ed25519_keypair_free(master_identity_key);
  946. ed25519_keypair_free(master_signing_key);
  947. ed25519_keypair_free(current_auth_key);
  948. tor_cert_free(signing_key_cert);
  949. tor_cert_free(link_cert_cert);
  950. tor_cert_free(auth_key_cert);
  951. master_identity_key = master_signing_key = NULL;
  952. current_auth_key = NULL;
  953. signing_key_cert = link_cert_cert = auth_key_cert = NULL;
  954. }