[thirdparty/openssl.git] / doc / man1 / openssl-storeutl.pod

=pod

=head1 NAME

openssl-storeutl - STORE utility

=head1 SYNOPSIS

B<openssl> B<storeutl>
[B<-help>]
[B<-out file>]
[B<-noout>]
[B<-passin arg>]
[B<-text arg>]
[B<-engine id>]
[B<-r>]
[B<-certs>]
[B<-keys>]
[B<-crls>]
[B<-subject arg>]
[B<-issuer arg>]
[B<-serial arg>]
[B<-alias arg>]
[B<-fingerprint arg>]
[B<-I<digest>>]
B<uri> ...

=head1 DESCRIPTION

The B<storeutl> command can be used to display the contents (after decryption
as the case may be) fetched from the given URIs.

=head1 OPTIONS

=over 4

=item B<-help>

Print out a usage message.

=item B<-out filename>

specifies the output filename to write to or standard output by
default.

=item B<-noout>

this option prevents output of the PEM data.

=item B<-passin arg>

the key password source. For more information about the format of B<arg>
see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.

=item B<-text>

Prints out the objects in text form, similarly to the B<-text> output from
B<openssl x509>, B<openssl pkey>, etc.

=item B<-engine id>

specifying an engine (by its unique B<id> string) will cause B<storeutl>
to attempt to obtain a functional reference to the specified engine,
thus initialising it if needed.
The engine will then be set as the default for all available algorithms.

=item B<-r>

Fetch objects recursively when possible.

=item B<-certs>

=item B<-keys>

=item B<-crls>

Only select the certificates, keys or CRLs from the given URI.
However, if this URI would return a set of names (URIs), those are always
returned.

=item B<-subject arg>

Search for an object having the subject name B<arg>.
The arg must be formatted as I</type0=value0/type1=value1/type2=...>.
Keyword characters may be escaped by \ (backslash), and whitespace is retained.
Empty values are permitted but are ignored for the search.  That is,
a search with an empty value will have the same effect as not specifying
the type at all.

=item B<-issuer arg>

=item B<-serial arg>

Search for an object having the given issuer name and serial number.
These two options I<must> be used together.
The issuer arg must be formatted as I</type0=value0/type1=value1/type2=...>,
characters may be escaped by \ (backslash), no spaces are skipped.
The serial arg may be specified as a decimal value or a hex value if preceded
by B<0x>.

=item B<-alias arg>

Search for an object having the given alias.

=item B<-fingerprint arg>

Search for an object having the given fingerprint.

=item B<-I<digest>>

The digest that was used to compute the fingerprint given with B<-fingerprint>.

=back

=head1 SEE ALSO

L<openssl(1)>

=head1 HISTORY

The B<openssl> B<storeutl> app was added in OpenSSL 1.1.1.

=head1 COPYRIGHT

Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut
Commit	Line	Data
8f507bc5 RL	1	=pod
	2
	3	=head1 NAME
	4
b6b66573	5	openssl-storeutl - STORE utility
8f507bc5 RL	6
	7	=head1 SYNOPSIS
	8
	9	B<openssl> B<storeutl>
	10	[B<-help>]
	11	[B<-out file>]
	12	[B<-noout>]
	13	[B<-passin arg>]
	14	[B<-text arg>]
	15	[B<-engine id>]
dd8f6edc	16	[B<-r>]
ce9586b9 RL	17	[B<-certs>]
	18	[B<-keys>]
	19	[B<-crls>]
6ab6decc RL	20	[B<-subject arg>]
	21	[B<-issuer arg>]
	22	[B<-serial arg>]
	23	[B<-alias arg>]
	24	[B<-fingerprint arg>]
	25	[B<-I<digest>>]
8f507bc5 RL	26	B<uri> ...
	27
	28	=head1 DESCRIPTION
	29
	30	The B<storeutl> command can be used to display the contents (after decryption
	31	as the case may be) fetched from the given URIs.
	32
a95d7574	33	=head1 OPTIONS
8f507bc5 RL	34
	35	=over 4
	36
	37	=item B<-help>
	38
	39	Print out a usage message.
	40
	41	=item B<-out filename>
	42
	43	specifies the output filename to write to or standard output by
	44	default.
	45
	46	=item B<-noout>
	47
	48	this option prevents output of the PEM data.
	49
	50	=item B<-passin arg>
	51
	52	the key password source. For more information about the format of B<arg>
	53	see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
	54
	55	=item B<-text>
	56
	57	Prints out the objects in text form, similarly to the B<-text> output from
	58	B<openssl x509>, B<openssl pkey>, etc.
	59
	60	=item B<-engine id>
	61
	62	specifying an engine (by its unique B<id> string) will cause B<storeutl>
	63	to attempt to obtain a functional reference to the specified engine,
	64	thus initialising it if needed.
	65	The engine will then be set as the default for all available algorithms.
	66
dd8f6edc RL	67	=item B<-r>
	68
	69	Fetch objects recursively when possible.
	70
ce9586b9 RL	71	=item B<-certs>
	72
	73	=item B<-keys>
	74
	75	=item B<-crls>
	76
	77	Only select the certificates, keys or CRLs from the given URI.
	78	However, if this URI would return a set of names (URIs), those are always
	79	returned.
	80
6ab6decc RL	81	=item B<-subject arg>
	82
	83	Search for an object having the subject name B<arg>.
3d362f19 BK	84	The arg must be formatted as I</type0=value0/type1=value1/type2=...>.
	85	Keyword characters may be escaped by \ (backslash), and whitespace is retained.
	86	Empty values are permitted but are ignored for the search. That is,
	87	a search with an empty value will have the same effect as not specifying
	88	the type at all.
6ab6decc RL	89
	90	=item B<-issuer arg>
	91
	92	=item B<-serial arg>
	93
	94	Search for an object having the given issuer name and serial number.
	95	These two options I<must> be used together.
	96	The issuer arg must be formatted as I</type0=value0/type1=value1/type2=...>,
	97	characters may be escaped by \ (backslash), no spaces are skipped.
	98	The serial arg may be specified as a decimal value or a hex value if preceded
	99	by B<0x>.
	100
	101	=item B<-alias arg>
	102
	103	Search for an object having the given alias.
	104
	105	=item B<-fingerprint arg>
	106
	107	Search for an object having the given fingerprint.
	108
	109	=item B<-I<digest>>
	110
	111	The digest that was used to compute the fingerprint given with B<-fingerprint>.
	112
8f507bc5 RL	113	=back
	114
	115	=head1 SEE ALSO
	116
	117	L<openssl(1)>
	118
	119	=head1 HISTORY
	120
fc5ecadd	121	The B<openssl> B<storeutl> app was added in OpenSSL 1.1.1.
8f507bc5 RL	122
	123	=head1 COPYRIGHT
	124
b6b66573	125	Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
8f507bc5	126
449040b4	127	Licensed under the Apache License 2.0 (the "License"). You may not use
8f507bc5 RL	128	this file except in compliance with the License. You can obtain a copy
	129	in the file LICENSE in the source distribution or at
	130	L<https://www.openssl.org/source/license.html>.
	131
	132	=cut