]> git.sur5r.net Git - openldap/blob - libraries/liblber/io.c
09b8b92c077ae0ccf6543f477c5f22ae9b562a50
[openldap] / libraries / liblber / io.c
1 /* io.c - ber general i/o routines */
2 /* $OpenLDAP$ */
3 /*
4  * Copyright 1998-2003 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 #include "ldap_log.h"
37
38 ber_slen_t
39 ber_read(
40         BerElement *ber,
41         char *buf,
42         ber_len_t len )
43 {
44         ber_len_t       actuallen, nleft;
45
46         assert( ber != NULL );
47         assert( buf != NULL );
48
49         assert( LBER_VALID( ber ) );
50
51         nleft = ber_pvt_ber_remaining( ber );
52         actuallen = nleft < len ? nleft : len;
53
54         AC_MEMCPY( buf, ber->ber_ptr, actuallen );
55
56         ber->ber_ptr += actuallen;
57
58         return( (ber_slen_t) actuallen );
59 }
60
61 ber_slen_t
62 ber_write(
63         BerElement *ber,
64         LDAP_CONST char *buf,
65         ber_len_t len,
66         int nosos )
67 {
68         assert( ber != NULL );
69         assert( buf != NULL );
70
71         assert( LBER_VALID( ber ) );
72
73         if ( nosos || ber->ber_sos == NULL ) {
74                 if ( ber->ber_ptr + len > ber->ber_end ) {
75                         if ( ber_realloc( ber, len ) != 0 )
76                                 return( -1 );
77                 }
78                 AC_MEMCPY( ber->ber_ptr, buf, (size_t)len );
79                 ber->ber_ptr += len;
80                 return( (ber_slen_t) len );
81
82         } else {
83                 if ( ber->ber_sos->sos_ptr + len > ber->ber_end ) {
84                         if ( ber_realloc( ber, len ) != 0 )
85                                 return( -1 );
86                 }
87                 AC_MEMCPY( ber->ber_sos->sos_ptr, buf, (size_t)len );
88                 ber->ber_sos->sos_ptr += len;
89                 ber->ber_sos->sos_clen += len;
90                 return( (ber_slen_t) len );
91         }
92 }
93
94 int
95 ber_realloc( BerElement *ber, ber_len_t len )
96 {
97         ber_len_t       total;
98         Seqorset        *s;
99         long            off;
100         char            *oldbuf;
101
102         assert( ber != NULL );
103         assert( len > 0 );
104         assert( LBER_VALID( ber ) );
105
106         total = ber_pvt_ber_total( ber );
107
108 #define LBER_EXBUFSIZ   4060 /* a few words less than 2^N for binary buddy */
109 #if defined( LBER_EXBUFSIZ ) && LBER_EXBUFSIZ > 0
110 # ifndef notdef
111         /* don't realloc by small amounts */
112         total += len < LBER_EXBUFSIZ ? LBER_EXBUFSIZ : len;
113 # else
114         {       /* not sure what value this adds */
115                 ber_len_t have = (total + (LBER_EXBUFSIZE - 1)) / LBER_EXBUFSIZ;
116                 ber_len_t need = (len + (LBER_EXBUFSIZ - 1)) / LBER_EXBUFSIZ;
117                 total = ( have + need ) * LBER_EXBUFSIZ;
118         }
119 # endif
120 #else
121         total += len;   /* realloc just what's needed */
122 #endif
123
124         oldbuf = ber->ber_buf;
125
126         ber->ber_buf = (char *) ber_memrealloc_x( oldbuf, total, ber->ber_memctx );
127         
128         if ( ber->ber_buf == NULL ) {
129                 ber->ber_buf = oldbuf;
130                 return( -1 );
131         }
132
133         ber->ber_end = ber->ber_buf + total;
134
135         /*
136          * If the stinking thing was moved, we need to go through and
137          * reset all the sos and ber pointers.  Offsets would've been
138          * a better idea... oh well.
139          */
140
141         if ( ber->ber_buf != oldbuf ) {
142                 ber->ber_ptr = ber->ber_buf + (ber->ber_ptr - oldbuf);
143
144                 for ( s = ber->ber_sos; s != NULL; s = s->sos_next ) {
145                         off = s->sos_first - oldbuf;
146                         s->sos_first = ber->ber_buf + off;
147
148                         off = s->sos_ptr - oldbuf;
149                         s->sos_ptr = ber->ber_buf + off;
150                 }
151         }
152
153         return( 0 );
154 }
155
156 void
157 ber_free_buf( BerElement *ber )
158 {
159         Seqorset *s, *next;
160
161         assert( LBER_VALID( ber ) );
162
163         if ( ber->ber_buf) ber_memfree_x( ber->ber_buf, ber->ber_memctx );
164
165         for( s = ber->ber_sos ; s != NULL ; s = next ) {
166                 next = s->sos_next;
167                 ber_memfree_x( s, ber->ber_memctx );
168         }
169
170         ber->ber_buf = NULL;
171         ber->ber_sos = NULL;
172         ber->ber_valid = LBER_UNINITIALIZED;
173 }
174
175 void
176 ber_free( BerElement *ber, int freebuf )
177 {
178 #ifdef LDAP_MEMORY_DEBUG
179         assert( ber != NULL );
180 #endif
181
182         if( ber == NULL ) {
183                 return;
184         }
185
186         if( freebuf )
187                 ber_free_buf( ber );
188
189         ber_memfree_x( (char *) ber, ber->ber_memctx );
190 }
191
192 int
193 ber_flush( Sockbuf *sb, BerElement *ber, int freeit )
194 {
195         ber_len_t       towrite;
196         ber_slen_t      rc;     
197
198         assert( sb != NULL );
199         assert( ber != NULL );
200
201         assert( SOCKBUF_VALID( sb ) );
202         assert( LBER_VALID( ber ) );
203
204         if ( ber->ber_rwptr == NULL ) {
205                 ber->ber_rwptr = ber->ber_buf;
206         }
207         towrite = ber->ber_ptr - ber->ber_rwptr;
208
209         if ( sb->sb_debug ) {
210 #ifdef NEW_LOGGING
211                 LDAP_LOG( BER, DETAIL1,
212                            "ber_flush: %ld bytes to sd %ld%s\n",
213                            towrite, (long)sb->sb_fd,
214                            ber->ber_rwptr != ber->ber_buf ? " (re-flush)" : "" );
215
216                 if(LDAP_LOGS_TEST(BER, DETAIL2))
217                                 BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
218
219 #else
220                 ber_log_printf( LDAP_DEBUG_TRACE, sb->sb_debug,
221                         "ber_flush: %ld bytes to sd %ld%s\n",
222                         towrite, (long) sb->sb_fd,
223                         ber->ber_rwptr != ber->ber_buf ?  " (re-flush)" : "" );
224                 ber_log_bprint( LDAP_DEBUG_PACKETS, sb->sb_debug,
225                         ber->ber_rwptr, towrite );
226 #endif
227         }
228
229         while ( towrite > 0 ) {
230 #define LBER_TRICKLE
231 #ifdef LBER_TRICKLE
232                 sleep(1);
233                 rc = ber_int_sb_write( sb, ber->ber_rwptr, 1 );
234 #else
235                 rc = ber_int_sb_write( sb, ber->ber_rwptr, towrite );
236 #endif
237                 if (rc<=0) {
238                         return -1;
239                 }
240                 towrite -= rc;
241                 ber->ber_rwptr += rc;
242         } 
243
244         if ( freeit )
245                 ber_free( ber, 1 );
246
247         return( 0 );
248 }
249
250 BerElement *
251 ber_alloc_t( int options )
252 {
253         BerElement      *ber;
254
255     ber_int_options.lbo_valid = LBER_INITIALIZED;
256
257         ber = (BerElement *) LBER_CALLOC( 1, sizeof(BerElement) );
258
259         if ( ber == NULL ) {
260                 return NULL;
261         }
262
263         ber->ber_valid = LBER_VALID_BERELEMENT;
264         ber->ber_tag = LBER_DEFAULT;
265         ber->ber_options = options;
266         ber->ber_debug = ber_int_debug;
267
268         assert( LBER_VALID( ber ) );
269         return ber;
270 }
271
272 BerElement *
273 ber_alloc( void )       /* deprecated */
274 {
275         return ber_alloc_t( 0 );
276 }
277
278 BerElement *
279 der_alloc( void )       /* deprecated */
280 {
281         return ber_alloc_t( LBER_USE_DER );
282 }
283
284 BerElement *
285 ber_dup( BerElement *ber )
286 {
287         BerElement      *new;
288
289         assert( ber != NULL );
290         assert( LBER_VALID( ber ) );
291
292         if ( (new = ber_alloc_t( ber->ber_options )) == NULL ) {
293                 return NULL;
294         }
295
296         *new = *ber;
297
298         assert( LBER_VALID( new ) );
299         return( new );
300 }
301
302
303 void
304 ber_init2( BerElement *ber, struct berval *bv, int options )
305 {
306         assert( ber != NULL );
307
308         ber_int_options.lbo_valid = LBER_INITIALIZED;
309
310         (void) memset( (char *)ber, '\0', sizeof( BerElement ));
311         ber->ber_valid = LBER_VALID_BERELEMENT;
312         ber->ber_tag = LBER_DEFAULT;
313         ber->ber_options = (char) options;
314         ber->ber_debug = ber_int_debug;
315
316         if ( bv != NULL ) {
317                 ber->ber_buf = bv->bv_val;
318                 ber->ber_ptr = ber->ber_buf;
319                 ber->ber_end = ber->ber_buf + bv->bv_len;
320         }
321
322         assert( LBER_VALID( ber ) );
323 }
324
325 /* OLD U-Mich ber_init() */
326 void
327 ber_init_w_nullc( BerElement *ber, int options )
328 {
329         ber_init2( ber, NULL, options );
330 }
331
332 /* New C-API ber_init() */
333 /* This function constructs a BerElement containing a copy
334 ** of the data in the bv argument.
335 */
336 BerElement *
337 ber_init( struct berval *bv )
338 {
339         BerElement *ber;
340
341         assert( bv != NULL );
342
343     ber_int_options.lbo_valid = LBER_INITIALIZED;
344
345         if ( bv == NULL ) {
346                 return NULL;
347         }
348
349         ber = ber_alloc_t( 0 );
350
351         if( ber == NULL ) {
352                 /* allocation failed */
353                 return NULL;
354         }
355
356         /* copy the data */
357         if ( ((ber_len_t) ber_write ( ber, bv->bv_val, bv->bv_len, 0 ))
358                 != bv->bv_len )
359         {
360                 /* write failed, so free and return NULL */
361                 ber_free( ber, 1 );
362                 return NULL;
363         }
364
365         ber_reset( ber, 1 );    /* reset the pointer to the start of the buffer */
366         return ber;
367 }
368
369 /* New C-API ber_flatten routine */
370 /* This routine allocates a struct berval whose contents are a BER
371 ** encoding taken from the ber argument.  The bvPtr pointer points to
372 ** the returned berval.
373 **
374 ** ber_flatten2 is the same, but uses a struct berval passed by
375 ** the caller. If alloc is 0 the returned bv uses the ber buf directly.
376 */
377 int ber_flatten2(
378         BerElement *ber,
379         struct berval *bv,
380         int alloc )
381 {
382         assert( bv != NULL );
383
384         ber_int_options.lbo_valid = LBER_INITIALIZED;
385
386         if ( bv == NULL ) {
387                 return -1;
388         }
389
390         if ( ber == NULL ) {
391                 /* ber is null, create an empty berval */
392                 bv->bv_val = NULL;
393                 bv->bv_len = 0;
394
395         } else {
396                 /* copy the berval */
397                 ber_len_t len = ber_pvt_ber_write( ber );
398
399                 if ( alloc ) {
400                         bv->bv_val = (char *) ber_memalloc_x( len + 1, ber->ber_memctx );
401                         if ( bv->bv_val == NULL ) {
402                                 return -1;
403                         }
404                         AC_MEMCPY( bv->bv_val, ber->ber_buf, len );
405                 } else {
406                         bv->bv_val = ber->ber_buf;
407                 }
408                 bv->bv_val[len] = '\0';
409                 bv->bv_len = len;
410         }
411         return 0;
412 }
413
414 int ber_flatten(
415         BerElement *ber,
416         struct berval **bvPtr)
417 {
418         struct berval *bv;
419         int rc;
420  
421         assert( bvPtr != NULL );
422
423         ber_int_options.lbo_valid = LBER_INITIALIZED;
424
425         if(bvPtr == NULL) {
426                 return -1;
427         }
428
429         bv = ber_memalloc_x( sizeof(struct berval), ber->ber_memctx );
430         if ( bv == NULL ) {
431                 return -1;
432         }
433         rc = ber_flatten2(ber, bv, 1);
434         if (rc == -1) {
435                 ber_memfree_x(bv, ber->ber_memctx);
436         } else {
437                 *bvPtr = bv;
438         }
439         return rc;
440 }
441
442 void
443 ber_reset( BerElement *ber, int was_writing )
444 {
445         assert( ber != NULL );
446         assert( LBER_VALID( ber ) );
447
448         if ( was_writing ) {
449                 ber->ber_end = ber->ber_ptr;
450                 ber->ber_ptr = ber->ber_buf;
451
452         } else {
453                 ber->ber_ptr = ber->ber_end;
454         }
455
456         ber->ber_rwptr = NULL;
457 }
458
459 /*
460  * A rewrite of ber_get_next that can safely be called multiple times 
461  * for the same packet. It will simply continue where it stopped until
462  * a full packet is read.
463  */
464
465 #define LENSIZE 4
466
467 ber_tag_t
468 ber_get_next(
469         Sockbuf *sb,
470         ber_len_t *len,
471         BerElement *ber )
472 {
473         assert( sb != NULL );
474         assert( len != NULL );
475         assert( ber != NULL );
476
477         assert( SOCKBUF_VALID( sb ) );
478         assert( LBER_VALID( ber ) );
479
480 #ifdef NEW_LOGGING
481         LDAP_LOG( BER, ENTRY, "ber_get_next: enter\n", 0, 0, 0 );
482 #else
483         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
484                 "ber_get_next\n" );
485 #endif
486
487         /*
488          * Any ber element looks like this: tag length contents.
489          * Assuming everything's ok, we return the tag byte (we
490          * can assume a single byte), return the length in len,
491          * and the rest of the undecoded element in buf.
492          *
493          * Assumptions:
494          *      1) small tags (less than 128)
495          *      2) definite lengths
496          *      3) primitive encodings used whenever possible
497          *
498          * The code also handles multi-byte tags. The first few bytes
499          * of the message are read to check for multi-byte tags and
500          * lengths. These bytes are temporarily stored in the ber_tag,
501          * ber_len, and ber_usertag fields of the berelement until
502          * tag/len parsing is complete. After this parsing, any leftover
503          * bytes and the rest of the message are copied into the ber_buf.
504          *
505          * We expect tag and len to be at most 32 bits wide.
506          */
507
508         if (ber->ber_rwptr == NULL) {
509                 assert( ber->ber_buf == NULL );
510                 ber->ber_rwptr = (char *) &ber->ber_len-1;
511                 ber->ber_ptr = ber->ber_rwptr;
512                 ber->ber_tag = 0;
513         }
514
515         while (ber->ber_rwptr > (char *)&ber->ber_tag && ber->ber_rwptr <
516                 (char *)&ber->ber_len + LENSIZE*2 -1) {
517                 ber_slen_t sblen;
518                 char buf[sizeof(ber->ber_len)-1];
519                 ber_len_t tlen = 0;
520
521                 errno = 0;
522                 sblen=ber_int_sb_read( sb, ber->ber_rwptr,
523                         ((char *)&ber->ber_len + LENSIZE*2 - 1)-ber->ber_rwptr);
524                 if (sblen<=0) return LBER_DEFAULT;
525                 ber->ber_rwptr += sblen;
526
527                 /* We got at least one byte, try to parse the tag. */
528                 if (ber->ber_ptr == (char *)&ber->ber_len-1) {
529                         ber_tag_t tag;
530                         unsigned char *p = (unsigned char *)ber->ber_ptr;
531                         tag = *p++;
532                         if ((tag & LBER_BIG_TAG_MASK) == LBER_BIG_TAG_MASK) {
533                                 ber_len_t i;
534                                 for (i=1; (char *)p<ber->ber_rwptr; i++) {
535                                         tag <<= 8;
536                                         tag |= *p++;
537                                         if (!(tag & LBER_MORE_TAG_MASK))
538                                                 break;
539                                         /* Is the tag too big? */
540                                         if (i == sizeof(ber_tag_t)-1) {
541                                                 errno = ERANGE;
542                                                 return LBER_DEFAULT;
543                                         }
544                                 }
545                                 /* Did we run out of bytes? */
546                                 if ((char *)p == ber->ber_rwptr) {
547 #if defined( EWOULDBLOCK )
548                                         errno = EWOULDBLOCK;
549 #elif defined( EAGAIN )
550                                         errno = EAGAIN;
551 #endif                  
552                                         return LBER_DEFAULT;
553                                 }
554                         }
555                         if (sblen == 1) continue;
556
557                         ber->ber_tag = tag;
558                         ber->ber_ptr = (char *)p;
559                 }
560
561                 /* Now look for the length */
562                 if (*ber->ber_ptr & 0x80) {     /* multi-byte */
563                         ber_len_t i;
564                         unsigned char *p = (unsigned char *)ber->ber_ptr;
565                         int llen = *p++ & 0x7f;
566                         if (llen > (int)sizeof(ber_len_t)) {
567                                 errno = ERANGE;
568                                 return LBER_DEFAULT;
569                         }
570                         /* Not enough bytes? */
571                         if (ber->ber_rwptr - (char *)p < llen) {
572 #if defined( EWOULDBLOCK )
573                                 errno = EWOULDBLOCK;
574 #elif defined( EAGAIN )
575                                 errno = EAGAIN;
576 #endif                  
577                                 return LBER_DEFAULT;
578                         }
579                         for (i=0; i<llen; i++)
580                         {
581                                 tlen <<=8;
582                                 tlen |= *p++;
583                         }
584                         ber->ber_ptr = p;
585                 } else {
586                         tlen = *(unsigned char *)ber->ber_ptr++;
587                 }
588
589                 /* Are there leftover data bytes inside ber->ber_len? */
590                 if (ber->ber_ptr < (char *)&ber->ber_usertag) {
591                         if (ber->ber_rwptr < (char *)&ber->ber_usertag)
592                                 sblen = ber->ber_rwptr - ber->ber_ptr;
593                         else
594                                 sblen = (char *)&ber->ber_usertag - ber->ber_ptr;
595                         AC_MEMCPY(buf, ber->ber_ptr, sblen);
596                         ber->ber_ptr += sblen;
597                 } else {
598                         sblen = 0;
599                 }
600                 ber->ber_len = tlen;
601
602                 /* now fill the buffer. */
603
604                 /* make sure length is reasonable */
605                 if ( ber->ber_len == 0 ) {
606                         errno = ERANGE;
607                         return LBER_DEFAULT;
608                 }
609
610                 if ( sb->sb_max_incoming && ber->ber_len > sb->sb_max_incoming ) {
611 #ifdef NEW_LOGGING
612                         LDAP_LOG( BER, ERR, 
613                                 "ber_get_next: sockbuf_max_incoming exceeded "
614                                 "(%d > %d)\n", ber->ber_len, sb->sb_max_incoming, 0 );
615 #else
616                         ber_log_printf( LDAP_DEBUG_CONNS, ber->ber_debug,
617                                 "ber_get_next: sockbuf_max_incoming exceeded "
618                                 "(%ld > %ld)\n", ber->ber_len, sb->sb_max_incoming );
619 #endif
620                         errno = ERANGE;
621                         return LBER_DEFAULT;
622                 }
623
624                 if (ber->ber_buf==NULL) {
625                         ber_len_t l = ber->ber_rwptr - ber->ber_ptr;
626                         /* ber->ber_ptr is always <= ber->ber->ber_rwptr.
627                          * make sure ber->ber_len agrees with what we've
628                          * already read.
629                          */
630                         if ( ber->ber_len < sblen + l ) {
631                                 errno = ERANGE;
632                                 return LBER_DEFAULT;
633                         }
634                         ber->ber_buf = (char *) ber_memalloc_x( ber->ber_len + 1, ber->ber_memctx );
635                         if (ber->ber_buf==NULL) {
636                                 return LBER_DEFAULT;
637                         }
638                         ber->ber_end = ber->ber_buf + ber->ber_len;
639                         if (sblen) {
640                                 AC_MEMCPY(ber->ber_buf, buf, sblen);
641                         }
642                         if (l > 0) {
643                                 AC_MEMCPY(ber->ber_buf + sblen, ber->ber_ptr, l);
644                                 sblen += l;
645                         }
646                         ber->ber_ptr = ber->ber_buf;
647                         ber->ber_usertag = 0;
648                         if ((ber_len_t)sblen == ber->ber_len) {
649                                 goto done;
650                         }
651                         ber->ber_rwptr = ber->ber_buf + sblen;
652                 }
653         }
654
655         if ((ber->ber_rwptr>=ber->ber_buf) && (ber->ber_rwptr<ber->ber_end)) {
656                 ber_slen_t res;
657                 ber_slen_t to_go;
658                 
659                 to_go = ber->ber_end - ber->ber_rwptr;
660                 assert( to_go > 0 );
661                 
662                 errno = 0;
663                 res = ber_int_sb_read( sb, ber->ber_rwptr, to_go );
664                 if (res<=0) return LBER_DEFAULT;
665                 ber->ber_rwptr+=res;
666                 
667                 if (res<to_go) {
668 #if defined( EWOULDBLOCK )
669                         errno = EWOULDBLOCK;
670 #elif defined( EAGAIN )
671                         errno = EAGAIN;
672 #endif                  
673                         return LBER_DEFAULT;
674                 }
675 done:
676                 ber->ber_rwptr = NULL;
677                 *len = ber->ber_len;
678                 if ( ber->ber_debug ) {
679 #ifdef NEW_LOGGING
680                         LDAP_LOG( BER, DETAIL1, 
681                                 "ber_get_next: tag 0x%lx len %ld\n", 
682                                 ber->ber_tag, ber->ber_len, 0  );
683                         if(LDAP_LOGS_TEST(BER, DETAIL2))
684                                         BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
685 #else
686                         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
687                                 "ber_get_next: tag 0x%lx len %ld contents:\n",
688                                 ber->ber_tag, ber->ber_len );
689                         ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
690 #endif
691                 }
692                 return (ber->ber_tag);
693         }
694
695         assert( 0 ); /* ber structure is messed up ?*/
696         return LBER_DEFAULT;
697 }
698
699 char *
700 ber_start( BerElement* ber )
701 {
702         return ber->ber_buf;
703 }
704
705 int
706 ber_len( BerElement* ber )
707 {
708         return ( ber->ber_end - ber->ber_buf );
709 }
710
711 int
712 ber_ptrlen( BerElement* ber )
713 {
714         return ( ber->ber_ptr - ber->ber_buf );
715 }
716
717 void
718 ber_rewind ( BerElement * ber )
719 {
720         ber->ber_rwptr = NULL;
721         ber->ber_sos = NULL;
722         ber->ber_end = ber->ber_ptr;
723         ber->ber_ptr = ber->ber_buf;
724 }
725
726 int
727 ber_remaining( BerElement * ber )
728 {
729         return ber_pvt_ber_remaining( ber );
730 }