Tor 0.4.9.2-alpha-dev
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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
79void tor_tls_init(void);
80void tls_log_errors(tor_tls_t *tls, int severity, int domain,
81 const char *doing);
82const char *tor_tls_get_last_error_msg(const tor_tls_t *tls);
83int tor_tls_context_init(unsigned flags,
84 crypto_pk_t *client_identity,
85 crypto_pk_t *server_identity,
86 unsigned int key_lifetime);
90tor_tls_t *tor_tls_new(tor_socket_t sock, int is_server);
91void tor_tls_set_logged_address(tor_tls_t *tls, const char *address);
94void tor_tls_free_(tor_tls_t *tls);
95#define tor_tls_free(tls) FREE_AND_NULL(tor_tls_t, tor_tls_free_, (tls))
97MOCK_DECL(struct tor_x509_cert_t *,tor_tls_get_peer_cert,(tor_tls_t *tls));
98MOCK_DECL(struct tor_x509_cert_t *,tor_tls_get_own_cert,(tor_tls_t *tls));
99MOCK_DECL(int, tor_tls_read, (tor_tls_t *tls, char *cp, size_t len));
100int tor_tls_write(tor_tls_t *tls, const char *cp, size_t n);
104
106 size_t *n_read, size_t *n_written);
107
109 size_t *rbuf_capacity, size_t *rbuf_bytes,
110 size_t *wbuf_capacity, size_t *wbuf_bytes);
111
113
114int tor_tls_get_num_server_handshakes(tor_tls_t *tls);
115MOCK_DECL(int,tor_tls_cert_matches_key,(const tor_tls_t *tls,
116 const struct tor_x509_cert_t *cert));
118 tor_tls_t *tls, uint8_t *secrets_out,
119 const uint8_t *context,
120 size_t context_len,
121 const char *label));
122
123#ifdef ENABLE_OPENSSL
124/* Log and abort if there are unhandled TLS errors in OpenSSL's error stack.
125 */
126#define check_no_tls_errors() check_no_tls_errors_(__FILE__,__LINE__)
127void check_no_tls_errors_(const char *fname, int line);
128
129void tor_tls_log_one_error(tor_tls_t *tls, unsigned long err,
130 int severity, int domain, const char *doing);
131#else /* !defined(ENABLE_OPENSSL) */
132#define check_no_tls_errors() STMT_NIL
133#endif /* defined(ENABLE_OPENSSL) */
134
135int tor_tls_get_my_certs(int server,
136 const struct tor_x509_cert_t **link_cert_out,
137 const struct tor_x509_cert_t **id_cert_out);
138
139const char *tor_tls_get_ciphersuite_name(tor_tls_t *tls);
140
141int evaluate_ecgroup_for_tls(const char *ecgroup);
142
143#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_peer_has_cert(tor_tls_t *tls)
Definition: tortls_nss.c:492
int tor_tls_context_init(unsigned flags, crypto_pk_t *client_identity, crypto_pk_t *server_identity, unsigned int key_lifetime)
Definition: tortls.c:168
void tor_tls_get_n_raw_bytes(tor_tls_t *tls, size_t *n_read, size_t *n_written)
Definition: tortls_nss.c:611
void tor_tls_context_incref(tor_tls_context_t *ctx)
Definition: tortls.c:98
int tor_tls_read(tor_tls_t *tls, char *cp, size_t len)
Definition: tortls_nss.c:522
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:646
int evaluate_ecgroup_for_tls(const char *ecgroup)
Definition: tortls_nss.c:770
void tor_tls_context_decref(tor_tls_context_t *ctx)
Definition: tortls.c:106
int tor_tls_write(tor_tls_t *tls, const char *cp, size_t n)
Definition: tortls_nss.c:545
void tor_tls_free_(tor_tls_t *tls)
Definition: tortls.c:375
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:631
struct tor_x509_cert_t * tor_tls_get_peer_cert(tor_tls_t *tls)
Definition: tortls_nss.c:501
int tor_tls_is_server(tor_tls_t *tls)
Definition: tortls.c:365
void tor_tls_init(void)
Definition: tortls_nss.c:328
void tor_tls_set_logged_address(tor_tls_t *tls, const char *address)
Definition: tortls.c:355
int tor_tls_get_pending_bytes(tor_tls_t *tls)
Definition: tortls_nss.c:591
int tor_tls_handshake(tor_tls_t *tls)
Definition: tortls_nss.c:573
const char * tor_tls_err_to_string(int err)
Definition: tortls.c:142
tor_tls_t * tor_tls_new(tor_socket_t sock, int is_server)
Definition: tortls_nss.c:381
const char * tor_tls_get_last_error_msg(const tor_tls_t *tls)
Definition: tortls_nss.c:369
void tls_log_errors(tor_tls_t *tls, int severity, int domain, const char *doing)
Definition: tortls_nss.c:334
struct tor_x509_cert_t * tor_tls_get_own_cert(tor_tls_t *tls)
Definition: tortls_nss.c:511
void tor_tls_free_all(void)
Definition: tortls.c:124
void tor_tls_get_state_description(tor_tls_t *tls, char *buf, size_t sz)
Definition: tortls_nss.c:318
void tor_tls_release_socket(tor_tls_t *tls)
Definition: tortls_nss.c:444
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:716
size_t tor_tls_get_forced_write_size(tor_tls_t *tls)
Definition: tortls_nss.c:603