dtls1.h 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288
  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. #ifndef HEADER_DTLS1_H
  60. #define HEADER_DTLS1_H
  61. #include <openssl/buffer.h>
  62. #include <openssl/pqueue.h>
  63. #ifdef OPENSSL_SYS_VMS
  64. #include <resource.h>
  65. #include <sys/timeb.h>
  66. #endif
  67. #ifdef OPENSSL_SYS_WIN32
  68. /* Needed for struct timeval */
  69. #include <winsock.h>
  70. #elif defined(OPENSSL_SYS_NETWARE) && !defined(_WINSOCK2API_)
  71. #include <sys/timeval.h>
  72. #else
  73. #if defined(OPENSSL_SYS_VXWORKS)
  74. #include <sys/times.h>
  75. #else
  76. #include <sys/time.h>
  77. #endif
  78. #endif
  79. #ifdef __cplusplus
  80. extern "C" {
  81. #endif
  82. #define DTLS1_VERSION 0xFEFF
  83. #define DTLS_MAX_VERSION DTLS1_VERSION
  84. #define DTLS1_BAD_VER 0x0100
  85. #if 0
  86. /* this alert description is not specified anywhere... */
  87. #define DTLS1_AD_MISSING_HANDSHAKE_MESSAGE 110
  88. #endif
  89. /* lengths of messages */
  90. #define DTLS1_COOKIE_LENGTH 256
  91. #define DTLS1_RT_HEADER_LENGTH 13
  92. #define DTLS1_HM_HEADER_LENGTH 12
  93. #define DTLS1_HM_BAD_FRAGMENT -2
  94. #define DTLS1_HM_FRAGMENT_RETRY -3
  95. #define DTLS1_CCS_HEADER_LENGTH 1
  96. #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
  97. #define DTLS1_AL_HEADER_LENGTH 7
  98. #else
  99. #define DTLS1_AL_HEADER_LENGTH 2
  100. #endif
  101. #ifndef OPENSSL_NO_SSL_INTERN
  102. #ifndef OPENSSL_NO_SCTP
  103. #define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
  104. #endif
  105. typedef struct dtls1_bitmap_st
  106. {
  107. unsigned long map; /* track 32 packets on 32-bit systems
  108. and 64 - on 64-bit systems */
  109. unsigned char max_seq_num[8]; /* max record number seen so far,
  110. 64-bit value in big-endian
  111. encoding */
  112. } DTLS1_BITMAP;
  113. struct dtls1_retransmit_state
  114. {
  115. EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
  116. EVP_MD_CTX *write_hash; /* used for mac generation */
  117. #ifndef OPENSSL_NO_COMP
  118. COMP_CTX *compress; /* compression */
  119. #else
  120. char *compress;
  121. #endif
  122. SSL_SESSION *session;
  123. unsigned short epoch;
  124. };
  125. struct hm_header_st
  126. {
  127. unsigned char type;
  128. unsigned long msg_len;
  129. unsigned short seq;
  130. unsigned long frag_off;
  131. unsigned long frag_len;
  132. unsigned int is_ccs;
  133. struct dtls1_retransmit_state saved_retransmit_state;
  134. };
  135. struct ccs_header_st
  136. {
  137. unsigned char type;
  138. unsigned short seq;
  139. };
  140. struct dtls1_timeout_st
  141. {
  142. /* Number of read timeouts so far */
  143. unsigned int read_timeouts;
  144. /* Number of write timeouts so far */
  145. unsigned int write_timeouts;
  146. /* Number of alerts received so far */
  147. unsigned int num_alerts;
  148. };
  149. typedef struct record_pqueue_st
  150. {
  151. unsigned short epoch;
  152. pqueue q;
  153. } record_pqueue;
  154. typedef struct hm_fragment_st
  155. {
  156. struct hm_header_st msg_header;
  157. unsigned char *fragment;
  158. unsigned char *reassembly;
  159. } hm_fragment;
  160. typedef struct dtls1_state_st
  161. {
  162. unsigned int send_cookie;
  163. unsigned char cookie[DTLS1_COOKIE_LENGTH];
  164. unsigned char rcvd_cookie[DTLS1_COOKIE_LENGTH];
  165. unsigned int cookie_len;
  166. /*
  167. * The current data and handshake epoch. This is initially
  168. * undefined, and starts at zero once the initial handshake is
  169. * completed
  170. */
  171. unsigned short r_epoch;
  172. unsigned short w_epoch;
  173. /* records being received in the current epoch */
  174. DTLS1_BITMAP bitmap;
  175. /* renegotiation starts a new set of sequence numbers */
  176. DTLS1_BITMAP next_bitmap;
  177. /* handshake message numbers */
  178. unsigned short handshake_write_seq;
  179. unsigned short next_handshake_write_seq;
  180. unsigned short handshake_read_seq;
  181. /* save last sequence number for retransmissions */
  182. unsigned char last_write_sequence[8];
  183. /* Received handshake records (processed and unprocessed) */
  184. record_pqueue unprocessed_rcds;
  185. record_pqueue processed_rcds;
  186. /* Buffered handshake messages */
  187. pqueue buffered_messages;
  188. /* Buffered (sent) handshake records */
  189. pqueue sent_messages;
  190. /* Buffered application records.
  191. * Only for records between CCS and Finished
  192. * to prevent either protocol violation or
  193. * unnecessary message loss.
  194. */
  195. record_pqueue buffered_app_data;
  196. /* Is set when listening for new connections with dtls1_listen() */
  197. unsigned int listen;
  198. unsigned int mtu; /* max DTLS packet size */
  199. struct hm_header_st w_msg_hdr;
  200. struct hm_header_st r_msg_hdr;
  201. struct dtls1_timeout_st timeout;
  202. /* Indicates when the last handshake msg or heartbeat sent will timeout */
  203. struct timeval next_timeout;
  204. /* Timeout duration */
  205. unsigned short timeout_duration;
  206. /* storage for Alert/Handshake protocol data received but not
  207. * yet processed by ssl3_read_bytes: */
  208. unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH];
  209. unsigned int alert_fragment_len;
  210. unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH];
  211. unsigned int handshake_fragment_len;
  212. unsigned int retransmitting;
  213. unsigned int change_cipher_spec_ok;
  214. #ifndef OPENSSL_NO_SCTP
  215. /* used when SSL_ST_XX_FLUSH is entered */
  216. int next_state;
  217. int shutdown_received;
  218. #endif
  219. } DTLS1_STATE;
  220. typedef struct dtls1_record_data_st
  221. {
  222. unsigned char *packet;
  223. unsigned int packet_length;
  224. SSL3_BUFFER rbuf;
  225. SSL3_RECORD rrec;
  226. #ifndef OPENSSL_NO_SCTP
  227. struct bio_dgram_sctp_rcvinfo recordinfo;
  228. #endif
  229. } DTLS1_RECORD_DATA;
  230. #endif
  231. /* Timeout multipliers (timeout slice is defined in apps/timeouts.h */
  232. #define DTLS1_TMO_READ_COUNT 2
  233. #define DTLS1_TMO_WRITE_COUNT 2
  234. #define DTLS1_TMO_ALERT_COUNT 12
  235. #ifdef __cplusplus
  236. }
  237. #endif
  238. #endif