Import Upstream version 0.66.4
[hcoop/debian/courier-authlib.git] / authpasswd.1
1 '\" t
2 .\" <!-- Copyright 2004-2008 Double Precision, Inc. See COPYING for -->
3 .\" <!-- distribution information. -->
4 .\" Title: authpasswd
5 .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
6 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
7 .\" Date: 06/20/2015
8 .\" Manual: Double Precision, Inc.
9 .\" Source: Double Precision, Inc.
10 .\" Language: English
11 .\"
12 .TH "AUTHPASSWD" "1" "06/20/2015" "Double Precision, Inc." "Double Precision, Inc."
13 .\" -----------------------------------------------------------------
14 .\" * Define some portability stuff
15 .\" -----------------------------------------------------------------
16 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17 .\" http://bugs.debian.org/507673
18 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
19 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .ie \n(.g .ds Aq \(aq
21 .el .ds Aq '
22 .\" -----------------------------------------------------------------
23 .\" * set default formatting
24 .\" -----------------------------------------------------------------
25 .\" disable hyphenation
26 .nh
27 .\" disable justification (adjust text to left margin only)
28 .ad l
29 .\" -----------------------------------------------------------------
30 .\" * MAIN CONTENT STARTS HERE *
31 .\" -----------------------------------------------------------------
32 .SH "NAME"
33 authpasswd \- Generate login passwords
34 .SH "SYNOPSIS"
35 .HP \w'\fBauthpasswd\fR\ 'u
36 \fBauthpasswd\fR [method]
37 .SH "DESCRIPTION"
38 .PP
39 \fBauthpasswd\fR
40 is a helper utility that generates encrypted passwords for the Courier authentication library\&. The Courier authentication library is capable of using several different encryption methods for storing passwords\&.
41 \fBauthpasswd\fR
42 issues a password prompt\&. Enter the same password twice (for verification purposes)\&.
43 \fBauthpasswd\fR
44 computes and prints the encrypted password\&. The encrypted password can be inserted verbatim into the appropriate account record that\*(Aqs processed by the authentication library\*(Aqs
45 authmysql,
46 authpgsql,
47 authsqlite, or
48 authldap
49 module\&.
50 .PP
51 \fImethod\fR
52 may be set to one of the following literals:
53 .PP
54 crypt
55 .RS 4
56 Use the traditional
57 DES\-based encrypted password\&.
58 .RE
59 .PP
60 md5
61 .RS 4
62 Compute a base64\-encoded
63 MD5
64 password hash\&.
65 .RE
66 .PP
67 md5raw
68 .RS 4
69 Compute a hexadecimal\-encoded
70 MD5
71 password hash\&.
72 .RE
73 .PP
74 sha1
75 .RS 4
76 Compute a
77 SHA1
78 password hash\&.
79 .RE
80 .PP
81 ssha
82 .RS 4
83 Compute a salted
84 SHA1
85 password hash\&.
86 .RE
87 .PP
88 sha256
89 .RS 4
90 Compute a
91 SHA256
92 password hash\&.
93 .RE
94 .PP
95 If not specified,
96 \fImethod\fR
97 defaults to the modified\-MD5
98 password encryption algorithm that\*(Aqs used in Linux (note that this is different from the
99 \(lqmd5\(rq
100 password hash method)\&.