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