1 /* io.c - ber general i/o routines */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2007 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
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>.
16 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
17 * All rights reserved.
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.
27 * This work was originally developed by the University of Michigan
28 * (as part of U-MICH LDAP).
35 #include <ac/stdlib.h>
39 #include <ac/socket.h>
40 #include <ac/string.h>
41 #include <ac/unistd.h>
56 ber_len_t actuallen, nleft;
58 assert( ber != NULL );
59 assert( buf != NULL );
61 assert( LBER_VALID( ber ) );
63 nleft = ber_pvt_ber_remaining( ber );
64 actuallen = nleft < len ? nleft : len;
66 AC_MEMCPY( buf, ber->ber_ptr, actuallen );
68 ber->ber_ptr += actuallen;
70 return( (ber_slen_t) actuallen );
80 assert( ber != NULL );
81 assert( buf != NULL );
83 assert( LBER_VALID( ber ) );
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 );
89 AC_MEMCPY( ber->ber_ptr, buf, (size_t)len );
91 return( (ber_slen_t) len );
94 if ( ber->ber_sos->sos_ptr + len > ber->ber_end ) {
95 if ( ber_realloc( ber, len ) != 0 ) return( -1 );
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 );
105 ber_realloc( BerElement *ber, ber_len_t len )
112 assert( ber != NULL );
114 assert( LBER_VALID( ber ) );
116 total = ber_pvt_ber_total( ber );
118 #define LBER_EXBUFSIZ 4060 /* a few words less than 2^N for binary buddy */
119 #if defined( LBER_EXBUFSIZ ) && LBER_EXBUFSIZ > 0
121 /* don't realloc by small amounts */
122 total += len < LBER_EXBUFSIZ ? LBER_EXBUFSIZ : len;
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;
131 total += len; /* realloc just what's needed */
134 oldbuf = ber->ber_buf;
136 ber->ber_buf = (char *) ber_memrealloc_x( oldbuf, total, ber->ber_memctx );
138 if ( ber->ber_buf == NULL ) {
139 ber->ber_buf = oldbuf;
143 ber->ber_end = ber->ber_buf + total;
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.
151 if ( ber->ber_buf != oldbuf ) {
152 ber->ber_ptr = ber->ber_buf + (ber->ber_ptr - oldbuf);
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;
158 off = s->sos_ptr - oldbuf;
159 s->sos_ptr = ber->ber_buf + off;
167 ber_free_buf( BerElement *ber )
171 assert( LBER_VALID( ber ) );
173 if ( ber->ber_buf) ber_memfree_x( ber->ber_buf, ber->ber_memctx );
175 for( s = ber->ber_sos ; s != NULL ; s = next ) {
177 ber_memfree_x( s, ber->ber_memctx );
182 ber->ber_valid = LBER_UNINITIALIZED;
186 ber_free( BerElement *ber, int freebuf )
188 #ifdef LDAP_MEMORY_DEBUG
189 assert( ber != NULL );
196 if( freebuf ) ber_free_buf( ber );
198 ber_memfree_x( (char *) ber, ber->ber_memctx );
202 ber_flush( Sockbuf *sb, BerElement *ber, int freeit )
204 return ber_flush2( sb, ber,
205 freeit ? LBER_FLUSH_FREE_ON_SUCCESS
206 : LBER_FLUSH_FREE_NEVER );
210 ber_flush2( Sockbuf *sb, BerElement *ber, int freeit )
215 assert( sb != NULL );
216 assert( ber != NULL );
218 assert( SOCKBUF_VALID( sb ) );
219 assert( LBER_VALID( ber ) );
221 if ( ber->ber_rwptr == NULL ) {
222 ber->ber_rwptr = ber->ber_buf;
224 towrite = ber->ber_ptr - ber->ber_rwptr;
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 );
235 while ( towrite > 0 ) {
238 rc = ber_int_sb_write( sb, ber->ber_rwptr, 1 );
240 rc = ber_int_sb_write( sb, ber->ber_rwptr, towrite );
243 if ( freeit & LBER_FLUSH_FREE_ON_ERROR ) ber_free( ber, 1 );
247 ber->ber_rwptr += rc;
250 if ( freeit & LBER_FLUSH_FREE_ON_SUCCESS ) ber_free( ber, 1 );
256 ber_alloc_t( int options )
260 ber = (BerElement *) LBER_CALLOC( 1, sizeof(BerElement) );
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;
271 assert( LBER_VALID( ber ) );
276 ber_alloc( void ) /* deprecated */
278 return ber_alloc_t( 0 );
282 der_alloc( void ) /* deprecated */
284 return ber_alloc_t( LBER_USE_DER );
288 ber_dup( BerElement *ber )
292 assert( ber != NULL );
293 assert( LBER_VALID( ber ) );
295 if ( (new = ber_alloc_t( ber->ber_options )) == NULL ) {
301 assert( LBER_VALID( new ) );
307 ber_init2( BerElement *ber, struct berval *bv, int options )
309 assert( ber != NULL );
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;
318 ber->ber_buf = bv->bv_val;
319 ber->ber_ptr = ber->ber_buf;
320 ber->ber_end = ber->ber_buf + bv->bv_len;
323 assert( LBER_VALID( ber ) );
326 /* OLD U-Mich ber_init() */
328 ber_init_w_nullc( BerElement *ber, int options )
330 ber_init2( ber, NULL, options );
333 /* New C-API ber_init() */
334 /* This function constructs a BerElement containing a copy
335 ** of the data in the bv argument.
338 ber_init( struct berval *bv )
342 assert( bv != NULL );
348 ber = ber_alloc_t( 0 );
351 /* allocation failed */
356 if ( ((ber_len_t) ber_write ( ber, bv->bv_val, bv->bv_len, 0 ))
359 /* write failed, so free and return NULL */
364 ber_reset( ber, 1 ); /* reset the pointer to the start of the buffer */
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.
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.
381 assert( bv != NULL );
388 /* ber is null, create an empty berval */
393 /* copy the berval */
394 ber_len_t len = ber_pvt_ber_write( ber );
397 bv->bv_val = (char *) ber_memalloc_x( len + 1, ber->ber_memctx );
398 if ( bv->bv_val == NULL ) {
401 AC_MEMCPY( bv->bv_val, ber->ber_buf, len );
403 bv->bv_val = ber->ber_buf;
405 bv->bv_val[len] = '\0';
413 struct berval **bvPtr)
418 assert( bvPtr != NULL );
424 bv = ber_memalloc_x( sizeof(struct berval), ber->ber_memctx );
428 rc = ber_flatten2(ber, bv, 1);
430 ber_memfree_x(bv, ber->ber_memctx);
438 ber_reset( BerElement *ber, int was_writing )
440 assert( ber != NULL );
441 assert( LBER_VALID( ber ) );
444 ber->ber_end = ber->ber_ptr;
445 ber->ber_ptr = ber->ber_buf;
448 ber->ber_ptr = ber->ber_end;
451 ber->ber_rwptr = NULL;
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.
468 assert( sb != NULL );
469 assert( len != NULL );
470 assert( ber != NULL );
472 assert( SOCKBUF_VALID( sb ) );
473 assert( LBER_VALID( ber ) );
475 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
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.
485 * 1) small tags (less than 128)
486 * 2) definite lengths
487 * 3) primitive encodings used whenever possible
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.
496 * We expect tag and len to be at most 32 bits wide.
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;
506 while (ber->ber_rwptr > (char *)&ber->ber_tag && ber->ber_rwptr <
507 (char *)&ber->ber_len + LENSIZE*2 -1) {
509 char buf[sizeof(ber->ber_len)-1];
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;
518 /* We got at least one byte, try to parse the tag. */
519 if (ber->ber_ptr == (char *)&ber->ber_len-1) {
521 unsigned char *p = (unsigned char *)ber->ber_ptr;
523 if ((tag & LBER_BIG_TAG_MASK) == LBER_BIG_TAG_MASK) {
525 for (i=1; (char *)p<ber->ber_rwptr; i++) {
528 if (!(tag & LBER_MORE_TAG_MASK))
530 /* Is the tag too big? */
531 if (i == sizeof(ber_tag_t)-1) {
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 )
547 ber->ber_ptr = (char *)p;
550 if ( ber->ber_ptr == ber->ber_rwptr ) {
551 #if defined( EWOULDBLOCK )
552 sock_errset(EWOULDBLOCK);
553 #elif defined( EAGAIN )
559 /* Now look for the length */
560 if (*ber->ber_ptr & 0x80) { /* multi-byte */
562 unsigned char *p = (unsigned char *)ber->ber_ptr;
563 int llen = *p++ & 0x7f;
564 if (llen > (int)sizeof(ber_len_t)) {
568 /* Not enough bytes? */
569 if (ber->ber_rwptr - (char *)p < llen) {
570 #if defined( EWOULDBLOCK )
571 sock_errset(EWOULDBLOCK);
572 #elif defined( EAGAIN )
577 for (i=0; i<llen; i++) {
581 ber->ber_ptr = (char *)p;
583 tlen = *(unsigned char *)ber->ber_ptr++;
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;
591 sblen = (char *)&ber->ber_usertag - ber->ber_ptr;
593 AC_MEMCPY(buf, ber->ber_ptr, sblen);
594 ber->ber_ptr += sblen;
600 /* now fill the buffer. */
602 /* make sure length is reasonable */
603 if ( ber->ber_len == 0 ) {
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 );
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
622 if ( ber->ber_len < sblen + l ) {
626 ber->ber_buf = (char *) ber_memalloc_x( ber->ber_len + 1, ber->ber_memctx );
627 if (ber->ber_buf==NULL) {
630 ber->ber_end = ber->ber_buf + ber->ber_len;
632 AC_MEMCPY(ber->ber_buf, buf, sblen);
635 AC_MEMCPY(ber->ber_buf + sblen, ber->ber_ptr, l);
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) {
644 ber->ber_rwptr = ber->ber_buf + sblen;
648 if ((ber->ber_rwptr>=ber->ber_buf) && (ber->ber_rwptr<ber->ber_end)) {
652 to_go = ber->ber_end - ber->ber_rwptr;
656 res = ber_int_sb_read( sb, ber->ber_rwptr, to_go );
657 if (res<=0) return LBER_DEFAULT;
661 #if defined( EWOULDBLOCK )
662 sock_errset(EWOULDBLOCK);
663 #elif defined( EAGAIN )
669 ber->ber_rwptr = NULL;
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 );
677 return (ber->ber_tag);
680 assert( 0 ); /* ber structure is messed up ?*/
685 ber_start( BerElement* ber )
691 ber_len( BerElement* ber )
693 return ( ber->ber_end - ber->ber_buf );
697 ber_ptrlen( BerElement* ber )
699 return ( ber->ber_ptr - ber->ber_buf );
703 ber_rewind ( BerElement * ber )
705 ber->ber_rwptr = NULL;
707 ber->ber_end = ber->ber_ptr;
708 ber->ber_ptr = ber->ber_buf;
712 ber_remaining( BerElement * ber )
714 return ber_pvt_ber_remaining( ber );