Debian Codegraph @

upstream/mageia-cauldron/man1/systemd-keyutil.1

raw
1 '\" t
2 .TH "SYSTEMD\-KEYUTIL" "1" "" "systemd 258.7" "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 \fBpublic\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 \fBpkcs7\fR
61 .RS 4
62 This command embeds the PKCS#1 signature (RSA) provided with
63 \fB\-\-signature=\fR
64 in a PKCS#7 signature using the certificate given with
65 \fB\-\-certificate=\fR
66 and writes it to the file specified with
67 \fB\-\-output=\fR
68 in PKCS#7 format (p7s)\&. If
69 \fB\-\-content=\fR
70 is provided it is included in the p7s, otherwise a "detached" signature is created\&. The
71 \fB\-\-hash\-algorithm=\fR
72 option, which defaults to
73 "SHA256", specifies what hash algorithm was used to generate the signature\&.
74 .sp
75 Added in version 258\&.
76 .RE
77 .SH "OPTIONS"
78 .PP
79 The following options are understood:
80 .PP
81 \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
82 .RS 4
83 Set the private key and certificate to use\&. The
84 \fB\-\-certificate=\fR
85 option takes a path to a PEM encoded X\&.509 certificate or a URI that\*(Aqs passed to the OpenSSL provider configured with
86 \fB\-\-certificate\-source\fR\&. The
87 \fB\-\-certificate\-source\fR
88 takes one of
89 "file"
90 or
91 "provider", with the latter being followed by a specific provider identifier, separated with a colon, e\&.g\&.
92 "provider:pkcs11"\&. The
93 \fB\-\-private\-key=\fR
94 option can take a path or a URI that will be passed to the OpenSSL engine or provider, as specified by
95 \fB\-\-private\-key\-source=\fR
96 as a
97 "type:name"
98 tuple, such as
99 "engine:pkcs11"\&.
100 .sp
101 Added in version 257\&.
102 .RE
103 .PP
104 \fB\-\-signature=\fR\fB\fIPATH\fR\fR
105 .RS 4
106 Input PKCS#1 signature for the
107 \fBpkcs7\fR
108 command\&.
109 .sp
110 Added in version 258\&.
111 .RE
112 .PP
113 \fB\-\-content=\fR\fB\fIPATH\fR\fR
114 .RS 4
115 Input data that corresponds to the PKCS#1 signature for the
116 \fBpkcs7\fR
117 command, used for generating inline (i\&.e\&. non\-"detached") PKCS#7 signatures\&.
118 .sp
119 Added in version 258\&.
120 .RE
121 .PP
122 \fB\-\-hash\-algorithm=\fR\fB\fIALGORITHM\fR\fR
123 .RS 4
124 Hash algorithm used to generate the PKCS#1 signature for the
125 \fBpkcs7\fR
126 command\&. This should be a valid openssl digest algorithm; use
127 "openssl list \-digest\-algorithms"
128 to see a list of valid algorithms on your system\&. Defaults to
129 "SHA256"\&.
130 .sp
131 Added in version 258\&.
132 .RE
133 .PP
134 \fB\-\-output=\fR\fB\fIPATH\fR\fR
135 .RS 4
136 Output PKCS#7 signature for the
137 \fBpkcs7\fR
138 command\&.
139 .sp
140 Added in version 258\&.
141 .RE
142 .PP
143 \fB\-h\fR, \fB\-\-help\fR
144 .RS 4
145 Print a short help text and exit\&.
146 .RE
147 .PP
148 \fB\-\-version\fR
149 .RS 4
150 Print a short version string and exit\&.
151 .RE
152 .SH "SEE ALSO"
153 .PP
154 \fBsystemd-sbsign\fR(1), \fBsystemd-measure\fR(1)