[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[Pki-devel] [PATCH] 617 Updated pkispawn man page.



The man page for pkispawn has been updated to fix the examples and
to add information about TPS.

https://fedorahosted.org/pki/ticket/827

--
Endi S. Dewata
From d9322ed941dabcfdcc89d701c64a2e1a5e984ef4 Mon Sep 17 00:00:00 2001
From: "Endi S. Dewata" <edewata redhat com>
Date: Wed, 24 Jun 2015 12:07:47 -0400
Subject: [PATCH] Updated pkispawn man page.

The man page for pkispawn has been updated to fix the examples and
to add information about TPS.

https://fedorahosted.org/pki/ticket/827
---
 base/server/man/man8/pkispawn.8                    | 426 ++++++++++++++++-----
 .../python/pki/server/deployment/pkiparser.py      |   4 +-
 2 files changed, 331 insertions(+), 99 deletions(-)

diff --git a/base/server/man/man8/pkispawn.8 b/base/server/man/man8/pkispawn.8
index 33c36e3380950b1b499f4e3d644e0d59c7a80597..c5152cea3a50a775360a0204eafa1806b241f9c8 100644
--- a/base/server/man/man8/pkispawn.8
+++ b/base/server/man/man8/pkispawn.8
@@ -21,7 +21,8 @@ pkispawn \- Sets up an instance of Certificate Server.
 pkispawn \-s <subsystem> \-f <config_file> [\-h] [\-v] [\-p <prefix>]
 
 .SH DESCRIPTION
-Sets up an instance of Certificate Server.  This utility creates any of the Java-based Certificate Server subsystems (CA, KRA, OCSP, and TKS). 
+Sets up a Certificate Server subsystem (CA, KRA, OCSP, TKS, or TPS) in a
+Tomcat instance.
 .TP
 \fBNote:\fP 
 A 389 Directory Server instance must be configured and running before this script can be run. Certificate Server requires an internal directory database. The default configuration assumes a Directory Server instance running on the same machine on port 389.  For more information on creating a Directory Server instance, see
@@ -35,7 +36,14 @@ respectively.
 .PP
 The instances are created based on values for configuration parameters in the default configuration (/etc/pki/default.cfg) and the user-provided configuration file.  The user-provided configuration file is read after the default configuration file, so any parameters defined in that file will override parameters in the default configuration file.  In general, most users will store only those parameters which are different from the default configuration in their user-provided configuration file.
 .PP
-This configuration file contains directives that are divided into sections for different subsystem types (such as [DEFAULT], [CA], and [KRA]).  These sections are stacked, so that parameters read in earlier sections can be overwritten by parameters in later sections.  For the Java subsystems (CA, KRA, OCSP and TKS), the sections read are [DEFAULT], [Tomcat] and the subsystem-type section ([CA], [KRA], [OCSP], or [TKS]), in that order.  This allows the ability to specify parameters to be shared by all subsystems in [DEFAULT] or [Tomcat], and system-specific upgrades in the [CA], [KRA], and other sections.
+This configuration file contains parameters that are grouped into sections.
+These sections are stacked, so that parameters defined in earlier sections can
+be overwritten by parameters defined in later sections. The sections are read
+in the following order: [DEFAULT], [Tomcat], and the subsystem section ([CA],
+[KRA], [OCSP], [TKS], or [TPS]). This allows the ability to specify parameters
+to be shared by all subsystems in [DEFAULT] or [Tomcat], and system-specific
+customization.
+
 .TP
 \fBNote:\fP
 Any non-password related parameter values in the configuration file that needs to contain a \fB%\fP character must be properly escaped.  For example, a value of \fBfoo%bar\fP would be specified as \fBfoo%%bar\fP in the configuration file.
@@ -68,7 +76,7 @@ Previously, as an alternative to using \fBpkisilent\fP to perform a non-interact
 .SH OPTIONS
 .TP
 .B -s <subsystem>
-Specifies the subsystem to be installed and configured, where <subsystem> is CA, KRA, OCSP, or TKS.
+Specifies the subsystem to be installed and configured, where <subsystem> is CA, KRA, OCSP, TKS, or TPS.
 .TP
 .B -f <config_file>
 Specifies the path to the user-defined configuration file.  This file contains differences between the default configuration and the custom configuration.
@@ -83,10 +91,16 @@ for details.
 
 .SH INTERACTIVE MODE
 .PP
-If no options are specified, pkispawn will provide an interactive menu to collect the parameters needed to install
-the Certificate Server instance.  Note that only the most basic installation options are provided.  This includes root CAs,
-KRAs, OCSPs and TKS, connecting to the LDAP port of a directory server.  More complicated setups such as: cloned subsystems, subordinate or externally signed CAs, subsystems that connect to the directory server using LDAPS, and subsystems that are customized beyond the options described below -  require the use of a configuration file with the
-\-f option.
+If no options are specified, pkispawn will provide an interactive menu to
+collect the parameters needed to install the Certificate Server instance.
+Note that only the most basic installation options are provided. This
+includes root CA, KRA, OCSP, TKS, and TPS connecting to an existing
+directory server. More advanced setups such as cloned subsystems,
+subordinate or externally signed CA, subsystems that connect to the
+directory server using LDAPS, and subsystems that are customized beyond
+the options described below require the use of a configuration file with
+the \-f option.
+
 .PP
 The interactive option is most useful for those users getting familiar with Certificate Server.  The parameters collected are
 written to the installation file of the subsystem, which can be found at \fB/etc/sysconfig/pki/tomcat/<instance name>/<subsystem>/deployment.cfg.\fP
@@ -95,7 +109,7 @@ The following parameters are queried interactively during the installation proce
 .PP
 \fBSubsystem Type\fP
 .TP
-\fISubsystem (CA/KRA/OCSP/TKS):\fP
+\fISubsystem (CA/KRA/OCSP/TKS/TPS):\fP
 the type of subsystem to be installed. Prompted when the \-s option is not specified.  The default value chosen is CA.
 .PP
 \fBInstance Specific Parameters\fP
@@ -103,7 +117,7 @@ the type of subsystem to be installed. Prompted when the \-s option is not speci
 \fIInstance name:\fP
 the name of the tomcat instance in which the subsystem is to be installed. The default value is pki-tomcat.
 .br
-\fBNote:\fP Only one subsystem of a given type (CA, KRA, OCSP, TKS) can exist within a given instance.
+\fBNote:\fP Only one subsystem of a given type (CA, KRA, OCSP, TKS, TPS) can exist within a given instance.
 .TP
 \fIHTTP port:\fP
 the HTTP port of the Tomcat instance. The default value is 8080.
@@ -122,7 +136,7 @@ the management port of the Tomcat instance. The default value is 8005.
 \fBAdministrative User Parameters\fP
 .TP
 \fIUsername:\fP
-the username of the administrator of this subsystem. The default value is <ca/kra/tks/ocsp>admin.
+the username of the administrator of this subsystem. The default value is <ca/kra/ocsp/tks/tps>admin.
 .TP
 \fIPassword:\fP
 password for the administrator user.
@@ -131,7 +145,7 @@ password for the administrator user.
 An optional parameter that can be used to import an already available CA admin certificate into this instance.
 .TP
 \fIExport certificate:\fP
-setup the path where the admin certificate of this <subsystem> should be stored. The default value is /root/.dogtag/pki-tomcat/<ca/kra/tks/ocsp>_admin.cert.
+setup the path where the admin certificate of this <subsystem> should be stored. The default value is /root/.dogtag/pki-tomcat/<ca/kra/ocsp/tks/tps>_admin.cert.
 .PP
 \fBDirectory Server Parameters\fP
 .TP
@@ -181,55 +195,125 @@ the username of the security domain administrator of the CA. Required only for n
 password for the security domain administrator. Required for all subsystems that are not root CAs.
 
 .SH EXAMPLES
-.SS CA using default configuration
+
+.SS Installing a root CA
+.BR
+.PP
+To install a root CA in a new instance execute the following command:
+
+.IP
 \x'-1'\fBpkispawn \-s CA \-f myconfig.txt\fR
+
 .PP
 where \fImyconfig.txt\fP contains the following text:
+
 .IP
 .nf
-[DEFAULT]
+[CA]
 pki_admin_password=\fIpassword123\fP
 pki_client_pkcs12_password=\fIpassword123\fP
 pki_ds_password=\fIpassword123\fP
 .fi
+
 .PP
-Prior to running this command, a Directory Server instance should be created and running. This command assumes that the Directory Server instance is using its default configuration:
+Prior to running this command, a Directory Server instance should be created
+and running. This command assumes that the Directory Server instance is using
+its default configuration:
+
 .IP
 * Installed on the local machine
+
 .IP
 * Listening on port 389 
+
 .IP
 * The user is cn=Directory Manager, with the password specified in pki_ds_password
 
-This invocation of \fBpkispawn\fP creates a Tomcat instance containing a CA running on the local machine with secure port 8443 and unsecure port 8080.  To access this CA, simply point a browser to https://<hostname>:8443.
 .PP
-The instance name (defined by pki_instance_name) is pki-tomcat, and it is located at \fI/var/lib/pki/pki-tomcat\fP.  Logs for the instance are located at \fI/var/log/pki/pki-tomcat\fP, and an installation log is written to \fI/var/log/pki/pki-<subsystem>-spawn.<timestamp>.log\fP.
+This invocation of \fBpkispawn\fP creates a Tomcat instance containing a CA
+running on the local machine with secure port 8443 and unsecure port 8080.
+To access this CA, simply point a browser to https://<hostname>:8443.
+
 .PP
-A PKCS #12 file containing the administrator certificate is created in \fI$HOME/.dogtag/pki-tomcat\fP.  This PKCS #12 file uses the password designated by pki_client_pkcs12_password in the configuration file.
+The instance name (defined by pki_instance_name) is pki-tomcat, and it is
+located at \fI/var/lib/pki/pki-tomcat\fP. Logs for the instance are located
+at \fI/var/log/pki/pki-tomcat\fP, and an installation log is written to
+\fI/var/log/pki/pki-<subsystem>-spawn.<timestamp>.log\fP.
+
 .PP
-To access the agent pages, first import the CA certificate by accessing the CA End Entity Pages and clicking on the Retrieval Tab.  Be sure to trust the CA certificate.  Then, import the administrator certificate in the PKCS #12 file.
-.SS KRA, OCSP, or TKS using default configuration
+A PKCS #12 file containing the administrator certificate is created in
+\fI$HOME/.dogtag/pki-tomcat\fP. This PKCS #12 file uses the password
+designated by pki_client_pkcs12_password in the configuration file.
+
+.PP
+To access the agent pages, first import the CA certificate by accessing the CA
+End Entity Pages and clicking on the Retrieval Tab. Be sure to trust the CA
+certificate. Then, import the administrator certificate in the PKCS #12 file.
+
+.SS Installing a KRA, OCSP, TKS, or TPS in a shared instance
+.BR
+.PP
+To install a KRA, OCSP, TKS, or TPS in the same instance used by the CA execute
+the following command:
+
+.IP
 \x'-1'\fBpkispawn \-s <subsystem> \-f myconfig.txt\fR
+
 .PP
-where subsystem is KRA, OCSP, or TKS, and \fImyconfig.txt\fP contains the following text: 
+where subsystem is KRA, OCSP, TKS, or TPS and \fImyconfig.txt\fP contains the
+following text:
+
 .IP
 .nf
-[DEFAULT]
+[KRA/OCSP/TKS/TPS]
 pki_admin_password=\fIpassword123\fP
 pki_client_database_password=\fIpassword123\fP
 pki_client_pkcs12_password=\fIpassword123\fP
 pki_ds_password=\fIpassword123\fP
 pki_security_domain_password=\fIpassword123\fP
 .fi
+
 .PP
-The \fBpki_security_domain_password\fP is the admin password of the CA installed in the same default instance. This command should be run after a CA is installed.  This installs another subsystem within the same default instance using the certificate generated for the CA administrator for the subsystem's administrator.  This allows a user to access both subsystems on the browser with a single administrator certificate.  To access the new subsystem's functionality, simply point the browser to https://<hostname>:8443 and click the relevant top-level links.
-.SS KRA, OCSP, or TKS connecting to a remote CA
+For TPS the following parameters should be added into the \fImyconfig.txt\fP:
+
+.IP
+.nf
+pki_enable_server_side_keygen=\fITrue\fP
+pki_authdb_basedn=\fIdc=example,dc=com\fP
+.fi
+
+.PP
+The \fBpki_security_domain_password\fP is the admin password of the CA
+installed in the same instance. This command should be run after a CA is
+installed. This installs another subsystem within the same instance using the
+certificate generated for the CA administrator for the subsystem's
+administrator. This allows a user to access both subsystems on the browser
+with a single administrator certificate. To access the new subsystem's
+functionality, simply point the browser to https://<hostname>:8443 and click
+the relevant top-level links.
+
+If \fBpki_enable_server_side_keygen\fP is True, TPS will use KRA for
+server-side key generation
+
+The \fBpki_authdb_basedn\fP specifies the base DN of the authentication
+database for TPS.
+
+.SS Installing a KRA, OCSP, TKS, or TPS in a separate instance
+.BR
+.PP
+To install a KRA, OCSP, TKS, or TPS with a remote a CA execute the following
+command:
+
+.IP
 \x'-1'\fBpkispawn \-s <subsystem> \-f myconfig.txt\fR
+
 .PP
-where subsystem is KRA, OCSP, or TKS, and \fImyconfig.txt\fP contains the following text:
+where subsystem is KRA, OCSP, TKS, or TPS and \fImyconfig.txt\fP contains the
+following text:
+
 .IP
 .nf
-[DEFAULT]
+[KRA/OCSP/TKS/TPS]
 pki_admin_password=\fIpassword123\fP
 pki_client_database_password=\fIpassword123\fP
 pki_client_pkcs12_password=\fIpassword123\fP
@@ -238,24 +322,50 @@ pki_security_domain_password=\fIpassword123\fP
 pki_security_domain_hostname=<ca_hostname>
 pki_security_domain_https_port=<ca_port>
 pki_security_domain_user=caadmin
-pki_issuing_ca_uri=https://<ca_hostname>:<ca_port>
-
-[KRA]
+pki_issuing_ca_uri=https://<ca_hostname>:<ca_https_port>
 pki_import_admin_cert=False
 .fi
+
 .PP
-A remote CA is one where the CA resides in another Certificate Server instance, either on the local machine or a remote machine.  In this case, \fImyconfig.txt\fP must specify the connection information for the remote CA and the information about the security domain (the trusted collection of subsystems within an instance).
+For TPS the following parameters should be added into the \fImyconfig.txt\fP:
+
+.IP
+.nf
+pki_ca_uri=\fIhttps://<ca_hostname>:<ca_https_port>\fP
+pki_enable_server_side_keygen=\fITrue\fP
+pki_authdb_basedn=\fIdc=example,dc=com\fP
+.fi
+
 .PP
-The subsystem section is [KRA], [OCSP], or [TKS].  This example assumes that the specified CA hosts the security domain.  The CA must be running and accessible.  
+A remote CA is one where the CA resides in another Certificate Server instance,
+either on the local machine or a remote machine.  In this case,
+\fImyconfig.txt\fP must specify the connection information for the remote CA
+and the information about the security domain (the trusted collection of
+subsystems within an instance).
+
+.PP
+The subsystem section is [KRA], [OCSP], [TKS], or [TPS].  This example assumes
+that the specified CA hosts the security domain.  The CA must be running and
+accessible.
+
 .PP 
-A new administrator certificate is generated for the new subsystem and stored in a PKCS #12 file in \fI$HOME/.dogtag/pki-tomcat\fP.
+A new administrator certificate is generated for the new subsystem and stored
+in a PKCS #12 file in \fI$HOME/.dogtag/pki-tomcat\fP.
+
 .SS Installing a CA clone
+.BR
+.PP
+To install a CA clone execute the following command:
+
+.IP
 \x'-1'\fBpkispawn \-s CA \-f myconfig.txt\fR
+
 .PP 
 where \fImyconfig.txt\fP contains the following text:
+
 .IP
 .nf
-[DEFAULT]
+[CA]
 pki_admin_password=\fIpassword123\fP
 pki_client_database_password=\fIpassword123\fP
 pki_client_pkcs12_password=\fIpassword123\fP
@@ -264,26 +374,52 @@ pki_security_domain_password=\fIpassword123\fP
 pki_security_domain_hostname=<master_ca_hostname>
 pki_security_domain_https_port=<master_ca_https_port>
 pki_security_domain_user=caadmin
-
-[CA]
 pki_clone=True
 pki_clone_pkcs12_password=\fIpassword123\fP
 pki_clone_pkcs12_path=<path_to_pkcs12_file>
 pki_clone_replicate_schema=True
 pki_clone_uri=https://<master_ca_hostname>:<master_ca_https_port>
 .fi
+
 .PP
-A cloned CA is a CA which uses the same signing, OCSP signing, and audit signing certificates as the master CA, but issues certificates within a different serial number range.  It has its own internal database -- separate from the master CA database -- but using the same base DN, that keeps in sync with the master CA through replication agreements between the databases.  This is very useful for load sharing and disaster recovery. To create a clone, the \fImyconfig.txt\fP uses pki_clone-* parameters in its [CA] section which identify the original CA to use as a master template. Additionally, it connects to the master CA as a remote CA and uses its security domain.
+A cloned CA is a CA which uses the same signing, OCSP signing, and audit
+signing certificates as the master CA, but issues certificates within a
+different serial number range. It has its own internal database -- separate
+from the master CA database -- but using the same base DN, that keeps in sync
+with the master CA through replication agreements between the databases. This
+is very useful for load sharing and disaster recovery. To create a clone, the
+\fImyconfig.txt\fP uses pki_clone_* parameters in its [CA] section which
+identify the original CA to use as a master template. Additionally, it
+connects to the master CA as a remote CA and uses its security domain.
+
 .PP
-Before the clone can be generated, the Directory Server must be created that is separate from the master CA's Directory Server.  The example assumes that the master CA and cloned CA are on different machines, and that their Directory Servers are on port 389.  In addition, the master's system certs and keys have been stored in a PKCS #12 file that is copied over to the clone subsystem in the location specified in <path_to_pkcs12_file>.  This file is created when the master CA is installed; it can also be generated using \fBPKCS12Export\fP.  The file needs to be readable by the user the Certificate Server runs as (by default, pkiuser) and be given the SELinux context pki_tomcat_cert_t.
+Before the clone can be generated, the Directory Server must be created that
+is separate from the master CA's Directory Server. The example assumes that
+the master CA and cloned CA are on different machines, and that their Directory
+Servers are on port 389. In addition, the master's system certs and keys have
+been stored in a PKCS #12 file that is copied over to the clone subsystem in
+the location specified in <path_to_pkcs12_file>. This file is created when the
+master CA is installed; it can also be generated using \fBPKCS12Export\fP. The
+file needs to be readable by the user the Certificate Server runs as (by
+default, pkiuser) and be given the SELinux context pki_tomcat_cert_t.
+
 .PP
-.SS Installing a KRA, OCSP, or TKS clone
+
+.SS Installing a KRA, OCSP, TKS, or TPS clone
+.BR
+.PP
+To install a KRA, OCSP, TKS, or TPS clone execute the following command:
+
+.IP
 \x'-1'\fBpkispawn \-s <subsystem> \-f myconfig.txt\fR
+
 .PP
-where subsystem is KRA, OCSP, or TKS, and \fImyconfig.txt\fP contains the following text:
+where subsystem is KRA, OCSP, TKS, or TPS, and \fImyconfig.txt\fP contains the
+following text:
+
 .IP
 .nf
-[DEFAULT]
+[KRA/OCSP/TKS/TPS]
 pki_admin_password=\fIpassword123\fP
 pki_client_database_password=\fIpassword123\fP
 pki_client_pkcs12_password=\fIpassword123\fP
@@ -292,26 +428,49 @@ pki_security_domain_password=\fIpassword123\fP
 pki_security_domain_hostname=<master_ca_hostname>
 pki_security_domain_https_port=<master_ca_https_port>
 pki_security_domain_user=caadmin
-
-[KRA]
 pki_clone=True
 pki_clone_pkcs12_password=\fIpassword123\fP
 pki_clone_pkcs12_path=<path_to_pkcs12_file>
 pki_clone_replicate_schema=True
-pki_clone_uri=https://<master_kra_host>:<master_kra_https_port>
+pki_clone_uri=https://<master_subsystem_host>:<master_subsystem_https_port>
 pki_issuing_ca=https://<ca_hostname>:<ca_https_port>
 .fi
+
 .PP
-As with a CA clone, a KRA, OCSP, or TKS clone uses the same certificates and basic configuration as the original subsystem. The configuration points to the original subsystem to copy its configuration. This example also assumes that the CA is on a remote machine and specifies the CA and security domain information. 
+For TPS the following parameters should be added into the \fImyconfig.txt\fP:
+
+.IP
+.nf
+pki_ca_uri=\fIhttps://<ca_hostname>:<ca_https_port>\fP
+pki_enable_server_side_keygen=\fITrue\fP
+pki_authdb_basedn=\fIdc=example,dc=com\fP
+.fi
+
 .PP
-The subsystem section is [KRA], [OCSP], or [TKS].
-.SS Installing a subordinate CA
+As with a CA clone, a KRA, OCSP, TKS, or TPS clone uses the same certificates
+and basic configuration as the original subsystem. The configuration points to
+the original subsystem to copy its configuration. This example also assumes
+that the CA is on a remote machine and specifies the CA and security domain
+information.
+
+.PP
+The subsystem section is [KRA], [OCSP], [TKS], or [TPS].
+
+.SS Installing a subordinate CA in existing security domain
+.BR
+.PP
+To install a subordinate CA in an existing security domain execute the
+following command:
+
+.IP
 \x'-1'\fBpkispawn \-s CA \-f myconfig.txt\fR
+
 .PP
 where \fImyconfig.txt\fP contains the following text:
+
 .IP
 .nf
-[DEFAULT]
+[CA]
 pki_admin_password=\fIpassword123\fP
 pki_client_database_password=\fIpassword123\fP
 pki_client_pkcs12_password=\fIpassword123\fP
@@ -320,23 +479,37 @@ pki_security_domain_password=\fIpassword123\fP
 pki_security_domain_hostname=<security_domain_ca_hostname>
 pki_security_domain_https_port=<security_domain_ca_https_port>
 pki_security_domain_user=caadmin
-
-[CA]
 pki_subordinate=True
 pki_issuing_ca=https://<master_ca_hostname>:<master_ca_https_port>
 pki_ca_signing_subject_dn=cn=CA Subordinate Signing,o=example.com
 .fi
+
 .PP
-A sub-CA derives its certificate configuration -- such as allowed extensions and validity periods -- from a superior or root CA. Otherwise, the configuration of the CA is independent of the root CA, so it is its own instance rather than a clone. A sub-CA is configured using the pki_subordinate parameter and a pointer to the CA which issues the sub-CA's certificates.
+A sub-CA derives its certificate configuration -- such as allowed extensions
+and validity periods -- from a superior or root CA. Otherwise, the
+configuration of the CA is independent of the root CA, so it is its own
+instance rather than a clone. A sub-CA is configured using the pki_subordinate
+parameter and a pointer to the CA which issues the sub-CA's certificates.
+
 .PP
-\fBNote:\fP The value of \fBpki_ca_signing_subject_dn\fP of a subordinate CA should be different from the root CA's signing subject DN.
-.SS Installing a subordinate CA which hosts its own security domain
+\fBNote:\fP The value of \fBpki_ca_signing_subject_dn\fP of a subordinate CA
+should be different from the root CA's signing subject DN.
+
+.SS Installing a subordinate CA in new security domain
+.BR
+.PP
+To install a subordinate CA in a new security domain execute the following
+command:
+
+.IP
 \x'-1'\fBpkispawn \-s CA \-f myconfig.txt\fR
+
 .PP
 where \fImyconfig.txt\fP contains the following text:
+
 .IP
 .nf
-[DEFAULT]
+[CA]
 pki_admin_password=\fIpassword123\fP
 pki_client_database_password=\fIpassword123\fP
 pki_client_pkcs12_password=\fIpassword123\fP
@@ -345,115 +518,174 @@ pki_security_domain_password=\fIpassword123\fP
 pki_security_domain_hostname=<master CA security domain hostname>
 pki_security_domain_https_port=<master CA security domain https port>
 pki_security_domain_user=caadmin
-
-[CA]
 pki_subordinate=True
 pki_issuing_ca=https://<master ca hostname>:<master ca https port>
-pki_ca_signing_subject_dn=cn=CA Subordinate Signing,o=example.com
+pki_ca_signing_subject_dn=\fIcn=CA Subordinate Signing,o=example.com\fP
 pki_subordinate_create_new_security_domain=True
-pki_subordinate_security_domain_name=Subordinate CA Security Domain
+pki_subordinate_security_domain_name=\fISubordinate CA Security Domain\fP
 .fi
+
 .PP
-In this section, the subordinate CA logs onto and registers with the security domain CA (using parameters \fBpki_security_domain_hostname\fP, \fBpki_security_domain_https_port\fP, \fBpki_security_domain_user\fP and \fBpki_security_domain_password\fP) as in the previous section, but also creates and hosts a new security domain.  To do this, \fBpki_subordinate_create_new_security_domain\fP must be set to \fBTrue\fP.  The subordinate CA security domain name can also be specified by specifying a value for \fBpki_subordinate_security_domain_name\fP.
+In this section, the subordinate CA logs onto and registers with the security
+domain CA (using parameters \fBpki_security_domain_hostname\fP,
+\fBpki_security_domain_https_port\fP, \fBpki_security_domain_user\fP and
+\fBpki_security_domain_password\fP) as in the previous section, but also
+creates and hosts a new security domain. To do this,
+\fBpki_subordinate_create_new_security_domain\fP must be set to \fBTrue\fP.
+The subordinate CA security domain name can also be specified by specifying a
+value for \fBpki_subordinate_security_domain_name\fP.
+
 .PP
-\fBNote:\fP The value of \fBpki_ca_signing_subject_dn\fP of a subordinate CA should be different from the root CA's signing subject DN.
+\fBNote:\fP The value of \fBpki_ca_signing_subject_dn\fP of a subordinate CA
+should be different from the root CA's signing subject DN.
+
 .SS Installing an externally signed CA
+.BR
+.PP
+To install an externally signed CA execute the following command:
+
+.IP
 \x'-1'\fBpkispawn \-s CA \-f myconfig.txt\fR
+
 .PP
 This is a two step process.
+
 .PP
-In the first step, a certificate signing request (CSR) is generated for the signing certificate and \fImyconfig.txt\fP contains the following text:
+In the first step, a certificate signing request (CSR) is generated for the
+signing certificate and \fImyconfig.txt\fP contains the following text:
+
 .IP
 .nf
-[DEFAULT]
+[CA]
 pki_admin_password=\fIpassword123\fP
 pki_client_database_password=\fIpassword123\fP
 pki_client_pkcs12_password=\fIpassword123\fP
 pki_ds_password=\fIpassword123\fP
 pki_security_domain_password=\fIpassword123\fP
-
-[CA]
 pki_external=True
-pki_external_csr_path=/tmp/ca_signing.csr
-pki_ca_signing_subject_dn=cn=CA Signing,ou=External,o=example.com
+pki_external_csr_path=\fI/tmp/ca_signing.csr\fP
+pki_ca_signing_subject_dn=\fIcn=CA Signing,ou=External,o=example.com\fP
 .fi
+
 .PP
-The CSR is written to pki_external_csr_path.  The pki_ca_signing_subject_dn should be different from the subject DN of the external CA that is signing the request.  The pki_ca_signing_subject_dn parameter can be used to specify the signing certificate's subject DN.
+The CSR is written to pki_external_csr_path. The pki_ca_signing_subject_dn
+should be different from the subject DN of the external CA that is signing
+the request. The pki_ca_signing_subject_dn parameter can be used to specify
+the signing certificate's subject DN.
 
 .PP
-The CSR is then submitted to the external CA, and the resulting certificate and certificate chain are saved to files on the system.
+The CSR is then submitted to the external CA, and the resulting certificate
+and certificate chain are saved to files on the system.
 
 .PP
-In the second step, the configuration file has been modified to install the issued certificates. In place of the original CSR, the configuration file now points to the issued CA certificate and certificate chain. There is also a flag to indicate that this completes the installation process (pki_external_step_two). 
+In the second step, the configuration file has been modified to install the
+issued certificates. In place of the original CSR, the configuration file now
+points to the issued CA certificate and certificate chain. There is also a
+flag to indicate that this completes the installation process
+(pki_external_step_two).
+
 .IP
 .nf
-[DEFAULT]
+[CA]
 pki_admin_password=\fIpassword123\fP
 pki_client_database_password=\fIpassword123\fP
 pki_client_pkcs12_password=\fIpassword123\fP
 pki_ds_password=\fIpassword123\fP
 pki_security_domain_password=\fIpassword123\fP
-
-[CA]
 pki_external=True
-pki_external_ca_cert_chain_path=/tmp/ca_cert_chain.cert
-pki_external_ca_cert_path=/tmp/ca_signing.cert
+pki_external_ca_cert_chain_path=\fI/tmp/ca_cert_chain.cert\fP
+pki_external_ca_cert_path=\fI/tmp/ca_signing.cert\fP
 pki_external_step_two=True
-pki_ca_signing_subject_dn=cn=CA Signing Certificate,ou=External,o=example.com
+pki_ca_signing_subject_dn=\fIcn=CA Signing Certificate,ou=External,o=example.com\fP
 .fi
+
 .PP
 Then, the \fBpkispawn\fP command is run again:
-.PP
+
+.IP
 .B pkispawn -s CA -f myconfig.txt
-.SS Installing a CA connecting securely to a Directory Server via LDAPS
-\x'-1'\fBpkispawn \-s CA \-f myconfig.txt\fR
+
+.SS Installing PKI subsystem with a secure Directory Server
+.BR
 .PP
-where \fImyconfig.txt\fP contains the following text:
+To connect any subsystem described above to a Directory Server via LDAPS
+add the following parameters into the \fImyconfig.txt\fP:
+
 .IP
 .nf
-[DEFAULT]
-pki_admin_password=\fIpassword123\fP
-pki_client_database_password=\fIpassword123\fP
-pki_client_pkcs12_password=\fIpassword123\fP
-pki_ds_password=\fIpassword123\fP
 pki_ds_secure_connection=True
 pki_ds_secure_connection_ca_pem_file=\fI/root/dscacert.pem\fP
-
-[CA]
-pki_base_dn=\fIdc=example, dc=com\fP
 .fi
-.TP
-\fBImportant:\fP
-Although this example is specifically for a CA, the \fB[CA]\fP section may be replaced by the appropriate PKI subsystem (i. e. - \fb[KRA]\fP, \fb[OCSP]\fP, \fb[TKS]\fP, or \fb[TPS]\fP) being installed.  Additionally, if a KRA, OCSP, TKS, or TPS subsystem is being installed, they must also include the name/value pair \fBpki_security_domain_password=\fIpassword123\fP in the \fB[DEFAULT]\fP section.
+
 .PP
-Prior to running this command, a Directory Server instance must be configured to run securely over LDAPS using a self-signed certificate, and its self-signed CA certificate exported to a file so that it may be utilized by a PKI instance:
+Prior to installing the subsystem, a Directory Server instance must be
+configured to run securely over LDAPS using a self-signed certificate, and its
+self-signed CA certificate exported to a file so that it may be utilized by a
+PKI instance:
+
 .IP
-* \fBsetup-ds.pl\fP or \fBsetup-ds-admin.pl\fP
+* \fBsetup-ds-admin.pl\fP
+
 .IP
 * \fB/usr/sbin/setupssl2.sh /etc/dirsrv/\fIslapd-pki\fP 389 636 \fIpassword123\fP
+
 .TP
 \fBNote:\fP
-The \fBsetupssl2.sh\fP script may be downloaded from \fBhttps://github.com/richm/scripts/blob/master/setupssl2.sh\fP.
+The \fBsetupssl2.sh\fP script may be downloaded from \fBhttps://raw.githubusercontent.com/richm/scripts/master/setupssl2.sh\fP.
+
 .IP
 * \fBsystemctl restart dirsrv.target\fP
+
 .IP
 * \fBcd /etc/dirsrv/\fIslapd-pki\fP
+
 .IP
 * \fB/usr/lib64/mozldap/ldapsearch -Z -h \fIpki.example.com\fP -p 636 -D 'cn=Directory Manager' -w \fIpassword123\fP -b \fI"dc=example, dc=com"\fP "objectclass=*"\fP
+
 .TP
 \fBNote:\fP
-The \fBmozldap ldapsearch\fP utility may be downloaded via running \fByum install mozldap-tools\fP.
+The \fBmozldap ldapsearch\fP utility is part of \fBmozldap-tools\fP package.
+
 .IP
 * \fBcertutil -L -d /etc/dirsrv/\fIslapd-pki\fP -n "CA certificate" -a > \fI/root/dscacert.pem\fP
+
 .PP
-It should be noted that there are basically three scenarios in which a PKI subsystem (e. g. - a CA) needs to communicate securely via LDAPS with a directory server:
+It should be noted that there are basically three scenarios in which a PKI
+subsystem (e. g. - a CA) needs to communicate securely via LDAPS with a
+directory server:
+
 .IP
-* A directory server exists which is already running LDAPS using a CA certificate that has been issued by some other CA.  For this scenario, the CA certificate must be made available via a PEM file during \fBpkispawn\fP installation/configuration such that the CA may be installed and configured to communicate with this directory server using LDAPS.
+* A directory server exists which is already running LDAPS using a CA
+certificate that has been issued by some other CA. For this scenario, the CA
+certificate must be made available via a PEM file during \fBpkispawn\fP
+installation/configuration such that the CA may be installed and configured
+to communicate with this directory server using LDAPS.
+
 .IP
-* A directory server exists which is currently running LDAP.  Once a CA has been created, there is a desire to use its CA certificate to issue an SSL certificate for this directory server so that this CA and this directory server can communicate via LDAPS.  For this scenario, since there is no need to communicate securely during the \fBpkispawn\fP installation/configuration, simply use \fBpkispawn\fP to install and configure the CA using the LDAP port of the directory server, issue an SSL certificate from this CA for the directory server, and then reconfigure the CA and directory server to communicate with each other via LDAPS.
+* A directory server exists which is currently running LDAP. Once a CA has
+been created, there is a desire to use its CA certificate to issue an SSL
+certificate for this directory server so that this CA and this directory
+server can communicate via LDAPS.  For this scenario, since there is no need
+to communicate securely during the \fBpkispawn\fP installation/configuration,
+simply use \fBpkispawn\fP to install and configure the CA using the LDAP port
+of the directory server, issue an SSL certificate from this CA for the
+directory server, and then reconfigure the CA and directory server to
+communicate with each other via LDAPS.
+
 .IP
-* Similar to the previous scenario, a directory server exists which is currently running LDAP, and the desire is to create a CA and use it to establish LDAPS communications between this CA and this directory server.  However, for this scenario, there is a need for the CA and the directory server to communicate securely during \fBpkispawn\fP installation/configuration.  For this to succeed, the directory server must generate a temporary self-signed certificate for use during \fBpkispawn\fP installation/creation.  Once the CA has been created, swap things out to reconfigure the CA and directory server to utilize LDAPS through the desired certificates.  This example demonstrates the \fBpkispawn\fP portion of this particular scenario.
-.SS Execution management of a PKI instance (start, stop, status, etc.)
+* Similar to the previous scenario, a directory server exists which is
+currently running LDAP, and the desire is to create a CA and use it to
+establish LDAPS communications between this CA and this directory server.
+However, for this scenario, there is a need for the CA and the directory
+server to communicate securely during \fBpkispawn\fP installation and
+configuration. For this to succeed, the directory server must generate a
+temporary self-signed certificate for use during \fBpkispawn\fP
+installation/creation. Once the CA has been created, swap things out to
+reconfigure the CA and directory server to utilize LDAPS through the
+desired certificates. This example demonstrates the \fBpkispawn\fP
+portion of this particular scenario.
+
+.SS Managing PKI instance
 .BR
 .PP
 To start all 389 instances (local PKI databases):
diff --git a/base/server/python/pki/server/deployment/pkiparser.py b/base/server/python/pki/server/deployment/pkiparser.py
index 7e1813c75b891466600117998559c6c1c714ef94..471bd06b7d4d4ed7fbd4971f12d42f5f71bd78e0 100644
--- a/base/server/python/pki/server/deployment/pkiparser.py
+++ b/base/server/python/pki/server/deployment/pkiparser.py
@@ -71,7 +71,7 @@ class PKIConfigParser:
             nargs=1, choices=config.PKI_SUBSYSTEMS,
             metavar='<subsystem>',
             help='where <subsystem> is '
-            'CA, KRA, OCSP, RA, TKS, or TPS')
+            'CA, KRA, OCSP, TKS, or TPS')
         self.optional.add_argument(
             '-h', '--help',
             dest='help', action='help',
@@ -1141,7 +1141,7 @@ class PKIConfigParser:
             elif (config.pki_subsystem != "CA" or\
                     config.str2bool(self.mdict['pki_clone']) or\
                     config.str2bool(self.mdict['pki_subordinate'])):
-                # PKI KRA, PKI OCSP, PKI RA, PKI TKS, PKI TPS,
+                # PKI KRA, PKI OCSP, PKI TKS, PKI TPS,
                 # CA Clone, KRA Clone, OCSP Clone, TKS Clone, TPS Clone
                 # Subordinate CA
                 self.mdict['pki_security_domain_type'] = "existing"
-- 
1.9.3


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]