origin_circuit_st.h

/* Copyright (c) 2001 Matej Pfajfar.
 * Copyright (c) 2001-2004, Roger Dingledine.
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
 * Copyright (c) 2007-2019, The Tor Project, Inc. */
/* See LICENSE for licensing information */

#ifndef ORIGIN_CIRCUIT_ST_H
#define ORIGIN_CIRCUIT_ST_H

#include "core/or/or.h"

#include "core/or/circuit_st.h"

struct onion_queue_t;

enum path_state_t {
    PATH_STATE_NEW_CIRC = 0,
    PATH_STATE_BUILD_ATTEMPTED = 1,
    PATH_STATE_BUILD_SUCCEEDED = 2,
    PATH_STATE_USE_ATTEMPTED = 3,
    PATH_STATE_USE_SUCCEEDED = 4,

    PATH_STATE_USE_FAILED = 5,

    PATH_STATE_ALREADY_COUNTED = 6,
};

struct origin_circuit_t {
  circuit_t base_;

  edge_connection_t *p_streams;

  smartlist_t *half_streams;

  uint32_t n_read_circ_bw;

  uint32_t n_written_circ_bw;

  uint32_t n_delivered_read_circ_bw;

  uint32_t n_delivered_written_circ_bw;

  uint32_t n_overhead_read_circ_bw;

  uint32_t n_overhead_written_circ_bw;

  cpath_build_state_t *build_state;
  crypt_path_t *cpath;

  rend_data_t *rend_data;

  struct hs_ident_circuit_t *hs_ident;

  struct circuit_guard_state_t *guard_state;

  int global_origin_circuit_list_idx;

  unsigned int remaining_relay_early_cells : 4;

  unsigned int is_ancient : 1;

  unsigned int has_opened : 1;

  path_state_bitfield_t path_state : 3;

  /* If this flag is set, we should not consider attaching any more
   * connections to this circuit. */
  unsigned int unusable_for_new_conns : 1;

  /* If this flag is set (due to padding negotiation failure), we should
   * not try to negotiate further circuit padding. */
  unsigned padding_negotiation_failed : 1;

  uint8_t pathbias_shouldcount;
#define PATHBIAS_SHOULDCOUNT_UNDECIDED 0
#define PATHBIAS_SHOULDCOUNT_IGNORED   1
#define PATHBIAS_SHOULDCOUNT_COUNTED   2

  streamid_t pathbias_probe_id;

  uint32_t pathbias_probe_nonce;

  unsigned int hs_circ_has_timed_out : 1;

  unsigned int relaxed_timeout : 1;

  unsigned int hs_service_side_rend_circ_has_been_relaunched : 1;

  uint8_t relay_early_commands[MAX_RELAY_EARLY_CELLS_PER_CIRCUIT];

  int relay_early_cells_sent;

  streamid_t next_stream_id;

  /* The intro key replaces the hidden service's public key if purpose is
   * S_ESTABLISH_INTRO or S_INTRO, provided that no unversioned rendezvous
   * descriptor is used. */
  crypto_pk_t *intro_key;

  /* XXXX NM This can get re-used after 2**32 circuits. */
  uint32_t global_identifier;

  unsigned int isolation_values_set : 1;
  unsigned int isolation_any_streams_attached : 1;

  uint8_t isolation_flags_mixed;

  uint8_t client_proto_type;
  uint8_t client_proto_socksver;
  uint16_t dest_port;
  tor_addr_t client_addr;
  char *dest_address;
  int session_group;
  unsigned nym_epoch;
  size_t socks_username_len;
  uint8_t socks_password_len;
  /* Note that the next two values are NOT NUL-terminated; see
     socks_username_len and socks_password_len for their lengths. */
  char *socks_username;
  char *socks_password;
  uint64_t associated_isolated_stream_global_id;
  smartlist_t *prepend_policy;

  int circuit_idle_timeout;

};

#endif /* !defined(ORIGIN_CIRCUIT_ST_H) */