git.sur5r.net Git - openldap/blob - doc/man/man1/ldappasswd.1

   1 .TH LDAPPASSWD 1 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldappasswd \- change the password of an LDAP entry
   7 .SH SYNOPSIS
   8 .B ldappasswd
   9 [\c
  10 .BR \-A ]
  11 [\c
  12 .BI \-a \ oldPasswd\fR]
  13 [\c
  14 .BI \-t \ oldpasswdfile\fR]
  15 [\c
  16 .BI \-D \ binddn\fR]
  17 [\c
  18 .BI \-d \ debuglevel\fR]
  19 [\c
  20 .BI \-H \ ldapuri\fR]
  21 [\c
  22 .BI \-h \ ldaphost\fR]
  23 [\c
  24 .BR \-n ]
  25 [\c
  26 .BI \-p \ ldapport\fR]
  27 [\c
  28 .BR \-S ]
  29 [\c
  30 .BI \-s \ newPasswd\fR]
  31 [\c
  32 .BI \-T \ newpasswdfile\fR]
  33 [\c
  34 .BR \-v ]
  35 [\c
  36 .BR \-W ]
  37 [\c
  38 .BI \-w \ passwd\fR]
  39 [\c
  40 .BI \-y \ passwdfile\fR]
  41 [\c
  42 .BR \-O \ security-properties ]
  43 [\c
  44 .BR \-I ]
  45 [\c
  46 .BR \-Q ]
  47 [\c
  48 .BI \-U \ authcid\fR]
  49 [\c
  50 .BI \-R \ authcid\fR]
  51 [\c
  52 .BR \-x ]
  53 [\c
  54 .BI \-X \ authzid\fR]
  55 [\c
  56 .BI \-R \ realm\fR]
  57 [\c
  58 .BI \-Y \ mech\fR]
  59 [\c
  60 .BR \-Z[Z] ]
  61 [\c
  62 .IR user ]
  63 .SH DESCRIPTION
  64 .B ldappasswd
  65 is a tool to set the password of an LDAP user.
  66 .B ldappasswd
  67 uses the LDAPv3 Password Modify (RFC 3062) extended operation.
  68 .LP
  69 .B ldappasswd
  70 sets the password of associated with the user [or an optionally
  71 specified
  72 .IR user ].
  73 If the new
  74 password is not specified on the command line and the user
  75 doesn't enable prompting, the server will be asked to generate
  76 a password for the user.
  77 .LP
  78 .B ldappasswd
  79 is neither designed nor intended to be a replacement for
  80 .BR passwd (1)
  81 and should not be installed as such.
  82 .SH OPTIONS
  83 .TP
  84 .BI \-A
  85 Prompt for old password.
  86 This is used instead of specifying the password on the command line.
  87 .TP
  88 .BI \-a \ oldPasswd
  89 Set the old password to \fIoldPasswd\fP.
  90 .TP
  91 .BI \-t \ oldPasswdFile
  92 Set the old password to the contents of \fIoldPasswdFile\fP.
  93 .TP
  94 .B \-x
  95 Use simple authentication instead of SASL.
  96 .TP
  97 .BI \-D \ binddn
  98 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
  99 .TP
 100 .BI \-d \ debuglevel
 101 Set the LDAP debugging level to \fIdebuglevel\fP.
 102 .B ldappasswd
 103 must be compiled with LDAP_DEBUG defined for this option to have any effect.
 104 .TP
 105 .BI \-H \ ldapuri
 106 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
 107 fields are allowed; a list of URI, separated by whitespace or commas
 108 is expected.
 109 .TP
 110 .BI \-h \ ldaphost
 111 Specify an alternate host on which the ldap server is running.
 112 Deprecated in favor of -H.
 113 .TP
 114 .BI \-p \ ldapport
 115 Specify an alternate TCP port where the ldap server is listening.
 116 Deprecated in favor of -H.
 117 .TP
 118 .B \-n
 119 Do not set password. (Can be useful when used in conjunction with
 120 .BR \-v \ or
 121 .BR \-d )
 122 .TP
 123 .BI \-S
 124 Prompt for new password.
 125 This is used instead of specifying the password on the command line.
 126 .TP
 127 .BI \-s \ newPasswd
 128 Set the new password to \fInewPasswd\fP.
 129 .TP
 130 .BI \-T \ newPasswdFile
 131 Set the new password to the contents of \fInewPasswdFile\fP.
 132 .TP
 133 .B \-v
 134 Increase the verbosity of output.  Can be specified multiple times.
 135 .TP
 136 .BI \-W
 137 Prompt for bind password.
 138 This is used instead of specifying the password on the command line.
 139 .TP
 140 .BI \-w \ passwd
 141 Use \fIpasswd\fP as the password to bind with.
 142 .TP
 143 .BI \-y \ passwdfile
 144 Use complete contents of \fIpasswdfile\fP as the password for
 145 simple authentication.
 146 .TP
 147 .BI \-O \ security-properties
 148 Specify SASL security properties.
 149 .TP
 150 .B \-I
 151 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 152 only as needed.
 153 .TP
 154 .B \-Q
 155 Enable SASL Quiet mode.  Never prompt.
 156 .TP
 157 .BI \-U \ authcid
 158 Specify the authentication ID for SASL bind. The form of the ID
 159 depends on the actual SASL mechanism used.
 160 .TP
 161 .BI \-R \ realm
 162 Specify the realm of authentication ID for SASL bind. The form of the realm
 163 depends on the actual SASL mechanism used.
 164 .TP
 165 .BI \-X \ authzid
 166 Specify the requested authorization ID for SASL bind.
 167 .I authzid
 168 must be one of the following formats:
 169 .BI dn: <distinguished name>
 170 or
 171 .BI u: <username>\fP.
 172 .TP
 173 .BI \-Y \ mech
 174 Specify the SASL mechanism to be used for authentication. If it's not
 175 specified, the program will choose the best mechanism the server knows.
 176 .TP
 177 .B \-Z[Z]
 178 Issue StartTLS (Transport Layer Security) extended operation. If you use
 179 .BR \-ZZ ,
 180 the command will require the operation to be successful
 181 .SH SEE ALSO
 182 .BR ldap_sasl_bind (3),
 183 .BR ldap_extended_operation (3),
 184 .BR ldap_start_tls_s (3)
 185 .SH AUTHOR
 186 The OpenLDAP Project <http://www.openldap.org/>
 187 .SH ACKNOWLEDGEMENTS
 188 .B OpenLDAP
 189 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 190 .B OpenLDAP
 191 is derived from University of Michigan LDAP 3.3 Release.