gimmecert Changeset - c89659681734

Changeset - c89659681734

Parent rev.

Child rev.

[Not reviewed]

0 1 0

Branko Majic (branko) - 6 years ago 2018-03-04 15:25:59
branko@majic.rs

GC-15: Added user documentation for the server command:

- Updated quickstart section to include samples for issuing server
certificates.
- Updated the initialisation section to mention creation of directory
used for storing server private keys and certificates.
- Added new section covering command for issuing server certificates.

1 file changed with 66 insertions and 0 deletions:

docs/usage.rst

0 comments (0 inline, 0 general)

docs/usage.rst

➞

Show inline comments

 - ``.gimmecert/ca/chain-full.cert.pem`` (full CA chain, in this case
   same as ``level1.cert.pem``)
 Issue a server certificate::
   gimmecert myserver1
 This will create the following artifacts for the server:
 - ``.gimmecert/server/myserver1.key.pem`` (private key)
 - ``.gimmecert/server/myserver1.cert.pem`` (certificate)
 Resulting certificate will include its own name as one of the DNS
 subject alternative names.
 Issue a server certificate with additional DNS subject alternative
 names::
   gimmecert myserver2 myserver2.local service.example.com
 This will create the following artifacts for the server:
 - ``.gimmecert/server/myserver2.key.pem`` (private key)
 - ``.gimmecert/server/myserver2.cert.pem`` (certificate)
 This time around, the ``myserver2`` certificate will include
 ``myserver2``, ``myserver2.local``, and ``service.example.com`` as DNS
 subject alternative names.
 Initialisation
 --------------
@@ @@ -85,6 +111,8 @@ process: @@
 - ``.gimmecert/``, base directory.
 - ``.gimmecert/ca/``, used for storing CA private keys and
   certificates.
 - ``.gimmecert/server/``, used for storing server private keys and
   certificates.
 Both CA private keys and certificates are stored as OpenSSL-style PEM
 files. The naming convention for keys is ``levelN.key.pem``, while for
@@ @@ -119,3 +147,41 @@ artifacts: @@
 - ``.gimmecert/ca/level3.key.pem``
 - ``.gimmecert/ca/level3.cert.pem`` (subject DN ``My Project Level 3 CA``)
 - ``.gimmecert/ca/chain-full.cert.pem``
 Issuing server certificates
 ---------------------------
 Server certificates can be issued once the initialisation is
 complete. Command supports passing-in additional DNS subject
 alternative names as additional positional arguments::
   gimmecert server NAME [DNS_NAME [DNS_NAME ...]]
 The command will:
 - Generate a 2048-bit RSA private key.
 - Issue a certificate associated with the generated private key using
   the leaf CA (the one deepest in hierachy).
 Rerunning the command will overwrite existing private key and
 certificate without warning.
 Resulting private keys and certificates are stored within directory
 ``.gimmecert/server/``. Private key naming convention is
 ``NAME.key.pem``, while certificates are stored as
 ``NAME.cert.pem``. In both cases the OpenSSL-style PEM format is used
 for storage.
 Subject DN naming convention for server certificates is ``CN=NAME``,
 where ``NAME`` is passed-in via positional argument.
 By default the certificate will include the passed-in server name as
 one of its DNS subject alternative names, but additional DNS names can
 be passed-in as well. For example::
   gimmecert server myserver myserver.local service.example.com
 Key usage and extended key usage in certificate are set typical TLS
 server use (e.g. *digital signature* + *key encipherment* for KU, and
 *TLS WWW server authentication* for EKU).

0 comments (0 inline, 0 general)