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).
66 #include <openssl/bio.h>
67 #ifndef OPENSSL_NO_DGRAM
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);
292 if ( ! data->connected && ret >= 0)
293 BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, &peer);
295 BIO_clear_retry_flags(b);
298 if (BIO_dgram_should_retry(ret))
300 BIO_set_retry_read(b);
301 data->_errno = get_last_socket_error();
305 dgram_reset_rcv_timeout(b);
310 static int dgram_write(BIO *b, const char *in, int inl)
313 bio_dgram_data *data = (bio_dgram_data *)b->ptr;
314 clear_socket_error();
316 if ( data->connected )
317 ret=writesocket(b->num,in,inl);
319 #if defined(NETWARE_CLIB) && defined(NETWARE_BSDSOCK)
320 ret=sendto(b->num, (char *)in, inl, 0, &data->peer, sizeof(data->peer));
322 ret=sendto(b->num, in, inl, 0, &data->peer, sizeof(data->peer));
325 BIO_clear_retry_flags(b);
328 if (BIO_dgram_should_retry(ret))
330 BIO_set_retry_write(b);
331 data->_errno = get_last_socket_error();
333 #if 0 /* higher layers are responsible for querying MTU, if necessary */
334 if ( data->_errno == EMSGSIZE)
335 /* retrieve the new MTU */
336 BIO_ctrl(b, BIO_CTRL_DGRAM_QUERY_MTU, 0, NULL);
343 static long dgram_ctrl(BIO *b, int cmd, long num, void *ptr)
347 struct sockaddr *to = NULL;
348 bio_dgram_data *data = NULL;
349 #if defined(IP_MTU_DISCOVER) || defined(IP_MTU)
350 long sockopt_val = 0;
351 unsigned int sockopt_len = 0;
353 #ifdef OPENSSL_SYS_LINUX
355 struct sockaddr_storage addr;
358 data = (bio_dgram_data *)b->ptr;
364 case BIO_C_FILE_SEEK:
367 case BIO_C_FILE_TELL:
373 b->num= *((int *)ptr);
374 b->shutdown=(int)num;
381 if (ip != NULL) *ip=b->num;
387 case BIO_CTRL_GET_CLOSE:
390 case BIO_CTRL_SET_CLOSE:
391 b->shutdown=(int)num;
393 case BIO_CTRL_PENDING:
394 case BIO_CTRL_WPENDING:
401 case BIO_CTRL_DGRAM_CONNECT:
402 to = (struct sockaddr *)ptr;
404 if (connect(b->num, to, sizeof(struct sockaddr)) < 0)
405 { perror("connect"); ret = 0; }
409 memcpy(&(data->peer),to, sizeof(struct sockaddr));
414 /* (Linux)kernel sets DF bit on outgoing IP packets */
415 case BIO_CTRL_DGRAM_MTU_DISCOVER:
416 #ifdef OPENSSL_SYS_LINUX
417 addr_len = (socklen_t)sizeof(struct sockaddr_storage);
418 memset((void *)&addr, 0, sizeof(struct sockaddr_storage));
419 if (getsockname(b->num, (void *)&addr, &addr_len) < 0)
424 sockopt_len = sizeof(sockopt_val);
425 switch (addr.ss_family)
428 sockopt_val = IP_PMTUDISC_DO;
429 if ((ret = setsockopt(b->num, IPPROTO_IP, IP_MTU_DISCOVER,
430 &sockopt_val, sizeof(sockopt_val))) < 0)
431 perror("setsockopt");
434 sockopt_val = IPV6_PMTUDISC_DO;
435 if ((ret = setsockopt(b->num, IPPROTO_IPV6, IPV6_MTU_DISCOVER,
436 &sockopt_val, sizeof(sockopt_val))) < 0)
437 perror("setsockopt");
447 case BIO_CTRL_DGRAM_QUERY_MTU:
448 #ifdef OPENSSL_SYS_LINUX
449 addr_len = (socklen_t)sizeof(struct sockaddr_storage);
450 memset((void *)&addr, 0, sizeof(struct sockaddr_storage));
451 if (getsockname(b->num, (void *)&addr, &addr_len) < 0)
456 sockopt_len = sizeof(sockopt_val);
457 switch (addr.ss_family)
460 if ((ret = getsockopt(b->num, IPPROTO_IP, IP_MTU, (void *)&sockopt_val,
461 &sockopt_len)) < 0 || sockopt_val < 0)
467 /* we assume that the transport protocol is UDP and no
468 * IP options are used.
470 data->mtu = sockopt_val - 8 - 20;
475 if ((ret = getsockopt(b->num, IPPROTO_IPV6, IPV6_MTU, (void *)&sockopt_val,
476 &sockopt_len)) < 0 || sockopt_val < 0)
482 /* we assume that the transport protocol is UDP and no
483 * IPV6 options are used.
485 data->mtu = sockopt_val - 8 - 40;
497 case BIO_CTRL_DGRAM_GET_MTU:
500 case BIO_CTRL_DGRAM_SET_MTU:
504 case BIO_CTRL_DGRAM_SET_CONNECTED:
505 to = (struct sockaddr *)ptr;
510 memcpy(&(data->peer),to, sizeof(struct sockaddr));
515 memset(&(data->peer), 0x00, sizeof(struct sockaddr));
518 case BIO_CTRL_DGRAM_GET_PEER:
519 to = (struct sockaddr *) ptr;
521 memcpy(to, &(data->peer), sizeof(struct sockaddr));
522 ret = sizeof(struct sockaddr);
524 case BIO_CTRL_DGRAM_SET_PEER:
525 to = (struct sockaddr *) ptr;
527 memcpy(&(data->peer), to, sizeof(struct sockaddr));
529 case BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT:
530 memcpy(&(data->next_timeout), ptr, sizeof(struct timeval));
532 #if defined(SO_RCVTIMEO)
533 case BIO_CTRL_DGRAM_SET_RECV_TIMEOUT:
534 #ifdef OPENSSL_SYS_WINDOWS
536 struct timeval *tv = (struct timeval *)ptr;
537 int timeout = tv->tv_sec * 1000 + tv->tv_usec/1000;
538 if (setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
539 (void*)&timeout, sizeof(timeout)) < 0)
540 { perror("setsockopt"); ret = -1; }
543 if ( setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO, ptr,
544 sizeof(struct timeval)) < 0)
545 { perror("setsockopt"); ret = -1; }
548 case BIO_CTRL_DGRAM_GET_RECV_TIMEOUT:
549 #ifdef OPENSSL_SYS_WINDOWS
551 int timeout, sz = sizeof(timeout);
552 struct timeval *tv = (struct timeval *)ptr;
553 if (getsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
554 (void*)&timeout, &sz) < 0)
555 { perror("getsockopt"); ret = -1; }
558 tv->tv_sec = timeout / 1000;
559 tv->tv_usec = (timeout % 1000) * 1000;
564 if ( getsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
565 ptr, (void *)&ret) < 0)
566 { perror("getsockopt"); ret = -1; }
570 #if defined(SO_SNDTIMEO)
571 case BIO_CTRL_DGRAM_SET_SEND_TIMEOUT:
572 #ifdef OPENSSL_SYS_WINDOWS
574 struct timeval *tv = (struct timeval *)ptr;
575 int timeout = tv->tv_sec * 1000 + tv->tv_usec/1000;
576 if (setsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO,
577 (void*)&timeout, sizeof(timeout)) < 0)
578 { perror("setsockopt"); ret = -1; }
581 if ( setsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO, ptr,
582 sizeof(struct timeval)) < 0)
583 { perror("setsockopt"); ret = -1; }
586 case BIO_CTRL_DGRAM_GET_SEND_TIMEOUT:
587 #ifdef OPENSSL_SYS_WINDOWS
589 int timeout, sz = sizeof(timeout);
590 struct timeval *tv = (struct timeval *)ptr;
591 if (getsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO,
592 (void*)&timeout, &sz) < 0)
593 { perror("getsockopt"); ret = -1; }
596 tv->tv_sec = timeout / 1000;
597 tv->tv_usec = (timeout % 1000) * 1000;
602 if ( getsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO,
603 ptr, (void *)&ret) < 0)
604 { perror("getsockopt"); ret = -1; }
608 case BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP:
610 case BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP:
611 #ifdef OPENSSL_SYS_WINDOWS
612 if ( data->_errno == WSAETIMEDOUT)
614 if ( data->_errno == EAGAIN)
624 case BIO_CTRL_DGRAM_MTU_EXCEEDED:
625 if ( data->_errno == EMSGSIZE)
641 static int dgram_puts(BIO *bp, const char *str)
646 ret=dgram_write(bp,str,n);
650 static int BIO_dgram_should_retry(int i)
654 if ((i == 0) || (i == -1))
656 err=get_last_socket_error();
658 #if defined(OPENSSL_SYS_WINDOWS)
659 /* If the socket return value (i) is -1
660 * and err is unexpectedly 0 at this point,
661 * the error code was overwritten by
662 * another system call before this error
663 * handling is called.
667 return(BIO_dgram_non_fatal_error(err));
672 int BIO_dgram_non_fatal_error(int err)
676 #if defined(OPENSSL_SYS_WINDOWS)
677 # if defined(WSAEWOULDBLOCK)
681 # if 0 /* This appears to always be an error */
682 # if defined(WSAENOTCONN)
689 # ifdef WSAEWOULDBLOCK
690 # if WSAEWOULDBLOCK != EWOULDBLOCK
703 #if EWOULDBLOCK != EAGAIN
728 static void get_current_time(struct timeval *t)
730 #ifdef OPENSSL_SYS_WIN32
733 t->tv_sec = (long)tb.time;
734 t->tv_usec = (long)tb.millitm * 1000;
735 #elif defined(OPENSSL_SYS_VMS)
738 t->tv_sec = (long)tb.time;
739 t->tv_usec = (long)tb.millitm * 1000;
741 gettimeofday(t, NULL);