Tor 0.4.9.0-alpha-dev
control_fmt.c
Go to the documentation of this file.
1/* Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
2 * Copyright (c) 2007-2021, The Tor Project, Inc. */
3/* See LICENSE for licensing information */
4
5/**
6 * \file control_fmt.c
7 * \brief Formatting functions for controller data.
8 */
9
10#include "core/or/or.h"
11
14#include "core/or/circuitlist.h"
19
26
27/** Given an AP connection <b>conn</b> and a <b>len</b>-character buffer
28 * <b>buf</b>, determine the address:port combination requested on
29 * <b>conn</b>, and write it to <b>buf</b>. Return 0 on success, -1 on
30 * failure. */
31int
33{
34 char buf2[256];
35 if (conn->chosen_exit_name)
36 if (tor_snprintf(buf2, sizeof(buf2), ".%s.exit", conn->chosen_exit_name)<0)
37 return -1;
38 if (!conn->socks_request)
39 return -1;
40 if (tor_snprintf(buf, len, "%s%s%s:%d",
42 conn->chosen_exit_name ? buf2 : "",
44 ENTRY_TO_EDGE_CONN(conn)) ? ".onion" : "",
45 conn->socks_request->port)<0)
46 return -1;
47 return 0;
48}
49
50/** Figure out the best name for the target router of an OR connection
51 * <b>conn</b>, and write it into the <b>len</b>-character buffer
52 * <b>name</b>. */
53void
55{
56 const node_t *node = node_get_by_id(conn->identity_digest);
57 if (node) {
60 } else if (! tor_digest_is_zero(conn->identity_digest)) {
61 name[0] = '$';
62 base16_encode(name+1, len-1, conn->identity_digest,
64 } else {
65 tor_snprintf(name, len, "%s:%d",
66 conn->base_.address, conn->base_.port);
67 }
68}
69
70/** Allocate and return a description of <b>circ</b>'s current status,
71 * including its path (if any). */
72char *
74{
75 char *rv;
76 smartlist_t *descparts = smartlist_new();
77
78 {
79 char *vpath = circuit_list_path_for_controller(circ);
80 if (*vpath) {
81 smartlist_add(descparts, vpath);
82 } else {
83 tor_free(vpath); /* empty path; don't put an extra space in the result */
84 }
85 }
86
87 {
88 cpath_build_state_t *build_state = circ->build_state;
89 smartlist_t *flaglist = smartlist_new();
90 char *flaglist_joined;
91
92 if (build_state->onehop_tunnel)
93 smartlist_add(flaglist, (void *)"ONEHOP_TUNNEL");
94 if (build_state->is_internal)
95 smartlist_add(flaglist, (void *)"IS_INTERNAL");
96 if (build_state->need_capacity)
97 smartlist_add(flaglist, (void *)"NEED_CAPACITY");
98 if (build_state->need_uptime)
99 smartlist_add(flaglist, (void *)"NEED_UPTIME");
100
101 /* Only emit a BUILD_FLAGS argument if it will have a non-empty value. */
102 if (smartlist_len(flaglist)) {
103 flaglist_joined = smartlist_join_strings(flaglist, ",", 0, NULL);
104
105 smartlist_add_asprintf(descparts, "BUILD_FLAGS=%s", flaglist_joined);
106
107 tor_free(flaglist_joined);
108 }
109
110 smartlist_free(flaglist);
111 }
112
113 smartlist_add_asprintf(descparts, "PURPOSE=%s",
115
116 {
117 const char *hs_state =
119
120 if (hs_state != NULL) {
121 smartlist_add_asprintf(descparts, "HS_STATE=%s", hs_state);
122 }
123 }
124
125 if (circ->hs_ident != NULL) {
126 char addr[HS_SERVICE_ADDR_LEN_BASE32 + 1];
127 const char *onion_address;
129 onion_address = addr;
130 smartlist_add_asprintf(descparts, "REND_QUERY=%s", onion_address);
131 }
132
133 {
134 char tbuf[ISO_TIME_USEC_LEN+1];
136
137 smartlist_add_asprintf(descparts, "TIME_CREATED=%s", tbuf);
138 }
139
140 // Show username and/or password if available.
141 if (circ->socks_username_len > 0) {
142 char* socks_username_escaped = esc_for_log_len(circ->socks_username,
143 (size_t) circ->socks_username_len);
144 smartlist_add_asprintf(descparts, "SOCKS_USERNAME=%s",
145 socks_username_escaped);
146 tor_free(socks_username_escaped);
147 }
148 if (circ->socks_password_len > 0) {
149 char* socks_password_escaped = esc_for_log_len(circ->socks_password,
150 (size_t) circ->socks_password_len);
151 smartlist_add_asprintf(descparts, "SOCKS_PASSWORD=%s",
152 socks_password_escaped);
153 tor_free(socks_password_escaped);
154 }
155
156 /* Attach the proof-of-work solution effort, if it's nonzero. Clients set
157 * this to the effort they've chosen, services set this to a value that
158 * was provided by the client and then verified by the service. */
159 if (circ->hs_pow_effort > 0) {
160 smartlist_add_asprintf(descparts, "HS_POW=v1,%u", circ->hs_pow_effort);
161 }
162
163 rv = smartlist_join_strings(descparts, " ", 0, NULL);
164
165 SMARTLIST_FOREACH(descparts, char *, cp, tor_free(cp));
166 smartlist_free(descparts);
167
168 return rv;
169}
170
171/** Allocate and return a description of <b>conn</b>'s current status. */
172char *
174{
175 char *rv;
176 smartlist_t *descparts = smartlist_new();
177
178 if (conn->socks_request != NULL) {
179 // Show username and/or password if available; used by IsolateSOCKSAuth.
180 if (conn->socks_request->usernamelen > 0) {
181 char* username_escaped = esc_for_log_len(conn->socks_request->username,
182 (size_t) conn->socks_request->usernamelen);
183 smartlist_add_asprintf(descparts, "SOCKS_USERNAME=%s",
184 username_escaped);
185 tor_free(username_escaped);
186 }
187 if (conn->socks_request->passwordlen > 0) {
188 char* password_escaped = esc_for_log_len(conn->socks_request->password,
189 (size_t) conn->socks_request->passwordlen);
190 smartlist_add_asprintf(descparts, "SOCKS_PASSWORD=%s",
191 password_escaped);
192 tor_free(password_escaped);
193 }
194
195 const char *client_protocol;
196 // Show the client protocol; used by IsolateClientProtocol.
197 switch (conn->socks_request->listener_type)
198 {
200 switch (conn->socks_request->socks_version)
201 {
202 case 4: client_protocol = "SOCKS4"; break;
203 case 5: client_protocol = "SOCKS5"; break;
204 default: client_protocol = "UNKNOWN";
205 }
206 break;
207 case CONN_TYPE_AP_TRANS_LISTENER: client_protocol = "TRANS"; break;
208 case CONN_TYPE_AP_NATD_LISTENER: client_protocol = "NATD"; break;
209 case CONN_TYPE_AP_DNS_LISTENER: client_protocol = "DNS"; break;
211 client_protocol = "HTTPCONNECT"; break;
213 client_protocol = "METRICS"; break;
214 default: client_protocol = "UNKNOWN";
215 }
216 smartlist_add_asprintf(descparts, "CLIENT_PROTOCOL=%s",
217 client_protocol);
218 }
219
220 // Show newnym epoch; used for stream isolation when NEWNYM is used.
221 smartlist_add_asprintf(descparts, "NYM_EPOCH=%u",
222 conn->nym_epoch);
223
224 // Show session group; used for stream isolation of multiple listener ports.
225 smartlist_add_asprintf(descparts, "SESSION_GROUP=%d",
226 conn->entry_cfg.session_group);
227
228 // Show isolation flags.
229 smartlist_t *isoflaglist = smartlist_new();
230 char *isoflaglist_joined;
231 if (conn->entry_cfg.isolation_flags & ISO_DESTPORT) {
232 smartlist_add(isoflaglist, (void *)"DESTPORT");
233 }
234 if (conn->entry_cfg.isolation_flags & ISO_DESTADDR) {
235 smartlist_add(isoflaglist, (void *)"DESTADDR");
236 }
237 if (conn->entry_cfg.isolation_flags & ISO_SOCKSAUTH) {
238 smartlist_add(isoflaglist, (void *)"SOCKS_USERNAME");
239 smartlist_add(isoflaglist, (void *)"SOCKS_PASSWORD");
240 }
241 if (conn->entry_cfg.isolation_flags & ISO_CLIENTPROTO) {
242 smartlist_add(isoflaglist, (void *)"CLIENT_PROTOCOL");
243 }
244 if (conn->entry_cfg.isolation_flags & ISO_CLIENTADDR) {
245 smartlist_add(isoflaglist, (void *)"CLIENTADDR");
246 }
247 if (conn->entry_cfg.isolation_flags & ISO_SESSIONGRP) {
248 smartlist_add(isoflaglist, (void *)"SESSION_GROUP");
249 }
250 if (conn->entry_cfg.isolation_flags & ISO_NYM_EPOCH) {
251 smartlist_add(isoflaglist, (void *)"NYM_EPOCH");
252 }
253 isoflaglist_joined = smartlist_join_strings(isoflaglist, ",", 0, NULL);
254 smartlist_add_asprintf(descparts, "ISO_FIELDS=%s", isoflaglist_joined);
255 tor_free(isoflaglist_joined);
256 smartlist_free(isoflaglist);
257
258 rv = smartlist_join_strings(descparts, " ", 0, NULL);
259
260 SMARTLIST_FOREACH(descparts, char *, cp, tor_free(cp));
261 smartlist_free(descparts);
262
263 return rv;
264}
265
266/** Return a longname the node whose identity is <b>id_digest</b>. If
267 * node_get_by_id() returns NULL, base 16 encoding of <b>id_digest</b> is
268 * returned instead.
269 *
270 * This function is not thread-safe. Each call to this function invalidates
271 * previous values returned by this function.
272 */
273MOCK_IMPL(const char *,
274node_describe_longname_by_id,(const char *id_digest))
275{
276 static char longname[MAX_VERBOSE_NICKNAME_LEN+1];
277 node_get_verbose_nickname_by_id(id_digest, longname);
278 return longname;
279}
void base16_encode(char *dest, size_t destlen, const char *src, size_t srclen)
Definition: binascii.c:478
char * circuit_list_path_for_controller(origin_circuit_t *circ)
Definition: circuitbuild.c:347
Header file for circuitbuild.c.
const char * circuit_purpose_to_controller_hs_state_string(uint8_t purpose)
Definition: circuitlist.c:867
const char * circuit_purpose_to_controller_string(uint8_t purpose)
Definition: circuitlist.c:801
Header file for circuitlist.c.
const char * name
Definition: config.c:2462
Header file for connection.c.
#define CONN_TYPE_AP_HTTP_CONNECT_LISTENER
Definition: connection.h:75
#define CONN_TYPE_METRICS_LISTENER
Definition: connection.h:77
#define CONN_TYPE_AP_NATD_LISTENER
Definition: connection.h:66
#define CONN_TYPE_AP_LISTENER
Definition: connection.h:48
#define CONN_TYPE_AP_DNS_LISTENER
Definition: connection.h:68
#define CONN_TYPE_AP_TRANS_LISTENER
Definition: connection.h:63
int connection_edge_is_rendezvous_stream(const edge_connection_t *conn)
Header file for connection_edge.c.
Controller connection structure.
char * entry_connection_describe_status_for_controller(const entry_connection_t *conn)
Definition: control_fmt.c:173
char * circuit_describe_status_for_controller(origin_circuit_t *circ)
Definition: control_fmt.c:73
const char * node_describe_longname_by_id(const char *id_digest)
Definition: control_fmt.c:274
void orconn_target_get_name(char *name, size_t len, or_connection_t *conn)
Definition: control_fmt.c:54
int write_stream_target_to_buf(entry_connection_t *conn, char *buf, size_t len)
Definition: control_fmt.c:32
Header file for control_fmt.c.
Header file for control_proto.c.
Circuit-build-stse structure.
#define DIGEST_LEN
Definition: digest_sizes.h:20
Entry connection structure.
#define ENTRY_TO_EDGE_CONN(c)
char * esc_for_log_len(const char *chars, size_t n)
Definition: escape.c:110
void hs_build_address(const ed25519_public_key_t *key, uint8_t version, char *addr_out)
Definition: hs_common.c:901
#define HS_VERSION_THREE
Definition: hs_common.h:23
#define HS_SERVICE_ADDR_LEN_BASE32
Definition: hs_common.h:80
#define tor_free(p)
Definition: malloc.h:56
void node_get_verbose_nickname_by_id(const char *id_digest, char *verbose_name_out)
Definition: nodelist.c:1562
const node_t * node_get_by_id(const char *identity_digest)
Definition: nodelist.c:226
void node_get_verbose_nickname(const node_t *node, char *verbose_name_out)
Definition: nodelist.c:1542
Header file for nodelist.c.
Master header file for Tor-specific functionality.
#define ISO_CLIENTPROTO
Definition: or.h:863
#define ISO_DESTADDR
Definition: or.h:859
#define ISO_SESSIONGRP
Definition: or.h:867
#define MAX_VERBOSE_NICKNAME_LEN
Definition: or.h:118
#define ISO_SOCKSAUTH
Definition: or.h:861
#define ISO_DESTPORT
Definition: or.h:857
#define ISO_NYM_EPOCH
Definition: or.h:869
#define ISO_CLIENTADDR
Definition: or.h:865
OR connection structure.
Origin circuit structure.
int tor_snprintf(char *str, size_t size, const char *format,...)
Definition: printf.c:27
void smartlist_add_asprintf(struct smartlist_t *sl, const char *pattern,...)
Definition: smartlist.c:36
char * smartlist_join_strings(smartlist_t *sl, const char *join, int terminate, size_t *len_out)
Definition: smartlist.c:279
smartlist_t * smartlist_new(void)
void smartlist_add(smartlist_t *sl, void *element)
#define SMARTLIST_FOREACH(sl, type, var, cmd)
Client request structure.
uint8_t purpose
Definition: circuit_st.h:112
struct timeval timestamp_created
Definition: circuit_st.h:169
uint16_t port
socks_request_t * socks_request
ed25519_public_key_t identity_pk
Definition: hs_ident.h:45
Definition: node_st.h:34
char identity_digest[DIGEST_LEN]
struct hs_ident_circuit_t * hs_ident
cpath_build_state_t * build_state
char address[MAX_SOCKS_ADDR_LEN]
#define MOCK_IMPL(rv, funcname, arglist)
Definition: testsupport.h:133
void format_iso_time_nospace_usec(char *buf, const struct timeval *tv)
Definition: time_fmt.c:354
#define tor_assert(expr)
Definition: util_bug.h:103
int tor_digest_is_zero(const char *digest)
Definition: util_string.c:98