OSDN Git Service

Update to 5b5ec56126af820b2d3c86e94ce4c056bf3b9904 about bug fixes.
[ffftp/ffftp.git] / contrib / openssl / include / openssl / dtls1.h
index 5a1cf8c..d4fcdd4 100644 (file)
-/* ssl/dtls1.h */
-/*
- * DTLS implementation written by Nagendra Modadugu
- * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.
- */
-/* ====================================================================
- * Copyright (c) 1999-2005 The OpenSSL Project.  All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in
- *    the documentation and/or other materials provided with the
- *    distribution.
- *
- * 3. All advertising materials mentioning features or use of this
- *    software must display the following acknowledgment:
- *    "This product includes software developed by the OpenSSL Project
- *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
- *
- * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
- *    endorse or promote products derived from this software without
- *    prior written permission. For written permission, please contact
- *    openssl-core@OpenSSL.org.
- *
- * 5. Products derived from this software may not be called "OpenSSL"
- *    nor may "OpenSSL" appear in their names without prior written
- *    permission of the OpenSSL Project.
- *
- * 6. Redistributions of any form whatsoever must retain the following
- *    acknowledgment:
- *    "This product includes software developed by the OpenSSL Project
- *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
- *
- * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
- * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
- * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
- * OF THE POSSIBILITY OF SUCH DAMAGE.
- * ====================================================================
- *
- * This product includes cryptographic software written by Eric Young
- * (eay@cryptsoft.com).  This product includes software written by Tim
- * Hudson (tjh@cryptsoft.com).
- *
- */
-
-#ifndef HEADER_DTLS1_H
-#define HEADER_DTLS1_H
-
-#include <openssl/buffer.h>
-#include <openssl/pqueue.h>
-#ifdef OPENSSL_SYS_VMS
-#include <resource.h>
-#include <sys/timeb.h>
-#endif
-#ifdef OPENSSL_SYS_WIN32
-/* Needed for struct timeval */
-#include <winsock.h>
-#elif defined(OPENSSL_SYS_NETWARE) && !defined(_WINSOCK2API_)
-#include <sys/timeval.h>
-#else
-#include <sys/time.h>
-#endif
-
-#ifdef  __cplusplus
-extern "C" {
-#endif
-
-#define DTLS1_VERSION                  0xFEFF
-#define DTLS1_BAD_VER                  0x0100
-
-#if 0
-/* this alert description is not specified anywhere... */
-#define DTLS1_AD_MISSING_HANDSHAKE_MESSAGE    110
-#endif
-
-/* lengths of messages */
-#define DTLS1_COOKIE_LENGTH                     256
-
-#define DTLS1_RT_HEADER_LENGTH                  13
-
-#define DTLS1_HM_HEADER_LENGTH                  12
-
-#define DTLS1_HM_BAD_FRAGMENT                   -2
-#define DTLS1_HM_FRAGMENT_RETRY                 -3
-
-#define DTLS1_CCS_HEADER_LENGTH                  1
-
-#ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
-#define DTLS1_AL_HEADER_LENGTH                   7
-#else
-#define DTLS1_AL_HEADER_LENGTH                   2
-#endif
-
-
-typedef struct dtls1_bitmap_st
-       {
-       unsigned long map;              /* track 32 packets on 32-bit systems
-                                          and 64 - on 64-bit systems */
-       unsigned char max_seq_num[8];   /* max record number seen so far,
-                                          64-bit value in big-endian
-                                          encoding */
-       } DTLS1_BITMAP;
-
-struct dtls1_retransmit_state
-       {
-       EVP_CIPHER_CTX *enc_write_ctx;  /* cryptographic state */
-       EVP_MD_CTX *write_hash;                 /* used for mac generation */
-#ifndef OPENSSL_NO_COMP
-       COMP_CTX *compress;                             /* compression */
-#else
-       char *compress;
-#endif
-       SSL_SESSION *session;
-       unsigned short epoch;
-       };
-
-struct hm_header_st
-       {
-       unsigned char type;
-       unsigned long msg_len;
-       unsigned short seq;
-       unsigned long frag_off;
-       unsigned long frag_len;
-       unsigned int is_ccs;
-       struct dtls1_retransmit_state saved_retransmit_state;
-       };
-
-struct ccs_header_st
-       {
-       unsigned char type;
-       unsigned short seq;
-       };
-
-struct dtls1_timeout_st
-       {
-       /* Number of read timeouts so far */
-       unsigned int read_timeouts;
-
-       /* Number of write timeouts so far */
-       unsigned int write_timeouts;
-
-       /* Number of alerts received so far */
-       unsigned int num_alerts;
-       };
-
-typedef struct record_pqueue_st
-       {
-       unsigned short epoch;
-       pqueue q;
-       } record_pqueue;
-
-typedef struct hm_fragment_st
-       {
-       struct hm_header_st msg_header;
-       unsigned char *fragment;
-       unsigned char *reassembly;
-       } hm_fragment;
-
-typedef struct dtls1_state_st
-       {
-       unsigned int send_cookie;
-       unsigned char cookie[DTLS1_COOKIE_LENGTH];
-       unsigned char rcvd_cookie[DTLS1_COOKIE_LENGTH];
-       unsigned int cookie_len;
-
-       /*
-        * The current data and handshake epoch.  This is initially
-        * undefined, and starts at zero once the initial handshake is
-        * completed
-        */
-       unsigned short r_epoch;
-       unsigned short w_epoch;
-
-       /* records being received in the current epoch */
-       DTLS1_BITMAP bitmap;
-
-       /* renegotiation starts a new set of sequence numbers */
-       DTLS1_BITMAP next_bitmap;
-
-       /* handshake message numbers */
-       unsigned short handshake_write_seq;
-       unsigned short next_handshake_write_seq;
-
-       unsigned short handshake_read_seq;
-
-       /* save last sequence number for retransmissions */
-       unsigned char last_write_sequence[8];
-
-       /* Received handshake records (processed and unprocessed) */
-       record_pqueue unprocessed_rcds;
-       record_pqueue processed_rcds;
-
-       /* Buffered handshake messages */
-       pqueue buffered_messages;
-
-       /* Buffered (sent) handshake records */
-       pqueue sent_messages;
-
-       /* Buffered application records.
-        * Only for records between CCS and Finished
-        * to prevent either protocol violation or
-        * unnecessary message loss.
-        */
-       record_pqueue buffered_app_data;
-
-       /* Is set when listening for new connections with dtls1_listen() */
-       unsigned int listen;
-
-       unsigned int mtu; /* max DTLS packet size */
-
-       struct hm_header_st w_msg_hdr;
-       struct hm_header_st r_msg_hdr;
-
-       struct dtls1_timeout_st timeout;
-
-       /* Indicates when the last handshake msg sent will timeout */
-       struct timeval next_timeout;
-
-       /* Timeout duration */
-       unsigned short timeout_duration;
-
-       /* storage for Alert/Handshake protocol data received but not
-        * yet processed by ssl3_read_bytes: */
-       unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH];
-       unsigned int alert_fragment_len;
-       unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH];
-       unsigned int handshake_fragment_len;
-
-       unsigned int retransmitting;
-       unsigned int change_cipher_spec_ok;
-
-       } DTLS1_STATE;
-
-typedef struct dtls1_record_data_st
-       {
-       unsigned char *packet;
-       unsigned int   packet_length;
-       SSL3_BUFFER    rbuf;
-       SSL3_RECORD    rrec;
-       } DTLS1_RECORD_DATA;
-
-
-/* Timeout multipliers (timeout slice is defined in apps/timeouts.h */
-#define DTLS1_TMO_READ_COUNT                      2
-#define DTLS1_TMO_WRITE_COUNT                     2
-
-#define DTLS1_TMO_ALERT_COUNT                     12
-
-#ifdef  __cplusplus
-}
-#endif
-#endif
-
+/* ssl/dtls1.h */\r
+/*\r
+ * DTLS implementation written by Nagendra Modadugu\r
+ * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.\r
+ */\r
+/* ====================================================================\r
+ * Copyright (c) 1999-2005 The OpenSSL Project.  All rights reserved.\r
+ *\r
+ * Redistribution and use in source and binary forms, with or without\r
+ * modification, are permitted provided that the following conditions\r
+ * are met:\r
+ *\r
+ * 1. Redistributions of source code must retain the above copyright\r
+ *    notice, this list of conditions and the following disclaimer.\r
+ *\r
+ * 2. Redistributions in binary form must reproduce the above copyright\r
+ *    notice, this list of conditions and the following disclaimer in\r
+ *    the documentation and/or other materials provided with the\r
+ *    distribution.\r
+ *\r
+ * 3. All advertising materials mentioning features or use of this\r
+ *    software must display the following acknowledgment:\r
+ *    "This product includes software developed by the OpenSSL Project\r
+ *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"\r
+ *\r
+ * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to\r
+ *    endorse or promote products derived from this software without\r
+ *    prior written permission. For written permission, please contact\r
+ *    openssl-core@OpenSSL.org.\r
+ *\r
+ * 5. Products derived from this software may not be called "OpenSSL"\r
+ *    nor may "OpenSSL" appear in their names without prior written\r
+ *    permission of the OpenSSL Project.\r
+ *\r
+ * 6. Redistributions of any form whatsoever must retain the following\r
+ *    acknowledgment:\r
+ *    "This product includes software developed by the OpenSSL Project\r
+ *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"\r
+ *\r
+ * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY\r
+ * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\r
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR\r
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\r
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,\r
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED\r
+ * OF THE POSSIBILITY OF SUCH DAMAGE.\r
+ * ====================================================================\r
+ *\r
+ * This product includes cryptographic software written by Eric Young\r
+ * (eay@cryptsoft.com).  This product includes software written by Tim\r
+ * Hudson (tjh@cryptsoft.com).\r
+ *\r
+ */\r
+\r
+#ifndef HEADER_DTLS1_H\r
+#define HEADER_DTLS1_H\r
+\r
+#include <openssl/buffer.h>\r
+#include <openssl/pqueue.h>\r
+#ifdef OPENSSL_SYS_VMS\r
+#include <resource.h>\r
+#include <sys/timeb.h>\r
+#endif\r
+#ifdef OPENSSL_SYS_WIN32\r
+/* Needed for struct timeval */\r
+#include <winsock.h>\r
+#elif defined(OPENSSL_SYS_NETWARE) && !defined(_WINSOCK2API_)\r
+#include <sys/timeval.h>\r
+#else\r
+#include <sys/time.h>\r
+#endif\r
+\r
+#ifdef  __cplusplus\r
+extern "C" {\r
+#endif\r
+\r
+#define DTLS1_VERSION                  0xFEFF\r
+#define DTLS1_BAD_VER                  0x0100\r
+\r
+#if 0\r
+/* this alert description is not specified anywhere... */\r
+#define DTLS1_AD_MISSING_HANDSHAKE_MESSAGE    110\r
+#endif\r
+\r
+/* lengths of messages */\r
+#define DTLS1_COOKIE_LENGTH                     256\r
+\r
+#define DTLS1_RT_HEADER_LENGTH                  13\r
+\r
+#define DTLS1_HM_HEADER_LENGTH                  12\r
+\r
+#define DTLS1_HM_BAD_FRAGMENT                   -2\r
+#define DTLS1_HM_FRAGMENT_RETRY                 -3\r
+\r
+#define DTLS1_CCS_HEADER_LENGTH                  1\r
+\r
+#ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE\r
+#define DTLS1_AL_HEADER_LENGTH                   7\r
+#else\r
+#define DTLS1_AL_HEADER_LENGTH                   2\r
+#endif\r
+\r
+\r
+typedef struct dtls1_bitmap_st\r
+       {\r
+       unsigned long map;              /* track 32 packets on 32-bit systems\r
+                                          and 64 - on 64-bit systems */\r
+       unsigned char max_seq_num[8];   /* max record number seen so far,\r
+                                          64-bit value in big-endian\r
+                                          encoding */\r
+       } DTLS1_BITMAP;\r
+\r
+struct dtls1_retransmit_state\r
+       {\r
+       EVP_CIPHER_CTX *enc_write_ctx;  /* cryptographic state */\r
+       EVP_MD_CTX *write_hash;                 /* used for mac generation */\r
+#ifndef OPENSSL_NO_COMP\r
+       COMP_CTX *compress;                             /* compression */\r
+#else\r
+       char *compress;\r
+#endif\r
+       SSL_SESSION *session;\r
+       unsigned short epoch;\r
+       };\r
+\r
+struct hm_header_st\r
+       {\r
+       unsigned char type;\r
+       unsigned long msg_len;\r
+       unsigned short seq;\r
+       unsigned long frag_off;\r
+       unsigned long frag_len;\r
+       unsigned int is_ccs;\r
+       struct dtls1_retransmit_state saved_retransmit_state;\r
+       };\r
+\r
+struct ccs_header_st\r
+       {\r
+       unsigned char type;\r
+       unsigned short seq;\r
+       };\r
+\r
+struct dtls1_timeout_st\r
+       {\r
+       /* Number of read timeouts so far */\r
+       unsigned int read_timeouts;\r
+\r
+       /* Number of write timeouts so far */\r
+       unsigned int write_timeouts;\r
+\r
+       /* Number of alerts received so far */\r
+       unsigned int num_alerts;\r
+       };\r
+\r
+typedef struct record_pqueue_st\r
+       {\r
+       unsigned short epoch;\r
+       pqueue q;\r
+       } record_pqueue;\r
+\r
+typedef struct hm_fragment_st\r
+       {\r
+       struct hm_header_st msg_header;\r
+       unsigned char *fragment;\r
+       unsigned char *reassembly;\r
+       } hm_fragment;\r
+\r
+typedef struct dtls1_state_st\r
+       {\r
+       unsigned int send_cookie;\r
+       unsigned char cookie[DTLS1_COOKIE_LENGTH];\r
+       unsigned char rcvd_cookie[DTLS1_COOKIE_LENGTH];\r
+       unsigned int cookie_len;\r
+\r
+       /*\r
+        * The current data and handshake epoch.  This is initially\r
+        * undefined, and starts at zero once the initial handshake is\r
+        * completed\r
+        */\r
+       unsigned short r_epoch;\r
+       unsigned short w_epoch;\r
+\r
+       /* records being received in the current epoch */\r
+       DTLS1_BITMAP bitmap;\r
+\r
+       /* renegotiation starts a new set of sequence numbers */\r
+       DTLS1_BITMAP next_bitmap;\r
+\r
+       /* handshake message numbers */\r
+       unsigned short handshake_write_seq;\r
+       unsigned short next_handshake_write_seq;\r
+\r
+       unsigned short handshake_read_seq;\r
+\r
+       /* save last sequence number for retransmissions */\r
+       unsigned char last_write_sequence[8];\r
+\r
+       /* Received handshake records (processed and unprocessed) */\r
+       record_pqueue unprocessed_rcds;\r
+       record_pqueue processed_rcds;\r
+\r
+       /* Buffered handshake messages */\r
+       pqueue buffered_messages;\r
+\r
+       /* Buffered (sent) handshake records */\r
+       pqueue sent_messages;\r
+\r
+       /* Buffered application records.\r
+        * Only for records between CCS and Finished\r
+        * to prevent either protocol violation or\r
+        * unnecessary message loss.\r
+        */\r
+       record_pqueue buffered_app_data;\r
+\r
+       /* Is set when listening for new connections with dtls1_listen() */\r
+       unsigned int listen;\r
+\r
+       unsigned int mtu; /* max DTLS packet size */\r
+\r
+       struct hm_header_st w_msg_hdr;\r
+       struct hm_header_st r_msg_hdr;\r
+\r
+       struct dtls1_timeout_st timeout;\r
+\r
+       /* Indicates when the last handshake msg sent will timeout */\r
+       struct timeval next_timeout;\r
+\r
+       /* Timeout duration */\r
+       unsigned short timeout_duration;\r
+\r
+       /* storage for Alert/Handshake protocol data received but not\r
+        * yet processed by ssl3_read_bytes: */\r
+       unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH];\r
+       unsigned int alert_fragment_len;\r
+       unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH];\r
+       unsigned int handshake_fragment_len;\r
+\r
+       unsigned int retransmitting;\r
+       unsigned int change_cipher_spec_ok;\r
+\r
+       } DTLS1_STATE;\r
+\r
+typedef struct dtls1_record_data_st\r
+       {\r
+       unsigned char *packet;\r
+       unsigned int   packet_length;\r
+       SSL3_BUFFER    rbuf;\r
+       SSL3_RECORD    rrec;\r
+       } DTLS1_RECORD_DATA;\r
+\r
+\r
+/* Timeout multipliers (timeout slice is defined in apps/timeouts.h */\r
+#define DTLS1_TMO_READ_COUNT                      2\r
+#define DTLS1_TMO_WRITE_COUNT                     2\r
+\r
+#define DTLS1_TMO_ALERT_COUNT                     12\r
+\r
+#ifdef  __cplusplus\r
+}\r
+#endif\r
+#endif\r
+\r