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