git.sur5r.net Git - openldap/blob - doc/man/man3/ldap_bind.3

   1 .TH LDAP_BIND 3 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2014 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldap_bind, ldap_bind_s, ldap_simple_bind, ldap_simple_bind_s, ldap_sasl_bind, ldap_sasl_bind_s, ldap_sasl_interactive_bind_s, ldap_parse_sasl_bind_result, ldap_unbind, ldap_unbind_s, ldap_unbind_ext, ldap_unbind_ext_s, ldap_set_rebind_proc \- LDAP bind routines
   7 .SH LIBRARY
   8 OpenLDAP LDAP (libldap, \-lldap)
   9 .SH SYNOPSIS
  10 .nf
  11 .B #include <ldap.h>
  12 .LP
  13 .BI "int ldap_bind(LDAP *" ld ", const char *" who ", const char *" cred ","
  14 .RS
  15 .BI "int " method ");"
  16 .RE
  17 .LP
  18 .BI "int ldap_bind_s(LDAP *" ld ", const char *" who ", const char *" cred ","
  19 .RS
  20 .BI "int " method ");"
  21 .RE
  22 .LP
  23 .BI "int ldap_simple_bind(LDAP *" ld ", const char *" who ", const char *" passwd ");"
  24 .LP
  25 .BI "int ldap_simple_bind_s(LDAP *" ld ", const char *" who ", const char *" passwd ");"
  26 .LP
  27 .BI "int ldap_sasl_bind(LDAP *" ld ", const char *" dn ", const char *" mechanism ","
  28 .RS
  29 .BI "struct berval *" cred ", LDAPControl *" sctrls "[],"
  30 .BI "LDAPControl *" cctrls "[], int *" msgidp ");"
  31 .RE
  32 .LP
  33 .BI "int ldap_sasl_bind_s(LDAP *" ld ", const char *" dn ", const char *" mechanism ","
  34 .RS
  35 .BI "struct berval *" cred ", LDAPControl *" sctrls "[],"
  36 .BI "LDAPControl *" cctrls "[], struct berval **" servercredp ");"
  37 .RE
  38 .LP
  39 .BI "int ldap_parse_sasl_bind_result(LDAP *" ld ", LDAPMessage *" res ","
  40 .RS
  41 .BI "struct berval **" servercredp ", int " freeit ");"
  42 .RE
  43 .LP
  44 .BI "int ldap_sasl_interactive_bind_s(LDAP *" ld ", const char *" dn ","
  45 .RS
  46 .BI "const char *" mechs ","
  47 .BI "LDAPControl *" sctrls "[], LDAPControl *" cctrls "[],"
  48 .BI "unsigned " flags ", LDAP_SASL_INTERACT_PROC *" interact ","
  49 .BI "void *" defaults ");"
  50 .RE
  51 .LP
  52 .BI "int ldap_sasl_interactive_bind(LDAP *" ld ", const char *" dn ","
  53 .RS
  54 .BI "const char *" mechs ","
  55 .BI "LDAPControl *" sctrls "[], LDAPControl *" cctrls "[],"
  56 .BI "unsigned " flags ", LDAP_SASL_INTERACT_PROC *" interact ","
  57 .BI "void *" defaults ", LDAPMessage *" result ","
  58 .BI "const char **" rmechp ", int *" msgidp ");"
  59 .RE
  60 .LP
  61 .BI "int (LDAP_SASL_INTERACT_PROC)(LDAP *" ld ", unsigned " flags ", void *" defaults ", void *" sasl_interact ");"
  62 .LP
  63 .BI "int ldap_unbind(LDAP *" ld ");"
  64 .LP
  65 .BI "int ldap_unbind_s(LDAP *" ld ");"
  66 .LP
  67 .BI "int ldap_unbind_ext(LDAP *" ld ", LDAPControl *" sctrls "[],"
  68 .RS
  69 .BI "LDAPControl *" cctrls "[]);"
  70 .RE
  71 .LP
  72 .BI "int ldap_unbind_ext_s(LDAP *" ld ", LDAPControl *" sctrls "[],"
  73 .RS
  74 .BI "LDAPControl *" cctrls "[]);"
  75 .RE
  76 .LP
  77 .BI "int ldap_set_rebind_proc (LDAP *" ld ", LDAP_REBIND_PROC *" ldap_proc ", void *" params ");"
  78 .LP
  79 .BI "int (LDAP_REBIND_PROC)(LDAP *" ld ", LDAP_CONST char *" url ", ber_tag_t " request ", ber_int_t " msgid ", void *" params ");"
  80 .SH DESCRIPTION
  81 .LP
  82 These routines provide various interfaces to the LDAP bind operation.
  83 After an association with an LDAP server is made using
  84 .BR ldap_init (3),
  85 an LDAP bind operation should be performed before other operations are
  86 attempted over the connection.  An LDAP bind is required when using
  87 Version 2 of the LDAP protocol; it is optional for Version 3 but is
  88 usually needed due to security considerations.
  89 .LP
  90 There are three types of bind calls, ones providing simple authentication,
  91 ones providing SASL authentication, and general routines capable of doing
  92 either simple or SASL authentication.
  93 .LP
  94 .B SASL
  95 (Simple Authentication and Security Layer)
  96 can negotiate one of many different kinds of authentication.
  97 Both synchronous and asynchronous versions of each variant of the bind
  98 call are provided.  All routines
  99 take \fIld\fP as their first parameter, as returned from
 100 .BR ldap_init (3).
 101 .SH SIMPLE AUTHENTICATION
 102 The simplest form of the bind call is
 103 .BR ldap_simple_bind_s() .
 104 It takes the DN to bind as in \fIwho\fP, and the userPassword associated
 105 with the entry in \fIpasswd\fP.  It returns an LDAP error indication
 106 (see
 107 .BR ldap_error (3)).
 108 The
 109 .B ldap_simple_bind()
 110 call is asynchronous,
 111 taking the same parameters but only initiating the bind operation and
 112 returning the message id of the request it sent.  The result of the
 113 operation can be obtained by a subsequent call to
 114 .BR ldap_result (3).
 115 .SH GENERAL AUTHENTICATION
 116 The
 117 .B ldap_bind()
 118 and
 119 .B ldap_bind_s()
 120 routines can be used when the
 121 authentication method to use needs to be selected at runtime.  They
 122 both take an extra \fImethod\fP parameter selecting the authentication
 123 method to use.  It should be set to LDAP_AUTH_SIMPLE
 124 to select simple authentication.
 125 .B ldap_bind()
 126 returns the message id of the request it initiates.
 127 .B ldap_bind_s()
 128 returns an LDAP error indication.
 129 .SH SASL AUTHENTICATION
 130 For SASL binds the server always ignores any provided DN, so the
 131 .I dn
 132 parameter should always be NULL.
 133 .BR ldap_sasl_bind_s ()
 134 sends a single SASL bind request with the given SASL
 135 .I mechanism
 136 and credentials in the
 137 .I cred
 138 parameter. The format of the credentials depends on the particular
 139 SASL mechanism in use. For mechanisms that provide mutual authentication
 140 the server's credentials will be returned in the
 141 .I servercredp
 142 parameter.
 143 The routine returns an LDAP error indication (see
 144 .BR ldap_error (3)).
 145 The
 146 .BR ldap_sasl_bind ()
 147 call is asynchronous, taking the same parameters but only sending the
 148 request and returning the message id of the request it sent. The result of
 149 the operation can be obtained by a subsequent
 150 call to
 151 .BR ldap_result (3).
 152 The result must be additionally parsed by
 153 .BR ldap_parse_sasl_bind_result ()
 154 to obtain any server credentials sent from the server.
 155 .LP
 156 Many SASL mechanisms require multiple message exchanges to perform a
 157 complete authentication. Applications should generally use
 158 .BR ldap_sasl_interactive_bind_s ()
 159 rather than calling the basic
 160 .BR ldap_sasl_bind ()
 161 functions directly. The
 162 .I mechs
 163 parameter should contain a space-separated list of candidate mechanisms
 164 to use. If this parameter is NULL or empty the library will query
 165 the supportedSASLMechanisms attribute from the server's rootDSE
 166 for the list of SASL mechanisms the server supports. The
 167 .I flags
 168 parameter controls the interaction used to retrieve any necessary
 169 SASL authentication parameters and should be one of:
 170 .TP
 171 LDAP_SASL_AUTOMATIC
 172 use defaults if available, prompt otherwise
 173 .TP
 174 LDAP_SASL_INTERACTIVE
 175 always prompt
 176 .TP
 177 LDAP_SASL_QUIET
 178 never prompt
 179 .LP
 180 The
 181 .I interact
 182 function uses the provided
 183 .I defaults
 184 to handle requests from the SASL library for particular authentication
 185 parameters. There is no defined format for the
 186 .I defaults
 187 information;
 188 it is up to the caller to use whatever format is appropriate for the
 189 supplied
 190 .I interact
 191 function.
 192 The
 193 .I sasl_interact
 194 parameter comes from the underlying SASL library. When used with Cyrus SASL
 195 this is an array of
 196 .B sasl_interact_t
 197 structures. The Cyrus SASL library will prompt for a variety of inputs,
 198 including:
 199 .TP
 200 SASL_CB_GETREALM
 201 the realm for the authentication attempt
 202 .TP
 203 SASL_CB_AUTHNAME
 204 the username to authenticate
 205 .TP
 206 SASL_CB_PASS
 207 the password for the provided username
 208 .TP
 209 SASL_CB_USER
 210 the username to use for proxy authorization
 211 .TP
 212 SASL_CB_NOECHOPROMPT
 213 generic prompt for input with input echoing disabled
 214 .TP
 215 SASL_CB_ECHOPROMPT
 216 generic prompt for input with input echoing enabled
 217 .TP
 218 SASL_CB_LIST_END
 219 indicates the end of the array of prompts
 220 .LP
 221 See the Cyrus SASL documentation for more details.
 222 .LP
 223 Applications which need to manage connections asynchronously may use
 224 .BR ldap_sasl_interactive_bind ()
 225 instead of the synchronous version.
 226 A valid mechs parameter must be supplied, otherwise the library will
 227 be forced to query the server for a list of supported mechanisms,
 228 and this query will be performed synchronously.
 229 The other parameters are the same as
 230 for the synchronous function, with three additional parameters.
 231 The actual SASL mechanism that was used, and the message ID for use
 232 with
 233 .BR ldap_result ()
 234 will be returned in rmechp and msgidp, respectively.
 235 The value in rmechp must not be modified by the caller and must be
 236 passed back on each subsequent call. The message obtained from
 237 .BR ldap_result ()
 238 must be passed in the result parameter.
 239 This parameter must be NULL when initiating a new Bind. The caller
 240 must free the result message after each call using
 241 .BR ldap_msgfree ().
 242 The
 243 .BR ldap_sasl_interactive_bind ()
 244 function returns an LDAP result code. If the code is
 245 LDAP_SASL_BIND_IN_PROGRESS then the Bind is not complete yet, and
 246 this function must be called again with the next result from the server.
 247 .SH REBINDING
 248 .LP
 249 The
 250 .B ldap_set_rebind_proc
 251 function() sets the process to use for binding when an operation returns a
 252 referral. This function is used when an application needs to bind to another server
 253 in order to follow a referral or search continuation reference.
 254 .LP
 255 The function takes \fIld\fP, the \fIrebind\fP function, and the \fIparams\fP,
 256 the arbitrary data like state information which the client might need to properly rebind.
 257 The LDAP_OPT_REFERRALS option in the \fIld\fP must be set to ON for the libraries
 258 to use the rebind function. Use the
 259 .BR ldap_set_option
 260 function to set the value.
 261 .LP
 262 The rebind function parameters are as follows:
 263 .LP
 264 The \fIld\fP parameter must be used by the application when binding to the
 265 referred server if the application wants the libraries to follow the referral.
 266 .LP
 267 The \fIurl\fP parameter points to the URL referral string received from the LDAP server.
 268 The LDAP application can use the
 269 .BR ldap_url_parse (3)
 270 function to parse the string into its components.
 271 .LP
 272 The \fIrequest\fP parameter specifies the type of request that generated the referral.
 273 .LP
 274 The \fImsgid\fP parameter specifies the message ID of the request generating the referral.
 275 .LP
 276 The \fIparams\fP parameter is the same value as passed originally to the
 277 .BR ldap_set_rebind_proc ()
 278 function.
 279 .LP
 280 The LDAP libraries set all the parameters when they call the rebind function. The application
 281 should not attempt to free either the ld or the url structures in the rebind function.
 282 .LP
 283 The application must supply to the rebind function the required authentication information such as,
 284 user name, password, and certificates. The rebind function must use a synchronous bind method.
 285 .SH UNBINDING
 286 The
 287 .B ldap_unbind()
 288 call is used to unbind from the directory,
 289 terminate the current association, and free the resources contained
 290 in the \fIld\fP structure.  Once it is called, the connection to
 291 the LDAP server is closed, and the \fIld\fP structure is invalid.
 292 The
 293 .B ldap_unbind_s()
 294 call is just another name for
 295 .BR ldap_unbind() ;
 296 both of these calls are synchronous in nature.
 297 .LP
 298 The
 299 .B ldap_unbind_ext()
 300 and
 301 .B ldap_unbind_ext_s()
 302 allows the operations to specify  controls.
 303 .SH ERRORS
 304 Asynchronous routines will return \-1 in case of error, setting the
 305 \fIld_errno\fP parameter of the \fIld\fP structure.  Synchronous
 306 routines return whatever \fIld_errno\fP is set to.  See
 307 .BR ldap_error (3)
 308 for more information.
 309 .SH NOTES
 310 If an anonymous bind is sufficient for the application, the rebind process
 311 need not be provided. The LDAP libraries with the LDAP_OPT_REFERRALS option
 312 set to ON (default value) will automatically follow referrals using an anonymous bind.
 313 .LP
 314 If the application needs stronger authentication than an anonymous bind,
 315 you need to provide a rebind process for that authentication method.
 316 The bind method must be synchronous.
 317 .SH SEE ALSO
 318 .BR ldap (3),
 319 .BR ldap_error (3),
 320 .BR ldap_open (3),
 321 .BR ldap_set_option (3),
 322 .BR ldap_url_parse (3)
 323 .B RFC 4422
 324 (http://www.rfc-editor.org),
 325 .B Cyrus SASL
 326 (http://asg.web.cmu.edu/sasl/)
 327 .SH ACKNOWLEDGEMENTS
 328 .so ../Project