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

[tor/master] Use C99 struct-initializer syntax in COMMANDLINE_ONLY_OPTIONS
by nickm＠torproject.org 17 Oct '19

17 Oct '19

commit bd5ce112c92b81a98023513a53ecd64cf44122fe Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Oct 8 10:54:57 2019 -0400 Use C99 struct-initializer syntax in COMMANDLINE_ONLY_OPTIONS I'm about to add more fields to this table, and this syntax change will make it easier to do so. --- src/app/config/config.c | 54 +++++++++++++++++++++++++++---------------------- 1 file changed, 30 insertions(+), 24 deletions(-) diff --git a/src/app/config/config.c b/src/app/config/config.c index 44d6a82e5..26b104802 100644 --- a/src/app/config/config.c +++ b/src/app/config/config.c @@ -2463,30 +2463,36 @@ static const struct { const char *name; takes_argument_t takes_argument; } CMDLINE_ONLY_OPTIONS[] = { - { "-f", ARGUMENT_NECESSARY }, - { "--allow-missing-torrc", ARGUMENT_NONE }, - { "--defaults-torrc", ARGUMENT_NECESSARY }, - { "--hash-password", ARGUMENT_NECESSARY }, - { "--dump-config", ARGUMENT_OPTIONAL }, - { "--list-fingerprint", ARGUMENT_NONE }, - { "--keygen", ARGUMENT_NONE }, - { "--key-expiration", ARGUMENT_OPTIONAL }, - { "--newpass", ARGUMENT_NONE }, - { "--no-passphrase", ARGUMENT_NONE }, - { "--passphrase-fd", ARGUMENT_NECESSARY }, - { "--verify-config", ARGUMENT_NONE }, - { "--ignore-missing-torrc", ARGUMENT_NONE }, - { "--quiet", ARGUMENT_NONE }, - { "--hush", ARGUMENT_NONE }, - { "--version", ARGUMENT_NONE }, - { "--list-modules", ARGUMENT_NONE }, - { "--library-versions", ARGUMENT_NONE }, - { "-h", ARGUMENT_NONE }, - { "--help", ARGUMENT_NONE }, - { "--list-torrc-options", ARGUMENT_NONE }, - { "--list-deprecated-options",ARGUMENT_NONE }, - { "--nt-service", ARGUMENT_NONE }, - { "-nt-service", ARGUMENT_NONE }, + { .name="-f", + .takes_argument=ARGUMENT_NECESSARY }, + { .name="--allow-missing-torrc" }, + { .name="--defaults-torrc", + .takes_argument=ARGUMENT_NECESSARY }, + { .name="--hash-password", + .takes_argument=ARGUMENT_NECESSARY }, + { .name="--dump-config", + .takes_argument=ARGUMENT_OPTIONAL }, + { .name="--list-fingerprint" }, + { .name="--keygen" }, + { .name="--key-expiration", + .takes_argument=ARGUMENT_OPTIONAL }, + { .name="--newpass" }, + { .name="--no-passphrase" }, + { .name="--passphrase-fd", + .takes_argument=ARGUMENT_NECESSARY }, + { .name="--verify-config" }, + { .name="--ignore-missing-torrc" }, + { .name="--quiet" }, + { .name="--hush" }, + { .name="--version" }, + { .name="--list-modules" }, + { .name="--library-versions" }, + { .name="-h" }, + { .name="--help" }, + { .name="--list-torrc-options" }, + { .name="--list-deprecated-options" }, + { .name="--nt-service" }, + { .name="-nt-service" }, { NULL, 0 }, };

1 0

[tor/master] Rename CMD_OTHER to CMD_IMMEDIATE
by nickm＠torproject.org 17 Oct '19

17 Oct '19

