fixed pluto/scepclient out-of-tree builds
[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 CBC encryption (key size = 168 bit).
156 .RE
157 .PP 
158 .B \-o, \-\-out \fItype\fP[=\fIfilename\fP]
159 .RS 4
160 Output file for certificate enrollment. This option can be specified multiple times to specify output files for every \fItype\fP.
161 .PP 
162 Supported values for \fItype\fP:
163 .IP "\fBpkcs1\fP" 12
164 RSA private key in PKCS#1 file format. If specified, the RSA key used for enrollment is stored in file \fIfilename\fP.
165 If none of the \fItypes\fP listed below are specified, \fBscepclient\fP will stop after outputting this file.
166 .br 
167 The default \fIfilename\fP is $CONFDIR/ipsec.d/private/myKey.der.
168 .IP "\fBpkcs10\fP" 12
169 PKCS#10 certificate request. If specified, the PKCS#10 request used or certificate enrollment is stored in file \fIfilename\fP.
170 If none of the \fItypes\fP listed below are specified, \fBscepclient\fP will stop after outputting this file. 
171 .br 
172 The default \fIfilename\fP is $CONFDIR/ipsec.d/req/myReq.der.
173 .IP "\fBpkcs7\fP" 12
174 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.
175 If none of \fItypes\fP listed below is not specified, \fBscepclient\fP will stop after outputting this file.
176 .br 
177 The default \fIfilename\fP is $CONFDIR/ipsec.d/req/pkcs7.der.
178 .IP "\fBcert-self\fP" 12
179 Self-signed certificate. If specified the self-signed certificate is stored in file \fIfilename\fP.
180 .br 
181 The default \fIfilename\fP is $CONFDIR/ipsec.d/certs/selfCert.der.
182 .IP "\fBcert\fP" 12
183 Enrolled certificate. This \fItype\fP must be specified for certificate enrollment.
184 The enrolled certificate is stored in file \fIfilename\fP.
185 .br 
186 The default \fIfilename\fP is set to $CONFDIR/ipsec.d/certs/myCert.der.
187 .RE
188 .PP 
189 .B \-m, \-\-method \fImethod\fP
190 .RS 4
191 Change HTTP request method for certificate enrollment. Default is \fBget\fP.
192 .PP 
193 Supported values for \fImethod\fP:
194 .IP "\fBpost\fP" 12
195 Certificate enrollment using HTTP POST. Must be supported by the given SCEP server.
196 .IP "\fBget\fP" 12
197 Certificate enrollment using HTTP GET.
198 .RE
199 .PP 
200 .B \-t, \-\-interval \fIseconds\fP
201 .RS 4
202 Set interval time in seconds when polling in manual mode.
203 The default interval is set to 5 seconds.
204 .RE
205 .PP 
206 .B \-x, \-\-maxpolltime \fIseconds\fP
207 .RS 4
208 Set max time in seconds to poll in manual mode.
209 The default max time is set to unlimited.
210 .RE
211
212 .SS Debugging Output Options:
213 .B \-A, \-\-debug\-all
214 .RS 4
215 Log everything except private data.
216 .RE
217 .PP 
218 .B \-P, \-\-debug\-parsing
219 .RS 4
220 Log parsing relevant stuff.
221 .RE
222 .PP 
223 .B \-R, \-\-debug\-raw
224 .RS 4
225 Log raw hex dumps.
226 .RE
227 .PP 
228 .B \-C, \-\-debug\-control
229 .RS 4
230 Log informations about control flow.
231 .RE
232 .PP 
233 .B \-M, \-\-debug\-controlmore
234 .RS 4
235 Log more detailed informations about control flow.
236 .RE
237 .PP 
238 .B \-X, \-\-debug\-private
239 .RS 4
240 Log sensitive data (e.g. private keys).
241 .RE
242 .SH "EXAMPLES"
243 .B  ipsec scepclient \-\-out caCert \-\-url http://scepserver/cgi\-bin/pkiclient.exe \-f
244 .RS 4
245 Acquire CA certificate from SCEP server and store it in the default file $CONFDIR/ipsec.d/cacerts/caCert.der.
246 If more then one CA certificate is returned, store them in files named caCert.der\-1', caCert.der\-2', etc. 
247 .br 
248 Existing files are overwritten.
249 .RE
250 .PP 
251 .B  ipsec scepclient \-\-out pkcs1=joeKey.der \-k 1024
252 .RS 4
253 Generate RSA private key with key length of 1024 bit and store it in file joeKey.der.
254 .RE
255 .PP 
256 .B  ipsec scepclient \-\-in pkcs1=joeKey.der \-\-out pkcs10=joeReq.der \e
257 .br 
258 .B \-\-dn \*(rqC=AT, CN=John Doe\*(rq \-s email=john@doe.com \-p mypassword
259 .RS 4
260 Generate a PKCS#10 request and store it in file joeReq.der. Use the RSA private key joeKey.der
261 created earlier to sign the PKCS#10\-Request. In addition to the distinguished name include a 
262 email\-subjectAltName and a challenge password in the request.
263 .RE
264 .PP 
265 .B  ipsec scepclient \-\-out pkcs1=joeKey.der \-\-out cert==joeCert.der \e
266 .br 
267 .B \-\-dn \*(rqC=CH, CN=John Doe\*(rq \-k 512 \-p 5xH2pnT7wq \e
268 .br 
269 .B \-\-url http://scep.hsr.ch/cgi\-bin/pkiclient.exe \e
270 .br 
271 .B \-\-in cacert\-enc=caCert.der \-\-in cacert\-sig=caCert.der
272 .RS 4
273 Generate a new RSA key for the request and store it in joeKey.der. Then enroll a certificate and store as joeCert.der.
274 The challenge password is '5xH2pnT7wq'. The encryption and signature check has to be made with the same CA certificate
275 caCert.der.
276 .RE
277
278
279 .SH "BUGS"
280 \fB\-\-optionsfrom\fP seems to have parsing problems reading option files containing strings in quotation marks.
281 .SH "COPYRIGHT"
282 Copyright (C) 2005 Jan Hutter, Martin Willi
283 .br 
284 Hochschule fuer Technik Rapperswil
285 .PP 
286 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>.
287 .PP 
288 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.