xref: /freebsd/crypto/openssl/doc/man1/openssl-storeutl.pod.in (revision 44096ebd22ddd0081a357011714eff8963614b65)
1b077aed3SPierre Pronchery=pod
2b077aed3SPierre Pronchery
3b077aed3SPierre Pronchery=begin comment
4b077aed3SPierre Pronchery{- join("\n", @autowarntext) -}
5b077aed3SPierre Pronchery
6b077aed3SPierre Pronchery=end comment
7b077aed3SPierre Pronchery
8b077aed3SPierre Pronchery=head1 NAME
9b077aed3SPierre Pronchery
10b077aed3SPierre Proncheryopenssl-storeutl - STORE command
11b077aed3SPierre Pronchery
12b077aed3SPierre Pronchery=head1 SYNOPSIS
13b077aed3SPierre Pronchery
14b077aed3SPierre ProncheryB<openssl> B<storeutl>
15b077aed3SPierre Pronchery[B<-help>]
16b077aed3SPierre Pronchery[B<-out> I<file>]
17b077aed3SPierre Pronchery[B<-noout>]
18b077aed3SPierre Pronchery[B<-passin> I<arg>]
19b077aed3SPierre Pronchery[B<-text> I<arg>]
20b077aed3SPierre Pronchery[B<-r>]
21b077aed3SPierre Pronchery[B<-certs>]
22b077aed3SPierre Pronchery[B<-keys>]
23b077aed3SPierre Pronchery[B<-crls>]
24b077aed3SPierre Pronchery[B<-subject> I<arg>]
25b077aed3SPierre Pronchery[B<-issuer> I<arg>]
26b077aed3SPierre Pronchery[B<-serial> I<arg>]
27b077aed3SPierre Pronchery[B<-alias> I<arg>]
28b077aed3SPierre Pronchery[B<-fingerprint> I<arg>]
29b077aed3SPierre Pronchery[B<-I<digest>>]
30b077aed3SPierre Pronchery{- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
31b077aed3SPierre ProncheryI<uri>
32b077aed3SPierre Pronchery
33b077aed3SPierre Pronchery=head1 DESCRIPTION
34b077aed3SPierre Pronchery
35b077aed3SPierre ProncheryThis command can be used to display the contents (after
36b077aed3SPierre Proncherydecryption as the case may be) fetched from the given URI.
37b077aed3SPierre Pronchery
38b077aed3SPierre Pronchery=head1 OPTIONS
39b077aed3SPierre Pronchery
40b077aed3SPierre Pronchery=over 4
41b077aed3SPierre Pronchery
42b077aed3SPierre Pronchery=item B<-help>
43b077aed3SPierre Pronchery
44b077aed3SPierre ProncheryPrint out a usage message.
45b077aed3SPierre Pronchery
46b077aed3SPierre Pronchery=item B<-out> I<filename>
47b077aed3SPierre Pronchery
48b077aed3SPierre Proncheryspecifies the output filename to write to or standard output by
49b077aed3SPierre Proncherydefault.
50b077aed3SPierre Pronchery
51b077aed3SPierre Pronchery=item B<-noout>
52b077aed3SPierre Pronchery
53b077aed3SPierre Proncherythis option prevents output of the PEM data.
54b077aed3SPierre Pronchery
55b077aed3SPierre Pronchery=item B<-passin> I<arg>
56b077aed3SPierre Pronchery
57b077aed3SPierre Proncherythe key password source. For more information about the format of I<arg>
58b077aed3SPierre Proncherysee L<openssl-passphrase-options(1)>.
59b077aed3SPierre Pronchery
60b077aed3SPierre Pronchery=item B<-text>
61b077aed3SPierre Pronchery
62b077aed3SPierre ProncheryPrints out the objects in text form, similarly to the B<-text> output from
63b077aed3SPierre ProncheryL<openssl-x509(1)>, L<openssl-pkey(1)>, etc.
64b077aed3SPierre Pronchery
65b077aed3SPierre Pronchery=item B<-r>
66b077aed3SPierre Pronchery
67b077aed3SPierre ProncheryFetch objects recursively when possible.
68b077aed3SPierre Pronchery
69b077aed3SPierre Pronchery=item B<-certs>
70b077aed3SPierre Pronchery
71b077aed3SPierre Pronchery=item B<-keys>
72b077aed3SPierre Pronchery
73b077aed3SPierre Pronchery=item B<-crls>
74b077aed3SPierre Pronchery
75b077aed3SPierre ProncheryOnly select the certificates, keys or CRLs from the given URI.
76b077aed3SPierre ProncheryHowever, if this URI would return a set of names (URIs), those are always
77b077aed3SPierre Proncheryreturned.
78b077aed3SPierre Pronchery
79b077aed3SPierre ProncheryNote that all options must be given before the I<uri> argument.
80b077aed3SPierre ProncheryOtherwise they are ignored.
81b077aed3SPierre Pronchery
82*44096ebdSEnji CooperNote I<-keys> selects exclusively private keys, there is no selector for public
83*44096ebdSEnji Cooperkeys only.
84*44096ebdSEnji Cooper
85b077aed3SPierre Pronchery=item B<-subject> I<arg>
86b077aed3SPierre Pronchery
87b077aed3SPierre ProncherySearch for an object having the subject name I<arg>.
88b077aed3SPierre Pronchery
89b077aed3SPierre ProncheryThe arg must be formatted as C</type0=value0/type1=value1/type2=...>.
90b077aed3SPierre ProncherySpecial characters may be escaped by C<\> (backslash), whitespace is retained.
91b077aed3SPierre ProncheryEmpty values are permitted but are ignored for the search.  That is,
92b077aed3SPierre Proncherya search with an empty value will have the same effect as not specifying
93b077aed3SPierre Proncherythe type at all.
94b077aed3SPierre ProncheryGiving a single C</> will lead to an empty sequence of RDNs (a NULL-DN).
95b077aed3SPierre ProncheryMulti-valued RDNs can be formed by placing a C<+> character instead of a C</>
96b077aed3SPierre Proncherybetween the AttributeValueAssertions (AVAs) that specify the members of the set.
97b077aed3SPierre Pronchery
98b077aed3SPierre ProncheryExample:
99b077aed3SPierre Pronchery
100b077aed3SPierre ProncheryC</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe>
101b077aed3SPierre Pronchery
102b077aed3SPierre Pronchery=item B<-issuer> I<arg>
103b077aed3SPierre Pronchery
104b077aed3SPierre Pronchery=item B<-serial> I<arg>
105b077aed3SPierre Pronchery
106b077aed3SPierre ProncherySearch for an object having the given issuer name and serial number.
107b077aed3SPierre ProncheryThese two options I<must> be used together.
108b077aed3SPierre ProncheryThe issuer arg must be formatted as C</type0=value0/type1=value1/type2=...>,
109b077aed3SPierre Proncherycharacters may be escaped by \ (backslash), no spaces are skipped.
110b077aed3SPierre ProncheryThe serial arg may be specified as a decimal value or a hex value if preceded
111b077aed3SPierre Proncheryby C<0x>.
112b077aed3SPierre Pronchery
113b077aed3SPierre Pronchery=item B<-alias> I<arg>
114b077aed3SPierre Pronchery
115b077aed3SPierre ProncherySearch for an object having the given alias.
116b077aed3SPierre Pronchery
117b077aed3SPierre Pronchery=item B<-fingerprint> I<arg>
118b077aed3SPierre Pronchery
119b077aed3SPierre ProncherySearch for an object having the given fingerprint.
120b077aed3SPierre Pronchery
121b077aed3SPierre Pronchery=item B<-I<digest>>
122b077aed3SPierre Pronchery
123b077aed3SPierre ProncheryThe digest that was used to compute the fingerprint given with B<-fingerprint>.
124b077aed3SPierre Pronchery
125b077aed3SPierre Pronchery{- $OpenSSL::safe::opt_engine_item -}
126b077aed3SPierre Pronchery
127b077aed3SPierre Pronchery{- $OpenSSL::safe::opt_provider_item -}
128b077aed3SPierre Pronchery
129b077aed3SPierre Pronchery=back
130b077aed3SPierre Pronchery
131b077aed3SPierre Pronchery=head1 SEE ALSO
132b077aed3SPierre Pronchery
133b077aed3SPierre ProncheryL<openssl(1)>
134b077aed3SPierre Pronchery
135b077aed3SPierre Pronchery=head1 HISTORY
136b077aed3SPierre Pronchery
137b077aed3SPierre ProncheryThis command was added in OpenSSL 1.1.1.
138b077aed3SPierre Pronchery
139b077aed3SPierre ProncheryThe B<-engine> option was deprecated in OpenSSL 3.0.
140b077aed3SPierre Pronchery
141b077aed3SPierre Pronchery=head1 COPYRIGHT
142b077aed3SPierre Pronchery
143*44096ebdSEnji CooperCopyright 2016-2024 The OpenSSL Project Authors. All Rights Reserved.
144b077aed3SPierre Pronchery
145b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
146b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
147b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
148b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
149b077aed3SPierre Pronchery
150b077aed3SPierre Pronchery=cut
151