external/bsd/openldap/man/ldapwhoami.1

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