Tor 0.4.9.0-alpha-dev
tortls.h
Go to the documentation of this file.
1/* Copyright (c) 2003, Roger Dingledine
2 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
3 * Copyright (c) 2007-2021, The Tor Project, Inc. */
4/* See LICENSE for licensing information */
5
6#ifndef TOR_TORTLS_H
7#define TOR_TORTLS_H
8
9/**
10 * \file tortls.h
11 * \brief Headers for tortls.c
12 **/
13
16#include "lib/net/nettypes.h"
17
18/* Opaque structure to hold a TLS connection. */
19typedef struct tor_tls_t tor_tls_t;
20
21#ifdef TORTLS_PRIVATE
22#ifdef ENABLE_OPENSSL
23struct ssl_st;
24struct ssl_ctx_st;
25struct ssl_session_st;
26typedef struct ssl_ctx_st tor_tls_context_impl_t;
27typedef struct ssl_st tor_tls_impl_t;
28#else /* !defined(ENABLE_OPENSSL) */
29struct PRFileDesc;
30typedef struct PRFileDesc tor_tls_context_impl_t;
31typedef struct PRFileDesc tor_tls_impl_t;
32#endif /* defined(ENABLE_OPENSSL) */
33#endif /* defined(TORTLS_PRIVATE) */
34
35struct tor_x509_cert_t;
36
37/* Possible return values for most tor_tls_* functions. */
38#define MIN_TOR_TLS_ERROR_VAL_ -9
39#define TOR_TLS_ERROR_MISC -9
40/* Rename to unexpected close or something. XXXX */
41#define TOR_TLS_ERROR_IO -8
42#define TOR_TLS_ERROR_CONNREFUSED -7
43#define TOR_TLS_ERROR_CONNRESET -6
44#define TOR_TLS_ERROR_NO_ROUTE -5
45#define TOR_TLS_ERROR_TIMEOUT -4
46#define TOR_TLS_CLOSE -3
47#define TOR_TLS_WANTREAD -2
48#define TOR_TLS_WANTWRITE -1
49#define TOR_TLS_DONE 0
50
51/** Collection of case statements for all TLS errors that are not due to
52 * underlying IO failure. */
53#define CASE_TOR_TLS_ERROR_ANY_NONIO \
54 case TOR_TLS_ERROR_MISC: \
55 case TOR_TLS_ERROR_CONNREFUSED: \
56 case TOR_TLS_ERROR_CONNRESET: \
57 case TOR_TLS_ERROR_NO_ROUTE: \
58 case TOR_TLS_ERROR_TIMEOUT
59
60/** Use this macro in a switch statement to catch _any_ TLS error. That way,
61 * if more errors are added, your switches will still work. */
62#define CASE_TOR_TLS_ERROR_ANY \
63 CASE_TOR_TLS_ERROR_ANY_NONIO: \
64 case TOR_TLS_ERROR_IO
65
66#define TOR_TLS_IS_ERROR(rv) ((rv) < TOR_TLS_CLOSE)
67
68/** Holds a SSL_CTX object and related state used to configure TLS
69 * connections.
70 */
72
73const char *tor_tls_err_to_string(int err);
74void tor_tls_get_state_description(tor_tls_t *tls, char *buf, size_t sz);
75void tor_tls_free_all(void);
76
77#define TOR_TLS_CTX_IS_PUBLIC_SERVER (1u<<0)
78#define TOR_TLS_CTX_USE_ECDHE_P256 (1u<<1)
79#define TOR_TLS_CTX_USE_ECDHE_P224 (1u<<2)
80
81void tor_tls_init(void);
82void tls_log_errors(tor_tls_t *tls, int severity, int domain,
83 const char *doing);
84const char *tor_tls_get_last_error_msg(const tor_tls_t *tls);
85int tor_tls_context_init(unsigned flags,
86 crypto_pk_t *client_identity,
87 crypto_pk_t *server_identity,
88 unsigned int key_lifetime);
92tor_tls_t *tor_tls_new(tor_socket_t sock, int is_server);
93void tor_tls_set_logged_address(tor_tls_t *tls, const char *address);
95 void (*cb)(tor_tls_t *, void *arg),
96 void *arg);
99void tor_tls_free_(tor_tls_t *tls);
100#define tor_tls_free(tls) FREE_AND_NULL(tor_tls_t, tor_tls_free_, (tls))
102MOCK_DECL(struct tor_x509_cert_t *,tor_tls_get_peer_cert,(tor_tls_t *tls));
103MOCK_DECL(struct tor_x509_cert_t *,tor_tls_get_own_cert,(tor_tls_t *tls));
104int tor_tls_verify(int severity, tor_tls_t *tls, crypto_pk_t **identity);
105MOCK_DECL(int, tor_tls_read, (tor_tls_t *tls, char *cp, size_t len));
106int tor_tls_write(tor_tls_t *tls, const char *cp, size_t n);
113
115 size_t *n_read, size_t *n_written);
116
118 size_t *rbuf_capacity, size_t *rbuf_bytes,
119 size_t *wbuf_capacity, size_t *wbuf_bytes);
120
122
124int tor_tls_get_num_server_handshakes(tor_tls_t *tls);
126MOCK_DECL(int,tor_tls_cert_matches_key,(const tor_tls_t *tls,
127 const struct tor_x509_cert_t *cert));
128MOCK_DECL(int,tor_tls_get_tlssecrets,(tor_tls_t *tls, uint8_t *secrets_out));
129#ifdef ENABLE_OPENSSL
130/* OpenSSL lets us see these master secrets; NSS sensibly does not. */
131#define HAVE_WORKING_TOR_TLS_GET_TLSSECRETS
132#endif
134 tor_tls_t *tls, uint8_t *secrets_out,
135 const uint8_t *context,
136 size_t context_len,
137 const char *label));
138
139#ifdef ENABLE_OPENSSL
140/* Log and abort if there are unhandled TLS errors in OpenSSL's error stack.
141 */
142#define check_no_tls_errors() check_no_tls_errors_(__FILE__,__LINE__)
143void check_no_tls_errors_(const char *fname, int line);
144
145void tor_tls_log_one_error(tor_tls_t *tls, unsigned long err,
146 int severity, int domain, const char *doing);
147#else /* !defined(ENABLE_OPENSSL) */
148#define check_no_tls_errors() STMT_NIL
149#endif /* defined(ENABLE_OPENSSL) */
150
151int tor_tls_get_my_certs(int server,
152 const struct tor_x509_cert_t **link_cert_out,
153 const struct tor_x509_cert_t **id_cert_out);
155
156const char *tor_tls_get_ciphersuite_name(tor_tls_t *tls);
157
158int evaluate_ecgroup_for_tls(const char *ecgroup);
159
160#endif /* !defined(TOR_TORTLS_H) */
Headers for crypto_rsa.c.
Declarations for types used throughout the Tor networking system.
#define tor_socket_t
Definition: nettypes.h:36
Macros to implement mocking and selective exposure for the test code.
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:127
int tor_tls_get_my_certs(int server, const tor_x509_cert_t **link_cert_out, const tor_x509_cert_t **id_cert_out)
Definition: tortls.c:76
int tor_tls_server_got_renegotiate(tor_tls_t *tls)
Definition: tortls_nss.c:726
void tor_tls_block_renegotiation(tor_tls_t *tls)
Definition: tortls_nss.c:647
int tor_tls_peer_has_cert(tor_tls_t *tls)
Definition: tortls_nss.c:532
int tor_tls_context_init(unsigned flags, crypto_pk_t *client_identity, crypto_pk_t *server_identity, unsigned int key_lifetime)
Definition: tortls.c:182
int tor_tls_used_v1_handshake(tor_tls_t *tls)
Definition: tortls_nss.c:717
void tor_tls_get_n_raw_bytes(tor_tls_t *tls, size_t *n_read, size_t *n_written)
Definition: tortls_nss.c:674
void tor_tls_context_incref(tor_tls_context_t *ctx)
Definition: tortls.c:111
int tor_tls_read(tor_tls_t *tls, char *cp, size_t len)
Definition: tortls_nss.c:562
void tor_tls_unblock_renegotiation(tor_tls_t *tls)
Definition: tortls_nss.c:640
tor_tls_context_t * tor_tls_context_get(int is_server)
Definition: tortls.c:45
double tls_get_write_overhead_ratio(void)
Definition: tortls_nss.c:709
int evaluate_ecgroup_for_tls(const char *ecgroup)
Definition: tortls_nss.c:860
void tor_tls_context_decref(tor_tls_context_t *ctx)
Definition: tortls.c:119
crypto_pk_t * tor_tls_get_my_client_auth_key(void)
Definition: tortls.c:101
void tor_tls_set_renegotiate_callback(tor_tls_t *tls, void(*cb)(tor_tls_t *, void *arg), void *arg)
Definition: tortls_nss.c:468
int tor_tls_write(tor_tls_t *tls, const char *cp, size_t n)
Definition: tortls_nss.c:585
void tor_tls_free_(tor_tls_t *tls)
Definition: tortls.c:389
int tor_tls_get_buffer_sizes(tor_tls_t *tls, size_t *rbuf_capacity, size_t *rbuf_bytes, size_t *wbuf_capacity, size_t *wbuf_bytes)
Definition: tortls_nss.c:694
struct tor_x509_cert_t * tor_tls_get_peer_cert(tor_tls_t *tls)
Definition: tortls_nss.c:541
int tor_tls_is_server(tor_tls_t *tls)
Definition: tortls.c:379
void tor_tls_init(void)
Definition: tortls_nss.c:356
void tor_tls_set_logged_address(tor_tls_t *tls, const char *address)
Definition: tortls.c:369
int tor_tls_get_pending_bytes(tor_tls_t *tls)
Definition: tortls_nss.c:654
int tor_tls_handshake(tor_tls_t *tls)
Definition: tortls_nss.c:613
int tor_tls_finish_handshake(tor_tls_t *tls)
Definition: tortls_nss.c:631
const char * tor_tls_err_to_string(int err)
Definition: tortls.c:155
tor_tls_t * tor_tls_new(tor_socket_t sock, int is_server)
Definition: tortls_nss.c:409
const char * tor_tls_get_last_error_msg(const tor_tls_t *tls)
Definition: tortls_nss.c:397
void tls_log_errors(tor_tls_t *tls, int severity, int domain, const char *doing)
Definition: tortls_nss.c:362
struct tor_x509_cert_t * tor_tls_get_own_cert(tor_tls_t *tls)
Definition: tortls_nss.c:551
int tor_tls_get_tlssecrets(tor_tls_t *tls, uint8_t *secrets_out)
Definition: tortls_nss.c:792
void tor_tls_free_all(void)
Definition: tortls.c:137
void tor_tls_get_state_description(tor_tls_t *tls, char *buf, size_t sz)
Definition: tortls_nss.c:346
void tor_tls_release_socket(tor_tls_t *tls)
Definition: tortls_nss.c:484
int tor_tls_verify(int severity, tor_tls_t *tls, crypto_pk_t **identity)
Definition: tortls.c:416
int tor_tls_export_key_material(tor_tls_t *tls, uint8_t *secrets_out, const uint8_t *context, size_t context_len, const char *label)
Definition: tortls_nss.c:806
size_t tor_tls_get_forced_write_size(tor_tls_t *tls)
Definition: tortls_nss.c:666