Merge branch 'priv-key-any'
[strongswan.git] / src / pki / man / pki---req.1.in
1 .TH "PKI \-\-REQ" 1 "2013-07-31" "@PACKAGE_VERSION@" "strongSwan"
2 .
3 .SH "NAME"
4 .
5 pki \-\-req \- Create a PKCS#10 certificate request
6 .
7 .SH "SYNOPSIS"
8 .
9 .SY pki\ \-\-req
10 .OP \-\-in file
11 .OP \-\-type type
12 .BI \-\-dn\~ distinguished-name
13 .OP \-\-san subjectAltName
14 .OP \-\-password password
15 .OP \-\-digest digest
16 .OP \-\-outform encoding
17 .OP \-\-debug level
18 .YS
19 .
20 .SY pki\ \-\-req
21 .BI \-\-options\~ file
22 .YS
23 .
24 .SY "pki \-\-req"
25 .B \-h
26 |
27 .B \-\-help
28 .YS
29 .
30 .SH "DESCRIPTION"
31 .
32 This sub-command of
33 .BR pki (1)
34 is used to create a PKCS#10 certificate request.
35 .
36 .SH "OPTIONS"
37 .
38 .TP
39 .B "\-h, \-\-help"
40 Print usage information with a summary of the available options.
41 .TP
42 .BI "\-v, \-\-debug " level
43 Set debug level, default: 1.
44 .TP
45 .BI "\-+, \-\-options " file
46 Read command line options from \fIfile\fR.
47 .TP
48 .BI "\-i, \-\-in " file
49 Private key input file. If not given the key is read from \fISTDIN\fR.
50 .TP
51 .BI "\-t, \-\-type " type
52 Type of the input key. Either \fIpriv\fR, \fIrsa\fR, \fIecdsa\fR or \fIbliss\fR,
53 defaults to \fIpriv\fR.
54 .TP
55 .BI "\-d, \-\-dn " distinguished-name
56 Subject distinguished name (DN). Required.
57 .TP
58 .BI "\-a, \-\-san " subjectAltName
59 subjectAltName extension to include in request. Can be used multiple times.
60 .TP
61 .BI "\-p, \-\-password " password
62 The challengePassword to include in the certificate request.
63 .TP
64 .BI "\-g, \-\-digest " digest
65 Digest to use for signature creation. One of \fImd5\fR, \fIsha1\fR,
66 \fIsha224\fR, \fIsha256\fR, \fIsha384\fR, or \fIsha512\fR.  The default is
67 determined based on the type and size of the signature key.
68 .TP
69 .BI "\-f, \-\-outform " encoding
70 Encoding of the created certificate file. Either \fIder\fR (ASN.1 DER) or
71 \fIpem\fR (Base64 PEM), defaults to \fIder\fR.
72 .
73 .SH "EXAMPLES"
74 .
75 Generate a certificate request for an RSA key, with a subjectAltName extension:
76 .PP
77 .EX
78   pki \-\-req \-\-in key.der \-\-dn "C=CH, O=strongSwan, CN=moon" \\
79        \-\-san moon@strongswan.org > req.der
80 .EE
81 .PP
82 Generate a certificate request for an ECDSA key and a different digest:
83 .PP
84 .EX
85   pki \-\-req \-\-in key.der \-\-type ecdsa \-\-digest sha256 \\
86       \-\-dn "C=CH, O=strongSwan, CN=carol"  > req.der
87 .EE
88 .PP
89 .
90 .SH "SEE ALSO"
91 .
92 .BR pki (1)