June 2011 - tor-commits - lists.torproject.org

[obfsproxy/master] Documentation updates.
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit 835464e0d6bd025faa74ff429610e970bec25933 Author: George Kadianakis <desnacked(a)gmail.com> Date: Thu Jun 9 17:27:56 2011 +0200 Documentation updates. * Tweaked tor-obfs-howto.txt for the new cli. * Fixed a comment in main.c --- doc/tor-obfs-howto.txt | 6 +++--- src/main.c | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/tor-obfs-howto.txt b/doc/tor-obfs-howto.txt index 36ad7a3..ed8ba72 100644 --- a/doc/tor-obfs-howto.txt +++ b/doc/tor-obfs-howto.txt @@ -50,11 +50,11 @@ Our port setup will be like this: This command will setup an obfsproxy socks client listening to the obfs2 protocol on localhost:1050: -./obfsproxy socks obfs2 127.0.0.1:1050 +./obfsproxy obfs2 socks 127.0.0.1:1050 This command will setup an obfsproxy server listening to the -obfs2 protocol on localhost:5001: -./obfsproxy server obfs2 127.0.0.1:1051 127.0.0.1:5001 +obfs2 protocol on localhost:1051: +./obfsproxy obfs2 --dest 127.0.0.1:5001 server 127.0.0.1:1051 Setting up Tor: diff --git a/src/main.c b/src/main.c index e7680d5..8617bb3 100644 --- a/src/main.c +++ b/src/main.c @@ -112,8 +112,8 @@ main(int argc, const char **argv) /* 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 by - set_up_protocol() and listener_new(). */ + options or arguments, but this will be resolved per-protocol by + set_up_protocol(). */ int actual_protocols=0; int start;

1 0

