tor-commits October 2019

tor-commits@lists.torproject.org

22 participants
4141 discussions

[tor/master] add missing docs in crypto_digest*
by nickm＠torproject.org 28 Oct '19

28 Oct '19

commit 25d66a33911df8561765b58b08d691b4afd36344 Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Oct 28 08:27:42 2019 -0400 add missing docs in crypto_digest* --- src/lib/crypt_ops/crypto_digest.c | 3 +++ src/lib/crypt_ops/crypto_digest.h | 33 +++++++++++++++++++++++++++++++ src/lib/crypt_ops/crypto_digest_nss.c | 7 +++++-- src/lib/crypt_ops/crypto_digest_openssl.c | 5 ++--- 4 files changed, 43 insertions(+), 5 deletions(-) diff --git a/src/lib/crypt_ops/crypto_digest.c b/src/lib/crypt_ops/crypto_digest.c index ba226f875..d14a40f32 100644 --- a/src/lib/crypt_ops/crypto_digest.c +++ b/src/lib/crypt_ops/crypto_digest.c @@ -150,6 +150,9 @@ struct crypto_xof_t { */ EVP_MD_CTX *ctx; #else /* !defined(OPENSSL_HAS_SHAKE3_EVP) */ + /** + * State of the Keccak sponge for the SHAKE-256 computation. + **/ keccak_state s; #endif /* defined(OPENSSL_HAS_SHAKE3_EVP) */ }; diff --git a/src/lib/crypt_ops/crypto_digest.h b/src/lib/crypt_ops/crypto_digest.h index 5869db780..fb819b12e 100644 --- a/src/lib/crypt_ops/crypto_digest.h +++ b/src/lib/crypt_ops/crypto_digest.h @@ -38,6 +38,9 @@ /** Length of hex encoding of SHA512 digest, not including final NUL. */ #define HEX_DIGEST512_LEN 128 +/** + * An identifier for a cryptographic digest algorithm. + **/ typedef enum { DIGEST_SHA1 = 0, DIGEST_SHA256 = 1, @@ -45,16 +48,31 @@ typedef enum { DIGEST_SHA3_256 = 3, DIGEST_SHA3_512 = 4, } digest_algorithm_t; +/** Number of digest algorithms that we know */ #define N_DIGEST_ALGORITHMS (DIGEST_SHA3_512+1) +/** Number of digest algorithms to compute when computing "all the + * commonly used digests." + * + * (This is used in common_digests_t and related functions.) + */ #define N_COMMON_DIGEST_ALGORITHMS (DIGEST_SHA256+1) +/** + * Bytes of storage needed to record the state of an in-progress SHA-1 digest. + * + * This is a deliberate overestimate. + **/ #define DIGEST_CHECKPOINT_BYTES (SIZEOF_VOID_P + 512) + /** Structure used to temporarily save the a digest object. Only implemented * for SHA1 digest for now. */ typedef struct crypto_digest_checkpoint_t { #ifdef ENABLE_NSS + /** The number of bytes used in mem. */ unsigned int bytes_used; #endif + /** A buffer to store the SHA1 state. Its contents are unspecified, and + * are managed by the underlying crypto library.*/ uint8_t mem[DIGEST_CHECKPOINT_BYTES]; } crypto_digest_checkpoint_t; @@ -67,10 +85,19 @@ typedef struct crypto_digest_checkpoint_t { * once. **/ typedef struct { + /** An array of digest outputs, one for each "common" digest algorithm. */ char d[N_COMMON_DIGEST_ALGORITHMS][DIGEST256_LEN]; } common_digests_t; +/** + * State for computing a digest over a stream of data. + **/ typedef struct crypto_digest_t crypto_digest_t; + +/** + * State for computing an "extendable-output function" (like SHAKE) over a + * stream of data, and/or streaming the output. + **/ typedef struct crypto_xof_t crypto_xof_t; struct smartlist_t; @@ -97,6 +124,9 @@ crypto_digest_t *crypto_digest_new(void); crypto_digest_t *crypto_digest256_new(digest_algorithm_t algorithm); crypto_digest_t *crypto_digest512_new(digest_algorithm_t algorithm); void crypto_digest_free_(crypto_digest_t *digest); +/** + * Release all storage held in d, and set it to NULL. + **/ #define crypto_digest_free(d) \ FREE_AND_NULL(crypto_digest_t, crypto_digest_free_, (d)) void crypto_digest_add_bytes(crypto_digest_t *digest, const char *data, @@ -122,6 +152,9 @@ crypto_xof_t *crypto_xof_new(void); void crypto_xof_add_bytes(crypto_xof_t *xof, const uint8_t *data, size_t len); void crypto_xof_squeeze_bytes(crypto_xof_t *xof, uint8_t *out, size_t len); void crypto_xof_free_(crypto_xof_t *xof); +/** + * Release all storage held in xof, and set it to NULL. + **/ #define crypto_xof_free(xof) \ FREE_AND_NULL(crypto_xof_t, crypto_xof_free_, (xof)) void crypto_xof(uint8_t *output, size_t output_len, diff --git a/src/lib/crypt_ops/crypto_digest_nss.c b/src/lib/crypt_ops/crypto_digest_nss.c index b73f0736f..54fb71443 100644 --- a/src/lib/crypt_ops/crypto_digest_nss.c +++ b/src/lib/crypt_ops/crypto_digest_nss.c @@ -44,7 +44,11 @@ digest_alg_to_nss_oid(digest_algorithm_t alg) } } -/* Helper: get an unkeyed digest via pk11wrap */ +/** Helper: Compute an unkeyed digest of the msg_len bytes at + * msg, using the digest algorithm specified by alg. + * Store the result in the len_out-byte buffer at digest. + * Return the number of bytes written on success, and -1 on failure. + **/ static int digest_nss_internal(SECOidTag alg, char *digest, unsigned len_out, @@ -557,4 +561,3 @@ crypto_hmac_sha256(char *hmac_out, tor_assert(ok); } - diff --git a/src/lib/crypt_ops/crypto_digest_openssl.c b/src/lib/crypt_ops/crypto_digest_openssl.c index b0d8b6aee..319714f86 100644 --- a/src/lib/crypt_ops/crypto_digest_openssl.c +++ b/src/lib/crypt_ops/crypto_digest_openssl.c @@ -147,9 +147,9 @@ crypto_digest_get_algorithm(crypto_digest_t *digest) static size_t crypto_digest_alloc_bytes(digest_algorithm_t alg) { - /* Helper: returns the number of bytes in the 'f' field of 'st' */ + /** Helper: returns the number of bytes in the 'f' field of 'st' */ #define STRUCT_FIELD_SIZE(st, f) (sizeof( ((st*)0)->f )) - /* Gives the length of crypto_digest_t through the end of the field 'd' */ + /** Gives the length of crypto_digest_t through the end of the field 'd' */ #define END_OF_FIELD(f) (offsetof(crypto_digest_t, f) + \ STRUCT_FIELD_SIZE(crypto_digest_t, f)) switch (alg) { @@ -519,4 +519,3 @@ crypto_hmac_sha256(char *hmac_out, (unsigned char*)hmac_out, NULL); tor_assert(rv); } -

1 0

[translation/abouttor-homepage] https://gitweb.torproject.org/translation.git/commit/?h=abouttor-homepage
by translation＠torproject.org 28 Oct '19

28 Oct '19

commit ae2ad9ec513329c361590459dcfb1a39e1a687b8 Author: Translation commit bot <translation(a)torproject.org> Date: Mon Oct 28 12:15:05 2019 +0000 https://gitweb.torproject.org/translation.git/commit/?h=abouttor-homepage --- nl/aboutTor.dtd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nl/aboutTor.dtd b/nl/aboutTor.dtd index 753822ba5..808cb3edb 100644 --- a/nl/aboutTor.dtd +++ b/nl/aboutTor.dtd @@ -34,4 +34,4 @@  <!ENTITY aboutTor.ey2019.mozilla "Geef vandaag, en Mozilla geeft hetzelfde bedrag."> <!ENTITY aboutTor.ey2019.tracking "Volgen, toezicht en censuur zijn wijdverspreid online."> -<!ENTITY aboutTor.ey2019.takeback "Take back the Internet with Tor"> +<!ENTITY aboutTor.ey2019.takeback "Pak het internet terug met Tor">

1 0

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

28 Oct '19

commit 4d2c8ca33858bbf360fb4423331dc8fdd363b8ea Merge: 3479024cb f751cc020 Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Oct 28 07:31:42 2019 -0400 Merge branch 'config_macros_doc_cleanup' src/lib/conf/confmacros.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)

