1 /* io.c - ber general i/o routines */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2010 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>
55 ber_len_t actuallen, nleft;
57 assert( ber != NULL );
58 assert( LBER_VALID( ber ) );
60 nleft = ber_pvt_ber_remaining( ber );
61 actuallen = nleft < len ? nleft : len;
62 ber->ber_ptr += actuallen;
63 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
65 return( (ber_slen_t) actuallen );
69 * Read from the ber buffer. The caller must maintain ber->ber_tag.
70 * Do not use to read whole tags. See ber_get_tag() and ber_skip_data().
78 ber_len_t actuallen, nleft;
80 assert( ber != NULL );
81 assert( buf != NULL );
82 assert( LBER_VALID( ber ) );
84 nleft = ber_pvt_ber_remaining( ber );
85 actuallen = nleft < len ? nleft : len;
87 AC_MEMCPY( buf, ber->ber_ptr, actuallen );
89 ber->ber_ptr += actuallen;
91 return( (ber_slen_t) actuallen );
95 * Write to the ber buffer.
96 * Note that ber_start_seqorset/ber_put_seqorset() bypass ber_write().
101 LDAP_CONST char *buf,
103 int zero ) /* nonzero is unsupported from OpenLDAP 2.4.18 */
107 assert( ber != NULL );
108 assert( buf != NULL );
109 assert( LBER_VALID( ber ) );
112 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug, "%s",
113 "ber_write: nonzero 4th argument not supported\n" );
117 p = ber->ber_sos_ptr == NULL ? &ber->ber_ptr : &ber->ber_sos_ptr;
118 if ( len > (ber_len_t) (ber->ber_end - *p) ) {
119 if ( ber_realloc( ber, len ) != 0 ) return( -1 );
121 AC_MEMCPY( *p, buf, len );
124 return( (ber_slen_t) len );
127 /* Resize the ber buffer */
129 ber_realloc( BerElement *ber, ber_len_t len )
131 ber_len_t total, offset, sos_offset;
134 assert( ber != NULL );
135 assert( LBER_VALID( ber ) );
137 /* leave room for ber_flatten() to \0-terminate ber_buf */
142 total = ber_pvt_ber_total( ber );
144 #define LBER_EXBUFSIZ 4060 /* a few words less than 2^N for binary buddy */
145 #if defined( LBER_EXBUFSIZ ) && LBER_EXBUFSIZ > 0
147 /* don't realloc by small amounts */
148 total += len < LBER_EXBUFSIZ ? LBER_EXBUFSIZ : len;
150 { /* not sure what value this adds. reduce fragmentation? */
151 ber_len_t have = (total + (LBER_EXBUFSIZE - 1)) / LBER_EXBUFSIZ;
152 ber_len_t need = (len + (LBER_EXBUFSIZ - 1)) / LBER_EXBUFSIZ;
153 total = ( have + need ) * LBER_EXBUFSIZ;
157 total += len; /* realloc just what's needed */
160 if ( total < len || total > (ber_len_t)-1 / 2 /* max ber_slen_t */ ) {
165 offset = ber->ber_ptr - buf;
166 sos_offset = ber->ber_sos_ptr ? ber->ber_sos_ptr - buf : 0;
167 /* if ber_sos_ptr != NULL, it is > ber_buf so that sos_offset > 0 */
169 buf = (char *) ber_memrealloc_x( buf, total, ber->ber_memctx );
175 ber->ber_end = buf + total;
176 ber->ber_ptr = buf + offset;
178 ber->ber_sos_ptr = buf + sos_offset;
184 ber_free_buf( BerElement *ber )
186 assert( LBER_VALID( ber ) );
188 if ( ber->ber_buf) ber_memfree_x( ber->ber_buf, ber->ber_memctx );
191 ber->ber_sos_ptr = NULL;
192 ber->ber_valid = LBER_UNINITIALIZED;
196 ber_free( BerElement *ber, int freebuf )
199 LDAP_MEMORY_DEBUG_ASSERT( ber != NULL );
203 if( freebuf ) ber_free_buf( ber );
205 ber_memfree_x( (char *) ber, ber->ber_memctx );
209 ber_flush( Sockbuf *sb, BerElement *ber, int freeit )
211 return ber_flush2( sb, ber,
212 freeit ? LBER_FLUSH_FREE_ON_SUCCESS
213 : LBER_FLUSH_FREE_NEVER );
217 ber_flush2( Sockbuf *sb, BerElement *ber, int freeit )
222 assert( sb != NULL );
223 assert( ber != NULL );
224 assert( SOCKBUF_VALID( sb ) );
225 assert( LBER_VALID( ber ) );
227 if ( ber->ber_rwptr == NULL ) {
228 ber->ber_rwptr = ber->ber_buf;
230 towrite = ber->ber_ptr - ber->ber_rwptr;
232 if ( sb->sb_debug ) {
233 ber_log_printf( LDAP_DEBUG_TRACE, sb->sb_debug,
234 "ber_flush2: %ld bytes to sd %ld%s\n",
235 towrite, (long) sb->sb_fd,
236 ber->ber_rwptr != ber->ber_buf ? " (re-flush)" : "" );
237 ber_log_bprint( LDAP_DEBUG_BER, sb->sb_debug,
238 ber->ber_rwptr, towrite );
241 while ( towrite > 0 ) {
244 rc = ber_int_sb_write( sb, ber->ber_rwptr, 1 );
246 rc = ber_int_sb_write( sb, ber->ber_rwptr, towrite );
249 if ( freeit & LBER_FLUSH_FREE_ON_ERROR ) ber_free( ber, 1 );
253 ber->ber_rwptr += rc;
256 if ( freeit & LBER_FLUSH_FREE_ON_SUCCESS ) ber_free( ber, 1 );
262 ber_alloc_t( int options )
266 ber = (BerElement *) LBER_CALLOC( 1, sizeof(BerElement) );
272 ber->ber_valid = LBER_VALID_BERELEMENT;
273 ber->ber_tag = LBER_DEFAULT;
274 ber->ber_options = options;
275 ber->ber_debug = ber_int_debug;
277 assert( LBER_VALID( ber ) );
282 ber_alloc( void ) /* deprecated */
284 return ber_alloc_t( 0 );
288 der_alloc( void ) /* deprecated */
290 return ber_alloc_t( LBER_USE_DER );
294 ber_dup( BerElement *ber )
298 assert( ber != NULL );
299 assert( LBER_VALID( ber ) );
301 if ( (new = ber_alloc_t( ber->ber_options )) == NULL ) {
307 assert( LBER_VALID( new ) );
313 ber_init2( BerElement *ber, struct berval *bv, int options )
315 assert( ber != NULL );
317 (void) memset( (char *)ber, '\0', sizeof( BerElement ));
318 ber->ber_valid = LBER_VALID_BERELEMENT;
319 ber->ber_tag = LBER_DEFAULT;
320 ber->ber_options = (char) options;
321 ber->ber_debug = ber_int_debug;
324 ber->ber_buf = bv->bv_val;
325 ber->ber_ptr = ber->ber_buf;
326 ber->ber_end = ber->ber_buf + bv->bv_len;
329 assert( LBER_VALID( ber ) );
332 /* OLD U-Mich ber_init() */
334 ber_init_w_nullc( BerElement *ber, int options )
336 ber_init2( ber, NULL, options );
339 /* New C-API ber_init() */
340 /* This function constructs a BerElement containing a copy
341 ** of the data in the bv argument.
344 ber_init( struct berval *bv )
348 assert( bv != NULL );
354 ber = ber_alloc_t( 0 );
357 /* allocation failed */
362 if ( ((ber_len_t) ber_write ( ber, bv->bv_val, bv->bv_len, 0 ))
365 /* write failed, so free and return NULL */
370 ber_reset( ber, 1 ); /* reset the pointer to the start of the buffer */
374 /* New C-API ber_flatten routine */
375 /* This routine allocates a struct berval whose contents are a BER
376 ** encoding taken from the ber argument. The bvPtr pointer points to
377 ** the returned berval.
379 ** ber_flatten2 is the same, but uses a struct berval passed by
380 ** the caller. If alloc is 0 the returned bv uses the ber buf directly.
387 assert( bv != NULL );
394 /* ber is null, create an empty berval */
399 /* copy the berval */
400 ber_len_t len = ber_pvt_ber_write( ber );
403 bv->bv_val = (char *) ber_memalloc_x( len + 1, ber->ber_memctx );
404 if ( bv->bv_val == NULL ) {
407 AC_MEMCPY( bv->bv_val, ber->ber_buf, len );
408 bv->bv_val[len] = '\0';
409 } else if ( ber->ber_buf != NULL ) {
410 bv->bv_val = ber->ber_buf;
411 bv->bv_val[len] = '\0';
422 struct berval **bvPtr)
427 assert( bvPtr != NULL );
433 bv = ber_memalloc_x( sizeof(struct berval), ber->ber_memctx );
437 rc = ber_flatten2(ber, bv, 1);
439 ber_memfree_x(bv, ber->ber_memctx);
447 ber_reset( BerElement *ber, int was_writing )
449 assert( ber != NULL );
450 assert( LBER_VALID( ber ) );
453 ber->ber_end = ber->ber_ptr;
454 ber->ber_ptr = ber->ber_buf;
457 ber->ber_ptr = ber->ber_end;
460 ber->ber_rwptr = NULL;
464 * A rewrite of ber_get_next that can safely be called multiple times
465 * for the same packet. It will simply continue where it stopped until
466 * a full packet is read.
477 assert( sb != NULL );
478 assert( len != NULL );
479 assert( ber != NULL );
480 assert( SOCKBUF_VALID( sb ) );
481 assert( LBER_VALID( ber ) );
483 if ( ber->ber_debug & LDAP_DEBUG_TRACE ) {
484 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
489 * Any ber element looks like this: tag length contents.
490 * Assuming everything's ok, we return the tag byte (we
491 * can assume a single byte), return the length in len,
492 * and the rest of the undecoded element in buf.
495 * 1) small tags (less than 128)
496 * 2) definite lengths
497 * 3) primitive encodings used whenever possible
499 * The code also handles multi-byte tags. The first few bytes
500 * of the message are read to check for multi-byte tags and
501 * lengths. These bytes are temporarily stored in the ber_tag,
502 * ber_len, and ber_usertag fields of the berelement until
503 * tag/len parsing is complete. After this parsing, any leftover
504 * bytes and the rest of the message are copied into the ber_buf.
506 * We expect tag and len to be at most 32 bits wide.
509 if (ber->ber_rwptr == NULL) {
510 assert( ber->ber_buf == NULL );
511 ber->ber_rwptr = (char *) &ber->ber_len-1;
512 ber->ber_ptr = ber->ber_rwptr;
516 while (ber->ber_rwptr > (char *)&ber->ber_tag && ber->ber_rwptr <
517 (char *)&ber->ber_len + LENSIZE*2) {
519 char buf[sizeof(ber->ber_len)-1];
522 /* The tag & len can be at most 9 bytes; we try to read up to 8 here */
524 sblen=((char *)&ber->ber_len + LENSIZE*2 - 1)-ber->ber_rwptr;
525 /* Trying to read the last len byte of a 9 byte tag+len */
528 sblen=ber_int_sb_read( sb, ber->ber_rwptr, sblen );
529 if (sblen<=0) return LBER_DEFAULT;
530 ber->ber_rwptr += sblen;
532 /* We got at least one byte, try to parse the tag. */
533 if (ber->ber_ptr == (char *)&ber->ber_len-1) {
535 unsigned char *p = (unsigned char *)ber->ber_ptr;
537 if ((tag & LBER_BIG_TAG_MASK) == LBER_BIG_TAG_MASK) {
539 for (i=1; (char *)p<ber->ber_rwptr; i++) {
542 if (!(tag & LBER_MORE_TAG_MASK))
544 /* Is the tag too big? */
545 if (i == sizeof(ber_tag_t)-1) {
550 /* Did we run out of bytes? */
551 if ((char *)p == ber->ber_rwptr) {
552 sock_errset(EWOULDBLOCK);
557 ber->ber_ptr = (char *)p;
560 if ( ber->ber_ptr == ber->ber_rwptr ) {
561 sock_errset(EWOULDBLOCK);
565 /* Now look for the length */
566 if (*ber->ber_ptr & 0x80) { /* multi-byte */
568 unsigned char *p = (unsigned char *)ber->ber_ptr;
569 int llen = *p++ & 0x7f;
570 if (llen > LENSIZE) {
574 /* Not enough bytes? */
575 if (ber->ber_rwptr - (char *)p < llen) {
576 sock_errset(EWOULDBLOCK);
579 for (i=0; i<llen; i++) {
583 ber->ber_ptr = (char *)p;
585 tlen = *(unsigned char *)ber->ber_ptr++;
588 /* Are there leftover data bytes inside ber->ber_len? */
589 if (ber->ber_ptr < (char *)&ber->ber_usertag) {
590 if (ber->ber_rwptr < (char *)&ber->ber_usertag) {
591 sblen = ber->ber_rwptr - ber->ber_ptr;
593 sblen = (char *)&ber->ber_usertag - ber->ber_ptr;
595 AC_MEMCPY(buf, ber->ber_ptr, sblen);
596 ber->ber_ptr += sblen;
602 /* now fill the buffer. */
604 /* make sure length is reasonable */
605 if ( ber->ber_len == 0 ) {
610 if ( sb->sb_max_incoming && ber->ber_len > sb->sb_max_incoming ) {
611 ber_log_printf( LDAP_DEBUG_CONNS, ber->ber_debug,
612 "ber_get_next: sockbuf_max_incoming exceeded "
613 "(%ld > %ld)\n", ber->ber_len, sb->sb_max_incoming );
618 if (ber->ber_buf==NULL) {
619 ber_len_t l = ber->ber_rwptr - ber->ber_ptr;
620 /* ber->ber_ptr is always <= ber->ber->ber_rwptr.
621 * make sure ber->ber_len agrees with what we've
624 if ( ber->ber_len < sblen + l ) {
628 ber->ber_buf = (char *) ber_memalloc_x( ber->ber_len + 1, ber->ber_memctx );
629 if (ber->ber_buf==NULL) {
632 ber->ber_end = ber->ber_buf + ber->ber_len;
634 AC_MEMCPY(ber->ber_buf, buf, sblen);
637 AC_MEMCPY(ber->ber_buf + sblen, ber->ber_ptr, l);
640 *ber->ber_end = '\0';
641 ber->ber_ptr = ber->ber_buf;
642 ber->ber_usertag = 0;
643 if ((ber_len_t)sblen == ber->ber_len) {
646 ber->ber_rwptr = ber->ber_buf + sblen;
650 if ((ber->ber_rwptr>=ber->ber_buf) && (ber->ber_rwptr<ber->ber_end)) {
654 to_go = ber->ber_end - ber->ber_rwptr;
658 res = ber_int_sb_read( sb, ber->ber_rwptr, to_go );
659 if (res<=0) return LBER_DEFAULT;
663 sock_errset(EWOULDBLOCK);
667 ber->ber_rwptr = NULL;
669 if ( ber->ber_debug ) {
670 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
671 "ber_get_next: tag 0x%lx len %ld contents:\n",
672 ber->ber_tag, ber->ber_len );
673 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
675 return (ber->ber_tag);
678 assert( 0 ); /* ber structure is messed up ?*/
683 ber_start( BerElement* ber )
689 ber_len( BerElement* ber )
691 return ( ber->ber_end - ber->ber_buf );
695 ber_ptrlen( BerElement* ber )
697 return ( ber->ber_ptr - ber->ber_buf );
701 ber_rewind ( BerElement * ber )
703 ber->ber_rwptr = NULL;
704 ber->ber_sos_ptr = NULL;
705 ber->ber_end = ber->ber_ptr;
706 ber->ber_ptr = ber->ber_buf;
707 #if 0 /* TODO: Should we add this? */
708 ber->ber_tag = LBER_DEFAULT;
709 ber->ber_usertag = 0;
714 ber_remaining( BerElement * ber )
716 return ber_pvt_ber_remaining( ber );