make depend
[openssl.git] / ssl / dtls1.h
index e3b6ad5ff24078ffc21320fdc5ff41212be5daf1..542ae04627b59b8b7840fa776e9cfe2ad9059bbd 100644 (file)
@@ -1,7 +1,7 @@
 /* ssl/dtls1.h */
-/* 
+/*
  * DTLS implementation written by Nagendra Modadugu
- * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.  
+ * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.
  */
 /* ====================================================================
  * Copyright (c) 1999-2005 The OpenSSL Project.  All rights reserved.
@@ -11,7 +11,7 @@
  * are met:
  *
  * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer. 
+ *    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
  *
  */
 
-#ifndef HEADER_DTLS1_H 
-#define HEADER_DTLS1_H 
-
-#include <openssl/buffer.h>
-#include <openssl/pqueue.h>
+#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
+#  if defined(OPENSSL_SYS_VXWORKS)
+#   include <sys/times.h>
+#  else
+#   include <sys/time.h>
+#  endif
+# endif
 
 #ifdef  __cplusplus
 extern "C" {
 #endif
 
-#define DTLS1_ALLOW_EXPERIMENTAL_CIPHERSUITES  1
+# define DTLS1_VERSION                   0xFEFF
+# define DTLS1_2_VERSION                 0xFEFD
+# define DTLS_MAX_VERSION                DTLS1_2_VERSION
+# define DTLS1_VERSION_MAJOR             0xFE
 
-#define DTLS1_VERSION                  0x0100
-#define DTLS1_VERSION_MAJOR            0x01
-#define DTLS1_VERSION_MINOR            0x00
+# define DTLS1_BAD_VER                   0x0100
 
-#define DTLS1_AD_MISSING_HANDSHAKE_MESSAGE    110
+/* Special value for method supporting multiple versions */
+# define DTLS_ANY_VERSION                0x1FFFF
 
 /* lengths of messages */
-#define DTLS1_COOKIE_LENGTH                     32
-
-#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                  3
-
-#define DTLS1_AL_HEADER_LENGTH                   7
-
-
-typedef struct dtls1_bitmap_st
-       {
-       unsigned long long map;
-       unsigned long length;     /* sizeof the bitmap in bits */
-       unsigned long long max_seq_num;  /* max record number seen so far */
-       } DTLS1_BITMAP;
-
-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 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;
-    } 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;
-
-    /* only matters for handshake messages */  
-       unsigned long long next_expected_seq_num; 
-
-       /* 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;
-
-       unsigned int mtu; /* max wire packet size */
-
-       struct hm_header_st w_msg_hdr;
-       struct hm_header_st r_msg_hdr;
-
-       struct dtls1_timeout_st timeout;
-       
-       /* 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;
-
-       } DTLS1_STATE;
-
-typedef struct dtls1_record_data_st
-       {
-       unsigned char *packet;
-       unsigned int   packet_length;
-       SSL3_BUFFER    rbuf;
-       SSL3_RECORD    rrec;
-       } DTLS1_RECORD_DATA;
-
-/* client methods */
-int dtls1_client_hello(SSL *s);
-int dtls1_send_client_certificate(SSL *s);
-int dtls1_send_client_key_exchange(SSL *s);
-int dtls1_send_client_verify(SSL *s);
-
-
-/* server methods */
-int dtls1_send_hello_request(SSL *s);
-int dtls1_send_server_hello(SSL *s);
-int dtls1_send_server_certificate(SSL *s);
-int dtls1_send_server_key_exchange(SSL *s);
-int dtls1_send_certificate_request(SSL *s);
-int dtls1_send_server_done(SSL *s);
-
-/* common methods */
-int dtls1_send_change_cipher_spec(SSL *s, int a, int b);
-int dtls1_send_finished(SSL *s, int a, int b, const char *sender, int slen);
-unsigned long dtls1_output_cert_chain(SSL *s, X509 *x);
-int dtls1_read_failed(SSL *s, int code);
-int dtls1_buffer_message(SSL *s, int ccs);
-int dtls1_retransmit_message(SSL *s, unsigned short seq, 
-       unsigned long frag_off, int *found);
-void dtls1_clear_record_buffer(SSL *s);
-void dtls1_get_message_header(unsigned char *data, struct hm_header_st *msg_hdr);
-void dtls1_get_ccs_header(unsigned char *data, struct ccs_header_st *ccs_hdr);
-void dtls1_reset_seq_numbers(SSL *s, int rw);
+# 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
+
 
 /* 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_READ_COUNT                      2
+# define DTLS1_TMO_WRITE_COUNT                     2
 
-#define DTLS1_TMO_ALERT_COUNT                     12
+# define DTLS1_TMO_ALERT_COUNT                     12
 
 #ifdef  __cplusplus
 }
 #endif
 #endif
-