doc/tor-gencert.1.txt

   1 // Copyright (c) The Tor Project, Inc.
   2 // See LICENSE for licensing information
   3 // This is an asciidoc file used to generate the manpage/html reference.
   4 // Learn asciidoc on http://www.methods.co.nz/asciidoc/userguide.html
   5 tor-gencert(1)
   6 ==============
   7 Nick Mathewson
   8
   9 NAME
  10 ----
  11 tor-gencert - Generate certs and keys for Tor directory authorities
  12
  13 SYNOPSIS
  14 --------
  15 **tor-gencert** [-h|--help] [-v] [-r|--reuse] [--create-identity-key] [-i __id_file__] [-c
  16 __cert_file__] [-m __num__] [-a __address__:__port__]
  17
  18 DESCRIPTION
  19 -----------
  20 **tor-gencert** generates certificates and private keys for use by Tor
  21 directory authorities running the v3 Tor directory protocol, as used by
  22 Tor 0.2.0 and later. If you are not running a directory authority, you
  23 don't need to use tor-gencert. +
  24
  25 Every directory authority has a long term authority __identity__ __key__ (which
  26 is distinct from the identity key it uses as a Tor server); this key
  27 should be kept offline in a secure location. It is used to certify
  28 shorter-lived __signing__ __keys__, which are kept online and used by the
  29 directory authority to sign votes and consensus documents. +
  30
  31 After you use this program to generate a signing key and a certificate,
  32 copy those files to the keys subdirectory of your Tor process, and send
  33 Tor a SIGHUP signal. DO NOT COPY THE IDENTITY KEY.
  34
  35 OPTIONS
  36 -------
  37 **-v**::
  38     Display verbose output.
  39
  40 **-h** or **--help**::
  41     Display help text and exit.
  42
  43 **-r** or **--reuse**::
  44     Generate a new certificate, but not a new signing key. This can be used to
  45     change the address or lifetime associated with a given key.
  46
  47 **--create-identity-key**::
  48     Generate a new identity key. You should only use this option the first time
  49     you run tor-gencert; in the future, you should use the identity key that's
  50     already there.
  51
  52 **-i** __FILENAME__::
  53     Read the identity key from the specified file. If the file is not present
  54     and --create-identity-key is provided, create the identity key in the
  55     specified file. Default: "./authority_identity_key"
  56
  57 **-s** __FILENAME__::
  58     Write the signing key to the specified file. Default:
  59     "./authority_signing_key"
  60
  61 **-c** __FILENAME__::
  62     Write the certificate to the specified file. Default:
  63     "./authority_certificate"
  64
  65 **-m** __NUM__::
  66     Number of months that the certificate should be valid. Default: 12.
  67
  68 **--passphrase-fd** __FILEDES__::
  69     Filedescriptor to read the file descriptor from. Ends at the first NUL or
  70     newline. Default: read from the terminal.
  71
  72 **-a** __address__:__port__::
  73     If provided, advertise the address:port combination as this authority's
  74     preferred directory port in its certificate. If the address is a hostname,
  75     the hostname is resolved to an IP before it's published.
  76
  77 BUGS
  78 ----
  79 This probably doesn't run on Windows. That's not a big issue, since we don't
  80 really want authorities to be running on Windows anyway.
  81
  82 SEE ALSO
  83 --------
  84 **tor**(1) +
  85
  86 See also the "dir-spec.txt" file, distributed with Tor.
  87
  88 AUTHORS
  89 -------
  90     Roger Dingledine <arma@mit.edu>, Nick Mathewson <nickm@alum.mit.edu>.