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

[tor/master] Update the "redox" doxygen/DOCDOC postprocessing script
by nickm＠torproject.org 05 Jun '12

05 Jun '12

commit b353cd7e508fd436ce4ec4bd55c52cc7619b29fd Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Jun 4 19:56:44 2012 -0400 Update the "redox" doxygen/DOCDOC postprocessing script Somewhere along the line, doxygen and tor changed their behavior a little. The script is still a dreadful kludge, but now at least it sorta works again. --- contrib/redox.py | 17 ++++++++++------- 1 files changed, 10 insertions(+), 7 deletions(-) diff --git a/contrib/redox.py b/contrib/redox.py index e18a92f..43200dd 100755 --- a/contrib/redox.py +++ b/contrib/redox.py @@ -1,6 +1,6 @@ #!/usr/bin/python # -# Copyright (c) 2008 The Tor Project, Inc. +# Copyright (c) 2008-2012 The Tor Project, Inc. # See LICENSE for licensing information. # # Hi! @@ -37,6 +37,8 @@ SKIP_FILES = [ "OpenBSD_malloc_Linux.c", "eventdns.h", "strlcat.c", "strlcpy.c", + "sha256.c", + "sha256.h", "aes.c", "aes.h" ] @@ -46,8 +48,8 @@ SKIP_NAME_PATTERNS = [ r'^.*_c_id$', # Which types of things should get DOCDOC comments added if they are # missing documentation? Recognized types are in KINDS below. -#ADD_DOCDOCS_TO_TYPES = [ 'function', 'type', 'typedef' ] -ADD_DOCDOCS_TO_TYPES = [ 'variable' ] +ADD_DOCDOCS_TO_TYPES = [ 'function', 'type', 'typedef' ] +ADD_DOCDOCS_TO_TYPES += [ 'variable', ] # ==================== # The rest of this should not need hacking. @@ -55,11 +57,12 @@ ADD_DOCDOCS_TO_TYPES = [ 'variable' ] import re import sys -KINDS = [ "type", "field", "typedef", "define", "function", "variable" ] +KINDS = [ "type", "field", "typedef", "define", "function", "variable", + "enumeration" ] NODOC_LINE_RE = re.compile(r'^([^:]+):(\d+): (\w+): (.*) is not documented\.$') -THING_RE = re.compile(r'^Member ([a-zA-Z0-9_]+).*$(typedef|define|function|variable)$ of (file|class) ') +THING_RE = re.compile(r'^Member ([a-zA-Z0-9_]+).*$(typedef|define|function|variable|enumeration)$ of (file|class) ') SKIP_NAMES = [re.compile(s) for s in SKIP_NAME_PATTERNS] @@ -72,7 +75,7 @@ def parsething(thing): else: m = THING_RE.match(thing) if not m: - print thing + print thing, "???? Format didn't match." return None, None else: name, tp, parent = m.groups() @@ -92,7 +95,7 @@ def read(): m = NODOC_LINE_RE.match(line) if m: file, line, tp, thing = m.groups() - assert tp == 'Warning' + assert tp.lower() == 'warning' name, kind = parsething(thing) errs.setdefault(file, []).append((int(line), name, kind))

1 0

[tor/master] Add about 60 more DOCDOC comments to 0.2.3
by nickm＠torproject.org 05 Jun '12

05 Jun '12

