From 189f7aa36f02256de5472117ea927ca762604a62 Mon Sep 17 00:00:00 2001 From: "Endi S. Dewata" Date: Sat, 29 Oct 2016 07:53:02 +0200 Subject: [PATCH] Added man pages for PKCS #12 utilities. New man pages have been added: pki-pkcs12, pki-pkcs12-cert, and pki-pkcs12-key. https://fedorahosted.org/pki/ticket/1920 --- base/java-tools/man/man1/pki-pkcs12-cert.1 | 131 +++++++++++++++++++++++++++++ base/java-tools/man/man1/pki-pkcs12-key.1 | 76 +++++++++++++++++ base/java-tools/man/man1/pki-pkcs12.1 | 113 +++++++++++++++++++++++++ 3 files changed, 320 insertions(+) create mode 100644 base/java-tools/man/man1/pki-pkcs12-cert.1 create mode 100644 base/java-tools/man/man1/pki-pkcs12-key.1 create mode 100644 base/java-tools/man/man1/pki-pkcs12.1 diff --git a/base/java-tools/man/man1/pki-pkcs12-cert.1 b/base/java-tools/man/man1/pki-pkcs12-cert.1 new file mode 100644 index 0000000000000000000000000000000000000000..f792115cefbc3777a1b937c3c5a5421887a980fa --- /dev/null +++ b/base/java-tools/man/man1/pki-pkcs12-cert.1 @@ -0,0 +1,131 @@ +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH pki-pkcs12-cert 1 "Oct 28, 2016" "version 10.3" "PKI PKCS #12 Certificate Management Commands" Dogtag Team +.\" Please adjust this date whenever revising the man page. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for man page specific macros, see man(7) +.SH NAME +pki-pkcs12-cert \- Command-Line Interface for managing individual certificates in PKCS #12 file. + +.SH SYNOPSIS +.nf +\fBpki\fR [CLI options] \fBpkcs12-cert\fR +\fBpki\fR [CLI options] \fBpkcs12-cert-find\fR [command options] +\fBpki\fR [CLI options] \fBpkcs12-cert-export \fR [command options] +\fBpki\fR [CLI options] \fBpkcs12-cert-add \fR [command options] +\fBpki\fR [CLI options] \fBpkcs12-cert-mod \fR [command options] +\fBpki\fR [CLI options] \fBpkcs12-cert-del \fR [command options] +.fi + +.SH DESCRIPTION +.PP +The \fBpki pkcs12-cert\fR commands provide command-line interfaces to manage certificates in a PKCS #12 file. + +.PP +\fBpki\fR [CLI options] \fBpkcs12-cert-find\fR [command options] +.RS 4 +This command is to list certificates in a PKCS #12 file. +.RE +.PP +\fBpki\fR [CLI options] \fBpkcs12-cert-export \fR [command options] +.RS 4 +This command is to export a certificate from a PKCS #12 file. +.RE +.PP +\fBpki\fR [CLI options] \fBpkcs12-cert-add \fR [command options] +.RS 4 +This command is to add a certificate into a PKCS #12 file. +.RE +.PP +\fBpki\fR [CLI options] \fBpkcs12-cert-mod \fR [command options] +.RS 4 +This command is to modify a certificate in a PKCS #12 file. +.RE +.PP +\fBpki\fR [CLI options] \fBpkcs12-cert-del \fR [command options] +.RS 4 +This command is to delete a certificate from a PKCS #12 file. +.RE + +.SH OPTIONS +The CLI options are described in \fBpki\fR(1). + +.SH OPERATIONS + +To view available profile commands, type \fBpki pkcs12-cert\fP. To view each command's usage, type \fB pki pkcs12-cert- \-\-help\fP. + +All \fBpkcs12-cert\fP commands require a PKCS #12 file and its password. +The PKCS #12 file can be specified with the \fB--pkcs12-file\fP parameter. +The password can be specified either directly with the \fB--pkcs12-password\fP parameter, or in a file with the \fB--pkcs12-password-file\fP parameter. + +Some \fBpki pkcs12-cert\fP commands require an NSS database and its password. +The NSS database location can be specified with the \fB-d\fP parameter (default: ~/.dogtag/nssdb). +The NSS database password can be specified with the \fB-c\fP or the \fB-C\fP parameter. + +.SS Viewing certificates in a PKCS #12 file + +To list the certificates in a PKCS #12 file: + +.B pki pkcs12-cert-find + +.SS Exporting a certificate from a PKCS #12 file + +To export a certificate from a PKCS #12 file into a certificate file: + +.B pki pkcs12-cert-export + +The certificate file can be specified with the \fB--cert-file\fP parameter. + +.SS Adding a certificate from an NSS database into a PKCS #12 file + +To add a certificate including its key and trust flags from an NSS database into a PKCS #12 file: + +.B pki pkcs12-cert-add + +If the PKCS #12 file does not exist, it will be created automatically. +If the PKCS #12 file already exists, the certificate will be added into the file. + +The trust flags can be overwritten with the \fB--trust-flags\fP parameter. +If the key is not needed, specify the \fB--no-key\fP parameter. + +.SS Adding a certificate from a certificate file into a PKCS #12 file + +To add a certificate from a certificate file into a PKCS #12 file: + +.B pki pkcs12-cert-add + +The certificate file can be specified with the \fB--cert-file\fP parameter. +The trust flags can optionally be specified with the \fB--trust-flags\fP parameter. + +.SS Modifying a certificate in a PKCS #12 file + +To modify the trust flags of a certificate in a PKCS #12 file: + +.B pki pkcs12-cert-mod + +The trust flags can be specified with the \fB--trust-flags\fP parameter. + +.SS Deleting a certificate from a PKCS #12 file + +To delete a certificate and its key from a PKCS #12 file: + +.B pki pkcs12-cert-del + +.SH AUTHORS +Endi S. Dewata . + +.SH COPYRIGHT +Copyright (c) 2016 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 +.BR pki-pkcs12(1) diff --git a/base/java-tools/man/man1/pki-pkcs12-key.1 b/base/java-tools/man/man1/pki-pkcs12-key.1 new file mode 100644 index 0000000000000000000000000000000000000000..884278dfe2cc8e34409c3789e6d9d10305aa2a3f --- /dev/null +++ b/base/java-tools/man/man1/pki-pkcs12-key.1 @@ -0,0 +1,76 @@ +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH pki-pkcs12-key 1 "Oct 28, 2016" "version 10.3" "PKI PKCS #12 Key Management Commands" Dogtag Team +.\" Please adjust this date whenever revising the man page. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for man page specific macros, see man(7) +.SH NAME +pki-pkcs12-key \- Command-Line Interface for managing individual keys in PKCS #12 file. + +.SH SYNOPSIS +.nf +\fBpki\fR [CLI options] \fBpkcs12-key\fR +\fBpki\fR [CLI options] \fBpkcs12-key-find\fR [command options] +\fBpki\fR [CLI options] \fBpkcs12-key-del \fR [command options] +.fi + +.SH DESCRIPTION +.PP +The \fBpki pkcs12-key\fR commands provide command-line interfaces to manage keys in a PKCS #12 file. + +.PP +\fBpki\fR [CLI options] \fBpkcs12-key-find\fR [command options] +.RS 4 +This command is to list keys in a PKCS #12 file. +.RE +.PP +\fBpki\fR [CLI options] \fBpkcs12-key-del \fR [command options] +.RS 4 +This command is to delete a key from a PKCS #12 file. +.RE + +.SH OPTIONS +The CLI options are described in \fBpki\fR(1). + +.SH OPERATIONS + +To view available profile commands, type \fBpki pkcs12-key\fP. To view each command's usage, type \fB pki pkcs12-key- \-\-help\fP. + +All \fBpkcs12-key\fP commands require a PKCS #12 file and its password. +The PKCS #12 file can be specified with the \fB--pkcs12-file\fP parameter. +The password can be specified either directly with the \fB--pkcs12-password\fP parameter, or in a file with the \fB--pkcs12-password-file\fP parameter. + +All \fBpkcs12-key\fP commands also require an NSS database and its password. +The NSS database location can be specified with the \fB-d\fP parameter (default: ~/.dogtag/nssdb). +The NSS database password can be specified with the \fB-c\fP or the \fB-C\fP parameter. + +.SS Viewing keys in a PKCS #12 file + +To list the keys in a PKCS #12 file: + +.B pki pkcs12-key-find + +.SS Deleting a key from a PKCS #12 file + +To delete a key from a PKCS #12 file: + +.B pki pkcs12-key-del + +.SH AUTHORS +Endi S. Dewata . + +.SH COPYRIGHT +Copyright (c) 2016 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 +.BR pki-pkcs12(1) diff --git a/base/java-tools/man/man1/pki-pkcs12.1 b/base/java-tools/man/man1/pki-pkcs12.1 new file mode 100644 index 0000000000000000000000000000000000000000..9e1a50cdea937b1f7510a535575711a5bdc22965 --- /dev/null +++ b/base/java-tools/man/man1/pki-pkcs12.1 @@ -0,0 +1,113 @@ +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH pki-pkcs12 1 "Oct 28, 2016" "version 10.3" "PKI PKCS #12 Management Commands" Dogtag Team +.\" Please adjust this date whenever revising the man page. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for man page specific macros, see man(7) +.SH NAME +pki-pkcs12 \- Command-Line Interface for managing certificates and keys in PKCS #12 file. + +.SH SYNOPSIS +.nf +\fBpki\fR [CLI options] \fBpkcs12\fR +\fBpki\fR [CLI options] \fBpkcs12-export\fR [command options] +\fBpki\fR [CLI options] \fBpkcs12-import\fR [command options] +\fBpki\fR [CLI options] \fBpkcs12-cert\fR [command options] +\fBpki\fR [CLI options] \fBpkcs12-key\fR [command options] +.fi + +.SH DESCRIPTION +.PP +The \fBpki pkcs12\fR commands provide command-line interfaces to manage certificate and keys in a PKCS #12 file. + +.PP +\fBpki\fR [CLI options] \fBpkcs12-export\fR [command options] +.RS 4 +This command is to export all certificates and keys from an NSS database into a PKCS #12 file. +.RE +.PP +\fBpki\fR [CLI options] \fBpkcs12-import\fR [command options] +.RS 4 +This command is to import all certificates and keys from a PKCS #12 file into an NSS database. +.RE +.PP +\fBpki\fR [CLI options] \fBpkcs12-cert\fR [command options] +.RS 4 +This command is to manage individual certificates in a PKCS #12 file. See \fBpki-pkcs12-cert\fR(1). +.RE +.PP +\fBpki\fR [CLI options] \fBpkcs12-key\fR [command options] +.RS 4 +This command is to import individual keys in a PKCS #12 file. See \fBpki-pkcs12-key\fR(1). +.RE + +.SH OPTIONS +The CLI options are described in \fBpki\fR(1). + +.SH OPERATIONS + +To view available PKCS #12 commands, type \fBpki pkcs12\fP. To view each command's usage, type \fB pki pkcs12- \-\-help\fP. + +All \fBpki pkcs12\fP commands require a PKCS #12 file and its password. +The PKCS #12 file can be specified with the \fB--pkcs12-file\fP parameter. +The password can be specified either directly with the \fB--pkcs12-password\fP parameter, or in a file with the \fB--pkcs12-password-file\fP parameter. + +Some \fBpki pkcs12\fP commands require an NSS database and its password. +The NSS database location can be specified with the \fB-d\fP parameter (default: ~/.dogtag/nssdb). +The NSS database password can be specified with the \fB-c\fP or the \fB-C\fP parameter. + +.SS Exporting all certificates and keys into a PKCS #12 file + +To export all certificates and keys from an NSS database into a PKCS #12 file: + +.B pki pkcs12-export [nicknames...] + +By default the command will export all certificates in the NSS database. +To export certain certificates only, specify the certificate nicknames as separate arguments. + +By default the command will always create a new PKCS #12 file. +To export into an existing PKCS #12 file, specify the \fB--append\fP parameter. + +By default the command will include the certificate chain. +To export without certificate chain, specify the \fB--no-chain\fP parameter. + +By default the command will include the key of each certificate. +To export without the key, specify the \fB--no-key\fP parameter. + +By default the command will include the trust flags of each certificate. +To export without the trust flags, specify the \fB--no-trust-flags\fP parameter. + +.SS Importing certificates and keys from a PKCS #12 file + +To import certificates and keys from a PKCS #12 file into an NSS database: + +.B pki pkcs12-import + +By default the command will include all certificates in the PKCS #12 file. +To import without the CA certificates (certificates without keys), specify the \fB--no-ca-certs\fP parameter. +To import without the user certificates (certificates with keys), specify the \fB--no-user-certs\fP parameter. + +By default the command will skip a certificate if it already exists in the NSS database. +To overwrite the nickname, the key, and the trust flags of existing certificates, specify the \fB--overwrite\fP parameter. + +By default the command will include the trust flags of each certificate. +To import without the trust flags, specify the \fB--no-trust-flags\fP parameter. + +.SH AUTHORS +Endi S. Dewata . + +.SH COPYRIGHT +Copyright (c) 2016 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 +.B pki-pkcs12-cert(1), pki-pkcs12-key(1) -- 2.5.5