1ldap_get_option(3LDAP) LDAP Library Functions ldap_get_option(3LDAP)
2
6 ldap_get_option, ldap_set_option - get or set session preferences in
7 the ldap structure.
8
10 cc [ flag... ] file... -lldap [ library... ]
11 #include <lber.h>
12 #include <ldap.h>
13 LDAP ldap_set_option(LDAP *ld, int option, void *optdata[]);
15 LDAP ldap_get_option(LDAP *ld, int option, void optdata[]);
18
21 These functions provide an LDAP structure with access to session pref‐
22 erences. The ldap_get_option() function gets session preferences from
23 the LDAP structure. The ldap_set_option() function sets session prefer‐
24 ences in the LDAP structure.
25 The ld parameter specifies the connection handle, a pointer to an LDAP
28 structure that contains information about the LDAP server connection.
29 The option parameter specifies the name of the option to be read or
30 modified. The optdata parameter serves as a pointer to the value of the
31 option that you set or get.
32
34 The following values can be specified for the option parameter:
35 LDAP_OPT_API_INFO
37 Retrieves basic information about the LDAP API implementation at
39 execution time. The data type for the optdata parameter is (LDAPA‐
40 PIInfo *). This option is READ-ONLY and cannot be set.
41 LDAP_OPT_DEREF
44 Determines how aliases are handled during a search. The data type
46 for the optdata parameter is (int *). The following values can be
47 specified for the optdata parameter:
48 LDAP_DEREF_NEVER Specifies that aliases are never derefer‐
50 enced.
51 LDAP_DEREF_SEARCHING Specifies that aliases are dereferenced
54 when searching under the base object, but
55 not when finding the base object.
56 LDAP_DEREF_FINDING Specifies that aliases are dereferenced
59 when finding the base object, but not when
60 searching under the base object.
61 LDAP_DEREF_ALWAYS Specifies that aliases are always derefer‐
64 enced when finding the base object and
65 searching under the base object.
66 LDAP_OPT_SIZELIMIT
70 Specifies the maximum number of entries returned by the server in
72 search results. The data type for the optdata parameter is (int *).
73 Setting the optdata parameter to LDAP_NO_LIMIT removes any size
74 limit enforced by the client.
75 LDAP_OPT_TIMELIMIT
78 Specifies the maximum number of seconds spent by the server when
80 answering a search request. The data type for the optdata parameter
81 is (int *). Setting the optdata parameter to LDAP_NO_LIMIT removes
82 any time limit enforced by the client.
83 LDAP_OPT_REFERRALS
86 Determines whether the client should follow referrals. The data
88 type for the optdata parameter is (int *). The following values can
89 be specified for the optdata parameter:
90 LDAP_OPT_ON Specifies that the client should follow referrals.
92 LDAP_OPT_OFF Specifies that the client should not follow refer‐
95 rals.
96 By default, the client follows referrals.
98 LDAP_OPT_RESTART
101 Determines whether LDAP I/O operations are automatically restarted
103 if aborted prematurely. It can be set to one of the constants
104 LDAP_OPT_ON or LDAP_OPT_OFF.
105 LDAP_OPT_PROTOCOL_VERSION
108 Specifies the version of the protocol supported by the client. The
110 data type for the optdata parameter is (int *). The version
111 LDAP_VERSION2 or LDAP_VERSION3 can be specified. If no version is
112 set, the default version LDAP_VERSION2 is set. To use LDAP v3 fea‐
113 tures, set the protocol version to LDAP_VERSION3.
114 LDAP_OPT_SERVER_CONTROLS
117 Specifies a pointer to an array of LDAPControl structures that rep‐
119 resent the LDAP v3 server controls sent by default with every
120 request. The data type for the optdata parameter for
121 ldap_set_option() is (LDAPControl **). For ldap_get_option(), the
122 data type is (LDAPControl ***).
123 LDAP_OPT_CLIENT_CONTROLS
126 Specifies a pointer to an array of LDAPControl structures that rep‐
128 resent the LDAP v3 client controls sent by default with every
129 request. The data type for the optdata parameter for
130 ldap_set_option() is (LDAPControl **). For ldap_get_option(), the
131 data type is (LDAPControl ***).
132 LDAP_OPT_API_FEATURE_INFO
135 Retrieves version information at execution time about extended fea‐
137 tures of the LDAP API. The data type for the optdata parameter is
138 (LDAPAPIFeatureInfo *). This option is READ-ONLY and cannot be set.
139 LDAP_OPT_HOST_NAME
142 Sets the host name or a list of hosts for the primary LDAP server.
144 The data type for the optdata parameter for ldap_set_option() is
145 (char *). For ldap_get_option(), the data type is (char **).
146 LDAP_OPT_ERROR_NUMBER
149 Specifies the code of the most recent LDAP error that occurred for
151 this session. The data type for the optdata parameter is (int *).
152 LDAP_OPT_ERROR_STRING
155 Specifies the message returned with the most recent LDAP error that
157 occurred for this session. The data type for the optdata parameter
158 for ldap_set_option() is (char *) and for ldap_get_option() is
159 (char **).
160 LDAP_OPT_MATCHED_DN
163 Specifies the matched DN value returned with the most recent LDAP
165 error that occurred for this session. The data type for the optdata
166 parameter for ldap_set_option() is (char *) and for
167 ldap_get_option() is (char **).
168 LDAP_OPT_REBIND_ARG
171 Sets the last argument passed to the routine specified by
173 LDAP_OPT_REBIND_FN. This option can also be set by calling the
174 ldap_set_rebind_proc() function. The data type for the optdata
175 parameter is (void * ).
176 LDAP_OPT_REBIND_FN
179 Sets the routine to be called to authenticate a connection with
181 another LDAP server. For example, the option is used to set the
182 routine called during the course of a referral. This option can
183 also be by calling the ldap_set_rebind_proc() function. The data
184 type for the optdata parameter is (LDAP_REBINDPROC_CALLBACK *).
185 LDAP_OPT_X_SASL_MECH
188 Sets the default SASL mechanism to call ldap_interactive_bind_s().
190 The data type for the optdata parameter is (char * ).
191 LDAP_OPT_X_SASL_REALM
194 Sets the default SASL_REALM. The default SASL_REALM should be used
196 during a SASL challenge in response to a SASL_CB_GETREALM request
197 when using the ldap_interactive_bind_s() function. The data type
198 for the optdata parameter is (char * ).
199 LDAP_OPT_X_SASL_AUTHCID
202 Sets the default SASL_AUTHNAME used during a SASL challenge in
204 response to a SASL_CB_AUTHNAME request when using the ldap_interac‐
205 tive_bind_s() function. The data type for the optdata parameter is
206 (char * ).
207 LDAP_OPT_X_SASL_AUTHZID
210 Sets the default SASL_USER that should be used during a SASL chal‐
212 lenge in response to a SASL_CB_USER request when using the
213 ldap_interactive_bind_s function. The data type for the optdata
214 parameter is (char * ).
215 LDAP_OPT_X_SASL_SSF
218 A read-only option used exclusively with the ldap_get_option()
220 function. The ldap_get_option() function performs a sasl_getprop()
221 operation that gets the SASL_SSF value for the current connection.
222 The data type for the optdata parameter is (sasl_ssf_t * ).
223 LDAP_OPT_X_SASL_SSF_EXTERNAL
226 A write-only option used exclusively with the ldap_set_option()
228 function. The ldap_set_option() function performs a sasl_setprop()
229 operation to set the SASL_SSF_EXTERNAL value for the current con‐
230 nection. The data type for the optdata parameter is (sasl_ssf_t *
231 ).
232 LDAP_OPT_X_SASL_SECPROPS
235 A write-only option used exclusively with the ldap_set_option().
237 This function performs a sasl_setprop(3SASL) operation for the
238 SASL_SEC_PROPS value for the current connection during an
239 ldap_interactive_bind_s() operation. The data type for the optdata
240 parameter is (char * ), a comma delimited string containing text
241 values for any of the SASL_SEC_PROPS that should be set. The text
242 values are:
243 noanonymous Sets the SASL_SEC_NOANONYMOUS flag
245 nodict Sets the SASL_SEC_NODICTIONARY flag
248 noplain Sets the SASL_SEC_NOPLAINTEXT flag
251 forwardsec Sets the SASL_SEC_FORWARD_SECRECY flag
254 passcred Sets the SASL_SEC_PASS_CREDENTIALS flag
257 minssf=N Sets minssf to the integer value N
260 maxssf=N Sets maxssf to the integer value N
263 maxbufsize=N Sets maxbufsize to the integer value N
266 LDAP_OPT_X_SASL_SSF_MIN
270 Sets the default SSF_MIN value used during a ldap_interac‐
272 tive_bind_s() operation. The data type for the optdata parameter is
273 (char * ) numeric string.
274 LDAP_OPT_X_SASL_SSF_MAX
277 Sets the default SSF_MAX value used during a ldap_interac‐
279 tive_bind_s() operation. The data type for the optdata parameter is
280 (char * ) numeric string.
281 LDAP_OPT_X_SASL_MAXBUFSIZE
284 Sets the default SSF_MAXBUFSIZE value used during a ldap_interac‐
286 tive_bind_s() operation. The data type for the optdata parameter is
287 (char * ) numeric string.
288
291 The ldap_set_option() and ldap_get_option() functions return:
292 LDAP_SUCCESS If successful
294 -1 If unsuccessful
297
300 See attributes(5) for descriptions of the following attributes:
301 ┌─────────────────────────────┬─────────────────────────────┐
306 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
307 ├─────────────────────────────┼─────────────────────────────┤
308 │Interface Stability │Evolving │
309 ├─────────────────────────────┼─────────────────────────────┤
310 │MT-Level │Safe │
311 └─────────────────────────────┴─────────────────────────────┘
312
314 ldap_init(3LDAP), sasl_setprop(3SASL), attributes(5)
315
317 There are other elements in the LDAP structure that should not be
318 changed. No assumptions should be made about the order of elements in
319 the LDAP structure.
320SunOS 5.11 15 Jan 2004 ldap_get_option(3LDAP)