blob: 6aa34fa33861b9b6e09126f3485dc5136d52f5f0 [file] [log] [blame]
Willy Tarreau55994562019-05-09 14:52:44 +02001#ifndef _COMMON_OPENSSL_COMPAT_H
2#define _COMMON_OPENSSL_COMPAT_H
Willy Tarreauc125cef2019-05-10 09:58:43 +02003#ifdef USE_OPENSSL
Willy Tarreau8d164dc2019-05-10 09:35:00 +02004
5#include <openssl/bn.h>
Dirkjan Bussink1866d6d2016-08-29 13:26:37 +02006#include <openssl/crypto.h>
7#include <openssl/ssl.h>
8#include <openssl/x509.h>
9#include <openssl/x509v3.h>
Dirkjan Bussink1866d6d2016-08-29 13:26:37 +020010#include <openssl/err.h>
11#include <openssl/rand.h>
Willy Tarreau8d164dc2019-05-10 09:35:00 +020012#include <openssl/hmac.h>
Dirkjan Bussink1866d6d2016-08-29 13:26:37 +020013#if (defined SSL_CTRL_SET_TLSEXT_STATUS_REQ_CB && !defined OPENSSL_NO_OCSP)
14#include <openssl/ocsp.h>
15#endif
16#ifndef OPENSSL_NO_DH
17#include <openssl/dh.h>
18#endif
Willy Tarreau8d164dc2019-05-10 09:35:00 +020019#ifndef OPENSSL_NO_ENGINE
20#include <openssl/engine.h>
21#endif
22
23#if (OPENSSL_VERSION_NUMBER >= 0x1010000fL) && !defined(OPENSSL_NO_ASYNC) && !defined(LIBRESSL_VERSION_NUMBER)
24#include <openssl/async.h>
25#endif
Dirkjan Bussink1866d6d2016-08-29 13:26:37 +020026
Willy Tarreau1d158ab2019-05-09 13:41:45 +020027#if defined(LIBRESSL_VERSION_NUMBER)
28/* LibreSSL is a fork of OpenSSL 1.0.1g but pretends to be 2.0.0, thus
29 * systematically breaking when some code is written for a specific version
30 * of OpenSSL. Let's make it appear like what it really is and deal with
31 * extra features with ORs and not with AND NOT.
32 */
33#define HA_OPENSSL_VERSION_NUMBER 0x1000107fL
34#else /* this is for a real OpenSSL or a truly compatible derivative */
Willy Tarreau9a1ab082019-05-09 13:26:41 +020035#define HA_OPENSSL_VERSION_NUMBER OPENSSL_VERSION_NUMBER
Willy Tarreau1d158ab2019-05-09 13:41:45 +020036#endif
Willy Tarreau9a1ab082019-05-09 13:26:41 +020037
Willy Tarreau9356dac2019-05-10 09:22:53 +020038#ifndef OPENSSL_VERSION
39#define OPENSSL_VERSION SSLEAY_VERSION
40#define OpenSSL_version(x) SSLeay_version(x)
41#define OpenSSL_version_num SSLeay
42#endif
43
Willy Tarreau9a1ab082019-05-09 13:26:41 +020044#if (HA_OPENSSL_VERSION_NUMBER < 0x0090800fL)
Willy Tarreau80ebacf2016-11-24 20:07:11 +010045/* Functions present in OpenSSL 0.9.8, older not tested */
Dirkjan Bussink1866d6d2016-08-29 13:26:37 +020046static inline const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *sess, unsigned int *sid_length)
47{
48 *sid_length = sess->session_id_length;
49 return sess->session_id;
50}
51
52static inline X509_NAME_ENTRY *X509_NAME_get_entry(const X509_NAME *name, int loc)
53{
54 return sk_X509_NAME_ENTRY_value(name->entries, loc);
55}
56
57static inline ASN1_OBJECT *X509_NAME_ENTRY_get_object(const X509_NAME_ENTRY *ne)
58{
59 return ne->object;
60}
61
62static inline ASN1_STRING *X509_NAME_ENTRY_get_data(const X509_NAME_ENTRY *ne)
63{
64 return ne->value;
65}
66
67static inline int ASN1_STRING_length(const ASN1_STRING *x)
68{
69 return x->length;
70}
71
72static inline int X509_NAME_entry_count(X509_NAME *name)
73{
74 return sk_X509_NAME_ENTRY_num(name->entries)
75}
76
Willy Tarreau80ebacf2016-11-24 20:07:11 +010077static inline void X509_ALGOR_get0(ASN1_OBJECT **paobj, int *pptype, const void **ppval, const X509_ALGOR *algor)
Dirkjan Bussink1866d6d2016-08-29 13:26:37 +020078{
Willy Tarreau80ebacf2016-11-24 20:07:11 +010079 *paobj = algor->algorithm;
80}
81
82#endif // OpenSSL < 0.9.8
83
84
Willy Tarreau9a1ab082019-05-09 13:26:41 +020085#if (HA_OPENSSL_VERSION_NUMBER < 0x1000000fL)
Willy Tarreau2b3205b2017-01-19 17:04:02 +010086/* Functions introduced in OpenSSL 1.0.0 */
Willy Tarreau80ebacf2016-11-24 20:07:11 +010087static inline int EVP_PKEY_base_id(const EVP_PKEY *pkey)
Dirkjan Bussink1866d6d2016-08-29 13:26:37 +020088{
Willy Tarreau80ebacf2016-11-24 20:07:11 +010089 return EVP_PKEY_type(pkey->type);
90}
91
92/* minimal implementation based on the fact that the only known call place
93 * doesn't make use of other arguments.
94 */
95static inline int X509_PUBKEY_get0_param(ASN1_OBJECT **ppkalg, const unsigned char **pk, int *ppklen, X509_ALGOR **pa, X509_PUBKEY *pub)
96{
97 *ppkalg = pub->algor->algorithm;
98 return 1;
Dirkjan Bussink1866d6d2016-08-29 13:26:37 +020099}
100
101#ifndef X509_get_X509_PUBKEY
102#define X509_get_X509_PUBKEY(x) ((x)->cert_info->key
103#endif
104
105#endif
106
Willy Tarreau9a1ab082019-05-09 13:26:41 +0200107#if (HA_OPENSSL_VERSION_NUMBER < 0x1000100fL)
Willy Tarreau2b3205b2017-01-19 17:04:02 +0100108/*
109 * Functions introduced in OpenSSL 1.0.1
110 */
111static inline int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx, unsigned int sid_ctx_len)
112{
113 s->sid_ctx_length = sid_ctx_len;
114 memcpy(s->sid_ctx, sid_ctx, sid_ctx_len);
115 return 1;
116}
117#endif
118
Willy Tarreau1d158ab2019-05-09 13:41:45 +0200119#if (HA_OPENSSL_VERSION_NUMBER < 0x1010000fL) && (LIBRESSL_VERSION_NUMBER < 0x2070000fL)
Dirkjan Bussink1866d6d2016-08-29 13:26:37 +0200120/*
Ilya Shipitsin54832b92019-05-05 23:27:54 +0500121 * Functions introduced in OpenSSL 1.1.0 and in LibreSSL 2.7.0
Dirkjan Bussink1866d6d2016-08-29 13:26:37 +0200122 */
123
124static inline const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *sess, unsigned int *sid_ctx_length)
125{
126 *sid_ctx_length = sess->sid_ctx_length;
127 return sess->sid_ctx;
128}
129
130static inline int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid, unsigned int sid_len)
131{
132 s->session_id_length = sid_len;
133 memcpy(s->session_id, sid, sid_len);
134 return 1;
135}
136
Emmanuel Hocdet019f9b12017-10-02 17:12:06 +0200137static inline X509_ALGOR *X509_get0_tbs_sigalg(const X509 *x)
138{
139 return x->cert_info->signature;
140}
141
Emmanuel Hocdetfdec7892017-01-13 17:48:18 +0100142#if (!defined OPENSSL_NO_OCSP)
Dirkjan Bussink1866d6d2016-08-29 13:26:37 +0200143static inline const OCSP_CERTID *OCSP_SINGLERESP_get0_id(const OCSP_SINGLERESP *single)
144{
145 return single->certId;
146}
Emmanuel Hocdetfdec7892017-01-13 17:48:18 +0100147#endif
Dirkjan Bussink1866d6d2016-08-29 13:26:37 +0200148
149static inline pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
150{
151 return ctx->default_passwd_callback;
152}
153
154static inline void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
155{
156 return ctx->default_passwd_callback_userdata;
157}
158
159#ifndef OPENSSL_NO_DH
160static inline int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g)
161{
162 /* Implements only the bare necessities for HAProxy */
163 dh->p = p;
164 dh->g = g;
165 return 1;
166}
167#endif
168
169static inline const unsigned char *ASN1_STRING_get0_data(const ASN1_STRING *x)
170{
171 return x->data;
172}
173
Dirkjan Bussink1866d6d2016-08-29 13:26:37 +0200174#endif
175
Willy Tarreau1d158ab2019-05-09 13:41:45 +0200176#if (HA_OPENSSL_VERSION_NUMBER >= 0x1010000fL) || (LIBRESSL_VERSION_NUMBER >= 0x2070200fL)
Dirkjan Bussink1866d6d2016-08-29 13:26:37 +0200177#define __OPENSSL_110_CONST__ const
178#else
179#define __OPENSSL_110_CONST__
180#endif
181
Willy Tarreaua4fb8ed2017-01-19 16:50:25 +0100182/* ERR_remove_state() was deprecated in 1.0.0 in favor of
183 * ERR_remove_thread_state(), which was in turn deprecated in
184 * 1.1.0 and does nothing anymore. Let's simply silently kill
185 * it.
186 */
Willy Tarreau9a1ab082019-05-09 13:26:41 +0200187#if (HA_OPENSSL_VERSION_NUMBER >= 0x1010000fL)
Willy Tarreaua4fb8ed2017-01-19 16:50:25 +0100188#undef ERR_remove_state
189#define ERR_remove_state(x)
190#endif
191
Willy Tarreau77d88da2017-01-19 17:10:54 +0100192
193/* RAND_pseudo_bytes() is deprecated in 1.1.0 in favor of RAND_bytes(). Note
194 * that the return codes differ, but it happens that the only use case (ticket
195 * key update) was already wrong, considering a non-cryptographic random as a
196 * failure.
197 */
Willy Tarreau9a1ab082019-05-09 13:26:41 +0200198#if (HA_OPENSSL_VERSION_NUMBER >= 0x1010000fL)
Willy Tarreau77d88da2017-01-19 17:10:54 +0100199#undef RAND_pseudo_bytes
200#define RAND_pseudo_bytes(x,y) RAND_bytes(x,y)
201#endif
202
Emmanuel Hocdet8c2ddc22017-07-19 16:04:05 +0200203
204/* Signature from RFC 5246, missing in openssl < 1.0.1 */
205#ifndef TLSEXT_signature_anonymous
206#define TLSEXT_signature_anonymous 0
207#define TLSEXT_signature_rsa 1
208#define TLSEXT_signature_dsa 2
209#define TLSEXT_signature_ecdsa 3
210#endif
211
Willy Tarreau9356dac2019-05-10 09:22:53 +0200212#if (OPENSSL_VERSION_NUMBER < 0x10100000L) || (LIBRESSL_VERSION_NUMBER < 0x20700000L)
213#define X509_getm_notBefore X509_get_notBefore
214#define X509_getm_notAfter X509_get_notAfter
215#endif
216
217#if (OPENSSL_VERSION_NUMBER < 0x1010000fL || defined LIBRESSL_VERSION_NUMBER)
218#define EVP_CTRL_AEAD_SET_IVLEN EVP_CTRL_GCM_SET_IVLEN
219#define EVP_CTRL_AEAD_SET_TAG EVP_CTRL_GCM_SET_TAG
220#endif
221
222/* Supported hash function for TLS tickets */
223#ifdef OPENSSL_NO_SHA256
224#define TLS_TICKET_HASH_FUNCT EVP_sha1
225#else
226#define TLS_TICKET_HASH_FUNCT EVP_sha256
227#endif /* OPENSSL_NO_SHA256 */
228
Willy Tarreau366a6982019-05-11 17:09:44 +0200229#ifndef SSL_OP_CIPHER_SERVER_PREFERENCE /* needs OpenSSL >= 0.9.7 */
230#define SSL_OP_CIPHER_SERVER_PREFERENCE 0
231#endif
232
233#ifndef SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION /* needs OpenSSL >= 0.9.7 */
234#define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION 0
235#define SSL_renegotiate_pending(arg) 0
236#endif
237
238#ifndef SSL_OP_SINGLE_ECDH_USE /* needs OpenSSL >= 0.9.8 */
239#define SSL_OP_SINGLE_ECDH_USE 0
240#endif
241
242#ifndef SSL_OP_NO_TICKET /* needs OpenSSL >= 0.9.8 */
243#define SSL_OP_NO_TICKET 0
244#endif
245
246#ifndef SSL_OP_NO_COMPRESSION /* needs OpenSSL >= 0.9.9 */
247#define SSL_OP_NO_COMPRESSION 0
248#endif
249
250#ifdef OPENSSL_NO_SSL3 /* SSLv3 support removed */
251#undef SSL_OP_NO_SSLv3
252#define SSL_OP_NO_SSLv3 0
253#endif
254
255#ifndef SSL_OP_NO_TLSv1_1 /* needs OpenSSL >= 1.0.1 */
256#define SSL_OP_NO_TLSv1_1 0
257#endif
258
259#ifndef SSL_OP_NO_TLSv1_2 /* needs OpenSSL >= 1.0.1 */
260#define SSL_OP_NO_TLSv1_2 0
261#endif
262
263#ifndef SSL_OP_NO_TLSv1_3 /* needs OpenSSL >= 1.1.1 */
264#define SSL_OP_NO_TLSv1_3 0
265#endif
266
267#ifndef SSL_OP_SINGLE_DH_USE /* needs OpenSSL >= 0.9.6 */
268#define SSL_OP_SINGLE_DH_USE 0
269#endif
270
271#ifndef SSL_OP_SINGLE_ECDH_USE /* needs OpenSSL >= 1.0.0 */
272#define SSL_OP_SINGLE_ECDH_USE 0
273#endif
274
275#ifndef SSL_MODE_RELEASE_BUFFERS /* needs OpenSSL >= 1.0.0 */
276#define SSL_MODE_RELEASE_BUFFERS 0
277#endif
278
279#ifndef SSL_MODE_SMALL_BUFFERS /* needs small_records.patch */
280#define SSL_MODE_SMALL_BUFFERS 0
281#endif
282
283#ifndef SSL_OP_PRIORITIZE_CHACHA /* needs OpenSSL >= 1.1.1 */
284#define SSL_OP_PRIORITIZE_CHACHA 0
285#endif
286
Willy Tarreau11b16712019-05-11 17:02:04 +0200287#ifndef SSL_CTRL_GET_EXTRA_CHAIN_CERTS
288#define SSL_CTX_get_extra_chain_certs(ctx, chain) do { *(chain) = (ctx)->extra_certs; } while (0)
289#endif
290
Willy Tarreau295d6142019-05-11 17:34:03 +0200291#if HA_OPENSSL_VERSION_NUMBER < 0x10100000L
292#define BIO_get_data(b) (b)->ptr
293#define BIO_set_data(b, v) do { (b)->ptr = (v); } while (0)
294#define BIO_set_init(b, v) do { (b)->init = (v); } while (0)
295
296#define BIO_meth_free(m) free(m)
297#define BIO_meth_new(type, name) calloc(1, sizeof(BIO_METHOD))
298#define BIO_meth_set_gets(m, f) do { (m)->bgets = (f); } while (0)
299#define BIO_meth_set_puts(m, f) do { (m)->bputs = (f); } while (0)
300#define BIO_meth_set_read(m, f) do { (m)->bread = (f); } while (0)
301#define BIO_meth_set_write(m, f) do { (m)->bwrite = (f); } while (0)
302#define BIO_meth_set_create(m, f) do { (m)->create = (f); } while (0)
303#define BIO_meth_set_ctrl(m, f) do { (m)->ctrl = (f); } while (0)
304#define BIO_meth_set_destroy(m, f) do { (m)->destroy = (f); } while (0)
305#endif
306
Willy Tarreauc125cef2019-05-10 09:58:43 +0200307#endif /* USE_OPENSSL */
Willy Tarreau55994562019-05-09 14:52:44 +0200308#endif /* _COMMON_OPENSSL_COMPAT_H */