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