openssl-storeutl.1ossl 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. .\" -*- mode: troff; coding: utf-8 -*-
  2. .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
  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 1ossl"
  58. .TH OPENSSL-STOREUTL 1ossl 2025-01-17 3.4.0 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\-propquery\fR \fIpropq\fR]
  87. \&\fIuri\fR
  88. .SH DESCRIPTION
  89. .IX Header "DESCRIPTION"
  90. This command can be used to display the contents (after
  91. decryption as the case may be) fetched from the given URI.
  92. .SH OPTIONS
  93. .IX Header "OPTIONS"
  94. .IP \fB\-help\fR 4
  95. .IX Item "-help"
  96. Print out a usage message.
  97. .IP "\fB\-out\fR \fIfilename\fR" 4
  98. .IX Item "-out filename"
  99. specifies the output filename to write to or standard output by
  100. default.
  101. .IP \fB\-noout\fR 4
  102. .IX Item "-noout"
  103. this option prevents output of the PEM data.
  104. .IP "\fB\-passin\fR \fIarg\fR" 4
  105. .IX Item "-passin arg"
  106. the key password source. For more information about the format of \fIarg\fR
  107. see \fBopenssl\-passphrase\-options\fR\|(1).
  108. .IP \fB\-text\fR 4
  109. .IX Item "-text"
  110. Prints out the objects in text form, similarly to the \fB\-text\fR output from
  111. \&\fBopenssl\-x509\fR\|(1), \fBopenssl\-pkey\fR\|(1), etc.
  112. .IP \fB\-r\fR 4
  113. .IX Item "-r"
  114. Fetch objects recursively when possible.
  115. .IP \fB\-certs\fR 4
  116. .IX Item "-certs"
  117. .PD 0
  118. .IP \fB\-keys\fR 4
  119. .IX Item "-keys"
  120. .IP \fB\-crls\fR 4
  121. .IX Item "-crls"
  122. .PD
  123. Only select the certificates, keys or CRLs from the given URI.
  124. However, if this URI would return a set of names (URIs), those are always
  125. returned.
  126. .Sp
  127. Note that all options must be given before the \fIuri\fR argument.
  128. .Sp
  129. Note \fI\-keys\fR selects exclusively private keys, there is no selector for public
  130. keys only.
  131. .IP "\fB\-subject\fR \fIarg\fR" 4
  132. .IX Item "-subject arg"
  133. Search for an object having the subject name \fIarg\fR.
  134. .Sp
  135. The arg must be formatted as \f(CW\*(C`/type0=value0/type1=value1/type2=...\*(C'\fR.
  136. Special characters may be escaped by \f(CW\*(C`\e\*(C'\fR (backslash), whitespace is retained.
  137. Empty values are permitted but are ignored for the search. That is,
  138. a search with an empty value will have the same effect as not specifying
  139. the type at all.
  140. Giving a single \f(CW\*(C`/\*(C'\fR will lead to an empty sequence of RDNs (a NULL-DN).
  141. Multi-valued RDNs can be formed by placing a \f(CW\*(C`+\*(C'\fR character instead of a \f(CW\*(C`/\*(C'\fR
  142. between the AttributeValueAssertions (AVAs) that specify the members of the set.
  143. .Sp
  144. Example:
  145. .Sp
  146. \&\f(CW\*(C`/DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe\*(C'\fR
  147. .IP "\fB\-issuer\fR \fIarg\fR" 4
  148. .IX Item "-issuer arg"
  149. .PD 0
  150. .IP "\fB\-serial\fR \fIarg\fR" 4
  151. .IX Item "-serial arg"
  152. .PD
  153. Search for an object having the given issuer name and serial number.
  154. These two options \fImust\fR be used together.
  155. The issuer arg must be formatted as \f(CW\*(C`/type0=value0/type1=value1/type2=...\*(C'\fR,
  156. characters may be escaped by \e (backslash), no spaces are skipped.
  157. The serial arg may be specified as a decimal value or a hex value if preceded
  158. by \f(CW\*(C`0x\*(C'\fR.
  159. .IP "\fB\-alias\fR \fIarg\fR" 4
  160. .IX Item "-alias arg"
  161. Search for an object having the given alias.
  162. .IP "\fB\-fingerprint\fR \fIarg\fR" 4
  163. .IX Item "-fingerprint arg"
  164. Search for an object having the given fingerprint.
  165. .IP \fB\-\fR\f(BIdigest\fR 4
  166. .IX Item "-digest"
  167. The digest that was used to compute the fingerprint given with \fB\-fingerprint\fR.
  168. .IP "\fB\-engine\fR \fIid\fR" 4
  169. .IX Item "-engine id"
  170. See "Engine Options" in \fBopenssl\fR\|(1).
  171. This option is deprecated.
  172. .IP "\fB\-provider\fR \fIname\fR" 4
  173. .IX Item "-provider name"
  174. .PD 0
  175. .IP "\fB\-provider\-path\fR \fIpath\fR" 4
  176. .IX Item "-provider-path path"
  177. .IP "\fB\-propquery\fR \fIpropq\fR" 4
  178. .IX Item "-propquery propq"
  179. .PD
  180. See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
  181. .SH "SEE ALSO"
  182. .IX Header "SEE ALSO"
  183. \&\fBopenssl\fR\|(1)
  184. .SH HISTORY
  185. .IX Header "HISTORY"
  186. This command was added in OpenSSL 1.1.1.
  187. .PP
  188. The \fB\-engine\fR option was deprecated in OpenSSL 3.0.
  189. .SH COPYRIGHT
  190. .IX Header "COPYRIGHT"
  191. Copyright 2016\-2024 The OpenSSL Project Authors. All Rights Reserved.
  192. .PP
  193. Licensed under the Apache License 2.0 (the "License"). You may not use
  194. this file except in compliance with the License. You can obtain a copy
  195. in the file LICENSE in the source distribution or at
  196. <https://www.openssl.org/source/license.html>.