1 0

[tor/master] Documentation cleanup in confmacros.h
by nickm＠torproject.org 28 Oct '19

28 Oct '19

commit f751cc020f2ccfa165ad5ef2a1dca11a36b56593 Author: Nick Mathewson <nickm(a)torproject.org> Date: Sat Oct 26 17:21:18 2019 -0400 Documentation cleanup in confmacros.h --- src/lib/conf/confmacros.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/lib/conf/confmacros.h b/src/lib/conf/confmacros.h index 67082454a..10de1fbce 100644 --- a/src/lib/conf/confmacros.h +++ b/src/lib/conf/confmacros.h @@ -45,7 +45,7 @@ } /** - * As CONFIG_VAR_XTYPE, but declares a value using an extension type whose + * As CONFIG_VAR_ETYPE, but declares a value using an extension type whose * type definition is vartype_type_defn. **/ #define CONFIG_VAR_DEFN(structtype, varname, vartype, membername, \ @@ -61,6 +61,9 @@ CONF_TEST_MEMBERS(structtype, vartype, membername) \ } +/** + * Declare an obsolete configuration variable with a given name. + **/ #define CONFIG_VAR_OBSOLETE(varname) \ { .member = { .name = varname, .type = CONFIG_TYPE_OBSOLETE }, \ .flags = CFLG_GROUP_OBSOLETE \

