openssl-storeutl.1ossl 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274
  1. .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
  2. .\"
  3. .\" Standard preamble:
  4. .\" ========================================================================
  5. .de Sp \" Vertical space (when we can't use .PP)
  6. .if t .sp .5v
  7. .if n .sp
  8. ..
  9. .de Vb \" Begin verbatim text
  10. .ft CW
  11. .nf
  12. .ne \\$1
  13. ..
  14. .de Ve \" End verbatim text
  15. .ft R
  16. .fi
  17. ..
  18. .\" Set up some character translations and predefined strings. \*(-- will
  19. .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20. .\" double quote, and \*(R" will give a right double quote. \*(C+ will
  21. .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
  22. .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
  23. .\" nothing in troff, for use with C<>.
  24. .tr \(*W-
  25. .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26. .ie n \{\
  27. . ds -- \(*W-
  28. . ds PI pi
  29. . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30. . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  31. . ds L" ""
  32. . ds R" ""
  33. . ds C` ""
  34. . ds C' ""
  35. 'br\}
  36. .el\{\
  37. . ds -- \|\(em\|
  38. . ds PI \(*p
  39. . ds L" ``
  40. . ds R" ''
  41. . ds C`
  42. . ds C'
  43. 'br\}
  44. .\"
  45. .\" Escape single quotes in literal strings from groff's Unicode transform.
  46. .ie \n(.g .ds Aq \(aq
  47. .el .ds Aq '
  48. .\"
  49. .\" If the F register is >0, we'll generate index entries on stderr for
  50. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51. .\" entries marked with X<> in POD. Of course, you'll have to process the
  52. .\" output yourself in some meaningful fashion.
  53. .\"
  54. .\" Avoid warning from groff about undefined register 'F'.
  55. .de IX
  56. ..
  57. .nr rF 0
  58. .if \n(.g .if rF .nr rF 1
  59. .if (\n(rF:(\n(.g==0)) \{\
  60. . if \nF \{\
  61. . de IX
  62. . tm Index:\\$1\t\\n%\t"\\$2"
  63. ..
  64. . if !\nF==2 \{\
  65. . nr % 0
  66. . nr F 2
  67. . \}
  68. . \}
  69. .\}
  70. .rr rF
  71. .\"
  72. .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73. .\" Fear. Run. Save yourself. No user-serviceable parts.
  74. . \" fudge factors for nroff and troff
  75. .if n \{\
  76. . ds #H 0
  77. . ds #V .8m
  78. . ds #F .3m
  79. . ds #[ \f1
  80. . ds #] \fP
  81. .\}
  82. .if t \{\
  83. . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84. . ds #V .6m
  85. . ds #F 0
  86. . ds #[ \&
  87. . ds #] \&
  88. .\}
  89. . \" simple accents for nroff and troff
  90. .if n \{\
  91. . ds ' \&
  92. . ds ` \&
  93. . ds ^ \&
  94. . ds , \&
  95. . ds ~ ~
  96. . ds /
  97. .\}
  98. .if t \{\
  99. . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  100. . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  101. . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  102. . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  103. . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  104. . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  105. .\}
  106. . \" troff and (daisy-wheel) nroff accents
  107. .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  108. .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
  109. .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
  110. .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
  111. .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
  112. .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
  113. .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
  114. .ds ae a\h'-(\w'a'u*4/10)'e
  115. .ds Ae A\h'-(\w'A'u*4/10)'E
  116. . \" corrections for vroff
  117. .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
  118. .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
  119. . \" for low resolution devices (crt and lpr)
  120. .if \n(.H>23 .if \n(.V>19 \
  121. \{\
  122. . ds : e
  123. . ds 8 ss
  124. . ds o a
  125. . ds d- d\h'-1'\(ga
  126. . ds D- D\h'-1'\(hy
  127. . ds th \o'bp'
  128. . ds Th \o'LP'
  129. . ds ae ae
  130. . ds Ae AE
  131. .\}
  132. .rm #[ #] #H #V #F C
  133. .\" ========================================================================
  134. .\"
  135. .IX Title "OPENSSL-STOREUTL 1ossl"
  136. .TH OPENSSL-STOREUTL 1ossl "2025-06-29" "3.3.2" "OpenSSL"
  137. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  138. .\" way too many mistakes in technical documents.
  139. .if n .ad l
  140. .nh
  141. .SH "NAME"
  142. openssl\-storeutl \- STORE command
  143. .SH "SYNOPSIS"
  144. .IX Header "SYNOPSIS"
  145. \&\fBopenssl\fR \fBstoreutl\fR
  146. [\fB\-help\fR]
  147. [\fB\-out\fR \fIfile\fR]
  148. [\fB\-noout\fR]
  149. [\fB\-passin\fR \fIarg\fR]
  150. [\fB\-text\fR \fIarg\fR]
  151. [\fB\-r\fR]
  152. [\fB\-certs\fR]
  153. [\fB\-keys\fR]
  154. [\fB\-crls\fR]
  155. [\fB\-subject\fR \fIarg\fR]
  156. [\fB\-issuer\fR \fIarg\fR]
  157. [\fB\-serial\fR \fIarg\fR]
  158. [\fB\-alias\fR \fIarg\fR]
  159. [\fB\-fingerprint\fR \fIarg\fR]
  160. [\fB\-\f(BIdigest\fB\fR]
  161. [\fB\-engine\fR \fIid\fR]
  162. [\fB\-provider\fR \fIname\fR]
  163. [\fB\-provider\-path\fR \fIpath\fR]
  164. [\fB\-propquery\fR \fIpropq\fR]
  165. \&\fIuri\fR
  166. .SH "DESCRIPTION"
  167. .IX Header "DESCRIPTION"
  168. This command can be used to display the contents (after
  169. decryption as the case may be) fetched from the given \s-1URI.\s0
  170. .SH "OPTIONS"
  171. .IX Header "OPTIONS"
  172. .IP "\fB\-help\fR" 4
  173. .IX Item "-help"
  174. Print out a usage message.
  175. .IP "\fB\-out\fR \fIfilename\fR" 4
  176. .IX Item "-out filename"
  177. specifies the output filename to write to or standard output by
  178. default.
  179. .IP "\fB\-noout\fR" 4
  180. .IX Item "-noout"
  181. this option prevents output of the \s-1PEM\s0 data.
  182. .IP "\fB\-passin\fR \fIarg\fR" 4
  183. .IX Item "-passin arg"
  184. the key password source. For more information about the format of \fIarg\fR
  185. see \fBopenssl\-passphrase\-options\fR\|(1).
  186. .IP "\fB\-text\fR" 4
  187. .IX Item "-text"
  188. Prints out the objects in text form, similarly to the \fB\-text\fR output from
  189. \&\fBopenssl\-x509\fR\|(1), \fBopenssl\-pkey\fR\|(1), etc.
  190. .IP "\fB\-r\fR" 4
  191. .IX Item "-r"
  192. Fetch objects recursively when possible.
  193. .IP "\fB\-certs\fR" 4
  194. .IX Item "-certs"
  195. .PD 0
  196. .IP "\fB\-keys\fR" 4
  197. .IX Item "-keys"
  198. .IP "\fB\-crls\fR" 4
  199. .IX Item "-crls"
  200. .PD
  201. Only select the certificates, keys or CRLs from the given \s-1URI.\s0
  202. However, if this \s-1URI\s0 would return a set of names (URIs), those are always
  203. returned.
  204. .Sp
  205. Note that all options must be given before the \fIuri\fR argument.
  206. .Sp
  207. Note \fI\-keys\fR selects exclusively private keys, there is no selector for public
  208. keys only.
  209. .IP "\fB\-subject\fR \fIarg\fR" 4
  210. .IX Item "-subject arg"
  211. Search for an object having the subject name \fIarg\fR.
  212. .Sp
  213. The arg must be formatted as \f(CW\*(C`/type0=value0/type1=value1/type2=...\*(C'\fR.
  214. Special characters may be escaped by \f(CW\*(C`\e\*(C'\fR (backslash), whitespace is retained.
  215. Empty values are permitted but are ignored for the search. That is,
  216. a search with an empty value will have the same effect as not specifying
  217. the type at all.
  218. Giving a single \f(CW\*(C`/\*(C'\fR will lead to an empty sequence of RDNs (a NULL-DN).
  219. Multi-valued RDNs can be formed by placing a \f(CW\*(C`+\*(C'\fR character instead of a \f(CW\*(C`/\*(C'\fR
  220. between the AttributeValueAssertions (AVAs) that specify the members of the set.
  221. .Sp
  222. Example:
  223. .Sp
  224. \&\f(CW\*(C`/DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe\*(C'\fR
  225. .IP "\fB\-issuer\fR \fIarg\fR" 4
  226. .IX Item "-issuer arg"
  227. .PD 0
  228. .IP "\fB\-serial\fR \fIarg\fR" 4
  229. .IX Item "-serial arg"
  230. .PD
  231. Search for an object having the given issuer name and serial number.
  232. These two options \fImust\fR be used together.
  233. The issuer arg must be formatted as \f(CW\*(C`/type0=value0/type1=value1/type2=...\*(C'\fR,
  234. characters may be escaped by \e (backslash), no spaces are skipped.
  235. The serial arg may be specified as a decimal value or a hex value if preceded
  236. by \f(CW\*(C`0x\*(C'\fR.
  237. .IP "\fB\-alias\fR \fIarg\fR" 4
  238. .IX Item "-alias arg"
  239. Search for an object having the given alias.
  240. .IP "\fB\-fingerprint\fR \fIarg\fR" 4
  241. .IX Item "-fingerprint arg"
  242. Search for an object having the given fingerprint.
  243. .IP "\fB\-\f(BIdigest\fB\fR" 4
  244. .IX Item "-digest"
  245. The digest that was used to compute the fingerprint given with \fB\-fingerprint\fR.
  246. .IP "\fB\-engine\fR \fIid\fR" 4
  247. .IX Item "-engine id"
  248. See \*(L"Engine Options\*(R" in \fBopenssl\fR\|(1).
  249. This option is deprecated.
  250. .IP "\fB\-provider\fR \fIname\fR" 4
  251. .IX Item "-provider name"
  252. .PD 0
  253. .IP "\fB\-provider\-path\fR \fIpath\fR" 4
  254. .IX Item "-provider-path path"
  255. .IP "\fB\-propquery\fR \fIpropq\fR" 4
  256. .IX Item "-propquery propq"
  257. .PD
  258. See \*(L"Provider Options\*(R" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
  259. .SH "SEE ALSO"
  260. .IX Header "SEE ALSO"
  261. \&\fBopenssl\fR\|(1)
  262. .SH "HISTORY"
  263. .IX Header "HISTORY"
  264. This command was added in OpenSSL 1.1.1.
  265. .PP
  266. The \fB\-engine\fR option was deprecated in OpenSSL 3.0.
  267. .SH "COPYRIGHT"
  268. .IX Header "COPYRIGHT"
  269. Copyright 2016\-2024 The OpenSSL Project Authors. All Rights Reserved.
  270. .PP
  271. Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
  272. this file except in compliance with the License. You can obtain a copy
  273. in the file \s-1LICENSE\s0 in the source distribution or at
  274. <https://www.openssl.org/source/license.html>.