lod plugins for scepclient
[strongswan.git] / src / scepclient / scepclient.8
1 .\" 
2 .TH "IPSEC_SCEPCLIENT" "8" "29 September 2005" "Jan Hutter, Martin Willi" ""
3 .SH "NAME"
4 ipsec scepclient \- Client for the SCEP protocol
5 .SH "SYNOPSIS"
6 .B ipsec scepclient [argument ...]
7 .sp
8 .B ipsec scepclient
9 .B \-\-help
10 .br 
11 .B ipsec scepclient
12 .B \-\-version
13 .SH "DESCRIPTION"
14 .BR scepclient
15 is a client implementation of Cisco System's Simple Certificate Enrollment Protocol (SCEP) written for Linux strongSwan <http://www.strongswan.org>.
16 .BR scepclient
17 is designed to be used for certificate enrollment on machines using the OpenSource IPsec solution
18 .I strongSwan.
19 .SH "FEATURES"
20 .BR scepclient
21 implements the following features of SCEP:
22 .br 
23 .IP "\-" 4
24 Automatic enrollment of client certificate using a preshared secret
25 .IP "\-" 4
26 Manual enrollment of client certificate. Offline fingerprint check required!
27 .IP "\-" 4
28 Acquisition of CA certificate(s)
29 .SH "OPTIONS"
30 .SS Basic Startup Options
31 .B \-v, \-\-version
32 .RS 4
33 Display the version of ipsec scepclient.
34 .PP 
35 .RE
36 .B \-h, \-\-help
37 .RS 4
38 Display usage of ipsec scepclient.
39 .RE
40
41 .SS General Options
42 .B \-u, \-\-url \fIurl\fP
43 .RS 4
44 Full HTTP URL of the SCEP server to be used for certificate enrollment and CA certificate acquisition.
45 .RE
46 .PP 
47 .B \-+, \-\-optionsfrom \fIfilename\fP
48 .RS 4
49 Reads additional options from \fIfilename\fP.
50 .RE
51 .PP 
52 .B \-f, \-\-force
53 .RS 4
54 Overwrite existing output file[s].
55 .RE
56 .PP 
57 .B \-q, \-\-quiet
58 .RS 4
59 Do not write log output to stderr.
60 .RE
61
62 .SS Options for CA Certificate Acquisition
63 .B \-o, \-\-out cacert[=\fIfilename\fP]
64 .RS 4
65 Output file of acquired CA certificate. If more then one CA certificate is available, \fIfilename\fP is used as prefix for the resulting files.
66 .br
67 The default \fIfilename\fP is $CONFDIR/ipsec.d/cacerts/caCert.der.
68 .RE
69
70 .SS Options For Certificate Enrollment
71 .B \-i, \-\-in \fItype\fP[=\fIfilename\fP]
72 .RS 4
73 Input file for certificate enrollment. This option can be specified multiple times to specify input files for every \fItype\fP. 
74 Input files can bei either DER or PEM encoded.
75 .PP 
76 Supported values for \fItype\fP:
77 .IP "\fBpkcs1\fP" 12
78 RSA private key in PKCS#1 file format. If no input of this type is specified, a RSA key gets generated.
79 .br
80 The default \fIfilename\fP is $CONFDIR/ipsec.d/private/myKey.der.
81 .IP "\fBcacert\-enc\fP" 12
82 CA certificate to encrypt the SCEP request. Has to be specified for certificate enrollment. 
83 .br 
84 The default \fIfilename\fP is $CONFDIR/ipsec.d/cacerts/caCert.der.
85 .IP "\fBcacert\-sig\fP" 12
86 CA certificate to check signature of SCEP reply. Has to be specified for certificate enrollment. 
87 .br 
88 The default \fIfilename\fP is $CONFDIR/ipsec.d/cacerts/caCert.der.
89 .RE
90 .PP 
91 .B \-k, \-\-keylength \fIbits\fP
92 .RS 4
93 sets the key length for RSA key generation. The default length for a generated rsa key is set to 2048 bit.
94 .RE
95 .PP 
96 .B \-D, \-\-days \fIdays\fP
97 .RS 4
98 Validity of the self-signed X.509 certificate in days. The default is 1825 days (5 years).
99 .RE
100 .PP 
101 .B \-S, \-\-startdate \fIYYMMDDHHMMSS\fPZ
102 .RS 4
103 defines the \fBnotBefore\fP date when the X.509 certificate  becomes  valid. 
104 The  date has the format \fIYYMMDDHHMMSS\fP and  must be specified in UTC (Zulu time).
105 If the \fB--startdate\fP option is not specified then the current date is taken as a default.
106 .RE
107 .PP 
108 .B \-E, \-\-enddate \fIYYMMDDHHMMSS\fPZ
109 .RS 4
110 defines the \fBnotAfter\fP date when the X.509 certificate will expire.
111 The date has the format \fIYYMMDDHHMMSS\fP and must be specified in UTC (Zulu time).
112 If the \fB--enddate\fP option is not specified then the default \fBnotAfter\fP value is computed by
113 adding the validity interval specified by the \fB--days\fP option to the \fBnotBefore\fP date.
114 .RE
115 .PP
116 .B \-d, \-\-dn \fIdn\fP
117 .RS 4
118 Distinguished name as comma separated list of relative distinguished names. Use quotation marks for a distinguished name containing spaces. If the \fB\-\-dn\fP parameter is missing then the default "C=CH, O=Linux strongSwan, CN=\fIhostname\fP"
119 is used with \fIhostname\fP being the return value of the \fIgethostname\fP() function.
120 .RE
121 .PP 
122 .B \-s, \-\-subjectAltName \fItype\fP=\fIvalue\fP
123 .RS 4
124 Include subjectAltName in certificate request. This option can be specified multiple times to specify a subjectAltName
125 for every \fItype\fP.
126 .PP 
127 Supported values for \fItype\fP:
128 .IP "\fBemail\fP" 12
129 subjectAltName is a email address.
130 .IP "\fBdns\fP" 12
131 subjectAltName is a hostname.
132 .IP "\fBip\fP" 12
133 subjectAltName is a IP address.
134 .RE
135 .PP 
136 .B \-p, \-\-password \fIpw\fP
137 .RS 4
138 Password to be included as a \fIchallenge password\fP in SCEP request.
139 If \fIpw\fP is \fB%prompt\fP', the password gets prompted for on the command line.
140 .IP
141 \- In automatic mode, this password corresponds to the preshared secret for the given enrollment.
142 .IP 
143 \- In manual mode, this password can be used to later revoke the corresponding certificate.
144 .RE
145 .PP 
146 .B \-a, \-\-algorithm \fIalgo\fP
147 .RS 4
148 Change symmetric algorithm to use for encryption of certificate Request.
149 The default is \fB3des\-cbc\fP.
150 .PP 
151 Supported values for \fIalgo\fP:
152 .IP "\fBdes\-cbc\fP" 12
153 DES CBC encryption (key size = 56 bit).
154 .IP "\fB3des\-cbc\fP" 12
155 Triple DES-EDE-CBC encryption (key size = 168 bit).
156 .IP "\fBaes128\-cbc\fP" 12
157 AES-CBC encryption (key size = 128 bit).
158 .IP "\fBaes192\-cbc\fP" 12
159 AES-CBC encryption (key size = 192 bit).
160 .IP "\fBaes256\-cbc\fP" 12
161 AES-CBC encryption (key size = 256 bit).
162 .RE
163 .PP 
164 .B \-o, \-\-out \fItype\fP[=\fIfilename\fP]
165 .RS 4
166 Output file for certificate enrollment. This option can be specified multiple times to specify output files for every \fItype\fP.
167 .PP 
168 Supported values for \fItype\fP:
169 .IP "\fBpkcs1\fP" 12
170 RSA private key in PKCS#1 file format. If specified, the RSA key used for enrollment is stored in file \fIfilename\fP.
171 If none of the \fItypes\fP listed below are specified, \fBscepclient\fP will stop after outputting this file.
172 .br 
173 The default \fIfilename\fP is $CONFDIR/ipsec.d/private/myKey.der.
174 .IP "\fBpkcs10\fP" 12
175 PKCS#10 certificate request. If specified, the PKCS#10 request used or certificate enrollment is stored in file \fIfilename\fP.
176 If none of the \fItypes\fP listed below are specified, \fBscepclient\fP will stop after outputting this file. 
177 .br 
178 The default \fIfilename\fP is $CONFDIR/ipsec.d/req/myReq.der.
179 .IP "\fBpkcs7\fP" 12
180 PKCS#7 SCEP request as it is sent using HTTP to the SCEP server. If specified, this SCEP request is stored in file \fIfilename\fP.
181 If none of \fItypes\fP listed below is not specified, \fBscepclient\fP will stop after outputting this file.
182 .br 
183 The default \fIfilename\fP is $CONFDIR/ipsec.d/req/pkcs7.der.
184 .IP "\fBcert-self\fP" 12
185 Self-signed certificate. If specified the self-signed certificate is stored in file \fIfilename\fP.
186 .br 
187 The default \fIfilename\fP is $CONFDIR/ipsec.d/certs/selfCert.der.
188 .IP "\fBcert\fP" 12
189 Enrolled certificate. This \fItype\fP must be specified for certificate enrollment.
190 The enrolled certificate is stored in file \fIfilename\fP.
191 .br 
192 The default \fIfilename\fP is set to $CONFDIR/ipsec.d/certs/myCert.der.
193 .RE
194 .PP 
195 .B \-m, \-\-method \fImethod\fP
196 .RS 4
197 Change HTTP request method for certificate enrollment. Default is \fBget\fP.
198 .PP 
199 Supported values for \fImethod\fP:
200 .IP "\fBpost\fP" 12
201 Certificate enrollment using HTTP POST. Must be supported by the given SCEP server.
202 .IP "\fBget\fP" 12
203 Certificate enrollment using HTTP GET.
204 .RE
205 .PP 
206 .B \-t, \-\-interval \fIseconds\fP
207 .RS 4
208 Set interval time in seconds when polling in manual mode.
209 The default interval is set to 5 seconds.
210 .RE
211 .PP 
212 .B \-x, \-\-maxpolltime \fIseconds\fP
213 .RS 4
214 Set max time in seconds to poll in manual mode.
215 The default max time is set to unlimited.
216 .RE
217
218 .SS Debugging Output Options:
219 .B \-A, \-\-debug\-all
220 .RS 4
221 Log everything except private data.
222 .RE
223 .PP 
224 .B \-P, \-\-debug\-parsing
225 .RS 4
226 Log parsing relevant stuff.
227 .RE
228 .PP 
229 .B \-R, \-\-debug\-raw
230 .RS 4
231 Log raw hex dumps.
232 .RE
233 .PP 
234 .B \-C, \-\-debug\-control
235 .RS 4
236 Log informations about control flow.
237 .RE
238 .PP 
239 .B \-M, \-\-debug\-controlmore
240 .RS 4
241 Log more detailed informations about control flow.
242 .RE
243 .PP 
244 .B \-X, \-\-debug\-private
245 .RS 4
246 Log sensitive data (e.g. private keys).
247 .RE
248 .SH "EXAMPLES"
249 .B  ipsec scepclient \-\-out caCert \-\-url http://scepserver/cgi\-bin/pkiclient.exe \-f
250 .RS 4
251 Acquire CA certificate from SCEP server and store it in the default file $CONFDIR/ipsec.d/cacerts/caCert.der.
252 If more then one CA certificate is returned, store them in files named caCert.der\-1', caCert.der\-2', etc. 
253 .br 
254 Existing files are overwritten.
255 .RE
256 .PP 
257 .B  ipsec scepclient \-\-out pkcs1=joeKey.der \-k 1024
258 .RS 4
259 Generate RSA private key with key length of 1024 bit and store it in file joeKey.der.
260 .RE
261 .PP 
262 .B  ipsec scepclient \-\-in pkcs1=joeKey.der \-\-out pkcs10=joeReq.der \e
263 .br 
264 .B \-\-dn \*(rqC=AT, CN=John Doe\*(rq \-s email=john@doe.com \-p mypassword
265 .RS 4
266 Generate a PKCS#10 request and store it in file joeReq.der. Use the RSA private key joeKey.der
267 created earlier to sign the PKCS#10\-Request. In addition to the distinguished name include a 
268 email\-subjectAltName and a challenge password in the request.
269 .RE
270 .PP 
271 .B  ipsec scepclient \-\-out pkcs1=joeKey.der \-\-out cert==joeCert.der \e
272 .br 
273 .B \-\-dn \*(rqC=CH, CN=John Doe\*(rq \-k 512 \-p 5xH2pnT7wq \e
274 .br 
275 .B \-\-url http://scep.hsr.ch/cgi\-bin/pkiclient.exe \e
276 .br 
277 .B \-\-in cacert\-enc=caCert.der \-\-in cacert\-sig=caCert.der
278 .RS 4
279 Generate a new RSA key for the request and store it in joeKey.der. Then enroll a certificate and store as joeCert.der.
280 The challenge password is '5xH2pnT7wq'. The encryption and signature check has to be made with the same CA certificate
281 caCert.der.
282 .RE
283
284
285 .SH "BUGS"
286 \fB\-\-optionsfrom\fP seems to have parsing problems reading option files containing strings in quotation marks.
287 .SH "COPYRIGHT"
288 Copyright (C) 2005 Jan Hutter, Martin Willi
289 .br 
290 Hochschule fuer Technik Rapperswil
291 .PP 
292 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
293 .PP 
294 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.