2
0

dtls1.h 7.5 KB

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