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 #define IP_MTU      14 /* linux is lame */
  70
  71 #ifdef WATT32
  72 #define sock_write SockWrite  /* Watt-32 uses same names */
  73 #define sock_read  SockRead
  74 #define sock_puts  SockPuts
  75 #endif
  76
  77 static int dgram_write(BIO *h, const char *buf, int num);
  78 static int dgram_read(BIO *h, char *buf, int size);
  79 static int dgram_puts(BIO *h, const char *str);
  80 static long dgram_ctrl(BIO *h, int cmd, long arg1, void *arg2);
  81 static int dgram_new(BIO *h);
  82 static int dgram_free(BIO *data);
  83 static int dgram_clear(BIO *bio);
  84
  85 static int BIO_dgram_should_retry(int s);
  86
  87 static BIO_METHOD methods_dgramp=
  88         {
  89         BIO_TYPE_DGRAM,
  90         "datagram socket",
  91         dgram_write,
  92         dgram_read,
  93         dgram_puts,
  94         NULL, /* dgram_gets, */
  95         dgram_ctrl,
  96         dgram_new,
  97         dgram_free,
  98         NULL,
  99         };
 100
 101 typedef struct bio_dgram_data_st
 102         {
 103         struct sockaddr peer;
 104         unsigned int connected;
 105         unsigned int _errno;
 106         unsigned int mtu;
 107         struct timeval hstimeoutdiff;
 108         struct timeval hstimeout;
 109         } bio_dgram_data;
 110
 111 BIO_METHOD *BIO_s_datagram(void)
 112         {
 113         return(&methods_dgramp);
 114         }
 115
 116 BIO *BIO_new_dgram(int fd, int close_flag)
 117         {
 118         BIO *ret;
 119
 120         ret=BIO_new(BIO_s_datagram());
 121         if (ret == NULL) return(NULL);
 122         BIO_set_fd(ret,fd,close_flag);
 123         return(ret);
 124         }
 125
 126 static int dgram_new(BIO *bi)
 127         {
 128         bio_dgram_data *data = NULL;
 129
 130         bi->init=0;
 131         bi->num=0;
 132         data = OPENSSL_malloc(sizeof(bio_dgram_data));
 133         if (data == NULL)
 134                 return 0;
 135         memset(data, 0x00, sizeof(bio_dgram_data));
 136     bi->ptr = data;
 137
 138         bi->flags=0;
 139         return(1);
 140         }
 141
 142 static int dgram_free(BIO *a)
 143         {
 144         bio_dgram_data *data;
 145
 146         if (a == NULL) return(0);
 147         if ( ! dgram_clear(a))
 148                 return 0;
 149
 150         data = (bio_dgram_data *)a->ptr;
 151         if(data != NULL) OPENSSL_free(data);
 152
 153         return(1);
 154         }
 155
 156 static int dgram_clear(BIO *a)
 157         {
 158         if (a == NULL) return(0);
 159         if (a->shutdown)
 160                 {
 161                 if (a->init)
 162                         {
 163                         SHUTDOWN2(a->num);
 164                         }
 165                 a->init=0;
 166                 a->flags=0;
 167                 }
 168         return(1);
 169         }
 170
 171 static int dgram_read(BIO *b, char *out, int outl)
 172         {
 173         int ret=0;
 174         bio_dgram_data *data = (bio_dgram_data *)b->ptr;
 175
 176         struct sockaddr peer;
 177         int peerlen = sizeof(peer);
 178
 179         if (out != NULL)
 180                 {
 181                 clear_socket_error();
 182                 memset(&peer, 0x00, peerlen);
 183                 /* Last arg in recvfrom is signed on some platforms and
 184                  * unsigned on others. It is of type socklen_t on some
 185                  * but this is not universal. Cast to (void *) to avoid
 186                  * compiler warnings.
 187                  */
 188                 ret=recvfrom(b->num,out,outl,0,&peer,(void *)&peerlen);
 189
 190                 if ( ! data->connected  && ret > 0)
 191                         BIO_ctrl(b, BIO_CTRL_DGRAM_CONNECT, 0, &peer);
 192
 193                 BIO_clear_retry_flags(b);
 194                 if (ret <= 0)
 195                         {
 196                         if (BIO_dgram_should_retry(ret))
 197                                 {
 198                                 BIO_set_retry_read(b);
 199                                 data->_errno = get_last_socket_error();
 200                                 }
 201                         memset(&(data->hstimeout), 0, sizeof(struct timeval));
 202                         }
 203                 else
 204                         {
 205                         if (data->hstimeout.tv_sec > 0 || data->hstimeout.tv_usec > 0)
 206                                 {
 207                                 struct timeval curtime;
 208                                 gettimeofday(&curtime, NULL);
 209                                 if (curtime.tv_sec >= data->hstimeout.tv_sec &&
 210                                         curtime.tv_usec >= data->hstimeout.tv_usec)
 211                                         {
 212                                         data->_errno = EAGAIN;
 213                                         ret = -1;
 214                                         memset(&(data->hstimeout), 0, sizeof(struct timeval));
 215                                         }
 216                                 }
 217                         }
 218                 }
 219         return(ret);
 220         }
 221
 222 static int dgram_write(BIO *b, const char *in, int inl)
 223         {
 224         int ret;
 225         bio_dgram_data *data = (bio_dgram_data *)b->ptr;
 226         clear_socket_error();
 227
 228     if ( data->connected )
 229         ret=writesocket(b->num,in,inl);
 230     else
 231 #if defined(NETWARE_CLIB) && defined(NETWARE_BSDSOCK)
 232         ret=sendto(b->num, (char *)in, inl, 0, &data->peer, sizeof(data->peer));
 233 #else
 234         ret=sendto(b->num, in, inl, 0, &data->peer, sizeof(data->peer));
 235 #endif
 236
 237         BIO_clear_retry_flags(b);
 238         if (ret <= 0)
 239                 {
 240                 if (BIO_sock_should_retry(ret))
 241                         {
 242                         BIO_set_retry_write(b);
 243                         data->_errno = get_last_socket_error();
 244
 245 #if 0 /* higher layers are responsible for querying MTU, if necessary */
 246                         if ( data->_errno == EMSGSIZE)
 247                                 /* retrieve the new MTU */
 248                                 BIO_ctrl(b, BIO_CTRL_DGRAM_QUERY_MTU, 0, NULL);
 249 #endif
 250                         }
 251                 }
 252         return(ret);
 253         }
 254
 255 static long dgram_ctrl(BIO *b, int cmd, long num, void *ptr)
 256         {
 257         long ret=1;
 258         int *ip;
 259         struct sockaddr *to = NULL;
 260         bio_dgram_data *data = NULL;
 261         long sockopt_val = 0;
 262         unsigned int sockopt_len = 0;
 263
 264         data = (bio_dgram_data *)b->ptr;
 265
 266         switch (cmd)
 267                 {
 268         case BIO_CTRL_RESET:
 269                 num=0;
 270         case BIO_C_FILE_SEEK:
 271                 ret=0;
 272                 break;
 273         case BIO_C_FILE_TELL:
 274         case BIO_CTRL_INFO:
 275                 ret=0;
 276                 break;
 277         case BIO_C_SET_FD:
 278                 dgram_clear(b);
 279                 b->num= *((int *)ptr);
 280                 b->shutdown=(int)num;
 281                 b->init=1;
 282                 break;
 283         case BIO_C_GET_FD:
 284                 if (b->init)
 285                         {
 286                         ip=(int *)ptr;
 287                         if (ip != NULL) *ip=b->num;
 288                         ret=b->num;
 289                         }
 290                 else
 291                         ret= -1;
 292                 break;
 293         case BIO_CTRL_GET_CLOSE:
 294                 ret=b->shutdown;
 295                 break;
 296         case BIO_CTRL_SET_CLOSE:
 297                 b->shutdown=(int)num;
 298                 break;
 299         case BIO_CTRL_PENDING:
 300         case BIO_CTRL_WPENDING:
 301                 ret=0;
 302                 break;
 303         case BIO_CTRL_DUP:
 304         case BIO_CTRL_FLUSH:
 305                 ret=1;
 306                 break;
 307         case BIO_CTRL_DGRAM_CONNECT:
 308                 to = (struct sockaddr *)ptr;
 309 #if 0
 310                 if (connect(b->num, to, sizeof(struct sockaddr)) < 0)
 311                         { perror("connect"); ret = 0; }
 312                 else
 313                         {
 314 #endif
 315                         memcpy(&(data->peer),to, sizeof(struct sockaddr));
 316 #if 0
 317                         }
 318 #endif
 319                 break;
 320                 /* (Linux)kernel sets DF bit on outgoing IP packets */
 321 #ifdef IP_MTU_DISCOVER
 322         case BIO_CTRL_DGRAM_MTU_DISCOVER:
 323                 sockopt_val = IP_PMTUDISC_DO;
 324                 if ((ret = setsockopt(b->num, IPPROTO_IP, IP_MTU_DISCOVER,
 325                         &sockopt_val, sizeof(sockopt_val))) < 0)
 326                         perror("setsockopt");
 327                 break;
 328 #endif
 329         case BIO_CTRL_DGRAM_QUERY_MTU:
 330          sockopt_len = sizeof(sockopt_val);
 331                 if ((ret = getsockopt(b->num, IPPROTO_IP, IP_MTU, (void *)&sockopt_val,
 332                         &sockopt_len)) < 0 || sockopt_val < 0)
 333                         { ret = 0; }
 334                 else
 335                         {
 336                         data->mtu = sockopt_val;
 337                         ret = data->mtu;
 338                         }
 339                 break;
 340         case BIO_CTRL_DGRAM_GET_MTU:
 341                 return data->mtu;
 342                 break;
 343         case BIO_CTRL_DGRAM_SET_MTU:
 344                 data->mtu = num;
 345                 ret = num;
 346                 break;
 347         case BIO_CTRL_DGRAM_SET_CONNECTED:
 348                 to = (struct sockaddr *)ptr;
 349
 350                 if ( to != NULL)
 351                         {
 352                         data->connected = 1;
 353                         memcpy(&(data->peer),to, sizeof(struct sockaddr));
 354                         }
 355                 else
 356                         {
 357                         data->connected = 0;
 358                         memset(&(data->peer), 0x00, sizeof(struct sockaddr));
 359                         }
 360                 break;
 361     case BIO_CTRL_DGRAM_SET_PEER:
 362         to = (struct sockaddr *) ptr;
 363
 364         memcpy(&(data->peer), to, sizeof(struct sockaddr));
 365         break;
 366         case BIO_CTRL_DGRAM_SET_TIMEOUT:
 367                 if (num > 0)
 368                         {
 369                         gettimeofday(&(data->hstimeout), NULL);
 370                         data->hstimeout.tv_sec += data->hstimeoutdiff.tv_sec;
 371                         data->hstimeout.tv_usec += data->hstimeoutdiff.tv_usec;
 372                         if (data->hstimeout.tv_usec >= 1000000)
 373                                 {
 374                                 data->hstimeout.tv_sec++;
 375                                 data->hstimeout.tv_usec -= 1000000;
 376                                 }
 377                         }
 378                 else
 379                         {
 380                         memset(&(data->hstimeout), 0, sizeof(struct timeval));
 381                         }
 382                 break;
 383 #if defined(SO_RCVTIMEO)
 384         case BIO_CTRL_DGRAM_SET_RECV_TIMEOUT:
 385 #ifdef OPENSSL_SYS_WINDOWS
 386                 {
 387                 struct timeval *tv = (struct timeval *)ptr;
 388                 int timeout = tv->tv_sec * 1000 + tv->tv_usec/1000;
 389                 if (setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
 390                         (void*)&timeout, sizeof(timeout)) < 0)
 391                         { perror("setsockopt"); ret = -1; }
 392                 }
 393 #else
 394                 if ( setsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO, ptr,
 395                         sizeof(struct timeval)) < 0)
 396                         { perror("setsockopt"); ret = -1; }
 397 #endif
 398                 memcpy(&(data->hstimeoutdiff), ptr, sizeof(struct timeval));
 399                 break;
 400         case BIO_CTRL_DGRAM_GET_RECV_TIMEOUT:
 401 #ifdef OPENSSL_SYS_WINDOWS
 402                 {
 403                 int timeout, sz = sizeof(timeout);
 404                 struct timeval *tv = (struct timeval *)ptr;
 405                 if (getsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
 406                         (void*)&timeout, &sz) < 0)
 407                         { perror("getsockopt"); ret = -1; }
 408                 else
 409                         {
 410                         tv->tv_sec = timeout / 1000;
 411                         tv->tv_usec = (timeout % 1000) * 1000;
 412                         ret = sizeof(*tv);
 413                         }
 414                 }
 415 #else
 416                 if ( getsockopt(b->num, SOL_SOCKET, SO_RCVTIMEO,
 417                         ptr, (void *)&ret) < 0)
 418                         { perror("getsockopt"); ret = -1; }
 419 #endif
 420                 break;
 421 #endif
 422 #if defined(SO_SNDTIMEO)
 423         case BIO_CTRL_DGRAM_SET_SEND_TIMEOUT:
 424 #ifdef OPENSSL_SYS_WINDOWS
 425                 {
 426                 struct timeval *tv = (struct timeval *)ptr;
 427                 int timeout = tv->tv_sec * 1000 + tv->tv_usec/1000;
 428                 if (setsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO,
 429                         (void*)&timeout, sizeof(timeout)) < 0)
 430                         { perror("setsockopt"); ret = -1; }
 431                 }
 432 #else
 433                 if ( setsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO, ptr,
 434                         sizeof(struct timeval)) < 0)
 435                         { perror("setsockopt"); ret = -1; }
 436 #endif
 437                 break;
 438         case BIO_CTRL_DGRAM_GET_SEND_TIMEOUT:
 439 #ifdef OPENSSL_SYS_WINDOWS
 440                 {
 441                 int timeout, sz = sizeof(timeout);
 442                 struct timeval *tv = (struct timeval *)ptr;
 443                 if (getsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO,
 444                         (void*)&timeout, &sz) < 0)
 445                         { perror("getsockopt"); ret = -1; }
 446                 else
 447                         {
 448                         tv->tv_sec = timeout / 1000;
 449                         tv->tv_usec = (timeout % 1000) * 1000;
 450                         ret = sizeof(*tv);
 451                         }
 452                 }
 453 #else
 454                 if ( getsockopt(b->num, SOL_SOCKET, SO_SNDTIMEO,
 455                         ptr, (void *)&ret) < 0)
 456                         { perror("getsockopt"); ret = -1; }
 457 #endif
 458                 break;
 459 #endif
 460         case BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP:
 461                 /* fall-through */
 462         case BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP:
 463 #ifdef OPENSSL_SYS_WINDOWS
 464                 if ( data->_errno == WSAETIMEDOUT)
 465 #else
 466                 if ( data->_errno == EAGAIN)
 467 #endif
 468                         {
 469                         ret = 1;
 470                         data->_errno = 0;
 471                         }
 472                 else
 473                         ret = 0;
 474                 break;
 475 #ifdef EMSGSIZE
 476         case BIO_CTRL_DGRAM_MTU_EXCEEDED:
 477                 if ( data->_errno == EMSGSIZE)
 478                         {
 479                         ret = 1;
 480                         data->_errno = 0;
 481                         }
 482                 else
 483                         ret = 0;
 484                 break;
 485 #endif
 486         default:
 487                 ret=0;
 488                 break;
 489                 }
 490         return(ret);
 491         }
 492
 493 static int dgram_puts(BIO *bp, const char *str)
 494         {
 495         int n,ret;
 496
 497         n=strlen(str);
 498         ret=dgram_write(bp,str,n);
 499         return(ret);
 500         }
 501
 502 static int BIO_dgram_should_retry(int i)
 503         {
 504         int err;
 505
 506         if ((i == 0) || (i == -1))
 507                 {
 508                 err=get_last_socket_error();
 509
 510 #if defined(OPENSSL_SYS_WINDOWS) && 0 /* more microsoft stupidity? perhaps not? Ben 4/1/99 */
 511                 if ((i == -1) && (err == 0))
 512                         return(1);
 513 #endif
 514
 515                 return(BIO_dgram_non_fatal_error(err));
 516                 }
 517         return(0);
 518         }
 519
 520 int BIO_dgram_non_fatal_error(int err)
 521         {
 522         switch (err)
 523                 {
 524 #if defined(OPENSSL_SYS_WINDOWS)
 525 # if defined(WSAEWOULDBLOCK)
 526         case WSAEWOULDBLOCK:
 527 # endif
 528
 529 # if 0 /* This appears to always be an error */
 530 #  if defined(WSAENOTCONN)
 531         case WSAENOTCONN:
 532 #  endif
 533 # endif
 534 #endif
 535
 536 #ifdef EWOULDBLOCK
 537 # ifdef WSAEWOULDBLOCK
 538 #  if WSAEWOULDBLOCK != EWOULDBLOCK
 539         case EWOULDBLOCK:
 540 #  endif
 541 # else
 542         case EWOULDBLOCK:
 543 # endif
 544 #endif
 545
 546 #if defined(ENOTCONN)
 547         case ENOTCONN:
 548 #endif
 549
 550 #ifdef EINTR
 551         case EINTR:
 552 #endif
 553
 554 #ifdef EAGAIN
 555 #if EWOULDBLOCK != EAGAIN
 556         case EAGAIN:
 557 # endif
 558 #endif
 559
 560 #ifdef EPROTO
 561         case EPROTO:
 562 #endif
 563
 564 #ifdef EINPROGRESS
 565         case EINPROGRESS:
 566 #endif
 567
 568 #ifdef EALREADY
 569         case EALREADY:
 570 #endif
 571
 572 /* DF bit set, and packet larger than MTU */
 573 #ifdef EMSGSIZE
 574         case EMSGSIZE:
 575 #endif
 576
 577                 return(1);
 578                 /* break; */
 579         default:
 580                 break;
 581                 }
 582         return(0);
 583         }
 584 #endif