router.c 123 KB

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