transports.h 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  1. /* Copyright (c) 2003-2004, Roger Dingledine
  2. * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  3. * Copyright (c) 2007-2017, The Tor Project, Inc. */
  4. /* See LICENSE for licensing information */
  5. /**
  6. * \file transports.h
  7. * \brief Headers for transports.c
  8. **/
  9. #ifndef TOR_TRANSPORTS_H
  10. #define TOR_TRANSPORTS_H
  11. /** Represents a pluggable transport used by a bridge. */
  12. typedef struct transport_t {
  13. /** SOCKS version: One of PROXY_SOCKS4, PROXY_SOCKS5. */
  14. int socks_version;
  15. /** Name of pluggable transport protocol */
  16. char *name;
  17. /** The IP address where the transport bound and is waiting for
  18. * connections. */
  19. tor_addr_t addr;
  20. /** Port of proxy */
  21. uint16_t port;
  22. /** Boolean: We are re-parsing our transport list, and we are going to remove
  23. * this one if we don't find it in the list of configured transports. */
  24. unsigned marked_for_removal : 1;
  25. /** Arguments for this transport that must be written to the
  26. extra-info descriptor. */
  27. char *extra_info_args;
  28. } transport_t;
  29. void mark_transport_list(void);
  30. void sweep_transport_list(void);
  31. MOCK_DECL(int, transport_add_from_config,
  32. (const tor_addr_t *addr, uint16_t port,
  33. const char *name, int socks_ver));
  34. void transport_free_(transport_t *transport);
  35. #define transport_free(tr) FREE_AND_NULL(transport_t, transport_free_, (tr))
  36. transport_t *transport_get_by_name(const char *name);
  37. MOCK_DECL(void, pt_kickstart_proxy,
  38. (const smartlist_t *transport_list, char **proxy_argv,
  39. int is_server));
  40. #define pt_kickstart_client_proxy(tl, pa) \
  41. pt_kickstart_proxy(tl, pa, 0)
  42. #define pt_kickstart_server_proxy(tl, pa) \
  43. pt_kickstart_proxy(tl, pa, 1)
  44. void pt_configure_remaining_proxies(void);
  45. int pt_proxies_configuration_pending(void);
  46. char *pt_get_extra_info_descriptor_string(void);
  47. void pt_free_all(void);
  48. void pt_prepare_proxy_list_for_config_read(void);
  49. void sweep_proxy_list(void);
  50. smartlist_t *get_transport_proxy_ports(void);
  51. char *pt_stringify_socks_args(const smartlist_t *socks_args);
  52. char *pt_get_socks_args_for_proxy_addrport(const tor_addr_t *addr,
  53. uint16_t port);
  54. #ifdef PT_PRIVATE
  55. /** State of the managed proxy configuration protocol. */
  56. enum pt_proto_state {
  57. PT_PROTO_INFANT, /* was just born */
  58. PT_PROTO_LAUNCHED, /* was just launched */
  59. PT_PROTO_ACCEPTING_METHODS, /* accepting methods */
  60. PT_PROTO_CONFIGURED, /* configured successfully */
  61. PT_PROTO_COMPLETED, /* configure and registered its transports */
  62. PT_PROTO_BROKEN, /* broke during the protocol */
  63. PT_PROTO_FAILED_LAUNCH /* failed while launching */
  64. };
  65. /** Structure containing information of a managed proxy. */
  66. typedef struct {
  67. enum pt_proto_state conf_state; /* the current configuration state */
  68. char **argv; /* the cli arguments of this proxy */
  69. int conf_protocol; /* the configuration protocol version used */
  70. char *proxy_uri; /* the outgoing proxy in TOR_PT_PROXY URI format */
  71. unsigned int proxy_supported : 1; /* the proxy honors TOR_PT_PROXY */
  72. int is_server; /* is it a server proxy? */
  73. /* A pointer to the process handle of this managed proxy. */
  74. process_handle_t *process_handle;
  75. int pid; /* The Process ID this managed proxy is using. */
  76. /** Boolean: We are re-parsing our config, and we are going to
  77. * remove this managed proxy if we don't find it any transport
  78. * plugins that use it. */
  79. unsigned int marked_for_removal : 1;
  80. /** Boolean: We got a SIGHUP while this proxy was running. We use
  81. * this flag to signify that this proxy might need to be restarted
  82. * so that it can listen for other transports according to the new
  83. * torrc. */
  84. unsigned int was_around_before_config_read : 1;
  85. /* transports to-be-launched by this proxy */
  86. smartlist_t *transports_to_launch;
  87. /* The 'transports' list contains all the transports this proxy has
  88. launched. */
  89. smartlist_t *transports;
  90. } managed_proxy_t;
  91. STATIC int parse_cmethod_line(const char *line, managed_proxy_t *mp);
  92. STATIC int parse_smethod_line(const char *line, managed_proxy_t *mp);
  93. STATIC int parse_version(const char *line, managed_proxy_t *mp);
  94. STATIC void parse_env_error(const char *line);
  95. STATIC void parse_proxy_error(const char *line);
  96. STATIC void handle_proxy_line(const char *line, managed_proxy_t *mp);
  97. STATIC char *get_transport_options_for_server_proxy(const managed_proxy_t *mp);
  98. STATIC void managed_proxy_destroy(managed_proxy_t *mp,
  99. int also_terminate_process);
  100. STATIC managed_proxy_t *managed_proxy_create(const smartlist_t *transport_list,
  101. char **proxy_argv, int is_server);
  102. STATIC int configure_proxy(managed_proxy_t *mp);
  103. STATIC char* get_pt_proxy_uri(void);
  104. STATIC void free_execve_args(char **arg);
  105. #endif /* defined(PT_PRIVATE) */
  106. #endif /* !defined(TOR_TRANSPORTS_H) */