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

   1 .TH LDAPPASSWD 1 "5 December 1998" "LDAPPasswd"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-1999 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 .BI \-D \ binddn\fR
  14 [\c
  15 .BI \-d \ debuglevel\fR]
  16 [\c
  17 .BI \-h \ ldaphost\fR]
  18 [\c
  19 .BR \-n ]
  20 [\c
  21 .BI \-p \ ldapport\fR]
  22 [\c
  23 .BR \-S ]
  24 [\c
  25 .BI \-s \ newPasswd\fR]
  26 [\c
  27 .BR \-v ]
  28 [\c
  29 .BR \-W ]
  30 [\c
  31 .BI \-w \ passwd\fR]
  32 [\c
  33 .BR \-E[E] ]
  34 [\c
  35 .BR \-I[I] ]
  36 [\c
  37 .BI \-U \ username\fR]
  38 [\c
  39 .BI \-X \ authzid\fR]
  40 [\c
  41 .BI \-Y \ mech\fR]
  42 [\c
  43 .BR \-Z[Z] ]
  44 .SH DESCRIPTION
  45 .B ldappasswd
  46 is a tool to set the password of an LDAP user.
  47 It is neither designed nor intended to be a replacement for
  48 .BR passwd (1)
  49 and should not be installed as such.
  50 .LP
  51 .B ldappasswd
  52 sets the password of associated with the user.  If the new
  53 password is not specified on the command line or the user
  54 doesn't enable prompting, the server will be asked to generate
  55 a password for the user.
  56 .SH OPTIONS
  57 .TP
  58 .BI \-A
  59 Prompt for old password.
  60 This is used instead of specifying the password on the command line.
  61 .TP
  62 .BI \-a \ oldPasswd
  63 Set the old password to \fIoldPasswd\fP.
  64 .TP
  65 .BI \-D \ binddn
  66 Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should
  67 be a string-represented DN as defined in RFC 2253.
  68 This flag is not optional.  The user DN will be used if the
  69 bind DN is not provided.
  70 .TP
  71 .BI \-d \ debuglevel
  72 Set the LDAP debugging level to \fIdebuglevel\fP.
  73 .B ldappasswd
  74 must be compiled with LDAP_DEBUG defined for this option to have any effect.
  75 .TP
  76 .BI \-h \ ldaphost
  77 Specify an alternate host on which the ldap server is running.
  78 .TP
  79 .B \-n
  80 Do not set password. (Can be useful when used in conjunction with
  81 .BR \-v \ or
  82 .BR \-d )
  83 .TP
  84 .BI \-S
  85 Prompt for new password.
  86 This is used instead of specifying the password on the command line.
  87 .TP
  88 .BI \-s \ newPasswd
  89 Set the new password to \fInewPasswd\fP.
  90 .TP
  91 .BI \-p \ ldapport
  92 Specify an alternate port on which the ldap server is running.
  93 .TP
  94 .B \-v
  95 Increase the verbosity of output.  Can be specified multiple times.
  96 .TP
  97 .BI \-W
  98 Prompt for bind password.
  99 This is used instead of specifying the password on the command line.
 100 .TP
 101 .BI \-w \ passwd
 102 Use \fIpasswd\fP as the password to bind with.
 103 .TP
 104 .B \-E[E]
 105 Requset the use of SASL privacy (encryption). If the server allows it, data
 106 sent between the client and the server will be encrypted. If the server
 107 requires the use of encryption and this flag is not specified, the command
 108 will fail. If you use
 109 .B \-EE\c
 110 , the command will fail if the server does not support encryption.
 111 .B \-E[E]
 112 implies
 113 .B \-I[I]
 114 .TP
 115 .B \-I[I]
 116 Request the use of SASL integrity checking. It protects data sent between the
 117 client and the server from being modified along the way, but it does not
 118 prevent sniffing. If the server requires the use of integrity checking and
 119 this flag is not specified, the command will fail.If you use
 120 .B \-II\c
 121 , the command will fail if the server does not support this function.
 122 .TP
 123 .BI \-U \ username
 124 Specify the username for SASL bind. The syntax of the username depends on the
 125 actual SASL mechanism used.
 126 .TP
 127 .BI \-X \ authzid
 128 Specify the requested authorization ID for SASL bind.
 129 .I authzid
 130 must be one of the following formats:
 131 .B dn:\c
 132 .I <distinguished name>
 133 or
 134 .B u:\c
 135 .I <username>
 136 .TP
 137 .BI \-Y \ mech
 138 Specify the SASL mechanism to be used for authentication. If it's not
 139 specified, the program will choose the best mechanism the server knows.
 140 .TP
 141 .B \-Z[Z]
 142 Request the use of TLS (Transport Layer Security). If you use
 143 .B \-ZZ\c
 144 , the command will fail if TLS negotiation does not succeed for some reason.
 145 .SH SEE ALSO
 146 .BR ldap_bind (3)
 147 .SH ACKNOWLEDGEMENTS
 148 .B      OpenLDAP
 149 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 150 .B      OpenLDAP
 151 is derived from University of Michigan LDAP 3.3 Release.