July 2020 - tor-commits - lists.torproject.org

[tor/master] Remove unneeded generate_ed_link_cert() in tests.
by nickm＠torproject.org 16 Jul '20

16 Jul '20

commit 4b24b3628926e864220d59b9d1b8c0dd45a1d52b Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Jul 16 12:58:40 2020 -0400 Remove unneeded generate_ed_link_cert() in tests. This fixes CID 1465291, which was a complaint that we never actually checked the return value of this function. It turns out that this function was failing, and it didn't matter, because it wasn't necessary for this test. --- src/test/test_routerkeys.c | 1 - 1 file changed, 1 deletion(-) diff --git a/src/test/test_routerkeys.c b/src/test/test_routerkeys.c index bafc886bc6..8d653e44a2 100644 --- a/src/test/test_routerkeys.c +++ b/src/test/test_routerkeys.c @@ -111,7 +111,6 @@ test_routerkeys_write_ed25519_identity(void *arg) set_client_identity_key(crypto_pk_dup_key(key)); load_ed_keys(options, now); - generate_ed_link_cert(options, now, 0); tt_assert(get_master_identity_key()); tt_int_op(0, OP_EQ, check_private_dir(ddir, CPD_CREATE, NULL));

1 0

[tor/master] Use CONST_TO_* macros in more places.
by dgoulet＠torproject.org 16 Jul '20

16 Jul '20

