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

   1 .TH LDAPPASSWD 1 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2018 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 \-V [ V ]]
  11 [\c
  12 .BI \-d \ debuglevel\fR]
  13 [\c
  14 .BR \-n ]
  15 [\c
  16 .BR \-v ]
  17 [\c
  18 .BR \-A ]
  19 [\c
  20 .BI \-a \ oldPasswd\fR]
  21 [\c
  22 .BI \-t \ oldpasswdfile\fR]
  23 [\c
  24 .BR \-S ]
  25 [\c
  26 .BI \-s \ newPasswd\fR]
  27 [\c
  28 .BI \-T \ newpasswdfile\fR]
  29 [\c
  30 .BR \-x ]
  31 [\c
  32 .BI \-D \ binddn\fR]
  33 [\c
  34 .BR \-W ]
  35 [\c
  36 .BI \-w \ passwd\fR]
  37 [\c
  38 .BI \-y \ passwdfile\fR]
  39 [\c
  40 .BI \-H \ ldapuri\fR]
  41 [\c
  42 .BI \-h \ ldaphost\fR]
  43 [\c
  44 .BI \-p \ ldapport\fR]
  45 [\c
  46 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
  47 [\c
  48 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
  49 [\c
  50 .BI \-o \ opt \fR[= optparam \fR]]
  51 [\c
  52 .BI \-O \ security-properties\fR]
  53 [\c
  54 .BR \-I ]
  55 [\c
  56 .BR \-Q ]
  57 [\c
  58 .BR \-N ]
  59 [\c
  60 .BI \-U \ authcid\fR]
  61 [\c
  62 .BI \-R \ realm\fR]
  63 [\c
  64 .BI \-X \ authzid\fR]
  65 [\c
  66 .BI \-Y \ mech\fR]
  67 [\c
  68 .BR \-Z [ Z ]]
  69 [\c
  70 .IR user ]
  71 .SH DESCRIPTION
  72 .B ldappasswd
  73 is a tool to set the password of an LDAP user.
  74 .B ldappasswd
  75 uses the LDAPv3 Password Modify (RFC 3062) extended operation.
  76 .LP
  77 .B ldappasswd
  78 sets the password of associated with the user [or an optionally
  79 specified
  80 .IR user ].
  81 If the new
  82 password is not specified on the command line and the user
  83 doesn't enable prompting, the server will be asked to generate
  84 a password for the user.
  85 .LP
  86 .B ldappasswd
  87 is neither designed nor intended to be a replacement for
  88 .BR passwd (1)
  89 and should not be installed as such.
  90 .SH OPTIONS
  91 .TP
  92 .BR \-V [ V ]
  93 Print version info.
  94 If \fB\-VV\fP is given, only the version information is printed.
  95 .TP
  96 .BI \-d \ debuglevel
  97 Set the LDAP debugging level to \fIdebuglevel\fP.
  98 .B ldappasswd
  99 must be compiled with LDAP_DEBUG defined for this option to have any effect.
 100 .TP
 101 .B \-n
 102 Do not set password. (Can be useful when used in conjunction with
 103 \fB\-v\fP or \fB\-d\fP)
 104 .TP
 105 .B \-v
 106 Increase the verbosity of output.  Can be specified multiple times.
 107 .TP
 108 .BI \-A
 109 Prompt for old password.
 110 This is used instead of specifying the password on the command line.
 111 .TP
 112 .BI \-a \ oldPasswd
 113 Set the old password to \fIoldPasswd\fP.
 114 .TP
 115 .BI \-t \ oldPasswdFile
 116 Set the old password to the contents of \fIoldPasswdFile\fP.
 117 .TP
 118 .BI \-S
 119 Prompt for new password.
 120 This is used instead of specifying the password on the command line.
 121 .TP
 122 .BI \-s \ newPasswd
 123 Set the new password to \fInewPasswd\fP.
 124 .TP
 125 .BI \-T \ newPasswdFile
 126 Set the new password to the contents of \fInewPasswdFile\fP.
 127 .TP
 128 .B \-x
 129 Use simple authentication instead of SASL.
 130 .TP
 131 .BI \-D \ binddn
 132 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 133 For SASL binds, the server is expected to ignore this value.
 134 .TP
 135 .BI \-W
 136 Prompt for bind password.
 137 This is used instead of specifying the password on the command line.
 138 .TP
 139 .BI \-w \ passwd
 140 Use \fIpasswd\fP as the password to bind with.
 141 .TP
 142 .BI \-y \ passwdfile
 143 Use complete contents of \fIpasswdfile\fP as the password for
 144 simple authentication.
 145 .TP
 146 .BI \-H \ ldapuri
 147 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
 148 fields are allowed; a list of URI, separated by whitespace or commas
 149 is expected.
 150 .TP
 151 .BI \-h \ ldaphost
 152 Specify an alternate host on which the ldap server is running.
 153 Deprecated in favor of \fB\-H\fP.
 154 .TP
 155 .BI \-p \ ldapport
 156 Specify an alternate TCP port where the ldap server is listening.
 157 Deprecated in favor of \fB\-H\fP.
 158 .TP
 159 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
 160 .TP
 161 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
 162
 163 Specify general extensions with \fB\-e\fP and passwd modify extensions with \fB\-E\fP.
 164 \'\fB!\fP\' indicates criticality.
 165
 166 General extensions:
 167 .nf
 168   [!]assert=<filter>    (an RFC 4515 Filter)
 169   !authzid=<authzid>    ("dn:<dn>" or "u:<user>")
 170   [!]bauthzid           (RFC 3829 authzid control)
 171   [!]chaining[=<resolve>[/<cont>]]
 172   [!]manageDSAit
 173   [!]noop
 174   ppolicy
 175   [!]postread[=<attrs>] (a comma-separated attribute list)
 176   [!]preread[=<attrs>]  (a comma-separated attribute list)
 177   [!]relax
 178   sessiontracking[=<username>]
 179   abandon,cancel,ignore (SIGINT sends abandon/cancel,
 180   or ignores response; if critical, doesn't wait for SIGINT.
 181   not really controls)
 182 .fi
 183
 184 Passwd Modify extensions:
 185 .nf
 186   (none)
 187 .fi
 188 .TP
 189 .BI \-o \ opt \fR[= optparam \fR]]
 190
 191 Specify any
 192 .BR ldap.conf (5)
 193 option or one of the following:
 194 .nf
 195   nettimeout=<timeout>  (in seconds, or "none" or "max")
 196   ldif_wrap=<width>     (in columns, or "no" for no wrapping)
 197 .fi
 198
 199 .TP
 200 .BI \-O \ security-properties
 201 Specify SASL security properties.
 202 .TP
 203 .B \-I
 204 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 205 only as needed.
 206 .TP
 207 .B \-Q
 208 Enable SASL Quiet mode.  Never prompt.
 209 .TP
 210 .B \-N
 211 Do not use reverse DNS to canonicalize SASL host name.
 212 .TP
 213 .BI \-U \ authcid
 214 Specify the authentication ID for SASL bind. The form of the ID
 215 depends on the actual SASL mechanism used.
 216 .TP
 217 .BI \-R \ realm
 218 Specify the realm of authentication ID for SASL bind. The form of the realm
 219 depends on the actual SASL mechanism used.
 220 .TP
 221 .BI \-X \ authzid
 222 Specify the requested authorization ID for SASL bind.
 223 .I authzid
 224 must be one of the following formats:
 225 .BI dn: "<distinguished name>"
 226 or
 227 .BI u: <username>\fP.
 228 .TP
 229 .BI \-Y \ mech
 230 Specify the SASL mechanism to be used for authentication. If it's not
 231 specified, the program will choose the best mechanism the server knows.
 232 .TP
 233 .BR \-Z [ Z ]
 234 Issue StartTLS (Transport Layer Security) extended operation. If you use
 235 \fB\-ZZ\fP, the command will require the operation to be successful
 236 .SH SEE ALSO
 237 .BR ldap_sasl_bind (3),
 238 .BR ldap_extended_operation (3),
 239 .BR ldap_start_tls_s (3)
 240 .SH AUTHOR
 241 The OpenLDAP Project <http://www.openldap.org/>
 242 .SH ACKNOWLEDGEMENTS
 243 .so ../Project