1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
/*
* OpenVPN -- An application to securely tunnel IP networks
* over a single TCP/UDP port, with support for SSL/TLS-based
* session authentication and key exchange,
* packet encryption, packet authentication, and
* packet compression.
*
* Copyright (C) 2002-2010 OpenVPN Technologies, Inc. <sales@openvpn.net>
* Copyright (C) 2010 Fox Crypto B.V. <openvpn@fox-it.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program (see the file COPYING included with this
* distribution); if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/**
* @file Data Channel Cryptography SSL library-specific backend interface
*/
#ifndef CRYPTO_BACKEND_H_
#define CRYPTO_BACKEND_H_
#include "config.h"
#ifdef USE_OPENSSL
#include "crypto_openssl.h"
#endif
#include "basic.h"
/*
* This routine should have additional OpenSSL crypto library initialisations
* used by both crypto and ssl components of OpenVPN.
*/
void crypto_init_lib (void);
void crypto_uninit_lib (void);
void crypto_clear_error (void);
/*
* Initialise the given named crypto engine.
*/
void crypto_init_lib_engine (const char *engine_name);
#ifdef DMALLOC
/*
* OpenSSL memory debugging. If dmalloc debugging is enabled, tell
* OpenSSL to use our private malloc/realloc/free functions so that
* we can dispatch them to dmalloc.
*/
void crypto_init_dmalloc (void);
#endif /* DMALLOC */
void show_available_ciphers (void);
void show_available_digests (void);
void show_available_engines (void);
/*
*
* Random number functions, used in cases where we want
* reasonably strong cryptographic random number generation
* without depleting our entropy pool. Used for random
* IV values and a number of other miscellaneous tasks.
*
*/
/**
* Wrapper for secure random number generator. Retrieves len bytes of random
* data, and places it in output.
*
* @param output Output buffer
* @param len Length of the output buffer, in bytes
*
* @return \c 1 on success, \c 0 on failure
*/
int rand_bytes (uint8_t *output, int len);
/*
*
* Key functions, allow manipulation of keys.
*
*/
/**
* Return number of DES cblocks (1 cblock = length of a single-DES key) for the
* current key type or 0 if not a DES cipher.
*
* @param kt Type of key
*
* @return Number of DES cblocks that the key consists of, or 0.
*/
int key_des_num_cblocks (const cipher_kt_t *kt);
/*
* Check the given DES key. Checks the given key's length, weakness and parity.
*
* @param key Key to check
* @param key_len Length of the key, in bytes
* @param ndc Number of DES cblocks that the key is made up of.
*
* @return \c true if the key is valid, \c false otherwise.
*/
bool key_des_check (uint8_t *key, int key_len, int ndc);
/*
* Fix the given DES key, setting its parity to odd.
*
* @param key Key to check
* @param key_len Length of the key, in bytes
* @param ndc Number of DES cblocks that the key is made up of.
*/
void key_des_fixup (uint8_t *key, int key_len, int ndc);
/**
* Encrypt the given block, using DES ECB mode
*
* @param key DES key to use.
* @param src Buffer containing the 8-byte source.
* @param dst Buffer containing the 8-byte destination
*/
void cipher_des_encrypt_ecb (const unsigned char key[8],
unsigned char src[8],
unsigned char dst[8]);
/*
*
* Generic cipher key type functions
*
*/
/*
* Max size in bytes of any cipher key that might conceivably be used.
*
* This value is checked at compile time in crypto.c to make sure
* it is always at least EVP_MAX_KEY_LENGTH.
*
* We define our own value, since this parameter
* is used to control the size of static key files.
* If the OpenSSL library increases EVP_MAX_KEY_LENGTH,
* we don't want our key files to be suddenly rendered
* unusable.
*/
#define MAX_CIPHER_KEY_LENGTH 64
/*
*
* Generic message digest information functions
*
*/
/*
* Max size in bytes of any HMAC key that might conceivably be used.
*
* This value is checked at compile time in crypto.c to make sure
* it is always at least EVP_MAX_MD_SIZE. We define our own value
* for the same reason as above.
*/
#define MAX_HMAC_KEY_LENGTH 64
/**
* Return message digest parameters, based on the given digest name. The
* contents of these parameters are library-specific, and can be used to
* initialise HMAC or message digest operations.
*
* @param digest Name of the digest to retrieve parameters for (e.g.
* \c MD5).
*
* @return A statically allocated structure containing parameters
* for the given message digest.
*/
const md_kt_t * md_kt_get (const char *digest);
/**
* Retrieve a string describing the digest digest (e.g. \c SHA1).
*
* @param kt Static message digest parameters
*
* @return Statically allocated string describing the message
* digest.
*/
const char * md_kt_name (const md_kt_t *kt);
/**
* Returns the size of the message digest, in bytes.
*
* @param kt Static message digest parameters
*
* @return Message digest size, in bytes, or 0 if ctx was NULL.
*/
int md_kt_size (const md_kt_t *kt);
#endif /* CRYPTO_BACKEND_H_ */
|
