1 /* $OpenBSD: dtls1.h,v 1.22 2018/08/24 19:35:05 jsing Exp $ */ 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 #if defined(_WIN32) 64 #include <winsock2.h> 65 #else 66 #include <sys/time.h> 67 #endif 68 69 #include <stdio.h> 70 #include <stdlib.h> 71 #include <string.h> 72 73 #include <openssl/opensslconf.h> 74 #include <openssl/buffer.h> 75 76 #ifdef __cplusplus 77 extern "C" { 78 #endif 79 80 #define DTLS1_VERSION 0xFEFF 81 82 /* lengths of messages */ 83 #define DTLS1_COOKIE_LENGTH 256 84 85 #define DTLS1_RT_HEADER_LENGTH 13 86 87 #define DTLS1_HM_HEADER_LENGTH 12 88 89 #define DTLS1_HM_BAD_FRAGMENT -2 90 #define DTLS1_HM_FRAGMENT_RETRY -3 91 92 #define DTLS1_CCS_HEADER_LENGTH 1 93 94 #define DTLS1_AL_HEADER_LENGTH 2 95 96 #ifndef OPENSSL_NO_SSL_INTERN 97 98 99 typedef struct dtls1_bitmap_st { 100 unsigned long map; /* track 32 packets on 32-bit systems 101 and 64 - on 64-bit systems */ 102 unsigned char max_seq_num[8]; /* max record number seen so far, 103 64-bit value in big-endian 104 encoding */ 105 } DTLS1_BITMAP; 106 107 struct dtls1_retransmit_state { 108 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */ 109 EVP_MD_CTX *write_hash; /* used for mac generation */ 110 SSL_SESSION *session; 111 unsigned short epoch; 112 }; 113 114 struct hm_header_st { 115 unsigned char type; 116 unsigned long msg_len; 117 unsigned short seq; 118 unsigned long frag_off; 119 unsigned long frag_len; 120 unsigned int is_ccs; 121 struct dtls1_retransmit_state saved_retransmit_state; 122 }; 123 124 struct ccs_header_st { 125 unsigned char type; 126 unsigned short seq; 127 }; 128 129 struct dtls1_timeout_st { 130 /* Number of read timeouts so far */ 131 unsigned int read_timeouts; 132 133 /* Number of write timeouts so far */ 134 unsigned int write_timeouts; 135 136 /* Number of alerts received so far */ 137 unsigned int num_alerts; 138 }; 139 140 struct _pqueue; 141 142 typedef struct record_pqueue_st { 143 unsigned short epoch; 144 struct _pqueue *q; 145 } record_pqueue; 146 147 typedef struct hm_fragment_st { 148 struct hm_header_st msg_header; 149 unsigned char *fragment; 150 unsigned char *reassembly; 151 } hm_fragment; 152 153 struct dtls1_state_internal_st; 154 155 typedef struct dtls1_state_st { 156 /* Buffered (sent) handshake records */ 157 struct _pqueue *sent_messages; 158 159 /* Indicates when the last handshake msg or heartbeat sent will timeout */ 160 struct timeval next_timeout; 161 162 /* Timeout duration */ 163 unsigned short timeout_duration; 164 165 struct dtls1_state_internal_st *internal; 166 } DTLS1_STATE; 167 168 typedef struct dtls1_record_data_st { 169 unsigned char *packet; 170 unsigned int packet_length; 171 SSL3_BUFFER rbuf; 172 SSL3_RECORD rrec; 173 } DTLS1_RECORD_DATA; 174 175 #endif 176 177 /* Timeout multipliers (timeout slice is defined in apps/timeouts.h */ 178 #define DTLS1_TMO_READ_COUNT 2 179 #define DTLS1_TMO_WRITE_COUNT 2 180 181 #define DTLS1_TMO_ALERT_COUNT 12 182 183 #ifdef __cplusplus 184 } 185 #endif 186 #endif 187