plugin-loader: Optionally use load option in each plugin section to load plugins
[strongswan.git] / src / pki / man / pki---self.1.in
1 .TH "PKI \-\-SELF" 1 "2013-07-31" "@PACKAGE_VERSION@" "strongSwan"
2 .
3 .SH "NAME"
4 .
5 pki \-\-self \- Create a self-signed certificate
6 .
7 .SH "SYNOPSIS"
8 .
9 .SY pki\ \-\-self
10 .RB [ \-\-in
11 .IR file | \fB\-\-keyid\fR
12 .IR hex ]
13 .OP \-\-type t
14 .BI \-\-dn\~ distinguished-name
15 .OP \-\-san subjectAltName
16 .OP \-\-lifetime days
17 .OP \-\-serial hex
18 .OP \-\-flag flag
19 .OP \-\-digest digest
20 .OP \-\-ca
21 .OP \-\-ocsp uri
22 .OP \-\-pathlen len
23 .OP \-\-nc-permitted name
24 .OP \-\-nc-excluded name
25 .OP \-\-policy\-mapping mapping
26 .OP \-\-policy\-explicit len
27 .OP \-\-policy\-inhibit len
28 .OP \-\-policy\-any len
29 .OP \-\-cert\-policy oid\ \fR[\fB\-\-cps\-uri\ \fIuri\fR]\ \fR[\fB\-\-user\-notice\ \fItext\fR]
30 .OP \-\-outform encoding
31 .OP \-\-debug level
32 .YS
33 .
34 .SY pki\ \-\-self
35 .BI \-\-options\~ file
36 .YS
37 .
38 .SY "pki \-\-self"
39 .B \-h
40 |
41 .B \-\-help
42 .YS
43 .
44 .SH "DESCRIPTION"
45 .
46 This sub-command of
47 .BR pki (1)
48 is used to create a self-signed certificate.
49 .
50 .SH "OPTIONS"
51 .
52 .TP
53 .B "\-h, \-\-help"
54 Print usage information with a summary of the available options.
55 .TP
56 .BI "\-v, \-\-debug " level
57 Set debug level, default: 1.
58 .TP
59 .BI "\-+, \-\-options " file
60 Read command line options from \fIfile\fR.
61 .TP
62 .BI "\-i, \-\-in " file
63 Private key input file. If not given the key is read from \fISTDIN\fR.
64 .TP
65 .BI "\-x, \-\-keyid " hex
66 Key ID of a private key on a smartcard.
67 .TP
68 .BI "\-t, \-\-type " type
69 Type of the input key. Either \fIrsa\fR or \fIecdsa\fR, defaults to \fIrsa\fR.
70 .TP
71 .BI "\-d, \-\-dn " distinguished-name
72 Subject and issuer distinguished name (DN). Required.
73 .TP
74 .BI "\-a, \-\-san " subjectAltName
75 subjectAltName extension to include in certificate. Can be used multiple times.
76 .TP
77 .BI "\-l, \-\-lifetime " days
78 Days the certificate is valid, default: 1095.
79 .TP
80 .BI "\-s, \-\-serial " hex
81 Serial number in hex. It is randomly allocated by default.
82 .TP
83 .BI "\-e, \-\-flag " flag
84 Add extendedKeyUsage flag. One of \fIserverAuth\fR, \fIclientAuth\fR,
85 \fIcrlSign\fR, or \fIocspSigning\fR. Can be used multiple times.
86 .TP
87 .BI "\-g, \-\-digest " digest
88 Digest to use for signature creation. One of \fImd5\fR, \fIsha1\fR,
89 \fIsha224\fR, \fIsha256\fR, \fIsha384\fR, or \fIsha512\fR. Defaults to
90 \fIsha1\fR.
91 .TP
92 .BI "\-f, \-\-outform " encoding
93 Encoding of the created certificate file. Either \fIder\fR (ASN.1 DER) or
94 \fIpem\fR (Base64 PEM), defaults to \fIder\fR.
95 .TP
96 .BI "\-b, \-\-ca"
97 Include CA basicConstraint extension in certificate.
98 .TP
99 .BI "\-o, \-\-ocsp " uri
100 OCSP AuthorityInfoAccess URI to include in certificate. Can be used multiple
101 times.
102 .TP
103 .BI "\-p, \-\-pathlen " len
104 Set path length constraint.
105 .TP
106 .BI "\-n, \-\-nc-permitted " name
107 Add permitted NameConstraint extension to certificate.
108 .TP
109 .BI "\-N, \-\-nc-excluded " name
110 Add excluded NameConstraint extension to certificate.
111 .TP
112 .BI "\-M, \-\-policy-mapping " issuer-oid:subject-oid
113 Add policyMapping from issuer to subject OID.
114 .TP
115 .BI "\-E, \-\-policy-explicit " len
116 Add requireExplicitPolicy constraint.
117 .TP
118 .BI "\-H, \-\-policy-inhibit " len
119 Add inhibitPolicyMapping constraint.
120 .TP
121 .BI "\-A, \-\-policy-any " len
122 Add inhibitAnyPolicy constraint.
123 .PP
124 .SS "Certificate Policy"
125 Multiple certificatePolicy extensions can be added. Each with the following
126 information:
127 .TP
128 .BI "\-P, \-\-cert-policy " oid
129 OID to include in certificatePolicy extension. Required.
130 .TP
131 .BI "\-C, \-\-cps-uri " uri
132 Certification Practice statement URI for certificatePolicy.
133 .TP
134 .BI "\-U, \-\-user-notice " text
135 User notice for certificatePolicy.
136 .
137 .SH "EXAMPLES"
138 .
139 Generate a self-signed certificate using the given RSA key:
140 .PP
141 .EX
142   pki \-\-self \-\-in key.der \-\-dn "C=CH, O=strongSwan, CN=moon" \\
143       \-\-san moon.strongswan.org > cert.der
144 .EE
145 .
146 .SH "SEE ALSO"
147 .
148 .BR pki (1)