1 /* crypto/bio/bio_dgram.c */
3 * DTLS implementation written by Nagendra Modadugu
4 * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.
6 /* ====================================================================
7 * Copyright (c) 1999-2005 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * openssl-core@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
60 #ifndef OPENSSL_NO_DGRAM
67 #include <openssl/bio.h>
69 #if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_VMS)
70 #include <sys/timeb.h>
73 #ifdef OPENSSL_SYS_LINUX
74 #define IP_MTU 14 /* linux is lame */
78 #define sock_write SockWrite /* Watt-32 uses same names */
79 #define sock_read SockRead
80 #define sock_puts SockPuts
83 static int dgram_write(BIO
*h
, const char *buf
, int num
);
84 static int dgram_read(BIO
*h
, char *buf
, int size
);
85 static int dgram_puts(BIO
*h
, const char *str
);
86 static long dgram_ctrl(BIO
*h
, int cmd
, long arg1
, void *arg2
);
87 static int dgram_new(BIO
*h
);
88 static int dgram_free(BIO
*data
);
89 static int dgram_clear(BIO
*bio
);
91 static int BIO_dgram_should_retry(int s
);
93 static void get_current_time(struct timeval
*t
);
95 static BIO_METHOD methods_dgramp
=
102 NULL
, /* dgram_gets, */
109 typedef struct bio_dgram_data_st
113 struct sockaddr_in sa_in
;
115 struct sockaddr_in6 sa_in6
;
118 unsigned int connected
;
121 struct timeval next_timeout
;
122 struct timeval socket_timeout
;
125 BIO_METHOD
*BIO_s_datagram(void)
127 return(&methods_dgramp
);
130 BIO
*BIO_new_dgram(int fd
, int close_flag
)
134 ret
=BIO_new(BIO_s_datagram());
135 if (ret
== NULL
) return(NULL
);
136 BIO_set_fd(ret
,fd
,close_flag
);
140 static int dgram_new(BIO
*bi
)
142 bio_dgram_data
*data
= NULL
;
146 data
= OPENSSL_malloc(sizeof(bio_dgram_data
));
149 memset(data
, 0x00, sizeof(bio_dgram_data
));
156 static int dgram_free(BIO
*a
)
158 bio_dgram_data
*data
;
160 if (a
== NULL
) return(0);
161 if ( ! dgram_clear(a
))
164 data
= (bio_dgram_data
*)a
->ptr
;
165 if(data
!= NULL
) OPENSSL_free(data
);
170 static int dgram_clear(BIO
*a
)
172 if (a
== NULL
) return(0);
185 static void dgram_adjust_rcv_timeout(BIO
*b
)
187 #if defined(SO_RCVTIMEO)
188 bio_dgram_data
*data
= (bio_dgram_data
*)b
->ptr
;
189 int sz
= sizeof(int);
191 /* Is a timer active? */
192 if (data
->next_timeout
.tv_sec
> 0 || data
->next_timeout
.tv_usec
> 0)
194 struct timeval timenow
, timeleft
;
196 /* Read current socket timeout */
197 #ifdef OPENSSL_SYS_WINDOWS
199 if (getsockopt(b
->num
, SOL_SOCKET
, SO_RCVTIMEO
,
200 (void*)&timeout
, &sz
) < 0)
201 { perror("getsockopt"); }
204 data
->socket_timeout
.tv_sec
= timeout
/ 1000;
205 data
->socket_timeout
.tv_usec
= (timeout
% 1000) * 1000;
208 if ( getsockopt(b
->num
, SOL_SOCKET
, SO_RCVTIMEO
,
209 &(data
->socket_timeout
), (void *)&sz
) < 0)
210 { perror("getsockopt"); }
213 /* Get current time */
214 get_current_time(&timenow
);
216 /* Calculate time left until timer expires */
217 memcpy(&timeleft
, &(data
->next_timeout
), sizeof(struct timeval
));
218 timeleft
.tv_sec
-= timenow
.tv_sec
;
219 timeleft
.tv_usec
-= timenow
.tv_usec
;
220 if (timeleft
.tv_usec
< 0)
223 timeleft
.tv_usec
+= 1000000;
226 if (timeleft
.tv_sec
< 0)
229 timeleft
.tv_usec
= 1;
232 /* Adjust socket timeout if next handhake message timer
233 * will expire earlier.
235 if ((data
->socket_timeout
.tv_sec
== 0 && data
->socket_timeout
.tv_usec
== 0) ||
236 (data
->socket_timeout
.tv_sec
> timeleft
.tv_sec
) ||
237 (data
->socket_timeout
.tv_sec
== timeleft
.tv_sec
&&
238 data
->socket_timeout
.tv_usec
>= timeleft
.tv_usec
))
240 #ifdef OPENSSL_SYS_WINDOWS
241 timeout
= timeleft
.tv_sec
* 1000 + timeleft
.tv_usec
/ 1000;
242 if (setsockopt(b
->num
, SOL_SOCKET
, SO_RCVTIMEO
,
243 (void*)&timeout
, sizeof(timeout
)) < 0)
244 { perror("setsockopt"); }
246 if ( setsockopt(b
->num
, SOL_SOCKET
, SO_RCVTIMEO
, &timeleft
,
247 sizeof(struct timeval
)) < 0)
248 { perror("setsockopt"); }
255 static void dgram_reset_rcv_timeout(BIO
*b
)
257 #if defined(SO_RCVTIMEO)
258 bio_dgram_data
*data
= (bio_dgram_data
*)b
->ptr
;
260 /* Is a timer active? */
261 if (data
->next_timeout
.tv_sec
> 0 || data
->next_timeout
.tv_usec
> 0)
263 #ifdef OPENSSL_SYS_WINDOWS
264 int timeout
= data
->socket_timeout
.tv_sec
* 1000 +
265 data
->socket_timeout
.tv_usec
/ 1000;
266 if (setsockopt(b
->num
, SOL_SOCKET
, SO_RCVTIMEO
,
267 (void*)&timeout
, sizeof(timeout
)) < 0)
268 { perror("setsockopt"); }
270 if ( setsockopt(b
->num
, SOL_SOCKET
, SO_RCVTIMEO
, &(data
->socket_timeout
),
271 sizeof(struct timeval
)) < 0)
272 { perror("setsockopt"); }
278 static int dgram_read(BIO
*b
, char *out
, int outl
)
281 bio_dgram_data
*data
= (bio_dgram_data
*)b
->ptr
;
285 * See commentary in b_sock.c. <appro>
287 union { size_t s
; int i
; } len
;
290 struct sockaddr_in sa_in
;
292 struct sockaddr_in6 sa_in6
;
298 sa
.len
.i
=sizeof(sa
.peer
);
302 clear_socket_error();
303 memset(&sa
.peer
, 0x00, sizeof(sa
.peer
));
304 dgram_adjust_rcv_timeout(b
);
305 ret
=recvfrom(b
->num
,out
,outl
,0,&sa
.peer
.sa
,(void *)&sa
.len
);
306 if (sizeof(sa
.len
.i
)!=sizeof(sa
.len
.s
) && sa
.len
.i
==0)
308 OPENSSL_assert(sa
.len
.s
<=sizeof(sa
.peer
));
309 sa
.len
.i
= (int)sa
.len
.s
;
311 dgram_reset_rcv_timeout(b
);
313 if ( ! data
->connected
&& ret
>= 0)
314 BIO_ctrl(b
, BIO_CTRL_DGRAM_SET_PEER
, 0, &sa
.peer
);
316 BIO_clear_retry_flags(b
);
319 if (BIO_dgram_should_retry(ret
))
321 BIO_set_retry_read(b
);
322 data
->_errno
= get_last_socket_error();
329 static int dgram_write(BIO
*b
, const char *in
, int inl
)
332 bio_dgram_data
*data
= (bio_dgram_data
*)b
->ptr
;
333 clear_socket_error();
335 if ( data
->connected
)
336 ret
=writesocket(b
->num
,in
,inl
);
339 int peerlen
= sizeof(data
->peer
);
341 if (data
->peer
.sa
.sa_family
== AF_INET
)
342 peerlen
= sizeof(data
->peer
.sa_in
);
344 else if (data
->peer
.sa
.sa_family
== AF_INET6
)
345 peerlen
= sizeof(data
->peer
.sa_in6
);
347 #if defined(NETWARE_CLIB) && defined(NETWARE_BSDSOCK)
348 ret
=sendto(b
->num
, (char *)in
, inl
, 0, &data
->peer
.sa
, peerlen
);
350 ret
=sendto(b
->num
, in
, inl
, 0, &data
->peer
.sa
, peerlen
);
354 BIO_clear_retry_flags(b
);
357 if (BIO_dgram_should_retry(ret
))
359 BIO_set_retry_write(b
);
360 data
->_errno
= get_last_socket_error();
362 #if 0 /* higher layers are responsible for querying MTU, if necessary */
363 if ( data
->_errno
== EMSGSIZE
)
364 /* retrieve the new MTU */
365 BIO_ctrl(b
, BIO_CTRL_DGRAM_QUERY_MTU
, 0, NULL
);
372 static long dgram_ctrl(BIO
*b
, int cmd
, long num
, void *ptr
)
376 struct sockaddr
*to
= NULL
;
377 bio_dgram_data
*data
= NULL
;
378 #if defined(IP_MTU_DISCOVER) || defined(IP_MTU)
379 long sockopt_val
= 0;
380 unsigned int sockopt_len
= 0;
382 #ifdef OPENSSL_SYS_LINUX
386 struct sockaddr_in s4
;
388 struct sockaddr_in6 s6
;
393 data
= (bio_dgram_data
*)b
->ptr
;
399 case BIO_C_FILE_SEEK
:
402 case BIO_C_FILE_TELL
:
408 b
->num
= *((int *)ptr
);
409 b
->shutdown
=(int)num
;
416 if (ip
!= NULL
) *ip
=b
->num
;
422 case BIO_CTRL_GET_CLOSE
:
425 case BIO_CTRL_SET_CLOSE
:
426 b
->shutdown
=(int)num
;
428 case BIO_CTRL_PENDING
:
429 case BIO_CTRL_WPENDING
:
436 case BIO_CTRL_DGRAM_CONNECT
:
437 to
= (struct sockaddr
*)ptr
;
439 if (connect(b
->num
, to
, sizeof(struct sockaddr
)) < 0)
440 { perror("connect"); ret
= 0; }
444 switch (to
->sa_family
)
447 memcpy(&data
->peer
,to
,sizeof(data
->peer
.sa_in
));
451 memcpy(&data
->peer
,to
,sizeof(data
->peer
.sa_in6
));
455 memcpy(&data
->peer
,to
,sizeof(data
->peer
.sa
));
462 /* (Linux)kernel sets DF bit on outgoing IP packets */
463 case BIO_CTRL_DGRAM_MTU_DISCOVER
:
464 #ifdef OPENSSL_SYS_LINUX
465 addr_len
= (socklen_t
)sizeof(addr
);
466 memset((void *)&addr
, 0, sizeof(addr
));
467 if (getsockname(b
->num
, &addr
.sa
, &addr_len
) < 0)
472 sockopt_len
= sizeof(sockopt_val
);
473 switch (addr
.sa
.sa_family
)
476 sockopt_val
= IP_PMTUDISC_DO
;
477 if ((ret
= setsockopt(b
->num
, IPPROTO_IP
, IP_MTU_DISCOVER
,
478 &sockopt_val
, sizeof(sockopt_val
))) < 0)
479 perror("setsockopt");
481 #if OPENSSL_USE_IPV6 && defined(IPV6_MTU_DISCOVER)
483 sockopt_val
= IPV6_PMTUDISC_DO
;
484 if ((ret
= setsockopt(b
->num
, IPPROTO_IPV6
, IPV6_MTU_DISCOVER
,
485 &sockopt_val
, sizeof(sockopt_val
))) < 0)
486 perror("setsockopt");
497 case BIO_CTRL_DGRAM_QUERY_MTU
:
498 #ifdef OPENSSL_SYS_LINUX
499 addr_len
= (socklen_t
)sizeof(addr
);
500 memset((void *)&addr
, 0, sizeof(addr
));
501 if (getsockname(b
->num
, &addr
.sa
, &addr_len
) < 0)
506 sockopt_len
= sizeof(sockopt_val
);
507 switch (addr
.sa
.sa_family
)
510 if ((ret
= getsockopt(b
->num
, IPPROTO_IP
, IP_MTU
, (void *)&sockopt_val
,
511 &sockopt_len
)) < 0 || sockopt_val
< 0)
517 /* we assume that the transport protocol is UDP and no
518 * IP options are used.
520 data
->mtu
= sockopt_val
- 8 - 20;
524 #if OPENSSL_USE_IPV6 && defined(IPV6_MTU)
526 if ((ret
= getsockopt(b
->num
, IPPROTO_IPV6
, IPV6_MTU
, (void *)&sockopt_val
,
527 &sockopt_len
)) < 0 || sockopt_val
< 0)
533 /* we assume that the transport protocol is UDP and no
534 * IPV6 options are used.
536 data
->mtu
= sockopt_val
- 8 - 40;
549 case BIO_CTRL_DGRAM_GET_MTU
:
552 case BIO_CTRL_DGRAM_SET_MTU
:
556 case BIO_CTRL_DGRAM_SET_CONNECTED
:
557 to
= (struct sockaddr
*)ptr
;
562 switch (to
->sa_family
)
565 memcpy(&data
->peer
,to
,sizeof(data
->peer
.sa_in
));
569 memcpy(&data
->peer
,to
,sizeof(data
->peer
.sa_in6
));
573 memcpy(&data
->peer
,to
,sizeof(data
->peer
.sa
));
580 memset(&(data
->peer
), 0x00, sizeof(data
->peer
));
583 case BIO_CTRL_DGRAM_GET_PEER
:
584 switch (data
->peer
.sa
.sa_family
)
587 ret
=sizeof(data
->peer
.sa_in
);
591 ret
=sizeof(data
->peer
.sa_in6
);
595 ret
=sizeof(data
->peer
.sa
);
598 if (num
==0 || num
>ret
)
600 memcpy(ptr
,&data
->peer
,(ret
=num
));
602 case BIO_CTRL_DGRAM_SET_PEER
:
603 to
= (struct sockaddr
*) ptr
;
604 switch (to
->sa_family
)
607 memcpy(&data
->peer
,to
,sizeof(data
->peer
.sa_in
));
611 memcpy(&data
->peer
,to
,sizeof(data
->peer
.sa_in6
));
615 memcpy(&data
->peer
,to
,sizeof(data
->peer
.sa
));
619 case BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT
:
620 memcpy(&(data
->next_timeout
), ptr
, sizeof(struct timeval
));
622 #if defined(SO_RCVTIMEO)
623 case BIO_CTRL_DGRAM_SET_RECV_TIMEOUT
:
624 #ifdef OPENSSL_SYS_WINDOWS
626 struct timeval
*tv
= (struct timeval
*)ptr
;
627 int timeout
= tv
->tv_sec
* 1000 + tv
->tv_usec
/1000;
628 if (setsockopt(b
->num
, SOL_SOCKET
, SO_RCVTIMEO
,
629 (void*)&timeout
, sizeof(timeout
)) < 0)
630 { perror("setsockopt"); ret
= -1; }
633 if ( setsockopt(b
->num
, SOL_SOCKET
, SO_RCVTIMEO
, ptr
,
634 sizeof(struct timeval
)) < 0)
635 { perror("setsockopt"); ret
= -1; }
638 case BIO_CTRL_DGRAM_GET_RECV_TIMEOUT
:
639 #ifdef OPENSSL_SYS_WINDOWS
641 int timeout
, sz
= sizeof(timeout
);
642 struct timeval
*tv
= (struct timeval
*)ptr
;
643 if (getsockopt(b
->num
, SOL_SOCKET
, SO_RCVTIMEO
,
644 (void*)&timeout
, &sz
) < 0)
645 { perror("getsockopt"); ret
= -1; }
648 tv
->tv_sec
= timeout
/ 1000;
649 tv
->tv_usec
= (timeout
% 1000) * 1000;
654 if ( getsockopt(b
->num
, SOL_SOCKET
, SO_RCVTIMEO
,
655 ptr
, (void *)&ret
) < 0)
656 { perror("getsockopt"); ret
= -1; }
660 #if defined(SO_SNDTIMEO)
661 case BIO_CTRL_DGRAM_SET_SEND_TIMEOUT
:
662 #ifdef OPENSSL_SYS_WINDOWS
664 struct timeval
*tv
= (struct timeval
*)ptr
;
665 int timeout
= tv
->tv_sec
* 1000 + tv
->tv_usec
/1000;
666 if (setsockopt(b
->num
, SOL_SOCKET
, SO_SNDTIMEO
,
667 (void*)&timeout
, sizeof(timeout
)) < 0)
668 { perror("setsockopt"); ret
= -1; }
671 if ( setsockopt(b
->num
, SOL_SOCKET
, SO_SNDTIMEO
, ptr
,
672 sizeof(struct timeval
)) < 0)
673 { perror("setsockopt"); ret
= -1; }
676 case BIO_CTRL_DGRAM_GET_SEND_TIMEOUT
:
677 #ifdef OPENSSL_SYS_WINDOWS
679 int timeout
, sz
= sizeof(timeout
);
680 struct timeval
*tv
= (struct timeval
*)ptr
;
681 if (getsockopt(b
->num
, SOL_SOCKET
, SO_SNDTIMEO
,
682 (void*)&timeout
, &sz
) < 0)
683 { perror("getsockopt"); ret
= -1; }
686 tv
->tv_sec
= timeout
/ 1000;
687 tv
->tv_usec
= (timeout
% 1000) * 1000;
692 if ( getsockopt(b
->num
, SOL_SOCKET
, SO_SNDTIMEO
,
693 ptr
, (void *)&ret
) < 0)
694 { perror("getsockopt"); ret
= -1; }
698 case BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP
:
700 case BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP
:
701 #ifdef OPENSSL_SYS_WINDOWS
702 if ( data
->_errno
== WSAETIMEDOUT
)
704 if ( data
->_errno
== EAGAIN
)
714 case BIO_CTRL_DGRAM_MTU_EXCEEDED
:
715 if ( data
->_errno
== EMSGSIZE
)
731 static int dgram_puts(BIO
*bp
, const char *str
)
736 ret
=dgram_write(bp
,str
,n
);
740 static int BIO_dgram_should_retry(int i
)
744 if ((i
== 0) || (i
== -1))
746 err
=get_last_socket_error();
748 #if defined(OPENSSL_SYS_WINDOWS) && 0 /* more microsoft stupidity? perhaps not? Ben 4/1/99 */
749 if ((i
== -1) && (err
== 0))
753 return(BIO_dgram_non_fatal_error(err
));
758 int BIO_dgram_non_fatal_error(int err
)
762 #if defined(OPENSSL_SYS_WINDOWS)
763 # if defined(WSAEWOULDBLOCK)
767 # if 0 /* This appears to always be an error */
768 # if defined(WSAENOTCONN)
775 # ifdef WSAEWOULDBLOCK
776 # if WSAEWOULDBLOCK != EWOULDBLOCK
789 #if EWOULDBLOCK != EAGAIN
815 static void get_current_time(struct timeval
*t
)
817 #ifdef OPENSSL_SYS_WIN32
820 t
->tv_sec
= (long)tb
.time
;
821 t
->tv_usec
= (long)tb
.millitm
* 1000;
822 #elif defined(OPENSSL_SYS_VMS)
825 t
->tv_sec
= (long)tb
.time
;
826 t
->tv_usec
= (long)tb
.millitm
* 1000;
828 gettimeofday(t
, NULL
);