commit 173b18c79b8e1f3a28e8b4122adb2b4ccf836c7b Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Jun 4 19:51:00 2012 -0400 Add about 60 more DOCDOC comments to 0.2.3 Also, try to resolve some doxygen issues. First, define a magic "This is doxygen!" macro so that we take the correct branch in various #if/#else/#endifs in order to get the right documentation. Second, add in a few grouping @{ and @} entries in order to get some variables and fields to get grouped together. --- src/common/compat.c | 17 +++++++++++++---- src/common/compat_libevent.c | 7 +++---- src/common/compat_libevent.h | 1 + src/common/crypto.c | 4 +++- src/common/log.c | 1 + src/common/procmon.c | 3 +++ src/common/procmon.h | 1 + src/common/torlog.h | 2 +- src/common/tortls.c | 4 ++++ src/common/util.c | 3 +++ src/common/util.h | 2 ++ src/common/util_codedigest.c | 1 + src/or/buffers.c | 2 +- src/or/circuitbuild.c | 2 ++ src/or/circuitbuild.h | 2 ++ src/or/config.c | 1 + src/or/config_codedigest.c | 1 + src/or/connection.c | 5 ++++- src/or/connection.h | 4 ++++ src/or/connection_edge.c | 4 ++-- src/or/connection_or.c | 2 +- src/or/control.c | 3 +++ src/or/control.h | 2 +- src/or/directory.c | 5 +++-- src/or/dirserv.c | 1 + src/or/dirvote.c | 2 ++ src/or/dirvote.h | 1 - src/or/geoip.c | 1 + src/or/hibernate.c | 2 ++ src/or/main.c | 3 +++ src/or/microdesc.c | 2 +- src/or/networkstatus.c | 6 ++++-- src/or/onion.c | 4 +++- src/or/or.h | 1 + src/or/policies.c | 1 + src/or/relay.c | 3 +++ src/or/rendcommon.c | 1 + src/or/rephist.c | 16 ++++++++++------ src/or/router.c | 1 + src/or/routerlist.c | 7 +++++-- src/or/routerlist.h | 1 + src/or/routerparse.c | 2 ++ 42 files changed, 103 insertions(+), 31 deletions(-) diff --git a/src/common/compat.c b/src/common/compat.c index 49a4afe..ed6886c 100644 --- a/src/common/compat.c +++ b/src/common/compat.c @@ -156,7 +156,7 @@ tor_fopen_cloexec(const char *path, const char *mode) return result; } -#ifdef HAVE_SYS_MMAN_H +#if defined(HAVE_SYS_MMAN_H) || defined(RUNNING_DOXYGEN) /** Try to create a memory mapping for <b>filename</b> and return it. On * failure, return NULL. Sets errno properly, using ERANGE to mean * "empty file". */ @@ -501,10 +501,13 @@ tor_memmem(const void *_haystack, size_t hlen, #endif } -/* Tables to implement ctypes-replacement TOR_IS*() functions. Each table +/** + * Tables to implement ctypes-replacement TOR_IS*() functions. Each table * has 256 bits to look up whether a character is in some set or not. This * fails on non-ASCII platforms, but it is hard to find a platform whose * character set is not a superset of ASCII nowadays. */ + +/**@{*/ const uint32_t TOR_ISALPHA_TABLE[8] = { 0, 0, 0x7fffffe, 0x7fffffe, 0, 0, 0, 0 }; const uint32_t TOR_ISALNUM_TABLE[8] = @@ -517,8 +520,10 @@ const uint32_t TOR_ISPRINT_TABLE[8] = { 0, 0xffffffff, 0xffffffff, 0x7fffffff, 0, 0, 0, 0x0 }; const uint32_t TOR_ISUPPER_TABLE[8] = { 0, 0, 0x7fffffe, 0, 0, 0, 0, 0 }; const uint32_t TOR_ISLOWER_TABLE[8] = { 0, 0, 0, 0x7fffffe, 0, 0, 0, 0 }; -/* Upper-casing and lowercasing tables to map characters to upper/lowercase - * equivalents. */ + +/** Upper-casing and lowercasing tables to map characters to upper/lowercase + * equivalents. Used by tor_toupper() and tor_tolower(). */ +/**@{*/ const char TOR_TOUPPER_TABLE[256] = { 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15, 16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31, @@ -555,6 +560,7 @@ const char TOR_TOLOWER_TABLE[256] = { 224,225,226,227,228,229,230,231,232,233,234,235,236,237,238,239, 240,241,242,243,244,245,246,247,248,249,250,251,252,253,254,255, }; +/**@}*/ /** Helper for tor_strtok_r_impl: Advances cp past all characters in * <b>sep</b>, and returns its new value. */ @@ -1779,9 +1785,11 @@ make_path_absolute(char *fname) #ifndef HAVE__NSGETENVIRON #ifndef HAVE_EXTERN_ENVIRON_DECLARED /* Some platforms declare environ under some circumstances, others don't. */ +#ifndef RUNNING_DOXYGEN extern char **environ; #endif #endif +#endif /** Return the current environment. This is a portable replacement for * 'environ'. */ @@ -2356,6 +2364,7 @@ tor_gettimeofday(struct timeval *timeval) #define TIME_FNS_NEED_LOCKS #endif +/* DOCDOC correct_tm */ static struct tm * correct_tm(int islocal, const time_t *timep, struct tm *resultbuf, struct tm *r) diff --git a/src/common/compat_libevent.c b/src/common/compat_libevent.c index 70e3baf..e522a8f 100644 --- a/src/common/compat_libevent.c +++ b/src/common/compat_libevent.c @@ -6,9 +6,8 @@ * \brief Wrappers to handle porting between different versions of libevent. * * In an ideal world, we'd just use Libevent 2.0 from now on. But as of June - * 2009, Libevent 2.0 is still in alpha, and we will have old versions of - * Libevent for the forseeable future. - **/ + * 2012, Libevent 1.4 is still all over, and some poor souls are stuck on + * Libevent 1.3e. */ #include "orconfig.h" #include "compat.h" @@ -57,7 +56,7 @@ typedef uint32_t le_version_t; static le_version_t tor_get_libevent_version(const char **v_out); -#ifdef HAVE_EVENT_SET_LOG_CALLBACK +#if defined(HAVE_EVENT_SET_LOG_CALLBACK) || defined(RUNNING_DOXYGEN) /** A string which, if it appears in a libevent log, should be ignored. */ static const char *suppress_msg = NULL; /** Callback function passed to event_set_log() so we can intercept diff --git a/src/common/compat_libevent.h b/src/common/compat_libevent.h index 0247297..95f633a 100644 --- a/src/common/compat_libevent.h +++ b/src/common/compat_libevent.h @@ -59,6 +59,7 @@ struct timeval; int tor_event_base_loopexit(struct event_base *base, struct timeval *tv); #endif +/* DOCDOC tor_libevent_cfg */ typedef struct tor_libevent_cfg { int disable_iocp; int num_cpus; diff --git a/src/common/crypto.c b/src/common/crypto.c index 8feac95..86f19df 100644 --- a/src/common/crypto.c +++ b/src/common/crypto.c @@ -69,7 +69,7 @@ /** Longest recognized */ #define MAX_DNS_LABEL_SIZE 63 -#if OPENSSL_VERSION_NUMBER < OPENSSL_V_SERIES(0,9,8) +#if OPENSSL_VERSION_NUMBER < OPENSSL_V_SERIES(0,9,8) && !defined(RUNNING_DOXYGEN) /** @{ */ /** On OpenSSL versions before 0.9.8, there is no working SHA256 * implementation, so we use Tom St Denis's nice speedy one, slightly adapted @@ -404,6 +404,8 @@ crypto_cipher_new_with_iv(const char *key, const char *iv) return env; } +/** Return a new crypto_cipher_t with the provided <b>key</b> and an IV of all + * zero bytes. */ crypto_cipher_t * crypto_cipher_new(const char *key) { diff --git a/src/common/log.c b/src/common/log.c index f509ddc..f0384a7 100644 --- a/src/common/log.c +++ b/src/common/log.c @@ -97,6 +97,7 @@ should_log_function_name(log_domain_mask_t domain, int severity) /** A mutex to guard changes to logfiles and logging. */ static tor_mutex_t log_mutex; +/* DOCDOC log_mutex_initialized */ static int log_mutex_initialized = 0; /** Linked list of logfile_t. */ diff --git a/src/common/procmon.c b/src/common/procmon.c index 85d2a2f..4375b60 100644 --- a/src/common/procmon.c +++ b/src/common/procmon.c @@ -41,6 +41,7 @@ static void tor_process_monitor_poll_cb(evutil_socket_t unused1, short unused2, /* This struct may contain pointers into the original process * specifier string, but it should *never* contain anything which * needs to be freed. */ +/* DOCDOC parsed_process_specifier_t */ struct parsed_process_specifier_t { pid_t pid; }; @@ -81,6 +82,7 @@ parse_process_specifier(const char *process_spec, return -1; } +/* DOCDOC tor_process_monitor_t */ struct tor_process_monitor_t { /** Log domain for warning messages. */ log_domain_mask_t log_domain; @@ -152,6 +154,7 @@ tor_validate_process_specifier(const char *process_spec, #define PERIODIC_TIMER_FLAGS (0) #endif +/* DOCDOC poll_interval_tv */ static struct timeval poll_interval_tv = {15, 0}; /* Note: If you port this file to plain Libevent 2, you can make * poll_interval_tv const. It has to be non-const here because in diff --git a/src/common/procmon.h b/src/common/procmon.h index 02eb2da..3bf6044 100644 --- a/src/common/procmon.h +++ b/src/common/procmon.h @@ -14,6 +14,7 @@ typedef struct tor_process_monitor_t tor_process_monitor_t; +/* DOCDOC tor_procmon_callback_t */ typedef void (*tor_procmon_callback_t)(void *); int tor_validate_process_specifier(const char *process_spec, diff --git a/src/common/torlog.h b/src/common/torlog.h index 4c5729e..d6b21df 100644 --- a/src/common/torlog.h +++ b/src/common/torlog.h @@ -153,7 +153,7 @@ void tor_log(int severity, log_domain_mask_t domain, const char *format, ...) CHECK_PRINTF(3,4); #define log tor_log /* hack it so we don't conflict with log() as much */ -#ifdef __GNUC__ +#if defined(__GNUC__) || defined(RUNNING_DOXYGEN) extern int _log_global_min_severity; void _log_fn(int severity, log_domain_mask_t domain, diff --git a/src/common/tortls.c b/src/common/tortls.c index a069ebf..06f6450 100644 --- a/src/common/tortls.c +++ b/src/common/tortls.c @@ -225,6 +225,7 @@ static int check_cert_lifetime_internal(int severity, const X509 *cert, /** Global TLS contexts. We keep them here because nobody else needs * to touch them. */ static tor_tls_context_t *server_tls_context = NULL; +/* DOCDOC client_tls_context */ static tor_tls_context_t *client_tls_context = NULL; /** True iff tor_tls_init() has been called. */ @@ -268,6 +269,7 @@ tor_tls_get_state_description(tor_tls_t *tls, char *buf, size_t sz) tor_snprintf(buf, sz, "%s%s", ssl_state, tortls_state); } +/* DOCDOC tor_tls_log_one_error */ void tor_tls_log_one_error(tor_tls_t *tls, unsigned long err, int severity, int domain, const char *doing) @@ -1342,6 +1344,7 @@ tor_tls_client_is_using_v2_ciphers(const SSL *ssl, const char *address) return 1; } +/* DOCDOC tor_tls_debug_state_callback */ static void tor_tls_debug_state_callback(const SSL *ssl, int type, int val) { @@ -1621,6 +1624,7 @@ tor_tls_block_renegotiation(tor_tls_t *tls) tls->ssl->s3->flags &= ~SSL3_FLAGS_ALLOW_UNSAFE_LEGACY_RENEGOTIATION; } +/* DOCDOC tor_tls_assert_renegotiation_unblocked */ void tor_tls_assert_renegotiation_unblocked(tor_tls_t *tls) { diff --git a/src/common/util.c b/src/common/util.c index b3145ae..e0de262 100644 --- a/src/common/util.c +++ b/src/common/util.c @@ -3303,6 +3303,7 @@ tor_process_get_stdout_pipe(process_handle_t *process_handle) return process_handle->stdout_pipe; } #else +/* DOCDOC tor_process_get_stdout_pipe */ FILE * tor_process_get_stdout_pipe(process_handle_t *process_handle) { @@ -3310,6 +3311,7 @@ tor_process_get_stdout_pipe(process_handle_t *process_handle) } #endif +/* DOCDOC process_handle_new */ static process_handle_t * process_handle_new(void) { @@ -4289,6 +4291,7 @@ get_string_from_pipe(FILE *stream, char *buf_out, size_t count) return IO_STREAM_TERM; } +/* DOCDOC tor_check_port_forwarding */ void tor_check_port_forwarding(const char *filename, int dir_port, int or_port, time_t now) diff --git a/src/common/util.h b/src/common/util.h index ae40898..de22e18 100644 --- a/src/common/util.h +++ b/src/common/util.h @@ -72,6 +72,7 @@ /* Memory management */ void *_tor_malloc(size_t size DMALLOC_PARAMS) ATTR_MALLOC; void *_tor_malloc_zero(size_t size DMALLOC_PARAMS) ATTR_MALLOC; +/* DOCDOC _tor_malloc_roundup */ void *_tor_malloc_roundup(size_t *size DMALLOC_PARAMS) ATTR_MALLOC; void *_tor_calloc(size_t nmemb, size_t size DMALLOC_PARAMS) ATTR_MALLOC; void *_tor_realloc(void *ptr, size_t size DMALLOC_PARAMS); @@ -382,6 +383,7 @@ HANDLE load_windows_system_library(const TCHAR *library_name); int environment_variable_names_equal(const char *s1, const char *s2); +/* DOCDOC process_environment_t */ struct process_environment_t { /** A pointer to a sorted empty-string-terminated sequence of * NUL-terminated strings of the form "NAME=VALUE". */ diff --git a/src/common/util_codedigest.c b/src/common/util_codedigest.c index 88fe508..ef70954 100644 --- a/src/common/util_codedigest.c +++ b/src/common/util_codedigest.c @@ -1,6 +1,7 @@ #include "util.h" +/** DOCDOC */ const char * libor_get_digests(void) { diff --git a/src/or/buffers.c b/src/or/buffers.c index aa3e01f..cdda5f0 100644 --- a/src/or/buffers.c +++ b/src/or/buffers.c @@ -108,7 +108,7 @@ chunk_repack(chunk_t *chunk) chunk->data = &chunk->mem[0]; } -#ifdef ENABLE_BUF_FREELISTS +#if defined(ENABLE_BUF_FREELISTS) || defined(RUNNING_DOXYGEN) /** A freelist of chunks. */ typedef struct chunk_freelist_t { size_t alloc_size; /**< What size chunks does this freelist hold? */ diff --git a/src/or/circuitbuild.c b/src/or/circuitbuild.c index 82ff327..cc162f2 100644 --- a/src/or/circuitbuild.c +++ b/src/or/circuitbuild.c @@ -236,6 +236,7 @@ circuit_build_times_quantile_cutoff(void) return num/100.0; } +/* DOCDOC circuit_build_times_get_bw_scale */ int circuit_build_times_get_bw_scale(networkstatus_t *ns) { @@ -4972,6 +4973,7 @@ find_bridge_by_digest(const char *digest) return NULL; } +/* DOCDOC find_transport_name_by_bridge_addrport */ const char * find_transport_name_by_bridge_addrport(const tor_addr_t *addr, uint16_t port) { diff --git a/src/or/circuitbuild.h b/src/or/circuitbuild.h index 2ef5be8..27732da 100644 --- a/src/or/circuitbuild.h +++ b/src/or/circuitbuild.h @@ -147,6 +147,7 @@ void circuit_build_times_network_is_live(circuit_build_times_t *cbt); int circuit_build_times_network_check_live(circuit_build_times_t *cbt); void circuit_build_times_network_circ_success(circuit_build_times_t *cbt); +/* DOCDOC circuit_build_times_get_bw_scale */ int circuit_build_times_get_bw_scale(networkstatus_t *ns); void clear_transport_list(void); @@ -157,6 +158,7 @@ void transport_free(transport_t *transport); transport_t *transport_new(const tor_addr_t *addr, uint16_t port, const char *name, int socks_ver); +/* DOCDOC find_transport_name_by_bridge_addrport */ const char *find_transport_name_by_bridge_addrport(const tor_addr_t *addr, uint16_t port); diff --git a/src/or/config.c b/src/or/config.c index 81d77c3..160ee9a 100644 --- a/src/or/config.c +++ b/src/or/config.c @@ -786,6 +786,7 @@ extern const char tor_git_revision[]; /* from tor_main.c */ /** The version of this Tor process, as parsed. */ static char *the_tor_version = NULL; +/* DOCDOC the_short_tor_version */ static char *the_short_tor_version = NULL; /** Return the current Tor version. */ diff --git a/src/or/config_codedigest.c b/src/or/config_codedigest.c index be9eaa3..992e9af 100644 --- a/src/or/config_codedigest.c +++ b/src/or/config_codedigest.c @@ -1,6 +1,7 @@ const char *tor_get_digests(void); +/** DOCDOC */ const char * tor_get_digests(void) { diff --git a/src/or/connection.c b/src/or/connection.c index 3ff6a71..5d32a06 100644 --- a/src/or/connection.c +++ b/src/or/connection.c @@ -80,6 +80,7 @@ static int get_proxy_type(void); * XXX024 We should really use the entire list of interfaces here. **/ static tor_addr_t *last_interface_ipv4 = NULL; +/* DOCDOC last_interface_ipv6 */ static tor_addr_t *last_interface_ipv6 = NULL; /** A list of tor_addr_t for addresses we've used in outgoing connections. * Used to detect IP address changes. */ @@ -731,7 +732,7 @@ connection_expire_held_open(void) }); } -#ifdef HAVE_SYS_UN_H +#if defined(HAVE_SYS_UN_H) || defined(RUNNING_DOXYGEN) /** Create an AF_UNIX listenaddr struct. * <b>listenaddress</b> provides the path to the Unix socket. * @@ -2730,6 +2731,7 @@ connection_handle_read_impl(connection_t *conn) return 0; } +/* DOCDOC connection_handle_read */ int connection_handle_read(connection_t *conn) { @@ -3322,6 +3324,7 @@ connection_handle_write_impl(connection_t *conn, int force) return 0; } +/* DOCDOC connection_handle_write */ int connection_handle_write(connection_t *conn, int force) { diff --git a/src/or/connection.h b/src/or/connection.h index bdeefa2..215eb1b 100644 --- a/src/or/connection.h +++ b/src/or/connection.h @@ -92,8 +92,10 @@ int connection_flush(connection_t *conn); void _connection_write_to_buf_impl(const char *string, size_t len, connection_t *conn, int zlib); +/* DOCDOC connection_write_to_buf */ static void connection_write_to_buf(const char *string, size_t len, connection_t *conn); +/* DOCDOC connection_write_to_buf_zlib */ static void connection_write_to_buf_zlib(const char *string, size_t len, dir_connection_t *conn, int done); static INLINE void @@ -108,7 +110,9 @@ connection_write_to_buf_zlib(const char *string, size_t len, _connection_write_to_buf_impl(string, len, TO_CONN(conn), done ? -1 : 1); } +/* DOCDOC connection_get_inbuf_len */ static size_t connection_get_inbuf_len(connection_t *conn); +/* DOCDOC connection_get_outbuf_len */ static size_t connection_get_outbuf_len(connection_t *conn); static INLINE size_t diff --git a/src/or/connection_edge.c b/src/or/connection_edge.c index 4c29e06..5ae5b17 100644 --- a/src/or/connection_edge.c +++ b/src/or/connection_edge.c @@ -457,7 +457,7 @@ connection_edge_about_to_close(edge_connection_t *edge_conn) } } -/* Called when we're about to finally unlink and free an AP (client) +/** Called when we're about to finally unlink and free an AP (client) * connection: perform necessary accounting and cleanup */ void connection_ap_about_to_close(entry_connection_t *entry_conn) @@ -492,7 +492,7 @@ connection_ap_about_to_close(entry_connection_t *entry_conn) circuit_detach_stream(circ, edge_conn); } -/* Called when we're about to finally unlink and free an exit +/** Called when we're about to finally unlink and free an exit * connection: perform necessary accounting and cleanup */ void connection_exit_about_to_close(edge_connection_t *edge_conn) diff --git a/src/or/connection_or.c b/src/or/connection_or.c index fbab666..b5339ad 100644 --- a/src/or/connection_or.c +++ b/src/or/connection_or.c @@ -508,7 +508,7 @@ connection_or_finished_connecting(or_connection_t *or_conn) return 0; } -/* Called when we're about to finally unlink and free an OR connection: +/** Called when we're about to finally unlink and free an OR connection: * perform necessary accounting and cleanup */ void connection_or_about_to_close(or_connection_t *or_conn) diff --git a/src/or/control.c b/src/or/control.c index 91d94fd..53ea85d 100644 --- a/src/or/control.c +++ b/src/or/control.c @@ -920,10 +920,12 @@ handle_control_loadconf(control_connection_t *conn, uint32_t len, return 0; } +/* DOCDOC control_event_t */ struct control_event_t { uint16_t event_code; const char *event_name; }; +/* DOCDOC control_event_table */ static const struct control_event_t control_event_table[] = { { EVENT_CIRCUIT_STATUS, "CIRC" }, { EVENT_CIRCUIT_STATUS_MINOR, "CIRC_MINOR" }, @@ -3215,6 +3217,7 @@ is_valid_initial_command(control_connection_t *conn, const char *cmd) * interfaces is broken. */ #define MAX_COMMAND_LINE_LENGTH (1024*1024) +/* DOCDOC peek_connection_has_control0_command */ static int peek_connection_has_control0_command(connection_t *conn) { diff --git a/src/or/control.h b/src/or/control.h index 7af4449..8786712 100644 --- a/src/or/control.h +++ b/src/or/control.h @@ -50,7 +50,7 @@ int control_event_or_conn_status(or_connection_t *conn, int control_event_bandwidth_used(uint32_t n_read, uint32_t n_written); int control_event_stream_bandwidth(edge_connection_t *edge_conn); int control_event_stream_bandwidth_used(void); -void control_event_logmsg(int severity, unsigned int domain, const char *msg); +void control_event_logmsg(int severity, uint32_t domain, const char *msg); int control_event_descriptors_changed(smartlist_t *routers); int control_event_address_mapped(const char *from, const char *to, time_t expires, const char *error); diff --git a/src/or/directory.c b/src/or/directory.c index 7531260..60a1963 100644 --- a/src/or/directory.c +++ b/src/or/directory.c @@ -2438,7 +2438,8 @@ write_http_response_header(dir_connection_t *conn, ssize_t length, cache_lifetime); } -#ifdef INSTRUMENT_DOWNLOADS +#if defined(INSTRUMENT_DOWNLOADS) || defined(RUNNING_DOXYGEN) +/* DOCDOC */ typedef struct request_t { uint64_t bytes; /**< How many bytes have we transferred? */ uint64_t count; /**< How many requests have we made? */ @@ -2796,7 +2797,7 @@ directory_handle_command_get(dir_connection_t *conn, const char *headers, want_fps = url+strlen(CONSENSUS_URL_PREFIX); } - /* XXXX MICRODESC NM NM should check document of correct flavor */ + /* XXXX023 MICRODESC NM NM should check document of correct flavor */ if (v && want_fps && !client_likes_consensus(v, want_fps)) { write_http_status_line(conn, 404, "Consensus not signed by sufficient " diff --git a/src/or/dirserv.c b/src/or/dirserv.c index 1220c32..ec8d9ec 100644 --- a/src/or/dirserv.c +++ b/src/or/dirserv.c @@ -951,6 +951,7 @@ list_single_server_status(const routerinfo_t *desc, int is_live) return tor_strdup(buf); } +/* DOCDOC running_long_enough_to_decide_unreachable */ static INLINE int running_long_enough_to_decide_unreachable(void) { diff --git a/src/or/dirvote.c b/src/or/dirvote.c index 20dc8c2..e2be239 100644 --- a/src/or/dirvote.c +++ b/src/or/dirvote.c @@ -33,6 +33,7 @@ typedef struct pending_consensus_t { networkstatus_t *consensus; } pending_consensus_t; +/* DOCDOC dirvote_add_signatures_to_all_pending_consensuses */ static int dirvote_add_signatures_to_all_pending_consensuses( const char *detached_signatures_body, const char *source, @@ -2679,6 +2680,7 @@ static smartlist_t *pending_vote_list = NULL; * build a consensus, the votes go here for the next period. */ static smartlist_t *previous_vote_list = NULL; +/* DOCDOC pending_consensuses */ static pending_consensus_t pending_consensuses[N_CONSENSUS_FLAVORS]; /** The detached signatures for the consensus that we're currently diff --git a/src/or/dirvote.h b/src/or/dirvote.h index 9248d47..2c8dcff 100644 --- a/src/or/dirvote.h +++ b/src/or/dirvote.h @@ -66,7 +66,6 @@ void set_routerstatus_from_routerinfo(routerstatus_t *rs, routerinfo_t *ri, time_t now, int naming, int listbadexits, int listbaddirs, int vote_on_hsdirs); -void router_clear_status_flags(routerinfo_t *ri); networkstatus_t * dirserv_generate_networkstatus_vote_obj(crypto_pk_t *private_key, authority_cert_t *cert); diff --git a/src/or/geoip.c b/src/or/geoip.c index 5e3735c..7f16a87 100644 --- a/src/or/geoip.c +++ b/src/or/geoip.c @@ -613,6 +613,7 @@ dirreq_map_ent_eq(const dirreq_map_entry_t *a, return a->dirreq_id == b->dirreq_id && a->type == b->type; } +/* DOCDOC dirreq_map_ent_hash */ static unsigned dirreq_map_ent_hash(const dirreq_map_entry_t *entry) { diff --git a/src/or/hibernate.c b/src/or/hibernate.c index bdf407d..c4a7d37 100644 --- a/src/or/hibernate.c +++ b/src/or/hibernate.c @@ -102,9 +102,11 @@ static time_unit_t cfg_unit = UNIT_MONTH; /** How many days,hours,minutes into each unit does our accounting interval * start? */ +/** @{ */ static int cfg_start_day = 0, cfg_start_hour = 0, cfg_start_min = 0; +/** @} */ static void reset_accounting(time_t now); static int read_bandwidth_usage(void); diff --git a/src/or/main.c b/src/or/main.c index ab53772..8fbba77 100644 --- a/src/or/main.c +++ b/src/or/main.c @@ -94,7 +94,9 @@ static int stats_prev_global_read_bucket; static int stats_prev_global_write_bucket; #endif +/* DOCDOC stats_prev_n_read */ static uint64_t stats_prev_n_read = 0; +/* DOCDOC stats_prev_n_written */ static uint64_t stats_prev_n_written = 0; /* XXX we might want to keep stats about global_relayed_*_bucket too. Or not.*/ @@ -443,6 +445,7 @@ get_bytes_read(void) return stats_n_bytes_read; } +/* DOCDOC get_bytes_written */ uint64_t get_bytes_written(void) { diff --git a/src/or/microdesc.c b/src/or/microdesc.c index 59b7d7b..7bd0a03 100644 --- a/src/or/microdesc.c +++ b/src/or/microdesc.c @@ -187,7 +187,7 @@ microdescs_add_to_cache(microdesc_cache_t *cache, return added; } -/* As microdescs_add_to_cache, but takes a list of micrdescriptors instead of +/** As microdescs_add_to_cache, but takes a list of micrdescriptors instead of * a string to decode. Frees any members of <b>descriptors</b> that it does * not add. */ smartlist_t * diff --git a/src/or/networkstatus.c b/src/or/networkstatus.c index 0f51676..029fbe7 100644 --- a/src/or/networkstatus.c +++ b/src/or/networkstatus.c @@ -78,6 +78,7 @@ typedef struct consensus_waiting_for_certs_t { int dl_failed; } consensus_waiting_for_certs_t; +/* DOCDOC consensus_waiting_for_certs */ static consensus_waiting_for_certs_t consensus_waiting_for_certs[N_CONSENSUS_FLAVORS]; @@ -1006,8 +1007,8 @@ networkstatus_get_v2_list(void) return networkstatus_v2_list; } -/* As router_get_consensus_status_by_descriptor_digest, but does not return - * a const pointer */ +/** As router_get_consensus_status_by_descriptor_digest, but does not return + * a const pointer. */ routerstatus_t * router_get_mutable_consensus_status_by_descriptor_digest( networkstatus_t *consensus, @@ -2194,6 +2195,7 @@ networkstatus_dump_bridge_status_to_file(time_t now) tor_free(status); } +/* DOCDOC get_net_param_from_list */ static int32_t get_net_param_from_list(smartlist_t *net_params, const char *param_name, int32_t default_val, int32_t min_val, int32_t max_val) diff --git a/src/or/onion.c b/src/or/onion.c index 09349a4..43f0765 100644 --- a/src/or/onion.c +++ b/src/or/onion.c @@ -29,9 +29,11 @@ typedef struct onion_queue_t { #define ONIONQUEUE_WAIT_CUTOFF 5 /** First and last elements in the linked list of circuits waiting for CPU - * workers, or NULL if the list is empty. */ + * workers, or NULL if the list is empty. + * @{ */ static onion_queue_t *ol_list=NULL; static onion_queue_t *ol_tail=NULL; +/**@}*/ /** Length of ol_list */ static int ol_length=0; diff --git a/src/or/or.h b/src/or/or.h index 5d620db..a01c14a 100644 --- a/src/or/or.h +++ b/src/or/or.h @@ -1065,6 +1065,7 @@ typedef struct connection_t { uint64_t dirreq_id; } connection_t; +/* DOCDOC listener_connection_t */ typedef struct listener_connection_t { connection_t _base; diff --git a/src/or/policies.c b/src/or/policies.c index 5eaebfa..62bdc1e 100644 --- a/src/or/policies.c +++ b/src/or/policies.c @@ -535,6 +535,7 @@ typedef struct policy_map_ent_t { addr_policy_t *policy; } policy_map_ent_t; +/* DOCDOC policy_root */ static HT_HEAD(policy_map, policy_map_ent_t) policy_root = HT_INITIALIZER(); /** Return true iff a and b are equal. */ diff --git a/src/or/relay.c b/src/or/relay.c index c540d96..003a07f 100644 --- a/src/or/relay.c +++ b/src/or/relay.c @@ -64,6 +64,7 @@ static struct timeval cached_time_hires = {0, 0}; * cells. */ #define CELL_QUEUE_LOWWATER_SIZE 64 +/* DOCDOC tor_gettimeofday_cached */ static void tor_gettimeofday_cached(struct timeval *tv) { @@ -73,6 +74,7 @@ tor_gettimeofday_cached(struct timeval *tv) *tv = cached_time_hires; } +/* DOCDOC tor_gettimeofday_cache_clear */ void tor_gettimeofday_cache_clear(void) { @@ -2090,6 +2092,7 @@ cell_ewma_get_tick(void) * has value ewma_scale_factor ** N.) */ static double ewma_scale_factor = 0.1; +/* DOCDOC ewma_enabled */ static int ewma_enabled = 0; #define EPSILON 0.00001 diff --git a/src/or/rendcommon.c b/src/or/rendcommon.c index 20bbdaf..0f78a7b 100644 --- a/src/or/rendcommon.c +++ b/src/or/rendcommon.c @@ -797,6 +797,7 @@ rend_cache_entry_free(rend_cache_entry_t *e) tor_free(e); } +/* DOCDOC _rend_cache_entry_free */ static void _rend_cache_entry_free(void *p) { diff --git a/src/or/rephist.c b/src/or/rephist.c index 0727c68..e1383bc 100644 --- a/src/or/rephist.c +++ b/src/or/rephist.c @@ -1772,6 +1772,7 @@ rep_hist_load_state(or_state_t *state, char **err) /*********************************************************************/ +/* DOCDOC predicted_port_t */ typedef struct predicted_port_t { uint16_t port; time_t time; @@ -2745,6 +2746,7 @@ rep_hist_desc_stats_write(time_t now) return start_of_served_descs_stats_interval + WRITE_STATS_INTERVAL; } +/* DOCDOC rep_hist_note_desc_served */ void rep_hist_note_desc_served(const char * desc) { @@ -2786,27 +2788,27 @@ rep_hist_conn_stats_init(time_t now) * connection stats. */ #define BIDI_INTERVAL 10 -/* Start of next BIDI_INTERVAL second interval. */ +/** Start of next BIDI_INTERVAL second interval. */ static time_t bidi_next_interval = 0; -/* Number of connections that we read and wrote less than BIDI_THRESHOLD +/** Number of connections that we read and wrote less than BIDI_THRESHOLD * bytes from/to in BIDI_INTERVAL seconds. */ static uint32_t below_threshold = 0; -/* Number of connections that we read at least BIDI_FACTOR times more +/** Number of connections that we read at least BIDI_FACTOR times more * bytes from than we wrote to in BIDI_INTERVAL seconds. */ static uint32_t mostly_read = 0; -/* Number of connections that we wrote at least BIDI_FACTOR times more +/** Number of connections that we wrote at least BIDI_FACTOR times more * bytes to than we read from in BIDI_INTERVAL seconds. */ static uint32_t mostly_written = 0; -/* Number of connections that we read and wrote at least BIDI_THRESHOLD +/** Number of connections that we read and wrote at least BIDI_THRESHOLD * bytes from/to, but not BIDI_FACTOR times more in either direction in * BIDI_INTERVAL seconds. */ static uint32_t both_read_and_written = 0; -/* Entry in a map from connection ID to the number of read and written +/** Entry in a map from connection ID to the number of read and written * bytes on this connection in a BIDI_INTERVAL second interval. */ typedef struct bidi_map_entry_t { HT_ENTRY(bidi_map_entry_t) node; @@ -2826,6 +2828,7 @@ bidi_map_ent_eq(const bidi_map_entry_t *a, const bidi_map_entry_t *b) return a->conn_id == b->conn_id; } +/* DOCDOC bidi_map_ent_hash */ static unsigned bidi_map_ent_hash(const bidi_map_entry_t *entry) { @@ -2837,6 +2840,7 @@ HT_PROTOTYPE(bidimap, bidi_map_entry_t, node, bidi_map_ent_hash, HT_GENERATE(bidimap, bidi_map_entry_t, node, bidi_map_ent_hash, bidi_map_ent_eq, 0.6, malloc, realloc, free); +/* DOCDOC bidi_map_free */ static void bidi_map_free(void) { diff --git a/src/or/router.c b/src/or/router.c index 34e231a..fc7cf73 100644 --- a/src/or/router.c +++ b/src/or/router.c @@ -484,6 +484,7 @@ v3_authority_check_key_expiry(void) last_warned = now; } +/* DOCDOC router_initialize_tls_context */ int router_initialize_tls_context(void) { diff --git a/src/or/routerlist.c b/src/or/routerlist.c index 5586439..9e5fff4 100644 --- a/src/or/routerlist.c +++ b/src/or/routerlist.c @@ -104,9 +104,12 @@ static time_t last_descriptor_download_attempted = 0; /** When we last computed the weights to use for bandwidths on directory * requests, what were the total weighted bandwidth, and our share of that * bandwidth? Used to determine what fraction of directory requests we should - * expect to see. */ + * expect to see. + * + * @{ */ static uint64_t sl_last_total_weighted_bw = 0, sl_last_weighted_bw_of_me = 0; +/**@}*/ /** Return the number of directory authorities whose type matches some bit set * in <b>type</b> */ @@ -2294,7 +2297,7 @@ hex_digest_nickname_matches(const char *hexdigest, const char *identity_digest, return tor_memeq(digest, identity_digest, DIGEST_LEN); } -/* Return true iff <b>router</b> is listed as named in the current +/** Return true iff <b>router</b> is listed as named in the current * consensus. */ int router_is_named(const routerinfo_t *router) diff --git a/src/or/routerlist.h b/src/or/routerlist.h index cae8814..ee665b6 100644 --- a/src/or/routerlist.h +++ b/src/or/routerlist.h @@ -103,6 +103,7 @@ static INLINE int WRA_WAS_OUTDATED(was_router_added_t s) s == ROUTER_NOT_IN_CONSENSUS || s == ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS); } +/* DOCDOC WRA_WAS_REJECTED */ static INLINE int WRA_WAS_REJECTED(was_router_added_t s) { return (s == ROUTER_AUTHDIR_REJECTS); diff --git a/src/or/routerparse.c b/src/or/routerparse.c index d86c0cf..dbc6bf1 100644 --- a/src/or/routerparse.c +++ b/src/or/routerparse.c @@ -519,6 +519,7 @@ static token_rule_t networkstatus_detached_signature_token_table[] = { END_OF_TABLE }; +/* DOCDOC microdesc_token_table */ static token_rule_t microdesc_token_table[] = { T1_START("onion-key", K_ONION_KEY, NO_ARGS, NEED_KEY_1024), T01("family", K_FAMILY, ARGS, NO_OBJ ), @@ -4200,6 +4201,7 @@ find_all_exitpolicy(smartlist_t *s) return out; } +/* DOCDOC router_get_hash_impl_helper */ static int router_get_hash_impl_helper(const char *s, size_t s_len, const char *start_str,

