openssl-passwd.pod.in 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. =pod
  2. {- OpenSSL::safe::output_do_not_edit_headers(); -}
  3. =head1 NAME
  4. openssl-passwd - compute password hashes
  5. =head1 SYNOPSIS
  6. B<openssl passwd>
  7. [B<-help>]
  8. [B<-1>]
  9. [B<-apr1>]
  10. [B<-aixmd5>]
  11. [B<-5>]
  12. [B<-6>]
  13. [B<-salt> I<string>]
  14. [B<-in> I<file>]
  15. [B<-stdin>]
  16. [B<-noverify>]
  17. [B<-quiet>]
  18. [B<-table>]
  19. [B<-reverse>]
  20. {- $OpenSSL::safe::opt_r_synopsis -}
  21. {- $OpenSSL::safe::opt_provider_synopsis -}
  22. [I<password>]
  23. =head1 DESCRIPTION
  24. This command computes the hash of a password typed at
  25. run-time or the hash of each password in a list. The password list is
  26. taken from the named file for option B<-in>, from stdin for
  27. option B<-stdin>, or from the command line, or from the terminal otherwise.
  28. The MD5-based BSD password algorithm B<-1>, its Apache variant B<-apr1>,
  29. and its AIX variant are available.
  30. =head1 OPTIONS
  31. =over 4
  32. =item B<-help>
  33. Print out a usage message.
  34. =item B<-1>
  35. Use the MD5 based BSD password algorithm B<1> (default).
  36. =item B<-apr1>
  37. Use the B<apr1> algorithm (Apache variant of the BSD algorithm).
  38. =item B<-aixmd5>
  39. Use the B<AIX MD5> algorithm (AIX variant of the BSD algorithm).
  40. =item B<-5>
  41. =item B<-6>
  42. Use the B<SHA256> / B<SHA512> based algorithms defined by Ulrich Drepper.
  43. See L<https://www.akkadia.org/drepper/SHA-crypt.txt>.
  44. =item B<-salt> I<string>
  45. Use the specified salt.
  46. When reading a password from the terminal, this implies B<-noverify>.
  47. =item B<-in> I<file>
  48. Read passwords from I<file>.
  49. =item B<-stdin>
  50. Read passwords from B<stdin>.
  51. =item B<-noverify>
  52. Don't verify when reading a password from the terminal.
  53. =item B<-quiet>
  54. Don't output warnings when passwords given at the command line are truncated.
  55. =item B<-table>
  56. In the output list, prepend the cleartext password and a TAB character
  57. to each password hash.
  58. =item B<-reverse>
  59. When the B<-table> option is used, reverse the order of cleartext and hash.
  60. {- $OpenSSL::safe::opt_r_item -}
  61. {- $OpenSSL::safe::opt_provider_item -}
  62. =back
  63. =head1 EXAMPLES
  64. % openssl passwd -1 -salt xxxxxxxx password
  65. $1$xxxxxxxx$UYCIxa628.9qXjpQCjM4a.
  66. % openssl passwd -apr1 -salt xxxxxxxx password
  67. $apr1$xxxxxxxx$dxHfLAsjHkDRmG83UXe8K0
  68. % openssl passwd -aixmd5 -salt xxxxxxxx password
  69. xxxxxxxx$8Oaipk/GPKhC64w/YVeFD/
  70. =head1 HISTORY
  71. The B<-crypt> option was removed in OpenSSL 3.0.
  72. =head1 COPYRIGHT
  73. Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
  74. Licensed under the Apache License 2.0 (the "License"). You may not use
  75. this file except in compliance with the License. You can obtain a copy
  76. in the file LICENSE in the source distribution or at
  77. L<https://www.openssl.org/source/license.html>.
  78. =cut