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

   1 .TH LDAPWHOAMI 1 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2009 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 \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
  33 [\c
  34 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
  35 [\c
  36 .BI \-O \ security-properties\fR]
  37 [\c
  38 .BR \-I ]
  39 [\c
  40 .BR \-Q ]
  41 [\c
  42 .BI \-U \ authcid\fR]
  43 [\c
  44 .BI \-R \ realm\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 .SH DESCRIPTION
  54 .I ldapwhoami
  55 implements the LDAP "Who Am I?" extended operation.
  56 .LP
  57 .B ldapwhoami
  58 opens a connection to an LDAP server, binds, and performs a whoami
  59 operation.
  60 .SH OPTIONS
  61 .TP
  62 .B \-n
  63 Show what would be done, but don't actually perform the whoami operation.
  64 Useful for
  65 debugging in conjunction with \fB\-v\fP.
  66 .TP
  67 .B \-v
  68 Run in verbose mode, with many diagnostics written to standard output.
  69 .TP
  70 .BI \-d \ debuglevel
  71 Set the LDAP debugging level to \fIdebuglevel\fP.
  72 .B ldapwhoami
  73 must be compiled with LDAP_DEBUG defined for this option to have any effect.
  74 .TP
  75 .B \-x
  76 Use simple authentication instead of SASL.
  77 .TP
  78 .BI \-D \ binddn
  79 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
  80 For SASL binds, the server is expected to ignore this value.
  81 .TP
  82 .B \-W
  83 Prompt for simple authentication.
  84 This is used instead of specifying the password on the command line.
  85 .TP
  86 .BI \-w \ passwd
  87 Use \fIpasswd\fP as the password for simple authentication.
  88 .TP
  89 .BI \-y \ passwdfile
  90 Use complete contents of \fIpasswdfile\fP as the password for
  91 simple authentication.
  92 .TP
  93 .BI \-H \ ldapuri
  94 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
  95 fields are allowed; a list of URI, separated by whitespace or commas
  96 is expected.
  97 .TP
  98 .BI \-h \ ldaphost
  99 Specify an alternate host on which the ldap server is running.
 100 Deprecated in favor of \fB\-H\fP.
 101 .TP
 102 .BI \-p \ ldapport
 103 Specify an alternate TCP port where the ldap server is listening.
 104 Deprecated in favor of \fB\-H\fP.
 105 .TP
 106 .BI \-O \ security-properties
 107 Specify SASL security properties.
 108 .TP
 109 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
 110 .TP
 111 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
 112
 113 Specify general extensions with \fB\-e\fP and search extensions with \fB\-E\fP.
 114 \'\fB!\fP\' indicates criticality.
 115
 116 General extensions:
 117 .nf
 118   [!]assert=<filter>   (an RFC 4515 Filter)
 119   [!]authzid=<authzid> ("dn:<dn>" or "u:<user>")
 120   [!]manageDSAit
 121   [!]noop
 122   ppolicy
 123   [!]postread[=<attrs>]        (a comma-separated attribute list)
 124   [!]preread[=<attrs>] (a comma-separated attribute list)
 125   abandon, cancel (SIGINT sends abandon/cancel; not really controls)
 126 .fi
 127
 128 Search extensions:
 129 .nf
 130   [!]domainScope                               (domain scope)
 131   [!]mv=<filter>                               (matched values filter)
 132   [!]pr=<size>[/prompt|noprompt]       (paged results/prompt)
 133   [!]sss=[\-]<attr[:OID]>[/[\-]<attr[:OID]>...]  (server side sorting)
 134   [!]subentries[=true|false]           (subentries)
 135   [!]sync=ro[/<cookie>]                        (LDAP Sync refreshOnly)
 136           rp[/<cookie>][/<slimit>]     (LDAP Sync refreshAndPersist)
 137 .fi
 138 .TP
 139 .B \-I
 140 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 141 only as needed.
 142 .TP
 143 .B \-Q
 144 Enable SASL Quiet mode.  Never prompt.
 145 .TP
 146 .BI \-U \ authcid
 147 Specify the authentication ID for SASL bind. The form of the ID
 148 depends on the actual SASL mechanism used.
 149 .TP
 150 .BI \-R \ realm
 151 Specify the realm of authentication ID for SASL bind. The form of the realm
 152 depends on the actual SASL mechanism used.
 153 .TP
 154 .BI \-X \ authzid
 155 Specify the requested authorization ID for SASL bind.
 156 .I authzid
 157 must be one of the following formats:
 158 .BI dn: "<distinguished name>"
 159 or
 160 .BI u: <username>
 161 .TP
 162 .BI \-Y \ mech
 163 Specify the SASL mechanism to be used for authentication. If it's not
 164 specified, the program will choose the best mechanism the server knows.
 165 .TP
 166 .BR \-Z [ Z ]
 167 Issue StartTLS (Transport Layer Security) extended operation. If you use
 168 \fB\-ZZ\fP, the command will require the operation to be successful.
 169 .SH EXAMPLE
 170 .nf
 171     ldapwhoami \-x \-D "cn=Manager,dc=example,dc=com" \-W
 172 .fi
 173 .SH "SEE ALSO"
 174 .BR ldap.conf (5),
 175 .BR ldap (3),
 176 .BR ldap_extended_operation (3)
 177 .SH AUTHOR
 178 The OpenLDAP Project <http://www.openldap.org/>
 179 .SH ACKNOWLEDGEMENTS
 180 .so ../Project