tor

The Tor anonymity network
git clone https://git.dasho.dev/tor.git
Log | Files | Refs | README | LICENSE

command.c (27593B)


      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 */
      6 
      7 /**
      8 * \file command.c
      9 * \brief Functions for processing incoming cells.
     10 *
     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.)
     17 *
     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.)
     24 *
     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 **/
     31 
     32 /* In-points to command.c:
     33 *
     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
     38 */
     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"
     61 
     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"
     66 
     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;
     75 
     76 /* Handle an incoming channel */
     77 static void command_handle_incoming_channel(channel_listener_t *listener,
     78                                            channel_t *chan);
     79 
     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);
     85 
     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)
     90 {
     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";
    110  }
    111 }
    112 
    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>.
    117 */
    118 static void
    119 command_time_process_cell(cell_t *cell, channel_t *chan, int *time,
    120                               void (*func)(cell_t *, channel_t *))
    121 {
    122  struct timeval start, end;
    123  long time_passed;
    124 
    125  tor_gettimeofday(&start);
    126 
    127  (*func)(cell, chan);
    128 
    129  tor_gettimeofday(&end);
    130  time_passed = tv_udiff(&start, &end) ;
    131 
    132  if (time_passed > 10000) { /* more than 10ms */
    133    log_debug(LD_OR,"That call just took %ld ms.",time_passed/1000);
    134  }
    135  if (time_passed < 0) {
    136    log_info(LD_GENERAL,"That call took us back in time!");
    137    time_passed = 0;
    138  }
    139  *time += time_passed;
    140 }
    141 #endif /* defined(KEEP_TIMING_STATS) */
    142 
    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.
    147 */
    148 void
    149 command_process_cell(channel_t *chan, cell_t *cell)
    150 {
    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 */
    158 
    159  time_t now = time(NULL);
    160 
    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);
    170 
    171    /* zero out stats */
    172    num_create = num_created = num_relay = num_destroy = 0;
    173    create_time = created_time = relay_time = destroy_time = 0;
    174 
    175    /* remember which second it is, for next time */
    176    current_second = now;
    177  }
    178 #endif /* defined(KEEP_TIMING_STATS) */
    179 
    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) */
    189 
    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;
    218  }
    219 }
    220 
    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.
    225 */
    226 static void
    227 command_process_create_cell(cell_t *cell, channel_t *chan)
    228 {
    229  or_circuit_t *circ;
    230  const or_options_t *options = get_options();
    231  int id_is_high;
    232  create_cell_t *create_cell;
    233 
    234  tor_assert(cell);
    235  tor_assert(chan);
    236 
    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);
    242 
    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);
    247 
    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;
    257  }
    258 
    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);
    272    }
    273    return;
    274  }
    275 
    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;
    283  }
    284 
    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;
    290  }
    291 
    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;
    302  }
    303 
    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;
    320  }
    321 
    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;
    332  }
    333 
    334  /* We no longer accept TAP, for any reason. */
    335  if (create_cell->handshake_type == ONION_HANDSHAKE_TYPE_TAP) {
    336    tor_free(create_cell);
    337    /* TODO: Should we collect statistics here?  Should we log? */
    338    circuit_mark_for_close(TO_CIRCUIT(circ), END_CIRC_REASON_TORPROTOCOL);
    339    return;
    340  }
    341 
    342  /* Mark whether this circuit used TAP in case we need to use this
    343   * information for onion service statistics later on. */
    344  if (create_cell->handshake_type == ONION_HANDSHAKE_TYPE_FAST ||
    345      create_cell->handshake_type == ONION_HANDSHAKE_TYPE_TAP) {
    346    circ->used_legacy_circuit_handshake = true;
    347  }
    348 
    349  if (!channel_is_client(chan)) {
    350    /* remember create types we've seen, but don't remember them from
    351     * clients, to be extra conservative about client statistics. */
    352    rep_hist_note_circuit_handshake_requested(create_cell->handshake_type);
    353  }
    354 
    355  if (create_cell->handshake_type != ONION_HANDSHAKE_TYPE_FAST) {
    356    /* hand it off to the cpuworkers, and then return. */
    357 
    358    if (assign_onionskin_to_cpuworker(circ, create_cell) < 0) {
    359      log_debug(LD_GENERAL,"Failed to hand off onionskin. Closing.");
    360      circuit_mark_for_close(TO_CIRCUIT(circ), END_CIRC_REASON_RESOURCELIMIT);
    361      return;
    362    }
    363    log_debug(LD_OR,"success: handed off onionskin.");
    364  } else {
    365    /* This is a CREATE_FAST cell; we can handle it immediately without using
    366     * a CPU worker. */
    367    uint8_t keys[CPATH_KEY_MATERIAL_LEN];
    368    uint8_t rend_circ_nonce[DIGEST_LEN];
    369    int len;
    370    created_cell_t created_cell;
    371    circuit_params_t params;
    372 
    373    memset(&created_cell, 0, sizeof(created_cell));
    374    size_t keylen = sizeof(keys);
    375    len = onion_skin_server_handshake(ONION_HANDSHAKE_TYPE_FAST,
    376                                       create_cell->onionskin,
    377                                       create_cell->handshake_len,
    378                                       NULL,
    379                                       NULL,
    380                                       created_cell.reply,
    381                                       sizeof(created_cell.reply),
    382                                        keys, &keylen,
    383                                       rend_circ_nonce,
    384                                       &params);
    385    tor_free(create_cell);
    386    if (len < 0 || keylen != sizeof(keys)) {
    387      log_warn(LD_OR,"Failed to generate key material. Closing.");
    388      circuit_mark_for_close(TO_CIRCUIT(circ), END_CIRC_REASON_INTERNAL);
    389      return;
    390    }
    391    created_cell.cell_type = CELL_CREATED_FAST;
    392    created_cell.handshake_len = len;
    393 
    394    if (onionskin_answer(circ, &created_cell,
    395                         RELAY_CRYPTO_ALG_TOR1,
    396                         (const char *)keys, sizeof(keys),
    397                         rend_circ_nonce)<0) {
    398      log_warn(LD_OR,"Failed to reply to CREATE_FAST cell. Closing.");
    399      circuit_mark_for_close(TO_CIRCUIT(circ), END_CIRC_REASON_INTERNAL);
    400      return;
    401    }
    402    memwipe(keys, 0, sizeof(keys));
    403  }
    404 }
    405 
    406 /** Process a 'created' <b>cell</b> that just arrived from <b>chan</b>.
    407 * Find the circuit
    408 * that it's intended for. If we're not the origin of the circuit, package
    409 * the 'created' cell in an 'extended' relay cell and pass it back. If we
    410 * are the origin of the circuit, send it to circuit_finish_handshake() to
    411 * finish processing keys, and then call circuit_send_next_onion_skin() to
    412 * extend to the next hop in the circuit if necessary.
    413 */
    414 static void
    415 command_process_created_cell(cell_t *cell, channel_t *chan)
    416 {
    417  circuit_t *circ;
    418  extended_cell_t extended_cell;
    419 
    420  circ = circuit_get_by_circid_channel(cell->circ_id, chan);
    421 
    422  if (!circ) {
    423    log_info(LD_OR,
    424             "(circID %u) unknown circ (probably got a destroy earlier). "
    425             "Dropping.", (unsigned)cell->circ_id);
    426    return;
    427  }
    428 
    429  if (circ->n_circ_id != cell->circ_id || circ->n_chan != chan) {
    430    log_fn(LOG_PROTOCOL_WARN,LD_PROTOCOL,
    431           "got created cell from Tor client? Closing.");
    432    circuit_mark_for_close(circ, END_CIRC_REASON_TORPROTOCOL);
    433    return;
    434  }
    435 
    436  if (created_cell_parse(&extended_cell.created_cell, cell) < 0) {
    437    log_fn(LOG_PROTOCOL_WARN, LD_OR, "Unparseable created cell.");
    438    circuit_mark_for_close(circ, END_CIRC_REASON_TORPROTOCOL);
    439    return;
    440  }
    441 
    442  if (CIRCUIT_IS_ORIGIN(circ)) { /* we're the OP. Handshake this. */
    443    origin_circuit_t *origin_circ = TO_ORIGIN_CIRCUIT(circ);
    444    int err_reason = 0;
    445    log_debug(LD_OR,"at OP. Finishing handshake.");
    446    if ((err_reason = circuit_finish_handshake(origin_circ,
    447                                        &extended_cell.created_cell)) < 0) {
    448      circuit_mark_for_close(circ, -err_reason);
    449      return;
    450    }
    451    log_debug(LD_OR,"Moving to next skin.");
    452    if ((err_reason = circuit_send_next_onion_skin(origin_circ)) < 0) {
    453      log_info(LD_OR,"circuit_send_next_onion_skin failed.");
    454      /* XXX push this circuit_close lower */
    455      circuit_mark_for_close(circ, -err_reason);
    456      return;
    457    }
    458  } else { /* pack it into an extended relay cell, and send it. */
    459    uint8_t command=0;
    460    uint16_t len=0;
    461    uint8_t payload[RELAY_PAYLOAD_SIZE_MAX];
    462    log_debug(LD_OR,
    463              "Converting created cell to extended relay cell, sending.");
    464    memset(payload, 0, sizeof(payload));
    465    if (extended_cell.created_cell.cell_type == CELL_CREATED2)
    466      extended_cell.cell_type = RELAY_COMMAND_EXTENDED2;
    467    else
    468      extended_cell.cell_type = RELAY_COMMAND_EXTENDED;
    469    if (extended_cell_format(&command, &len, payload, &extended_cell) < 0) {
    470      log_fn(LOG_PROTOCOL_WARN, LD_OR, "Can't format extended cell.");
    471      circuit_mark_for_close(circ, END_CIRC_REASON_TORPROTOCOL);
    472      return;
    473    }
    474    if (len > circuit_max_relay_payload(circ, NULL, command)) {
    475      log_fn(LOG_PROTOCOL_WARN, LD_OR, "Created cell too big to package.");
    476      circuit_mark_for_close(circ, END_CIRC_REASON_TORPROTOCOL);
    477      return;
    478    }
    479 
    480    relay_send_command_from_edge(0, circ, command,
    481                                 (const char*)payload, len, NULL);
    482  }
    483 }
    484 
    485 /** Process a 'relay' or 'relay_early' <b>cell</b> that just arrived from
    486 * <b>conn</b>. Make sure it came in with a recognized circ_id. Pass it on to
    487 * circuit_receive_relay_cell() for actual processing.
    488 */
    489 static void
    490 command_process_relay_cell(cell_t *cell, channel_t *chan)
    491 {
    492  const or_options_t *options = get_options();
    493  circuit_t *circ;
    494  int direction, reason;
    495  uint32_t orig_delivered_bw = 0;
    496  uint32_t orig_overhead_bw = 0;
    497 
    498  circ = circuit_get_by_circid_channel(cell->circ_id, chan);
    499 
    500  if (!circ) {
    501    log_debug(LD_OR,
    502              "unknown circuit %u on connection from %s. Dropping.",
    503              (unsigned)cell->circ_id,
    504              channel_describe_peer(chan));
    505    return;
    506  }
    507 
    508  if (circ->state == CIRCUIT_STATE_ONIONSKIN_PENDING) {
    509    log_fn(LOG_PROTOCOL_WARN,LD_PROTOCOL,"circuit in create_wait. Closing.");
    510    circuit_mark_for_close(circ, END_CIRC_REASON_TORPROTOCOL);
    511    return;
    512  }
    513 
    514  if (CIRCUIT_IS_ORIGIN(circ)) {
    515    /* if we're a relay and treating connections with recent local
    516     * traffic better, then this is one of them. */
    517    channel_timestamp_client(chan);
    518 
    519    /* Count all circuit bytes here for control port accuracy. We want
    520     * to count even invalid/dropped relay cells, hence counting
    521     * before the recognized check and the connection_edge_process_relay
    522     * cell checks.
    523     */
    524    origin_circuit_t *ocirc = TO_ORIGIN_CIRCUIT(circ);
    525 
    526    /* Count the payload bytes only. We don't care about cell headers */
    527    ocirc->n_read_circ_bw = tor_add_u32_nowrap(ocirc->n_read_circ_bw,
    528                                               CELL_PAYLOAD_SIZE);
    529 
    530    /* Stash the original delivered and overhead values. These values are
    531     * updated by circuit_read_valid_data() during cell processing by
    532     * connection_edge_process_relay_cell(), called from
    533     * circuit_receive_relay_cell() below. If they do not change, we inform
    534     * the control port about dropped cells immediately after the call
    535     * to circuit_receive_relay_cell() below. */
    536    orig_delivered_bw = ocirc->n_delivered_read_circ_bw;
    537    orig_overhead_bw = ocirc->n_overhead_read_circ_bw;
    538  }
    539 
    540  if (!CIRCUIT_IS_ORIGIN(circ) &&
    541      chan == TO_OR_CIRCUIT(circ)->p_chan &&
    542      cell->circ_id == TO_OR_CIRCUIT(circ)->p_circ_id)
    543    direction = CELL_DIRECTION_OUT;
    544  else
    545    direction = CELL_DIRECTION_IN;
    546 
    547  /* If we have a relay_early cell, make sure that it's outbound, and we've
    548   * gotten no more than MAX_RELAY_EARLY_CELLS_PER_CIRCUIT of them. */
    549  if (cell->command == CELL_RELAY_EARLY) {
    550    if (direction == CELL_DIRECTION_IN) {
    551      /* Inbound early cells could once be encountered as a result of
    552       * bug 1038; but relays running versions before 0.2.1.19 are long
    553       * gone from the network, so any such cells now are surprising. */
    554      log_warn(LD_OR,
    555               "Received an inbound RELAY_EARLY cell on circuit %u."
    556               " Closing circuit. Please report this event,"
    557               " along with the following message.",
    558               (unsigned)cell->circ_id);
    559      if (CIRCUIT_IS_ORIGIN(circ)) {
    560        circuit_log_path(LOG_WARN, LD_OR, TO_ORIGIN_CIRCUIT(circ));
    561        /* Always emit a bandwidth event for closed circs */
    562        control_event_circ_bandwidth_used_for_circ(TO_ORIGIN_CIRCUIT(circ));
    563      } else if (circ->n_chan) {
    564        log_warn(LD_OR, " upstream=%s",
    565                 channel_describe_peer(circ->n_chan));
    566      }
    567      circuit_mark_for_close(circ, END_CIRC_REASON_TORPROTOCOL);
    568      return;
    569    } else {
    570      or_circuit_t *or_circ = TO_OR_CIRCUIT(circ);
    571      if (or_circ->remaining_relay_early_cells == 0) {
    572        log_fn(LOG_PROTOCOL_WARN, LD_OR,
    573               "Received too many RELAY_EARLY cells on circ %u from %s."
    574               "  Closing circuit.",
    575               (unsigned)cell->circ_id,
    576               safe_str(channel_describe_peer(chan)));
    577        circuit_mark_for_close(circ, END_CIRC_REASON_TORPROTOCOL);
    578        return;
    579      }
    580      --or_circ->remaining_relay_early_cells;
    581    }
    582  }
    583 
    584  if ((reason = circuit_receive_relay_cell(cell, circ, direction)) < 0) {
    585    log_fn(LOG_DEBUG,LD_PROTOCOL,"circuit_receive_relay_cell "
    586           "(%s) failed. Closing.",
    587           direction==CELL_DIRECTION_OUT?"forward":"backward");
    588    /* Always emit a bandwidth event for closed circs */
    589    if (CIRCUIT_IS_ORIGIN(circ)) {
    590      control_event_circ_bandwidth_used_for_circ(TO_ORIGIN_CIRCUIT(circ));
    591    }
    592    circuit_mark_for_close(circ, -reason);
    593  }
    594 
    595  if (CIRCUIT_IS_ORIGIN(circ)) {
    596    origin_circuit_t *ocirc = TO_ORIGIN_CIRCUIT(circ);
    597 
    598    /* If neither the delivered nor overhead values changed, this cell
    599     * was dropped due to being invalid by one of the error codepaths in
    600     * connection_edge_process_relay_cell(), called by
    601     * circuit_receive_relay_cell().
    602     *
    603     * Valid cells, on the other hand, call circuit_read_valid_data()
    604     * to update these values upon processing them.
    605     *
    606     * So, if the values are the same as those stored above,
    607     * emit a control port event for CIRC_BW, so the controller can
    608     * react quickly to invalid cells. */
    609    if (orig_delivered_bw == ocirc->n_delivered_read_circ_bw &&
    610        orig_overhead_bw == ocirc->n_overhead_read_circ_bw) {
    611      control_event_circ_bandwidth_used_for_circ(ocirc);
    612    }
    613  }
    614 
    615  /* If this is a cell in an RP circuit, count it as part of the
    616     onion service stats */
    617  if (options->HiddenServiceStatistics &&
    618      !CIRCUIT_IS_ORIGIN(circ) &&
    619      CONST_TO_OR_CIRCUIT(circ)->circuit_carries_hs_traffic_stats) {
    620    /** We need to figure out of this is a v2 or v3 RP circuit to count it
    621     *  appropriately. v2 services always use the TAP legacy handshake to
    622     *  connect to the RP; we use this feature to distinguish between v2/v3. */
    623    bool is_v2 = false;
    624    if (CONST_TO_OR_CIRCUIT(circ)->used_legacy_circuit_handshake) {
    625      is_v2 = true;
    626    } else if (CONST_TO_OR_CIRCUIT(circ)->rend_splice) {
    627      /* If this is a client->RP circuit we need to check the spliced circuit
    628       * (which is the service->RP circuit) to see if it was using TAP and
    629       * hence if it's a v2 circuit. That's because client->RP circuits can
    630       * still use ntor even on v2; but service->RP will always use TAP. */
    631      const or_circuit_t *splice = CONST_TO_OR_CIRCUIT(circ)->rend_splice;
    632      if (splice->used_legacy_circuit_handshake) {
    633        is_v2 = true;
    634      }
    635    }
    636    rep_hist_seen_new_rp_cell(is_v2);
    637  }
    638 }
    639 
    640 /** Process a 'destroy' <b>cell</b> that just arrived from
    641 * <b>chan</b>. Find the circ that it refers to (if any).
    642 *
    643 * If the circ is in state
    644 * onionskin_pending, then call onion_pending_remove() to remove it
    645 * from the pending onion list (note that if it's already being
    646 * processed by the cpuworker, it won't be in the list anymore; but
    647 * when the cpuworker returns it, the circuit will be gone, and the
    648 * cpuworker response will be dropped).
    649 *
    650 * Then mark the circuit for close (which marks all edges for close,
    651 * and passes the destroy cell onward if necessary).
    652 */
    653 static void
    654 command_process_destroy_cell(cell_t *cell, channel_t *chan)
    655 {
    656  circuit_t *circ;
    657  int reason;
    658 
    659  circ = circuit_get_by_circid_channel(cell->circ_id, chan);
    660  if (!circ) {
    661    log_info(LD_OR,"unknown circuit %u on connection from %s. Dropping.",
    662             (unsigned)cell->circ_id,
    663             channel_describe_peer(chan));
    664    return;
    665  }
    666  log_debug(LD_OR,"Received for circID %u.",(unsigned)cell->circ_id);
    667 
    668  reason = (uint8_t)cell->payload[0];
    669  circ->received_destroy = 1;
    670 
    671  if (!CIRCUIT_IS_ORIGIN(circ) &&
    672      chan == TO_OR_CIRCUIT(circ)->p_chan &&
    673      cell->circ_id == TO_OR_CIRCUIT(circ)->p_circ_id) {
    674    /* The destroy came from behind so nullify its p_chan. Close the circuit
    675     * with a DESTROYED reason so we don't propagate along the path forward the
    676     * reason which could be used as a side channel. */
    677    circuit_set_p_circid_chan(TO_OR_CIRCUIT(circ), 0, NULL);
    678    circuit_mark_for_close(circ, END_CIRC_REASON_DESTROYED);
    679  } else { /* the destroy came from ahead */
    680    circuit_set_n_circid_chan(circ, 0, NULL);
    681    if (CIRCUIT_IS_ORIGIN(circ)) {
    682      circuit_mark_for_close(circ, reason|END_CIRC_REASON_FLAG_REMOTE);
    683    } else {
    684      /* Close the circuit so we stop queuing cells for it and propagate the
    685       * DESTROY cell down the circuit so relays can stop queuing in-flight
    686       * cells for this circuit which helps with memory pressure. We do NOT
    687       * propagate the remote reason so not to create a side channel. */
    688      log_debug(LD_OR, "Received DESTROY cell from n_chan, closing circuit.");
    689      circuit_mark_for_close(circ, END_CIRC_REASON_DESTROYED);
    690    }
    691  }
    692 }
    693 
    694 /** Callback to handle a new channel; call command_setup_channel() to give
    695 * it the right cell handlers.
    696 */
    697 
    698 static void
    699 command_handle_incoming_channel(channel_listener_t *listener, channel_t *chan)
    700 {
    701  tor_assert(listener);
    702  tor_assert(chan);
    703 
    704  command_setup_channel(chan);
    705 }
    706 
    707 /** Given a channel, install the right handlers to process incoming
    708 * cells on it.
    709 */
    710 
    711 void
    712 command_setup_channel(channel_t *chan)
    713 {
    714  tor_assert(chan);
    715 
    716  channel_set_cell_handlers(chan,
    717                            command_process_cell);
    718 }
    719 
    720 /** Given a listener, install the right handler to process incoming
    721 * channels on it.
    722 */
    723 
    724 void
    725 command_setup_listener(channel_listener_t *listener)
    726 {
    727  tor_assert(listener);
    728  tor_assert(listener->state == CHANNEL_LISTENER_STATE_LISTENING);
    729 
    730  channel_listener_set_listener_fn(listener, command_handle_incoming_channel);
    731 }