1 0

[tor/master] Resolve all currently pending DOCDOC items in master
by nickm＠torproject.org 04 Jun '12

04 Jun '12

commit f68c042637d253dfb3160357ba2b9ec530cb48ef Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Jun 4 18:50:13 2012 -0400 Resolve all currently pending DOCDOC items in master --- src/common/compat.c | 3 +- src/common/util.c | 12 +++++++- src/common/util.h | 4 ++- src/or/config.c | 59 +++++++++++++++++++++++++++++++-------------- src/or/connection.c | 13 +++++++--- src/or/connection_edge.c | 10 ++++---- src/or/connection_or.c | 3 +- src/or/directory.c | 5 +++- src/or/networkstatus.c | 6 +++- src/or/or.h | 5 ++- src/or/routerlist.c | 13 +++++++--- src/or/routerparse.c | 5 +++- 12 files changed, 95 insertions(+), 43 deletions(-) diff --git a/src/common/compat.c b/src/common/compat.c index 0931061..49a4afe 100644 --- a/src/common/compat.c +++ b/src/common/compat.c @@ -143,7 +143,8 @@ tor_open_cloexec(const char *path, int flags, unsigned mode) return fd; } -/** DOCDOC */ +/** As fpoen(path,mode), but ensures that the O_CLOEXEC bit is set on the + * underlying file handle. */ FILE * tor_fopen_cloexec(const char *path, const char *mode) { diff --git a/src/common/util.c b/src/common/util.c index e7979d8..b3145ae 100644 --- a/src/common/util.c +++ b/src/common/util.c @@ -3323,7 +3323,15 @@ process_handle_new(void) return out; } -/*DOCDOC*/ +/** + * @name child-process states + * + * Each of these values represents a possible state that a child process can + * be in. They're used to determine what to say when telling the parent how + * far along we were before failure. + * + * @{ + */ #define CHILD_STATE_INIT 0 #define CHILD_STATE_PIPE 1 #define CHILD_STATE_MAXFD 2 @@ -3334,7 +3342,7 @@ process_handle_new(void) #define CHILD_STATE_CLOSEFD 7 #define CHILD_STATE_EXEC 8 #define CHILD_STATE_FAILEXEC 9 - +/** @} */ /** Start a program in the background. If <b>filename</b> contains a '/', then * it will be treated as an absolute or relative path. Otherwise, on * non-Windows systems, the system path will be searched for <b>filename</b>. diff --git a/src/common/util.h b/src/common/util.h index 36601fa..ae40898 100644 --- a/src/common/util.h +++ b/src/common/util.h @@ -409,8 +409,10 @@ void set_environment_variable_in_smartlist(struct smartlist_t *env_vars, #define PROCESS_STATUS_ERROR -1 #ifdef UTIL_PRIVATE -/*DOCDOC*/ +/** Structure to represent the state of a process with which Tor is + * communicating. The contents of this structure are private to util.c */ struct process_handle_t { + /** One of the PROCESS_STATUS_* values */ int status; #ifdef _WIN32 HANDLE stdout_pipe; diff --git a/src/or/config.c b/src/or/config.c index 8a19ed6..5f5960f 100644 --- a/src/or/config.c +++ b/src/or/config.c @@ -675,11 +675,12 @@ static const config_format_t state_format = { /** Command-line and config-file options. */ static or_options_t *global_options = NULL; -/** DOCDOC */ +/** The fallback options_t object; this is where we look for options not + * in torrc before we fall back to Tor's defaults. */ static or_options_t *global_default_options = NULL; /** Name of most recently read torrc file. */ static char *torrc_fname = NULL; -/** DOCDOC */ +/** Name of the most recently read torrc-defaults file.*/ static char *torrc_defaults_fname; /** Persistent serialized state. */ static or_state_t *global_state = NULL; @@ -4345,8 +4346,8 @@ get_windows_conf_root(void) } #endif -/** Return the default location for our torrc file. - * DOCDOC defaults_file */ +/** Return the default location for our torrc file (if <b>defaults_file</b> is + * false), or for the torrc-defaults file (if <b>defaults_file</b> is true). */ static const char * get_default_conf_file(int defaults_file) { @@ -4396,12 +4397,21 @@ check_nickname_list(const char *lst, const char *name, char **msg) return r; } -/** Learn config file name from command line arguments, or use the default, - * DOCDOC defaults_file */ +/** Learn config file name from command line arguments, or use the default. + * + * If <b>defaults_file</b> is true, we're looking for torrc-defaults; + * otherwise, we're looking for the regular torrc_file. + * + * Set *<b>using_default_fname</b> to true if we're using the default + * configuration file name; or false if we've set it from the command line. + * + * Set *<b>ignore_missing_torrc</b> to true if we should ignore the resulting + * filename if it doesn't exist. + */ static char * find_torrc_filename(int argc, char **argv, int defaults_file, - int *using_default_torrc, int *ignore_missing_torrc) + int *using_default_fname, int *ignore_missing_torrc) { char *fname=NULL; int i; @@ -4427,14 +4437,14 @@ find_torrc_filename(int argc, char **argv, fname = absfname; } - *using_default_torrc = 0; + *using_default_fname = 0; ++i; } else if (ignore_opt && !strcmp(argv[i],ignore_opt)) { *ignore_missing_torrc = 1; } } - if (*using_default_torrc) { + if (*using_default_fname) { /* didn't find one, try CONFDIR */ const char *dflt = get_default_conf_file(defaults_file); if (dflt && file_status(dflt) == FN_FILE) { @@ -4458,8 +4468,13 @@ find_torrc_filename(int argc, char **argv, return fname; } -/** Load torrc from disk, setting torrc_fname if successful. - * DOCDOC defaults_file */ +/** Load a configuration file from disk, setting torrc_fname or + * torrc_defaults_fname if successful. + * + * If <b>defaults_file</b> is true, load torrc-defaults; otherwise load torrc. + * + * Return the contents of the file on success, and NULL on failure. + */ static char * load_torrc_from_disk(int argc, char **argv, int defaults_file) { @@ -5455,7 +5470,10 @@ warn_nonlocal_client_ports(const smartlist_t *ports, const char *portname) } SMARTLIST_FOREACH_END(port); } -/** DOCDOC */ +/** Given a list of port_cfg_t in <b>ports</b>, warn any controller port there + * is listening on any non-loopback address. If <b>forbid</b> is true, + * then emit a stronger warning and remove the port from the list. + */ static void warn_nonlocal_controller_ports(smartlist_t *ports, unsigned forbid) { @@ -5839,10 +5857,12 @@ parse_port_config(smartlist_t *out, return retval; } -/** DOCDOC */ +/** Parse a list of config_line_t for an AF_UNIX unix socket listener option + * from <b>cfg</b> and add them to <b>out</b>. No fancy options are + * supported: the line contains nothing but the path to the AF_UNIX socket. */ static int -parse_socket_config(smartlist_t *out, const config_line_t *cfg, - int listener_type) +parse_unix_socket_config(smartlist_t *out, const config_line_t *cfg, + int listener_type) { if (!out) @@ -5928,9 +5948,9 @@ parse_ports(const or_options_t *options, int validate_only, "configuration"); goto err; } - if (parse_socket_config(ports, - options->ControlSocket, - CONN_TYPE_CONTROL_LISTENER) < 0) { + if (parse_unix_socket_config(ports, + options->ControlSocket, + CONN_TYPE_CONTROL_LISTENER) < 0) { *msg = tor_strdup("Invalid ControlSocket configuration"); goto err; } @@ -5980,7 +6000,8 @@ parse_ports(const or_options_t *options, int validate_only, return retval; } -/** DOCDOC */ +/** Given a list of <b>port_cfg_t</b> in <b>ports</b>, check them for internal + * consistency and warn as appropriate. */ static int check_server_ports(const smartlist_t *ports, const or_options_t *options) diff --git a/src/or/connection.c b/src/or/connection.c index beeeb2a..3ff6a71 100644 --- a/src/or/connection.c +++ b/src/or/connection.c @@ -1659,7 +1659,8 @@ connection_send_socks5_connect(connection_t *conn) conn->proxy_state = PROXY_SOCKS5_WANT_CONNECT_OK; } -/** DOCDOC */ +/** Wrapper around fetch_from_(buf/evbuffer)_socks_client: see those functions + * for documentation of its behavior. */ static int connection_fetch_from_buf_socks_client(connection_t *conn, int state, char **reason) @@ -2239,7 +2240,9 @@ global_write_bucket_low(connection_t *conn, size_t attempt, int priority) return 0; } -/** DOCDOC */ +/** Helper: adjusts our bandwidth history and informs the controller as + * appropriate, given that we have just read <b>num_read</b> bytes and written + * <b>num_written</b> bytes on <b>conn</b>. */ static void record_num_bytes_transferred_impl(connection_t *conn, time_t now, size_t num_read, size_t num_written) @@ -2270,7 +2273,8 @@ record_num_bytes_transferred_impl(connection_t *conn, } #ifdef USE_BUFFEREVENTS -/** DOCDOC */ +/** Wrapper around fetch_from_(buf/evbuffer)_socks_client: see those functions + * for documentation of its behavior. */ static void record_num_bytes_transferred(connection_t *conn, time_t now, size_t num_read, size_t num_written) @@ -2592,7 +2596,8 @@ connection_get_rate_limit_totals(uint64_t *read_out, uint64_t *written_out) } } -/** DOCDOC */ +/** Perform whatever operations are needed on <b>conn</b> to enable + * rate-limiting. */ void connection_enable_rate_limiting(connection_t *conn) { diff --git a/src/or/connection_edge.c b/src/or/connection_edge.c index ca4bf3f..4c29e06 100644 --- a/src/or/connection_edge.c +++ b/src/or/connection_edge.c @@ -2673,12 +2673,12 @@ connection_ap_handshake_send_resolve(entry_connection_t *ap_conn) return 0; } -/** Make an AP connection_t, make a new linked connection pair, and attach - * one side to the conn, connection_add it, initialize it to circuit_wait, - * and call connection_ap_handshake_attach_circuit(conn) on it. +/** Make an AP connection_t linked to the connection_t <b>partner</b>. make a + * new linked connection pair, and attach one side to the conn, connection_add + * it, initialize it to circuit_wait, and call + * connection_ap_handshake_attach_circuit(conn) on it. * - * Return the other end of the linked connection pair, or -1 if error. - * DOCDOC partner. + * Return the newly created end of the linked connection pair, or -1 if error. */ entry_connection_t * connection_ap_make_link(connection_t *partner, diff --git a/src/or/connection_or.c b/src/or/connection_or.c index 8aec5d2..6a2f243 100644 --- a/src/or/connection_or.c +++ b/src/or/connection_or.c @@ -2099,7 +2099,8 @@ connection_or_send_auth_challenge_cell(or_connection_t *conn) * * If <b>server</b> is false and <b>signing_key</b> is provided, calculate the * entire authenticator, signed with <b>signing_key</b>. - * DOCDOC return value + * + * Return the length of the cell body on success, and -1 on failure. */ int connection_or_compute_authenticate_cell_body(or_connection_t *conn, diff --git a/src/or/directory.c b/src/or/directory.c index 3d2b955..7531260 100644 --- a/src/or/directory.c +++ b/src/or/directory.c @@ -3788,7 +3788,10 @@ dir_routerdesc_download_failed(smartlist_t *failed, int status_code, * every 10 or 60 seconds (FOO_DESCRIPTOR_RETRY_INTERVAL) in main.c. */ } -/* DOCDOC NM */ +/** Called when a connection to download microdescriptors has failed in whole + * or in part. <b>failed</b> is a list of every microdesc digest we didn't + * get. <b>status_code</b> is the http status code we received. Reschedule the + * microdesc downloads as appropriate. */ static void dir_microdesc_download_failed(smartlist_t *failed, int status_code) diff --git a/src/or/networkstatus.c b/src/or/networkstatus.c index 3646ee6..0f51676 100644 --- a/src/or/networkstatus.c +++ b/src/or/networkstatus.c @@ -1183,7 +1183,8 @@ update_v2_networkstatus_cache_downloads(time_t now) } } -/** DOCDOC */ +/** Return true iff, given the options listed in <b>options</b>, <b>flavor</b> + * is the flavor of a consensus networkstatus that we would like to fetch. */ static int we_want_to_fetch_flavor(const or_options_t *options, int flavor) { @@ -1455,7 +1456,8 @@ networkstatus_get_latest_consensus(void) return current_consensus; } -/** DOCDOC */ +/** Return the latest consensus we have whose flavor matches <b>f</b>, or NULL + * if we don't have one. */ networkstatus_t * networkstatus_get_latest_consensus_by_flavor(consensus_flavor_t f) { diff --git a/src/or/or.h b/src/or/or.h index 76681c9..5d620db 100644 --- a/src/or/or.h +++ b/src/or/or.h @@ -1251,7 +1251,8 @@ typedef struct or_connection_t { * bandwidthburst. (OPEN ORs only) */ int write_bucket; /**< When this hits 0, stop writing. Like read_bucket. */ #else - /** DOCDOC */ + /** A rate-limiting configuration object to determine how this connection + * set its read- and write- limits. */ /* XXXX we could share this among all connections. */ struct ev_token_bucket_cfg *bucket_cfg; #endif @@ -1729,7 +1730,7 @@ typedef struct { uint16_t or_port; /**< Port for TLS connections. */ uint16_t dir_port; /**< Port for HTTP directory connections. */ - /* DOCDOC */ + /** A router's IPv6 address, if it has one. */ /* XXXXX187 Actually these should probably be part of a list of addresses, * not just a special case. Use abstractions to access these; don't do it * directly. */ diff --git a/src/or/routerlist.c b/src/or/routerlist.c index 36a282a..db0844d 100644 --- a/src/or/routerlist.c +++ b/src/or/routerlist.c @@ -4188,9 +4188,9 @@ any_trusted_dir_is_v1_authority(void) /** For every current directory connection whose purpose is <b>purpose</b>, * and where the resource being downloaded begins with <b>prefix</b>, split - * rest of the resource into base16 fingerprints, decode them, and set the + * rest of the resource into base16 fingerprints (or base64 fingerprints if + * purpose==DIR_PURPPOSE_FETCH_MICRODESC), decode them, and set the * corresponding elements of <b>result</b> to a nonzero value. - * DOCDOC purpose==microdesc */ static void list_pending_downloads(digestmap_t *result, @@ -4235,8 +4235,13 @@ list_pending_descriptor_downloads(digestmap_t *result, int extrainfo) list_pending_downloads(result, purpose, "d/"); } -/** DOCDOC */ -/*XXXX NM should use digest256, if one comes into being. */ +/** For every microdescriptor we are currently downloading by descriptor + * digest, set result[d] to (void*)1. (Note that microdescriptor digests + * are 256-bit, and digestmap_t only holds 160-bit digests, so we're only + * getting the first 20 bytes of each digest here.) + * + * XXXX Let there be a digestmap256_t, and use that instead. + */ void list_pending_microdesc_downloads(digestmap_t *result) { diff --git a/src/or/routerparse.c b/src/or/routerparse.c index 781c578..d86c0cf 100644 --- a/src/or/routerparse.c +++ b/src/or/routerparse.c @@ -4169,7 +4169,10 @@ _find_by_keyword(smartlist_t *s, directory_keyword keyword, return tok; } -/** DOCDOC */ +/** If there are any directory_token_t entries in <b>s</b> whose keyword is + * <b>k</b>, return a newly allocated smartlist_t containing all such entries, + * in the same order in which they occur in <b>s</b>. Otherwise return + * NULL. */ static smartlist_t * find_all_by_keyword(smartlist_t *s, directory_keyword k) {

