openssl-storeutl.pod.in 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. =pod
  2. =begin comment
  3. {- join("\n", @autowarntext) -}
  4. =end comment
  5. =head1 NAME
  6. openssl-storeutl - STORE command
  7. =head1 SYNOPSIS
  8. B<openssl> B<storeutl>
  9. [B<-help>]
  10. [B<-out> I<file>]
  11. [B<-noout>]
  12. [B<-passin> I<arg>]
  13. [B<-text> I<arg>]
  14. [B<-r>]
  15. [B<-certs>]
  16. [B<-keys>]
  17. [B<-crls>]
  18. [B<-subject> I<arg>]
  19. [B<-issuer> I<arg>]
  20. [B<-serial> I<arg>]
  21. [B<-alias> I<arg>]
  22. [B<-fingerprint> I<arg>]
  23. [B<-I<digest>>]
  24. {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
  25. I<uri>
  26. =head1 DESCRIPTION
  27. This command can be used to display the contents (after
  28. decryption as the case may be) fetched from the given URI.
  29. =head1 OPTIONS
  30. =over 4
  31. =item B<-help>
  32. Print out a usage message.
  33. =item B<-out> I<filename>
  34. specifies the output filename to write to or standard output by
  35. default.
  36. =item B<-noout>
  37. this option prevents output of the PEM data.
  38. =item B<-passin> I<arg>
  39. the key password source. For more information about the format of I<arg>
  40. see L<openssl-passphrase-options(1)>.
  41. =item B<-text>
  42. Prints out the objects in text form, similarly to the B<-text> output from
  43. L<openssl-x509(1)>, L<openssl-pkey(1)>, etc.
  44. =item B<-r>
  45. Fetch objects recursively when possible.
  46. =item B<-certs>
  47. =item B<-keys>
  48. =item B<-crls>
  49. Only select the certificates, keys or CRLs from the given URI.
  50. However, if this URI would return a set of names (URIs), those are always
  51. returned.
  52. Note that all options must be given before the I<uri> argument.
  53. Note I<-keys> selects exclusively private keys, there is no selector for public
  54. keys only.
  55. =item B<-subject> I<arg>
  56. Search for an object having the subject name I<arg>.
  57. The arg must be formatted as C</type0=value0/type1=value1/type2=...>.
  58. Special characters may be escaped by C<\> (backslash), whitespace is retained.
  59. Empty values are permitted but are ignored for the search. That is,
  60. a search with an empty value will have the same effect as not specifying
  61. the type at all.
  62. Giving a single C</> will lead to an empty sequence of RDNs (a NULL-DN).
  63. Multi-valued RDNs can be formed by placing a C<+> character instead of a C</>
  64. between the AttributeValueAssertions (AVAs) that specify the members of the set.
  65. Example:
  66. C</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe>
  67. =item B<-issuer> I<arg>
  68. =item B<-serial> I<arg>
  69. Search for an object having the given issuer name and serial number.
  70. These two options I<must> be used together.
  71. The issuer arg must be formatted as C</type0=value0/type1=value1/type2=...>,
  72. characters may be escaped by \ (backslash), no spaces are skipped.
  73. The serial arg may be specified as a decimal value or a hex value if preceded
  74. by C<0x>.
  75. =item B<-alias> I<arg>
  76. Search for an object having the given alias.
  77. =item B<-fingerprint> I<arg>
  78. Search for an object having the given fingerprint.
  79. =item B<-I<digest>>
  80. The digest that was used to compute the fingerprint given with B<-fingerprint>.
  81. {- $OpenSSL::safe::opt_engine_item -}
  82. {- $OpenSSL::safe::opt_provider_item -}
  83. =back
  84. =head1 SEE ALSO
  85. L<openssl(1)>
  86. =head1 HISTORY
  87. This command was added in OpenSSL 1.1.1.
  88. The B<-engine> option was deprecated in OpenSSL 3.0.
  89. =head1 COPYRIGHT
  90. Copyright 2016-2024 The OpenSSL Project Authors. All Rights Reserved.
  91. Licensed under the Apache License 2.0 (the "License"). You may not use
  92. this file except in compliance with the License. You can obtain a copy
  93. in the file LICENSE in the source distribution or at
  94. L<https://www.openssl.org/source/license.html>.
  95. =cut