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