unit-tests: Fix "using integer constants in boolean context" warning
[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 \-\-not-before datetime
16 .OP \-\-not-after datetime
17 .OP \-\-serial hex
18 .OP \-\-digest digest
19 .OP \-\-outform encoding
20 .OP \-\-debug level
21 .YS
22 .
23 .SY pki\ \-\-acert
24 .BI \-\-options\~ file
25 .YS
26 .
27 .SY "pki \-\-acert"
28 .B \-h
29 |
30 .B \-\-help
31 .YS
32 .
33 .SH "DESCRIPTION"
34 .
35 This sub-command of
36 .BR pki (1)
37 is used to issue an attribute certificate using an issuer certificate with its
38 private key and the holder certificate.
39 .
40 .SH "OPTIONS"
41 .
42 .TP
43 .B "\-h, \-\-help"
44 Print usage information with a summary of the available options.
45 .TP
46 .BI "\-v, \-\-debug " level
47 Set debug level, default: 1.
48 .TP
49 .BI "\-+, \-\-options " file
50 Read command line options from \fIfile\fR.
51 .TP
52 .BI "\-i, \-\-in " file
53 Holder certificate to issue an attribute certificate for. If not given the
54 certificate is read from \fISTDIN\fR.
55 .TP
56 .BI "\-m, \-\-group " membership
57 Group membership the attribute certificate shall certify. The specified group
58 is included as a string. To include multiple groups, the option can be repeated.
59 .TP
60 .BI "\-k, \-\-issuerkey " file
61 Issuer private key file. Either this or
62 .B \-\-issuerkeyid
63 is required.
64 .TP
65 .BI "\-x, \-\-issuerkeyid " hex
66 Smartcard or TPM issuer private key object handle in hex format with an optional
67 h0x prefix. Either this or
68 .B \-\-issuerkey
69 is required.
70 .TP
71 .BI "\-c, \-\-issuercert " file
72 Issuer certificate file. Required.
73 .TP
74 .BI "\-l, \-\-lifetime " hours
75 Hours the attribute certificate is valid, default: 24. Ignored if both
76 an absolute start and end time are given.
77 .TP
78 .BI "\-F, \-\-not-before " datetime
79 Absolute time when the validity of the AC begins. The datetime format is
80 defined by the
81 .B \-\-dateform
82 option.
83 .TP
84 .BI "\-T, \-\-not-after " datetime
85 Absolute time when the validity of the AC ends. The datetime format is
86 defined by the
87 .B \-\-dateform
88 option.
89 .TP
90 .BI "\-D, \-\-dateform " form
91 strptime(3) format for the
92 .B \-\-not\-before
93 and
94 .B \-\-not\-after
95 options, default:
96 .B %d.%m.%y %T
97 .TP
98 .BI "\-s, \-\-serial " hex
99 Serial number in hex. It is randomly allocated by default.
100 .TP
101 .BI "\-g, \-\-digest " digest
102 Digest to use for signature creation. One of \fImd5\fR, \fIsha1\fR,
103 \fIsha224\fR, \fIsha256\fR, \fIsha384\fR, or \fIsha512\fR. The default is
104 determined based on the type and size of the signature key.
105 .TP
106 .BI "\-f, \-\-outform " encoding
107 Encoding of the created certificate file. Either \fIder\fR (ASN.1 DER) or
108 \fIpem\fR (Base64 PEM), defaults to \fIder\fR.
109 .
110 .SH "EXAMPLES"
111 .
112 To save repetitive typing, command line options can be stored in files.
113 Lets assume
114 .I acert.opt
115 contains the following contents:
116 .PP
117 .EX
118   --issuercert aacert.der --issuerkey aakey.der --digest sha256 --lifetime 4
119 .EE
120 .PP
121 Then the following command can be used to issue an attribute certificate based
122 on a holder certificate and the options above:
123 .PP
124 .EX
125   pki --acert --options acert.opt --in holder.der --group sales --group finance -f pem
126 .EE
127 .PP
128 .
129 .SH "SEE ALSO"
130 .
131 .BR pki (1)