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>
33 #define assert( cond )
36 #define MAX_BUF_SIZE 65535
37 #define MIN_BUF_SIZE 4096
39 #define sockbuf_io_write( sb, buf, len ) \
40 ((sb)->sb_io->sbi_write( (sb), (buf), (len) ))
42 #define sockbuf_io_read( sb, buf, len ) \
43 ((sb)->sb_io->sbi_read( (sb), (buf), (len) ))
45 static long have_no_read( Sockbuf *sb, void *buf, long len );
46 static long have_no_write( Sockbuf *sb, void *buf, long len );
47 static int have_no_close( Sockbuf *sb );
49 static Sockbuf_IO lber_pvt_sb_IO_None=
52 NULL, /* sbi_release */
53 have_no_read, /* sbi_read */
54 have_no_write, /* sbi_write */
55 have_no_close /* sbi_close */
59 update_status( Sockbuf *sb )
61 sb->sb_buf_ready = (sb->sb_buf.buf_ptr < sb->sb_buf.buf_end);
63 sb->sb_sec_ready = ((sb->sb_sec_buf_in.buf_end!=0) &&
64 (sb->sb_sec_buf_in.buf_ptr >=
65 sb->sb_sec_buf_in.buf_end));
71 status_is_ok( Sockbuf *sb )
75 obr = sb->sb_buf_ready;
77 osr = sb->sb_sec_ready;
80 if (obr!=sb->sb_buf_ready)
83 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 /* round to nearest 2k */
116 if (minsize < MIN_BUF_SIZE) {
117 minsize = MIN_BUF_SIZE;
119 minsize=((minsize-1)|2047)+1;
120 if (minsize > MAX_BUF_SIZE) {
121 /* 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 buf = (char *) buf_arg;
315 len = sockbuf_copy_out( sb, &buf, len );
318 return (buf - (char *) buf_arg);
324 assert( sb->sb_sec->sbs_release );
325 assert( sb->sb_sec_buf_in.buf_base );
326 if (sb->sb_read_ahead) {
327 max = sb->sb_sec_buf_in.buf_size - sb->sb_sec_buf_in.buf_ptr;
329 max = sb->sb_sec_buf_in.buf_end - sb->sb_sec_buf_in.buf_ptr;
331 /* special situation. This means that we need to read the first
332 * four bytes for the packet length.
338 /* read from stream into sb_sec_buf_in */
339 ret = sockbuf_io_read( sb, sb->sb_sec_buf_in.buf_base +
340 sb->sb_sec_buf_in.buf_ptr, max );
342 /* read error. return */
345 sb->sb_sec_buf_in.buf_ptr += ret;
347 if (sb->sb_sec_buf_in.buf_ptr < sb->sb_sec_buf_in.buf_end) {
348 /* did not finish a packet. give up. */
352 if (sb->sb_sec_buf_in.buf_end == 0) {
353 /* Were trying to read the first four bytes... */
354 if (sb->sb_sec_buf_in.buf_ptr < 4) {
355 /* did not read enough for packet length. give up. */
358 /* calculate the packet length. */
359 sb->sb_sec_buf_in.buf_end =
360 packet_length(sb->sb_sec_buf_in.buf_base );
361 if ((sb->sb_sec_buf_in.buf_end > sb->sb_sec_buf_in.buf_size) &&
362 (grow_buffer( &(sb->sb_sec_buf_in), sb->sb_sec_buf_in.buf_end)<0)) {
363 /* buffer has to be to big. exit with error. */
367 if (sb->sb_sec_buf_in.buf_ptr >= sb_sec_buf_in.buf_end) {
368 /* finished packet. decode it. */
371 /* did not finish packet yet. try again ? */
372 if (sb->sb_read_ahead) {
373 /* we were trying to read the max anyway. forget it */
378 /* we read enough for at least 1 packet */
379 ret = sockbuf_sec_release( sb, buf, len );
381 /* something went wrong... */
386 /* we are finished !!! */
387 if ((len==0) || (ret!=max))
392 if (sb->sb_read_ahead) {
394 max = sb->sb_buf.buf_size - sb->sb_buf.buf_end;
396 ret = sockbuf_io_read( sb,
397 sb->sb_buf.buf_base +
401 /* some error occured */
404 sb->sb_buf.buf_end += ret;
405 /* move out the data... */
406 len = sockbuf_copy_out( sb, &buf, len );
410 /* no read_ahead, just try to put the data in the buf. */
411 ret = sockbuf_io_read( sb, buf, len );
416 /* we might as well return, since there is nothing to do... */
421 assert( status_is_ok(sb) );
422 if ((ret<=0) && (buf==buf_arg)) {
423 /* there was an error. */
426 return (buf - ((char *) buf_arg));
430 long sockbuf_do_write( Sockbuf *sb )
433 to_go = sb->sb_sec_out.buf_end - sb->sb_sec_out.buf_ptr;
435 /* there is something left of the last time... */
436 ret = sockbuf_io_write( sb, sb->sb_sec_out.buf_base+
437 sb->sb_sec_out.buf_ptr, to_go );
438 if (ret<=0) /* error */
440 sb->sb_sec_out.buf_ptr += ret;
441 if (ret<to_go) /* not enough data, so pretend no data was sent. */
447 long lber_pvt_sb_write( Sockbuf *sb, void *buf, long len_arg )
451 assert( status_is_ok(sb) );
453 /* unfortunately breaks slapd */
454 assert( lber_pvt_sb_in_use( sb ) );
458 assert( sb->sb_sec_prev_len <= len );
459 if (sb->sb_sec_prev_len) {
460 ret = sockbuf_do_write( sb );
464 len -= sb->sb_sec_prev_len;
465 sb->sb_sec_prev_len = 0;
466 sb->sb_sec_out.buf_end = sb->sb_sec_out.buf_ptr = 0;
468 /* now protect the next packet. */
469 ret = sockbuf_sec_protect( sb, buf, len );
472 ret = sockbuf_do_write( sb );
474 sb->sb_sec_prev_len = len;
480 return sockbuf_io_write( sb, buf, len );
486 int lber_pvt_sb_close( Sockbuf *sb )
490 assert( sb->sb_io->sbi_close );
491 assert( status_is_ok(sb) );
492 assert( lber_pvt_sb_in_use( sb ) );
494 ret = sb->sb_io->sbi_close( sb );
495 lber_pvt_sb_set_desc( sb, -1 );
500 int lber_pvt_sb_set_readahead( Sockbuf *sb, int rh )
502 assert( status_is_ok(sb) );
503 sb->sb_read_ahead = (rh!=0);
507 int lber_pvt_sb_set_nonblock( Sockbuf *sb, int nb )
509 assert( status_is_ok(sb) );
511 sb->sb_non_block = 1;
513 sb->sb_read_ahead = 1;
516 sb->sb_non_block = 0;
518 sb->sb_read_ahead = 0;
521 if (lber_pvt_sb_in_use(sb)) {
522 int status = (nb!=0);
523 if (ioctl( lber_pvt_sb_get_desc(sb), FIONBIO, (caddr_t)&status ) == -1 ) {
530 #define sockbuf_buf_init( bb ) \
531 (bb)->buf_base=NULL;\
537 sockbuf_buf_destroy( Sockbuf_Buf *buf )
540 free( buf->buf_base );
541 sockbuf_buf_init( buf );
545 int lber_pvt_sb_init( Sockbuf *sb )
547 sb->sb_item_type=LBER_ITEM_SOCKBUF;
550 sb->sb_trans_ready = 0;
551 sb->sb_buf_ready = 0;
553 sb->sb_sec_ready = 0;
555 sb->sb_read_ahead = 0;
556 sb->sb_non_block = 0;
558 sb->sb_iodata = NULL;
559 sb->sb_io = &lber_pvt_sb_IO_None;
562 sb->sb_max_incoming = 0;
564 sockbuf_buf_init( &(sb->sb_buf) );
566 sockbuf_buf_init( &(sb->sb_sec_buf_in) );
567 sockbuf_buf_init( &(sb->sb_sec_buf_out) );
570 sb->sb_sec_prev_len = 0;
575 int lber_pvt_sb_destroy( Sockbuf *sb )
578 lber_pvt_sb_clear_sec(sb);
579 sockbuf_buf_destroy( &(sb->sb_sec_buf_in) );
580 sockbuf_buf_destroy( &(sb->sb_sec_buf_out) );
582 lber_pvt_sb_clear_io(sb);
583 sockbuf_buf_destroy( &(sb->sb_buf) );
584 return lber_pvt_sb_init( sb );
588 int lber_pvt_sb_set_sec( Sockbuf *sb, Sockbuf_Sec * sec, void *arg )
591 if ((sb->sb_sec) || (sec==NULL))
596 if ((sec->sbs_setup) && (sec->sbs_setup( sb, arg)<0)) {
600 len = sb->sb_buf.buf_end - sb->sb_buf.buf_ptr;
603 /* move this to the security layer. */
604 if (grow_buffer( &(sb->sb_sec_buf_in), len )<0)
606 memcpy( sb->sb_sec_buf_in.buf_base,
607 sb->sb_buf.buf_base + sb->sb_buf.buf_ptr, len );
608 sb->sb_sec_buf_in.buf_ptr = len;
609 sb->sb_sec_buf_in.buf_end = (len>4) ? packet_length( sb->sb_sec_buf_in ) : 0;
610 sb->sb_buf.buf_ptr = sb->sb_buf.buf_end = 0;
616 int lber_pvt_sb_clear_sec( Sockbuf *sb )
618 if (sb->sb_buf.buf_ptr!=0)
620 if (sb->sb_sec==NULL)
622 if ((sb->sb_sec->sbs_remove) && (sb->sb_sec->sbs_remove(sb)<0))
626 if (sb->sb_sec_buf_in.buf_ptr!=0) {
627 if (grow_buffer( &(sb->sb_buf),
628 sb->sb_buf.buf_end + sb->sb_sec_buf_in.buf_ptr)<0)
630 memcpy( sb->sb_buf.buf_base + sb->sb_buf.buf_end,
631 sb->sb_sec_buf_in.buf_base, sb->sb_sec_buf_in.buf_ptr );
632 sb->sb_buf.buf_end += sb->sb_sec_buf_in.buf_ptr;
633 sb->sb_buf_ready = 1;
635 sockbuf_buf_destroy( &(sb->sb_sec_buf_in) );
636 assert( sb->sb_sec_buf.buf_end==0 );
637 sockbuf_buf_destroy( &(sb->sb_sec_buf_out) );
639 sb->sb_sec_ready = 0;
645 int lber_pvt_sb_set_io( Sockbuf *sb, Sockbuf_IO *trans, void *arg )
647 assert( sb->sb_io == &lber_pvt_sb_IO_None );
654 if ((trans->sbi_setup) && (trans->sbi_setup( sb, arg)<0))
660 int lber_pvt_sb_clear_io( Sockbuf *sb )
662 if (sb->sb_io==&lber_pvt_sb_IO_None)
665 if ((sb->sb_io->sbi_remove) && (sb->sb_io->sbi_remove( sb )<0))
668 sb->sb_io = &lber_pvt_sb_IO_None;
670 sb->sb_trans_ready = 0;
680 stream_read( Sockbuf *sb, void *buf, long len )
684 * MacTCP/OpenTransport
686 return tcpread( lber_pvt_sb_get_desc(sb), 0, (unsigned char *)buf,
688 #elif (defined(DOS) && (defined(PCNFS) || defined( WINSOCK))) \
694 * Windows Socket API (under DOS/Windows 3.x)
697 * 32-bit Windows Socket API (under Windows NT or Windows 95)
699 return recv( lber_pvt_sb_get_desc(sb), buf, len, 0 );
700 #elif (defined(DOS) && defined( NCSA ))
702 * NCSA Telnet TCP/IP stack (under DOS)
704 return nread( lber_pvt_sb_get_desc(sb), buf, len );
706 return read( lber_pvt_sb_get_desc(sb), buf, len );
711 stream_write( Sockbuf *sb, void *buf, long len )
715 * MacTCP/OpenTransport
717 #define MAX_WRITE 65535
718 return tcpwrite( lber_pvt_sb_get_desc(sb),
719 (unsigned char *)(buf),
720 (len<MAX_WRITE)? len : MAX_WRITE );
721 #elif (defined(DOS) && (defined(PCNFS) || defined( WINSOCK))) \
727 * Windows Socket API (under DOS/Windows 3.x)
730 * 32-bit Windows Socket API (under Windows NT or Windows 95)
732 return send( lber_pvt_sb_get_desc(sb), buf, len, 0 );
734 return netwrite( lber_pvt_sb_get_desc(sb), buf, len );
737 * VMS -- each write must be 64K or smaller
739 #define MAX_WRITE 65535
740 return write( lber_pvt_sb_get_desc(sb), buf,
741 (len<MAX_WRITE)? len : MAX_WRITE);
743 return write( lber_pvt_sb_get_desc(sb), buf, len );
748 stream_close( Sockbuf *sb )
750 tcp_close( lber_pvt_sb_get_desc( sb ) );
754 Sockbuf_IO lber_pvt_sb_io_tcp=
756 NULL, /* sbi_setup */
757 NULL, /* sbi_release */
758 stream_read, /* sbi_read */
759 stream_write, /* sbi_write */
760 stream_close, /* sbi_close */
764 * Support for UDP (CLDAP)
774 dgram_setup( Sockbuf *sb, void *arg )
776 sb->sb_iodata = malloc( sizeof( struct dgram_data ) );
777 if (sb->sb_iodata==NULL)
779 sb->sb_read_ahead = 1; /* important since udp is packet based. */
784 dgram_release( Sockbuf *sb )
786 free( sb->sb_iodata );
791 dgram_read( Sockbuf *sb, void *buf, long len )
793 #ifdef LDAP_CONNECTIONLESS
796 struct dgram_data *dd;
798 dd = (struct dgram_data *)(sb->sb_iodata);
800 # if !defined( MACOS) && !defined(DOS) && !defined( _WIN32)
801 addrlen = sizeof( struct sockaddr );
802 rc=recvfrom( lber_pvt_sb_get_desc(sb), buf, len, 0, &(dd->src), &addrlen );
807 if ( sb->sb_debug ) {
808 lber_log_printf( LDAP_DEBUG_ANY, sb->sb_debug,
809 "dgram_read udp_read %d bytes\n",
812 lber_log_bprint( LDAP_DEBUG_PACKETS, sb->sb_debug,
816 # else /* LDAP_CONNECTIONLESS */
818 # endif /* LDAP_CONNECTIONLESS */
822 dgram_write( Sockbuf *sb, void *buf, long len )
824 #ifdef LDAP_CONNECTIONLESS
826 struct dgram_data *dd;
828 dd = (struct dgram_data *)(sb->sb_iodata);
830 # if !defined( MACOS) && !defined(DOS) && !defined( _WIN32)
831 rc=sendto( lber_pvt_sb_get_desc(sb), buf, len, 0, &(dd->dst),
832 sizeof( struct sockaddr ) );
839 /* fake error if write was not atomic */
853 dgram_close( Sockbuf *sb )
855 tcp_close( lber_pvt_sb_get_desc(sb) );
859 Sockbuf_IO lber_pvt_sb_io_udp=
861 dgram_setup, /* sbi_setup */
862 dgram_release, /* sbi_release */
863 dgram_read, /* sbi_read */
864 dgram_write, /* sbi_write */
865 dgram_close, /* sbi_close */
868 int lber_pvt_sb_udp_set_dst(Sockbuf *sb, void *addr )
870 struct dgram_data *dd;
871 assert( sb->sb_io == &lber_pvt_sb_io_udp );
872 dd = (struct dgram_data *) (sb->sb_iodata);
873 memcpy( &(dd->dst), addr, sizeof( struct sockaddr ) );
877 void *lber_pvt_sb_udp_get_src( Sockbuf *sb )
879 struct dgram_data *dd;
880 assert( sb->sb_io == &lber_pvt_sb_io_udp );
881 dd = (struct dgram_data *) (sb->sb_iodata);
889 * These routines should really call abort, but at the moment that would
894 have_no_read( Sockbuf *sb, void *buf, long len )
896 lber_log_printf( LDAP_DEBUG_ANY, lber_int_debug,
897 "warning: reading from uninitialized sockbuf\n");
903 have_no_write( Sockbuf *sb, void *buf, long len )
905 lber_log_printf( LDAP_DEBUG_ANY, lber_int_debug,
906 "warning: writing to uninitialized sockbuf\n");
912 have_no_close( Sockbuf *sb )