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

   1 .TH LDAPPASSWD 1 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2012 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 \-o \ \fIopt\fP [ =\fIoptparam\fP ]]
  29 [\c
  30 .BR \-S ]
  31 [\c
  32 .BI \-s \ newPasswd\fR]
  33 [\c
  34 .BI \-T \ newpasswdfile\fR]
  35 [\c
  36 .BR \-v ]
  37 [\c
  38 .BR \-W ]
  39 [\c
  40 .BI \-w \ passwd\fR]
  41 [\c
  42 .BI \-y \ passwdfile\fR]
  43 [\c
  44 .BI \-O \ security-properties\fR]
  45 [\c
  46 .BR \-I ]
  47 [\c
  48 .BR \-Q ]
  49 [\c
  50 .BI \-U \ authcid\fR]
  51 [\c
  52 .BI \-R \ realm\fR]
  53 [\c
  54 .BR \-x ]
  55 [\c
  56 .BI \-X \ authzid\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 For SASL binds, the server is expected to ignore this value.
 100 .TP
 101 .BI \-d \ debuglevel
 102 Set the LDAP debugging level to \fIdebuglevel\fP.
 103 .B ldappasswd
 104 must be compiled with LDAP_DEBUG defined for this option to have any effect.
 105 .TP
 106 .BI \-H \ ldapuri
 107 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
 108 fields are allowed; a list of URI, separated by whitespace or commas
 109 is expected.
 110 .TP
 111 .BI \-h \ ldaphost
 112 Specify an alternate host on which the ldap server is running.
 113 Deprecated in favor of \fB\-H\fP.
 114 .TP
 115 .BI \-p \ ldapport
 116 Specify an alternate TCP port where the ldap server is listening.
 117 Deprecated in favor of \fB\-H\fP.
 118 .TP
 119 .BR \-o \ \fIopt\fP [ =\fIoptparam\fP ]
 120
 121 Specify general options.
 122
 123 General options:
 124 .nf
 125   nettimeout=<timeout>  (in seconds, or "none" or "max")
 126   ldif-wrap=<width>     (in columns, or "no" for no wrapping)
 127 .fi
 128 .TP
 129 .B \-n
 130 Do not set password. (Can be useful when used in conjunction with
 131 \fB\-v\fP or \fB\-d\fP)
 132 .TP
 133 .BI \-S
 134 Prompt for new password.
 135 This is used instead of specifying the password on the command line.
 136 .TP
 137 .BI \-s \ newPasswd
 138 Set the new password to \fInewPasswd\fP.
 139 .TP
 140 .BI \-T \ newPasswdFile
 141 Set the new password to the contents of \fInewPasswdFile\fP.
 142 .TP
 143 .B \-v
 144 Increase the verbosity of output.  Can be specified multiple times.
 145 .TP
 146 .BI \-W
 147 Prompt for bind password.
 148 This is used instead of specifying the password on the command line.
 149 .TP
 150 .BI \-w \ passwd
 151 Use \fIpasswd\fP as the password to bind with.
 152 .TP
 153 .BI \-y \ passwdfile
 154 Use complete contents of \fIpasswdfile\fP as the password for
 155 simple authentication.
 156 .TP
 157 .BI \-O \ security-properties
 158 Specify SASL security properties.
 159 .TP
 160 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
 161 .TP
 162 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
 163
 164 Specify general extensions with \fB\-e\fP and passwd modify extensions with \fB\-E\fP.
 165 \'\fB!\fP\' indicates criticality.
 166
 167 General extensions:
 168 .nf
 169   [!]assert=<filter>    (an RFC 4515 Filter)
 170   !authzid=<authzid>    ("dn:<dn>" or "u:<user>")
 171   [!]bauthzid           (RFC 3829 authzid control)
 172   [!]chaining[=<resolve>[/<cont>]]
 173   [!]manageDSAit
 174   [!]noop
 175   ppolicy
 176   [!]postread[=<attrs>] (a comma-separated attribute list)
 177   [!]preread[=<attrs>]  (a comma-separated attribute list)
 178   [!]relax
 179   sessiontracking[=<username>]
 180   abandon,cancel,ignore (SIGINT sends abandon/cancel,
 181   or ignores response; if critical, doesn't wait for SIGINT.
 182   not really controls)
 183 .fi
 184
 185 Passwd Modify extensions:
 186 .nf
 187   (none)
 188 .fi
 189 .TP
 190 .B \-I
 191 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 192 only as needed.
 193 .TP
 194 .B \-Q
 195 Enable SASL Quiet mode.  Never prompt.
 196 .TP
 197 .BI \-U \ authcid
 198 Specify the authentication ID for SASL bind. The form of the ID
 199 depends on the actual SASL mechanism used.
 200 .TP
 201 .BI \-R \ realm
 202 Specify the realm of authentication ID for SASL bind. The form of the realm
 203 depends on the actual SASL mechanism used.
 204 .TP
 205 .BI \-X \ authzid
 206 Specify the requested authorization ID for SASL bind.
 207 .I authzid
 208 must be one of the following formats:
 209 .BI dn: "<distinguished name>"
 210 or
 211 .BI u: <username>\fP.
 212 .TP
 213 .BI \-Y \ mech
 214 Specify the SASL mechanism to be used for authentication. If it's not
 215 specified, the program will choose the best mechanism the server knows.
 216 .TP
 217 .BR \-Z [ Z ]
 218 Issue StartTLS (Transport Layer Security) extended operation. If you use
 219 \fB\-ZZ\fP, the command will require the operation to be successful
 220 .SH SEE ALSO
 221 .BR ldap_sasl_bind (3),
 222 .BR ldap_extended_operation (3),
 223 .BR ldap_start_tls_s (3)
 224 .SH AUTHOR
 225 The OpenLDAP Project <http://www.openldap.org/>
 226 .SH ACKNOWLEDGEMENTS
 227 .so ../Project