3 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 * Copyright (c) 1996 Regents of the University of Michigan.
10 * LIBLDAP url.c -- LDAP URL (RFC 2255) related routines
12 * LDAP URLs look like this:
13 * ldap[is]://host:port[/[dn[?[attributes][?[scope][?[filter][?exts]]]]]]
16 * attributes is a comma separated list
17 * scope is one of these three strings: base one sub (default=base)
18 * filter is an string-represented filter as in RFC 2254
20 * e.g., ldap://host:port/dc=com?o,cn?base?o=openldap?extension
22 * We also tolerate URLs that look like: <ldapurl> and <URL:ldapurl>
29 #include <ac/stdlib.h>
31 #include <ac/socket.h>
32 #include <ac/string.h>
39 static const char* skip_url_prefix LDAP_P((
42 const char **scheme ));
44 int ldap_pvt_url_scheme2proto( const char *scheme )
48 if( scheme == NULL ) {
52 if( strcmp("ldap", scheme) == 0 ) {
53 return LDAP_PROTO_TCP;
56 if( strcmp("ldapi", scheme) == 0 ) {
57 return LDAP_PROTO_IPC;
60 if( strcmp("ldaps", scheme) == 0 ) {
61 return LDAP_PROTO_TCP;
67 int ldap_pvt_url_scheme2tls( const char *scheme )
71 if( scheme == NULL ) {
75 return strcmp("ldaps", scheme) == 0;
79 ldap_is_ldap_url( LDAP_CONST char *url )
88 if( skip_url_prefix( url, &enclosed, &scheme ) == NULL ) {
96 ldap_is_ldaps_url( LDAP_CONST char *url )
105 if( skip_url_prefix( url, &enclosed, &scheme ) == NULL ) {
109 return strcmp(scheme, "ldaps") == 0;
113 ldap_is_ldapi_url( LDAP_CONST char *url )
122 if( skip_url_prefix( url, &enclosed, &scheme ) == NULL ) {
126 return strcmp(scheme, "ldapi") == 0;
133 const char **scheme )
136 * return non-zero if this looks like a LDAP URL; zero if not
137 * if non-zero returned, *urlp will be moved past "ldap://" part of URL
147 /* skip leading '<' (if any) */
155 /* skip leading "URL:" (if any) */
156 if ( strncasecmp( p, LDAP_URL_URLCOLON, LDAP_URL_URLCOLON_LEN ) == 0 )
158 p += LDAP_URL_URLCOLON_LEN;
161 /* check for "ldap://" prefix */
162 if ( strncasecmp( p, LDAP_URL_PREFIX, LDAP_URL_PREFIX_LEN ) == 0 ) {
163 /* skip over "ldap://" prefix and return success */
164 p += LDAP_URL_PREFIX_LEN;
169 /* check for "ldaps://" prefix */
170 if ( strncasecmp( p, LDAPS_URL_PREFIX, LDAPS_URL_PREFIX_LEN ) == 0 ) {
171 /* skip over "ldaps://" prefix and return success */
172 p += LDAPS_URL_PREFIX_LEN;
177 /* check for "ldapi://" prefix */
178 if ( strncasecmp( p, LDAPI_URL_PREFIX, LDAPI_URL_PREFIX_LEN ) == 0 ) {
179 /* skip over "ldapi://" prefix and return success */
180 p += LDAPI_URL_PREFIX_LEN;
189 static int str2scope( const char *p )
191 if ( strcasecmp( p, "one" ) == 0 ) {
192 return LDAP_SCOPE_ONELEVEL;
194 } else if ( strcasecmp( p, "onetree" ) == 0 ) {
195 return LDAP_SCOPE_ONELEVEL;
197 } else if ( strcasecmp( p, "base" ) == 0 ) {
198 return LDAP_SCOPE_BASE;
200 } else if ( strcasecmp( p, "sub" ) == 0 ) {
201 return LDAP_SCOPE_SUBTREE;
203 } else if ( strcasecmp( p, "subtree" ) == 0 ) {
204 return LDAP_SCOPE_SUBTREE;
212 ldap_url_parse( LDAP_CONST char *url_in, LDAPURLDesc **ludpp )
215 * Pick apart the pieces of an LDAP URL.
221 const char *scheme = NULL;
225 if( url_in == NULL && ludpp == NULL ) {
226 return LDAP_URL_ERR_PARAM;
229 #ifndef LDAP_INT_IN_KERNEL
230 /* Global options may not be created yet
231 * We can't test if the global options are initialized
232 * because a call to LDAP_INT_GLOBAL_OPT() will try to allocate
233 * the options and cause infinite recursion
235 Debug( LDAP_DEBUG_TRACE, "ldap_url_parse(%s)\n", url_in, 0, 0 );
238 *ludpp = NULL; /* pessimistic */
240 url_tmp = skip_url_prefix( url_in, &enclosed, &scheme );
242 if ( url_tmp == NULL ) {
243 return LDAP_URL_ERR_BADSCHEME;
248 /* make working copy of the remainder of the URL */
249 url = LDAP_STRDUP( url_tmp );
251 return LDAP_URL_ERR_MEM;
255 p = &url[strlen(url)-1];
259 return LDAP_URL_ERR_BADENCLOSURE;
265 /* allocate return struct */
266 ludp = (LDAPURLDesc *)LDAP_CALLOC( 1, sizeof( LDAPURLDesc ));
268 if ( ludp == NULL ) {
270 return LDAP_URL_ERR_MEM;
273 ludp->lud_next = NULL;
274 ludp->lud_host = NULL;
275 ludp->lud_port = LDAP_PORT;
277 ludp->lud_attrs = NULL;
278 ludp->lud_filter = NULL;
279 ludp->lud_scope = LDAP_SCOPE_BASE;
280 ludp->lud_filter = NULL;
282 ludp->lud_scheme = LDAP_STRDUP( scheme );
284 if ( ludp->lud_scheme == NULL ) {
286 ldap_free_urldesc( ludp );
287 return LDAP_URL_ERR_MEM;
290 if( strcasecmp( ludp->lud_scheme, "ldaps" ) == 0 ) {
291 ludp->lud_port = LDAPS_PORT;
294 /* scan forward for '/' that marks end of hostport and begin. of dn */
295 p = strchr( url, '/' );
298 /* terminate hostport; point to start of dn */
302 /* IPv6 syntax with [ip address]:port */
304 r = strchr( url, ']' );
307 ldap_free_urldesc( ludp );
308 return LDAP_URL_ERR_BADURL;
311 q = strchr( r, ':' );
313 q = strchr( url, ':' );
318 ldap_pvt_hex_unescape( q );
322 ldap_free_urldesc( ludp );
323 return LDAP_URL_ERR_BADURL;
326 ludp->lud_port = atoi( q );
329 ldap_pvt_hex_unescape( url );
331 /* If [ip address]:port syntax, url is [ip and we skip the [ */
332 ludp->lud_host = LDAP_STRDUP( url + ( *url == '[' ) );
334 if( ludp->lud_host == NULL ) {
336 ldap_free_urldesc( ludp );
337 return LDAP_URL_ERR_MEM;
341 * Kludge. ldap://111.222.333.444:389??cn=abc,o=company
343 * On early Novell releases, search references/referrals were returned
344 * in this format, i.e., the dn was kind of in the scope position,
345 * but the required slash is missing. The whole thing is illegal syntax,
346 * but we need to account for it. Fortunately it can't be confused with
349 if( (p == NULL) && (q != NULL) && ((q = strchr( q, '?')) != NULL)) {
351 /* ? immediately followed by question */
356 ldap_pvt_hex_unescape( q );
357 ludp->lud_dn = LDAP_STRDUP( q );
359 ludp->lud_dn = LDAP_STRDUP( "" );
362 if( ludp->lud_dn == NULL ) {
364 ldap_free_urldesc( ludp );
365 return LDAP_URL_ERR_MEM;
373 return LDAP_URL_SUCCESS;
376 /* scan forward for '?' that may marks end of dn */
377 q = strchr( p, '?' );
380 /* terminate dn part */
386 ldap_pvt_hex_unescape( p );
387 ludp->lud_dn = LDAP_STRDUP( p );
389 ludp->lud_dn = LDAP_STRDUP( "" );
392 if( ludp->lud_dn == NULL ) {
394 ldap_free_urldesc( ludp );
395 return LDAP_URL_ERR_MEM;
402 return LDAP_URL_SUCCESS;
405 /* scan forward for '?' that may marks end of attributes */
407 q = strchr( p, '?' );
410 /* terminate attributes part */
415 /* parse attributes */
416 ldap_pvt_hex_unescape( p );
417 ludp->lud_attrs = ldap_str2charray( p, "," );
419 if( ludp->lud_attrs == NULL ) {
421 ldap_free_urldesc( ludp );
422 return LDAP_URL_ERR_BADATTRS;
430 return LDAP_URL_SUCCESS;
433 /* scan forward for '?' that may marks end of scope */
435 q = strchr( p, '?' );
438 /* terminate the scope part */
443 /* parse the scope */
444 ldap_pvt_hex_unescape( p );
445 ludp->lud_scope = str2scope( p );
447 if( ludp->lud_scope == -1 ) {
449 ldap_free_urldesc( ludp );
450 return LDAP_URL_ERR_BADSCOPE;
458 return LDAP_URL_SUCCESS;
461 /* scan forward for '?' that may marks end of filter */
463 q = strchr( p, '?' );
466 /* terminate the filter part */
471 /* parse the filter */
472 ldap_pvt_hex_unescape( p );
477 ldap_free_urldesc( ludp );
478 return LDAP_URL_ERR_BADFILTER;
481 LDAP_FREE( ludp->lud_filter );
482 ludp->lud_filter = LDAP_STRDUP( p );
484 if( ludp->lud_filter == NULL ) {
486 ldap_free_urldesc( ludp );
487 return LDAP_URL_ERR_MEM;
495 return LDAP_URL_SUCCESS;
498 /* scan forward for '?' that may marks end of extensions */
500 q = strchr( p, '?' );
505 ldap_free_urldesc( ludp );
506 return LDAP_URL_ERR_BADURL;
509 /* parse the extensions */
510 ludp->lud_exts = ldap_str2charray( p, "," );
512 if( ludp->lud_exts == NULL ) {
514 ldap_free_urldesc( ludp );
515 return LDAP_URL_ERR_BADEXTS;
518 for( i=0; ludp->lud_exts[i] != NULL; i++ ) {
519 ldap_pvt_hex_unescape( ludp->lud_exts[i] );
523 /* must have 1 or more */
524 ldap_charray_free( ludp->lud_exts );
526 ldap_free_urldesc( ludp );
527 return LDAP_URL_ERR_BADEXTS;
533 return LDAP_URL_SUCCESS;
537 ldap_url_dup ( LDAPURLDesc *ludp )
541 if ( ludp == NULL ) {
545 dest = LDAP_MALLOC( sizeof(LDAPURLDesc) );
550 dest->lud_scheme = NULL;
551 dest->lud_host = NULL;
553 dest->lud_filter = NULL;
554 dest->lud_attrs = NULL;
555 dest->lud_exts = NULL;
556 dest->lud_next = NULL;
558 if ( ludp->lud_scheme != NULL ) {
559 dest->lud_scheme = LDAP_STRDUP( ludp->lud_scheme );
560 if (dest->lud_scheme == NULL) {
561 ldap_free_urldesc(dest);
566 if ( ludp->lud_host != NULL ) {
567 dest->lud_host = LDAP_STRDUP( ludp->lud_host );
568 if (dest->lud_host == NULL) {
569 ldap_free_urldesc(dest);
574 if ( ludp->lud_dn != NULL ) {
575 dest->lud_dn = LDAP_STRDUP( ludp->lud_dn );
576 if (dest->lud_dn == NULL) {
577 ldap_free_urldesc(dest);
582 if ( ludp->lud_filter != NULL ) {
583 dest->lud_filter = LDAP_STRDUP( ludp->lud_filter );
584 if (dest->lud_filter == NULL) {
585 ldap_free_urldesc(dest);
590 if ( ludp->lud_attrs != NULL ) {
591 dest->lud_attrs = ldap_charray_dup( ludp->lud_attrs );
592 if (dest->lud_attrs == NULL) {
593 ldap_free_urldesc(dest);
598 if ( ludp->lud_exts != NULL ) {
599 dest->lud_exts = ldap_charray_dup( ludp->lud_exts );
600 if (dest->lud_exts == NULL) {
601 ldap_free_urldesc(dest);
610 ldap_url_duplist (LDAPURLDesc *ludlist)
612 LDAPURLDesc *dest, *tail, *ludp, *newludp;
616 for (ludp = ludlist; ludp != NULL; ludp = ludp->lud_next) {
617 newludp = ldap_url_dup(ludp);
618 if (newludp == NULL) {
619 ldap_free_urllist(dest);
625 tail->lud_next = newludp;
632 ldap_url_parselist (LDAPURLDesc **ludlist, const char *url )
641 return LDAP_PARAM_ERROR;
643 urls = ldap_str2charray((char *)url, ", ");
645 return LDAP_NO_MEMORY;
647 /* count the URLs... */
648 for (i = 0; urls[i] != NULL; i++) ;
649 /* ...and put them in the "stack" backward */
651 rc = ldap_url_parse( urls[i], &ludp );
653 ldap_charray_free(urls);
654 ldap_free_urllist(*ludlist);
658 ludp->lud_next = *ludlist;
661 ldap_charray_free(urls);
667 LDAPURLDesc **ludlist,
678 return LDAP_PARAM_ERROR;
680 specs = ldap_str2charray((char *)hosts, ", ");
682 return LDAP_NO_MEMORY;
684 /* count the URLs... */
685 for (i = 0; specs[i] != NULL; i++) /* EMPTY */;
687 /* ...and put them in the "stack" backward */
689 ludp = LDAP_CALLOC( 1, sizeof(LDAPURLDesc) );
691 ldap_charray_free(specs);
692 ldap_free_urllist(*ludlist);
694 return LDAP_NO_MEMORY;
696 ludp->lud_port = port;
697 ludp->lud_host = specs[i];
699 p = strchr(ludp->lud_host, ':');
701 /* more than one :, IPv6 address */
702 if ( strchr(p+1, ':') != NULL ) {
703 /* allow [address] and [address]:port */
704 if ( *ludp->lud_host == '[' ) {
705 p = LDAP_STRDUP(ludp->lud_host+1);
706 /* copied, make sure we free source later */
707 specs[i] = ludp->lud_host;
709 p = strchr( ludp->lud_host, ']' );
711 return LDAP_PARAM_ERROR;
715 return LDAP_PARAM_ERROR;
724 ldap_pvt_hex_unescape(p);
725 ludp->lud_port = atoi(p);
728 ldap_pvt_hex_unescape(ludp->lud_host);
729 ludp->lud_scheme = LDAP_STRDUP("ldap");
730 ludp->lud_next = *ludlist;
734 /* this should be an array of NULLs now */
735 /* except entries starting with [ */
736 ldap_charray_free(specs);
741 ldap_url_list2hosts (LDAPURLDesc *ludlist)
745 char *s, *p, buf[32]; /* big enough to hold a long decimal # (overkill) */
750 /* figure out how big the string is */
751 size = 1; /* nul-term */
752 for (ludp = ludlist; ludp != NULL; ludp = ludp->lud_next) {
753 size += strlen(ludp->lud_host) + 1; /* host and space */
754 if (strchr(ludp->lud_host, ':')) /* will add [ ] below */
756 if (ludp->lud_port != 0)
757 size += sprintf(buf, ":%d", ludp->lud_port);
759 s = LDAP_MALLOC(size);
764 for (ludp = ludlist; ludp != NULL; ludp = ludp->lud_next) {
765 if (strchr(ludp->lud_host, ':')) {
766 p += sprintf(p, "[%s]", ludp->lud_host);
768 strcpy(p, ludp->lud_host);
769 p += strlen(ludp->lud_host);
771 if (ludp->lud_port != 0)
772 p += sprintf(p, ":%d", ludp->lud_port);
776 p--; /* nuke that extra space */
783 LDAPURLDesc *ludlist )
787 char *s, *p, buf[32]; /* big enough to hold a long decimal # (overkill) */
792 /* figure out how big the string is */
793 size = 1; /* nul-term */
794 for (ludp = ludlist; ludp != NULL; ludp = ludp->lud_next) {
795 size += strlen(ludp->lud_scheme) + strlen(ludp->lud_host);
796 if (strchr(ludp->lud_host, ':')) /* will add [ ] below */
798 size += sizeof(":/// ");
800 if (ludp->lud_port != 0) {
801 size += sprintf(buf, ":%d", ludp->lud_port);
805 s = LDAP_MALLOC(size);
811 for (ludp = ludlist; ludp != NULL; ludp = ludp->lud_next) {
813 strchr(ludp->lud_host, ':') ? "%s://[%s]" : "%s://%s",
814 ludp->lud_scheme, ludp->lud_host);
815 if (ludp->lud_port != 0)
816 p += sprintf(p, ":%d", ludp->lud_port);
821 p--; /* nuke that extra space */
827 ldap_free_urllist( LDAPURLDesc *ludlist )
829 LDAPURLDesc *ludp, *next;
831 for (ludp = ludlist; ludp != NULL; ludp = next) {
832 next = ludp->lud_next;
833 ldap_free_urldesc(ludp);
838 ldap_free_urldesc( LDAPURLDesc *ludp )
840 if ( ludp == NULL ) {
844 if ( ludp->lud_scheme != NULL ) {
845 LDAP_FREE( ludp->lud_scheme );
848 if ( ludp->lud_host != NULL ) {
849 LDAP_FREE( ludp->lud_host );
852 if ( ludp->lud_dn != NULL ) {
853 LDAP_FREE( ludp->lud_dn );
856 if ( ludp->lud_filter != NULL ) {
857 LDAP_FREE( ludp->lud_filter);
860 if ( ludp->lud_attrs != NULL ) {
861 LDAP_VFREE( ludp->lud_attrs );
864 if ( ludp->lud_exts != NULL ) {
865 LDAP_VFREE( ludp->lud_exts );
874 ldap_url_search( LDAP *ld, LDAP_CONST char *url, int attrsonly )
881 if ( ldap_url_parse( url, &ludp ) != 0 ) {
882 ld->ld_errno = LDAP_PARAM_ERROR;
886 ber = ldap_build_search_req( ld, ludp->lud_dn, ludp->lud_scope,
887 ludp->lud_filter, ludp->lud_attrs, attrsonly, NULL, NULL,
893 bind.ri_request = LDAP_REQ_SEARCH;
894 bind.ri_msgid = ld->ld_msgid;
895 bind.ri_url = (char *)url;
896 err = ldap_send_server_request(
897 ld, ber, ld->ld_msgid, NULL,
898 (ludp->lud_host != NULL || ludp->lud_port != 0)
903 ldap_free_urldesc( ludp );
909 ldap_url_search_st( LDAP *ld, LDAP_CONST char *url, int attrsonly,
910 struct timeval *timeout, LDAPMessage **res )
914 if (( msgid = ldap_url_search( ld, url, attrsonly )) == -1 ) {
915 return( ld->ld_errno );
918 if ( ldap_result( ld, msgid, 1, timeout, res ) == -1 ) {
919 return( ld->ld_errno );
922 if ( ld->ld_errno == LDAP_TIMEOUT ) {
923 (void) ldap_abandon( ld, msgid );
924 ld->ld_errno = LDAP_TIMEOUT;
925 return( ld->ld_errno );
928 return( ldap_result2error( ld, *res, 0 ));
934 LDAP *ld, LDAP_CONST char *url, int attrsonly, LDAPMessage **res )
938 if (( msgid = ldap_url_search( ld, url, attrsonly )) == -1 ) {
939 return( ld->ld_errno );
942 if ( ldap_result( ld, msgid, 1, (struct timeval *)NULL, res ) == -1 ) {
943 return( ld->ld_errno );
946 return( ldap_result2error( ld, *res, 0 ));
951 ldap_pvt_hex_unescape( char *s )
954 * Remove URL hex escapes from s... done in place. The basic concept for
955 * this routine is borrowed from the WWW library HTUnEscape() routine.
959 for ( p = s; *s != '\0'; ++s ) {
961 if ( *++s != '\0' ) {
962 *p = ldap_pvt_unhex( *s ) << 4;
964 if ( *++s != '\0' ) {
965 *p++ += ldap_pvt_unhex( *s );
977 ldap_pvt_unhex( int c )
979 return( c >= '0' && c <= '9' ? c - '0'
980 : c >= 'A' && c <= 'F' ? c - 'A' + 10