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

   1 .TH LDAPWHOAMI 1 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldapwhoami \- LDAP who am i? tool
   7 .SH SYNOPSIS
   8 .B ldapwhoami
   9 [\c
  10 .BR \-n ]
  11 [\c
  12 .BR \-v ]
  13 [\c
  14 .BR \-z ]
  15 [\c
  16 .BI \-d \ debuglevel\fR]
  17 [\c
  18 .BI \-D \ binddn\fR]
  19 [\c
  20 .BR \-W ]
  21 [\c
  22 .BI \-w \ passwd\fR]
  23 [\c
  24 .BI \-y \ passwdfile\fR]
  25 [\c
  26 .BI \-H \ ldapuri\fR]
  27 [\c
  28 .BI \-h \ ldaphost\fR]
  29 [\c
  30 .BI \-p \ ldapport\fR]
  31 [\c
  32 .BR \-O \ security-properties ]
  33 [\c
  34 .BR \-I ]
  35 [\c
  36 .BR \-Q ]
  37 [\c
  38 .BI \-U \ authcid\fR]
  39 [\c
  40 .BR \-x ]
  41 [\c
  42 .BI \-X \ authzid\fR]
  43 [\c
  44 .BI \-Y \ mech\fR]
  45 [\c
  46 .BR \-Z[Z] ]
  47 .SH DESCRIPTION
  48 .I ldapwhoami
  49 implements the LDAP "Who Am I?" extended operation.
  50 .LP
  51 .B ldapwhoami
  52 opens a connection to an LDAP server, binds, and performs a whoami
  53 operation.
  54 .SH OPTIONS
  55 .TP
  56 .B \-n
  57 Show what would be done, but don't actually perform the whoami operation.
  58 Useful for
  59 debugging in conjunction with -v.
  60 .TP
  61 .B \-v
  62 Run in verbose mode, with many diagnostics written to standard output.
  63 .TP
  64 .BI \-d \ debuglevel
  65 Set the LDAP debugging level to \fIdebuglevel\fP.
  66 .B ldapcompare
  67 must be compiled with LDAP_DEBUG defined for this option to have any effect.
  68 .TP
  69 .B \-x
  70 Use simple authentication instead of SASL.
  71 .TP
  72 .BI \-D \ binddn
  73 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
  74 .TP
  75 .B \-W
  76 Prompt for simple authentication.
  77 This is used instead of specifying the password on the command line.
  78 .TP
  79 .BI \-w \ passwd
  80 Use \fIpasswd\fP as the password for simple authentication.
  81 .TP
  82 .BI \-y \ passwdfile
  83 Use complete contents of \fIpasswdfile\fP as the password for
  84 simple authentication.
  85 .TP
  86 .BI \-H \ ldapuri
  87 Specify URI(s) referring to the ldap server(s).
  88 .TP
  89 .BI \-h \ ldaphost
  90 Specify an alternate host on which the ldap server is running.
  91 Deprecated in favor of -H.
  92 .TP
  93 .BI \-p \ ldapport
  94 Specify an alternate TCP port where the ldap server is listening.
  95 Deprecated in favor of -H.
  96 .TP
  97 .BI \-P \ 2\fR\||\|\fI3
  98 Specify the LDAP protocol version to use.
  99 .TP
 100 .BI \-O \ security-properties
 101 Specify SASL security properties.
 102 .TP
 103 .B \-I
 104 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 105 only as needed.
 106 .TP
 107 .B \-Q
 108 Enable SASL Quiet mode.  Never prompt.
 109 .TP
 110 .BI \-U \ authcid
 111 Specify the authentication ID for SASL bind. The form of the ID
 112 depends on the actual SASL mechanism used.
 113 .TP
 114 .BI \-X \ authzid
 115 Specify the requested authorization ID for SASL bind.
 116 .I authzid
 117 must be one of the following formats:
 118 .B dn:\c
 119 .I <distinguished name>
 120 or
 121 .B u:\c
 122 .I <username>
 123 .TP
 124 .BI \-Y \ mech
 125 Specify the SASL mechanism to be used for authentication. If it's not
 126 specified, the program will choose the best mechanism the server knows.
 127 .TP
 128 .B \-Z[Z]
 129 Issue StartTLS (Transport Layer Security) extended operation. If you use
 130 .B \-ZZ\c
 131 , the command will require the operation to be successful.
 132 .SH EXAMPLE
 133 .nf
 134     ldapwhoami -x -D "cn=Manager,dc=example,dc=com" -W
 135 .fi
 136 .SH "SEE ALSO"
 137 .BR ldap.conf (5),
 138 .BR ldap (3),
 139 .BR ldap_extended_s (3)
 140 .SH AUTHOR
 141 The OpenLDAP Project <http://www.openldap.org/>
 142 .SH ACKNOWLEDGEMENTS
 143 .B      OpenLDAP
 144 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 145 .B      OpenLDAP
 146 is derived from University of Michigan LDAP 3.3 Release.