commit b9f002dec6fac7276a34371e6183db0f4cd8560a Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Oct 16 16:39:58 2019 -0400 Rename CMD_OTHER to CMD_IMMEDIATE --- src/app/config/config.c | 18 +++++++++--------- src/app/config/tor_cmdline_mode.h | 4 ++-- src/app/main/main.c | 2 +- src/app/main/ntmain.c | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/src/app/config/config.c b/src/app/config/config.c index cc5bc8827..522c3b572 100644 --- a/src/app/config/config.c +++ b/src/app/config/config.c @@ -2494,25 +2494,25 @@ static const struct { { .name="--hush", .quiet=1 }, { .name="--version", - .command=CMD_OTHER, + .command=CMD_IMMEDIATE, .quiet=1 }, { .name="--list-modules", - .command=CMD_OTHER, + .command=CMD_IMMEDIATE, .quiet=1 }, { .name="--library-versions", - .command=CMD_OTHER, + .command=CMD_IMMEDIATE, .quiet=1 }, { .name="-h", - .command=CMD_OTHER, + .command=CMD_IMMEDIATE, .quiet=1 }, { .name="--help", - .command=CMD_OTHER, + .command=CMD_IMMEDIATE, .quiet=1 }, { .name="--list-torrc-options", - .command=CMD_OTHER, + .command=CMD_IMMEDIATE, .quiet=1 }, { .name="--list-deprecated-options", - .command=CMD_OTHER }, + .command=CMD_IMMEDIATE }, { .name="--nt-service" }, { .name="-nt-service" }, { .name=NULL }, @@ -5321,8 +5321,8 @@ options_init_from_torrc(int argc, char **argv) int command = global_cmdline->command; const char *command_arg = global_cmdline->command_arg; - /* "Other" has already been handled by this point. */ - tor_assert(command != CMD_OTHER); + /* "immediate" has already been handled by this point. */ + tor_assert(command != CMD_IMMEDIATE); if (command == CMD_HASH_PASSWORD) { cf_defaults = tor_strdup(""); diff --git a/src/app/config/tor_cmdline_mode.h b/src/app/config/tor_cmdline_mode.h index 36626bed5..b2c43bbb8 100644 --- a/src/app/config/tor_cmdline_mode.h +++ b/src/app/config/tor_cmdline_mode.h @@ -24,8 +24,8 @@ typedef enum { CMD_DUMP_CONFIG, /**< Running --dump-config. */ CMD_KEYGEN, /**< Running --keygen */ CMD_KEY_EXPIRATION, /**< Running --key-expiration */ - CMD_OTHER, /**< Special value: indicates a command that is handled - * immediately during configuration processing. */ + CMD_IMMEDIATE, /**< Special value: indicates a command that is handled + * immediately during configuration processing. */ CMD_RUN_UNITTESTS, /**< Special value: indicates that we have entered * the Tor code from the unit tests, not from the * regular Tor binary at all. */ diff --git a/src/app/main/main.c b/src/app/main/main.c index 95dccbee6..22694fdbb 100644 --- a/src/app/main/main.c +++ b/src/app/main/main.c @@ -1339,7 +1339,7 @@ tor_run_main(const tor_main_configuration_t *tor_cfg) result = do_dump_config(); break; case CMD_RUN_UNITTESTS: /* only set by test.c */ - case CMD_OTHER: /* Handled in config.c */ + case CMD_IMMEDIATE: /* Handled in config.c */ default: log_warn(LD_BUG,"Illegal command number %d: internal error.", get_options()->command); diff --git a/src/app/main/ntmain.c b/src/app/main/ntmain.c index 16dc72acc..9351d9687 100644 --- a/src/app/main/ntmain.c +++ b/src/app/main/ntmain.c @@ -340,7 +340,7 @@ nt_service_main(void) "or --key-expiration) in NT service."); break; case CMD_RUN_UNITTESTS: - case CMD_OTHER: + case CMD_IMMEDIATE: default: log_err(LD_CONFIG, "Illegal command number %d: internal error.", get_options()->command);

1 0

[tor/master] Add a test for a command-line option without a value.
by nickm＠torproject.org 17 Oct '19

17 Oct '19

commit 763d955a17ba6c6c6e5487357c672b0cae3d607c Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Oct 8 15:58:14 2019 -0400 Add a test for a command-line option without a value. --- src/test/conf_examples/missing_cl_arg/cmdline | 1 + src/test/conf_examples/missing_cl_arg/error | 1 + src/test/conf_examples/missing_cl_arg/torrc | 0 3 files changed, 2 insertions(+) diff --git a/src/test/conf_examples/missing_cl_arg/cmdline b/src/test/conf_examples/missing_cl_arg/cmdline new file mode 100644 index 000000000..7fc4d0a54 --- /dev/null +++ b/src/test/conf_examples/missing_cl_arg/cmdline @@ -0,0 +1 @@ +--hash-password diff --git a/src/test/conf_examples/missing_cl_arg/error b/src/test/conf_examples/missing_cl_arg/error new file mode 100644 index 000000000..61dbeac8a --- /dev/null +++ b/src/test/conf_examples/missing_cl_arg/error @@ -0,0 +1 @@ +Command-line option '--hash-password' with no value. diff --git a/src/test/conf_examples/missing_cl_arg/torrc b/src/test/conf_examples/missing_cl_arg/torrc new file mode 100644 index 000000000..e69de29bb

1 0

[tor/master] fixup! Print the error message for --dump-config even if no arguments are given.
by nickm＠torproject.org 17 Oct '19

17 Oct '19

commit d15223a3858446cda55fd7e062301f697bee1db3 Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Oct 16 16:31:17 2019 -0400 fixup! Print the error message for --dump-config even if no arguments are given. Fix a spelling error. --- src/app/config/config.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/app/config/config.c b/src/app/config/config.c index ea6a5e233..cc5bc8827 100644 --- a/src/app/config/config.c +++ b/src/app/config/config.c @@ -2446,7 +2446,7 @@ typedef enum { ARGUMENT_NONE = 0, /** Describes an option that takes a single argument. */ ARGUMENT_NECESSARY = 1, - /** Describes an option that takes a single optinal argument. */ + /** Describes an option that takes a single optional argument. */ ARGUMENT_OPTIONAL = 2 } takes_argument_t;

1 0

[tor/master] Use an enum for quiet_level.
by nickm＠torproject.org 17 Oct '19

17 Oct '19

commit d97d7f0e48495e0b354b30b79992da822d12c15d Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Oct 16 16:49:54 2019 -0400 Use an enum for quiet_level. --- src/app/config/config.c | 22 +++++++++++----------- src/app/config/config.h | 6 +++--- src/app/config/quiet_level.h | 28 ++++++++++++++++++++++++++++ src/app/main/main.c | 18 ++++++++++-------- src/core/include.am | 1 + src/core/mainloop/mainloop.h | 1 - 6 files changed, 53 insertions(+), 23 deletions(-) diff --git a/src/app/config/config.c b/src/app/config/config.c index 522c3b572..37eab2291 100644 --- a/src/app/config/config.c +++ b/src/app/config/config.c @@ -2470,11 +2470,11 @@ static const struct { { .name="--hash-password", .takes_argument=ARGUMENT_NECESSARY, .command=CMD_HASH_PASSWORD, - .quiet=1 }, + .quiet=QUIET_HUSH }, { .name="--dump-config", .takes_argument=ARGUMENT_OPTIONAL, .command=CMD_DUMP_CONFIG, - .quiet=2 }, + .quiet=QUIET_SILENT }, { .name="--list-fingerprint", .command=CMD_LIST_FINGERPRINT }, { .name="--keygen", @@ -2490,27 +2490,27 @@ static const struct { .command=CMD_VERIFY_CONFIG }, { .name="--ignore-missing-torrc" }, { .name="--quiet", - .quiet=2 }, + .quiet=QUIET_SILENT }, { .name="--hush", - .quiet=1 }, + .quiet=QUIET_HUSH }, { .name="--version", .command=CMD_IMMEDIATE, - .quiet=1 }, + .quiet=QUIET_HUSH }, { .name="--list-modules", .command=CMD_IMMEDIATE, - .quiet=1 }, + .quiet=QUIET_HUSH }, { .name="--library-versions", .command=CMD_IMMEDIATE, - .quiet=1 }, + .quiet=QUIET_HUSH }, { .name="-h", .command=CMD_IMMEDIATE, - .quiet=1 }, + .quiet=QUIET_HUSH }, { .name="--help", .command=CMD_IMMEDIATE, - .quiet=1 }, + .quiet=QUIET_HUSH }, { .name="--list-torrc-options", .command=CMD_IMMEDIATE, - .quiet=1 }, + .quiet=QUIET_HUSH }, { .name="--list-deprecated-options", .command=CMD_IMMEDIATE }, { .name="--nt-service" }, @@ -2553,7 +2553,7 @@ config_parse_commandline(int argc, char **argv, int ignore_errors) is_a_command = true; result->command = CMDLINE_ONLY_OPTIONS[j].command; } - int quiet = CMDLINE_ONLY_OPTIONS[j].quiet; + quiet_level_t quiet = CMDLINE_ONLY_OPTIONS[j].quiet; if (quiet > result->quiet_level) result->quiet_level = quiet; break; diff --git a/src/app/config/config.h b/src/app/config/config.h index 8fc10d504..e5b687c31 100644 --- a/src/app/config/config.h +++ b/src/app/config/config.h @@ -14,6 +14,7 @@ #include "app/config/or_options_st.h" #include "lib/testsupport/testsupport.h" +#include "app/config/quiet_level.h" #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(DARWIN) #define KERNEL_MAY_SUPPORT_IPFW @@ -208,9 +209,8 @@ typedef struct { tor_cmdline_mode_t command; /** Argument for the command mode, if any. */ const char *command_arg; - /** How quiet have we been told to be? 1 for "hush", and 2 for "quiet". - */ - int quiet_level; + /** How quiet have we been told to be? */ + quiet_level_t quiet_level; } parsed_cmdline_t; parsed_cmdline_t *config_parse_commandline(int argc, char **argv, diff --git a/src/app/config/quiet_level.h b/src/app/config/quiet_level.h new file mode 100644 index 000000000..e90ec3f27 --- /dev/null +++ b/src/app/config/quiet_level.h @@ -0,0 +1,28 @@ +/* Copyright (c) 2001 Matej Pfajfar. + * Copyright (c) 2001-2004, Roger Dingledine. + * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson. + * Copyright (c) 2007-2019, The Tor Project, Inc. */ +/* See LICENSE for licensing information */ + +/** + * \file quiet_level.h + * \brief Declare the quiet_level enumeration and global. + **/ + +#ifndef QUIET_LEVEL_H +#define QUIET_LEVEL_H + +/** Enumeration to define how quietly Tor should log at startup. */ +typedef enum { + /** Default quiet level: we log everything of level NOTICE or higher. */ + QUIET_NONE = 0, + /** "--hush" quiet level: we log everything of level WARNING or higher. */ + QUIET_HUSH = 1 , + /** "--quiet" quiet level: we log nothing at all. */ + QUIET_SILENT = 2 +} quiet_level_t; + +/** How quietly should Tor log at startup? */ +extern quiet_level_t quiet_level; + +#endif /* !defined(QUIET_LEVEL_H) */ diff --git a/src/app/main/main.c b/src/app/main/main.c index 22694fdbb..2d7579336 100644 --- a/src/app/main/main.c +++ b/src/app/main/main.c @@ -13,6 +13,7 @@ #include "app/config/config.h" #include "app/config/statefile.h" +#include "app/config/quiet_level.h" #include "app/main/main.h" #include "app/main/ntmain.h" #include "app/main/shutdown.h" @@ -110,11 +111,11 @@ static void process_signal(int sig); /********* START VARIABLES **********/ -/** Decides our behavior when no logs are configured/before any - * logs have been configured. For 0, we log notice to stdout as normal. - * For 1, we log warnings only. For 2, we log nothing. +/** Decides our behavior when no logs are configured/before any logs have been + * configured. For QUIET_NONE, we log notice to stdout as normal. For + * QUIET_HUSH, we log warnings only. For QUIET_SILENT, we log nothing. */ -int quiet_level = 0; +quiet_level_t quiet_level = 0; /********* END VARIABLES ************/ @@ -528,7 +529,7 @@ int tor_init(int argc, char *argv[]) { char progname[256]; - int quiet = 0; + quiet_level_t quiet = QUIET_NONE; time_of_process_start = time(NULL); tor_init_connection_lists(); @@ -558,13 +559,14 @@ tor_init(int argc, char *argv[]) /* give it somewhere to log to initially */ switch (quiet) { - case 2: + case QUIET_SILENT: /* --quiet: no initial logging */ break; - case 1: + case QUIET_HUSH: /* --hush: log at warning or higher. */ add_temp_log(LOG_WARN); break; + case QUIET_NONE: /* fall through */ default: add_temp_log(LOG_NOTICE); } @@ -1331,7 +1333,7 @@ tor_run_main(const tor_main_configuration_t *tor_cfg) result = 0; break; case CMD_VERIFY_CONFIG: - if (quiet_level == 0) + if (quiet_level == QUIET_NONE) printf("Configuration was valid\n"); result = 0; break; diff --git a/src/core/include.am b/src/core/include.am index 64004da34..92fb2c213 100644 --- a/src/core/include.am +++ b/src/core/include.am @@ -215,6 +215,7 @@ noinst_HEADERS += \ src/app/config/config.h \ src/app/config/or_options_st.h \ src/app/config/or_state_st.h \ + src/app/config/quiet_level.h \ src/app/config/statefile.h \ src/app/config/tor_cmdline_mode.h \ src/app/main/main.h \ diff --git a/src/core/mainloop/mainloop.h b/src/core/mainloop/mainloop.h index caef736c1..fe181c192 100644 --- a/src/core/mainloop/mainloop.h +++ b/src/core/mainloop/mainloop.h @@ -94,7 +94,6 @@ void tor_mainloop_free_all(void); struct token_bucket_rw_t; extern time_t time_of_process_start; -extern int quiet_level; extern struct token_bucket_rw_t global_bucket; extern struct token_bucket_rw_t global_relayed_bucket;

