hs_common.c File Reference

Contains code shared between different HS protocol version as well as useful data structures and accessors used by other subsystems. The rendcommon.c should only contains code relating to the v2 protocol. More...

#include "or.h"
#include "config.h"
#include "circuitbuild.h"
#include "crypto_rand.h"
#include "crypto_util.h"
#include "networkstatus.h"
#include "nodelist.h"
#include "hs_cache.h"
#include "hs_common.h"
#include "hs_client.h"
#include "hs_ident.h"
#include "hs_service.h"
#include "hs_circuitmap.h"
#include "policies.h"
#include "rendcommon.h"
#include "rendservice.h"
#include "routerset.h"
#include "router.h"
#include "shared_random_client.h"
#include "dirauth/shared_random_state.h"
#include "ed25519_cert.h"

Include dependency graph for hs_common.c:

Macros
#define	HS_COMMON_PRIVATE
#define	MAX_REND_FAILURES_DEFAULT   2
#define	MAX_REND_FAILURES_MIN   1
#define	MAX_REND_FAILURES_MAX   10

Functions
char *	hs_path_from_filename (const char *directory, const char *filename)
int	hs_check_service_private_dir (const char *username, const char *path, unsigned int dir_group_readable, unsigned int create)
int	hs_get_service_max_rend_failures (void)
STATIC uint64_t	get_time_period_length (void)
uint64_t	hs_get_time_period_num (time_t now)
uint64_t	hs_get_next_time_period_num (time_t now)
uint64_t	hs_get_previous_time_period_num (time_t now)
time_t	hs_get_start_time_of_next_time_period (time_t now)
void	rend_data_free_ (rend_data_t *data)
rend_data_t *	rend_data_dup (const rend_data_t *data)
rend_data_t *	rend_data_service_create (const char *onion_address, const char *pk_digest, const uint8_t *cookie, rend_auth_type_t auth_type)
rend_data_t *	rend_data_client_create (const char *onion_address, const char *desc_id, const char *cookie, rend_auth_type_t auth_type)
const char *	rend_data_get_address (const rend_data_t *rend_data)
const char *	rend_data_get_desc_id (const rend_data_t *rend_data, uint8_t replica, size_t *len_out)
const uint8_t *	rend_data_get_pk_digest (const rend_data_t *rend_data, size_t *len_out)
STATIC void	get_disaster_srv (uint64_t time_period_num, uint8_t *srv_out)
void	hs_get_subcredential (const ed25519_public_key_t *identity_pk, const ed25519_public_key_t *blinded_pk, uint8_t *subcred_out)
int	hs_set_conn_addr_port (const smartlist_t *ports, edge_connection_t *conn)
int	hs_parse_address (const char *address, ed25519_public_key_t *key_out, uint8_t *checksum_out, uint8_t *version_out)
int	hs_address_is_valid (const char *address)
void	hs_build_address (const ed25519_public_key_t *key, uint8_t version, char *addr_out)
link_specifier_t *	hs_link_specifier_dup (const link_specifier_t *lspec)
void	hs_build_blinded_pubkey (const ed25519_public_key_t *pk, const uint8_t *secret, size_t secret_len, uint64_t time_period_num, ed25519_public_key_t *blinded_pk_out)
void	hs_build_blinded_keypair (const ed25519_keypair_t *kp, const uint8_t *secret, size_t secret_len, uint64_t time_period_num, ed25519_keypair_t *blinded_kp_out)
	MOCK_IMPL (int, hs_in_period_between_tp_and_srv,(const networkstatus_t *consensus, time_t now))
int	hs_service_requires_uptime_circ (const smartlist_t *ports)
void	hs_build_hs_index (uint64_t replica, const ed25519_public_key_t *blinded_pk, uint64_t period_num, uint8_t *hs_index_out)
void	hs_build_hsdir_index (const ed25519_public_key_t *identity_pk, const uint8_t *srv_value, uint64_t period_num, uint8_t *hsdir_index_out)
uint8_t *	hs_get_current_srv (uint64_t time_period_num, const networkstatus_t *ns)
uint8_t *	hs_get_previous_srv (uint64_t time_period_num, const networkstatus_t *ns)
int32_t	hs_get_hsdir_n_replicas (void)
int32_t	hs_get_hsdir_spread_fetch (void)
int32_t	hs_get_hsdir_spread_store (void)
void	hs_get_responsible_hsdirs (const ed25519_public_key_t *blinded_pk, uint64_t time_period_num, int use_second_hsdir_index, int for_fetching, smartlist_t *responsible_dirs)
time_t	hs_hsdir_requery_period (const or_options_t *options)
STATIC strmap_t *	get_last_hid_serv_requests (void)
time_t	hs_lookup_last_hid_serv_request (routerstatus_t *hs_dir, const char *req_key_str, time_t now, int set)
void	hs_clean_last_hid_serv_requests (time_t now)
void	hs_purge_hid_serv_from_last_hid_serv_requests (const char *req_key_str)
void	hs_purge_last_hid_serv_requests (void)
routerstatus_t *	hs_pick_hsdir (smartlist_t *responsible_dirs, const char *req_key_str)
extend_info_t *	hs_get_extend_info_from_lspecs (const smartlist_t *lspecs, const curve25519_public_key_t *onion_key, int direct_conn)
void	hs_init (void)
void	hs_free_all (void)
void	hs_dec_rdv_stream_counter (origin_circuit_t *circ)
void	hs_inc_rdv_stream_counter (origin_circuit_t *circ)

