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