1 0

r25668: {website} fix the wml for imgroot. (website/trunk/donate/en)
by Andrew Lewman 04 Jun '12

04 Jun '12

Author: phobos Date: 2012-06-04 20:18:49 +0000 (Mon, 04 Jun 2012) New Revision: 25668 Modified: website/trunk/donate/en/donate.wml Log: fix the wml for imgroot. Modified: website/trunk/donate/en/donate.wml =================================================================== --- website/trunk/donate/en/donate.wml 2012-06-04 20:07:15 UTC (rev 25667) +++ website/trunk/donate/en/donate.wml 2012-06-04 20:18:49 UTC (rev 25668) @@ -137,7 +137,7 @@ <div> <label for="amazon">$</label> <input type="text" name="amount" size="6" value="20"> - <input class="donate-btn" type="image" src="images/golden_small_donate_withmsg_whitebg.gif"> + <input class="donate-btn" type="image" src="$(IMGROOT)/golden_small_donate_withmsg_whitebg.gif"> </div> <input type="hidden" name="immediateReturn" value="1"> <input type="hidden" name="collectShippingAddress" value="0">

1 0

r25667: {website} attempt to not leak data to amazon. (in website/trunk: donate/en images)
by Andrew Lewman 04 Jun '12

04 Jun '12

