]> git.sur5r.net Git - openldap/blob - doc/man/man1/ldappasswd.1
Document "*", "+", and "1.1" use in attrlist.
[openldap] / doc / man / man1 / ldappasswd.1
1 .TH LDAPPASSWD 1 "5 December 1998" "LDAPPasswd"
2 .SH NAME
3 ldappasswd \- change the password of an LDAP entry
4 .SH SYNOPSIS
5 .B ldappasswd
6 [\c
7 .BI \-a \ passwdattribute\fR]
8 [\c
9 .BI \-b \ searchbase\fR]
10 [\c
11 .BI \-D \ binddn\fR]
12 [\c
13 .BI \-d \ debuglevel\fR]
14 [\c
15 .BR \-E ]
16 [\c
17 .BI \-e \ passwd\fR] 
18 [\c
19 .BI \-g \ pwlen\fR]
20 [\c
21 .BI \-H \ none\fR\||\|\fIcrypt\fR\||\|\fImd5\fR\||\|\fIsmd5\fR\||\|\fIsha\fR\||\|\fIssha]
22 [\c
23 .BI \-h \ ldaphost\fR]
24 [\c
25 .BR \-K ]
26 [\c
27 .BR \-k ]
28 [\c
29 .BI \-l \ searchtime\fR]
30 [\c
31 .BR \-n ]
32 [\c
33 .BI \-P \ 2\fR\||\|\fI3\fR]
34 [\c
35 .BI \-p \ ldapport\fR]
36 [\c
37 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR]
38 [\c
39 .BI \-t \ targetdn\fR]
40 [\c
41 .BR \-v ]
42 [\c
43 .BR \-W ]
44 [\c
45 .BI \-w \ passwd\fR]
46 [\c
47 .BI \-z \ searchsize\fR]
48 [\fIfilter\fR]
49 .SH DESCRIPTION
50 .B ldappasswd
51 is a tool to modify the password of one or more LDAP entries.
52 Multiple entries can be specified using a search filter.
53 It is neither designed nor intended to be a replacement for
54 .BR passwd (1)
55 and should not be installed as such.
56 .LP
57 .B ldappasswd
58 works by specifying a single target dn or by using a search filter.
59 Matching entries will be modified with the new password.
60 If the new password is not specified on the command line, the user
61 will be prompted to enter it.
62 The new password will be hashed using
63 .I crypt
64 or any other supported hashing algorithm.
65 For hashing algorithms other than
66 .I crypt
67 or
68 .IR none ,
69 the stored password will be base64 encoded.
70 Salts are only generated for crypt and are based on the least
71 significant bits of the current time and other psuedo randomness.
72 .SH OPTIONS
73 .TP
74 .BI \-a \ passwdattribute
75 Specify the LDAP attribute to change. The default is "userPassword".
76 .TP
77 .BI \-b \ searchbase
78 Use \fIsearchbase\fP as the starting point for the search instead of
79 the default.
80 .TP
81 .B \-H \fInone\fR\||\|\fIcrypt\fR\||\|\fImd5\fR\||\|\fIsmd5\fR\||\|\fIsha\fR\||\|\fIssha
82 Specify the hashing algorithm used to store the password. The default is
83 .IR crypt .
84 .TP
85 .BI \-D \ binddn
86 Use \fIbinddn\fP to bind to the X.500 directory. \fIbinddn\fP should be
87 a string-represented DN as defined in RFC 1779.
88 .TP
89 .BI \-d \ debuglevel
90 Set the LDAP debugging level to \fIdebuglevel\fP.
91 .B ldappasswd
92 must be compiled with LDAP_DEBUG defined for this option to have any effect.
93 .TP
94 .BI \-g \ pwlen
95 Auto-generate passwords of length \fIpwlen\fR.
96 Passwords will be displayed when using verbose,
97 .BR -vvv .
98 .TP
99 .BI \-h \ ldaphost
100 Specify an alternate host on which the ldap server is running.
101 .TP
102 .B \-K
103 Same as -k, but only does step 1 of the kerberos bind.
104 This is useful when connecting to a slapd and there is no x500dsa.hostname principal registered with your kerberos servers.
105 .TP
106 .B \-k
107 Use Kerberos authentication instead of simple authentication.
108 It is assumed that you already have a valid ticket granting ticket.
109 .B ldappasswd
110 must be compiled with KERBEROS defined for this option to have any effect.
111 .TP
112 .BI \-l \ searchtime
113 Specify a maximum query time in seconds.
114 .TP
115 .B \-n
116 Make no modifications. (Can be useful when used in conjunction with
117 .BR \-v \ or
118 .BR \-d )
119 .TP
120 .BI \-P \ 2\fR\||\|\fI3
121 Specify the LDAP protocol version to use.
122 .TP
123 .BI \-p \ ldapport
124 Specify an alternate port on which the ldap server is running.
125 .TP
126 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR
127 Specify the scope of the search. The default is
128 .IR base .
129 .TP
130 .B \-t \fR[\fItargetdn\fR]
131 Specify the target dn to modify.
132 If an argument is not given, the target dn will be the binddn.
133 .TP
134 .B \-v
135 The more v's the more verbose.
136 .TP
137 .BI \-W
138 Prompt for simple authentication.
139 This is used instead of specifying the password on the command line.
140 .TP
141 .BI \-w \ passwd
142 Use \fIpasswd\fP as the password for simple authentication.
143 .TP
144 .BI \-z \ searchsize
145 Specify a maximum query size.
146 .SH AUTHOR
147 David E. Storey <dave@tamos.net>
148 .SH "SEE ALSO"
149 .BR ldapadd (1),
150 .BR ldapdelete (1),
151 .BR ldapmodrdn (1),
152 .BR ldapsearch (1)