Detailed Description

Contains code shared between different HS protocol version as well as useful data structures and accessors used by other subsystems. The rendcommon.c should only contains code relating to the v2 protocol.

Function Documentation

get_disaster_srv()

STATIC void get_disaster_srv	(	uint64_t	time_period_num,
		uint8_t *	srv_out
	)

Compute the disaster SRV value for this time_period_num and put it in srv_out (of size at least DIGEST256_LEN). First check our caches to see if we have already computed it.

get_last_hid_serv_requests()

STATIC strmap_t* get_last_hid_serv_requests

(

void

)

Returns last_hid_serv_requests_, initializing it to a new strmap if necessary.

Here is the caller graph for this function:

get_time_period_length()

STATIC uint64_t get_time_period_length

(

void

)

Get the default HS time period length in minutes from the consensus.

Here is the call graph for this function:

Here is the caller graph for this function:

hs_clean_last_hid_serv_requests()

void hs_clean_last_hid_serv_requests

(

time_t

now

)

Clean the history of request times to hidden service directories, so that it does not contain requests older than REND_HID_SERV_DIR_REQUERY_PERIOD seconds any more.

Here is the call graph for this function:

Here is the caller graph for this function:

hs_get_next_time_period_num()

uint64_t hs_get_next_time_period_num

(

time_t

now

)

Get the number of the upcoming HS time period, given that the current time is now. If now is not set, we try to get the time from a live consensus.

Here is the call graph for this function:

hs_get_service_max_rend_failures()

int hs_get_service_max_rend_failures

(

void

)

How many times will a hidden service operator attempt to connect to a requested rendezvous point before giving up?

hs_get_time_period_num()

uint64_t hs_get_time_period_num

(

time_t

now

)

Get the HS time period number at time now. If now is not set, we try to get the time ourselves from a live consensus.

Here is the call graph for this function:

Here is the caller graph for this function:

hs_hsdir_requery_period()

time_t hs_hsdir_requery_period

(

const or_options_t *

options

)

Return the period for which a hidden service directory cannot be queried for the same descriptor ID again, taking TestingTorNetwork into account.

Here is the caller graph for this function:

hs_lookup_last_hid_serv_request()

time_t hs_lookup_last_hid_serv_request	(	routerstatus_t *	hs_dir,
		const char *	req_key_str,
		time_t	now,
		int	set
	)

Look up the last request time to hidden service directory hs_dir for descriptor request key req_key_str which is the descriptor ID for a v2 service or the blinded key for v3. If set is non-zero, assign the current time now and return that. Otherwise, return the most recent request time, or 0 if no such request has been sent before.

Here is the call graph for this function:

Here is the caller graph for this function:

hs_pick_hsdir()

routerstatus_t* hs_pick_hsdir	(	smartlist_t *	responsible_dirs,
		const char *	req_key_str
	)

Given the list of responsible HSDirs in responsible_dirs, pick the one that we should use to fetch a descriptor right now. Take into account previous failed attempts at fetching this descriptor from HSDirs using the string identifier req_key_str.

Steals ownership of responsible_dirs.

Return the routerstatus of the chosen HSDir if successful, otherwise return NULL if no HSDirs are worth trying right now.

Here is the call graph for this function:

hs_purge_hid_serv_from_last_hid_serv_requests()

void hs_purge_hid_serv_from_last_hid_serv_requests

(

const char *

req_key_str

)

Remove all requests related to the descriptor request key string req_key_str from the history of times of requests to hidden service directories.

This is called from rend_client_note_connection_attempt_ended(), which must be idempotent, so any future changes to this function must leave it idempotent too.

Here is the call graph for this function:

hs_purge_last_hid_serv_requests()

void hs_purge_last_hid_serv_requests

(

void

)

Purge the history of request times to hidden service directories, so that future lookups of an HS descriptor will not fail because we accessed all of the HSDir relays responsible for the descriptor recently.

Here is the caller graph for this function:

rend_data_free_()

void rend_data_free_

(

rend_data_t *

data

)

Free all storage associated with data