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