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);
338 #if defined(NETWARE_CLIB) && defined(NETWARE_BSDSOCK)
339 ret=sendto(b->num, (char *)in, inl, 0, &data->peer.sa, sizeof(data->peer));
341 ret=sendto(b->num, in, inl, 0, &data->peer.sa, sizeof(data->peer));
344 BIO_clear_retry_flags(b);
347 if (BIO_dgram_should_retry(ret))
349 BIO_set_retry_write(b);
350 data->_errno = get_last_socket_error();
352 #if 0 /* higher layers are responsible for querying MTU, if necessary */
353 if ( data->_errno == EMSGSIZE)
354 /* retrieve the new MTU */
355 BIO_ctrl(b, BIO_CTRL_DGRAM_QUERY_MTU, 0, NULL);
362 static long dgram_ctrl(BIO *b, int cmd, long num, void *ptr)
366 struct sockaddr *to = NULL;
367 bio_dgram_data *data = NULL;
368 #if defined(IP_MTU_DISCOVER) || defined(IP_MTU)
369 long sockopt_val = 0;
370 unsigned int sockopt_len = 0;
372 #ifdef OPENSSL_SYS_LINUX
376 struct sockaddr_in s4;
378 struct sockaddr_in6 s6;
383 data = (bio_dgram_data *)b->ptr;
389 case BIO_C_FILE_SEEK:
392 case BIO_C_FILE_TELL:
398 b->num= *((int *)ptr);
399 b->shutdown=(int)num;
406 if (ip != NULL) *ip=b->num;
412 case BIO_CTRL_GET_CLOSE:
415 case BIO_CTRL_SET_CLOSE:
416 b->shutdown=(int)num;
418 case BIO_CTRL_PENDING:
419 case BIO_CTRL_WPENDING:
426 case BIO_CTRL_DGRAM_CONNECT:
427 to = (struct sockaddr *)ptr;
429 if (connect(b->num, to, sizeof(struct sockaddr)) < 0)
430 { perror("connect"); ret = 0; }
434 switch (to->sa_family)
437 memcpy(&data->peer,to,sizeof(data->peer.sa_in));
441 memcpy(&data->peer,to,sizeof(data->peer.sa_in6));
445 memcpy(&data->peer,to,sizeof(data->peer.sa));
452 /* (Linux)kernel sets DF bit on outgoing IP packets */
453 case BIO_CTRL_DGRAM_MTU_DISCOVER:
454 #ifdef OPENSSL_SYS_LINUX
455 addr_len = (socklen_t)sizeof(addr);
456 memset((void *)&addr, 0, sizeof(addr));
457 if (getsockname(b->num, &addr.sa, &addr_len) < 0)
462 sockopt_len = sizeof(sockopt_val);
463 switch (addr.sa.sa_family)
466 sockopt_val = IP_PMTUDISC_DO;
467 if ((ret = setsockopt(b->num, IPPROTO_IP, IP_MTU_DISCOVER,
468 &sockopt_val, sizeof(sockopt_val))) < 0)
469 perror("setsockopt");
471 #if OPENSSL_USE_IPV6 && defined(IPV6_MTU_DISCOVER)
473 sockopt_val = IPV6_PMTUDISC_DO;
474 if ((ret = setsockopt(b->num, IPPROTO_IPV6, IPV6_MTU_DISCOVER,
475 &sockopt_val, sizeof(sockopt_val))) < 0)
476 perror("setsockopt");
487 case BIO_CTRL_DGRAM_QUERY_MTU:
488 #ifdef OPENSSL_SYS_LINUX
489 addr_len = (socklen_t)sizeof(addr);
490 memset((void *)&addr, 0, sizeof(addr));
491 if (getsockname(b->num, &addr.sa, &addr_len) < 0)
496 sockopt_len = sizeof(sockopt_val);
497 switch (addr.sa.sa_family)
500 if ((ret = getsockopt(b->num, IPPROTO_IP, IP_MTU, (void *)&sockopt_val,
501 &sockopt_len)) < 0 || sockopt_val < 0)
507 /* we assume that the transport protocol is UDP and no
508 * IP options are used.
510 data->mtu = sockopt_val - 8 - 20;
514 #if OPENSSL_USE_IPV6 && defined(IPV6_MTU)
516 if ((ret = getsockopt(b->num, IPPROTO_IPV6, IPV6_MTU, (void *)&sockopt_val,
517 &sockopt_len)) < 0 || sockopt_val < 0)
523 /* we assume that the transport protocol is UDP and no
524 * IPV6 options are used.
526 data->mtu = sockopt_val - 8 - 40;
539 case BIO_CTRL_DGRAM_GET_MTU:
542 case BIO_CTRL_DGRAM_SET_MTU:
546 case BIO_CTRL_DGRAM_SET_CONNECTED:
547 to = (struct sockaddr *)ptr;
552 switch (to->sa_family)
555 memcpy(&data->peer,to,sizeof(data->peer.sa_in));
559 memcpy(&data->peer,to,sizeof(data->peer.sa_in6));
563 memcpy(&data->peer,to,sizeof(data->peer.sa));
570 memset(&(data->peer), 0x00, sizeof(data->peer));
573 case BIO_CTRL_DGRAM_GET_PEER:
574 switch (data->peer.sa.sa_family)
577 ret=sizeof(data->peer.sa_in);
581 ret=sizeof(data->peer.sa_in6);
585 ret=sizeof(data->peer.sa);
588 if (num==0 || num>ret)
590 memcpy(ptr,&data->peer,(ret=num));
592 case BIO_CTRL_DGRAM_SET_PEER:
593 to = (struct sockaddr *) ptr;
594 switch (to->sa_family)
597 memcpy(&data->peer,to,sizeof(data->peer.sa_in));
601 memcpy(&data->peer,to,sizeof(data->peer.sa_in6));
605 memcpy(&data->peer,to,sizeof(data->peer.sa));
609 case BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT:
610 memcpy(&(data->next_timeout), ptr, sizeof(struct timeval));
612 #if defined(SO_RCVTIMEO)
613 case BIO_CTRL_DGRAM_SET_RECV_TIMEOUT:
614 #ifdef OPENSSL_SYS_WINDOWS
616 struct timeval *tv = (struct timeval *)ptr;
617 int timeout = tv->tv_sec * 1000 + tv->tv_usec/1000;
618 if (setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
619 (void*)&timeout, sizeof(timeout)) < 0)
620 { perror("setsockopt"); ret = -1; }
623 if ( setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO, ptr,
624 sizeof(struct timeval)) < 0)
625 { perror("setsockopt"); ret = -1; }
628 case BIO_CTRL_DGRAM_GET_RECV_TIMEOUT:
629 #ifdef OPENSSL_SYS_WINDOWS
631 int timeout, sz = sizeof(timeout);
632 struct timeval *tv = (struct timeval *)ptr;
633 if (getsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
634 (void*)&timeout, &sz) < 0)
635 { perror("getsockopt"); ret = -1; }
638 tv->tv_sec = timeout / 1000;
639 tv->tv_usec = (timeout % 1000) * 1000;
644 if ( getsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
645 ptr, (void *)&ret) < 0)
646 { perror("getsockopt"); ret = -1; }
650 #if defined(SO_SNDTIMEO)
651 case BIO_CTRL_DGRAM_SET_SEND_TIMEOUT:
652 #ifdef OPENSSL_SYS_WINDOWS
654 struct timeval *tv = (struct timeval *)ptr;
655 int timeout = tv->tv_sec * 1000 + tv->tv_usec/1000;
656 if (setsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO,
657 (void*)&timeout, sizeof(timeout)) < 0)
658 { perror("setsockopt"); ret = -1; }
661 if ( setsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO, ptr,
662 sizeof(struct timeval)) < 0)
663 { perror("setsockopt"); ret = -1; }
666 case BIO_CTRL_DGRAM_GET_SEND_TIMEOUT:
667 #ifdef OPENSSL_SYS_WINDOWS
669 int timeout, sz = sizeof(timeout);
670 struct timeval *tv = (struct timeval *)ptr;
671 if (getsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO,
672 (void*)&timeout, &sz) < 0)
673 { perror("getsockopt"); ret = -1; }
676 tv->tv_sec = timeout / 1000;
677 tv->tv_usec = (timeout % 1000) * 1000;
682 if ( getsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO,
683 ptr, (void *)&ret) < 0)
684 { perror("getsockopt"); ret = -1; }
688 case BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP:
690 case BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP:
691 #ifdef OPENSSL_SYS_WINDOWS
692 if ( data->_errno == WSAETIMEDOUT)
694 if ( data->_errno == EAGAIN)
704 case BIO_CTRL_DGRAM_MTU_EXCEEDED:
705 if ( data->_errno == EMSGSIZE)
721 static int dgram_puts(BIO *bp, const char *str)
726 ret=dgram_write(bp,str,n);
730 static int BIO_dgram_should_retry(int i)
734 if ((i == 0) || (i == -1))
736 err=get_last_socket_error();
738 #if defined(OPENSSL_SYS_WINDOWS) && 0 /* more microsoft stupidity? perhaps not? Ben 4/1/99 */
739 if ((i == -1) && (err == 0))
743 return(BIO_dgram_non_fatal_error(err));
748 int BIO_dgram_non_fatal_error(int err)
752 #if defined(OPENSSL_SYS_WINDOWS)
753 # if defined(WSAEWOULDBLOCK)
757 # if 0 /* This appears to always be an error */
758 # if defined(WSAENOTCONN)
765 # ifdef WSAEWOULDBLOCK
766 # if WSAEWOULDBLOCK != EWOULDBLOCK
779 #if EWOULDBLOCK != EAGAIN
805 static void get_current_time(struct timeval *t)
807 #ifdef OPENSSL_SYS_WIN32
810 t->tv_sec = (long)tb.time;
811 t->tv_usec = (long)tb.millitm * 1000;
812 #elif defined(OPENSSL_SYS_VMS)
815 t->tv_sec = (long)tb.time;
816 t->tv_usec = (long)tb.millitm * 1000;
818 gettimeofday(t, NULL);