1 0

[translation/abouttor-homepage_completed] https://gitweb.torproject.org/translation.git/commit/?h=abouttor-homepage_completed
by translation＠torproject.org 28 Oct '19

28 Oct '19

commit 7b7d2e3a03f84a5722d532d4b304c50bb8046b7b Author: Translation commit bot <translation(a)torproject.org> Date: Mon Oct 28 09:15:14 2019 +0000 https://gitweb.torproject.org/translation.git/commit/?h=abouttor-homepage_c… --- es-ES/aboutTor.dtd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/es-ES/aboutTor.dtd b/es-ES/aboutTor.dtd index 99f09ee48..788637e51 100644 --- a/es-ES/aboutTor.dtd +++ b/es-ES/aboutTor.dtd @@ -32,6 +32,6 @@ <!ENTITY aboutTor.donationBanner.buttonA "Dona ahora.">  -<!ENTITY aboutTor.ey2019.mozilla ""> -<!ENTITY aboutTor.ey2019.tracking ""> +<!ENTITY aboutTor.ey2019.mozilla "Dona hoy, y Mozilla igualará tu donación."> +<!ENTITY aboutTor.ey2019.tracking "El rastreo, la vigilancia y la censura están muy extendidos en línea."> <!ENTITY aboutTor.ey2019.takeback "">

1 0

[translation/abouttor-homepage] https://gitweb.torproject.org/translation.git/commit/?h=abouttor-homepage
by translation＠torproject.org 28 Oct '19

28 Oct '19

