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