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