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

[obfsproxy/master] Updated HACKING with logging subsystem info.
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit 43cb2ba31079ebcb494439fa9b9b584b5ee16970 Author: George Kadianakis <desnacked(a)gmail.com> Date: Thu Jun 9 17:04:04 2011 +0200 Updated HACKING with logging subsystem info. --- doc/HACKING | 3 +++ 1 files changed, 3 insertions(+), 0 deletions(-) diff --git a/doc/HACKING b/doc/HACKING index 88bccb9..c9197fb 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -37,6 +37,9 @@ obfsproxy currently provides the following functions for protocols according to your protocol. Note that (*handshake) and (*destroy) are optional. +For all your logging needs you can use the functions log_{warn,info,debug} +defined in src/util.h. + [1]: For example: 'your_protocol --additional-parameter=yes server 127.0.0.1:666' [2]: For example setting up the crypto subsystem. You shouldn't be

1 0

[obfsproxy/master] Merge remote-tracking branch 'asn/bug3288'
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit e3797338e090795b5b11452dc88d318ab375eb1d Merge: 2d17ad7 43cb2ba Author: Nick Mathewson <nickm(a)torproject.org> Date: Fri Jun 10 15:44:06 2011 -0400 Merge remote-tracking branch 'asn/bug3288' doc/HACKING | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 46 insertions(+), 0 deletions(-)

1 0

[obfsproxy/master] Added HACKING.
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit 30c330e51fb647e07118d3d71fcec0be602ab9c5 Author: George Kadianakis <desnacked(a)gmail.com> Date: Tue Jun 7 02:17:04 2011 +0200 Added HACKING. --- doc/HACKING | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 43 insertions(+), 0 deletions(-) diff --git a/doc/HACKING b/doc/HACKING new file mode 100644 index 0000000..88bccb9 --- /dev/null +++ b/doc/HACKING @@ -0,0 +1,43 @@ + obfproxy codebase tour + +main.[ch] - entry point +network.[ch] - network functions +protocol.[ch] - protocol abstraction layer +socks.[ch] - SOCKS server +util.[ch] - utility functions +protocols/ - protocol specific files + + DIY pluggable transports + +Everything starts from protocol.c:set_up_protocol(), that's where your +protocol's init function is called. + +Init function: + Your protocol's init function must parse the cli protocol line [1] and + fill the protocol_params_t struct appropriately. It should also do + anything else you want to do only once for the runtime of your + protocol [2]. Finally and most importantly each protocol has a + function table and your init function should populate it. + +obfsproxy currently provides the following functions for protocols +(protocol.h:protocol_vtable): + (*create): Where you fill the protocol_params_t struct and + create a protocol state if you feel like it. + Called for every connection. + (*destroy): Where you free the protocol state and anything + else you might have created. + Called for every connection. + (*handshake): Where you send a handshake message to the + other party. + Called right after the listener is created + and the necessary network stuff are set up. + (*send): Where you specify how the data is send according to + your protocol. + (*recv): Where you specify how the data is received + according to your protocol. +Note that (*handshake) and (*destroy) are optional. + +[1]: For example: + 'your_protocol --additional-parameter=yes server 127.0.0.1:666' +[2]: For example setting up the crypto subsystem. You shouldn't be + doing this for every connection, just once is enough.

1 0

[obfsproxy/master] Silence the noisy unit test.
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit 2d17ad70d83992a10038aaa30a85cd19df53055a Author: Nick Mathewson <nickm(a)torproject.org> Date: Fri Jun 10 15:39:19 2011 -0400 Silence the noisy unit test. --- src/protocols/obfs2.c | 4 ++-- src/test/unittest_obfs2.c | 5 +++++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/src/protocols/obfs2.c b/src/protocols/obfs2.c index b24bf05..d84d3ae 100644 --- a/src/protocols/obfs2.c +++ b/src/protocols/obfs2.c @@ -160,7 +160,7 @@ parse_and_set_options(int n_options, char **options, static void usage(void) { - printf("You failed at creating a correct obfs2 line.\n" + log_warn("You failed at creating a correct obfs2 line.\n" "obfs2 syntax:\n" "\tobfs2 [obfs2_args] obfs2_opts\n" "\t'obfs2_opts':\n" @@ -171,7 +171,7 @@ usage(void) "\t\tShared Secret ~ --shared-secret=<secret>\n" "\tExample:\n" "\tobfsproxy --dest=127.0.0.1:666 --shared-secret=himitsu " - "\tobfs2 server 127.0.0.1:1026\n"); + "\tobfs2 server 127.0.0.1:1026"); } /** diff --git a/src/test/unittest_obfs2.c b/src/test/unittest_obfs2.c index 1348c7d..dd51762 100644 --- a/src/test/unittest_obfs2.c +++ b/src/test/unittest_obfs2.c @@ -30,6 +30,9 @@ test_proto_option_parsing(void *data) char *options[] = {"obfs2", "--shared-secret=a", "socks", "127.0.0.1:0"}; int n_options = 4; + /* Suppress logs for the duration of this function. */ + log_set_method(LOG_METHOD_NULL, NULL); + tt_assert(set_up_protocol(n_options, options, proto_params) == 1); @@ -99,6 +102,8 @@ test_proto_option_parsing(void *data) end: if (proto_params) free(proto_params); + /* Unsuspend logging */ + log_set_method(LOG_METHOD_STDOUT, NULL); } /* Make sure we can successfully set up a protocol state */

1 0

[obfsproxy/master] Remove an extraneous newline at the end of a log message
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit 6b2249034b7381c42fd39bf109b58c7e1b93c84d Author: Nick Mathewson <nickm(a)torproject.org> Date: Fri Jun 10 15:34:13 2011 -0400 Remove an extraneous newline at the end of a log message --- src/main.c | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/src/main.c b/src/main.c index 0c3227e..cebf14b 100644 --- a/src/main.c +++ b/src/main.c @@ -342,7 +342,7 @@ main(int argc, const char **argv) if (n_listeners) event_base_dispatch(base); - log_info("Exiting.\n"); + log_info("Exiting."); if (close_obfsproxy_logfile() < 0) printf("Failed closing logfile!\n");

