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

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