Update 'openssl passwd' documentation on selection of algorithms.

[openssl.git] / doc / apps / passwd.pod

diff --git a/doc/apps/passwd.pod b/doc/apps/passwd.pod
index 0df9252981974846dafff9ed0de26b903285796d..6e098940c750dac8069ccacf3b113f7f3f27d1a9 100644 (file)
--- a/doc/apps/passwd.pod
+++ b/doc/apps/passwd.pod
@@ -8,17 +8,23 @@ passwd - compute password hashes
 
 B<openssl passwd>
 [B<-crypt>]
 
 B<openssl passwd>
 [B<-crypt>]

-[B<-salt string>]
+[B<-1>]
+[B<-apr1>]
+[B<-salt> I<string>]
+[B<-in> I<file>]
+[B<-stdin>]

 [B<-quiet>]
 [B<-table>]
 [B<-quiet>]
 [B<-table>]

-{B<password>}
+{I<password>}

 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 

-The B<passwd> command computes the hashes of a list of passwords
-passed on the command line, or the hash of a password typed at run-time.
-Currently only the Unix standard algorithm B<crypt>
-is implemented.
+The B<passwd> command computes the hash of a password typed at
+run-time or the hash of each password in a list.  The password list is
+taken from the named file for option B<-in file>, from stdin for
+option B<-stdin>, and from the command line otherwise.
+The Unix standard algorithm B<crypt> and the MD5-based BSD password
+algorithm B<1> and its Apache variant B<apr1> are available.

 
 =head1 OPTIONS
 
 
 =head1 OPTIONS
 


@@ -28,13 +34,29 @@ is implemented.
 
 Use the B<crypt> algorithm (default).
 
 
 Use the B<crypt> algorithm (default).
 

-=item B<-salt string>
+=item B<-1>
+
+Use the MD5 based BSD password algorithm B<1>.
+
+=item B<-apr1>
+
+Use the B<apr1> algorithm (Apache variant of the BSD algorithm).
+
+=item B<-salt> I<string>

 
 Use the specified salt.
 
 
 Use the specified salt.
 

+=item B<-in> I<file>
+
+Read passwords from I<file>.
+
+=item B<-stdin>
+
+Read passwords from B<stdin>.
+

 =item B<-quiet>
 
 =item B<-quiet>
 

-Don't output warnings when passwords are truncated.
+Don't output warnings when passwords given at the command line are truncated.

 
 =item B<-table>
 
 
 =item B<-table>
 


@@ -43,8 +65,12 @@ to each password hash.
 
 =back
 
 
 =back
 

-=head1 EXAMPLE
+=head1 EXAMPLES
+
+B<openssl passwd -crypt -salt xx password> prints B<xxj31ZMTZzkVA>.
+
+B<openssl passwd -1 -salt xxxxxxxx password> prints B<$1$xxxxxxxx$8XJIcl6ZXqBMCK0qFevqT1>.

 
 

-B<openssl passwd -salt xx password> prints B<xxj31ZMTZzkVA>.
+B<openssl passwd -apr1 -salt xxxxxxxx password> prints B<$apr1$xxxxxxxx$dxHfLAsjHkDRmG83UXe8K0>.

 
 =cut
 
 =cut