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