tor  0.4.2.1-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-2019, The Tor Project, Inc. */
3 /* See LICENSE for licensing information */
4 
10 #include "core/or/or.h"
11 
13 #include "core/or/circuitbuild.h"
14 #include "core/or/circuitlist.h"
19 
20 #include "core/or/cpath_build_state_st.h"
21 #include "core/or/entry_connection_st.h"
22 #include "core/or/or_connection_st.h"
23 #include "core/or/origin_circuit_st.h"
24 #include "core/or/socks_request_st.h"
25 #include "feature/control/control_connection_st.h"
26 
31 int
32 write_stream_target_to_buf(entry_connection_t *conn, char *buf, size_t len)
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",
41  conn->socks_request->address,
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 
53 void
54 orconn_target_get_name(char *name, size_t len, or_connection_t *conn)
55 {
56  const node_t *node = node_get_by_id(conn->identity_digest);
57  if (node) {
59  node_get_verbose_nickname(node, name);
60  } else if (! tor_digest_is_zero(conn->identity_digest)) {
61  name[0] = '$';
62  base16_encode(name+1, len-1, conn->identity_digest,
63  DIGEST_LEN);
64  } else {
65  tor_snprintf(name, len, "%s:%d",
66  conn->base_.address, conn->base_.port);
67  }
68 }
69 
72 char *
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->rend_data != NULL || circ->hs_ident != NULL) {
126  char addr[HS_SERVICE_ADDR_LEN_BASE32 + 1];
127  const char *onion_address;
128  if (circ->rend_data) {
129  onion_address = rend_data_get_address(circ->rend_data);
130  } else {
131  hs_build_address(&circ->hs_ident->identity_pk, HS_VERSION_THREE, addr);
132  onion_address = addr;
133  }
134  smartlist_add_asprintf(descparts, "REND_QUERY=%s", onion_address);
135  }
136 
137  {
138  char tbuf[ISO_TIME_USEC_LEN+1];
140 
141  smartlist_add_asprintf(descparts, "TIME_CREATED=%s", tbuf);
142  }
143 
144  // Show username and/or password if available.
145  if (circ->socks_username_len > 0) {
146  char* socks_username_escaped = esc_for_log_len(circ->socks_username,
147  (size_t) circ->socks_username_len);
148  smartlist_add_asprintf(descparts, "SOCKS_USERNAME=%s",
149  socks_username_escaped);
150  tor_free(socks_username_escaped);
151  }
152  if (circ->socks_password_len > 0) {
153  char* socks_password_escaped = esc_for_log_len(circ->socks_password,
154  (size_t) circ->socks_password_len);
155  smartlist_add_asprintf(descparts, "SOCKS_PASSWORD=%s",
156  socks_password_escaped);
157  tor_free(socks_password_escaped);
158  }
159 
160  rv = smartlist_join_strings(descparts, " ", 0, NULL);
161 
162  SMARTLIST_FOREACH(descparts, char *, cp, tor_free(cp));
163  smartlist_free(descparts);
164 
165  return rv;
166 }
167 
175 MOCK_IMPL(const char *,
176 node_describe_longname_by_id,(const char *id_digest))
177 {
178  static char longname[MAX_VERBOSE_NICKNAME_LEN+1];
179  node_get_verbose_nickname_by_id(id_digest, longname);
180  return longname;
181 }
rend_data_t * rend_data
int write_stream_target_to_buf(entry_connection_t *conn, char *buf, size_t len)
Definition: control_fmt.c:32
Definition: node_st.h:28
char identity_digest[DIGEST_LEN]
Header file for connection.c.
Header file for nodelist.c.
void smartlist_add(smartlist_t *sl, void *element)
Header file for control_fmt.c.
MOCK_IMPL(const char *, node_describe_longname_by_id,(const char *id_digest))
Definition: control_fmt.c:175
const char * circuit_purpose_to_controller_hs_state_string(uint8_t purpose)
Definition: circuitlist.c:838
char address[MAX_SOCKS_ADDR_LEN]
char * esc_for_log_len(const char *chars, size_t n)
Definition: escape.c:110
char * circuit_list_path_for_controller(origin_circuit_t *circ)
Definition: circuitbuild.c:347
void format_iso_time_nospace_usec(char *buf, const struct timeval *tv)
Definition: time_fmt.c:323
uint16_t port
#define tor_free(p)
Definition: malloc.h:52
uint8_t purpose
Definition: circuit_st.h:100
socks_request_t * socks_request
void orconn_target_get_name(char *name, size_t len, or_connection_t *conn)
Definition: control_fmt.c:54
tor_assert(buffer)
#define MAX_VERBOSE_NICKNAME_LEN
Definition: or.h:119
#define DIGEST_LEN
Definition: digest_sizes.h:20
void smartlist_add_asprintf(struct smartlist_t *sl, const char *pattern,...)
Definition: smartlist.c:36
void node_get_verbose_nickname_by_id(const char *id_digest, char *verbose_name_out)
Definition: nodelist.c:1404
Master header file for Tor-specific functionality.
Header file for circuitbuild.c.
void node_get_verbose_nickname(const node_t *node, char *verbose_name_out)
Definition: nodelist.c:1384
void base16_encode(char *dest, size_t destlen, const char *src, size_t srclen)
Definition: binascii.c:478
char * circuit_describe_status_for_controller(origin_circuit_t *circ)
Definition: control_fmt.c:73
Header file for circuitlist.c.
int tor_digest_is_zero(const char *digest)
Definition: util_string.c:96
int connection_edge_is_rendezvous_stream(const edge_connection_t *conn)
cpath_build_state_t * build_state
Header file for connection_edge.c.
int tor_snprintf(char *str, size_t size, const char *format,...)
Definition: printf.c:27
char * smartlist_join_strings(smartlist_t *sl, const char *join, int terminate, size_t *len_out)
Definition: smartlist.c:279
struct hs_ident_circuit_t * hs_ident
#define SMARTLIST_FOREACH(sl, type, var, cmd)
const char * circuit_purpose_to_controller_string(uint8_t purpose)
Definition: circuitlist.c:777
Header file for control_proto.c.
struct timeval timestamp_created
Definition: circuit_st.h:157