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

   1 .TH LDAPPASSWD 1 "20 August 2001" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2000 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 .BR \-C ]
  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 .BR \-v ]
  33 [\c
  34 .BR \-W ]
  35 [\c
  36 .BI \-w \ passwd\fR]
  37 [\c
  38 .BR \-O \ security-properties ]
  39 [\c
  40 .BR \-I ]
  41 [\c
  42 .BR \-Q ]
  43 [\c
  44 .BI \-U \ authcid\fR]
  45 [\c
  46 .BR \-x ]
  47 [\c
  48 .BI \-X \ authzid\fR]
  49 [\c
  50 .BI \-Y \ mech\fR]
  51 [\c
  52 .BR \-Z[Z] ]
  53 [\c
  54 .IR user ]
  55 .SH DESCRIPTION
  56 .B ldappasswd
  57 is a tool to set the password of an LDAP user.
  58 .B ldappasswd
  59 uses the LDAPv3 Password Modify (RFC 3062) extended operation.
  60 .LP
  61 .B ldappasswd
  62 sets the password of associated with the user [or an optionally
  63 specified
  64 .IR user ].
  65 If the new
  66 password is not specified on the command line and the user
  67 doesn't enable prompting, the server will be asked to generate
  68 a password for the user.
  69 .LP
  70 .B ldappasswd
  71 is neither designed nor intended to be a replacement for
  72 .BR passwd (1)
  73 and should not be installed as such.
  74 .SH OPTIONS
  75 .TP
  76 .BI \-A
  77 Prompt for old password.
  78 This is used instead of specifying the password on the command line.
  79 .TP
  80 .BI \-a \ oldPasswd
  81 Set the old password to \fIoldPasswd\fP.
  82 .TP
  83 .B \-C
  84 Automatically chase referrals.
  85 .TP
  86 .B \-x
  87 Use simple authentication instead of SASL.
  88 .TP
  89 .BI \-D \ binddn
  90 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
  91 .TP
  92 .BI \-d \ debuglevel
  93 Set the LDAP debugging level to \fIdebuglevel\fP.
  94 .B ldappasswd
  95 must be compiled with LDAP_DEBUG defined for this option to have any effect.
  96 .TP
  97 .BI \-H \ ldapuri
  98 Specify URI(s) referring to the ldap server(s).
  99 .TP
 100 .BI \-h \ ldaphost
 101 Specify an alternate host on which the ldap server is running.
 102 Deprecated in favor of -H.
 103 .TP
 104 .BI \-p \ ldapport
 105 Specify an alternate TCP port where the ldap server is listening.
 106 Deprecated in favor of -H.
 107 .TP
 108 .B \-n
 109 Do not set password. (Can be useful when used in conjunction with
 110 .BR \-v \ or
 111 .BR \-d )
 112 .TP
 113 .BI \-S
 114 Prompt for new password.
 115 This is used instead of specifying the password on the command line.
 116 .TP
 117 .BI \-s \ newPasswd
 118 Set the new password to \fInewPasswd\fP.
 119 .TP
 120 .B \-v
 121 Increase the verbosity of output.  Can be specified multiple times.
 122 .TP
 123 .BI \-W
 124 Prompt for bind password.
 125 This is used instead of specifying the password on the command line.
 126 .TP
 127 .BI \-w \ passwd
 128 Use \fIpasswd\fP as the password to bind with.
 129 .TP
 130 .BI \-O \ security-properties
 131 Specify SASL security properties.
 132 .TP
 133 .B \-I
 134 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 135 only as needed.
 136 .TP
 137 .B \-Q
 138 Enable SASL Quiet mode.  Never prompt.
 139 .TP
 140 .BI \-U \ authcid
 141 Specify the authentication ID for SASL bind. The form of the ID
 142 depends on the actual SASL mechanism used.
 143 .TP
 144 .BI \-X \ authzid
 145 Specify the requested authorization ID for SASL bind.
 146 .I authzid
 147 must be one of the following formats:
 148 .BI dn: <distinguished name>
 149 or
 150 .BI u: <username>\fP.
 151 .TP
 152 .BI \-Y \ mech
 153 Specify the SASL mechanism to be used for authentication. If it's not
 154 specified, the program will choose the best mechanism the server knows.
 155 .TP
 156 .B \-Z[Z]
 157 Issue StartTLS (Transport Layer Security) extended operation. If you use
 158 .BR \-ZZ ,
 159 the command will require the operation to be successful
 160 .SH SEE ALSO
 161 .BR ldap_sasl_bind (3)
 162 .BR ldap_extended_operation (3)
 163 .BR ldap_start_tls_s (3)
 164 .SH AUTHOR
 165 The OpenLDAP Project <http://www.openldap.org/>
 166 .SH ACKNOWLEDGEMENTS
 167 .B      OpenLDAP
 168 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 169 .B      OpenLDAP
 170 is derived from University of Michigan LDAP 3.3 Release.