doc/man1/openssl-passwd.pod.in

   1 =pod
   2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
   3
   4 =head1 NAME
   5
   6 openssl-passwd - compute password hashes
   7
   8 =head1 SYNOPSIS
   9
  10 B<openssl passwd>
  11 [B<-help>]
  12 [B<-crypt>]
  13 [B<-1>]
  14 [B<-apr1>]
  15 [B<-aixmd5>]
  16 [B<-5>]
  17 [B<-6>]
  18 [B<-salt> I<string>]
  19 [B<-in> I<file>]
  20 [B<-stdin>]
  21 [B<-noverify>]
  22 [B<-quiet>]
  23 [B<-table>]
  24 [B<-reverse>]
  25 {- $OpenSSL::safe::opt_r_synopsis -}
  26 {- $OpenSSL::safe::opt_provider_synopsis -}
  27 [I<password>]
  28
  29 =for openssl ifdef crypt
  30
  31 =head1 DESCRIPTION
  32
  33 This command computes the hash of a password typed at
  34 run-time or the hash of each password in a list.  The password list is
  35 taken from the named file for option B<-in>, from stdin for
  36 option B<-stdin>, or from the command line, or from the terminal otherwise.
  37 The Unix standard algorithm B<-crypt> and the MD5-based BSD password
  38 algorithm B<-1>, its Apache variant B<-apr1>, and its AIX variant are
  39 available.
  40
  41 =head1 OPTIONS
  42
  43 =over 4
  44
  45 =item B<-help>
  46
  47 Print out a usage message.
  48
  49 =item B<-crypt>
  50
  51 Use the B<crypt> algorithm (default).
  52
  53 =item B<-1>
  54
  55 Use the MD5 based BSD password algorithm B<1>.
  56
  57 =item B<-apr1>
  58
  59 Use the B<apr1> algorithm (Apache variant of the BSD algorithm).
  60
  61 =item B<-aixmd5>
  62
  63 Use the B<AIX MD5> algorithm (AIX variant of the BSD algorithm).
  64
  65 =item B<-5>
  66
  67 =item B<-6>
  68
  69 Use the B<SHA256> / B<SHA512> based algorithms defined by Ulrich Drepper.
  70 See L<https://www.akkadia.org/drepper/SHA-crypt.txt>.
  71
  72 =item B<-salt> I<string>
  73
  74 Use the specified salt.
  75 When reading a password from the terminal, this implies B<-noverify>.
  76
  77 =item B<-in> I<file>
  78
  79 Read passwords from I<file>.
  80
  81 =item B<-stdin>
  82
  83 Read passwords from B<stdin>.
  84
  85 =item B<-noverify>
  86
  87 Don't verify when reading a password from the terminal.
  88
  89 =item B<-quiet>
  90
  91 Don't output warnings when passwords given at the command line are truncated.
  92
  93 =item B<-table>
  94
  95 In the output list, prepend the cleartext password and a TAB character
  96 to each password hash.
  97
  98 =item B<-reverse>
  99
 100 When the B<-table> option is used, reverse the order of cleartext and hash.
 101
 102 {- $OpenSSL::safe::opt_r_item -}
 103
 104 {- $OpenSSL::safe::opt_provider_item -}
 105
 106 =back
 107
 108 =head1 EXAMPLES
 109
 110   % openssl passwd -crypt -salt xx password
 111   xxj31ZMTZzkVA
 112
 113   % openssl passwd -1 -salt xxxxxxxx password
 114   $1$xxxxxxxx$UYCIxa628.9qXjpQCjM4a.
 115
 116   % openssl passwd -apr1 -salt xxxxxxxx password
 117   $apr1$xxxxxxxx$dxHfLAsjHkDRmG83UXe8K0
 118
 119   % openssl passwd -aixmd5 -salt xxxxxxxx password
 120   xxxxxxxx$8Oaipk/GPKhC64w/YVeFD/
 121
 122 =head1 COPYRIGHT
 123
 124 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 125
 126 Licensed under the Apache License 2.0 (the "License").  You may not use
 127 this file except in compliance with the License.  You can obtain a copy
 128 in the file LICENSE in the source distribution or at
 129 L<https://www.openssl.org/source/license.html>.
 130
 131 =cut