Debian Codegraph @

upstream/debian-unstable/man1/systemd-keyutil.1

raw
1 '\" t
2 .TH "SYSTEMD\-KEYUTIL" "1" "" "systemd 261~rc3" "systemd-keyutil"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 systemd-keyutil \- Perform various operations on private keys and X\&.509 certificates
24 .SH "SYNOPSIS"
25 .HP \w'\fBsystemd\-keyutil\fR\ 'u
26 \fBsystemd\-keyutil\fR [OPTIONS...] {COMMAND}
27 .SH "DESCRIPTION"
28 .PP
29 \fBsystemd\-keyutil\fR
30 can be used to perform various operations on private keys and X\&.509 certificates\&.
31 .SH "COMMANDS"
32 .PP
33 \fBvalidate\fR
34 .RS 4
35 Checks that we can load the private key and certificate specified with
36 \fB\-\-private\-key=\fR
37 and
38 \fB\-\-certificate=\fR
39 respectively\&.
40 .sp
41 As a side effect, if the private key is loaded from a PIN\-protected hardware token, this command can be used to cache the PIN in the kernel keyring\&. The
42 \fI$SYSTEMD_ASK_PASSWORD_KEYRING_TIMEOUT_SEC\fR
43 and
44 \fI$SYSTEMD_ASK_PASSWORD_KEYRING_TYPE\fR
45 environment variables can be used to control how long and in which kernel keyring the PIN is cached\&.
46 .sp
47 Added in version 257\&.
48 .RE
49 .PP
50 \fBextract\-public\fR
51 .RS 4
52 This commands prints the public key in PEM format extracted from either the certificate given with
53 \fB\-\-certificate=\fR
54 or the private key given with
55 \fB\-\-private\-key=\fR\&.
56 .sp
57 Added in version 257\&.
58 .RE
59 .PP
60 \fBextract\-certificate\fR
61 .RS 4
62 This command prints the X\&.509 certificate in PEM format extracted from the certificate given with
63 \fB\-\-certificate=\fR\&. This is useful when loading a certificate from an OpenSSL provider (e\&.g\&. a hardware token) and wanting to output a standalone PEM certificate that can be used without the provider\&.
64 .sp
65 Added in version 260\&.
66 .RE
67 .PP
68 \fBpkcs7\fR
69 .RS 4
70 This command embeds the PKCS#1 signature (RSA) provided with
71 \fB\-\-signature=\fR
72 in a PKCS#7 signature using the certificate given with
73 \fB\-\-certificate=\fR
74 and writes it to the file specified with
75 \fB\-\-output=\fR
76 in PKCS#7 format (p7s)\&. If
77 \fB\-\-content=\fR
78 is provided it is included in the p7s, otherwise a "detached" signature is created\&. The
79 \fB\-\-hash\-algorithm=\fR
80 option, which defaults to
81 "SHA256", specifies what hash algorithm was used to generate the signature\&.
82 .sp
83 Added in version 258\&.
84 .RE
85 .SH "OPTIONS"
86 .PP
87 The following options are understood:
88 .PP
89 \fB\-\-private\-key=\fR\fB\fIPATH/URI\fR\fR, \fB\-\-private\-key\-source=\fR\fB\fITYPE\fR\fR\fB[:\fR\fB\fINAME\fR\fR\fB]\fR, \fB\-\-certificate=\fR\fB\fIPATH\fR\fR, \fB\-\-certificate\-source=\fR\fB\fITYPE\fR\fR\fB[:\fR\fB\fINAME\fR\fR\fB]\fR
90 .RS 4
91 Set the private key and certificate to use\&. The
92 \fB\-\-certificate=\fR
93 option takes a path to a PEM encoded X\&.509 certificate or a URI that\*(Aqs passed to the OpenSSL provider configured with
94 \fB\-\-certificate\-source\fR\&. The
95 \fB\-\-certificate\-source\fR
96 takes one of
97 "file"
98 or
99 "provider", with the latter being followed by a specific provider identifier, separated with a colon, e\&.g\&.
100 "provider:pkcs11"\&. The
101 \fB\-\-private\-key=\fR
102 option can take a path or a URI that will be passed to the OpenSSL engine or provider, as specified by
103 \fB\-\-private\-key\-source=\fR
104 as a
105 "type:name"
106 tuple, such as
107 "engine:pkcs11"\&.
108 .sp
109 Added in version 257\&.
110 .RE
111 .PP
112 \fB\-\-signature=\fR\fB\fIPATH\fR\fR
113 .RS 4
114 Input PKCS#1 signature for the
115 \fBpkcs7\fR
116 command\&.
117 .sp
118 Added in version 258\&.
119 .RE
120 .PP
121 \fB\-\-content=\fR\fB\fIPATH\fR\fR
122 .RS 4
123 Input data that corresponds to the PKCS#1 signature for the
124 \fBpkcs7\fR
125 command, used for generating inline (i\&.e\&. non\-"detached") PKCS#7 signatures\&.
126 .sp
127 Added in version 258\&.
128 .RE
129 .PP
130 \fB\-\-hash\-algorithm=\fR\fB\fIALGORITHM\fR\fR
131 .RS 4
132 Hash algorithm used to generate the PKCS#1 signature for the
133 \fBpkcs7\fR
134 command\&. This should be a valid openssl digest algorithm; use
135 "openssl list \-digest\-algorithms"
136 to see a list of valid algorithms on your system\&. Defaults to
137 "SHA256"\&.
138 .sp
139 Added in version 258\&.
140 .RE
141 .PP
142 \fB\-\-output=\fR\fB\fIPATH\fR\fR
143 .RS 4
144 Output PKCS#7 signature for the
145 \fBpkcs7\fR
146 command\&.
147 .sp
148 Added in version 258\&.
149 .RE
150 .PP
151 \fB\-h\fR, \fB\-\-help\fR
152 .RS 4
153 Print a short help text and exit\&.
154 .RE
155 .PP
156 \fB\-\-version\fR
157 .RS 4
158 Print a short version string and exit\&.
159 .RE
160 .SH "SEE ALSO"
161 .PP
162 \fBsystemd-sbsign\fR(1), \fBsystemd-measure\fR(1)