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