Author: phobos Date: 2012-06-04 20:07:15 +0000 (Mon, 04 Jun 2012) New Revision: 25667 Added: website/trunk/images/golden_small_donate_withmsg_whitebg.gif Modified: website/trunk/donate/en/donate.wml Log: attempt to not leak data to amazon. Modified: website/trunk/donate/en/donate.wml =================================================================== --- website/trunk/donate/en/donate.wml 2012-06-04 19:52:03 UTC (rev 25666) +++ website/trunk/donate/en/donate.wml 2012-06-04 20:07:15 UTC (rev 25667) @@ -137,7 +137,7 @@ <div> <label for="amazon">$</label> <input type="text" name="amount" size="6" value="20"> - <input class="donate-btn" type="image" src="http://g-ecx.images-amazon.com/images/G/01/asp/golden_small_donate_withmsg_…"> + <input class="donate-btn" type="image" src="images/golden_small_donate_withmsg_whitebg.gif"> </div> <input type="hidden" name="immediateReturn" value="1"> <input type="hidden" name="collectShippingAddress" value="0"> Added: website/trunk/images/golden_small_donate_withmsg_whitebg.gif =================================================================== (Binary files differ) Property changes on: website/trunk/images/golden_small_donate_withmsg_whitebg.gif ___________________________________________________________________ Added: svn:mime-type + image/gif

