openssl-passwd.pod.in 2.6 KB

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