openssl-passwd.pod.in 2.5 KB

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