1 /* $OpenBSD: tls.h,v 1.63 2023/07/02 06:37:27 beck Exp $ */
3 * Copyright (c) 2014 Joel Sing <jsing@openbsd.org>
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.
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.
25 #include <sys/types.h>
30 #define TLS_API 20200120
33 * Deprecated versions of TLS. Using these effectively selects
34 * the minimum supported version.
36 #define TLS_PROTOCOL_TLSv1_0 (1 << 3)
37 #define TLS_PROTOCOL_TLSv1_1 (1 << 3)
38 /* Supported versions of TLS */
39 #define TLS_PROTOCOL_TLSv1_2 (1 << 3)
40 #define TLS_PROTOCOL_TLSv1_3 (1 << 4)
42 #define TLS_PROTOCOL_TLSv1 \
43 (TLS_PROTOCOL_TLSv1_2|TLS_PROTOCOL_TLSv1_3)
45 #define TLS_PROTOCOLS_ALL TLS_PROTOCOL_TLSv1
46 #define TLS_PROTOCOLS_DEFAULT (TLS_PROTOCOL_TLSv1_2|TLS_PROTOCOL_TLSv1_3)
48 #define TLS_WANT_POLLIN -2
49 #define TLS_WANT_POLLOUT -3
51 /* RFC 6960 Section 2.3 */
52 #define TLS_OCSP_RESPONSE_SUCCESSFUL 0
53 #define TLS_OCSP_RESPONSE_MALFORMED 1
54 #define TLS_OCSP_RESPONSE_INTERNALERROR 2
55 #define TLS_OCSP_RESPONSE_TRYLATER 3
56 #define TLS_OCSP_RESPONSE_SIGREQUIRED 4
57 #define TLS_OCSP_RESPONSE_UNAUTHORIZED 5
59 /* RFC 6960 Section 2.2 */
60 #define TLS_OCSP_CERT_GOOD 0
61 #define TLS_OCSP_CERT_REVOKED 1
62 #define TLS_OCSP_CERT_UNKNOWN 2
64 /* RFC 5280 Section 5.3.1 */
65 #define TLS_CRL_REASON_UNSPECIFIED 0
66 #define TLS_CRL_REASON_KEY_COMPROMISE 1
67 #define TLS_CRL_REASON_CA_COMPROMISE 2
68 #define TLS_CRL_REASON_AFFILIATION_CHANGED 3
69 #define TLS_CRL_REASON_SUPERSEDED 4
70 #define TLS_CRL_REASON_CESSATION_OF_OPERATION 5
71 #define TLS_CRL_REASON_CERTIFICATE_HOLD 6
72 #define TLS_CRL_REASON_REMOVE_FROM_CRL 8
73 #define TLS_CRL_REASON_PRIVILEGE_WITHDRAWN 9
74 #define TLS_CRL_REASON_AA_COMPROMISE 10
76 #define TLS_MAX_SESSION_ID_LENGTH 32
77 #define TLS_TICKET_KEY_SIZE 48
82 typedef ssize_t (*tls_read_cb)(struct tls *_ctx, void *_buf, size_t _buflen,
84 typedef ssize_t (*tls_write_cb)(struct tls *_ctx, const void *_buf,
85 size_t _buflen, void *_cb_arg);
89 const char *tls_config_error(struct tls_config *_config);
90 const char *tls_error(struct tls *_ctx);
92 struct tls_config *tls_config_new(void);
93 void tls_config_free(struct tls_config *_config);
95 const char *tls_default_ca_cert_file(void);
97 int tls_config_add_keypair_file(struct tls_config *_config,
98 const char *_cert_file, const char *_key_file);
99 int tls_config_add_keypair_mem(struct tls_config *_config, const uint8_t *_cert,
100 size_t _cert_len, const uint8_t *_key, size_t _key_len);
101 int tls_config_add_keypair_ocsp_file(struct tls_config *_config,
102 const char *_cert_file, const char *_key_file,
103 const char *_ocsp_staple_file);
104 int tls_config_add_keypair_ocsp_mem(struct tls_config *_config, const uint8_t *_cert,
105 size_t _cert_len, const uint8_t *_key, size_t _key_len,
106 const uint8_t *_staple, size_t _staple_len);
107 int tls_config_set_alpn(struct tls_config *_config, const char *_alpn);
108 int tls_config_set_ca_file(struct tls_config *_config, const char *_ca_file);
109 int tls_config_set_ca_path(struct tls_config *_config, const char *_ca_path);
110 int tls_config_set_ca_mem(struct tls_config *_config, const uint8_t *_ca,
112 int tls_config_set_cert_file(struct tls_config *_config,
113 const char *_cert_file);
114 int tls_config_set_cert_mem(struct tls_config *_config, const uint8_t *_cert,
116 int tls_config_set_ciphers(struct tls_config *_config, const char *_ciphers);
117 int tls_config_set_crl_file(struct tls_config *_config, const char *_crl_file);
118 int tls_config_set_crl_mem(struct tls_config *_config, const uint8_t *_crl,
120 int tls_config_set_dheparams(struct tls_config *_config, const char *_params);
121 int tls_config_set_ecdhecurve(struct tls_config *_config, const char *_curve);
122 int tls_config_set_ecdhecurves(struct tls_config *_config, const char *_curves);
123 int tls_config_set_key_file(struct tls_config *_config, const char *_key_file);
124 int tls_config_set_key_mem(struct tls_config *_config, const uint8_t *_key,
126 int tls_config_set_keypair_file(struct tls_config *_config,
127 const char *_cert_file, const char *_key_file);
128 int tls_config_set_keypair_mem(struct tls_config *_config, const uint8_t *_cert,
129 size_t _cert_len, const uint8_t *_key, size_t _key_len);
130 int tls_config_set_keypair_ocsp_file(struct tls_config *_config,
131 const char *_cert_file, const char *_key_file, const char *_staple_file);
132 int tls_config_set_keypair_ocsp_mem(struct tls_config *_config, const uint8_t *_cert,
133 size_t _cert_len, const uint8_t *_key, size_t _key_len,
134 const uint8_t *_staple, size_t staple_len);
135 int tls_config_set_ocsp_staple_mem(struct tls_config *_config,
136 const uint8_t *_staple, size_t _len);
137 int tls_config_set_ocsp_staple_file(struct tls_config *_config,
138 const char *_staple_file);
139 int tls_config_set_protocols(struct tls_config *_config, uint32_t _protocols);
140 int tls_config_set_session_fd(struct tls_config *_config, int _session_fd);
141 int tls_config_set_verify_depth(struct tls_config *_config, int _verify_depth);
143 void tls_config_prefer_ciphers_client(struct tls_config *_config);
144 void tls_config_prefer_ciphers_server(struct tls_config *_config);
146 void tls_config_insecure_noverifycert(struct tls_config *_config);
147 void tls_config_insecure_noverifyname(struct tls_config *_config);
148 void tls_config_insecure_noverifytime(struct tls_config *_config);
149 void tls_config_verify(struct tls_config *_config);
151 void tls_config_ocsp_require_stapling(struct tls_config *_config);
152 void tls_config_verify_client(struct tls_config *_config);
153 void tls_config_verify_client_optional(struct tls_config *_config);
155 void tls_config_clear_keys(struct tls_config *_config);
156 int tls_config_parse_protocols(uint32_t *_protocols, const char *_protostr);
158 int tls_config_set_session_id(struct tls_config *_config,
159 const unsigned char *_session_id, size_t _len);
160 int tls_config_set_session_lifetime(struct tls_config *_config, int _lifetime);
161 int tls_config_add_ticket_key(struct tls_config *_config, uint32_t _keyrev,
162 unsigned char *_key, size_t _keylen);
164 struct tls *tls_client(void);
165 struct tls *tls_server(void);
166 int tls_configure(struct tls *_ctx, struct tls_config *_config);
167 void tls_reset(struct tls *_ctx);
168 void tls_free(struct tls *_ctx);
170 int tls_accept_fds(struct tls *_ctx, struct tls **_cctx, int _fd_read,
172 int tls_accept_socket(struct tls *_ctx, struct tls **_cctx, int _socket);
173 int tls_accept_cbs(struct tls *_ctx, struct tls **_cctx,
174 tls_read_cb _read_cb, tls_write_cb _write_cb, void *_cb_arg);
175 int tls_connect(struct tls *_ctx, const char *_host, const char *_port);
176 int tls_connect_fds(struct tls *_ctx, int _fd_read, int _fd_write,
177 const char *_servername);
178 int tls_connect_servername(struct tls *_ctx, const char *_host,
179 const char *_port, const char *_servername);
180 int tls_connect_socket(struct tls *_ctx, int _s, const char *_servername);
181 int tls_connect_cbs(struct tls *_ctx, tls_read_cb _read_cb,
182 tls_write_cb _write_cb, void *_cb_arg, const char *_servername);
183 int tls_handshake(struct tls *_ctx);
184 ssize_t tls_read(struct tls *_ctx, void *_buf, size_t _buflen);
185 ssize_t tls_write(struct tls *_ctx, const void *_buf, size_t _buflen);
186 int tls_close(struct tls *_ctx);
188 int tls_peer_cert_provided(struct tls *_ctx);
189 int tls_peer_cert_contains_name(struct tls *_ctx, const char *_name);
191 const char *tls_peer_cert_hash(struct tls *_ctx);
192 const char *tls_peer_cert_issuer(struct tls *_ctx);
193 const char *tls_peer_cert_subject(struct tls *_ctx);
194 time_t tls_peer_cert_notbefore(struct tls *_ctx);
195 time_t tls_peer_cert_notafter(struct tls *_ctx);
196 const uint8_t *tls_peer_cert_chain_pem(struct tls *_ctx, size_t *_len);
198 const char *tls_conn_alpn_selected(struct tls *_ctx);
199 const char *tls_conn_cipher(struct tls *_ctx);
200 int tls_conn_cipher_strength(struct tls *_ctx);
201 const char *tls_conn_servername(struct tls *_ctx);
202 int tls_conn_session_resumed(struct tls *_ctx);
203 const char *tls_conn_version(struct tls *_ctx);
205 uint8_t *tls_load_file(const char *_file, size_t *_len, char *_password);
206 void tls_unload_file(uint8_t *_buf, size_t len);
208 int tls_ocsp_process_response(struct tls *_ctx, const unsigned char *_response,
210 int tls_peer_ocsp_cert_status(struct tls *_ctx);
211 int tls_peer_ocsp_crl_reason(struct tls *_ctx);
212 time_t tls_peer_ocsp_next_update(struct tls *_ctx);
213 int tls_peer_ocsp_response_status(struct tls *_ctx);
214 const char *tls_peer_ocsp_result(struct tls *_ctx);
215 time_t tls_peer_ocsp_revocation_time(struct tls *_ctx);
216 time_t tls_peer_ocsp_this_update(struct tls *_ctx);
217 const char *tls_peer_ocsp_url(struct tls *_ctx);
223 #endif /* HEADER_TLS_H */
