]> git.sur5r.net Git - openldap/blob - libraries/liblber/io.c
Add draft-ietf-ldapext-ldap-c-api-01 routines ber_init()
[openldap] / libraries / liblber / io.c
1 /* io.c - ber general i/o routines */
2 /*
3  * Copyright (c) 1990 Regents of the University of Michigan.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms are permitted
7  * provided that this notice is preserved and that due credit is given
8  * to the University of Michigan at Ann Arbor. The name of the University
9  * may not be used to endorse or promote products derived from this
10  * software without specific prior written permission. This software
11  * is provided ``as is'' without express or implied warranty.
12  */
13
14 #include "portable.h"
15
16 #include <stdio.h>
17 #include <stdlib.h>
18
19 #include <ac/ctype.h>
20 #include <ac/errno.h>
21 #include <ac/socket.h>
22 #include <ac/string.h>
23 #include <ac/unistd.h>
24
25 #ifdef HAVE_IO_H
26 #include <io.h>
27 #endif
28
29 #include "lber-int.h"
30
31 static int ber_realloc LDAP_P(( BerElement *ber, unsigned long len ));
32 static int ber_filbuf LDAP_P(( Sockbuf *sb, long len ));
33 static long BerRead LDAP_P(( Sockbuf *sb, char *buf, long len ));
34 #ifdef PCNFS
35 static int BerWrite LDAP_P(( Sockbuf *sb, char *buf, long len ));
36 #endif /* PCNFS */
37
38 #define bergetc( sb, len )    ( sb->sb_ber.ber_end > sb->sb_ber.ber_ptr ? \
39                           (unsigned char)*sb->sb_ber.ber_ptr++ : \
40                           ber_filbuf( sb, len ))
41
42 #ifdef MACOS
43 /*
44  * MacTCP/OpenTransport
45  */
46 #define read( s, b, l ) tcpread( s, 0, (unsigned char *)b, l, NULL )
47 #define MAX_WRITE       65535
48 #define BerWrite( sb, b, l )   tcpwrite( sb->sb_sd, (unsigned char *)(b), (l<MAX_WRITE)? l : MAX_WRITE )
49 #else /* MACOS */
50 #ifdef DOS
51 #ifdef PCNFS
52 /*
53  * PCNFS (under DOS)
54  */
55 #define read( s, b, l ) recv( s, b, l, 0 )
56 #define BerWrite( s, b, l ) send( s->sb_sd, b, (int) l, 0 )
57 #endif /* PCNFS */
58 #ifdef NCSA
59 /*
60  * NCSA Telnet TCP/IP stack (under DOS)
61  */
62 #define read( s, b, l ) nread( s, b, l )
63 #define BerWrite( s, b, l ) netwrite( s->sb_sd, b, l )
64 #endif /* NCSA */
65 #ifdef WINSOCK
66 /*
67  * Windows Socket API (under DOS/Windows 3.x)
68  */
69 #define read( s, b, l ) recv( s, b, l, 0 )
70 #define BerWrite( s, b, l ) send( s->sb_sd, b, l, 0 )
71 #endif /* WINSOCK */
72 #else /* DOS */
73 #ifdef _WIN32
74 /*
75  * 32-bit Windows Socket API (under Windows NT or Windows 95)
76  */
77 #define read( s, b, l )         recv( s, b, l, 0 )
78 #define BerWrite( s, b, l )     send( s->sb_sd, b, l, 0 )
79 #else /* _WIN32 */
80 #ifdef VMS
81 /*
82  * VMS -- each write must be 64K or smaller
83  */
84 #define MAX_WRITE 65535
85 #define BerWrite( sb, b, l ) write( sb->sb_sd, b, (l<MAX_WRITE)? l : MAX_WRITE)
86 #else /* VMS */
87 /*
88  * everything else (Unix/BSD 4.3 socket API)
89  */
90 #define BerWrite( sb, b, l )    write( sb->sb_sd, b, l )
91 #endif /* VMS */
92 #define udp_read( sb, b, l, al ) recvfrom(sb->sb_sd, (char *)b, l, 0, \
93                 (struct sockaddr *)sb->sb_fromaddr, \
94                 (al = sizeof(struct sockaddr), &al))
95 #define udp_write( sb, b, l ) sendto(sb->sb_sd, (char *)(b), l, 0, \
96                 (struct sockaddr *)sb->sb_useaddr, sizeof(struct sockaddr))
97 #endif /* _WIN32 */
98 #endif /* DOS */
99 #endif /* MACOS */
100
101 #ifndef udp_read
102 #define udp_read( sb, b, l, al )        CLDAP NOT SUPPORTED
103 #define udp_write( sb, b, l )           CLDAP NOT SUPPORTED
104 #endif /* udp_read */
105
106 #define EXBUFSIZ        1024
107
108 static int
109 ber_filbuf( Sockbuf *sb, long len )
110 {
111         short   rc;
112 #ifdef LDAP_CONNECTIONLESS
113         int     addrlen;
114 #endif /* LDAP_CONNECTIONLESS */
115
116         if ( sb->sb_ber.ber_buf == NULL ) {
117                 if ( (sb->sb_ber.ber_buf = (char *) malloc( READBUFSIZ )) ==
118                     NULL )
119                         return( -1 );
120                 sb->sb_ber.ber_ptr = sb->sb_ber.ber_buf;
121                 sb->sb_ber.ber_end = sb->sb_ber.ber_buf;
122         }
123
124         if ( sb->sb_naddr > 0 ) {
125 #ifdef LDAP_CONNECTIONLESS
126                 rc = udp_read(sb, sb->sb_ber.ber_buf, READBUFSIZ, addrlen );
127 #ifdef LDAP_DEBUG
128                 if ( lber_debug ) {
129                         fprintf( stderr, "ber_filbuf udp_read %d bytes\n",
130                                 rc );
131                         if ( lber_debug > 1 && rc > 0 )
132                                 lber_bprint( sb->sb_ber.ber_buf, rc );
133                 }
134 #endif /* LDAP_DEBUG */
135 #else /* LDAP_CONNECTIONLESS */
136                 rc = -1;
137 #endif /* LDAP_CONNECTIONLESS */
138         } else {
139                 rc = read( sb->sb_sd, sb->sb_ber.ber_buf,
140                         ((sb->sb_options & LBER_NO_READ_AHEAD) && (len < READBUFSIZ)) ?
141                                 len : READBUFSIZ );
142         }
143
144         if ( rc > 0 ) {
145                 sb->sb_ber.ber_ptr = sb->sb_ber.ber_buf + 1;
146                 sb->sb_ber.ber_end = sb->sb_ber.ber_buf + rc;
147                 return( (unsigned char)*sb->sb_ber.ber_buf );
148         }
149
150         return( -1 );
151 }
152
153
154 static long
155 BerRead( Sockbuf *sb, char *buf, long len )
156 {
157         int     c;
158         long    nread = 0;
159
160         while ( len > 0 ) {
161                 if ( (c = bergetc( sb, len )) < 0 ) {
162                         if ( nread > 0 )
163                                 break;
164                         return( c );
165                 }
166                 *buf++ = (char) c;
167                 nread++;
168                 len--;
169         }
170
171         return( nread );
172 }
173
174
175 long
176 ber_read( BerElement *ber, char *buf, unsigned long len )
177 {
178         unsigned long   actuallen, nleft;
179
180         nleft = ber->ber_end - ber->ber_ptr;
181         actuallen = nleft < len ? nleft : len;
182
183         SAFEMEMCPY( buf, ber->ber_ptr, (size_t)actuallen );
184
185         ber->ber_ptr += actuallen;
186
187         return( (long)actuallen );
188 }
189
190 long
191 ber_write( BerElement *ber, char *buf, unsigned long len, int nosos )
192 {
193         if ( nosos || ber->ber_sos == NULL ) {
194                 if ( ber->ber_ptr + len > ber->ber_end ) {
195                         if ( ber_realloc( ber, len ) != 0 )
196                                 return( -1 );
197                 }
198                 SAFEMEMCPY( ber->ber_ptr, buf, (size_t)len );
199                 ber->ber_ptr += len;
200                 return( len );
201         } else {
202                 if ( ber->ber_sos->sos_ptr + len > ber->ber_end ) {
203                         if ( ber_realloc( ber, len ) != 0 )
204                                 return( -1 );
205                 }
206                 SAFEMEMCPY( ber->ber_sos->sos_ptr, buf, (size_t)len );
207                 ber->ber_sos->sos_ptr += len;
208                 ber->ber_sos->sos_clen += len;
209                 return( len );
210         }
211 }
212
213 static int
214 ber_realloc( BerElement *ber, unsigned long len )
215 {
216         unsigned long   need, have, total;
217         Seqorset        *s;
218         long            off;
219         char            *oldbuf;
220
221         have = (ber->ber_end - ber->ber_buf) / EXBUFSIZ;
222         need = (len < EXBUFSIZ ? 1 : (len + (EXBUFSIZ - 1)) / EXBUFSIZ);
223         total = have * EXBUFSIZ + need * EXBUFSIZ;
224
225         oldbuf = ber->ber_buf;
226
227         if ( ber->ber_buf == NULL ) {
228                 if ( (ber->ber_buf = (char *) malloc( (size_t)total )) == NULL )
229                         return( -1 );
230         } else if ( (ber->ber_buf = (char *) realloc( ber->ber_buf,
231             (size_t)total )) == NULL )
232                 return( -1 );
233
234         ber->ber_end = ber->ber_buf + total;
235
236         /*
237          * If the stinking thing was moved, we need to go through and
238          * reset all the sos and ber pointers.  Offsets would've been
239          * a better idea... oh well.
240          */
241
242         if ( ber->ber_buf != oldbuf ) {
243                 ber->ber_ptr = ber->ber_buf + (ber->ber_ptr - oldbuf);
244
245                 for ( s = ber->ber_sos; s != NULLSEQORSET; s = s->sos_next ) {
246                         off = s->sos_first - oldbuf;
247                         s->sos_first = ber->ber_buf + off;
248
249                         off = s->sos_ptr - oldbuf;
250                         s->sos_ptr = ber->ber_buf + off;
251                 }
252         }
253
254         return( 0 );
255 }
256
257 void
258 ber_free( BerElement *ber, int freebuf )
259 {
260         if ( freebuf && ber->ber_buf != NULL )
261                 free( ber->ber_buf );
262         free( (char *) ber );
263 }
264
265 int
266 ber_flush( Sockbuf *sb, BerElement *ber, int freeit )
267 {
268         long    nwritten, towrite, rc;
269
270         if ( ber->ber_rwptr == NULL ) {
271                 ber->ber_rwptr = ber->ber_buf;
272         }
273         towrite = ber->ber_ptr - ber->ber_rwptr;
274
275 #ifdef LDAP_DEBUG
276         if ( lber_debug ) {
277                 fprintf( stderr, "ber_flush: %ld bytes to sd %ld%s\n", towrite,
278                     (long) sb->sb_sd, ber->ber_rwptr != ber->ber_buf ? " (re-flush)"
279                     : "" );
280                 if ( lber_debug > 1 )
281                         lber_bprint( ber->ber_rwptr, towrite );
282         }
283 #endif
284 #if !defined(MACOS) && !defined(DOS)
285         if ( sb->sb_options & (LBER_TO_FILE | LBER_TO_FILE_ONLY) ) {
286                 rc = write( sb->sb_fd, ber->ber_buf, towrite );
287                 if ( sb->sb_options & LBER_TO_FILE_ONLY ) {
288                         return( (int)rc );
289                 }
290         }
291 #endif
292
293         nwritten = 0;
294         do {
295                 if (sb->sb_naddr > 0) {
296 #ifdef LDAP_CONNECTIONLESS
297                         rc = udp_write( sb, ber->ber_buf + nwritten,
298                             (size_t)towrite );
299 #else /* LDAP_CONNECTIONLESS */
300                         rc = -1;
301 #endif /* LDAP_CONNECTIONLESS */
302                         if ( rc <= 0 )
303                                 return( -1 );
304
305                         /* fake error if write was not atomic */
306                         if (rc < towrite) {
307 #ifdef EMSGSIZE
308                             errno = EMSGSIZE;
309 #endif
310                             return( -1 );
311                         }
312                 } else {
313                         if ( (rc = BerWrite( sb, ber->ber_rwptr,
314                             (size_t) towrite )) <= 0 ) {
315                                 return( -1 );
316                         }
317                 }
318                 towrite -= rc;
319                 nwritten += rc;
320                 ber->ber_rwptr += rc;
321         } while ( towrite > 0 );
322
323         if ( freeit )
324                 ber_free( ber, 1 );
325
326         return( 0 );
327 }
328
329 BerElement *
330 ber_alloc_t( int options )
331 {
332         BerElement      *ber;
333
334         if ( (ber = (BerElement *) calloc( 1, sizeof(BerElement) )) == NULLBER )
335                 return( NULLBER );
336         ber->ber_tag = LBER_DEFAULT;
337         ber->ber_options = (char) options;
338
339         return( ber );
340 }
341
342 BerElement *
343 ber_alloc( void )
344 {
345         return( ber_alloc_t( 0 ) );
346 }
347
348 BerElement *
349 der_alloc( void )
350 {
351         return( ber_alloc_t( LBER_USE_DER ) );
352 }
353
354 BerElement *
355 ber_dup( BerElement *ber )
356 {
357         BerElement      *new;
358
359         if ( (new = ber_alloc()) == NULLBER )
360                 return( NULLBER );
361
362         *new = *ber;
363
364         return( new );
365 }
366
367
368 /* OLD U-Mich ber_init() */
369 void
370 ber_init_w_nullc( BerElement *ber, int options )
371 {
372         (void) memset( (char *)ber, '\0', sizeof( BerElement ));
373         ber->ber_tag = LBER_DEFAULT;
374         ber->ber_options = (char) options;
375 }
376
377 /* New C-API ber_init() */
378 /* This function constructs a BerElement containing a copy
379 ** of the data in the bv argument.
380 */
381 BerElement *
382 ber_init( struct berval *bv )
383 {
384         BerElement *ber;
385
386         if ( bv == NULL ) {
387                 return NULL;
388         }
389
390         ber = ber_alloc_t( 0 );
391
392         if( ber == NULLBER ) {
393                 /* allocation failed */
394                 return ( NULL );
395         }
396
397         /* copy the data */
398         if ( (ber_write ( ber, bv->bv_val, bv->bv_len, 0 )) != bv->bv_len ) {
399                 /* write failed, so free and return NULL */
400                 ber_free( ber, 1 );
401                 return( NULL );
402         }
403
404         ber_reset( ber, 1 );    /* reset the pointer to the start of the buffer */
405
406         return ( ber );
407 }
408
409 /* New C-API ber_flatten routine */
410 /* This routine allocates a struct berval whose contents are a BER
411 ** encoding taken from the ber argument.  The bvPtr pointer pointers to
412 ** the returned berval.
413 */
414 int ber_flatten(
415         BerElement *ber,
416         struct berval **bvPtr)
417 {
418         struct berval *bv;
419  
420         if(bvPtr == NULL) {
421                 return( -1 );
422         }
423
424         if ( (bv = malloc( sizeof(struct berval))) == NULL ) {
425                 return( -1 );
426         }
427
428         if ( ber == NULL ) {
429                 /* ber is null, create an empty berval */
430                 bv->bv_val = NULL;
431                 bv->bv_len = 0;
432
433         } else {
434                 /* copy the berval */
435                 ptrdiff_t len = ber->ber_ptr - ber->ber_buf;
436
437                 if ( (bv->bv_val = (char *) malloc( len + 1 )) == NULL ) {
438                         ber_bvfree( bv );
439                         return( -1 );
440                 }
441
442                 SAFEMEMCPY( bv->bv_val, ber->ber_buf, (size_t)len );
443                 bv->bv_val[len] = '\0';
444                 bv->bv_len = len;
445         }
446     
447         *bvPtr = bv;
448         return( 0 );
449 }
450
451 void
452 ber_reset( BerElement *ber, int was_writing )
453 {
454         if ( was_writing ) {
455                 ber->ber_end = ber->ber_ptr;
456                 ber->ber_ptr = ber->ber_buf;
457         } else {
458                 ber->ber_ptr = ber->ber_end;
459         }
460
461         ber->ber_rwptr = NULL;
462 }
463
464
465 #ifdef LDAP_DEBUG
466
467 void
468 ber_dump( BerElement *ber, int inout )
469 {
470         fprintf( stderr, "ber_dump: buf 0x%lx, ptr 0x%lx, end 0x%lx\n",
471             (long) ber->ber_buf,
472                 (long) ber->ber_ptr,
473                 (long) ber->ber_end );
474         if ( inout == 1 ) {
475                 fprintf( stderr, "          current len %ld, contents:\n",
476                     (long) (ber->ber_end - ber->ber_ptr) );
477                 lber_bprint( ber->ber_ptr, ber->ber_end - ber->ber_ptr );
478         } else {
479                 fprintf( stderr, "          current len %ld, contents:\n",
480                     (long) (ber->ber_ptr - ber->ber_buf) );
481                 lber_bprint( ber->ber_buf, ber->ber_ptr - ber->ber_buf );
482         }
483 }
484
485 void
486 ber_sos_dump( Seqorset *sos )
487 {
488         fprintf( stderr, "*** sos dump ***\n" );
489         while ( sos != NULLSEQORSET ) {
490                 fprintf( stderr, "ber_sos_dump: clen %ld first 0x%lx ptr 0x%lx\n",
491                     (long) sos->sos_clen, (long) sos->sos_first, (long) sos->sos_ptr );
492                 fprintf( stderr, "              current len %ld contents:\n",
493                     (long) (sos->sos_ptr - sos->sos_first) );
494                 lber_bprint( sos->sos_first, sos->sos_ptr - sos->sos_first );
495
496                 sos = sos->sos_next;
497         }
498         fprintf( stderr, "*** end dump ***\n" );
499 }
500
501 #endif
502
503 /* return the tag - LBER_DEFAULT returned means trouble */
504 static unsigned long
505 get_tag( Sockbuf *sb )
506 {
507         unsigned char   xbyte;
508         unsigned long   tag;
509         char            *tagp;
510         unsigned int    i;
511
512         if ( BerRead( sb, (char *) &xbyte, 1 ) != 1 )
513                 return( LBER_DEFAULT );
514
515         if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK )
516                 return( (unsigned long) xbyte );
517
518         tagp = (char *) &tag;
519         tagp[0] = xbyte;
520         for ( i = 1; i < sizeof(long); i++ ) {
521                 if ( BerRead( sb, (char *) &xbyte, 1 ) != 1 )
522                         return( LBER_DEFAULT );
523
524                 tagp[i] = xbyte;
525
526                 if ( ! (xbyte & LBER_MORE_TAG_MASK) )
527                         break;
528         }
529
530         /* tag too big! */
531         if ( i == sizeof(long) )
532                 return( LBER_DEFAULT );
533
534         /* want leading, not trailing 0's */
535         return( tag >> (sizeof(long) - i - 1) );
536 }
537
538 unsigned long
539 ber_get_next( Sockbuf *sb, unsigned long *len, BerElement *ber )
540 {
541         unsigned long   tag = 0, netlen, toread;
542         unsigned char   lc;
543         long            rc;
544         long            noctets;
545         unsigned int    diff;
546
547 #ifdef LDAP_DEBUG
548         if ( lber_debug )
549                 fprintf( stderr, "ber_get_next\n" );
550 #endif
551
552         /*
553          * Any ber element looks like this: tag length contents.
554          * Assuming everything's ok, we return the tag byte (we
555          * can assume a single byte), return the length in len,
556          * and the rest of the undecoded element in buf.
557          *
558          * Assumptions:
559          *      1) small tags (less than 128)
560          *      2) definite lengths
561          *      3) primitive encodings used whenever possible
562          */
563
564         /*
565          * first time through - malloc the buffer, set up ptrs, and
566          * read the tag and the length and as much of the rest as we can
567          */
568
569         if ( ber->ber_rwptr == NULL ) {
570                 /*
571                  * First, we read the tag.
572                  */
573
574                 if ( (tag = get_tag( sb )) == LBER_DEFAULT ) {
575                         return( LBER_DEFAULT );
576                 }
577                 ber->ber_tag = tag;
578
579                 /*
580                  * Next, read the length.  The first byte contains the length
581                  * of the length.  If bit 8 is set, the length is the long
582                  * form, otherwise it's the short form.  We don't allow a
583                  * length that's greater than what we can hold in an unsigned
584                  * long.
585                  */
586
587                 *len = netlen = 0;
588                 if ( BerRead( sb, (char *) &lc, 1 ) != 1 ) {
589                         return( LBER_DEFAULT );
590                 }
591                 if ( lc & 0x80 ) {
592                         noctets = (lc & 0x7f);
593                         if ( noctets > sizeof(unsigned long) )
594                                 return( LBER_DEFAULT );
595                         diff = sizeof(unsigned long) - noctets;
596                         if ( BerRead( sb, (char *) &netlen + diff, noctets ) !=
597                             noctets ) {
598                                 return( LBER_DEFAULT );
599                         }
600                         *len = AC_NTOHL( netlen );
601                 } else {
602                         *len = lc;
603                 }
604                 ber->ber_len = *len;
605
606                 /*
607                  * Finally, malloc a buffer for the contents and read it in.
608                  * It's this buffer that's passed to all the other ber decoding
609                  * routines.
610                  */
611
612 #if defined( DOS ) && !defined( _WIN32 )
613                 if ( *len > 65535 ) {   /* DOS can't allocate > 64K */
614                     return( LBER_DEFAULT );
615                 }
616 #endif /* DOS && !_WIN32 */
617
618                 if ( ( sb->sb_options & LBER_MAX_INCOMING_SIZE ) &&
619                     *len > (unsigned long) sb->sb_max_incoming ) {
620                         return( LBER_DEFAULT );
621                 }
622
623                 if ( (ber->ber_buf = (char *) malloc( (size_t)*len )) == NULL ) {
624                         return( LBER_DEFAULT );
625                 }
626                 ber->ber_ptr = ber->ber_buf;
627                 ber->ber_end = ber->ber_buf + *len;
628                 ber->ber_rwptr = ber->ber_buf;
629         }
630
631         toread = (unsigned long)ber->ber_end - (unsigned long)ber->ber_rwptr;
632         do {
633                 if ( (rc = BerRead( sb, ber->ber_rwptr, (long)toread )) <= 0 ) {
634                         return( LBER_DEFAULT );
635                 }
636
637                 toread -= rc;
638                 ber->ber_rwptr += rc;
639         } while ( toread > 0 );
640
641 #ifdef LDAP_DEBUG
642         if ( lber_debug ) {
643                 fprintf( stderr, "ber_get_next: tag 0x%lx len %ld contents:\n",
644                     tag, ber->ber_len );
645                 if ( lber_debug > 1 )
646                         ber_dump( ber, 1 );
647         }
648 #endif
649
650         *len = ber->ber_len;
651         ber->ber_rwptr = NULL;
652         return( ber->ber_tag );
653 }