blob: d6d01a7a27859292c7c0972b248717bc7a042a00 [file] [log] [blame]
Emeric Brun46591952012-05-18 15:47:34 +02001/*
2 * include/proto/ssl_sock.h
3 * This file contains definition for ssl stream socket operations
4 *
5 * Copyright (C) 2012 EXCELIANCE, Emeric Brun <ebrun@exceliance.fr>
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22#ifndef _PROTO_SSL_SOCK_H
23#define _PROTO_SSL_SOCK_H
Willy Tarreauc125cef2019-05-10 09:58:43 +020024#ifdef USE_OPENSSL
25
Willy Tarreau8d164dc2019-05-10 09:35:00 +020026#include <common/openssl-compat.h>
Emeric Brun46591952012-05-18 15:47:34 +020027
Willy Tarreaud1d54542012-09-12 22:58:11 +020028#include <types/connection.h>
29#include <types/listener.h>
30#include <types/proxy.h>
Emeric Brun46591952012-05-18 15:47:34 +020031#include <types/stream_interface.h>
32
Willy Tarreauc125cef2019-05-10 09:58:43 +020033#include <proto/connection.h>
34
Willy Tarreau71b734c2014-01-28 15:19:44 +010035extern int sslconns;
36extern int totalsslconns;
37
David Safb76832014-05-08 23:42:08 -040038/* boolean, returns true if connection is over SSL */
39static inline
40int ssl_sock_is_ssl(struct connection *conn)
41{
Willy Tarreaud9f5cca2016-12-22 21:08:52 +010042 if (!conn || conn->xprt != xprt_get(XPRT_SSL) || !conn->xprt_ctx)
David Safb76832014-05-08 23:42:08 -040043 return 0;
44 else
45 return 1;
46}
47
Emmanuel Hocdet98263292016-12-29 18:26:15 +010048int ssl_sock_prepare_ctx(struct bind_conf *bind_conf, struct ssl_bind_conf *, SSL_CTX *ctx);
Willy Tarreau03209342016-12-22 17:08:28 +010049int ssl_sock_prepare_all_ctx(struct bind_conf *bind_conf);
Willy Tarreau55d37912016-12-21 23:38:39 +010050int ssl_sock_prepare_bind_conf(struct bind_conf *bind_conf);
Willy Tarreau03209342016-12-22 17:08:28 +010051int ssl_sock_prepare_srv_ctx(struct server *srv);
Christopher Faulet77fe80c2015-07-29 13:02:40 +020052void ssl_sock_free_srv_ctx(struct server *srv);
Willy Tarreau2a65ff02012-09-13 17:54:29 +020053void ssl_sock_free_all_ctx(struct bind_conf *bind_conf);
Willy Tarreau03209342016-12-22 17:08:28 +010054int ssl_sock_load_ca(struct bind_conf *bind_conf);
Christopher Faulet31af49d2015-06-09 17:29:50 +020055void ssl_sock_free_ca(struct bind_conf *bind_conf);
Emmanuel Hocdet253c3b72018-02-01 18:29:59 +010056const char *ssl_sock_get_sni(struct connection *conn);
Emmanuel Hocdet283e0042017-11-02 14:05:23 +010057const char *ssl_sock_get_cert_sig(struct connection *conn);
Willy Tarreauffc3fcd2012-10-12 20:17:54 +020058const char *ssl_sock_get_cipher_name(struct connection *conn);
59const char *ssl_sock_get_proto_version(struct connection *conn);
Olivier Houchardab28a322018-12-21 19:45:40 +010060void ssl_sock_set_alpn(struct connection *conn, const unsigned char *, int);
Willy Tarreau63076412015-07-10 11:33:32 +020061void ssl_sock_set_servername(struct connection *conn, const char *hostname);
Olivier Houchardab28a322018-12-21 19:45:40 +010062
Dave McCowan328fb582014-07-30 10:39:13 -040063int ssl_sock_get_cert_used_sess(struct connection *conn);
64int ssl_sock_get_cert_used_conn(struct connection *conn);
Willy Tarreau83061a82018-07-13 11:56:34 +020065int ssl_sock_get_remote_common_name(struct connection *conn,
66 struct buffer *out);
67int ssl_sock_get_pkey_algo(struct connection *conn, struct buffer *out);
David Safb76832014-05-08 23:42:08 -040068unsigned int ssl_sock_get_verify_result(struct connection *conn);
Lukas Tribuse4e30f72014-12-09 16:32:51 +010069#if (defined SSL_CTRL_SET_TLSEXT_STATUS_REQ_CB && !defined OPENSSL_NO_OCSP)
Willy Tarreau83061a82018-07-13 11:56:34 +020070int ssl_sock_update_ocsp_response(struct buffer *ocsp_response, char **err);
Emeric Brun4147b2e2014-06-16 18:36:30 +020071#endif
Nenad Merdanovic200b0fa2015-05-09 08:46:01 +020072#if (defined SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB && TLS_TICKETS_NO > 0)
Emeric Brun9e754772019-01-10 17:51:55 +010073int ssl_sock_update_tlskey_ref(struct tls_keys_ref *ref,
Willy Tarreau83061a82018-07-13 11:56:34 +020074 struct buffer *tlskey);
75int ssl_sock_update_tlskey(char *filename, struct buffer *tlskey, char **err);
Nenad Merdanovic200b0fa2015-05-09 08:46:01 +020076struct tls_keys_ref *tlskeys_ref_lookup(const char *filename);
77struct tls_keys_ref *tlskeys_ref_lookupid(int unique_id);
Nenad Merdanovic200b0fa2015-05-09 08:46:01 +020078#endif
Remi Gacogne47783ef2015-05-29 15:53:22 +020079#ifndef OPENSSL_NO_DH
80int ssl_sock_load_global_dh_param_from_file(const char *filename);
Grant Zhang872f9c22017-01-21 01:10:18 +000081void ssl_free_dh(void);
Remi Gacogne47783ef2015-05-29 15:53:22 +020082#endif
Grant Zhang872f9c22017-01-21 01:10:18 +000083void ssl_free_engines(void);
Emeric Brun46591952012-05-18 15:47:34 +020084
Christopher Faulet635c0ad2015-11-12 11:35:51 +010085SSL_CTX *ssl_sock_create_cert(struct connection *conn, const char *servername, unsigned int key);
Emeric Brun821bb9b2017-06-15 16:37:39 +020086SSL_CTX *ssl_sock_assign_generated_cert(unsigned int key, struct bind_conf *bind_conf, SSL *ssl);
Christopher Faulet635c0ad2015-11-12 11:35:51 +010087SSL_CTX *ssl_sock_get_generated_cert(unsigned int key, struct bind_conf *bind_conf);
88int ssl_sock_set_generated_cert(SSL_CTX *ctx, unsigned int key, struct bind_conf *bind_conf);
89unsigned int ssl_sock_generated_cert_key(const void *data, size_t len);
Christopher Faulet30548802015-06-11 13:39:32 +020090
Willy Tarreau9a1ab082019-05-09 13:26:41 +020091#if (HA_OPENSSL_VERSION_NUMBER >= 0x1010000fL) && !defined(OPENSSL_NO_ASYNC) && !defined(LIBRESSL_VERSION_NUMBER)
Emeric Brund0e095c2019-04-19 17:15:28 +020092void ssl_async_fd_handler(int fd);
93void ssl_async_fd_free(int fd);
94#endif
William Lallemanded0b5ad2017-10-30 19:36:36 +010095
96/* ssl shctx macro */
97
William Lallemand4f45bb92017-10-30 20:08:51 +010098#define sh_ssl_sess_tree_delete(s) ebmb_delete(&(s)->key);
William Lallemanded0b5ad2017-10-30 19:36:36 +010099
William Lallemand4f45bb92017-10-30 20:08:51 +0100100#define sh_ssl_sess_tree_insert(s) (struct sh_ssl_sess_hdr *)ebmb_insert(sh_ssl_sess_tree, \
101 &(s)->key, SSL_MAX_SSL_SESSION_ID_LENGTH);
William Lallemanded0b5ad2017-10-30 19:36:36 +0100102
William Lallemand4f45bb92017-10-30 20:08:51 +0100103#define sh_ssl_sess_tree_lookup(k) (struct sh_ssl_sess_hdr *)ebmb_lookup(sh_ssl_sess_tree, \
104 (k), SSL_MAX_SSL_SESSION_ID_LENGTH);
Willy Tarreauc125cef2019-05-10 09:58:43 +0200105#endif /* USE_OPENSSL */
Emeric Brun46591952012-05-18 15:47:34 +0200106#endif /* _PROTO_SSL_SOCK_H */
107
108/*
109 * Local variables:
110 * c-indent-level: 8
111 * c-basic-offset: 8
112 * End:
113 */