]> git.sur5r.net Git - openldap/blob - libraries/liblber/io.c
- change in message to modlist conversion
[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                 rc = ber_int_sb_write( sb, ber->ber_rwptr, towrite );
231                 if (rc<=0) {
232                         return -1;
233                 }
234                 towrite -= rc;
235                 ber->ber_rwptr += rc;
236         } 
237
238         if ( freeit )
239                 ber_free( ber, 1 );
240
241         return( 0 );
242 }
243
244 BerElement *
245 ber_alloc_t( int options )
246 {
247         BerElement      *ber;
248
249     ber_int_options.lbo_valid = LBER_INITIALIZED;
250
251         ber = (BerElement *) LBER_CALLOC( 1, sizeof(BerElement) );
252
253         if ( ber == NULL ) {
254                 return NULL;
255         }
256
257         ber->ber_valid = LBER_VALID_BERELEMENT;
258         ber->ber_tag = LBER_DEFAULT;
259         ber->ber_options = options;
260         ber->ber_debug = ber_int_debug;
261
262         assert( LBER_VALID( ber ) );
263         return ber;
264 }
265
266 BerElement *
267 ber_alloc( void )       /* deprecated */
268 {
269         return ber_alloc_t( 0 );
270 }
271
272 BerElement *
273 der_alloc( void )       /* deprecated */
274 {
275         return ber_alloc_t( LBER_USE_DER );
276 }
277
278 BerElement *
279 ber_dup( BerElement *ber )
280 {
281         BerElement      *new;
282
283         assert( ber != NULL );
284         assert( LBER_VALID( ber ) );
285
286         if ( (new = ber_alloc_t( ber->ber_options )) == NULL ) {
287                 return NULL;
288         }
289
290         *new = *ber;
291
292         assert( LBER_VALID( new ) );
293         return( new );
294 }
295
296
297 void
298 ber_init2( BerElement *ber, struct berval *bv, int options )
299 {
300         assert( ber != NULL );
301
302         ber_int_options.lbo_valid = LBER_INITIALIZED;
303
304         (void) memset( (char *)ber, '\0', sizeof( BerElement ));
305         ber->ber_valid = LBER_VALID_BERELEMENT;
306         ber->ber_tag = LBER_DEFAULT;
307         ber->ber_options = (char) options;
308         ber->ber_debug = ber_int_debug;
309
310         if ( bv != NULL ) {
311                 ber->ber_buf = bv->bv_val;
312                 ber->ber_ptr = ber->ber_buf;
313                 ber->ber_end = ber->ber_buf + bv->bv_len;
314         }
315
316         assert( LBER_VALID( ber ) );
317 }
318
319 /* OLD U-Mich ber_init() */
320 void
321 ber_init_w_nullc( BerElement *ber, int options )
322 {
323         ber_init2( ber, NULL, options );
324 }
325
326 /* New C-API ber_init() */
327 /* This function constructs a BerElement containing a copy
328 ** of the data in the bv argument.
329 */
330 BerElement *
331 ber_init( struct berval *bv )
332 {
333         BerElement *ber;
334
335         assert( bv != NULL );
336
337     ber_int_options.lbo_valid = LBER_INITIALIZED;
338
339         if ( bv == NULL ) {
340                 return NULL;
341         }
342
343         ber = ber_alloc_t( 0 );
344
345         if( ber == NULL ) {
346                 /* allocation failed */
347                 return NULL;
348         }
349
350         /* copy the data */
351         if ( ((ber_len_t) ber_write ( ber, bv->bv_val, bv->bv_len, 0 ))
352                 != bv->bv_len )
353         {
354                 /* write failed, so free and return NULL */
355                 ber_free( ber, 1 );
356                 return NULL;
357         }
358
359         ber_reset( ber, 1 );    /* reset the pointer to the start of the buffer */
360         return ber;
361 }
362
363 /* New C-API ber_flatten routine */
364 /* This routine allocates a struct berval whose contents are a BER
365 ** encoding taken from the ber argument.  The bvPtr pointer points to
366 ** the returned berval.
367 **
368 ** ber_flatten2 is the same, but uses a struct berval passed by
369 ** the caller. If alloc is 0 the returned bv uses the ber buf directly.
370 */
371 int ber_flatten2(
372         BerElement *ber,
373         struct berval *bv,
374         int alloc )
375 {
376         assert( bv != NULL );
377
378         ber_int_options.lbo_valid = LBER_INITIALIZED;
379
380         if ( bv == NULL ) {
381                 return -1;
382         }
383
384         if ( ber == NULL ) {
385                 /* ber is null, create an empty berval */
386                 bv->bv_val = NULL;
387                 bv->bv_len = 0;
388
389         } else {
390                 /* copy the berval */
391                 ber_len_t len = ber_pvt_ber_write( ber );
392
393                 if ( alloc ) {
394                         bv->bv_val = (char *) ber_memalloc_x( len + 1, ber->ber_memctx );
395                         if ( bv->bv_val == NULL ) {
396                                 return -1;
397                         }
398                         AC_MEMCPY( bv->bv_val, ber->ber_buf, len );
399                 } else {
400                         bv->bv_val = ber->ber_buf;
401                 }
402                 bv->bv_val[len] = '\0';
403                 bv->bv_len = len;
404         }
405         return 0;
406 }
407
408 int ber_flatten(
409         BerElement *ber,
410         struct berval **bvPtr)
411 {
412         struct berval *bv;
413         int rc;
414  
415         assert( bvPtr != NULL );
416
417         ber_int_options.lbo_valid = LBER_INITIALIZED;
418
419         if(bvPtr == NULL) {
420                 return -1;
421         }
422
423         bv = ber_memalloc_x( sizeof(struct berval), ber->ber_memctx );
424         if ( bv == NULL ) {
425                 return -1;
426         }
427         rc = ber_flatten2(ber, bv, 1);
428         if (rc == -1) {
429                 ber_memfree_x(bv, ber->ber_memctx);
430         } else {
431                 *bvPtr = bv;
432         }
433         return rc;
434 }
435
436 void
437 ber_reset( BerElement *ber, int was_writing )
438 {
439         assert( ber != NULL );
440         assert( LBER_VALID( ber ) );
441
442         if ( was_writing ) {
443                 ber->ber_end = ber->ber_ptr;
444                 ber->ber_ptr = ber->ber_buf;
445
446         } else {
447                 ber->ber_ptr = ber->ber_end;
448         }
449
450         ber->ber_rwptr = NULL;
451 }
452
453 /*
454  * A rewrite of ber_get_next that can safely be called multiple times 
455  * for the same packet. It will simply continue where it stopped until
456  * a full packet is read.
457  */
458
459 #define LENSIZE 4
460
461 ber_tag_t
462 ber_get_next(
463         Sockbuf *sb,
464         ber_len_t *len,
465         BerElement *ber )
466 {
467         assert( sb != NULL );
468         assert( len != NULL );
469         assert( ber != NULL );
470
471         assert( SOCKBUF_VALID( sb ) );
472         assert( LBER_VALID( ber ) );
473
474 #ifdef NEW_LOGGING
475         LDAP_LOG( BER, ENTRY, "ber_get_next: enter\n", 0, 0, 0 );
476 #else
477         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
478                 "ber_get_next\n" );
479 #endif
480
481         /*
482          * Any ber element looks like this: tag length contents.
483          * Assuming everything's ok, we return the tag byte (we
484          * can assume a single byte), return the length in len,
485          * and the rest of the undecoded element in buf.
486          *
487          * Assumptions:
488          *      1) small tags (less than 128)
489          *      2) definite lengths
490          *      3) primitive encodings used whenever possible
491          *
492          * The code also handles multi-byte tags. The first few bytes
493          * of the message are read to check for multi-byte tags and
494          * lengths. These bytes are temporarily stored in the ber_tag,
495          * ber_len, and ber_usertag fields of the berelement until
496          * tag/len parsing is complete. After this parsing, any leftover
497          * bytes and the rest of the message are copied into the ber_buf.
498          *
499          * We expect tag and len to be at most 32 bits wide.
500          */
501
502         if (ber->ber_rwptr == NULL) {
503 #if 0
504                 /* XXYYZ - dtest does like this assert.  */
505                 assert( ber->ber_buf == NULL );
506 #endif
507                 ber->ber_rwptr = (char *) &ber->ber_len-1;
508                 ber->ber_ptr = ber->ber_rwptr;
509                 ber->ber_tag = 0;
510         }
511
512         while (ber->ber_rwptr > (char *)&ber->ber_tag && ber->ber_rwptr <
513                 (char *)&ber->ber_len + LENSIZE*2 -1) {
514                 ber_slen_t sblen;
515                 char buf[sizeof(ber->ber_len)-1];
516                 ber_len_t tlen = 0;
517
518                 sblen=ber_int_sb_read( sb, ber->ber_rwptr,
519                         ((char *)&ber->ber_len + LENSIZE*2 - 1)-ber->ber_rwptr);
520                 if (sblen<=0) return LBER_DEFAULT;
521                 ber->ber_rwptr += sblen;
522
523                 /* We got at least one byte, try to parse the tag. */
524                 if (ber->ber_ptr == (char *)&ber->ber_len-1) {
525                         ber_tag_t tag;
526                         unsigned char *p = (unsigned char *)ber->ber_ptr;
527                         tag = *p++;
528                         if ((tag & LBER_BIG_TAG_MASK) == LBER_BIG_TAG_MASK) {
529                                 ber_len_t i;
530                                 for (i=1; (char *)p<ber->ber_rwptr; i++) {
531                                         tag <<= 8;
532                                         tag |= *p++;
533                                         if (!(tag & LBER_MORE_TAG_MASK))
534                                                 break;
535                                         /* Is the tag too big? */
536                                         if (i == sizeof(ber_tag_t)-1) {
537                                                 errno = ERANGE;
538                                                 return LBER_DEFAULT;
539                                         }
540                                 }
541                                 /* Did we run out of bytes? */
542                                 if ((char *)p == ber->ber_rwptr) {
543 #if defined( EWOULDBLOCK )
544                                         errno = EWOULDBLOCK;
545 #elif defined( EAGAIN )
546                                         errno = EAGAIN;
547 #endif                  
548                                         return LBER_DEFAULT;
549                                 }
550                         }
551                         if (sblen == 1) continue;
552
553                         ber->ber_tag = tag;
554                         ber->ber_ptr = (char *)p;
555                 }
556
557                 /* Now look for the length */
558                 if (*ber->ber_ptr & 0x80) {     /* multi-byte */
559                         ber_len_t i;
560                         unsigned char *p = (unsigned char *)ber->ber_ptr;
561                         int llen = *p++ & 0x7f;
562                         if (llen > (int)sizeof(ber_len_t)) {
563                                 errno = ERANGE;
564                                 return LBER_DEFAULT;
565                         }
566                         /* Not enough bytes? */
567                         if (ber->ber_rwptr - (char *)p < llen) {
568 #if defined( EWOULDBLOCK )
569                                 errno = EWOULDBLOCK;
570 #elif defined( EAGAIN )
571                                 errno = EAGAIN;
572 #endif                  
573                                 return LBER_DEFAULT;
574                         }
575                         for (i=0; i<llen; i++)
576                         {
577                                 tlen <<=8;
578                                 tlen |= *p++;
579                         }
580                         ber->ber_ptr = p;
581                 } else {
582                         tlen = *(unsigned char *)ber->ber_ptr++;
583                 }
584
585                 /* Are there leftover data bytes inside ber->ber_len? */
586                 if (ber->ber_ptr < (char *)&ber->ber_usertag) {
587                         if (ber->ber_rwptr < (char *)&ber->ber_usertag)
588                                 sblen = ber->ber_rwptr - ber->ber_ptr;
589                         else
590                                 sblen = (char *)&ber->ber_usertag - ber->ber_ptr;
591                         AC_MEMCPY(buf, ber->ber_ptr, sblen);
592                         ber->ber_ptr += sblen;
593                 } else {
594                         sblen = 0;
595                 }
596                 ber->ber_len = tlen;
597
598                 /* now fill the buffer. */
599
600                 /* make sure length is reasonable */
601                 if ( ber->ber_len == 0 ) {
602                         errno = ERANGE;
603                         return LBER_DEFAULT;
604                 }
605
606                 if ( sb->sb_max_incoming && ber->ber_len > sb->sb_max_incoming ) {
607 #ifdef NEW_LOGGING
608                         LDAP_LOG( BER, ERR, 
609                                 "ber_get_next: sockbuf_max_incoming exceeded "
610                                 "(%d > %d)\n", ber->ber_len, sb->sb_max_incoming, 0 );
611 #else
612                         ber_log_printf( LDAP_DEBUG_CONNS, ber->ber_debug,
613                                 "ber_get_next: sockbuf_max_incoming exceeded "
614                                 "(%ld > %ld)\n", ber->ber_len, sb->sb_max_incoming );
615 #endif
616                         errno = ERANGE;
617                         return LBER_DEFAULT;
618                 }
619
620                 if (ber->ber_buf==NULL) {
621                         ber_len_t l = ber->ber_rwptr - ber->ber_ptr;
622                         /* ber->ber_ptr is always <= ber->ber->ber_rwptr.
623                          * make sure ber->ber_len agrees with what we've
624                          * already read.
625                          */
626                         if ( ber->ber_len < sblen + l ) {
627                                 errno = ERANGE;
628                                 return LBER_DEFAULT;
629                         }
630                         ber->ber_buf = (char *) ber_memalloc_x( ber->ber_len + 1, ber->ber_memctx );
631                         if (ber->ber_buf==NULL) {
632                                 return LBER_DEFAULT;
633                         }
634                         ber->ber_end = ber->ber_buf + ber->ber_len;
635                         if (sblen) {
636                                 AC_MEMCPY(ber->ber_buf, buf, sblen);
637                         }
638                         if (l > 0) {
639                                 AC_MEMCPY(ber->ber_buf + sblen, ber->ber_ptr, l);
640                                 sblen += l;
641                         }
642                         ber->ber_ptr = ber->ber_buf;
643                         ber->ber_usertag = 0;
644                         if ((ber_len_t)sblen == ber->ber_len) {
645                                 goto done;
646                         }
647                         ber->ber_rwptr = ber->ber_buf + sblen;
648                 }
649         }
650
651         if ((ber->ber_rwptr>=ber->ber_buf) && (ber->ber_rwptr<ber->ber_end)) {
652                 ber_slen_t res;
653                 ber_slen_t to_go;
654                 
655                 to_go = ber->ber_end - ber->ber_rwptr;
656                 assert( to_go > 0 );
657                 
658                 res = ber_int_sb_read( sb, ber->ber_rwptr, to_go );
659                 if (res<=0) return LBER_DEFAULT;
660                 ber->ber_rwptr+=res;
661                 
662                 if (res<to_go) {
663 #if defined( EWOULDBLOCK )
664                         errno = EWOULDBLOCK;
665 #elif defined( EAGAIN )
666                         errno = EAGAIN;
667 #endif                  
668                         return LBER_DEFAULT;
669                 }
670 done:
671                 ber->ber_rwptr = NULL;
672                 *len = ber->ber_len;
673                 if ( ber->ber_debug ) {
674 #ifdef NEW_LOGGING
675                         LDAP_LOG( BER, DETAIL1, 
676                                 "ber_get_next: tag 0x%lx len %ld\n", 
677                                 ber->ber_tag, ber->ber_len, 0  );
678                         if(LDAP_LOGS_TEST(BER, DETAIL2))
679                                         BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
680 #else
681                         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
682                                 "ber_get_next: tag 0x%lx len %ld contents:\n",
683                                 ber->ber_tag, ber->ber_len );
684                         ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
685 #endif
686                 }
687                 return (ber->ber_tag);
688         }
689
690         assert( 0 ); /* ber structure is messed up ?*/
691         return LBER_DEFAULT;
692 }
693
694 char *
695 ber_start( BerElement* ber )
696 {
697         return ber->ber_buf;
698 }
699
700 int
701 ber_len( BerElement* ber )
702 {
703         return ( ber->ber_end - ber->ber_buf );
704 }
705
706 int
707 ber_ptrlen( BerElement* ber )
708 {
709         return ( ber->ber_ptr - ber->ber_buf );
710 }
711
712 void
713 ber_rewind ( BerElement * ber )
714 {
715         ber->ber_rwptr = NULL;
716         ber->ber_sos = NULL;
717         ber->ber_end = ber->ber_ptr;
718         ber->ber_ptr = ber->ber_buf;
719 }
720
721 int
722 ber_remaining( BerElement * ber )
723 {
724         return ber_pvt_ber_remaining( ber );
725 }