Debian Codegraph @

upstream/debian-unstable/man1/openssl-storeutl.1ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OPENSSL-STOREUTL 1SSL"
58 .TH OPENSSL-STOREUTL 1SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 openssl\-storeutl \- STORE command
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 \&\fBopenssl\fR \fBstoreutl\fR
68 [\fB\-help\fR]
69 [\fB\-out\fR \fIfile\fR]
70 [\fB\-noout\fR]
71 [\fB\-passin\fR \fIarg\fR]
72 [\fB\-text\fR \fIarg\fR]
73 [\fB\-r\fR]
74 [\fB\-certs\fR]
75 [\fB\-keys\fR]
76 [\fB\-crls\fR]
77 [\fB\-subject\fR \fIarg\fR]
78 [\fB\-issuer\fR \fIarg\fR]
79 [\fB\-serial\fR \fIarg\fR]
80 [\fB\-alias\fR \fIarg\fR]
81 [\fB\-fingerprint\fR \fIarg\fR]
82 [\fB\-\fR\f(BIdigest\fR]
83 [\fB\-engine\fR \fIid\fR]
84 [\fB\-provider\fR \fIname\fR]
85 [\fB\-provider\-path\fR \fIpath\fR]
86 [\fB\-provparam\fR \fI[name:]key=value\fR]
87 [\fB\-propquery\fR \fIpropq\fR]
88 \&\fIuri\fR
89 .SH DESCRIPTION
90 .IX Header "DESCRIPTION"
91 This command can be used to display the contents (after
92 decryption as the case may be) fetched from the given URI.
93 .SH OPTIONS
94 .IX Header "OPTIONS"
95 .IP \fB\-help\fR 4
96 .IX Item "-help"
97 Print out a usage message.
98 .IP "\fB\-out\fR \fIfilename\fR" 4
99 .IX Item "-out filename"
100 This specifies the output file to write to.
101 Standard output is used if this option is not present.
102 The output file can be the same as the input,
103 which leads to replacing the file contents.
104 Note that file I/O is not atomic. The output file is truncated and then written.
105 .IP \fB\-noout\fR 4
106 .IX Item "-noout"
107 this option prevents output of the PEM data.
108 .IP "\fB\-passin\fR \fIarg\fR" 4
109 .IX Item "-passin arg"
110 the key password source. For more information about the format of \fIarg\fR
111 see \fBopenssl\-passphrase\-options\fR\|(1).
112 .IP \fB\-text\fR 4
113 .IX Item "-text"
114 Prints out the objects in text form, similarly to the \fB\-text\fR output from
115 \&\fBopenssl\-x509\fR\|(1), \fBopenssl\-pkey\fR\|(1), etc.
116 .IP \fB\-r\fR 4
117 .IX Item "-r"
118 Fetch objects recursively when possible.
119 .IP \fB\-certs\fR 4
120 .IX Item "-certs"
121 .PD 0
122 .IP \fB\-keys\fR 4
123 .IX Item "-keys"
124 .IP \fB\-crls\fR 4
125 .IX Item "-crls"
126 .PD
127 Only select the certificates, keys or CRLs from the given URI.
128 However, if this URI would return a set of names (URIs), those are always
129 returned.
130 .Sp
131 Note that all options must be given before the \fIuri\fR argument.
132 .Sp
133 Note \fI\-keys\fR selects exclusively private keys, there is no selector for public
134 keys only.
135 .IP "\fB\-subject\fR \fIarg\fR" 4
136 .IX Item "-subject arg"
137 Search for an object having the subject name \fIarg\fR.
138 .Sp
139 The arg must be formatted as \f(CW\*(C`/type0=value0/type1=value1/type2=...\*(C'\fR.
140 Special characters may be escaped by \f(CW\*(C`\e\*(C'\fR (backslash), whitespace is retained.
141 Empty values are permitted but are ignored for the search. That is,
142 a search with an empty value will have the same effect as not specifying
143 the type at all.
144 Giving a single \f(CW\*(C`/\*(C'\fR will lead to an empty sequence of RDNs (a NULL-DN).
145 Multi-valued RDNs can be formed by placing a \f(CW\*(C`+\*(C'\fR character instead of a \f(CW\*(C`/\*(C'\fR
146 between the AttributeValueAssertions (AVAs) that specify the members of the set.
147 .Sp
148 Example:
149 .Sp
150 \&\f(CW\*(C`/DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe\*(C'\fR
151 .IP "\fB\-issuer\fR \fIarg\fR" 4
152 .IX Item "-issuer arg"
153 .PD 0
154 .IP "\fB\-serial\fR \fIarg\fR" 4
155 .IX Item "-serial arg"
156 .PD
157 Search for an object having the given issuer name and serial number.
158 These two options \fImust\fR be used together.
159 The issuer arg must be formatted as \f(CW\*(C`/type0=value0/type1=value1/type2=...\*(C'\fR,
160 characters may be escaped by \e (backslash), no spaces are skipped.
161 The serial arg may be specified as a decimal value or a hex value if preceded
162 by \f(CW\*(C`0x\*(C'\fR.
163 .IP "\fB\-alias\fR \fIarg\fR" 4
164 .IX Item "-alias arg"
165 Search for an object having the given alias.
166 .IP "\fB\-fingerprint\fR \fIarg\fR" 4
167 .IX Item "-fingerprint arg"
168 Search for an object having the given fingerprint.
169 .IP \fB\-\fR\f(BIdigest\fR 4
170 .IX Item "-digest"
171 The digest that was used to compute the fingerprint given with \fB\-fingerprint\fR.
172 .IP "\fB\-engine\fR \fIid\fR" 4
173 .IX Item "-engine id"
174 See "Engine Options" in \fBopenssl\fR\|(1).
175 This option is deprecated.
176 .IP "\fB\-provider\fR \fIname\fR" 4
177 .IX Item "-provider name"
178 .PD 0
179 .IP "\fB\-provider\-path\fR \fIpath\fR" 4
180 .IX Item "-provider-path path"
181 .IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4
182 .IX Item "-provparam [name:]key=value"
183 .IP "\fB\-propquery\fR \fIpropq\fR" 4
184 .IX Item "-propquery propq"
185 .PD
186 See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
187 .SH "SEE ALSO"
188 .IX Header "SEE ALSO"
189 \&\fBopenssl\fR\|(1)
190 .SH HISTORY
191 .IX Header "HISTORY"
192 This command was added in OpenSSL 1.1.1.
193 .PP
194 The \fB\-engine\fR option was deprecated in OpenSSL 3.0.
195 .SH COPYRIGHT
196 .IX Header "COPYRIGHT"
197 Copyright 2016\-2024 The OpenSSL Project Authors. All Rights Reserved.
198 .PP
199 Licensed under the Apache License 2.0 (the "License"). You may not use
200 this file except in compliance with the License. You can obtain a copy
201 in the file LICENSE in the source distribution or at
202 <https://www.openssl.org/source/license.html>.