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