pki: Add acert and extend pki/print manpages
[strongswan.git] / src / pki / man / pki---acert.1.in
1 .TH "PKI \-\-ACERT" 1 "2014-02-05" "@PACKAGE_VERSION@" "strongSwan"
2 .
3 .SH "NAME"
4 .
5 pki \-\-acert \- Issue an attribute certificate
6 .
7 .SH "SYNOPSIS"
8 .
9 .SY pki\ \-\-acert
10 .OP \-\-in file
11 .OP \-\-group membership
12 .BI \-\-issuerkey\~ file |\-\-issuerkeyid\~ hex
13 .BI \-\-issuercert\~ file
14 .OP \-\-lifetime hours
15 .OP \-\-serial hex
16 .OP \-\-digest digest
17 .OP \-\-outform encoding
18 .OP \-\-debug level
19 .YS
20 .
21 .SY pki\ \-\-acert
22 .BI \-\-options\~ file
23 .YS
24 .
25 .SY "pki \-\-acert"
26 .B \-h
27 |
28 .B \-\-help
29 .YS
30 .
31 .SH "DESCRIPTION"
32 .
33 This sub-command of
34 .BR pki (1)
35 is used to issue an attribute certificate using an issuer certificate with its
36 private key and the holder certificate.
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 Holder certificate to issue an attribute certificate for. If not given the
52 certificate is read from \fISTDIN\fR.
53 .TP
54 .BI "\-m, \-\-group " membership
55 Group membership the attribute certificate shall certify. The specified group
56 is included as a string. To include multiple groups, the option can be repeated.
57 .TP
58 .BI "\-k, \-\-issuerkey " file
59 Issuer private key file. Either this or
60 .B \-\-issuerkeyid
61 is required.
62 .TP
63 .BI "\-x, \-\-issuerkeyid " hex
64 Key ID of a issuer private key on a smartcard. Either this or
65 .B \-\-issuerkey
66 is required.
67 .TP
68 .BI "\-c, \-\-issuercert " file
69 Issuer certificate file. Required.
70 .TP
71 .BI "\-l, \-\-lifetime " hours
72 Hours the attribute certificate is valid, default: 24.
73 .TP
74 .BI "\-s, \-\-serial " hex
75 Serial number in hex. It is randomly allocated by default.
76 .TP
77 .BI "\-g, \-\-digest " digest
78 Digest to use for signature creation. One of \fImd5\fR, \fIsha1\fR,
79 \fIsha224\fR, \fIsha256\fR, \fIsha384\fR, or \fIsha512\fR. Defaults to
80 \fIsha1\fR.
81 .TP
82 .BI "\-f, \-\-outform " encoding
83 Encoding of the created certificate file. Either \fIder\fR (ASN.1 DER) or
84 \fIpem\fR (Base64 PEM), defaults to \fIder\fR.
85 .
86 .SH "EXAMPLES"
87 .
88 To save repetitive typing, command line options can be stored in files.
89 Lets assume
90 .I acert.opt
91 contains the following contents:
92 .PP
93 .EX
94   --issuercert aacert.der --issuerkey aakey.der --digest sha256 --lifetime 4
95 .EE
96 .PP
97 Then the following command can be used to issue an attribute certificate based
98 on a holder certificate and the options above:
99 .PP
100 .EX
101   pki --acert --options acert.opt --in holder.der --group sales --group finance -f pem
102 .EE
103 .PP
104 .
105 .SH "SEE ALSO"
106 .
107 .BR pki (1)