- tor-commits - lists.torproject.org

[obfsproxy/master] Remove a conditional that's guaranteed to be false and causes Apple's gcc to barf
by nickm＠torproject.org 10 Sep '11

10 Sep '11

commit 19eda9f86a92e4f8e849e6669a11f2b3beab29e7 Author: Zack Weinberg <zackw(a)panix.com> Date: Thu Aug 4 14:49:56 2011 -0700 Remove a conditional that's guaranteed to be false and causes Apple's gcc to barf --- src/socks.c | 6 ------ 1 files changed, 0 insertions(+), 6 deletions(-) diff --git a/src/socks.c b/src/socks.c index 9941005..46bc5d5 100644 --- a/src/socks.c +++ b/src/socks.c @@ -317,12 +317,6 @@ socks5_handle_negotiation(struct evbuffer *source, evbuffer_drain(source, 1); - /* this should be impossible, but we check it anyway for great defensiveness */ - if (nmethods > 0xFF) { - log_warn("too many methods!"); - return SOCKS_BROKEN; - } - if (evbuffer_remove(source, methods, nmethods) < 0) obfs_abort();

1 0

[obfsproxy/master] Move socks_state, is_open, and flushing fields from conn_t to circuit_t.
by nickm＠torproject.org 10 Sep '11

10 Sep '11

commit c76bd29587ed0be50125f3ac2cd37a0e89710415 Author: Zack Weinberg <zackw(a)panix.com> Date: Wed Aug 3 11:43:13 2011 -0700 Move socks_state, is_open, and flushing fields from conn_t to circuit_t. --- src/network.c | 89 +++++++++++++++++++++++++++++++++++++-------------------- src/network.h | 27 +++++++++++++---- 2 files changed, 78 insertions(+), 38 deletions(-) diff --git a/src/network.c b/src/network.c index 08ce696..cc5b633 100644 --- a/src/network.c +++ b/src/network.c @@ -82,7 +82,9 @@ static void conn_free(conn_t *conn); static void conn_free_all(void); static void conn_free_on_flush(struct bufferevent *bev, void *arg); -static int circuit_create(conn_t *upstream, conn_t *downstream); +static int circuit_create(conn_t *up, conn_t *down); +static void circuit_create_socks(conn_t *up); +static int circuit_add_down(circuit_t *circuit, conn_t *down); static void circuit_free(circuit_t *circuit); static conn_t *open_outbound(conn_t *conn, bufferevent_data_cb readcb); @@ -293,7 +295,7 @@ socks_client_listener_cb(conn_t *conn) obfs_assert(conn->mode == LSN_SOCKS_CLIENT); log_debug("%s: socks client connection", conn->peername); - conn->socks_state = socks_state_new(); + circuit_create_socks(conn); bufferevent_setcb(conn->buffer, socks_read_cb, NULL, error_cb, conn); bufferevent_enable(conn->buffer, EV_READ|EV_WRITE); @@ -341,8 +343,6 @@ conn_free(conn_t *conn) } if (conn->peername) free(conn->peername); - if (conn->socks_state) - socks_state_free(conn->socks_state); if (conn->buffer) bufferevent_free(conn->buffer); proto_conn_free(conn); @@ -386,13 +386,38 @@ circuit_create(conn_t *up, conn_t *down) } static void +circuit_create_socks(conn_t *up) +{ + obfs_assert(up); + + circuit_t *r = xzalloc(sizeof(circuit_t)); + r->upstream = up; + r->socks_state = socks_state_new(); + up->circuit = r; +} + +static int +circuit_add_down(circuit_t *circuit, conn_t *down) +{ + if (!down) + return -1; + circuit->downstream = down; + down->circuit = circuit; + return 0; +} + +static void circuit_free(circuit_t *circuit) { /* break the circular references before deallocating each side */ circuit->upstream->circuit = NULL; - circuit->downstream->circuit = NULL; conn_free(circuit->upstream); - conn_free(circuit->downstream); + if (circuit->downstream) { + circuit->downstream->circuit = NULL; + conn_free(circuit->downstream); + } + if (circuit->socks_state) + socks_state_free(circuit->socks_state); free(circuit); } @@ -504,22 +529,28 @@ static void socks_read_cb(struct bufferevent *bev, void *arg) { conn_t *conn = arg; + socks_state_t *socks; enum socks_ret socks_ret; + log_debug("%s: %s", conn->peername, __func__); + obfs_assert(conn->circuit); + obfs_assert(conn->circuit->socks_state); + socks = conn->circuit->socks_state; do { - enum socks_status_t status = socks_state_get_status(conn->socks_state); + enum socks_status_t status = socks_state_get_status(socks); if (status == ST_SENT_REPLY) { /* We shouldn't be here. */ obfs_abort(); } else if (status == ST_HAVE_ADDR) { int af, r, port; const char *addr=NULL; - r = socks_state_get_address(conn->socks_state, &af, &addr, &port); + r = socks_state_get_address(socks, &af, &addr, &port); obfs_assert(r==0); log_info("%s: socks: trying to connect to %s:%u", conn->peername, addr, port); - if (circuit_create(conn, open_outbound_hostname(conn, af, addr, port))) { + if (circuit_add_down(conn->circuit, + open_outbound_hostname(conn, af, addr, port))) { /* XXXX send socks reply */ conn_free(conn); return; @@ -532,7 +563,7 @@ socks_read_cb(struct bufferevent *bev, void *arg) socks_ret = handle_socks(bufferevent_get_input(bev), bufferevent_get_output(bev), - conn->socks_state); + socks); } while (socks_ret == SOCKS_GOOD); if (socks_ret == SOCKS_INCOMPLETE) @@ -542,7 +573,7 @@ socks_read_cb(struct bufferevent *bev, void *arg) else if (socks_ret == SOCKS_CMD_NOT_CONNECT) { bufferevent_enable(bev, EV_WRITE); bufferevent_disable(bev, EV_READ); - socks5_send_reply(bufferevent_get_output(bev), conn->socks_state, + socks5_send_reply(bufferevent_get_output(bev), socks, SOCKS5_FAILED_UNSUPPORTED); bufferevent_setcb(bev, NULL, conn_free_on_flush, flush_error_cb, conn); @@ -564,10 +595,10 @@ upstream_read_cb(struct bufferevent *bev, void *arg) (unsigned long)evbuffer_get_length(bufferevent_get_input(bev))); obfs_assert(up->buffer == bev); - obfs_assert(!up->flushing); - obfs_assert(up->is_open); obfs_assert(up->circuit); obfs_assert(up->circuit->downstream); + obfs_assert(up->circuit->is_open); + obfs_assert(!up->circuit->is_flushing); down = up->circuit->downstream; if (proto_send(up, @@ -597,10 +628,10 @@ downstream_read_cb(struct bufferevent *bev, void *arg) (unsigned long)evbuffer_get_length(bufferevent_get_input(bev))); obfs_assert(down->buffer == bev); - obfs_assert(!down->flushing); - obfs_assert(down->is_open); obfs_assert(down->circuit); obfs_assert(down->circuit->upstream); + obfs_assert(down->circuit->is_open); + obfs_assert(!down->circuit->is_flushing); up = down->circuit->upstream; @@ -644,7 +675,8 @@ error_or_eof(conn_t *conn) struct bufferevent *bev_flush; log_debug("%s for %s", __func__, conn->peername); - if (!circ || conn->flushing || !conn->is_open) { + if (!circ || !circ->upstream || !circ->downstream || !circ->is_open + || circ->is_flushing) { conn_free(conn); return; } @@ -656,9 +688,7 @@ error_or_eof(conn_t *conn) return; } - /* XXX move ->flushing and ->is_open to circuit_t */ - circ->upstream->flushing = 1; - circ->downstream->flushing = 1; + circ->is_flushing = 1; /* Stop reading and writing; wait for the other side to flush if it has * data. */ @@ -717,7 +747,8 @@ flush_error_cb(struct bufferevent *bev, short what, void *arg) obfs_assert(what & (BEV_EVENT_EOF|BEV_EVENT_ERROR|BEV_EVENT_TIMEOUT)); obfs_assert(!(what & BEV_EVENT_CONNECTED)); - obfs_assert(conn->flushing); + obfs_assert(conn->circuit); + obfs_assert(conn->circuit->is_flushing); log_warn("Error during flush of connection with %s: %s", conn->peername, @@ -743,11 +774,9 @@ pending_conn_cb(struct bufferevent *bev, short what, void *arg) if (what & BEV_EVENT_CONNECTED) { circuit_t *circ = conn->circuit; obfs_assert(circ); - obfs_assert(!circ->upstream->flushing); - obfs_assert(!circ->downstream->flushing); + obfs_assert(!circ->is_flushing); - circ->upstream->is_open = 1; - circ->downstream->is_open = 1; + circ->is_open = 1; log_debug("%s: Successful connection", conn->peername); @@ -790,11 +819,11 @@ pending_socks_cb(struct bufferevent *bev, short what, void *arg) obfs_assert(circ); obfs_assert(circ->upstream); - obfs_assert(circ->upstream->socks_state); + obfs_assert(circ->socks_state); obfs_assert(circ->downstream == down); up = circ->upstream; - socks = circ->upstream->socks_state; + socks = circ->socks_state; /* If we got an error while in the ST_HAVE_ADDR state, chances are that we failed connecting to the host requested by the CONNECT @@ -820,8 +849,7 @@ pending_socks_cb(struct bufferevent *bev, short what, void *arg) struct sockaddr *sa = (struct sockaddr*)&ss; socklen_t slen = sizeof(&ss); - obfs_assert(!up->flushing); - obfs_assert(!down->flushing); + obfs_assert(!circ->is_flushing); /* Figure out where we actually connected to, and tell the socks client */ if (getpeername(bufferevent_getfd(bev), sa, &slen) == 0) { @@ -833,9 +861,8 @@ pending_socks_cb(struct bufferevent *bev, short what, void *arg) /* Switch to regular upstream behavior. */ socks_state_free(socks); - up->socks_state = NULL; - up->is_open = 1; - down->is_open = 1; + circ->socks_state = NULL; + circ->is_open = 1; log_debug("%s: Successful outbound connection to %s", up->peername, down->peername); diff --git a/src/network.h b/src/network.h index 72df32c..fa15f48 100644 --- a/src/network.h +++ b/src/network.h @@ -26,23 +26,36 @@ void start_shutdown(int barbaric); struct conn_t { config_t *cfg; char *peername; - socks_state_t *socks_state; circuit_t *circuit; struct bufferevent *buffer; - enum listen_mode mode : 30; - unsigned int flushing : 1; - unsigned int is_open : 1; + enum listen_mode mode; }; /** - This struct defines a pair of established connections. The "upstream" - connection is to the higher-level client or server that we are proxying - traffic for. The "downstream" connection is to the remote peer. + This struct defines a pair of established connections. + + The "upstream" connection is to the higher-level client or server + that we are proxying traffic for. The "downstream" connection is + to the remote peer. Circuits always have an upstream connection, + and normally also have a downstream connection; however, a circuit + that's waiting for SOCKS directives from its upstream will have a + non-null socks_state field instead. + + A circuit is "open" if both its upstream and downstream connections + have been established (not just if both conn_t objects exist). + It is "flushing" if one of the two connections has hit either EOF + or an error, and we are clearing out the other side's pending + transmissions before closing it. Both of these flags are used + near-exclusively for assertion checks; the actual behavior is + controlled by changing bufferevent callbacks on the connections. */ struct circuit_t { conn_t *upstream; conn_t *downstream; + socks_state_t *socks_state; + unsigned int is_open : 1; + unsigned int is_flushing : 1; }; #endif

1 0

[obfsproxy/master] Disable obfs2 end-to-end tests for now
by nickm＠torproject.org 10 Sep '11

10 Sep '11

commit 792cbb92975a2250b613a6d52b0112cf3207d66e Author: Zack Weinberg <zackw(a)panix.com> Date: Fri Jul 29 09:10:02 2011 -0700 Disable obfs2 end-to-end tests for now --- src/test/tester.py.in | 32 +++++++++++++++++--------------- 1 files changed, 17 insertions(+), 15 deletions(-) diff --git a/src/test/tester.py.in b/src/test/tester.py.in index 916c1a0..683724d 100644 --- a/src/test/tester.py.in +++ b/src/test/tester.py.in @@ -282,12 +282,12 @@ class GoodSocksTest(SocksTest): # Test methods for good SOCKS dialogues; these should be repeated for each # protocol. - def test_socks4_connect(self): + def test_socks4_transfer(self): # SOCKS4 connection request - should succeed self.socksTest([ ( (4, 1, SERVER_PORT, 127, 0, 0, 1, 0), "!BBH5B" ), ( (0, 90, SERVER_PORT, 127, 0, 0, 1), "!BBH4B" ) ]) - def test_socks5_connect(self): + def test_socks5_transfer(self): self.socksTest([ "\x05\x01\x00", "\x05\x00", ( (5, 1, 0, 1, 127, 0, 0, 1, SERVER_PORT), "!8BH" ), ( (5, 0, 0, 1, 127, 0, 0, 1, SERVER_PORT), "!8BH" ) ]) @@ -351,13 +351,14 @@ class SocksBad(SocksTest, unittest.TestCase): # Concrete test classes specialize the above base classes for each protocol. # -class DirectObfs2(DirectTest, unittest.TestCase): - obfs_args = ("obfs2", - "--dest=127.0.0.1:%d" % EXIT_PORT, - "server", "127.0.0.1:%d" % SERVER_PORT, - "+", "obfs2", - "--dest=127.0.0.1:%d" % SERVER_PORT, - "client", "127.0.0.1:%d" % ENTRY_PORT) +# fails, disabled +#class DirectObfs2(DirectTest, unittest.TestCase): +# obfs_args = ("obfs2", +# "--dest=127.0.0.1:%d" % EXIT_PORT, +# "server", "127.0.0.1:%d" % SERVER_PORT, +# "+", "obfs2", +# "--dest=127.0.0.1:%d" % SERVER_PORT, +# "client", "127.0.0.1:%d" % ENTRY_PORT) class DirectDummy(DirectTest, unittest.TestCase): obfs_args = ("dummy", "server", @@ -367,12 +368,13 @@ class DirectDummy(DirectTest, unittest.TestCase): "127.0.0.1:%d" % ENTRY_PORT, "127.0.0.1:%d" % SERVER_PORT) -class SocksObfs2(GoodSocksTest, unittest.TestCase): - server_args = ("obfs2", - "--dest=127.0.0.1:%d" % EXIT_PORT, - "server", "127.0.0.1:%d" % SERVER_PORT) - client_args = ("obfs2", - "socks", "127.0.0.1:%d" % ENTRY_PORT) +# fails, disabled +#class SocksObfs2(GoodSocksTest, unittest.TestCase): +# server_args = ("obfs2", +# "--dest=127.0.0.1:%d" % EXIT_PORT, +# "server", "127.0.0.1:%d" % SERVER_PORT) +# client_args = ("obfs2", +# "socks", "127.0.0.1:%d" % ENTRY_PORT) class SocksDummy(GoodSocksTest, unittest.TestCase): server_args = ("dummy", "server",

1 0

[obfsproxy/master] Fix typo in makefile; fix include search path so subdirectory sources don't need to use ../whatever.h
by nickm＠torproject.org 10 Sep '11

10 Sep '11

commit 60fa1ee82bf5077d0a8194be694a094d7d8c3289 Author: Zack Weinberg <zackw(a)panix.com> Date: Thu Aug 4 15:27:12 2011 -0700 Fix typo in makefile; fix include search path so subdirectory sources don't need to use ../whatever.h Conflicts: Makefile.am --- Makefile.am | 1 + configure.ac | 2 +- src/protocols/dummy.c | 2 +- src/protocols/dummy.h | 4 ++-- src/protocols/obfs2.c | 2 +- src/protocols/obfs2.h | 4 ++-- src/test/unittest.c | 2 +- src/test/unittest_container.c | 6 +++--- src/test/unittest_crypt.c | 4 ++-- src/test/unittest_dummy.c | 4 ++-- src/test/unittest_obfs2.c | 6 +++--- src/test/unittest_socks.c | 6 +++--- 12 files changed, 22 insertions(+), 21 deletions(-) diff --git a/Makefile.am b/Makefile.am index 617fd27..ece6069 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,6 +1,7 @@ ACLOCAL_AMFLAGS = -I m4 WARNINGS = -Wall -Wwrite-strings -Werror +AM_CPPFLAGS = -I. -I$(srcdir)/src AM_CFLAGS = $(WARNINGS) @libevent_CFLAGS@ @libcrypto_CFLAGS@ LDADD = libobfsproxy.a @libevent_LIBS@ @libcrypto_LIBS@ @ws32_LIBS@ diff --git a/configure.ac b/configure.ac index ceeec89..3809750 100644 --- a/configure.ac +++ b/configure.ac @@ -1,7 +1,7 @@ AC_PREREQ([2.61])dnl Possibly earlier will do, but this is what I have AC_INIT([obfsproxy], [0.0]) AC_CONFIG_SRCDIR([src/main.c]) -AM_INIT_AUTOMAKE([foreign]) +AM_INIT_AUTOMAKE([foreign nostdinc]) dnl The stock definition of AC_INCLUDES_DEFAULT performs a whole bunch dnl of completely unnecessary checks *even if* you override its diff --git a/src/protocols/dummy.c b/src/protocols/dummy.c index e55699d..6489f58 100644 --- a/src/protocols/dummy.c +++ b/src/protocols/dummy.c @@ -2,7 +2,7 @@ See LICENSE for other credits and copying information */ -#include "../util.h" +#include "util.h" #define PROTOCOL_DUMMY_PRIVATE #include "dummy.h" diff --git a/src/protocols/dummy.h b/src/protocols/dummy.h index 6a957bb..d243f06 100644 --- a/src/protocols/dummy.h +++ b/src/protocols/dummy.h @@ -14,8 +14,8 @@ extern const protocol_vtable dummy_vtable; ========== */ -#include "../network.h" -#include "../protocol.h" +#include "network.h" +#include "protocol.h" /* Dummy presently needs only the obligatory extensions to the generic protocol structures, but we have shims for future expansion, and diff --git a/src/protocols/obfs2.c b/src/protocols/obfs2.c index f313204..94fd173 100644 --- a/src/protocols/obfs2.c +++ b/src/protocols/obfs2.c @@ -2,7 +2,7 @@ See LICENSE for other credits and copying information */ -#include "../util.h" +#include "util.h" #define PROTOCOL_OBFS2_PRIVATE #include "obfs2.h" diff --git a/src/protocols/obfs2.h b/src/protocols/obfs2.h index ce28217..e994d97 100644 --- a/src/protocols/obfs2.h +++ b/src/protocols/obfs2.h @@ -9,8 +9,8 @@ extern const protocol_vtable obfs2_vtable; #ifdef PROTOCOL_OBFS2_PRIVATE -#include "../crypt.h" -#include "../protocol.h" +#include "crypt.h" +#include "protocol.h" /* ========== These definitions are not part of the obfs2_protocol interface. diff --git a/src/test/unittest.c b/src/test/unittest.c index 29c0af9..13557bf 100644 --- a/src/test/unittest.c +++ b/src/test/unittest.c @@ -3,7 +3,7 @@ */ #include "tinytest.h" -#include "../crypt.h" +#include "crypt.h" extern struct testcase_t container_tests[]; extern struct testcase_t crypt_tests[]; diff --git a/src/test/unittest_container.c b/src/test/unittest_container.c index 4731139..2806520 100644 --- a/src/test/unittest_container.c +++ b/src/test/unittest_container.c @@ -3,11 +3,11 @@ * Copyright (c) 2007-2011, The Tor Project, Inc. */ /* See LICENSE for licensing information */ -#include "../util.h" +#include "util.h" #include "tinytest_macros.h" -#include "../container.h" -#include "../crypt.h" +#include "container.h" +#include "crypt.h" /** Helper: return a tristate based on comparing the strings in *<b>a</b> and * *<b>b</b>. */ diff --git a/src/test/unittest_crypt.c b/src/test/unittest_crypt.c index 112da20..08d53a5 100644 --- a/src/test/unittest_crypt.c +++ b/src/test/unittest_crypt.c @@ -2,11 +2,11 @@ See LICENSE for other credits and copying information */ -#include "../util.h" +#include "util.h" #include "tinytest_macros.h" #define CRYPT_PRIVATE -#include "../crypt.h" +#include "crypt.h" /* Test vectors for sha256 */ static void diff --git a/src/test/unittest_dummy.c b/src/test/unittest_dummy.c index 0eb133c..19a82d4 100644 --- a/src/test/unittest_dummy.c +++ b/src/test/unittest_dummy.c @@ -2,8 +2,8 @@ See LICENSE for other credits and copying information */ -#include "../util.h" -#include "../protocol.h" +#include "util.h" +#include "protocol.h" #include "tinytest_macros.h" #include <event2/buffer.h> diff --git a/src/test/unittest_obfs2.c b/src/test/unittest_obfs2.c index c6d793c..e5addcc 100644 --- a/src/test/unittest_obfs2.c +++ b/src/test/unittest_obfs2.c @@ -2,13 +2,13 @@ See LICENSE for other credits and copying information */ -#include "../util.h" +#include "util.h" #include "tinytest_macros.h" #define PROTOCOL_OBFS2_PRIVATE #define CRYPT_PRIVATE -#include "../protocols/obfs2.h" -#include "../crypt.h" +#include "protocols/obfs2.h" +#include "crypt.h" #include <event2/buffer.h> diff --git a/src/test/unittest_socks.c b/src/test/unittest_socks.c index d213a80..7293d68 100644 --- a/src/test/unittest_socks.c +++ b/src/test/unittest_socks.c @@ -2,12 +2,12 @@ See LICENSE for other credits and copying information */ -#include "../util.h" +#include "util.h" #include "tinytest_macros.h" #define SOCKS_PRIVATE -#include "../socks.h" -#include "../crypt.h" +#include "socks.h" +#include "crypt.h" #include <event2/buffer.h>

1 0

[obfsproxy/master] Partially revert the last-but-one patch; separate "configuration"s from "listener"s.
by nickm＠torproject.org 10 Sep '11

10 Sep '11

commit fa84ea22705ac578fc24fbed91813de12b56a876 Author: Zack Weinberg <zackw(a)panix.com> Date: Tue Aug 2 15:17:55 2011 -0700 Partially revert the last-but-one patch; separate "configuration"s from "listener"s. listener_t is once again entirely internal to network.c and has no protocol-specific content. It points to a 'config_t', which is entirely protocol-specific, but has accessors in the protocol vtable to retrieve listen and target address lists. Generic code can now handle there being more than one listen address (open listening sockets for all of them; each gets its own 'listener_t') or more than one target address (try each in succession until one connects -- this may not work 100% correctly in the case of an asynchronous failure). The notion of a 'target address' or 'listener address' is still not fully decoupled from the notion of an 'upstream address' or 'downstream address', unfortunately. These changes also facilitate further simplification of the argument-parsing code in main(). --- src/main.c | 136 ++++++---------- src/network.c | 390 ++++++++++++++++++++++----------------------- src/network.h | 38 ++---- src/protocol.c | 74 ++++++--- src/protocol.h | 58 +++++-- src/protocols/dummy.c | 125 ++++++++------- src/protocols/dummy.h | 19 ++- src/test/unittest_dummy.c | 34 ++-- src/util.h | 2 +- 9 files changed, 434 insertions(+), 442 deletions(-) diff --git a/src/main.c b/src/main.c index 14125f8..06729be 100644 --- a/src/main.c +++ b/src/main.c @@ -58,7 +58,7 @@ handle_signal_cb(evutil_socket_t fd, short what, void *arg) switch (signum) { case SIGINT: - free_all_listeners(); + close_all_listeners(); if (!got_sigint) { log_info("Got SIGINT. Preparing shutdown."); start_shutdown(0); @@ -104,7 +104,7 @@ is_supported_protocol(const char *name) If it fails, it exits obfsproxy. */ static int -handle_obfsproxy_args(const char **argv) +handle_obfsproxy_args(const char *const *argv) { int logmethod_set=0; int logsev_set=0; @@ -154,83 +154,53 @@ handle_obfsproxy_args(const char **argv) } int -main(int argc, const char **argv) +main(int argc, const char *const *argv) { struct event *sig_int; struct event *sig_term; - - /* Array of argument counts, one per listener. */ - int *listener_argcs = NULL; - - /* Array of pointers into argv. Each points to the beginning of a - sequence of options for a particular listener. */ - const char *const **listener_argvs = NULL; - - /* Total number of listeners requested on the command line. */ - unsigned int n_listeners; - - /* Total number of listeners successfully created. */ - unsigned int n_good_listeners; - - /* Index of the first argv string after the optional obfsproxy - arguments. Normally this should be where the listeners start. */ - int start_of_listeners; - - int cl, i; + smartlist_t *configs = smartlist_create(); + const char *const *begin; + const char *const *end; /* Handle optional obfsproxy arguments. */ - start_of_listeners = handle_obfsproxy_args(argv); + begin = argv + handle_obfsproxy_args(argv); - if (!is_supported_protocol(argv[start_of_listeners])) + /* Find the subsets of argv that define each configuration. + Each configuration's subset consists of the entries in argv from + its recognized protocol name, up to but not including the next + recognized protocol name. */ + if (!*begin || !is_supported_protocol(*begin)) usage(); - /* Count number of listeners and allocate space for the listener- - argument arrays. We already know there's at least one. */ - n_listeners = 1; - for (i = start_of_listeners+1; i < argc; i++) - if (is_supported_protocol(argv[i])) - n_listeners++; - - log_debug("%d listener%s on command line.", - n_listeners, n_listeners == 1 ? "" : "s"); - listener_argcs = xzalloc(n_listeners * sizeof(int)); - listener_argvs = xzalloc(n_listeners * sizeof(char **)); - - /* Each listener's argument vector consists of the entries in argv - from its recognized protocol name, up to but not including - the next recognized protocol name. */ - cl = 1; - listener_argvs[0] = &argv[start_of_listeners]; - for (i = start_of_listeners + 1; i < argc; i++) - if (is_supported_protocol(argv[i])) { - listener_argcs[cl-1] = i - (listener_argvs[cl-1] - argv); - if (listener_argcs[cl-1] == 1) - log_warn("No arguments to listener %d", cl); - - listener_argvs[cl] = &argv[i]; - cl++; - } - - listener_argcs[cl-1] = argc - (listener_argvs[cl-1] - argv); - if (listener_argcs[cl-1] == 1) - log_warn("No arguments to listener %d", cl); - - obfs_assert(cl == n_listeners); - - if (log_do_debug()) { - smartlist_t *s = smartlist_create(); - char *joined; - for (cl = 0; cl < n_listeners; cl++) { - smartlist_clear(s); - for (i = 0; i < listener_argcs[cl]; i++) - smartlist_add(s, (void *)listener_argvs[cl][i]); + do { + end = begin+1; + while (*end && !is_supported_protocol(*end)) + end++; + if (log_do_debug()) { + smartlist_t *s = smartlist_create(); + char *joined; + const char *const *p; + for (p = begin; p < end; p++) + smartlist_add(s, (void *)*p); joined = smartlist_join_strings(s, " ", 0, NULL); - log_debug("Listener %d: %s", cl+1, joined); + log_debug("Configuration %d: %s", smartlist_len(configs)+1, joined); + free(joined); + smartlist_free(s); } - smartlist_free(s); - } + if (end == begin+1) { + log_warn("No arguments for configuration %d", smartlist_len(configs)+1); + usage(); + } else { + config_t *cfg = config_create(end - begin, begin); + if (!cfg) + return 2; /* diagnostic already issued */ + smartlist_add(configs, cfg); + } + begin = end; + } while (*begin); + obfs_assert(smartlist_len(configs) > 0); - /* argv has been chunked; proceed with initialization. */ + /* Configurations have been established; proceed with initialization. */ /* Ugly method to fix a Windows problem: http://archives.seul.org/libevent/users/Oct-2010/msg00049.html */ @@ -268,37 +238,31 @@ main(int argc, const char **argv) return 1; } - /* Open a new listener for each protocol. */ - n_good_listeners = 0; - for (cl = 0; cl < n_listeners; cl++) - if (create_listener(the_event_base, - listener_argcs[cl], listener_argvs[cl])) - n_good_listeners++; - - /* If the number of usable listeners is not equal to the complete - set specified on the command line, we have a usage error. - Diagnostics have already been issued. */ - log_debug("%d recognized listener%s on command line, %d with valid config", - n_listeners, n_listeners == 1 ? "" : "s", n_good_listeners); - if (n_listeners != n_good_listeners) - return 2; + /* Open listeners for each configuration. */ + SMARTLIST_FOREACH(configs, config_t *, cfg, { + if (!open_listeners(the_event_base, cfg)) { + log_error("Failed to open listeners for configuration %d", cfg_sl_idx+1); + return 1; + } + }); /* We are go for launch. */ event_base_dispatch(the_event_base); + /* We have landed. */ log_info("Exiting."); - free_all_listeners(); + close_all_listeners(); + SMARTLIST_FOREACH(configs, config_t *, cfg, config_free(cfg)); + smartlist_free(configs); + evdns_base_free(get_evdns_base(), 0); event_free(sig_int); event_free(sig_term); event_base_free(the_event_base); cleanup_crypto(); - close_obfsproxy_logfile(); - free(listener_argvs); - free(listener_argcs); return 0; } diff --git a/src/network.c b/src/network.c index d11b60f..4ae2c15 100644 --- a/src/network.c +++ b/src/network.c @@ -47,6 +47,15 @@ (version 4 or 5). */ +/** + This struct defines the state of a listener on a particular address. + */ +typedef struct listener_t { + config_t *cfg; + struct evconnlistener *listener; + char *address; +} listener_t; + /** All our listeners. */ static smartlist_t *listeners; @@ -59,18 +68,24 @@ static int shutting_down=0; static void listener_free(listener_t *lsn); -static void simple_client_listener_cb(struct evconnlistener *evcl, - evutil_socket_t fd, struct sockaddr *sourceaddr, int socklen, void *arg); -static void socks_client_listener_cb(struct evconnlistener *evcl, - evutil_socket_t fd, struct sockaddr *sourceaddr, int socklen, void *arg); -static void simple_server_listener_cb(struct evconnlistener *evcl, - evutil_socket_t fd, struct sockaddr *sourceaddr, int socklen, void *arg); +static void listener_cb(struct evconnlistener *evcl, evutil_socket_t fd, + struct sockaddr *sourceaddr, int socklen, + void *closure); + +static void simple_client_listener_cb(conn_t *conn, struct bufferevent *buf); +static void socks_client_listener_cb(conn_t *conn, struct bufferevent *buf); +static void simple_server_listener_cb(conn_t *conn, struct bufferevent *buf); static void conn_free(conn_t *conn); +static void close_conn(conn_t *conn); static void close_all_connections(void); static void close_conn_on_flush(struct bufferevent *bev, void *arg); +static struct bufferevent *open_outbound_socket(conn_t *conn, + struct event_base *base, + bufferevent_data_cb readcb); + static void upstream_read_cb(struct bufferevent *bev, void *arg); static void downstream_read_cb(struct bufferevent *bev, void *arg); static void socks_read_cb(struct bufferevent *bev, void *arg); @@ -126,49 +141,48 @@ close_all_connections(void) } /** - This function spawns a listener configured according to the - provided argument subvector. Returns 1 on success, 0 on failure. - (No, you can't have the listener object. It's private.) -*/ + This function opens listening sockets configured according to the + provided 'config_t'. Returns 1 on success, 0 on failure. + */ int -create_listener(struct event_base *base, int argc, const char *const *argv) +open_listeners(struct event_base *base, config_t *cfg) { const unsigned flags = LEV_OPT_CLOSE_ON_FREE|LEV_OPT_CLOSE_ON_EXEC|LEV_OPT_REUSEABLE; - evconnlistener_cb callback; - listener_t *lsn = proto_listener_create(argc, argv); - if (!lsn) - return 0; - - switch (lsn->mode) { - case LSN_SIMPLE_CLIENT: callback = simple_client_listener_cb; break; - case LSN_SIMPLE_SERVER: callback = simple_server_listener_cb; break; - case LSN_SOCKS_CLIENT: callback = socks_client_listener_cb; break; - default: obfs_abort(); - } - - lsn->listen_addr_str = printable_address(lsn->listen_addr->ai_addr, - lsn->listen_addr->ai_addrlen); - lsn->listener = - evconnlistener_new_bind(base, callback, lsn, flags, -1, - lsn->listen_addr->ai_addr, - lsn->listen_addr->ai_addrlen); - - if (!lsn->listener) { - log_warn("Could not begin listening on %s: %s", - lsn->listen_addr_str, - evutil_socket_error_to_string(EVUTIL_SOCKET_ERROR())); - listener_free(lsn); - return 0; - } - - log_debug("Now listening on %s in mode %d, protocol %s.", - lsn->listen_addr_str, lsn->mode, lsn->vtable->name); + size_t i; + listener_t *lsn; + struct evutil_addrinfo *addrs; /* If we don't have a listener list, create one now. */ if (!listeners) listeners = smartlist_create(); - smartlist_add(listeners, lsn); + + for (i = 0; ; i++) { + addrs = config_get_listen_addrs(cfg, i); + if (!addrs) break; + do { + lsn = xzalloc(sizeof(listener_t)); + lsn->cfg = cfg; + lsn->address = printable_address(addrs->ai_addr, addrs->ai_addrlen); + lsn->listener = + evconnlistener_new_bind(base, listener_cb, lsn, flags, -1, + addrs->ai_addr, addrs->ai_addrlen); + + if (!lsn->listener) { + log_warn("Failed to open listening socket on %s: %s", + lsn->address, + evutil_socket_error_to_string(EVUTIL_SOCKET_ERROR())); + listener_free(lsn); + return 0; + } + + smartlist_add(listeners, lsn); + log_debug("Now listening on %s for protocol %s.", + lsn->address, cfg->vtable->name); + + addrs = addrs->ai_next; + } while (addrs); + } return 1; } @@ -181,21 +195,16 @@ listener_free(listener_t *lsn) { if (lsn->listener) evconnlistener_free(lsn->listener); - if (lsn->listen_addr) - evutil_freeaddrinfo(lsn->listen_addr); - if (lsn->listen_addr_str) - free(lsn->listen_addr_str); - if (lsn->target_addr) - evutil_freeaddrinfo(lsn->target_addr); - - proto_listener_free(lsn); + if (lsn->address) + free(lsn->address); + free(lsn); } /** Frees all active listeners. */ void -free_all_listeners(void) +close_all_listeners(void) { if (!listeners) return; @@ -208,73 +217,75 @@ free_all_listeners(void) } /** - This function is called when an upstream client connects to us in - simple client mode. -*/ + This function is called when any listener receives a connection. + */ static void -simple_client_listener_cb(struct evconnlistener *evcl, - evutil_socket_t fd, struct sockaddr *sourceaddr, - int socklen, void *arg) +listener_cb(struct evconnlistener *evcl, evutil_socket_t fd, + struct sockaddr *peeraddr, int peerlen, + void *closure) { - struct event_base *base; - listener_t *lsn = arg; - conn_t *conn = proto_conn_create(lsn); - if (!conn) { - log_warn("Failed to create state object for new connection to %s", - lsn->listen_addr_str); - goto err; + struct event_base *base = evconnlistener_get_base(evcl); + listener_t *lsn = closure; + char *peername = printable_address(peeraddr, peerlen); + conn_t *conn = proto_conn_create(lsn->cfg); + struct bufferevent *buf = bufferevent_socket_new(base, fd, + BEV_OPT_CLOSE_ON_FREE); + + if (!conn || !buf) { + log_warn("%s: failed to set up new connection from %s.", + lsn->address, peername); + if (buf) + bufferevent_free(buf); + else + evutil_closesocket(fd); + if (conn) + proto_conn_free(conn); + free(peername); + return; } - conn->peername = printable_address(sourceaddr, socklen); - log_debug("%s: connection to %s from %s", __func__, - lsn->listen_addr_str, conn->peername); + if (!connections) + connections = smartlist_create(); + smartlist_add(connections, conn); + log_debug("%s: new connection from %s (%d total)", lsn->address, peername, + smartlist_len(connections)); + + conn->peername = peername; + switch (conn->mode) { + case LSN_SIMPLE_CLIENT: simple_client_listener_cb(conn, buf); break; + case LSN_SOCKS_CLIENT: socks_client_listener_cb(conn, buf); break; + case LSN_SIMPLE_SERVER: simple_server_listener_cb(conn, buf); break; + default: + obfs_abort(); + } +} - conn->mode = lsn->mode; +/** + This function is called when an upstream client connects to us in + simple client mode. +*/ +static void +simple_client_listener_cb(conn_t *conn, struct bufferevent *buf) +{ + struct event_base *base = bufferevent_get_base(buf); + obfs_assert(buf); + obfs_assert(conn); obfs_assert(conn->mode == LSN_SIMPLE_CLIENT); + log_debug("%s: simple client connection", conn->peername); - /* New bufferevent to wrap socket we received. */ - base = evconnlistener_get_base(lsn->listener); - conn->upstream = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE); - if (!conn->upstream) - goto err; - fd = -1; /* prevent double-close */ - - bufferevent_setcb(conn->upstream, - upstream_read_cb, NULL, error_cb, conn); + conn->upstream = buf; + bufferevent_setcb(conn->upstream, upstream_read_cb, NULL, error_cb, conn); /* Don't enable the upstream side for reading at this point; wait till the downstream side is established. */ - /* New bufferevent to connect to the target address */ - conn->downstream = bufferevent_socket_new(base, -1, BEV_OPT_CLOSE_ON_FREE); - if (!conn->downstream) - goto err; - - bufferevent_setcb(conn->downstream, - downstream_read_cb, NULL, pending_conn_cb, conn); - - /* Launch the connect attempt. */ - if (bufferevent_socket_connect(conn->downstream, - lsn->target_addr->ai_addr, - lsn->target_addr->ai_addrlen)<0) - goto err; - - bufferevent_enable(conn->downstream, EV_READ|EV_WRITE); - - /* add conn to the connection list */ - if (!connections) - connections = smartlist_create(); - smartlist_add(connections, conn); - - log_debug("%s: setup completed, %d connections", - __func__, smartlist_len(connections)); - return; + conn->downstream = open_outbound_socket(conn, base, downstream_read_cb); + if (!conn->downstream) { + close_conn(conn); + return; + } - err: - if (conn) - conn_free(conn); - if (fd >= 0) - evutil_closesocket(fd); + log_debug("%s: setup complete", conn->peername); } /** @@ -282,56 +293,24 @@ simple_client_listener_cb(struct evconnlistener *evcl, socks mode. */ static void -socks_client_listener_cb(struct evconnlistener *evcl, - evutil_socket_t fd, struct sockaddr *sourceaddr, - int socklen, void *arg) +socks_client_listener_cb(conn_t *conn, struct bufferevent *buf) { - struct event_base *base; - listener_t *lsn = arg; - conn_t *conn = proto_conn_create(lsn); - if (!conn) { - log_warn("Failed to create state object for new connection to %s", - lsn->listen_addr_str); - goto err; - } - - conn->peername = printable_address(sourceaddr, socklen); - log_debug("%s: connection to %s from %s", __func__, - lsn->listen_addr_str, conn->peername); - - conn->mode = lsn->mode; + obfs_assert(buf); + obfs_assert(conn); obfs_assert(conn->mode == LSN_SOCKS_CLIENT); + log_debug("%s: socks client connection", conn->peername); - /* Construct SOCKS state. */ - conn->socks_state = socks_state_new(); - - /* New bufferevent to wrap socket we received. */ - base = evconnlistener_get_base(lsn->listener); - conn->upstream = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE); - if (!conn->upstream) - goto err; - fd = -1; /* prevent double-close */ - + conn->upstream = buf; bufferevent_setcb(conn->upstream, socks_read_cb, NULL, error_cb, conn); bufferevent_enable(conn->upstream, EV_READ|EV_WRITE); + /* Construct SOCKS state. */ + conn->socks_state = socks_state_new(); + /* Do not create a downstream bufferevent at this time; the socks handler will do it after it learns the downstream peer address. */ - /* add conn to the connection list */ - if (!connections) - connections = smartlist_create(); - smartlist_add(connections, conn); - - log_debug("%s: setup completed, %d connections", - __func__, smartlist_len(connections)); - return; - - err: - if (conn) - conn_free(conn); - if (fd >= 0) - evutil_closesocket(fd); + log_debug("%s: setup complete", conn->peername); } /** @@ -339,33 +318,15 @@ socks_client_listener_cb(struct evconnlistener *evcl, server mode. */ static void -simple_server_listener_cb(struct evconnlistener *evcl, - evutil_socket_t fd, struct sockaddr *sourceaddr, - int socklen, void *arg) +simple_server_listener_cb(conn_t *conn, struct bufferevent *buf) { - struct event_base *base; - listener_t *lsn = arg; - conn_t *conn = proto_conn_create(lsn); - if (!conn) { - log_warn("Failed to create state object for new connection to %s", - lsn->listen_addr_str); - goto err; - } - - conn->peername = printable_address(sourceaddr, socklen); - log_debug("%s: connection to %s from %s", __func__, - lsn->listen_addr_str, conn->peername); - - conn->mode = lsn->mode; + struct event_base *base = bufferevent_get_base(buf); + obfs_assert(buf); + obfs_assert(conn); obfs_assert(conn->mode == LSN_SIMPLE_SERVER); + log_debug("%s: server connection", conn->peername); - /* New bufferevent to wrap socket we received. */ - base = evconnlistener_get_base(lsn->listener); - conn->downstream = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE); - if (!conn->downstream) - goto err; - fd = -1; /* prevent double-close */ - + conn->downstream = buf; bufferevent_setcb(conn->downstream, downstream_read_cb, NULL, error_cb, conn); @@ -373,35 +334,13 @@ simple_server_listener_cb(struct evconnlistener *evcl, till the upstream side is established. */ /* New bufferevent to connect to the target address. */ - conn->upstream = bufferevent_socket_new(base, -1, BEV_OPT_CLOSE_ON_FREE); - if (!conn->upstream) - goto err; - - bufferevent_setcb(conn->upstream, - upstream_read_cb, NULL, pending_conn_cb, conn); - - /* Launch the connect attempt. */ - if (bufferevent_socket_connect(conn->upstream, - lsn->target_addr->ai_addr, - lsn->target_addr->ai_addrlen) < 0) - goto err; - - bufferevent_enable(conn->upstream, EV_READ|EV_WRITE); - - /* add conn to the connection list */ - if (!connections) - connections = smartlist_create(); - smartlist_add(connections, conn); - - log_debug("%s: setup completed, %d connections", - __func__, smartlist_len(connections)); - return; + conn->upstream = open_outbound_socket(conn, base, upstream_read_cb); + if (!conn->upstream) { + close_conn(conn); + return; + } - err: - if (conn) - conn_free(conn); - if (fd >= 0) - evutil_closesocket(fd); + log_debug("%s: setup complete", conn->peername); } /** @@ -437,13 +376,10 @@ close_conn(conn_t *conn) /* If this was the last connection AND we are shutting down, finish shutdown. */ - if (smartlist_len(connections) == 0) { + if (smartlist_len(connections) == 0 && shutting_down) { smartlist_free(connections); - connections = NULL; - } - - if (!connections && shutting_down) finish_shutdown(); + } } /** @@ -461,6 +397,54 @@ close_conn_on_flush(struct bufferevent *bev, void *arg) } /** + Make the outbound socket for a connection. +*/ +static struct bufferevent * +open_outbound_socket(conn_t *conn, struct event_base *base, + bufferevent_data_cb readcb) +{ + struct evutil_addrinfo *addr = config_get_target_addr(conn->cfg); + struct bufferevent *buf; + char *peername; + + if (!addr) { + log_warn("%s: no target addresses available", conn->peername); + return NULL; + } + + buf = bufferevent_socket_new(base, -1, BEV_OPT_CLOSE_ON_FREE); + if (!buf) { + log_warn("%s: unable to create outbound socket buffer", conn->peername); + return NULL; + } + + bufferevent_setcb(buf, readcb, NULL, pending_conn_cb, conn); + + do { + peername = printable_address(addr->ai_addr, addr->ai_addrlen); + log_info("%s (%s): trying to connect to %s", + conn->peername, conn->cfg->vtable->name, peername); + if (bufferevent_socket_connect(buf, addr->ai_addr, addr->ai_addrlen) >= 0) { + /* success */ + bufferevent_enable(buf, EV_READ|EV_WRITE); + free(peername); + return buf; + } + log_info("%s: connection to %s failed: %s", + conn->peername, peername, + evutil_socket_error_to_string(EVUTIL_SOCKET_ERROR())); + free(peername); + addr = addr->ai_next; + } while (addr); + + log_warn("%s: all outbound connection attempts failed", + conn->peername); + + bufferevent_free(buf); + return NULL; +} + +/** This callback is responsible for handling SOCKS traffic. */ static void diff --git a/src/network.h b/src/network.h index 17b0e6b..8fb41ef 100644 --- a/src/network.h +++ b/src/network.h @@ -6,30 +6,12 @@ #define NETWORK_H /* returns 1 on success, 0 on failure */ -int create_listener(struct event_base *base, int argc, const char *const *argv); -void free_all_listeners(void); +int open_listeners(struct event_base *base, config_t *cfg); +void close_all_listeners(void); void start_shutdown(int barbaric); /** - This struct defines the state of a listener on a particular address. - Each protocol may extend this structure with additional private data - by embedding it as the first member of a larger structure (standard - fake-inheritance-in-C technique). The protocol's listener_create() - method is responsible for filling in the |vtable|, |listen_addr|, - |target_addr|, and |mode| fields of this structure, but should leave - the |listener| and |listen_addr_str| fields alone. - */ -struct listener_t { - const protocol_vtable *vtable; - struct evconnlistener *listener; - struct evutil_addrinfo *listen_addr; - char *listen_addr_str; - struct evutil_addrinfo *target_addr; - enum listen_mode mode; -}; - -/** This struct defines the state of a connection between "upstream" and "downstream" peers (it's really two connections at the socket level). Again, each protocol may extend this structure with @@ -39,14 +21,14 @@ struct listener_t { private data of course. */ struct conn_t { - const protocol_vtable *vtable; - char *peername; - socks_state_t *socks_state; - struct bufferevent *upstream; - struct bufferevent *downstream; - enum listen_mode mode : 30; - unsigned int flushing : 1; - unsigned int is_open : 1; + config_t *cfg; + char *peername; + socks_state_t *socks_state; + struct bufferevent *upstream; + struct bufferevent *downstream; + enum listen_mode mode : 30; + unsigned int flushing : 1; + unsigned int is_open : 1; }; #endif diff --git a/src/protocol.c b/src/protocol.c index eddb9a3..e5d1818 100644 --- a/src/protocol.c +++ b/src/protocol.c @@ -22,18 +22,18 @@ const size_t n_supported_protocols = sizeof(supported_protocols)/sizeof(supported_protocols[0]); /** - This function dispatches (by name) creation of a |listener_t| + This function dispatches (by name) creation of a |config_t| to the appropriate protocol-specific initalization function. */ -listener_t * -proto_listener_create(int n_options, const char *const *options) +config_t * +config_create(int n_options, const char *const *options) { size_t i; for (i = 0; i < n_supported_protocols; i++) if (!strcmp(*options, supported_protocols[i]->name)) /* Remove the first element of 'options' (which is always the protocol name) from the list passed to the init method. */ - return supported_protocols[i]->listener_create(n_options - 1, options + 1); + return supported_protocols[i]->config_create(n_options - 1, options + 1); return NULL; } @@ -42,12 +42,30 @@ proto_listener_create(int n_options, const char *const *options) This function destroys the protocol-specific part of a listener object. */ void -proto_listener_free(listener_t *lsn) +config_free(config_t *cfg) { - obfs_assert(lsn); - obfs_assert(lsn->vtable); - obfs_assert(lsn->vtable->listener_free); - lsn->vtable->listener_free(lsn); + obfs_assert(cfg); + obfs_assert(cfg->vtable); + obfs_assert(cfg->vtable->config_free); + cfg->vtable->config_free(cfg); +} + +struct evutil_addrinfo * +config_get_listen_addrs(config_t *cfg, size_t n) +{ + obfs_assert(cfg); + obfs_assert(cfg->vtable); + obfs_assert(cfg->vtable->config_get_listen_addrs); + return cfg->vtable->config_get_listen_addrs(cfg, n); +} + +struct evutil_addrinfo * +config_get_target_addr(config_t *cfg) +{ + obfs_assert(cfg); + obfs_assert(cfg->vtable); + obfs_assert(cfg->vtable->config_get_target_addr); + return cfg->vtable->config_get_target_addr(cfg); } /** @@ -57,12 +75,12 @@ proto_listener_free(listener_t *lsn) Return a 'protocol_t' if successful, NULL otherwise. */ conn_t * -proto_conn_create(listener_t *lsn) +proto_conn_create(config_t *cfg) { - obfs_assert(lsn); - obfs_assert(lsn->vtable); - obfs_assert(lsn->vtable->conn_create); - return lsn->vtable->conn_create(lsn); + obfs_assert(cfg); + obfs_assert(cfg->vtable); + obfs_assert(cfg->vtable->conn_create); + return cfg->vtable->conn_create(cfg); } /** @@ -72,9 +90,10 @@ proto_conn_create(listener_t *lsn) int proto_handshake(conn_t *conn, void *buf) { obfs_assert(conn); - obfs_assert(conn->vtable); - obfs_assert(conn->vtable->handshake); - return conn->vtable->handshake(conn, buf); + obfs_assert(conn->cfg); + obfs_assert(conn->cfg->vtable); + obfs_assert(conn->cfg->vtable->handshake); + return conn->cfg->vtable->handshake(conn, buf); } /** @@ -83,9 +102,10 @@ proto_handshake(conn_t *conn, void *buf) { int proto_send(conn_t *conn, void *source, void *dest) { obfs_assert(conn); - obfs_assert(conn->vtable); - obfs_assert(conn->vtable->send); - return conn->vtable->send(conn, source, dest); + obfs_assert(conn->cfg); + obfs_assert(conn->cfg->vtable); + obfs_assert(conn->cfg->vtable->send); + return conn->cfg->vtable->send(conn, source, dest); } /** @@ -94,9 +114,10 @@ proto_send(conn_t *conn, void *source, void *dest) { enum recv_ret proto_recv(conn_t *conn, void *source, void *dest) { obfs_assert(conn); - obfs_assert(conn->vtable); - obfs_assert(conn->vtable->recv); - return conn->vtable->recv(conn, source, dest); + obfs_assert(conn->cfg); + obfs_assert(conn->cfg->vtable); + obfs_assert(conn->cfg->vtable->recv); + return conn->cfg->vtable->recv(conn, source, dest); } /** @@ -106,7 +127,8 @@ proto_recv(conn_t *conn, void *source, void *dest) { void proto_conn_free(conn_t *conn) { obfs_assert(conn); - obfs_assert(conn->vtable); - obfs_assert(conn->vtable->conn_free); - conn->vtable->conn_free(conn); + obfs_assert(conn->cfg); + obfs_assert(conn->cfg->vtable); + obfs_assert(conn->cfg->vtable->conn_free); + conn->cfg->vtable->conn_free(conn); } diff --git a/src/protocol.h b/src/protocol.h index 6dfb04a..989b6db 100644 --- a/src/protocol.h +++ b/src/protocol.h @@ -6,6 +6,18 @@ #define PROTOCOL_H /** + This struct defines a "configuration" of the proxy. + A configuration is a set of addresses to listen on, and what to do + when connections are received. Almost all of a configuration is + protocol-private data, stored in the larger structure in which this + struct is embedded. + */ +struct config_t +{ + const struct protocol_vtable *vtable; +}; + +/** This struct defines a protocol and its methods; note that not all of them are methods on the same object in the C++ sense. @@ -18,20 +30,29 @@ struct protocol_vtable /** The short name of this protocol. */ const char *name; - /** Allocate a 'listener_t' object and fill it in from the provided + /** Allocate a 'config_t' object and fill it in from the provided 'options' array. */ - listener_t *(*listener_create)(int n_options, const char *const *options); + config_t *(*config_create)(int n_options, const char *const *options); + + /** Destroy the provided 'config_t' object. */ + void (*config_free)(config_t *cfg); - /** Destroy the provided 'listener_t' object. This function is - responsible for deallocating any data that the protocol's - extended structure points to, and deallocating the object - itself. But it is *not* responsible for deallocating the data - pointed to by the generic 'listener_t'; that's already been done - by generic code. */ - void (*listener_free)(listener_t *params); + /** Return a set of addresses to listen on, in the form of an + 'evutil_addrinfo' linked list. There may be more than one list; + users of this function should call it repeatedly with successive + values of N, starting from zero, until it returns NULL, and + create listeners for every address returned. */ + struct evutil_addrinfo *(*config_get_listen_addrs)(config_t *cfg, size_t n); - /** Allocate per-connection, protocol-specific state. */ - conn_t *(*conn_create)(listener_t *params); + /** Return a set of addresses to attempt an outbound connection to, + in the form of an 'evutil_addrinfo' linked list. There is only + one such list. */ + struct evutil_addrinfo *(*config_get_target_addr)(config_t *cfg); + + /** A connection has just been made to one of 'cfg's listener + addresses. Return an extended 'conn_t' object, filling in the + 'cfg' and 'mode' fields of the generic structure. */ + conn_t *(*conn_create)(config_t *cfg); /** Destroy per-connection, protocol-specific state. */ void (*conn_free)(conn_t *state); @@ -59,17 +80,22 @@ struct protocol_vtable #define DEFINE_PROTOCOL_VTABLE(name) \ const protocol_vtable name##_vtable = { \ #name, \ - name##_listener_create, \ - name##_listener_free, \ + name##_config_create, \ + name##_config_free, \ + name##_config_get_listen_addrs, \ + name##_config_get_target_addr, \ name##_conn_create, \ name##_conn_free, \ name##_handshake, name##_send, name##_recv \ } -listener_t *proto_listener_create(int n_options, const char *const *options); -void proto_listener_free(listener_t *lsn); +config_t *config_create(int n_options, const char *const *options); +void config_free(config_t *cfg); + +struct evutil_addrinfo *config_get_listen_addrs(config_t *cfg, size_t n); +struct evutil_addrinfo *config_get_target_addr(config_t *cfg); -conn_t *proto_conn_create(listener_t *lsn); +conn_t *proto_conn_create(config_t *cfg); void proto_conn_free(conn_t *conn); int proto_handshake(conn_t *conn, void *buf); diff --git a/src/protocols/dummy.c b/src/protocols/dummy.c index 30b0d16..e55699d 100644 --- a/src/protocols/dummy.c +++ b/src/protocols/dummy.c @@ -10,10 +10,10 @@ #include <event2/buffer.h> /* type-safe downcast wrappers */ -static inline dummy_listener_t * -downcast_listener(listener_t *p) +static inline dummy_config_t * +downcast_config(config_t *p) { - return DOWNCAST(dummy_listener_t, super, p); + return DOWNCAST(dummy_config_t, super, p); } static inline dummy_conn_t * @@ -22,51 +22,12 @@ downcast_conn(conn_t *p) return DOWNCAST(dummy_conn_t, super, p); } -static int parse_and_set_options(int n_options, - const char *const *options, - dummy_listener_t *lsn); - /** - This function populates 'lsn' according to 'options' and sets up - the protocol vtable. - - 'options' is an array like this: - {"dummy","socks","127.0.0.1:6666"} -*/ -static listener_t * -dummy_listener_create(int n_options, const char *const *options) -{ - dummy_listener_t *lsn = xzalloc(sizeof(dummy_listener_t)); - lsn->super.vtable = &dummy_vtable; - - if (parse_and_set_options(n_options, options, lsn) == 0) - return &lsn->super; - - if (lsn->super.listen_addr) - evutil_freeaddrinfo(lsn->super.listen_addr); - if (lsn->super.target_addr) - evutil_freeaddrinfo(lsn->super.target_addr); - free(lsn); - - log_warn("dummy syntax:\n" - "\tdummy <mode> <listen_address> [<target_address>]\n" - "\t\tmode ~ server|client|socks\n" - "\t\tlisten_address, target_address ~ host:port\n" - "\ttarget_address is required for server and client mode,\n" - "\tand forbidden for socks mode.\n" - "Examples:\n" - "\tobfsproxy dummy socks 127.0.0.1:5000\n" - "\tobfsproxy dummy client 127.0.0.1:5000 192.168.1.99:11253\n" - "\tobfsproxy dummy server 192.168.1.99:11253 127.0.0.1:9005"); - return NULL; -} - -/** - Helper: Parses 'options' and fills 'lsn'. + Helper: Parses 'options' and fills 'cfg'. */ static int parse_and_set_options(int n_options, const char *const *options, - dummy_listener_t *lsn) + dummy_config_t *cfg) { const char* defport; @@ -75,36 +36,85 @@ parse_and_set_options(int n_options, const char *const *options, if (!strcmp(options[0], "client")) { defport = "48988"; /* bf5c */ - lsn->super.mode = LSN_SIMPLE_CLIENT; + cfg->mode = LSN_SIMPLE_CLIENT; } else if (!strcmp(options[0], "socks")) { defport = "23548"; /* 5bf5 */ - lsn->super.mode = LSN_SOCKS_CLIENT; + cfg->mode = LSN_SOCKS_CLIENT; } else if (!strcmp(options[0], "server")) { defport = "11253"; /* 2bf5 */ - lsn->super.mode = LSN_SIMPLE_SERVER; + cfg->mode = LSN_SIMPLE_SERVER; } else return -1; - if (n_options != (lsn->super.mode == LSN_SOCKS_CLIENT ? 2 : 3)) + if (n_options != (cfg->mode == LSN_SOCKS_CLIENT ? 2 : 3)) return -1; - lsn->super.listen_addr = resolve_address_port(options[1], 1, 1, defport); - if (!lsn->super.listen_addr) + cfg->listen_addr = resolve_address_port(options[1], 1, 1, defport); + if (!cfg->listen_addr) return -1; - if (lsn->super.mode != LSN_SOCKS_CLIENT) { - lsn->super.target_addr = resolve_address_port(options[2], 1, 0, NULL); - if (!lsn->super.target_addr) + if (cfg->mode != LSN_SOCKS_CLIENT) { + cfg->target_addr = resolve_address_port(options[2], 1, 0, NULL); + if (!cfg->target_addr) return -1; } return 0; } +/* Deallocate 'cfg'. */ static void -dummy_listener_free(listener_t *lsn) +dummy_config_free(config_t *c) +{ + dummy_config_t *cfg = downcast_config(c); + if (cfg->listen_addr) + evutil_freeaddrinfo(cfg->listen_addr); + if (cfg->target_addr) + evutil_freeaddrinfo(cfg->target_addr); + free(cfg); +} + +/** + Populate 'cfg' according to 'options', which is an array like this: + {"socks","127.0.0.1:6666"} +*/ +static config_t * +dummy_config_create(int n_options, const char *const *options) +{ + dummy_config_t *cfg = xzalloc(sizeof(dummy_config_t)); + cfg->super.vtable = &dummy_vtable; + + if (parse_and_set_options(n_options, options, cfg) == 0) + return &cfg->super; + + dummy_config_free(&cfg->super); + log_warn("dummy syntax:\n" + "\tdummy <mode> <listen_address> [<target_address>]\n" + "\t\tmode ~ server|client|socks\n" + "\t\tlisten_address, target_address ~ host:port\n" + "\ttarget_address is required for server and client mode,\n" + "\tand forbidden for socks mode.\n" + "Examples:\n" + "\tobfsproxy dummy socks 127.0.0.1:5000\n" + "\tobfsproxy dummy client 127.0.0.1:5000 192.168.1.99:11253\n" + "\tobfsproxy dummy server 192.168.1.99:11253 127.0.0.1:9005"); + return NULL; +} + +/** Retrieve the 'n'th set of listen addresses for this configuration. */ +static struct evutil_addrinfo * +dummy_config_get_listen_addrs(config_t *cfg, size_t n) +{ + if (n > 0) + return 0; + return downcast_config(cfg)->listen_addr; +} + +/* Retrieve the target address for this configuration. */ +static struct evutil_addrinfo * +dummy_config_get_target_addr(config_t *cfg) { - free(downcast_listener(lsn)); + return downcast_config(cfg)->target_addr; } /* @@ -113,10 +123,11 @@ dummy_listener_free(listener_t *lsn) */ static conn_t * -dummy_conn_create(listener_t *lsn) +dummy_conn_create(config_t *cfg) { dummy_conn_t *proto = xzalloc(sizeof(dummy_conn_t)); - proto->super.vtable = &dummy_vtable; + proto->super.cfg = cfg; + proto->super.mode = downcast_config(cfg)->mode; return &proto->super; } diff --git a/src/protocols/dummy.h b/src/protocols/dummy.h index e7a450e..6a957bb 100644 --- a/src/protocols/dummy.h +++ b/src/protocols/dummy.h @@ -17,14 +17,17 @@ extern const protocol_vtable dummy_vtable; #include "../network.h" #include "../protocol.h" -/* Dummy presently needs no extensions to the generic protocol - structures, but we have shims for future expansion, and also - because, if you're using dummy as a template, you probably will - want to extend the generic structures. */ - -typedef struct dummy_listener_t { - listener_t super; -} dummy_listener_t; +/* Dummy presently needs only the obligatory extensions to the generic + protocol structures, but we have shims for future expansion, and + also because, if you're using dummy as a template, you probably + will want to extend the generic structures. */ + +typedef struct dummy_config_t { + config_t super; + struct evutil_addrinfo *listen_addr; + struct evutil_addrinfo *target_addr; + enum listen_mode mode; +} dummy_config_t; typedef struct dummy_conn_t { conn_t super; diff --git a/src/test/unittest_dummy.c b/src/test/unittest_dummy.c index ec09a82..0eb133c 100644 --- a/src/test/unittest_dummy.c +++ b/src/test/unittest_dummy.c @@ -12,7 +12,7 @@ static void test_dummy_option_parsing(void *unused) { struct option_parsing_case { - listener_t *result; + config_t *result; short should_succeed; short n_opts; const char *const opts[4]; @@ -45,7 +45,7 @@ test_dummy_option_parsing(void *unused) struct option_parsing_case *c; for (c = cases; c->n_opts; c++) { - c->result = proto_listener_create(c->n_opts, c->opts); + c->result = config_create(c->n_opts, c->opts); if (c->should_succeed) tt_ptr_op(c->result, !=, NULL); else @@ -55,7 +55,7 @@ test_dummy_option_parsing(void *unused) end: for (c = cases; c->n_opts; c++) if (c->result) - proto_listener_free(c->result); + config_free(c->result); /* Unsuspend logging */ log_set_method(LOG_METHOD_STDERR, NULL); @@ -64,8 +64,8 @@ test_dummy_option_parsing(void *unused) /* All the tests below use this test environment: */ struct test_dummy_state { - listener_t *lsn_client; - listener_t *lsn_server; + config_t *cfg_client; + config_t *cfg_server; conn_t *conn_client; conn_t *conn_server; struct evbuffer *output_buffer; @@ -82,10 +82,10 @@ cleanup_dummy_state(const struct testcase_t *unused, void *state) if (s->conn_server) proto_conn_free(s->conn_server); - if (s->lsn_client) - proto_listener_free(s->lsn_client); - if (s->lsn_server) - proto_listener_free(s->lsn_server); + if (s->cfg_client) + config_free(s->cfg_client); + if (s->cfg_server) + config_free(s->cfg_server); if (s->output_buffer) evbuffer_free(s->output_buffer); @@ -109,18 +109,18 @@ setup_dummy_state(const struct testcase_t *unused) { struct test_dummy_state *s = xzalloc(sizeof(struct test_dummy_state)); - s->lsn_client = - proto_listener_create(ALEN(options_client), options_client); - tt_assert(s->lsn_client); + s->cfg_client = + config_create(ALEN(options_client), options_client); + tt_assert(s->cfg_client); - s->lsn_server = - proto_listener_create(ALEN(options_server), options_server); - tt_assert(s->lsn_server); + s->cfg_server = + config_create(ALEN(options_server), options_server); + tt_assert(s->cfg_server); - s->conn_client = proto_conn_create(s->lsn_client); + s->conn_client = proto_conn_create(s->cfg_client); tt_assert(s->conn_client); - s->conn_server = proto_conn_create(s->lsn_server); + s->conn_server = proto_conn_create(s->cfg_server); tt_assert(s->conn_server); s->output_buffer = evbuffer_new(); diff --git a/src/util.h b/src/util.h index 8b6f3b4..8228790 100644 --- a/src/util.h +++ b/src/util.h @@ -62,8 +62,8 @@ unsigned int ui64_log2(uint64_t u64); /***** Network types and functions. *****/ +typedef struct config_t config_t; typedef struct conn_t conn_t; -typedef struct listener_t listener_t; typedef struct protocol_vtable protocol_vtable; typedef struct socks_state_t socks_state_t;

1 0

[obfsproxy/master] Merge protocol_params_t into listener_t.
by nickm＠torproject.org 10 Sep '11

10 Sep '11

commit 07dd121cd4d49793df67b3e1a57e52e8bdf7f9a8 Author: Zack Weinberg <zackw(a)panix.com> Date: Tue Aug 2 10:16:31 2011 -0700 Merge protocol_params_t into listener_t. --- src/network.c | 68 +++++++++++++++++++++++--------------------- src/network.h | 24 ++++++++++++---- src/protocol.c | 53 +++++++++++++---------------------- src/protocol.h | 46 ++++++++++-------------------- src/protocols/dummy.c | 57 ++++++++++++++++++++----------------- src/protocols/dummy.h | 7 ++-- src/test/unittest_dummy.c | 34 +++++++++++----------- src/util.h | 4 +- 8 files changed, 144 insertions(+), 149 deletions(-) diff --git a/src/network.c b/src/network.c index c327403..b1d71dc 100644 --- a/src/network.c +++ b/src/network.c @@ -58,6 +58,8 @@ static smartlist_t *connections; connections and shutdowns when the last connection is closed. */ static int shutting_down=0; +static void listener_free(listener_t *lsn); + static void simple_client_listener_cb(struct evconnlistener *evcl, evutil_socket_t fd, struct sockaddr *sourceaddr, int socklen, void *arg); static void socks_client_listener_cb(struct evconnlistener *evcl, @@ -135,35 +137,34 @@ create_listener(struct event_base *base, int argc, const char *const *argv) const unsigned flags = LEV_OPT_CLOSE_ON_FREE|LEV_OPT_CLOSE_ON_EXEC|LEV_OPT_REUSEABLE; evconnlistener_cb callback; - listener_t *lsn; - protocol_params_t *params = proto_params_init(argc, argv); - if (!params) + listener_t *lsn = proto_listener_create(argc, argv); + if (!lsn) return 0; - switch (params->mode) { + switch (lsn->mode) { case LSN_SIMPLE_CLIENT: callback = simple_client_listener_cb; break; case LSN_SIMPLE_SERVER: callback = simple_server_listener_cb; break; case LSN_SOCKS_CLIENT: callback = socks_client_listener_cb; break; default: obfs_abort(); } - lsn = xzalloc(sizeof(listener_t)); - lsn->address = printable_address(params->listen_addr->ai_addr, - params->listen_addr->ai_addrlen); - lsn->proto_params = params; + + lsn->listen_addr_str = printable_address(lsn->listen_addr->ai_addr, + lsn->listen_addr->ai_addrlen); lsn->listener = evconnlistener_new_bind(base, callback, lsn, flags, -1, - params->listen_addr->ai_addr, - params->listen_addr->ai_addrlen); + lsn->listen_addr->ai_addr, + lsn->listen_addr->ai_addrlen); if (!lsn->listener) { - log_warn("Failed to create listener!"); - proto_params_free(params); - free(lsn); + log_warn("Could not begin listening on %s: %s", + lsn->listen_addr_str, + evutil_socket_error_to_string(EVUTIL_SOCKET_ERROR())); + listener_free(lsn); return 0; } log_debug("Now listening on %s in mode %d, protocol %s.", - lsn->address, params->mode, params->vtable->name); + lsn->listen_addr_str, lsn->mode, lsn->vtable->name); /* If we don't have a listener list, create one now. */ if (!listeners) @@ -179,13 +180,16 @@ create_listener(struct event_base *base, int argc, const char *const *argv) static void listener_free(listener_t *lsn) { - if (lsn->address) - free(lsn->address); if (lsn->listener) evconnlistener_free(lsn->listener); - if (lsn->proto_params) - proto_params_free(lsn->proto_params); - free(lsn); + if (lsn->listen_addr) + evutil_freeaddrinfo(lsn->listen_addr); + if (lsn->listen_addr_str) + free(lsn->listen_addr_str); + if (lsn->target_addr) + evutil_freeaddrinfo(lsn->target_addr); + + proto_listener_free(lsn); } /** @@ -219,12 +223,12 @@ simple_client_listener_cb(struct evconnlistener *evcl, conn->peername = printable_address(sourceaddr, socklen); log_debug("%s: connection to %s from %s", __func__, - lsn->address, conn->peername); + lsn->listen_addr_str, conn->peername); - conn->mode = lsn->proto_params->mode; + conn->mode = lsn->mode; obfs_assert(conn->mode == LSN_SIMPLE_CLIENT); - conn->proto = proto_create(lsn->proto_params); + conn->proto = proto_create(lsn); if (!conn->proto) { log_warn("Creation of protocol object failed! Closing connection."); goto err; @@ -253,8 +257,8 @@ simple_client_listener_cb(struct evconnlistener *evcl, /* Launch the connect attempt. */ if (bufferevent_socket_connect(conn->downstream, - lsn->proto_params->target_addr->ai_addr, - lsn->proto_params->target_addr->ai_addrlen)<0) + lsn->target_addr->ai_addr, + lsn->target_addr->ai_addrlen)<0) goto err; bufferevent_enable(conn->downstream, EV_READ|EV_WRITE); @@ -290,12 +294,12 @@ socks_client_listener_cb(struct evconnlistener *evcl, conn->peername = printable_address(sourceaddr, socklen); log_debug("%s: connection to %s from %s", __func__, - lsn->address, conn->peername); + lsn->listen_addr_str, conn->peername); - conn->mode = lsn->proto_params->mode; + conn->mode = lsn->mode; obfs_assert(conn->mode == LSN_SOCKS_CLIENT); - conn->proto = proto_create(lsn->proto_params); + conn->proto = proto_create(lsn); if (!conn->proto) { log_warn("Creation of protocol object failed! Closing connection."); goto err; @@ -348,12 +352,12 @@ simple_server_listener_cb(struct evconnlistener *evcl, conn->peername = printable_address(sourceaddr, socklen); log_debug("%s: connection to %s from %s", __func__, - lsn->address, conn->peername); + lsn->listen_addr_str, conn->peername); - conn->mode = lsn->proto_params->mode; + conn->mode = lsn->mode; obfs_assert(conn->mode == LSN_SIMPLE_SERVER); - conn->proto = proto_create(lsn->proto_params); + conn->proto = proto_create(lsn); if (!conn->proto) { log_warn("Creation of protocol object failed! Closing connection."); goto err; @@ -382,8 +386,8 @@ simple_server_listener_cb(struct evconnlistener *evcl, /* Launch the connect attempt. */ if (bufferevent_socket_connect(conn->upstream, - lsn->proto_params->target_addr->ai_addr, - lsn->proto_params->target_addr->ai_addrlen)<0) + lsn->target_addr->ai_addr, + lsn->target_addr->ai_addrlen) < 0) goto err; bufferevent_enable(conn->upstream, EV_READ|EV_WRITE); diff --git a/src/network.h b/src/network.h index 54684a6..dc099f6 100644 --- a/src/network.h +++ b/src/network.h @@ -11,13 +11,25 @@ void free_all_listeners(void); void start_shutdown(int barbaric); -#ifdef NETWORK_PRIVATE +/** + This struct defines the state of a listener on a particular address. + Each protocol may extend this structure with additional private data + by embedding it as the first member of a larger structure (standard + fake-inheritance-in-C technique). The protocol's listener_create() + method is responsible for filling in the |vtable|, |listen_addr|, + |target_addr|, and |mode| fields of this structure, but should leave + the |listener| and |listen_addr_str| fields alone. + */ +struct listener_t { + const protocol_vtable *vtable; + struct evconnlistener *listener; + struct evutil_addrinfo *listen_addr; + char *listen_addr_str; + struct evutil_addrinfo *target_addr; + enum listen_mode mode; +}; -typedef struct listener_t { - char *address; - protocol_params_t *proto_params; - struct evconnlistener *listener; -} listener_t; +#ifdef NETWORK_PRIVATE typedef struct conn_t { char *peername; diff --git a/src/protocol.c b/src/protocol.c index 8366d58..7865aac 100644 --- a/src/protocol.c +++ b/src/protocol.c @@ -3,10 +3,11 @@ */ #include "util.h" - +#include "network.h" #include "protocol.h" -/*#include "protocols/obfs2.h"*/ + #include "protocols/dummy.h" +/*#include "protocols/obfs2.h"*/ /** All supported protocols should be put in this array. @@ -21,46 +22,32 @@ const size_t n_supported_protocols = sizeof(supported_protocols)/sizeof(supported_protocols[0]); /** - This function figures out which protocol we want to set up, and - gives 'n_options', 'options' and 'params' to the appropriate - protocol-specific initalization function. - This function is called once for every listener through the runtime - of obfsproxy. -*/ -protocol_params_t * -proto_params_init(int n_options, const char *const *options) + This function dispatches (by name) creation of a |listener_t| + to the appropriate protocol-specific initalization function. + */ +listener_t * +proto_listener_create(int n_options, const char *const *options) { size_t i; for (i = 0; i < n_supported_protocols; i++) if (!strcmp(*options, supported_protocols[i]->name)) /* Remove the first element of 'options' (which is always the protocol name) from the list passed to the init method. */ - return supported_protocols[i]->init(n_options - 1, options + 1); + return supported_protocols[i]->listener_create(n_options - 1, options + 1); return NULL; } /** - This function destroys 'params'. - It's called everytime we free a listener. + This function destroys the protocol-specific part of a listener object. */ void -proto_params_free(protocol_params_t *params) +proto_listener_free(listener_t *lsn) { - obfs_assert(params); - obfs_assert(params->vtable); - obfs_assert(params->vtable->fini); - - if (params->target_addr) { - evutil_freeaddrinfo(params->target_addr); - params->target_addr = NULL; - } - if (params->listen_addr) { - evutil_freeaddrinfo(params->listen_addr); - params->listen_addr = NULL; - } - - params->vtable->fini(params); + obfs_assert(lsn); + obfs_assert(lsn->vtable); + obfs_assert(lsn->vtable->listener_free); + lsn->vtable->listener_free(lsn); } /** @@ -70,12 +57,12 @@ proto_params_free(protocol_params_t *params) Return a 'protocol_t' if successful, NULL otherwise. */ protocol_t * -proto_create(protocol_params_t *params) +proto_create(listener_t *lsn) { - obfs_assert(params); - obfs_assert(params->vtable); - obfs_assert(params->vtable->create); - return params->vtable->create(params); + obfs_assert(lsn); + obfs_assert(lsn->vtable); + obfs_assert(lsn->vtable->create); + return lsn->vtable->create(lsn); } /** diff --git a/src/protocol.h b/src/protocol.h index 246ad1c..0f4f32d 100644 --- a/src/protocol.h +++ b/src/protocol.h @@ -6,20 +6,6 @@ #define PROTOCOL_H /** - This struct defines the protocol-specific state for all connections - opened from a particular listener. Each protocol may extend this - structure with additional private data by embedding it as the first - member of a larger structure (standard fake-inheritance-in-C - technique). - */ -struct protocol_params_t { - const protocol_vtable *vtable; - struct evutil_addrinfo *target_addr; - struct evutil_addrinfo *listen_addr; - int mode; -}; - -/** This struct defines the protocol-specific state for a particular connection. Again, each protocol may extend this structure with additional private data by embedding it as the first member of a @@ -42,20 +28,20 @@ struct protocol_vtable /** The short name of this protocol. */ const char *name; - /** Initialization: Allocate a 'protocol_params_t' object and fill - it in from the provided 'options' array. */ - protocol_params_t *(*init)(int n_options, const char *const *options); + /** Allocate a 'listener_t' object and fill it in from the provided + 'options' array. */ + listener_t *(*listener_create)(int n_options, const char *const *options); - /** Finalization: Destroy the provided 'protocol_params_t' object. - This function is responsible for deallocating any data that the - protocol's extended structure points to, and deallocating the - object itself. But it is *not* responsible for deallocating the - data pointed to by the generic 'protocol_params_t'; that's - already been done. */ - void (*fini)(protocol_params_t *params); + /** Destroy the provided 'listener_t' object. This function is + responsible for deallocating any data that the protocol's + extended structure points to, and deallocating the object + itself. But it is *not* responsible for deallocating the data + pointed to by the generic 'listener_t'; that's already been done + by generic code. */ + void (*listener_free)(listener_t *params); /** Constructor: Allocates per-connection, protocol-specific state. */ - protocol_t *(*create)(protocol_params_t *params); + protocol_t *(*create)(listener_t *params); /** Destructor: Destroys per-connection, protocol-specific state. */ void (*destroy)(protocol_t *state); @@ -83,16 +69,16 @@ struct protocol_vtable #define DEFINE_PROTOCOL_VTABLE(name) \ const protocol_vtable name##_vtable = { \ #name, \ - name##_init, name##_fini, \ + name##_listener_create, \ + name##_listener_free, \ name##_create, name##_destroy, \ name##_handshake, name##_send, name##_recv \ } -protocol_params_t *proto_params_init(int n_options, - const char *const *options); -void proto_params_free(protocol_params_t *params); +listener_t *proto_listener_create(int n_options, const char *const *options); +void proto_listener_free(listener_t *params); -protocol_t *proto_create(protocol_params_t *params); +protocol_t *proto_create(listener_t *params); void proto_destroy(protocol_t *proto); int proto_handshake(protocol_t *proto, void *buf); diff --git a/src/protocols/dummy.c b/src/protocols/dummy.c index 8ecce8f..e78398f 100644 --- a/src/protocols/dummy.c +++ b/src/protocols/dummy.c @@ -10,10 +10,10 @@ #include <event2/buffer.h> /* type-safe downcast wrappers */ -static inline dummy_params_t * -downcast_params(protocol_params_t *p) +static inline dummy_listener_t * +downcast_listener(listener_t *p) { - return DOWNCAST(dummy_params_t, super, p); + return DOWNCAST(dummy_listener_t, super, p); } static inline dummy_protocol_t * @@ -24,25 +24,30 @@ downcast_protocol(protocol_t *p) static int parse_and_set_options(int n_options, const char *const *options, - dummy_params_t *params); + dummy_listener_t *lsn); /** - This function populates 'params' according to 'options' and sets up + This function populates 'lsn' according to 'options' and sets up the protocol vtable. 'options' is an array like this: {"dummy","socks","127.0.0.1:6666"} */ -static protocol_params_t * -dummy_init(int n_options, const char *const *options) +static listener_t * +dummy_listener_create(int n_options, const char *const *options) { - dummy_params_t *params = xzalloc(sizeof(dummy_params_t)); - params->super.vtable = &dummy_vtable; + dummy_listener_t *lsn = xzalloc(sizeof(dummy_listener_t)); + lsn->super.vtable = &dummy_vtable; - if (parse_and_set_options(n_options, options, params) == 0) - return &params->super; + if (parse_and_set_options(n_options, options, lsn) == 0) + return &lsn->super; + + if (lsn->super.listen_addr) + evutil_freeaddrinfo(lsn->super.listen_addr); + if (lsn->super.target_addr) + evutil_freeaddrinfo(lsn->super.target_addr); + free(lsn); - proto_params_free(&params->super); log_warn("dummy syntax:\n" "\tdummy <mode> <listen_address> [<target_address>]\n" "\t\tmode ~ server|client|socks\n" @@ -57,11 +62,11 @@ dummy_init(int n_options, const char *const *options) } /** - Helper: Parses 'options' and fills 'params'. + Helper: Parses 'options' and fills 'lsn'. */ static int parse_and_set_options(int n_options, const char *const *options, - dummy_params_t *params) + dummy_listener_t *lsn) { const char* defport; @@ -70,26 +75,26 @@ parse_and_set_options(int n_options, const char *const *options, if (!strcmp(options[0], "client")) { defport = "48988"; /* bf5c */ - params->super.mode = LSN_SIMPLE_CLIENT; + lsn->super.mode = LSN_SIMPLE_CLIENT; } else if (!strcmp(options[0], "socks")) { defport = "23548"; /* 5bf5 */ - params->super.mode = LSN_SOCKS_CLIENT; + lsn->super.mode = LSN_SOCKS_CLIENT; } else if (!strcmp(options[0], "server")) { defport = "11253"; /* 2bf5 */ - params->super.mode = LSN_SIMPLE_SERVER; + lsn->super.mode = LSN_SIMPLE_SERVER; } else return -1; - if (n_options != (params->super.mode == LSN_SOCKS_CLIENT ? 2 : 3)) + if (n_options != (lsn->super.mode == LSN_SOCKS_CLIENT ? 2 : 3)) return -1; - params->super.listen_addr = resolve_address_port(options[1], 1, 1, defport); - if (!params->super.listen_addr) + lsn->super.listen_addr = resolve_address_port(options[1], 1, 1, defport); + if (!lsn->super.listen_addr) return -1; - if (params->super.mode != LSN_SOCKS_CLIENT) { - params->super.target_addr = resolve_address_port(options[2], 1, 0, NULL); - if (!params->super.target_addr) + if (lsn->super.mode != LSN_SOCKS_CLIENT) { + lsn->super.target_addr = resolve_address_port(options[2], 1, 0, NULL); + if (!lsn->super.target_addr) return -1; } @@ -97,9 +102,9 @@ parse_and_set_options(int n_options, const char *const *options, } static void -dummy_fini(protocol_params_t *params) +dummy_listener_free(listener_t *lsn) { - free(downcast_params(params)); + free(downcast_listener(lsn)); } /* @@ -108,7 +113,7 @@ dummy_fini(protocol_params_t *params) */ static protocol_t * -dummy_create(protocol_params_t *params) +dummy_create(listener_t *lsn) { dummy_protocol_t *proto = xzalloc(sizeof(dummy_protocol_t)); proto->super.vtable = &dummy_vtable; diff --git a/src/protocols/dummy.h b/src/protocols/dummy.h index 308c4f0..b4e9c84 100644 --- a/src/protocols/dummy.h +++ b/src/protocols/dummy.h @@ -14,6 +14,7 @@ extern const protocol_vtable dummy_vtable; ========== */ +#include "../network.h" #include "../protocol.h" /* Dummy presently needs no extensions to the generic protocol @@ -21,9 +22,9 @@ extern const protocol_vtable dummy_vtable; because, if you're using dummy as a template, you probably will want to extend the generic structures. */ -typedef struct dummy_params_t { - protocol_params_t super; -} dummy_params_t; +typedef struct dummy_listener_t { + listener_t super; +} dummy_listener_t; typedef struct dummy_protocol_t { protocol_t super; diff --git a/src/test/unittest_dummy.c b/src/test/unittest_dummy.c index 6470528..2a55b9d 100644 --- a/src/test/unittest_dummy.c +++ b/src/test/unittest_dummy.c @@ -12,7 +12,7 @@ static void test_dummy_option_parsing(void *unused) { struct option_parsing_case { - protocol_params_t *result; + listener_t *result; short should_succeed; short n_opts; const char *const opts[4]; @@ -45,7 +45,7 @@ test_dummy_option_parsing(void *unused) struct option_parsing_case *c; for (c = cases; c->n_opts; c++) { - c->result = proto_params_init(c->n_opts, c->opts); + c->result = proto_listener_create(c->n_opts, c->opts); if (c->should_succeed) tt_ptr_op(c->result, !=, NULL); else @@ -55,7 +55,7 @@ test_dummy_option_parsing(void *unused) end: for (c = cases; c->n_opts; c++) if (c->result) - proto_params_free(c->result); + proto_listener_free(c->result); /* Unsuspend logging */ log_set_method(LOG_METHOD_STDERR, NULL); @@ -64,8 +64,8 @@ test_dummy_option_parsing(void *unused) /* All the tests below use this test environment: */ struct test_dummy_state { - protocol_params_t *proto_params_client; - protocol_params_t *proto_params_server; + listener_t *proto_lsn_client; + listener_t *proto_lsn_server; protocol_t *client_proto; protocol_t *server_proto; struct evbuffer *output_buffer; @@ -82,10 +82,10 @@ cleanup_dummy_state(const struct testcase_t *unused, void *state) if (s->server_proto) proto_destroy(s->server_proto); - if (s->proto_params_client) - proto_params_free(s->proto_params_client); - if (s->proto_params_server) - proto_params_free(s->proto_params_server); + if (s->proto_lsn_client) + proto_listener_free(s->proto_lsn_client); + if (s->proto_lsn_server) + proto_listener_free(s->proto_lsn_server); if (s->output_buffer) evbuffer_free(s->output_buffer); @@ -109,18 +109,18 @@ setup_dummy_state(const struct testcase_t *unused) { struct test_dummy_state *s = xzalloc(sizeof(struct test_dummy_state)); - s->proto_params_client = - proto_params_init(ALEN(options_client), options_client); - tt_assert(s->proto_params_client); + s->proto_lsn_client = + proto_listener_create(ALEN(options_client), options_client); + tt_assert(s->proto_lsn_client); - s->proto_params_server = - proto_params_init(ALEN(options_server), options_server); - tt_assert(s->proto_params_server); + s->proto_lsn_server = + proto_listener_create(ALEN(options_server), options_server); + tt_assert(s->proto_lsn_server); - s->client_proto = proto_create(s->proto_params_client); + s->client_proto = proto_create(s->proto_lsn_client); tt_assert(s->client_proto); - s->server_proto = proto_create(s->proto_params_server); + s->server_proto = proto_create(s->proto_lsn_server); tt_assert(s->server_proto); s->output_buffer = evbuffer_new(); diff --git a/src/util.h b/src/util.h index d2bbea9..d8c6bb2 100644 --- a/src/util.h +++ b/src/util.h @@ -21,8 +21,8 @@ #endif struct bufferevent; -struct evconnlistener; struct evbuffer; +struct evconnlistener; struct evdns_base; struct event_base; @@ -62,8 +62,8 @@ unsigned int ui64_log2(uint64_t u64); /***** Network types and functions. *****/ +typedef struct listener_t listener_t; typedef struct protocol_t protocol_t; -typedef struct protocol_params_t protocol_params_t; typedef struct protocol_vtable protocol_vtable; typedef struct socks_state_t socks_state_t;

1 0

[obfsproxy/master] Merge protocol_t into conn_t.
by nickm＠torproject.org 10 Sep '11

10 Sep '11

commit 6b3b9273f5b2e67f99b0c49ebf2fa7d36e0f9f56 Author: Zack Weinberg <zackw(a)panix.com> Date: Tue Aug 2 10:46:13 2011 -0700 Merge protocol_t into conn_t. --- src/network.c | 61 ++++++++++++++++++++------------------------- src/network.h | 33 ++++++++++++++---------- src/protocol.c | 50 ++++++++++++++++++------------------ src/protocol.h | 39 +++++++++++----------------- src/protocols/dummy.c | 22 ++++++++-------- src/protocols/dummy.h | 6 ++-- src/test/unittest_dummy.c | 52 +++++++++++++++++++------------------- src/util.h | 2 +- 8 files changed, 127 insertions(+), 138 deletions(-) diff --git a/src/network.c b/src/network.c index b1d71dc..d11b60f 100644 --- a/src/network.c +++ b/src/network.c @@ -4,7 +4,6 @@ #include "util.h" -#define NETWORK_PRIVATE #include "network.h" #include "container.h" @@ -217,9 +216,14 @@ simple_client_listener_cb(struct evconnlistener *evcl, evutil_socket_t fd, struct sockaddr *sourceaddr, int socklen, void *arg) { - listener_t *lsn = arg; struct event_base *base; - conn_t *conn = xzalloc(sizeof(conn_t)); + listener_t *lsn = arg; + conn_t *conn = proto_conn_create(lsn); + if (!conn) { + log_warn("Failed to create state object for new connection to %s", + lsn->listen_addr_str); + goto err; + } conn->peername = printable_address(sourceaddr, socklen); log_debug("%s: connection to %s from %s", __func__, @@ -228,12 +232,6 @@ simple_client_listener_cb(struct evconnlistener *evcl, conn->mode = lsn->mode; obfs_assert(conn->mode == LSN_SIMPLE_CLIENT); - conn->proto = proto_create(lsn); - if (!conn->proto) { - log_warn("Creation of protocol object failed! Closing connection."); - goto err; - } - /* New bufferevent to wrap socket we received. */ base = evconnlistener_get_base(lsn->listener); conn->upstream = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE); @@ -288,9 +286,14 @@ socks_client_listener_cb(struct evconnlistener *evcl, evutil_socket_t fd, struct sockaddr *sourceaddr, int socklen, void *arg) { - listener_t *lsn = arg; struct event_base *base; - conn_t *conn = xzalloc(sizeof(conn_t)); + listener_t *lsn = arg; + conn_t *conn = proto_conn_create(lsn); + if (!conn) { + log_warn("Failed to create state object for new connection to %s", + lsn->listen_addr_str); + goto err; + } conn->peername = printable_address(sourceaddr, socklen); log_debug("%s: connection to %s from %s", __func__, @@ -299,12 +302,6 @@ socks_client_listener_cb(struct evconnlistener *evcl, conn->mode = lsn->mode; obfs_assert(conn->mode == LSN_SOCKS_CLIENT); - conn->proto = proto_create(lsn); - if (!conn->proto) { - log_warn("Creation of protocol object failed! Closing connection."); - goto err; - } - /* Construct SOCKS state. */ conn->socks_state = socks_state_new(); @@ -346,9 +343,14 @@ simple_server_listener_cb(struct evconnlistener *evcl, evutil_socket_t fd, struct sockaddr *sourceaddr, int socklen, void *arg) { - listener_t *lsn = arg; struct event_base *base; - conn_t *conn = xzalloc(sizeof(conn_t)); + listener_t *lsn = arg; + conn_t *conn = proto_conn_create(lsn); + if (!conn) { + log_warn("Failed to create state object for new connection to %s", + lsn->listen_addr_str); + goto err; + } conn->peername = printable_address(sourceaddr, socklen); log_debug("%s: connection to %s from %s", __func__, @@ -357,12 +359,6 @@ simple_server_listener_cb(struct evconnlistener *evcl, conn->mode = lsn->mode; obfs_assert(conn->mode == LSN_SIMPLE_SERVER); - conn->proto = proto_create(lsn); - if (!conn->proto) { - log_warn("Creation of protocol object failed! Closing connection."); - goto err; - } - /* New bufferevent to wrap socket we received. */ base = evconnlistener_get_base(lsn->listener); conn->downstream = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE); @@ -416,8 +412,6 @@ conn_free(conn_t *conn) { if (conn->peername) free(conn->peername); - if (conn->proto) - proto_destroy(conn->proto); if (conn->socks_state) socks_state_free(conn->socks_state); if (conn->upstream) @@ -425,8 +419,7 @@ conn_free(conn_t *conn) if (conn->downstream) bufferevent_free(conn->downstream); - memset(conn, 0x99, sizeof(conn_t)); - free(conn); + proto_conn_free(conn); } /** @@ -546,7 +539,7 @@ upstream_read_cb(struct bufferevent *bev, void *arg) (unsigned long)evbuffer_get_length(bufferevent_get_input(bev))); obfs_assert(bev == conn->upstream); - if (proto_send(conn->proto, + if (proto_send(conn, bufferevent_get_input(conn->upstream), bufferevent_get_output(conn->downstream)) < 0) { log_debug("%s: Error during transmit.", conn->peername); @@ -568,7 +561,7 @@ downstream_read_cb(struct bufferevent *bev, void *arg) (unsigned long)evbuffer_get_length(bufferevent_get_input(bev))); obfs_assert(bev == conn->downstream); - r = proto_recv(conn->proto, + r = proto_recv(conn, bufferevent_get_input(conn->downstream), bufferevent_get_output(conn->upstream)); @@ -579,7 +572,7 @@ downstream_read_cb(struct bufferevent *bev, void *arg) log_debug("%s: Reply of %lu bytes", conn->peername, (unsigned long) evbuffer_get_length(bufferevent_get_input(conn->upstream))); - if (proto_send(conn->proto, + if (proto_send(conn, bufferevent_get_input(conn->upstream), bufferevent_get_output(conn->downstream)) < 0) { log_debug("%s: Error during reply.", conn->peername); @@ -708,7 +701,7 @@ pending_conn_cb(struct bufferevent *bev, short what, void *arg) bev == conn->upstream ? "upstream" : "downstream"); /* Queue handshake, if any. */ - if (proto_handshake(conn->proto, + if (proto_handshake(conn, bufferevent_get_output(conn->downstream))<0) { log_debug("%s: Error during handshake", conn->peername); close_conn(conn); @@ -791,7 +784,7 @@ pending_socks_cb(struct bufferevent *bev, short what, void *arg) bufferevent_enable(conn->upstream, EV_READ|EV_WRITE); /* Queue handshake, if any. */ - if (proto_handshake(conn->proto, + if (proto_handshake(conn, bufferevent_get_output(conn->downstream))<0) { log_debug("%s: Error during handshake", conn->peername); close_conn(conn); diff --git a/src/network.h b/src/network.h index dc099f6..17b0e6b 100644 --- a/src/network.h +++ b/src/network.h @@ -29,19 +29,24 @@ struct listener_t { enum listen_mode mode; }; -#ifdef NETWORK_PRIVATE - -typedef struct conn_t { - char *peername; - protocol_t *proto; - socks_state_t *socks_state; - struct bufferevent *upstream; - struct bufferevent *downstream; - unsigned int mode : 30; - unsigned int flushing : 1; - unsigned int is_open : 1; -} conn_t; - -#endif +/** + This struct defines the state of a connection between "upstream" + and "downstream" peers (it's really two connections at the socket + level). Again, each protocol may extend this structure with + additional private data by embedding it as the first member of a + larger structure. The protocol's conn_create() method is responsible + only for filling in the |vtable| field of this structure, plus any + private data of course. + */ +struct conn_t { + const protocol_vtable *vtable; + char *peername; + socks_state_t *socks_state; + struct bufferevent *upstream; + struct bufferevent *downstream; + enum listen_mode mode : 30; + unsigned int flushing : 1; + unsigned int is_open : 1; +}; #endif diff --git a/src/protocol.c b/src/protocol.c index 7865aac..eddb9a3 100644 --- a/src/protocol.c +++ b/src/protocol.c @@ -56,13 +56,13 @@ proto_listener_free(listener_t *lsn) Return a 'protocol_t' if successful, NULL otherwise. */ -protocol_t * -proto_create(listener_t *lsn) +conn_t * +proto_conn_create(listener_t *lsn) { obfs_assert(lsn); obfs_assert(lsn->vtable); - obfs_assert(lsn->vtable->create); - return lsn->vtable->create(lsn); + obfs_assert(lsn->vtable->conn_create); + return lsn->vtable->conn_create(lsn); } /** @@ -70,43 +70,43 @@ proto_create(listener_t *lsn) Not all protocols have a handshake. */ int -proto_handshake(protocol_t *proto, void *buf) { - obfs_assert(proto); - obfs_assert(proto->vtable); - obfs_assert(proto->vtable->handshake); - return proto->vtable->handshake(proto, buf); +proto_handshake(conn_t *conn, void *buf) { + obfs_assert(conn); + obfs_assert(conn->vtable); + obfs_assert(conn->vtable->handshake); + return conn->vtable->handshake(conn, buf); } /** This function is responsible for sending protocol data. */ int -proto_send(protocol_t *proto, void *source, void *dest) { - obfs_assert(proto); - obfs_assert(proto->vtable); - obfs_assert(proto->vtable->send); - return proto->vtable->send(proto, source, dest); +proto_send(conn_t *conn, void *source, void *dest) { + obfs_assert(conn); + obfs_assert(conn->vtable); + obfs_assert(conn->vtable->send); + return conn->vtable->send(conn, source, dest); } /** This function is responsible for receiving protocol data. */ enum recv_ret -proto_recv(protocol_t *proto, void *source, void *dest) { - obfs_assert(proto); - obfs_assert(proto->vtable); - obfs_assert(proto->vtable->recv); - return proto->vtable->recv(proto, source, dest); +proto_recv(conn_t *conn, void *source, void *dest) { + obfs_assert(conn); + obfs_assert(conn->vtable); + obfs_assert(conn->vtable->recv); + return conn->vtable->recv(conn, source, dest); } /** - This function destroys 'proto'. + This function destroys 'conn'. It's called everytime we close a connection. */ void -proto_destroy(protocol_t *proto) { - obfs_assert(proto); - obfs_assert(proto->vtable); - obfs_assert(proto->vtable->destroy); - proto->vtable->destroy(proto); +proto_conn_free(conn_t *conn) { + obfs_assert(conn); + obfs_assert(conn->vtable); + obfs_assert(conn->vtable->conn_free); + conn->vtable->conn_free(conn); } diff --git a/src/protocol.h b/src/protocol.h index 0f4f32d..6dfb04a 100644 --- a/src/protocol.h +++ b/src/protocol.h @@ -6,16 +6,6 @@ #define PROTOCOL_H /** - This struct defines the protocol-specific state for a particular - connection. Again, each protocol may extend this structure with - additional private data by embedding it as the first member of a - larger structure. - */ -struct protocol_t { - const protocol_vtable *vtable; -}; - -/** This struct defines a protocol and its methods; note that not all of them are methods on the same object in the C++ sense. @@ -40,22 +30,22 @@ struct protocol_vtable by generic code. */ void (*listener_free)(listener_t *params); - /** Constructor: Allocates per-connection, protocol-specific state. */ - protocol_t *(*create)(listener_t *params); + /** Allocate per-connection, protocol-specific state. */ + conn_t *(*conn_create)(listener_t *params); - /** Destructor: Destroys per-connection, protocol-specific state. */ - void (*destroy)(protocol_t *state); + /** Destroy per-connection, protocol-specific state. */ + void (*conn_free)(conn_t *state); /** Perform a connection handshake. Not all protocols have a handshake. */ - int (*handshake)(protocol_t *state, struct evbuffer *buf); + int (*handshake)(conn_t *state, struct evbuffer *buf); /** Send data coming downstream from 'source' along to 'dest'. */ - int (*send)(protocol_t *state, + int (*send)(conn_t *state, struct evbuffer *source, struct evbuffer *dest); /** Receive data from 'source' and pass it upstream to 'dest'. */ - enum recv_ret (*recv)(protocol_t *state, + enum recv_ret (*recv)(conn_t *state, struct evbuffer *source, struct evbuffer *dest); @@ -71,19 +61,20 @@ struct protocol_vtable #name, \ name##_listener_create, \ name##_listener_free, \ - name##_create, name##_destroy, \ + name##_conn_create, \ + name##_conn_free, \ name##_handshake, name##_send, name##_recv \ } listener_t *proto_listener_create(int n_options, const char *const *options); -void proto_listener_free(listener_t *params); +void proto_listener_free(listener_t *lsn); -protocol_t *proto_create(listener_t *params); -void proto_destroy(protocol_t *proto); +conn_t *proto_conn_create(listener_t *lsn); +void proto_conn_free(conn_t *conn); -int proto_handshake(protocol_t *proto, void *buf); -int proto_send(protocol_t *proto, void *source, void *dest); -enum recv_ret proto_recv(protocol_t *proto, void *source, void *dest); +int proto_handshake(conn_t *conn, void *buf); +int proto_send(conn_t *conn, void *source, void *dest); +enum recv_ret proto_recv(conn_t *conn, void *source, void *dest); extern const protocol_vtable *const supported_protocols[]; extern const size_t n_supported_protocols; diff --git a/src/protocols/dummy.c b/src/protocols/dummy.c index e78398f..30b0d16 100644 --- a/src/protocols/dummy.c +++ b/src/protocols/dummy.c @@ -16,10 +16,10 @@ downcast_listener(listener_t *p) return DOWNCAST(dummy_listener_t, super, p); } -static inline dummy_protocol_t * -downcast_protocol(protocol_t *p) +static inline dummy_conn_t * +downcast_conn(conn_t *p) { - return DOWNCAST(dummy_protocol_t, super, p); + return DOWNCAST(dummy_conn_t, super, p); } static int parse_and_set_options(int n_options, @@ -112,36 +112,36 @@ dummy_listener_free(listener_t *lsn) protocol. */ -static protocol_t * -dummy_create(listener_t *lsn) +static conn_t * +dummy_conn_create(listener_t *lsn) { - dummy_protocol_t *proto = xzalloc(sizeof(dummy_protocol_t)); + dummy_conn_t *proto = xzalloc(sizeof(dummy_conn_t)); proto->super.vtable = &dummy_vtable; return &proto->super; } static void -dummy_destroy(protocol_t *proto) +dummy_conn_free(conn_t *proto) { - free(downcast_protocol(proto)); + free(downcast_conn(proto)); } /** Dummy has no handshake */ static int -dummy_handshake(protocol_t *proto, struct evbuffer *buf) +dummy_handshake(conn_t *proto, struct evbuffer *buf) { return 0; } /** send, receive - just copy */ static int -dummy_send(protocol_t *proto, struct evbuffer *source, struct evbuffer *dest) +dummy_send(conn_t *proto, struct evbuffer *source, struct evbuffer *dest) { return evbuffer_add_buffer(dest,source); } static enum recv_ret -dummy_recv(protocol_t *proto, struct evbuffer *source, struct evbuffer *dest) +dummy_recv(conn_t *proto, struct evbuffer *source, struct evbuffer *dest) { if (evbuffer_add_buffer(dest,source)<0) return RECV_BAD; diff --git a/src/protocols/dummy.h b/src/protocols/dummy.h index b4e9c84..e7a450e 100644 --- a/src/protocols/dummy.h +++ b/src/protocols/dummy.h @@ -26,9 +26,9 @@ typedef struct dummy_listener_t { listener_t super; } dummy_listener_t; -typedef struct dummy_protocol_t { - protocol_t super; -} dummy_protocol_t; +typedef struct dummy_conn_t { + conn_t super; +} dummy_conn_t; #endif diff --git a/src/test/unittest_dummy.c b/src/test/unittest_dummy.c index 2a55b9d..ec09a82 100644 --- a/src/test/unittest_dummy.c +++ b/src/test/unittest_dummy.c @@ -64,10 +64,10 @@ test_dummy_option_parsing(void *unused) /* All the tests below use this test environment: */ struct test_dummy_state { - listener_t *proto_lsn_client; - listener_t *proto_lsn_server; - protocol_t *client_proto; - protocol_t *server_proto; + listener_t *lsn_client; + listener_t *lsn_server; + conn_t *conn_client; + conn_t *conn_server; struct evbuffer *output_buffer; struct evbuffer *dummy_buffer; }; @@ -77,15 +77,15 @@ cleanup_dummy_state(const struct testcase_t *unused, void *state) { struct test_dummy_state *s = (struct test_dummy_state *)state; - if (s->client_proto) - proto_destroy(s->client_proto); - if (s->server_proto) - proto_destroy(s->server_proto); + if (s->conn_client) + proto_conn_free(s->conn_client); + if (s->conn_server) + proto_conn_free(s->conn_server); - if (s->proto_lsn_client) - proto_listener_free(s->proto_lsn_client); - if (s->proto_lsn_server) - proto_listener_free(s->proto_lsn_server); + if (s->lsn_client) + proto_listener_free(s->lsn_client); + if (s->lsn_server) + proto_listener_free(s->lsn_server); if (s->output_buffer) evbuffer_free(s->output_buffer); @@ -109,19 +109,19 @@ setup_dummy_state(const struct testcase_t *unused) { struct test_dummy_state *s = xzalloc(sizeof(struct test_dummy_state)); - s->proto_lsn_client = + s->lsn_client = proto_listener_create(ALEN(options_client), options_client); - tt_assert(s->proto_lsn_client); + tt_assert(s->lsn_client); - s->proto_lsn_server = + s->lsn_server = proto_listener_create(ALEN(options_server), options_server); - tt_assert(s->proto_lsn_server); + tt_assert(s->lsn_server); - s->client_proto = proto_create(s->proto_lsn_client); - tt_assert(s->client_proto); + s->conn_client = proto_conn_create(s->lsn_client); + tt_assert(s->conn_client); - s->server_proto = proto_create(s->proto_lsn_server); - tt_assert(s->server_proto); + s->conn_server = proto_conn_create(s->lsn_server); + tt_assert(s->conn_server); s->output_buffer = evbuffer_new(); tt_assert(s->output_buffer); @@ -148,13 +148,13 @@ test_dummy_transfer(void *state) /* Call the handshake method to satisfy the high-level contract, even though dummy doesn't use a handshake */ - tt_int_op(proto_handshake(s->client_proto, s->output_buffer), >=, 0); + tt_int_op(proto_handshake(s->conn_client, s->output_buffer), >=, 0); /* That should have put nothing into the output buffer */ tt_int_op(evbuffer_get_length(s->output_buffer), ==, 0); /* Ditto on the server side */ - tt_int_op(proto_handshake(s->server_proto, s->output_buffer), >=, 0); + tt_int_op(proto_handshake(s->conn_server, s->output_buffer), >=, 0); tt_int_op(evbuffer_get_length(s->output_buffer), ==, 0); const char *msg1 = "this is a 54-byte message passed from client to server"; @@ -162,9 +162,9 @@ test_dummy_transfer(void *state) /* client -> server */ evbuffer_add(s->dummy_buffer, msg1, 54); - proto_send(s->client_proto, s->dummy_buffer, s->output_buffer); + proto_send(s->conn_client, s->dummy_buffer, s->output_buffer); - tt_assert(RECV_GOOD == proto_recv(s->server_proto, s->output_buffer, + tt_assert(RECV_GOOD == proto_recv(s->conn_server, s->output_buffer, s->dummy_buffer)); n = evbuffer_peek(s->dummy_buffer, -1, NULL, &v[0], 2); @@ -177,10 +177,10 @@ test_dummy_transfer(void *state) /* client <- server */ evbuffer_add(s->dummy_buffer, msg2, 55); - tt_int_op(0, <=, proto_send(s->server_proto, s->dummy_buffer, + tt_int_op(0, <=, proto_send(s->conn_server, s->dummy_buffer, s->output_buffer)); - tt_assert(RECV_GOOD == proto_recv(s->client_proto, s->output_buffer, + tt_assert(RECV_GOOD == proto_recv(s->conn_client, s->output_buffer, s->dummy_buffer)); n = evbuffer_peek(s->dummy_buffer, -1, NULL, &v[1], 2); diff --git a/src/util.h b/src/util.h index d8c6bb2..8b6f3b4 100644 --- a/src/util.h +++ b/src/util.h @@ -62,8 +62,8 @@ unsigned int ui64_log2(uint64_t u64); /***** Network types and functions. *****/ +typedef struct conn_t conn_t; typedef struct listener_t listener_t; -typedef struct protocol_t protocol_t; typedef struct protocol_vtable protocol_vtable; typedef struct socks_state_t socks_state_t;

1 0

[obfsproxy/master] Take a chain saw to the overcomplicated argument segmenting code in main.c. Push the call to proto_params_init inside the call to create_listener.
by nickm＠torproject.org 10 Sep '11

10 Sep '11

commit 8bffcf5549bbe27b95bff0ef357174c7028c3149 Author: Zack Weinberg <zackw(a)panix.com> Date: Mon Aug 1 16:50:21 2011 -0700 Take a chain saw to the overcomplicated argument segmenting code in main.c. Push the call to proto_params_init inside the call to create_listener. --- src/main.c | 289 ++++++++++++++++++------------------------------- src/network.c | 15 ++-- src/network.h | 2 +- src/test/tester.py.in | 4 +- src/util.c | 9 ++ src/util.h | 3 + 6 files changed, 127 insertions(+), 195 deletions(-) diff --git a/src/main.c b/src/main.c index 1459af3..14125f8 100644 --- a/src/main.c +++ b/src/main.c @@ -4,6 +4,7 @@ #include "util.h" +#include "container.h" #include "crypt.h" #include "network.h" #include "protocol.h" @@ -15,27 +16,18 @@ #include <event2/event.h> #include <event2/dns.h> -/* The character that seperates multiple listeners in the cli */ -#define SEPARATOR "+" -/* Totally arbitrary. */ -#define MAXPROTOCOLS 20 - -static void usage(void) ATTR_NORETURN; -static int handle_obfsproxy_args(const char **argv); - -static struct event_base *the_event_base=NULL; +static struct event_base *the_event_base; /** Prints the obfsproxy usage instructions then exits. */ -static void +static void ATTR_NORETURN usage(void) { int i; - fprintf(stderr, - "Usage: obfsproxy protocol_name [protocol_args] protocol_options %s protocol_name ...\n" - "* Available protocols:\n", - SEPARATOR); + fputs("Usage: obfsproxy protocol_name [protocol_args] protocol_options " + "protocol_name ...\n" + "* Available protocols:\n", stderr); /* this is awful. */ for (i=0;i<n_supported_protocols;i++) fprintf(stderr,"[%s] ", supported_protocols[i]->name); @@ -83,11 +75,7 @@ handle_signal_cb(evutil_socket_t fd, short what, void *arg) } } -/** - Stops obfsproxy's event loop. - - Final cleanup happens in main(). -*/ +/** Stop obfsproxy's event loop. Final cleanup happens in main(). */ void finish_shutdown(void) { @@ -95,36 +83,21 @@ finish_shutdown(void) event_base_loopexit(the_event_base, NULL); } -/** - This function visits 'n_options' command line arguments off 'argv' - and writes them in 'options_string'. -*/ -static void -populate_options(char **options_string, - const char **argv, int n_options) +/** Return 1 if 'name' is the name of a supported protocol, otherwise 0. */ +static int +is_supported_protocol(const char *name) { - int g; - for (g=0;g<=n_options-1;g++) - options_string[g] = (char*) argv[g]; -} + int i; + for (i = 0; i < n_supported_protocols; i++) + if (!strcmp(name, supported_protocols[i]->name)) + return 1; -/** - Return 0 if 'name' is the name of a supported protocol, otherwise - return -1. -*/ -static int -is_supported_protocol(const char *name) { - int f; - for (f=0;f<n_supported_protocols;f++) { - if (!strcmp(name,supported_protocols[f]->name)) - return 0; - } - return -1; + return 0; } /** - Receives argv[1] as 'argv' and scans from thereafter for any - obfsproxy optional arguments and tries to set them in effect. + Receives 'argv' and scans for any obfsproxy optional arguments and + tries to set them in effect. If it succeeds it returns the number of argv arguments its caller should skip to get past the optional arguments we already handled. @@ -135,7 +108,7 @@ handle_obfsproxy_args(const char **argv) { int logmethod_set=0; int logsev_set=0; - int i=0; + int i=1; while (argv[i] && !strncmp(argv[i],"--",2)) { @@ -186,121 +159,81 @@ main(int argc, const char **argv) struct event *sig_int; struct event *sig_term; - /* Yes, these are three stars right there. This is an array of - arrays of strings! Every element of the array is an array of - strings that contains all the options of a protocol. - At runtime it should look like this: - char protocol_options[<number of protocols>][<number of options>][<length of option>] - */ - char ***protocol_options = NULL; - /* This is an array of integers! Each integer is the number of - options of the respective protocol. */ - int *n_options_array = NULL; - /* This is an integer! It contains the number of protocols that we - managed to recognize, by their protocol name. Of course it's not - the *actual* actual_protocols since some of them could have wrong - options or arguments, but this will be resolved per-protocol by - proto_params_init(). */ - int actual_protocols=0; - - int start; - int end; - int n_options; - int i; + /* Array of argument counts, one per listener. */ + int *listener_argcs = NULL; - /* The number of protocols. */ - unsigned int n_protocols=1; - /* An array which holds the position in argv of the command line - options for each protocol. */ - unsigned int *protocols=NULL; - /* keeps track of allocated space for the protocols array */ - unsigned int n_alloc; + /* Array of pointers into argv. Each points to the beginning of a + sequence of options for a particular listener. */ + const char *const **listener_argvs = NULL; - if (argc < 2) { - usage(); - } + /* Total number of listeners requested on the command line. */ + unsigned int n_listeners; - /** "Points" to the first argv string after the optional obfsproxy - arguments. Normally this should be where the protocols start. */ - int start_of_protocols; - /** Handle optional obfsproxy arguments. */ - start_of_protocols = handle_obfsproxy_args(&argv[1]); - - protocols = xzalloc((n_protocols + 1) * sizeof(int)); - n_alloc = n_protocols+1; - - /* Populate protocols and calculate n_protocols. */ - for (i=start_of_protocols;i<argc;i++) { - if (!strcmp(argv[i],SEPARATOR)) { - protocols[n_protocols] = i; - n_protocols++; - - /* Do we need to expand the protocols array? */ - if (n_alloc <= n_protocols) { - n_alloc *= 2; - protocols = xrealloc(protocols, sizeof(int)*(n_alloc)); - } - } - } + /* Total number of listeners successfully created. */ + unsigned int n_good_listeners; - /* protocols[0] points right before the first option of the first - protocol. */ - protocols[0] = start_of_protocols; - /* protocols[n_protocols] points right after the last command line - option. */ - protocols[n_protocols] = argc; - - log_debug("Found %d protocol(s).", n_protocols); - - /* We now allocate enough space for our parsing adventures. - We first allocate space for n_protocols pointers in protocol_options, - that point to arrays carrying the options of the protocols. - Finally, we allocate enough space on the n_options_array so that - we can put the number of options there. - */ - protocol_options = xzalloc(n_protocols * sizeof(char**)); - n_options_array = xzalloc(n_protocols * sizeof(int)); - - /* Iterate through protocols. */ - for (i=0;i<n_protocols;i++) { - log_debug("Parsing protocol %d.", i+1); - /* This "points" to the first argument of this protocol in argv. */ - start = protocols[i]+1; - /* This "points" to the last argument of this protocol in argv. */ - end = protocols[i+1]-1; - /* This is the number of options of this protocol. */ - n_options = end-start+1; - - if (start >= end) { - log_warn("No protocol options were given on protocol %d.", i+1); - continue; - } + /* Index of the first argv string after the optional obfsproxy + arguments. Normally this should be where the listeners start. */ + int start_of_listeners; - /* First option should be protocol_name. See if we support it. */ - if (is_supported_protocol(argv[start])<0) { - log_warn("We don't support protocol: %s", argv[start]); - continue; - } + int cl, i; + + /* Handle optional obfsproxy arguments. */ + start_of_listeners = handle_obfsproxy_args(argv); - actual_protocols++; + if (!is_supported_protocol(argv[start_of_listeners])) + usage(); - /* Allocate space for the array carrying the options of this - protocol. */ - protocol_options[actual_protocols-1] = xzalloc(n_options * sizeof(char*)); + /* Count number of listeners and allocate space for the listener- + argument arrays. We already know there's at least one. */ + n_listeners = 1; + for (i = start_of_listeners+1; i < argc; i++) + if (is_supported_protocol(argv[i])) + n_listeners++; - /* Write the number of options to the correct place in n_options_array[]. */ - n_options_array[actual_protocols-1] = n_options; + log_debug("%d listener%s on command line.", + n_listeners, n_listeners == 1 ? "" : "s"); + listener_argcs = xzalloc(n_listeners * sizeof(int)); + listener_argvs = xzalloc(n_listeners * sizeof(char **)); + + /* Each listener's argument vector consists of the entries in argv + from its recognized protocol name, up to but not including + the next recognized protocol name. */ + cl = 1; + listener_argvs[0] = &argv[start_of_listeners]; + for (i = start_of_listeners + 1; i < argc; i++) + if (is_supported_protocol(argv[i])) { + listener_argcs[cl-1] = i - (listener_argvs[cl-1] - argv); + if (listener_argcs[cl-1] == 1) + log_warn("No arguments to listener %d", cl); + + listener_argvs[cl] = &argv[i]; + cl++; + } - /* Finally! Let's fill protocol_options. */ - populate_options(protocol_options[actual_protocols-1], - &argv[start], n_options); + listener_argcs[cl-1] = argc - (listener_argvs[cl-1] - argv); + if (listener_argcs[cl-1] == 1) + log_warn("No arguments to listener %d", cl); + + obfs_assert(cl == n_listeners); + + if (log_do_debug()) { + smartlist_t *s = smartlist_create(); + char *joined; + for (cl = 0; cl < n_listeners; cl++) { + smartlist_clear(s); + for (i = 0; i < listener_argcs[cl]; i++) + smartlist_add(s, (void *)listener_argvs[cl][i]); + joined = smartlist_join_strings(s, " ", 0, NULL); + log_debug("Listener %d: %s", cl+1, joined); + } + smartlist_free(s); } - /* Excellent. Now we should have protocol_options populated with all - the protocol options we got from the user. */ + /* argv has been chunked; proceed with initialization. */ - /* Ugly method to fix a Windows problem: - http://archives.seul.org/libevent/users/Oct-2010/msg00049.html */ + /* Ugly method to fix a Windows problem: + http://archives.seul.org/libevent/users/Oct-2010/msg00049.html */ #ifdef _WIN32 WSADATA wsaData; WSAStartup(0x101, &wsaData); @@ -308,24 +241,21 @@ main(int argc, const char **argv) /* Initialize crypto */ if (initialize_crypto() < 0) { - log_warn("Can't initialize crypto; failing"); - return 1; + log_error("Failed to initialize cryptography."); } /* Initialize libevent */ the_event_base = event_base_new(); if (!the_event_base) { - log_warn("Can't initialize Libevent; failing"); - return 1; + log_error("Failed to initialize networking."); } /* ASN should this happen only when SOCKS is enabled? */ - if (init_evdns_base(the_event_base) < 0) { - log_warn("Can't initialize evdns; failing"); - return 1; + if (init_evdns_base(the_event_base)) { + log_error("Failed to initialize DNS resolver."); } - /* Handle signals */ + /* Handle signals. */ #ifdef SIGPIPE signal(SIGPIPE, SIG_IGN); #endif @@ -334,37 +264,27 @@ main(int argc, const char **argv) sig_term = evsignal_new(the_event_base, SIGTERM, handle_signal_cb, NULL); if (event_add(sig_int,NULL) || event_add(sig_term,NULL)) { - log_warn("We can't even add events for signals! Exiting."); + log_error("Failed to initialize signal handling."); return 1; } - /*Let's open a new listener for each protocol. */ - int h; - int n_listeners=0; - protocol_params_t *proto_params=NULL; - for (h=0;h<actual_protocols;h++) { - log_debug("Spawning listener %d!", h+1); - - /** normally free'd in listener_free() */ - proto_params = proto_params_init(n_options_array[h], - (const char *const *)protocol_options[h]); - if (proto_params && create_listener(the_event_base, proto_params)) { - log_info("Succesfully created listener %d.", h+1); - n_listeners++; - } - - /** Free the space allocated for this protocol's options. */ - free(protocol_options[h]); - } + /* Open a new listener for each protocol. */ + n_good_listeners = 0; + for (cl = 0; cl < n_listeners; cl++) + if (create_listener(the_event_base, + listener_argcs[cl], listener_argvs[cl])) + n_good_listeners++; - log_debug("From the original %d protocols only %d " - "were parsed from main.c. In the end only " - "%d survived.", - n_protocols, actual_protocols,n_listeners); + /* If the number of usable listeners is not equal to the complete + set specified on the command line, we have a usage error. + Diagnostics have already been issued. */ + log_debug("%d recognized listener%s on command line, %d with valid config", + n_listeners, n_listeners == 1 ? "" : "s", n_good_listeners); + if (n_listeners != n_good_listeners) + return 2; - /* run the event loop if at least one listener was created. */ - if (n_listeners) - event_base_dispatch(the_event_base); + /* We are go for launch. */ + event_base_dispatch(the_event_base); log_info("Exiting."); @@ -377,9 +297,8 @@ main(int argc, const char **argv) cleanup_crypto(); close_obfsproxy_logfile(); - free(protocol_options); - free(n_options_array); - free(protocols); + free(listener_argvs); + free(listener_argcs); return 0; } diff --git a/src/network.c b/src/network.c index c9eafce..c327403 100644 --- a/src/network.c +++ b/src/network.c @@ -126,18 +126,19 @@ close_all_connections(void) /** This function spawns a listener configured according to the - provided 'protocol_params_t' object'. Returns 1 on success, 0 on - failure. (No, you can't have the listener object. It's private.) - - Regardless of success or failure, the protocol_params_t is consumed. + provided argument subvector. Returns 1 on success, 0 on failure. + (No, you can't have the listener object. It's private.) */ int -create_listener(struct event_base *base, protocol_params_t *params) +create_listener(struct event_base *base, int argc, const char *const *argv) { const unsigned flags = LEV_OPT_CLOSE_ON_FREE|LEV_OPT_CLOSE_ON_EXEC|LEV_OPT_REUSEABLE; evconnlistener_cb callback; - listener_t *lsn = xzalloc(sizeof(listener_t)); + listener_t *lsn; + protocol_params_t *params = proto_params_init(argc, argv); + if (!params) + return 0; switch (params->mode) { case LSN_SIMPLE_CLIENT: callback = simple_client_listener_cb; break; @@ -145,7 +146,7 @@ create_listener(struct event_base *base, protocol_params_t *params) case LSN_SOCKS_CLIENT: callback = socks_client_listener_cb; break; default: obfs_abort(); } - + lsn = xzalloc(sizeof(listener_t)); lsn->address = printable_address(params->listen_addr->ai_addr, params->listen_addr->ai_addrlen); lsn->proto_params = params; diff --git a/src/network.h b/src/network.h index 4ae96fc..54684a6 100644 --- a/src/network.h +++ b/src/network.h @@ -6,7 +6,7 @@ #define NETWORK_H /* returns 1 on success, 0 on failure */ -int create_listener(struct event_base *base, protocol_params_t *params); +int create_listener(struct event_base *base, int argc, const char *const *argv); void free_all_listeners(void); void start_shutdown(int barbaric); diff --git a/src/test/tester.py.in b/src/test/tester.py.in index 683724d..55d9477 100644 --- a/src/test/tester.py.in +++ b/src/test/tester.py.in @@ -356,7 +356,7 @@ class SocksBad(SocksTest, unittest.TestCase): # obfs_args = ("obfs2", # "--dest=127.0.0.1:%d" % EXIT_PORT, # "server", "127.0.0.1:%d" % SERVER_PORT, -# "+", "obfs2", +# "obfs2", # "--dest=127.0.0.1:%d" % SERVER_PORT, # "client", "127.0.0.1:%d" % ENTRY_PORT) @@ -364,7 +364,7 @@ class DirectDummy(DirectTest, unittest.TestCase): obfs_args = ("dummy", "server", "127.0.0.1:%d" % SERVER_PORT, "127.0.0.1:%d" % EXIT_PORT, - "+", "dummy", "client", + "dummy", "client", "127.0.0.1:%d" % ENTRY_PORT, "127.0.0.1:%d" % SERVER_PORT) diff --git a/src/util.c b/src/util.c index fa1a62c..3769aba 100644 --- a/src/util.c +++ b/src/util.c @@ -472,6 +472,15 @@ log_set_min_severity(const char* sev_string) return 0; } +/** True if the minimum log severity is "debug". Used in a few places + to avoid some expensive formatting work if we are going to ignore the + result. */ +int +log_do_debug(void) +{ + return logging_min_sev == LOG_SEV_DEBUG; +} + /** Logging worker function. Accepts a logging 'severity' and a 'format' string and logs the diff --git a/src/util.h b/src/util.h index 5108b62..d2bbea9 100644 --- a/src/util.h +++ b/src/util.h @@ -138,6 +138,9 @@ int log_set_method(int method, const char *filename); 'sev_string' may be "warn", "info", or "debug" (case-insensitively). */ int log_set_min_severity(const char* sev_string); +/** True if debug messages are being logged. */ +int log_do_debug(void); + /** Close the logfile if it's open. Ignores errors. */ void close_obfsproxy_logfile(void);

1 0

[obfsproxy/master] A conn_t now wraps only one socket. A new struct, circuit_t, associates the two sides of a proxy channel.
by nickm＠torproject.org 10 Sep '11

10 Sep '11

commit 99dee61ff3aa70aab43b9543a8fd0c58858f0dcd Author: Zack Weinberg <zackw(a)panix.com> Date: Wed Aug 3 11:20:17 2011 -0700 A conn_t now wraps only one socket. A new struct, circuit_t, associates the two sides of a proxy channel. --- src/network.c | 538 ++++++++++++++++++++++++++++++++------------------------ src/network.h | 32 +++- src/util.h | 1 + 3 files changed, 331 insertions(+), 240 deletions(-) diff --git a/src/network.c b/src/network.c index 4ae2c15..08ce696 100644 --- a/src/network.c +++ b/src/network.c @@ -20,25 +20,27 @@ /* Terminology used in this file: - A "side" is a bidirectional communications channel, usually backed - by a network socket and represented at this layer by a - 'struct bufferevent'. - - A "connection" is a _pair_ of sides, referred to as the "upstream" - side and the "downstream" side. A connection is represented by a - 'conn_t'. The upstream side of a connection communicates in - cleartext with the higher-level program that wishes to make use of - our obfuscation service. The downstream side commmunicates in an - obfuscated fashion with the remote peer that the higher-level - client wishes to contact. + A "connection" is a bidirectional communications channel, usually + backed by a network socket, and represented in this layer by a + 'conn_t', wrapping a 'struct bufferevent'. + + A "circuit" is a _pair_ of connections, referred to as the + "upstream" and "downstream" connections. A circuit is represented + by a 'circuit_t'. The upstream connection of a circuit + communicates in cleartext with the higher-level program that wishes + to make use of our obfuscation service. The downstream connection + commmunicates in an obfuscated fashion with the remote peer that + the higher-level client wishes to contact. A "listener" is a listening socket bound to a particular - obfuscation protocol, represented in this layer by a 'listener_t'. - Connecting to a listener creates one side of a connection, and - causes this program to initiate the other side of the connection. - A listener is said to be a "client" listener if connecting to it - creates the _upstream_ side of a connection, and a "server" - listener if connecting to it creates the _downstream_ side. + obfuscation protocol, represented in this layer by a 'listener_t' + and its 'config_t'. Connecting to a listener creates one + connection of a circuit, and causes this program to initiate the + other connection (possibly after receiving in-band instructions + about where to connect to). A listener is said to be a "client" + listener if connecting to it creates the _upstream_ connection, and + a "server" listener if connecting to it creates the _downstream_ + connection. There are two kinds of client listeners: a "simple" client listener always connects to the same remote peer every time it needs to @@ -72,19 +74,17 @@ static void listener_cb(struct evconnlistener *evcl, evutil_socket_t fd, struct sockaddr *sourceaddr, int socklen, void *closure); -static void simple_client_listener_cb(conn_t *conn, struct bufferevent *buf); -static void socks_client_listener_cb(conn_t *conn, struct bufferevent *buf); -static void simple_server_listener_cb(conn_t *conn, struct bufferevent *buf); +static void simple_client_listener_cb(conn_t *conn); +static void socks_client_listener_cb(conn_t *conn); +static void simple_server_listener_cb(conn_t *conn); static void conn_free(conn_t *conn); -static void close_conn(conn_t *conn); -static void close_all_connections(void); +static void conn_free_all(void); +static void conn_free_on_flush(struct bufferevent *bev, void *arg); -static void close_conn_on_flush(struct bufferevent *bev, void *arg); - -static struct bufferevent *open_outbound_socket(conn_t *conn, - struct event_base *base, - bufferevent_data_cb readcb); +static int circuit_create(conn_t *upstream, conn_t *downstream); +static void circuit_free(circuit_t *circuit); +static conn_t *open_outbound(conn_t *conn, bufferevent_data_cb readcb); static void upstream_read_cb(struct bufferevent *bev, void *arg); static void downstream_read_cb(struct bufferevent *bev, void *arg); @@ -114,7 +114,7 @@ start_shutdown(int barbaric) shutting_down=1; if (barbaric) - close_all_connections(); + conn_free_all(); if (connections && smartlist_len(connections) == 0) { smartlist_free(connections); @@ -129,7 +129,7 @@ start_shutdown(int barbaric) Closes all open connections. */ static void -close_all_connections(void) +conn_free_all(void) { if (!connections) return; @@ -251,10 +251,11 @@ listener_cb(struct evconnlistener *evcl, evutil_socket_t fd, smartlist_len(connections)); conn->peername = peername; + conn->buffer = buf; switch (conn->mode) { - case LSN_SIMPLE_CLIENT: simple_client_listener_cb(conn, buf); break; - case LSN_SOCKS_CLIENT: socks_client_listener_cb(conn, buf); break; - case LSN_SIMPLE_SERVER: simple_server_listener_cb(conn, buf); break; + case LSN_SIMPLE_CLIENT: simple_client_listener_cb(conn); break; + case LSN_SOCKS_CLIENT: socks_client_listener_cb(conn); break; + case LSN_SIMPLE_SERVER: simple_server_listener_cb(conn); break; default: obfs_abort(); } @@ -265,23 +266,16 @@ listener_cb(struct evconnlistener *evcl, evutil_socket_t fd, simple client mode. */ static void -simple_client_listener_cb(conn_t *conn, struct bufferevent *buf) +simple_client_listener_cb(conn_t *conn) { - struct event_base *base = bufferevent_get_base(buf); - obfs_assert(buf); obfs_assert(conn); obfs_assert(conn->mode == LSN_SIMPLE_CLIENT); log_debug("%s: simple client connection", conn->peername); - conn->upstream = buf; - bufferevent_setcb(conn->upstream, upstream_read_cb, NULL, error_cb, conn); - - /* Don't enable the upstream side for reading at this point; wait - till the downstream side is established. */ + bufferevent_setcb(conn->buffer, upstream_read_cb, NULL, error_cb, conn); - conn->downstream = open_outbound_socket(conn, base, downstream_read_cb); - if (!conn->downstream) { - close_conn(conn); + if (circuit_create(conn, open_outbound(conn, downstream_read_cb))) { + conn_free(conn); return; } @@ -293,22 +287,19 @@ simple_client_listener_cb(conn_t *conn, struct bufferevent *buf) socks mode. */ static void -socks_client_listener_cb(conn_t *conn, struct bufferevent *buf) +socks_client_listener_cb(conn_t *conn) { - obfs_assert(buf); obfs_assert(conn); obfs_assert(conn->mode == LSN_SOCKS_CLIENT); log_debug("%s: socks client connection", conn->peername); - conn->upstream = buf; - bufferevent_setcb(conn->upstream, socks_read_cb, NULL, error_cb, conn); - bufferevent_enable(conn->upstream, EV_READ|EV_WRITE); - - /* Construct SOCKS state. */ conn->socks_state = socks_state_new(); - /* Do not create a downstream bufferevent at this time; the socks - handler will do it after it learns the downstream peer address. */ + bufferevent_setcb(conn->buffer, socks_read_cb, NULL, error_cb, conn); + bufferevent_enable(conn->buffer, EV_READ|EV_WRITE); + + /* Do not create a circuit at this time; the socks handler will do + it after it learns the remote peer address. */ log_debug("%s: setup complete", conn->peername); } @@ -318,25 +309,16 @@ socks_client_listener_cb(conn_t *conn, struct bufferevent *buf) server mode. */ static void -simple_server_listener_cb(conn_t *conn, struct bufferevent *buf) +simple_server_listener_cb(conn_t *conn) { - struct event_base *base = bufferevent_get_base(buf); - obfs_assert(buf); obfs_assert(conn); obfs_assert(conn->mode == LSN_SIMPLE_SERVER); log_debug("%s: server connection", conn->peername); - conn->downstream = buf; - bufferevent_setcb(conn->downstream, - downstream_read_cb, NULL, error_cb, conn); - - /* Don't enable the downstream side for reading at this point; wait - till the upstream side is established. */ + bufferevent_setcb(conn->buffer, downstream_read_cb, NULL, error_cb, conn); - /* New bufferevent to connect to the target address. */ - conn->upstream = open_outbound_socket(conn, base, upstream_read_cb); - if (!conn->upstream) { - close_conn(conn); + if (circuit_create(open_outbound(conn, upstream_read_cb), conn)) { + conn_free(conn); return; } @@ -349,36 +331,29 @@ simple_server_listener_cb(conn_t *conn, struct bufferevent *buf) static void conn_free(conn_t *conn) { - if (conn->peername) - free(conn->peername); - if (conn->socks_state) - socks_state_free(conn->socks_state); - if (conn->upstream) - bufferevent_free(conn->upstream); - if (conn->downstream) - bufferevent_free(conn->downstream); - - proto_conn_free(conn); -} - -/** - Closes a fully open connection. -*/ -static void -close_conn(conn_t *conn) -{ - obfs_assert(connections); - log_debug("Closing connection from %s; %d remaining", - conn->peername, smartlist_len(connections) - 1); - - smartlist_remove(connections, conn); - conn_free(conn); - - /* If this was the last connection AND we are shutting down, - finish shutdown. */ - if (smartlist_len(connections) == 0 && shutting_down) { - smartlist_free(connections); - finish_shutdown(); + if (conn->circuit) + circuit_free(conn->circuit); /* will recurse and take care of us */ + else { + if (connections) { + smartlist_remove(connections, conn); + log_debug("Closing connection with %s; %d remaining", + conn->peername, smartlist_len(connections)); + } + if (conn->peername) + free(conn->peername); + if (conn->socks_state) + socks_state_free(conn->socks_state); + if (conn->buffer) + bufferevent_free(conn->buffer); + proto_conn_free(conn); + + /* If this was the last connection AND we are shutting down, + finish shutdown. */ + if (shutting_down && (!connections || smartlist_len(connections) == 0)) { + if (connections) + smartlist_free(connections); + finish_shutdown(); + } } } @@ -387,25 +362,51 @@ close_conn(conn_t *conn) empty. */ static void -close_conn_on_flush(struct bufferevent *bev, void *arg) +conn_free_on_flush(struct bufferevent *bev, void *arg) { conn_t *conn = arg; log_debug("%s for %s", __func__, conn->peername); if (evbuffer_get_length(bufferevent_get_output(bev)) == 0) - close_conn(conn); + conn_free(conn); +} + +static int +circuit_create(conn_t *up, conn_t *down) +{ + if (!up || !down) + return -1; + + circuit_t *r = xzalloc(sizeof(circuit_t)); + r->upstream = up; + r->downstream = down; + up->circuit = r; + down->circuit = r; + return 0; +} + +static void +circuit_free(circuit_t *circuit) +{ + /* break the circular references before deallocating each side */ + circuit->upstream->circuit = NULL; + circuit->downstream->circuit = NULL; + conn_free(circuit->upstream); + conn_free(circuit->downstream); + free(circuit); } /** - Make the outbound socket for a connection. + Make the outbound connection for a circuit. */ -static struct bufferevent * -open_outbound_socket(conn_t *conn, struct event_base *base, - bufferevent_data_cb readcb) +static conn_t * +open_outbound(conn_t *conn, bufferevent_data_cb readcb) { struct evutil_addrinfo *addr = config_get_target_addr(conn->cfg); + struct event_base *base = bufferevent_get_base(conn->buffer); struct bufferevent *buf; char *peername; + conn_t *newconn; if (!addr) { log_warn("%s: no target addresses available", conn->peername); @@ -418,18 +419,23 @@ open_outbound_socket(conn_t *conn, struct event_base *base, return NULL; } - bufferevent_setcb(buf, readcb, NULL, pending_conn_cb, conn); + newconn = proto_conn_create(conn->cfg); + if (!conn) { + log_warn("%s: failed to allocate state for outbound connection", + conn->peername); + bufferevent_free(buf); + return NULL; + } + + newconn->buffer = buf; + bufferevent_setcb(buf, readcb, NULL, pending_conn_cb, newconn); do { peername = printable_address(addr->ai_addr, addr->ai_addrlen); log_info("%s (%s): trying to connect to %s", conn->peername, conn->cfg->vtable->name, peername); - if (bufferevent_socket_connect(buf, addr->ai_addr, addr->ai_addrlen) >= 0) { - /* success */ - bufferevent_enable(buf, EV_READ|EV_WRITE); - free(peername); - return buf; - } + if (bufferevent_socket_connect(buf, addr->ai_addr, addr->ai_addrlen) >= 0) + goto success; log_info("%s: connection to %s failed: %s", conn->peername, peername, evutil_socket_error_to_string(EVUTIL_SOCKET_ERROR())); @@ -440,8 +446,55 @@ open_outbound_socket(conn_t *conn, struct event_base *base, log_warn("%s: all outbound connection attempts failed", conn->peername); - bufferevent_free(buf); + conn_free(newconn); return NULL; + + success: + bufferevent_enable(buf, EV_READ|EV_WRITE); + newconn->peername = peername; + obfs_assert(connections); + smartlist_add(connections, newconn); + return newconn; +} + +/** + As open_outbound, but uses bufferevent_socket_connect_hostname + rather than bufferevent_socket_connect. +*/ +static conn_t * +open_outbound_hostname(conn_t *conn, int af, const char *addr, int port) +{ + struct event_base *base = bufferevent_get_base(conn->buffer); + struct bufferevent *buf; + conn_t *newconn; + + buf = bufferevent_socket_new(base, -1, BEV_OPT_CLOSE_ON_FREE); + if (!buf) { + log_warn("%s: unable to create outbound socket buffer", conn->peername); + return NULL; + } + newconn = proto_conn_create(conn->cfg); + if (!conn) { + log_warn("%s: failed to allocate state for outbound connection", + conn->peername); + bufferevent_free(buf); + return NULL; + } + newconn->buffer = buf; + bufferevent_setcb(buf, downstream_read_cb, NULL, pending_socks_cb, newconn); + if (bufferevent_socket_connect_hostname(buf, get_evdns_base(), + af, addr, port) < 0) { + log_warn("%s: outbound connection to %s:%d failed: %s", + conn->peername, addr, port, + evutil_socket_error_to_string(EVUTIL_SOCKET_ERROR())); + conn_free(newconn); + return NULL; + } + + bufferevent_enable(buf, EV_READ|EV_WRITE); + obfs_assert(connections); + smartlist_add(connections, newconn); + return newconn; } /** @@ -452,9 +505,7 @@ socks_read_cb(struct bufferevent *bev, void *arg) { conn_t *conn = arg; enum socks_ret socks_ret; - log_debug("%s for %s", __func__, conn->peername); - /* socks only makes sense on the upstream side */ - obfs_assert(bev == conn->upstream); + log_debug("%s: %s", conn->peername, __func__); do { enum socks_status_t status = socks_state_get_status(conn->socks_state); @@ -466,27 +517,16 @@ socks_read_cb(struct bufferevent *bev, void *arg) const char *addr=NULL; r = socks_state_get_address(conn->socks_state, &af, &addr, &port); obfs_assert(r==0); - conn->downstream = - bufferevent_socket_new(bufferevent_get_base(conn->upstream), - -1, BEV_OPT_CLOSE_ON_FREE); - - bufferevent_setcb(conn->downstream, - downstream_read_cb, NULL, pending_socks_cb, conn); - - r = bufferevent_socket_connect_hostname(conn->downstream, - get_evdns_base(), - af, addr, port); - bufferevent_enable(conn->downstream, EV_READ|EV_WRITE); - log_debug("socket_connect_hostname said %d! (%s,%d)", r, addr, port); - - if (r < 0) { + log_info("%s: socks: trying to connect to %s:%u", + conn->peername, addr, port); + if (circuit_create(conn, open_outbound_hostname(conn, af, addr, port))) { /* XXXX send socks reply */ - close_conn(conn); + conn_free(conn); return; } /* further upstream data will be processed once the downstream side is established */ - bufferevent_disable(conn->upstream, EV_READ|EV_WRITE); + bufferevent_disable(conn->buffer, EV_READ|EV_WRITE); return; } @@ -498,14 +538,14 @@ socks_read_cb(struct bufferevent *bev, void *arg) if (socks_ret == SOCKS_INCOMPLETE) return; /* need to read more data. */ else if (socks_ret == SOCKS_BROKEN) - close_conn(conn); /* XXXX send socks reply */ + conn_free(conn); /* XXXX send socks reply */ else if (socks_ret == SOCKS_CMD_NOT_CONNECT) { bufferevent_enable(bev, EV_WRITE); bufferevent_disable(bev, EV_READ); socks5_send_reply(bufferevent_get_output(bev), conn->socks_state, SOCKS5_FAILED_UNSUPPORTED); bufferevent_setcb(bev, NULL, - close_conn_on_flush, flush_error_cb, conn); + conn_free_on_flush, flush_error_cb, conn); return; } } @@ -518,17 +558,27 @@ socks_read_cb(struct bufferevent *bev, void *arg) static void upstream_read_cb(struct bufferevent *bev, void *arg) { - conn_t *conn = arg; - log_debug("%s: %s, %lu bytes available", conn->peername, __func__, + conn_t *up = arg; + conn_t *down; + log_debug("%s: %s, %lu bytes available", up->peername, __func__, (unsigned long)evbuffer_get_length(bufferevent_get_input(bev))); - obfs_assert(bev == conn->upstream); - if (proto_send(conn, - bufferevent_get_input(conn->upstream), - bufferevent_get_output(conn->downstream)) < 0) { - log_debug("%s: Error during transmit.", conn->peername); - close_conn(conn); + obfs_assert(up->buffer == bev); + obfs_assert(!up->flushing); + obfs_assert(up->is_open); + obfs_assert(up->circuit); + obfs_assert(up->circuit->downstream); + + down = up->circuit->downstream; + if (proto_send(up, + bufferevent_get_input(up->buffer), + bufferevent_get_output(down->buffer))) { + log_debug("%s: error during transmit.", up->peername); + conn_free(up); } + log_debug("%s: transmitted %lu bytes", down->peername, + (unsigned long) + evbuffer_get_length(bufferevent_get_output(down->buffer))); } /** @@ -539,28 +589,45 @@ upstream_read_cb(struct bufferevent *bev, void *arg) static void downstream_read_cb(struct bufferevent *bev, void *arg) { - conn_t *conn = arg; + conn_t *down = arg; + conn_t *up; enum recv_ret r; - log_debug("%s: %s, %lu bytes available", conn->peername, __func__, + + log_debug("%s: %s, %lu bytes available", down->peername, __func__, (unsigned long)evbuffer_get_length(bufferevent_get_input(bev))); - obfs_assert(bev == conn->downstream); - r = proto_recv(conn, - bufferevent_get_input(conn->downstream), - bufferevent_get_output(conn->upstream)); + obfs_assert(down->buffer == bev); + obfs_assert(!down->flushing); + obfs_assert(down->is_open); + obfs_assert(down->circuit); + obfs_assert(down->circuit->upstream); + up = down->circuit->upstream; + + + r = proto_recv(down, + bufferevent_get_input(down->buffer), + bufferevent_get_output(up->buffer)); if (r == RECV_BAD) { - log_debug("%s: Error during receive.", conn->peername); - close_conn(conn); - } else if (r == RECV_SEND_PENDING) { - log_debug("%s: Reply of %lu bytes", conn->peername, + log_debug("%s: error during receive.", down->peername); + conn_free(down); + } else { + log_debug("%s: forwarded %lu bytes", down->peername, (unsigned long) - evbuffer_get_length(bufferevent_get_input(conn->upstream))); - if (proto_send(conn, - bufferevent_get_input(conn->upstream), - bufferevent_get_output(conn->downstream)) < 0) { - log_debug("%s: Error during reply.", conn->peername); - close_conn(conn); + evbuffer_get_length(bufferevent_get_output(up->buffer))); + if (r == RECV_SEND_PENDING) { + log_debug("%s: reply of %lu bytes", down->peername, + (unsigned long) + evbuffer_get_length(bufferevent_get_input(up->buffer))); + if (proto_send(up, + bufferevent_get_input(up->buffer), + bufferevent_get_output(down->buffer)) < 0) { + log_debug("%s: error during reply.", down->peername); + conn_free(down); + } + log_debug("%s: transmitted %lu bytes", down->peername, + (unsigned long) + evbuffer_get_length(bufferevent_get_output(down->buffer))); } } } @@ -570,22 +637,29 @@ downstream_read_cb(struct bufferevent *bev, void *arg) We prepare the connection to be closed ASAP. */ static void -error_or_eof(conn_t *conn, struct bufferevent *bev_err) +error_or_eof(conn_t *conn) { + circuit_t *circ = conn->circuit; + struct bufferevent *bev_err = conn->buffer; struct bufferevent *bev_flush; - log_debug("%s for %s", __func__, conn->peername); - if (bev_err == conn->upstream) bev_flush = conn->downstream; - else if (bev_err == conn->downstream) bev_flush = conn->upstream; - else obfs_abort(); + log_debug("%s for %s", __func__, conn->peername); + if (!circ || conn->flushing || !conn->is_open) { + conn_free(conn); + return; + } - if (conn->flushing || !conn->is_open || - evbuffer_get_length(bufferevent_get_output(bev_flush)) == 0) { - close_conn(conn); + bev_flush = (conn == circ->upstream) ? circ->downstream->buffer + : circ->upstream->buffer; + if (evbuffer_get_length(bufferevent_get_output(bev_flush)) == 0) { + conn_free(conn); return; } - conn->flushing = 1; + /* XXX move ->flushing and ->is_open to circuit_t */ + circ->upstream->flushing = 1; + circ->downstream->flushing = 1; + /* Stop reading and writing; wait for the other side to flush if it has * data. */ bufferevent_disable(bev_err, EV_READ|EV_WRITE); @@ -595,7 +669,7 @@ error_or_eof(conn_t *conn, struct bufferevent *bev_err) official API to retrieve the callback functions and/or change just one callback while leaving the others intact. */ bufferevent_setcb(bev_flush, bev_flush->readcb, - close_conn_on_flush, flush_error_cb, conn); + conn_free_on_flush, flush_error_cb, conn); } /** @@ -607,7 +681,7 @@ error_cb(struct bufferevent *bev, short what, void *arg) { conn_t *conn = arg; int errcode = EVUTIL_SOCKET_ERROR(); - log_debug("%s for %s: what=%x err=%d", __func__, conn->peername, + log_debug("%s for %s: what=0x%04x errno=%d", __func__, conn->peername, what, errcode); /* It should be impossible to get here with BEV_EVENT_CONNECTED. */ @@ -615,21 +689,16 @@ error_cb(struct bufferevent *bev, short what, void *arg) obfs_assert(!(what & BEV_EVENT_CONNECTED)); if (what & BEV_EVENT_ERROR) { - log_warn("Error on %s side of connection from %s: %s", - bev == conn->upstream ? "upstream" : "downstream", + log_warn("Error talking to %s: %s", conn->peername, evutil_socket_error_to_string(errcode)); } else if (what & BEV_EVENT_EOF) { - log_info("EOF on %s side of connection from %s", - bev == conn->upstream ? "upstream" : "downstream", - conn->peername); + log_info("EOF from %s", conn->peername); } else { obfs_assert(what & BEV_EVENT_TIMEOUT); - log_info("Timeout on %s side of connection from %s", - bev == conn->upstream ? "upstream" : "downstream", - conn->peername); + log_info("Timeout talking to %s", conn->peername); } - error_or_eof(arg, bev); + error_or_eof(conn); } /** @@ -641,7 +710,7 @@ flush_error_cb(struct bufferevent *bev, short what, void *arg) { conn_t *conn = arg; int errcode = EVUTIL_SOCKET_ERROR(); - log_debug("%s for %s: what=%x err=%d", __func__, conn->peername, + log_debug("%s for %s: what=0x%04x errno=%d", __func__, conn->peername, what, errcode); /* It should be impossible to get here with BEV_EVENT_CONNECTED. */ @@ -650,11 +719,10 @@ flush_error_cb(struct bufferevent *bev, short what, void *arg) obfs_assert(conn->flushing); - log_warn("Error during flush of %s side of connection from %s: %s", - bev == conn->upstream ? "upstream" : "downstream", + log_warn("Error during flush of connection with %s: %s", conn->peername, evutil_socket_error_to_string(errcode)); - close_conn(conn); + conn_free(conn); return; } @@ -668,35 +736,36 @@ static void pending_conn_cb(struct bufferevent *bev, short what, void *arg) { conn_t *conn = arg; - struct bufferevent *other; log_debug("%s: %s", conn->peername, __func__); - if (bev == conn->upstream) other = conn->downstream; - else if (bev == conn->downstream) other = conn->upstream; - else obfs_abort(); - - /* Upon successful connection, enable traffic on the other side, - and replace this callback with the regular error_cb */ + /* Upon successful connection, enable traffic on both sides of the + connection, and replace this callback with the regular error_cb */ if (what & BEV_EVENT_CONNECTED) { - obfs_assert(!conn->flushing); + circuit_t *circ = conn->circuit; + obfs_assert(circ); + obfs_assert(!circ->upstream->flushing); + obfs_assert(!circ->downstream->flushing); + + circ->upstream->is_open = 1; + circ->downstream->is_open = 1; - conn->is_open = 1; - log_debug("%s: Successful %s connection", conn->peername, - bev == conn->upstream ? "upstream" : "downstream"); + log_debug("%s: Successful connection", conn->peername); /* Queue handshake, if any. */ - if (proto_handshake(conn, - bufferevent_get_output(conn->downstream))<0) { + if (proto_handshake(circ->downstream, + bufferevent_get_output(circ->downstream->buffer))<0) { log_debug("%s: Error during handshake", conn->peername); - close_conn(conn); + conn_free(conn); return; } - /* XXX Dirty access to bufferevent guts. There appears to be no - official API to retrieve the callback functions and/or change - just one callback while leaving the others intact. */ - bufferevent_setcb(bev, bev->readcb, bev->writecb, error_cb, conn); - bufferevent_enable(other, EV_READ|EV_WRITE); + bufferevent_setcb(circ->upstream->buffer, + upstream_read_cb, NULL, error_cb, circ->upstream); + bufferevent_setcb(circ->downstream->buffer, + downstream_read_cb, NULL, error_cb, circ->downstream); + + bufferevent_enable(circ->upstream->buffer, EV_READ|EV_WRITE); + bufferevent_enable(circ->downstream->buffer, EV_READ|EV_WRITE); return; } @@ -712,10 +781,20 @@ pending_conn_cb(struct bufferevent *bev, short what, void *arg) static void pending_socks_cb(struct bufferevent *bev, short what, void *arg) { - conn_t *conn = arg; - log_debug("%s: %s", conn->peername, __func__); - obfs_assert(bev == conn->downstream); - obfs_assert(conn->socks_state); + conn_t *down = arg; + circuit_t *circ = down->circuit; + conn_t *up; + socks_state_t *socks; + + log_debug("%s: %s", down->peername, __func__); + + obfs_assert(circ); + obfs_assert(circ->upstream); + obfs_assert(circ->upstream->socks_state); + obfs_assert(circ->downstream == down); + + up = circ->upstream; + socks = circ->upstream->socks_state; /* If we got an error while in the ST_HAVE_ADDR state, chances are that we failed connecting to the host requested by the CONNECT @@ -725,14 +804,11 @@ pending_socks_cb(struct bufferevent *bev, short what, void *arg) errno isn't meaningful in that case... */ if ((what & (BEV_EVENT_EOF|BEV_EVENT_ERROR|BEV_EVENT_TIMEOUT))) { int err = EVUTIL_SOCKET_ERROR(); - log_warn("Connection error: %s", - evutil_socket_error_to_string(err)); - if (socks_state_get_status(conn->socks_state) == ST_HAVE_ADDR) { - socks_send_reply(conn->socks_state, - bufferevent_get_output(conn->upstream), - err); + log_warn("Connection error: %s", evutil_socket_error_to_string(err)); + if (socks_state_get_status(socks) == ST_HAVE_ADDR) { + socks_send_reply(socks, bufferevent_get_output(up->buffer), err); } - error_or_eof(conn, bev); + error_or_eof(down); return; } @@ -744,39 +820,39 @@ pending_socks_cb(struct bufferevent *bev, short what, void *arg) struct sockaddr *sa = (struct sockaddr*)&ss; socklen_t slen = sizeof(&ss); - obfs_assert(!conn->flushing); + obfs_assert(!up->flushing); + obfs_assert(!down->flushing); + /* Figure out where we actually connected to, and tell the socks client */ if (getpeername(bufferevent_getfd(bev), sa, &slen) == 0) { - /* Figure out where we actually connected to so that we can tell the - * socks client */ - socks_state_set_address(conn->socks_state, sa); + socks_state_set_address(socks, sa); + if (!down->peername) + down->peername = printable_address(sa, slen); } - socks_send_reply(conn->socks_state, - bufferevent_get_output(conn->upstream), 0); + socks_send_reply(socks, bufferevent_get_output(up->buffer), 0); /* Switch to regular upstream behavior. */ - socks_state_free(conn->socks_state); - conn->socks_state = NULL; - conn->is_open = 1; - log_debug("%s: Successful %s connection", conn->peername, - bev == conn->upstream ? "upstream" : "downstream"); - - bufferevent_setcb(conn->upstream, - upstream_read_cb, NULL, error_cb, conn); - bufferevent_setcb(conn->downstream, - downstream_read_cb, NULL, error_cb, conn); - bufferevent_enable(conn->upstream, EV_READ|EV_WRITE); + socks_state_free(socks); + up->socks_state = NULL; + up->is_open = 1; + down->is_open = 1; + log_debug("%s: Successful outbound connection to %s", + up->peername, down->peername); + + bufferevent_setcb(up->buffer, upstream_read_cb, NULL, error_cb, up); + bufferevent_setcb(down->buffer, downstream_read_cb, NULL, error_cb, down); + bufferevent_enable(up->buffer, EV_READ|EV_WRITE); + bufferevent_enable(down->buffer, EV_READ|EV_WRITE); /* Queue handshake, if any. */ - if (proto_handshake(conn, - bufferevent_get_output(conn->downstream))<0) { - log_debug("%s: Error during handshake", conn->peername); - close_conn(conn); + if (proto_handshake(down, bufferevent_get_output(down->buffer))) { + log_debug("%s: Error during handshake", down->peername); + conn_free(down); return; } - if (evbuffer_get_length(bufferevent_get_input(conn->upstream)) != 0) - upstream_read_cb(conn->upstream, conn); + if (evbuffer_get_length(bufferevent_get_input(up->buffer)) > 0) + upstream_read_cb(up->buffer, up); return; } diff --git a/src/network.h b/src/network.h index 8fb41ef..72df32c 100644 --- a/src/network.h +++ b/src/network.h @@ -12,23 +12,37 @@ void close_all_listeners(void); void start_shutdown(int barbaric); /** - This struct defines the state of a connection between "upstream" - and "downstream" peers (it's really two connections at the socket - level). Again, each protocol may extend this structure with - additional private data by embedding it as the first member of a - larger structure. The protocol's conn_create() method is responsible - only for filling in the |vtable| field of this structure, plus any - private data of course. + This struct defines the state of one socket-level connection. Each + protocol may extend this structure with additional private data by + embedding it as the first member of a larger structure. The + protocol's conn_create() method is responsible only for filling in + the |cfg| and |mode| fields of this structure, plus any private + data of course. + + An incoming connection is not associated with a circuit until the + destination for the other side of the circuit is known. An outgoing + connection is associated with a circuit from its creation. */ struct conn_t { config_t *cfg; char *peername; socks_state_t *socks_state; - struct bufferevent *upstream; - struct bufferevent *downstream; + circuit_t *circuit; + struct bufferevent *buffer; enum listen_mode mode : 30; unsigned int flushing : 1; unsigned int is_open : 1; }; +/** + This struct defines a pair of established connections. The "upstream" + connection is to the higher-level client or server that we are proxying + traffic for. The "downstream" connection is to the remote peer. + */ + +struct circuit_t { + conn_t *upstream; + conn_t *downstream; +}; + #endif diff --git a/src/util.h b/src/util.h index 8228790..2b37c48 100644 --- a/src/util.h +++ b/src/util.h @@ -62,6 +62,7 @@ unsigned int ui64_log2(uint64_t u64); /***** Network types and functions. *****/ +typedef struct circuit_t circuit_t; typedef struct config_t config_t; typedef struct conn_t conn_t; typedef struct protocol_vtable protocol_vtable;

1 0

[obfsproxy/master] Avoid double-freeing the connections smartlist on barbaric shutdown.
by nickm＠torproject.org 10 Sep '11

10 Sep '11

commit 9c4f2a0a82964b6137c9286cee5122ca493ed5de Author: George Kadianakis <desnacked(a)gmail.com> Date: Fri Aug 19 18:14:09 2011 +0200 Avoid double-freeing the connections smartlist on barbaric shutdown. --- src/network.c | 36 ++++++++++-------------------------- 1 files changed, 10 insertions(+), 26 deletions(-) diff --git a/src/network.c b/src/network.c index cc5b633..62a45b8 100644 --- a/src/network.c +++ b/src/network.c @@ -79,7 +79,6 @@ static void socks_client_listener_cb(conn_t *conn); static void simple_server_listener_cb(conn_t *conn); static void conn_free(conn_t *conn); -static void conn_free_all(void); static void conn_free_on_flush(struct bufferevent *bev, void *arg); static int circuit_create(conn_t *up, conn_t *down); @@ -115,31 +114,16 @@ start_shutdown(int barbaric) if (!shutting_down) shutting_down=1; - if (barbaric) - conn_free_all(); - - if (connections && smartlist_len(connections) == 0) { + if (!connections) { + finish_shutdown(); + } else if (smartlist_len(connections) == 0) { smartlist_free(connections); connections = NULL; - } - - if (!connections) finish_shutdown(); -} - -/** - Closes all open connections. -*/ -static void -conn_free_all(void) -{ - if (!connections) - return; - log_debug("Closing all connections."); - SMARTLIST_FOREACH(connections, conn_t *, conn, - { conn_free(conn); }); - smartlist_free(connections); - connections = NULL; + } else if (barbaric) { + while (connections) /* last conn_free() will free connections smartlist */ + conn_free(smartlist_get(connections,0)); + } } /** @@ -349,9 +333,9 @@ conn_free(conn_t *conn) /* If this was the last connection AND we are shutting down, finish shutdown. */ - if (shutting_down && (!connections || smartlist_len(connections) == 0)) { - if (connections) - smartlist_free(connections); + if (shutting_down && connections && smartlist_len(connections) == 0) { + smartlist_free(connections); + connections = NULL; finish_shutdown(); } }

1 0