]> git.sur5r.net Git - openldap/blob - libraries/libldap/url.c
30b15d11ddf5ed1c79b58f4ac4ea350316de024f
[openldap] / libraries / libldap / url.c
1 /* LIBLDAP url.c -- LDAP URL (RFC 4516) related routines */
2 /* $OpenLDAP$ */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4  *
5  * Copyright 1998-2007 The OpenLDAP Foundation.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted only as authorized by the OpenLDAP
10  * Public License.
11  *
12  * A copy of this license is available in the file LICENSE in the
13  * top-level directory of the distribution or, alternatively, at
14  * <http://www.OpenLDAP.org/license.html>.
15  */
16 /* Portions Copyright (c) 1996 Regents of the University of Michigan.
17  * All rights reserved.
18  */
19
20
21 /*
22  *  LDAP URLs look like this:
23  *    ldap[is]://host[:port][/[dn[?[attributes][?[scope][?[filter][?exts]]]]]]
24  *
25  *  where:
26  *   attributes is a comma separated list
27  *   scope is one of these three strings:  base one sub (default=base)
28  *   filter is an string-represented filter as in RFC 4515
29  *
30  *  e.g.,  ldap://host:port/dc=com?o,cn?base?(o=openldap)?extension
31  *
32  *  We also tolerate URLs that look like: <ldapurl> and <URL:ldapurl>
33  */
34
35 #include "portable.h"
36
37 #include <stdio.h>
38
39 #include <ac/stdlib.h>
40 #include <ac/ctype.h>
41
42 #include <ac/socket.h>
43 #include <ac/string.h>
44 #include <ac/time.h>
45
46 #include "ldap-int.h"
47
48 /* local functions */
49 static const char* skip_url_prefix LDAP_P((
50         const char *url,
51         int *enclosedp,
52         const char **scheme ));
53
54 int ldap_pvt_url_scheme2proto( const char *scheme )
55 {
56         assert( scheme != NULL );
57
58         if( scheme == NULL ) {
59                 return -1;
60         }
61
62         if( strcmp("ldap", scheme) == 0 ) {
63                 return LDAP_PROTO_TCP;
64         }
65
66         if( strcmp("ldapi", scheme) == 0 ) {
67                 return LDAP_PROTO_IPC;
68         }
69
70         if( strcmp("ldaps", scheme) == 0 ) {
71                 return LDAP_PROTO_TCP;
72         }
73 #ifdef LDAP_CONNECTIONLESS
74         if( strcmp("cldap", scheme) == 0 ) {
75                 return LDAP_PROTO_UDP;
76         }
77 #endif
78
79         return -1;
80 }
81
82 int ldap_pvt_url_scheme_port( const char *scheme, int port )
83 {
84         assert( scheme != NULL );
85
86         if( port ) return port;
87         if( scheme == NULL ) return port;
88
89         if( strcmp("ldap", scheme) == 0 ) {
90                 return LDAP_PORT;
91         }
92
93         if( strcmp("ldapi", scheme) == 0 ) {
94                 return -1;
95         }
96
97         if( strcmp("ldaps", scheme) == 0 ) {
98                 return LDAPS_PORT;
99         }
100
101 #ifdef LDAP_CONNECTIONLESS
102         if( strcmp("cldap", scheme) == 0 ) {
103                 return LDAP_PORT;
104         }
105 #endif
106
107         return -1;
108 }
109
110 int
111 ldap_pvt_url_scheme2tls( const char *scheme )
112 {
113         assert( scheme != NULL );
114
115         if( scheme == NULL ) {
116                 return -1;
117         }
118
119         return strcmp("ldaps", scheme) == 0;
120 }
121
122 int
123 ldap_is_ldap_url( LDAP_CONST char *url )
124 {
125         int     enclosed;
126         const char * scheme;
127
128         if( url == NULL ) {
129                 return 0;
130         }
131
132         if( skip_url_prefix( url, &enclosed, &scheme ) == NULL ) {
133                 return 0;
134         }
135
136         return 1;
137 }
138
139 int
140 ldap_is_ldaps_url( LDAP_CONST char *url )
141 {
142         int     enclosed;
143         const char * scheme;
144
145         if( url == NULL ) {
146                 return 0;
147         }
148
149         if( skip_url_prefix( url, &enclosed, &scheme ) == NULL ) {
150                 return 0;
151         }
152
153         return strcmp(scheme, "ldaps") == 0;
154 }
155
156 int
157 ldap_is_ldapi_url( LDAP_CONST char *url )
158 {
159         int     enclosed;
160         const char * scheme;
161
162         if( url == NULL ) {
163                 return 0;
164         }
165
166         if( skip_url_prefix( url, &enclosed, &scheme ) == NULL ) {
167                 return 0;
168         }
169
170         return strcmp(scheme, "ldapi") == 0;
171 }
172
173 #ifdef LDAP_CONNECTIONLESS
174 int
175 ldap_is_ldapc_url( LDAP_CONST char *url )
176 {
177         int     enclosed;
178         const char * scheme;
179
180         if( url == NULL ) {
181                 return 0;
182         }
183
184         if( skip_url_prefix( url, &enclosed, &scheme ) == NULL ) {
185                 return 0;
186         }
187
188         return strcmp(scheme, "cldap") == 0;
189 }
190 #endif
191
192 static const char*
193 skip_url_prefix(
194         const char *url,
195         int *enclosedp,
196         const char **scheme )
197 {
198         /*
199          * return non-zero if this looks like a LDAP URL; zero if not
200          * if non-zero returned, *urlp will be moved past "ldap://" part of URL
201          */
202         const char *p;
203
204         if ( url == NULL ) {
205                 return( NULL );
206         }
207
208         p = url;
209
210         /* skip leading '<' (if any) */
211         if ( *p == '<' ) {
212                 *enclosedp = 1;
213                 ++p;
214         } else {
215                 *enclosedp = 0;
216         }
217
218         /* skip leading "URL:" (if any) */
219         if ( strncasecmp( p, LDAP_URL_URLCOLON, LDAP_URL_URLCOLON_LEN ) == 0 ) {
220                 p += LDAP_URL_URLCOLON_LEN;
221         }
222
223         /* check for "ldap://" prefix */
224         if ( strncasecmp( p, LDAP_URL_PREFIX, LDAP_URL_PREFIX_LEN ) == 0 ) {
225                 /* skip over "ldap://" prefix and return success */
226                 p += LDAP_URL_PREFIX_LEN;
227                 *scheme = "ldap";
228                 return( p );
229         }
230
231         /* check for "ldaps://" prefix */
232         if ( strncasecmp( p, LDAPS_URL_PREFIX, LDAPS_URL_PREFIX_LEN ) == 0 ) {
233                 /* skip over "ldaps://" prefix and return success */
234                 p += LDAPS_URL_PREFIX_LEN;
235                 *scheme = "ldaps";
236                 return( p );
237         }
238
239         /* check for "ldapi://" prefix */
240         if ( strncasecmp( p, LDAPI_URL_PREFIX, LDAPI_URL_PREFIX_LEN ) == 0 ) {
241                 /* skip over "ldapi://" prefix and return success */
242                 p += LDAPI_URL_PREFIX_LEN;
243                 *scheme = "ldapi";
244                 return( p );
245         }
246
247 #ifdef LDAP_CONNECTIONLESS
248         /* check for "cldap://" prefix */
249         if ( strncasecmp( p, LDAPC_URL_PREFIX, LDAPC_URL_PREFIX_LEN ) == 0 ) {
250                 /* skip over "cldap://" prefix and return success */
251                 p += LDAPC_URL_PREFIX_LEN;
252                 *scheme = "cldap";
253                 return( p );
254         }
255 #endif
256
257         return( NULL );
258 }
259
260 int
261 ldap_pvt_scope2bv( int scope, struct berval *bv )
262 {
263         switch ( scope ) {
264         case LDAP_SCOPE_BASE:
265                 BER_BVSTR( bv, "base" );
266                 break;
267
268         case LDAP_SCOPE_ONELEVEL:
269                 BER_BVSTR( bv, "one" );
270                 break;
271
272         case LDAP_SCOPE_SUBTREE:
273                 BER_BVSTR( bv, "sub" );
274                 break;
275
276         case LDAP_SCOPE_SUBORDINATE:
277                 BER_BVSTR( bv, "subordinate" );
278                 break;
279
280         default:
281                 return LDAP_OTHER;
282         }
283
284         return LDAP_SUCCESS;
285 }
286
287 const char *
288 ldap_pvt_scope2str( int scope )
289 {
290         struct berval   bv;
291
292         if ( ldap_pvt_scope2bv( scope, &bv ) == LDAP_SUCCESS ) {
293                 return bv.bv_val;
294         }
295
296         return NULL;
297 }
298
299 int
300 ldap_pvt_bv2scope( struct berval *bv )
301 {
302         static struct {
303                 struct berval   bv;
304                 int             scope;
305         }       v[] = {
306                 { BER_BVC( "one" ),             LDAP_SCOPE_ONELEVEL },
307                 { BER_BVC( "onelevel" ),        LDAP_SCOPE_ONELEVEL },
308                 { BER_BVC( "base" ),            LDAP_SCOPE_BASE },
309                 { BER_BVC( "sub" ),             LDAP_SCOPE_SUBTREE },
310                 { BER_BVC( "subtree" ),         LDAP_SCOPE_SUBTREE },
311                 { BER_BVC( "subord" ),          LDAP_SCOPE_SUBORDINATE },
312                 { BER_BVC( "subordinate" ),     LDAP_SCOPE_SUBORDINATE },
313                 { BER_BVC( "children" ),        LDAP_SCOPE_SUBORDINATE },
314                 { BER_BVNULL,                   -1 }
315         };
316         int     i;
317
318         for ( i = 0; v[ i ].scope != -1; i++ ) {
319                 if ( ber_bvstrcasecmp( bv, &v[ i ].bv ) == 0 ) {
320                         return v[ i ].scope;
321                 }
322         }
323
324         return( -1 );
325 }
326
327 int
328 ldap_pvt_str2scope( const char *p )
329 {
330         struct berval   bv;
331
332         ber_str2bv( p, 0, 0, &bv );
333
334         return ldap_pvt_bv2scope( &bv );
335 }
336
337 static const char       hex[] = "0123456789ABCDEF";
338
339 #define URLESC_NONE     0x0000U
340 #define URLESC_COMMA    0x0001U
341 #define URLESC_SLASH    0x0002U
342
343 static int
344 hex_escape_len( const char *s, unsigned list )
345 {
346         int     len;
347
348         if ( s == NULL ) {
349                 return 0;
350         }
351
352         for ( len = 0; s[0]; s++ ) {
353                 switch ( s[0] ) {
354                 /* RFC 2396: reserved */
355                 case '?':
356                         len += 3;
357                         break;
358
359                 case ',':
360                         if ( list & URLESC_COMMA ) {
361                                 len += 3;
362                         } else {
363                                 len++;
364                         }
365                         break;
366
367                 case '/':
368                         if ( list & URLESC_SLASH ) {
369                                 len += 3;
370                         } else {
371                                 len++;
372                         }
373                         break;
374
375                 case ';':
376                 case ':':
377                 case '@':
378                 case '&':
379                 case '=':
380                 case '+':
381                 case '$':
382
383                 /* RFC 2396: unreserved mark */
384                 case '-':
385                 case '_':
386                 case '.':
387                 case '!':
388                 case '~':
389                 case '*':
390                 case '\'':
391                 case '(':
392                 case ')':
393                         len++;
394                         break;
395                         
396                 /* RFC 2396: unreserved alphanum */
397                 default:
398                         if ( !isalnum( (unsigned char) s[0] ) ) {
399                                 len += 3;
400                         } else {
401                                 len++;
402                         }
403                         break;
404                 }
405         }
406
407         return len;
408 }
409
410 static int
411 hex_escape( char *buf, int len, const char *s, unsigned list )
412 {
413         int     i;
414         int     pos;
415
416         if ( s == NULL ) {
417                 return 0;
418         }
419
420         for ( pos = 0, i = 0; s[i] && pos < len; i++ ) {
421                 int     escape = 0;
422
423                 switch ( s[i] ) {
424                 /* RFC 2396: reserved */
425                 case '?':
426                         escape = 1;
427                         break;
428
429                 case ',':
430                         if ( list & URLESC_COMMA ) {
431                                 escape = 1;
432                         }
433                         break;
434
435                 case '/':
436                         if ( list & URLESC_SLASH ) {
437                                 escape = 1;
438                         }
439                         break;
440
441                 case ';':
442                 case ':':
443                 case '@':
444                 case '&':
445                 case '=':
446                 case '+':
447                 case '$':
448
449                 /* RFC 2396: unreserved mark */
450                 case '-':
451                 case '_':
452                 case '.':
453                 case '!':
454                 case '~':
455                 case '*':
456                 case '\'':
457                 case '(':
458                 case ')':
459                         break;
460                         
461                 /* RFC 2396: unreserved alphanum */
462                 default:
463                         if ( !isalnum( (unsigned char) s[i] ) ) {
464                                 escape = 1;
465                         }
466                         break;
467                 }
468
469                 if ( escape ) {
470                         buf[pos++] = '%';
471                         buf[pos++] = hex[ (s[i] >> 4) & 0x0f ];
472                         buf[pos++] = hex[ s[i] & 0x0f ];
473
474                 } else {
475                         buf[pos++] = s[i];
476                 }
477         }
478
479         buf[pos] = '\0';
480
481         return pos;
482 }
483
484 static int
485 hex_escape_len_list( char **s, unsigned flags )
486 {
487         int     len;
488         int     i;
489
490         if ( s == NULL ) {
491                 return 0;
492         }
493
494         len = 0;
495         for ( i = 0; s[i] != NULL; i++ ) {
496                 if ( len ) {
497                         len++;
498                 }
499                 len += hex_escape_len( s[i], flags );
500         }
501
502         return len;
503 }
504
505 static int
506 hex_escape_list( char *buf, int len, char **s, unsigned flags )
507 {
508         int     pos;
509         int     i;
510
511         if ( s == NULL ) {
512                 return 0;
513         }
514
515         pos = 0;
516         for ( i = 0; s[i] != NULL; i++ ) {
517                 int     curlen;
518
519                 if ( pos ) {
520                         buf[pos++] = ',';
521                         len--;
522                 }
523                 curlen = hex_escape( &buf[pos], len, s[i], flags );
524                 len -= curlen;
525                 pos += curlen;
526         }
527
528         return pos;
529 }
530
531 static int
532 desc2str_len( LDAPURLDesc *u )
533 {
534         int             sep = 0;
535         int             len = 0;
536         int             is_ipc = 0;
537         struct berval   scope;
538
539         if ( u == NULL || u->lud_scheme == NULL ) {
540                 return -1;
541         }
542
543         if ( !strcmp( "ldapi", u->lud_scheme )) {
544                 is_ipc = 1;
545         }
546
547         if ( u->lud_exts ) {
548                 len += hex_escape_len_list( u->lud_exts, URLESC_COMMA );
549                 if ( !sep ) {
550                         sep = 5;
551                 }
552         }
553
554         if ( u->lud_filter ) {
555                 len +=  hex_escape_len( u->lud_filter, URLESC_NONE );
556                 if ( !sep ) {
557                         sep = 4;
558                 }
559         }
560
561         if ( ldap_pvt_scope2bv( u->lud_scope, &scope ) == LDAP_SUCCESS ) {
562                 len += scope.bv_len;
563                 if ( !sep ) {
564                         sep = 3;
565                 }
566         }
567
568         if ( u->lud_attrs ) {
569                 len +=  hex_escape_len_list( u->lud_attrs, URLESC_NONE );
570                 if ( !sep ) {
571                         sep = 2;
572                 }
573         }
574
575         if ( u->lud_dn && u->lud_dn[0] ) {
576                 len += hex_escape_len( u->lud_dn, URLESC_NONE );
577                 if ( !sep ) {
578                         sep = 1;
579                 }
580         };
581
582         len += sep;
583
584         if ( u->lud_port ) {
585                 char    buf[] = ":65535";
586
587                 len += snprintf( buf, sizeof( buf ), ":%d", u->lud_port );
588                 if ( u->lud_host && u->lud_host[0] ) {
589                         len += strlen( u->lud_host );
590                 }
591
592         } else {
593                 if ( u->lud_host && u->lud_host[0] ) {
594                         len += hex_escape_len( u->lud_host, URLESC_SLASH );
595                         if ( !is_ipc && strchr( u->lud_host, ':' )) {
596                                 len += 2;       /* IPv6, [] */
597                         }
598                 }
599         }
600
601         len += strlen( u->lud_scheme ) + STRLENOF( "://" );
602
603         return len;
604 }
605
606 static int
607 desc2str( LDAPURLDesc *u, char *s, int len )
608 {
609         int             i;
610         int             sep = 0;
611         int             sofar = 0;
612         int             is_v6 = 0;
613         int             is_ipc = 0;
614         struct berval   scope = BER_BVNULL;
615
616         if ( u == NULL ) {
617                 return -1;
618         }
619
620         if ( s == NULL ) {
621                 return -1;
622         }
623
624         if ( u->lud_scheme && !strcmp( "ldapi", u->lud_scheme )) {
625                 is_ipc = 1;
626         }
627
628         ldap_pvt_scope2bv( u->lud_scope, &scope );
629
630         if ( u->lud_exts ) {
631                 sep = 5;
632         } else if ( u->lud_filter ) {
633                 sep = 4;
634         } else if ( !BER_BVISEMPTY( &scope ) ) {
635                 sep = 3;
636         } else if ( u->lud_attrs ) {
637                 sep = 2;
638         } else if ( u->lud_dn && u->lud_dn[0] ) {
639                 sep = 1;
640         }
641
642         if ( !is_ipc && u->lud_host && strchr( u->lud_host, ':' )) {
643                 is_v6 = 1;
644         }
645
646         if ( u->lud_port ) {
647                 len -= sprintf( s, "%s://%s%s%s:%d%n", u->lud_scheme,
648                                 is_v6 ? "[" : "",
649                                 u->lud_host ? u->lud_host : "",
650                                 is_v6 ? "]" : "",
651                                 u->lud_port, &sofar );
652
653         } else {
654                 len -= sprintf( s, "%s://%n", u->lud_scheme, &sofar );
655                 if ( u->lud_host && u->lud_host[0] ) {
656                         if ( is_v6 ) {
657                                 s[sofar++] = '[';
658                                 len--;
659                         }
660                         i = hex_escape( &s[sofar], len, u->lud_host, URLESC_SLASH );
661                         sofar += i;
662                         len -= i;
663                         if ( is_v6 ) {
664                                 s[sofar++] = ']';
665                                 len--;
666                         }
667                 }
668         }
669
670         assert( len >= 0 );
671
672         if ( sep < 1 ) {
673                 goto done;
674         }
675
676         s[sofar++] = '/';
677         len--;
678
679         assert( len >= 0 );
680
681         if ( u->lud_dn && u->lud_dn[0] ) {
682                 i = hex_escape( &s[sofar], len, u->lud_dn, URLESC_NONE );
683                 sofar += i;
684                 len -= i;
685
686                 assert( len >= 0 );
687         }
688
689         if ( sep < 2 ) {
690                 goto done;
691         }
692         s[sofar++] = '?';
693         len--;
694
695         assert( len >= 0 );
696
697         i = hex_escape_list( &s[sofar], len, u->lud_attrs, URLESC_NONE );
698         sofar += i;
699         len -= i;
700
701         assert( len >= 0 );
702
703         if ( sep < 3 ) {
704                 goto done;
705         }
706         s[sofar++] = '?';
707         len--;
708
709         assert( len >= 0 );
710
711         if ( !BER_BVISNULL( &scope ) ) {
712                 strcpy( &s[sofar], scope.bv_val );
713                 sofar += scope.bv_len;
714                 len -= scope.bv_len;
715         }
716
717         assert( len >= 0 );
718
719         if ( sep < 4 ) {
720                 goto done;
721         }
722         s[sofar++] = '?';
723         len--;
724
725         assert( len >= 0 );
726
727         i = hex_escape( &s[sofar], len, u->lud_filter, URLESC_NONE );
728         sofar += i;
729         len -= i;
730
731         assert( len >= 0 );
732
733         if ( sep < 5 ) {
734                 goto done;
735         }
736         s[sofar++] = '?';
737         len--;
738
739         assert( len >= 0 );
740
741         i = hex_escape_list( &s[sofar], len, u->lud_exts, URLESC_COMMA );
742         sofar += i;
743         len -= i;
744
745         assert( len >= 0 );
746
747 done:
748         if ( len < 0 ) {
749                 return -1;
750         }
751
752         return sofar;
753 }
754
755 char *
756 ldap_url_desc2str( LDAPURLDesc *u )
757 {
758         int     len;
759         char    *s;
760
761         if ( u == NULL ) {
762                 return NULL;
763         }
764
765         len = desc2str_len( u );
766         if ( len < 0 ) {
767                 return NULL;
768         }
769         
770         /* allocate enough to hex escape everything -- overkill */
771         s = LDAP_MALLOC( len + 1 );
772
773         if ( s == NULL ) {
774                 return NULL;
775         }
776
777         if ( desc2str( u, s, len ) != len ) {
778                 LDAP_FREE( s );
779                 return NULL;
780         }
781
782         s[len] = '\0';
783
784         return s;
785 }
786
787 int
788 ldap_url_parse_ext( LDAP_CONST char *url_in, LDAPURLDesc **ludpp, unsigned flags )
789 {
790 /*
791  *  Pick apart the pieces of an LDAP URL.
792  */
793
794         LDAPURLDesc     *ludp;
795         char    *p, *q, *r;
796         int             i, enclosed, proto, is_v6 = 0;
797         const char *scheme = NULL;
798         const char *url_tmp;
799         char *url;
800
801         int     check_dn = 1;
802
803         if( url_in == NULL || ludpp == NULL ) {
804                 return LDAP_URL_ERR_PARAM;
805         }
806
807 #ifndef LDAP_INT_IN_KERNEL
808         /* Global options may not be created yet
809          * We can't test if the global options are initialized
810          * because a call to LDAP_INT_GLOBAL_OPT() will try to allocate
811          * the options and cause infinite recursion
812          */
813         Debug( LDAP_DEBUG_TRACE, "ldap_url_parse_ext(%s)\n", url_in, 0, 0 );
814 #endif
815
816         *ludpp = NULL;  /* pessimistic */
817
818         url_tmp = skip_url_prefix( url_in, &enclosed, &scheme );
819
820         if ( url_tmp == NULL ) {
821                 return LDAP_URL_ERR_BADSCHEME;
822         }
823
824         assert( scheme != NULL );
825
826         proto = ldap_pvt_url_scheme2proto( scheme );
827         if ( proto == -1 ) {
828                 return LDAP_URL_ERR_BADSCHEME;
829         }
830
831         /* make working copy of the remainder of the URL */
832         url = LDAP_STRDUP( url_tmp );
833         if ( url == NULL ) {
834                 return LDAP_URL_ERR_MEM;
835         }
836
837         if ( enclosed ) {
838                 p = &url[strlen(url)-1];
839
840                 if( *p != '>' ) {
841                         LDAP_FREE( url );
842                         return LDAP_URL_ERR_BADENCLOSURE;
843                 }
844
845                 *p = '\0';
846         }
847
848         /* allocate return struct */
849         ludp = (LDAPURLDesc *)LDAP_CALLOC( 1, sizeof( LDAPURLDesc ));
850
851         if ( ludp == NULL ) {
852                 LDAP_FREE( url );
853                 return LDAP_URL_ERR_MEM;
854         }
855
856         ludp->lud_next = NULL;
857         ludp->lud_host = NULL;
858         ludp->lud_port = 0;
859         ludp->lud_dn = NULL;
860         ludp->lud_attrs = NULL;
861         ludp->lud_scope = ( flags & LDAP_PVT_URL_PARSE_NODEF_SCOPE ) ? LDAP_SCOPE_BASE : LDAP_SCOPE_DEFAULT;
862         ludp->lud_filter = NULL;
863         ludp->lud_exts = NULL;
864
865         ludp->lud_scheme = LDAP_STRDUP( scheme );
866
867         if ( ludp->lud_scheme == NULL ) {
868                 LDAP_FREE( url );
869                 ldap_free_urldesc( ludp );
870                 return LDAP_URL_ERR_MEM;
871         }
872
873         /* scan forward for '/' that marks end of hostport and begin. of dn */
874         p = strchr( url, '/' );
875         q = NULL;
876
877         if( p != NULL ) {
878                 /* terminate hostport; point to start of dn */
879                 *p++ = '\0';
880         } else {
881                 /* check for Novell kludge, see below */
882                 p = strchr( url, '?' );
883                 if ( p ) {
884                         *p++ = '\0';
885                         q = p;
886                         p = NULL;
887                 }
888         }
889
890         if ( proto != LDAP_PROTO_IPC ) {
891                 /* IPv6 syntax with [ip address]:port */
892                 if ( *url == '[' ) {
893                         r = strchr( url, ']' );
894                         if ( r == NULL ) {
895                                 LDAP_FREE( url );
896                                 ldap_free_urldesc( ludp );
897                                 return LDAP_URL_ERR_BADURL;
898                         }
899                         *r++ = '\0';
900                         q = strchr( r, ':' );
901                         if ( q && q != r ) {
902                                 LDAP_FREE( url );
903                                 ldap_free_urldesc( ludp );
904                                 return LDAP_URL_ERR_BADURL;
905                         }
906                         is_v6 = 1;
907                 } else {
908                         q = strchr( url, ':' );
909                 }
910
911                 if ( q != NULL ) {
912                         char    *next;
913
914                         *q++ = '\0';
915                         ldap_pvt_hex_unescape( q );
916
917                         if( *q == '\0' ) {
918                                 LDAP_FREE( url );
919                                 ldap_free_urldesc( ludp );
920                                 return LDAP_URL_ERR_BADURL;
921                         }
922
923                         ludp->lud_port = strtol( q, &next, 10 );
924                         if ( next == q || next[0] != '\0' ) {
925                                 LDAP_FREE( url );
926                                 ldap_free_urldesc( ludp );
927                                 return LDAP_URL_ERR_BADURL;
928                         }
929                         /* check for Novell kludge */
930                         if ( !p ) {
931                                 q = next+1;
932                         }
933                 }
934
935                 if ( ( flags & LDAP_PVT_URL_PARSE_DEF_PORT ) && ludp->lud_port == 0 ) {
936                         if ( strcmp( ludp->lud_scheme, "ldaps" ) == 0 ) {
937                                 ludp->lud_port = LDAPS_PORT;
938                         } else {
939                                 ludp->lud_port = LDAP_PORT;
940                         }
941                 }
942         }
943
944         ldap_pvt_hex_unescape( url );
945
946         /* If [ip address]:port syntax, url is [ip and we skip the [ */
947         ludp->lud_host = LDAP_STRDUP( url + is_v6 );
948
949         if( ludp->lud_host == NULL ) {
950                 LDAP_FREE( url );
951                 ldap_free_urldesc( ludp );
952                 return LDAP_URL_ERR_MEM;
953         }
954
955         if ( ( flags & LDAP_PVT_URL_PARSE_NOEMPTY_HOST )
956                 && ludp->lud_host != NULL
957                 && *ludp->lud_host == '\0' )
958         {
959                 LDAP_FREE( ludp->lud_host );
960                 ludp->lud_host = NULL;
961         }
962
963         /*
964          * Kludge.  ldap://111.222.333.444:389??cn=abc,o=company
965          *
966          * On early Novell releases, search references/referrals were returned
967          * in this format, i.e., the dn was kind of in the scope position,
968          * but the required slash is missing. The whole thing is illegal syntax,
969          * but we need to account for it. Fortunately it can't be confused with
970          * anything real.
971          */
972         if( (p == NULL) && (q != NULL) && (*q == '?') ) {
973                 /* ? immediately followed by question */
974                 q++;
975                 if( *q != '\0' ) {
976                         /* parse dn part */
977                         ldap_pvt_hex_unescape( q );
978                         ludp->lud_dn = LDAP_STRDUP( q );
979
980                 } else if ( !( flags & LDAP_PVT_URL_PARSE_NOEMPTY_DN ) ) {
981                         ludp->lud_dn = LDAP_STRDUP( "" );
982
983                 } else {
984                         check_dn = 0;
985                 }
986
987                 if ( check_dn && ludp->lud_dn == NULL ) {
988                         LDAP_FREE( url );
989                         ldap_free_urldesc( ludp );
990                         return LDAP_URL_ERR_MEM;
991                 }
992         }
993
994         if( p == NULL ) {
995                 LDAP_FREE( url );
996                 *ludpp = ludp;
997                 return LDAP_URL_SUCCESS;
998         }
999
1000         /* scan forward for '?' that may marks end of dn */
1001         q = strchr( p, '?' );
1002
1003         if( q != NULL ) {
1004                 /* terminate dn part */
1005                 *q++ = '\0';
1006         }
1007
1008         if( *p != '\0' ) {
1009                 /* parse dn part */
1010                 ldap_pvt_hex_unescape( p );
1011                 ludp->lud_dn = LDAP_STRDUP( p );
1012
1013         } else if ( !( flags & LDAP_PVT_URL_PARSE_NOEMPTY_DN ) ) {
1014                 ludp->lud_dn = LDAP_STRDUP( "" );
1015
1016         } else {
1017                 check_dn = 0;
1018         }
1019
1020         if( check_dn && ludp->lud_dn == NULL ) {
1021                 LDAP_FREE( url );
1022                 ldap_free_urldesc( ludp );
1023                 return LDAP_URL_ERR_MEM;
1024         }
1025
1026         if( q == NULL ) {
1027                 /* no more */
1028                 LDAP_FREE( url );
1029                 *ludpp = ludp;
1030                 return LDAP_URL_SUCCESS;
1031         }
1032
1033         /* scan forward for '?' that may marks end of attributes */
1034         p = q;
1035         q = strchr( p, '?' );
1036
1037         if( q != NULL ) {
1038                 /* terminate attributes part */
1039                 *q++ = '\0';
1040         }
1041
1042         if( *p != '\0' ) {
1043                 /* parse attributes */
1044                 ldap_pvt_hex_unescape( p );
1045                 ludp->lud_attrs = ldap_str2charray( p, "," );
1046
1047                 if( ludp->lud_attrs == NULL ) {
1048                         LDAP_FREE( url );
1049                         ldap_free_urldesc( ludp );
1050                         return LDAP_URL_ERR_BADATTRS;
1051                 }
1052         }
1053
1054         if ( q == NULL ) {
1055                 /* no more */
1056                 LDAP_FREE( url );
1057                 *ludpp = ludp;
1058                 return LDAP_URL_SUCCESS;
1059         }
1060
1061         /* scan forward for '?' that may marks end of scope */
1062         p = q;
1063         q = strchr( p, '?' );
1064
1065         if( q != NULL ) {
1066                 /* terminate the scope part */
1067                 *q++ = '\0';
1068         }
1069
1070         if( *p != '\0' ) {
1071                 /* parse the scope */
1072                 ldap_pvt_hex_unescape( p );
1073                 ludp->lud_scope = ldap_pvt_str2scope( p );
1074
1075                 if( ludp->lud_scope == -1 ) {
1076                         LDAP_FREE( url );
1077                         ldap_free_urldesc( ludp );
1078                         return LDAP_URL_ERR_BADSCOPE;
1079                 }
1080         }
1081
1082         if ( q == NULL ) {
1083                 /* no more */
1084                 LDAP_FREE( url );
1085                 *ludpp = ludp;
1086                 return LDAP_URL_SUCCESS;
1087         }
1088
1089         /* scan forward for '?' that may marks end of filter */
1090         p = q;
1091         q = strchr( p, '?' );
1092
1093         if( q != NULL ) {
1094                 /* terminate the filter part */
1095                 *q++ = '\0';
1096         }
1097
1098         if( *p != '\0' ) {
1099                 /* parse the filter */
1100                 ldap_pvt_hex_unescape( p );
1101
1102                 if( ! *p ) {
1103                         /* missing filter */
1104                         LDAP_FREE( url );
1105                         ldap_free_urldesc( ludp );
1106                         return LDAP_URL_ERR_BADFILTER;
1107                 }
1108
1109                 ludp->lud_filter = LDAP_STRDUP( p );
1110
1111                 if( ludp->lud_filter == NULL ) {
1112                         LDAP_FREE( url );
1113                         ldap_free_urldesc( ludp );
1114                         return LDAP_URL_ERR_MEM;
1115                 }
1116         }
1117
1118         if ( q == NULL ) {
1119                 /* no more */
1120                 LDAP_FREE( url );
1121                 *ludpp = ludp;
1122                 return LDAP_URL_SUCCESS;
1123         }
1124
1125         /* scan forward for '?' that may marks end of extensions */
1126         p = q;
1127         q = strchr( p, '?' );
1128
1129         if( q != NULL ) {
1130                 /* extra '?' */
1131                 LDAP_FREE( url );
1132                 ldap_free_urldesc( ludp );
1133                 return LDAP_URL_ERR_BADURL;
1134         }
1135
1136         /* parse the extensions */
1137         ludp->lud_exts = ldap_str2charray( p, "," );
1138
1139         if( ludp->lud_exts == NULL ) {
1140                 LDAP_FREE( url );
1141                 ldap_free_urldesc( ludp );
1142                 return LDAP_URL_ERR_BADEXTS;
1143         }
1144
1145         for( i=0; ludp->lud_exts[i] != NULL; i++ ) {
1146                 ldap_pvt_hex_unescape( ludp->lud_exts[i] );
1147
1148                 if( *ludp->lud_exts[i] == '!' ) {
1149                         /* count the number of critical extensions */
1150                         ludp->lud_crit_exts++;
1151                 }
1152         }
1153
1154         if( i == 0 ) {
1155                 /* must have 1 or more */
1156                 LDAP_FREE( url );
1157                 ldap_free_urldesc( ludp );
1158                 return LDAP_URL_ERR_BADEXTS;
1159         }
1160
1161         /* no more */
1162         *ludpp = ludp;
1163         LDAP_FREE( url );
1164         return LDAP_URL_SUCCESS;
1165 }
1166
1167 int
1168 ldap_url_parse( LDAP_CONST char *url_in, LDAPURLDesc **ludpp )
1169 {
1170         return ldap_url_parse_ext( url_in, ludpp, LDAP_PVT_URL_PARSE_HISTORIC );
1171 }
1172
1173 LDAPURLDesc *
1174 ldap_url_dup ( LDAPURLDesc *ludp )
1175 {
1176         LDAPURLDesc *dest;
1177
1178         if ( ludp == NULL ) {
1179                 return NULL;
1180         }
1181
1182         dest = LDAP_MALLOC( sizeof(LDAPURLDesc) );
1183         if (dest == NULL)
1184                 return NULL;
1185         
1186         *dest = *ludp;
1187         dest->lud_scheme = NULL;
1188         dest->lud_host = NULL;
1189         dest->lud_dn = NULL;
1190         dest->lud_filter = NULL;
1191         dest->lud_attrs = NULL;
1192         dest->lud_exts = NULL;
1193         dest->lud_next = NULL;
1194
1195         if ( ludp->lud_scheme != NULL ) {
1196                 dest->lud_scheme = LDAP_STRDUP( ludp->lud_scheme );
1197                 if (dest->lud_scheme == NULL) {
1198                         ldap_free_urldesc(dest);
1199                         return NULL;
1200                 }
1201         }
1202
1203         if ( ludp->lud_host != NULL ) {
1204                 dest->lud_host = LDAP_STRDUP( ludp->lud_host );
1205                 if (dest->lud_host == NULL) {
1206                         ldap_free_urldesc(dest);
1207                         return NULL;
1208                 }
1209         }
1210
1211         if ( ludp->lud_dn != NULL ) {
1212                 dest->lud_dn = LDAP_STRDUP( ludp->lud_dn );
1213                 if (dest->lud_dn == NULL) {
1214                         ldap_free_urldesc(dest);
1215                         return NULL;
1216                 }
1217         }
1218
1219         if ( ludp->lud_filter != NULL ) {
1220                 dest->lud_filter = LDAP_STRDUP( ludp->lud_filter );
1221                 if (dest->lud_filter == NULL) {
1222                         ldap_free_urldesc(dest);
1223                         return NULL;
1224                 }
1225         }
1226
1227         if ( ludp->lud_attrs != NULL ) {
1228                 dest->lud_attrs = ldap_charray_dup( ludp->lud_attrs );
1229                 if (dest->lud_attrs == NULL) {
1230                         ldap_free_urldesc(dest);
1231                         return NULL;
1232                 }
1233         }
1234
1235         if ( ludp->lud_exts != NULL ) {
1236                 dest->lud_exts = ldap_charray_dup( ludp->lud_exts );
1237                 if (dest->lud_exts == NULL) {
1238                         ldap_free_urldesc(dest);
1239                         return NULL;
1240                 }
1241         }
1242
1243         return dest;
1244 }
1245
1246 LDAPURLDesc *
1247 ldap_url_duplist (LDAPURLDesc *ludlist)
1248 {
1249         LDAPURLDesc *dest, *tail, *ludp, *newludp;
1250
1251         dest = NULL;
1252         tail = NULL;
1253         for (ludp = ludlist; ludp != NULL; ludp = ludp->lud_next) {
1254                 newludp = ldap_url_dup(ludp);
1255                 if (newludp == NULL) {
1256                         ldap_free_urllist(dest);
1257                         return NULL;
1258                 }
1259                 if (tail == NULL)
1260                         dest = newludp;
1261                 else
1262                         tail->lud_next = newludp;
1263                 tail = newludp;
1264         }
1265         return dest;
1266 }
1267
1268 static int
1269 ldap_url_parselist_int (LDAPURLDesc **ludlist, const char *url, const char *sep, unsigned flags )
1270         
1271 {
1272         int i, rc;
1273         LDAPURLDesc *ludp;
1274         char **urls;
1275
1276         assert( ludlist != NULL );
1277         assert( url != NULL );
1278
1279         *ludlist = NULL;
1280
1281         if ( sep == NULL ) {
1282                 sep = ", ";
1283         }
1284
1285         urls = ldap_str2charray( url, sep );
1286         if (urls == NULL)
1287                 return LDAP_URL_ERR_MEM;
1288
1289         /* count the URLs... */
1290         for (i = 0; urls[i] != NULL; i++) ;
1291         /* ...and put them in the "stack" backward */
1292         while (--i >= 0) {
1293                 rc = ldap_url_parse_ext( urls[i], &ludp, flags );
1294                 if ( rc != 0 ) {
1295                         ldap_charray_free( urls );
1296                         ldap_free_urllist( *ludlist );
1297                         *ludlist = NULL;
1298                         return rc;
1299                 }
1300                 ludp->lud_next = *ludlist;
1301                 *ludlist = ludp;
1302         }
1303         ldap_charray_free( urls );
1304         return LDAP_URL_SUCCESS;
1305 }
1306
1307 int
1308 ldap_url_parselist (LDAPURLDesc **ludlist, const char *url )
1309 {
1310         return ldap_url_parselist_int( ludlist, url, ", ", LDAP_PVT_URL_PARSE_HISTORIC );
1311 }
1312
1313 int
1314 ldap_url_parselist_ext (LDAPURLDesc **ludlist, const char *url, const char *sep, unsigned flags )
1315 {
1316         return ldap_url_parselist_int( ludlist, url, sep, flags );
1317 }
1318
1319 int
1320 ldap_url_parsehosts(
1321         LDAPURLDesc **ludlist,
1322         const char *hosts,
1323         int port )
1324 {
1325         int i;
1326         LDAPURLDesc *ludp;
1327         char **specs, *p;
1328
1329         assert( ludlist != NULL );
1330         assert( hosts != NULL );
1331
1332         *ludlist = NULL;
1333
1334         specs = ldap_str2charray(hosts, ", ");
1335         if (specs == NULL)
1336                 return LDAP_NO_MEMORY;
1337
1338         /* count the URLs... */
1339         for (i = 0; specs[i] != NULL; i++) /* EMPTY */;
1340
1341         /* ...and put them in the "stack" backward */
1342         while (--i >= 0) {
1343                 ludp = LDAP_CALLOC( 1, sizeof(LDAPURLDesc) );
1344                 if (ludp == NULL) {
1345                         ldap_charray_free(specs);
1346                         ldap_free_urllist(*ludlist);
1347                         *ludlist = NULL;
1348                         return LDAP_NO_MEMORY;
1349                 }
1350                 ludp->lud_port = port;
1351                 ludp->lud_host = specs[i];
1352                 specs[i] = NULL;
1353                 p = strchr(ludp->lud_host, ':');
1354                 if (p != NULL) {
1355                         /* more than one :, IPv6 address */
1356                         if ( strchr(p+1, ':') != NULL ) {
1357                                 /* allow [address] and [address]:port */
1358                                 if ( *ludp->lud_host == '[' ) {
1359                                         p = LDAP_STRDUP(ludp->lud_host+1);
1360                                         /* copied, make sure we free source later */
1361                                         specs[i] = ludp->lud_host;
1362                                         ludp->lud_host = p;
1363                                         p = strchr( ludp->lud_host, ']' );
1364                                         if ( p == NULL ) {
1365                                                 LDAP_FREE(ludp);
1366                                                 ldap_charray_free(specs);
1367                                                 return LDAP_PARAM_ERROR;
1368                                         }
1369                                         *p++ = '\0';
1370                                         if ( *p != ':' ) {
1371                                                 if ( *p != '\0' ) {
1372                                                         LDAP_FREE(ludp);
1373                                                         ldap_charray_free(specs);
1374                                                         return LDAP_PARAM_ERROR;
1375                                                 }
1376                                                 p = NULL;
1377                                         }
1378                                 } else {
1379                                         p = NULL;
1380                                 }
1381                         }
1382                         if (p != NULL) {
1383                                 char    *next;
1384
1385                                 *p++ = 0;
1386                                 ldap_pvt_hex_unescape(p);
1387                                 ludp->lud_port = strtol( p, &next, 10 );
1388                                 if ( next == p || next[0] != '\0' ) {
1389                                         LDAP_FREE(ludp);
1390                                         ldap_charray_free(specs);
1391                                         return LDAP_PARAM_ERROR;
1392                                 }
1393                         }
1394                 }
1395                 ldap_pvt_hex_unescape(ludp->lud_host);
1396                 ludp->lud_scheme = LDAP_STRDUP("ldap");
1397                 ludp->lud_next = *ludlist;
1398                 *ludlist = ludp;
1399         }
1400
1401         /* this should be an array of NULLs now */
1402         /* except entries starting with [ */
1403         ldap_charray_free(specs);
1404         return LDAP_SUCCESS;
1405 }
1406
1407 char *
1408 ldap_url_list2hosts (LDAPURLDesc *ludlist)
1409 {
1410         LDAPURLDesc *ludp;
1411         int size;
1412         char *s, *p, buf[32];   /* big enough to hold a long decimal # (overkill) */
1413
1414         if (ludlist == NULL)
1415                 return NULL;
1416
1417         /* figure out how big the string is */
1418         size = 1;       /* nul-term */
1419         for (ludp = ludlist; ludp != NULL; ludp = ludp->lud_next) {
1420                 size += strlen(ludp->lud_host) + 1;             /* host and space */
1421                 if (strchr(ludp->lud_host, ':'))        /* will add [ ] below */
1422                         size += 2;
1423                 if (ludp->lud_port != 0)
1424                         size += sprintf(buf, ":%d", ludp->lud_port);
1425         }
1426         s = LDAP_MALLOC(size);
1427         if (s == NULL)
1428                 return NULL;
1429
1430         p = s;
1431         for (ludp = ludlist; ludp != NULL; ludp = ludp->lud_next) {
1432                 if (strchr(ludp->lud_host, ':')) {
1433                         p += sprintf(p, "[%s]", ludp->lud_host);
1434                 } else {
1435                         strcpy(p, ludp->lud_host);
1436                         p += strlen(ludp->lud_host);
1437                 }
1438                 if (ludp->lud_port != 0)
1439                         p += sprintf(p, ":%d", ludp->lud_port);
1440                 *p++ = ' ';
1441         }
1442         if (p != s)
1443                 p--;    /* nuke that extra space */
1444         *p = 0;
1445         return s;
1446 }
1447
1448 char *
1449 ldap_url_list2urls(
1450         LDAPURLDesc *ludlist )
1451 {
1452         LDAPURLDesc     *ludp;
1453         int             size, sofar;
1454         char            *s;
1455
1456         if ( ludlist == NULL ) {
1457                 return NULL;
1458         }
1459
1460         /* figure out how big the string is */
1461         for ( size = 0, ludp = ludlist; ludp != NULL; ludp = ludp->lud_next ) {
1462                 int     len = desc2str_len( ludp );
1463                 if ( len < 0 ) {
1464                         return NULL;
1465                 }
1466                 size += len + 1;
1467         }
1468         
1469         s = LDAP_MALLOC( size );
1470
1471         if ( s == NULL ) {
1472                 return NULL;
1473         }
1474
1475         for ( sofar = 0, ludp = ludlist; ludp != NULL; ludp = ludp->lud_next ) {
1476                 int     len;
1477
1478                 len = desc2str( ludp, &s[sofar], size );
1479                 
1480                 if ( len < 0 ) {
1481                         LDAP_FREE( s );
1482                         return NULL;
1483                 }
1484
1485                 sofar += len;
1486                 size -= len;
1487
1488                 s[sofar++] = ' ';
1489                 size--;
1490
1491                 assert( size >= 0 );
1492         }
1493
1494         s[sofar - 1] = '\0';
1495
1496         return s;
1497 }
1498
1499 void
1500 ldap_free_urllist( LDAPURLDesc *ludlist )
1501 {
1502         LDAPURLDesc *ludp, *next;
1503
1504         for (ludp = ludlist; ludp != NULL; ludp = next) {
1505                 next = ludp->lud_next;
1506                 ldap_free_urldesc(ludp);
1507         }
1508 }
1509
1510 void
1511 ldap_free_urldesc( LDAPURLDesc *ludp )
1512 {
1513         if ( ludp == NULL ) {
1514                 return;
1515         }
1516         
1517         if ( ludp->lud_scheme != NULL ) {
1518                 LDAP_FREE( ludp->lud_scheme );
1519         }
1520
1521         if ( ludp->lud_host != NULL ) {
1522                 LDAP_FREE( ludp->lud_host );
1523         }
1524
1525         if ( ludp->lud_dn != NULL ) {
1526                 LDAP_FREE( ludp->lud_dn );
1527         }
1528
1529         if ( ludp->lud_filter != NULL ) {
1530                 LDAP_FREE( ludp->lud_filter);
1531         }
1532
1533         if ( ludp->lud_attrs != NULL ) {
1534                 LDAP_VFREE( ludp->lud_attrs );
1535         }
1536
1537         if ( ludp->lud_exts != NULL ) {
1538                 LDAP_VFREE( ludp->lud_exts );
1539         }
1540
1541         LDAP_FREE( ludp );
1542 }
1543
1544 static int
1545 ldap_int_is_hexpair( char *s )
1546 {
1547         int     i;
1548
1549         for ( i = 0; i < 2; i++ ) {
1550                 if ( s[i] >= '0' && s[i] <= '9' ) {
1551                         continue;
1552                 }
1553
1554                 if ( s[i] >= 'A' && s[i] <= 'F' ) {
1555                         continue;
1556                 }
1557
1558                 if ( s[i] >= 'a' && s[i] <= 'f' ) {
1559                         continue;
1560                 }
1561
1562                 return 0;
1563         }
1564         
1565         return 1;       
1566 }
1567         
1568 static int
1569 ldap_int_unhex( int c )
1570 {
1571         return( c >= '0' && c <= '9' ? c - '0'
1572             : c >= 'A' && c <= 'F' ? c - 'A' + 10
1573             : c - 'a' + 10 );
1574 }
1575
1576 void
1577 ldap_pvt_hex_unescape( char *s )
1578 {
1579         /*
1580          * Remove URL hex escapes from s... done in place.  The basic concept for
1581          * this routine is borrowed from the WWW library HTUnEscape() routine.
1582          */
1583         char    *p,
1584                 *save_s = s;
1585
1586         for ( p = s; *s != '\0'; ++s ) {
1587                 if ( *s == '%' ) {
1588                         /*
1589                          * FIXME: what if '%' is followed
1590                          * by non-hexpair chars?
1591                          */
1592                         if ( !ldap_int_is_hexpair( s + 1 ) ) {
1593                                 p = save_s;
1594                                 break;
1595                         }
1596
1597                         if ( *++s == '\0' ) {
1598                                 break;
1599                         }
1600                         *p = ldap_int_unhex( *s ) << 4;
1601                         if ( *++s == '\0' ) {
1602                                 break;
1603                         }
1604                         *p++ += ldap_int_unhex( *s );
1605                 } else {
1606                         *p++ = *s;
1607                 }
1608         }
1609
1610         *p = '\0';
1611 }
1612