1 0

[tor/master] Move responsibility for setting the "quiet level" into a table.
by nickm＠torproject.org 17 Oct '19

17 Oct '19

commit bfdfaae0405aa683cdae85bde58da742f4b59ae5 Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Oct 8 13:13:31 2019 -0400 Move responsibility for setting the "quiet level" into a table. Previously this was done with a big list of options in main.c which implied "hush" or "quiet". One of these options ("--digests") no longer existed, but we still checked for it. Now we use the table of command-line-only arguments to set this value. --- src/app/config/config.c | 35 +++++++++++++++++++++++++---------- src/app/config/config.h | 3 +++ src/app/main/main.c | 30 ++++++------------------------ 3 files changed, 34 insertions(+), 34 deletions(-) diff --git a/src/app/config/config.c b/src/app/config/config.c index 734bd0f92..ea6a5e233 100644 --- a/src/app/config/config.c +++ b/src/app/config/config.c @@ -2459,6 +2459,8 @@ static const struct { takes_argument_t takes_argument; /** If not CMD_RUN_TOR, what should Tor do when it starts? */ tor_cmdline_mode_t command; + /** If nonzero, set the quiet level to this. 1 is "hush", 2 is "quiet" */ + int quiet; } CMDLINE_ONLY_OPTIONS[] = { { .name="-f", .takes_argument=ARGUMENT_NECESSARY }, @@ -2467,10 +2469,12 @@ static const struct { .takes_argument=ARGUMENT_NECESSARY }, { .name="--hash-password", .takes_argument=ARGUMENT_NECESSARY, - .command=CMD_HASH_PASSWORD }, + .command=CMD_HASH_PASSWORD, + .quiet=1 }, { .name="--dump-config", .takes_argument=ARGUMENT_OPTIONAL, - .command=CMD_DUMP_CONFIG }, + .command=CMD_DUMP_CONFIG, + .quiet=2 }, { .name="--list-fingerprint", .command=CMD_LIST_FINGERPRINT }, { .name="--keygen", @@ -2485,20 +2489,28 @@ static const struct { { .name="--verify-config", .command=CMD_VERIFY_CONFIG }, { .name="--ignore-missing-torrc" }, - { .name="--quiet" }, - { .name="--hush" }, + { .name="--quiet", + .quiet=2 }, + { .name="--hush", + .quiet=1 }, { .name="--version", - .command=CMD_OTHER }, + .command=CMD_OTHER, + .quiet=1 }, { .name="--list-modules", - .command=CMD_OTHER }, + .command=CMD_OTHER, + .quiet=1 }, { .name="--library-versions", - .command=CMD_OTHER }, + .command=CMD_OTHER, + .quiet=1 }, { .name="-h", - .command=CMD_OTHER }, + .command=CMD_OTHER, + .quiet=1 }, { .name="--help", - .command=CMD_OTHER }, + .command=CMD_OTHER, + .quiet=1 }, { .name="--list-torrc-options", - .command=CMD_OTHER }, + .command=CMD_OTHER, + .quiet=1 }, { .name="--list-deprecated-options", .command=CMD_OTHER }, { .name="--nt-service" }, @@ -2541,6 +2553,9 @@ config_parse_commandline(int argc, char **argv, int ignore_errors) is_a_command = true; result->command = CMDLINE_ONLY_OPTIONS[j].command; } + int quiet = CMDLINE_ONLY_OPTIONS[j].quiet; + if (quiet > result->quiet_level) + result->quiet_level = quiet; break; } } diff --git a/src/app/config/config.h b/src/app/config/config.h index 582b97d74..8fc10d504 100644 --- a/src/app/config/config.h +++ b/src/app/config/config.h @@ -208,6 +208,9 @@ typedef struct { tor_cmdline_mode_t command; /** Argument for the command mode, if any. */ const char *command_arg; + /** How quiet have we been told to be? 1 for "hush", and 2 for "quiet". + */ + int quiet_level; } parsed_cmdline_t; parsed_cmdline_t *config_parse_commandline(int argc, char **argv, diff --git a/src/app/main/main.c b/src/app/main/main.c index ad8253cc7..95dccbee6 100644 --- a/src/app/main/main.c +++ b/src/app/main/main.c @@ -547,40 +547,22 @@ tor_init(int argc, char *argv[]) hs_init(); { - /* We search for the "quiet" option first, since it decides whether we - * will log anything at all to the command line. */ + /* We check for the "quiet"/"hush" settings first, since they decide + whether we log anything at all to stdout. */ parsed_cmdline_t *cmdline; - const config_line_t *cl = NULL; cmdline = config_parse_commandline(argc, argv, 1); - if (cmdline != NULL) { - cl = cmdline->cmdline_opts; - } - for (; cl; cl = cl->next) { - if (!strcmp(cl->key, "--hush")) - quiet = 1; - if (!strcmp(cl->key, "--quiet") || - !strcmp(cl->key, "--dump-config")) - quiet = 2; - /* The following options imply --hush */ - if (!strcmp(cl->key, "--version") || !strcmp(cl->key, "--digests") || - !strcmp(cl->key, "--list-torrc-options") || - !strcmp(cl->key, "--library-versions") || - !strcmp(cl->key, "--list-modules") || - !strcmp(cl->key, "--hash-password") || - !strcmp(cl->key, "-h") || !strcmp(cl->key, "--help")) { - if (quiet < 1) - quiet = 1; - } - } + if (cmdline) + quiet = cmdline->quiet_level; parsed_cmdline_free(cmdline); } /* give it somewhere to log to initially */ switch (quiet) { case 2: - /* no initial logging */ + /* --quiet: no initial logging */ break; case 1: + /* --hush: log at warning or higher. */ add_temp_log(LOG_WARN); break; default:

1 0

[tor/master] Make the command-line parser understand "commands".
by nickm＠torproject.org 17 Oct '19

17 Oct '19

commit c529b3f8f1d882b29c6b505de1a61d24c6a0943c Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Oct 8 16:05:04 2019 -0400 Make the command-line parser understand "commands". Previously these were implemented with a search in options_init_from_torrc(), but that led to each option being declared more than needed: once to say that it was a valid option, and once to say what it meant. --- src/app/config/config.c | 80 ++++++++++++++++++++++----------------- src/app/config/config.h | 4 ++ src/app/config/tor_cmdline_mode.h | 4 +- src/app/main/main.c | 1 + src/app/main/ntmain.c | 1 + 5 files changed, 55 insertions(+), 35 deletions(-) diff --git a/src/app/config/config.c b/src/app/config/config.c index 74cd70ad3..734bd0f92 100644 --- a/src/app/config/config.c +++ b/src/app/config/config.c @@ -2457,6 +2457,8 @@ static const struct { const char *name; /** Does this option accept an argument? */ takes_argument_t takes_argument; + /** If not CMD_RUN_TOR, what should Tor do when it starts? */ + tor_cmdline_mode_t command; } CMDLINE_ONLY_OPTIONS[] = { { .name="-f", .takes_argument=ARGUMENT_NECESSARY }, @@ -2464,31 +2466,44 @@ static const struct { { .name="--defaults-torrc", .takes_argument=ARGUMENT_NECESSARY }, { .name="--hash-password", - .takes_argument=ARGUMENT_NECESSARY }, + .takes_argument=ARGUMENT_NECESSARY, + .command=CMD_HASH_PASSWORD }, { .name="--dump-config", - .takes_argument=ARGUMENT_OPTIONAL }, - { .name="--list-fingerprint" }, - { .name="--keygen" }, + .takes_argument=ARGUMENT_OPTIONAL, + .command=CMD_DUMP_CONFIG }, + { .name="--list-fingerprint", + .command=CMD_LIST_FINGERPRINT }, + { .name="--keygen", + .command=CMD_KEYGEN }, { .name="--key-expiration", - .takes_argument=ARGUMENT_OPTIONAL }, + .takes_argument=ARGUMENT_OPTIONAL, + .command=CMD_KEY_EXPIRATION }, { .name="--newpass" }, { .name="--no-passphrase" }, { .name="--passphrase-fd", .takes_argument=ARGUMENT_NECESSARY }, - { .name="--verify-config" }, + { .name="--verify-config", + .command=CMD_VERIFY_CONFIG }, { .name="--ignore-missing-torrc" }, { .name="--quiet" }, { .name="--hush" }, - { .name="--version" }, - { .name="--list-modules" }, - { .name="--library-versions" }, - { .name="-h" }, - { .name="--help" }, - { .name="--list-torrc-options" }, - { .name="--list-deprecated-options" }, + { .name="--version", + .command=CMD_OTHER }, + { .name="--list-modules", + .command=CMD_OTHER }, + { .name="--library-versions", + .command=CMD_OTHER }, + { .name="-h", + .command=CMD_OTHER }, + { .name="--help", + .command=CMD_OTHER }, + { .name="--list-torrc-options", + .command=CMD_OTHER }, + { .name="--list-deprecated-options", + .command=CMD_OTHER }, { .name="--nt-service" }, { .name="-nt-service" }, - { NULL, 0 }, + { .name=NULL }, }; /** Helper: Read a list of configuration options from the command line. If @@ -2502,6 +2517,7 @@ parsed_cmdline_t * config_parse_commandline(int argc, char **argv, int ignore_errors) { parsed_cmdline_t *result = tor_malloc_zero(sizeof(parsed_cmdline_t)); + result->command = CMD_RUN_TOR; config_line_t *param = NULL; config_line_t **new_cmdline = &result->cmdline_opts; @@ -2515,11 +2531,16 @@ config_parse_commandline(int argc, char **argv, int ignore_errors) takes_argument_t want_arg = ARGUMENT_NECESSARY; int is_cmdline = 0; int j; + bool is_a_command = false; for (j = 0; CMDLINE_ONLY_OPTIONS[j].name != NULL; ++j) { if (!strcmp(argv[i], CMDLINE_ONLY_OPTIONS[j].name)) { is_cmdline = 1; want_arg = CMDLINE_ONLY_OPTIONS[j].takes_argument; + if (CMDLINE_ONLY_OPTIONS[j].command != CMD_RUN_TOR) { + is_a_command = true; + result->command = CMDLINE_ONLY_OPTIONS[j].command; + } break; } } @@ -2569,6 +2590,10 @@ config_parse_commandline(int argc, char **argv, int ignore_errors) log_debug(LD_CONFIG, "command line: parsed keyword '%s', value '%s'", param->key, param->value); + if (is_a_command) { + result->command_arg = param->value; + } + if (is_cmdline) { *new_cmdline = param; new_cmdline = &((*new_cmdline)->next); @@ -3020,7 +3045,9 @@ is_local_addr, (const tor_addr_t *addr)) or_options_t * options_new(void) { - return config_new(get_options_mgr()); + or_options_t *options = config_new(get_options_mgr()); + options->command = CMD_RUN_TOR; + return options; } /** Set options to hold reasonable defaults for most options. @@ -5277,25 +5304,10 @@ options_init_from_torrc(int argc, char **argv) return 1; } - command = CMD_RUN_TOR; - for (p_index = cmdline_only_options; p_index; p_index = p_index->next) { - if (!strcmp(p_index->key,"--keygen")) { - command = CMD_KEYGEN; - } else if (!strcmp(p_index->key, "--key-expiration")) { - command = CMD_KEY_EXPIRATION; - command_arg = p_index->value; - } else if (!strcmp(p_index->key,"--list-fingerprint")) { - command = CMD_LIST_FINGERPRINT; - } else if (!strcmp(p_index->key, "--hash-password")) { - command = CMD_HASH_PASSWORD; - command_arg = p_index->value; - } else if (!strcmp(p_index->key, "--dump-config")) { - command = CMD_DUMP_CONFIG; - command_arg = p_index->value; - } else if (!strcmp(p_index->key, "--verify-config")) { - command = CMD_VERIFY_CONFIG; - } - } + int command = global_cmdline->command; + const char *command_arg = global_cmdline->command_arg; + /* "Other" has already been handled by this point. */ + tor_assert(command != CMD_OTHER); if (command == CMD_HASH_PASSWORD) { cf_defaults = tor_strdup(""); diff --git a/src/app/config/config.h b/src/app/config/config.h index fe4e272d8..582b97d74 100644 --- a/src/app/config/config.h +++ b/src/app/config/config.h @@ -204,6 +204,10 @@ typedef struct { /** List of other options, to be handled by the general Tor configuration system. */ struct config_line_t *other_opts; + /** Subcommand that Tor has been told to run */ + tor_cmdline_mode_t command; + /** Argument for the command mode, if any. */ + const char *command_arg; } parsed_cmdline_t; parsed_cmdline_t *config_parse_commandline(int argc, char **argv, diff --git a/src/app/config/tor_cmdline_mode.h b/src/app/config/tor_cmdline_mode.h index 9bc9a68d5..36626bed5 100644 --- a/src/app/config/tor_cmdline_mode.h +++ b/src/app/config/tor_cmdline_mode.h @@ -16,7 +16,7 @@ * Enumeration to describe which command Tor is running. These commands * are controlled by command-line options. **/ -typedef enum tor_cmdline_mode_t { +typedef enum { CMD_RUN_TOR=0, /**< The default: run Tor as a daemon. */ CMD_LIST_FINGERPRINT, /**< Running --list-fingerprint. */ CMD_HASH_PASSWORD, /**< Running --hash-password. */ @@ -24,6 +24,8 @@ typedef enum tor_cmdline_mode_t { CMD_DUMP_CONFIG, /**< Running --dump-config. */ CMD_KEYGEN, /**< Running --keygen */ CMD_KEY_EXPIRATION, /**< Running --key-expiration */ + CMD_OTHER, /**< Special value: indicates a command that is handled + * immediately during configuration processing. */ CMD_RUN_UNITTESTS, /**< Special value: indicates that we have entered * the Tor code from the unit tests, not from the * regular Tor binary at all. */ diff --git a/src/app/main/main.c b/src/app/main/main.c index 0edda66fd..ad8253cc7 100644 --- a/src/app/main/main.c +++ b/src/app/main/main.c @@ -1357,6 +1357,7 @@ tor_run_main(const tor_main_configuration_t *tor_cfg) result = do_dump_config(); break; case CMD_RUN_UNITTESTS: /* only set by test.c */ + case CMD_OTHER: /* Handled in config.c */ default: log_warn(LD_BUG,"Illegal command number %d: internal error.", get_options()->command); diff --git a/src/app/main/ntmain.c b/src/app/main/ntmain.c index a2de5bb87..16dc72acc 100644 --- a/src/app/main/ntmain.c +++ b/src/app/main/ntmain.c @@ -340,6 +340,7 @@ nt_service_main(void) "or --key-expiration) in NT service."); break; case CMD_RUN_UNITTESTS: + case CMD_OTHER: default: log_err(LD_CONFIG, "Illegal command number %d: internal error.", get_options()->command);

1 0

[tor/master] add a changes file for 32003 (command-line option parsing).
by nickm＠torproject.org 17 Oct '19

17 Oct '19

commit 35c18870b420e0ce7037c834709ff6daffd70754 Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Oct 8 13:21:24 2019 -0400 add a changes file for 32003 (command-line option parsing). --- changes/ticket32003 | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/changes/ticket32003 b/changes/ticket32003 new file mode 100644 index 000000000..b8809f288 --- /dev/null +++ b/changes/ticket32003 @@ -0,0 +1,4 @@ + o Code simplification and refactoring: + - When parsing the command line, handle options that determine our "quiet + level" and our mode of operation (e.g., --dump-config and so on) + all in one table. Closes ticket 32003.

1 0

[tor/master] Add a return type for the parsed commandline.
by nickm＠torproject.org 17 Oct '19

17 Oct '19

commit 9826fb19815794507cbc55358439758fbf700291 Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Oct 8 11:47:43 2019 -0400 Add a return type for the parsed commandline. Previously it was stored in two outvars, but this is more elegant. I'm going to be expanding this struct in later commits. --- src/app/config/config.c | 89 ++++++++++++++++++++++++++----------------------- src/app/config/config.h | 17 ++++++++-- src/app/main/main.c | 14 ++++---- 3 files changed, 69 insertions(+), 51 deletions(-) diff --git a/src/app/config/config.c b/src/app/config/config.c index 1abe1e13a..74cd70ad3 100644 --- a/src/app/config/config.c +++ b/src/app/config/config.c @@ -885,12 +885,8 @@ static or_options_t *global_default_options = NULL; static char *torrc_fname = NULL; /** Name of the most recently read torrc-defaults file.*/ static char *torrc_defaults_fname = NULL; -/** Configuration options set by command line. */ -static config_line_t *global_cmdline_options = NULL; -/** Non-configuration options set by the command line */ -static config_line_t *global_cmdline_only_options = NULL; -/** Boolean: Have we parsed the command line? */ -static int have_parsed_cmdline = 0; +/** Result of parsing the command line. */ +static parsed_cmdline_t *global_cmdline = NULL; /** Contents of most recently read DirPortFrontPage file. */ static char *global_dirfrontpagecontents = NULL; /** List of port_cfg_t for all configured ports. */ @@ -1064,11 +1060,7 @@ config_free_all(void) or_options_free(global_default_options); global_default_options = NULL; - config_free_lines(global_cmdline_options); - global_cmdline_options = NULL; - - config_free_lines(global_cmdline_only_options); - global_cmdline_only_options = NULL; + parsed_cmdline_free(global_cmdline); if (configured_ports) { SMARTLIST_FOREACH(configured_ports, @@ -1083,7 +1075,6 @@ config_free_all(void) cleanup_protocol_warning_severity_level(); - have_parsed_cmdline = 0; libevent_initialized = 0; config_mgr_free(options_mgr); @@ -2459,8 +2450,12 @@ typedef enum { ARGUMENT_OPTIONAL = 2 } takes_argument_t; +/** Table describing arguments that Tor accepts on the command line, + * other than those that are the same as in torrc. */ static const struct { + /** The string that the user has to provide. */ const char *name; + /** Does this option accept an argument? */ takes_argument_t takes_argument; } CMDLINE_ONLY_OPTIONS[] = { { .name="-f", @@ -2497,22 +2492,20 @@ static const struct { }; /** Helper: Read a list of configuration options from the command line. If - * successful, or if ignore_errors is set, put them in *result, put the - * commandline-only options in *cmdline_result, and return 0; - * otherwise, return -1 and leave *result and cmdline_result - * alone. */ -int -config_parse_commandline(int argc, char **argv, int ignore_errors, - config_line_t **result, - config_line_t **cmdline_result) + * successful, return a newly allocated parsed_cmdline_t; otherwise return + * NULL. + * + * If ignore_errors is set, try to recover from all recoverable + * errors and return the best command line we can. + */ +parsed_cmdline_t * +config_parse_commandline(int argc, char **argv, int ignore_errors) { + parsed_cmdline_t *result = tor_malloc_zero(sizeof(parsed_cmdline_t)); config_line_t *param = NULL; - config_line_t *front = NULL; - config_line_t **new = &front; - - config_line_t *front_cmdline = NULL; - config_line_t **new_cmdline = &front_cmdline; + config_line_t **new_cmdline = &result->cmdline_opts; + config_line_t **new = &result->other_opts; char *s, *arg; int i = 1; @@ -2557,9 +2550,8 @@ config_parse_commandline(int argc, char **argv, int ignore_errors, } else { log_warn(LD_CONFIG,"Command-line option '%s' with no value. Failing.", argv[i]); - config_free_lines(front); - config_free_lines(front_cmdline); - return -1; + parsed_cmdline_free(result); + return NULL; } } else if (want_arg == ARGUMENT_OPTIONAL && is_last) { arg = tor_strdup(""); @@ -2587,9 +2579,19 @@ config_parse_commandline(int argc, char **argv, int ignore_errors, i += want_arg ? 2 : 1; } - *cmdline_result = front_cmdline; - *result = front; - return 0; + + return result; +} + +/** Release all storage held by cmdline. */ +void +parsed_cmdline_free_(parsed_cmdline_t *cmdline) +{ + if (!cmdline) + return; + config_free_lines(cmdline->cmdline_opts); + config_free_lines(cmdline->other_opts); + tor_free(cmdline); } /** Return true iff key is a valid configuration option. */ @@ -5199,24 +5201,20 @@ int options_init_from_torrc(int argc, char **argv) { char *cf=NULL, *cf_defaults=NULL; - int command; int retval = -1; - char *command_arg = NULL; char *errmsg=NULL; - config_line_t *p_index = NULL; - config_line_t *cmdline_only_options = NULL; + const config_line_t *cmdline_only_options; /* Go through command-line variables */ - if (! have_parsed_cmdline) { + if (global_cmdline == NULL) { /* Or we could redo the list every time we pass this place. * It does not really matter */ - if (config_parse_commandline(argc, argv, 0, &global_cmdline_options, - &global_cmdline_only_options) < 0) { + global_cmdline = config_parse_commandline(argc, argv, 0); + if (global_cmdline == NULL) { goto err; } - have_parsed_cmdline = 1; } - cmdline_only_options = global_cmdline_only_options; + cmdline_only_options = global_cmdline->cmdline_opts; if (config_line_find(cmdline_only_options, "-h") || config_line_find(cmdline_only_options, "--help")) { @@ -5465,8 +5463,15 @@ options_init_from_string(const char *cf_defaults, const char *cf, } /* Go through command-line variables too */ - retval = config_assign(get_options_mgr(), newoptions, - global_cmdline_options, CAL_WARN_DEPRECATIONS, msg); + { + config_line_t *other_opts = NULL; + if (global_cmdline) { + other_opts = global_cmdline->other_opts; + } + retval = config_assign(get_options_mgr(), newoptions, + other_opts, + CAL_WARN_DEPRECATIONS, msg); + } if (retval < 0) { err = SETOPT_ERR_PARSE; goto err; diff --git a/src/app/config/config.h b/src/app/config/config.h index 44f09e5ee..fe4e272d8 100644 --- a/src/app/config/config.h +++ b/src/app/config/config.h @@ -197,9 +197,20 @@ int init_cookie_authentication(const char *fname, const char *header, or_options_t *options_new(void); -int config_parse_commandline(int argc, char **argv, int ignore_errors, - struct config_line_t **result, - struct config_line_t **cmdline_result); +/** Options settings parsed from the command-line. */ +typedef struct { + /** List of options that can only be set from the command-line */ + struct config_line_t *cmdline_opts; + /** List of other options, to be handled by the general Tor configuration + system. */ + struct config_line_t *other_opts; +} parsed_cmdline_t; + +parsed_cmdline_t *config_parse_commandline(int argc, char **argv, + int ignore_errors); +void parsed_cmdline_free_(parsed_cmdline_t *cmdline); +#define parsed_cmdline_free(c) \ + FREE_AND_NULL(parsed_cmdline_t, parsed_cmdline_free_, (c)) void config_register_addressmaps(const or_options_t *options); /* XXXX move to connection_edge.h */ diff --git a/src/app/main/main.c b/src/app/main/main.c index 3bdf8f146..0edda66fd 100644 --- a/src/app/main/main.c +++ b/src/app/main/main.c @@ -549,10 +549,13 @@ tor_init(int argc, char *argv[]) { /* We search for the "quiet" option first, since it decides whether we * will log anything at all to the command line. */ - config_line_t *opts = NULL, *cmdline_opts = NULL; - const config_line_t *cl; - (void) config_parse_commandline(argc, argv, 1, &opts, &cmdline_opts); - for (cl = cmdline_opts; cl; cl = cl->next) { + parsed_cmdline_t *cmdline; + const config_line_t *cl = NULL; + cmdline = config_parse_commandline(argc, argv, 1); + if (cmdline != NULL) { + cl = cmdline->cmdline_opts; + } + for (; cl; cl = cl->next) { if (!strcmp(cl->key, "--hush")) quiet = 1; if (!strcmp(cl->key, "--quiet") || @@ -569,8 +572,7 @@ tor_init(int argc, char *argv[]) quiet = 1; } } - config_free_lines(opts); - config_free_lines(cmdline_opts); + parsed_cmdline_free(cmdline); } /* give it somewhere to log to initially */

1 0

[tor/master] Merge branch 'cmdline_refactor'
by nickm＠torproject.org 17 Oct '19

17 Oct '19

commit 800b823c292009dd232d9758d1b40c61072e4433 Merge: 0081d6c11 d97d7f0e4 Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Oct 17 12:01:45 2019 -0400 Merge branch 'cmdline_refactor' changes/ticket32003 | 4 + src/app/config/config.c | 228 +++++++++++++++----------- src/app/config/config.h | 24 ++- src/app/config/or_options_st.h | 8 +- src/app/config/quiet_level.h | 28 ++++ src/app/config/tor_cmdline_mode.h | 34 ++++ src/app/main/main.c | 53 +++--- src/app/main/ntmain.c | 1 + src/core/include.am | 2 + src/core/mainloop/mainloop.h | 1 - src/test/conf_examples/missing_cl_arg/cmdline | 1 + src/test/conf_examples/missing_cl_arg/error | 1 + src/test/conf_examples/missing_cl_arg/torrc | 0 13 files changed, 250 insertions(+), 135 deletions(-)

1 0