| blob | 6644b3c6bf698d833a8bf07f71370c049376bf34 |
1 '\" te
2 .\" Copyright (C) 1990, Regents of the University of Michigan. All Rights Reserved.
3 .\" Portions Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved.
4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 .TH LDAP 3LDAP "May 13, 2017"
8 .SH NAME
9 ldap \- Lightweight Directory Access Protocol package
10 .SH SYNOPSIS
11 .LP
12 .nf
13 cc[ \fIflag\fR... ] \fIfile\fR... -lldap[ \fIlibrary\fR... ]
14 #include <lber.h>
15 #include <ldap.h>
16 .fi
18 .SH DESCRIPTION
19 .LP
20 The Lightweight Directory Access Protocol ("LDAP") package includes
21 various command line LDAP clients and a LDAP client library to provide
22 programmatic access to the LDAP protocol. This man page gives an overview of
23 the LDAP client library functions.
24 .sp
25 .LP
26 An application might use the LDAP client library functions as follows. The
27 application would initialize a LDAP session with a LDAP server by calling
28 \fBldap_init\fR(3LDAP). Next, it authenticates to the LDAP server by calling
29 \fBldap_sasl_bind\fR(3LDAP) and friends. It may perform some LDAP operations
30 and obtain results by calling \fBldap_search\fR(3LDAP) and friends. To parse
31 the results returned from these functions, it calls
32 \fBldap_parse_result\fR(3LDAP), \fBldap_next_entry\fR(3LDAP), and
33 \fBldap_first_entry\fR(3LDAP) and others. It closes the LDAP session by calling
34 \fBldap_unbind\fR(3LDAP).
35 .sp
36 .LP
37 LDAP operations can be either synchronous or asynchronous. By convention, the
38 names of the synchronous functions end with "_s." For example, a synchronous
39 binding to the LDAP server can be performed by calling
40 \fBldap_sasl_bind_s\fR(3LDAP). Complete an asynchronous binding with
41 \fBldap_sasl_bind\fR(3LDAP). All synchronous functions return the actual
42 outcome of the operation, either \fBLDAP_SUCCESS\fR or an error code.
43 Asynchronous routines provide an invocation identifier which can be used to
44 obtain the result of a specific operation by passing it to
45 the \fBldap_result\fR(3LDAP) function.
46 .SS "Initializing a LDAP session"
47 .LP
48 Initializing a LDAP session involves calling the \fBldap_init\fR(3LDAP)
49 function. However, the call does not actually open a connection to the LDAP
50 server. It merely initializes a LDAP structure that represents the session. The
51 connection is opened when the first operation is attempted. Unlike
52 \fBldap_init()\fR, \fBldap_open\fR(3LDAP) attempts to open a connection with
53 the LDAP server. However, the use of \fBldap_open()\fR is deprecated.
54 .SS "Authenticating to a LDAP server"
55 .LP
56 The \fBldap_sasl_bind\fR(3LDAP) and \fBldap_sasl_bind_s\fR(3LDAP) functions
57 provide general and extensible authenticaton for an LDAP client to a LDAP
58 server. Both use the Simple Authentication Security Layer (SASL). Simplified
59 routines \fBldap_simple_bind\fR(3LDAP) and \fBldap_simple_bind_s\fR(3LDAP) use
60 cleartext passwords to bind to the LDAP server. Use of \fBldap_bind\fR(3LDAP)
61 and \fBldap_bind_s\fR(3LDAP)(3LDAP) is deprecated.
62 .SS "Searching a LDAP directory"
63 .LP
64 Search for an entry in a LDAP directory by calling the
65 \fBldap_search_ext\fR(3LDAP) or the \fBldap_search_ext_s\fR(3LDAP) functions.
66 These functions support LDAPv3 server controls, client controls and variable
67 size and time limits as arguments for each search operation.
68 \fBldap_search\fR(3LDAP) and \fBldap_search_s\fR(3LDAP) are identical functions
69 but do not support the controls and limits as arguments to the call.
70 .SS "Adding or Deleting an entry"
71 .LP
72 Use \fBldap_add_ext\fR(3LDAP) and \fBldap_delete_ext\fR(3LDAP) to add or delete
73 entries in a LDAP directory server. The synchronous counterparts to these
74 functions are \fBldap_add_ext_s\fR(3LDAP) and \fBldap_delete_ext_s\fR(3LDAP).
75 The \fBldap_add\fR(3LDAP), \fBldap_add_s\fR(3LDAP), \fBldap_delete\fR(3LDAP),
76 and \fBldap_delete_s\fR(3LDAP) provide identical functionality to add and to
77 delete entries, but they do not support LDAP v3 server and client controls.
78 .SS "Modifying Entries"
79 .LP
80 Use \fBldap_modify_ext\fR(3LDAP) and \fBldap_modify_ext_s\fR(3LDAP) to modify
81 an existing entry in a LDAP server that supports for LDAPv3 server and client
82 controls. Similarly, use \fBldap_rename\fR(3LDAP) and
83 \fBldap_rename_s\fR(3LDAP) to change the name of an LDAP entry. The
84 \fBldap_modrdn\fR(3LDAP), \fBldap_modrdn_s\fR(3LDAP), \fBldap_modrdn2\fR(3LDAP)
85 and \fBldap_modrdn2_s\fR(3LDAP) interfaces are deprecated.
86 .SS "Obtaining Results"
87 .LP
88 Use \fBldap_result\fR(3LDAP) to obtain the results of a previous asynchronous
89 operation. For all LDAP operations other than search, only one message is
90 returned. For the search operation, a list of result messages can be returned.
91 .SS "Handling Errors and Parsing Results"
92 .LP
93 Use the \fBldap_parse_result\fR(3LDAP),
94 \fBldap_parse_sasl_bind_result\fR(3LDAP), and the
95 \fBldap_parse_extended_result\fR(3LDAP) functions to extract required
96 information from results and to handle the returned errors. To convert a
97 numeric error code into a null-terminated character string message describing
98 the error, use \fBldap_err2string\fR(3LDAP). The \fBldap_result2error\fR(3LDAP)
99 and \fBldap_perror\fR(3LDAP) functions are deprecated. To step through the list
100 of messages in a result returned by \fBldap_result()\fR, use
101 \fBldap_first_message\fR(3LDAP) and \fBldap_next_message\fR(3LDAP).
102 \fBldap_count_messages\fR(3LDAP) returns the number of messages contained in
103 the list.
104 .sp
105 .LP
106 You can use \fBldap_first_entry\fR(3LDAP) and \fBldap_next_entry\fR(3LDAP) to
107 step through and obtain a list of entries from a list of messages returned by a
108 search result. \fBldap_count_entries\fR(3LDAP) returns the number of entries
109 contained in a list of messages. Call either \fBldap_first_attribute\fR(3LDAP)
110 and \fBldap_next_attribute\fR(3LDAP) to step through a list of attributes
111 associated with an entry. Retrieve the values of a given attribute by calling
112 \fBldap_get_values\fR(3LDAP) and \fBldap_get_values_len\fR(3LDAP). Count the
113 number of values returned by using \fBldap_count_values\fR(3LDAP) and
114 \fBldap_count_values_len\fR(3LDAP).
115 .sp
116 .LP
117 Use the \fBldap_get_lang_values\fR(3LDAP) and
118 \fBldap_get_lang_values_len\fR(3LDAP) to return an attribute's values that
119 matches a specified language subtype. The \fBldap_get_lang_values()\fR function
120 returns an array of an attribute's string values that matches a specified
121 language subtype. To retrieve the binary data from an attribute, call the
122 \fBldap_get_lang_values_len()\fR function instead.
123 .SS "Uniform Resource Locators (URLS)"
124 .LP
125 You can use the \fBldap_url\fR(3LDAP)functions to test a URL to verify that it
126 is an LDAP URL, to parse LDAP URLs into their component pieces, to initiate
127 searches directly using an LDAP URL, and to retrieve the URL associated with a
128 DNS domain name or a distinguished name.
129 .SS "User Friendly Naming"
130 .LP
131 The \fBldap_ufn\fR(3LDAP) functions implement a user friendly naming scheme by
132 means of LDAP. This scheme allows you to look up entries using fuzzy, untyped
133 names like "mark smith, umich, us".
134 .SS "Caching"
135 .LP
136 The \fBldap_memcache\fR(3LDAP) functions provide an in-memory client side cache
137 to store search requests. Caching improves performance and reduces network
138 bandwidth when a client makes repeated requests.
139 .SS "Utility Functions"
140 .LP
141 There are also various utility functions. You can use the
142 \fBldap_sort\fR(3LDAP) functions are used to sort the entries and values
143 returned by means of the ldap search functions. The \fBldap_friendly\fR(3LDAP)
144 functions will map from short two letter country codes or other strings to
145 longer "friendlier" names. Use the \fBldap_charset\fR(3LDAP) functions to
146 translate to and from the T.61 character set that is used for many character
147 strings in the LDAP protocol.
148 .SS "Generating Filters"
149 .LP
150 Make calls to \fBldap_init_getfilter\fR(3LDAP) and \fBldap_search\fR(3LDAP) to
151 generate filters to be used in \fBldap_search\fR(3LDAP) and
152 \fBldap_search_s\fR(3LDAP). \fBldap_init_getfilter()\fR reads
153 \fBldapfilter.conf\fR(4), the LDAP configuration file, while
154 \fBldap_init_getfilter_buf()\fR reads the configuration information from
155 \fIbuf\fR of length \fIbuflen\fR. \fBldap_getfilter_free\fR(3LDAP) frees memory
156 that has been allocated by means of \fBldap_init_getfilter()\fR.
157 .SS "BER Library"
158 .LP
159 The LDAP package includes a set of lightweight Basic Encoding Rules ("BER)"
160 functions. The LDAP library functions use the BER functions to encode and
161 decode LDAP protocol elements through the slightly simplified BER defined by
162 LDAP. They are not normally used directly by an LDAP application program will
163 not normally use the BER functions directly. Instead, these functions provide a
164 \fBprintf()\fR and \fBscanf()\fR-like interface, as well as lower-level access.
165 .SH LIST OF INTERFACES
166 .ne 2
167 .na
168 \fB\fBldap_open\fR(3LDAP)\fR
169 .ad
170 .sp .6
171 .RS 4n
172 Deprecated. Use \fBldap_init\fR(3LDAP).
173 .RE
175 .sp
176 .ne 2
177 .na
178 \fB\fBldap_init\fR(3LDAP)\fR
179 .ad
180 .sp .6
181 .RS 4n
182 Initialize a session with a LDAP server without opening a connection to a
183 server.
184 .RE
186 .sp
187 .ne 2
188 .na
189 \fB\fBldap_result\fR(3LDAP)\fR
190 .ad
191 .sp .6
192 .RS 4n
193 Obtain the result from a previous asynchronous operation.
194 .RE
196 .sp
197 .ne 2
198 .na
199 \fB\fBldap_abandon\fR(3LDAP)\fR
200 .ad
201 .sp .6
202 .RS 4n
203 Abandon or abort an asynchronous operation.
204 .RE
206 .sp
207 .ne 2
208 .na
209 \fB\fBldap_add\fR(3LDAP)\fR
210 .ad
211 .sp .6
212 .RS 4n
213 Asynchronously add an entry
214 .RE
216 .sp
217 .ne 2
218 .na
219 \fB\fBldap_add_s\fR(3LDAP)\fR
220 .ad
221 .sp .6
222 .RS 4n
223 Synchronously add an entry.
224 .RE
226 .sp
227 .ne 2
228 .na
229 \fB\fBldap_add_ext\fR(3LDAP)\fR
230 .ad
231 .sp .6
232 .RS 4n
233 Asynchronously add an entry with support for LDAPv3 controls.
234 .RE
236 .sp
237 .ne 2
238 .na
239 \fB\fBldap_add_ext_s\fR(3LDAP)\fR
240 .ad
241 .sp .6
242 .RS 4n
243 Synchronously add an entry with support for LDAPv3 controls.
244 .RE
246 .sp
247 .ne 2
248 .na
249 \fB\fBldap_bind\fR(3LDAP)\fR
250 .ad
251 .sp .6
252 .RS 4n
253 Deprecated. Use \fBldap_sasl_bind\fR(3LDAP) or \fBldap_simple_bind\fR(3LDAP).
254 .RE
256 .sp
257 .ne 2
258 .na
259 \fB\fBldap_sasl_bind\fR(3LDAP)\fR
260 .ad
261 .sp .6
262 .RS 4n
263 Asynchronously bind to the directory using SASL authentication
264 .RE
266 .sp
267 .ne 2
268 .na
269 \fB\fBldap_sasl_bind_s\fR(3LDAP)\fR
270 .ad
271 .sp .6
272 .RS 4n
273 Synchronously bind to the directory using SASL authentication
274 .RE
276 .sp
277 .ne 2
278 .na
279 \fB\fBldap_bind_s\fR(3LDAP)\fR
280 .ad
281 .sp .6
282 .RS 4n
283 Deprecated. Use \fBldap_sasl_bind_s\fR(3LDAP) or
284 \fBldap_simple_bind_s\fR(3LDAP).
285 .RE
287 .sp
288 .ne 2
289 .na
290 \fB\fBldap_simple_bind\fR(3LDAP)\fR
291 .ad
292 .sp .6
293 .RS 4n
294 Asynchronously bind to the directory using simple authentication.
295 .RE
297 .sp
298 .ne 2
299 .na
300 \fB\fBldap_simple_bind_s\fR(3LDAP)\fR
301 .ad
302 .sp .6
303 .RS 4n
304 Synchronously bind to the directory using simple authentication.
305 .RE
307 .sp
308 .ne 2
309 .na
310 \fB\fBldap_unbind\fR(3LDAP)\fR
311 .ad
312 .sp .6
313 .RS 4n
314 Synchronously unbind from the LDAP server, close the connection, and dispose
315 the session handle.
316 .RE
318 .sp
319 .ne 2
320 .na
321 \fB\fBldap_unbind_ext\fR(3LDAP)\fR
322 .ad
323 .sp .6
324 .RS 4n
325 Synchronously unbind from the LDAP server and close the connection.
326 \fBldap_unbind_ext()\fR allows you to explicitly include both server and client
327 controls in the unbind request.
328 .RE
330 .sp
331 .ne 2
332 .na
333 \fB\fBldap_set_rebind_proc\fR(3LDAP)\fR
334 .ad
335 .sp .6
336 .RS 4n
337 Set callback function for obtaining credentials from a referral.
338 .RE
340 .sp
341 .ne 2
342 .na
343 \fB\fBldap_memcache_init\fR(3LDAP)\fR
344 .ad
345 .sp .6
346 .RS 4n
347 Create the in-memory client side cache.
348 .RE
350 .sp
351 .ne 2
352 .na
353 \fB\fBldap_memcache_set\fR(3LDAP)\fR
354 .ad
355 .sp .6
356 .RS 4n
357 Associate an in-memory cache that has been already created by calling the
358 \fBldap_memcache_init\fR(3LDAP) function with an LDAP connection handle.
359 .RE
361 .sp
362 .ne 2
363 .na
364 \fB\fBldap_memcache_get\fR(3LDAP)\fR
365 .ad
366 .sp .6
367 .RS 4n
368 Get the cache associated with the specified LDAP structure.
369 .RE
371 .sp
372 .ne 2
373 .na
374 \fB\fBldap_memcache_flush\fR(3LDAP)\fR
375 .ad
376 .sp .6
377 .RS 4n
378 Flushes search requests from the cache.
379 .RE
381 .sp
382 .ne 2
383 .na
384 \fB\fBldap_memcache_destroy\fR(3LDAP)\fR
385 .ad
386 .sp .6
387 .RS 4n
388 Frees the specified \fBLDAPMemCache\fR structure pointed to by cache from
389 memory.
390 .RE
392 .sp
393 .ne 2
394 .na
395 \fB\fBldap_memcache_update\fR(3LDAP)\fR
396 .ad
397 .sp .6
398 .RS 4n
399 Checks the cache for items that have expired and removes them.
400 .RE
402 .sp
403 .ne 2
404 .na
405 \fB\fBldap_compare\fR(3LDAP)\fR
406 .ad
407 .sp .6
408 .RS 4n
409 Asynchronous compare with a directory entry.
410 .RE
412 .sp
413 .ne 2
414 .na
415 \fB\fBldap_compare_s\fR(3LDAP)\fR
416 .ad
417 .sp .6
418 .RS 4n
419 Synchronous compare with a directory entry.
420 .RE
422 .sp
423 .ne 2
424 .na
425 \fB\fBldap_compare_ext\fR(3LDAP)\fR
426 .ad
427 .sp .6
428 .RS 4n
429 Asynchronous compare with a directory entry, with support for LDAPv3 controls.
430 .RE
432 .sp
433 .ne 2
434 .na
435 \fB\fBldap_compare_ext_s\fR(3LDAP)\fR
436 .ad
437 .sp .6
438 .RS 4n
439 Synchronous compare with a directory entry, with support for LDAPv3 controls.
440 .RE
442 .sp
443 .ne 2
444 .na
445 \fB\fBldap_control_free\fR(3LDAP)\fR
446 .ad
447 .sp .6
448 .RS 4n
449 Dispose of an LDAP control.
450 .RE
452 .sp
453 .ne 2
454 .na
455 \fB\fBldap_controls_free\fR(3LDAP)\fR
456 .ad
457 .sp .6
458 .RS 4n
459 Dispose of an array of LDAP controls.
460 .RE
462 .sp
463 .ne 2
464 .na
465 \fB\fBldap_delete\fR(3LDAP)\fR
466 .ad
467 .sp .6
468 .RS 4n
469 Asynchronously delete an entry.
470 .RE
472 .sp
473 .ne 2
474 .na
475 \fB\fBldap_delete_s\fR(3LDAP)\fR
476 .ad
477 .sp .6
478 .RS 4n
479 Synchronously delete an entry.
480 .RE
482 .sp
483 .ne 2
484 .na
485 \fB\fBldap_delete_ext\fR(3LDAP)\fR
486 .ad
487 .sp .6
488 .RS 4n
489 Asynchronously delete an entry, with support for LDAPv3 controls.
490 .RE
492 .sp
493 .ne 2
494 .na
495 \fB\fBldap_delete_ext_s\fR(3LDAP)\fR
496 .ad
497 .sp .6
498 .RS 4n
499 Synchronously delete an entry, with support for LDAPv3 controls.
500 .RE
502 .sp
503 .ne 2
504 .na
505 \fB\fBldap_init_templates\fR(3LDAP)\fR
506 .ad
507 .sp .6
508 .RS 4n
509 Read a sequence of templates from a LDAP template configuration file.
510 .RE
512 .sp
513 .ne 2
514 .na
515 \fB\fBldap_init_templates_buf\fR(3LDAP)\fR
516 .ad
517 .sp .6
518 .RS 4n
519 Read a sequence of templates from a buffer.
520 .RE
522 .sp
523 .ne 2
524 .na
525 \fB\fBldap_free_templates\fR(3LDAP)\fR
526 .ad
527 .sp .6
528 .RS 4n
529 Dispose of the templates allocated.
530 .RE
532 .sp
533 .ne 2
534 .na
535 \fB\fBldap_first_reference\fR(3LDAP)\fR
536 .ad
537 .sp .6
538 .RS 4n
539 Step through a list of continuation references from a search result.
540 .RE
542 .sp
543 .ne 2
544 .na
545 \fB\fBldap_next_reference\fR(3LDAP)\fR
546 .ad
547 .sp .6
548 .RS 4n
549 Step through a list of continuation references from a search result.
550 .RE
552 .sp
553 .ne 2
554 .na
555 \fB\fBldap_count_references\fR(3LDAP)\fR
556 .ad
557 .sp .6
558 .RS 4n
559 Count the number of messages in a search result.
560 .RE
562 .sp
563 .ne 2
564 .na
565 \fB\fBldap_first_message\fR(3LDAP)\fR
566 .ad
567 .sp .6
568 .RS 4n
569 Step through a list of messages in a search result.
570 .RE
572 .sp
573 .ne 2
574 .na
575 \fB\fBldap_count_messages\fR(3LDAP)\fR
576 .ad
577 .sp .6
578 .RS 4n
579 Count the messages in a list of messages in a search result.
580 .RE
582 .sp
583 .ne 2
584 .na
585 \fB\fBldap_next_message\fR(3LDAP)\fR
586 .ad
587 .sp .6
588 .RS 4n
589 Step through a list of messages in a search result.
590 .RE
592 .sp
593 .ne 2
594 .na
595 \fB\fBldap_msgtype\fR(3LDAP)\fR
596 .ad
597 .sp .6
598 .RS 4n
599 Return the type of LDAP message.
600 .RE
602 .sp
603 .ne 2
604 .na
605 \fB\fBldap_first_disptmpl\fR(3LDAP)\fR
606 .ad
607 .sp .6
608 .RS 4n
609 Get first display template in a list.
610 .RE
612 .sp
613 .ne 2
614 .na
615 \fB\fBldap_next_disptmpl\fR(3LDAP)\fR
616 .ad
617 .sp .6
618 .RS 4n
619 Get next display template in a list.
620 .RE
622 .sp
623 .ne 2
624 .na
625 \fB\fBldap_oc2template\fR(3LDAP)\fR
626 .ad
627 .sp .6
628 .RS 4n
629 Return template appropriate for the objectclass.
630 .RE
632 .sp
633 .ne 2
634 .na
635 \fB\fBldap_name2template\fR(3LDAP)\fR
636 .ad
637 .sp .6
638 .RS 4n
639 Return named template
640 .RE
642 .sp
643 .ne 2
644 .na
645 \fB\fBldap_tmplattrs\fR(3LDAP)\fR
646 .ad
647 .sp .6
648 .RS 4n
649 Return attributes needed by the template.
650 .RE
652 .sp
653 .ne 2
654 .na
655 \fB\fBldap_first_tmplrow\fR(3LDAP)\fR
656 .ad
657 .sp .6
658 .RS 4n
659 Return first row of displayable items in a template.
660 .RE
662 .sp
663 .ne 2
664 .na
665 \fB\fBldap_next_tmplrow\fR(3LDAP)\fR
666 .ad
667 .sp .6
668 .RS 4n
669 Return next row of displayable items in a template.
670 .RE
672 .sp
673 .ne 2
674 .na
675 \fB\fBldap_first_tmplcol\fR(3LDAP)\fR
676 .ad
677 .sp .6
678 .RS 4n
679 Return first column of displayable items in a template.
680 .RE
682 .sp
683 .ne 2
684 .na
685 \fB\fBldap_next_tmplcol\fR(3LDAP)\fR
686 .ad
687 .sp .6
688 .RS 4n
689 Return next column of displayable items in a template.
690 .RE
692 .sp
693 .ne 2
694 .na
695 \fB\fBldap_entry2text\fR(3LDAP)\fR
696 .ad
697 .sp .6
698 .RS 4n
699 Display an entry as text by using a display template.
700 .RE
702 .sp
703 .ne 2
704 .na
705 \fB\fBldap_entry2text_search\fR(3LDAP)\fR
706 .ad
707 .sp .6
708 .RS 4n
709 Search for and display an entry as text by using a display template.
710 .RE
712 .sp
713 .ne 2
714 .na
715 \fB\fBldap_vals2text\fR(3LDAP)\fR
716 .ad
717 .sp .6
718 .RS 4n
719 Display values as text.
720 .RE
722 .sp
723 .ne 2
724 .na
725 \fB\fBldap_entry2html\fR(3LDAP)\fR
726 .ad
727 .sp .6
728 .RS 4n
729 Display an entry as HTML (HyperText Markup Language) by using a display
730 template.
731 .RE
733 .sp
734 .ne 2
735 .na
736 \fB\fBldap_entry2html_search\fR(3LDAP)\fR
737 .ad
738 .sp .6
739 .RS 4n
740 Search for and display an entry as HTML by using a display template.
741 .RE
743 .sp
744 .ne 2
745 .na
746 \fB\fBldap_vals2html\fR(3LDAP)\fR
747 .ad
748 .sp .6
749 .RS 4n
750 Display values as HTML.
751 .RE
753 .sp
754 .ne 2
755 .na
756 \fB\fBldap_perror\fR(3LDAP)\fR
757 .ad
758 .sp .6
759 .RS 4n
760 Deprecated. Use \fBldap_parse_result\fR(3LDAP).
761 .RE
763 .sp
764 .ne 2
765 .na
766 \fB\fBldap_result2error\fR(3LDAP)\fR
767 .ad
768 .sp .6
769 .RS 4n
770 Deprecated. Use \fBldap_parse_result\fR(3LDAP).
771 .RE
773 .sp
774 .ne 2
775 .na
776 \fB\fBldap_err2string\fR(3LDAP)\fR
777 .ad
778 .sp .6
779 .RS 4n
780 Convert LDAP error indication to a string.
781 .RE
783 .sp
784 .ne 2
785 .na
786 \fB\fBldap_first_attribute\fR(3LDAP)\fR
787 .ad
788 .sp .6
789 .RS 4n
790 Return first attribute name in an entry.
791 .RE
793 .sp
794 .ne 2
795 .na
796 \fB\fBldap_next_attribute\fR(3LDAP)\fR
797 .ad
798 .sp .6
799 .RS 4n
800 Return next attribute name in an entry.
801 .RE
803 .sp
804 .ne 2
805 .na
806 \fB\fBldap_first_entry\fR(3LDAP)\fR
807 .ad
808 .sp .6
809 .RS 4n
810 Return first entry in a chain of search results.
811 .RE
813 .sp
814 .ne 2
815 .na
816 \fB\fBldap_next_entry\fR(3LDAP)\fR
817 .ad
818 .sp .6
819 .RS 4n
820 Return next entry in a chain of search results.
821 .RE
823 .sp
824 .ne 2
825 .na
826 \fB\fBldap_count_entries\fR(3LDAP)\fR
827 .ad
828 .sp .6
829 .RS 4n
830 Return number of entries in a search result.
831 .RE
833 .sp
834 .ne 2
835 .na
836 \fB\fBldap_friendly_name\fR(3LDAP)\fR
837 .ad
838 .sp .6
839 .RS 4n
840 Map from unfriendly to friendly names.
841 .RE
843 .sp
844 .ne 2
845 .na
846 \fB\fBldap_free_friendlymap\fR(3LDAP)\fR
847 .ad
848 .sp .6
849 .RS 4n
850 Free resources used by \fBldap_friendly\fR(3LDAP).
851 .RE
853 .sp
854 .ne 2
855 .na
856 \fB\fBldap_get_dn\fR(3LDAP)\fR
857 .ad
858 .sp .6
859 .RS 4n
860 Extract the DN from an entry.
861 .RE
863 .sp
864 .ne 2
865 .na
866 \fB\fBldap_explode_dn\fR(3LDAP)\fR
867 .ad
868 .sp .6
869 .RS 4n
870 Convert a DN into its component parts.
871 .RE
873 .sp
874 .ne 2
875 .na
876 \fB\fBldap_explode_dns\fR(3LDAP)\fR
877 .ad
878 .sp .6
879 .RS 4n
880 Convert a DNS-style DN into its component parts (experimental).
881 .RE
883 .sp
884 .ne 2
885 .na
886 \fB\fBldap_is_dns_dn\fR(3LDAP)\fR
887 .ad
888 .sp .6
889 .RS 4n
890 Check to see if a DN is a DNS-style DN (experimental).
891 .RE
893 .sp
894 .ne 2
895 .na
896 \fB\fBldap_dns_to_dn\fR(3LDAP)\fR
897 .ad
898 .sp .6
899 .RS 4n
900 Convert a DNS domain name into an X.500 distinguished name.
901 .RE
903 .sp
904 .ne 2
905 .na
906 \fB\fBldap_dn2ufn\fR(3LDAP)\fR
907 .ad
908 .sp .6
909 .RS 4n
910 Convert a DN into user friendly form.
911 .RE
913 .sp
914 .ne 2
915 .na
916 \fB\fBldap_get_values\fR(3LDAP)\fR
917 .ad
918 .sp .6
919 .RS 4n
920 Return an attribute's values.
921 .RE
923 .sp
924 .ne 2
925 .na
926 \fB\fBldap_get_values_len\fR(3LDAP)\fR
927 .ad
928 .sp .6
929 .RS 4n
930 Return an attribute's values with lengths.
931 .RE
933 .sp
934 .ne 2
935 .na
936 \fB\fBldap_value_free\fR(3LDAP)\fR
937 .ad
938 .sp .6
939 .RS 4n
940 Free memory allocated by \fBldap_get_values\fR(3LDAP).
941 .RE
943 .sp
944 .ne 2
945 .na
946 \fB\fBldap_value_free_len\fR(3LDAP)\fR
947 .ad
948 .sp .6
949 .RS 4n
950 Free memory allocated by \fBldap_get_values_len\fR(3LDAP).
951 .RE
953 .sp
954 .ne 2
955 .na
956 \fB\fBldap_count_values\fR(3LDAP)\fR
957 .ad
958 .sp .6
959 .RS 4n
960 Return number of values.
961 .RE
963 .sp
964 .ne 2
965 .na
966 \fB\fBldap_count_values_len\fR(3LDAP)\fR
967 .ad
968 .sp .6
969 .RS 4n
970 Return number of values.
971 .RE
973 .sp
974 .ne 2
975 .na
976 \fB\fBldap_init_getfilter\fR(3LDAP)\fR
977 .ad
978 .sp .6
979 .RS 4n
980 Initialize getfilter functions from a file.
981 .RE
983 .sp
984 .ne 2
985 .na
986 \fB\fBldap_init_getfilter_buf\fR(3LDAP)\fR
987 .ad
988 .sp .6
989 .RS 4n
990 Initialize getfilter functions from a buffer.
991 .RE
993 .sp
994 .ne 2
995 .na
996 \fB\fBldap_getfilter_free\fR(3LDAP)\fR
997 .ad
998 .sp .6
999 .RS 4n
1000 Free resources allocated by \fBldap_init_getfilter\fR(3LDAP).
1001 .RE
1003 .sp
1004 .ne 2
1005 .na
1006 \fB\fBldap_getfirstfilter\fR(3LDAP)\fR
1007 .ad
1008 .sp .6
1009 .RS 4n
1010 Return first search filter.
1011 .RE
1013 .sp
1014 .ne 2
1015 .na
1016 \fB\fBldap_getnextfilter\fR(3LDAP)\fR
1017 .ad
1018 .sp .6
1019 .RS 4n
1020 Return next search filter.
1021 .RE
1023 .sp
1024 .ne 2
1025 .na
1026 \fB\fBldap_build_filter\fR(3LDAP)\fR
1027 .ad
1028 .sp .6
1029 .RS 4n
1030 Construct an LDAP search filter from a pattern.
1031 .RE
1033 .sp
1034 .ne 2
1035 .na
1036 \fB\fBldap_setfilteraffixes\fR(3LDAP)\fR
1037 .ad
1038 .sp .6
1039 .RS 4n
1040 Set prefix and suffix for search filters.
1041 .RE
1043 .sp
1044 .ne 2
1045 .na
1046 \fB\fBldap_modify\fR(3LDAP)\fR
1047 .ad
1048 .sp .6
1049 .RS 4n
1050 Asynchronously modify an entry.
1051 .RE
1053 .sp
1054 .ne 2
1055 .na
1056 \fB\fBldap_modify_s\fR(3LDAP)\fR
1057 .ad
1058 .sp .6
1059 .RS 4n
1060 Synchronously modify an entry.
1061 .RE
1063 .sp
1064 .ne 2
1065 .na
1066 \fB\fBldap_modify_ext\fR(3LDAP)\fR
1067 .ad
1068 .sp .6
1069 .RS 4n
1070 Asynchronously modify an entry, return value, and place message.
1071 .RE
1073 .sp
1074 .ne 2
1075 .na
1076 \fB\fBldap_modify_ext_s\fR(3LDAP)\fR
1077 .ad
1078 .sp .6
1079 .RS 4n
1080 Synchronously modify an entry, return value, and place message.
1081 .RE
1083 .sp
1084 .ne 2
1085 .na
1086 \fB\fBldap_mods_free\fR(3LDAP)\fR
1087 .ad
1088 .sp .6
1089 .RS 4n
1090 Free array of pointers to mod structures used by \fBldap_modify\fR(3LDAP).
1091 .RE
1093 .sp
1094 .ne 2
1095 .na
1096 \fB\fBldap_modrdn2\fR(3LDAP)\fR
1097 .ad
1098 .sp .6
1099 .RS 4n
1100 Deprecated. Use \fBldap_rename\fR(3LDAP) instead.
1101 .RE
1103 .sp
1104 .ne 2
1105 .na
1106 \fB\fBldap_modrdn2_s\fR(3LDAP)\fR
1107 .ad
1108 .sp .6
1109 .RS 4n
1110 Deprecated. Use \fBldap_rename_s\fR(3LDAP) instead.
1111 .RE
1113 .sp
1114 .ne 2
1115 .na
1116 \fB\fBldap_modrdn\fR(3LDAP)\fR
1117 .ad
1118 .sp .6
1119 .RS 4n
1120 Deprecated. Use \fBldap_rename\fR(3LDAP) instead.
1121 .RE
1123 .sp
1124 .ne 2
1125 .na
1126 \fB\fBldap_modrdn_s\fR(3LDAP)\fR
1127 .ad
1128 .sp .6
1129 .RS 4n
1130 Depreciated. Use \fBldap_rename_s\fR(3LDAP) instead.
1131 .RE
1133 .sp
1134 .ne 2
1135 .na
1136 \fB\fBldap_rename\fR(3LDAP)\fR
1137 .ad
1138 .sp .6
1139 .RS 4n
1140 Asynchronously modify the name of an LDAP entry.
1141 .RE
1143 .sp
1144 .ne 2
1145 .na
1146 \fB\fBldap_rename_s\fR(3LDAP)\fR
1147 .ad
1148 .sp .6
1149 .RS 4n
1150 Synchronously modify the name of an LDAP entry.
1151 .RE
1153 .sp
1154 .ne 2
1155 .na
1156 \fB\fBldap_msgfree\fR(3LDAP)\fR
1157 .ad
1158 .sp .6
1159 .RS 4n
1160 Free result messages.
1161 .RE
1163 .sp
1164 .ne 2
1165 .na
1166 \fB\fBldap_parse_result\fR(3LDAP)\fR
1167 .ad
1168 .sp .6
1169 .RS 4n
1170 Search for a message to parse.
1171 .RE
1173 .sp
1174 .ne 2
1175 .na
1176 \fB\fBldap_parse_extended_result\fR(3LDAP)\fR
1177 .ad
1178 .sp .6
1179 .RS 4n
1180 Search for a message to parse.
1181 .RE
1183 .sp
1184 .ne 2
1185 .na
1186 \fB\fBldap_parse_sasl_bind_result\fR(3LDAP)\fR
1187 .ad
1188 .sp .6
1189 .RS 4n
1190 Search for a message to parse.
1191 .RE
1193 .sp
1194 .ne 2
1195 .na
1196 \fB\fBldap_search\fR(3LDAP)\fR
1197 .ad
1198 .sp .6
1199 .RS 4n
1200 Asynchronously search the directory.
1201 .RE
1203 .sp
1204 .ne 2
1205 .na
1206 \fB\fBldap_search_s\fR(3LDAP)\fR
1207 .ad
1208 .sp .6
1209 .RS 4n
1210 Synchronously search the directory.
1211 .RE
1213 .sp
1214 .ne 2
1215 .na
1216 \fB\fBldap_search_ext\fR(3LDAP)\fR
1217 .ad
1218 .sp .6
1219 .RS 4n
1220 Asynchronously search the directory with support for LDAPv3 controls.
1221 .RE
1223 .sp
1224 .ne 2
1225 .na
1226 \fB\fBldap_search_ext_s\fR(3LDAP)\fR
1227 .ad
1228 .sp .6
1229 .RS 4n
1230 Synchronously search the directory with support for LDAPv3 controls.
1231 .RE
1233 .sp
1234 .ne 2
1235 .na
1236 \fB\fBldap_search_st\fR(3LDAP)\fR
1237 .ad
1238 .sp .6
1239 .RS 4n
1240 Synchronously search the directory with support for a local timeout value.
1241 .RE
1243 .sp
1244 .ne 2
1245 .na
1246 \fB\fBldap_ufn_search_s\fR(3LDAP)\fR
1247 .ad
1248 .sp .6
1249 .RS 4n
1250 User friendly search the directory.
1251 .RE
1253 .sp
1254 .ne 2
1255 .na
1256 \fB\fBldap_ufn_search_c\fR(3LDAP)\fR
1257 .ad
1258 .sp .6
1259 .RS 4n
1260 User friendly search the directory with cancel.
1261 .RE
1263 .sp
1264 .ne 2
1265 .na
1266 \fB\fBldap_ufn_search_ct\fR(3LDAP)\fR
1267 .ad
1268 .sp .6
1269 .RS 4n
1270 User friendly search the directory with cancel and timeout.
1271 .RE
1273 .sp
1274 .ne 2
1275 .na
1276 \fB\fBldap_ufn_setfilter\fR(3LDAP)\fR
1277 .ad
1278 .sp .6
1279 .RS 4n
1280 Set filter file used by \fBldap_ufn\fR(3LDAP) functions.
1281 .RE
1283 .sp
1284 .ne 2
1285 .na
1286 \fB\fBldap_ufn_setprefix\fR(3LDAP)\fR
1287 .ad
1288 .sp .6
1289 .RS 4n
1290 Set prefix used by \fBldap_ufn\fR(3LDAP) functions.
1291 .RE
1293 .sp
1294 .ne 2
1295 .na
1296 \fB\fBldap_ufn_timeout\fR(3LDAP)\fR
1297 .ad
1298 .sp .6
1299 .RS 4n
1300 Set timeout used by \fBldap_ufn\fR(3LDAP) functions.
1301 .RE
1303 .sp
1304 .ne 2
1305 .na
1306 \fB\fBldap_is_ldap_url\fR(3LDAP)\fR
1307 .ad
1308 .sp .6
1309 .RS 4n
1310 Check a URL string to see if it is an LDAP URL.
1311 .RE
1313 .sp
1314 .ne 2
1315 .na
1316 \fB\fBldap_url_parse\fR(3LDAP)\fR
1317 .ad
1318 .sp .6
1319 .RS 4n
1320 Break up an LDAP URL string into its components.
1321 .RE
1323 .sp
1324 .ne 2
1325 .na
1326 \fB\fBldap_free_urldesc\fR(3LDAP)\fR
1327 .ad
1328 .sp .6
1329 .RS 4n
1330 Free an LDAP URL structure.
1331 .RE
1333 .sp
1334 .ne 2
1335 .na
1336 \fB\fBldap_url_search\fR(3LDAP)\fR
1337 .ad
1338 .sp .6
1339 .RS 4n
1340 Asynchronously search by using an LDAP URL.
1341 .RE
1343 .sp
1344 .ne 2
1345 .na
1346 \fB\fBldap_url_search_s\fR(3LDAP)\fR
1347 .ad
1348 .sp .6
1349 .RS 4n
1350 Synchronously search by using an LDAP URL.
1351 .RE
1353 .sp
1354 .ne 2
1355 .na
1356 \fB\fBldap_url_search_st\fR(3LDAP)\fR
1357 .ad
1358 .sp .6
1359 .RS 4n
1360 Asynchronously search by using an LDAP URL, with support for a local timeout
1361 value.
1362 .RE
1364 .sp
1365 .ne 2
1366 .na
1367 \fB\fBldap_dns_to_url\fR(3LDAP)\fR
1368 .ad
1369 .sp .6
1370 .RS 4n
1371 Locate the LDAP URL associated with a DNS domain name.
1372 .RE
1374 .sp
1375 .ne 2
1376 .na
1377 \fB\fBldap_dn_to_url\fR(3LDAP)\fR
1378 .ad
1379 .sp .6
1380 .RS 4n
1381 Locate the LDAP URL associated with a distinguished name.
1382 .RE
1384 .sp
1385 .ne 2
1386 .na
1387 \fB\fBldap_init_searchprefs\fR(3LDAP)\fR
1388 .ad
1389 .sp .6
1390 .RS 4n
1391 Initialize searchprefs functions from a file.
1392 .RE
1394 .sp
1395 .ne 2
1396 .na
1397 \fB\fBldap_init_searchprefs_buf\fR(3LDAP)\fR
1398 .ad
1399 .sp .6
1400 .RS 4n
1401 Initialize searchprefs functions from a buffer.
1402 .RE
1404 .sp
1405 .ne 2
1406 .na
1407 \fB\fBldap_free_searchprefs\fR(3LDAP)\fR
1408 .ad
1409 .sp .6
1410 .RS 4n
1411 Free memory allocated by searchprefs functions.
1412 .RE
1414 .sp
1415 .ne 2
1416 .na
1417 \fB\fBldap_first_searchobj\fR(3LDAP)\fR
1418 .ad
1419 .sp .6
1420 .RS 4n
1421 Return first searchpref object.
1422 .RE
1424 .sp
1425 .ne 2
1426 .na
1427 \fB\fBldap_next_searchobj\fR(3LDAP)\fR
1428 .ad
1429 .sp .6
1430 .RS 4n
1431 Return next searchpref object.
1432 .RE
1434 .sp
1435 .ne 2
1436 .na
1437 \fB\fBldap_sort_entries\fR(3LDAP)\fR
1438 .ad
1439 .sp .6
1440 .RS 4n
1441 Sort a list of search results.
1442 .RE
1444 .sp
1445 .ne 2
1446 .na
1447 \fB\fBldap_sort_values\fR(3LDAP)\fR
1448 .ad
1449 .sp .6
1450 .RS 4n
1451 Sort a list of attribute values.
1452 .RE
1454 .sp
1455 .ne 2
1456 .na
1457 \fB\fBldap_sort_strcasecmp\fR(3LDAP)\fR
1458 .ad
1459 .sp .6
1460 .RS 4n
1461 Case insensitive string comparison.
1462 .RE
1464 .sp
1465 .ne 2
1466 .na
1467 \fB\fBldap_set_string_translators\fR(3LDAP)\fR
1468 .ad
1469 .sp .6
1470 .RS 4n
1471 Set character set translation functions used by LDAP library.
1472 .RE
1474 .sp
1475 .ne 2
1476 .na
1477 \fB\fBldap_translate_from_t61\fR(3LDAP)\fR
1478 .ad
1479 .sp .6
1480 .RS 4n
1481 Translate from the T.61 character set to another character set.
1482 .RE
1484 .sp
1485 .ne 2
1486 .na
1487 \fB\fBldap_translate_to_t61\fR(3LDAP)\fR
1488 .ad
1489 .sp .6
1490 .RS 4n
1491 Translate to the T.61 character set from another character set.
1492 .RE
1494 .sp
1495 .ne 2
1496 .na
1497 \fB\fBldap_enable_translation\fR(3LDAP)\fR
1498 .ad
1499 .sp .6
1500 .RS 4n
1501 Enable or disable character translation for an LDAP entry result.
1502 .RE
1504 .sp
1505 .ne 2
1506 .na
1507 \fB\fBldap_version\fR(3LDAP)\fR
1508 .ad
1509 .sp .6
1510 .RS 4n
1511 Get version information about the LDAP SDK for C.
1512 .RE
1514 .sp
1515 .ne 2
1516 .na
1517 \fB\fBldap_get_lang_values\fR(3LDAP)\fR
1518 .ad
1519 .sp .6
1520 .RS 4n
1521 Return an attribute's value that matches a specified language subtype.
1522 .RE
1524 .sp
1525 .ne 2
1526 .na
1527 \fB\fBldap_get_lang_values_len\fR(3LDAP)\fR
1528 .ad
1529 .sp .6
1530 .RS 4n
1531 Return an attribute's value that matches a specified language subtype along
1532 with lengths.
1533 .RE
1535 .sp
1536 .ne 2
1537 .na
1538 \fB\fBldap_get_entry_controls\fR(3LDAP)\fR
1539 .ad
1540 .sp .6
1541 .RS 4n
1542 Get the LDAP controls included with a directory entry in a set of search
1543 results.
1544 .RE
1546 .sp
1547 .ne 2
1548 .na
1549 \fB\fBldap_get_option\fR(3LDAP)\fR
1550 .ad
1551 .sp .6
1552 .RS 4n
1553 Get session preferences in an LDAP structure.
1554 .RE
1556 .sp
1557 .ne 2
1558 .na
1559 \fB\fBldap_set_option\fR(3LDAP)\fR
1560 .ad
1561 .sp .6
1562 .RS 4n
1563 Set session preferences in an LDAP structure.
1564 .RE
1566 .sp
1567 .ne 2
1568 .na
1569 \fB\fBldap_memfree\fR(3LDAP)\fR
1570 .ad
1571 .sp .6
1572 .RS 4n
1573 Free memory allocated by LDAP API functions.
1574 .RE
1576 .SH ATTRIBUTES
1577 .LP
1578 See \fBattributes\fR(5) for a description of the following attributes:
1579 .sp
1581 .sp
1582 .TS
1583 box;
1584 c | c
1585 l | l .
1586 ATTRIBUTE TYPE ATTRIBUTE VALUE
1587 _
1588 Stability Level Evolving
1589 .TE
1591 .SH SEE ALSO
1592 .LP
1593 \fBattributes\fR(5)