1 /* $OpenBSD: tls_internal.h,v 1.74 2019/04/01 15:58:02 jsing 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 <pthread.h> 23 24 #include <arpa/inet.h> 25 #include <netinet/in.h> 26 27 #include <openssl/ssl.h> 28 29 __BEGIN_HIDDEN_DECLS 30 31 #define TLS_CIPHERS_DEFAULT "TLSv1.2+AEAD+ECDHE:TLSv1.2+AEAD+DHE" 32 #define TLS_CIPHERS_COMPAT "HIGH:!aNULL" 33 #define TLS_CIPHERS_LEGACY "HIGH:MEDIUM:!aNULL" 34 #define TLS_CIPHERS_ALL "ALL:!aNULL:!eNULL" 35 36 #define TLS_ECDHE_CURVES "X25519,P-256,P-384" 37 38 union tls_addr { 39 struct in_addr ip4; 40 struct in6_addr ip6; 41 }; 42 43 struct tls_error { 44 char *msg; 45 int num; 46 int tls; 47 }; 48 49 struct tls_keypair { 50 struct tls_keypair *next; 51 52 char *cert_mem; 53 size_t cert_len; 54 char *key_mem; 55 size_t key_len; 56 char *ocsp_staple; 57 size_t ocsp_staple_len; 58 char *pubkey_hash; 59 }; 60 61 #define TLS_MIN_SESSION_TIMEOUT (4) 62 #define TLS_MAX_SESSION_TIMEOUT (24 * 60 * 60) 63 64 #define TLS_NUM_TICKETS 4 65 #define TLS_TICKET_NAME_SIZE 16 66 #define TLS_TICKET_AES_SIZE 32 67 #define TLS_TICKET_HMAC_SIZE 16 68 69 struct tls_ticket_key { 70 /* The key_name must be 16 bytes according to -lssl */ 71 unsigned char key_name[TLS_TICKET_NAME_SIZE]; 72 unsigned char aes_key[TLS_TICKET_AES_SIZE]; 73 unsigned char hmac_key[TLS_TICKET_HMAC_SIZE]; 74 time_t time; 75 }; 76 77 struct tls_config { 78 struct tls_error error; 79 80 pthread_mutex_t mutex; 81 int refcount; 82 83 char *alpn; 84 size_t alpn_len; 85 const char *ca_path; 86 char *ca_mem; 87 size_t ca_len; 88 const char *ciphers; 89 int ciphers_server; 90 char *crl_mem; 91 size_t crl_len; 92 int dheparams; 93 int *ecdhecurves; 94 size_t ecdhecurves_len; 95 struct tls_keypair *keypair; 96 int ocsp_require_stapling; 97 uint32_t protocols; 98 unsigned char session_id[TLS_MAX_SESSION_ID_LENGTH]; 99 int session_fd; 100 int session_lifetime; 101 struct tls_ticket_key ticket_keys[TLS_NUM_TICKETS]; 102 uint32_t ticket_keyrev; 103 int ticket_autorekey; 104 int verify_cert; 105 int verify_client; 106 int verify_depth; 107 int verify_name; 108 int verify_time; 109 int skip_private_key_check; 110 }; 111 112 struct tls_conninfo { 113 char *alpn; 114 char *cipher; 115 char *servername; 116 int session_resumed; 117 char *version; 118 119 char *hash; 120 char *issuer; 121 char *subject; 122 123 uint8_t *peer_cert; 124 size_t peer_cert_len; 125 126 time_t notbefore; 127 time_t notafter; 128 }; 129 130 #define TLS_CLIENT (1 << 0) 131 #define TLS_SERVER (1 << 1) 132 #define TLS_SERVER_CONN (1 << 2) 133 134 #define TLS_EOF_NO_CLOSE_NOTIFY (1 << 0) 135 #define TLS_CONNECTED (1 << 1) 136 #define TLS_HANDSHAKE_COMPLETE (1 << 2) 137 #define TLS_SSL_NEEDS_SHUTDOWN (1 << 3) 138 139 struct tls_ocsp_result { 140 const char *result_msg; 141 int response_status; 142 int cert_status; 143 int crl_reason; 144 time_t this_update; 145 time_t next_update; 146 time_t revocation_time; 147 }; 148 149 struct tls_ocsp { 150 /* responder location */ 151 char *ocsp_url; 152 153 /* cert data, this struct does not own these */ 154 X509 *main_cert; 155 STACK_OF(X509) *extra_certs; 156 157 struct tls_ocsp_result *ocsp_result; 158 }; 159 160 struct tls_sni_ctx { 161 struct tls_sni_ctx *next; 162 163 struct tls_keypair *keypair; 164 165 SSL_CTX *ssl_ctx; 166 X509 *ssl_cert; 167 }; 168 169 struct tls { 170 struct tls_config *config; 171 struct tls_keypair *keypair; 172 173 struct tls_error error; 174 175 uint32_t flags; 176 uint32_t state; 177 178 char *servername; 179 int socket; 180 181 SSL *ssl_conn; 182 SSL_CTX *ssl_ctx; 183 184 struct tls_sni_ctx *sni_ctx; 185 186 X509 *ssl_peer_cert; 187 STACK_OF(X509) *ssl_peer_chain; 188 189 struct tls_conninfo *conninfo; 190 191 struct tls_ocsp *ocsp; 192 193 tls_read_cb read_cb; 194 tls_write_cb write_cb; 195 void *cb_arg; 196 }; 197 198 int tls_set_mem(char **_dest, size_t *_destlen, const void *_src, 199 size_t _srclen); 200 int tls_set_string(const char **_dest, const char *_src); 201 202 struct tls_keypair *tls_keypair_new(void); 203 void tls_keypair_clear_key(struct tls_keypair *_keypair); 204 void tls_keypair_free(struct tls_keypair *_keypair); 205 int tls_keypair_set_cert_file(struct tls_keypair *_keypair, 206 struct tls_error *_error, const char *_cert_file); 207 int tls_keypair_set_cert_mem(struct tls_keypair *_keypair, 208 struct tls_error *_error, const uint8_t *_cert, size_t _len); 209 int tls_keypair_set_key_file(struct tls_keypair *_keypair, 210 struct tls_error *_error, const char *_key_file); 211 int tls_keypair_set_key_mem(struct tls_keypair *_keypair, 212 struct tls_error *_error, const uint8_t *_key, size_t _len); 213 int tls_keypair_set_ocsp_staple_file(struct tls_keypair *_keypair, 214 struct tls_error *_error, const char *_ocsp_file); 215 int tls_keypair_set_ocsp_staple_mem(struct tls_keypair *_keypair, 216 struct tls_error *_error, const uint8_t *_staple, size_t _len); 217 int tls_keypair_load_cert(struct tls_keypair *_keypair, 218 struct tls_error *_error, X509 **_cert); 219 220 struct tls_sni_ctx *tls_sni_ctx_new(void); 221 void tls_sni_ctx_free(struct tls_sni_ctx *sni_ctx); 222 223 struct tls_config *tls_config_new_internal(void); 224 225 struct tls *tls_new(void); 226 struct tls *tls_server_conn(struct tls *ctx); 227 228 int tls_check_name(struct tls *ctx, X509 *cert, const char *servername, 229 int *match); 230 int tls_configure_server(struct tls *ctx); 231 232 int tls_configure_ssl(struct tls *ctx, SSL_CTX *ssl_ctx); 233 int tls_configure_ssl_keypair(struct tls *ctx, SSL_CTX *ssl_ctx, 234 struct tls_keypair *keypair, int required); 235 int tls_configure_ssl_verify(struct tls *ctx, SSL_CTX *ssl_ctx, int verify); 236 237 int tls_handshake_client(struct tls *ctx); 238 int tls_handshake_server(struct tls *ctx); 239 240 int tls_config_load_file(struct tls_error *error, const char *filetype, 241 const char *filename, char **buf, size_t *len); 242 int tls_config_ticket_autorekey(struct tls_config *config); 243 int tls_host_port(const char *hostport, char **host, char **port); 244 245 int tls_set_cbs(struct tls *ctx, 246 tls_read_cb read_cb, tls_write_cb write_cb, void *cb_arg); 247 248 void tls_error_clear(struct tls_error *error); 249 int tls_error_set(struct tls_error *error, const char *fmt, ...) 250 __attribute__((__format__ (printf, 2, 3))) 251 __attribute__((__nonnull__ (2))); 252 int tls_error_setx(struct tls_error *error, const char *fmt, ...) 253 __attribute__((__format__ (printf, 2, 3))) 254 __attribute__((__nonnull__ (2))); 255 int tls_config_set_error(struct tls_config *cfg, const char *fmt, ...) 256 __attribute__((__format__ (printf, 2, 3))) 257 __attribute__((__nonnull__ (2))); 258 int tls_config_set_errorx(struct tls_config *cfg, const char *fmt, ...) 259 __attribute__((__format__ (printf, 2, 3))) 260 __attribute__((__nonnull__ (2))); 261 int tls_set_error(struct tls *ctx, const char *fmt, ...) 262 __attribute__((__format__ (printf, 2, 3))) 263 __attribute__((__nonnull__ (2))); 264 int tls_set_errorx(struct tls *ctx, const char *fmt, ...) 265 __attribute__((__format__ (printf, 2, 3))) 266 __attribute__((__nonnull__ (2))); 267 int tls_set_ssl_errorx(struct tls *ctx, const char *fmt, ...) 268 __attribute__((__format__ (printf, 2, 3))) 269 __attribute__((__nonnull__ (2))); 270 271 int tls_ssl_error(struct tls *ctx, SSL *ssl_conn, int ssl_ret, 272 const char *prefix); 273 274 int tls_conninfo_populate(struct tls *ctx); 275 void tls_conninfo_free(struct tls_conninfo *conninfo); 276 277 int tls_ocsp_verify_cb(SSL *ssl, void *arg); 278 int tls_ocsp_stapling_cb(SSL *ssl, void *arg); 279 void tls_ocsp_free(struct tls_ocsp *ctx); 280 struct tls_ocsp *tls_ocsp_setup_from_peer(struct tls *ctx); 281 int tls_hex_string(const unsigned char *_in, size_t _inlen, char **_out, 282 size_t *_outlen); 283 int tls_cert_hash(X509 *_cert, char **_hash); 284 int tls_cert_pubkey_hash(X509 *_cert, char **_hash); 285 286 int tls_password_cb(char *_buf, int _size, int _rwflag, void *_u); 287 288 __END_HIDDEN_DECLS 289 290 /* XXX this function is not fully hidden so relayd can use it */ 291 void tls_config_skip_private_key_check(struct tls_config *config); 292 293 #endif /* HEADER_TLS_INTERNAL_H */ 294