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
111 struct sockaddr peer;
112 unsigned int connected;
115 struct timeval next_timeout;
116 struct timeval socket_timeout;
119 BIO_METHOD *BIO_s_datagram(void)
121 return(&methods_dgramp);
124 BIO *BIO_new_dgram(int fd, int close_flag)
128 ret=BIO_new(BIO_s_datagram());
129 if (ret == NULL) return(NULL);
130 BIO_set_fd(ret,fd,close_flag);
134 static int dgram_new(BIO *bi)
136 bio_dgram_data *data = NULL;
140 data = OPENSSL_malloc(sizeof(bio_dgram_data));
143 memset(data, 0x00, sizeof(bio_dgram_data));
150 static int dgram_free(BIO *a)
152 bio_dgram_data *data;
154 if (a == NULL) return(0);
155 if ( ! dgram_clear(a))
158 data = (bio_dgram_data *)a->ptr;
159 if(data != NULL) OPENSSL_free(data);
164 static int dgram_clear(BIO *a)
166 if (a == NULL) return(0);
179 static void dgram_adjust_rcv_timeout(BIO *b)
181 #if defined(SO_RCVTIMEO)
182 bio_dgram_data *data = (bio_dgram_data *)b->ptr;
183 int sz = sizeof(int);
185 /* Is a timer active? */
186 if (data->next_timeout.tv_sec > 0 || data->next_timeout.tv_usec > 0)
188 struct timeval timenow, timeleft;
190 /* Read current socket timeout */
191 #ifdef OPENSSL_SYS_WINDOWS
193 if (getsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
194 (void*)&timeout, &sz) < 0)
195 { perror("getsockopt"); }
198 data->socket_timeout.tv_sec = timeout / 1000;
199 data->socket_timeout.tv_usec = (timeout % 1000) * 1000;
202 if ( getsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
203 &(data->socket_timeout), (void *)&sz) < 0)
204 { perror("getsockopt"); }
207 /* Get current time */
208 get_current_time(&timenow);
210 /* Calculate time left until timer expires */
211 memcpy(&timeleft, &(data->next_timeout), sizeof(struct timeval));
212 timeleft.tv_sec -= timenow.tv_sec;
213 timeleft.tv_usec -= timenow.tv_usec;
214 if (timeleft.tv_usec < 0)
217 timeleft.tv_usec += 1000000;
220 if (timeleft.tv_sec < 0)
223 timeleft.tv_usec = 1;
226 /* Adjust socket timeout if next handhake message timer
227 * will expire earlier.
229 if ((data->socket_timeout.tv_sec == 0 && data->socket_timeout.tv_usec == 0) ||
230 (data->socket_timeout.tv_sec > timeleft.tv_sec) ||
231 (data->socket_timeout.tv_sec == timeleft.tv_sec &&
232 data->socket_timeout.tv_usec >= timeleft.tv_usec))
234 #ifdef OPENSSL_SYS_WINDOWS
235 timeout = timeleft.tv_sec * 1000 + timeleft.tv_usec / 1000;
236 if (setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
237 (void*)&timeout, sizeof(timeout)) < 0)
238 { perror("setsockopt"); }
240 if ( setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO, &timeleft,
241 sizeof(struct timeval)) < 0)
242 { perror("setsockopt"); }
249 static void dgram_reset_rcv_timeout(BIO *b)
251 #if defined(SO_RCVTIMEO)
252 bio_dgram_data *data = (bio_dgram_data *)b->ptr;
254 /* Is a timer active? */
255 if (data->next_timeout.tv_sec > 0 || data->next_timeout.tv_usec > 0)
257 #ifdef OPENSSL_SYS_WINDOWS
258 int timeout = data->socket_timeout.tv_sec * 1000 +
259 data->socket_timeout.tv_usec / 1000;
260 if (setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
261 (void*)&timeout, sizeof(timeout)) < 0)
262 { perror("setsockopt"); }
264 if ( setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO, &(data->socket_timeout),
265 sizeof(struct timeval)) < 0)
266 { perror("setsockopt"); }
272 static int dgram_read(BIO *b, char *out, int outl)
275 bio_dgram_data *data = (bio_dgram_data *)b->ptr;
277 struct sockaddr peer;
278 int peerlen = sizeof(peer);
282 clear_socket_error();
283 memset(&peer, 0x00, peerlen);
284 /* Last arg in recvfrom is signed on some platforms and
285 * unsigned on others. It is of type socklen_t on some
286 * but this is not universal. Cast to (void *) to avoid
289 dgram_adjust_rcv_timeout(b);
290 ret=recvfrom(b->num,out,outl,0,&peer,(void *)&peerlen);
291 dgram_reset_rcv_timeout(b);
293 if ( ! data->connected && ret >= 0)
294 BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, &peer);
296 BIO_clear_retry_flags(b);
299 if (BIO_dgram_should_retry(ret))
301 BIO_set_retry_read(b);
302 data->_errno = get_last_socket_error();
309 static int dgram_write(BIO *b, const char *in, int inl)
312 bio_dgram_data *data = (bio_dgram_data *)b->ptr;
313 clear_socket_error();
315 if ( data->connected )
316 ret=writesocket(b->num,in,inl);
318 #if defined(NETWARE_CLIB) && defined(NETWARE_BSDSOCK)
319 ret=sendto(b->num, (char *)in, inl, 0, &data->peer, sizeof(data->peer));
321 ret=sendto(b->num, in, inl, 0, &data->peer, sizeof(data->peer));
324 BIO_clear_retry_flags(b);
327 if (BIO_dgram_should_retry(ret))
329 BIO_set_retry_write(b);
330 data->_errno = get_last_socket_error();
332 #if 0 /* higher layers are responsible for querying MTU, if necessary */
333 if ( data->_errno == EMSGSIZE)
334 /* retrieve the new MTU */
335 BIO_ctrl(b, BIO_CTRL_DGRAM_QUERY_MTU, 0, NULL);
342 static long dgram_ctrl(BIO *b, int cmd, long num, void *ptr)
346 struct sockaddr *to = NULL;
347 bio_dgram_data *data = NULL;
348 #if defined(IP_MTU_DISCOVER) || defined(IP_MTU)
349 long sockopt_val = 0;
350 unsigned int sockopt_len = 0;
352 #ifdef OPENSSL_SYS_LINUX
354 struct sockaddr_storage addr;
357 data = (bio_dgram_data *)b->ptr;
363 case BIO_C_FILE_SEEK:
366 case BIO_C_FILE_TELL:
372 b->num= *((int *)ptr);
373 b->shutdown=(int)num;
380 if (ip != NULL) *ip=b->num;
386 case BIO_CTRL_GET_CLOSE:
389 case BIO_CTRL_SET_CLOSE:
390 b->shutdown=(int)num;
392 case BIO_CTRL_PENDING:
393 case BIO_CTRL_WPENDING:
400 case BIO_CTRL_DGRAM_CONNECT:
401 to = (struct sockaddr *)ptr;
403 if (connect(b->num, to, sizeof(struct sockaddr)) < 0)
404 { perror("connect"); ret = 0; }
408 memcpy(&(data->peer),to, sizeof(struct sockaddr));
413 /* (Linux)kernel sets DF bit on outgoing IP packets */
414 case BIO_CTRL_DGRAM_MTU_DISCOVER:
415 #ifdef OPENSSL_SYS_LINUX
416 addr_len = (socklen_t)sizeof(struct sockaddr_storage);
417 memset((void *)&addr, 0, sizeof(struct sockaddr_storage));
418 if (getsockname(b->num, (void *)&addr, &addr_len) < 0)
423 sockopt_len = sizeof(sockopt_val);
424 switch (addr.ss_family)
427 sockopt_val = IP_PMTUDISC_DO;
428 if ((ret = setsockopt(b->num, IPPROTO_IP, IP_MTU_DISCOVER,
429 &sockopt_val, sizeof(sockopt_val))) < 0)
430 perror("setsockopt");
433 sockopt_val = IPV6_PMTUDISC_DO;
434 if ((ret = setsockopt(b->num, IPPROTO_IPV6, IPV6_MTU_DISCOVER,
435 &sockopt_val, sizeof(sockopt_val))) < 0)
436 perror("setsockopt");
446 case BIO_CTRL_DGRAM_QUERY_MTU:
447 #ifdef OPENSSL_SYS_LINUX
448 addr_len = (socklen_t)sizeof(struct sockaddr_storage);
449 memset((void *)&addr, 0, sizeof(struct sockaddr_storage));
450 if (getsockname(b->num, (void *)&addr, &addr_len) < 0)
455 sockopt_len = sizeof(sockopt_val);
456 switch (addr.ss_family)
459 if ((ret = getsockopt(b->num, IPPROTO_IP, IP_MTU, (void *)&sockopt_val,
460 &sockopt_len)) < 0 || sockopt_val < 0)
466 /* we assume that the transport protocol is UDP and no
467 * IP options are used.
469 data->mtu = sockopt_val - 8 - 20;
474 if ((ret = getsockopt(b->num, IPPROTO_IPV6, IPV6_MTU, (void *)&sockopt_val,
475 &sockopt_len)) < 0 || sockopt_val < 0)
481 /* we assume that the transport protocol is UDP and no
482 * IPV6 options are used.
484 data->mtu = sockopt_val - 8 - 40;
496 case BIO_CTRL_DGRAM_GET_MTU:
499 case BIO_CTRL_DGRAM_SET_MTU:
503 case BIO_CTRL_DGRAM_SET_CONNECTED:
504 to = (struct sockaddr *)ptr;
509 memcpy(&(data->peer),to, sizeof(struct sockaddr));
514 memset(&(data->peer), 0x00, sizeof(struct sockaddr));
517 case BIO_CTRL_DGRAM_GET_PEER:
518 to = (struct sockaddr *) ptr;
520 memcpy(to, &(data->peer), sizeof(struct sockaddr));
521 ret = sizeof(struct sockaddr);
523 case BIO_CTRL_DGRAM_SET_PEER:
524 to = (struct sockaddr *) ptr;
526 memcpy(&(data->peer), to, sizeof(struct sockaddr));
528 case BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT:
529 memcpy(&(data->next_timeout), ptr, sizeof(struct timeval));
531 #if defined(SO_RCVTIMEO)
532 case BIO_CTRL_DGRAM_SET_RECV_TIMEOUT:
533 #ifdef OPENSSL_SYS_WINDOWS
535 struct timeval *tv = (struct timeval *)ptr;
536 int timeout = tv->tv_sec * 1000 + tv->tv_usec/1000;
537 if (setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
538 (void*)&timeout, sizeof(timeout)) < 0)
539 { perror("setsockopt"); ret = -1; }
542 if ( setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO, ptr,
543 sizeof(struct timeval)) < 0)
544 { perror("setsockopt"); ret = -1; }
547 case BIO_CTRL_DGRAM_GET_RECV_TIMEOUT:
548 #ifdef OPENSSL_SYS_WINDOWS
550 int timeout, sz = sizeof(timeout);
551 struct timeval *tv = (struct timeval *)ptr;
552 if (getsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
553 (void*)&timeout, &sz) < 0)
554 { perror("getsockopt"); ret = -1; }
557 tv->tv_sec = timeout / 1000;
558 tv->tv_usec = (timeout % 1000) * 1000;
563 if ( getsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
564 ptr, (void *)&ret) < 0)
565 { perror("getsockopt"); ret = -1; }
569 #if defined(SO_SNDTIMEO)
570 case BIO_CTRL_DGRAM_SET_SEND_TIMEOUT:
571 #ifdef OPENSSL_SYS_WINDOWS
573 struct timeval *tv = (struct timeval *)ptr;
574 int timeout = tv->tv_sec * 1000 + tv->tv_usec/1000;
575 if (setsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO,
576 (void*)&timeout, sizeof(timeout)) < 0)
577 { perror("setsockopt"); ret = -1; }
580 if ( setsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO, ptr,
581 sizeof(struct timeval)) < 0)
582 { perror("setsockopt"); ret = -1; }
585 case BIO_CTRL_DGRAM_GET_SEND_TIMEOUT:
586 #ifdef OPENSSL_SYS_WINDOWS
588 int timeout, sz = sizeof(timeout);
589 struct timeval *tv = (struct timeval *)ptr;
590 if (getsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO,
591 (void*)&timeout, &sz) < 0)
592 { perror("getsockopt"); ret = -1; }
595 tv->tv_sec = timeout / 1000;
596 tv->tv_usec = (timeout % 1000) * 1000;
601 if ( getsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO,
602 ptr, (void *)&ret) < 0)
603 { perror("getsockopt"); ret = -1; }
607 case BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP:
609 case BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP:
610 #ifdef OPENSSL_SYS_WINDOWS
611 if ( data->_errno == WSAETIMEDOUT)
613 if ( data->_errno == EAGAIN)
623 case BIO_CTRL_DGRAM_MTU_EXCEEDED:
624 if ( data->_errno == EMSGSIZE)
640 static int dgram_puts(BIO *bp, const char *str)
645 ret=dgram_write(bp,str,n);
649 static int BIO_dgram_should_retry(int i)
653 if ((i == 0) || (i == -1))
655 err=get_last_socket_error();
657 #if defined(OPENSSL_SYS_WINDOWS) && 0 /* more microsoft stupidity? perhaps not? Ben 4/1/99 */
658 if ((i == -1) && (err == 0))
662 return(BIO_dgram_non_fatal_error(err));
667 int BIO_dgram_non_fatal_error(int err)
671 #if defined(OPENSSL_SYS_WINDOWS)
672 # if defined(WSAEWOULDBLOCK)
676 # if 0 /* This appears to always be an error */
677 # if defined(WSAENOTCONN)
684 # ifdef WSAEWOULDBLOCK
685 # if WSAEWOULDBLOCK != EWOULDBLOCK
698 #if EWOULDBLOCK != EAGAIN
724 static void get_current_time(struct timeval *t)
726 #ifdef OPENSSL_SYS_WIN32
729 t->tv_sec = (long)tb.time;
730 t->tv_usec = (long)tb.millitm * 1000;
731 #elif defined(OPENSSL_SYS_VMS)
734 t->tv_sec = (long)tb.time;
735 t->tv_usec = (long)tb.millitm * 1000;
737 gettimeofday(t, NULL);