From 1e46576f89aa401532d64865f9a06771c1d82a36 Mon Sep 17 00:00:00 2001 From: Ade Lee Date: Fri, 7 Dec 2012 15:36:43 -0500 Subject: Added more detail to man page for pki(1) --- base/java-tools/man/man1/pki.1 | 198 +++++++++++++++++++++++++++++++++++------ 1 file changed, 171 insertions(+), 27 deletions(-) (limited to 'base/java-tools/man') diff --git a/base/java-tools/man/man1/pki.1 b/base/java-tools/man/man1/pki.1 index 30b8668f2..a7644ac31 100644 --- a/base/java-tools/man/man1/pki.1 +++ b/base/java-tools/man/man1/pki.1 @@ -15,17 +15,15 @@ .\" .sp insert n+1 empty lines .\" for manpage-specific macros, see man(7) .SH NAME -pki \- Command-Line Interface (CLI) Tools. +pki \- Command-Line Interface Tool for accessing Certificate System Servers. -.SH LOCATION -/usr/bin/pki +.SH SYNOPSIS +pki [CLI options] [command arguments] .SH DESCRIPTION .PP -The \fBpki\fR command-line interface tool allows an administrator the ability -to manage certificates, groups, keys, security domains, and users from the -command line. - +\fBpki\fR provides a command-line interface to Certficate System Servers, allowing administrators to manage certificates, groups, keys, security domains, and users. + .SH OPTIONS .TP .B -d @@ -64,32 +62,178 @@ Displays 'pki' CLI version information. .B -w Specifies the password. -.SH COMMANDS -.SS cert \- Certificate Management Commands -.PP -blah blah +.SH OPERATIONS +To view available commands and options, simply type \fBpki\fP. Some commands have sub-commands. To view the sub-commands, type \fBpki \fP. To view each command's usage, type: \fB pki --help\fP -.SS group \- Group Management Commands -.PP -blah blah +.SS Connection +By default, \fBpki\fP will connect to the non-secure (http) port of a CA server running on the localhost on port 8080. To specify a different location, parameters can be changed individually using the following options: -.SS key \- Key Management Commands -.PP -blah blah +.B pki -P -h -p -t -.SS securitydomain \- Security Domain Commands -.PP -blah blah +Alternatively, the connection parameters can be specified as a URL: -.SS user \- User Management Commands -.PP -blah blah +.B pki -U + +where the URL is of the format: https://:/. + +.SS Authentication +Some commands require authentication. These are commands that are restricted to particular sets of users (agents, admins) or those operations involving certificate profiles that require authentication. + +To execute a command without authentication: + +.B pki + +To authenticate with username and password: + +.B pki -u -w + +To authenticate with client certificate: + +.B pki -d -w -n + +.SS Certificates +Viewing certificates can be executed anonymously. + +To list all certificates: + +.B pki cert-find + +It is also possible to search/list specific certificates by adding a search filter. Use \fBpki cert-find --help\fP to see options. An example invocation would be : + +.B pki cert-find --issuedOnFrom 2012-06-15 + +To view a particular certificate: + +.B pki cert-show + +Revoking, holding, or releasing a certificate must be executed as an agent. +To revoke a certificate: + +.B pki cert-revoke + +To place a certificate on-hold temporarily: + +.B pki cert-hold + +To release a certificate that has been placed on hold: + +.B pki cert-release-hold + +.SS Certificate Requests +To request a certificate, first generate a certificate request in PKCS #10 or CRMF, and store this request in an XML file, for example: + + +.br + + caUserCert + false + + + crmf + MIIBozCCAZ8wggEFA ... + CSR in Base 64 ... + + KeyGenInput + + + + testuser + testuser@example.com + US + Engineering + Test User + Example + + SubjectNameInput + + + + admin + admin@example.com + + 123-456-7890 + + SubmitterInfoInput + + + +Then submit the request for review. This can be done without authentication. + +.B pki cert-request-submit + +Then, an agent needs to review the request. + +.B pki cert-request-review --output + +The output file contains details about the request, as well as the defaults and constraints of the enrollment profile. It contains all the values that can be overridden by the agent. To approve a request, run the following command as an agent: + +.B pki cert-request-approve + +.SS Group Management Commands +All group commands must be executed as an administrator. Some representative commands are shown below. Type \fBpki group\fP to get a list of additional commands. + +To list groups, use \fBpki group-find\fP. It is possible to select the page size to limit the number of entries returned. To list all groups: + +.B pki group-find + +To view a particular group: + +.B pki group-show + +To add a group: + +.B pki group-add --description "description" + +To delete a group: + +.B pki group-del + +To add a user to a group: + +.B pki group-add-member + +To delete a user from a group: + +.B pki group-remove-member + +.SS Key Management Commands +\fBpki\fP can be used with a KRA to find specific keys and key requests. This will be documented in more detail at a later time. + +.SS Security Domain Commands +\fBpki\fP can be used to access certain information from the security domain. + +To get an installation token (used when installing a new subsystem within a security domain), the following command can be run. + +\fBpki securitydomain-get-install-token --hostname --subsystem \fP + +To show the contents of the security domain: + +\fBpki securitydomain-show\fP + +.SS User Management Commands +All user commands must be executed as an administrator. Some representative commands are shown below. Type \fBpki user\fP to get a list of additional commands. + +To list users, use \fBpki user-find\fP. It is possible to select the page size to limit the size of the results. To list all users: + +.B pki user-find + +To view a particular user: + +.B pki user-show + +To add a user: + +.B pki user-add --fullName + +To delete a user: + +.B pki user-del + +.SH FILES +.I /usr/bin/pki .SH AUTHORS -Ade Lee . \fBpki\fP was written by the Dogtag project. +Ade Lee , Endi Dewata and Matt Harmsen . \fBpki\fP was written by the Dogtag project. .SH COPYRIGHT Copyright (c) 2012 Red Hat, Inc. This is licensed under the GNU General Public License, version 2 (GPLv2). A copy of this license is available at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt. - -.SH SEE ALSO -blah blah -- cgit