[obfsproxy/master] Added unit tests for parse_and_set_options() of obfs2.
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit b03e4e200a2f990829152bfce5684f3c5d84b935 Author: George Kadianakis <desnacked(a)gmail.com> Date: Thu Jun 9 19:36:30 2011 +0200 Added unit tests for parse_and_set_options() of obfs2. --- src/protocols/obfs2.c | 7 +-- src/protocols/obfs2.h | 3 + src/test/unittest_obfs2.c | 109 ++++++++++++++++++++++++++++++++++++++++++-- 3 files changed, 109 insertions(+), 10 deletions(-) diff --git a/src/protocols/obfs2.c b/src/protocols/obfs2.c index 2cb1089..edfc365 100644 --- a/src/protocols/obfs2.c +++ b/src/protocols/obfs2.c @@ -34,9 +34,6 @@ static int obfs2_state_set_shared_secret(void *s, size_t secretlen); static int set_up_vtable(void); static void usage(void); -static int parse_and_set_options(int n_options, char **options, - struct protocol_params_t *params); - static protocol_vtable *vtable=NULL; @@ -67,7 +64,7 @@ obfs2_init(int n_options, char **options, return 1; } -static int +int parse_and_set_options(int n_options, char **options, struct protocol_params_t *params) { @@ -94,7 +91,7 @@ parse_and_set_options(int n_options, char **options, struct sockaddr_storage ss_target; struct sockaddr *sa_target=NULL; int sl_target=0; - if (resolve_address_port(*options+7, 1, 0, + if (resolve_address_port(*options+7, 1, 0, &ss_target, &sl_target, NULL) < 0) return -1; assert(sl_target <= sizeof(struct sockaddr_storage)); diff --git a/src/protocols/obfs2.h b/src/protocols/obfs2.h index 7747330..d206bc8 100644 --- a/src/protocols/obfs2.h +++ b/src/protocols/obfs2.h @@ -21,6 +21,9 @@ struct listener_t; int obfs2_init(int n_options, char **options, struct protocol_params_t *params); void *obfs2_new(struct protocol_t *proto_struct, struct protocol_params_t *params); +int parse_and_set_options(int n_options, char **options, + struct protocol_params_t *params); + #ifdef CRYPT_PROTOCOL_PRIVATE diff --git a/src/test/unittest_obfs2.c b/src/test/unittest_obfs2.c index 45d1278..1348c7d 100644 --- a/src/test/unittest_obfs2.c +++ b/src/test/unittest_obfs2.c @@ -23,6 +23,84 @@ #include "../protocols/obfs2.h" #include "../network.h" +static void +test_proto_option_parsing(void *data) +{ + protocol_params_t *proto_params = calloc(1, sizeof(protocol_params_t)); + char *options[] = {"obfs2", "--shared-secret=a", "socks", "127.0.0.1:0"}; + int n_options = 4; + + tt_assert(set_up_protocol(n_options, options, + proto_params) == 1); + + /** two --dest. */ + char *options2[] = {"obfs2", "--dest=127.0.0.1:5555", "--dest=a", + "server", "127.0.0.1:5552"}; + n_options = 5; + + tt_assert(set_up_protocol(n_options, options2, + proto_params) == -1); + + /** unknown arg */ + char *options3[] = {"obfs2", "--gabura=a", + "server", "127.0.0.1:5552"}; + n_options = 4; + + tt_assert(set_up_protocol(n_options, options3, + proto_params) == -1); + + /** too many args */ + char *options4[] = {"obfs2", "1", "2", "3", "4", "5" }; + n_options = 6; + + tt_assert(set_up_protocol(n_options, options4, + proto_params) == -1); + + /** wrong mode */ + char *options5[] = {"obfs2", "--dest=1:1", + "gladiator", "127.0.0.1:5552"}; + n_options = 4; + + tt_assert(set_up_protocol(n_options, options5, + proto_params) == -1); + + /** stupid listen addr. */ + char *options6[] = {"obfs2", "--dest=1:1", + "server", "127.0.0.1:a"}; + n_options = 4; + + tt_assert(set_up_protocol(n_options, options6, + proto_params) == -1); + + /** stupid dest addr. */ + char *options7[] = {"obfs2", "--dest=1:b", + "server", "127.0.0.1:1"}; + n_options = 4; + + tt_assert(set_up_protocol(n_options, options7, + proto_params) == -1); + + /** socks with dest. */ + char *options8[] = {"obfs2", "--dest=1:2", + "socks", "127.0.0.1:1"}; + n_options = 4; + + tt_assert(set_up_protocol(n_options, options8, + proto_params) == -1); + + /** socks with dest. */ + char *options9[] = {"obfs2", "--shared-secret=a", + "server", "127.0.0.1:1"}; + n_options = 4; + + tt_assert(set_up_protocol(n_options, options9, + proto_params) == -1); + + end: + if (proto_params) + free(proto_params); +} + /* Make sure we can successfully set up a protocol state */ static void test_proto_setup(void *data) @@ -57,7 +135,6 @@ test_proto_setup(void *data) proto_destroy(client_proto); if (server_proto->state) proto_destroy(server_proto); - } static void @@ -126,6 +203,11 @@ test_proto_handshake(void *data) if (server_proto->state) proto_destroy(server_proto); + if (proto_params_client) + free(proto_params_client); + if (proto_params_serv) + free(proto_params_serv); + if (output_buffer) evbuffer_free(output_buffer); if (dummy_buffer) @@ -215,6 +297,11 @@ test_proto_transfer(void *data) if (server_proto->state) proto_destroy(server_proto); + if (proto_params_client) + free(proto_params_client); + if (proto_params_serv) + free(proto_params_serv); + if (output_buffer) evbuffer_free(output_buffer); if (dummy_buffer) @@ -378,6 +465,11 @@ test_proto_splitted_handshake(void *data) if (server_state) proto_destroy(server_proto); + if (proto_params_client) + free(proto_params_client); + if (proto_params_serv) + free(proto_params_serv); + if (output_buffer) evbuffer_free(output_buffer); if (dummy_buffer) @@ -459,6 +551,11 @@ test_proto_wrong_handshake_magic(void *data) if (server_state) proto_destroy(server_proto); + if (proto_params_client) + free(proto_params_client); + if (proto_params_serv) + free(proto_params_serv); + if (output_buffer) evbuffer_free(output_buffer); if (dummy_buffer) @@ -539,25 +636,27 @@ test_proto_wrong_handshake_plength(void *data) if (server_state) proto_destroy(server_proto); + if (proto_params_client) + free(proto_params_client); + if (proto_params_serv) + free(proto_params_serv); + if (output_buffer) evbuffer_free(output_buffer); if (dummy_buffer) evbuffer_free(dummy_buffer); } - #define T(name, flags) \ { #name, test_proto_##name, (flags), NULL, NULL } struct testcase_t protocol_tests[] = { + T(option_parsing,0), T(setup, 0), T(handshake, 0), T(transfer, 0), T(splitted_handshake, 0), T(wrong_handshake_magic, 0), -#if 0 - T(wrong_handshake_padding, 0), -#endif T(wrong_handshake_plength, 0), END_OF_TESTCASES };

1 0

[obfsproxy/master] We no longer strdup argv strings; we are now using the argv addresses themselves.
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit 30f8a9e03b2e2e63a55ff8dec6c7d4e2a5885411 Author: George Kadianakis <desnacked(a)gmail.com> Date: Tue Jun 7 00:54:26 2011 +0200 We no longer strdup argv strings; we are now using the argv addresses themselves. --- src/main.c | 31 ++++++++++++------------------- 1 files changed, 12 insertions(+), 19 deletions(-) diff --git a/src/main.c b/src/main.c index 237de94..f7d3d35 100644 --- a/src/main.c +++ b/src/main.c @@ -68,18 +68,13 @@ handle_signal_cb(evutil_socket_t fd, short what, void *arg) Returns 1 on success, -1 on fail. */ -static int +static void populate_options(char **options_string, const char **argv, int n_options) { - int x,g; - for (g=0;g<=n_options-1;g++) { - options_string[g] = strdup(argv[g]); - if (!options_string[x]) { - return -1; - } - } - return 1; + int g; + for (g=0;g<=n_options-1;g++) + options_string[g] = (char*) argv[g]; } /** @@ -209,9 +204,8 @@ main(int argc, const char **argv) n_options_array[actual_protocols-1] = n_options; /* Finally! Let's fill protocol_options. */ - if (populate_options(protocol_options[actual_protocols-1], - &argv[start], n_options) < 0) - return 1; + populate_options(protocol_options[actual_protocols-1], + &argv[start], n_options); } /* Excellent. Now we should have protocol_options populated with all @@ -232,9 +226,10 @@ main(int argc, const char **argv) /* Handle signals */ signal(SIGPIPE, SIG_IGN); - sigevent = evsignal_new(base, SIGINT, handle_signal_cb, (void*) base); + sigevent = evsignal_new(base, SIGINT, + handle_signal_cb, (void*) base); if (event_add(sigevent,NULL)) { - printf("Oh come on! We can't even add events for signals! Exiting.\n"); + printf("We can't even add events for signals! Exiting.\n"); return 1; } @@ -251,12 +246,10 @@ main(int argc, const char **argv) STUPID_BEAUTIFIER, h+1)); } - temp_listener = listener_new(base, n_options_array[h], protocol_options[h]); + temp_listener = listener_new(base, n_options_array[h], + protocol_options[h]); - /** Now that we created the listener, free the space allocated for - this protocol's options. */ - for (i=0;i<n_options_array[h];i++) - free(protocol_options[h][i]); + /** Free the space allocated for this protocol's options. */ free(protocol_options[h]); if (!temp_listener) {

1 0

[obfsproxy/master] minor fix
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit afdc2d87cd073f3b9521cc4764f9bf4230a8a6dd Author: George Kadianakis <desnacked(a)gmail.com> Date: Tue Jun 7 04:00:13 2011 +0200 minor fix --- src/main.c | 11 ++++++----- 1 files changed, 6 insertions(+), 5 deletions(-) diff --git a/src/main.c b/src/main.c index 065e011..e7680d5 100644 --- a/src/main.c +++ b/src/main.c @@ -238,7 +238,7 @@ main(int argc, const char **argv) listener_t *listeners[actual_protocols]; listener_t *temp_listener; int n_listeners=0; - protocol_params_t *proto_params; + protocol_params_t *proto_params=NULL; for (h=0;h<actual_protocols;h++) { if (n_protocols > 1) { @@ -247,20 +247,21 @@ main(int argc, const char **argv) STUPID_BEAUTIFIER, h+1)); } - /** free'd in listener_free() */ + /** normally free'd in listener_free() */ proto_params = calloc(1, sizeof(protocol_params_t)); if (set_up_protocol(n_options_array[h],protocol_options[h], - proto_params)<0) + proto_params)<0) { + free(proto_params); continue; + } temp_listener = listener_new(base, proto_params); /** Free the space allocated for this protocol's options. */ free(protocol_options[h]); - if (!temp_listener) { + if (!temp_listener) continue; - } dbg(("Succesfully created listener.\n")); listeners[n_listeners] = temp_listener;

