router.c 121 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640
  1. /* Copyright (c) 2001 Matej Pfajfar.
  2. * Copyright (c) 2001-2004, Roger Dingledine.
  3. * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  4. * Copyright (c) 2007-2016, The Tor Project, Inc. */
  5. /* See LICENSE for licensing information */
  6. #define ROUTER_PRIVATE
  7. #include "or.h"
  8. #include "circuitbuild.h"
  9. #include "circuitlist.h"
  10. #include "circuituse.h"
  11. #include "config.h"
  12. #include "connection.h"
  13. #include "control.h"
  14. #include "crypto_curve25519.h"
  15. #include "directory.h"
  16. #include "dirserv.h"
  17. #include "dns.h"
  18. #include "geoip.h"
  19. #include "hibernate.h"
  20. #include "main.h"
  21. #include "networkstatus.h"
  22. #include "nodelist.h"
  23. #include "policies.h"
  24. #include "protover.h"
  25. #include "relay.h"
  26. #include "rephist.h"
  27. #include "router.h"
  28. #include "routerkeys.h"
  29. #include "routerlist.h"
  30. #include "routerparse.h"
  31. #include "statefile.h"
  32. #include "torcert.h"
  33. #include "transports.h"
  34. #include "routerset.h"
  35. /**
  36. * \file router.c
  37. * \brief Miscellaneous relay functionality, including RSA key maintenance,
  38. * generating and uploading server descriptors, picking an address to
  39. * advertise, and so on.
  40. *
  41. * This module handles the job of deciding whether we are a Tor relay, and if
  42. * so what kind. (Mostly through functions like server_mode() that inspect an
  43. * or_options_t, but in some cases based on our own capabilities, such as when
  44. * we are deciding whether to be a directory cache in
  45. * router_has_bandwidth_to_be_dirserver().)
  46. *
  47. * Also in this module are the functions to generate our own routerinfo_t and
  48. * extrainfo_t, and to encode those to signed strings for upload to the
  49. * directory authorities.
  50. *
  51. * This module also handles key maintenance for RSA and Curve25519-ntor keys,
  52. * and for our TLS context. (These functions should eventually move to
  53. * routerkeys.c along with the code that handles Ed25519 keys now.)
  54. **/
  55. /************************************************************/
  56. /*****
  57. * Key management: ORs only.
  58. *****/
  59. /** Private keys for this OR. There is also an SSL key managed by tortls.c.
  60. */
  61. static tor_mutex_t *key_lock=NULL;
  62. static time_t onionkey_set_at=0; /**< When was onionkey last changed? */
  63. /** Current private onionskin decryption key: used to decode CREATE cells. */
  64. static crypto_pk_t *onionkey=NULL;
  65. /** Previous private onionskin decryption key: used to decode CREATE cells
  66. * generated by clients that have an older version of our descriptor. */
  67. static crypto_pk_t *lastonionkey=NULL;
  68. /** Current private ntor secret key: used to perform the ntor handshake. */
  69. static curve25519_keypair_t curve25519_onion_key;
  70. /** Previous private ntor secret key: used to perform the ntor handshake
  71. * with clients that have an older version of our descriptor. */
  72. static curve25519_keypair_t last_curve25519_onion_key;
  73. /** Private server "identity key": used to sign directory info and TLS
  74. * certificates. Never changes. */
  75. static crypto_pk_t *server_identitykey=NULL;
  76. /** Digest of server_identitykey. */
  77. static char server_identitykey_digest[DIGEST_LEN];
  78. /** Private client "identity key": used to sign bridges' and clients'
  79. * outbound TLS certificates. Regenerated on startup and on IP address
  80. * change. */
  81. static crypto_pk_t *client_identitykey=NULL;
  82. /** Signing key used for v3 directory material; only set for authorities. */
  83. static crypto_pk_t *authority_signing_key = NULL;
  84. /** Key certificate to authenticate v3 directory material; only set for
  85. * authorities. */
  86. static authority_cert_t *authority_key_certificate = NULL;
  87. /** For emergency V3 authority key migration: An extra signing key that we use
  88. * with our old (obsolete) identity key for a while. */
  89. static crypto_pk_t *legacy_signing_key = NULL;
  90. /** For emergency V3 authority key migration: An extra certificate to
  91. * authenticate legacy_signing_key with our obsolete identity key.*/
  92. static authority_cert_t *legacy_key_certificate = NULL;
  93. /* (Note that v3 authorities also have a separate "authority identity key",
  94. * but this key is never actually loaded by the Tor process. Instead, it's
  95. * used by tor-gencert to sign new signing keys and make new key
  96. * certificates. */
  97. /** Replace the current onion key with <b>k</b>. Does not affect
  98. * lastonionkey; to update lastonionkey correctly, call rotate_onion_key().
  99. */
  100. static void
  101. set_onion_key(crypto_pk_t *k)
  102. {
  103. if (onionkey && crypto_pk_eq_keys(onionkey, k)) {
  104. /* k is already our onion key; free it and return */
  105. crypto_pk_free(k);
  106. return;
  107. }
  108. tor_mutex_acquire(key_lock);
  109. crypto_pk_free(onionkey);
  110. onionkey = k;
  111. tor_mutex_release(key_lock);
  112. mark_my_descriptor_dirty("set onion key");
  113. }
  114. /** Return the current onion key. Requires that the onion key has been
  115. * loaded or generated. */
  116. crypto_pk_t *
  117. get_onion_key(void)
  118. {
  119. tor_assert(onionkey);
  120. return onionkey;
  121. }
  122. /** Store a full copy of the current onion key into *<b>key</b>, and a full
  123. * copy of the most recent onion key into *<b>last</b>.
  124. */
  125. void
  126. dup_onion_keys(crypto_pk_t **key, crypto_pk_t **last)
  127. {
  128. tor_assert(key);
  129. tor_assert(last);
  130. tor_mutex_acquire(key_lock);
  131. tor_assert(onionkey);
  132. *key = crypto_pk_copy_full(onionkey);
  133. if (lastonionkey)
  134. *last = crypto_pk_copy_full(lastonionkey);
  135. else
  136. *last = NULL;
  137. tor_mutex_release(key_lock);
  138. }
  139. /** Return the current secret onion key for the ntor handshake. Must only
  140. * be called from the main thread. */
  141. static const curve25519_keypair_t *
  142. get_current_curve25519_keypair(void)
  143. {
  144. return &curve25519_onion_key;
  145. }
  146. /** Return a map from KEYID (the key itself) to keypairs for use in the ntor
  147. * handshake. Must only be called from the main thread. */
  148. di_digest256_map_t *
  149. construct_ntor_key_map(void)
  150. {
  151. di_digest256_map_t *m = NULL;
  152. dimap_add_entry(&m,
  153. curve25519_onion_key.pubkey.public_key,
  154. tor_memdup(&curve25519_onion_key,
  155. sizeof(curve25519_keypair_t)));
  156. if (!tor_mem_is_zero((const char*)
  157. last_curve25519_onion_key.pubkey.public_key,
  158. CURVE25519_PUBKEY_LEN)) {
  159. dimap_add_entry(&m,
  160. last_curve25519_onion_key.pubkey.public_key,
  161. tor_memdup(&last_curve25519_onion_key,
  162. sizeof(curve25519_keypair_t)));
  163. }
  164. return m;
  165. }
  166. /** Helper used to deallocate a di_digest256_map_t returned by
  167. * construct_ntor_key_map. */
  168. static void
  169. ntor_key_map_free_helper(void *arg)
  170. {
  171. curve25519_keypair_t *k = arg;
  172. memwipe(k, 0, sizeof(*k));
  173. tor_free(k);
  174. }
  175. /** Release all storage from a keymap returned by construct_ntor_key_map. */
  176. void
  177. ntor_key_map_free(di_digest256_map_t *map)
  178. {
  179. if (!map)
  180. return;
  181. dimap_free(map, ntor_key_map_free_helper);
  182. }
  183. /** Return the time when the onion key was last set. This is either the time
  184. * when the process launched, or the time of the most recent key rotation since
  185. * the process launched.
  186. */
  187. time_t
  188. get_onion_key_set_at(void)
  189. {
  190. return onionkey_set_at;
  191. }
  192. /** Set the current server identity key to <b>k</b>.
  193. */
  194. void
  195. set_server_identity_key(crypto_pk_t *k)
  196. {
  197. crypto_pk_free(server_identitykey);
  198. server_identitykey = k;
  199. crypto_pk_get_digest(server_identitykey, server_identitykey_digest);
  200. }
  201. /** Make sure that we have set up our identity keys to match or not match as
  202. * appropriate, and die with an assertion if we have not. */
  203. static void
  204. assert_identity_keys_ok(void)
  205. {
  206. if (1)
  207. return;
  208. tor_assert(client_identitykey);
  209. if (public_server_mode(get_options())) {
  210. /* assert that we have set the client and server keys to be equal */
  211. tor_assert(server_identitykey);
  212. tor_assert(crypto_pk_eq_keys(client_identitykey, server_identitykey));
  213. } else {
  214. /* assert that we have set the client and server keys to be unequal */
  215. if (server_identitykey)
  216. tor_assert(!crypto_pk_eq_keys(client_identitykey, server_identitykey));
  217. }
  218. }
  219. /** Returns the current server identity key; requires that the key has
  220. * been set, and that we are running as a Tor server.
  221. */
  222. crypto_pk_t *
  223. get_server_identity_key(void)
  224. {
  225. tor_assert(server_identitykey);
  226. tor_assert(server_mode(get_options()));
  227. assert_identity_keys_ok();
  228. return server_identitykey;
  229. }
  230. /** Return true iff we are a server and the server identity key
  231. * has been set. */
  232. int
  233. server_identity_key_is_set(void)
  234. {
  235. return server_mode(get_options()) && server_identitykey != NULL;
  236. }
  237. /** Set the current client identity key to <b>k</b>.
  238. */
  239. void
  240. set_client_identity_key(crypto_pk_t *k)
  241. {
  242. crypto_pk_free(client_identitykey);
  243. client_identitykey = k;
  244. }
  245. /** Returns the current client identity key for use on outgoing TLS
  246. * connections; requires that the key has been set.
  247. */
  248. crypto_pk_t *
  249. get_tlsclient_identity_key(void)
  250. {
  251. tor_assert(client_identitykey);
  252. assert_identity_keys_ok();
  253. return client_identitykey;
  254. }
  255. /** Return true iff the client identity key has been set. */
  256. int
  257. client_identity_key_is_set(void)
  258. {
  259. return client_identitykey != NULL;
  260. }
  261. /** Return the key certificate for this v3 (voting) authority, or NULL
  262. * if we have no such certificate. */
  263. MOCK_IMPL(authority_cert_t *,
  264. get_my_v3_authority_cert, (void))
  265. {
  266. return authority_key_certificate;
  267. }
  268. /** Return the v3 signing key for this v3 (voting) authority, or NULL
  269. * if we have no such key. */
  270. crypto_pk_t *
  271. get_my_v3_authority_signing_key(void)
  272. {
  273. return authority_signing_key;
  274. }
  275. /** If we're an authority, and we're using a legacy authority identity key for
  276. * emergency migration purposes, return the certificate associated with that
  277. * key. */
  278. authority_cert_t *
  279. get_my_v3_legacy_cert(void)
  280. {
  281. return legacy_key_certificate;
  282. }
  283. /** If we're an authority, and we're using a legacy authority identity key for
  284. * emergency migration purposes, return that key. */
  285. crypto_pk_t *
  286. get_my_v3_legacy_signing_key(void)
  287. {
  288. return legacy_signing_key;
  289. }
  290. /** Replace the previous onion key with the current onion key, and generate
  291. * a new previous onion key. Immediately after calling this function,
  292. * the OR should:
  293. * - schedule all previous cpuworkers to shut down _after_ processing
  294. * pending work. (This will cause fresh cpuworkers to be generated.)
  295. * - generate and upload a fresh routerinfo.
  296. */
  297. void
  298. rotate_onion_key(void)
  299. {
  300. char *fname, *fname_prev;
  301. crypto_pk_t *prkey = NULL;
  302. or_state_t *state = get_or_state();
  303. curve25519_keypair_t new_curve25519_keypair;
  304. time_t now;
  305. fname = get_datadir_fname2("keys", "secret_onion_key");
  306. fname_prev = get_datadir_fname2("keys", "secret_onion_key.old");
  307. /* There isn't much point replacing an old key with an empty file */
  308. if (file_status(fname) == FN_FILE) {
  309. if (replace_file(fname, fname_prev))
  310. goto error;
  311. }
  312. if (!(prkey = crypto_pk_new())) {
  313. log_err(LD_GENERAL,"Error constructing rotated onion key");
  314. goto error;
  315. }
  316. if (crypto_pk_generate_key(prkey)) {
  317. log_err(LD_BUG,"Error generating onion key");
  318. goto error;
  319. }
  320. if (crypto_pk_write_private_key_to_filename(prkey, fname)) {
  321. log_err(LD_FS,"Couldn't write generated onion key to \"%s\".", fname);
  322. goto error;
  323. }
  324. tor_free(fname);
  325. tor_free(fname_prev);
  326. fname = get_datadir_fname2("keys", "secret_onion_key_ntor");
  327. fname_prev = get_datadir_fname2("keys", "secret_onion_key_ntor.old");
  328. if (curve25519_keypair_generate(&new_curve25519_keypair, 1) < 0)
  329. goto error;
  330. /* There isn't much point replacing an old key with an empty file */
  331. if (file_status(fname) == FN_FILE) {
  332. if (replace_file(fname, fname_prev))
  333. goto error;
  334. }
  335. if (curve25519_keypair_write_to_file(&new_curve25519_keypair, fname,
  336. "onion") < 0) {
  337. log_err(LD_FS,"Couldn't write curve25519 onion key to \"%s\".",fname);
  338. goto error;
  339. }
  340. log_info(LD_GENERAL, "Rotating onion key");
  341. tor_mutex_acquire(key_lock);
  342. crypto_pk_free(lastonionkey);
  343. lastonionkey = onionkey;
  344. onionkey = prkey;
  345. memcpy(&last_curve25519_onion_key, &curve25519_onion_key,
  346. sizeof(curve25519_keypair_t));
  347. memcpy(&curve25519_onion_key, &new_curve25519_keypair,
  348. sizeof(curve25519_keypair_t));
  349. now = time(NULL);
  350. state->LastRotatedOnionKey = onionkey_set_at = now;
  351. tor_mutex_release(key_lock);
  352. mark_my_descriptor_dirty("rotated onion key");
  353. or_state_mark_dirty(state, get_options()->AvoidDiskWrites ? now+3600 : 0);
  354. goto done;
  355. error:
  356. log_warn(LD_GENERAL, "Couldn't rotate onion key.");
  357. if (prkey)
  358. crypto_pk_free(prkey);
  359. done:
  360. memwipe(&new_curve25519_keypair, 0, sizeof(new_curve25519_keypair));
  361. tor_free(fname);
  362. tor_free(fname_prev);
  363. }
  364. /** Log greeting message that points to new relay lifecycle document the
  365. * first time this function has been called.
  366. */
  367. static void
  368. log_new_relay_greeting(void)
  369. {
  370. static int already_logged = 0;
  371. if (already_logged)
  372. return;
  373. tor_log(LOG_NOTICE, LD_GENERAL, "You are running a new relay. "
  374. "Thanks for helping the Tor network! If you wish to know "
  375. "what will happen in the upcoming weeks regarding its usage, "
  376. "have a look at https://blog.torproject.org/blog/lifecycle-of"
  377. "-a-new-relay");
  378. already_logged = 1;
  379. }
  380. /** Try to read an RSA key from <b>fname</b>. If <b>fname</b> doesn't exist
  381. * and <b>generate</b> is true, create a new RSA key and save it in
  382. * <b>fname</b>. Return the read/created key, or NULL on error. Log all
  383. * errors at level <b>severity</b>. If <b>log_greeting</b> is non-zero and a
  384. * new key was created, log_new_relay_greeting() is called.
  385. */
  386. crypto_pk_t *
  387. init_key_from_file(const char *fname, int generate, int severity,
  388. int log_greeting)
  389. {
  390. crypto_pk_t *prkey = NULL;
  391. if (!(prkey = crypto_pk_new())) {
  392. tor_log(severity, LD_GENERAL,"Error constructing key");
  393. goto error;
  394. }
  395. switch (file_status(fname)) {
  396. case FN_DIR:
  397. case FN_ERROR:
  398. tor_log(severity, LD_FS,"Can't read key from \"%s\"", fname);
  399. goto error;
  400. /* treat empty key files as if the file doesn't exist, and,
  401. * if generate is set, replace the empty file in
  402. * crypto_pk_write_private_key_to_filename() */
  403. case FN_NOENT:
  404. case FN_EMPTY:
  405. if (generate) {
  406. if (!have_lockfile()) {
  407. if (try_locking(get_options(), 0)<0) {
  408. /* Make sure that --list-fingerprint only creates new keys
  409. * if there is no possibility for a deadlock. */
  410. tor_log(severity, LD_FS, "Another Tor process has locked \"%s\". "
  411. "Not writing any new keys.", fname);
  412. /*XXXX The 'other process' might make a key in a second or two;
  413. * maybe we should wait for it. */
  414. goto error;
  415. }
  416. }
  417. log_info(LD_GENERAL, "No key found in \"%s\"; generating fresh key.",
  418. fname);
  419. if (crypto_pk_generate_key(prkey)) {
  420. tor_log(severity, LD_GENERAL,"Error generating onion key");
  421. goto error;
  422. }
  423. if (crypto_pk_check_key(prkey) <= 0) {
  424. tor_log(severity, LD_GENERAL,"Generated key seems invalid");
  425. goto error;
  426. }
  427. log_info(LD_GENERAL, "Generated key seems valid");
  428. if (log_greeting) {
  429. log_new_relay_greeting();
  430. }
  431. if (crypto_pk_write_private_key_to_filename(prkey, fname)) {
  432. tor_log(severity, LD_FS,
  433. "Couldn't write generated key to \"%s\".", fname);
  434. goto error;
  435. }
  436. } else {
  437. tor_log(severity, LD_GENERAL, "No key found in \"%s\"", fname);
  438. goto error;
  439. }
  440. return prkey;
  441. case FN_FILE:
  442. if (crypto_pk_read_private_key_from_filename(prkey, fname)) {
  443. tor_log(severity, LD_GENERAL,"Error loading private key.");
  444. goto error;
  445. }
  446. return prkey;
  447. default:
  448. tor_assert(0);
  449. }
  450. error:
  451. if (prkey)
  452. crypto_pk_free(prkey);
  453. return NULL;
  454. }
  455. /** Load a curve25519 keypair from the file <b>fname</b>, writing it into
  456. * <b>keys_out</b>. If the file isn't found, or is empty, and <b>generate</b>
  457. * is true, create a new keypair and write it into the file. If there are
  458. * errors, log them at level <b>severity</b>. Generate files using <b>tag</b>
  459. * in their ASCII wrapper. */
  460. static int
  461. init_curve25519_keypair_from_file(curve25519_keypair_t *keys_out,
  462. const char *fname,
  463. int generate,
  464. int severity,
  465. const char *tag)
  466. {
  467. switch (file_status(fname)) {
  468. case FN_DIR:
  469. case FN_ERROR:
  470. tor_log(severity, LD_FS,"Can't read key from \"%s\"", fname);
  471. goto error;
  472. /* treat empty key files as if the file doesn't exist, and, if generate
  473. * is set, replace the empty file in curve25519_keypair_write_to_file() */
  474. case FN_NOENT:
  475. case FN_EMPTY:
  476. if (generate) {
  477. if (!have_lockfile()) {
  478. if (try_locking(get_options(), 0)<0) {
  479. /* Make sure that --list-fingerprint only creates new keys
  480. * if there is no possibility for a deadlock. */
  481. tor_log(severity, LD_FS, "Another Tor process has locked \"%s\". "
  482. "Not writing any new keys.", fname);
  483. /*XXXX The 'other process' might make a key in a second or two;
  484. * maybe we should wait for it. */
  485. goto error;
  486. }
  487. }
  488. log_info(LD_GENERAL, "No key found in \"%s\"; generating fresh key.",
  489. fname);
  490. if (curve25519_keypair_generate(keys_out, 1) < 0)
  491. goto error;
  492. if (curve25519_keypair_write_to_file(keys_out, fname, tag)<0) {
  493. tor_log(severity, LD_FS,
  494. "Couldn't write generated key to \"%s\".", fname);
  495. memwipe(keys_out, 0, sizeof(*keys_out));
  496. goto error;
  497. }
  498. } else {
  499. log_info(LD_GENERAL, "No key found in \"%s\"", fname);
  500. }
  501. return 0;
  502. case FN_FILE:
  503. {
  504. char *tag_in=NULL;
  505. if (curve25519_keypair_read_from_file(keys_out, &tag_in, fname) < 0) {
  506. tor_log(severity, LD_GENERAL,"Error loading private key.");
  507. tor_free(tag_in);
  508. goto error;
  509. }
  510. if (!tag_in || strcmp(tag_in, tag)) {
  511. tor_log(severity, LD_GENERAL,"Unexpected tag %s on private key.",
  512. escaped(tag_in));
  513. tor_free(tag_in);
  514. goto error;
  515. }
  516. tor_free(tag_in);
  517. return 0;
  518. }
  519. default:
  520. tor_assert(0);
  521. }
  522. error:
  523. return -1;
  524. }
  525. /** Try to load the vote-signing private key and certificate for being a v3
  526. * directory authority, and make sure they match. If <b>legacy</b>, load a
  527. * legacy key/cert set for emergency key migration; otherwise load the regular
  528. * key/cert set. On success, store them into *<b>key_out</b> and
  529. * *<b>cert_out</b> respectively, and return 0. On failure, return -1. */
  530. static int
  531. load_authority_keyset(int legacy, crypto_pk_t **key_out,
  532. authority_cert_t **cert_out)
  533. {
  534. int r = -1;
  535. char *fname = NULL, *cert = NULL;
  536. const char *eos = NULL;
  537. crypto_pk_t *signing_key = NULL;
  538. authority_cert_t *parsed = NULL;
  539. fname = get_datadir_fname2("keys",
  540. legacy ? "legacy_signing_key" : "authority_signing_key");
  541. signing_key = init_key_from_file(fname, 0, LOG_ERR, 0);
  542. if (!signing_key) {
  543. log_warn(LD_DIR, "No version 3 directory key found in %s", fname);
  544. goto done;
  545. }
  546. tor_free(fname);
  547. fname = get_datadir_fname2("keys",
  548. legacy ? "legacy_certificate" : "authority_certificate");
  549. cert = read_file_to_str(fname, 0, NULL);
  550. if (!cert) {
  551. log_warn(LD_DIR, "Signing key found, but no certificate found in %s",
  552. fname);
  553. goto done;
  554. }
  555. parsed = authority_cert_parse_from_string(cert, &eos);
  556. if (!parsed) {
  557. log_warn(LD_DIR, "Unable to parse certificate in %s", fname);
  558. goto done;
  559. }
  560. if (!crypto_pk_eq_keys(signing_key, parsed->signing_key)) {
  561. log_warn(LD_DIR, "Stored signing key does not match signing key in "
  562. "certificate");
  563. goto done;
  564. }
  565. crypto_pk_free(*key_out);
  566. authority_cert_free(*cert_out);
  567. *key_out = signing_key;
  568. *cert_out = parsed;
  569. r = 0;
  570. signing_key = NULL;
  571. parsed = NULL;
  572. done:
  573. tor_free(fname);
  574. tor_free(cert);
  575. crypto_pk_free(signing_key);
  576. authority_cert_free(parsed);
  577. return r;
  578. }
  579. /** Load the v3 (voting) authority signing key and certificate, if they are
  580. * present. Return -1 if anything is missing, mismatched, or unloadable;
  581. * return 0 on success. */
  582. static int
  583. init_v3_authority_keys(void)
  584. {
  585. if (load_authority_keyset(0, &authority_signing_key,
  586. &authority_key_certificate)<0)
  587. return -1;
  588. if (get_options()->V3AuthUseLegacyKey &&
  589. load_authority_keyset(1, &legacy_signing_key,
  590. &legacy_key_certificate)<0)
  591. return -1;
  592. return 0;
  593. }
  594. /** If we're a v3 authority, check whether we have a certificate that's
  595. * likely to expire soon. Warn if we do, but not too often. */
  596. void
  597. v3_authority_check_key_expiry(void)
  598. {
  599. time_t now, expires;
  600. static time_t last_warned = 0;
  601. int badness, time_left, warn_interval;
  602. if (!authdir_mode_v3(get_options()) || !authority_key_certificate)
  603. return;
  604. now = time(NULL);
  605. expires = authority_key_certificate->expires;
  606. time_left = (int)( expires - now );
  607. if (time_left <= 0) {
  608. badness = LOG_ERR;
  609. warn_interval = 60*60;
  610. } else if (time_left <= 24*60*60) {
  611. badness = LOG_WARN;
  612. warn_interval = 60*60;
  613. } else if (time_left <= 24*60*60*7) {
  614. badness = LOG_WARN;
  615. warn_interval = 24*60*60;
  616. } else if (time_left <= 24*60*60*30) {
  617. badness = LOG_WARN;
  618. warn_interval = 24*60*60*5;
  619. } else {
  620. return;
  621. }
  622. if (last_warned + warn_interval > now)
  623. return;
  624. if (time_left <= 0) {
  625. tor_log(badness, LD_DIR, "Your v3 authority certificate has expired."
  626. " Generate a new one NOW.");
  627. } else if (time_left <= 24*60*60) {
  628. tor_log(badness, LD_DIR, "Your v3 authority certificate expires in %d "
  629. "hours; Generate a new one NOW.", time_left/(60*60));
  630. } else {
  631. tor_log(badness, LD_DIR, "Your v3 authority certificate expires in %d "
  632. "days; Generate a new one soon.", time_left/(24*60*60));
  633. }
  634. last_warned = now;
  635. }
  636. /** Set up Tor's TLS contexts, based on our configuration and keys. Return 0
  637. * on success, and -1 on failure. */
  638. int
  639. router_initialize_tls_context(void)
  640. {
  641. unsigned int flags = 0;
  642. const or_options_t *options = get_options();
  643. int lifetime = options->SSLKeyLifetime;
  644. if (public_server_mode(options))
  645. flags |= TOR_TLS_CTX_IS_PUBLIC_SERVER;
  646. if (options->TLSECGroup) {
  647. if (!strcasecmp(options->TLSECGroup, "P256"))
  648. flags |= TOR_TLS_CTX_USE_ECDHE_P256;
  649. else if (!strcasecmp(options->TLSECGroup, "P224"))
  650. flags |= TOR_TLS_CTX_USE_ECDHE_P224;
  651. }
  652. if (!lifetime) { /* we should guess a good ssl cert lifetime */
  653. /* choose between 5 and 365 days, and round to the day */
  654. unsigned int five_days = 5*24*3600;
  655. unsigned int one_year = 365*24*3600;
  656. lifetime = crypto_rand_int_range(five_days, one_year);
  657. lifetime -= lifetime % (24*3600);
  658. if (crypto_rand_int(2)) {
  659. /* Half the time we expire at midnight, and half the time we expire
  660. * one second before midnight. (Some CAs wobble their expiry times a
  661. * bit in practice, perhaps to reduce collision attacks; see ticket
  662. * 8443 for details about observed certs in the wild.) */
  663. lifetime--;
  664. }
  665. }
  666. /* It's ok to pass lifetime in as an unsigned int, since
  667. * config_parse_interval() checked it. */
  668. return tor_tls_context_init(flags,
  669. get_tlsclient_identity_key(),
  670. server_mode(options) ?
  671. get_server_identity_key() : NULL,
  672. (unsigned int)lifetime);
  673. }
  674. /** Compute fingerprint (or hashed fingerprint if hashed is 1) and write
  675. * it to 'fingerprint' (or 'hashed-fingerprint'). Return 0 on success, or
  676. * -1 if Tor should die,
  677. */
  678. STATIC int
  679. router_write_fingerprint(int hashed)
  680. {
  681. char *keydir = NULL, *cp = NULL;
  682. const char *fname = hashed ? "hashed-fingerprint" :
  683. "fingerprint";
  684. char fingerprint[FINGERPRINT_LEN+1];
  685. const or_options_t *options = get_options();
  686. char *fingerprint_line = NULL;
  687. int result = -1;
  688. keydir = get_datadir_fname(fname);
  689. log_info(LD_GENERAL,"Dumping %sfingerprint to \"%s\"...",
  690. hashed ? "hashed " : "", keydir);
  691. if (!hashed) {
  692. if (crypto_pk_get_fingerprint(get_server_identity_key(),
  693. fingerprint, 0) < 0) {
  694. log_err(LD_GENERAL,"Error computing fingerprint");
  695. goto done;
  696. }
  697. } else {
  698. if (crypto_pk_get_hashed_fingerprint(get_server_identity_key(),
  699. fingerprint) < 0) {
  700. log_err(LD_GENERAL,"Error computing hashed fingerprint");
  701. goto done;
  702. }
  703. }
  704. tor_asprintf(&fingerprint_line, "%s %s\n", options->Nickname, fingerprint);
  705. /* Check whether we need to write the (hashed-)fingerprint file. */
  706. cp = read_file_to_str(keydir, RFTS_IGNORE_MISSING, NULL);
  707. if (!cp || strcmp(cp, fingerprint_line)) {
  708. if (write_str_to_file(keydir, fingerprint_line, 0)) {
  709. log_err(LD_FS, "Error writing %sfingerprint line to file",
  710. hashed ? "hashed " : "");
  711. goto done;
  712. }
  713. }
  714. log_notice(LD_GENERAL, "Your Tor %s identity key fingerprint is '%s %s'",
  715. hashed ? "bridge's hashed" : "server's", options->Nickname,
  716. fingerprint);
  717. result = 0;
  718. done:
  719. tor_free(cp);
  720. tor_free(keydir);
  721. tor_free(fingerprint_line);
  722. return result;
  723. }
  724. static int
  725. init_keys_common(void)
  726. {
  727. if (!key_lock)
  728. key_lock = tor_mutex_new();
  729. /* There are a couple of paths that put us here before we've asked
  730. * openssl to initialize itself. */
  731. if (crypto_global_init(get_options()->HardwareAccel,
  732. get_options()->AccelName,
  733. get_options()->AccelDir)) {
  734. log_err(LD_BUG, "Unable to initialize OpenSSL. Exiting.");
  735. return -1;
  736. }
  737. return 0;
  738. }
  739. int
  740. init_keys_client(void)
  741. {
  742. crypto_pk_t *prkey;
  743. if (init_keys_common() < 0)
  744. return -1;
  745. if (!(prkey = crypto_pk_new()))
  746. return -1;
  747. if (crypto_pk_generate_key(prkey)) {
  748. crypto_pk_free(prkey);
  749. return -1;
  750. }
  751. set_client_identity_key(prkey);
  752. /* Create a TLS context. */
  753. if (router_initialize_tls_context() < 0) {
  754. log_err(LD_GENERAL,"Error creating TLS context for Tor client.");
  755. return -1;
  756. }
  757. return 0;
  758. }
  759. /** Initialize all OR private keys, and the TLS context, as necessary.
  760. * On OPs, this only initializes the tls context. Return 0 on success,
  761. * or -1 if Tor should die.
  762. */
  763. int
  764. init_keys(void)
  765. {
  766. char *keydir;
  767. const char *mydesc;
  768. crypto_pk_t *prkey;
  769. char digest[DIGEST_LEN];
  770. char v3_digest[DIGEST_LEN];
  771. const or_options_t *options = get_options();
  772. dirinfo_type_t type;
  773. time_t now = time(NULL);
  774. dir_server_t *ds;
  775. int v3_digest_set = 0;
  776. authority_cert_t *cert = NULL;
  777. /* OP's don't need persistent keys; just make up an identity and
  778. * initialize the TLS context. */
  779. if (!server_mode(options)) {
  780. return init_keys_client();
  781. }
  782. if (init_keys_common() < 0)
  783. return -1;
  784. /* Make sure DataDirectory exists, and is private. */
  785. if (check_private_dir(options->DataDirectory, CPD_CREATE, options->User)) {
  786. return -1;
  787. }
  788. /* Check the key directory. */
  789. keydir = get_datadir_fname("keys");
  790. if (check_private_dir(keydir, CPD_CREATE, options->User)) {
  791. tor_free(keydir);
  792. return -1;
  793. }
  794. tor_free(keydir);
  795. /* 1a. Read v3 directory authority key/cert information. */
  796. memset(v3_digest, 0, sizeof(v3_digest));
  797. if (authdir_mode_v3(options)) {
  798. if (init_v3_authority_keys()<0) {
  799. log_err(LD_GENERAL, "We're configured as a V3 authority, but we "
  800. "were unable to load our v3 authority keys and certificate! "
  801. "Use tor-gencert to generate them. Dying.");
  802. return -1;
  803. }
  804. cert = get_my_v3_authority_cert();
  805. if (cert) {
  806. crypto_pk_get_digest(get_my_v3_authority_cert()->identity_key,
  807. v3_digest);
  808. v3_digest_set = 1;
  809. }
  810. }
  811. /* 1b. Read identity key. Make it if none is found. */
  812. keydir = get_datadir_fname2("keys", "secret_id_key");
  813. log_info(LD_GENERAL,"Reading/making identity key \"%s\"...",keydir);
  814. prkey = init_key_from_file(keydir, 1, LOG_ERR, 1);
  815. tor_free(keydir);
  816. if (!prkey) return -1;
  817. set_server_identity_key(prkey);
  818. /* 1c. If we are configured as a bridge, generate a client key;
  819. * otherwise, set the server identity key as our client identity
  820. * key. */
  821. if (public_server_mode(options)) {
  822. set_client_identity_key(crypto_pk_dup_key(prkey)); /* set above */
  823. } else {
  824. if (!(prkey = crypto_pk_new()))
  825. return -1;
  826. if (crypto_pk_generate_key(prkey)) {
  827. crypto_pk_free(prkey);
  828. return -1;
  829. }
  830. set_client_identity_key(prkey);
  831. }
  832. /* 1d. Load all ed25519 keys */
  833. if (load_ed_keys(options,now) < 0)
  834. return -1;
  835. /* 2. Read onion key. Make it if none is found. */
  836. keydir = get_datadir_fname2("keys", "secret_onion_key");
  837. log_info(LD_GENERAL,"Reading/making onion key \"%s\"...",keydir);
  838. prkey = init_key_from_file(keydir, 1, LOG_ERR, 1);
  839. tor_free(keydir);
  840. if (!prkey) return -1;
  841. set_onion_key(prkey);
  842. if (options->command == CMD_RUN_TOR) {
  843. /* only mess with the state file if we're actually running Tor */
  844. or_state_t *state = get_or_state();
  845. if (state->LastRotatedOnionKey > 100 && state->LastRotatedOnionKey < now) {
  846. /* We allow for some parsing slop, but we don't want to risk accepting
  847. * values in the distant future. If we did, we might never rotate the
  848. * onion key. */
  849. onionkey_set_at = state->LastRotatedOnionKey;
  850. } else {
  851. /* We have no LastRotatedOnionKey set; either we just created the key
  852. * or it's a holdover from 0.1.2.4-alpha-dev or earlier. In either case,
  853. * start the clock ticking now so that we will eventually rotate it even
  854. * if we don't stay up for a full MIN_ONION_KEY_LIFETIME. */
  855. state->LastRotatedOnionKey = onionkey_set_at = now;
  856. or_state_mark_dirty(state, options->AvoidDiskWrites ?
  857. time(NULL)+3600 : 0);
  858. }
  859. }
  860. keydir = get_datadir_fname2("keys", "secret_onion_key.old");
  861. if (!lastonionkey && file_status(keydir) == FN_FILE) {
  862. /* Load keys from non-empty files only.
  863. * Missing old keys won't be replaced with freshly generated keys. */
  864. prkey = init_key_from_file(keydir, 0, LOG_ERR, 0);
  865. if (prkey)
  866. lastonionkey = prkey;
  867. }
  868. tor_free(keydir);
  869. {
  870. /* 2b. Load curve25519 onion keys. */
  871. int r;
  872. keydir = get_datadir_fname2("keys", "secret_onion_key_ntor");
  873. r = init_curve25519_keypair_from_file(&curve25519_onion_key,
  874. keydir, 1, LOG_ERR, "onion");
  875. tor_free(keydir);
  876. if (r<0)
  877. return -1;
  878. keydir = get_datadir_fname2("keys", "secret_onion_key_ntor.old");
  879. if (tor_mem_is_zero((const char *)
  880. last_curve25519_onion_key.pubkey.public_key,
  881. CURVE25519_PUBKEY_LEN) &&
  882. file_status(keydir) == FN_FILE) {
  883. /* Load keys from non-empty files only.
  884. * Missing old keys won't be replaced with freshly generated keys. */
  885. init_curve25519_keypair_from_file(&last_curve25519_onion_key,
  886. keydir, 0, LOG_ERR, "onion");
  887. }
  888. tor_free(keydir);
  889. }
  890. /* 3. Initialize link key and TLS context. */
  891. if (router_initialize_tls_context() < 0) {
  892. log_err(LD_GENERAL,"Error initializing TLS context");
  893. return -1;
  894. }
  895. /* 3b. Get an ed25519 link certificate. Note that we need to do this
  896. * after we set up the TLS context */
  897. if (generate_ed_link_cert(options, now) < 0) {
  898. log_err(LD_GENERAL,"Couldn't make link cert");
  899. return -1;
  900. }
  901. /* 4. Build our router descriptor. */
  902. /* Must be called after keys are initialized. */
  903. mydesc = router_get_my_descriptor();
  904. if (authdir_mode_handles_descs(options, ROUTER_PURPOSE_GENERAL)) {
  905. const char *m = NULL;
  906. routerinfo_t *ri;
  907. /* We need to add our own fingerprint so it gets recognized. */
  908. if (dirserv_add_own_fingerprint(get_server_identity_key())) {
  909. log_err(LD_GENERAL,"Error adding own fingerprint to set of relays");
  910. return -1;
  911. }
  912. if (mydesc) {
  913. was_router_added_t added;
  914. ri = router_parse_entry_from_string(mydesc, NULL, 1, 0, NULL, NULL);
  915. if (!ri) {
  916. log_err(LD_GENERAL,"Generated a routerinfo we couldn't parse.");
  917. return -1;
  918. }
  919. added = dirserv_add_descriptor(ri, &m, "self");
  920. if (!WRA_WAS_ADDED(added)) {
  921. if (!WRA_WAS_OUTDATED(added)) {
  922. log_err(LD_GENERAL, "Unable to add own descriptor to directory: %s",
  923. m?m:"<unknown error>");
  924. return -1;
  925. } else {
  926. /* If the descriptor was outdated, that's ok. This can happen
  927. * when some config options are toggled that affect workers, but
  928. * we don't really need new keys yet so the descriptor doesn't
  929. * change and the old one is still fresh. */
  930. log_info(LD_GENERAL, "Couldn't add own descriptor to directory "
  931. "after key init: %s This is usually not a problem.",
  932. m?m:"<unknown error>");
  933. }
  934. }
  935. }
  936. }
  937. /* 5. Dump fingerprint and possibly hashed fingerprint to files. */
  938. if (router_write_fingerprint(0)) {
  939. log_err(LD_FS, "Error writing fingerprint to file");
  940. return -1;
  941. }
  942. if (!public_server_mode(options) && router_write_fingerprint(1)) {
  943. log_err(LD_FS, "Error writing hashed fingerprint to file");
  944. return -1;
  945. }
  946. if (!authdir_mode(options))
  947. return 0;
  948. /* 6. [authdirserver only] load approved-routers file */
  949. if (dirserv_load_fingerprint_file() < 0) {
  950. log_err(LD_GENERAL,"Error loading fingerprints");
  951. return -1;
  952. }
  953. /* 6b. [authdirserver only] add own key to approved directories. */
  954. crypto_pk_get_digest(get_server_identity_key(), digest);
  955. type = ((options->V3AuthoritativeDir ?
  956. (V3_DIRINFO|MICRODESC_DIRINFO|EXTRAINFO_DIRINFO) : NO_DIRINFO) |
  957. (options->BridgeAuthoritativeDir ? BRIDGE_DIRINFO : NO_DIRINFO));
  958. ds = router_get_trusteddirserver_by_digest(digest);
  959. if (!ds) {
  960. ds = trusted_dir_server_new(options->Nickname, NULL,
  961. router_get_advertised_dir_port(options, 0),
  962. router_get_advertised_or_port(options),
  963. NULL,
  964. digest,
  965. v3_digest,
  966. type, 0.0);
  967. if (!ds) {
  968. log_err(LD_GENERAL,"We want to be a directory authority, but we "
  969. "couldn't add ourselves to the authority list. Failing.");
  970. return -1;
  971. }
  972. dir_server_add(ds);
  973. }
  974. if (ds->type != type) {
  975. log_warn(LD_DIR, "Configured authority type does not match authority "
  976. "type in DirAuthority list. Adjusting. (%d v %d)",
  977. type, ds->type);
  978. ds->type = type;
  979. }
  980. if (v3_digest_set && (ds->type & V3_DIRINFO) &&
  981. tor_memneq(v3_digest, ds->v3_identity_digest, DIGEST_LEN)) {
  982. log_warn(LD_DIR, "V3 identity key does not match identity declared in "
  983. "DirAuthority line. Adjusting.");
  984. memcpy(ds->v3_identity_digest, v3_digest, DIGEST_LEN);
  985. }
  986. if (cert) { /* add my own cert to the list of known certs */
  987. log_info(LD_DIR, "adding my own v3 cert");
  988. if (trusted_dirs_load_certs_from_string(
  989. cert->cache_info.signed_descriptor_body,
  990. TRUSTED_DIRS_CERTS_SRC_SELF, 0,
  991. NULL)<0) {
  992. log_warn(LD_DIR, "Unable to parse my own v3 cert! Failing.");
  993. return -1;
  994. }
  995. }
  996. return 0; /* success */
  997. }
  998. /* Keep track of whether we should upload our server descriptor,
  999. * and what type of server we are.
  1000. */
  1001. /** Whether we can reach our ORPort from the outside. */
  1002. static int can_reach_or_port = 0;
  1003. /** Whether we can reach our DirPort from the outside. */
  1004. static int can_reach_dir_port = 0;
  1005. /** Forget what we have learned about our reachability status. */
  1006. void
  1007. router_reset_reachability(void)
  1008. {
  1009. can_reach_or_port = can_reach_dir_port = 0;
  1010. }
  1011. /** Return 1 if we won't do reachability checks, because:
  1012. * - AssumeReachable is set, or
  1013. * - the network is disabled.
  1014. * Otherwise, return 0.
  1015. */
  1016. static int
  1017. router_reachability_checks_disabled(const or_options_t *options)
  1018. {
  1019. return options->AssumeReachable ||
  1020. net_is_disabled();
  1021. }
  1022. /** Return 0 if we need to do an ORPort reachability check, because:
  1023. * - no reachability check has been done yet, or
  1024. * - we've initiated reachability checks, but none have succeeded.
  1025. * Return 1 if we don't need to do an ORPort reachability check, because:
  1026. * - we've seen a successful reachability check, or
  1027. * - AssumeReachable is set, or
  1028. * - the network is disabled.
  1029. */
  1030. int
  1031. check_whether_orport_reachable(const or_options_t *options)
  1032. {
  1033. int reach_checks_disabled = router_reachability_checks_disabled(options);
  1034. return reach_checks_disabled ||
  1035. can_reach_or_port;
  1036. }
  1037. /** Return 0 if we need to do a DirPort reachability check, because:
  1038. * - no reachability check has been done yet, or
  1039. * - we've initiated reachability checks, but none have succeeded.
  1040. * Return 1 if we don't need to do a DirPort reachability check, because:
  1041. * - we've seen a successful reachability check, or
  1042. * - there is no DirPort set, or
  1043. * - AssumeReachable is set, or
  1044. * - the network is disabled.
  1045. */
  1046. int
  1047. check_whether_dirport_reachable(const or_options_t *options)
  1048. {
  1049. int reach_checks_disabled = router_reachability_checks_disabled(options) ||
  1050. !options->DirPort_set;
  1051. return reach_checks_disabled ||
  1052. can_reach_dir_port;
  1053. }
  1054. /** The lower threshold of remaining bandwidth required to advertise (or
  1055. * automatically provide) directory services */
  1056. /* XXX Should this be increased? */
  1057. #define MIN_BW_TO_ADVERTISE_DIRSERVER 51200
  1058. /** Return true iff we have enough configured bandwidth to cache directory
  1059. * information. */
  1060. static int
  1061. router_has_bandwidth_to_be_dirserver(const or_options_t *options)
  1062. {
  1063. if (options->BandwidthRate < MIN_BW_TO_ADVERTISE_DIRSERVER) {
  1064. return 0;
  1065. }
  1066. if (options->RelayBandwidthRate > 0 &&
  1067. options->RelayBandwidthRate < MIN_BW_TO_ADVERTISE_DIRSERVER) {
  1068. return 0;
  1069. }
  1070. return 1;
  1071. }
  1072. /** Helper: Return 1 if we have sufficient resources for serving directory
  1073. * requests, return 0 otherwise.
  1074. * dir_port is either 0 or the configured DirPort number.
  1075. * If AccountingMax is set less than our advertised bandwidth, then don't
  1076. * serve requests. Likewise, if our advertised bandwidth is less than
  1077. * MIN_BW_TO_ADVERTISE_DIRSERVER, don't bother trying to serve requests.
  1078. */
  1079. static int
  1080. router_should_be_directory_server(const or_options_t *options, int dir_port)
  1081. {
  1082. static int advertising=1; /* start out assuming we will advertise */
  1083. int new_choice=1;
  1084. const char *reason = NULL;
  1085. if (accounting_is_enabled(options) &&
  1086. get_options()->AccountingRule != ACCT_IN) {
  1087. /* Don't spend bytes for directory traffic if we could end up hibernating,
  1088. * but allow DirPort otherwise. Some people set AccountingMax because
  1089. * they're confused or to get statistics. Directory traffic has a much
  1090. * larger effect on output than input so there is no reason to turn it
  1091. * off if using AccountingRule in. */
  1092. int interval_length = accounting_get_interval_length();
  1093. uint32_t effective_bw = get_effective_bwrate(options);
  1094. uint64_t acc_bytes;
  1095. if (!interval_length) {
  1096. log_warn(LD_BUG, "An accounting interval is not allowed to be zero "
  1097. "seconds long. Raising to 1.");
  1098. interval_length = 1;
  1099. }
  1100. log_info(LD_GENERAL, "Calculating whether to advertise %s: effective "
  1101. "bwrate: %u, AccountingMax: "U64_FORMAT", "
  1102. "accounting interval length %d",
  1103. dir_port ? "dirport" : "begindir",
  1104. effective_bw, U64_PRINTF_ARG(options->AccountingMax),
  1105. interval_length);
  1106. acc_bytes = options->AccountingMax;
  1107. if (get_options()->AccountingRule == ACCT_SUM)
  1108. acc_bytes /= 2;
  1109. if (effective_bw >=
  1110. acc_bytes / interval_length) {
  1111. new_choice = 0;
  1112. reason = "AccountingMax enabled";
  1113. }
  1114. } else if (! router_has_bandwidth_to_be_dirserver(options)) {
  1115. /* if we're advertising a small amount */
  1116. new_choice = 0;
  1117. reason = "BandwidthRate under 50KB";
  1118. }
  1119. if (advertising != new_choice) {
  1120. if (new_choice == 1) {
  1121. if (dir_port > 0)
  1122. log_notice(LD_DIR, "Advertising DirPort as %d", dir_port);
  1123. else
  1124. log_notice(LD_DIR, "Advertising directory service support");
  1125. } else {
  1126. tor_assert(reason);
  1127. log_notice(LD_DIR, "Not advertising Dir%s (Reason: %s)",
  1128. dir_port ? "Port" : "ectory Service support", reason);
  1129. }
  1130. advertising = new_choice;
  1131. }
  1132. return advertising;
  1133. }
  1134. /** Return 1 if we are configured to accept either relay or directory requests
  1135. * from clients and we aren't at risk of exceeding our bandwidth limits, thus
  1136. * we should be a directory server. If not, return 0.
  1137. */
  1138. int
  1139. dir_server_mode(const or_options_t *options)
  1140. {
  1141. if (!options->DirCache)
  1142. return 0;
  1143. return options->DirPort_set ||
  1144. (server_mode(options) && router_has_bandwidth_to_be_dirserver(options));
  1145. }
  1146. /** Look at a variety of factors, and return 0 if we don't want to
  1147. * advertise the fact that we have a DirPort open or begindir support, else
  1148. * return 1.
  1149. *
  1150. * Where dir_port or supports_tunnelled_dir_requests are not relevant, they
  1151. * must be 0.
  1152. *
  1153. * Log a helpful message if we change our mind about whether to publish.
  1154. */
  1155. static int
  1156. decide_to_advertise_dir_impl(const or_options_t *options,
  1157. uint16_t dir_port,
  1158. int supports_tunnelled_dir_requests)
  1159. {
  1160. /* Part one: reasons to publish or not publish that aren't
  1161. * worth mentioning to the user, either because they're obvious
  1162. * or because they're normal behavior. */
  1163. /* short circuit the rest of the function */
  1164. if (!dir_port && !supports_tunnelled_dir_requests)
  1165. return 0;
  1166. if (authdir_mode(options)) /* always publish */
  1167. return 1;
  1168. if (net_is_disabled())
  1169. return 0;
  1170. if (dir_port && !router_get_advertised_dir_port(options, dir_port))
  1171. return 0;
  1172. if (supports_tunnelled_dir_requests &&
  1173. !router_get_advertised_or_port(options))
  1174. return 0;
  1175. /* Part two: consider config options that could make us choose to
  1176. * publish or not publish that the user might find surprising. */
  1177. return router_should_be_directory_server(options, dir_port);
  1178. }
  1179. /** Front-end to decide_to_advertise_dir_impl(): return 0 if we don't want to
  1180. * advertise the fact that we have a DirPort open, else return the
  1181. * DirPort we want to advertise.
  1182. */
  1183. static int
  1184. decide_to_advertise_dirport(const or_options_t *options, uint16_t dir_port)
  1185. {
  1186. /* supports_tunnelled_dir_requests is not relevant, pass 0 */
  1187. return decide_to_advertise_dir_impl(options, dir_port, 0) ? dir_port : 0;
  1188. }
  1189. /** Front-end to decide_to_advertise_dir_impl(): return 0 if we don't want to
  1190. * advertise the fact that we support begindir requests, else return 1.
  1191. */
  1192. static int
  1193. decide_to_advertise_begindir(const or_options_t *options,
  1194. int supports_tunnelled_dir_requests)
  1195. {
  1196. /* dir_port is not relevant, pass 0 */
  1197. return decide_to_advertise_dir_impl(options, 0,
  1198. supports_tunnelled_dir_requests);
  1199. }
  1200. /** Allocate and return a new extend_info_t that can be used to build
  1201. * a circuit to or through the router <b>r</b>. Uses the primary
  1202. * address of the router, so should only be called on a server. */
  1203. static extend_info_t *
  1204. extend_info_from_router(const routerinfo_t *r)
  1205. {
  1206. tor_addr_port_t ap;
  1207. tor_assert(r);
  1208. /* Make sure we don't need to check address reachability */
  1209. tor_assert_nonfatal(router_skip_or_reachability(get_options(), 0));
  1210. router_get_prim_orport(r, &ap);
  1211. return extend_info_new(r->nickname, r->cache_info.identity_digest,
  1212. r->onion_pkey, r->onion_curve25519_pkey,
  1213. &ap.addr, ap.port);
  1214. }
  1215. /** Some time has passed, or we just got new directory information.
  1216. * See if we currently believe our ORPort or DirPort to be
  1217. * unreachable. If so, launch a new test for it.
  1218. *
  1219. * For ORPort, we simply try making a circuit that ends at ourselves.
  1220. * Success is noticed in onionskin_answer().
  1221. *
  1222. * For DirPort, we make a connection via Tor to our DirPort and ask
  1223. * for our own server descriptor.
  1224. * Success is noticed in connection_dir_client_reached_eof().
  1225. */
  1226. void
  1227. consider_testing_reachability(int test_or, int test_dir)
  1228. {
  1229. const routerinfo_t *me = router_get_my_routerinfo();
  1230. const or_options_t *options = get_options();
  1231. int orport_reachable = check_whether_orport_reachable(options);
  1232. tor_addr_t addr;
  1233. if (!me)
  1234. return;
  1235. if (routerset_contains_router(options->ExcludeNodes, me, -1) &&
  1236. options->StrictNodes) {
  1237. /* If we've excluded ourself, and StrictNodes is set, we can't test
  1238. * ourself. */
  1239. if (test_or || test_dir) {
  1240. #define SELF_EXCLUDED_WARN_INTERVAL 3600
  1241. static ratelim_t warning_limit=RATELIM_INIT(SELF_EXCLUDED_WARN_INTERVAL);
  1242. log_fn_ratelim(&warning_limit, LOG_WARN, LD_CIRC,
  1243. "Can't peform self-tests for this relay: we have "
  1244. "listed ourself in ExcludeNodes, and StrictNodes is set. "
  1245. "We cannot learn whether we are usable, and will not "
  1246. "be able to advertise ourself.");
  1247. }
  1248. return;
  1249. }
  1250. if (test_or && (!orport_reachable || !circuit_enough_testing_circs())) {
  1251. extend_info_t *ei = extend_info_from_router(me);
  1252. /* XXX IPv6 self testing */
  1253. log_info(LD_CIRC, "Testing %s of my ORPort: %s:%d.",
  1254. !orport_reachable ? "reachability" : "bandwidth",
  1255. fmt_addr32(me->addr), me->or_port);
  1256. circuit_launch_by_extend_info(CIRCUIT_PURPOSE_TESTING, ei,
  1257. CIRCLAUNCH_NEED_CAPACITY|CIRCLAUNCH_IS_INTERNAL);
  1258. extend_info_free(ei);
  1259. }
  1260. /* XXX IPv6 self testing */
  1261. tor_addr_from_ipv4h(&addr, me->addr);
  1262. if (test_dir && !check_whether_dirport_reachable(options) &&
  1263. !connection_get_by_type_addr_port_purpose(
  1264. CONN_TYPE_DIR, &addr, me->dir_port,
  1265. DIR_PURPOSE_FETCH_SERVERDESC)) {
  1266. /* ask myself, via tor, for my server descriptor. */
  1267. directory_initiate_command(&addr, me->or_port,
  1268. &addr, me->dir_port,
  1269. me->cache_info.identity_digest,
  1270. DIR_PURPOSE_FETCH_SERVERDESC,
  1271. ROUTER_PURPOSE_GENERAL,
  1272. DIRIND_ANON_DIRPORT, "authority.z", NULL, 0, 0);
  1273. }
  1274. }
  1275. /** Annotate that we found our ORPort reachable. */
  1276. void
  1277. router_orport_found_reachable(void)
  1278. {
  1279. const routerinfo_t *me = router_get_my_routerinfo();
  1280. const or_options_t *options = get_options();
  1281. if (!can_reach_or_port && me) {
  1282. char *address = tor_dup_ip(me->addr);
  1283. log_notice(LD_OR,"Self-testing indicates your ORPort is reachable from "
  1284. "the outside. Excellent.%s",
  1285. options->PublishServerDescriptor_ != NO_DIRINFO
  1286. && check_whether_dirport_reachable(options) ?
  1287. " Publishing server descriptor." : "");
  1288. can_reach_or_port = 1;
  1289. mark_my_descriptor_dirty("ORPort found reachable");
  1290. /* This is a significant enough change to upload immediately,
  1291. * at least in a test network */
  1292. if (options->TestingTorNetwork == 1) {
  1293. reschedule_descriptor_update_check();
  1294. }
  1295. control_event_server_status(LOG_NOTICE,
  1296. "REACHABILITY_SUCCEEDED ORADDRESS=%s:%d",
  1297. address, me->or_port);
  1298. tor_free(address);
  1299. }
  1300. }
  1301. /** Annotate that we found our DirPort reachable. */
  1302. void
  1303. router_dirport_found_reachable(void)
  1304. {
  1305. const routerinfo_t *me = router_get_my_routerinfo();
  1306. const or_options_t *options = get_options();
  1307. if (!can_reach_dir_port && me) {
  1308. char *address = tor_dup_ip(me->addr);
  1309. log_notice(LD_DIRSERV,"Self-testing indicates your DirPort is reachable "
  1310. "from the outside. Excellent.%s",
  1311. options->PublishServerDescriptor_ != NO_DIRINFO
  1312. && check_whether_orport_reachable(options) ?
  1313. " Publishing server descriptor." : "");
  1314. can_reach_dir_port = 1;
  1315. if (decide_to_advertise_dirport(options, me->dir_port)) {
  1316. mark_my_descriptor_dirty("DirPort found reachable");
  1317. /* This is a significant enough change to upload immediately,
  1318. * at least in a test network */
  1319. if (options->TestingTorNetwork == 1) {
  1320. reschedule_descriptor_update_check();
  1321. }
  1322. }
  1323. control_event_server_status(LOG_NOTICE,
  1324. "REACHABILITY_SUCCEEDED DIRADDRESS=%s:%d",
  1325. address, me->dir_port);
  1326. tor_free(address);
  1327. }
  1328. }
  1329. /** We have enough testing circuits open. Send a bunch of "drop"
  1330. * cells down each of them, to exercise our bandwidth. */
  1331. void
  1332. router_perform_bandwidth_test(int num_circs, time_t now)
  1333. {
  1334. int num_cells = (int)(get_options()->BandwidthRate * 10 /
  1335. CELL_MAX_NETWORK_SIZE);
  1336. int max_cells = num_cells < CIRCWINDOW_START ?
  1337. num_cells : CIRCWINDOW_START;
  1338. int cells_per_circuit = max_cells / num_circs;
  1339. origin_circuit_t *circ = NULL;
  1340. log_notice(LD_OR,"Performing bandwidth self-test...done.");
  1341. while ((circ = circuit_get_next_by_pk_and_purpose(circ, NULL,
  1342. CIRCUIT_PURPOSE_TESTING))) {
  1343. /* dump cells_per_circuit drop cells onto this circ */
  1344. int i = cells_per_circuit;
  1345. if (circ->base_.state != CIRCUIT_STATE_OPEN)
  1346. continue;
  1347. circ->base_.timestamp_dirty = now;
  1348. while (i-- > 0) {
  1349. if (relay_send_command_from_edge(0, TO_CIRCUIT(circ),
  1350. RELAY_COMMAND_DROP,
  1351. NULL, 0, circ->cpath->prev)<0) {
  1352. return; /* stop if error */
  1353. }
  1354. }
  1355. }
  1356. }
  1357. /** Return true iff our network is in some sense disabled: either we're
  1358. * hibernating, entering hibernation, or the network is turned off with
  1359. * DisableNetwork. */
  1360. int
  1361. net_is_disabled(void)
  1362. {
  1363. return get_options()->DisableNetwork || we_are_hibernating();
  1364. }
  1365. /** Return true iff we believe ourselves to be an authoritative
  1366. * directory server.
  1367. */
  1368. int
  1369. authdir_mode(const or_options_t *options)
  1370. {
  1371. return options->AuthoritativeDir != 0;
  1372. }
  1373. /** Return true iff we believe ourselves to be a v3 authoritative
  1374. * directory server.
  1375. */
  1376. int
  1377. authdir_mode_v3(const or_options_t *options)
  1378. {
  1379. return authdir_mode(options) && options->V3AuthoritativeDir != 0;
  1380. }
  1381. /** Return true iff we are a v3 directory authority. */
  1382. int
  1383. authdir_mode_any_main(const or_options_t *options)
  1384. {
  1385. return options->V3AuthoritativeDir;
  1386. }
  1387. /** Return true if we believe ourselves to be any kind of
  1388. * authoritative directory beyond just a hidserv authority. */
  1389. int
  1390. authdir_mode_any_nonhidserv(const or_options_t *options)
  1391. {
  1392. return options->BridgeAuthoritativeDir ||
  1393. authdir_mode_any_main(options);
  1394. }
  1395. /** Return true iff we are an authoritative directory server that is
  1396. * authoritative about receiving and serving descriptors of type
  1397. * <b>purpose</b> on its dirport. Use -1 for "any purpose". */
  1398. int
  1399. authdir_mode_handles_descs(const or_options_t *options, int purpose)
  1400. {
  1401. if (purpose < 0)
  1402. return authdir_mode_any_nonhidserv(options);
  1403. else if (purpose == ROUTER_PURPOSE_GENERAL)
  1404. return authdir_mode_any_main(options);
  1405. else if (purpose == ROUTER_PURPOSE_BRIDGE)
  1406. return (options->BridgeAuthoritativeDir);
  1407. else
  1408. return 0;
  1409. }
  1410. /** Return true iff we are an authoritative directory server that
  1411. * publishes its own network statuses.
  1412. */
  1413. int
  1414. authdir_mode_publishes_statuses(const or_options_t *options)
  1415. {
  1416. if (authdir_mode_bridge(options))
  1417. return 0;
  1418. return authdir_mode_any_nonhidserv(options);
  1419. }
  1420. /** Return true iff we are an authoritative directory server that
  1421. * tests reachability of the descriptors it learns about.
  1422. */
  1423. int
  1424. authdir_mode_tests_reachability(const or_options_t *options)
  1425. {
  1426. return authdir_mode_handles_descs(options, -1);
  1427. }
  1428. /** Return true iff we believe ourselves to be a bridge authoritative
  1429. * directory server.
  1430. */
  1431. int
  1432. authdir_mode_bridge(const or_options_t *options)
  1433. {
  1434. return authdir_mode(options) && options->BridgeAuthoritativeDir != 0;
  1435. }
  1436. /** Return true iff we are trying to be a server.
  1437. */
  1438. MOCK_IMPL(int,
  1439. server_mode,(const or_options_t *options))
  1440. {
  1441. if (options->ClientOnly) return 0;
  1442. /* XXXX I believe we can kill off ORListenAddress here.*/
  1443. return (options->ORPort_set || options->ORListenAddress);
  1444. }
  1445. /** Return true iff we are trying to be a non-bridge server.
  1446. */
  1447. MOCK_IMPL(int,
  1448. public_server_mode,(const or_options_t *options))
  1449. {
  1450. if (!server_mode(options)) return 0;
  1451. return (!options->BridgeRelay);
  1452. }
  1453. /** Return true iff the combination of options in <b>options</b> and parameters
  1454. * in the consensus mean that we don't want to allow exits from circuits
  1455. * we got from addresses not known to be servers. */
  1456. int
  1457. should_refuse_unknown_exits(const or_options_t *options)
  1458. {
  1459. if (options->RefuseUnknownExits != -1) {
  1460. return options->RefuseUnknownExits;
  1461. } else {
  1462. return networkstatus_get_param(NULL, "refuseunknownexits", 1, 0, 1);
  1463. }
  1464. }
  1465. /** Remember if we've advertised ourselves to the dirservers. */
  1466. static int server_is_advertised=0;
  1467. /** Return true iff we have published our descriptor lately.
  1468. */
  1469. MOCK_IMPL(int,
  1470. advertised_server_mode,(void))
  1471. {
  1472. return server_is_advertised;
  1473. }
  1474. /**
  1475. * Called with a boolean: set whether we have recently published our
  1476. * descriptor.
  1477. */
  1478. static void
  1479. set_server_advertised(int s)
  1480. {
  1481. server_is_advertised = s;
  1482. }
  1483. /** Return true iff we are trying to proxy client connections. */
  1484. int
  1485. proxy_mode(const or_options_t *options)
  1486. {
  1487. (void)options;
  1488. SMARTLIST_FOREACH_BEGIN(get_configured_ports(), const port_cfg_t *, p) {
  1489. if (p->type == CONN_TYPE_AP_LISTENER ||
  1490. p->type == CONN_TYPE_AP_TRANS_LISTENER ||
  1491. p->type == CONN_TYPE_AP_DNS_LISTENER ||
  1492. p->type == CONN_TYPE_AP_NATD_LISTENER)
  1493. return 1;
  1494. } SMARTLIST_FOREACH_END(p);
  1495. return 0;
  1496. }
  1497. /** Decide if we're a publishable server. We are a publishable server if:
  1498. * - We don't have the ClientOnly option set
  1499. * and
  1500. * - We have the PublishServerDescriptor option set to non-empty
  1501. * and
  1502. * - We have ORPort set
  1503. * and
  1504. * - We believe our ORPort and DirPort (if present) are reachable from
  1505. * the outside; or
  1506. * - We believe our ORPort is reachable from the outside, and we can't
  1507. * check our DirPort because the consensus has no exits; or
  1508. * - We are an authoritative directory server.
  1509. */
  1510. static int
  1511. decide_if_publishable_server(void)
  1512. {
  1513. const or_options_t *options = get_options();
  1514. if (options->ClientOnly)
  1515. return 0;
  1516. if (options->PublishServerDescriptor_ == NO_DIRINFO)
  1517. return 0;
  1518. if (!server_mode(options))
  1519. return 0;
  1520. if (authdir_mode(options))
  1521. return 1;
  1522. if (!router_get_advertised_or_port(options))
  1523. return 0;
  1524. if (!check_whether_orport_reachable(options))
  1525. return 0;
  1526. if (router_have_consensus_path() == CONSENSUS_PATH_INTERNAL) {
  1527. /* All set: there are no exits in the consensus (maybe this is a tiny
  1528. * test network), so we can't check our DirPort reachability. */
  1529. return 1;
  1530. } else {
  1531. return check_whether_dirport_reachable(options);
  1532. }
  1533. }
  1534. /** Initiate server descriptor upload as reasonable (if server is publishable,
  1535. * etc). <b>force</b> is as for router_upload_dir_desc_to_dirservers.
  1536. *
  1537. * We need to rebuild the descriptor if it's dirty even if we're not
  1538. * uploading, because our reachability testing *uses* our descriptor to
  1539. * determine what IP address and ports to test.
  1540. */
  1541. void
  1542. consider_publishable_server(int force)
  1543. {
  1544. int rebuilt;
  1545. if (!server_mode(get_options()))
  1546. return;
  1547. rebuilt = router_rebuild_descriptor(0);
  1548. if (decide_if_publishable_server()) {
  1549. set_server_advertised(1);
  1550. if (rebuilt == 0)
  1551. router_upload_dir_desc_to_dirservers(force);
  1552. } else {
  1553. set_server_advertised(0);
  1554. }
  1555. }
  1556. /** Return the port of the first active listener of type
  1557. * <b>listener_type</b>. */
  1558. /** XXX not a very good interface. it's not reliable when there are
  1559. multiple listeners. */
  1560. uint16_t
  1561. router_get_active_listener_port_by_type_af(int listener_type,
  1562. sa_family_t family)
  1563. {
  1564. /* Iterate all connections, find one of the right kind and return
  1565. the port. Not very sophisticated or fast, but effective. */
  1566. smartlist_t *conns = get_connection_array();
  1567. SMARTLIST_FOREACH_BEGIN(conns, connection_t *, conn) {
  1568. if (conn->type == listener_type && !conn->marked_for_close &&
  1569. conn->socket_family == family) {
  1570. return conn->port;
  1571. }
  1572. } SMARTLIST_FOREACH_END(conn);
  1573. return 0;
  1574. }
  1575. /** Return the port that we should advertise as our ORPort; this is either
  1576. * the one configured in the ORPort option, or the one we actually bound to
  1577. * if ORPort is "auto".
  1578. */
  1579. uint16_t
  1580. router_get_advertised_or_port(const or_options_t *options)
  1581. {
  1582. return router_get_advertised_or_port_by_af(options, AF_INET);
  1583. }
  1584. /** As router_get_advertised_or_port(), but allows an address family argument.
  1585. */
  1586. uint16_t
  1587. router_get_advertised_or_port_by_af(const or_options_t *options,
  1588. sa_family_t family)
  1589. {
  1590. int port = get_first_advertised_port_by_type_af(CONN_TYPE_OR_LISTENER,
  1591. family);
  1592. (void)options;
  1593. /* If the port is in 'auto' mode, we have to use
  1594. router_get_listener_port_by_type(). */
  1595. if (port == CFG_AUTO_PORT)
  1596. return router_get_active_listener_port_by_type_af(CONN_TYPE_OR_LISTENER,
  1597. family);
  1598. return port;
  1599. }
  1600. /** Return the port that we should advertise as our DirPort;
  1601. * this is one of three possibilities:
  1602. * The one that is passed as <b>dirport</b> if the DirPort option is 0, or
  1603. * the one configured in the DirPort option,
  1604. * or the one we actually bound to if DirPort is "auto". */
  1605. uint16_t
  1606. router_get_advertised_dir_port(const or_options_t *options, uint16_t dirport)
  1607. {
  1608. int dirport_configured = get_primary_dir_port();
  1609. (void)options;
  1610. if (!dirport_configured)
  1611. return dirport;
  1612. if (dirport_configured == CFG_AUTO_PORT)
  1613. return router_get_active_listener_port_by_type_af(CONN_TYPE_DIR_LISTENER,
  1614. AF_INET);
  1615. return dirport_configured;
  1616. }
  1617. /*
  1618. * OR descriptor generation.
  1619. */
  1620. /** My routerinfo. */
  1621. static routerinfo_t *desc_routerinfo = NULL;
  1622. /** My extrainfo */
  1623. static extrainfo_t *desc_extrainfo = NULL;
  1624. /** Why did we most recently decide to regenerate our descriptor? Used to
  1625. * tell the authorities why we're sending it to them. */
  1626. static const char *desc_gen_reason = NULL;
  1627. /** Since when has our descriptor been "clean"? 0 if we need to regenerate it
  1628. * now. */
  1629. static time_t desc_clean_since = 0;
  1630. /** Why did we mark the descriptor dirty? */
  1631. static const char *desc_dirty_reason = NULL;
  1632. /** Boolean: do we need to regenerate the above? */
  1633. static int desc_needs_upload = 0;
  1634. /** OR only: If <b>force</b> is true, or we haven't uploaded this
  1635. * descriptor successfully yet, try to upload our signed descriptor to
  1636. * all the directory servers we know about.
  1637. */
  1638. void
  1639. router_upload_dir_desc_to_dirservers(int force)
  1640. {
  1641. const routerinfo_t *ri;
  1642. extrainfo_t *ei;
  1643. char *msg;
  1644. size_t desc_len, extra_len = 0, total_len;
  1645. dirinfo_type_t auth = get_options()->PublishServerDescriptor_;
  1646. ri = router_get_my_routerinfo();
  1647. if (!ri) {
  1648. log_info(LD_GENERAL, "No descriptor; skipping upload");
  1649. return;
  1650. }
  1651. ei = router_get_my_extrainfo();
  1652. if (auth == NO_DIRINFO)
  1653. return;
  1654. if (!force && !desc_needs_upload)
  1655. return;
  1656. log_info(LD_OR, "Uploading relay descriptor to directory authorities%s",
  1657. force ? " (forced)" : "");
  1658. desc_needs_upload = 0;
  1659. desc_len = ri->cache_info.signed_descriptor_len;
  1660. extra_len = ei ? ei->cache_info.signed_descriptor_len : 0;
  1661. total_len = desc_len + extra_len + 1;
  1662. msg = tor_malloc(total_len);
  1663. memcpy(msg, ri->cache_info.signed_descriptor_body, desc_len);
  1664. if (ei) {
  1665. memcpy(msg+desc_len, ei->cache_info.signed_descriptor_body, extra_len);
  1666. }
  1667. msg[desc_len+extra_len] = 0;
  1668. directory_post_to_dirservers(DIR_PURPOSE_UPLOAD_DIR,
  1669. (auth & BRIDGE_DIRINFO) ?
  1670. ROUTER_PURPOSE_BRIDGE :
  1671. ROUTER_PURPOSE_GENERAL,
  1672. auth, msg, desc_len, extra_len);
  1673. tor_free(msg);
  1674. }
  1675. /** OR only: Check whether my exit policy says to allow connection to
  1676. * conn. Return 0 if we accept; non-0 if we reject.
  1677. */
  1678. int
  1679. router_compare_to_my_exit_policy(const tor_addr_t *addr, uint16_t port)
  1680. {
  1681. const routerinfo_t *me = router_get_my_routerinfo();
  1682. if (!me) /* make sure routerinfo exists */
  1683. return -1;
  1684. /* make sure it's resolved to something. this way we can't get a
  1685. 'maybe' below. */
  1686. if (tor_addr_is_null(addr))
  1687. return -1;
  1688. /* look at router_get_my_routerinfo()->exit_policy for both the v4 and the
  1689. * v6 policies. The exit_policy field in router_get_my_routerinfo() is a
  1690. * bit unusual, in that it contains IPv6 and IPv6 entries. We don't want to
  1691. * look at router_get_my_routerinfo()->ipv6_exit_policy, since that's a port
  1692. * summary. */
  1693. if ((tor_addr_family(addr) == AF_INET ||
  1694. tor_addr_family(addr) == AF_INET6)) {
  1695. return compare_tor_addr_to_addr_policy(addr, port,
  1696. me->exit_policy) != ADDR_POLICY_ACCEPTED;
  1697. #if 0
  1698. } else if (tor_addr_family(addr) == AF_INET6) {
  1699. return get_options()->IPv6Exit &&
  1700. desc_routerinfo->ipv6_exit_policy &&
  1701. compare_tor_addr_to_short_policy(addr, port,
  1702. me->ipv6_exit_policy) != ADDR_POLICY_ACCEPTED;
  1703. #endif
  1704. } else {
  1705. return -1;
  1706. }
  1707. }
  1708. /** Return true iff my exit policy is reject *:*. Return -1 if we don't
  1709. * have a descriptor */
  1710. MOCK_IMPL(int,
  1711. router_my_exit_policy_is_reject_star,(void))
  1712. {
  1713. if (!router_get_my_routerinfo()) /* make sure routerinfo exists */
  1714. return -1;
  1715. return router_get_my_routerinfo()->policy_is_reject_star;
  1716. }
  1717. /** Return true iff I'm a server and <b>digest</b> is equal to
  1718. * my server identity key digest. */
  1719. int
  1720. router_digest_is_me(const char *digest)
  1721. {
  1722. return (server_identitykey &&
  1723. tor_memeq(server_identitykey_digest, digest, DIGEST_LEN));
  1724. }
  1725. /** Return my identity digest. */
  1726. const uint8_t *
  1727. router_get_my_id_digest(void)
  1728. {
  1729. return (const uint8_t *)server_identitykey_digest;
  1730. }
  1731. /** Return true iff I'm a server and <b>digest</b> is equal to
  1732. * my identity digest. */
  1733. int
  1734. router_extrainfo_digest_is_me(const char *digest)
  1735. {
  1736. extrainfo_t *ei = router_get_my_extrainfo();
  1737. if (!ei)
  1738. return 0;
  1739. return tor_memeq(digest,
  1740. ei->cache_info.signed_descriptor_digest,
  1741. DIGEST_LEN);
  1742. }
  1743. /** A wrapper around router_digest_is_me(). */
  1744. int
  1745. router_is_me(const routerinfo_t *router)
  1746. {
  1747. return router_digest_is_me(router->cache_info.identity_digest);
  1748. }
  1749. /** Return a routerinfo for this OR, rebuilding a fresh one if
  1750. * necessary. Return NULL on error, or if called on an OP. */
  1751. MOCK_IMPL(const routerinfo_t *,
  1752. router_get_my_routerinfo,(void))
  1753. {
  1754. if (!server_mode(get_options()))
  1755. return NULL;
  1756. if (router_rebuild_descriptor(0))
  1757. return NULL;
  1758. return desc_routerinfo;
  1759. }
  1760. /** OR only: Return a signed server descriptor for this OR, rebuilding a fresh
  1761. * one if necessary. Return NULL on error.
  1762. */
  1763. const char *
  1764. router_get_my_descriptor(void)
  1765. {
  1766. const char *body;
  1767. const routerinfo_t *me = router_get_my_routerinfo();
  1768. if (! me)
  1769. return NULL;
  1770. tor_assert(me->cache_info.saved_location == SAVED_NOWHERE);
  1771. body = signed_descriptor_get_body(&me->cache_info);
  1772. /* Make sure this is nul-terminated. */
  1773. tor_assert(!body[me->cache_info.signed_descriptor_len]);
  1774. log_debug(LD_GENERAL,"my desc is '%s'", body);
  1775. return body;
  1776. }
  1777. /** Return the extrainfo document for this OR, or NULL if we have none.
  1778. * Rebuilt it (and the server descriptor) if necessary. */
  1779. extrainfo_t *
  1780. router_get_my_extrainfo(void)
  1781. {
  1782. if (!server_mode(get_options()))
  1783. return NULL;
  1784. if (router_rebuild_descriptor(0))
  1785. return NULL;
  1786. return desc_extrainfo;
  1787. }
  1788. /** Return a human-readable string describing what triggered us to generate
  1789. * our current descriptor, or NULL if we don't know. */
  1790. const char *
  1791. router_get_descriptor_gen_reason(void)
  1792. {
  1793. return desc_gen_reason;
  1794. }
  1795. /** A list of nicknames that we've warned about including in our family
  1796. * declaration verbatim rather than as digests. */
  1797. static smartlist_t *warned_nonexistent_family = NULL;
  1798. static int router_guess_address_from_dir_headers(uint32_t *guess);
  1799. /** Make a current best guess at our address, either because
  1800. * it's configured in torrc, or because we've learned it from
  1801. * dirserver headers. Place the answer in *<b>addr</b> and return
  1802. * 0 on success, else return -1 if we have no guess.
  1803. *
  1804. * If <b>cache_only</b> is true, just return any cached answers, and
  1805. * don't try to get any new answers.
  1806. */
  1807. MOCK_IMPL(int,
  1808. router_pick_published_address,(const or_options_t *options, uint32_t *addr,
  1809. int cache_only))
  1810. {
  1811. /* First, check the cached output from resolve_my_address(). */
  1812. *addr = get_last_resolved_addr();
  1813. if (*addr)
  1814. return 0;
  1815. /* Second, consider doing a resolve attempt right here. */
  1816. if (!cache_only) {
  1817. if (resolve_my_address(LOG_INFO, options, addr, NULL, NULL) >= 0) {
  1818. log_info(LD_CONFIG,"Success: chose address '%s'.", fmt_addr32(*addr));
  1819. return 0;
  1820. }
  1821. }
  1822. /* Third, check the cached output from router_new_address_suggestion(). */
  1823. if (router_guess_address_from_dir_headers(addr) >= 0)
  1824. return 0;
  1825. /* We have no useful cached answers. Return failure. */
  1826. return -1;
  1827. }
  1828. /* Like router_check_descriptor_address_consistency, but specifically for the
  1829. * ORPort or DirPort.
  1830. * listener_type is either CONN_TYPE_OR_LISTENER or CONN_TYPE_DIR_LISTENER. */
  1831. static void
  1832. router_check_descriptor_address_port_consistency(uint32_t ipv4h_desc_addr,
  1833. int listener_type)
  1834. {
  1835. tor_assert(listener_type == CONN_TYPE_OR_LISTENER ||
  1836. listener_type == CONN_TYPE_DIR_LISTENER);
  1837. /* The first advertised Port may be the magic constant CFG_AUTO_PORT.
  1838. */
  1839. int port_v4_cfg = get_first_advertised_port_by_type_af(listener_type,
  1840. AF_INET);
  1841. if (port_v4_cfg != 0 &&
  1842. !port_exists_by_type_addr32h_port(listener_type,
  1843. ipv4h_desc_addr, port_v4_cfg, 1)) {
  1844. const tor_addr_t *port_addr = get_first_advertised_addr_by_type_af(
  1845. listener_type,
  1846. AF_INET);
  1847. /* If we're building a descriptor with no advertised address,
  1848. * something is terribly wrong. */
  1849. tor_assert(port_addr);
  1850. tor_addr_t desc_addr;
  1851. char port_addr_str[TOR_ADDR_BUF_LEN];
  1852. char desc_addr_str[TOR_ADDR_BUF_LEN];
  1853. tor_addr_to_str(port_addr_str, port_addr, TOR_ADDR_BUF_LEN, 0);
  1854. tor_addr_from_ipv4h(&desc_addr, ipv4h_desc_addr);
  1855. tor_addr_to_str(desc_addr_str, &desc_addr, TOR_ADDR_BUF_LEN, 0);
  1856. const char *listener_str = (listener_type == CONN_TYPE_OR_LISTENER ?
  1857. "OR" : "Dir");
  1858. log_warn(LD_CONFIG, "The IPv4 %sPort address %s does not match the "
  1859. "descriptor address %s. If you have a static public IPv4 "
  1860. "address, use 'Address <IPv4>' and 'OutboundBindAddress "
  1861. "<IPv4>'. If you are behind a NAT, use two %sPort lines: "
  1862. "'%sPort <PublicPort> NoListen' and '%sPort <InternalPort> "
  1863. "NoAdvertise'.",
  1864. listener_str, port_addr_str, desc_addr_str, listener_str,
  1865. listener_str, listener_str);
  1866. }
  1867. }
  1868. /* Tor relays only have one IPv4 address in the descriptor, which is derived
  1869. * from the Address torrc option, or guessed using various methods in
  1870. * router_pick_published_address().
  1871. * Warn the operator if there is no ORPort on the descriptor address
  1872. * ipv4h_desc_addr.
  1873. * Warn the operator if there is no DirPort on the descriptor address.
  1874. * This catches a few common config errors:
  1875. * - operators who expect ORPorts and DirPorts to be advertised on the
  1876. * ports' listen addresses, rather than the torrc Address (or guessed
  1877. * addresses in the absence of an Address config). This includes
  1878. * operators who attempt to put their ORPort and DirPort on different
  1879. * addresses;
  1880. * - discrepancies between guessed addresses and configured listen
  1881. * addresses (when the Address option isn't set).
  1882. * If a listener is listening on all IPv4 addresses, it is assumed that it
  1883. * is listening on the configured Address, and no messages are logged.
  1884. * If an operators has specified NoAdvertise ORPorts in a NAT setting,
  1885. * no messages are logged, unless they have specified other advertised
  1886. * addresses.
  1887. * The message tells operators to configure an ORPort and DirPort that match
  1888. * the Address (using NoListen if needed).
  1889. */
  1890. static void
  1891. router_check_descriptor_address_consistency(uint32_t ipv4h_desc_addr)
  1892. {
  1893. router_check_descriptor_address_port_consistency(ipv4h_desc_addr,
  1894. CONN_TYPE_OR_LISTENER);
  1895. router_check_descriptor_address_port_consistency(ipv4h_desc_addr,
  1896. CONN_TYPE_DIR_LISTENER);
  1897. }
  1898. /** Build a fresh routerinfo, signed server descriptor, and extra-info document
  1899. * for this OR. Set r to the generated routerinfo, e to the generated
  1900. * extra-info document. Return 0 on success, -1 on temporary error. Failure to
  1901. * generate an extra-info document is not an error and is indicated by setting
  1902. * e to NULL. Caller is responsible for freeing generated documents if 0 is
  1903. * returned.
  1904. */
  1905. int
  1906. router_build_fresh_descriptor(routerinfo_t **r, extrainfo_t **e)
  1907. {
  1908. routerinfo_t *ri;
  1909. extrainfo_t *ei;
  1910. uint32_t addr;
  1911. char platform[256];
  1912. int hibernating = we_are_hibernating();
  1913. const or_options_t *options = get_options();
  1914. if (router_pick_published_address(options, &addr, 0) < 0) {
  1915. log_warn(LD_CONFIG, "Don't know my address while generating descriptor");
  1916. return -1;
  1917. }
  1918. /* Log a message if the address in the descriptor doesn't match the ORPort
  1919. * and DirPort addresses configured by the operator. */
  1920. router_check_descriptor_address_consistency(addr);
  1921. ri = tor_malloc_zero(sizeof(routerinfo_t));
  1922. ri->cache_info.routerlist_index = -1;
  1923. ri->nickname = tor_strdup(options->Nickname);
  1924. ri->addr = addr;
  1925. ri->or_port = router_get_advertised_or_port(options);
  1926. ri->dir_port = router_get_advertised_dir_port(options, 0);
  1927. ri->supports_tunnelled_dir_requests =
  1928. directory_permits_begindir_requests(options);
  1929. ri->cache_info.published_on = time(NULL);
  1930. ri->onion_pkey = crypto_pk_dup_key(get_onion_key()); /* must invoke from
  1931. * main thread */
  1932. ri->onion_curve25519_pkey =
  1933. tor_memdup(&get_current_curve25519_keypair()->pubkey,
  1934. sizeof(curve25519_public_key_t));
  1935. /* For now, at most one IPv6 or-address is being advertised. */
  1936. {
  1937. const port_cfg_t *ipv6_orport = NULL;
  1938. SMARTLIST_FOREACH_BEGIN(get_configured_ports(), const port_cfg_t *, p) {
  1939. if (p->type == CONN_TYPE_OR_LISTENER &&
  1940. ! p->server_cfg.no_advertise &&
  1941. ! p->server_cfg.bind_ipv4_only &&
  1942. tor_addr_family(&p->addr) == AF_INET6) {
  1943. /* Like IPv4, if the relay is configured using the default
  1944. * authorities, disallow internal IPs. Otherwise, allow them. */
  1945. const int default_auth = using_default_dir_authorities(options);
  1946. if (! tor_addr_is_internal(&p->addr, 0) || ! default_auth) {
  1947. ipv6_orport = p;
  1948. break;
  1949. } else {
  1950. char addrbuf[TOR_ADDR_BUF_LEN];
  1951. log_warn(LD_CONFIG,
  1952. "Unable to use configured IPv6 address \"%s\" in a "
  1953. "descriptor. Skipping it. "
  1954. "Try specifying a globally reachable address explicitly.",
  1955. tor_addr_to_str(addrbuf, &p->addr, sizeof(addrbuf), 1));
  1956. }
  1957. }
  1958. } SMARTLIST_FOREACH_END(p);
  1959. if (ipv6_orport) {
  1960. tor_addr_copy(&ri->ipv6_addr, &ipv6_orport->addr);
  1961. ri->ipv6_orport = ipv6_orport->port;
  1962. }
  1963. }
  1964. ri->identity_pkey = crypto_pk_dup_key(get_server_identity_key());
  1965. if (crypto_pk_get_digest(ri->identity_pkey,
  1966. ri->cache_info.identity_digest)<0) {
  1967. routerinfo_free(ri);
  1968. return -1;
  1969. }
  1970. ri->cache_info.signing_key_cert =
  1971. tor_cert_dup(get_master_signing_key_cert());
  1972. get_platform_str(platform, sizeof(platform));
  1973. ri->platform = tor_strdup(platform);
  1974. ri->protocol_list = tor_strdup(protover_get_supported_protocols());
  1975. /* compute ri->bandwidthrate as the min of various options */
  1976. ri->bandwidthrate = get_effective_bwrate(options);
  1977. /* and compute ri->bandwidthburst similarly */
  1978. ri->bandwidthburst = get_effective_bwburst(options);
  1979. ri->bandwidthcapacity = hibernating ? 0 : rep_hist_bandwidth_assess();
  1980. if (dns_seems_to_be_broken() || has_dns_init_failed()) {
  1981. /* DNS is screwed up; don't claim to be an exit. */
  1982. policies_exit_policy_append_reject_star(&ri->exit_policy);
  1983. } else {
  1984. policies_parse_exit_policy_from_options(options,ri->addr,&ri->ipv6_addr,
  1985. &ri->exit_policy);
  1986. }
  1987. ri->policy_is_reject_star =
  1988. policy_is_reject_star(ri->exit_policy, AF_INET, 1) &&
  1989. policy_is_reject_star(ri->exit_policy, AF_INET6, 1);
  1990. if (options->IPv6Exit) {
  1991. char *p_tmp = policy_summarize(ri->exit_policy, AF_INET6);
  1992. if (p_tmp)
  1993. ri->ipv6_exit_policy = parse_short_policy(p_tmp);
  1994. tor_free(p_tmp);
  1995. }
  1996. if (options->MyFamily && ! options->BridgeRelay) {
  1997. smartlist_t *family;
  1998. if (!warned_nonexistent_family)
  1999. warned_nonexistent_family = smartlist_new();
  2000. family = smartlist_new();
  2001. ri->declared_family = smartlist_new();
  2002. smartlist_split_string(family, options->MyFamily, ",",
  2003. SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK|SPLIT_STRIP_SPACE, 0);
  2004. SMARTLIST_FOREACH_BEGIN(family, char *, name) {
  2005. const node_t *member;
  2006. if (!strcasecmp(name, options->Nickname))
  2007. goto skip; /* Don't list ourself, that's redundant */
  2008. else
  2009. member = node_get_by_nickname(name, 1);
  2010. if (!member) {
  2011. int is_legal = is_legal_nickname_or_hexdigest(name);
  2012. if (!smartlist_contains_string(warned_nonexistent_family, name) &&
  2013. !is_legal_hexdigest(name)) {
  2014. if (is_legal)
  2015. log_warn(LD_CONFIG,
  2016. "I have no descriptor for the router named \"%s\" in my "
  2017. "declared family; I'll use the nickname as is, but "
  2018. "this may confuse clients.", name);
  2019. else
  2020. log_warn(LD_CONFIG, "There is a router named \"%s\" in my "
  2021. "declared family, but that isn't a legal nickname. "
  2022. "Skipping it.", escaped(name));
  2023. smartlist_add(warned_nonexistent_family, tor_strdup(name));
  2024. }
  2025. if (is_legal) {
  2026. smartlist_add(ri->declared_family, name);
  2027. name = NULL;
  2028. }
  2029. } else if (router_digest_is_me(member->identity)) {
  2030. /* Don't list ourself in our own family; that's redundant */
  2031. /* XXX shouldn't be possible */
  2032. } else {
  2033. char *fp = tor_malloc(HEX_DIGEST_LEN+2);
  2034. fp[0] = '$';
  2035. base16_encode(fp+1,HEX_DIGEST_LEN+1,
  2036. member->identity, DIGEST_LEN);
  2037. smartlist_add(ri->declared_family, fp);
  2038. if (smartlist_contains_string(warned_nonexistent_family, name))
  2039. smartlist_string_remove(warned_nonexistent_family, name);
  2040. }
  2041. skip:
  2042. tor_free(name);
  2043. } SMARTLIST_FOREACH_END(name);
  2044. /* remove duplicates from the list */
  2045. smartlist_sort_strings(ri->declared_family);
  2046. smartlist_uniq_strings(ri->declared_family);
  2047. smartlist_free(family);
  2048. }
  2049. /* Now generate the extrainfo. */
  2050. ei = tor_malloc_zero(sizeof(extrainfo_t));
  2051. ei->cache_info.is_extrainfo = 1;
  2052. strlcpy(ei->nickname, get_options()->Nickname, sizeof(ei->nickname));
  2053. ei->cache_info.published_on = ri->cache_info.published_on;
  2054. ei->cache_info.signing_key_cert =
  2055. tor_cert_dup(get_master_signing_key_cert());
  2056. memcpy(ei->cache_info.identity_digest, ri->cache_info.identity_digest,
  2057. DIGEST_LEN);
  2058. if (extrainfo_dump_to_string(&ei->cache_info.signed_descriptor_body,
  2059. ei, get_server_identity_key(),
  2060. get_master_signing_keypair()) < 0) {
  2061. log_warn(LD_BUG, "Couldn't generate extra-info descriptor.");
  2062. extrainfo_free(ei);
  2063. ei = NULL;
  2064. } else {
  2065. ei->cache_info.signed_descriptor_len =
  2066. strlen(ei->cache_info.signed_descriptor_body);
  2067. router_get_extrainfo_hash(ei->cache_info.signed_descriptor_body,
  2068. ei->cache_info.signed_descriptor_len,
  2069. ei->cache_info.signed_descriptor_digest);
  2070. crypto_digest256((char*) ei->digest256,
  2071. ei->cache_info.signed_descriptor_body,
  2072. ei->cache_info.signed_descriptor_len,
  2073. DIGEST_SHA256);
  2074. }
  2075. /* Now finish the router descriptor. */
  2076. if (ei) {
  2077. memcpy(ri->cache_info.extra_info_digest,
  2078. ei->cache_info.signed_descriptor_digest,
  2079. DIGEST_LEN);
  2080. memcpy(ri->cache_info.extra_info_digest256,
  2081. ei->digest256,
  2082. DIGEST256_LEN);
  2083. } else {
  2084. /* ri was allocated with tor_malloc_zero, so there is no need to
  2085. * zero ri->cache_info.extra_info_digest here. */
  2086. }
  2087. if (! (ri->cache_info.signed_descriptor_body =
  2088. router_dump_router_to_string(ri, get_server_identity_key(),
  2089. get_onion_key(),
  2090. get_current_curve25519_keypair(),
  2091. get_master_signing_keypair())) ) {
  2092. log_warn(LD_BUG, "Couldn't generate router descriptor.");
  2093. routerinfo_free(ri);
  2094. extrainfo_free(ei);
  2095. return -1;
  2096. }
  2097. ri->cache_info.signed_descriptor_len =
  2098. strlen(ri->cache_info.signed_descriptor_body);
  2099. ri->purpose =
  2100. options->BridgeRelay ? ROUTER_PURPOSE_BRIDGE : ROUTER_PURPOSE_GENERAL;
  2101. if (options->BridgeRelay) {
  2102. /* Bridges shouldn't be able to send their descriptors unencrypted,
  2103. anyway, since they don't have a DirPort, and always connect to the
  2104. bridge authority anonymously. But just in case they somehow think of
  2105. sending them on an unencrypted connection, don't allow them to try. */
  2106. ri->cache_info.send_unencrypted = 0;
  2107. if (ei)
  2108. ei->cache_info.send_unencrypted = 0;
  2109. } else {
  2110. ri->cache_info.send_unencrypted = 1;
  2111. if (ei)
  2112. ei->cache_info.send_unencrypted = 1;
  2113. }
  2114. router_get_router_hash(ri->cache_info.signed_descriptor_body,
  2115. strlen(ri->cache_info.signed_descriptor_body),
  2116. ri->cache_info.signed_descriptor_digest);
  2117. if (ei) {
  2118. tor_assert(!
  2119. routerinfo_incompatible_with_extrainfo(ri->identity_pkey, ei,
  2120. &ri->cache_info, NULL));
  2121. }
  2122. *r = ri;
  2123. *e = ei;
  2124. return 0;
  2125. }
  2126. /** If <b>force</b> is true, or our descriptor is out-of-date, rebuild a fresh
  2127. * routerinfo, signed server descriptor, and extra-info document for this OR.
  2128. * Return 0 on success, -1 on temporary error.
  2129. */
  2130. int
  2131. router_rebuild_descriptor(int force)
  2132. {
  2133. routerinfo_t *ri;
  2134. extrainfo_t *ei;
  2135. uint32_t addr;
  2136. const or_options_t *options = get_options();
  2137. if (desc_clean_since && !force)
  2138. return 0;
  2139. if (router_pick_published_address(options, &addr, 0) < 0 ||
  2140. router_get_advertised_or_port(options) == 0) {
  2141. /* Stop trying to rebuild our descriptor every second. We'll
  2142. * learn that it's time to try again when ip_address_changed()
  2143. * marks it dirty. */
  2144. desc_clean_since = time(NULL);
  2145. return -1;
  2146. }
  2147. log_info(LD_OR, "Rebuilding relay descriptor%s", force ? " (forced)" : "");
  2148. if (router_build_fresh_descriptor(&ri, &ei) < 0) {
  2149. return -1;
  2150. }
  2151. routerinfo_free(desc_routerinfo);
  2152. desc_routerinfo = ri;
  2153. extrainfo_free(desc_extrainfo);
  2154. desc_extrainfo = ei;
  2155. desc_clean_since = time(NULL);
  2156. desc_needs_upload = 1;
  2157. desc_gen_reason = desc_dirty_reason;
  2158. desc_dirty_reason = NULL;
  2159. control_event_my_descriptor_changed();
  2160. return 0;
  2161. }
  2162. /** If our router descriptor ever goes this long without being regenerated
  2163. * because something changed, we force an immediate regenerate-and-upload. */
  2164. #define FORCE_REGENERATE_DESCRIPTOR_INTERVAL (18*60*60)
  2165. /** If our router descriptor seems to be missing or unacceptable according
  2166. * to the authorities, regenerate and reupload it _this_ often. */
  2167. #define FAST_RETRY_DESCRIPTOR_INTERVAL (90*60)
  2168. /** Mark descriptor out of date if it's been "too long" since we last tried
  2169. * to upload one. */
  2170. void
  2171. mark_my_descriptor_dirty_if_too_old(time_t now)
  2172. {
  2173. networkstatus_t *ns;
  2174. const routerstatus_t *rs;
  2175. const char *retry_fast_reason = NULL; /* Set if we should retry frequently */
  2176. const time_t slow_cutoff = now - FORCE_REGENERATE_DESCRIPTOR_INTERVAL;
  2177. const time_t fast_cutoff = now - FAST_RETRY_DESCRIPTOR_INTERVAL;
  2178. /* If it's already dirty, don't mark it. */
  2179. if (! desc_clean_since)
  2180. return;
  2181. /* If it's older than FORCE_REGENERATE_DESCRIPTOR_INTERVAL, it's always
  2182. * time to rebuild it. */
  2183. if (desc_clean_since < slow_cutoff) {
  2184. mark_my_descriptor_dirty("time for new descriptor");
  2185. return;
  2186. }
  2187. /* Now we see whether we want to be retrying frequently or no. The
  2188. * rule here is that we'll retry frequently if we aren't listed in the
  2189. * live consensus we have, or if the publication time of the
  2190. * descriptor listed for us in the consensus is very old. */
  2191. ns = networkstatus_get_live_consensus(now);
  2192. if (ns) {
  2193. rs = networkstatus_vote_find_entry(ns, server_identitykey_digest);
  2194. if (rs == NULL)
  2195. retry_fast_reason = "not listed in consensus";
  2196. else if (rs->published_on < slow_cutoff)
  2197. retry_fast_reason = "version listed in consensus is quite old";
  2198. }
  2199. if (retry_fast_reason && desc_clean_since < fast_cutoff)
  2200. mark_my_descriptor_dirty(retry_fast_reason);
  2201. }
  2202. /** Call when the current descriptor is out of date. */
  2203. void
  2204. mark_my_descriptor_dirty(const char *reason)
  2205. {
  2206. const or_options_t *options = get_options();
  2207. if (server_mode(options) && options->PublishServerDescriptor_)
  2208. log_info(LD_OR, "Decided to publish new relay descriptor: %s", reason);
  2209. desc_clean_since = 0;
  2210. if (!desc_dirty_reason)
  2211. desc_dirty_reason = reason;
  2212. }
  2213. /** How frequently will we republish our descriptor because of large (factor
  2214. * of 2) shifts in estimated bandwidth? Note: We don't use this constant
  2215. * if our previous bandwidth estimate was exactly 0. */
  2216. #define MAX_BANDWIDTH_CHANGE_FREQ (3*60*60)
  2217. /** Check whether bandwidth has changed a lot since the last time we announced
  2218. * bandwidth. If so, mark our descriptor dirty. */
  2219. void
  2220. check_descriptor_bandwidth_changed(time_t now)
  2221. {
  2222. static time_t last_changed = 0;
  2223. uint64_t prev, cur;
  2224. if (!router_get_my_routerinfo())
  2225. return;
  2226. prev = router_get_my_routerinfo()->bandwidthcapacity;
  2227. cur = we_are_hibernating() ? 0 : rep_hist_bandwidth_assess();
  2228. if ((prev != cur && (!prev || !cur)) ||
  2229. cur > prev*2 ||
  2230. cur < prev/2) {
  2231. if (last_changed+MAX_BANDWIDTH_CHANGE_FREQ < now || !prev) {
  2232. log_info(LD_GENERAL,
  2233. "Measured bandwidth has changed; rebuilding descriptor.");
  2234. mark_my_descriptor_dirty("bandwidth has changed");
  2235. last_changed = now;
  2236. }
  2237. }
  2238. }
  2239. /** Note at log level severity that our best guess of address has changed from
  2240. * <b>prev</b> to <b>cur</b>. */
  2241. static void
  2242. log_addr_has_changed(int severity,
  2243. const tor_addr_t *prev,
  2244. const tor_addr_t *cur,
  2245. const char *source)
  2246. {
  2247. char addrbuf_prev[TOR_ADDR_BUF_LEN];
  2248. char addrbuf_cur[TOR_ADDR_BUF_LEN];
  2249. if (tor_addr_to_str(addrbuf_prev, prev, sizeof(addrbuf_prev), 1) == NULL)
  2250. strlcpy(addrbuf_prev, "???", TOR_ADDR_BUF_LEN);
  2251. if (tor_addr_to_str(addrbuf_cur, cur, sizeof(addrbuf_cur), 1) == NULL)
  2252. strlcpy(addrbuf_cur, "???", TOR_ADDR_BUF_LEN);
  2253. if (!tor_addr_is_null(prev))
  2254. log_fn(severity, LD_GENERAL,
  2255. "Our IP Address has changed from %s to %s; "
  2256. "rebuilding descriptor (source: %s).",
  2257. addrbuf_prev, addrbuf_cur, source);
  2258. else
  2259. log_notice(LD_GENERAL,
  2260. "Guessed our IP address as %s (source: %s).",
  2261. addrbuf_cur, source);
  2262. }
  2263. /** Check whether our own address as defined by the Address configuration
  2264. * has changed. This is for routers that get their address from a service
  2265. * like dyndns. If our address has changed, mark our descriptor dirty. */
  2266. void
  2267. check_descriptor_ipaddress_changed(time_t now)
  2268. {
  2269. uint32_t prev, cur;
  2270. const or_options_t *options = get_options();
  2271. const char *method = NULL;
  2272. char *hostname = NULL;
  2273. (void) now;
  2274. if (router_get_my_routerinfo() == NULL)
  2275. return;
  2276. /* XXXX ipv6 */
  2277. prev = router_get_my_routerinfo()->addr;
  2278. if (resolve_my_address(LOG_INFO, options, &cur, &method, &hostname) < 0) {
  2279. log_info(LD_CONFIG,"options->Address didn't resolve into an IP.");
  2280. return;
  2281. }
  2282. if (prev != cur) {
  2283. char *source;
  2284. tor_addr_t tmp_prev, tmp_cur;
  2285. tor_addr_from_ipv4h(&tmp_prev, prev);
  2286. tor_addr_from_ipv4h(&tmp_cur, cur);
  2287. tor_asprintf(&source, "METHOD=%s%s%s", method,
  2288. hostname ? " HOSTNAME=" : "",
  2289. hostname ? hostname : "");
  2290. log_addr_has_changed(LOG_NOTICE, &tmp_prev, &tmp_cur, source);
  2291. tor_free(source);
  2292. ip_address_changed(0);
  2293. }
  2294. tor_free(hostname);
  2295. }
  2296. /** The most recently guessed value of our IP address, based on directory
  2297. * headers. */
  2298. static tor_addr_t last_guessed_ip = TOR_ADDR_NULL;
  2299. /** A directory server <b>d_conn</b> told us our IP address is
  2300. * <b>suggestion</b>.
  2301. * If this address is different from the one we think we are now, and
  2302. * if our computer doesn't actually know its IP address, then switch. */
  2303. void
  2304. router_new_address_suggestion(const char *suggestion,
  2305. const dir_connection_t *d_conn)
  2306. {
  2307. tor_addr_t addr;
  2308. uint32_t cur = 0; /* Current IPv4 address. */
  2309. const or_options_t *options = get_options();
  2310. /* first, learn what the IP address actually is */
  2311. if (tor_addr_parse(&addr, suggestion) == -1) {
  2312. log_debug(LD_DIR, "Malformed X-Your-Address-Is header %s. Ignoring.",
  2313. escaped(suggestion));
  2314. return;
  2315. }
  2316. log_debug(LD_DIR, "Got X-Your-Address-Is: %s.", suggestion);
  2317. if (!server_mode(options)) {
  2318. tor_addr_copy(&last_guessed_ip, &addr);
  2319. return;
  2320. }
  2321. /* XXXX ipv6 */
  2322. cur = get_last_resolved_addr();
  2323. if (cur ||
  2324. resolve_my_address(LOG_INFO, options, &cur, NULL, NULL) >= 0) {
  2325. /* We're all set -- we already know our address. Great. */
  2326. tor_addr_from_ipv4h(&last_guessed_ip, cur); /* store it in case we
  2327. need it later */
  2328. return;
  2329. }
  2330. if (tor_addr_is_internal(&addr, 0)) {
  2331. /* Don't believe anybody who says our IP is, say, 127.0.0.1. */
  2332. return;
  2333. }
  2334. if (tor_addr_eq(&d_conn->base_.addr, &addr)) {
  2335. /* Don't believe anybody who says our IP is their IP. */
  2336. log_debug(LD_DIR, "A directory server told us our IP address is %s, "
  2337. "but they are just reporting their own IP address. Ignoring.",
  2338. suggestion);
  2339. return;
  2340. }
  2341. /* Okay. We can't resolve our own address, and X-Your-Address-Is is giving
  2342. * us an answer different from what we had the last time we managed to
  2343. * resolve it. */
  2344. if (!tor_addr_eq(&last_guessed_ip, &addr)) {
  2345. control_event_server_status(LOG_NOTICE,
  2346. "EXTERNAL_ADDRESS ADDRESS=%s METHOD=DIRSERV",
  2347. suggestion);
  2348. log_addr_has_changed(LOG_NOTICE, &last_guessed_ip, &addr,
  2349. d_conn->base_.address);
  2350. ip_address_changed(0);
  2351. tor_addr_copy(&last_guessed_ip, &addr); /* router_rebuild_descriptor()
  2352. will fetch it */
  2353. }
  2354. }
  2355. /** We failed to resolve our address locally, but we'd like to build
  2356. * a descriptor and publish / test reachability. If we have a guess
  2357. * about our address based on directory headers, answer it and return
  2358. * 0; else return -1. */
  2359. static int
  2360. router_guess_address_from_dir_headers(uint32_t *guess)
  2361. {
  2362. if (!tor_addr_is_null(&last_guessed_ip)) {
  2363. *guess = tor_addr_to_ipv4h(&last_guessed_ip);
  2364. return 0;
  2365. }
  2366. return -1;
  2367. }
  2368. /** Set <b>platform</b> (max length <b>len</b>) to a NUL-terminated short
  2369. * string describing the version of Tor and the operating system we're
  2370. * currently running on.
  2371. */
  2372. STATIC void
  2373. get_platform_str(char *platform, size_t len)
  2374. {
  2375. tor_snprintf(platform, len, "Tor %s on %s",
  2376. get_short_version(), get_uname());
  2377. }
  2378. /* XXX need to audit this thing and count fenceposts. maybe
  2379. * refactor so we don't have to keep asking if we're
  2380. * near the end of maxlen?
  2381. */
  2382. #define DEBUG_ROUTER_DUMP_ROUTER_TO_STRING
  2383. /** OR only: Given a routerinfo for this router, and an identity key to sign
  2384. * with, encode the routerinfo as a signed server descriptor and return a new
  2385. * string encoding the result, or NULL on failure.
  2386. */
  2387. char *
  2388. router_dump_router_to_string(routerinfo_t *router,
  2389. const crypto_pk_t *ident_key,
  2390. const crypto_pk_t *tap_key,
  2391. const curve25519_keypair_t *ntor_keypair,
  2392. const ed25519_keypair_t *signing_keypair)
  2393. {
  2394. char *address = NULL;
  2395. char *onion_pkey = NULL; /* Onion key, PEM-encoded. */
  2396. char *identity_pkey = NULL; /* Identity key, PEM-encoded. */
  2397. char digest[DIGEST256_LEN];
  2398. char published[ISO_TIME_LEN+1];
  2399. char fingerprint[FINGERPRINT_LEN+1];
  2400. char *extra_info_line = NULL;
  2401. size_t onion_pkeylen, identity_pkeylen;
  2402. char *family_line = NULL;
  2403. char *extra_or_address = NULL;
  2404. const or_options_t *options = get_options();
  2405. smartlist_t *chunks = NULL;
  2406. char *output = NULL;
  2407. const int emit_ed_sigs = signing_keypair &&
  2408. router->cache_info.signing_key_cert;
  2409. char *ed_cert_line = NULL;
  2410. char *rsa_tap_cc_line = NULL;
  2411. char *ntor_cc_line = NULL;
  2412. char *proto_line = NULL;
  2413. /* Make sure the identity key matches the one in the routerinfo. */
  2414. if (!crypto_pk_eq_keys(ident_key, router->identity_pkey)) {
  2415. log_warn(LD_BUG,"Tried to sign a router with a private key that didn't "
  2416. "match router's public key!");
  2417. goto err;
  2418. }
  2419. if (emit_ed_sigs) {
  2420. if (!router->cache_info.signing_key_cert->signing_key_included ||
  2421. !ed25519_pubkey_eq(&router->cache_info.signing_key_cert->signed_key,
  2422. &signing_keypair->pubkey)) {
  2423. log_warn(LD_BUG, "Tried to sign a router descriptor with a mismatched "
  2424. "ed25519 key chain %d",
  2425. router->cache_info.signing_key_cert->signing_key_included);
  2426. goto err;
  2427. }
  2428. }
  2429. /* record our fingerprint, so we can include it in the descriptor */
  2430. if (crypto_pk_get_fingerprint(router->identity_pkey, fingerprint, 1)<0) {
  2431. log_err(LD_BUG,"Error computing fingerprint");
  2432. goto err;
  2433. }
  2434. if (emit_ed_sigs) {
  2435. /* Encode ed25519 signing cert */
  2436. char ed_cert_base64[256];
  2437. char ed_fp_base64[ED25519_BASE64_LEN+1];
  2438. if (base64_encode(ed_cert_base64, sizeof(ed_cert_base64),
  2439. (const char*)router->cache_info.signing_key_cert->encoded,
  2440. router->cache_info.signing_key_cert->encoded_len,
  2441. BASE64_ENCODE_MULTILINE) < 0) {
  2442. log_err(LD_BUG,"Couldn't base64-encode signing key certificate!");
  2443. goto err;
  2444. }
  2445. if (ed25519_public_to_base64(ed_fp_base64,
  2446. &router->cache_info.signing_key_cert->signing_key)<0) {
  2447. log_err(LD_BUG,"Couldn't base64-encode identity key\n");
  2448. goto err;
  2449. }
  2450. tor_asprintf(&ed_cert_line, "identity-ed25519\n"
  2451. "-----BEGIN ED25519 CERT-----\n"
  2452. "%s"
  2453. "-----END ED25519 CERT-----\n"
  2454. "master-key-ed25519 %s\n",
  2455. ed_cert_base64, ed_fp_base64);
  2456. }
  2457. /* PEM-encode the onion key */
  2458. if (crypto_pk_write_public_key_to_string(router->onion_pkey,
  2459. &onion_pkey,&onion_pkeylen)<0) {
  2460. log_warn(LD_BUG,"write onion_pkey to string failed!");
  2461. goto err;
  2462. }
  2463. /* PEM-encode the identity key */
  2464. if (crypto_pk_write_public_key_to_string(router->identity_pkey,
  2465. &identity_pkey,&identity_pkeylen)<0) {
  2466. log_warn(LD_BUG,"write identity_pkey to string failed!");
  2467. goto err;
  2468. }
  2469. /* Cross-certify with RSA key */
  2470. if (tap_key && router->cache_info.signing_key_cert &&
  2471. router->cache_info.signing_key_cert->signing_key_included) {
  2472. char buf[256];
  2473. int tap_cc_len = 0;
  2474. uint8_t *tap_cc =
  2475. make_tap_onion_key_crosscert(tap_key,
  2476. &router->cache_info.signing_key_cert->signing_key,
  2477. router->identity_pkey,
  2478. &tap_cc_len);
  2479. if (!tap_cc) {
  2480. log_warn(LD_BUG,"make_tap_onion_key_crosscert failed!");
  2481. goto err;
  2482. }
  2483. if (base64_encode(buf, sizeof(buf), (const char*)tap_cc, tap_cc_len,
  2484. BASE64_ENCODE_MULTILINE) < 0) {
  2485. log_warn(LD_BUG,"base64_encode(rsa_crosscert) failed!");
  2486. tor_free(tap_cc);
  2487. goto err;
  2488. }
  2489. tor_free(tap_cc);
  2490. tor_asprintf(&rsa_tap_cc_line,
  2491. "onion-key-crosscert\n"
  2492. "-----BEGIN CROSSCERT-----\n"
  2493. "%s"
  2494. "-----END CROSSCERT-----\n", buf);
  2495. }
  2496. /* Cross-certify with onion keys */
  2497. if (ntor_keypair && router->cache_info.signing_key_cert &&
  2498. router->cache_info.signing_key_cert->signing_key_included) {
  2499. int sign = 0;
  2500. char buf[256];
  2501. /* XXXX Base the expiration date on the actual onion key expiration time?*/
  2502. tor_cert_t *cert =
  2503. make_ntor_onion_key_crosscert(ntor_keypair,
  2504. &router->cache_info.signing_key_cert->signing_key,
  2505. router->cache_info.published_on,
  2506. MIN_ONION_KEY_LIFETIME, &sign);
  2507. if (!cert) {
  2508. log_warn(LD_BUG,"make_ntor_onion_key_crosscert failed!");
  2509. goto err;
  2510. }
  2511. tor_assert(sign == 0 || sign == 1);
  2512. if (base64_encode(buf, sizeof(buf),
  2513. (const char*)cert->encoded, cert->encoded_len,
  2514. BASE64_ENCODE_MULTILINE)<0) {
  2515. log_warn(LD_BUG,"base64_encode(ntor_crosscert) failed!");
  2516. tor_cert_free(cert);
  2517. goto err;
  2518. }
  2519. tor_cert_free(cert);
  2520. tor_asprintf(&ntor_cc_line,
  2521. "ntor-onion-key-crosscert %d\n"
  2522. "-----BEGIN ED25519 CERT-----\n"
  2523. "%s"
  2524. "-----END ED25519 CERT-----\n", sign, buf);
  2525. }
  2526. /* Encode the publication time. */
  2527. format_iso_time(published, router->cache_info.published_on);
  2528. if (router->declared_family && smartlist_len(router->declared_family)) {
  2529. char *family = smartlist_join_strings(router->declared_family,
  2530. " ", 0, NULL);
  2531. tor_asprintf(&family_line, "family %s\n", family);
  2532. tor_free(family);
  2533. } else {
  2534. family_line = tor_strdup("");
  2535. }
  2536. if (!tor_digest_is_zero(router->cache_info.extra_info_digest)) {
  2537. char extra_info_digest[HEX_DIGEST_LEN+1];
  2538. base16_encode(extra_info_digest, sizeof(extra_info_digest),
  2539. router->cache_info.extra_info_digest, DIGEST_LEN);
  2540. if (!tor_digest256_is_zero(router->cache_info.extra_info_digest256)) {
  2541. char d256_64[BASE64_DIGEST256_LEN+1];
  2542. digest256_to_base64(d256_64, router->cache_info.extra_info_digest256);
  2543. tor_asprintf(&extra_info_line, "extra-info-digest %s %s\n",
  2544. extra_info_digest, d256_64);
  2545. } else {
  2546. tor_asprintf(&extra_info_line, "extra-info-digest %s\n",
  2547. extra_info_digest);
  2548. }
  2549. }
  2550. if (router->ipv6_orport &&
  2551. tor_addr_family(&router->ipv6_addr) == AF_INET6) {
  2552. char addr[TOR_ADDR_BUF_LEN];
  2553. const char *a;
  2554. a = tor_addr_to_str(addr, &router->ipv6_addr, sizeof(addr), 1);
  2555. if (a) {
  2556. tor_asprintf(&extra_or_address,
  2557. "or-address %s:%d\n", a, router->ipv6_orport);
  2558. log_debug(LD_OR, "My or-address line is <%s>", extra_or_address);
  2559. }
  2560. }
  2561. if (router->protocol_list) {
  2562. tor_asprintf(&proto_line, "proto %s\n", router->protocol_list);
  2563. } else {
  2564. proto_line = tor_strdup("");
  2565. }
  2566. address = tor_dup_ip(router->addr);
  2567. chunks = smartlist_new();
  2568. /* Generate the easy portion of the router descriptor. */
  2569. smartlist_add_asprintf(chunks,
  2570. "router %s %s %d 0 %d\n"
  2571. "%s"
  2572. "%s"
  2573. "platform %s\n"
  2574. "%s"
  2575. "published %s\n"
  2576. "fingerprint %s\n"
  2577. "uptime %ld\n"
  2578. "bandwidth %d %d %d\n"
  2579. "%s%s"
  2580. "onion-key\n%s"
  2581. "signing-key\n%s"
  2582. "%s%s"
  2583. "%s%s%s%s",
  2584. router->nickname,
  2585. address,
  2586. router->or_port,
  2587. decide_to_advertise_dirport(options, router->dir_port),
  2588. ed_cert_line ? ed_cert_line : "",
  2589. extra_or_address ? extra_or_address : "",
  2590. router->platform,
  2591. proto_line,
  2592. published,
  2593. fingerprint,
  2594. stats_n_seconds_working,
  2595. (int) router->bandwidthrate,
  2596. (int) router->bandwidthburst,
  2597. (int) router->bandwidthcapacity,
  2598. extra_info_line ? extra_info_line : "",
  2599. (options->DownloadExtraInfo || options->V3AuthoritativeDir) ?
  2600. "caches-extra-info\n" : "",
  2601. onion_pkey, identity_pkey,
  2602. rsa_tap_cc_line ? rsa_tap_cc_line : "",
  2603. ntor_cc_line ? ntor_cc_line : "",
  2604. family_line,
  2605. we_are_hibernating() ? "hibernating 1\n" : "",
  2606. "hidden-service-dir\n",
  2607. options->AllowSingleHopExits ? "allow-single-hop-exits\n" : "");
  2608. if (options->ContactInfo && strlen(options->ContactInfo)) {
  2609. const char *ci = options->ContactInfo;
  2610. if (strchr(ci, '\n') || strchr(ci, '\r'))
  2611. ci = escaped(ci);
  2612. smartlist_add_asprintf(chunks, "contact %s\n", ci);
  2613. }
  2614. if (options->BridgeRelay) {
  2615. const char *bd;
  2616. if (options->PublishServerDescriptor_ & BRIDGE_DIRINFO)
  2617. bd = "any";
  2618. else
  2619. bd = "none";
  2620. smartlist_add_asprintf(chunks, "bridge-distribution-request %s\n", bd);
  2621. }
  2622. if (router->onion_curve25519_pkey) {
  2623. char kbuf[128];
  2624. base64_encode(kbuf, sizeof(kbuf),
  2625. (const char *)router->onion_curve25519_pkey->public_key,
  2626. CURVE25519_PUBKEY_LEN, BASE64_ENCODE_MULTILINE);
  2627. smartlist_add_asprintf(chunks, "ntor-onion-key %s", kbuf);
  2628. } else {
  2629. /* Authorities will start rejecting relays without ntor keys in 0.2.9 */
  2630. log_err(LD_BUG, "A relay must have an ntor onion key");
  2631. goto err;
  2632. }
  2633. /* Write the exit policy to the end of 's'. */
  2634. if (!router->exit_policy || !smartlist_len(router->exit_policy)) {
  2635. smartlist_add(chunks, tor_strdup("reject *:*\n"));
  2636. } else if (router->exit_policy) {
  2637. char *exit_policy = router_dump_exit_policy_to_string(router,1,0);
  2638. if (!exit_policy)
  2639. goto err;
  2640. smartlist_add_asprintf(chunks, "%s\n", exit_policy);
  2641. tor_free(exit_policy);
  2642. }
  2643. if (router->ipv6_exit_policy) {
  2644. char *p6 = write_short_policy(router->ipv6_exit_policy);
  2645. if (p6 && strcmp(p6, "reject 1-65535")) {
  2646. smartlist_add_asprintf(chunks,
  2647. "ipv6-policy %s\n", p6);
  2648. }
  2649. tor_free(p6);
  2650. }
  2651. if (decide_to_advertise_begindir(options,
  2652. router->supports_tunnelled_dir_requests)) {
  2653. smartlist_add(chunks, tor_strdup("tunnelled-dir-server\n"));
  2654. }
  2655. /* Sign the descriptor with Ed25519 */
  2656. if (emit_ed_sigs) {
  2657. smartlist_add(chunks, tor_strdup("router-sig-ed25519 "));
  2658. crypto_digest_smartlist_prefix(digest, DIGEST256_LEN,
  2659. ED_DESC_SIGNATURE_PREFIX,
  2660. chunks, "", DIGEST_SHA256);
  2661. ed25519_signature_t sig;
  2662. char buf[ED25519_SIG_BASE64_LEN+1];
  2663. if (ed25519_sign(&sig, (const uint8_t*)digest, DIGEST256_LEN,
  2664. signing_keypair) < 0)
  2665. goto err;
  2666. if (ed25519_signature_to_base64(buf, &sig) < 0)
  2667. goto err;
  2668. smartlist_add_asprintf(chunks, "%s\n", buf);
  2669. }
  2670. /* Sign the descriptor with RSA */
  2671. smartlist_add(chunks, tor_strdup("router-signature\n"));
  2672. crypto_digest_smartlist(digest, DIGEST_LEN, chunks, "", DIGEST_SHA1);
  2673. note_crypto_pk_op(SIGN_RTR);
  2674. {
  2675. char *sig;
  2676. if (!(sig = router_get_dirobj_signature(digest, DIGEST_LEN, ident_key))) {
  2677. log_warn(LD_BUG, "Couldn't sign router descriptor");
  2678. goto err;
  2679. }
  2680. smartlist_add(chunks, sig);
  2681. }
  2682. /* include a last '\n' */
  2683. smartlist_add(chunks, tor_strdup("\n"));
  2684. output = smartlist_join_strings(chunks, "", 0, NULL);
  2685. #ifdef DEBUG_ROUTER_DUMP_ROUTER_TO_STRING
  2686. {
  2687. char *s_dup;
  2688. const char *cp;
  2689. routerinfo_t *ri_tmp;
  2690. cp = s_dup = tor_strdup(output);
  2691. ri_tmp = router_parse_entry_from_string(cp, NULL, 1, 0, NULL, NULL);
  2692. if (!ri_tmp) {
  2693. log_err(LD_BUG,
  2694. "We just generated a router descriptor we can't parse.");
  2695. log_err(LD_BUG, "Descriptor was: <<%s>>", output);
  2696. goto err;
  2697. }
  2698. tor_free(s_dup);
  2699. routerinfo_free(ri_tmp);
  2700. }
  2701. #endif
  2702. goto done;
  2703. err:
  2704. tor_free(output); /* sets output to NULL */
  2705. done:
  2706. if (chunks) {
  2707. SMARTLIST_FOREACH(chunks, char *, cp, tor_free(cp));
  2708. smartlist_free(chunks);
  2709. }
  2710. tor_free(address);
  2711. tor_free(family_line);
  2712. tor_free(onion_pkey);
  2713. tor_free(identity_pkey);
  2714. tor_free(extra_or_address);
  2715. tor_free(ed_cert_line);
  2716. tor_free(rsa_tap_cc_line);
  2717. tor_free(ntor_cc_line);
  2718. tor_free(extra_info_line);
  2719. tor_free(proto_line);
  2720. return output;
  2721. }
  2722. /**
  2723. * OR only: Given <b>router</b>, produce a string with its exit policy.
  2724. * If <b>include_ipv4</b> is true, include IPv4 entries.
  2725. * If <b>include_ipv6</b> is true, include IPv6 entries.
  2726. */
  2727. char *
  2728. router_dump_exit_policy_to_string(const routerinfo_t *router,
  2729. int include_ipv4,
  2730. int include_ipv6)
  2731. {
  2732. if ((!router->exit_policy) || (router->policy_is_reject_star)) {
  2733. return tor_strdup("reject *:*");
  2734. }
  2735. return policy_dump_to_string(router->exit_policy,
  2736. include_ipv4,
  2737. include_ipv6);
  2738. }
  2739. /** Copy the primary (IPv4) OR port (IP address and TCP port) for
  2740. * <b>router</b> into *<b>ap_out</b>. */
  2741. void
  2742. router_get_prim_orport(const routerinfo_t *router, tor_addr_port_t *ap_out)
  2743. {
  2744. tor_assert(ap_out != NULL);
  2745. tor_addr_from_ipv4h(&ap_out->addr, router->addr);
  2746. ap_out->port = router->or_port;
  2747. }
  2748. /** Return 1 if any of <b>router</b>'s addresses are <b>addr</b>.
  2749. * Otherwise return 0. */
  2750. int
  2751. router_has_addr(const routerinfo_t *router, const tor_addr_t *addr)
  2752. {
  2753. return
  2754. tor_addr_eq_ipv4h(addr, router->addr) ||
  2755. tor_addr_eq(&router->ipv6_addr, addr);
  2756. }
  2757. int
  2758. router_has_orport(const routerinfo_t *router, const tor_addr_port_t *orport)
  2759. {
  2760. return
  2761. (tor_addr_eq_ipv4h(&orport->addr, router->addr) &&
  2762. orport->port == router->or_port) ||
  2763. (tor_addr_eq(&orport->addr, &router->ipv6_addr) &&
  2764. orport->port == router->ipv6_orport);
  2765. }
  2766. /** Load the contents of <b>filename</b>, find the last line starting with
  2767. * <b>end_line</b>, ensure that its timestamp is not more than 25 hours in
  2768. * the past or more than 1 hour in the future with respect to <b>now</b>,
  2769. * and write the file contents starting with that line to *<b>out</b>.
  2770. * Return 1 for success, 0 if the file does not exist or is empty, or -1
  2771. * if the file does not contain a line matching these criteria or other
  2772. * failure. */
  2773. static int
  2774. load_stats_file(const char *filename, const char *end_line, time_t now,
  2775. char **out)
  2776. {
  2777. int r = -1;
  2778. char *fname = get_datadir_fname(filename);
  2779. char *contents, *start = NULL, *tmp, timestr[ISO_TIME_LEN+1];
  2780. time_t written;
  2781. switch (file_status(fname)) {
  2782. case FN_FILE:
  2783. /* X022 Find an alternative to reading the whole file to memory. */
  2784. if ((contents = read_file_to_str(fname, 0, NULL))) {
  2785. tmp = strstr(contents, end_line);
  2786. /* Find last block starting with end_line */
  2787. while (tmp) {
  2788. start = tmp;
  2789. tmp = strstr(tmp + 1, end_line);
  2790. }
  2791. if (!start)
  2792. goto notfound;
  2793. if (strlen(start) < strlen(end_line) + 1 + sizeof(timestr))
  2794. goto notfound;
  2795. strlcpy(timestr, start + 1 + strlen(end_line), sizeof(timestr));
  2796. if (parse_iso_time(timestr, &written) < 0)
  2797. goto notfound;
  2798. if (written < now - (25*60*60) || written > now + (1*60*60))
  2799. goto notfound;
  2800. *out = tor_strdup(start);
  2801. r = 1;
  2802. }
  2803. notfound:
  2804. tor_free(contents);
  2805. break;
  2806. /* treat empty stats files as if the file doesn't exist */
  2807. case FN_NOENT:
  2808. case FN_EMPTY:
  2809. r = 0;
  2810. break;
  2811. case FN_ERROR:
  2812. case FN_DIR:
  2813. default:
  2814. break;
  2815. }
  2816. tor_free(fname);
  2817. return r;
  2818. }
  2819. /** Write the contents of <b>extrainfo</b> and aggregated statistics to
  2820. * *<b>s_out</b>, signing them with <b>ident_key</b>. Return 0 on
  2821. * success, negative on failure. */
  2822. int
  2823. extrainfo_dump_to_string(char **s_out, extrainfo_t *extrainfo,
  2824. crypto_pk_t *ident_key,
  2825. const ed25519_keypair_t *signing_keypair)
  2826. {
  2827. const or_options_t *options = get_options();
  2828. char identity[HEX_DIGEST_LEN+1];
  2829. char published[ISO_TIME_LEN+1];
  2830. char digest[DIGEST_LEN];
  2831. char *bandwidth_usage;
  2832. int result;
  2833. static int write_stats_to_extrainfo = 1;
  2834. char sig[DIROBJ_MAX_SIG_LEN+1];
  2835. char *s = NULL, *pre, *contents, *cp, *s_dup = NULL;
  2836. time_t now = time(NULL);
  2837. smartlist_t *chunks = smartlist_new();
  2838. extrainfo_t *ei_tmp = NULL;
  2839. const int emit_ed_sigs = signing_keypair &&
  2840. extrainfo->cache_info.signing_key_cert;
  2841. char *ed_cert_line = NULL;
  2842. base16_encode(identity, sizeof(identity),
  2843. extrainfo->cache_info.identity_digest, DIGEST_LEN);
  2844. format_iso_time(published, extrainfo->cache_info.published_on);
  2845. bandwidth_usage = rep_hist_get_bandwidth_lines();
  2846. if (emit_ed_sigs) {
  2847. if (!extrainfo->cache_info.signing_key_cert->signing_key_included ||
  2848. !ed25519_pubkey_eq(&extrainfo->cache_info.signing_key_cert->signed_key,
  2849. &signing_keypair->pubkey)) {
  2850. log_warn(LD_BUG, "Tried to sign a extrainfo descriptor with a "
  2851. "mismatched ed25519 key chain %d",
  2852. extrainfo->cache_info.signing_key_cert->signing_key_included);
  2853. goto err;
  2854. }
  2855. char ed_cert_base64[256];
  2856. if (base64_encode(ed_cert_base64, sizeof(ed_cert_base64),
  2857. (const char*)extrainfo->cache_info.signing_key_cert->encoded,
  2858. extrainfo->cache_info.signing_key_cert->encoded_len,
  2859. BASE64_ENCODE_MULTILINE) < 0) {
  2860. log_err(LD_BUG,"Couldn't base64-encode signing key certificate!");
  2861. goto err;
  2862. }
  2863. tor_asprintf(&ed_cert_line, "identity-ed25519\n"
  2864. "-----BEGIN ED25519 CERT-----\n"
  2865. "%s"
  2866. "-----END ED25519 CERT-----\n", ed_cert_base64);
  2867. } else {
  2868. ed_cert_line = tor_strdup("");
  2869. }
  2870. tor_asprintf(&pre, "extra-info %s %s\n%spublished %s\n%s",
  2871. extrainfo->nickname, identity,
  2872. ed_cert_line,
  2873. published, bandwidth_usage);
  2874. smartlist_add(chunks, pre);
  2875. if (geoip_is_loaded(AF_INET))
  2876. smartlist_add_asprintf(chunks, "geoip-db-digest %s\n",
  2877. geoip_db_digest(AF_INET));
  2878. if (geoip_is_loaded(AF_INET6))
  2879. smartlist_add_asprintf(chunks, "geoip6-db-digest %s\n",
  2880. geoip_db_digest(AF_INET6));
  2881. if (options->ExtraInfoStatistics && write_stats_to_extrainfo) {
  2882. log_info(LD_GENERAL, "Adding stats to extra-info descriptor.");
  2883. if (options->DirReqStatistics &&
  2884. load_stats_file("stats"PATH_SEPARATOR"dirreq-stats",
  2885. "dirreq-stats-end", now, &contents) > 0) {
  2886. smartlist_add(chunks, contents);
  2887. }
  2888. if (options->HiddenServiceStatistics &&
  2889. load_stats_file("stats"PATH_SEPARATOR"hidserv-stats",
  2890. "hidserv-stats-end", now, &contents) > 0) {
  2891. smartlist_add(chunks, contents);
  2892. }
  2893. if (options->EntryStatistics &&
  2894. load_stats_file("stats"PATH_SEPARATOR"entry-stats",
  2895. "entry-stats-end", now, &contents) > 0) {
  2896. smartlist_add(chunks, contents);
  2897. }
  2898. if (options->CellStatistics &&
  2899. load_stats_file("stats"PATH_SEPARATOR"buffer-stats",
  2900. "cell-stats-end", now, &contents) > 0) {
  2901. smartlist_add(chunks, contents);
  2902. }
  2903. if (options->ExitPortStatistics &&
  2904. load_stats_file("stats"PATH_SEPARATOR"exit-stats",
  2905. "exit-stats-end", now, &contents) > 0) {
  2906. smartlist_add(chunks, contents);
  2907. }
  2908. if (options->ConnDirectionStatistics &&
  2909. load_stats_file("stats"PATH_SEPARATOR"conn-stats",
  2910. "conn-bi-direct", now, &contents) > 0) {
  2911. smartlist_add(chunks, contents);
  2912. }
  2913. }
  2914. /* Add information about the pluggable transports we support. */
  2915. if (options->ServerTransportPlugin) {
  2916. char *pluggable_transports = pt_get_extra_info_descriptor_string();
  2917. if (pluggable_transports)
  2918. smartlist_add(chunks, pluggable_transports);
  2919. }
  2920. if (should_record_bridge_info(options) && write_stats_to_extrainfo) {
  2921. const char *bridge_stats = geoip_get_bridge_stats_extrainfo(now);
  2922. if (bridge_stats) {
  2923. smartlist_add(chunks, tor_strdup(bridge_stats));
  2924. }
  2925. }
  2926. if (emit_ed_sigs) {
  2927. char sha256_digest[DIGEST256_LEN];
  2928. smartlist_add(chunks, tor_strdup("router-sig-ed25519 "));
  2929. crypto_digest_smartlist_prefix(sha256_digest, DIGEST256_LEN,
  2930. ED_DESC_SIGNATURE_PREFIX,
  2931. chunks, "", DIGEST_SHA256);
  2932. ed25519_signature_t ed_sig;
  2933. char buf[ED25519_SIG_BASE64_LEN+1];
  2934. if (ed25519_sign(&ed_sig, (const uint8_t*)sha256_digest, DIGEST256_LEN,
  2935. signing_keypair) < 0)
  2936. goto err;
  2937. if (ed25519_signature_to_base64(buf, &ed_sig) < 0)
  2938. goto err;
  2939. smartlist_add_asprintf(chunks, "%s\n", buf);
  2940. }
  2941. smartlist_add(chunks, tor_strdup("router-signature\n"));
  2942. s = smartlist_join_strings(chunks, "", 0, NULL);
  2943. while (strlen(s) > MAX_EXTRAINFO_UPLOAD_SIZE - DIROBJ_MAX_SIG_LEN) {
  2944. /* So long as there are at least two chunks (one for the initial
  2945. * extra-info line and one for the router-signature), we can keep removing
  2946. * things. */
  2947. if (smartlist_len(chunks) > 2) {
  2948. /* We remove the next-to-last element (remember, len-1 is the last
  2949. element), since we need to keep the router-signature element. */
  2950. int idx = smartlist_len(chunks) - 2;
  2951. char *e = smartlist_get(chunks, idx);
  2952. smartlist_del_keeporder(chunks, idx);
  2953. log_warn(LD_GENERAL, "We just generated an extra-info descriptor "
  2954. "with statistics that exceeds the 50 KB "
  2955. "upload limit. Removing last added "
  2956. "statistics.");
  2957. tor_free(e);
  2958. tor_free(s);
  2959. s = smartlist_join_strings(chunks, "", 0, NULL);
  2960. } else {
  2961. log_warn(LD_BUG, "We just generated an extra-info descriptors that "
  2962. "exceeds the 50 KB upload limit.");
  2963. goto err;
  2964. }
  2965. }
  2966. memset(sig, 0, sizeof(sig));
  2967. if (router_get_extrainfo_hash(s, strlen(s), digest) < 0 ||
  2968. router_append_dirobj_signature(sig, sizeof(sig), digest, DIGEST_LEN,
  2969. ident_key) < 0) {
  2970. log_warn(LD_BUG, "Could not append signature to extra-info "
  2971. "descriptor.");
  2972. goto err;
  2973. }
  2974. smartlist_add(chunks, tor_strdup(sig));
  2975. tor_free(s);
  2976. s = smartlist_join_strings(chunks, "", 0, NULL);
  2977. cp = s_dup = tor_strdup(s);
  2978. ei_tmp = extrainfo_parse_entry_from_string(cp, NULL, 1, NULL, NULL);
  2979. if (!ei_tmp) {
  2980. if (write_stats_to_extrainfo) {
  2981. log_warn(LD_GENERAL, "We just generated an extra-info descriptor "
  2982. "with statistics that we can't parse. Not "
  2983. "adding statistics to this or any future "
  2984. "extra-info descriptors.");
  2985. write_stats_to_extrainfo = 0;
  2986. result = extrainfo_dump_to_string(s_out, extrainfo, ident_key,
  2987. signing_keypair);
  2988. goto done;
  2989. } else {
  2990. log_warn(LD_BUG, "We just generated an extrainfo descriptor we "
  2991. "can't parse.");
  2992. goto err;
  2993. }
  2994. }
  2995. *s_out = s;
  2996. s = NULL; /* prevent free */
  2997. result = 0;
  2998. goto done;
  2999. err:
  3000. result = -1;
  3001. done:
  3002. tor_free(s);
  3003. SMARTLIST_FOREACH(chunks, char *, chunk, tor_free(chunk));
  3004. smartlist_free(chunks);
  3005. tor_free(s_dup);
  3006. tor_free(ed_cert_line);
  3007. extrainfo_free(ei_tmp);
  3008. tor_free(bandwidth_usage);
  3009. return result;
  3010. }
  3011. /** Return true iff <b>s</b> is a valid server nickname. (That is, a string
  3012. * containing between 1 and MAX_NICKNAME_LEN characters from
  3013. * LEGAL_NICKNAME_CHARACTERS.) */
  3014. int
  3015. is_legal_nickname(const char *s)
  3016. {
  3017. size_t len;
  3018. tor_assert(s);
  3019. len = strlen(s);
  3020. return len > 0 && len <= MAX_NICKNAME_LEN &&
  3021. strspn(s,LEGAL_NICKNAME_CHARACTERS) == len;
  3022. }
  3023. /** Return true iff <b>s</b> is a valid server nickname or
  3024. * hex-encoded identity-key digest. */
  3025. int
  3026. is_legal_nickname_or_hexdigest(const char *s)
  3027. {
  3028. if (*s!='$')
  3029. return is_legal_nickname(s);
  3030. else
  3031. return is_legal_hexdigest(s);
  3032. }
  3033. /** Return true iff <b>s</b> is a valid hex-encoded identity-key
  3034. * digest. (That is, an optional $, followed by 40 hex characters,
  3035. * followed by either nothing, or = or ~ followed by a nickname, or
  3036. * a character other than =, ~, or a hex character.)
  3037. */
  3038. int
  3039. is_legal_hexdigest(const char *s)
  3040. {
  3041. size_t len;
  3042. tor_assert(s);
  3043. if (s[0] == '$') s++;
  3044. len = strlen(s);
  3045. if (len > HEX_DIGEST_LEN) {
  3046. if (s[HEX_DIGEST_LEN] == '=' ||
  3047. s[HEX_DIGEST_LEN] == '~') {
  3048. if (!is_legal_nickname(s+HEX_DIGEST_LEN+1))
  3049. return 0;
  3050. } else {
  3051. return 0;
  3052. }
  3053. }
  3054. return (len >= HEX_DIGEST_LEN &&
  3055. strspn(s,HEX_CHARACTERS)==HEX_DIGEST_LEN);
  3056. }
  3057. /** Use <b>buf</b> (which must be at least NODE_DESC_BUF_LEN bytes long) to
  3058. * hold a human-readable description of a node with identity digest
  3059. * <b>id_digest</b>, named-status <b>is_named</b>, nickname <b>nickname</b>,
  3060. * and address <b>addr</b> or <b>addr32h</b>.
  3061. *
  3062. * The <b>nickname</b> and <b>addr</b> fields are optional and may be set to
  3063. * NULL. The <b>addr32h</b> field is optional and may be set to 0.
  3064. *
  3065. * Return a pointer to the front of <b>buf</b>.
  3066. */
  3067. const char *
  3068. format_node_description(char *buf,
  3069. const char *id_digest,
  3070. int is_named,
  3071. const char *nickname,
  3072. const tor_addr_t *addr,
  3073. uint32_t addr32h)
  3074. {
  3075. char *cp;
  3076. if (!buf)
  3077. return "<NULL BUFFER>";
  3078. buf[0] = '$';
  3079. base16_encode(buf+1, HEX_DIGEST_LEN+1, id_digest, DIGEST_LEN);
  3080. cp = buf+1+HEX_DIGEST_LEN;
  3081. if (nickname) {
  3082. buf[1+HEX_DIGEST_LEN] = is_named ? '=' : '~';
  3083. strlcpy(buf+1+HEX_DIGEST_LEN+1, nickname, MAX_NICKNAME_LEN+1);
  3084. cp += strlen(cp);
  3085. }
  3086. if (addr32h || addr) {
  3087. memcpy(cp, " at ", 4);
  3088. cp += 4;
  3089. if (addr) {
  3090. tor_addr_to_str(cp, addr, TOR_ADDR_BUF_LEN, 0);
  3091. } else {
  3092. struct in_addr in;
  3093. in.s_addr = htonl(addr32h);
  3094. tor_inet_ntoa(&in, cp, INET_NTOA_BUF_LEN);
  3095. }
  3096. }
  3097. return buf;
  3098. }
  3099. /** Use <b>buf</b> (which must be at least NODE_DESC_BUF_LEN bytes long) to
  3100. * hold a human-readable description of <b>ri</b>.
  3101. *
  3102. *
  3103. * Return a pointer to the front of <b>buf</b>.
  3104. */
  3105. const char *
  3106. router_get_description(char *buf, const routerinfo_t *ri)
  3107. {
  3108. if (!ri)
  3109. return "<null>";
  3110. return format_node_description(buf,
  3111. ri->cache_info.identity_digest,
  3112. router_is_named(ri),
  3113. ri->nickname,
  3114. NULL,
  3115. ri->addr);
  3116. }
  3117. /** Use <b>buf</b> (which must be at least NODE_DESC_BUF_LEN bytes long) to
  3118. * hold a human-readable description of <b>node</b>.
  3119. *
  3120. * Return a pointer to the front of <b>buf</b>.
  3121. */
  3122. const char *
  3123. node_get_description(char *buf, const node_t *node)
  3124. {
  3125. const char *nickname = NULL;
  3126. uint32_t addr32h = 0;
  3127. int is_named = 0;
  3128. if (!node)
  3129. return "<null>";
  3130. if (node->rs) {
  3131. nickname = node->rs->nickname;
  3132. is_named = node->rs->is_named;
  3133. addr32h = node->rs->addr;
  3134. } else if (node->ri) {
  3135. nickname = node->ri->nickname;
  3136. addr32h = node->ri->addr;
  3137. }
  3138. return format_node_description(buf,
  3139. node->identity,
  3140. is_named,
  3141. nickname,
  3142. NULL,
  3143. addr32h);
  3144. }
  3145. /** Use <b>buf</b> (which must be at least NODE_DESC_BUF_LEN bytes long) to
  3146. * hold a human-readable description of <b>rs</b>.
  3147. *
  3148. * Return a pointer to the front of <b>buf</b>.
  3149. */
  3150. const char *
  3151. routerstatus_get_description(char *buf, const routerstatus_t *rs)
  3152. {
  3153. if (!rs)
  3154. return "<null>";
  3155. return format_node_description(buf,
  3156. rs->identity_digest,
  3157. rs->is_named,
  3158. rs->nickname,
  3159. NULL,
  3160. rs->addr);
  3161. }
  3162. /** Use <b>buf</b> (which must be at least NODE_DESC_BUF_LEN bytes long) to
  3163. * hold a human-readable description of <b>ei</b>.
  3164. *
  3165. * Return a pointer to the front of <b>buf</b>.
  3166. */
  3167. const char *
  3168. extend_info_get_description(char *buf, const extend_info_t *ei)
  3169. {
  3170. if (!ei)
  3171. return "<null>";
  3172. return format_node_description(buf,
  3173. ei->identity_digest,
  3174. 0,
  3175. ei->nickname,
  3176. &ei->addr,
  3177. 0);
  3178. }
  3179. /** Return a human-readable description of the routerinfo_t <b>ri</b>.
  3180. *
  3181. * This function is not thread-safe. Each call to this function invalidates
  3182. * previous values returned by this function.
  3183. */
  3184. const char *
  3185. router_describe(const routerinfo_t *ri)
  3186. {
  3187. static char buf[NODE_DESC_BUF_LEN];
  3188. return router_get_description(buf, ri);
  3189. }
  3190. /** Return a human-readable description of the node_t <b>node</b>.
  3191. *
  3192. * This function is not thread-safe. Each call to this function invalidates
  3193. * previous values returned by this function.
  3194. */
  3195. const char *
  3196. node_describe(const node_t *node)
  3197. {
  3198. static char buf[NODE_DESC_BUF_LEN];
  3199. return node_get_description(buf, node);
  3200. }
  3201. /** Return a human-readable description of the routerstatus_t <b>rs</b>.
  3202. *
  3203. * This function is not thread-safe. Each call to this function invalidates
  3204. * previous values returned by this function.
  3205. */
  3206. const char *
  3207. routerstatus_describe(const routerstatus_t *rs)
  3208. {
  3209. static char buf[NODE_DESC_BUF_LEN];
  3210. return routerstatus_get_description(buf, rs);
  3211. }
  3212. /** Return a human-readable description of the extend_info_t <b>ri</b>.
  3213. *
  3214. * This function is not thread-safe. Each call to this function invalidates
  3215. * previous values returned by this function.
  3216. */
  3217. const char *
  3218. extend_info_describe(const extend_info_t *ei)
  3219. {
  3220. static char buf[NODE_DESC_BUF_LEN];
  3221. return extend_info_get_description(buf, ei);
  3222. }
  3223. /** Set <b>buf</b> (which must have MAX_VERBOSE_NICKNAME_LEN+1 bytes) to the
  3224. * verbose representation of the identity of <b>router</b>. The format is:
  3225. * A dollar sign.
  3226. * The upper-case hexadecimal encoding of the SHA1 hash of router's identity.
  3227. * A "=" if the router is named; a "~" if it is not.
  3228. * The router's nickname.
  3229. **/
  3230. void
  3231. router_get_verbose_nickname(char *buf, const routerinfo_t *router)
  3232. {
  3233. const char *good_digest = networkstatus_get_router_digest_by_nickname(
  3234. router->nickname);
  3235. int is_named = good_digest && tor_memeq(good_digest,
  3236. router->cache_info.identity_digest,
  3237. DIGEST_LEN);
  3238. buf[0] = '$';
  3239. base16_encode(buf+1, HEX_DIGEST_LEN+1, router->cache_info.identity_digest,
  3240. DIGEST_LEN);
  3241. buf[1+HEX_DIGEST_LEN] = is_named ? '=' : '~';
  3242. strlcpy(buf+1+HEX_DIGEST_LEN+1, router->nickname, MAX_NICKNAME_LEN+1);
  3243. }
  3244. /** Forget that we have issued any router-related warnings, so that we'll
  3245. * warn again if we see the same errors. */
  3246. void
  3247. router_reset_warnings(void)
  3248. {
  3249. if (warned_nonexistent_family) {
  3250. SMARTLIST_FOREACH(warned_nonexistent_family, char *, cp, tor_free(cp));
  3251. smartlist_clear(warned_nonexistent_family);
  3252. }
  3253. }
  3254. /** Given a router purpose, convert it to a string. Don't call this on
  3255. * ROUTER_PURPOSE_UNKNOWN: The whole point of that value is that we don't
  3256. * know its string representation. */
  3257. const char *
  3258. router_purpose_to_string(uint8_t p)
  3259. {
  3260. switch (p)
  3261. {
  3262. case ROUTER_PURPOSE_GENERAL: return "general";
  3263. case ROUTER_PURPOSE_BRIDGE: return "bridge";
  3264. case ROUTER_PURPOSE_CONTROLLER: return "controller";
  3265. default:
  3266. tor_assert(0);
  3267. }
  3268. return NULL;
  3269. }
  3270. /** Given a string, convert it to a router purpose. */
  3271. uint8_t
  3272. router_purpose_from_string(const char *s)
  3273. {
  3274. if (!strcmp(s, "general"))
  3275. return ROUTER_PURPOSE_GENERAL;
  3276. else if (!strcmp(s, "bridge"))
  3277. return ROUTER_PURPOSE_BRIDGE;
  3278. else if (!strcmp(s, "controller"))
  3279. return ROUTER_PURPOSE_CONTROLLER;
  3280. else
  3281. return ROUTER_PURPOSE_UNKNOWN;
  3282. }
  3283. /** Release all static resources held in router.c */
  3284. void
  3285. router_free_all(void)
  3286. {
  3287. crypto_pk_free(onionkey);
  3288. crypto_pk_free(lastonionkey);
  3289. crypto_pk_free(server_identitykey);
  3290. crypto_pk_free(client_identitykey);
  3291. tor_mutex_free(key_lock);
  3292. routerinfo_free(desc_routerinfo);
  3293. extrainfo_free(desc_extrainfo);
  3294. crypto_pk_free(authority_signing_key);
  3295. authority_cert_free(authority_key_certificate);
  3296. crypto_pk_free(legacy_signing_key);
  3297. authority_cert_free(legacy_key_certificate);
  3298. memwipe(&curve25519_onion_key, 0, sizeof(curve25519_onion_key));
  3299. memwipe(&last_curve25519_onion_key, 0, sizeof(last_curve25519_onion_key));
  3300. if (warned_nonexistent_family) {
  3301. SMARTLIST_FOREACH(warned_nonexistent_family, char *, cp, tor_free(cp));
  3302. smartlist_free(warned_nonexistent_family);
  3303. }
  3304. }
  3305. /** Return a smartlist of tor_addr_port_t's with all the OR ports of
  3306. <b>ri</b>. Note that freeing of the items in the list as well as
  3307. the smartlist itself is the callers responsibility. */
  3308. smartlist_t *
  3309. router_get_all_orports(const routerinfo_t *ri)
  3310. {
  3311. tor_assert(ri);
  3312. node_t fake_node;
  3313. memset(&fake_node, 0, sizeof(fake_node));
  3314. /* we don't modify ri, fake_node is passed as a const node_t *
  3315. */
  3316. fake_node.ri = (routerinfo_t *)ri;
  3317. return node_get_all_orports(&fake_node);
  3318. }