router.c 116 KB

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