openssl-rsa.pod.in 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  1. =pod
  2. =begin comment
  3. {- join("\n", @autowarntext) -}
  4. =end comment
  5. =head1 NAME
  6. openssl-rsa - RSA key processing command
  7. =head1 SYNOPSIS
  8. B<openssl> B<rsa>
  9. [B<-help>]
  10. [B<-inform> B<DER>|B<PEM>|B<P12>|B<ENGINE>]
  11. [B<-outform> B<DER>|B<PEM>]
  12. [B<-in> I<filename>|I<uri>]
  13. [B<-passin> I<arg>]
  14. [B<-out> I<filename>]
  15. [B<-passout> I<arg>]
  16. [B<-aes128>]
  17. [B<-aes192>]
  18. [B<-aes256>]
  19. [B<-aria128>]
  20. [B<-aria192>]
  21. [B<-aria256>]
  22. [B<-camellia128>]
  23. [B<-camellia192>]
  24. [B<-camellia256>]
  25. [B<-des>]
  26. [B<-des3>]
  27. [B<-idea>]
  28. [B<-text>]
  29. [B<-noout>]
  30. [B<-modulus>]
  31. [B<-traditional>]
  32. [B<-check>]
  33. [B<-pubin>]
  34. [B<-pubout>]
  35. [B<-RSAPublicKey_in>]
  36. [B<-RSAPublicKey_out>]
  37. [B<-pvk-strong>]
  38. [B<-pvk-weak>]
  39. [B<-pvk-none>]
  40. {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
  41. =head1 DESCRIPTION
  42. This command processes RSA keys. They can be converted between
  43. various forms and their components printed out.
  44. =head1 OPTIONS
  45. =over 4
  46. =item B<-help>
  47. Print out a usage message.
  48. =item B<-inform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
  49. The key input format; unspecified by default.
  50. See L<openssl-format-options(1)> for details.
  51. =item B<-outform> B<DER>|B<PEM>
  52. The key output format; the default is B<PEM>.
  53. See L<openssl-format-options(1)> for details.
  54. =item B<-traditional>
  55. When writing a private key, use the traditional PKCS#1 format
  56. instead of the PKCS#8 format.
  57. =item B<-in> I<filename>|I<uri>
  58. This specifies the input to read a key from or standard input if this
  59. option is not specified. If the key is encrypted a pass phrase will be
  60. prompted for.
  61. =item B<-passin> I<arg>, B<-passout> I<arg>
  62. The password source for the input and output file.
  63. For more information about the format of B<arg>
  64. see L<openssl-passphrase-options(1)>.
  65. =item B<-out> I<filename>
  66. This specifies the output filename to write a key to or standard output if this
  67. option is not specified. If any encryption options are set then a pass phrase
  68. will be prompted for. The output filename should B<not> be the same as the input
  69. filename.
  70. =item B<-aes128>, B<-aes192>, B<-aes256>, B<-aria128>, B<-aria192>, B<-aria256>, B<-camellia128>, B<-camellia192>, B<-camellia256>, B<-des>, B<-des3>, B<-idea>
  71. These options encrypt the private key with the specified
  72. cipher before outputting it. A pass phrase is prompted for.
  73. If none of these options is specified the key is written in plain text. This
  74. means that this command can be used to remove the pass phrase from a key
  75. by not giving any encryption option is given, or to add or change the pass
  76. phrase by setting them.
  77. These options can only be used with PEM format output files.
  78. =item B<-text>
  79. Prints out the various public or private key components in
  80. plain text in addition to the encoded version.
  81. =item B<-noout>
  82. This option prevents output of the encoded version of the key.
  83. =item B<-modulus>
  84. This option prints out the value of the modulus of the key.
  85. =item B<-check>
  86. This option checks the consistency of an RSA private key.
  87. =item B<-pubin>
  88. By default a private key is read from the input.
  89. With this option a public key is read instead.
  90. If the input contains no public key but a private key, its public part is used.
  91. =item B<-pubout>
  92. By default a private key is output: with this option a public
  93. key will be output instead. This option is automatically set if
  94. the input is a public key.
  95. =item B<-RSAPublicKey_in>, B<-RSAPublicKey_out>
  96. Like B<-pubin> and B<-pubout> except B<RSAPublicKey> format is used instead.
  97. =item B<-pvk-strong>
  98. Enable 'Strong' PVK encoding level (default).
  99. =item B<-pvk-weak>
  100. Enable 'Weak' PVK encoding level.
  101. =item B<-pvk-none>
  102. Don't enforce PVK encoding.
  103. {- $OpenSSL::safe::opt_engine_item -}
  104. {- $OpenSSL::safe::opt_provider_item -}
  105. =back
  106. =head1 NOTES
  107. The L<openssl-pkey(1)> command is capable of performing all the operations
  108. this command can, as well as supporting other public key types.
  109. =head1 EXAMPLES
  110. The documentation for the L<openssl-pkey(1)> command contains examples
  111. equivalent to the ones listed here.
  112. To remove the pass phrase on an RSA private key:
  113. openssl rsa -in key.pem -out keyout.pem
  114. To encrypt a private key using triple DES:
  115. openssl rsa -in key.pem -des3 -out keyout.pem
  116. To convert a private key from PEM to DER format:
  117. openssl rsa -in key.pem -outform DER -out keyout.der
  118. To print out the components of a private key to standard output:
  119. openssl rsa -in key.pem -text -noout
  120. To just output the public part of a private key:
  121. openssl rsa -in key.pem -pubout -out pubkey.pem
  122. Output the public part of a private key in B<RSAPublicKey> format:
  123. openssl rsa -in key.pem -RSAPublicKey_out -out pubkey.pem
  124. =head1 BUGS
  125. There should be an option that automatically handles F<.key> files,
  126. without having to manually edit them.
  127. =head1 SEE ALSO
  128. L<openssl(1)>,
  129. L<openssl-pkey(1)>,
  130. L<openssl-pkcs8(1)>,
  131. L<openssl-dsa(1)>,
  132. L<openssl-genrsa(1)>,
  133. L<openssl-gendsa(1)>
  134. =head1 HISTORY
  135. The B<-engine> option was deprecated in OpenSSL 3.0.
  136. =head1 COPYRIGHT
  137. Copyright 2000-2023 The OpenSSL Project Authors. All Rights Reserved.
  138. Licensed under the Apache License 2.0 (the "License"). You may not use
  139. this file except in compliance with the License. You can obtain a copy
  140. in the file LICENSE in the source distribution or at
  141. L<https://www.openssl.org/source/license.html>.
  142. =cut