commit 4a6f44bcc86f6e347ae718ac765da140ccfbf82d Author: Translation commit bot <translation(a)torproject.org> Date: Mon Oct 28 09:15:06 2019 +0000 https://gitweb.torproject.org/translation.git/commit/?h=abouttor-homepage --- es-ES/aboutTor.dtd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/es-ES/aboutTor.dtd b/es-ES/aboutTor.dtd index d8d195b7f..aa0752784 100644 --- a/es-ES/aboutTor.dtd +++ b/es-ES/aboutTor.dtd @@ -34,4 +34,4 @@  <!ENTITY aboutTor.ey2019.mozilla "Dona hoy, y Mozilla igualará tu donación."> <!ENTITY aboutTor.ey2019.tracking "El rastreo, la vigilancia y la censura están muy extendidos en línea."> -<!ENTITY aboutTor.ey2019.takeback "Take back the Internet with Tor"> +<!ENTITY aboutTor.ey2019.takeback "Recupera Internet con Tor.">

1 0

[tor/master] scripts: Change to the top source directory as needed
by teor＠torproject.org 28 Oct '19

28 Oct '19

commit 3479024cb1034dd453fed577b493cbe5515765d3 Author: teor <teor(a)torproject.org> Date: Mon Oct 28 13:28:50 2019 +1000 scripts: Change to the top source directory as needed Bugfix on 31919; not in any released version of tor. --- scripts/coccinelle/check_cocci_parse.sh | 1 + scripts/git/pre-push.git-hook | 4 +++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/scripts/coccinelle/check_cocci_parse.sh b/scripts/coccinelle/check_cocci_parse.sh index 5c27c7bc8..220b40594 100755 --- a/scripts/coccinelle/check_cocci_parse.sh +++ b/scripts/coccinelle/check_cocci_parse.sh @@ -30,6 +30,7 @@ if test $# -ge 1 ; then "$try_parse" "$@" exitcode=$? else + cd "$top" || exit 1 # This is the layout in 0.3.5 "$try_parse" \ src/lib/*/*.[ch] \ diff --git a/scripts/git/pre-push.git-hook b/scripts/git/pre-push.git-hook index 2f3608029..7be184ec6 100755 --- a/scripts/git/pre-push.git-hook +++ b/scripts/git/pre-push.git-hook @@ -28,6 +28,8 @@ upstream_name=${TOR_UPSTREAM_REMOTE_NAME:-"upstream"} workdir=$(git rev-parse --show-toplevel) +cd "$workdir" || exit 1 + remote="$1" remote_name=$(git remote --verbose | grep "$2" | awk '{print $1}' | head -n 1) @@ -83,7 +85,7 @@ do # We want word splitting here, because file names are space separated # shellcheck disable=SC2086 - if ! "$workdir/"scripts/git/pre-commit.git-hook $CHECK_FILES; then + if ! scripts/git/pre-commit.git-hook $CHECK_FILES ; then exit 1 fi

1 0

[tor/master] practracker: Don't read editor temp files
by teor＠torproject.org 28 Oct '19

28 Oct '19

commit 18e09913bf23253645404612726983c5c43e19cc Author: teor <teor(a)torproject.org> Date: Mon Oct 28 13:09:58 2019 +1000 practracker: Don't read editor temp files (Or any dot files.) Obviously correct changes to already-reviewed code. --- scripts/maint/practracker/util.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/scripts/maint/practracker/util.py b/scripts/maint/practracker/util.py index df629110c..c38e4c8dd 100644 --- a/scripts/maint/practracker/util.py +++ b/scripts/maint/practracker/util.py @@ -33,6 +33,9 @@ def get_tor_c_files(tor_topdir, include_dirs=None): # We only care about .c and .h files if not (filename.endswith(".c") or filename.endswith(".h")): continue + # Avoid editor temporary files + if filename.startswith("."): + continue if filename in EXCLUDE_FILES: continue

1 0

[tor/master] scripts/git: Fix a shellcheck error in pre-commit.git-hook
by teor＠torproject.org 28 Oct '19

28 Oct '19

