src/third_party/boringssl/src/include/openssl/dtls1.h

   1 /* ssl/dtls1.h */
   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 HEADER_DTLS1_H
  61 #define HEADER_DTLS1_H
  62
  63 #include <openssl/buf.h>
  64 #include <openssl/pqueue.h>
  65 #if defined(OPENSSL_WINDOWS)
  66 /* Including winsock.h pollutes the namespace too much with defines for
  67  * X509_NAME etc. */
  68 typedef struct timeval {
  69         long tv_sec;
  70         long tv_usec;
  71 } timeval;
  72 #else
  73 #include <sys/time.h>
  74 #endif
  75
  76 #ifdef  __cplusplus
  77 extern "C" {
  78 #endif
  79
  80 #define DTLS1_VERSION                   0xFEFF
  81 #define DTLS1_BAD_VER                   0x0100
  82 #define DTLS1_2_VERSION                 0xFEFD
  83 /* Special value for method supporting multiple versions */
  84 #define DTLS_ANY_VERSION                0x1FFFF
  85
  86 #if 0
  87 /* this alert description is not specified anywhere... */
  88 #define DTLS1_AD_MISSING_HANDSHAKE_MESSAGE    110
  89 #endif
  90
  91 /* lengths of messages */
  92 #define DTLS1_COOKIE_LENGTH                     256
  93
  94 #define DTLS1_RT_HEADER_LENGTH                  13
  95
  96 #define DTLS1_HM_HEADER_LENGTH                  12
  97
  98 #define DTLS1_HM_BAD_FRAGMENT                   -2
  99 #define DTLS1_HM_FRAGMENT_RETRY                 -3
 100
 101 #define DTLS1_CCS_HEADER_LENGTH                  1
 102
 103 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
 104 #define DTLS1_AL_HEADER_LENGTH                   7
 105 #else
 106 #define DTLS1_AL_HEADER_LENGTH                   2
 107 #endif
 108
 109 #ifndef OPENSSL_NO_SSL_INTERN
 110
 111 typedef struct dtls1_bitmap_st
 112         {
 113         unsigned long map;              /* track 32 packets on 32-bit systems
 114                                            and 64 - on 64-bit systems */
 115         unsigned char max_seq_num[8];   /* max record number seen so far,
 116                                            64-bit value in big-endian
 117                                            encoding */
 118         } DTLS1_BITMAP;
 119
 120 struct dtls1_retransmit_state
 121         {
 122         EVP_CIPHER_CTX *enc_write_ctx;  /* cryptographic state */
 123         EVP_MD_CTX *write_hash;                 /* used for mac generation */
 124         SSL_SESSION *session;
 125         unsigned short epoch;
 126         };
 127
 128 struct hm_header_st
 129         {
 130         unsigned char type;
 131         unsigned long msg_len;
 132         unsigned short seq;
 133         unsigned long frag_off;
 134         unsigned long frag_len;
 135         unsigned int is_ccs;
 136         struct dtls1_retransmit_state saved_retransmit_state;
 137         };
 138
 139 struct ccs_header_st
 140         {
 141         unsigned char type;
 142         unsigned short seq;
 143         };
 144
 145 struct dtls1_timeout_st
 146         {
 147         /* Number of read timeouts so far */
 148         unsigned int read_timeouts;
 149
 150         /* Number of write timeouts so far */
 151         unsigned int write_timeouts;
 152
 153         /* Number of alerts received so far */
 154         unsigned int num_alerts;
 155         };
 156
 157 typedef struct record_pqueue_st
 158         {
 159         unsigned short epoch;
 160         pqueue q;
 161         } record_pqueue;
 162
 163 typedef struct hm_fragment_st
 164         {
 165         struct hm_header_st msg_header;
 166         unsigned char *fragment;
 167         unsigned char *reassembly;
 168         } hm_fragment;
 169
 170 typedef struct dtls1_state_st
 171         {
 172         unsigned int send_cookie;
 173         unsigned char cookie[DTLS1_COOKIE_LENGTH];
 174         unsigned int cookie_len;
 175
 176         /*
 177          * The current data and handshake epoch.  This is initially
 178          * undefined, and starts at zero once the initial handshake is
 179          * completed
 180          */
 181         unsigned short r_epoch;
 182         unsigned short w_epoch;
 183
 184         /* records being received in the current epoch */
 185         DTLS1_BITMAP bitmap;
 186
 187         /* renegotiation starts a new set of sequence numbers */
 188         DTLS1_BITMAP next_bitmap;
 189
 190         /* handshake message numbers */
 191         unsigned short handshake_write_seq;
 192         unsigned short next_handshake_write_seq;
 193
 194         unsigned short handshake_read_seq;
 195
 196         /* save last sequence number for retransmissions */
 197         unsigned char last_write_sequence[8];
 198
 199         /* Received handshake records (processed and unprocessed) */
 200         record_pqueue unprocessed_rcds;
 201         record_pqueue processed_rcds;
 202
 203         /* Buffered handshake messages */
 204         pqueue buffered_messages;
 205
 206         /* Buffered (sent) handshake records */
 207         pqueue sent_messages;
 208
 209         /* Buffered application records.
 210          * Only for records between CCS and Finished
 211          * to prevent either protocol violation or
 212          * unnecessary message loss.
 213          */
 214         record_pqueue buffered_app_data;
 215
 216         /* Is set when listening for new connections with dtls1_listen() */
 217         unsigned int listen;
 218
 219         unsigned int mtu; /* max DTLS packet size */
 220
 221         struct hm_header_st w_msg_hdr;
 222         struct hm_header_st r_msg_hdr;
 223
 224         struct dtls1_timeout_st timeout;
 225
 226         /* Indicates when the last handshake msg or heartbeat sent will timeout */
 227         struct timeval next_timeout;
 228
 229         /* Timeout duration */
 230         unsigned short timeout_duration;
 231
 232         /* storage for Alert/Handshake protocol data received but not
 233          * yet processed by ssl3_read_bytes: */
 234         unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH];
 235         unsigned int alert_fragment_len;
 236         unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH];
 237         unsigned int handshake_fragment_len;
 238
 239         unsigned int retransmitting;
 240         unsigned int change_cipher_spec_ok;
 241         } DTLS1_STATE;
 242
 243 typedef struct dtls1_record_data_st
 244         {
 245         unsigned char *packet;
 246         unsigned int   packet_length;
 247         SSL3_BUFFER    rbuf;
 248         SSL3_RECORD    rrec;
 249         } DTLS1_RECORD_DATA;
 250
 251 #endif
 252
 253 /* Timeout multipliers (timeout slice is defined in apps/timeouts.h */
 254 #define DTLS1_TMO_READ_COUNT                      2
 255 #define DTLS1_TMO_WRITE_COUNT                     2
 256
 257 #define DTLS1_TMO_ALERT_COUNT                     12
 258
 259 #ifdef  __cplusplus
 260 }
 261 #endif
 262 #endif
 263