]> git.sur5r.net Git - openldap/blob - libraries/liblber/io.c
Prep for in-place parsing. Cache a ber_tag byte.
[openldap] / libraries / liblber / io.c
1 /* io.c - ber general i/o routines */
2 /* $OpenLDAP$ */
3 /*
4  * Copyright 1998-2002 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
38 BerRead(
39         Sockbuf *sb,
40         unsigned char *buf,
41         ber_len_t len )
42 {
43         ber_slen_t      c;
44         ber_slen_t      nread = 0;
45
46         assert( sb != NULL );
47         assert( buf != NULL );
48
49         assert( SOCKBUF_VALID( sb ) );
50
51         while ( len > 0 ) {
52                 if ( (c = ber_int_sb_read( sb, buf, len )) <= 0 ) {
53                         if ( nread > 0 )
54                                 break;
55                         return( c );
56                 }
57                 buf+=c;
58                 nread+=c;
59                 len-=c;
60         }
61
62         return( nread );
63 }
64
65 ber_slen_t
66 ber_read(
67         BerElement *ber,
68         char *buf,
69         ber_len_t len )
70 {
71         ber_len_t       actuallen, nleft;
72
73         assert( ber != NULL );
74         assert( buf != NULL );
75
76         assert( LBER_VALID( ber ) );
77
78         nleft = ber_pvt_ber_remaining( ber );
79         actuallen = nleft < len ? nleft : len;
80
81         AC_MEMCPY( buf, ber->ber_ptr, actuallen );
82
83         ber->ber_ptr += actuallen;
84
85         return( (ber_slen_t) actuallen );
86 }
87
88 ber_slen_t
89 ber_write(
90         BerElement *ber,
91         LDAP_CONST char *buf,
92         ber_len_t len,
93         int nosos )
94 {
95         assert( ber != NULL );
96         assert( buf != NULL );
97
98         assert( LBER_VALID( ber ) );
99
100         if ( nosos || ber->ber_sos == NULL ) {
101                 if ( ber->ber_ptr + len > ber->ber_end ) {
102                         if ( ber_realloc( ber, len ) != 0 )
103                                 return( -1 );
104                 }
105                 AC_MEMCPY( ber->ber_ptr, buf, (size_t)len );
106                 ber->ber_ptr += len;
107                 return( (ber_slen_t) len );
108
109         } else {
110                 if ( ber->ber_sos->sos_ptr + len > ber->ber_end ) {
111                         if ( ber_realloc( ber, len ) != 0 )
112                                 return( -1 );
113                 }
114                 AC_MEMCPY( ber->ber_sos->sos_ptr, buf, (size_t)len );
115                 ber->ber_sos->sos_ptr += len;
116                 ber->ber_sos->sos_clen += len;
117                 return( (ber_slen_t) len );
118         }
119 }
120
121 int
122 ber_realloc( BerElement *ber, ber_len_t len )
123 {
124         ber_len_t       total;
125         Seqorset        *s;
126         long            off;
127         char            *oldbuf;
128
129         assert( ber != NULL );
130         assert( len > 0 );
131         assert( LBER_VALID( ber ) );
132
133         total = ber_pvt_ber_total( ber );
134
135 #define LBER_EXBUFSIZ   1000 /* a few words less than 2^N for binary buddy */
136 #if defined( LBER_EXBUFSIZ ) && LBER_EXBUFSIZ > 0
137 # ifndef notdef
138         /* don't realloc by small amounts */
139         total += len < LBER_EXBUFSIZ ? LBER_EXBUFSIZ : len;
140 # else
141         {       /* not sure what value this adds */
142                 ber_len_t have = (total + (LBER_EXBUFSIZE - 1)) / LBER_EXBUFSIZ;
143                 ber_len_t need = (len + (LBER_EXBUFSIZ - 1)) / LBER_EXBUFSIZ;
144                 total = ( have + need ) * LBER_EXBUFSIZ;
145         }
146 # endif
147 #else
148         total += len;   /* realloc just what's needed */
149 #endif
150
151         oldbuf = ber->ber_buf;
152
153         ber->ber_buf = (char *) LBER_REALLOC( oldbuf, total );
154         
155         if ( ber->ber_buf == NULL ) {
156                 ber->ber_buf = oldbuf;
157                 return( -1 );
158         }
159
160         ber->ber_end = ber->ber_buf + total;
161
162         /*
163          * If the stinking thing was moved, we need to go through and
164          * reset all the sos and ber pointers.  Offsets would've been
165          * a better idea... oh well.
166          */
167
168         if ( ber->ber_buf != oldbuf ) {
169                 ber->ber_ptr = ber->ber_buf + (ber->ber_ptr - oldbuf);
170
171                 for ( s = ber->ber_sos; s != NULL; s = s->sos_next ) {
172                         off = s->sos_first - oldbuf;
173                         s->sos_first = ber->ber_buf + off;
174
175                         off = s->sos_ptr - oldbuf;
176                         s->sos_ptr = ber->ber_buf + off;
177                 }
178         }
179
180         return( 0 );
181 }
182
183 void
184 ber_free_buf( BerElement *ber )
185 {
186         Seqorset *s, *next;
187
188         assert( LBER_VALID( ber ) );
189
190         if ( ber->ber_buf) LBER_FREE( ber->ber_buf );
191
192         for( s = ber->ber_sos ; s != NULL ; s = next ) {
193                 next = s->sos_next;
194                 LBER_FREE( s );
195         }
196
197         ber->ber_buf = NULL;
198         ber->ber_sos = NULL;
199         ber->ber_valid = LBER_UNINITIALIZED;
200 }
201
202 void
203 ber_free( BerElement *ber, int freebuf )
204 {
205 #ifdef LDAP_MEMORY_DEBUG
206         assert( ber != NULL );
207 #endif
208
209         if( ber == NULL ) {
210                 return;
211         }
212
213         if( freebuf )
214                 ber_free_buf( ber );
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( sb ) );
229         assert( LBER_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 #ifdef NEW_LOGGING
238                 LDAP_LOG(( "liblber", LDAP_LEVEL_DETAIL1,
239                            "ber_flush: %ld bytes to sd %ld%s\n",
240                            towrite, (long)sb->sb_fd,
241                            ber->ber_rwptr != ber->ber_buf ? " (re-flush)" : "" ));
242                 BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
243 #else
244                 ber_log_printf( LDAP_DEBUG_ANY, sb->sb_debug,
245                         "ber_flush: %ld bytes to sd %ld%s\n",
246                         towrite, (long) sb->sb_fd,
247                         ber->ber_rwptr != ber->ber_buf ?  " (re-flush)" : "" );
248                 ber_log_bprint( LDAP_DEBUG_PACKETS, sb->sb_debug,
249                         ber->ber_rwptr, towrite );
250 #endif
251         }
252
253         nwritten = 0;
254         do {
255                 rc = ber_int_sb_write( sb, ber->ber_rwptr, towrite );
256                 if (rc<=0) {
257                         return -1;
258                 }
259                 towrite -= rc;
260                 nwritten += rc;
261                 ber->ber_rwptr += rc;
262         } while ( towrite > 0 );
263
264         if ( freeit )
265                 ber_free( ber, 1 );
266
267         return( 0 );
268 }
269
270 BerElement *
271 ber_alloc_t( int options )
272 {
273         BerElement      *ber;
274
275     ber_int_options.lbo_valid = LBER_INITIALIZED;
276
277         ber = (BerElement *) LBER_CALLOC( 1, sizeof(BerElement) );
278
279         if ( ber == NULL ) {
280                 return NULL;
281         }
282
283         ber->ber_valid = LBER_VALID_BERELEMENT;
284         ber->ber_tag = LBER_DEFAULT;
285         ber->ber_options = options;
286         ber->ber_debug = ber_int_debug;
287
288         assert( LBER_VALID( ber ) );
289         return ber;
290 }
291
292 BerElement *
293 ber_alloc( void )       /* deprecated */
294 {
295         return ber_alloc_t( 0 );
296 }
297
298 BerElement *
299 der_alloc( void )       /* deprecated */
300 {
301         return ber_alloc_t( LBER_USE_DER );
302 }
303
304 BerElement *
305 ber_dup( BerElement *ber )
306 {
307         BerElement      *new;
308
309         assert( ber != NULL );
310         assert( LBER_VALID( ber ) );
311
312         if ( (new = ber_alloc_t( ber->ber_options )) == NULL ) {
313                 return NULL;
314         }
315
316         *new = *ber;
317
318         assert( LBER_VALID( new ) );
319         return( new );
320 }
321
322
323 /* OLD U-Mich ber_init() */
324 void
325 ber_init_w_nullc( BerElement *ber, int options )
326 {
327         assert( ber != NULL );
328
329     ber_int_options.lbo_valid = LBER_INITIALIZED;
330
331         (void) memset( (char *)ber, '\0', sizeof( BerElement ));
332         ber->ber_valid = LBER_VALID_BERELEMENT;
333         ber->ber_tag = LBER_DEFAULT;
334         ber->ber_options = (char) options;
335         ber->ber_debug = ber_int_debug;
336
337         assert( LBER_VALID( ber ) );
338 }
339
340 /* New C-API ber_init() */
341 /* This function constructs a BerElement containing a copy
342 ** of the data in the bv argument.
343 */
344 BerElement *
345 ber_init( struct berval *bv )
346 {
347         BerElement *ber;
348
349         assert( bv != NULL );
350
351     ber_int_options.lbo_valid = LBER_INITIALIZED;
352
353         if ( bv == NULL ) {
354                 return NULL;
355         }
356
357         ber = ber_alloc_t( 0 );
358
359         if( ber == NULL ) {
360                 /* allocation failed */
361                 return NULL;
362         }
363
364         /* copy the data */
365         if ( ((ber_len_t) ber_write ( ber, bv->bv_val, bv->bv_len, 0 ))
366                 != bv->bv_len )
367         {
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         return ber;
375 }
376
377 /* New C-API ber_flatten routine */
378 /* This routine allocates a struct berval whose contents are a BER
379 ** encoding taken from the ber argument.  The bvPtr pointer pointers to
380 ** the returned berval.
381 */
382 int ber_flatten(
383         BerElement *ber,
384         struct berval **bvPtr)
385 {
386         struct berval *bv;
387  
388         assert( bvPtr != NULL );
389
390     ber_int_options.lbo_valid = LBER_INITIALIZED;
391
392         if(bvPtr == NULL) {
393                 return -1;
394         }
395
396         bv = LBER_MALLOC( sizeof(struct berval) );
397         if ( bv == 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_pvt_ber_write( ber );
409
410                 bv->bv_val = (char *) LBER_MALLOC( len + 1 );
411                 if ( bv->bv_val == NULL ) {
412                         LBER_FREE( bv );
413                         return -1;
414                 }
415
416                 AC_MEMCPY( bv->bv_val, ber->ber_buf, len );
417                 bv->bv_val[len] = '\0';
418                 bv->bv_len = len;
419         }
420     
421         *bvPtr = bv;
422         return 0;
423 }
424
425 void
426 ber_reset( BerElement *ber, int was_writing )
427 {
428         assert( ber != NULL );
429         assert( LBER_VALID( ber ) );
430
431         if ( was_writing ) {
432                 ber->ber_end = ber->ber_ptr;
433                 ber->ber_ptr = ber->ber_buf;
434
435         } else {
436                 ber->ber_ptr = ber->ber_end;
437         }
438
439         ber->ber_rwptr = NULL;
440 }
441
442 /*
443  * A rewrite of ber_get_next that can safely be called multiple times 
444  * for the same packet. It will simply continue where it stopped until
445  * a full packet is read.
446  */
447
448 ber_tag_t
449 ber_get_next(
450         Sockbuf *sb,
451         ber_len_t *len,
452         BerElement *ber )
453 {
454         assert( sb != NULL );
455         assert( len != NULL );
456         assert( ber != NULL );
457
458         assert( SOCKBUF_VALID( sb ) );
459         assert( LBER_VALID( ber ) );
460
461 #ifdef NEW_LOGGING
462         LDAP_LOG(( "liblber", LDAP_LEVEL_ENTRY, "ber_get_next: enter\n" ));
463 #else
464         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
465                 "ber_get_next\n" );
466 #endif
467
468         /*
469          * Any ber element looks like this: tag length contents.
470          * Assuming everything's ok, we return the tag byte (we
471          * can assume a single byte), return the length in len,
472          * and the rest of the undecoded element in buf.
473          *
474          * Assumptions:
475          *      1) small tags (less than 128)
476          *      2) definite lengths
477          *      3) primitive encodings used whenever possible
478          */
479         
480         if (ber->ber_rwptr == NULL) {
481                 /* XXYYZ
482                  * dtest does like this assert.
483                  */
484                 /* assert( ber->ber_buf == NULL ); */
485                 ber->ber_rwptr = (char *) &ber->ber_tag;
486                 ber->ber_tag = 0;
487         }
488
489 #undef PTR_IN_VAR
490 #define PTR_IN_VAR( ptr, var ) \
491         (((ptr)>=(char *) &(var)) && ((ptr)< (char *) &(var)+sizeof(var)))
492         
493         if (PTR_IN_VAR(ber->ber_rwptr, ber->ber_tag)) {
494                 if (ber->ber_rwptr == (char *) &ber->ber_tag) {
495                         if (ber_int_sb_read( sb, ber->ber_rwptr, 1)<=0)
496                                 return LBER_DEFAULT;
497
498                         if ((ber->ber_rwptr[0] & LBER_BIG_TAG_MASK)
499                                 != LBER_BIG_TAG_MASK)
500                         {
501                                 ber->ber_tag = ber->ber_rwptr[0];
502                                 ber->ber_rwptr = (char *) &ber->ber_usertag;
503                                 goto get_lenbyte;
504                         }
505                         ber->ber_rwptr++;
506                 }
507                 do {
508                         /* reading the tag... */
509                         if (ber_int_sb_read( sb, ber->ber_rwptr, 1)<=0) {
510                                 return LBER_DEFAULT;
511                         }
512
513                         if (! (ber->ber_rwptr[0] & LBER_MORE_TAG_MASK) ) {
514                                 ber->ber_tag>>=sizeof(ber->ber_tag) -
515                                   ((char *) &ber->ber_tag - ber->ber_rwptr);
516                                 ber->ber_rwptr = (char *) &ber->ber_usertag;
517                                 goto get_lenbyte;
518                         }
519                 } while( PTR_IN_VAR(ber->ber_rwptr, ber->ber_tag ));
520
521                 errno = ERANGE; /* this is a serious error. */
522                 return LBER_DEFAULT;
523         }
524
525 get_lenbyte:
526         if (ber->ber_rwptr==(char *) &ber->ber_usertag) {
527                 unsigned char c;
528                 if (ber_int_sb_read( sb, (char *) &c, 1)<=0) {
529                         return LBER_DEFAULT;
530                 }
531
532                 if (c & 0x80U) {
533                         int len = c & 0x7fU;
534                         if ( (len==0) || ( len>sizeof( ber->ber_len ) ) ) {
535                                 errno = ERANGE;
536                                 return LBER_DEFAULT;
537                         }
538
539                         ber->ber_rwptr = (char *) &ber->ber_len +
540                                 sizeof(ber->ber_len) - len;
541                         ber->ber_len = 0;
542
543                 } else {
544                         ber->ber_len = c;
545                         goto fill_buffer;
546                 }
547         }
548
549         if (PTR_IN_VAR(ber->ber_rwptr, ber->ber_len)) {
550                 unsigned char netlen[sizeof(ber_len_t)];
551
552                 ber_slen_t res;
553                 ber_slen_t to_go;
554                 to_go = (char *) &ber->ber_len + sizeof( ber->ber_len ) -
555                         ber->ber_rwptr;
556                 assert( to_go > 0 );
557
558                 res = BerRead( sb, netlen, to_go );
559                 if (res <= 0) {
560                         return LBER_DEFAULT;
561                 }
562                 ber->ber_rwptr += res;
563
564                 /* convert length. */
565                 for( to_go = 0; to_go < res ; to_go++ ) {
566                         ber->ber_len <<= 8;
567                         ber->ber_len |= netlen[to_go];
568                 }
569
570                 if (PTR_IN_VAR(ber->ber_rwptr, ber->ber_len)) {
571                         return LBER_DEFAULT;
572                 }
573         }
574
575 fill_buffer:    
576         /* now fill the buffer. */
577
578         /* make sure length is reasonable */
579         if ( ber->ber_len == 0 ) {
580                 errno = ERANGE;
581                 return LBER_DEFAULT;
582         } else if ( sb->sb_max_incoming && ber->ber_len > sb->sb_max_incoming ) {
583 #ifdef NEW_LOGGING
584                 LDAP_LOG(( "liblber", LDAP_LEVEL_ERR, 
585                         "ber_get_next: sockbuf_max_incoming limit hit "
586                         "(%d > %d)\n", ber->ber_len, sb->sb_max_incoming ));
587 #else
588                 ber_log_printf( LDAP_DEBUG_CONNS, ber->ber_debug,
589                         "ber_get_next: sockbuf_max_incoming limit hit "
590                         "(%ld > %ld)\n", ber->ber_len, sb->sb_max_incoming );
591 #endif
592                 errno = ERANGE;
593                 return LBER_DEFAULT;
594         }
595
596         if (ber->ber_buf==NULL) {
597                 ber->ber_buf = (char *) LBER_MALLOC( ber->ber_len + 1 );
598                 if (ber->ber_buf==NULL) {
599                         return LBER_DEFAULT;
600                 }
601                 ber->ber_rwptr = ber->ber_buf;
602                 ber->ber_ptr = ber->ber_buf;
603                 ber->ber_end = ber->ber_buf + ber->ber_len;
604         }
605
606         if ((ber->ber_rwptr>=ber->ber_buf) && (ber->ber_rwptr<ber->ber_end)) {
607                 ber_slen_t res;
608                 ber_slen_t to_go;
609                 
610                 to_go = ber->ber_end - ber->ber_rwptr;
611                 assert( to_go > 0 );
612                 
613                 res = ber_int_sb_read( sb, ber->ber_rwptr, to_go );
614                 if (res<=0)
615                         return LBER_DEFAULT;
616                 ber->ber_rwptr+=res;
617                 
618                 if (res<to_go) {
619 #if defined( EWOULDBLOCK )
620                         errno = EWOULDBLOCK;
621 #elif defined( EAGAIN )
622                         errno = EAGAIN;
623 #endif                  
624                         return LBER_DEFAULT;
625                 }
626                 
627                 ber->ber_rwptr = NULL;
628                 *len = ber->ber_len;
629                 if ( ber->ber_debug ) {
630 #ifdef NEW_LOGGING
631                         LDAP_LOG(( "liblber", LDAP_LEVEL_DETAIL1,
632                                    "ber_get_next: tag 0x%lx len %ld\n",
633                                    ber->ber_tag, ber->ber_len ));
634                         BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
635 #else
636                         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
637                                 "ber_get_next: tag 0x%lx len %ld contents:\n",
638                                 ber->ber_tag, ber->ber_len );
639                         ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
640 #endif
641                 }
642                 return (ber->ber_tag);
643         }
644
645         assert( 0 ); /* ber structure is messed up ?*/
646         return LBER_DEFAULT;
647 }