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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
|
.\" 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 pkidaemon 1 "Jul 8, 2015" "version 10.2" "pkidaemon" 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
\fBpkidaemon\fR \- provides status management of PKI instances
.SH SYNOPSIS
.nf
\fBpkidaemon {start|status} [instance-name]\fR
.fi
.TP
\fBNote:\fP Although this tool currently resides in the \fB/usr/bin\fP directory, proper use of it requires it to be run with super user privileges.
.SH DESCRIPTION
.PP
The \fBpkidaemon\fR command with the 'status' argument provides a way to display the status of all existing PKI instances on a machine. Optionally, an individual PKI instance may be specified by using an optional \fB[instance-name]\fP.
.PP
The \fBpkidaemon\fR 'start' argument is currently only used internally by the systemctl scripts.
.SH OPTIONS
As stated above, the only optional argument to \fBpkidaemon\fR is \fB[instance-name]\fP. If a valid instance name is specified, only the status of that instance will be displayed.
.SH EXAMPLES
For the following examples, two instances were installed. The first contained a CA, KRA, OCSP, TKS and TPS in a shared PKI instance named 'pki-tomcat', while the second simply contained a CA running on different ports and named 'pki-tomcat-2'.
For the OCSP 'Unsecure URL' and the OCSP 'Secure EE URL' which both specify a static string of '<ocsp request blob>', the intention is for the user to replace this static string with an actual OCSP request blob relevant to their particular deployment.
.SS Listing the status of all local PKI instances on this machine:
.BR
.PP
\fB# pkidaemon status\fR
REPORT STATUS OF 'tomcat' INSTANCE(S):
Status for pki-tomcat: pki-tomcat is running ..
[CA Status Definitions]
Unsecure URL = http://pki.example.com:8080/ca/ee/ca
Secure Agent URL = https://pki.example.com:8443/ca/agent/ca
Secure EE URL = https://pki.example.com:8443/ca/ee/ca
Secure Admin URL = https://pki.example.com:8443/ca/services
PKI Console Command = pkiconsole https://pki.example.com:8443/ca
Tomcat Port = 8005 (for shutdown)
[KRA Status Definitions]
Secure Agent URL = https://pki.example.com:8443/kra/agent/kra
Secure Admin URL = https://pki.example.com:8443/kra/services
PKI Console Command = pkiconsole https://pki.example.com:8443/kra
Tomcat Port = 8005 (for shutdown)
[OCSP Status Definitions]
Unsecure URL = http://pki.example.com:8080/ocsp/ee/ocsp/<ocsp request blob>
Secure Agent URL = https://pki.example.com:8443/ocsp/agent/ocsp
Secure EE URL = https://pki.example.com:8443/ocsp/ee/ocsp/<ocsp request blob>
Secure Admin URL = https://pki.example.com:8443/ocsp/services
PKI Console Command = pkiconsole https://pki.example.com:8443/ocsp
Tomcat Port = 8005 (for shutdown)
[TKS Status Definitions]
Secure Agent URL = https://pki.example.com:8443/tks/agent/tks
Secure Admin URL = https://pki.example.com:8443/tks/services
PKI Console Command = pkiconsole https://pki.example.com:8443/tks
Tomcat Port = 8005 (for shutdown)
[TPS Status Definitions]
Unsecure URL = http://pki.example.com:8080/tps
Secure URL = https://pki.example.com:8443/tps
Unsecure PHONE HOME = http://pki.example.com:8080/tps/phoneHome
Secure PHONE HOME = https://pki.example.com:8443/tps/phoneHome
Tomcat Port = 8005 (for shutdown)
[CA Configuration Definitions]
PKI Instance Name: pki-tomcat
PKI Subsystem Type: Root CA (Security Domain)
Registered PKI Security Domain Information:
====================================================================
Name: example.com Security Domain
URL: https://pki.example.com:8443
====================================================================
[KRA Configuration Definitions]
PKI Instance Name: pki-tomcat
PKI Subsystem Type: KRA
Registered PKI Security Domain Information:
====================================================================
Name: example.com Security Domain
URL: https://pki.example.com:8443
====================================================================
[OCSP Configuration Definitions]
PKI Instance Name: pki-tomcat
PKI Subsystem Type: OCSP
Registered PKI Security Domain Information:
====================================================================
Name: example.com Security Domain
URL: https://pki.example.com:8443
====================================================================
[TKS Configuration Definitions]
PKI Instance Name: pki-tomcat
PKI Subsystem Type: TKS
Registered PKI Security Domain Information:
====================================================================
Name: example.com Security Domain
URL: https://pki.example.com:8443
====================================================================
[TPS Configuration Definitions]
PKI Instance Name: pki-tomcat
PKI Subsystem Type: TPS
Registered PKI Security Domain Information:
====================================================================
Name: example.com Security Domain
URL: https://pki.example.com:8443
====================================================================
Status for pki-tomcat-2: pki-tomcat-2 is running ..
[CA Status Definitions]
Unsecure URL = http://pki.example.com:18080/ca/ee/ca
Secure Agent URL = https://pki.example.com:18443/ca/agent/ca
Secure EE URL = https://pki.example.com:18443/ca/ee/ca
Secure Admin URL = https://pki.example.com:18443/ca/services
PKI Console Command = pkiconsole https://pki.example.com:18443/ca
Tomcat Port = 18005 (for shutdown)
[CA Configuration Definitions]
PKI Instance Name: pki-tomcat-2
PKI Subsystem Type: Root CA (Security Domain)
Registered PKI Security Domain Information:
====================================================================
Name: example.com Security Domain
URL: https://pki.example.com:18443
====================================================================
FINISHED REPORTING STATUS OF 'tomcat' INSTANCE(S).
.SS Listing the status of the PKI instance named 'pki-tomcat':
.BR
.PP
\fB# pkidaemon status pki-tomcat\fR
Status for pki-tomcat: pki-tomcat is running ..
[CA Status Definitions]
Unsecure URL = http://pki.example.com:8080/ca/ee/ca
Secure Agent URL = https://pki.example.com:8443/ca/agent/ca
Secure EE URL = https://pki.example.com:8443/ca/ee/ca
Secure Admin URL = https://pki.example.com:8443/ca/services
PKI Console Command = pkiconsole https://pki.example.com:8443/ca
Tomcat Port = 8005 (for shutdown)
[KRA Status Definitions]
Secure Agent URL = https://pki.example.com:8443/kra/agent/kra
Secure Admin URL = https://pki.example.com:8443/kra/services
PKI Console Command = pkiconsole https://pki.example.com:8443/kra
Tomcat Port = 8005 (for shutdown)
[OCSP Status Definitions]
Unsecure URL = http://pki.example.com:8080/ocsp/ee/ocsp/<ocsp request blob>
Secure Agent URL = https://pki.example.com:8443/ocsp/agent/ocsp
Secure EE URL = https://pki.example.com:8443/ocsp/ee/ocsp/<ocsp request blob>
Secure Admin URL = https://pki.example.com:8443/ocsp/services
PKI Console Command = pkiconsole https://pki.example.com:8443/ocsp
Tomcat Port = 8005 (for shutdown)
[TKS Status Definitions]
Secure Agent URL = https://pki.example.com:8443/tks/agent/tks
Secure Admin URL = https://pki.example.com:8443/tks/services
PKI Console Command = pkiconsole https://pki.example.com:8443/tks
Tomcat Port = 8005 (for shutdown)
[TPS Status Definitions]
Unsecure URL = http://pki.example.com:8080/tps
Secure URL = https://pki.example.com:8443/tps
Unsecure PHONE HOME = http://pki.example.com:8080/tps/phoneHome
Secure PHONE HOME = https://pki.example.com:8443/tps/phoneHome
Tomcat Port = 8005 (for shutdown)
[CA Configuration Definitions]
PKI Instance Name: pki-tomcat
PKI Subsystem Type: Root CA (Security Domain)
Registered PKI Security Domain Information:
====================================================================
Name: example.com Security Domain
URL: https://pki.example.com:8443
====================================================================
[KRA Configuration Definitions]
PKI Instance Name: pki-tomcat
PKI Subsystem Type: KRA
Registered PKI Security Domain Information:
====================================================================
Name: example.com Security Domain
URL: https://pki.example.com:8443
====================================================================
[OCSP Configuration Definitions]
PKI Instance Name: pki-tomcat
PKI Subsystem Type: OCSP
Registered PKI Security Domain Information:
====================================================================
Name: example.com Security Domain
URL: https://pki.example.com:8443
====================================================================
[TKS Configuration Definitions]
PKI Instance Name: pki-tomcat
PKI Subsystem Type: TKS
Registered PKI Security Domain Information:
====================================================================
Name: example.com Security Domain
URL: https://pki.example.com:8443
====================================================================
[TPS Configuration Definitions]
PKI Instance Name: pki-tomcat
PKI Subsystem Type: TPS
Registered PKI Security Domain Information:
====================================================================
Name: example.com Security Domain
URL: https://pki.example.com:8443
====================================================================
.SS Listing the status of the PKI instance named 'pki-tomcat-2':
.BR
.PP
\fB# pkidaemon status pki-tomcat-2\fR
Status for pki-tomcat-2: pki-tomcat-2 is running ..
[CA Status Definitions]
Unsecure URL = http://pki.example.com:18080/ca/ee/ca
Secure Agent URL = https://pki.example.com:18443/ca/agent/ca
Secure EE URL = https://pki.example.com:18443/ca/ee/ca
Secure Admin URL = https://pki.example.com:18443/ca/services
PKI Console Command = pkiconsole https://pki.example.com:18443/ca
Tomcat Port = 18005 (for shutdown)
[CA Configuration Definitions]
PKI Instance Name: pki-tomcat-2
PKI Subsystem Type: Root CA (Security Domain)
Registered PKI Security Domain Information:
====================================================================
Name: example.com Security Domain
URL: https://pki.example.com:18443
====================================================================
.SH BUGS
Report bugs to http://bugzilla.redhat.com.
.SH AUTHORS
Matthew Harmsen <mharmsen@redhat.com>. \fBpkidaemon\fP was written by the Certificate Server project.
.SH COPYRIGHT
Copyright (c) 2015 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 pkispawn(8),
.BR pkidestroy(8),
.BR pki_default.cfg(5),
.BR pki(1)
|