commit 7ebfa607b238ed909473bb971d1187066d68c56f Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Jul 16 10:26:43 2020 -0400 Use CONST_TO_* macros in more places. This is an automated commit made with a python script. After running the automated script, I had to hand-revert the cases where it made the conversion functions call themselves. Additionally, I had to edit a variable declaration in control_bootstrap.c so that the result of a const cast could be put in a const field. --- src/core/mainloop/connection.c | 4 ++-- src/core/or/channeltls.c | 4 ++-- src/core/or/scheduler.c | 2 +- src/core/or/scheduler_kist.c | 2 +- src/feature/control/control_bootstrap.c | 4 ++-- src/feature/dircommon/directory.c | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/core/mainloop/connection.c b/src/core/mainloop/connection.c index 20e38ac44b..90fd35b527 100644 --- a/src/core/mainloop/connection.c +++ b/src/core/mainloop/connection.c @@ -433,7 +433,7 @@ connection_describe_peer_internal(const connection_t *conn, address = conn->address ? conn->address : "unix socket"; } else if (conn->type == CONN_TYPE_OR) { /* For OR connections, we have a lot to do. */ - const or_connection_t *or_conn = TO_OR_CONN((connection_t *)conn); + const or_connection_t *or_conn = CONST_TO_OR_CONN(conn); /* we report 'real_addr' as the address we're talking with, if it's set. * * TODO: Eventually we should have 'addr' always mean the address on the @@ -2257,7 +2257,7 @@ connection_connect_log_client_use_ip_version(const connection_t *conn) /* OR conns keep the original address in real_addr, as addr gets overwritten * with the descriptor address */ if (conn->type == CONN_TYPE_OR) { - const or_connection_t *or_conn = TO_OR_CONN((connection_t *)conn); + const or_connection_t *or_conn = CONST_TO_OR_CONN(conn); tor_addr_copy(&real_addr, &or_conn->real_addr); } else if (conn->type == CONN_TYPE_DIR) { tor_addr_copy(&real_addr, &conn->addr); diff --git a/src/core/or/channeltls.c b/src/core/or/channeltls.c index 4a421462cc..90049a7e5c 100644 --- a/src/core/or/channeltls.c +++ b/src/core/or/channeltls.c @@ -538,7 +538,7 @@ static int channel_tls_get_remote_addr_method(const channel_t *chan, tor_addr_t *addr_out) { - const channel_tls_t *tlschan = BASE_CHAN_TO_TLS((channel_t*) chan); + const channel_tls_t *tlschan = CONST_BASE_CHAN_TO_TLS(chan); tor_assert(tlschan); tor_assert(addr_out); @@ -593,7 +593,7 @@ channel_tls_get_transport_name_method(channel_t *chan, char **transport_out) static const char * channel_tls_describe_peer_method(const channel_t *chan) { - const channel_tls_t *tlschan = BASE_CHAN_TO_TLS((channel_t*)chan); + const channel_tls_t *tlschan = CONST_BASE_CHAN_TO_TLS(chan); tor_assert(tlschan); if (tlschan->conn) { diff --git a/src/core/or/scheduler.c b/src/core/or/scheduler.c index 072d78128b..18f11487d9 100644 --- a/src/core/or/scheduler.c +++ b/src/core/or/scheduler.c @@ -713,7 +713,7 @@ scheduler_bug_occurred(const channel_t *chan) if (chan != NULL) { const size_t outbuf_len = - buf_datalen(TO_CONN(BASE_CHAN_TO_TLS((channel_t *) chan)->conn)->outbuf); + buf_datalen(TO_CONN(CONST_BASE_CHAN_TO_TLS(chan)->conn)->outbuf); tor_snprintf(buf, sizeof(buf), "Channel %" PRIu64 " in state %s and scheduler state %s." " Num cells on cmux: %d. Connection outbuf len: %lu.", diff --git a/src/core/or/scheduler_kist.c b/src/core/or/scheduler_kist.c index 5c1922847e..8c6a7bd1d1 100644 --- a/src/core/or/scheduler_kist.c +++ b/src/core/or/scheduler_kist.c @@ -203,7 +203,7 @@ update_socket_info_impl, (socket_table_ent_t *ent)) tor_assert(ent); tor_assert(ent->chan); const tor_socket_t sock = - TO_CONN(BASE_CHAN_TO_TLS((channel_t *) ent->chan)->conn)->s; + TO_CONN(CONST_BASE_CHAN_TO_TLS(ent->chan)->conn)->s; struct tcp_info tcp; socklen_t tcp_info_len = sizeof(tcp); diff --git a/src/feature/control/control_bootstrap.c b/src/feature/control/control_bootstrap.c index fee7612ba2..d4f2adde81 100644 --- a/src/feature/control/control_bootstrap.c +++ b/src/feature/control/control_bootstrap.c @@ -274,7 +274,7 @@ control_event_bootstrap_problem(const char *warn, const char *reason, const char *recommendation = "ignore"; int severity; char *or_id = NULL, *hostaddr = NULL; - or_connection_t *or_conn = NULL; + const or_connection_t *or_conn = NULL; /* bootstrap_percent must not be in "undefined" state here. */ tor_assert(status >= 0); @@ -301,7 +301,7 @@ control_event_bootstrap_problem(const char *warn, const char *reason, if (conn && conn->type == CONN_TYPE_OR) { /* XXX TO_OR_CONN can't deal with const */ - or_conn = TO_OR_CONN((connection_t *)conn); + or_conn = CONST_TO_OR_CONN(conn); or_id = tor_strdup(hex_str(or_conn->identity_digest, DIGEST_LEN)); } else { or_id = tor_strdup("?"); diff --git a/src/feature/dircommon/directory.c b/src/feature/dircommon/directory.c index e92e6480af..b276ac3441 100644 --- a/src/feature/dircommon/directory.c +++ b/src/feature/dircommon/directory.c @@ -233,7 +233,7 @@ connection_dir_is_anonymous(const dir_connection_t *dir_conn) return false; } - edge_conn = TO_EDGE_CONN((connection_t *) linked_conn); + edge_conn = CONST_TO_EDGE_CONN(linked_conn); circ = edge_conn->on_circuit; /* Can't be a circuit we initiated and without a circuit, no channel. */

1 0

[tor/master] Improve documentation for our TO_*_CONN() cast functions.
by dgoulet＠torproject.org 16 Jul '20

16 Jul '20

commit b0d7b100886ef14a785f6ca1de968df9a884d0a7 Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Jul 16 09:57:52 2020 -0400 Improve documentation for our TO_*_CONN() cast functions. Preliminary work for #40046. --- src/core/mainloop/connection.c | 8 ++++++-- src/core/or/connection_edge.c | 20 ++++++++++++++++++-- src/core/or/connection_or.c | 7 +++++-- src/feature/control/control.c | 8 ++++++-- src/feature/dircommon/directory.c | 8 ++++++-- 5 files changed, 41 insertions(+), 10 deletions(-) diff --git a/src/core/mainloop/connection.c b/src/core/mainloop/connection.c index 282d90c2b0..216aeb68d1 100644 --- a/src/core/mainloop/connection.c +++ b/src/core/mainloop/connection.c @@ -220,8 +220,12 @@ static smartlist_t *outgoing_addrs = NULL; /**************************************************************/ -/** Convert a connection_t* to an listener_connection_t*; assert if the cast - * is invalid. */ +/** + * Cast a `connection_t *` to a `listener_connection_t *`. + * + * Exit with an assertion failure if the input is not a + * `listener_connection_t`. + **/ listener_connection_t * TO_LISTENER_CONN(connection_t *c) { diff --git a/src/core/or/connection_edge.c b/src/core/or/connection_edge.c index 8eb9f8ba0f..30cfb18f0f 100644 --- a/src/core/or/connection_edge.c +++ b/src/core/or/connection_edge.c @@ -166,8 +166,12 @@ static int connection_exit_connect_dir(edge_connection_t *exitconn); static int consider_plaintext_ports(entry_connection_t *conn, uint16_t port); static int connection_ap_supports_optimistic_data(const entry_connection_t *); -/** Convert a connection_t* to an edge_connection_t*; assert if the cast is - * invalid. */ +/** + * Cast a `connection_t *` to an `edge_connection_t *`. + * + * Exit with an assertion failure if the input is not an + * `edge_connection_t`. + **/ edge_connection_t * TO_EDGE_CONN(connection_t *c) { @@ -176,6 +180,12 @@ TO_EDGE_CONN(connection_t *c) return DOWNCAST(edge_connection_t, c); } +/** + * Cast a `connection_t *` to an `entry_connection_t *`. + * + * Exit with an assertion failure if the input is not an + * `entry_connection_t`. + **/ entry_connection_t * TO_ENTRY_CONN(connection_t *c) { @@ -183,6 +193,12 @@ TO_ENTRY_CONN(connection_t *c) return (entry_connection_t*) SUBTYPE_P(c, entry_connection_t, edge_.base_); } +/** + * Cast an `edge_connection_t *` to an `entry_connection_t *`. + * + * Exit with an assertion failure if the input is not an + * `entry_connection_t`. + **/ entry_connection_t * EDGE_TO_ENTRY_CONN(edge_connection_t *c) { diff --git a/src/core/or/connection_or.c b/src/core/or/connection_or.c index e62c28821a..e6dc62a475 100644 --- a/src/core/or/connection_or.c +++ b/src/core/or/connection_or.c @@ -99,8 +99,11 @@ static void connection_or_check_canonicity(or_connection_t *conn, /**************************************************************/ -/** Convert a connection_t* to an or_connection_t*; assert if the cast is - * invalid. */ +/** + * Cast a `connection_t *` to an `or_connection_t *`. + * + * Exit with an assertion failure if the input is not an `or_connnection_t`. + **/ or_connection_t * TO_OR_CONN(connection_t *c) { diff --git a/src/feature/control/control.c b/src/feature/control/control.c index ee1026359d..b5d4c31525 100644 --- a/src/feature/control/control.c +++ b/src/feature/control/control.c @@ -61,8 +61,12 @@ #include <sys/stat.h> #endif -/** Convert a connection_t* to an control_connection_t*; assert if the cast is - * invalid. */ +/** + * Cast a `connection_t *` to a `control_connection_t *`. + * + * Exit with an assertion failure if the input is not a + * `control_connection_t`. + **/ control_connection_t * TO_CONTROL_CONN(connection_t *c) { diff --git a/src/feature/dircommon/directory.c b/src/feature/dircommon/directory.c index 7f9f157a49..bb9264eaf9 100644 --- a/src/feature/dircommon/directory.c +++ b/src/feature/dircommon/directory.c @@ -79,8 +79,12 @@ * connection_finished_connecting() in connection.c */ -/** Convert a connection_t* to a dir_connection_t*; assert if the cast is - * invalid. */ +/** + * Cast a `connection_t *` to a `dir_connection_t *`. + * + * Exit with an assertion failure if the input is not a + * `dir_connection_t`. + **/ dir_connection_t * TO_DIR_CONN(connection_t *c) {

1 0

[tor/master] Changes file for CONST_TO_*() functions.
by dgoulet＠torproject.org 16 Jul '20

16 Jul '20

commit f0204a3c3453af3db734b03ad1ebafd151035174 Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Jul 16 10:34:44 2020 -0400 Changes file for CONST_TO_*() functions. Closes #40046. --- changes/ticket40046 | 3 +++ 1 file changed, 3 insertions(+) diff --git a/changes/ticket40046 b/changes/ticket40046 new file mode 100644 index 0000000000..68e1ed2544 --- /dev/null +++ b/changes/ticket40046 @@ -0,0 +1,3 @@ + o Code simplification and refactoring: + - Add and use a set of functions to perform downcasts on constant + connection and channel pointers. Closes ticket 40046.

1 0

[tor/master] Define new CONST_TO_*_CONN() functions for const-to-const casts
by dgoulet＠torproject.org 16 Jul '20

16 Jul '20

commit 47a48e2f5a384450679a544e7a1f26f378a26a78 Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Jul 16 10:07:21 2020 -0400 Define new CONST_TO_*_CONN() functions for const-to-const casts These names are analogous to the CONST_TO_*_CIRC() functions we have for circuits. Part of #40046. --- src/core/mainloop/connection.c | 12 ++++++++++++ src/core/mainloop/connection.h | 2 ++ src/core/or/connection_edge.c | 36 ++++++++++++++++++++++++++++++++++++ src/core/or/connection_edge.h | 4 ++++ src/core/or/connection_or.c | 11 +++++++++++ src/core/or/connection_or.h | 1 + src/feature/control/control.c | 12 ++++++++++++ src/feature/control/control.h | 1 + src/feature/dircommon/directory.c | 12 ++++++++++++ src/feature/dircommon/directory.h | 1 + 10 files changed, 92 insertions(+) diff --git a/src/core/mainloop/connection.c b/src/core/mainloop/connection.c index 216aeb68d1..20e38ac44b 100644 --- a/src/core/mainloop/connection.c +++ b/src/core/mainloop/connection.c @@ -233,6 +233,18 @@ TO_LISTENER_CONN(connection_t *c) return DOWNCAST(listener_connection_t, c); } +/** + * Cast a `const connection_t *` to a `const listener_connection_t *`. + * + * Exit with an assertion failure if the input is not a + * `listener_connection_t`. + **/ +const listener_connection_t * +CONST_TO_LISTENER_CONN(const connection_t *c) +{ + return TO_LISTENER_CONN((connection_t *)c); +} + size_t connection_get_inbuf_len(connection_t *conn) { diff --git a/src/core/mainloop/connection.h b/src/core/mainloop/connection.h index af45007676..ee3dce49f4 100644 --- a/src/core/mainloop/connection.h +++ b/src/core/mainloop/connection.h @@ -31,6 +31,8 @@ struct tor_addr_t; struct or_options_t; struct listener_connection_t *TO_LISTENER_CONN(struct connection_t *); +const struct listener_connection_t *CONST_TO_LISTENER_CONN( + const struct connection_t *); struct buf_t; diff --git a/src/core/or/connection_edge.c b/src/core/or/connection_edge.c index 30cfb18f0f..ed27fb1b57 100644 --- a/src/core/or/connection_edge.c +++ b/src/core/or/connection_edge.c @@ -180,6 +180,18 @@ TO_EDGE_CONN(connection_t *c) return DOWNCAST(edge_connection_t, c); } +/** + * Cast a `const connection_t *` to a `const edge_connection_t *`. + * + * Exit with an assertion failure if the input is not an + * `edge_connection_t`. + **/ +const edge_connection_t * +CONST_TO_EDGE_CONN(const connection_t *c) +{ + return TO_EDGE_CONN((connection_t *)c); +} + /** * Cast a `connection_t *` to an `entry_connection_t *`. * @@ -193,6 +205,18 @@ TO_ENTRY_CONN(connection_t *c) return (entry_connection_t*) SUBTYPE_P(c, entry_connection_t, edge_.base_); } +/** + * Cast a `const connection_t *` to a `const entry_connection_t *`. + * + * Exit with an assertion failure if the input is not an + * `entry_connection_t`. + **/ +const entry_connection_t * +CONST_TO_ENTRY_CONN(const connection_t *c) +{ + return TO_ENTRY_CONN((connection_t*) c); +} + /** * Cast an `edge_connection_t *` to an `entry_connection_t *`. * @@ -206,6 +230,18 @@ EDGE_TO_ENTRY_CONN(edge_connection_t *c) return (entry_connection_t*) SUBTYPE_P(c, entry_connection_t, edge_); } +/** + * Cast a `const edge_connection_t *` to a `const entry_connection_t *`. + * + * Exit with an assertion failure if the input is not an + * `entry_connection_t`. + **/ +const entry_connection_t * +CONST_EDGE_TO_ENTRY_CONN(const edge_connection_t *c) +{ + return EDGE_TO_ENTRY_CONN((edge_connection_t*)c); +} + /** An AP stream has failed/finished. If it hasn't already sent back * a socks reply, send one now (based on endreason). Also set * has_sent_end to 1, and mark the conn. diff --git a/src/core/or/connection_edge.h b/src/core/or/connection_edge.h index 8c06af5664..9b2cbb8532 100644 --- a/src/core/or/connection_edge.h +++ b/src/core/or/connection_edge.h @@ -20,6 +20,10 @@ edge_connection_t *TO_EDGE_CONN(connection_t *); entry_connection_t *TO_ENTRY_CONN(connection_t *); entry_connection_t *EDGE_TO_ENTRY_CONN(edge_connection_t *); +const edge_connection_t *CONST_TO_EDGE_CONN(const connection_t *); +const entry_connection_t *CONST_TO_ENTRY_CONN(const connection_t *); +const entry_connection_t *CONST_EDGE_TO_ENTRY_CONN(const edge_connection_t *); + #define EXIT_CONN_STATE_MIN_ 1 /** State for an exit connection: waiting for response from DNS farm. */ #define EXIT_CONN_STATE_RESOLVING 1 diff --git a/src/core/or/connection_or.c b/src/core/or/connection_or.c index e6dc62a475..91dcbe695b 100644 --- a/src/core/or/connection_or.c +++ b/src/core/or/connection_or.c @@ -111,6 +111,17 @@ TO_OR_CONN(connection_t *c) return DOWNCAST(or_connection_t, c); } +/** + * Cast a `const connection_t *` to a `const or_connection_t *`. + * + * Exit with an assertion failure if the input is not an `or_connnection_t`. + **/ +const or_connection_t * +CONST_TO_OR_CONN(const connection_t *c) +{ + return TO_OR_CONN((connection_t *)c); +} + /** Clear clear conn->identity_digest and update other data * structures as appropriate.*/ void diff --git a/src/core/or/connection_or.h b/src/core/or/connection_or.h index e9ace56ab4..fe81b5c5e1 100644 --- a/src/core/or/connection_or.h +++ b/src/core/or/connection_or.h @@ -16,6 +16,7 @@ struct ed25519_public_key_t; struct ed25519_keypair_t; or_connection_t *TO_OR_CONN(connection_t *); +const or_connection_t *CONST_TO_OR_CONN(const connection_t *); #include "core/or/orconn_event.h" diff --git a/src/feature/control/control.c b/src/feature/control/control.c index b5d4c31525..ef707319a6 100644 --- a/src/feature/control/control.c +++ b/src/feature/control/control.c @@ -74,6 +74,18 @@ TO_CONTROL_CONN(connection_t *c) return DOWNCAST(control_connection_t, c); } +/** + * Cast a `const connection_t *` to a `const control_connection_t *`. + * + * Exit with an assertion failure if the input is not a + * `control_connection_t`. + **/ +const control_connection_t * +CONST_TO_CONTROL_CONN(const connection_t *c) +{ + return TO_CONTROL_CONN((connection_t*)c); +} + /** Create and add a new controller connection on sock. If * CC_LOCAL_FD_IS_OWNER is set in flags, this Tor process should * exit when the connection closes. If CC_LOCAL_FD_IS_AUTHENTICATED diff --git a/src/feature/control/control.h b/src/feature/control/control.h index 7e72b2736b..f884286ec7 100644 --- a/src/feature/control/control.h +++ b/src/feature/control/control.h @@ -13,6 +13,7 @@ #define TOR_CONTROL_H control_connection_t *TO_CONTROL_CONN(connection_t *); +const control_connection_t *CONST_TO_CONTROL_CONN(const connection_t *); #define CONTROL_CONN_STATE_MIN_ 1 /** State for a control connection: Authenticated and accepting v1 commands. */ diff --git a/src/feature/dircommon/directory.c b/src/feature/dircommon/directory.c index bb9264eaf9..e92e6480af 100644 --- a/src/feature/dircommon/directory.c +++ b/src/feature/dircommon/directory.c @@ -92,6 +92,18 @@ TO_DIR_CONN(connection_t *c) return DOWNCAST(dir_connection_t, c); } +/** + * Cast a `const connection_t *` to a `const dir_connection_t *`. + * + * Exit with an assertion failure if the input is not a + * `dir_connection_t`. + **/ +const dir_connection_t * +CONST_TO_DIR_CONN(const connection_t *c) +{ + return TO_DIR_CONN((connection_t *)c); +} + /** Return false if the directory purpose dir_purpose * does not require an anonymous (three-hop) connection. * diff --git a/src/feature/dircommon/directory.h b/src/feature/dircommon/directory.h index 0f26cdeff9..0aa2ff53ef 100644 --- a/src/feature/dircommon/directory.h +++ b/src/feature/dircommon/directory.h @@ -13,6 +13,7 @@ #define TOR_DIRECTORY_H dir_connection_t *TO_DIR_CONN(connection_t *c); +const dir_connection_t *CONST_TO_DIR_CONN(const connection_t *c); #define DIR_CONN_STATE_MIN_ 1 /** State for connection to directory server: waiting for connect(). */

1 0

[tor/master] Define const variants for our channel_tls_t* casts.
by dgoulet＠torproject.org 16 Jul '20

16 Jul '20

commit b3eb4091579e59e4bf311713a3bef0f85137b1b0 Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Jul 16 10:11:13 2020 -0400 Define const variants for our channel_tls_t* casts. --- src/core/or/channeltls.c | 19 +++++++++++++++++++ src/core/or/channeltls.h | 4 ++++ 2 files changed, 23 insertions(+) diff --git a/src/core/or/channeltls.c b/src/core/or/channeltls.c index 082a035c3c..4a421462cc 100644 --- a/src/core/or/channeltls.c +++ b/src/core/or/channeltls.c @@ -389,6 +389,25 @@ channel_tls_from_base(channel_t *chan) return (channel_tls_t *)(chan); } +/** + * Cast a const channel_tls_t to a const channel_t. + */ +const channel_t * +channel_tls_to_base_const(const channel_tls_t *tlschan) +{ + return channel_tls_to_base((channel_tls_t*) tlschan); +} + +/** + * Cast a const channel_t to a const channel_tls_t, with appropriate + * type-checking asserts. + */ +const channel_tls_t * +channel_tls_from_base_const(const channel_t *chan) +{ + return channel_tls_from_base((channel_t *)chan); +} + /******************************************** * Method implementations for channel_tls_t * *******************************************/ diff --git a/src/core/or/channeltls.h b/src/core/or/channeltls.h index f04ce0fa9c..e7010a51fc 100644 --- a/src/core/or/channeltls.h +++ b/src/core/or/channeltls.h @@ -19,6 +19,8 @@ struct curve25519_public_key_t; #define BASE_CHAN_TO_TLS(c) (channel_tls_from_base((c))) #define TLS_CHAN_TO_BASE(c) (channel_tls_to_base((c))) +#define CONST_BASE_CHAN_TO_TLS(c) (channel_tls_from_base_const((c))) +#define CONST_TLS_CHAN_TO_BASE(c) (channel_tls_to_base_const((c))) #define TLS_CHAN_MAGIC 0x8a192427U @@ -44,6 +46,8 @@ channel_t * channel_tls_handle_incoming(or_connection_t *orconn); channel_t * channel_tls_to_base(channel_tls_t *tlschan); channel_tls_t * channel_tls_from_base(channel_t *chan); +const channel_t * channel_tls_to_base_const(const channel_tls_t *tlschan); +const channel_tls_t * channel_tls_from_base_const(const channel_t *chan); /* Things for connection_or.c to call back into */ void channel_tls_handle_cell(cell_t *cell, or_connection_t *conn);

1 0

[tor/master] Merge branch 'tor-gitlab/mr/54'
by dgoulet＠torproject.org 16 Jul '20

16 Jul '20

commit f6fc062119231a2f5cda1e841a14a3f912595532 Merge: 39b54bf1dd f0204a3c34 Author: David Goulet <dgoulet(a)torproject.org> Date: Thu Jul 16 12:55:26 2020 -0400 Merge branch 'tor-gitlab/mr/54' changes/ticket40046 | 3 ++ src/core/mainloop/connection.c | 24 +++++++++++--- src/core/mainloop/connection.h | 2 ++ src/core/or/channeltls.c | 23 ++++++++++++-- src/core/or/channeltls.h | 4 +++ src/core/or/connection_edge.c | 56 +++++++++++++++++++++++++++++++-- src/core/or/connection_edge.h | 4 +++ src/core/or/connection_or.c | 18 +++++++++-- src/core/or/connection_or.h | 1 + src/core/or/scheduler.c | 2 +- src/core/or/scheduler_kist.c | 2 +- src/feature/control/control.c | 20 ++++++++++-- src/feature/control/control.h | 1 + src/feature/control/control_bootstrap.c | 4 +-- src/feature/dircommon/directory.c | 22 +++++++++++-- src/feature/dircommon/directory.h | 1 + 16 files changed, 168 insertions(+), 19 deletions(-)

1 0

[tor/master] Merge branch 'tor-gitlab/merge-requests/53'
by ahf＠torproject.org 16 Jul '20

16 Jul '20

commit 39b54bf1dd7975a4a087a8f57e79c2a2202fe755 Merge: 10d8555e7d 9c653e58b4 Author: Alexander Færøy <ahf(a)torproject.org> Date: Thu Jul 16 14:19:18 2020 +0000 Merge branch 'tor-gitlab/merge-requests/53' changes/ticket40036 | 3 + doc/HACKING/tracing/EventsCircuit.md | 139 ++++++++++++++++++++++++++ doc/HACKING/{Tracing.md => tracing/README.md} | 0 3 files changed, 142 insertions(+)

1 0

[tor/master] doc: Document circuit subsystem tracing events
by ahf＠torproject.org 16 Jul '20

16 Jul '20

commit 9c653e58b41f12c58da060669fa148172f20127a Author: David Goulet <dgoulet(a)torproject.org> Date: Wed Jul 15 09:44:12 2020 -0400 doc: Document circuit subsystem tracing events Create a doc/tracing/ directory to contain a top level README.md which is the previously named Tracing.md and add the EventsCircuit.md which describes the circuit subsystem tracing events in depth. Closes #40036 Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- changes/ticket40036 | 3 + doc/HACKING/tracing/EventsCircuit.md | 139 ++++++++++++++++++++++++++ doc/HACKING/{Tracing.md => tracing/README.md} | 0 3 files changed, 142 insertions(+) diff --git a/changes/ticket40036 b/changes/ticket40036 new file mode 100644 index 0000000000..3586e44694 --- /dev/null +++ b/changes/ticket40036 @@ -0,0 +1,3 @@ + o Documentation (tracing): + - Document in depth the circuit subsystem trace events in the new + doc/tracing/EventsCircuit.md. Closes ticket 40036. diff --git a/doc/HACKING/tracing/EventsCircuit.md b/doc/HACKING/tracing/EventsCircuit.md new file mode 100644 index 0000000000..42abdda856 --- /dev/null +++ b/doc/HACKING/tracing/EventsCircuit.md @@ -0,0 +1,139 @@ +# Circuit Subsystem Trace Events + +The circuit subsystem emits a series of tracing events related to a circuit +object life cycle and its state change. + +This document describes each event as in what data they record and what they +represent. + +## Background + +There are two types of circuits: origin and OR (onion router). Both of them +are derived from a base object called a general circuit. + +- Origin circuits are the ones initiated by tor itself so client or onion + service circuits for instance. + +- OR circuits are the ones going through us that we have not initiated and + thus only seen by relays. + +Many operations are done on the base (general) circuit, and some are specific +to an origin or OR. The following section describes each of them by circuit +type. + +## Trace Events + +For the LTTng tracer, the subsystem name of these events is: `tor_circuit`. + +Also, unless specified otherwise, every event emits a common set of parameters +thus they should always be expected in the following order: + +- `circ_id`: For an origin circuit, this is the global circuit identifier used + in a cell. For an OR circuit, the value is 0. + +- `purpose`: Purpose of the circuit as in what it is used for. Note that this + can change during the lifetime of a circuit. See `CIRCUIT_PURPOSE_*` in + `core/or/circuitlist.h` for an exhaustive list of the possible values. + +- `state`: State of a circuit. This changes during the lifetime of a circuit. + See `CIRCUIT_STATE_*` in `core/or/circuitlist.h` for an exhaustive list of + the possible values. + +Now, the tracing events. + +### General Circuit (`circuit_t`) + +The following events are triggered for the base circuit object and thus apply +to all types of circuits. + + * `free`: A circuit object is freed that is memory is released and not + usable anymore. After this event, no more events will be emitted for the + specific circuit object. + + * `mark_for_close`: A circuit object is marked for close that is scheduled + to be closed in a later mainloop periodic event. + + Extra parameters: + + - `end_reason`: Reason why the circuit is closed. Tor often changes that + reason to something generic sometimes in order to avoid leaking internal + reasons to the end point. Thus, this value can be different from + orig_close_reason. + + - `orig_close_reason`: Original reason why the circuit is closed. That + value never changes and contains the internal reason why we close it. It + is **never** this reason that is sent back on the circuit. + + * `change_purpose`: Purpose change. + + Extra parameters: + + (`purpose` parameter is not present) + + - `old_purpose`: Previous purpose that is no longer. + + - `new_purpose`: New purpose assigned to the circuit. + + * `change_state`: State change. + + Extra parameters: + + (`state` parameter is not present) + + - `old_state`: Previous state that is no longer. + + - `new_state`: New state assigned to the circuit. + +### Origin Circuit (`origin_circuit_t`) + +The following events are triggered only for origin circuits. + + * `new_origin`: New origin circuit has been created meaning it has been + newly allocated, initialized and added to the global list. + + * `establish`: Circuit is being established. This is the initial first step + where the path was selected and a connection to the first hop has been + launched. + + * `cannibalized`: Circuit has been cannibalized. This happens when we have + an already opened unused circuit (preemptive circuits) and it was picked. + + * `first_onion_skin`: First onion skin was sent that is the handshake with + the first hop. + + Extra parameters: + + - `fingerprint`: Identity digest (RSA) of the first hop. + + * `intermediate_onion_skin`: An intermediate onion skin was sent which can + be why any hops after the first one. There is thus `N - 1` of these events + where `N` is the total number of hops in the path. + + Extra parameters: + + - `fingerprint`: Identity digest (RSA) of the next hop. + + * `opened`: Circuit just became opened which means that all hops down the + path have negotiated the handshake between them and us and the circuit is + now ready to send cells. + + * `timeout`: Circuit has timed out that is we waited too long for the + circuit to be built. + + * `idle_timeout`: Circuit has timed out due to idleness. This is controlled + by the MaxCircuitDirtiness parameter which is 10 min by default. + +For the common use case of a 3-hop circuit, the following events should be +seen in this order: + + `new_origin` -> `establish` -> `first_onion_skin` -> + `intermediate_onion_skin` -> `intermediate_onion_skin` -> `opened` + +### OR Circuit (`or_circuit_t`) + +The following events are triggered only for OR circuits. For each of them, the +`circ_id` parameter is not present since it would always be 0. The `purpose` +and `state` remain. + + * `new_or`: New OR circuit has been created meaning it has been newly + allocated, initialized and added to the global list. diff --git a/doc/HACKING/Tracing.md b/doc/HACKING/tracing/README.md similarity index 100% rename from doc/HACKING/Tracing.md rename to doc/HACKING/tracing/README.md

1 0

[tor/master] Apply SafeLogging in connection_describe_peer().
by nickm＠torproject.org 16 Jul '20

16 Jul '20

commit 8fbafd14021c9c9ec9b2e3f57752b96b8d2c809d Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Jul 13 14:42:30 2020 -0400 Apply SafeLogging in connection_describe_peer(). --- src/core/mainloop/connection.c | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/core/mainloop/connection.c b/src/core/mainloop/connection.c index a91bc6408f..bde002fd2e 100644 --- a/src/core/mainloop/connection.c +++ b/src/core/mainloop/connection.c @@ -389,6 +389,7 @@ connection_describe_peer_internal(const connection_t *conn, const tor_addr_t *addr = &conn->addr; const char *address = NULL; const char *prep; + bool scrub = false; char extra_buf[128]; extra_buf[0] = 0; @@ -423,6 +424,7 @@ connection_describe_peer_internal(const connection_t *conn, /* We report the IDs we're talking to... */ if (fast_digest_is_zero(or_conn->identity_digest)) { strlcpy(id_buf, "unknown", sizeof(id_buf)); + scrub = true; // This could be a client, so scrub it. } else { base16_encode(id_buf, sizeof(id_buf), or_conn->identity_digest, DIGEST_LEN); @@ -439,6 +441,7 @@ connection_describe_peer_internal(const connection_t *conn, } } } else if (conn->type == CONN_TYPE_EXIT) { + scrub = true; /* This is a client's request; scrub it with SafeLogging. */ if (tor_addr_is_null(addr)) { address = conn->address; strlcpy(extra_buf, " (DNS lookup pending)", sizeof(extra_buf)); @@ -458,6 +461,10 @@ connection_describe_peer_internal(const connection_t *conn, } } + if (scrub) { + address = safe_str(address); + } + const char *sp = include_preposition ? " " : ""; if (! include_preposition) prep = "";

1 0