STORE: Add documentation on search criteria
[openssl.git] / doc / man1 / storeutl.pod
index 2792a554faa3d659bfeac35d714cce09d4a6ccc7..3f26ab500b8313076d63301cd1aa2e4acf1f2a7c 100644 (file)
@@ -2,6 +2,7 @@
 
 =head1 NAME
 
 
 =head1 NAME
 
+openssl-storeutl,
 storeutl - STORE utility
 
 =head1 SYNOPSIS
 storeutl - STORE utility
 
 =head1 SYNOPSIS
@@ -13,6 +14,16 @@ B<openssl> B<storeutl>
 [B<-passin arg>]
 [B<-text arg>]
 [B<-engine id>]
 [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
 B<uri> ...
 
 =head1 DESCRIPTION
@@ -54,6 +65,49 @@ 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.
 
 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=...>,
+characters may be escaped by \ (backslash), no spaces are skipped.
+
+=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
 =back
 
 =head1 SEE ALSO
@@ -66,7 +120,7 @@ B<openssl> B<storeutl> was added to OpenSSL 1.1.1.
 
 =head1 COPYRIGHT
 
 
 =head1 COPYRIGHT
 
-Copyright 2016-2017 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
 
 Licensed under the OpenSSL license (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy
 
 Licensed under the OpenSSL license (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy