Provide framework for auto initialise/deinitialise of the library
[openssl.git] / include / openssl / dtls1.h
1 /*
2  * DTLS implementation written by Nagendra Modadugu
3  * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.
4  */
5 /* ====================================================================
6  * Copyright (c) 1999-2005 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    openssl-core@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  *
53  * This product includes cryptographic software written by Eric Young
54  * (eay@cryptsoft.com).  This product includes software written by Tim
55  * Hudson (tjh@cryptsoft.com).
56  *
57  */
58
59 #ifndef HEADER_DTLS1_H
60 # define HEADER_DTLS1_H
61
62 #ifdef  __cplusplus
63 extern "C" {
64 #endif
65
66 # define DTLS1_VERSION                   0xFEFF
67 # define DTLS1_2_VERSION                 0xFEFD
68 # define DTLS_MIN_VERSION                DTLS1_VERSION
69 # define DTLS_MAX_VERSION                DTLS1_2_VERSION
70 # define DTLS1_VERSION_MAJOR             0xFE
71
72 # define DTLS1_BAD_VER                   0x0100
73
74 /* Special value for method supporting multiple versions */
75 # define DTLS_ANY_VERSION                0x1FFFF
76
77 /* lengths of messages */
78 # define DTLS1_COOKIE_LENGTH                     256
79
80 # define DTLS1_RT_HEADER_LENGTH                  13
81
82 # define DTLS1_HM_HEADER_LENGTH                  12
83
84 # define DTLS1_HM_BAD_FRAGMENT                   -2
85 # define DTLS1_HM_FRAGMENT_RETRY                 -3
86
87 # define DTLS1_CCS_HEADER_LENGTH                  1
88
89 # ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
90 #  define DTLS1_AL_HEADER_LENGTH                   7
91 # else
92 #  define DTLS1_AL_HEADER_LENGTH                   2
93 # endif
94
95
96 /* Timeout multipliers (timeout slice is defined in apps/timeouts.h */
97 # define DTLS1_TMO_READ_COUNT                      2
98 # define DTLS1_TMO_WRITE_COUNT                     2
99
100 # define DTLS1_TMO_ALERT_COUNT                     12
101
102 #ifdef  __cplusplus
103 }
104 #endif
105 #endif