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
  66 #ifdef  __cplusplus
  67 extern "C" {
  68 #endif
  69
  70 #define DTLS1_VERSION                   0xFEFF
  71
  72 #if 0
  73 /* this alert description is not specified anywhere... */
  74 #define DTLS1_AD_MISSING_HANDSHAKE_MESSAGE    110
  75 #endif
  76
  77 /* lengths of messages */
  78 #define DTLS1_COOKIE_LENGTH                     32
  79
  80 #define DTLS1_RT_HEADER_LENGTH                  13
  81
  82 #define DTLS1_HM_HEADER_LENGTH                  12
  83
  84 #define DTLS1_HM_BAD_FRAGMENT                   -2
  85 #define DTLS1_HM_FRAGMENT_RETRY                 -3
  86
  87 #define DTLS1_CCS_HEADER_LENGTH                  1
  88
  89 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
  90 #define DTLS1_AL_HEADER_LENGTH                   7
  91 #else
  92 #define DTLS1_AL_HEADER_LENGTH                   2
  93 #endif
  94
  95
  96 typedef struct dtls1_bitmap_st
  97         {
  98         unsigned long map;              /* track 32 packets on 32-bit systems
  99                                            and 64 - on 64-bit systems */
 100         unsigned char max_seq_num[8];   /* max record number seen so far,
 101                                            64-bit value in big-endian
 102                                            encoding */
 103         } DTLS1_BITMAP;
 104
 105 struct hm_header_st
 106         {
 107         unsigned char type;
 108         unsigned long msg_len;
 109         unsigned short seq;
 110         unsigned long frag_off;
 111         unsigned long frag_len;
 112         unsigned int is_ccs;
 113         };
 114
 115 struct ccs_header_st
 116         {
 117         unsigned char type;
 118         unsigned short seq;
 119         };
 120
 121 struct dtls1_timeout_st
 122         {
 123         /* Number of read timeouts so far */
 124         unsigned int read_timeouts;
 125
 126         /* Number of write timeouts so far */
 127         unsigned int write_timeouts;
 128
 129         /* Number of alerts received so far */
 130         unsigned int num_alerts;
 131         };
 132
 133 typedef struct record_pqueue_st
 134         {
 135         unsigned short epoch;
 136         pqueue q;
 137         } record_pqueue;
 138
 139 typedef struct hm_fragment_st
 140         {
 141         struct hm_header_st msg_header;
 142         unsigned char *fragment;
 143         } hm_fragment;
 144
 145 typedef struct dtls1_state_st
 146         {
 147         unsigned int send_cookie;
 148         unsigned char cookie[DTLS1_COOKIE_LENGTH];
 149         unsigned char rcvd_cookie[DTLS1_COOKIE_LENGTH];
 150         unsigned int cookie_len;
 151
 152         /*
 153          * The current data and handshake epoch.  This is initially
 154          * undefined, and starts at zero once the initial handshake is
 155          * completed
 156          */
 157         unsigned short r_epoch;
 158         unsigned short w_epoch;
 159
 160         /* records being received in the current epoch */
 161         DTLS1_BITMAP bitmap;
 162
 163         /* renegotiation starts a new set of sequence numbers */
 164         DTLS1_BITMAP next_bitmap;
 165
 166         /* handshake message numbers */
 167         unsigned short handshake_write_seq;
 168         unsigned short next_handshake_write_seq;
 169
 170         unsigned short handshake_read_seq;
 171
 172         /* Received handshake records (processed and unprocessed) */
 173         record_pqueue unprocessed_rcds;
 174         record_pqueue processed_rcds;
 175
 176         /* Buffered handshake messages */
 177         pqueue buffered_messages;
 178
 179         /* Buffered (sent) handshake records */
 180         pqueue sent_messages;
 181
 182         unsigned int mtu; /* max wire packet size */
 183
 184         struct hm_header_st w_msg_hdr;
 185         struct hm_header_st r_msg_hdr;
 186
 187         struct dtls1_timeout_st timeout;
 188
 189         /* storage for Alert/Handshake protocol data received but not
 190          * yet processed by ssl3_read_bytes: */
 191         unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH];
 192         unsigned int alert_fragment_len;
 193         unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH];
 194         unsigned int handshake_fragment_len;
 195
 196         unsigned int retransmitting;
 197
 198         } DTLS1_STATE;
 199
 200 typedef struct dtls1_record_data_st
 201         {
 202         unsigned char *packet;
 203         unsigned int   packet_length;
 204         SSL3_BUFFER    rbuf;
 205         SSL3_RECORD    rrec;
 206         } DTLS1_RECORD_DATA;
 207
 208
 209 /* Timeout multipliers (timeout slice is defined in apps/timeouts.h */
 210 #define DTLS1_TMO_READ_COUNT                      2
 211 #define DTLS1_TMO_WRITE_COUNT                     2
 212
 213 #define DTLS1_TMO_ALERT_COUNT                     12
 214
 215 #ifdef  __cplusplus
 216 }
 217 #endif
 218 #endif
 219