1 0

[obfsproxy/master] Merge branch 'bug3204' into bug3204_actual_merge
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit 1e750f25009721ff183483fad831b79ee9de8ed1 Merge: f949fac afdc2d8 Author: George Kadianakis <desnacked(a)gmail.com> Date: Thu Jun 9 15:44:12 2011 +0200 Merge branch 'bug3204' into bug3204_actual_merge Conflicts: src/main.c src/protocol.c src/protocol.h src/protocols/dummy.c src/socks.h src/test/unittest_obfs2.c src/main.c | 300 +++++++++++++++++++++++++++++++++------------ src/network.c | 75 +++-------- src/network.h | 15 ++- src/protocol.c | 88 +++++++++---- src/protocol.h | 45 ++++--- src/protocols/dummy.c | 70 ++++++++++- src/protocols/dummy.h | 5 +- src/protocols/obfs2.c | 175 ++++++++++++++++++++++++-- src/protocols/obfs2.h | 5 +- src/test/unittest_obfs2.c | 158 ++++++++++++------------ src/test/unittest_socks.c | 2 +- 11 files changed, 654 insertions(+), 284 deletions(-) diff --cc src/protocol.c index bcd5330,57c0c23..32d8d0d --- a/src/protocol.c +++ b/src/protocol.c @@@ -72,7 -80,10 +80,10 @@@ proto_send(struct protocol_t *proto, vo return -1; } + /** + This function is responsible for receiving protocol data. + */ -int +enum recv_ret proto_recv(struct protocol_t *proto, void *source, void *dest) { assert(proto); if (proto->vtable->recv) diff --cc src/protocol.h index 4a17c73,0a7c452..69ea4aa --- a/src/protocol.h +++ b/src/protocol.h @@@ -39,6 -44,15 +44,15 @@@ struct protocol_t */ void *state; }; + int set_up_protocol(int n_options, char **options, + struct protocol_params_t *params); + struct protocol_t *proto_new(struct protocol_params_t *params); + void proto_destroy(struct protocol_t *proto); + int proto_handshake(struct protocol_t *proto, void *buf); + int proto_send(struct protocol_t *proto, void *source, void *dest); -int proto_recv(struct protocol_t *proto, void *source, void *dest); ++enum recv_ret proto_recv(struct protocol_t *proto, void *source, void *dest); + + void proto_params_free(protocol_params_t *params); typedef struct protocol_vtable { diff --cc src/protocols/dummy.c index 68bd7a1,2a24b56..5f6b8eb --- a/src/protocols/dummy.c +++ b/src/protocols/dummy.c @@@ -9,14 -9,16 +9,16 @@@ #include <event2/buffer.h> #include "dummy.h" + #include "../network.h" #include "../util.h" #include "../protocol.h" - +#include "../network.h" static int dummy_send(void *nothing, - struct evbuffer *source, struct evbuffer *dest); -static int dummy_recv(void *nothing, struct evbuffer *source, - struct evbuffer *dest); + struct evbuffer *source, struct evbuffer *dest); +static enum recv_ret dummy_recv(void *nothing, struct evbuffer *source, + struct evbuffer *dest); + static void usage(void); static protocol_vtable *vtable=NULL; diff --cc src/protocols/obfs2.c index c93db0e,5e91b5c..d886594 --- a/src/protocols/obfs2.c +++ b/src/protocols/obfs2.c @@@ -17,9 -17,9 +17,10 @@@ #include "obfs2_crypt.h" #include "obfs2.h" + #include "../network.h" #include "../util.h" #include "../protocol.h" +#include "../network.h" static void obfs2_state_free(void *state); static int obfs2_send_initial_message(void *state, struct evbuffer *buf); @@@ -441,14 -575,12 +585,17 @@@ obfs2_recv(void *s, struct evbuffer *so dbg(("Processing %d bytes data onto destination buffer\n", (int) evbuffer_get_length(source))); - return crypt_and_transmit(state->recv_crypto, source, dest); + crypt_and_transmit(state->recv_crypto, source, dest); + + if (r != RECV_SEND_PENDING) + r = RECV_GOOD; + + return r; } + /** + Frees obfs2 state 's' + */ static void obfs2_state_free(void *s) {

1 0

[obfsproxy/master] Small fixes in main.c.
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit c21133152b9def7b6c3d2c24d444d154dbd3a8b1 Author: George Kadianakis <desnacked(a)gmail.com> Date: Tue Jun 7 00:33:12 2011 +0200 Small fixes in main.c. * 's/SEPERATOR/SEPARATOR' * Fixed documentation of is_supported_protocol * Removed MAXPROTOCOLS, we now dynamically allocate necessary space for protocols. --- src/main.c | 44 +++++++++++++++++++++++++++----------------- 1 files changed, 27 insertions(+), 17 deletions(-) diff --git a/src/main.c b/src/main.c index cb70c44..237de94 100644 --- a/src/main.c +++ b/src/main.c @@ -20,7 +20,7 @@ #endif /* The character that seperates multiple listeners in the cli */ -#define SEPERATOR "+" +#define SEPARATOR "+" /* Totally arbitrary. */ #define MAXPROTOCOLS 20 @@ -40,7 +40,7 @@ usage(void) fprintf(stderr, "Usage: obfsproxy protocol_name [protocol_args] protocol_options %s protocol_name ...\n" "Available protocols:", - SEPERATOR); + SEPARATOR); /* this is awful. */ for (i=0;i<n_supported_protocols;i++) fprintf(stderr," [%s]", supported_protocols[i]); @@ -83,10 +83,8 @@ populate_options(char **options_string, } /** - Iterates through all the supported protocols and checks if 'name' - matches with the name of any of them. - - Returns 1 on success, 0 on fail. + Returns 1 if 'name' is the nmae of a supported protocol, otherwise + it returns 0. */ static int is_supported_protocol(const char *name) { @@ -129,29 +127,40 @@ main(int argc, const char **argv) void *temp; int i; + /* The number of protocols. */ unsigned int n_protocols=1; - unsigned int protocols[MAXPROTOCOLS+1]; - protocols[0] = 0; + /* An array which holds the position in argv of the command line + options for each protocol. */ + unsigned int *protocols=NULL; + if (argc < 2) { usage(); } - /* Iterate through command line arguments and find protocols. */ + protocols = malloc(sizeof(int)*(n_protocols+1)); + if (!protocols) + exit(1); + + protocols[0] = 0; + + /* Populate protocols and calculate n_protocols. */ for (i=0;i<argc;i++) { - if (!strcmp(argv[i],SEPERATOR)) { + if (!strcmp(argv[i],SEPARATOR)) { protocols[n_protocols] = i; n_protocols++; - if (n_protocols > MAXPROTOCOLS) { - printf("Sorry, we only allow %d protocols. Don't ask me why. " - "Exiting.\n", MAXPROTOCOLS); - return 1; - } + + temp = realloc(protocols, sizeof(int)*(n_protocols+1)); + if (!temp) + exit(1); + protocols = temp; } } + protocols[n_protocols] = argc; + if (n_protocols > 1) - printf("Found %d protocols.\n", n_protocols); + dbg(("Found %d protocols.\n", n_protocols)); /* Iterate through protocols. */ for (i=0;i<n_protocols;i++) { @@ -167,7 +176,7 @@ main(int argc, const char **argv) /* First option should be protocol_name. See if we support it. */ if (!is_supported_protocol(argv[start])) { - printf("We don't support crappy protocols, son.\n"); + printf("We don't support protocol: %s\n", argv[start]); continue; } @@ -277,6 +286,7 @@ main(int argc, const char **argv) listener_free(listeners[h]); free(protocol_options); free(n_options_array); + free(protocols); return 0; }

1 0

[obfsproxy/master] Kept argument parsing (set_up_protocol()) to main.c. We now just pass the protocol_params_t to listener_new().
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit afa43eb36053c3f0a292d43cd282dba104fc9648 Author: George Kadianakis <desnacked(a)gmail.com> Date: Tue Jun 7 01:47:11 2011 +0200 Kept argument parsing (set_up_protocol()) to main.c. We now just pass the protocol_params_t to listener_new(). --- src/main.c | 10 ++++++++-- src/network.c | 13 +++++-------- src/network.h | 3 ++- 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/src/main.c b/src/main.c index f7d3d35..065e011 100644 --- a/src/main.c +++ b/src/main.c @@ -238,6 +238,7 @@ main(int argc, const char **argv) listener_t *listeners[actual_protocols]; listener_t *temp_listener; int n_listeners=0; + protocol_params_t *proto_params; for (h=0;h<actual_protocols;h++) { if (n_protocols > 1) { @@ -246,8 +247,13 @@ main(int argc, const char **argv) STUPID_BEAUTIFIER, h+1)); } - temp_listener = listener_new(base, n_options_array[h], - protocol_options[h]); + /** free'd in listener_free() */ + proto_params = calloc(1, sizeof(protocol_params_t)); + if (set_up_protocol(n_options_array[h],protocol_options[h], + proto_params)<0) + continue; + + temp_listener = listener_new(base, proto_params); /** Free the space allocated for this protocol's options. */ free(protocol_options[h]); diff --git a/src/network.c b/src/network.c index c7dab85..3d64037 100644 --- a/src/network.c +++ b/src/network.c @@ -46,23 +46,20 @@ static void output_event_cb(struct bufferevent *bev, short what, void *arg); */ listener_t * listener_new(struct event_base *base, - int n_options, char **options) + protocol_params_t *proto_params) { const unsigned flags = LEV_OPT_CLOSE_ON_FREE|LEV_OPT_CLOSE_ON_EXEC|LEV_OPT_REUSEABLE; listener_t *lsn = calloc(1, sizeof(listener_t)); - if (!lsn) + if (!lsn) { + if (proto_params) + free(proto_params); return NULL; + } - protocol_params_t *proto_params = calloc(1, sizeof(protocol_params_t)); lsn->proto_params = proto_params; - if (set_up_protocol(n_options,options,lsn->proto_params)<0) { - listener_free(lsn); - return NULL; - } - lsn->listener = evconnlistener_new_bind(base, simple_listener_cb, lsn, flags, -1, diff --git a/src/network.h b/src/network.h index 5537680..120af80 100644 --- a/src/network.h +++ b/src/network.h @@ -21,6 +21,7 @@ typedef struct listener_t *listener; struct sockaddr; struct event_base; struct socks_state_t; +struct protocol_params_t; #define LSN_SIMPLE_CLIENT 1 #define LSN_SIMPLE_SERVER 2 @@ -30,7 +31,7 @@ typedef struct listener_t listener_t; struct addrinfo; listener_t *listener_new(struct event_base *base, - int n_options, char **options); + struct protocol_params_t *params); void listener_free(listener_t *listener); #ifdef NETWORK_PRIVATE

1 0

[obfsproxy/master] Function documentation for the upgraded functions.
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit 589bfa30f3619a8db15ef13479d54ea0c4f08b28 Author: George Kadianakis <desnacked(a)gmail.com> Date: Mon May 30 05:55:12 2011 +0200 Function documentation for the upgraded functions. --- src/main.c | 40 +++++++++++++++++++++++++++------------- src/network.c | 6 ++++++ src/protocols/obfs2.c | 19 +++++++++++++++---- 3 files changed, 48 insertions(+), 17 deletions(-) diff --git a/src/main.c b/src/main.c index dffe210..7b67988 100644 --- a/src/main.c +++ b/src/main.c @@ -30,6 +30,9 @@ static void usage(void) __attribute__((noreturn)); extern char *supported_protocols[]; extern int n_supported_protocols; +/** + Prints the obfsproxy usage instructions then exits. +*/ static void usage(void) { @@ -46,6 +49,10 @@ usage(void) exit(1); } +/** + This is called on SIGINT. It kills the event base loop, so that we + start exiting. +*/ static void handle_signal_cb(evutil_socket_t fd, short what, void *arg) { @@ -56,9 +63,11 @@ handle_signal_cb(evutil_socket_t fd, short what, void *arg) } /** - This function visits all the command line arguments in 'argv' between - 'start' and 'end' and writes them in 'options_string'. - */ + This function visits 'n_options' command line arguments off 'argv' + and writes them in 'options_string'. + + Returns 1 on success, -1 on fail. +*/ static int populate_options(char **options_string, const char **argv, int n_options) @@ -70,12 +79,14 @@ populate_options(char **options_string, return -1; } } - return 0; + return 1; } /** - Runs through all the supported protocols and checks if 'name' + Iterates through all the supported protocols and checks if 'name' matches with the name of any of them. + + Returns 1 on success, 0 on fail. */ static int is_supported_protocol(const char *name) { @@ -134,7 +145,7 @@ main(int argc, const char **argv) if (n_protocols > MAXPROTOCOLS) { printf("Sorry, we only allow %d protocols. Don't ask me why. " "Exiting.\n", MAXPROTOCOLS); - return 5; + return 1; } } } @@ -148,14 +159,15 @@ main(int argc, const char **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; + /* First option should be protocol_name. See if we support it. */ if (!is_supported_protocol(argv[start])) { printf("We don't support crappy protocols, son.\n"); continue; } - /* Okay seems like we support this protocol. */ actual_protocols++; /* We now allocate enough space for our parsing adventures. @@ -185,8 +197,9 @@ main(int argc, const char **argv) n_options_array[actual_protocols-1] = n_options; /* Finally! Let's fill protocol_options. */ - populate_options(protocol_options[actual_protocols-1], - &argv[start], n_options); + if (populate_options(protocol_options[actual_protocols-1], + &argv[start], n_options) < 0) + return 1; } /* Excellent. Now we should have protocol_options populated with all @@ -196,13 +209,13 @@ main(int argc, const char **argv) base = event_base_new(); if (!base) { fprintf(stderr, "Can't initialize Libevent; failing\n"); - return 2; + return 1; } /* ASN should this happen only when SOCKS is enabled? */ if (init_evdns_base(base) < 0) { fprintf(stderr, "Can't initialize evdns; failing\n"); - return 3; + return 1; } /* Handle signals */ @@ -210,7 +223,7 @@ main(int argc, const char **argv) sigevent = evsignal_new(base, SIGINT, handle_signal_cb, (void*) base); if (event_add(sigevent,NULL)) { printf("Oh come on! We can't even add events for signals! Exiting.\n"); - return 4; + return 1; } /*Let's open a new listener for each protocol. */ @@ -228,7 +241,8 @@ main(int argc, const char **argv) temp_listener = listener_new(base, n_options_array[h], protocol_options[h]); - /** Free the space allocated for this protocol's options. */ + /** Now that we created the listener, free the space allocated for + this protocol's options. */ for (i=0;i<n_options_array[h];i++) free(protocol_options[h][i]); free(protocol_options[h]); diff --git a/src/network.c b/src/network.c index 3b3c2bf..c7dab85 100644 --- a/src/network.c +++ b/src/network.c @@ -38,6 +38,12 @@ static void obfuscated_read_cb(struct bufferevent *bev, void *arg); static void input_event_cb(struct bufferevent *bev, short what, void *arg); static void output_event_cb(struct bufferevent *bev, short what, void *arg); +/** + This function sets up the protocol defined by 'options' and + attempts to bind a new listener for it. + + Returns the listener on success, NULL on fail. +*/ listener_t * listener_new(struct event_base *base, int n_options, char **options) diff --git a/src/protocols/obfs2.c b/src/protocols/obfs2.c index 115337e..6f6f84b 100644 --- a/src/protocols/obfs2.c +++ b/src/protocols/obfs2.c @@ -37,8 +37,11 @@ static void usage(void); static protocol_vtable *vtable=NULL; -/* Sets the function table for the obfs2 protocol and - calls initialize_crypto(). +/* + This function parses 'options' and fills the protocol_params_t + 'params'. + It then fills the obfs2 vtable and initializes the crypto subsystem. + Returns 0 on success, -1 on fail. */ int @@ -127,7 +130,7 @@ obfs2_init(int n_options, char **options, goto err; } - if (!set_up_vtable()) + if (set_up_vtable() < 0) return -1; if (initialize_crypto() < 0) { @@ -142,6 +145,9 @@ obfs2_init(int n_options, char **options, return -1; } +/** + Prints usage instructions for the obfs2 protocol. +*/ static void usage(void) { @@ -159,13 +165,18 @@ usage(void) "\tobfs2 server 127.0.0.1:1026\n"); } +/** + Helper: Allocates space for the protocol vtable and populates it's + function pointers. + Returns 1 on success, -1 on fail. +*/ static int set_up_vtable(void) { /* XXX memleak. */ vtable = calloc(1, sizeof(protocol_vtable)); if (!vtable) - return 0; + return -1; vtable->destroy = obfs2_state_free; vtable->create = obfs2_new;

1 0

[obfsproxy/master] Updated obfs2.c function documentation.
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit 27e11a547181401016bdbf5fbda062e541a941f3 Author: George Kadianakis <desnacked(a)gmail.com> Date: Tue Jun 7 01:55:05 2011 +0200 Updated obfs2.c function documentation. --- src/protocols/obfs2.c | 30 +++++++++++++++++++++++------- 1 files changed, 23 insertions(+), 7 deletions(-) diff --git a/src/protocols/obfs2.c b/src/protocols/obfs2.c index 6f6f84b..5e91b5c 100644 --- a/src/protocols/obfs2.c +++ b/src/protocols/obfs2.c @@ -38,8 +38,8 @@ static void usage(void); static protocol_vtable *vtable=NULL; /* - This function parses 'options' and fills the protocol_params_t - 'params'. + This function parses 'options' and fills the protocol parameters + structure 'params'. It then fills the obfs2 vtable and initializes the crypto subsystem. Returns 0 on success, -1 on fail. @@ -233,6 +233,10 @@ derive_key(void *s, const char *keytype) return cryptstate; } +/** + Derive and return padding key of type 'keytype' from the seeds + currently set in state 's'. Returns NULL on failure. +*/ static crypt_t * derive_padding_key(void *s, const uchar *seed, const char *keytype) @@ -268,6 +272,14 @@ derive_padding_key(void *s, const uchar *seed, return cryptstate; } +/** + This is called everytime we get a connection for the obfs2 + protocol. + + It sets up the protocol vtable in 'proto_struct' and then attempts + to create and return a protocol state according to the protocol + parameters 'params'. +*/ void * obfs2_new(struct protocol_t *proto_struct, protocol_params_t *params) @@ -279,9 +291,8 @@ obfs2_new(struct protocol_t *proto_struct, } /** - Return a new object to handle protocol state. If 'initiator' is true, - we're the handshake initiator. Otherwise, we're the responder. Return - NULL on failure. + Returns an obfs2 state according to the protocol parameters + 'params'. If something goes wrong it returns NULL. */ static void * obfs2_state_new(protocol_params_t *params) @@ -324,7 +335,9 @@ obfs2_state_new(protocol_params_t *params) return state; } -/** Set the shared secret to be used with this protocol state. */ +/** + Sets the shared 'secret' to be used, on the protocol state 's'. +*/ static int obfs2_state_set_shared_secret(void *s, const char *secret, size_t secretlen) @@ -349,7 +362,7 @@ obfs2_state_set_shared_secret(void *s, const char *secret, } /** - Write the initial protocol setup and padding message for 'state' to + Write the initial protocol setup and padding message for state 's' to the evbuffer 'buf'. Return 0 on success, -1 on failure. */ static int @@ -565,6 +578,9 @@ obfs2_recv(void *s, struct evbuffer *source, return crypt_and_transmit(state->recv_crypto, source, dest); } +/** + Frees obfs2 state 's' +*/ static void obfs2_state_free(void *s) {

1 0

[obfsproxy/master] Code quality improvements.
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit 4bfd04672ac0c3bc04ac89edf7856421e343bfe4 Author: George Kadianakis <desnacked(a)gmail.com> Date: Sun Jun 5 23:52:31 2011 +0200 Code quality improvements. * Fixed a small bug. * Updated documentation in protocol.c. --- src/main.c | 3 +++ src/protocol.c | 44 +++++++++++++++++++++++++++++++++----------- 2 files changed, 36 insertions(+), 11 deletions(-) diff --git a/src/main.c b/src/main.c index 7b67988..cb70c44 100644 --- a/src/main.c +++ b/src/main.c @@ -162,6 +162,9 @@ main(int argc, const char **argv) /* This is the number of options of this protocol. */ n_options = end-start+1; + if (start >= end) + usage(); + /* First option should be protocol_name. See if we support it. */ if (!is_supported_protocol(argv[start])) { printf("We don't support crappy protocols, son.\n"); diff --git a/src/protocol.c b/src/protocol.c index 1c93150..57c0c23 100644 --- a/src/protocol.c +++ b/src/protocol.c @@ -9,33 +9,37 @@ #include "protocols/obfs2.h" #include "protocols/dummy.h" +/** + All supported protocols should be put in this array. + It's used by main.c. +*/ char *supported_protocols[] = { "obfs2", "dummy" }; int n_supported_protocols = 2; /** - This function initializes <protocol>. - It's called once in the runtime of the program for each proto. + 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. */ int set_up_protocol(int n_options, char **options, struct protocol_params_t *params) { - char **name = options; - while (!strncmp(*name,"--",2)) - name++; - if (!strcmp(*name,"dummy")) + if (!strcmp(*options,"dummy")) return dummy_init(n_options, options, params); - else if (!strcmp(*name,"obfs2")) + else if (!strcmp(*options,"obfs2")) return obfs2_init(n_options, options, params); else return -1; } /** - This function creates a protocol object. It's called once - for every connection. It creates a new protocol_t structure - and fills it's vtable etc. - Return the protocol_t if successful, NULL otherwise. + This function creates a protocol object. + It's called once per connection. + It creates a new protocol_t structure and fills it's vtable etc. + Return a 'protocol_t' if successful, NULL otherwise. */ struct protocol_t * proto_new(protocol_params_t *params) { @@ -51,6 +55,10 @@ proto_new(protocol_params_t *params) { return proto->state ? proto : NULL; } +/** + This function does the protocol handshake. + Not all protocols have a handshake. +*/ int proto_handshake(struct protocol_t *proto, void *buf) { assert(proto); @@ -60,6 +68,9 @@ proto_handshake(struct protocol_t *proto, void *buf) { return 0; } +/** + This function is responsible for sending protocol data. +*/ int proto_send(struct protocol_t *proto, void *source, void *dest) { assert(proto); @@ -69,6 +80,9 @@ proto_send(struct protocol_t *proto, void *source, void *dest) { return -1; } +/** + This function is responsible for receiving protocol data. +*/ int proto_recv(struct protocol_t *proto, void *source, void *dest) { assert(proto); @@ -78,6 +92,10 @@ proto_recv(struct protocol_t *proto, void *source, void *dest) { return -1; } +/** + This function destroys 'proto'. + It's called everytime we close a connection. +*/ void proto_destroy(struct protocol_t *proto) { assert(proto); @@ -89,6 +107,10 @@ proto_destroy(struct protocol_t *proto) { free(proto); } +/** + This function destroys 'params'. + It's called everytime we free a listener. +*/ void proto_params_free(protocol_params_t *params) {

1 0