1 /* sockbuf.c - i/o routines with support for adding i/o layers. */
3 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
14 #include <ac/socket.h>
15 #include <ac/string.h>
16 #include <ac/unistd.h>
20 #endif /* HAVE_IO_H */
22 #if defined( HAVE_SYS_FILIO_H )
23 #include <sys/filio.h>
24 #elif defined( HAVE_SYS_IOCTL_H )
25 #include <sys/ioctl.h>
31 #undef TEST_PARTIAL_READ
32 #undef TEST_PARTIAL_WRITE
35 #define MAX_BUF_SIZE 65535
36 #define MIN_BUF_SIZE 4096
38 #define sockbuf_io_write( sb, buf, len ) \
39 ((sb)->sb_io->sbi_write( (sb), (buf), (len) ))
41 #define sockbuf_io_read( sb, buf, len ) \
42 ((sb)->sb_io->sbi_read( (sb), (buf), (len) ))
44 static long have_no_read( Sockbuf *sb, void *buf, long len );
45 static long have_no_write( Sockbuf *sb, void *buf, long len );
46 static int have_no_close( Sockbuf *sb );
48 static Sockbuf_IO lber_pvt_sb_IO_None=
51 NULL, /* sbi_release */
52 have_no_read, /* sbi_read */
53 have_no_write, /* sbi_write */
54 have_no_close /* sbi_close */
58 update_status( Sockbuf *sb )
60 sb->sb_buf_ready = (sb->sb_buf.buf_ptr < sb->sb_buf.buf_end);
62 sb->sb_sec_ready = ((sb->sb_sec_buf_in.buf_end!=0) &&
63 (sb->sb_sec_buf_in.buf_ptr >=
64 sb->sb_sec_buf_in.buf_end));
70 status_is_ok( Sockbuf *sb )
72 int obr = sb->sb_buf_ready;
74 int osr = sb->sb_sec_ready;
78 if (obr!=sb->sb_buf_ready)
82 if (osr!=sb->sb_sec_ready)
92 packet_length( char *buf )
95 size = (((unsigned long)buf[0])<<24)|
96 (((unsigned long)buf[1])<<16)|
97 (((unsigned long)buf[2])<<8)|
98 (((unsigned long)buf[3]));
100 if ((size<0) || (size>MAX_BUF_SIZE)) {
101 /* somebody is trying to mess me up. */
102 lber_log_printf( LDAP_DEBUG_SASL, sb->sb_debug,
103 "SASL: received packet length of %d bytes\n",
105 size = 16; /* this should lead to an error. */
108 return size + 4; /* include the size !!! */
113 grow_buffer( Sockbuf_Buf * buf, long minsize )
115 long pw=MIN_BUF_SIZE;
117 for(;(pw<minsize);pw<<=1) {
118 if (pw > MAX_BUF_SIZE) {
119 /* this could mean that somebody is trying to crash us. */
125 if (buf->buf_size<minsize) {
126 if ((buf->buf_base==NULL) || ((buf->buf_end==0) && (buf->buf_ptr==0))) {
128 if (buf->buf_base!=NULL)
129 free( buf->buf_base );
130 assert( buf->buf_ptr==0 );
131 assert( buf->buf_end==0 );
132 buf->buf_base = malloc( minsize );
133 if (buf->buf_base==NULL)
137 nb = realloc( buf->buf_base, minsize );
142 buf->buf_size = minsize;
149 sockbuf_sec_release( Sockbuf *sb, char *buf, long len )
151 /* when this is called:
152 * sb->sb_sec_buf_in.buf_base points to a packet.
153 * sb->sb_sec_buf_in.buf_ptr contains the total bytes read.
154 * sb->sb_sec_end.buf_end contains the packet length.
156 * sb->sb_buf.buf_ptr == sb->sb_buf.buf_end == 0;
164 assert( sb->sb_sec );
165 assert( sb->sb_sec->sbs_release );
166 assert( sb->sb_sec_buf_in.sb_ptr >= sb->sb_sec_buf_in.sb_end );
168 assert( sb->sb_buf.sb_ptr == 0 );
169 assert( sb->sb_buf.sb_end == 0 );
171 assert( status_is_ok(sb) );
175 ptr = sb->sb_sec_buf_in.buf_base;
176 end = ptr+ sb->sb_sec_buf_in.buf_ptr;
177 size = sb->sb_sec_buf_in.buf_end;
179 sb->sb_sec_ready = 1;
181 for(;(ptr+size<=end);) {
183 rlen = sb->sb_sec->sbs_release( sb, ptr, size,
186 sb->sb_buf.buf_size );
188 /* this means a security violation. */
189 return total; /* total ? total : 0 */
192 /* this means that the buffer isn't big enough. */
193 if (grow_buffer( &(sb->sb_buf), -rlen )<0)
194 /* memory violation. */
195 return total; /* total ? total : 0 */
203 /* move to the next packet... */
207 size = packet_length( ptr );
208 /* size is always at least 4, so the loop condition is always OK !!*/
215 sb->sb_buf_ready = (sb->sb_buf.buf_end = rlen - len) ? 1 : 0;
221 sb->sb_sec_ready = 0;
222 /* clean up the mess. */
224 /* copy back to beginning of buffer. */
225 SAFEMEMCPY( sb->sb_sec_buf_in.buf_base, ptr, end-ptr );
226 sb->sb_sec_buf_in.buf_ptr = 0;
227 sb->sb_sec_buf_in.buf_end -= (ptr - sb->sb_sec_buf_in.buf_base);
229 assert( status_is_ok(sb) );
234 sockbuf_sec_protect( Sockbuf *sb, char *buf, long len )
240 assert( sb->sb_sec_out.buf_end == 0 );
241 assert( sb->sb_sec_out.buf_ptr == 0 );
243 assert( sb->sb_sec );
244 assert( sb->sb_sec->sbs_protect );
246 assert( status_is_ok(sb) );
252 ret = sb->sb_sec->sbs_protect( sb, buf, &blen,
253 sb->sb_sec_out.buf_base+
254 sb->sb_sec_out.buf_end,
255 sb->sb_sec_out.buf_size -
256 sb->sb_sec_out.buf_end );
258 /* protection error ? */
261 if (grow_buffer( &(sb->sb_sec_out),-ret-sb->sb_sec_out.buf_end )<0)
266 /* else if (ret>0) */
269 sb->sb_sec_out.buf_end += ret;
273 assert( status_is_ok(sb) );
279 sockbuf_copy_out( Sockbuf *sb, char **buf, long len )
281 long blen = (sb->sb_buf.buf_end - sb->sb_buf.buf_ptr );
282 assert( status_is_ok(sb) );
284 long rlen = (blen<len) ? blen : len;
285 memcpy( *buf, sb->sb_buf.buf_base + sb->sb_buf.buf_ptr, rlen );
286 sb->sb_buf.buf_ptr+=rlen;
289 if (sb->sb_buf.buf_ptr >= sb->sb_buf.buf_end) {
290 sb->sb_buf.buf_ptr = sb->sb_buf.buf_end = 0;
291 sb->sb_buf_ready = 0;
293 sb->sb_buf_ready = 1;
296 assert( status_is_ok(sb) );
302 lber_pvt_sb_read( Sockbuf *sb, void *buf_arg, long len )
307 assert( status_is_ok(sb) );
309 /* breaks slapd :-) */
310 assert( lber_pvt_sb_in_use( sb ) );
313 #ifdef TEST_PARTIAL_READ
314 if ((rand() & 3)==1) { /* 1 out of 4 */
319 len = (rand() % len)+1;
322 buf = (char *) buf_arg;
324 if (sb->sb_buf.buf_ptr!=sb->sb_buf.buf_end) {
325 len = sockbuf_copy_out( sb, &buf, len );
327 return (buf - (char *) buf_arg);
334 assert( sb->sb_sec->sbs_release );
335 assert( sb->sb_sec_buf_in.buf_base );
336 if (sb->sb_read_ahead) {
337 max = sb->sb_sec_buf_in.buf_size - sb->sb_sec_buf_in.buf_ptr;
339 max = sb->sb_sec_buf_in.buf_end - sb->sb_sec_buf_in.buf_ptr;
341 /* special situation. This means that we need to read the first
342 * four bytes for the packet length.
348 /* read from stream into sb_sec_buf_in */
350 ret = sockbuf_io_read( sb, sb->sb_sec_buf_in.buf_base +
351 sb->sb_sec_buf_in.buf_ptr, max );
353 if ((ret<0) && (errno==EINTR))
359 /* read error. return */
362 sb->sb_sec_buf_in.buf_ptr += ret;
364 if (sb->sb_sec_buf_in.buf_ptr < sb->sb_sec_buf_in.buf_end) {
365 /* did not finish a packet. give up. */
369 if (sb->sb_sec_buf_in.buf_end == 0) {
370 /* Were trying to read the first four bytes... */
371 if (sb->sb_sec_buf_in.buf_ptr < 4) {
372 /* did not read enough for packet length. give up. */
375 /* calculate the packet length. */
376 sb->sb_sec_buf_in.buf_end =
377 packet_length(sb->sb_sec_buf_in.buf_base );
378 if ((sb->sb_sec_buf_in.buf_end > sb->sb_sec_buf_in.buf_size) &&
379 (grow_buffer( &(sb->sb_sec_buf_in), sb->sb_sec_buf_in.buf_end)<0)) {
380 /* buffer has to be to big. exit with error. */
384 if (sb->sb_sec_buf_in.buf_ptr >= sb_sec_buf_in.buf_end) {
385 /* finished packet. decode it. */
388 /* did not finish packet yet. try again ? */
389 if (sb->sb_read_ahead) {
390 /* we were trying to read the max anyway. forget it */
395 /* we read enough for at least 1 packet */
396 ret = sockbuf_sec_release( sb, buf, len );
398 /* something went wrong... */
403 /* we are finished !!! */
404 if ((len==0) || (ret!=max))
409 if (sb->sb_read_ahead) {
411 max = sb->sb_buf.buf_size - sb->sb_buf.buf_end;
414 ret = sockbuf_io_read( sb,
415 sb->sb_buf.buf_base +
419 if ((ret<0) && (errno==EINTR))
425 /* some error occured */
428 sb->sb_buf.buf_end += ret;
429 /* move out the data... */
430 len = sockbuf_copy_out( sb, &buf, len );
434 /* no read_ahead, just try to put the data in the buf. */
436 ret = sockbuf_io_read( sb, buf, len );
438 if ((ret<0) && (errno==EINTR))
447 /* we might as well return, since there is nothing to do... */
452 assert( status_is_ok(sb) );
453 if ((ret<=0) && (buf==buf_arg)) {
454 /* there was an error. */
457 return (buf - ((char *) buf_arg));
461 long sockbuf_do_write( Sockbuf *sb )
464 to_go = sb->sb_sec_out.buf_end - sb->sb_sec_out.buf_ptr;
466 /* there is something left of the last time... */
468 ret = sockbuf_io_write( sb, sb->sb_sec_out.buf_base+
469 sb->sb_sec_out.buf_ptr, to_go );
471 if ((ret<0) && (errno==EINTR))
476 if (ret<=0) /* error */
478 sb->sb_sec_out.buf_ptr += ret;
479 if (ret<to_go) /* not enough data, so pretend no data was sent. */
485 long lber_pvt_sb_write( Sockbuf *sb, void *buf, long len_arg )
489 assert( status_is_ok(sb) );
491 /* unfortunately breaks slapd */
492 assert( lber_pvt_sb_in_use( sb ) );
494 #ifdef TEST_PARTIAL_WRITE
495 if ((rand() & 3)==1) { /* 1 out of 4 */
500 len_arg = (rand() % len_arg)+1;
506 assert( sb->sb_sec_prev_len <= len );
507 if (sb->sb_sec_prev_len) {
508 ret = sockbuf_do_write( sb );
512 len -= sb->sb_sec_prev_len;
513 sb->sb_sec_prev_len = 0;
514 sb->sb_sec_out.buf_end = sb->sb_sec_out.buf_ptr = 0;
516 /* now protect the next packet. */
517 ret = sockbuf_sec_protect( sb, buf, len );
520 ret = sockbuf_do_write( sb );
522 sb->sb_sec_prev_len = len;
529 ret = sockbuf_io_write( sb, buf, len );
531 if ((ret<0) && (errno==EINTR))
543 int lber_pvt_sb_close( Sockbuf *sb )
547 assert( sb->sb_io->sbi_close );
548 assert( status_is_ok(sb) );
549 assert( lber_pvt_sb_in_use( sb ) );
551 ret = sb->sb_io->sbi_close( sb );
552 lber_pvt_sb_set_desc( sb, -1 );
557 int lber_pvt_sb_set_readahead( Sockbuf *sb, int rh )
559 assert( status_is_ok(sb) );
560 sb->sb_read_ahead = (rh!=0);
566 int lber_pvt_sb_set_nonblock( Sockbuf *sb, int nb )
568 assert( status_is_ok(sb) );
570 sb->sb_non_block = 1;
572 sb->sb_read_ahead = 1;
575 sb->sb_non_block = 0;
577 sb->sb_read_ahead = 0;
581 if (lber_pvt_sb_in_use(sb)) {
582 /* WINSOCK requires the status to be a long */
583 ioctl_t status = (nb!=0);
584 if (ioctl( lber_pvt_sb_get_desc(sb), FIONBIO, &status ) == -1 ) {
593 #define sockbuf_buf_init( bb ) do { \
594 Sockbuf_Buf *sbb = (bb); \
595 sbb->buf_base = NULL; \
602 sockbuf_buf_destroy( Sockbuf_Buf *buf )
605 free( buf->buf_base );
606 sockbuf_buf_init( buf );
610 int lber_pvt_sb_init( Sockbuf *sb )
612 sb->sb_item_type=LBER_ITEM_SOCKBUF;
615 sb->sb_trans_ready = 0;
616 sb->sb_buf_ready = 0;
618 sb->sb_sec_ready = 0;
620 sb->sb_read_ahead = 0;
621 sb->sb_non_block = 0;
623 sb->sb_iodata = NULL;
624 sb->sb_io = &lber_pvt_sb_IO_None;
627 sb->sb_max_incoming = 0;
629 sockbuf_buf_init( &(sb->sb_buf) );
631 sockbuf_buf_init( &(sb->sb_sec_buf_in) );
632 sockbuf_buf_init( &(sb->sb_sec_buf_out) );
635 sb->sb_sec_prev_len = 0;
640 int lber_pvt_sb_destroy( Sockbuf *sb )
643 lber_pvt_sb_clear_sec(sb);
644 sockbuf_buf_destroy( &(sb->sb_sec_buf_in) );
645 sockbuf_buf_destroy( &(sb->sb_sec_buf_out) );
647 lber_pvt_sb_clear_io(sb);
648 sockbuf_buf_destroy( &(sb->sb_buf) );
649 return lber_pvt_sb_init( sb );
653 int lber_pvt_sb_set_sec( Sockbuf *sb, Sockbuf_Sec * sec, void *arg )
656 if ((sb->sb_sec) || (sec==NULL))
661 if ((sec->sbs_setup) && (sec->sbs_setup( sb, arg)<0)) {
665 len = sb->sb_buf.buf_end - sb->sb_buf.buf_ptr;
668 /* move this to the security layer. */
669 if (grow_buffer( &(sb->sb_sec_buf_in), len )<0)
671 memcpy( sb->sb_sec_buf_in.buf_base,
672 sb->sb_buf.buf_base + sb->sb_buf.buf_ptr, len );
673 sb->sb_sec_buf_in.buf_ptr = len;
674 sb->sb_sec_buf_in.buf_end = (len>4) ? packet_length( sb->sb_sec_buf_in ) : 0;
675 sb->sb_buf.buf_ptr = sb->sb_buf.buf_end = 0;
681 int lber_pvt_sb_clear_sec( Sockbuf *sb )
683 if (sb->sb_buf.buf_ptr!=0)
685 if (sb->sb_sec==NULL)
687 if ((sb->sb_sec->sbs_remove) && (sb->sb_sec->sbs_remove(sb)<0))
691 if (sb->sb_sec_buf_in.buf_ptr!=0) {
692 if (grow_buffer( &(sb->sb_buf),
693 sb->sb_buf.buf_end + sb->sb_sec_buf_in.buf_ptr)<0)
695 memcpy( sb->sb_buf.buf_base + sb->sb_buf.buf_end,
696 sb->sb_sec_buf_in.buf_base, sb->sb_sec_buf_in.buf_ptr );
697 sb->sb_buf.buf_end += sb->sb_sec_buf_in.buf_ptr;
698 sb->sb_buf_ready = 1;
700 sockbuf_buf_destroy( &(sb->sb_sec_buf_in) );
701 assert( sb->sb_sec_buf.buf_end==0 );
702 sockbuf_buf_destroy( &(sb->sb_sec_buf_out) );
704 sb->sb_sec_ready = 0;
710 int lber_pvt_sb_set_io( Sockbuf *sb, Sockbuf_IO *trans, void *arg )
712 assert( sb->sb_io == &lber_pvt_sb_IO_None );
719 if ((trans->sbi_setup) && (trans->sbi_setup( sb, arg)<0))
725 int lber_pvt_sb_clear_io( Sockbuf *sb )
727 if (sb->sb_io==&lber_pvt_sb_IO_None)
730 if ((sb->sb_io->sbi_remove) && (sb->sb_io->sbi_remove( sb )<0))
733 sb->sb_io = &lber_pvt_sb_IO_None;
735 sb->sb_trans_ready = 0;
745 stream_read( Sockbuf *sb, void *buf, long len )
749 * MacTCP/OpenTransport
751 return tcpread( lber_pvt_sb_get_desc(sb), 0, (unsigned char *)buf,
753 #elif (defined(DOS) && (defined(PCNFS) || defined( WINSOCK))) \
754 || defined( _WIN32) || defined ( __BEOS__ )
759 * Windows Socket API (under DOS/Windows 3.x)
762 * 32-bit Windows Socket API (under Windows NT or Windows 95)
764 return recv( lber_pvt_sb_get_desc(sb), buf, len, 0 );
765 #elif (defined(DOS) && defined( NCSA ))
767 * NCSA Telnet TCP/IP stack (under DOS)
769 return nread( lber_pvt_sb_get_desc(sb), buf, len );
771 return read( lber_pvt_sb_get_desc(sb), buf, len );
776 stream_write( Sockbuf *sb, void *buf, long len )
780 * MacTCP/OpenTransport
782 #define MAX_WRITE 65535
783 return tcpwrite( lber_pvt_sb_get_desc(sb),
784 (unsigned char *)(buf),
785 (len<MAX_WRITE)? len : MAX_WRITE );
786 #elif (defined(DOS) && (defined(PCNFS) || defined( WINSOCK))) \
787 || defined( _WIN32 ) || defined ( __BEOS__ )
792 * Windows Socket API (under DOS/Windows 3.x)
795 * 32-bit Windows Socket API (under Windows NT or Windows 95)
797 return send( lber_pvt_sb_get_desc(sb), buf, len, 0 );
799 return netwrite( lber_pvt_sb_get_desc(sb), buf, len );
802 * VMS -- each write must be 64K or smaller
804 #define MAX_WRITE 65535
805 return write( lber_pvt_sb_get_desc(sb), buf,
806 (len<MAX_WRITE)? len : MAX_WRITE);
808 return write( lber_pvt_sb_get_desc(sb), buf, len );
813 stream_close( Sockbuf *sb )
815 tcp_close( lber_pvt_sb_get_desc( sb ) );
819 Sockbuf_IO lber_pvt_sb_io_tcp=
821 NULL, /* sbi_setup */
822 NULL, /* sbi_release */
823 stream_read, /* sbi_read */
824 stream_write, /* sbi_write */
825 stream_close, /* sbi_close */
829 * Support for UDP (CLDAP)
839 dgram_setup( Sockbuf *sb, void *arg )
841 sb->sb_iodata = malloc( sizeof( struct dgram_data ) );
842 if (sb->sb_iodata==NULL)
844 sb->sb_read_ahead = 1; /* important since udp is packet based. */
849 dgram_release( Sockbuf *sb )
851 free( sb->sb_iodata );
856 dgram_read( Sockbuf *sb, void *buf, long len )
858 #ifdef LDAP_CONNECTIONLESS
861 struct dgram_data *dd;
863 dd = (struct dgram_data *)(sb->sb_iodata);
865 # if !defined( MACOS) && !defined(DOS) && !defined( _WIN32)
866 addrlen = sizeof( struct sockaddr );
867 rc=recvfrom( lber_pvt_sb_get_desc(sb), buf, len, 0, &(dd->src), &addrlen );
872 if ( sb->sb_debug ) {
873 lber_log_printf( LDAP_DEBUG_ANY, sb->sb_debug,
874 "dgram_read udp_read %d bytes\n",
877 lber_log_bprint( LDAP_DEBUG_PACKETS, sb->sb_debug,
881 # else /* LDAP_CONNECTIONLESS */
883 # endif /* LDAP_CONNECTIONLESS */
887 dgram_write( Sockbuf *sb, void *buf, long len )
889 #ifdef LDAP_CONNECTIONLESS
891 struct dgram_data *dd;
893 dd = (struct dgram_data *)(sb->sb_iodata);
895 # if !defined( MACOS) && !defined(DOS) && !defined( _WIN32)
896 rc=sendto( lber_pvt_sb_get_desc(sb), buf, len, 0, &(dd->dst),
897 sizeof( struct sockaddr ) );
904 /* fake error if write was not atomic */
918 dgram_close( Sockbuf *sb )
920 tcp_close( lber_pvt_sb_get_desc(sb) );
924 Sockbuf_IO lber_pvt_sb_io_udp=
926 dgram_setup, /* sbi_setup */
927 dgram_release, /* sbi_release */
928 dgram_read, /* sbi_read */
929 dgram_write, /* sbi_write */
930 dgram_close, /* sbi_close */
933 int lber_pvt_sb_udp_set_dst(Sockbuf *sb, void *addr )
935 struct dgram_data *dd;
936 assert( sb->sb_io == &lber_pvt_sb_io_udp );
937 dd = (struct dgram_data *) (sb->sb_iodata);
938 memcpy( &(dd->dst), addr, sizeof( struct sockaddr ) );
942 void *lber_pvt_sb_udp_get_src( Sockbuf *sb )
944 struct dgram_data *dd;
945 assert( sb->sb_io == &lber_pvt_sb_io_udp );
946 dd = (struct dgram_data *) (sb->sb_iodata);
954 * These routines should really call abort, but at the moment that would
959 have_no_read( Sockbuf *sb, void *buf, long len )
961 lber_log_printf( LDAP_DEBUG_ANY, lber_int_debug,
962 "warning: reading from uninitialized sockbuf\n");
968 have_no_write( Sockbuf *sb, void *buf, long len )
970 lber_log_printf( LDAP_DEBUG_ANY, lber_int_debug,
971 "warning: writing to uninitialized sockbuf\n");
977 have_no_close( Sockbuf *sb )