Hook up client usage of congestion control negotiation
[tor.git] / src / core / or / command.c
blobffdd1f19d9b7746a4bff3c15d15bc05886fc7f46
1 /* Copyright (c) 2001 Matej Pfajfar.
2 * Copyright (c) 2001-2004, Roger Dingledine.
3 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4 * Copyright (c) 2007-2021, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
7 /**
8 * \file command.c
9 * \brief Functions for processing incoming cells.
11 * When we receive a cell from a client or a relay, it arrives on some
12 * channel, and tells us what to do with it. In this module, we dispatch based
13 * on the cell type using the functions command_process_cell() and
14 * command_process_var_cell(), and deal with the cell accordingly. (These
15 * handlers are installed on a channel with the command_setup_channel()
16 * function.)
18 * Channels have a chance to handle some cell types on their own before they
19 * are ever passed here --- typically, they do this for cells that are
20 * specific to a given channel type. For example, in channeltls.c, the cells
21 * for the initial connection handshake are handled before we get here. (Of
22 * course, the fact that there _is_ only one channel type for now means that
23 * we may have gotten the factoring wrong here.)
25 * Handling other cell types is mainly farmed off to other modules, after
26 * initial sanity-checking. CREATE* cells are handled ultimately in onion.c,
27 * CREATED* cells trigger circuit creation in circuitbuild.c, DESTROY cells
28 * are handled here (since they're simple), and RELAY cells, in all their
29 * complexity, are passed off to relay.c.
30 **/
32 /* In-points to command.c:
34 * - command_process_cell(), called from
35 * incoming cell handlers of channel_t instances;
36 * callbacks registered in command_setup_channel(),
37 * called when channels are created in circuitbuild.c
39 #include "core/or/or.h"
40 #include "app/config/config.h"
41 #include "core/crypto/onion_crypto.h"
42 #include "core/mainloop/connection.h"
43 #include "core/mainloop/cpuworker.h"
44 #include "core/or/channel.h"
45 #include "core/or/circuitbuild.h"
46 #include "core/or/circuitlist.h"
47 #include "core/or/command.h"
48 #include "core/or/connection_or.h"
49 #include "core/or/dos.h"
50 #include "core/or/onion.h"
51 #include "core/or/relay.h"
52 #include "feature/control/control_events.h"
53 #include "feature/hibernate/hibernate.h"
54 #include "feature/nodelist/describe.h"
55 #include "feature/nodelist/nodelist.h"
56 #include "feature/nodelist/routerlist.h"
57 #include "feature/relay/circuitbuild_relay.h"
58 #include "feature/relay/routermode.h"
59 #include "feature/stats/rephist.h"
60 #include "lib/crypt_ops/crypto_util.h"
62 #include "core/or/cell_st.h"
63 #include "core/or/or_circuit_st.h"
64 #include "core/or/origin_circuit_st.h"
65 #include "core/or/var_cell_st.h"
67 /** How many CELL_CREATE cells have we received, ever? */
68 uint64_t stats_n_create_cells_processed = 0;
69 /** How many CELL_CREATED cells have we received, ever? */
70 uint64_t stats_n_created_cells_processed = 0;
71 /** How many CELL_RELAY cells have we received, ever? */
72 uint64_t stats_n_relay_cells_processed = 0;
73 /** How many CELL_DESTROY cells have we received, ever? */
74 uint64_t stats_n_destroy_cells_processed = 0;
76 /* Handle an incoming channel */
77 static void command_handle_incoming_channel(channel_listener_t *listener,
78 channel_t *chan);
80 /* These are the main functions for processing cells */
81 static void command_process_create_cell(cell_t *cell, channel_t *chan);
82 static void command_process_created_cell(cell_t *cell, channel_t *chan);
83 static void command_process_relay_cell(cell_t *cell, channel_t *chan);
84 static void command_process_destroy_cell(cell_t *cell, channel_t *chan);
86 /** Convert the cell <b>command</b> into a lower-case, human-readable
87 * string. */
88 const char *
89 cell_command_to_string(uint8_t command)
91 switch (command) {
92 case CELL_PADDING: return "padding";
93 case CELL_CREATE: return "create";
94 case CELL_CREATED: return "created";
95 case CELL_RELAY: return "relay";
96 case CELL_DESTROY: return "destroy";
97 case CELL_CREATE_FAST: return "create_fast";
98 case CELL_CREATED_FAST: return "created_fast";
99 case CELL_VERSIONS: return "versions";
100 case CELL_NETINFO: return "netinfo";
101 case CELL_RELAY_EARLY: return "relay_early";
102 case CELL_CREATE2: return "create2";
103 case CELL_CREATED2: return "created2";
104 case CELL_VPADDING: return "vpadding";
105 case CELL_CERTS: return "certs";
106 case CELL_AUTH_CHALLENGE: return "auth_challenge";
107 case CELL_AUTHENTICATE: return "authenticate";
108 case CELL_AUTHORIZE: return "authorize";
109 default: return "unrecognized";
113 #ifdef KEEP_TIMING_STATS
114 /** This is a wrapper function around the actual function that processes the
115 * <b>cell</b> that just arrived on <b>conn</b>. Increment <b>*time</b>
116 * by the number of microseconds used by the call to <b>*func(cell, conn)</b>.
118 static void
119 command_time_process_cell(cell_t *cell, channel_t *chan, int *time,
120 void (*func)(cell_t *, channel_t *))
122 struct timeval start, end;
123 long time_passed;
125 tor_gettimeofday(&start);
127 (*func)(cell, chan);
129 tor_gettimeofday(&end);
130 time_passed = tv_udiff(&start, &end) ;
132 if (time_passed > 10000) { /* more than 10ms */
133 log_debug(LD_OR,"That call just took %ld ms.",time_passed/1000);
135 if (time_passed < 0) {
136 log_info(LD_GENERAL,"That call took us back in time!");
137 time_passed = 0;
139 *time += time_passed;
141 #endif /* defined(KEEP_TIMING_STATS) */
143 /** Process a <b>cell</b> that was just received on <b>chan</b>. Keep internal
144 * statistics about how many of each cell we've processed so far
145 * this second, and the total number of microseconds it took to
146 * process each type of cell.
148 void
149 command_process_cell(channel_t *chan, cell_t *cell)
151 #ifdef KEEP_TIMING_STATS
152 /* how many of each cell have we seen so far this second? needs better
153 * name. */
154 static int num_create=0, num_created=0, num_relay=0, num_destroy=0;
155 /* how long has it taken to process each type of cell? */
156 static int create_time=0, created_time=0, relay_time=0, destroy_time=0;
157 static time_t current_second = 0; /* from previous calls to time */
159 time_t now = time(NULL);
161 if (now > current_second) { /* the second has rolled over */
162 /* print stats */
163 log_info(LD_OR,
164 "At end of second: %d creates (%d ms), %d createds (%d ms), "
165 "%d relays (%d ms), %d destroys (%d ms)",
166 num_create, create_time/1000,
167 num_created, created_time/1000,
168 num_relay, relay_time/1000,
169 num_destroy, destroy_time/1000);
171 /* zero out stats */
172 num_create = num_created = num_relay = num_destroy = 0;
173 create_time = created_time = relay_time = destroy_time = 0;
175 /* remember which second it is, for next time */
176 current_second = now;
178 #endif /* defined(KEEP_TIMING_STATS) */
180 #ifdef KEEP_TIMING_STATS
181 #define PROCESS_CELL(tp, cl, cn) STMT_BEGIN { \
182 ++num ## tp; \
183 command_time_process_cell(cl, cn, & tp ## time , \
184 command_process_ ## tp ## _cell); \
185 } STMT_END
186 #else /* !defined(KEEP_TIMING_STATS) */
187 #define PROCESS_CELL(tp, cl, cn) command_process_ ## tp ## _cell(cl, cn)
188 #endif /* defined(KEEP_TIMING_STATS) */
190 switch (cell->command) {
191 case CELL_CREATE:
192 case CELL_CREATE_FAST:
193 case CELL_CREATE2:
194 ++stats_n_create_cells_processed;
195 PROCESS_CELL(create, cell, chan);
196 break;
197 case CELL_CREATED:
198 case CELL_CREATED_FAST:
199 case CELL_CREATED2:
200 ++stats_n_created_cells_processed;
201 PROCESS_CELL(created, cell, chan);
202 break;
203 case CELL_RELAY:
204 case CELL_RELAY_EARLY:
205 ++stats_n_relay_cells_processed;
206 PROCESS_CELL(relay, cell, chan);
207 break;
208 case CELL_DESTROY:
209 ++stats_n_destroy_cells_processed;
210 PROCESS_CELL(destroy, cell, chan);
211 break;
212 default:
213 log_fn(LOG_INFO, LD_PROTOCOL,
214 "Cell of unknown or unexpected type (%d) received. "
215 "Dropping.",
216 cell->command);
217 break;
221 /** Process a 'create' <b>cell</b> that just arrived from <b>chan</b>. Make a
222 * new circuit with the p_circ_id specified in cell. Put the circuit in state
223 * onionskin_pending, and pass the onionskin to the cpuworker. Circ will get
224 * picked up again when the cpuworker finishes decrypting it.
226 static void
227 command_process_create_cell(cell_t *cell, channel_t *chan)
229 or_circuit_t *circ;
230 const or_options_t *options = get_options();
231 int id_is_high;
232 create_cell_t *create_cell;
234 tor_assert(cell);
235 tor_assert(chan);
237 log_debug(LD_OR,
238 "Got a CREATE cell for circ_id %u on channel %"PRIu64
239 " (%p)",
240 (unsigned)cell->circ_id,
241 (chan->global_identifier), chan);
243 /* First thing we do, even though the cell might be invalid, is inform the
244 * DoS mitigation subsystem layer of this event. Validation is done by this
245 * function. */
246 dos_cc_new_create_cell(chan);
248 /* We check for the conditions that would make us drop the cell before
249 * we check for the conditions that would make us send a DESTROY back,
250 * since those conditions would make a DESTROY nonsensical. */
251 if (cell->circ_id == 0) {
252 log_fn(LOG_PROTOCOL_WARN, LD_PROTOCOL,
253 "Received a create cell (type %d) from %s with zero circID; "
254 " ignoring.", (int)cell->command,
255 channel_describe_peer(chan));
256 return;
259 if (circuit_id_in_use_on_channel(cell->circ_id, chan)) {
260 const node_t *node = node_get_by_id(chan->identity_digest);
261 log_fn(LOG_PROTOCOL_WARN, LD_PROTOCOL,
262 "Received CREATE cell (circID %u) for known circ. "
263 "Dropping (age %d).",
264 (unsigned)cell->circ_id,
265 (int)(time(NULL) - channel_when_created(chan)));
266 if (node) {
267 char *p = esc_for_log(node_get_platform(node));
268 log_fn(LOG_PROTOCOL_WARN, LD_PROTOCOL,
269 "Details: router %s, platform %s.",
270 node_describe(node), p);
271 tor_free(p);
273 return;
276 if (we_are_hibernating()) {
277 log_info(LD_OR,
278 "Received create cell but we're shutting down. Sending back "
279 "destroy.");
280 channel_send_destroy(cell->circ_id, chan,
281 END_CIRC_REASON_HIBERNATING);
282 return;
285 /* Check if we should apply a defense for this channel. */
286 if (dos_cc_get_defense_type(chan) == DOS_CC_DEFENSE_REFUSE_CELL) {
287 channel_send_destroy(cell->circ_id, chan,
288 END_CIRC_REASON_RESOURCELIMIT);
289 return;
292 if (!server_mode(options) ||
293 (!public_server_mode(options) && channel_is_outgoing(chan))) {
294 log_fn(LOG_PROTOCOL_WARN, LD_PROTOCOL,
295 "Received create cell (type %d) from %s, but we're connected "
296 "to it as a client. "
297 "Sending back a destroy.",
298 (int)cell->command, channel_describe_peer(chan));
299 channel_send_destroy(cell->circ_id, chan,
300 END_CIRC_REASON_TORPROTOCOL);
301 return;
304 /* If the high bit of the circuit ID is not as expected, close the
305 * circ. */
306 if (chan->wide_circ_ids)
307 id_is_high = cell->circ_id & (1u<<31);
308 else
309 id_is_high = cell->circ_id & (1u<<15);
310 if ((id_is_high &&
311 chan->circ_id_type == CIRC_ID_TYPE_HIGHER) ||
312 (!id_is_high &&
313 chan->circ_id_type == CIRC_ID_TYPE_LOWER)) {
314 log_fn(LOG_PROTOCOL_WARN, LD_PROTOCOL,
315 "Received create cell with unexpected circ_id %u. Closing.",
316 (unsigned)cell->circ_id);
317 channel_send_destroy(cell->circ_id, chan,
318 END_CIRC_REASON_TORPROTOCOL);
319 return;
322 circ = or_circuit_new(cell->circ_id, chan);
323 circ->base_.purpose = CIRCUIT_PURPOSE_OR;
324 circuit_set_state(TO_CIRCUIT(circ), CIRCUIT_STATE_ONIONSKIN_PENDING);
325 create_cell = tor_malloc_zero(sizeof(create_cell_t));
326 if (create_cell_parse(create_cell, cell) < 0) {
327 tor_free(create_cell);
328 log_fn(LOG_PROTOCOL_WARN, LD_OR,
329 "Bogus/unrecognized create cell; closing.");
330 circuit_mark_for_close(TO_CIRCUIT(circ), END_CIRC_REASON_TORPROTOCOL);
331 return;
334 /* Mark whether this circuit used TAP in case we need to use this
335 * information for onion service statistics later on. */
336 if (create_cell->handshake_type == ONION_HANDSHAKE_TYPE_FAST ||
337 create_cell->handshake_type == ONION_HANDSHAKE_TYPE_TAP) {
338 circ->used_legacy_circuit_handshake = true;
341 if (!channel_is_client(chan)) {
342 /* remember create types we've seen, but don't remember them from
343 * clients, to be extra conservative about client statistics. */
344 rep_hist_note_circuit_handshake_requested(create_cell->handshake_type);
347 if (create_cell->handshake_type != ONION_HANDSHAKE_TYPE_FAST) {
348 /* hand it off to the cpuworkers, and then return. */
350 if (assign_onionskin_to_cpuworker(circ, create_cell) < 0) {
351 log_debug(LD_GENERAL,"Failed to hand off onionskin. Closing.");
352 circuit_mark_for_close(TO_CIRCUIT(circ), END_CIRC_REASON_RESOURCELIMIT);
353 return;
355 log_debug(LD_OR,"success: handed off onionskin.");
356 } else {
357 /* This is a CREATE_FAST cell; we can handle it immediately without using
358 * a CPU worker. */
359 uint8_t keys[CPATH_KEY_MATERIAL_LEN];
360 uint8_t rend_circ_nonce[DIGEST_LEN];
361 int len;
362 created_cell_t created_cell;
363 circuit_params_t params;
365 memset(&created_cell, 0, sizeof(created_cell));
366 len = onion_skin_server_handshake(ONION_HANDSHAKE_TYPE_FAST,
367 create_cell->onionskin,
368 create_cell->handshake_len,
369 NULL,
370 NULL,
371 created_cell.reply,
372 sizeof(created_cell.reply),
373 keys, CPATH_KEY_MATERIAL_LEN,
374 rend_circ_nonce,
375 &params);
376 tor_free(create_cell);
377 if (len < 0) {
378 log_warn(LD_OR,"Failed to generate key material. Closing.");
379 circuit_mark_for_close(TO_CIRCUIT(circ), END_CIRC_REASON_INTERNAL);
380 return;
382 created_cell.cell_type = CELL_CREATED_FAST;
383 created_cell.handshake_len = len;
385 if (onionskin_answer(circ, &created_cell,
386 (const char *)keys, sizeof(keys),
387 rend_circ_nonce)<0) {
388 log_warn(LD_OR,"Failed to reply to CREATE_FAST cell. Closing.");
389 circuit_mark_for_close(TO_CIRCUIT(circ), END_CIRC_REASON_INTERNAL);
390 return;
392 memwipe(keys, 0, sizeof(keys));
396 /** Process a 'created' <b>cell</b> that just arrived from <b>chan</b>.
397 * Find the circuit
398 * that it's intended for. If we're not the origin of the circuit, package
399 * the 'created' cell in an 'extended' relay cell and pass it back. If we
400 * are the origin of the circuit, send it to circuit_finish_handshake() to
401 * finish processing keys, and then call circuit_send_next_onion_skin() to
402 * extend to the next hop in the circuit if necessary.
404 static void
405 command_process_created_cell(cell_t *cell, channel_t *chan)
407 circuit_t *circ;
408 extended_cell_t extended_cell;
410 circ = circuit_get_by_circid_channel(cell->circ_id, chan);
412 if (!circ) {
413 log_info(LD_OR,
414 "(circID %u) unknown circ (probably got a destroy earlier). "
415 "Dropping.", (unsigned)cell->circ_id);
416 return;
419 if (circ->n_circ_id != cell->circ_id || circ->n_chan != chan) {
420 log_fn(LOG_PROTOCOL_WARN,LD_PROTOCOL,
421 "got created cell from Tor client? Closing.");
422 circuit_mark_for_close(circ, END_CIRC_REASON_TORPROTOCOL);
423 return;
426 if (created_cell_parse(&extended_cell.created_cell, cell) < 0) {
427 log_fn(LOG_PROTOCOL_WARN, LD_OR, "Unparseable created cell.");
428 circuit_mark_for_close(circ, END_CIRC_REASON_TORPROTOCOL);
429 return;
432 if (CIRCUIT_IS_ORIGIN(circ)) { /* we're the OP. Handshake this. */
433 origin_circuit_t *origin_circ = TO_ORIGIN_CIRCUIT(circ);
434 int err_reason = 0;
435 log_debug(LD_OR,"at OP. Finishing handshake.");
436 if ((err_reason = circuit_finish_handshake(origin_circ,
437 &extended_cell.created_cell)) < 0) {
438 circuit_mark_for_close(circ, -err_reason);
439 return;
441 log_debug(LD_OR,"Moving to next skin.");
442 if ((err_reason = circuit_send_next_onion_skin(origin_circ)) < 0) {
443 log_info(LD_OR,"circuit_send_next_onion_skin failed.");
444 /* XXX push this circuit_close lower */
445 circuit_mark_for_close(circ, -err_reason);
446 return;
448 } else { /* pack it into an extended relay cell, and send it. */
449 uint8_t command=0;
450 uint16_t len=0;
451 uint8_t payload[RELAY_PAYLOAD_SIZE];
452 log_debug(LD_OR,
453 "Converting created cell to extended relay cell, sending.");
454 memset(payload, 0, sizeof(payload));
455 if (extended_cell.created_cell.cell_type == CELL_CREATED2)
456 extended_cell.cell_type = RELAY_COMMAND_EXTENDED2;
457 else
458 extended_cell.cell_type = RELAY_COMMAND_EXTENDED;
459 if (extended_cell_format(&command, &len, payload, &extended_cell) < 0) {
460 log_fn(LOG_PROTOCOL_WARN, LD_OR, "Can't format extended cell.");
461 circuit_mark_for_close(circ, END_CIRC_REASON_TORPROTOCOL);
462 return;
465 relay_send_command_from_edge(0, circ, command,
466 (const char*)payload, len, NULL);
470 /** Process a 'relay' or 'relay_early' <b>cell</b> that just arrived from
471 * <b>conn</b>. Make sure it came in with a recognized circ_id. Pass it on to
472 * circuit_receive_relay_cell() for actual processing.
474 static void
475 command_process_relay_cell(cell_t *cell, channel_t *chan)
477 const or_options_t *options = get_options();
478 circuit_t *circ;
479 int reason, direction;
480 uint32_t orig_delivered_bw = 0;
481 uint32_t orig_overhead_bw = 0;
483 circ = circuit_get_by_circid_channel(cell->circ_id, chan);
485 if (!circ) {
486 log_debug(LD_OR,
487 "unknown circuit %u on connection from %s. Dropping.",
488 (unsigned)cell->circ_id,
489 channel_describe_peer(chan));
490 return;
493 if (circ->state == CIRCUIT_STATE_ONIONSKIN_PENDING) {
494 log_fn(LOG_PROTOCOL_WARN,LD_PROTOCOL,"circuit in create_wait. Closing.");
495 circuit_mark_for_close(circ, END_CIRC_REASON_TORPROTOCOL);
496 return;
499 if (CIRCUIT_IS_ORIGIN(circ)) {
500 /* if we're a relay and treating connections with recent local
501 * traffic better, then this is one of them. */
502 channel_timestamp_client(chan);
504 /* Count all circuit bytes here for control port accuracy. We want
505 * to count even invalid/dropped relay cells, hence counting
506 * before the recognized check and the connection_edge_process_relay
507 * cell checks.
509 origin_circuit_t *ocirc = TO_ORIGIN_CIRCUIT(circ);
511 /* Count the payload bytes only. We don't care about cell headers */
512 ocirc->n_read_circ_bw = tor_add_u32_nowrap(ocirc->n_read_circ_bw,
513 CELL_PAYLOAD_SIZE);
515 /* Stash the original delivered and overhead values. These values are
516 * updated by circuit_read_valid_data() during cell processing by
517 * connection_edge_process_relay_cell(), called from
518 * circuit_receive_relay_cell() below. If they do not change, we inform
519 * the control port about dropped cells immediately after the call
520 * to circuit_receive_relay_cell() below. */
521 orig_delivered_bw = ocirc->n_delivered_read_circ_bw;
522 orig_overhead_bw = ocirc->n_overhead_read_circ_bw;
525 if (!CIRCUIT_IS_ORIGIN(circ) &&
526 chan == TO_OR_CIRCUIT(circ)->p_chan &&
527 cell->circ_id == TO_OR_CIRCUIT(circ)->p_circ_id)
528 direction = CELL_DIRECTION_OUT;
529 else
530 direction = CELL_DIRECTION_IN;
532 /* If we have a relay_early cell, make sure that it's outbound, and we've
533 * gotten no more than MAX_RELAY_EARLY_CELLS_PER_CIRCUIT of them. */
534 if (cell->command == CELL_RELAY_EARLY) {
535 if (direction == CELL_DIRECTION_IN) {
536 /* Inbound early cells could once be encountered as a result of
537 * bug 1038; but relays running versions before 0.2.1.19 are long
538 * gone from the network, so any such cells now are surprising. */
539 log_warn(LD_OR,
540 "Received an inbound RELAY_EARLY cell on circuit %u."
541 " Closing circuit. Please report this event,"
542 " along with the following message.",
543 (unsigned)cell->circ_id);
544 if (CIRCUIT_IS_ORIGIN(circ)) {
545 circuit_log_path(LOG_WARN, LD_OR, TO_ORIGIN_CIRCUIT(circ));
546 /* Always emit a bandwidth event for closed circs */
547 control_event_circ_bandwidth_used_for_circ(TO_ORIGIN_CIRCUIT(circ));
548 } else if (circ->n_chan) {
549 log_warn(LD_OR, " upstream=%s",
550 channel_describe_peer(circ->n_chan));
552 circuit_mark_for_close(circ, END_CIRC_REASON_TORPROTOCOL);
553 return;
554 } else {
555 or_circuit_t *or_circ = TO_OR_CIRCUIT(circ);
556 if (or_circ->remaining_relay_early_cells == 0) {
557 log_fn(LOG_PROTOCOL_WARN, LD_OR,
558 "Received too many RELAY_EARLY cells on circ %u from %s."
559 " Closing circuit.",
560 (unsigned)cell->circ_id,
561 safe_str(channel_describe_peer(chan)));
562 circuit_mark_for_close(circ, END_CIRC_REASON_TORPROTOCOL);
563 return;
565 --or_circ->remaining_relay_early_cells;
569 if ((reason = circuit_receive_relay_cell(cell, circ, direction)) < 0) {
570 log_fn(LOG_DEBUG,LD_PROTOCOL,"circuit_receive_relay_cell "
571 "(%s) failed. Closing.",
572 direction==CELL_DIRECTION_OUT?"forward":"backward");
573 /* Always emit a bandwidth event for closed circs */
574 if (CIRCUIT_IS_ORIGIN(circ)) {
575 control_event_circ_bandwidth_used_for_circ(TO_ORIGIN_CIRCUIT(circ));
577 circuit_mark_for_close(circ, -reason);
580 if (CIRCUIT_IS_ORIGIN(circ)) {
581 origin_circuit_t *ocirc = TO_ORIGIN_CIRCUIT(circ);
583 /* If neither the delivered nor overhead values changed, this cell
584 * was dropped due to being invalid by one of the error codepaths in
585 * connection_edge_process_relay_cell(), called by
586 * circuit_receive_relay_cell().
588 * Valid cells, on the other hand, call circuit_read_valid_data()
589 * to update these values upon processing them.
591 * So, if the values are the same as those stored above,
592 * emit a control port event for CIRC_BW, so the controller can
593 * react quickly to invalid cells. */
594 if (orig_delivered_bw == ocirc->n_delivered_read_circ_bw &&
595 orig_overhead_bw == ocirc->n_overhead_read_circ_bw) {
596 control_event_circ_bandwidth_used_for_circ(ocirc);
600 /* If this is a cell in an RP circuit, count it as part of the
601 onion service stats */
602 if (options->HiddenServiceStatistics &&
603 !CIRCUIT_IS_ORIGIN(circ) &&
604 CONST_TO_OR_CIRCUIT(circ)->circuit_carries_hs_traffic_stats) {
605 /** We need to figure out of this is a v2 or v3 RP circuit to count it
606 * appropriately. v2 services always use the TAP legacy handshake to
607 * connect to the RP; we use this feature to distinguish between v2/v3. */
608 bool is_v2 = false;
609 if (CONST_TO_OR_CIRCUIT(circ)->used_legacy_circuit_handshake) {
610 is_v2 = true;
611 } else if (CONST_TO_OR_CIRCUIT(circ)->rend_splice) {
612 /* If this is a client->RP circuit we need to check the spliced circuit
613 * (which is the service->RP circuit) to see if it was using TAP and
614 * hence if it's a v2 circuit. That's because client->RP circuits can
615 * still use ntor even on v2; but service->RP will always use TAP. */
616 const or_circuit_t *splice = CONST_TO_OR_CIRCUIT(circ)->rend_splice;
617 if (splice->used_legacy_circuit_handshake) {
618 is_v2 = true;
621 rep_hist_seen_new_rp_cell(is_v2);
625 /** Process a 'destroy' <b>cell</b> that just arrived from
626 * <b>chan</b>. Find the circ that it refers to (if any).
628 * If the circ is in state
629 * onionskin_pending, then call onion_pending_remove() to remove it
630 * from the pending onion list (note that if it's already being
631 * processed by the cpuworker, it won't be in the list anymore; but
632 * when the cpuworker returns it, the circuit will be gone, and the
633 * cpuworker response will be dropped).
635 * Then mark the circuit for close (which marks all edges for close,
636 * and passes the destroy cell onward if necessary).
638 static void
639 command_process_destroy_cell(cell_t *cell, channel_t *chan)
641 circuit_t *circ;
642 int reason;
644 circ = circuit_get_by_circid_channel(cell->circ_id, chan);
645 if (!circ) {
646 log_info(LD_OR,"unknown circuit %u on connection from %s. Dropping.",
647 (unsigned)cell->circ_id,
648 channel_describe_peer(chan));
649 return;
651 log_debug(LD_OR,"Received for circID %u.",(unsigned)cell->circ_id);
653 reason = (uint8_t)cell->payload[0];
654 circ->received_destroy = 1;
656 if (!CIRCUIT_IS_ORIGIN(circ) &&
657 chan == TO_OR_CIRCUIT(circ)->p_chan &&
658 cell->circ_id == TO_OR_CIRCUIT(circ)->p_circ_id) {
659 /* the destroy came from behind */
660 circuit_set_p_circid_chan(TO_OR_CIRCUIT(circ), 0, NULL);
661 circuit_mark_for_close(circ, reason|END_CIRC_REASON_FLAG_REMOTE);
662 } else { /* the destroy came from ahead */
663 circuit_set_n_circid_chan(circ, 0, NULL);
664 if (CIRCUIT_IS_ORIGIN(circ)) {
665 circuit_mark_for_close(circ, reason|END_CIRC_REASON_FLAG_REMOTE);
666 } else {
667 char payload[1];
668 log_debug(LD_OR, "Delivering 'truncated' back.");
669 payload[0] = (char)reason;
670 relay_send_command_from_edge(0, circ, RELAY_COMMAND_TRUNCATED,
671 payload, sizeof(payload), NULL);
676 /** Callback to handle a new channel; call command_setup_channel() to give
677 * it the right cell handlers.
680 static void
681 command_handle_incoming_channel(channel_listener_t *listener, channel_t *chan)
683 tor_assert(listener);
684 tor_assert(chan);
686 command_setup_channel(chan);
689 /** Given a channel, install the right handlers to process incoming
690 * cells on it.
693 void
694 command_setup_channel(channel_t *chan)
696 tor_assert(chan);
698 channel_set_cell_handlers(chan,
699 command_process_cell);
702 /** Given a listener, install the right handler to process incoming
703 * channels on it.
706 void
707 command_setup_listener(channel_listener_t *listener)
709 tor_assert(listener);
710 tor_assert(listener->state == CHANNEL_LISTENER_STATE_LISTENING);
712 channel_listener_set_listener_fn(listener, command_handle_incoming_channel);