HTML rendering created 2025-09-06 byMichael Kerrisk, author ofThe Linux Programming Interface. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH. |  |
NAME |LIBRARY |SYNOPSIS |DESCRIPTION |SEE ALSO |ACKNOWLEDGEMENTS |COLOPHON | |
LDAP_URL(3) Library Functions ManualLDAP_URL(3)ldap_is_ldap_url, ldap_url_parse, ldap_free_urldesc - LDAP Uniform Resource Locator routines
OpenLDAP LDAP (libldap, -lldap)
#include <ldap.h>int ldap_is_ldap_url( const char *url )int ldap_url_parse( const char *url, LDAPURLDesc **ludpp ) typedef struct ldap_url_desc { char * lud_scheme; /* URI scheme */ char * lud_host; /* LDAP host to contact */ int lud_port; /* port on host */ char * lud_dn; /* base for search */ char ** lud_attrs; /* list of attributes */ int lud_scope; /* a LDAP_SCOPE_... value */ char * lud_filter; /* LDAP search filter */ char ** lud_exts; /* LDAP extensions */ int lud_crit_exts; /* true if any extension is critical */ /* may contain additional fields for internal use */ } LDAPURLDesc;void ldap_free_urldesc( LDAPURLDesc *ludp );These routines support the use of LDAP URLs (Uniform Resource Locators) as detailed in RFC 4516. LDAP URLs look like this:ldap://hostport/dn[?attrs[?scope[?filter[?exts]]]] where:hostport is a host name with an optional ":portnumber"dn is the search baseattrs is a comma separated list of attributes to requestscope is one of these three strings: base one sub (default=base)filter is filterexts are recognized set of LDAP and/or API extensions. Example: ldap://ldap.example.net/dc=example,dc=net?cn,sn?sub?(cn=*) URLs that are wrapped in angle-brackets and/or preceded by "URL:" are also tolerated. Alternative LDAP schemes such as ldaps:// and ldapi:// may be parsed using the below routines as well.ldap_is_ldap_url()returns a non-zero value ifurl looks like an LDAP URL (as opposed to some other kind of URL). It can be used as a quick check for an LDAP URL; theldap_url_parse()routine should be used if a more thorough check is needed.ldap_url_parse()breaks down an LDAP URL passed inurl into its component pieces. If successful, zero is returned, an LDAP URL description is allocated, filled in, andludpp is set to point to it. If an error occurs, a non-zero URL error code is returned.ldap_free_urldesc()should be called to free an LDAP URL description that was obtained from a call toldap_url_parse().
ldap(3)RFC 4516<http://www.rfc-editor.org/rfc/rfc4516.txt>
OpenLDAP Softwareis developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.OpenLDAP Softwareis derived from the University of Michigan LDAP 3.3 Release.
This page is part of theOpenLDAP (an open source implementation of the Lightweight Directory Access Protocol) project. Information about the project can be found at ⟨http://www.openldap.org/⟩. If you have a bug report for this manual page, see ⟨http://www.openldap.org/its/⟩. This page was obtained from the project's upstream Git repository ⟨https://git.openldap.org/openldap/openldap.git⟩ on 2025-08-11. (At that time, the date of the most recent commit that was found in the repository was 2025-08-05.) If you discover any rendering problems in this HTML version of the page, or you believe there is a better or more up-to-date source for the page, or you have corrections or improvements to the information in this COLOPHON (which isnot part of the original manual page), send a mail to man-pages@man7.orgOpenLDAP LDVERSION RELEASEDATELDAP_URL(3)Pages that refer to this page:ldapurl(1), ldap(3), ldap_bind(3)
HTML rendering created 2025-09-06 byMichael Kerrisk, author ofThe Linux Programming Interface. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH. | |