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

   1 .TH LDAPWHOAMI 1 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2016 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 \-V [ V ]]
  11 [\c
  12 .BI \-d \ debuglevel\fR]
  13 [\c
  14 .BR \-n ]
  15 [\c
  16 .BR \-v ]
  17 [\c
  18 .BR \-x ]
  19 [\c
  20 .BI \-D \ binddn\fR]
  21 [\c
  22 .BR \-W ]
  23 [\c
  24 .BI \-w \ passwd\fR]
  25 [\c
  26 .BI \-y \ passwdfile\fR]
  27 [\c
  28 .BI \-H \ ldapuri\fR]
  29 [\c
  30 .BI \-h \ ldaphost\fR]
  31 [\c
  32 .BI \-p \ ldapport\fR]
  33 [\c
  34 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
  35 [\c
  36 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
  37 [\c
  38 .BI \-o \ opt \fR[= optparam \fR]]
  39 [\c
  40 .BI \-O \ security-properties\fR]
  41 [\c
  42 .BR \-I ]
  43 [\c
  44 .BR \-Q ]
  45 [\c
  46 .BR \-N ]
  47 [\c
  48 .BI \-U \ authcid\fR]
  49 [\c
  50 .BI \-R \ realm\fR]
  51 [\c
  52 .BI \-X \ authzid\fR]
  53 [\c
  54 .BI \-Y \ mech\fR]
  55 [\c
  56 .BR \-Z [ Z ]]
  57 .SH DESCRIPTION
  58 .I ldapwhoami
  59 implements the LDAP "Who Am I?" extended operation.
  60 .LP
  61 .B ldapwhoami
  62 opens a connection to an LDAP server, binds, and performs a whoami
  63 operation.
  64 .SH OPTIONS
  65 .TP
  66 .BR \-V [ V ]
  67 Print version info.
  68 If \fB\-VV\fP is given, only the version information is printed.
  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 \-n
  76 Show what would be done, but don't actually perform the whoami operation.
  77 Useful for
  78 debugging in conjunction with \fB\-v\fP.
  79 .TP
  80 .B \-v
  81 Run in verbose mode, with many diagnostics written to standard output.
  82 .TP
  83 .B \-x
  84 Use simple authentication instead of SASL.
  85 .TP
  86 .BI \-D \ binddn
  87 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
  88 For SASL binds, the server is expected to ignore this value.
  89 .TP
  90 .B \-W
  91 Prompt for simple authentication.
  92 This is used instead of specifying the password on the command line.
  93 .TP
  94 .BI \-w \ passwd
  95 Use \fIpasswd\fP as the password for simple authentication.
  96 .TP
  97 .BI \-y \ passwdfile
  98 Use complete contents of \fIpasswdfile\fP as the password for
  99 simple authentication.
 100 .TP
 101 .BI \-H \ ldapuri
 102 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
 103 fields are allowed; a list of URI, separated by whitespace or commas
 104 is expected.
 105 .TP
 106 .BI \-h \ ldaphost
 107 Specify an alternate host on which the ldap server is running.
 108 Deprecated in favor of \fB\-H\fP.
 109 .TP
 110 .BI \-p \ ldapport
 111 Specify an alternate TCP port where the ldap server is listening.
 112 Deprecated in favor of \fB\-H\fP.
 113 .TP
 114 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
 115 .TP
 116 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
 117
 118 Specify general extensions with \fB\-e\fP and whoami extensions with \fB\-E\fP.
 119 \'\fB!\fP\' indicates criticality.
 120
 121 General extensions:
 122 .nf
 123   [!]assert=<filter>    (an RFC 4515 Filter)
 124   !authzid=<authzid>    ("dn:<dn>" or "u:<user>")
 125   [!]bauthzid           (RFC 3829 authzid control)
 126   [!]chaining[=<resolve>[/<cont>]]
 127   [!]manageDSAit
 128   [!]noop
 129   ppolicy
 130   [!]postread[=<attrs>] (a comma-separated attribute list)
 131   [!]preread[=<attrs>]  (a comma-separated attribute list)
 132   [!]relax
 133   sessiontracking[=<username>]
 134   abandon,cancel,ignore (SIGINT sends abandon/cancel,
 135   or ignores response; if critical, doesn't wait for SIGINT.
 136   not really controls)
 137 .fi
 138
 139 WhoAmI extensions:
 140 .nf
 141   (none)
 142 .fi
 143 .TP
 144 .BI \-o \ opt \fR[= optparam \fR]
 145
 146 Specify general options.
 147
 148 General options:
 149 .nf
 150   nettimeout=<timeout>  (in seconds, or "none" or "max")
 151   ldif-wrap=<width>     (in columns, or "no" for no wrapping)
 152 .fi
 153 .TP
 154 .BI \-O \ security-properties
 155 Specify SASL security properties.
 156 .TP
 157 .B \-I
 158 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 159 only as needed.
 160 .TP
 161 .B \-Q
 162 Enable SASL Quiet mode.  Never prompt.
 163 .TP
 164 .B \-N
 165 Do not use reverse DNS to canonicalize SASL host name.
 166 .TP
 167 .BI \-U \ authcid
 168 Specify the authentication ID for SASL bind. The form of the ID
 169 depends on the actual SASL mechanism used.
 170 .TP
 171 .BI \-R \ realm
 172 Specify the realm of authentication ID for SASL bind. The form of the realm
 173 depends on the actual SASL mechanism used.
 174 .TP
 175 .BI \-X \ authzid
 176 Specify the requested authorization ID for SASL bind.
 177 .I authzid
 178 must be one of the following formats:
 179 .BI dn: "<distinguished name>"
 180 or
 181 .BI u: <username>
 182 .TP
 183 .BI \-Y \ mech
 184 Specify the SASL mechanism to be used for authentication. If it's not
 185 specified, the program will choose the best mechanism the server knows.
 186 .TP
 187 .BR \-Z [ Z ]
 188 Issue StartTLS (Transport Layer Security) extended operation. If you use
 189 \fB\-ZZ\fP, the command will require the operation to be successful.
 190 .SH EXAMPLE
 191 .nf
 192     ldapwhoami \-x \-D "cn=Manager,dc=example,dc=com" \-W
 193 .fi
 194 .SH "SEE ALSO"
 195 .BR ldap.conf (5),
 196 .BR ldap (3),
 197 .BR ldap_extended_operation (3)
 198 .SH AUTHOR
 199 The OpenLDAP Project <http://www.openldap.org/>
 200 .SH ACKNOWLEDGEMENTS
 201 .so ../Project