1 /* $OpenBSD: tls.h,v 1.58 2020/01/22 06:44:02 beck Exp $ */ 2 /* 3 * Copyright (c) 2014 Joel Sing <jsing@openbsd.org> 4 * 5 * Permission to use, copy, modify, and distribute this software for any 6 * purpose with or without fee is hereby granted, provided that the above 7 * copyright notice and this permission notice appear in all copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16 */ 17 18 #ifndef HEADER_TLS_H 19 #define HEADER_TLS_H 20 21 #ifdef __cplusplus 22 extern "C" { 23 #endif 24 25 #include <sys/types.h> 26 27 #include <stddef.h> 28 #include <stdint.h> 29 30 #define TLS_API 20200120 31 32 #define TLS_PROTOCOL_TLSv1_0 (1 << 1) 33 #define TLS_PROTOCOL_TLSv1_1 (1 << 2) 34 #define TLS_PROTOCOL_TLSv1_2 (1 << 3) 35 #define TLS_PROTOCOL_TLSv1_3 (1 << 4) 36 37 #define TLS_PROTOCOL_TLSv1 \ 38 (TLS_PROTOCOL_TLSv1_0|TLS_PROTOCOL_TLSv1_1|\ 39 TLS_PROTOCOL_TLSv1_2|TLS_PROTOCOL_TLSv1_3) 40 41 #define TLS_PROTOCOLS_ALL TLS_PROTOCOL_TLSv1 42 #define TLS_PROTOCOLS_DEFAULT (TLS_PROTOCOL_TLSv1_2|TLS_PROTOCOL_TLSv1_3) 43 44 #define TLS_WANT_POLLIN -2 45 #define TLS_WANT_POLLOUT -3 46 47 /* RFC 6960 Section 2.3 */ 48 #define TLS_OCSP_RESPONSE_SUCCESSFUL 0 49 #define TLS_OCSP_RESPONSE_MALFORMED 1 50 #define TLS_OCSP_RESPONSE_INTERNALERROR 2 51 #define TLS_OCSP_RESPONSE_TRYLATER 3 52 #define TLS_OCSP_RESPONSE_SIGREQUIRED 4 53 #define TLS_OCSP_RESPONSE_UNAUTHORIZED 5 54 55 /* RFC 6960 Section 2.2 */ 56 #define TLS_OCSP_CERT_GOOD 0 57 #define TLS_OCSP_CERT_REVOKED 1 58 #define TLS_OCSP_CERT_UNKNOWN 2 59 60 /* RFC 5280 Section 5.3.1 */ 61 #define TLS_CRL_REASON_UNSPECIFIED 0 62 #define TLS_CRL_REASON_KEY_COMPROMISE 1 63 #define TLS_CRL_REASON_CA_COMPROMISE 2 64 #define TLS_CRL_REASON_AFFILIATION_CHANGED 3 65 #define TLS_CRL_REASON_SUPERSEDED 4 66 #define TLS_CRL_REASON_CESSATION_OF_OPERATION 5 67 #define TLS_CRL_REASON_CERTIFICATE_HOLD 6 68 #define TLS_CRL_REASON_REMOVE_FROM_CRL 8 69 #define TLS_CRL_REASON_PRIVILEGE_WITHDRAWN 9 70 #define TLS_CRL_REASON_AA_COMPROMISE 10 71 72 #define TLS_MAX_SESSION_ID_LENGTH 32 73 #define TLS_TICKET_KEY_SIZE 48 74 75 struct tls; 76 struct tls_config; 77 78 typedef ssize_t (*tls_read_cb)(struct tls *_ctx, void *_buf, size_t _buflen, 79 void *_cb_arg); 80 typedef ssize_t (*tls_write_cb)(struct tls *_ctx, const void *_buf, 81 size_t _buflen, void *_cb_arg); 82 83 int tls_init(void); 84 85 const char *tls_config_error(struct tls_config *_config); 86 const char *tls_error(struct tls *_ctx); 87 88 struct tls_config *tls_config_new(void); 89 void tls_config_free(struct tls_config *_config); 90 91 const char *tls_default_ca_cert_file(void); 92 93 int tls_config_add_keypair_file(struct tls_config *_config, 94 const char *_cert_file, const char *_key_file); 95 int tls_config_add_keypair_mem(struct tls_config *_config, const uint8_t *_cert, 96 size_t _cert_len, const uint8_t *_key, size_t _key_len); 97 int tls_config_add_keypair_ocsp_file(struct tls_config *_config, 98 const char *_cert_file, const char *_key_file, 99 const char *_ocsp_staple_file); 100 int tls_config_add_keypair_ocsp_mem(struct tls_config *_config, const uint8_t *_cert, 101 size_t _cert_len, const uint8_t *_key, size_t _key_len, 102 const uint8_t *_staple, size_t _staple_len); 103 int tls_config_set_alpn(struct tls_config *_config, const char *_alpn); 104 int tls_config_set_ca_file(struct tls_config *_config, const char *_ca_file); 105 int tls_config_set_ca_path(struct tls_config *_config, const char *_ca_path); 106 int tls_config_set_ca_mem(struct tls_config *_config, const uint8_t *_ca, 107 size_t _len); 108 int tls_config_set_cert_file(struct tls_config *_config, 109 const char *_cert_file); 110 int tls_config_set_cert_mem(struct tls_config *_config, const uint8_t *_cert, 111 size_t _len); 112 int tls_config_set_ciphers(struct tls_config *_config, const char *_ciphers); 113 int tls_config_set_crl_file(struct tls_config *_config, const char *_crl_file); 114 int tls_config_set_crl_mem(struct tls_config *_config, const uint8_t *_crl, 115 size_t _len); 116 int tls_config_set_dheparams(struct tls_config *_config, const char *_params); 117 int tls_config_set_ecdhecurve(struct tls_config *_config, const char *_curve); 118 int tls_config_set_ecdhecurves(struct tls_config *_config, const char *_curves); 119 int tls_config_set_key_file(struct tls_config *_config, const char *_key_file); 120 int tls_config_set_key_mem(struct tls_config *_config, const uint8_t *_key, 121 size_t _len); 122 int tls_config_set_keypair_file(struct tls_config *_config, 123 const char *_cert_file, const char *_key_file); 124 int tls_config_set_keypair_mem(struct tls_config *_config, const uint8_t *_cert, 125 size_t _cert_len, const uint8_t *_key, size_t _key_len); 126 int tls_config_set_keypair_ocsp_file(struct tls_config *_config, 127 const char *_cert_file, const char *_key_file, const char *_staple_file); 128 int tls_config_set_keypair_ocsp_mem(struct tls_config *_config, const uint8_t *_cert, 129 size_t _cert_len, const uint8_t *_key, size_t _key_len, 130 const uint8_t *_staple, size_t staple_len); 131 int tls_config_set_ocsp_staple_mem(struct tls_config *_config, 132 const uint8_t *_staple, size_t _len); 133 int tls_config_set_ocsp_staple_file(struct tls_config *_config, 134 const char *_staple_file); 135 int tls_config_set_protocols(struct tls_config *_config, uint32_t _protocols); 136 int tls_config_set_session_fd(struct tls_config *_config, int _session_fd); 137 int tls_config_set_verify_depth(struct tls_config *_config, int _verify_depth); 138 139 void tls_config_prefer_ciphers_client(struct tls_config *_config); 140 void tls_config_prefer_ciphers_server(struct tls_config *_config); 141 142 void tls_config_insecure_noverifycert(struct tls_config *_config); 143 void tls_config_insecure_noverifyname(struct tls_config *_config); 144 void tls_config_insecure_noverifytime(struct tls_config *_config); 145 void tls_config_verify(struct tls_config *_config); 146 147 void tls_config_ocsp_require_stapling(struct tls_config *_config); 148 void tls_config_verify_client(struct tls_config *_config); 149 void tls_config_verify_client_optional(struct tls_config *_config); 150 151 void tls_config_clear_keys(struct tls_config *_config); 152 int tls_config_parse_protocols(uint32_t *_protocols, const char *_protostr); 153 154 int tls_config_set_session_id(struct tls_config *_config, 155 const unsigned char *_session_id, size_t _len); 156 int tls_config_set_session_lifetime(struct tls_config *_config, int _lifetime); 157 int tls_config_add_ticket_key(struct tls_config *_config, uint32_t _keyrev, 158 unsigned char *_key, size_t _keylen); 159 160 struct tls *tls_client(void); 161 struct tls *tls_server(void); 162 int tls_configure(struct tls *_ctx, struct tls_config *_config); 163 void tls_reset(struct tls *_ctx); 164 void tls_free(struct tls *_ctx); 165 166 int tls_accept_fds(struct tls *_ctx, struct tls **_cctx, int _fd_read, 167 int _fd_write); 168 int tls_accept_socket(struct tls *_ctx, struct tls **_cctx, int _socket); 169 int tls_accept_cbs(struct tls *_ctx, struct tls **_cctx, 170 tls_read_cb _read_cb, tls_write_cb _write_cb, void *_cb_arg); 171 int tls_connect(struct tls *_ctx, const char *_host, const char *_port); 172 int tls_connect_fds(struct tls *_ctx, int _fd_read, int _fd_write, 173 const char *_servername); 174 int tls_connect_servername(struct tls *_ctx, const char *_host, 175 const char *_port, const char *_servername); 176 int tls_connect_socket(struct tls *_ctx, int _s, const char *_servername); 177 int tls_connect_cbs(struct tls *_ctx, tls_read_cb _read_cb, 178 tls_write_cb _write_cb, void *_cb_arg, const char *_servername); 179 int tls_handshake(struct tls *_ctx); 180 ssize_t tls_read(struct tls *_ctx, void *_buf, size_t _buflen); 181 ssize_t tls_write(struct tls *_ctx, const void *_buf, size_t _buflen); 182 int tls_close(struct tls *_ctx); 183 184 int tls_peer_cert_provided(struct tls *_ctx); 185 int tls_peer_cert_contains_name(struct tls *_ctx, const char *_name); 186 187 const char *tls_peer_cert_hash(struct tls *_ctx); 188 const char *tls_peer_cert_issuer(struct tls *_ctx); 189 const char *tls_peer_cert_subject(struct tls *_ctx); 190 time_t tls_peer_cert_notbefore(struct tls *_ctx); 191 time_t tls_peer_cert_notafter(struct tls *_ctx); 192 const uint8_t *tls_peer_cert_chain_pem(struct tls *_ctx, size_t *_len); 193 194 const char *tls_conn_alpn_selected(struct tls *_ctx); 195 const char *tls_conn_cipher(struct tls *_ctx); 196 int tls_conn_cipher_strength(struct tls *_ctx); 197 const char *tls_conn_servername(struct tls *_ctx); 198 int tls_conn_session_resumed(struct tls *_ctx); 199 const char *tls_conn_version(struct tls *_ctx); 200 201 uint8_t *tls_load_file(const char *_file, size_t *_len, char *_password); 202 void tls_unload_file(uint8_t *_buf, size_t len); 203 204 int tls_ocsp_process_response(struct tls *_ctx, const unsigned char *_response, 205 size_t _size); 206 int tls_peer_ocsp_cert_status(struct tls *_ctx); 207 int tls_peer_ocsp_crl_reason(struct tls *_ctx); 208 time_t tls_peer_ocsp_next_update(struct tls *_ctx); 209 int tls_peer_ocsp_response_status(struct tls *_ctx); 210 const char *tls_peer_ocsp_result(struct tls *_ctx); 211 time_t tls_peer_ocsp_revocation_time(struct tls *_ctx); 212 time_t tls_peer_ocsp_this_update(struct tls *_ctx); 213 const char *tls_peer_ocsp_url(struct tls *_ctx); 214 215 #ifdef __cplusplus 216 } 217 #endif 218 219 #endif /* HEADER_TLS_H */ 220