1e4666822ffe3cf5709bf11644d42eeb59e17734
[openssl.git] / crypto / bio / bss_dgram.c
1 /* crypto/bio/bio_dgram.c */
2 /* 
3  * DTLS implementation written by Nagendra Modadugu
4  * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.  
5  */
6 /* ====================================================================
7  * Copyright (c) 1999-2005 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer. 
15  *
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
19  *    distribution.
20  *
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/)"
25  *
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.
30  *
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.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
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  * ====================================================================
53  *
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).
57  *
58  */
59
60 #ifndef OPENSSL_NO_DGRAM
61
62 #include <stdio.h>
63 #include <errno.h>
64 #define USE_SOCKETS
65 #include "cryptlib.h"
66
67 #include <openssl/bio.h>
68
69 #if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_VMS)
70 #include <sys/timeb.h>
71 #endif
72
73 #ifdef OPENSSL_SYS_LINUX
74 #define IP_MTU      14 /* linux is lame */
75 #endif
76
77 #ifdef WATT32
78 #define sock_write SockWrite  /* Watt-32 uses same names */
79 #define sock_read  SockRead
80 #define sock_puts  SockPuts
81 #endif
82
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);
90
91 static int BIO_dgram_should_retry(int s);
92
93 static void get_current_time(struct timeval *t);
94
95 static BIO_METHOD methods_dgramp=
96         {
97         BIO_TYPE_DGRAM,
98         "datagram socket",
99         dgram_write,
100         dgram_read,
101         dgram_puts,
102         NULL, /* dgram_gets, */
103         dgram_ctrl,
104         dgram_new,
105         dgram_free,
106         NULL,
107         };
108
109 typedef struct bio_dgram_data_st
110         {
111         struct sockaddr peer;
112         unsigned int connected;
113         unsigned int _errno;
114         unsigned int mtu;
115         struct timeval next_timeout;
116         struct timeval socket_timeout;
117         } bio_dgram_data;
118
119 BIO_METHOD *BIO_s_datagram(void)
120         {
121         return(&methods_dgramp);
122         }
123
124 BIO *BIO_new_dgram(int fd, int close_flag)
125         {
126         BIO *ret;
127
128         ret=BIO_new(BIO_s_datagram());
129         if (ret == NULL) return(NULL);
130         BIO_set_fd(ret,fd,close_flag);
131         return(ret);
132         }
133
134 static int dgram_new(BIO *bi)
135         {
136         bio_dgram_data *data = NULL;
137
138         bi->init=0;
139         bi->num=0;
140         data = OPENSSL_malloc(sizeof(bio_dgram_data));
141         if (data == NULL)
142                 return 0;
143         memset(data, 0x00, sizeof(bio_dgram_data));
144     bi->ptr = data;
145
146         bi->flags=0;
147         return(1);
148         }
149
150 static int dgram_free(BIO *a)
151         {
152         bio_dgram_data *data;
153
154         if (a == NULL) return(0);
155         if ( ! dgram_clear(a))
156                 return 0;
157
158         data = (bio_dgram_data *)a->ptr;
159         if(data != NULL) OPENSSL_free(data);
160
161         return(1);
162         }
163
164 static int dgram_clear(BIO *a)
165         {
166         if (a == NULL) return(0);
167         if (a->shutdown)
168                 {
169                 if (a->init)
170                         {
171                         SHUTDOWN2(a->num);
172                         }
173                 a->init=0;
174                 a->flags=0;
175                 }
176         return(1);
177         }
178
179 static void dgram_adjust_rcv_timeout(BIO *b)
180         {
181 #if defined(SO_RCVTIMEO)
182         bio_dgram_data *data = (bio_dgram_data *)b->ptr;
183         int sz = sizeof(int);
184
185         /* Is a timer active? */
186         if (data->next_timeout.tv_sec > 0 || data->next_timeout.tv_usec > 0)
187                 {
188                 struct timeval timenow, timeleft;
189
190                 /* Read current socket timeout */
191 #ifdef OPENSSL_SYS_WINDOWS
192                 int timeout;
193                 if (getsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
194                                            (void*)&timeout, &sz) < 0)
195                         { perror("getsockopt"); }
196                 else
197                         {
198                         data->socket_timeout.tv_sec = timeout / 1000;
199                         data->socket_timeout.tv_usec = (timeout % 1000) * 1000;
200                         }
201 #else
202                 if ( getsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO, 
203                                                 &(data->socket_timeout), (void *)&sz) < 0)
204                         { perror("getsockopt"); }
205 #endif
206
207                 /* Get current time */
208                 get_current_time(&timenow);
209
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)
215                         {
216                         timeleft.tv_sec--;
217                         timeleft.tv_usec += 1000000;
218                         }
219
220                 /* Adjust socket timeout if next handhake message timer
221                  * will expire earlier.
222                  */
223                 if (data->socket_timeout.tv_sec < timeleft.tv_sec ||
224                         (data->socket_timeout.tv_sec == timeleft.tv_sec &&
225                          data->socket_timeout.tv_usec <= timeleft.tv_usec))
226                         {
227 #ifdef OPENSSL_SYS_WINDOWS
228                         timeout = timeleft.tv_sec * 1000 + timeleft.tv_usec / 1000;
229                         if (setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
230                                                    (void*)&timeout, sizeof(timeout)) < 0)
231                                 { perror("setsockopt"); }
232 #else
233                         if ( setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO, &timeleft,
234                                                         sizeof(struct timeval)) < 0)
235                                 { perror("setsockopt"); }
236 #endif
237                         }
238                 }
239 #endif
240         }
241
242 static void dgram_reset_rcv_timeout(BIO *b)
243         {
244 #if defined(SO_RCVTIMEO)
245         bio_dgram_data *data = (bio_dgram_data *)b->ptr;
246 #ifdef OPENSSL_SYS_WINDOWS
247         int timeout = data->socket_timeout.tv_sec * 1000 +
248                                   data->socket_timeout.tv_usec / 1000;
249         if (setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
250                                    (void*)&timeout, sizeof(timeout)) < 0)
251                 { perror("setsockopt"); }
252 #else
253         if ( setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO, &(data->socket_timeout),
254                                         sizeof(struct timeval)) < 0)
255                 { perror("setsockopt"); }
256 #endif
257 #endif
258         }
259
260 static int dgram_read(BIO *b, char *out, int outl)
261         {
262         int ret=0;
263         bio_dgram_data *data = (bio_dgram_data *)b->ptr;
264
265         struct sockaddr peer;
266         int peerlen = sizeof(peer);
267
268         if (out != NULL)
269                 {
270                 clear_socket_error();
271                 memset(&peer, 0x00, peerlen);
272                 /* Last arg in recvfrom is signed on some platforms and
273                  * unsigned on others. It is of type socklen_t on some
274                  * but this is not universal. Cast to (void *) to avoid
275                  * compiler warnings.
276                  */
277                 dgram_adjust_rcv_timeout(b);
278                 ret=recvfrom(b->num,out,outl,0,&peer,(void *)&peerlen);
279                 dgram_reset_rcv_timeout(b);
280
281                 if ( ! data->connected  && ret > 0)
282                         BIO_ctrl(b, BIO_CTRL_DGRAM_CONNECT, 0, &peer);
283
284                 BIO_clear_retry_flags(b);
285                 if (ret <= 0)
286                         {
287                         if (BIO_dgram_should_retry(ret))
288                                 {
289                                 BIO_set_retry_read(b);
290                                 data->_errno = get_last_socket_error();
291                                 }
292                         memset(&(data->hstimeout), 0, sizeof(struct timeval));
293                         }
294                 }
295         return(ret);
296         }
297
298 static int dgram_write(BIO *b, const char *in, int inl)
299         {
300         int ret;
301         bio_dgram_data *data = (bio_dgram_data *)b->ptr;
302         clear_socket_error();
303
304     if ( data->connected )
305         ret=writesocket(b->num,in,inl);
306     else
307 #if defined(NETWARE_CLIB) && defined(NETWARE_BSDSOCK)
308         ret=sendto(b->num, (char *)in, inl, 0, &data->peer, sizeof(data->peer));
309 #else
310         ret=sendto(b->num, in, inl, 0, &data->peer, sizeof(data->peer));
311 #endif
312
313         BIO_clear_retry_flags(b);
314         if (ret <= 0)
315                 {
316                 if (BIO_sock_should_retry(ret))
317                         {
318                         BIO_set_retry_write(b);  
319                         data->_errno = get_last_socket_error();
320
321 #if 0 /* higher layers are responsible for querying MTU, if necessary */
322                         if ( data->_errno == EMSGSIZE)
323                                 /* retrieve the new MTU */
324                                 BIO_ctrl(b, BIO_CTRL_DGRAM_QUERY_MTU, 0, NULL);
325 #endif
326                         }
327                 }
328         return(ret);
329         }
330
331 static long dgram_ctrl(BIO *b, int cmd, long num, void *ptr)
332         {
333         long ret=1;
334         int *ip;
335         struct sockaddr *to = NULL;
336         bio_dgram_data *data = NULL;
337         long sockopt_val = 0;
338         unsigned int sockopt_len = 0;
339
340         data = (bio_dgram_data *)b->ptr;
341
342         switch (cmd)
343                 {
344         case BIO_CTRL_RESET:
345                 num=0;
346         case BIO_C_FILE_SEEK:
347                 ret=0;
348                 break;
349         case BIO_C_FILE_TELL:
350         case BIO_CTRL_INFO:
351                 ret=0;
352                 break;
353         case BIO_C_SET_FD:
354                 dgram_clear(b);
355                 b->num= *((int *)ptr);
356                 b->shutdown=(int)num;
357                 b->init=1;
358                 break;
359         case BIO_C_GET_FD:
360                 if (b->init)
361                         {
362                         ip=(int *)ptr;
363                         if (ip != NULL) *ip=b->num;
364                         ret=b->num;
365                         }
366                 else
367                         ret= -1;
368                 break;
369         case BIO_CTRL_GET_CLOSE:
370                 ret=b->shutdown;
371                 break;
372         case BIO_CTRL_SET_CLOSE:
373                 b->shutdown=(int)num;
374                 break;
375         case BIO_CTRL_PENDING:
376         case BIO_CTRL_WPENDING:
377                 ret=0;
378                 break;
379         case BIO_CTRL_DUP:
380         case BIO_CTRL_FLUSH:
381                 ret=1;
382                 break;
383         case BIO_CTRL_DGRAM_CONNECT:
384                 to = (struct sockaddr *)ptr;
385 #if 0
386                 if (connect(b->num, to, sizeof(struct sockaddr)) < 0)
387                         { perror("connect"); ret = 0; }
388                 else
389                         {
390 #endif
391                         memcpy(&(data->peer),to, sizeof(struct sockaddr));
392 #if 0
393                         }
394 #endif
395                 break;
396                 /* (Linux)kernel sets DF bit on outgoing IP packets */
397 #ifdef IP_MTU_DISCOVER
398         case BIO_CTRL_DGRAM_MTU_DISCOVER:
399                 sockopt_val = IP_PMTUDISC_DO;
400                 if ((ret = setsockopt(b->num, IPPROTO_IP, IP_MTU_DISCOVER,
401                         &sockopt_val, sizeof(sockopt_val))) < 0)
402                         perror("setsockopt");
403                 break;
404 #endif
405         case BIO_CTRL_DGRAM_QUERY_MTU:
406 #ifdef IP_MTU
407         sockopt_len = sizeof(sockopt_val);
408                 if ((ret = getsockopt(b->num, IPPROTO_IP, IP_MTU, (void *)&sockopt_val,
409                         &sockopt_len)) < 0 || sockopt_val < 0)
410                         { ret = 0; }
411                 else
412                         {
413                         data->mtu = sockopt_val - 20 - 8; /* Subtract IP and UDP header */
414                         ret = data->mtu;
415                         }
416 #else
417                 ret = 0;
418 #endif
419                 break;
420         case BIO_CTRL_DGRAM_GET_MTU:
421                 return data->mtu;
422                 break;
423         case BIO_CTRL_DGRAM_SET_MTU:
424                 data->mtu = num - 20 - 8; /* Subtract IP and UDP header */
425                 ret = data->mtu;
426                 break;
427         case BIO_CTRL_DGRAM_SET_CONNECTED:
428                 to = (struct sockaddr *)ptr;
429
430                 if ( to != NULL)
431                         {
432                         data->connected = 1;
433                         memcpy(&(data->peer),to, sizeof(struct sockaddr));
434                         }
435                 else
436                         {
437                         data->connected = 0;
438                         memset(&(data->peer), 0x00, sizeof(struct sockaddr));
439                         }
440                 break;
441     case BIO_CTRL_DGRAM_SET_PEER:
442         to = (struct sockaddr *) ptr;
443
444         memcpy(&(data->peer), to, sizeof(struct sockaddr));
445         break;
446         case BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT:
447                 memcpy(&(data->next_timeout), ptr, sizeof(struct timeval));             
448                 break;
449 #if defined(SO_RCVTIMEO)
450         case BIO_CTRL_DGRAM_SET_RECV_TIMEOUT:
451 #ifdef OPENSSL_SYS_WINDOWS
452                 {
453                 struct timeval *tv = (struct timeval *)ptr;
454                 int timeout = tv->tv_sec * 1000 + tv->tv_usec/1000;
455                 if (setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
456                         (void*)&timeout, sizeof(timeout)) < 0)
457                         { perror("setsockopt"); ret = -1; }
458                 }
459 #else
460                 if ( setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO, ptr,
461                         sizeof(struct timeval)) < 0)
462                         { perror("setsockopt"); ret = -1; }
463 #endif
464                 break;
465         case BIO_CTRL_DGRAM_GET_RECV_TIMEOUT:
466 #ifdef OPENSSL_SYS_WINDOWS
467                 {
468                 int timeout, sz = sizeof(timeout);
469                 struct timeval *tv = (struct timeval *)ptr;
470                 if (getsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
471                         (void*)&timeout, &sz) < 0)
472                         { perror("getsockopt"); ret = -1; }
473                 else
474                         {
475                         tv->tv_sec = timeout / 1000;
476                         tv->tv_usec = (timeout % 1000) * 1000;
477                         ret = sizeof(*tv);
478                         }
479                 }
480 #else
481                 if ( getsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO, 
482                         ptr, (void *)&ret) < 0)
483                         { perror("getsockopt"); ret = -1; }
484 #endif
485                 break;
486 #endif
487 #if defined(SO_SNDTIMEO)
488         case BIO_CTRL_DGRAM_SET_SEND_TIMEOUT:
489 #ifdef OPENSSL_SYS_WINDOWS
490                 {
491                 struct timeval *tv = (struct timeval *)ptr;
492                 int timeout = tv->tv_sec * 1000 + tv->tv_usec/1000;
493                 if (setsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO,
494                         (void*)&timeout, sizeof(timeout)) < 0)
495                         { perror("setsockopt"); ret = -1; }
496                 }
497 #else
498                 if ( setsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO, ptr,
499                         sizeof(struct timeval)) < 0)
500                         { perror("setsockopt"); ret = -1; }
501 #endif
502                 break;
503         case BIO_CTRL_DGRAM_GET_SEND_TIMEOUT:
504 #ifdef OPENSSL_SYS_WINDOWS
505                 {
506                 int timeout, sz = sizeof(timeout);
507                 struct timeval *tv = (struct timeval *)ptr;
508                 if (getsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO,
509                         (void*)&timeout, &sz) < 0)
510                         { perror("getsockopt"); ret = -1; }
511                 else
512                         {
513                         tv->tv_sec = timeout / 1000;
514                         tv->tv_usec = (timeout % 1000) * 1000;
515                         ret = sizeof(*tv);
516                         }
517                 }
518 #else
519                 if ( getsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO, 
520                         ptr, (void *)&ret) < 0)
521                         { perror("getsockopt"); ret = -1; }
522 #endif
523                 break;
524 #endif
525         case BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP:
526                 /* fall-through */
527         case BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP:
528 #ifdef OPENSSL_SYS_WINDOWS
529                 if ( data->_errno == WSAETIMEDOUT)
530 #else
531                 if ( data->_errno == EAGAIN)
532 #endif
533                         {
534                         ret = 1;
535                         data->_errno = 0;
536                         }
537                 else
538                         ret = 0;
539                 break;
540 #ifdef EMSGSIZE
541         case BIO_CTRL_DGRAM_MTU_EXCEEDED:
542                 if ( data->_errno == EMSGSIZE)
543                         {
544                         ret = 1;
545                         data->_errno = 0;
546                         }
547                 else
548                         ret = 0;
549                 break;
550 #endif
551         default:
552                 ret=0;
553                 break;
554                 }
555         return(ret);
556         }
557
558 static int dgram_puts(BIO *bp, const char *str)
559         {
560         int n,ret;
561
562         n=strlen(str);
563         ret=dgram_write(bp,str,n);
564         return(ret);
565         }
566
567 static int BIO_dgram_should_retry(int i)
568         {
569         int err;
570
571         if ((i == 0) || (i == -1))
572                 {
573                 err=get_last_socket_error();
574
575 #if defined(OPENSSL_SYS_WINDOWS) && 0 /* more microsoft stupidity? perhaps not? Ben 4/1/99 */
576                 if ((i == -1) && (err == 0))
577                         return(1);
578 #endif
579
580                 return(BIO_dgram_non_fatal_error(err));
581                 }
582         return(0);
583         }
584
585 int BIO_dgram_non_fatal_error(int err)
586         {
587         switch (err)
588                 {
589 #if defined(OPENSSL_SYS_WINDOWS)
590 # if defined(WSAEWOULDBLOCK)
591         case WSAEWOULDBLOCK:
592 # endif
593
594 # if 0 /* This appears to always be an error */
595 #  if defined(WSAENOTCONN)
596         case WSAENOTCONN:
597 #  endif
598 # endif
599 #endif
600
601 #ifdef EWOULDBLOCK
602 # ifdef WSAEWOULDBLOCK
603 #  if WSAEWOULDBLOCK != EWOULDBLOCK
604         case EWOULDBLOCK:
605 #  endif
606 # else
607         case EWOULDBLOCK:
608 # endif
609 #endif
610
611 #if defined(ENOTCONN)
612         case ENOTCONN:
613 #endif
614
615 #ifdef EINTR
616         case EINTR:
617 #endif
618
619 #ifdef EAGAIN
620 #if EWOULDBLOCK != EAGAIN
621         case EAGAIN:
622 # endif
623 #endif
624
625 #ifdef EPROTO
626         case EPROTO:
627 #endif
628
629 #ifdef EINPROGRESS
630         case EINPROGRESS:
631 #endif
632
633 #ifdef EALREADY
634         case EALREADY:
635 #endif
636
637 /* DF bit set, and packet larger than MTU */
638 #ifdef EMSGSIZE
639         case EMSGSIZE:
640 #endif
641
642                 return(1);
643                 /* break; */
644         default:
645                 break;
646                 }
647         return(0);
648         }
649 #endif
650
651 static void get_current_time(struct timeval *t)
652         {
653 #ifdef OPENSSL_SYS_WIN32
654         struct _timeb tb;
655         _ftime(&tb);
656         t->tv_sec = (long)tb.time;
657         t->tv_usec = (long)tb.millitm * 1000;
658 #elif defined(OPENSSL_SYS_VMS)
659         struct timeb tb;
660         ftime(&tb);
661         t->tv_sec = (long)tb.time;
662         t->tv_usec = (long)tb.millitm * 1000;
663 #else
664         gettimeofday(t, NULL);
665 #endif
666         }