1 /* $OpenBSD: tls_internal.h,v 1.83 2023/06/27 18:19:59 tb Exp $ */
2 /*
3  * Copyright (c) 2014 Jeremie Courreges-Anglas <jca@openbsd.org>
4  * Copyright (c) 2014 Joel Sing <jsing@openbsd.org>
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 #ifndef HEADER_TLS_INTERNAL_H
20 #define HEADER_TLS_INTERNAL_H
21 
22 #include <arpa/inet.h>
23 #include <netinet/in.h>
24 
25 #include <openssl/ssl.h>
26 
27 #define TLS_CIPHERS_DEFAULT	TLS_CIPHERS_COMPAT
28 #define TLS_CIPHERS_COMPAT	"HIGH:!aNULL"
29 #define TLS_CIPHERS_LEGACY	"HIGH:MEDIUM:!aNULL"
30 #define TLS_CIPHERS_ALL		"ALL:!aNULL:!eNULL"
31 
32 #define TLS_ECDHE_CURVES	"X25519,P-256,P-384"
33 
34 union tls_addr {
35 	struct in_addr ip4;
36 	struct in6_addr ip6;
37 };
38 
39 struct tls_error {
40 	char *msg;
41 	int num;
42 	int tls;
43 };
44 
45 struct tls_keypair {
46 	struct tls_keypair *next;
47 
48 	char *cert_mem;
49 	size_t cert_len;
50 	char *key_mem;
51 	size_t key_len;
52 	char *ocsp_staple;
53 	size_t ocsp_staple_len;
54 	char *pubkey_hash;
55 };
56 
57 #define TLS_MIN_SESSION_TIMEOUT (4)
58 #define TLS_MAX_SESSION_TIMEOUT (24 * 60 * 60)
59 
60 #define TLS_NUM_TICKETS				4
61 #define TLS_TICKET_NAME_SIZE			16
62 #define TLS_TICKET_AES_SIZE			32
63 #define TLS_TICKET_HMAC_SIZE			16
64 
65 struct tls_ticket_key {
66 	/* The key_name must be 16 bytes according to -lssl */
67 	unsigned char	key_name[TLS_TICKET_NAME_SIZE];
68 	unsigned char	aes_key[TLS_TICKET_AES_SIZE];
69 	unsigned char	hmac_key[TLS_TICKET_HMAC_SIZE];
70 	time_t		time;
71 };
72 
73 typedef int (*tls_sign_cb)(void *_cb_arg, const char *_pubkey_hash,
74     const uint8_t *_input, size_t _input_len, int _padding_type,
75     uint8_t **_out_signature, size_t *_out_signature_len);
76 
77 struct tls_config {
78 	struct tls_error error;
79 
80 	int refcount;
81 
82 	char *alpn;
83 	size_t alpn_len;
84 	const char *ca_path;
85 	char *ca_mem;
86 	size_t ca_len;
87 	const char *ciphers;
88 	int ciphers_server;
89 	char *crl_mem;
90 	size_t crl_len;
91 	int dheparams;
92 	int *ecdhecurves;
93 	size_t ecdhecurves_len;
94 	struct tls_keypair *keypair;
95 	int ocsp_require_stapling;
96 	uint32_t protocols;
97 	unsigned char session_id[TLS_MAX_SESSION_ID_LENGTH];
98 	int session_fd;
99 	int session_lifetime;
100 	struct tls_ticket_key ticket_keys[TLS_NUM_TICKETS];
101 	uint32_t ticket_keyrev;
102 	int ticket_autorekey;
103 	int verify_cert;
104 	int verify_client;
105 	int verify_depth;
106 	int verify_name;
107 	int verify_time;
108 	int skip_private_key_check;
109 	int use_fake_private_key;
110 	tls_sign_cb sign_cb;
111 	void *sign_cb_arg;
112 };
113 
114 struct tls_conninfo {
115 	char *alpn;
116 	char *cipher;
117 	int cipher_strength;
118 	char *servername;
119 	int session_resumed;
120 	char *version;
121 
122 	char *hash;
123 	char *issuer;
124 	char *subject;
125 
126 	uint8_t *peer_cert;
127 	size_t peer_cert_len;
128 
129 	time_t notbefore;
130 	time_t notafter;
131 };
132 
133 #define TLS_CLIENT		(1 << 0)
134 #define TLS_SERVER		(1 << 1)
135 #define TLS_SERVER_CONN		(1 << 2)
136 
137 #define TLS_EOF_NO_CLOSE_NOTIFY	(1 << 0)
138 #define TLS_CONNECTED		(1 << 1)
139 #define TLS_HANDSHAKE_COMPLETE	(1 << 2)
140 #define TLS_SSL_NEEDS_SHUTDOWN	(1 << 3)
141 
142 struct tls_ocsp_result {
143 	const char *result_msg;
144 	int response_status;
145 	int cert_status;
146 	int crl_reason;
147 	time_t this_update;
148 	time_t next_update;
149 	time_t revocation_time;
150 };
151 
152 struct tls_ocsp {
153 	/* responder location */
154 	char *ocsp_url;
155 
156 	/* cert data, this struct does not own these */
157 	X509 *main_cert;
158 	STACK_OF(X509) *extra_certs;
159 
160 	struct tls_ocsp_result *ocsp_result;
161 };
162 
163 struct tls_sni_ctx {
164 	struct tls_sni_ctx *next;
165 
166 	struct tls_keypair *keypair;
167 
168 	SSL_CTX *ssl_ctx;
169 	X509 *ssl_cert;
170 };
171 
172 struct tls {
173 	struct tls_config *config;
174 	struct tls_keypair *keypair;
175 
176 	struct tls_error error;
177 
178 	uint32_t flags;
179 	uint32_t state;
180 
181 	char *servername;
182 	int socket;
183 
184 	SSL *ssl_conn;
185 	SSL_CTX *ssl_ctx;
186 
187 	struct tls_sni_ctx *sni_ctx;
188 
189 	X509 *ssl_peer_cert;
190 	STACK_OF(X509) *ssl_peer_chain;
191 
192 	struct tls_conninfo *conninfo;
193 
194 	struct tls_ocsp *ocsp;
195 
196 	tls_read_cb read_cb;
197 	tls_write_cb write_cb;
198 	void *cb_arg;
199 };
200 
201 int tls_set_mem(char **_dest, size_t *_destlen, const void *_src,
202     size_t _srclen);
203 int tls_set_string(const char **_dest, const char *_src);
204 
205 struct tls_keypair *tls_keypair_new(void);
206 void tls_keypair_clear_key(struct tls_keypair *_keypair);
207 void tls_keypair_free(struct tls_keypair *_keypair);
208 int tls_keypair_set_cert_file(struct tls_keypair *_keypair,
209     struct tls_error *_error, const char *_cert_file);
210 int tls_keypair_set_cert_mem(struct tls_keypair *_keypair,
211     struct tls_error *_error, const uint8_t *_cert, size_t _len);
212 int tls_keypair_set_key_file(struct tls_keypair *_keypair,
213     struct tls_error *_error, const char *_key_file);
214 int tls_keypair_set_key_mem(struct tls_keypair *_keypair,
215     struct tls_error *_error, const uint8_t *_key, size_t _len);
216 int tls_keypair_set_ocsp_staple_file(struct tls_keypair *_keypair,
217     struct tls_error *_error, const char *_ocsp_file);
218 int tls_keypair_set_ocsp_staple_mem(struct tls_keypair *_keypair,
219     struct tls_error *_error, const uint8_t *_staple, size_t _len);
220 int tls_keypair_load_cert(struct tls_keypair *_keypair,
221     struct tls_error *_error, X509 **_cert);
222 
223 struct tls_sni_ctx *tls_sni_ctx_new(void);
224 void tls_sni_ctx_free(struct tls_sni_ctx *sni_ctx);
225 
226 struct tls_config *tls_config_new_internal(void);
227 
228 struct tls *tls_new(void);
229 struct tls *tls_server_conn(struct tls *ctx);
230 
231 int tls_check_name(struct tls *ctx, X509 *cert, const char *servername,
232     int *match);
233 int tls_configure_server(struct tls *ctx);
234 
235 int tls_configure_ssl(struct tls *ctx, SSL_CTX *ssl_ctx);
236 int tls_configure_ssl_keypair(struct tls *ctx, SSL_CTX *ssl_ctx,
237     struct tls_keypair *keypair, int required);
238 int tls_configure_ssl_verify(struct tls *ctx, SSL_CTX *ssl_ctx, int verify);
239 
240 int tls_handshake_client(struct tls *ctx);
241 int tls_handshake_server(struct tls *ctx);
242 
243 int tls_config_load_file(struct tls_error *error, const char *filetype,
244     const char *filename, char **buf, size_t *len);
245 int tls_config_ticket_autorekey(struct tls_config *config);
246 int tls_host_port(const char *hostport, char **host, char **port);
247 
248 int tls_set_cbs(struct tls *ctx,
249     tls_read_cb read_cb, tls_write_cb write_cb, void *cb_arg);
250 
251 void tls_error_clear(struct tls_error *error);
252 int tls_error_set(struct tls_error *error, const char *fmt, ...)
253     __attribute__((__format__ (printf, 2, 3)))
254     __attribute__((__nonnull__ (2)));
255 int tls_error_setx(struct tls_error *error, const char *fmt, ...)
256     __attribute__((__format__ (printf, 2, 3)))
257     __attribute__((__nonnull__ (2)));
258 int tls_config_set_error(struct tls_config *cfg, const char *fmt, ...)
259     __attribute__((__format__ (printf, 2, 3)))
260     __attribute__((__nonnull__ (2)));
261 int tls_config_set_errorx(struct tls_config *cfg, const char *fmt, ...)
262     __attribute__((__format__ (printf, 2, 3)))
263     __attribute__((__nonnull__ (2)));
264 int tls_set_error(struct tls *ctx, const char *fmt, ...)
265     __attribute__((__format__ (printf, 2, 3)))
266     __attribute__((__nonnull__ (2)));
267 int tls_set_errorx(struct tls *ctx, const char *fmt, ...)
268     __attribute__((__format__ (printf, 2, 3)))
269     __attribute__((__nonnull__ (2)));
270 int tls_set_ssl_errorx(struct tls *ctx, const char *fmt, ...)
271     __attribute__((__format__ (printf, 2, 3)))
272     __attribute__((__nonnull__ (2)));
273 
274 int tls_ssl_error(struct tls *ctx, SSL *ssl_conn, int ssl_ret,
275     const char *prefix);
276 
277 int tls_conninfo_populate(struct tls *ctx);
278 void tls_conninfo_free(struct tls_conninfo *conninfo);
279 
280 int tls_ocsp_verify_cb(SSL *ssl, void *arg);
281 int tls_ocsp_stapling_cb(SSL *ssl, void *arg);
282 void tls_ocsp_free(struct tls_ocsp *ctx);
283 struct tls_ocsp *tls_ocsp_setup_from_peer(struct tls *ctx);
284 int tls_hex_string(const unsigned char *_in, size_t _inlen, char **_out,
285     size_t *_outlen);
286 int tls_cert_hash(X509 *_cert, char **_hash);
287 int tls_cert_pubkey_hash(X509 *_cert, char **_hash);
288 
289 int tls_password_cb(char *_buf, int _size, int _rwflag, void *_u);
290 
291 RSA_METHOD *tls_signer_rsa_method(void);
292 EC_KEY_METHOD *tls_signer_ecdsa_method(void);
293 
294 #define TLS_PADDING_NONE			0
295 #define TLS_PADDING_RSA_PKCS1			1
296 
297 int tls_config_set_sign_cb(struct tls_config *_config, tls_sign_cb _cb,
298     void *_cb_arg);
299 
300 struct tls_signer* tls_signer_new(void);
301 void tls_signer_free(struct tls_signer * _signer);
302 const char *tls_signer_error(struct tls_signer * _signer);
303 int tls_signer_add_keypair_file(struct tls_signer *_signer,
304     const char *_cert_file, const char *_key_file);
305 int tls_signer_add_keypair_mem(struct tls_signer *_signer, const uint8_t *_cert,
306     size_t _cert_len, const uint8_t *_key, size_t _key_len);
307 int tls_signer_sign(struct tls_signer *_signer, const char *_pubkey_hash,
308     const uint8_t *_input, size_t _input_len, int _padding_type,
309     uint8_t **_out_signature, size_t *_out_signature_len);
310 
311 /* XXX this function is not fully hidden so relayd can use it */
312 void tls_config_skip_private_key_check(struct tls_config *config);
313 void tls_config_use_fake_private_key(struct tls_config *config);
314 
315 #ifndef HAVE_SSL_CTX_USE_CERTIFICATE_CHAIN_MEM
316 int SSL_CTX_use_certificate_chain_mem(SSL_CTX *, void *, int);
317 #endif
318 
319 #ifndef HAVE_SSL_CTX_LOAD_VERIFY_MEM
320 int SSL_CTX_load_verify_mem(SSL_CTX *, void *, int);
321 #endif
322 
323 #endif /* HEADER_TLS_INTERNAL_H */