summaryrefslogtreecommitdiffstats
path: root/base/java-tools/man/man1/pki-client.1
blob: 0364f84efb97a7263194799bf44ce625519311e1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
.\" 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-client 1 "May 5, 2014" "version 10.2" "PKI Client Security Database 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 <n>    insert n+1 empty lines
.\" for man page specific macros, see man(7)
.SH NAME
pki-client \- Command-Line Interface for managing the security database on Certificate System client.
.SH SYNOPSIS
.nf
\fBpki\fR [CLI options] \fBclient\fR
\fBpki\fR [CLI options] \fBclient-init\fR [command options]
\fBpki\fR [CLI options] \fBclient-cert-find\fR [command options]
\fBpki\fR [CLI options] \fBclient-cert-request\fR <subject DN> [command options]
\fBpki\fR [CLI options] \fBclient-cert-import\fR <nickname> [command options]
\fBpki\fR [CLI options] \fBclient-cert-del\fR <nickname> [command options]
.fi

.SH DESCRIPTION
.PP
The \fBpki-client\fR commands provide command-line interfaces to manage the security database on the client's machine.
.PP
\fBpki\fR [CLI options] \fBclient\fR
.RS 4
This command is to list available client commands.
.RE
.PP
\fBpki\fR [CLI options] \fBclient-init\fR [command options]
.RS 4
This command is to create a new security database for the client.
.RE
.PP
\fBpki\fR [CLI options] \fBclient-cert-find\fR [command options]
.RS 4
This command is to list certificates in the client security database.
.RE
.PP
\fBpki\fR [CLI options] \fBclient-cert-request\fR <subject DN> [command options]
.RS 4
This command is to generate and submit a certificate request.
.RE
.PP
\fBpki\fR [CLI options] \fBclient-cert-import\fR <nickname> [command options]
.RS 4
This command is to view a certificate in the client security database.
.RE
.PP
\fBpki\fR [CLI options] \fBclient-cert-del\fR <nickname> [command options]
.RS 4
This command is to delete a certificate from the client security database.
.RE

.SH OPTIONS
The CLI options are described in \fBpki\fR(1).

.SH OPERATIONS
To view available client commands, type \fBpki client\fP. To view each command's usage, type \fB pki client-<command> \-\-help\fP.

To create a new database execute the following command:

.B pki -d <security database location> -c <security database password> client-init

To view certificates in the security database:

.B pki -d <security database location> -c <security database password> client-cert-find

To request a certificate:

.B pki -d <security database location> -c <security database password> client-cert-request <subject DN>

To import a certificate from a file into the security database:

.B pki -d <security database location> -c <security database password> client-cert-import <nickname> --cert <certificate file>

To import a CA certificate from a file into the security database:

.B pki -d <security database location> -c <security database password> client-cert-import <nickname> --ca-cert <CA certificate file>

To import a certificate from CA server into the security database:

.B pki -d <security database location> -c <security database password> client-cert-import <nickname> --serial <serial number>

To import a CA certificate from CA server into the security database:

.B pki -d <security database location> -c <security database password> client-cert-import <nickname> --ca-server

To delete a certificate from the security database:

.B pki -d <security database location> -c <security database password> client-cert-del <nickname>

.SH AUTHORS
Ade Lee <alee@redhat.com>, Endi Dewata <edewata@redhat.com>, and Matthew Harmsen <mharmsen@redhat.com>.

.SH COPYRIGHT
Copyright (c) 2014 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.