Update documentation

This commit is contained in:
Josh Cepek 2014-07-27 07:01:35 -05:00
parent 5758825baa
commit a0d58b2faf
3 changed files with 37 additions and 6 deletions

View File

@ -5,6 +5,9 @@ This is a quickstart guide to using Easy-RSA version 3. Detailed help on usage
and specific commands by running easyrsa with the 'help' command. Additional
documentation can be found in the doc/ directory.
If you're upgrading from the Easy-RSA 2.x series there are Upgrade-Notes
available, also under the doc/ path.
Setup and signing the first request
-----------------------------------
@ -16,11 +19,11 @@ first entity certificate.
./easyrsa init-pki
./easyrsa build-ca
2. On the separate system that is requesting a certificate, init its own PKI and
generate a keypair/request. Note that the init-pki is used _only_ when this
is done on a separate system (or at least a separate PKI dir.) This is the
recommended procedure. If you are not using this recommended procedure, skip
the next import-req step as well.
2. On the system that is requesting a certificate, init its own PKI and generate
a keypair/request. Note that the init-pki is used _only_ when this is done on
a separate system (or at least a separate PKI dir.) This is the recommended
procedure. If you are not using this recommended procedure, skip the next
import-req step as well.
./easyrsa init-pki
./easyrsa gen-req EntityName
@ -82,3 +85,16 @@ without a matching file.
./easyrsa show-req EntityName
./easyrsa show-cert EntityName
Changing private key passphrases
--------------------------------
RSA and EC private keys can be re-encrypted so a new passphrase can be supplied
with one of the following commands depending on the key type:
./easyrsa set-rsa-pass EntityName
./easyrsa set-ec-pass EntityName
Optionally, the passphrase can be removed completely with the 'nopass' flag.
Consult the command help for details.

View File

@ -3,6 +3,10 @@ Easy-RSA 3 Windows README
Easy-RSA 3 runs POSIX shell code, so use on Windows has some additional
requirements: an OpenSSL installation, and a usable shell environment.
If you don't have OpenSSL, you'll need to install an OpenSSL package (see
section 1.) The Easy-RSA Windows release includes a ready-to-use shell
environment with special thanks to the mksh/Win32 project.
Contents of this file:
1. OpenSSL
2. shell environment
@ -10,6 +14,8 @@ Contents of this file:
4. Appendix:
4.1: reference links
4.2: license of included components
5. Special Thanks
5.1: mksh/Win32
1. Obtaining OpenSSL for use with Easy-RSA
@ -114,5 +120,13 @@ Contents of this file:
The full source for this win32 port can be found here:
http://sourceforge.net/projects/unxutils/
5. Special Thanks
5.1: mksh/Win32
A special thanks is in order to the mksh/Win32 project and its primary
maintainer, Michael Langguth <mksh-w32@gmx.net>. This shell offers featurs
that allow Easy-RSA to run smoothly under Windows; by using mksh/Win32,
Easy-RSA can deliver the same PKI flexibility to all major platforms.
vim: wrap tw=80 expandtab

View File

@ -2,7 +2,8 @@
# Easy-RSA 3 -- A Shell-based CA Utility
#
# Copyright (C) 2013 by the Open-Source OpenVPN development community
# Copyright (C) 2013 by the Open-Source OpenVPN development community.
# A full list of contributors can be found in the ChangeLog.
#
# This code released under version 2 of the GNU GPL; see COPYING and the
# Licensing/ directory of this project for full licensing details.