November 2019 - tor-commits - lists.torproject.org

[tor/release-0.4.2] config: Log the option name when skipping an obsolete option
by teor＠torproject.org 11 Nov '19

11 Nov '19

commit 2ee04fc309b8f4fb3c34271587ab47addaff32ae Author: teor <teor(a)torproject.org> Date: Mon Nov 11 11:59:50 2019 +1000 config: Log the option name when skipping an obsolete option This is a basic fix for 0.4.2 only. The fix for 0.4.3 and later is in 32404. Fixes bug 32295; bugfix on 0.4.2.1-alpha. --- changes/bug32295 | 3 +++ src/lib/confmgt/type_defs.c | 39 ++++++++++++++++++++++++++------------- src/lib/confmgt/typedvar.c | 11 ++++++----- src/lib/confmgt/typedvar.h | 2 +- src/lib/confmgt/var_type_def_st.h | 5 ++++- 5 files changed, 40 insertions(+), 20 deletions(-) diff --git a/changes/bug32295 b/changes/bug32295 new file mode 100644 index 000000000..e5e5a4399 --- /dev/null +++ b/changes/bug32295 @@ -0,0 +1,3 @@ + o Minor bugfixes (configuration): + - Log the option name when skipping an obsolete option. + Fixes bug 32295; bugfix on 0.4.2.1-alpha. diff --git a/src/lib/confmgt/type_defs.c b/src/lib/confmgt/type_defs.c index ed930fb02..5066e1226 100644 --- a/src/lib/confmgt/type_defs.c +++ b/src/lib/confmgt/type_defs.c @@ -52,10 +52,11 @@ static int string_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)params; (void)errmsg; + (void)key; char **p = (char**)target; *p = tor_strdup(value); return 0; @@ -106,8 +107,10 @@ static const int_parse_params_t INT_PARSE_POSINT = { }; static int -int_parse(void *target, const char *value, char **errmsg, const void *params) +int_parse(void *target, const char *value, char **errmsg, const void *params, + const char *key) { + (void)key; const int_parse_params_t *pp; if (params) { pp = params; @@ -169,10 +172,11 @@ static const var_type_fns_t int_fns = { static int uint64_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)params; (void)errmsg; + (void)key; uint64_t *p = target; int ok=0; *p = tor_parse_uint64(value, 10, 0, UINT64_MAX, &ok, NULL); @@ -219,8 +223,9 @@ static const var_type_fns_t uint64_fns = { static int units_parse_u64(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { + (void)key; const unit_table_t *table = params; tor_assert(table); uint64_t *v = (uint64_t*)target; @@ -235,8 +240,9 @@ units_parse_u64(void *target, const char *value, char **errmsg, static int units_parse_int(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { + (void)key; const unit_table_t *table = params; tor_assert(table); int *v = (int*)target; @@ -283,10 +289,11 @@ static const var_type_fns_t interval_fns = { static int double_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)params; (void)errmsg; + (void)key; double *v = (double*)target; char *endptr=NULL; errno = 0; @@ -347,8 +354,9 @@ typedef struct enumeration_table_t { static int enum_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { + (void)key; const enumeration_table_t *table = params; int *p = (int *)target; for (; table->name; ++table) { @@ -422,9 +430,10 @@ static const var_type_fns_t enum_fns = { static int time_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void) params; + (void) key; time_t *p = target; if (parse_iso_time(value, p) < 0) { tor_asprintf(errmsg, "Invalid time %s", escaped(value)); @@ -466,10 +475,11 @@ static const var_type_fns_t time_fns = { static int csv_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)params; (void)errmsg; + (void)key; smartlist_t **sl = (smartlist_t**)target; *sl = smartlist_new(); smartlist_split_string(*sl, value, ",", @@ -515,7 +525,7 @@ static const var_type_fns_t csv_fns = { static int legacy_csv_interval_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)params; /* We used to have entire smartlists here. But now that all of our @@ -529,7 +539,7 @@ legacy_csv_interval_parse(void *target, const char *value, char **errmsg, val = tmp; } - int rv = units_parse_int(target, val, errmsg, &time_units); + int rv = units_parse_int(target, val, errmsg, &time_units, key); tor_free(tmp); return rv; } @@ -693,14 +703,17 @@ static const var_type_fns_t linelist_s_fns = { static int ignore_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)target; (void)value; (void)errmsg; (void)params; // XXXX move this to a higher level, once such a level exists. - log_warn(LD_GENERAL, "Skipping obsolete configuration option."); + log_warn(LD_GENERAL, "Skipping obsolete configuration option%s%s%s", + key && *key ? " \"" : "", + key && *key ? key : "", + key && *key ? "\"." : "."); return 0; } diff --git a/src/lib/confmgt/typedvar.c b/src/lib/confmgt/typedvar.c index 219a2d15b..ce11a6937 100644 --- a/src/lib/confmgt/typedvar.c +++ b/src/lib/confmgt/typedvar.c @@ -33,7 +33,8 @@ /** * Try to parse a string in value that encodes an object of the type - * defined by def. + * defined by def. If not NULL, key is the name of the option, + * which may be used for logging. * * On success, adjust the lvalue pointed to by target to hold that * value, and return 0. On failure, set *errmsg to a newly allocated @@ -41,7 +42,7 @@ **/ int typed_var_assign(void *target, const char *value, char **errmsg, - const var_type_def_t *def) + const var_type_def_t *def, const char *key) { if (BUG(!def)) return -1; // LCOV_EXCL_LINE @@ -49,7 +50,7 @@ typed_var_assign(void *target, const char *value, char **errmsg, typed_var_free(target, def); tor_assert(def->fns->parse); - return def->fns->parse(target, value, errmsg, def->params); + return def->fns->parse(target, value, errmsg, def->params, key); } /** @@ -75,7 +76,7 @@ typed_var_kvassign(void *target, const config_line_t *line, return def->fns->kv_parse(target, line, errmsg, def->params); } - return typed_var_assign(target, line->value, errmsg, def); + return typed_var_assign(target, line->value, errmsg, def, line->key); } /** @@ -158,7 +159,7 @@ typed_var_copy(void *dest, const void *src, const var_type_def_t *def) return 0; } char *err = NULL; - int rv = typed_var_assign(dest, enc, &err, def); + int rv = typed_var_assign(dest, enc, &err, def, NULL); if (BUG(rv < 0)) { // LCOV_EXCL_START log_warn(LD_BUG, "Encoded value %s was not parseable as a %s: %s", diff --git a/src/lib/confmgt/typedvar.h b/src/lib/confmgt/typedvar.h index 22f2e3c58..438261383 100644 --- a/src/lib/confmgt/typedvar.h +++ b/src/lib/confmgt/typedvar.h @@ -21,7 +21,7 @@ typedef struct var_type_fns_t var_type_fns_t; typedef struct var_type_def_t var_type_def_t; int typed_var_assign(void *target, const char *value, char **errmsg, - const var_type_def_t *def); + const var_type_def_t *def, const char *key); void typed_var_free(void *target, const var_type_def_t *def); char *typed_var_encode(const void *value, const var_type_def_t *def); int typed_var_copy(void *dest, const void *src, const var_type_def_t *def); diff --git a/src/lib/confmgt/var_type_def_st.h b/src/lib/confmgt/var_type_def_st.h index 2bf3d37ca..aa9ded39e 100644 --- a/src/lib/confmgt/var_type_def_st.h +++ b/src/lib/confmgt/var_type_def_st.h @@ -52,9 +52,12 @@ struct var_type_fns_t { * type. On success, adjust the lvalue pointed to by target to hold * that value, and return 0. On failure, set *errmsg to a newly * allocated string holding an error message, and return -1. + * + * If not NULL, key is the name of the option, which may be used for + * logging. **/ int (*parse)(void *target, const char *value, char **errmsg, - const void *params); + const void *params, const char *key); /** * Try to parse a single line from the head ofline that encodes * an object of this type. On success and failure, behave as in the parse()

1 0

[tor/release-0.4.2] Merge branch 'maint-0.4.2' into release-0.4.2
by teor＠torproject.org 11 Nov '19

11 Nov '19

commit 0cfb7f6ce715d1947029c7dd92e6fd79868dc599 Merge: 111f988b5 9be51e8a8 Author: teor <teor(a)torproject.org> Date: Tue Nov 12 10:09:57 2019 +1000 Merge branch 'maint-0.4.2' into release-0.4.2 changes/bug32295 | 3 ++ src/lib/confmgt/type_defs.c | 39 +++++++++++------ src/lib/confmgt/typedvar.c | 11 ++--- src/lib/confmgt/typedvar.h | 2 +- src/lib/confmgt/var_type_def_st.h | 5 ++- src/test/conf_examples/obsolete_1/expected | 0 src/test/conf_examples/obsolete_1/torrc | 68 ++++++++++++++++++++++++++++++ src/test/conf_examples/obsolete_2/expected | 0 src/test/conf_examples/obsolete_2/torrc | 2 + 9 files changed, 110 insertions(+), 20 deletions(-)

1 0

[tor/maint-0.4.2] config: Log the option name when skipping an obsolete option
by teor＠torproject.org 11 Nov '19

11 Nov '19

commit 2ee04fc309b8f4fb3c34271587ab47addaff32ae Author: teor <teor(a)torproject.org> Date: Mon Nov 11 11:59:50 2019 +1000 config: Log the option name when skipping an obsolete option This is a basic fix for 0.4.2 only. The fix for 0.4.3 and later is in 32404. Fixes bug 32295; bugfix on 0.4.2.1-alpha. --- changes/bug32295 | 3 +++ src/lib/confmgt/type_defs.c | 39 ++++++++++++++++++++++++++------------- src/lib/confmgt/typedvar.c | 11 ++++++----- src/lib/confmgt/typedvar.h | 2 +- src/lib/confmgt/var_type_def_st.h | 5 ++++- 5 files changed, 40 insertions(+), 20 deletions(-) diff --git a/changes/bug32295 b/changes/bug32295 new file mode 100644 index 000000000..e5e5a4399 --- /dev/null +++ b/changes/bug32295 @@ -0,0 +1,3 @@ + o Minor bugfixes (configuration): + - Log the option name when skipping an obsolete option. + Fixes bug 32295; bugfix on 0.4.2.1-alpha. diff --git a/src/lib/confmgt/type_defs.c b/src/lib/confmgt/type_defs.c index ed930fb02..5066e1226 100644 --- a/src/lib/confmgt/type_defs.c +++ b/src/lib/confmgt/type_defs.c @@ -52,10 +52,11 @@ static int string_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)params; (void)errmsg; + (void)key; char **p = (char**)target; *p = tor_strdup(value); return 0; @@ -106,8 +107,10 @@ static const int_parse_params_t INT_PARSE_POSINT = { }; static int -int_parse(void *target, const char *value, char **errmsg, const void *params) +int_parse(void *target, const char *value, char **errmsg, const void *params, + const char *key) { + (void)key; const int_parse_params_t *pp; if (params) { pp = params; @@ -169,10 +172,11 @@ static const var_type_fns_t int_fns = { static int uint64_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)params; (void)errmsg; + (void)key; uint64_t *p = target; int ok=0; *p = tor_parse_uint64(value, 10, 0, UINT64_MAX, &ok, NULL); @@ -219,8 +223,9 @@ static const var_type_fns_t uint64_fns = { static int units_parse_u64(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { + (void)key; const unit_table_t *table = params; tor_assert(table); uint64_t *v = (uint64_t*)target; @@ -235,8 +240,9 @@ units_parse_u64(void *target, const char *value, char **errmsg, static int units_parse_int(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { + (void)key; const unit_table_t *table = params; tor_assert(table); int *v = (int*)target; @@ -283,10 +289,11 @@ static const var_type_fns_t interval_fns = { static int double_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)params; (void)errmsg; + (void)key; double *v = (double*)target; char *endptr=NULL; errno = 0; @@ -347,8 +354,9 @@ typedef struct enumeration_table_t { static int enum_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { + (void)key; const enumeration_table_t *table = params; int *p = (int *)target; for (; table->name; ++table) { @@ -422,9 +430,10 @@ static const var_type_fns_t enum_fns = { static int time_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void) params; + (void) key; time_t *p = target; if (parse_iso_time(value, p) < 0) { tor_asprintf(errmsg, "Invalid time %s", escaped(value)); @@ -466,10 +475,11 @@ static const var_type_fns_t time_fns = { static int csv_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)params; (void)errmsg; + (void)key; smartlist_t **sl = (smartlist_t**)target; *sl = smartlist_new(); smartlist_split_string(*sl, value, ",", @@ -515,7 +525,7 @@ static const var_type_fns_t csv_fns = { static int legacy_csv_interval_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)params; /* We used to have entire smartlists here. But now that all of our @@ -529,7 +539,7 @@ legacy_csv_interval_parse(void *target, const char *value, char **errmsg, val = tmp; } - int rv = units_parse_int(target, val, errmsg, &time_units); + int rv = units_parse_int(target, val, errmsg, &time_units, key); tor_free(tmp); return rv; } @@ -693,14 +703,17 @@ static const var_type_fns_t linelist_s_fns = { static int ignore_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)target; (void)value; (void)errmsg; (void)params; // XXXX move this to a higher level, once such a level exists. - log_warn(LD_GENERAL, "Skipping obsolete configuration option."); + log_warn(LD_GENERAL, "Skipping obsolete configuration option%s%s%s", + key && *key ? " \"" : "", + key && *key ? key : "", + key && *key ? "\"." : "."); return 0; } diff --git a/src/lib/confmgt/typedvar.c b/src/lib/confmgt/typedvar.c index 219a2d15b..ce11a6937 100644 --- a/src/lib/confmgt/typedvar.c +++ b/src/lib/confmgt/typedvar.c @@ -33,7 +33,8 @@ /** * Try to parse a string in value that encodes an object of the type - * defined by def. + * defined by def. If not NULL, key is the name of the option, + * which may be used for logging. * * On success, adjust the lvalue pointed to by target to hold that * value, and return 0. On failure, set *errmsg to a newly allocated @@ -41,7 +42,7 @@ **/ int typed_var_assign(void *target, const char *value, char **errmsg, - const var_type_def_t *def) + const var_type_def_t *def, const char *key) { if (BUG(!def)) return -1; // LCOV_EXCL_LINE @@ -49,7 +50,7 @@ typed_var_assign(void *target, const char *value, char **errmsg, typed_var_free(target, def); tor_assert(def->fns->parse); - return def->fns->parse(target, value, errmsg, def->params); + return def->fns->parse(target, value, errmsg, def->params, key); } /** @@ -75,7 +76,7 @@ typed_var_kvassign(void *target, const config_line_t *line, return def->fns->kv_parse(target, line, errmsg, def->params); } - return typed_var_assign(target, line->value, errmsg, def); + return typed_var_assign(target, line->value, errmsg, def, line->key); } /** @@ -158,7 +159,7 @@ typed_var_copy(void *dest, const void *src, const var_type_def_t *def) return 0; } char *err = NULL; - int rv = typed_var_assign(dest, enc, &err, def); + int rv = typed_var_assign(dest, enc, &err, def, NULL); if (BUG(rv < 0)) { // LCOV_EXCL_START log_warn(LD_BUG, "Encoded value %s was not parseable as a %s: %s", diff --git a/src/lib/confmgt/typedvar.h b/src/lib/confmgt/typedvar.h index 22f2e3c58..438261383 100644 --- a/src/lib/confmgt/typedvar.h +++ b/src/lib/confmgt/typedvar.h @@ -21,7 +21,7 @@ typedef struct var_type_fns_t var_type_fns_t; typedef struct var_type_def_t var_type_def_t; int typed_var_assign(void *target, const char *value, char **errmsg, - const var_type_def_t *def); + const var_type_def_t *def, const char *key); void typed_var_free(void *target, const var_type_def_t *def); char *typed_var_encode(const void *value, const var_type_def_t *def); int typed_var_copy(void *dest, const void *src, const var_type_def_t *def); diff --git a/src/lib/confmgt/var_type_def_st.h b/src/lib/confmgt/var_type_def_st.h index 2bf3d37ca..aa9ded39e 100644 --- a/src/lib/confmgt/var_type_def_st.h +++ b/src/lib/confmgt/var_type_def_st.h @@ -52,9 +52,12 @@ struct var_type_fns_t { * type. On success, adjust the lvalue pointed to by target to hold * that value, and return 0. On failure, set *errmsg to a newly * allocated string holding an error message, and return -1. + * + * If not NULL, key is the name of the option, which may be used for + * logging. **/ int (*parse)(void *target, const char *value, char **errmsg, - const void *params); + const void *params, const char *key); /** * Try to parse a single line from the head ofline that encodes * an object of this type. On success and failure, behave as in the parse()

1 0

[tor/maint-0.4.2] test/parseconf: Add tests for ignored options
by teor＠torproject.org 11 Nov '19

11 Nov '19

commit 9be51e8a8e0663a60359f720664defdb4d1d593a Author: teor <teor(a)torproject.org> Date: Mon Nov 11 12:01:31 2019 +1000 test/parseconf: Add tests for ignored options These tests will also pass on 0.4.3, with the original implementation, and with the new implementation in 32404. Part of 32295 and 32404. --- src/test/conf_examples/obsolete_1/expected | 0 src/test/conf_examples/obsolete_1/torrc | 68 ++++++++++++++++++++++++++++++ src/test/conf_examples/obsolete_2/expected | 0 src/test/conf_examples/obsolete_2/torrc | 2 + 4 files changed, 70 insertions(+) diff --git a/src/test/conf_examples/obsolete_1/expected b/src/test/conf_examples/obsolete_1/expected new file mode 100644 index 000000000..e69de29bb diff --git a/src/test/conf_examples/obsolete_1/torrc b/src/test/conf_examples/obsolete_1/torrc new file mode 100644 index 000000000..3cd9a6d77 --- /dev/null +++ b/src/test/conf_examples/obsolete_1/torrc @@ -0,0 +1,68 @@ +# These options are obsolete as of 0.4.2 +AllowDotExit +AllowInvalidNodes +AllowSingleHopCircuits +AllowSingleHopExits +AlternateHSAuthority +AuthDirBadDir +AuthDirBadDirCCs +AuthDirRejectUnlisted +AuthDirListBadDirs +AuthDirMaxServersPerAuthAddr +CircuitIdleTimeout +ControlListenAddress +DirListenAddress +DisableIOCP +DisableV2DirectoryInfo_ +DynamicDHGroups +DNSListenAddress +TestingEnableTbEmptyEvent +ExcludeSingleHopRelays +FallbackNetworkstatusFile +FastFirstHopPK +FetchV2Networkstatus +Group +HidServDirectoryV2 +CloseHSClientCircuitsImmediatelyOnTimeout +CloseHSServiceRendCircuitsImmediatelyOnTimeout +MaxOnionsPending +NamingAuthoritativeDirectory +NATDListenAddress +PredictedPortsRelevanceTime +WarnUnsafeSocks +ORListenAddress +PathBiasDisableRate +PathBiasScaleFactor +PathBiasMultFactor +PathBiasUseCloseCounts +PortForwarding +PortForwardingHelper +PreferTunneledDirConns +RecommendedPackages +RunTesting +SchedulerLowWaterMark__ +SchedulerHighWaterMark__ +SchedulerMaxFlushCells__ +SocksListenAddress +StrictEntryNodes +StrictExitNodes +Support022HiddenServices +Tor2webMode +Tor2webRendezvousPoints +TLSECGroup +TransListenAddress +TunnelDirConns +UseEntryGuardsAsDirGuards +UseNTorHandshake +UserspaceIOCPBuffers +V1AuthoritativeDirectory +V2AuthoritativeDirectory +VoteOnHidServDirectoriesV2 +UseFilteringSSLBufferevents +__UseFilteringSSLBufferevents +TestingConsensusMaxDownloadTries +ClientBootstrapConsensusMaxDownloadTries +ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries +TestingDescriptorMaxDownloadTries +TestingMicrodescMaxDownloadTries +TestingCertMaxDownloadTries diff --git a/src/test/conf_examples/obsolete_2/expected b/src/test/conf_examples/obsolete_2/expected new file mode 100644 index 000000000..e69de29bb diff --git a/src/test/conf_examples/obsolete_2/torrc b/src/test/conf_examples/obsolete_2/torrc new file mode 100644 index 000000000..4f78d4762 --- /dev/null +++ b/src/test/conf_examples/obsolete_2/torrc @@ -0,0 +1,2 @@ +# This option has been obsolete for some time +AllowDotExit

1 0

[tor/master] Merge branch 'maint-0.4.2'
by teor＠torproject.org 11 Nov '19

11 Nov '19

commit 233ccef6d878253ee4f0cfa4610577101b68e6c6 Merge: 3d6ec40e6 9be51e8a8 Author: teor <teor(a)torproject.org> Date: Tue Nov 12 10:10:01 2019 +1000 Merge branch 'maint-0.4.2' src/test/conf_examples/obsolete_1/expected | 0 src/test/conf_examples/obsolete_1/torrc | 68 ++++++++++++++++++++++++++++++ src/test/conf_examples/obsolete_2/expected | 0 src/test/conf_examples/obsolete_2/torrc | 2 + 4 files changed, 70 insertions(+)

1 0

[tor/master] Merge branch 'maint-0.4.2'
by teor＠torproject.org 11 Nov '19

11 Nov '19

commit 3d6ec40e6a0ad2658a49a1b02bbf93f1a731fe73 Merge: 3d1a7d7dd 2ee04fc30 Author: teor <teor(a)torproject.org> Date: Tue Nov 12 10:07:46 2019 +1000 Merge branch 'maint-0.4.2' "git merge --strategy ours", because: * 32295 is a quick fix for 0.4.2 only * 32404 has a better implementation for master

1 0

[tor/master] config: Log the option name when skipping an obsolete option
by teor＠torproject.org 11 Nov '19

11 Nov '19

commit 2ee04fc309b8f4fb3c34271587ab47addaff32ae Author: teor <teor(a)torproject.org> Date: Mon Nov 11 11:59:50 2019 +1000 config: Log the option name when skipping an obsolete option This is a basic fix for 0.4.2 only. The fix for 0.4.3 and later is in 32404. Fixes bug 32295; bugfix on 0.4.2.1-alpha. --- changes/bug32295 | 3 +++ src/lib/confmgt/type_defs.c | 39 ++++++++++++++++++++++++++------------- src/lib/confmgt/typedvar.c | 11 ++++++----- src/lib/confmgt/typedvar.h | 2 +- src/lib/confmgt/var_type_def_st.h | 5 ++++- 5 files changed, 40 insertions(+), 20 deletions(-) diff --git a/changes/bug32295 b/changes/bug32295 new file mode 100644 index 000000000..e5e5a4399 --- /dev/null +++ b/changes/bug32295 @@ -0,0 +1,3 @@ + o Minor bugfixes (configuration): + - Log the option name when skipping an obsolete option. + Fixes bug 32295; bugfix on 0.4.2.1-alpha. diff --git a/src/lib/confmgt/type_defs.c b/src/lib/confmgt/type_defs.c index ed930fb02..5066e1226 100644 --- a/src/lib/confmgt/type_defs.c +++ b/src/lib/confmgt/type_defs.c @@ -52,10 +52,11 @@ static int string_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)params; (void)errmsg; + (void)key; char **p = (char**)target; *p = tor_strdup(value); return 0; @@ -106,8 +107,10 @@ static const int_parse_params_t INT_PARSE_POSINT = { }; static int -int_parse(void *target, const char *value, char **errmsg, const void *params) +int_parse(void *target, const char *value, char **errmsg, const void *params, + const char *key) { + (void)key; const int_parse_params_t *pp; if (params) { pp = params; @@ -169,10 +172,11 @@ static const var_type_fns_t int_fns = { static int uint64_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)params; (void)errmsg; + (void)key; uint64_t *p = target; int ok=0; *p = tor_parse_uint64(value, 10, 0, UINT64_MAX, &ok, NULL); @@ -219,8 +223,9 @@ static const var_type_fns_t uint64_fns = { static int units_parse_u64(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { + (void)key; const unit_table_t *table = params; tor_assert(table); uint64_t *v = (uint64_t*)target; @@ -235,8 +240,9 @@ units_parse_u64(void *target, const char *value, char **errmsg, static int units_parse_int(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { + (void)key; const unit_table_t *table = params; tor_assert(table); int *v = (int*)target; @@ -283,10 +289,11 @@ static const var_type_fns_t interval_fns = { static int double_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)params; (void)errmsg; + (void)key; double *v = (double*)target; char *endptr=NULL; errno = 0; @@ -347,8 +354,9 @@ typedef struct enumeration_table_t { static int enum_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { + (void)key; const enumeration_table_t *table = params; int *p = (int *)target; for (; table->name; ++table) { @@ -422,9 +430,10 @@ static const var_type_fns_t enum_fns = { static int time_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void) params; + (void) key; time_t *p = target; if (parse_iso_time(value, p) < 0) { tor_asprintf(errmsg, "Invalid time %s", escaped(value)); @@ -466,10 +475,11 @@ static const var_type_fns_t time_fns = { static int csv_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)params; (void)errmsg; + (void)key; smartlist_t **sl = (smartlist_t**)target; *sl = smartlist_new(); smartlist_split_string(*sl, value, ",", @@ -515,7 +525,7 @@ static const var_type_fns_t csv_fns = { static int legacy_csv_interval_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)params; /* We used to have entire smartlists here. But now that all of our @@ -529,7 +539,7 @@ legacy_csv_interval_parse(void *target, const char *value, char **errmsg, val = tmp; } - int rv = units_parse_int(target, val, errmsg, &time_units); + int rv = units_parse_int(target, val, errmsg, &time_units, key); tor_free(tmp); return rv; } @@ -693,14 +703,17 @@ static const var_type_fns_t linelist_s_fns = { static int ignore_parse(void *target, const char *value, char **errmsg, - const void *params) + const void *params, const char *key) { (void)target; (void)value; (void)errmsg; (void)params; // XXXX move this to a higher level, once such a level exists. - log_warn(LD_GENERAL, "Skipping obsolete configuration option."); + log_warn(LD_GENERAL, "Skipping obsolete configuration option%s%s%s", + key && *key ? " \"" : "", + key && *key ? key : "", + key && *key ? "\"." : "."); return 0; } diff --git a/src/lib/confmgt/typedvar.c b/src/lib/confmgt/typedvar.c index 219a2d15b..ce11a6937 100644 --- a/src/lib/confmgt/typedvar.c +++ b/src/lib/confmgt/typedvar.c @@ -33,7 +33,8 @@ /** * Try to parse a string in value that encodes an object of the type - * defined by def. + * defined by def. If not NULL, key is the name of the option, + * which may be used for logging. * * On success, adjust the lvalue pointed to by target to hold that * value, and return 0. On failure, set *errmsg to a newly allocated @@ -41,7 +42,7 @@ **/ int typed_var_assign(void *target, const char *value, char **errmsg, - const var_type_def_t *def) + const var_type_def_t *def, const char *key) { if (BUG(!def)) return -1; // LCOV_EXCL_LINE @@ -49,7 +50,7 @@ typed_var_assign(void *target, const char *value, char **errmsg, typed_var_free(target, def); tor_assert(def->fns->parse); - return def->fns->parse(target, value, errmsg, def->params); + return def->fns->parse(target, value, errmsg, def->params, key); } /** @@ -75,7 +76,7 @@ typed_var_kvassign(void *target, const config_line_t *line, return def->fns->kv_parse(target, line, errmsg, def->params); } - return typed_var_assign(target, line->value, errmsg, def); + return typed_var_assign(target, line->value, errmsg, def, line->key); } /** @@ -158,7 +159,7 @@ typed_var_copy(void *dest, const void *src, const var_type_def_t *def) return 0; } char *err = NULL; - int rv = typed_var_assign(dest, enc, &err, def); + int rv = typed_var_assign(dest, enc, &err, def, NULL); if (BUG(rv < 0)) { // LCOV_EXCL_START log_warn(LD_BUG, "Encoded value %s was not parseable as a %s: %s", diff --git a/src/lib/confmgt/typedvar.h b/src/lib/confmgt/typedvar.h index 22f2e3c58..438261383 100644 --- a/src/lib/confmgt/typedvar.h +++ b/src/lib/confmgt/typedvar.h @@ -21,7 +21,7 @@ typedef struct var_type_fns_t var_type_fns_t; typedef struct var_type_def_t var_type_def_t; int typed_var_assign(void *target, const char *value, char **errmsg, - const var_type_def_t *def); + const var_type_def_t *def, const char *key); void typed_var_free(void *target, const var_type_def_t *def); char *typed_var_encode(const void *value, const var_type_def_t *def); int typed_var_copy(void *dest, const void *src, const var_type_def_t *def); diff --git a/src/lib/confmgt/var_type_def_st.h b/src/lib/confmgt/var_type_def_st.h index 2bf3d37ca..aa9ded39e 100644 --- a/src/lib/confmgt/var_type_def_st.h +++ b/src/lib/confmgt/var_type_def_st.h @@ -52,9 +52,12 @@ struct var_type_fns_t { * type. On success, adjust the lvalue pointed to by target to hold * that value, and return 0. On failure, set *errmsg to a newly * allocated string holding an error message, and return -1. + * + * If not NULL, key is the name of the option, which may be used for + * logging. **/ int (*parse)(void *target, const char *value, char **errmsg, - const void *params); + const void *params, const char *key); /** * Try to parse a single line from the head ofline that encodes * an object of this type. On success and failure, behave as in the parse()

1 0

[tor/master] test/parseconf: Add tests for ignored options
by teor＠torproject.org 11 Nov '19

11 Nov '19

commit 9be51e8a8e0663a60359f720664defdb4d1d593a Author: teor <teor(a)torproject.org> Date: Mon Nov 11 12:01:31 2019 +1000 test/parseconf: Add tests for ignored options These tests will also pass on 0.4.3, with the original implementation, and with the new implementation in 32404. Part of 32295 and 32404. --- src/test/conf_examples/obsolete_1/expected | 0 src/test/conf_examples/obsolete_1/torrc | 68 ++++++++++++++++++++++++++++++ src/test/conf_examples/obsolete_2/expected | 0 src/test/conf_examples/obsolete_2/torrc | 2 + 4 files changed, 70 insertions(+) diff --git a/src/test/conf_examples/obsolete_1/expected b/src/test/conf_examples/obsolete_1/expected new file mode 100644 index 000000000..e69de29bb diff --git a/src/test/conf_examples/obsolete_1/torrc b/src/test/conf_examples/obsolete_1/torrc new file mode 100644 index 000000000..3cd9a6d77 --- /dev/null +++ b/src/test/conf_examples/obsolete_1/torrc @@ -0,0 +1,68 @@ +# These options are obsolete as of 0.4.2 +AllowDotExit +AllowInvalidNodes +AllowSingleHopCircuits +AllowSingleHopExits +AlternateHSAuthority +AuthDirBadDir +AuthDirBadDirCCs +AuthDirRejectUnlisted +AuthDirListBadDirs +AuthDirMaxServersPerAuthAddr +CircuitIdleTimeout +ControlListenAddress +DirListenAddress +DisableIOCP +DisableV2DirectoryInfo_ +DynamicDHGroups +DNSListenAddress +TestingEnableTbEmptyEvent +ExcludeSingleHopRelays +FallbackNetworkstatusFile +FastFirstHopPK +FetchV2Networkstatus +Group +HidServDirectoryV2 +CloseHSClientCircuitsImmediatelyOnTimeout +CloseHSServiceRendCircuitsImmediatelyOnTimeout +MaxOnionsPending +NamingAuthoritativeDirectory +NATDListenAddress +PredictedPortsRelevanceTime +WarnUnsafeSocks +ORListenAddress +PathBiasDisableRate +PathBiasScaleFactor +PathBiasMultFactor +PathBiasUseCloseCounts +PortForwarding +PortForwardingHelper +PreferTunneledDirConns +RecommendedPackages +RunTesting +SchedulerLowWaterMark__ +SchedulerHighWaterMark__ +SchedulerMaxFlushCells__ +SocksListenAddress +StrictEntryNodes +StrictExitNodes +Support022HiddenServices +Tor2webMode +Tor2webRendezvousPoints +TLSECGroup +TransListenAddress +TunnelDirConns +UseEntryGuardsAsDirGuards +UseNTorHandshake +UserspaceIOCPBuffers +V1AuthoritativeDirectory +V2AuthoritativeDirectory +VoteOnHidServDirectoriesV2 +UseFilteringSSLBufferevents +__UseFilteringSSLBufferevents +TestingConsensusMaxDownloadTries +ClientBootstrapConsensusMaxDownloadTries +ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries +TestingDescriptorMaxDownloadTries +TestingMicrodescMaxDownloadTries +TestingCertMaxDownloadTries diff --git a/src/test/conf_examples/obsolete_2/expected b/src/test/conf_examples/obsolete_2/expected new file mode 100644 index 000000000..e69de29bb diff --git a/src/test/conf_examples/obsolete_2/torrc b/src/test/conf_examples/obsolete_2/torrc new file mode 100644 index 000000000..4f78d4762 --- /dev/null +++ b/src/test/conf_examples/obsolete_2/torrc @@ -0,0 +1,2 @@ +# This option has been obsolete for some time +AllowDotExit

1 0

[snowflake/master] Stop using custom websocket library in server
by arlo＠torproject.org 11 Nov '19

11 Nov '19

commit c417fd5599c5d39951c606856c69a9f05941afd3 Author: Arlo Breault <arlolra(a)gmail.com> Date: Wed Oct 16 21:00:13 2019 -0400 Stop using custom websocket library in server Trac: 31028 --- .travis.yml | 2 +- server/server.go | 88 +++++++++++++++++++++++++++++++++----------------------- 2 files changed, 53 insertions(+), 37 deletions(-) diff --git a/.travis.yml b/.travis.yml index 9ed48bb..2f02f74 100644 --- a/.travis.yml +++ b/.travis.yml @@ -26,8 +26,8 @@ install: - go get -u github.com/keroserene/go-webrtc - go get -u github.com/pion/webrtc - go get -u github.com/dchest/uniuri + - go get -u github.com/gorilla/websocket - go get -u git.torproject.org/pluggable-transports/goptlib.git - - go get -u git.torproject.org/pluggable-transports/websocket.git/websocket - go get -u google.golang.org/appengine - go get -u golang.org/x/crypto/acme/autocert - go get -u golang.org/x/net/http2 diff --git a/server/server.go b/server/server.go index b1b566a..d111fce 100644 --- a/server/server.go +++ b/server/server.go @@ -21,7 +21,7 @@ import ( pt "git.torproject.org/pluggable-transports/goptlib.git" "git.torproject.org/pluggable-transports/snowflake.git/common/safelog" - "git.torproject.org/pluggable-transports/websocket.git/websocket" + "github.com/gorilla/websocket" "golang.org/x/crypto/acme/autocert" "golang.org/x/net/http2" ) @@ -53,50 +53,60 @@ additional HTTP listener on port 80 to work with ACME. // An abstraction that makes an underlying WebSocket connection look like an // io.ReadWriteCloser. type webSocketConn struct { - Ws *websocket.WebSocket - messageBuf []byte + Ws *websocket.Conn + r io.Reader } // Implements io.Reader. func (conn *webSocketConn) Read(b []byte) (n int, err error) { - for len(conn.messageBuf) == 0 { - var m websocket.Message - m, err = conn.Ws.ReadMessage() - if err != nil { - return - } - if m.Opcode == 8 { - err = io.EOF - return - } - if m.Opcode != 2 { - err = fmt.Errorf("got non-binary opcode %d", m.Opcode) - return + var opCode int + if conn.r == nil { + // New message + var r io.Reader + for { + if opCode, r, err = conn.Ws.NextReader(); err != nil { + return + } + if opCode != websocket.BinaryMessage && opCode != websocket.TextMessage { + continue + } + + conn.r = r + break } - conn.messageBuf = m.Payload } - n = copy(b, conn.messageBuf) - conn.messageBuf = conn.messageBuf[n:] - + n, err = conn.r.Read(b) + if err != nil { + if err == io.EOF { + // Message finished + conn.r = nil + err = nil + } + } return } // Implements io.Writer. -func (conn *webSocketConn) Write(b []byte) (int, error) { - err := conn.Ws.WriteMessage(2, b) - return len(b), err +func (conn *webSocketConn) Write(b []byte) (n int, err error) { + var w io.WriteCloser + if w, err = conn.Ws.NextWriter(websocket.BinaryMessage); err != nil { + return + } + if n, err = w.Write(b); err != nil { + return + } + err = w.Close() + return } // Implements io.Closer. func (conn *webSocketConn) Close() error { - // Ignore any error in trying to write a Close frame. - _ = conn.Ws.WriteFrame(8, nil) - return conn.Ws.Conn.Close() + return conn.Ws.Close() } // Create a new webSocketConn. -func newWebSocketConn(ws *websocket.WebSocket) webSocketConn { +func newWebSocketConn(ws *websocket.Conn) webSocketConn { var conn webSocketConn conn.Ws = ws return conn @@ -145,16 +155,22 @@ func clientAddr(clientIPParam string) string { return (&net.TCPAddr{IP: clientIP, Port: 1, Zone: ""}).String() } -func webSocketHandler(ws *websocket.WebSocket) { - // Undo timeouts on HTTP request handling. - if err := ws.Conn.SetDeadline(time.Time{}); err != nil { - log.Printf("unable to set deadlines with error: %v", err) +var upgrader = websocket.Upgrader{} + +type HTTPHandler struct{} + +func (handler *HTTPHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { + ws, err := upgrader.Upgrade(w, r, nil) + if err != nil { + log.Println(err) + return } + conn := newWebSocketConn(ws) defer conn.Close() // Pass the address of client as the remote address of incoming connection - clientIPParam := ws.Request().URL.Query().Get("client_ip") + clientIPParam := r.URL.Query().Get("client_ip") addr := clientAddr(clientIPParam) if addr == "" { statsChannel <- false @@ -162,7 +178,6 @@ func webSocketHandler(ws *websocket.WebSocket) { statsChannel <- true } or, err := pt.DialOr(&ptInfo, addr, ptMethodName) - if err != nil { log.Printf("failed to connect to ORPort: %s", err) return @@ -185,11 +200,12 @@ func initServer(addr *net.TCPAddr, return nil, fmt.Errorf("cannot listen on port %d; configure a port using ServerTransportListenAddr", addr.Port) } - var config websocket.Config - config.MaxMessageSize = maxMessageSize + upgrader.CheckOrigin = func(r *http.Request) bool { return true } + + var handler HTTPHandler server := &http.Server{ Addr: addr.String(), - Handler: config.Handler(webSocketHandler), + Handler: &handler, ReadTimeout: requestTimeout, } // We need to override server.TLSConfig.GetCertificate--but first

1 0

[snowflake/master] Restore sending close message before closing
by arlo＠torproject.org 11 Nov '19

11 Nov '19

commit abefae158716b9f56692ea16336c1f8185eda27e Author: Arlo Breault <arlolra(a)gmail.com> Date: Mon Nov 11 16:59:33 2019 -0500 Restore sending close message before closing And simplify EOF check. --- server/server.go | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/server/server.go b/server/server.go index d111fce..ce804fc 100644 --- a/server/server.go +++ b/server/server.go @@ -77,12 +77,10 @@ func (conn *webSocketConn) Read(b []byte) (n int, err error) { } n, err = conn.r.Read(b) - if err != nil { - if err == io.EOF { - // Message finished - conn.r = nil - err = nil - } + if err == io.EOF { + // Message finished + conn.r = nil + err = nil } return } @@ -102,6 +100,8 @@ func (conn *webSocketConn) Write(b []byte) (n int, err error) { // Implements io.Closer. func (conn *webSocketConn) Close() error { + // Ignore any error in trying to write a Close frame. + _ = conn.Ws.WriteControl(websocket.CloseMessage, []byte{}, time.Now().Add(time.Second)) return conn.Ws.Close() }

1 0