Seth Woolley's Man Viewer

ldap_url(3) - ldap_free_urldesc, ldap_is_ldap_url, ldap_url_parse - LDAP Uniform Resource Locator routines - man 3 ldap_url

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

LDAP_URL(3)                                                        LDAP_URL(3)



NAME
       ldap_is_ldap_url,  ldap_url_parse,  ldap_free_urldesc  -  LDAP  Uniform
       Resource Locator routines

LIBRARY
       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS
       #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(1,5) to contact */
           int         lud_port;       /* port on host(1,5) */
           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(1,3x,3x curs_util) */
           char **     lud_exts;       /* LDAP extensions */
           int         lud_crit_exts;  /* true if(3,n) any extension is critical */
           /* may contain additional fields for internal use */
       } LDAPURLDesc;

       ldap_free_urldesc( LDAPURLDesc *ludp )

DESCRIPTION
       These routines support the use of LDAP URLs (Uniform Resource Locators)
       as detailed in(1,8) RFC 2255.  LDAP URLs look(1,8,3 Search::Dict) like this:

         ldap://hostport/dn[?attrs[?scope[?filter(1,3x,3x curs_util)[?exts]]]]

       where:
         hostport is a host(1,5) name with an optional ":portnumber"
         dn is the search base
         attrs is a comma separated list of attributes to request
         scope is one of these three strings:
           base one sub (default=base)
         filter(1,3x,3x curs_util) is filter(1,3x,3x curs_util)
         exts are recognized set(7,n,1 builtins) of LDAP and/or API extensions.

       Example:
         ldap://ldap.example.net/dc=example,dc=net?cn,sn?sub?(cn=*)


       URLs  that  are wrapped in(1,8) angle-brackets and/or preceded by "URL:" are
       also tolerated.  Alternative schemes such as ldaps:// and ldapi://  may
       be parsed using the below routines as well.

       ldap_is_ldap_url()  returns  a non-zero value if(3,n) url 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; the ldap_url_parse() routine should be used if(3,n) a
       more thorough check is needed.

       ldap_url_parse() breaks down an LDAP URL passed in(1,8) url into its  compo-
       nent  pieces.  If successful, zero is returned, an LDAP URL description
       is allocated, filled in(1,8), and ludpp is set(7,n,1 builtins) to point to it.  If an  error(8,n)
       occurs, a non-zero URL error(8,n) code is returned.

       ldap_free_urldesc()  should  be  called to free an LDAP URL description
       that was obtained from a call to ldap_url_parse().

SEE ALSO
       ldap(3,5,n)(3)

       The LDAP URL Format, RFC 2255, Tim Howes and Mark Smith, December 1997.

ACKNOWLEDGEMENTS
       OpenLDAP   is   developed   and  maintained  by  The  OpenLDAP  Project
       (http://www.openldap.org/).  OpenLDAP is  derived  from  University  of
       Michigan LDAP 3.3 Release.



OpenLDAP LDVERSION                RELEASEDATE                      LDAP_URL(3)

References for this manual (incoming links)