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