describe.c File Reference

Format short descriptions of relays. More...

#include "core/or/or.h"
#include "core/or/extendinfo.h"
#include "feature/nodelist/describe.h"
#include "feature/nodelist/nodelist.h"
#include "feature/nodelist/routerinfo.h"
#include "lib/crypt_ops/crypto_ed25519.h"
#include "lib/crypt_ops/crypto_format.h"
#include "core/or/extend_info_st.h"
#include "feature/nodelist/node_st.h"
#include "feature/nodelist/routerinfo_st.h"
#include "feature/nodelist/routerstatus_st.h"
#include "feature/nodelist/microdesc_st.h"

Go to the source code of this file.

Functions
STATIC const char *	format_node_description (char *buf, const char *rsa_id_digest, const ed25519_public_key_t *ed25519_id, const char *nickname, const tor_addr_t *ipv4_addr, const tor_addr_t *ipv6_addr)
const char *	router_describe (const routerinfo_t *ri)
const char *	node_describe (const node_t *node)
const char *	routerstatus_describe (const routerstatus_t *rs)
const char *	extend_info_describe (const extend_info_t *ei)
void	router_get_verbose_nickname (char *buf, const routerinfo_t *router)

Detailed Description

Format short descriptions of relays.

Definition in file describe.c.

Macro Definition Documentation

DESCRIBE_PRIVATE

#define DESCRIBE_PRIVATE

Definition at line 12 of file describe.c.

Function Documentation

extend_info_describe()

const char * extend_info_describe

(

const extend_info_t *

ei

)

Return a human-readable description of the extend_info_t ei.

This function is not thread-safe. Each call to this function invalidates previous values returned by this function.

Definition at line 224 of file describe.c.

Referenced by can_relaunch_service_rendezvous_point(), circuit_extend_to_new_exit(), circuit_get_open_circ_or_launch(), circuit_handle_first_hop(), client_rendezvous_circ_has_opened(), connection_ap_expire_beginning(), handle_introduce_ack_bad(), hs_circ_launch_intro_point(), hs_client_reextend_intro_circuit(), launch_intro_point_circuits(), launch_rendezvous_point_circuit(), onion_extend_cpath(), onion_pick_cpath_exit(), retry_service_rendezvous_point(), and warn_if_last_router_excluded().

format_node_description()

STATIC const char * format_node_description	(	char *	buf,
		const char *	rsa_id_digest,
		const ed25519_public_key_t *	ed25519_id,
		const char *	nickname,
		const tor_addr_t *	ipv4_addr,
		const tor_addr_t *	ipv6_addr
	)

Use buf (which must be at least NODE_DESC_BUF_LEN bytes long) to hold a human-readable description of a node with identity digest id_digest, nickname nickname, and addresses addr32h and addr.

The nickname, ipv6_addr and ipv4_addr fields are optional and may be set to NULL or the null address.

Return a pointer to the front of buf. If buf is NULL, return a string constant describing the error.

Definition at line 40 of file describe.c.

Referenced by extend_info_describe(), node_describe(), router_describe(), and routerstatus_describe().

node_describe()

const char * node_describe

(

const node_t *

node

)

Return a human-readable description of the node_t node.

This function is not thread-safe. Each call to this function invalidates previous values returned by this function.

Definition at line 160 of file describe.c.

Referenced by adjust_exit_policy_from_exitpolicy_failure(), choose_good_exit_server_general(), circuit_send_first_onion_skin(), command_process_create_cell(), connection_ap_handshake_rewrite_and_attach(), entry_guard_add_to_sample(), extend_info_from_node(), hs_get_responsible_hsdirs(), link_apconn_to_circ(), node_log_dup_ed_id(), pick_intro_point(), router_set_status(), and upload_descriptor_to_hsdir().

router_describe()

const char * router_describe

(

const routerinfo_t *

ri

)

Return a human-readable description of the routerinfo_t ri.

This function is not thread-safe. Each call to this function invalidates previous values returned by this function.

Definition at line 137 of file describe.c.

Referenced by authdir_wants_to_reject_router(), directory_remove_invalid(), dirserv_add_descriptor(), dirserv_orconn_tls_done(), dirserv_router_get_status(), dirserv_router_has_valid_address(), dirserv_should_launch_reachability_test(), learned_bridge_descriptor(), router_add_to_routerlist(), router_parse_list_from_string(), and routerlist_remove_old_routers().

router_get_verbose_nickname()

void router_get_verbose_nickname	(	char *	buf,
		const routerinfo_t *	router
	)

Set buf (which must have MAX_VERBOSE_NICKNAME_LEN+1 bytes) to the verbose representation of the identity of router. The format is: A dollar sign. The upper-case hexadecimal encoding of the SHA1 hash of router's identity. A "=" if the router is named (no longer implemented); a "~" if it is not. The router's nickname.

Definition at line 256 of file describe.c.

Referenced by control_event_descriptors_changed().

routerstatus_describe()

const char * routerstatus_describe

(

const routerstatus_t *

rs

)

Return a human-readable description of the routerstatus_t rs.

This function is not thread-safe. Each call to this function invalidates previous values returned by this function.

Definition at line 203 of file describe.c.

Referenced by directory_launch_v3_desc_fetch(), directory_request_set_dir_from_routerstatus(), networkstatus_verify_bw_weights(), and update_consensus_router_descriptor_downloads().