commit 68befa3b84080fcbf4face0fa39afedae9f3223d Author: teor <teor(a)torproject.org> Date: Mon Oct 28 13:04:29 2019 +1000 scripts/git: Fix a shellcheck error in pre-commit.git-hook Some versions of shellcheck do not detect this error. Bugfix on 31919; not in any released version of tor. --- scripts/git/pre-commit.git-hook | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/git/pre-commit.git-hook b/scripts/git/pre-commit.git-hook index 2e476c310..c138d2ae2 100755 --- a/scripts/git/pre-commit.git-hook +++ b/scripts/git/pre-commit.git-hook @@ -61,7 +61,7 @@ fi ## Owned Source File Checks -printf "Modified tor-owned source files:\n%s\n" "$CHECK_FILES" +printf "Modified tor-owned source files:\\n%s\\n" "$CHECK_FILES" # We want word splitting here, because file names are space separated # shellcheck disable=SC2086

1 0

[tor/master] Move config_format_t and allied definitions into conftypes.h
by teor＠torproject.org 28 Oct '19

28 Oct '19

commit 407fb0c35cec731c386bc288bf1f7852a299d498 Author: Nick Mathewson <nickm(a)torproject.org> Date: Sat Oct 26 10:05:03 2019 -0400 Move config_format_t and allied definitions into conftypes.h Since these are needed by every module that is _configurable_, they belong in lib/conf, not lib/confmgt. --- src/lib/conf/conftypes.h | 136 ++++++++++++++++++++++++++++++++++++++++++++ src/lib/confmgt/confparse.h | 136 -------------------------------------------- 2 files changed, 136 insertions(+), 136 deletions(-) diff --git a/src/lib/conf/conftypes.h b/src/lib/conf/conftypes.h index 274065cff..69a5f79bf 100644 --- a/src/lib/conf/conftypes.h +++ b/src/lib/conf/conftypes.h @@ -199,4 +199,140 @@ typedef struct config_var_t { #endif } config_var_t; +/** + * An abbreviation or alias for a configuration option. + **/ +typedef struct config_abbrev_t { + /** The option name as abbreviated. Not case-sensitive. */ + const char *abbreviated; + /** The full name of the option. Not case-sensitive. */ + const char *full; + /** True if this abbreviation should only be allowed on the command line. */ + int commandline_only; + /** True if we should warn whenever this abbreviation is used. */ + int warn; +} config_abbrev_t; + +/** + * A note that a configuration option is deprecated, with an explanation why. + */ +typedef struct config_deprecation_t { + /** The option that is deprecated. */ + const char *name; + /** A user-facing string explaining why the option is deprecated. */ + const char *why_deprecated; +} config_deprecation_t; + +/** + * Handy macro for declaring "In the config file or on the command line, you + * can abbreviate toks as tok". Used inside an array of + * config_abbrev_t. + * + * For example, to declare "NumCpu" as an abbreviation for "NumCPUs", + * you can say PLURAL(NumCpu). + **/ +#define PLURAL(tok) { #tok, #tok "s", 0, 0 } + +/** + * Validation function: verify whether a configuation object is well-formed + * and consistent. + * + * On success, return 0. On failure, set msg_out to a newly allocated + * string containing an error message, and return -1. */ +typedef int (*validate_fn_t)(const void *value, char **msg_out); +/** + * Validation function: verify whether a configuration object (`value`) is an + * allowable value given the previous configuration value (`old_value`). + * + * On success, return 0. On failure, set msg_out to a newly allocated + * string containing an error message, and return -1. */ +typedef int (*check_transition_fn_t)(const void *old_value, const void *value, + char **msg_out); +/** + * Validation function: normalize members of `value`, and compute derived + * members. + * + * This function is called before any other validation of `value`, and must + * not assume that validate_fn or check_transition_fn has passed. + * + * On success, return 0. On failure, set msg_out to a newly allocated + * string containing an error message, and return -1. */ +typedef int (*pre_normalize_fn_t)(void *value, char **msg_out); +/** + * Validation function: normalize members of `value`, and compute derived + * members. + * + * This function is called after validation of `value`, and may + * assume that validate_fn or check_transition_fn has passed. + * + * On success, return 0. On failure, set msg_out to a newly allocated + * string containing an error message, and return -1. */ +typedef int (*post_normalize_fn_t)(void *value, char **msg_out); + +/** + * Legacy function to validate whether a given configuration is + * well-formed and consistent. + * + * The configuration to validate is passed as newval. The previous + * configuration, if any, is provided in oldval. + * + * This API is deprecated, since it mixes the responsibilities of + * pre_normalize_fn_t, post_normalize_fn_t, validate_fn_t, and + * check_transition_fn_t. No new instances of this function type should + * be written. + * + * On success, return 0. On failure, set *msg_out to a newly allocated + * error message, and return -1. + */ +typedef int (*legacy_validate_fn_t)(const void *oldval, + void *newval, + char **msg_out); + +struct config_mgr_t; + +/** + * Callback to clear all non-managed fields of a configuration object. + * + * obj is the configuration object whose non-managed fields should be + * cleared. + * + * (Regular fields get cleared by config_reset(), but you might have fields + * in the object that do not correspond to configuration variables. If those + * fields need to be cleared or freed, this is where to do it.) + */ +typedef void (*clear_cfg_fn_t)(const struct config_mgr_t *mgr, void *obj); + +/** Information on the keys, value types, key-to-struct-member mappings, + * variable descriptions, validation functions, and abbreviations for a + * configuration or storage format. */ +typedef struct config_format_t { + size_t size; /**< Size of the struct that everything gets parsed into. */ + struct_magic_decl_t magic; /**< Magic number info for this struct. */ + const config_abbrev_t *abbrevs; /**< List of abbreviations that we expand + * when parsing this format. */ + const config_deprecation_t *deprecations; /** List of deprecated options */ + const config_var_t *vars; /**< List of variables we recognize, their default + * values, and where we stick them in the + * structure. */ + + /** Early-stage normalization callback. Invoked by config_validate(). */ + pre_normalize_fn_t pre_normalize_fn; + /** Configuration validation function. Invoked by config_validate(). */ + validate_fn_t validate_fn; + /** Legacy validation function. Invoked by config_validate(). */ + legacy_validate_fn_t legacy_validate_fn; + /** Transition checking function. Invoked by config_validate(). */ + check_transition_fn_t check_transition_fn; + /** Late-stage normalization callback. Invoked by config_validate(). */ + post_normalize_fn_t post_normalize_fn; + + clear_cfg_fn_t clear_fn; /**< Function to clear the configuration. */ + /** If present, extra denotes a LINELIST variable for unrecognized + * lines. Otherwise, unrecognized lines are an error. */ + const struct_member_t *extra; + /** The position of a config_suite_t pointer within the toplevel object, + * or -1 if there is no such pointer. */ + ptrdiff_t config_suite_offset; +} config_format_t; + #endif /* !defined(TOR_SRC_LIB_CONF_CONFTYPES_H) */ diff --git a/src/lib/confmgt/confparse.h b/src/lib/confmgt/confparse.h index f187bfc38..246ad887c 100644 --- a/src/lib/confmgt/confparse.h +++ b/src/lib/confmgt/confparse.h @@ -18,142 +18,6 @@ #include "lib/testsupport/testsupport.h" /** - * An abbreviation or alias for a configuration option. - **/ -typedef struct config_abbrev_t { - /** The option name as abbreviated. Not case-sensitive. */ - const char *abbreviated; - /** The full name of the option. Not case-sensitive. */ - const char *full; - /** True if this abbreviation should only be allowed on the command line. */ - int commandline_only; - /** True if we should warn whenever this abbreviation is used. */ - int warn; -} config_abbrev_t; - -/** - * A note that a configuration option is deprecated, with an explanation why. - */ -typedef struct config_deprecation_t { - /** The option that is deprecated. */ - const char *name; - /** A user-facing string explaining why the option is deprecated. */ - const char *why_deprecated; -} config_deprecation_t; - -/** - * Handy macro for declaring "In the config file or on the command line, you - * can abbreviate toks as tok". Used inside an array of - * config_abbrev_t. - * - * For example, to declare "NumCpu" as an abbreviation for "NumCPUs", - * you can say PLURAL(NumCpu). - **/ -#define PLURAL(tok) { #tok, #tok "s", 0, 0 } - -/** - * Validation function: verify whether a configuation object is well-formed - * and consistent. - * - * On success, return 0. On failure, set msg_out to a newly allocated - * string containing an error message, and return -1. */ -typedef int (*validate_fn_t)(const void *value, char **msg_out); -/** - * Validation function: verify whether a configuration object (`value`) is an - * allowable value given the previous configuration value (`old_value`). - * - * On success, return 0. On failure, set msg_out to a newly allocated - * string containing an error message, and return -1. */ -typedef int (*check_transition_fn_t)(const void *old_value, const void *value, - char **msg_out); -/** - * Validation function: normalize members of `value`, and compute derived - * members. - * - * This function is called before any other validation of `value`, and must - * not assume that validate_fn or check_transition_fn has passed. - * - * On success, return 0. On failure, set msg_out to a newly allocated - * string containing an error message, and return -1. */ -typedef int (*pre_normalize_fn_t)(void *value, char **msg_out); -/** - * Validation function: normalize members of `value`, and compute derived - * members. - * - * This function is called after validation of `value`, and may - * assume that validate_fn or check_transition_fn has passed. - * - * On success, return 0. On failure, set msg_out to a newly allocated - * string containing an error message, and return -1. */ -typedef int (*post_normalize_fn_t)(void *value, char **msg_out); - -/** - * Legacy function to validate whether a given configuration is - * well-formed and consistent. - * - * The configuration to validate is passed as newval. The previous - * configuration, if any, is provided in oldval. - * - * This API is deprecated, since it mixes the responsibilities of - * pre_normalize_fn_t, post_normalize_fn_t, validate_fn_t, and - * check_transition_fn_t. No new instances of this function type should - * be written. - * - * On success, return 0. On failure, set *msg_out to a newly allocated - * error message, and return -1. - */ -typedef int (*legacy_validate_fn_t)(const void *oldval, - void *newval, - char **msg_out); - -struct config_mgr_t; - -/** - * Callback to clear all non-managed fields of a configuration object. - * - * obj is the configuration object whose non-managed fields should be - * cleared. - * - * (Regular fields get cleared by config_reset(), but you might have fields - * in the object that do not correspond to configuration variables. If those - * fields need to be cleared or freed, this is where to do it.) - */ -typedef void (*clear_cfg_fn_t)(const struct config_mgr_t *mgr, void *obj); - -/** Information on the keys, value types, key-to-struct-member mappings, - * variable descriptions, validation functions, and abbreviations for a - * configuration or storage format. */ -typedef struct config_format_t { - size_t size; /**< Size of the struct that everything gets parsed into. */ - struct_magic_decl_t magic; /**< Magic number info for this struct. */ - const config_abbrev_t *abbrevs; /**< List of abbreviations that we expand - * when parsing this format. */ - const config_deprecation_t *deprecations; /** List of deprecated options */ - const config_var_t *vars; /**< List of variables we recognize, their default - * values, and where we stick them in the - * structure. */ - - /** Early-stage normalization callback. Invoked by config_validate(). */ - pre_normalize_fn_t pre_normalize_fn; - /** Configuration validation function. Invoked by config_validate(). */ - validate_fn_t validate_fn; - /** Legacy validation function. Invoked by config_validate(). */ - legacy_validate_fn_t legacy_validate_fn; - /** Transition checking function. Invoked by config_validate(). */ - check_transition_fn_t check_transition_fn; - /** Late-stage normalization callback. Invoked by config_validate(). */ - post_normalize_fn_t post_normalize_fn; - - clear_cfg_fn_t clear_fn; /**< Function to clear the configuration. */ - /** If present, extra denotes a LINELIST variable for unrecognized - * lines. Otherwise, unrecognized lines are an error. */ - const struct_member_t *extra; - /** The position of a config_suite_t pointer within the toplevel object, - * or -1 if there is no such pointer. */ - ptrdiff_t config_suite_offset; -} config_format_t; - -/** * A collection of config_format_t objects to describe several objects * that are all configured with the same configuration file. *

1 0

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

tor-commits October 2019