Make SIGNAL DUMP work on FreeBSD
[tor/rransom.git] / doc / v3-authority-howto.txt
blobe4470e8c81365557ca74c9136b53cb9fb32643c3
2                     How to add a v3 directory authority.
4 What we'll be doing:
6    We'll be configuring your Tor server as a v3 directory authority,
7    generating a v3 identity key plus certificates, and adding your v3
8    identity fingerprint to the list of default directory authorities.
10 The steps:
12 0) Make sure you're running ntp, and that your time is correct.
14    Make sure you have Tor version at least r12724. In the short term,
15    running a working authority may mean running the latest version of
16    Tor from SVN trunk. Later on, we hope that it will become easier
17    and you can just run a recent development release (and later still,
18    a recent stable release).
20 1) First, you'll need a certificate.  Run ./src/tools/tor-gencert to
21    generate one.
23    Run tor-gencert in a separate, very secure directory.  Maybe even on
24    a more secure computer.  The first time you run it, you will need to
25    run it with the --create-identity-key option to make a v3 authority
26    identity key.  Subsequent times, you can just run it as-is.
28    tor-gencert will make 3 files:
30       authority_identity_key -- THIS IS VERY SECRET AND VERY SENSITIVE.
31         DO NOT LEAK IT.  DO NOT LOSE IT.
33       authority_signing_key -- A key for signing votes and v3 conensuses.
35       authority_certificate -- A document authenticating your signing key
36          with your identity-key.
38    You will need to rotate your signing key periodically.  The current
39    default lifetime is 1 year.  We'll probably take this down to a month or
40    two some time soon.  To rotate your key, run tor-gencert as before,
41    but without the --create-identity-key option.
43 2) Copy authority_signing_key and authority_certificate to your Tor keys
44    directory.
46    For example if your data directory is /var/lib/tor/, you should run
47      cp authority_signing_key authority_certificate /var/lib/tor/keys/
49    You will need to repeat this every time you rotate your certificate.
51 3) Tell your Tor to be a v3 authority by adding these lines to your torrc:
53    AuthoritativeDirectory 1
54    V3AuthoritativeDirectory 1
56 4) Now your authority is generating a networkstatus opinion (called a
57    "vote") every period, but none of the other authorities care yet. The
58    next step is to get a Tor developer (likely Roger or Nick) to add
59    your v3 identity fingerprint to the default list of dirservers.
61    First, you need to learn your authority's v3 identity fingerprint.
62    It should be in your authority_certificate file in a line like:
64      fingerprint 3041632465FA8847A98B2C5742108C72325532D9
66    One of the Tor developers then needs to add this fingerprint to
67    the add_default_trusted_dirservers() function in config.c, using
68    the syntax "v3ident=<fingerprint>". For example, if moria1's new v3
69    identity fingerprint is FOO, the moria1 dirserver line should now be:
71      DirServer moria1 v1 orport=9001 v3ident=FOO 128.31.0.34:9031 FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441
73    The v3ident item must appear after the nickname and before the IP.
75 5) Once your fingerprint has been added to config.c, we will try to
76    get a majority of v3 authorities to upgrade, so they know about you
77    too. At that point your vote will automatically be included in the
78    networkstatus consensus, and you'll be a fully-functioning contributing
79    v3 authority.
81    Note also that a majority of the configured v3 authorities need to
82    agree in order to generate a consensus: so this is also the point
83    where extended downtime on your server means missing votes.