|
Tor 0.4.9.0-alpha-dev
|
Header file containing circuit data for the whole HS subsystem. More...
#include "core/or/or.h"#include "lib/crypt_ops/crypto_ed25519.h"#include "feature/hs/hs_cell.h"#include "feature/hs/hs_service.h"Go to the source code of this file.
Data Structures | |
| struct | pending_rend_t |
Header file containing circuit data for the whole HS subsystem.
Definition in file hs_circuit.h.
| void hs_circ_cleanup_on_close | ( | circuit_t * | circ | ) |
Circuit cleanup strategy:
What follows is a series of functions that notifies the HS subsystem of 3 different circuit cleanup phase: close, free and repurpose.
Tor can call any of those in any orders so they have to be safe between each other. In other words, the free should never depend on close to be called before.
The "on_close()" is called from circuit_mark_for_close() which is considered the tor fast path and thus as little work as possible should done in that function. Currently, we only remove the circuit from the HS circuit map and move on.
The "on_free()" is called from circuit circuit_free_() and it is very important that at the end of the function, no state or objects related to this circuit remains alive.
The "on_repurpose()" is called from circuit_change_purpose() for which we simply remove it from the HS circuit map. We do not have other cleanup requirements after that.
NOTE: The onion service code, specifically the service code, cleans up lingering objects or state if any of its circuit disappear which is why our cleanup strategy doesn't involve any service specific actions. As long as the circuit is removed from the HS circuit map, it won't be used. We are about to close this circ. Clean it up from any related HS data structures. This function can be called multiple times safely for the same circuit.
Definition at line 1605 of file hs_circuit.c.
| void hs_circ_cleanup_on_free | ( | circuit_t * | circ | ) |
We are about to free this circ. Clean it up from any related HS data structures. This function can be called multiple times safely for the same circuit.
Definition at line 1631 of file hs_circuit.c.
Referenced by circuit_free_().
| void hs_circ_cleanup_on_repurpose | ( | circuit_t * | circ | ) |
We are about to repurpose this circ. Clean it up from any related HS data structures. This function can be called multiple times safely for the same circuit.
Definition at line 1652 of file hs_circuit.c.
| int hs_circ_handle_intro_established | ( | const hs_service_t * | service, |
| const hs_service_intro_point_t * | ip, | ||
| origin_circuit_t * | circ, | ||
| const uint8_t * | payload, | ||
| size_t | payload_len | ||
| ) |
Circ has been expecting an INTRO_ESTABLISHED cell that just arrived. Handle the INTRO_ESTABLISHED cell payload of length payload_len arriving on the given introduction circuit circ. The service is only used for logging purposes. Return 0 on success else a negative value.
Definition at line 1223 of file hs_circuit.c.
| bool hs_circ_is_rend_sent_in_intro1 | ( | const origin_circuit_t * | circ | ) |
Return true iff the given established client rendezvous circuit was sent into the INTRODUCE1 cell. This is called so we can take a decision on expiring or not the circuit.
The caller MUST make sure the circuit is an established client rendezvous circuit (purpose: CIRCUIT_PURPOSE_C_REND_READY).
This function supports all onion service versions.
Definition at line 1685 of file hs_circuit.c.
| int hs_circ_launch_intro_point | ( | hs_service_t * | service, |
| const hs_service_intro_point_t * | ip, | ||
| extend_info_t * | ei, | ||
| bool | direct_conn | ||
| ) |
For a given service and a service intro point, launch a circuit to the extend info ei. If the service is a single onion, and direct_conn is true, a one-hop circuit will be requested.
Return 0 if the circuit was successfully launched and tagged with the correct identifier. On error, a negative value is returned.
Definition at line 1025 of file hs_circuit.c.
| void hs_circ_retry_service_rendezvous_point | ( | const origin_circuit_t * | circ | ) |
Called when we fail building a rendezvous circuit at some point other than the last hop: launches a new circuit to the same rendezvous point.
We currently relaunch connections to rendezvous points if:
We avoid relaunching a connection to this rendezvous point if:
Definition at line 999 of file hs_circuit.c.
Referenced by hs_circ_cleanup_on_repurpose().
| int hs_circ_send_establish_rendezvous | ( | origin_circuit_t * | circ | ) |
Send an ESTABLISH_RENDEZVOUS cell along the rendezvous circuit circ. On success, 0 is returned else -1 and the circuit is marked for close.
Definition at line 1525 of file hs_circuit.c.
| origin_circuit_t * hs_circ_service_get_established_intro_circ | ( | const hs_service_intro_point_t * | ip | ) |
Return an introduction point established circuit matching the given intro point object. The circuit purpose has to be CIRCUIT_PURPOSE_S_INTRO. NULL is returned is no such circuit can be found.
Definition at line 972 of file hs_circuit.c.
| origin_circuit_t * hs_circ_service_get_intro_circ | ( | const hs_service_intro_point_t * | ip | ) |
Return an introduction point circuit matching the given intro point object. NULL is returned is no such circuit can be found.
Definition at line 961 of file hs_circuit.c.
Referenced by should_remove_intro_point().
| int hs_circ_service_intro_has_opened | ( | hs_service_t * | service, |
| hs_service_intro_point_t * | ip, | ||
| const hs_service_descriptor_t * | desc, | ||
| origin_circuit_t * | circ | ||
| ) |
Called when a service introduction point circuit is done building. Given the service and intro point object, this function will send the ESTABLISH_INTRO cell on the circuit. Return 0 on success. Return 1 if the circuit has been repurposed to General because we already have too many opened.
Definition at line 1083 of file hs_circuit.c.
| void hs_circ_service_rp_has_opened | ( | const hs_service_t * | service, |
| origin_circuit_t * | circ | ||
| ) |
Called when a service rendezvous point circuit is done building. Given the service and the circuit, this function will send a RENDEZVOUS1 cell on the circuit using the information in the circuit identifier. If the cell can't be sent, the circuit is closed.
Definition at line 1151 of file hs_circuit.c.
| void hs_circ_setup_congestion_control | ( | origin_circuit_t * | origin_circ, |
| uint8_t | sendme_inc, | ||
| bool | is_single_onion | ||
| ) |
Setup on the given circuit congestion control with the given parameters.
This function assumes that congestion control is enabled on the network and so it is the caller responsability to make sure of it.
Definition at line 928 of file hs_circuit.c.
Referenced by setup_rendezvous_circ_congestion_control().
| int hs_circuit_setup_e2e_rend_circ | ( | origin_circuit_t * | circ, |
| const uint8_t * | ntor_key_seed, | ||
| size_t | seed_len, | ||
| int | is_service_side | ||
| ) |
Circuit circ just finished the rend ntor key exchange. Use the key exchange output material at ntor_key_seed and setup circ to serve as a rendezvous end-to-end circuit between the client and the service. If is_service_side is set, then we are the hidden service and the other side is the client.
Return 0 if the operation went well; in case of error return -1.
Definition at line 1405 of file hs_circuit.c.
| void rend_pqueue_clear | ( | hs_pow_service_state_t * | pow_state | ) |
Abandon and free all pending rend requests, leaving the pqueue empty.
Definition at line 748 of file hs_circuit.c.
Referenced by hs_pow_free_service_state().
| int top_of_rend_pqueue_is_worthwhile | ( | hs_pow_service_state_t * | pow_state | ) |
Peek at the top entry on the pending rend pqueue, which must not be empty. If its level of effort is at least what we're suggesting for that service right now, return 1, else return 0.
Definition at line 732 of file hs_circuit.c.
1.9.4