1 0

[obfsproxy/master] cleanups and tweaks on logging
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit 01c29282a94241121c0890279e007becfe6f99bd Author: Nick Mathewson <nickm(a)torproject.org> Date: Fri Jun 10 15:26:19 2011 -0400 cleanups and tweaks on logging The macro syntax originally used here is a gcc extension; let's also support the c99 version and a fallback to declaring this stuff as function. Also, let's use the __attribute__((format)) feature in GCC so that we can learn about type mismatches earlier. Also, make more functions const. --- src/util.c | 66 ++++++++++++++++++++++++++++++++++++++++++++++++----------- src/util.h | 32 +++++++++++++++++++++++----- 2 files changed, 79 insertions(+), 19 deletions(-) diff --git a/src/util.c b/src/util.c index 6ff337f..976dd59 100644 --- a/src/util.c +++ b/src/util.c @@ -24,9 +24,9 @@ static const char *sev_to_string(int severity); static int sev_is_valid(int severity); static int write_logfile_prologue(int fd); static int compose_logfile_prologue(char *buf, size_t buflen); -static int string_to_sev(char *string); -static int open_and_set_obfsproxy_logfile(char *filename); - +static int string_to_sev(const char *string); +static int open_and_set_obfsproxy_logfile(const char *filename); +static void logv(int severity, const char *format, va_list ap); /************************ Obfsproxy Network Routines *************************/ @@ -182,7 +182,7 @@ sev_to_string(int severity) /** If 'string' is a valid log severity, return the corresponding * numeric value. Otherwise, return -1. */ static int -string_to_sev(char *string) +string_to_sev(const char *string) { if (!strcasecmp(string, "warn")) return LOG_SEV_WARN; @@ -212,7 +212,7 @@ sev_is_valid(int severity) It returns 1 on success and -1 on fail. */ int -log_set_method(int method, char *filename) +log_set_method(int method, const char *filename) { logging_method = method; @@ -230,7 +230,7 @@ log_set_method(int method, char *filename) On success it returns 1, on fail it returns -1. */ static int -open_and_set_obfsproxy_logfile(char *filename) +open_and_set_obfsproxy_logfile(const char *filename) { if (!filename) return -1; @@ -291,7 +291,7 @@ compose_logfile_prologue(char *buf, size_t buflen) not a valid severity, it returns -1. */ int -log_set_min_severity(char* sev_string) { +log_set_min_severity(const char* sev_string) { int severity = string_to_sev(sev_string); if (!sev_is_valid(severity)) { log_warn("Severity '%s' makes no sense.", sev_string); @@ -301,7 +301,7 @@ log_set_min_severity(char* sev_string) { return 1; } -/** +/** Logging function of obfsproxy. Don't call this directly; use the log_* macros defined in util.h instead. @@ -313,6 +313,18 @@ log_set_min_severity(char* sev_string) { void log_fn(int severity, const char *format, ...) { + + va_list ap; + va_start(ap,format); + + logv(severity, format, ap); + + va_end(ap); +} + +static void +logv(int severity, const char *format, va_list ap) +{ assert(sev_is_valid(severity)); if (logging_method == LOG_METHOD_NULL) @@ -328,9 +340,6 @@ log_fn(int severity, const char *format, ...) size_t buflen = MAX_LOG_ENTRY-2; - va_list ap; - va_start(ap,format); - r = obfs_snprintf(buf, buflen, "[%s] ", sev_to_string(severity)); if (r < 0) n = strlen(buf); @@ -351,8 +360,6 @@ log_fn(int severity, const char *format, ...) buf[n]='\n'; buf[n+1]='\0'; - - va_end(ap); if (logging_method == LOG_METHOD_STDOUT) fprintf(stdout, "%s", buf); @@ -363,3 +370,36 @@ log_fn(int severity, const char *format, ...) } else assert(0); } + +#ifdef NEED_LOG_WRAPPERS +void +log_info(const char *format, ...) +{ + va_list ap; + va_start(ap,format); + + logv(LOG_SEV_INFO, format, ap); + + va_end(ap); +} +void +log_warn(const char *format, ...) +{ + va_list ap; + va_start(ap,format); + + logv(LOG_SEV_WARN, format, ap); + + va_end(ap); +} +void +log_debug(const char *format, ...) +{ + va_list ap; + va_start(ap,format); + + logv(LOG_SEV_DEBUG, format, ap); + + va_end(ap); +} +#endif diff --git a/src/util.h b/src/util.h index e62e730..af3cd88 100644 --- a/src/util.h +++ b/src/util.h @@ -43,21 +43,41 @@ int init_evdns_base(struct event_base *base); /** Any size_t larger than this amount is likely to be an underflow. */ #define SIZE_T_CEILING ((size_t)(SSIZE_T_MAX-16)) -int obfs_vsnprintf(char *str, size_t size, +#ifndef __GNUC__ +#define __attribute__(x) +#endif + +int obfs_vsnprintf(char *str, size_t size, const char *format, va_list args); -int obfs_snprintf(char *str, size_t size, - const char *format, ...); +int obfs_snprintf(char *str, size_t size, + const char *format, ...) + __attribute__((format(printf, 3, 4))); /***** Logging subsystem stuff. *****/ -void log_fn(int severity, const char *format, ...); -int log_set_method(int method, char *filename); -int log_set_min_severity(char* sev_string); +void log_fn(int severity, const char *format, ...) + __attribute__((format(printf, 2, 3))); +int log_set_method(int method, const char *filename); +int log_set_min_severity(const char* sev_string); int close_obfsproxy_logfile(void); +#ifdef __GNUC__ #define log_info(args...) log_fn(LOG_SEV_INFO, args) #define log_warn(args...) log_fn(LOG_SEV_WARN, args) #define log_debug(args...) log_fn(LOG_SEV_DEBUG, args) +#elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L +#define log_info(...) log_fn(LOG_SEV_INFO, __VA_ARGS__) +#define log_warn(...) log_fn(LOG_SEV_WARN, __VA_ARGS__) +#define log_debug(...) log_fn(LOG_SEV_DEBUG, __VA_ARGS__) +#else +#define NEED_LOG_WRAPPERS +void log_info(const char *format, ...) + __attribute__((format(printf, 1, 2))); +void log_warn(const char *format, ...) + __attribute__((format(printf, 1, 2))); +void log_debug(const char *format, ...) + __attribute__((format(printf, 1, 2))); +#endif /** Logging methods */

1 0

[obfsproxy/master] Have autoconf tell us SIZEOF_SIZE_T
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit 7c2865fa821bd47bc8b831581b438b03e71d3740 Author: Nick Mathewson <nickm(a)torproject.org> Date: Fri Jun 10 15:08:45 2011 -0400 Have autoconf tell us SIZEOF_SIZE_T --- configure.ac | 2 ++ src/util.h | 9 ++++----- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/configure.ac b/configure.ac index faf57a7..da838db 100644 --- a/configure.ac +++ b/configure.ac @@ -17,6 +17,8 @@ PKG_CHECK_MODULES([openssl], [openssl >= 0.9.7]) # We don't need -lssl, only -lcrypto openssl_LIBS=`echo "$openssl_LIBS" | $SED -e 's/-lssl//'` +AC_CHECK_SIZEOF(size_t) + AC_CONFIG_FILES([Makefile]) AC_OUTPUT diff --git a/src/util.h b/src/util.h index a48f7d8..e62e730 100644 --- a/src/util.h +++ b/src/util.h @@ -5,11 +5,13 @@ in all redistributed copies and derived works. There is no warranty. */ +#ifndef UTIL_H +#define UTIL_H + /* va_list definition */ #include <stdarg.h> -#ifndef UTIL_H -#define UTIL_H +#include "config.h" struct sockaddr_storage; struct event_base; @@ -29,9 +31,6 @@ int init_evdns_base(struct event_base *base); /***** String functions stuff. *****/ /* The sizeof a size_t, as computed by sizeof. */ -#ifndef SIZEOF_SIZE_T -#define SIZEOF_SIZE_T 4 -#endif #ifndef SSIZE_T_MAX #if (SIZEOF_SIZE_T == 4) #define SSIZE_T_MAX INT32_MAX

1 0

[obfsproxy/master] Added obfsproxy argument handling so that the user can configure logging.
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit 076555d5f5790ce831125273f1003e08e96a69ba Author: George Kadianakis <desnacked(a)gmail.com> Date: Thu Jun 9 23:24:32 2011 +0200 Added obfsproxy argument handling so that the user can configure logging. --- src/main.c | 124 +++++++++++++++++++++++++++++++++++++++++++++-------------- 1 files changed, 94 insertions(+), 30 deletions(-) diff --git a/src/main.c b/src/main.c index 8617bb3..0c3227e 100644 --- a/src/main.c +++ b/src/main.c @@ -25,6 +25,7 @@ #define MAXPROTOCOLS 20 static void usage(void) __attribute__((noreturn)); +static int handle_obfsproxy_args(const char **argv); /* protocol.c */ extern char *supported_protocols[]; @@ -39,12 +40,15 @@ usage(void) int i; fprintf(stderr, "Usage: obfsproxy protocol_name [protocol_args] protocol_options %s protocol_name ...\n" - "Available protocols:", + "* Available protocols:\n", SEPARATOR); /* this is awful. */ for (i=0;i<n_supported_protocols;i++) - fprintf(stderr," [%s]", supported_protocols[i]); - fprintf(stderr,"\n"); + fprintf(stderr,"[%s] ", supported_protocols[i]); + fprintf(stderr, "\n* Available arguments:\n" + "--log-file=<file> ~ set logfile\n" + "--log-min-severity=warn|info|debug ~ set minimum logging severity\n" + "--no-log ~ disable logging\n"); exit(1); } @@ -59,6 +63,7 @@ handle_signal_cb(evutil_socket_t fd, short what, void *arg) struct event_base *base = arg; /* int signum = (int) fd; */ + log_info("Caught SIGINT."); event_base_loopexit(base, NULL); } @@ -91,7 +96,63 @@ is_supported_protocol(const char *name) { return 0; } -#define STUPID_BEAUTIFIER "===========================\n" +/** + Receives argv[1] as 'argv' and scans from thereafter 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. + If it fails, it exits obfsproxy. +*/ +static int +handle_obfsproxy_args(const char **argv) +{ + int logmethod_set=0; + int logsev_set=0; + int i=0; + + while (argv[i] && + !strncmp(argv[i],"--",2)) { + if (!strncmp(argv[i], "--log-file=", 11)) { + if (logmethod_set) { + log_warn("You've already set a log file!"); + exit(1); + } + if (log_set_method(LOG_METHOD_FILE, + (char *)argv[i]+11) < 0) { + log_warn("Failed creating logfile."); + exit(1); + } + logmethod_set=1; + } else if (!strncmp(argv[i], "--log-min-severity=", 19)) { + if (logsev_set) { + log_warn("You've already set a min. log severity!"); + exit(1); + } + if (log_set_min_severity((char *)argv[i]+19) < 0) { + log_warn("Error at setting logging severity"); + exit(1); + } + logsev_set=1; + } else if (!strncmp(argv[i], "--no-log", 9)) { + if (logsev_set) { + printf("You've already set a min. log severity!\n"); + exit(1); + } + if (log_set_method(LOG_METHOD_NULL, NULL) < 0) { + printf("Error at setting logging severity.\n"); + exit(1); + } + logsev_set=1; + } else { + log_warn("Unrecognizable obfsproxy argument '%s'", argv[i]); + exit(1); + } + i++; + } + + return i; +} int main(int argc, const char **argv) @@ -128,19 +189,24 @@ main(int argc, const char **argv) options for each protocol. */ unsigned int *protocols=NULL; - if (argc < 2) { usage(); } + /** "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 = malloc(sizeof(int)*(n_protocols+1)); if (!protocols) exit(1); - protocols[0] = 0; + protocols[0] = start_of_protocols; /* Populate protocols and calculate n_protocols. */ - for (i=0;i<argc;i++) { + for (i=protocols[0];i<argc;i++) { if (!strcmp(argv[i],SEPARATOR)) { protocols[n_protocols] = i; n_protocols++; @@ -154,11 +220,11 @@ main(int argc, const char **argv) protocols[n_protocols] = argc; - if (n_protocols > 1) - dbg(("Found %d protocols.\n", n_protocols)); + log_debug("Found %d protocol(s).", n_protocols); /* 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. */ @@ -166,12 +232,14 @@ main(int argc, const char **argv) /* This is the number of options of this protocol. */ n_options = end-start+1; - if (start >= end) - usage(); + if (start >= end) { + log_warn("No protocol options were given on protocol %d.", i+1); + continue; + } /* First option should be protocol_name. See if we support it. */ if (!is_supported_protocol(argv[start])) { - printf("We don't support protocol: %s\n", argv[start]); + log_warn("We don't support protocol: %s", argv[start]); continue; } @@ -214,13 +282,13 @@ main(int argc, const char **argv) /* Initialize libevent */ base = event_base_new(); if (!base) { - fprintf(stderr, "Can't initialize Libevent; failing\n"); + log_warn("Can't initialize Libevent; failing"); 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"); + log_warn("Can't initialize evdns; failing"); return 1; } @@ -229,7 +297,7 @@ main(int argc, const char **argv) sigevent = evsignal_new(base, SIGINT, handle_signal_cb, (void*) base); if (event_add(sigevent,NULL)) { - printf("We can't even add events for signals! Exiting.\n"); + log_warn("We can't even add events for signals! Exiting."); return 1; } @@ -241,11 +309,7 @@ main(int argc, const char **argv) protocol_params_t *proto_params=NULL; for (h=0;h<actual_protocols;h++) { - if (n_protocols > 1) { - dbg((STUPID_BEAUTIFIER - "Spawning listener %d!\n" - STUPID_BEAUTIFIER, h+1)); - } + log_debug("Spawning listener %d!", h+1); /** normally free'd in listener_free() */ proto_params = calloc(1, sizeof(protocol_params_t)); @@ -263,24 +327,26 @@ main(int argc, const char **argv) if (!temp_listener) continue; - dbg(("Succesfully created listener.\n")); + log_info("Succesfully created listener %d.", h+1); listeners[n_listeners] = temp_listener; n_listeners++; } - if (n_protocols > 1) { - dbg((STUPID_BEAUTIFIER - "From the original %d protocols only %d were parsed from main.c. " - "In the end only %d survived.\n\nStarting up...\n" - STUPID_BEAUTIFIER, - n_protocols, actual_protocols,n_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); /* run the event loop if at least a listener was created. */ if (n_listeners) event_base_dispatch(base); + log_info("Exiting.\n"); + + if (close_obfsproxy_logfile() < 0) + printf("Failed closing logfile!\n"); + /* We are exiting. Clean everything. */ for (h=0;h<n_listeners;h++) listener_free(listeners[h]); @@ -290,5 +356,3 @@ main(int argc, const char **argv) return 0; } - -#undef STUPID_BEAUTIFIER

1 0

[obfsproxy/master] Replaced dbg/printf with log_* functions.
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit 4a339aa90d778b6beec85119058ada5fd8f53bd9 Author: George Kadianakis <desnacked(a)gmail.com> Date: Thu Jun 9 23:25:18 2011 +0200 Replaced dbg/printf with log_* functions. --- src/network.c | 22 +++++++++++----------- src/protocols/dummy.c | 2 +- src/protocols/obfs2.c | 27 ++++++++++++++------------- src/socks.c | 24 ++++++++++++------------ 4 files changed, 38 insertions(+), 37 deletions(-) diff --git a/src/network.c b/src/network.c index 76c4ef2..f2410ce 100644 --- a/src/network.c +++ b/src/network.c @@ -67,6 +67,7 @@ listener_new(struct event_base *base, lsn->proto_params->on_address_len); if (!lsn->listener) { + log_warn("Failed to create listener!"); listener_free(lsn); return NULL; } @@ -95,13 +96,13 @@ simple_listener_cb(struct evconnlistener *evcl, if (!conn) goto err; - dbg(("Got a connection\n")); + log_debug("Got a connection"); conn->mode = lsn->proto_params->mode; conn->proto = proto_new(lsn->proto_params); if (!conn->proto) { - printf("Creation of protocol object failed! Closing connection.\n"); + log_warn("Creation of protocol object failed! Closing connection."); goto err; } @@ -209,7 +210,6 @@ socks_read_cb(struct bufferevent *bev, void *arg) enum socks_ret socks_ret; assert(bev == conn->input); /* socks must be on the initial bufferevent */ - //dbg(("Got data on the socks side (%d) \n", conn->socks_state->state)); do { enum socks_status_t status = socks_state_get_status(conn->socks_state); @@ -225,7 +225,7 @@ socks_read_cb(struct bufferevent *bev, void *arg) get_evdns_base(), af, addr, port); bufferevent_enable(conn->output, EV_READ|EV_WRITE); - dbg(("socket_connect_hostname said %d! (%s,%d)\n", r, addr, port)); + log_debug("socket_connect_hostname said %d! (%s,%d)", r, addr, port); if (r < 0) { /* XXXX send socks reply */ @@ -263,7 +263,7 @@ plaintext_read_cb(struct bufferevent *bev, void *arg) struct bufferevent *other; other = (bev == conn->input) ? conn->output : conn->input; - dbg(("Got data on plaintext side\n")); + log_debug("Got data on plaintext side"); if (proto_send(conn->proto, bufferevent_get_input(bev), bufferevent_get_output(other)) < 0) @@ -278,7 +278,7 @@ obfuscated_read_cb(struct bufferevent *bev, void *arg) other = (bev == conn->input) ? conn->output : conn->input; enum recv_ret r; - dbg(("Got data on encrypted side\n")); + log_debug("Got data on encrypted side"); r = proto_recv(conn->proto, bufferevent_get_input(bev), bufferevent_get_output(other)); @@ -295,7 +295,7 @@ static void error_or_eof(conn_t *conn, struct bufferevent *bev_err, struct bufferevent *bev_flush) { - dbg(("error_or_eof\n")); + log_debug("error_or_eof"); if (conn->flushing || ! conn->is_open || 0 == evbuffer_get_length(bufferevent_get_output(bev_flush))) { @@ -321,7 +321,7 @@ input_event_cb(struct bufferevent *bev, short what, void *arg) assert(bev == conn->input); if (what & (BEV_EVENT_EOF|BEV_EVENT_ERROR)) { - printf("Got error: %s\n", + log_warn("Got error: %s", evutil_socket_error_to_string(EVUTIL_SOCKET_ERROR())); error_or_eof(conn, bev, conn->output); } @@ -345,7 +345,7 @@ output_event_cb(struct bufferevent *bev, short what, void *arg) if ((conn->mode == LSN_SOCKS_CLIENT) && (conn->socks_state) && (socks_state_get_status(conn->socks_state) == ST_HAVE_ADDR)) { - dbg(("Connection failed\n")); + log_debug("Connection failed") ; /* Enable EV_WRITE so that we can send the response. Disable EV_READ so that we don't get more stuff from the client. */ bufferevent_enable(conn->input, EV_WRITE); @@ -364,7 +364,7 @@ output_event_cb(struct bufferevent *bev, short what, void *arg) this connection soon. */ if (conn->flushing || (what & (BEV_EVENT_EOF|BEV_EVENT_ERROR))) { - printf("Got error: %s\n", + log_warn("Got error: %s", evutil_socket_error_to_string(EVUTIL_SOCKET_ERROR())); error_or_eof(conn, bev, conn->input); return; @@ -380,7 +380,7 @@ output_event_cb(struct bufferevent *bev, short what, void *arg) if (what & BEV_EVENT_CONNECTED) { /* woo, we're connected. Now the input buffer can start reading. */ conn->is_open = 1; - dbg(("Connection done\n")); + log_debug("Connection done") ; bufferevent_enable(conn->input, EV_READ|EV_WRITE); if (conn->mode == LSN_SOCKS_CLIENT) { struct sockaddr_storage ss; diff --git a/src/protocols/dummy.c b/src/protocols/dummy.c index 71b3313..bbda22f 100644 --- a/src/protocols/dummy.c +++ b/src/protocols/dummy.c @@ -81,7 +81,7 @@ parse_and_set_options(int n_options, char **options, if (resolve_address_port(options[2], 1, 1, &ss_listen, &sl_listen, defport) < 0) { - printf("addr\n"); + log_warn("addr"); return -1; } assert(sl_listen <= sizeof(struct sockaddr_storage)); diff --git a/src/protocols/obfs2.c b/src/protocols/obfs2.c index edfc365..b24bf05 100644 --- a/src/protocols/obfs2.c +++ b/src/protocols/obfs2.c @@ -25,7 +25,7 @@ static void obfs2_state_free(void *state); static int obfs2_send_initial_message(void *state, struct evbuffer *buf); static int obfs2_send(void *state, - struct evbuffer *source, struct evbuffer *dest); + struct evbuffer *source, struct evbuffer *dest); static enum recv_ret obfs2_recv(void *state, struct evbuffer *source, struct evbuffer *dest); static void *obfs2_state_new(protocol_params_t *params); @@ -75,7 +75,7 @@ parse_and_set_options(int n_options, char **options, const char* defport; if ((n_options < 3) || (n_options > 5)) { - printf("wrong options number: %d\n", n_options); + log_warn("%s(): wrong options number: %d", __func__, n_options); return -1; } @@ -107,7 +107,7 @@ parse_and_set_options(int n_options, char **options, params->shared_secret_len = strlen(*options+16); got_ss=1; } else { - printf("Unknown argument.\n"); + log_warn("%s(): Unknown argument.", __func__); return -1; } options++; @@ -123,7 +123,7 @@ parse_and_set_options(int n_options, char **options, defport = "11253"; /* 2bf5 */ params->mode = LSN_SIMPLE_SERVER; } else { - printf("only client/socks/server modes supported.\n"); + log_warn("%s(): only client/socks/server modes supported.", __func__); return -1; } options++; @@ -141,15 +141,16 @@ parse_and_set_options(int n_options, char **options, /* Validate option selection. */ if (got_dest && (params->mode == LSN_SOCKS_CLIENT)) { - printf("You can't be on socks mode and have --dest.\n"); + log_warn("%s(): You can't be on socks mode and have --dest.", __func__); return -1; } if (!got_dest && (params->mode != LSN_SOCKS_CLIENT)) { - printf("client/server mode needs --dest.\n"); + log_warn("%s(): client/server mode needs --dest.", __func__); return -1; } + log_debug("%s(): Parsed obfs2 options nicely!", __func__); return 1; } @@ -159,7 +160,7 @@ parse_and_set_options(int n_options, char **options, static void usage(void) { - printf("You failed at creating an understandable command.\n" + printf("You failed at creating a correct obfs2 line.\n" "obfs2 syntax:\n" "\tobfs2 [obfs2_args] obfs2_opts\n" "\t'obfs2_opts':\n" @@ -430,7 +431,7 @@ crypt_and_transmit(crypt_t *crypto, return 0; stream_crypt(crypto, data, n); evbuffer_add(dest, data, n); - dbg(("Processed %d bytes.", n)); + log_debug("%s(): Processed %d bytes.", __func__, n); } } @@ -563,7 +564,7 @@ obfs2_recv(void *s, struct evbuffer *source, /* Fall through here: if there is padding data waiting on the buffer, pull it off immediately. */ - dbg(("Received key, expecting %d bytes of padding\n", plength)); + log_debug("%s(): Received key, expecting %d bytes of padding", __func__, plength); } /* If we have pending data to send, we set the return code @@ -583,15 +584,15 @@ obfs2_recv(void *s, struct evbuffer *source, n = evbuffer_get_length(source); evbuffer_drain(source, n); state->padding_left_to_read -= n; - dbg(("Received %d bytes of padding; %d left to read\n", n, - state->padding_left_to_read)); + log_debug("%s(): Received %d bytes of padding; %d left to read", + __func__, n, state->padding_left_to_read); } /* Okay; now we're definitely open. Process whatever data we have. */ state->state = ST_OPEN; - dbg(("Processing %d bytes data onto destination buffer\n", - (int) evbuffer_get_length(source))); + log_debug("%s(): Processing %d bytes data onto destination buffer", + __func__, (int) evbuffer_get_length(source)); crypt_and_transmit(state->recv_crypto, source, dest); if (r != RECV_SEND_PENDING) diff --git a/src/socks.c b/src/socks.c index 6266503..626ba88 100644 --- a/src/socks.c +++ b/src/socks.c @@ -129,7 +129,7 @@ socks5_handle_request(struct evbuffer *source, struct parsereq *parsereq) unsigned int buflength = evbuffer_get_length(source); if (buflength < SIZEOF_SOCKS5_STATIC_REQ+1) { - printf("socks: request packet is too small (1).\n"); + log_debug("socks: request packet is too small (1)."); return SOCKS_INCOMPLETE; } @@ -144,7 +144,7 @@ socks5_handle_request(struct evbuffer *source, struct parsereq *parsereq) p[1] = Command field p[2] = Reserved field */ if (p[0] != SOCKS5_VERSION || p[2] != 0x00) { - printf("socks: Corrupted packet. Discarding.\n"); + log_debug("socks: Corrupted packet. Discarding."); goto err; } @@ -171,13 +171,13 @@ socks5_handle_request(struct evbuffer *source, struct parsereq *parsereq) /* as above, but we also have the addrlen field byte */ break; default: - printf("socks: Address type not supported. Go away.\n"); + log_debug("socks: Address type not supported. Go away."); goto err; } int minsize = SIZEOF_SOCKS5_STATIC_REQ + addrlen + extralen + 2; if (buflength < minsize) { - printf("socks: request packet too small %d:%d (2)\n", buflength, minsize); + log_debug("socks: request packet too small %d:%d (2)", buflength, minsize); return SOCKS_INCOMPLETE; } @@ -304,7 +304,7 @@ socks5_handle_negotiation(struct evbuffer *source, /* XXX user controlled malloc(). range should be: 0x00-0xff */ p = malloc(nmethods); if (!p) { - printf("malloc failed!\n"); + log_warn("malloc failed!"); return SOCKS_BROKEN; } if (evbuffer_remove(source, p, nmethods) < 0) @@ -368,7 +368,7 @@ socks4_read_request(struct evbuffer *source, socks_state_t *state) return SOCKS_INCOMPLETE; /* more bytes needed */ evbuffer_copyout(source, (char*)header, 7); if (header[0] != 1) { - printf("socks: Only CONNECT supported.\n"); + log_debug("socks: Only CONNECT supported."); return SOCKS_BROKEN; } memcpy(&portnum, header+1, 2); @@ -398,7 +398,7 @@ socks4_read_request(struct evbuffer *source, socks_state_t *state) } hostname_len = end_of_hostname.pos - end_of_user.pos - 1; if (hostname_len >= sizeof(state->parsereq.addr)) { - printf("socks4a: Hostname too long\n"); + log_debug("socks4a: Hostname too long"); return SOCKS_BROKEN; } } @@ -461,7 +461,7 @@ handle_socks(struct evbuffer *source, struct evbuffer *dest, return SOCKS_BROKEN; if (evbuffer_get_length(source) < MIN_SOCKS_PACKET) { - printf("socks: Packet is too small.\n"); + log_debug("socks: Packet is too small."); return SOCKS_INCOMPLETE; } @@ -474,10 +474,10 @@ handle_socks(struct evbuffer *source, struct evbuffer *dest, evbuffer_remove(source, &socks_state->version, 1); if (socks_state->version != SOCKS5_VERSION && socks_state->version != SOCKS4_VERSION) { - printf("socks: unexpected version %d", (int)socks_state->version); + log_debug("socks: unexpected version %d", (int)socks_state->version); goto broken; } - dbg(("Got version %d\n",(int)socks_state->version)); + log_debug("Got version %d",(int)socks_state->version); } switch(socks_state->version) { @@ -560,7 +560,7 @@ socks_state_set_address(socks_state_t *state, const struct sockaddr *sa) return -1; } else if (sa->sa_family == AF_INET6) { if (state->version == 4) { - printf("Oops; socks4 doesn't allow ipv6 addresses\n"); + log_debug("Oops; socks4 doesn't allow ipv6 addresses"); return -1; } const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sa; @@ -568,7 +568,7 @@ socks_state_set_address(socks_state_t *state, const struct sockaddr *sa) if (evutil_inet_ntop(AF_INET6, &sin6->sin6_addr, state->parsereq.addr, sizeof(state->parsereq.addr)) == NULL) return -1; } else { - printf("Unknown address family %d\n", sa->sa_family); + log_debug("Unknown address family %d", sa->sa_family); return -1; }

1 0

[obfsproxy/master] Logging subsystem code.
by nickm＠torproject.org 10 Jun '11

10 Jun '11

commit 792954eb8ebc389f44c1e651c67e1dee738ba4ae Author: George Kadianakis <desnacked(a)gmail.com> Date: Thu Jun 9 23:23:57 2011 +0200 Logging subsystem code. --- src/util.c | 288 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- src/util.h | 66 ++++++++++++-- 2 files changed, 342 insertions(+), 12 deletions(-) diff --git a/src/util.c b/src/util.c index baebe10..6ff337f 100644 --- a/src/util.c +++ b/src/util.c @@ -9,9 +9,27 @@ #include <stdio.h> #include <stdlib.h> +#include <assert.h> +#include <sys/types.h> +#include <sys/stat.h> +#include <fcntl.h> +#include <unistd.h> + +#include "util.h" + #include <event2/util.h> #include <event2/dns.h> +static const char *sev_to_string(int severity); +static int sev_is_valid(int severity); +static int write_logfile_prologue(int fd); +static int compose_logfile_prologue(char *buf, size_t buflen); +static int string_to_sev(char *string); +static int open_and_set_obfsproxy_logfile(char *filename); + + +/************************ Obfsproxy Network Routines *************************/ + int resolve_address_port(const char *address, int nodns, int passive, @@ -33,7 +51,7 @@ resolve_address_port(const char *address, } else if (default_port) { portstr = default_port; } else { - fprintf(stderr, "Error in address %s: port required.\n", address); + log_debug("Error in address %s: port required.", address); goto done; } @@ -47,16 +65,16 @@ resolve_address_port(const char *address, ai_hints.ai_flags |= EVUTIL_AI_NUMERICHOST; if ((ai_res = evutil_getaddrinfo(a, portstr, &ai_hints, &ai))) { - fprintf(stderr, "Error resolving %s (%s) (%s): %s\n", - address, a, portstr, evutil_gai_strerror(ai_res)); + log_warn("Error resolving %s (%s) (%s): %s", + address, a, portstr, evutil_gai_strerror(ai_res)); goto done; } if (ai == NULL) { - fprintf(stderr, "No result for address %s\n", address); + log_warn("No result for address %s", address); goto done; } if (ai->ai_addrlen > sizeof(struct sockaddr_storage)) { - fprintf(stderr, "Result for address %s too long\n", address); + log_warn("Result for address %s too long", address); goto done; } @@ -85,3 +103,263 @@ init_evdns_base(struct event_base *base) the_evdns_base = evdns_base_new(base, 1); return the_evdns_base == NULL ? -1 : 0; } + +/************************ String Functions *************************/ +/** The functions in this section were carbon copied off tor. Thank you tor! */ + +/** Replacement for snprintf. Differs from platform snprintf in two + * ways: First, always NUL-terminates its output. Second, always + * returns -1 if the result is truncated. (Note that this return + * behavior does <i>not</i> conform to C99; it just happens to be + * easier to emulate "return -1" with conformant implementations than + * it is to emulate "return number that would be written" with + * non-conformant implementations.) */ +int +obfs_snprintf(char *str, size_t size, const char *format, ...) +{ + va_list ap; + int r; + va_start(ap,format); + r = obfs_vsnprintf(str,size,format,ap); + va_end(ap); + return r; +} + +/** Replacement for vsnprintf; behavior differs as obfs_snprintf differs from + * snprintf. + */ +int +obfs_vsnprintf(char *str, size_t size, const char *format, va_list args) +{ + int r; + if (size == 0) + return -1; /* no place for the NUL */ + if (size > SIZE_T_CEILING) + return -1; +#ifdef MS_WINDOWS + r = _vsnprintf(str, size, format, args); +#else + r = vsnprintf(str, size, format, args); +#endif + str[size-1] = '\0'; + if (r < 0 || r >= (ssize_t)size) + return -1; + return r; +} + +/************************ Logging Subsystem *************************/ +/** The code of this section was to a great extend shamelessly copied + off tor. It's basicaly a stripped down version of tor's logging + system. Thank you tor. */ + +/* Size of maximum log entry, including newline and NULL byte. */ +#define MAX_LOG_ENTRY 1024 +/* String to append when a log entry doesn't fit in MAX_LOG_ENTRY. */ +#define TRUNCATED_STR "[...truncated]" +/* strlen(TRUNCATED_STR) */ +#define TRUNCATED_STR_LEN 14 + +/* logging method */ +static int logging_method=LOG_METHOD_STDOUT; +/* minimum logging severity */ +static int logging_min_sev=LOG_SEV_INFO; +/* logfile fd */ +static int logging_logfile=-1; + +/** Helper: map a log severity to descriptive string. */ +static const char * +sev_to_string(int severity) +{ + switch (severity) { + case LOG_SEV_WARN: return "warn"; + case LOG_SEV_INFO: return "info"; + case LOG_SEV_DEBUG: return "debug"; + default: + assert(0); return "UNKNOWN"; + } +} + +/** If 'string' is a valid log severity, return the corresponding + * numeric value. Otherwise, return -1. */ +static int +string_to_sev(char *string) +{ + if (!strcasecmp(string, "warn")) + return LOG_SEV_WARN; + else if (!strcasecmp(string, "info")) + return LOG_SEV_INFO; + else if (!strcasecmp(string, "debug")) + return LOG_SEV_DEBUG; + else + return -1; +} + +/** + Returns True if 'severity' is a valid obfsproxy logging severity. + Otherwise, it returns False. +*/ +static int +sev_is_valid(int severity) +{ + return (severity == LOG_SEV_WARN || + severity == LOG_SEV_INFO || + severity == LOG_SEV_DEBUG); +} + +/** + Sets the global logging 'method' and also sets and open the logfile + 'filename' in case we want to log into a file. + It returns 1 on success and -1 on fail. +*/ +int +log_set_method(int method, char *filename) +{ + + logging_method = method; + if (method == LOG_METHOD_FILE) { + if (open_and_set_obfsproxy_logfile(filename) < 0) + return -1; + if (write_logfile_prologue(logging_logfile) < 0) + return -1; + } + return 1; +} + +/** + Helper: Opens 'filename' and sets it as the obfsproxy logfile. + On success it returns 1, on fail it returns -1. +*/ +static int +open_and_set_obfsproxy_logfile(char *filename) +{ + if (!filename) + return -1; + logging_logfile = open(filename, + O_WRONLY|O_CREAT|O_APPEND, + 0644); + if (logging_logfile < 0) + return -1; + return 1; +} + +/** + Closes the obfsproxy logfile if it exists. + Returns 0 on success or if we weren't using a logfile (that's + close()'s success return value) and -1 on failure. +*/ +int +close_obfsproxy_logfile(void) +{ + if (logging_logfile < 0) /* no logfile. */ + return 0; + else + return close(logging_logfile); +} + +/** + Writes a small prologue in the logfile 'fd' that mentions the + obfsproxy version and helps separate log instances. +*/ +static int +write_logfile_prologue(int logfile) { + char buf[256]; + if (compose_logfile_prologue(buf, sizeof(buf)) < 0) + return -1; + if (write(logfile, buf, strlen(buf)) < 0) + return -1; + return 1; +} + +#define TEMP_PROLOGUE "\nBrand new obfsproxy log:\n" +/** + Helper: Composes the logfile prologue. +*/ +static int +compose_logfile_prologue(char *buf, size_t buflen) +{ + if (obfs_snprintf(buf, buflen, TEMP_PROLOGUE) < 0) { + log_warn("Logfile prologue couldn't be written."); + return -1; + } + return 1; +} +#undef TEMP_PROLOGUE + +/** + Sets the minimum logging severity of obfsproxy to the severity + described by 'sev_string', then it returns 1. If 'sev_string' is + not a valid severity, it returns -1. +*/ +int +log_set_min_severity(char* sev_string) { + int severity = string_to_sev(sev_string); + if (!sev_is_valid(severity)) { + log_warn("Severity '%s' makes no sense.", sev_string); + return -1; + } + logging_min_sev = severity; + return 1; +} + +/** + Logging function of obfsproxy. + Don't call this directly; use the log_* macros defined in util.h + instead. + + It accepts a logging 'severity' and a 'format' string and logs the + message in 'format' according to the configured obfsproxy minimum + logging severity and logging method. +*/ +void +log_fn(int severity, const char *format, ...) +{ + assert(sev_is_valid(severity)); + + if (logging_method == LOG_METHOD_NULL) + return; + + /* See if the user is interested in this log message. */ + if (severity < logging_min_sev) + return; + + size_t n=0; + int r=0; + char buf[MAX_LOG_ENTRY]; + + size_t buflen = MAX_LOG_ENTRY-2; + + va_list ap; + va_start(ap,format); + + r = obfs_snprintf(buf, buflen, "[%s] ", sev_to_string(severity)); + if (r < 0) + n = strlen(buf); + else + n=r; + + r = obfs_vsnprintf(buf+n, buflen-n, format, ap); + if (r < 0) { + if (buflen >= TRUNCATED_STR_LEN) { + size_t offset = buflen-TRUNCATED_STR_LEN; + r = obfs_snprintf(buf+offset, TRUNCATED_STR_LEN+1, + "%s", TRUNCATED_STR); + if (r < 0) assert(0); + } + n = buflen; + } else + n+=r; + + buf[n]='\n'; + buf[n+1]='\0'; + + va_end(ap); + + if (logging_method == LOG_METHOD_STDOUT) + fprintf(stdout, "%s", buf); + else if (logging_method == LOG_METHOD_FILE) { + assert(logging_logfile); + if (write(logging_logfile, buf, strlen(buf)) < 0) + printf("%s(): Terrible write() error!!!\n", __func__); + } else + assert(0); +} diff --git a/src/util.h b/src/util.h index 69bd768..a48f7d8 100644 --- a/src/util.h +++ b/src/util.h @@ -5,10 +5,17 @@ in all redistributed copies and derived works. There is no warranty. */ +/* va_list definition */ +#include <stdarg.h> + #ifndef UTIL_H #define UTIL_H struct sockaddr_storage; +struct event_base; +struct evdns_base; + +/***** Network functions stuff. *****/ int resolve_address_port(const char *address, int nodns, int passive, @@ -16,16 +23,61 @@ int resolve_address_port(const char *address, int *addrlen_out, const char *default_port); -#ifdef DEBUG -#define dbg(x) printf x +struct evdns_base *get_evdns_base(void); +int init_evdns_base(struct event_base *base); + +/***** String functions stuff. *****/ + +/* The sizeof a size_t, as computed by sizeof. */ +#ifndef SIZEOF_SIZE_T +#define SIZEOF_SIZE_T 4 +#endif +#ifndef SSIZE_T_MAX +#if (SIZEOF_SIZE_T == 4) +#define SSIZE_T_MAX INT32_MAX +#elif (SIZEOF_SIZE_T == 8) +#define SSIZE_T_MAX INT64_MAX #else -#define dbg(x) ((void)0) +#error "Can't define SSIZE_T_MAX" +#endif #endif +/** Any size_t larger than this amount is likely to be an underflow. */ +#define SIZE_T_CEILING ((size_t)(SSIZE_T_MAX-16)) -struct event_base; -struct evdns_base; -struct evdns_base *get_evdns_base(void); -int init_evdns_base(struct event_base *base); +int obfs_vsnprintf(char *str, size_t size, + const char *format, va_list args); +int obfs_snprintf(char *str, size_t size, + const char *format, ...); + +/***** Logging subsystem stuff. *****/ + +void log_fn(int severity, const char *format, ...); +int log_set_method(int method, char *filename); +int log_set_min_severity(char* sev_string); +int close_obfsproxy_logfile(void); + +#define log_info(args...) log_fn(LOG_SEV_INFO, args) +#define log_warn(args...) log_fn(LOG_SEV_WARN, args) +#define log_debug(args...) log_fn(LOG_SEV_DEBUG, args) + +/** Logging methods */ + +/** Spit log messages on stdout. */ +#define LOG_METHOD_STDOUT 1 +/** Place log messages in a file. */ +#define LOG_METHOD_FILE 2 +/** We don't want no logs. */ +#define LOG_METHOD_NULL 3 + +/** Logging severities */ +/** Warn-level severity: for messages that only appear when something has gone wrong. */ +#define LOG_SEV_WARN 3 +/** Info-level severity: for messages that should be sent to the user + during normal operation. */ +#define LOG_SEV_INFO 2 +/** Debug-level severity: for hyper-verbose messages of no interest to + anybody but developers. */ +#define LOG_SEV_DEBUG 1 #endif

1 0