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