1 0

r25666: {website} make an overview jobs page. now there's room for the QA auto (website/trunk/about/en)
by Roger Dingledine 04 Jun '12

04 Jun '12

Author: arma Date: 2012-06-04 19:52:03 +0000 (Mon, 04 Jun 2012) New Revision: 25666 Added: website/trunk/about/en/jobs-coredev.wml Modified: website/trunk/about/en/jobs.wml Log: make an overview jobs page. now there's room for the QA automation build engineer world savior position, or whatever it will turn out to be called. Added: website/trunk/about/en/jobs-coredev.wml =================================================================== --- website/trunk/about/en/jobs-coredev.wml (rev 0) +++ website/trunk/about/en/jobs-coredev.wml 2012-06-04 19:52:03 UTC (rev 25666) @@ -0,0 +1,134 @@ +## translation metadata +# Revision: $Revision$ +# Translation-Priority: 3-low + +#include "head.wmi" TITLE="Tor Project: Jobs (core developer)" CHARSET="UTF-8" +<div id="content" class="clearfix"> + <div id="breadcrumbs"> + <a href="<page index>">Home » </a> + <a href="<page about/overview>">About » </a> + <a href="<page about/jobs>">Jobs</a> + </div> + <div id="maincol"> +<h1>The Tor Project is looking for another dedicated core developer!</h1> + +<p> +Your job would be to work on all aspects of the main Tor network daemon +and other open-source software. +This would be a contractor position for 2012 (starting as soon as you're +ready and with plenty of work to keep you busy), with the possibility of +2013 and beyond. +</p> + +<p> +Any candidate must: +</p> + +<ul> +<li>Have extensive experience in C, and several other programming + languages. At least 5 years experience with C is probably necessary + for the level of expertise we want; most people would need more.</li> +<li>Have a solid understanding of issues surrounding secure C programming.</li> +<li>Be comfortable working from home (or wherever your preferred + Internet connection is).</li> +<li>Be familiar and experienced with nonblocking, event-driven networking + programs.</li> +<li>Be comfortable and experienced with interacting with users online.</li> +<li>Be comfortable and experienced with driving the entire lifecycle + of a new feature in an existing piece of software, from design to + implementation to testing.</li> +<li>Be comfortable and experienced getting code and design reviewed, + and reviewing the code and design of others.</li> +<li>Be comfortable with transparency: as a non-profit, everything we do + is in public, including your name and pay rate.</li> +</ul> + +<p> +An ideal candidate would also: +</p> + +<ul> +<li>Know enough of the basics of cryptography in order to understand + how to implement our protocols and discuss changes to them. (Actually + implementing block ciphers and stuff like that isn't necessary.)</li> +<li>Know enough about networking in order to understand how to implement + our protocols and discuss changes to them.</li> +<li>Have experience with high-performance networking code.</li> +<li>Have experience with open-source software development, including + working with distributed teams across different time-zones containing + employees and volunteers of differing skill levels over email and IRC.</li> +<li>Have basic familiarity with distributed version control systems.</li> +<li>Have contributed significant chunks of code to multiple + open-source projects in the past.</li> +<li>Genuinely be excited about Tor and our values.</li> +</ul> + +<p> +Being a core Tor developer includes triaging, +diagnosing, and fixing bugs; looking for and resolving security +issues; and working collaboratively with coworkers and volunteers +on implementing new features and protocol changes at every stage from +design to maintenance. We'd also need help making our code more scalable, +testable, and maintainable. Sometimes, we need to drop everything and +scramble to implement last-minute anticensorship schemes, or to deploy +urgent security updates. You'd also be reviewing other people's code and +designs, and looking for ways to improve it. For an idea of the +breadth and depth of the work you'd be doing, have a look at <a +href="https://gitweb.torproject.org/tor.git/blob/HEAD:/ChangeLog">the +ChangeLog file from the Tor source distribution</a>. +</p> + +<p> +Other notes: +</p> + +<ul> +<li>Tor developers don't have an office; you can work from wherever you + want, in basically any country. You'll need to be comfortable in + this environment! We coordinate via IRC, email, and bug trackers.</li> +<li>Academic degrees are great, but not required if you have the right + experience.</li> +<li>We only write free (open source) software, and we don't believe in + software patents.</li> +</ul> + +<p> +How to apply: +</p> + +<ul> +<li>Link to a sample of code you've written in the past that you're + allowed to show us.</li> +<li>Provide a CV explaining your background, experience, skills, and + other relevant qualifications.</li> +<li>List some people who can tell us more about you: these references + could be employers or coworkers, open source projects, etc.</li> +<li>Email the above to jobs at torproject.org.</li> +</ul> + +<p> +About the company:<br> + The Tor Project is a US 501(c)(3) non-profit dedicated to research, + development, and education about online anonymity and privacy. The Tor + network's 3000 volunteer relays carry 14 Gbps for upwards of half a million + daily users, including ordinary citizens who want protection from identity + theft and prying corporations, corporations who want to look at a + competitor's website in private, people around the world whose Internet + connections are censored, and even governments and law enforcement. Tor has + a staff of 13 paid developers, researchers, and advocates, plus many dozen + volunteers who help out on a daily basis. Tor is funded in part by + government research and development grants, and in part by individual and + corporate donations. +</p> + + </div> +  + <div id = "sidecol"> +#include "side.wmi" +#include "info.wmi" + </div> +  +</div> + +#include <foot.wmi> + Property changes on: website/trunk/about/en/jobs-coredev.wml ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision Added: svn:eol-style + native Modified: website/trunk/about/en/jobs.wml =================================================================== --- website/trunk/about/en/jobs.wml 2012-06-03 20:41:17 UTC (rev 25665) +++ website/trunk/about/en/jobs.wml 2012-06-04 19:52:03 UTC (rev 25666) @@ -10,103 +10,16 @@ <a href="<page about/jobs>">Jobs</a> </div> <div id="maincol"> -<h1>The Tor Project is looking for another dedicated core developer!</h1> +<h1>The Tor Project is looking for more great developers!</h1> -<p> -Your job would be to work on all aspects of the main Tor network daemon -and other open-source software. -This would be a contractor position for 2012 (starting as soon as you're -ready and with plenty of work to keep you busy), with the possibility of -2013 and beyond. +<p>Specifically, we're looking for the following people currently: </p> -<p> -Any candidate must: -</p> - <ul> -<li>Have extensive experience in C, and several other programming - languages. At least 5 years experience with C is probably necessary - for the level of expertise we want; most people would need more.</li> -<li>Have a solid understanding of issues surrounding secure C programming.</li> -<li>Be comfortable working from home (or wherever your preferred - Internet connection is).</li> -<li>Be familiar and experienced with nonblocking, event-driven networking - programs.</li> -<li>Be comfortable and experienced with interacting with users online.</li> -<li>Be comfortable and experienced with driving the entire lifecycle - of a new feature in an existing piece of software, from design to - implementation to testing.</li> -<li>Be comfortable and experienced getting code and design reviewed, - and reviewing the code and design of others.</li> -<li>Be comfortable with transparency: as a non-profit, everything we do - is in public, including your name and pay rate.</li> +<li><a href="<page about/jobs-coredev>">Core developer</a></li> </ul> <p> -An ideal candidate would also: -</p> - -<ul> -<li>Know enough of the basics of cryptography in order to understand - how to implement our protocols and discuss changes to them. (Actually - implementing block ciphers and stuff like that isn't necessary.)</li> -<li>Know enough about networking in order to understand how to implement - our protocols and discuss changes to them.</li> -<li>Have experience with high-performance networking code.</li> -<li>Have experience with open-source software development, including - working with distributed teams across different time-zones containing - employees and volunteers of differing skill levels over email and IRC.</li> -<li>Have basic familiarity with distributed version control systems.</li> -<li>Have contributed significant chunks of code to multiple - open-source projects in the past.</li> -<li>Genuinely be excited about Tor and our values.</li> -</ul> - -<p> -Being a core Tor developer includes triaging, -diagnosing, and fixing bugs; looking for and resolving security -issues; and working collaboratively with coworkers and volunteers -on implementing new features and protocol changes at every stage from -design to maintenance. We'd also need help making our code more scalable, -testable, and maintainable. Sometimes, we need to drop everything and -scramble to implement last-minute anticensorship schemes, or to deploy -urgent security updates. You'd also be reviewing other people's code and -designs, and looking for ways to improve it. For an idea of the -breadth and depth of the work you'd be doing, have a look at <a -href="https://gitweb.torproject.org/tor.git/blob/HEAD:/ChangeLog">the -ChangeLog file from the Tor source distribution</a>. -</p> - -<p> -Other notes: -</p> - -<ul> -<li>Tor developers don't have an office; you can work from wherever you - want, in basically any country. You'll need to be comfortable in - this environment! We coordinate via IRC, email, and bug trackers.</li> -<li>Academic degrees are great, but not required if you have the right - experience.</li> -<li>We only write free (open source) software, and we don't believe in - software patents.</li> -</ul> - -<p> -How to apply: -</p> - -<ul> -<li>Link to a sample of code you've written in the past that you're - allowed to show us.</li> -<li>Provide a CV explaining your background, experience, skills, and - other relevant qualifications.</li> -<li>List some people who can tell us more about you: these references - could be employers or coworkers, open source projects, etc.</li> -<li>Email the above to jobs at torproject.org.</li> -</ul> - -<p> About the company:<br> The Tor Project is a US 501(c)(3) non-profit dedicated to research, development, and education about online anonymity and privacy. The Tor

1 0

[tor/master] Kill non-open OR connections with any data on their inbufs.
by nickm＠torproject.org 04 Jun '12

04 Jun '12

commit af54a0182870babec62bf07d067ca82a67c423de Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu May 31 11:19:35 2012 -0400 Kill non-open OR connections with any data on their inbufs. This fixes a DoS issue where a client could send so much data in 5 minutes that they exhausted the server's RAM. Fix for bug 5934 and 6007. Bugfix on 0.2.0.20-rc, which enabled the v2 handshake. --- changes/bug6007 | 5 +++++ src/or/connection_or.c | 22 ++++++++++++++++++++-- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/changes/bug6007 b/changes/bug6007 new file mode 100644 index 0000000..4e81575 --- /dev/null +++ b/changes/bug6007 @@ -0,0 +1,5 @@ + o Major bugfixes (security): + - When waiting for a client to renegotiate, don't allow it to add + any bytes to the input buffer. This fixes a DoS issue. Fix for + bugs 6007 and 5934; bugfix on 0.2.0.20-rc. + diff --git a/src/or/connection_or.c b/src/or/connection_or.c index dc8850e..cb0082b 100644 --- a/src/or/connection_or.c +++ b/src/or/connection_or.c @@ -209,7 +209,12 @@ connection_or_reached_eof(or_connection_t *conn) int connection_or_process_inbuf(or_connection_t *conn) { - int ret; + /** Don't let the inbuf of a nonopen OR connection grow beyond this many + * bytes: it's either a broken client, a non-Tor client, or a DOS + * attempt. */ +#define MAX_OR_INBUF_WHEN_NONOPEN 0 + + int ret = 0; tor_assert(conn); switch (conn->_base.state) { @@ -231,8 +236,21 @@ connection_or_process_inbuf(or_connection_t *conn) case OR_CONN_STATE_OR_HANDSHAKING: return connection_or_process_cells_from_inbuf(conn); default: - return 0; /* don't do anything */ + break; /* don't do anything */ } + + if (buf_datalen(conn->_base.inbuf) > MAX_OR_INBUF_WHEN_NONOPEN) { + log_fn(LOG_PROTOCOL_WARN, LD_NET, "Accumulated too much data (%d bytes) " + "on nonopen OR connection %s %s:%u in state %s; closing.", + (int)buf_datalen(conn->_base.inbuf), + connection_or_nonopen_was_started_here(conn) ? "to" : "from", + conn->_base.address, conn->_base.port, + conn_state_to_string(conn->_base.type, conn->_base.state)); + connection_mark_for_close(TO_CONN(conn)); + ret = -1; + } + + return ret; } /** When adding cells to an OR connection's outbuf, keep adding until the

1 0

[tor/master] Merge remote-tracking branch 'public/bug6007_strict_squashed' into maint-0.2.2
by nickm＠torproject.org 04 Jun '12

04 Jun '12

commit 491dc3a601d7c2610503f73192bd1a40bcb37ab2 Merge: 6d85a79 af54a01 Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Jun 4 11:40:52 2012 -0400 Merge remote-tracking branch 'public/bug6007_strict_squashed' into maint-0.2.2 changes/bug6007 | 5 +++++ src/or/connection_or.c | 22 ++++++++++++++++++++-- 2 files changed, 25 insertions(+), 2 deletions(-)

1 0

[tor/master] Merge origin/maint-0.2.2 for 6007_strict
by nickm＠torproject.org 04 Jun '12

04 Jun '12

commit 41e8bee188571ca61c2f5628ea99dff34343d673 Merge: 329e1c6 491dc3a Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Jun 4 11:47:36 2012 -0400 Merge origin/maint-0.2.2 for 6007_strict This code shouldn't have any effect in 0.2.3, since we already accept (and handle) data received while we are expecting a renegotiation. (That's because the 0.2.3.x handshake _does_ have data there instead of the renegotiation.) I'm leaving it in anyway, since if it breaks anything, we'll want it broken in master too so we can find out about it. I added an XXX023 comment so that we can come back later and fix that. changes/bug6007 | 5 +++++ src/or/connection_or.c | 28 ++++++++++++++++++++++++++-- 2 files changed, 31 insertions(+), 2 deletions(-) diff --cc src/or/connection_or.c index 8f88292,cb0082b..8aec5d2 --- a/src/or/connection_or.c +++ b/src/or/connection_or.c @@@ -376,21 -232,25 +381,40 @@@ connection_or_process_inbuf(or_connecti } return ret; + case OR_CONN_STATE_TLS_SERVER_RENEGOTIATING: +#ifdef USE_BUFFEREVENTS + if (tor_tls_server_got_renegotiate(conn->tls)) + connection_or_tls_renegotiated_cb(conn->tls, conn); + if (conn->_base.marked_for_close) + return 0; + /* fall through. */ +#endif case OR_CONN_STATE_OPEN: - case OR_CONN_STATE_OR_HANDSHAKING: + case OR_CONN_STATE_OR_HANDSHAKING_V2: + case OR_CONN_STATE_OR_HANDSHAKING_V3: return connection_or_process_cells_from_inbuf(conn); default: - return 0; /* don't do anything */ + break; /* don't do anything */ + } + ++ /* This check was necessary with 0.2.2, when the TLS_SERVER_RENEGOTIATING ++ * check would otherwise just let data accumulate. It serves no purpose ++ * in 0.2.3. ++ * ++ * XXX023 Remove this check once we verify that the above paragraph is ++ * 100% true. */ + if (buf_datalen(conn->_base.inbuf) > MAX_OR_INBUF_WHEN_NONOPEN) { + log_fn(LOG_PROTOCOL_WARN, LD_NET, "Accumulated too much data (%d bytes) " + "on nonopen OR connection %s %s:%u in state %s; closing.", + (int)buf_datalen(conn->_base.inbuf), + connection_or_nonopen_was_started_here(conn) ? "to" : "from", + conn->_base.address, conn->_base.port, + conn_state_to_string(conn->_base.type, conn->_base.state)); + connection_mark_for_close(TO_CONN(conn)); + ret = -1; } + + return ret; } /** When adding cells to an OR connection's outbuf, keep adding until the

1 0

[tor/maint-0.2.2] Kill non-open OR connections with any data on their inbufs.
by nickm＠torproject.org 04 Jun '12

04 Jun '12

commit af54a0182870babec62bf07d067ca82a67c423de Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu May 31 11:19:35 2012 -0400 Kill non-open OR connections with any data on their inbufs. This fixes a DoS issue where a client could send so much data in 5 minutes that they exhausted the server's RAM. Fix for bug 5934 and 6007. Bugfix on 0.2.0.20-rc, which enabled the v2 handshake. --- changes/bug6007 | 5 +++++ src/or/connection_or.c | 22 ++++++++++++++++++++-- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/changes/bug6007 b/changes/bug6007 new file mode 100644 index 0000000..4e81575 --- /dev/null +++ b/changes/bug6007 @@ -0,0 +1,5 @@ + o Major bugfixes (security): + - When waiting for a client to renegotiate, don't allow it to add + any bytes to the input buffer. This fixes a DoS issue. Fix for + bugs 6007 and 5934; bugfix on 0.2.0.20-rc. + diff --git a/src/or/connection_or.c b/src/or/connection_or.c index dc8850e..cb0082b 100644 --- a/src/or/connection_or.c +++ b/src/or/connection_or.c @@ -209,7 +209,12 @@ connection_or_reached_eof(or_connection_t *conn) int connection_or_process_inbuf(or_connection_t *conn) { - int ret; + /** Don't let the inbuf of a nonopen OR connection grow beyond this many + * bytes: it's either a broken client, a non-Tor client, or a DOS + * attempt. */ +#define MAX_OR_INBUF_WHEN_NONOPEN 0 + + int ret = 0; tor_assert(conn); switch (conn->_base.state) { @@ -231,8 +236,21 @@ connection_or_process_inbuf(or_connection_t *conn) case OR_CONN_STATE_OR_HANDSHAKING: return connection_or_process_cells_from_inbuf(conn); default: - return 0; /* don't do anything */ + break; /* don't do anything */ } + + if (buf_datalen(conn->_base.inbuf) > MAX_OR_INBUF_WHEN_NONOPEN) { + log_fn(LOG_PROTOCOL_WARN, LD_NET, "Accumulated too much data (%d bytes) " + "on nonopen OR connection %s %s:%u in state %s; closing.", + (int)buf_datalen(conn->_base.inbuf), + connection_or_nonopen_was_started_here(conn) ? "to" : "from", + conn->_base.address, conn->_base.port, + conn_state_to_string(conn->_base.type, conn->_base.state)); + connection_mark_for_close(TO_CONN(conn)); + ret = -1; + } + + return ret; } /** When adding cells to an OR connection's outbuf, keep adding until the

1 0