torproject/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-12-06 19:41:15 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'config_subsys_v4'

Browse Source
This commit is contained in:
Nick Mathewson
2019-11-07 08:59:42 -05:00
parent 582cee723a de7053b896
commit f6c9ca3a1d
46 changed files with 925 additions and 132 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Doxyfile.in
+7 -3
View File
@@ -318,7 +318,7 @@ OPTIMIZE_OUTPUT_SLICE = NO
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.
EXTENSION_MAPPING = dox=C h=C c=C
EXTENSION_MAPPING = dox=C h=C c=C inc=C
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
@@ -845,7 +845,8 @@ INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.c \
*.h \
*.dox
*.dox \
*.inc
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
@@ -2110,7 +2111,10 @@ INCLUDE_FILE_PATTERNS =
PREDEFINED = "MOCK_IMPL(a,b,c)=a b c" \
"MOCK_DECL(a,b,c)=a b c" \
__attribute__(x)=
__attribute__(x)= \
"BEGIN_CONF_STRUCT(x)=struct x {" \
"END_CONF_STRUCT(x)=};" \
"CONF_VAR(a,b,c,d)=b a;"
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
changes/ticket32382
+4
View File
@@ -0,0 +1,4 @@
o Minor bugfixes (configuration):
- Avoid changing the user's value of HardwareAccel as stored by SAVECONF,
when AccelName is set but HardwareAccel is not.
Fixes bug 32382; bugfix on 0.2.2.1-alpha.
changes/ticket32406
+4
View File
@@ -0,0 +1,4 @@
o Minor features (configuration):
- If the configured hardware crypto accelerator in AccelName
is prefixed with "!", Tor now exits when it cannot be found.
Closes ticket 32406.
doc/tor.1.txt
+3
View File
@@ -843,6 +843,9 @@ GENERAL OPTIONS
engine of this name. This must be used for any dynamic hardware engine.
Names can be verified with the openssl engine command. Can not be changed
while tor is running.
+
If the engine name is prefixed with a "!", then Tor will exit if the
engine cannot be loaded.
[[AccelDir]] **AccelDir** __DIR__::
Specify this option if using dynamic hardware acceleration and the engine
src/app/config/config.c
+5 -9
View File
@@ -498,11 +498,8 @@ static const config_var_t option_vars_[] = {
#endif /* defined(_WIN32) */
OBSOLETE("Group"),
V(GuardLifetime, INTERVAL, "0 minutes"),
V_IMMUTABLE(HardwareAccel, BOOL, "0"),
V(HeartbeatPeriod, INTERVAL, "6 hours"),
V(MainloopStats, BOOL, "0"),
V_IMMUTABLE(AccelName, STRING, NULL),
V_IMMUTABLE(AccelDir, FILENAME, NULL),
V(HashedControlPassword, LINELIST, NULL),
OBSOLETE("HidServDirectoryV2"),
VAR("HiddenServiceDir", LINELIST_S, RendConfigLines, NULL),
@@ -883,6 +880,7 @@ static const config_format_t options_format = {
.legacy_validate_fn = options_validate_cb,
.check_transition_fn = options_check_transition_cb,
.clear_fn = options_clear_cb,
.has_config_suite = true,
.config_suite_offset = offsetof(or_options_t, subconfigs_),
};
@@ -918,6 +916,8 @@ get_options_mgr(void)
{
if (PREDICT_UNLIKELY(options_mgr == NULL)) {
options_mgr = config_mgr_new(&options_format);
int rv = subsystems_register_options_formats(options_mgr);
tor_assert(rv == 0);
config_mgr_freeze(options_mgr);
}
return options_mgr;
@@ -985,7 +985,8 @@ set_options(or_options_t *new_val, char **msg)
global_options = old_options;
return -1;
}
if (options_act(old_options) < 0) { /* acting on the options failed. die. */
if (subsystems_set_options(get_options_mgr(), new_val) < 0 ||
options_act(old_options) < 0) { /* acting on the options failed. die. */
if (! tor_event_loop_shutdown_is_pending()) {
log_err(LD_BUG,
"Acting on config options left us in a broken state. Dying.");
@@ -3935,11 +3936,6 @@ options_validate_cb(const void *old_options_, void *options_, char **msg)
"testing Tor network!");
}
if (options->AccelName && !options->HardwareAccel)
options->HardwareAccel = 1;
if (options->AccelDir && !options->AccelName)
REJECT("Can't use hardware crypto accelerator dir without engine name.");
if (options_validate_scheduler(options, msg) < 0) {
return -1;
}
src/app/config/or_options_st.h
-4
View File
@@ -536,12 +536,8 @@ struct or_options_t {
* protocol, is it a warn or an info in our logs? */
int TestSocks; /**< Boolean: when we get a socks connection, do we loudly
* log whether it was DNS-leaking or not? */
int HardwareAccel; /**< Boolean: Should we enable OpenSSL hardware
* acceleration where available? */
/** Token Bucket Refill resolution in milliseconds. */
int TokenBucketRefillInterval;
char *AccelName; /**< Optional hardware acceleration engine name. */
char *AccelDir; /**< Optional hardware acceleration engine search dir. */
/** Boolean: Do we try to enter from a smallish number
* of fixed nodes? */
src/app/config/or_state_st.h
-7
View File
@@ -89,13 +89,6 @@ struct or_state_t {
/** When did we last rotate our onion key? "0" for 'no idea'. */
time_t LastRotatedOnionKey;
/** Number of minutes since the last user-initiated request (as defined by
* the dormant net-status system.) Set to zero if we are dormant. */
int MinutesSinceUserActivity;
/** True if we were dormant when we last wrote the file; false if we
* weren't. "auto" on initial startup. */
int Dormant;
/**
* State objects for individual modules.
*
src/app/config/statefile.c
+9 -6
View File
@@ -45,6 +45,7 @@
#include "feature/relay/routermode.h"
#include "lib/sandbox/sandbox.h"
#include "app/config/statefile.h"
#include "app/main/subsysmgr.h"
#include "lib/encoding/confline.h"
#include "lib/net/resolve.h"
#include "lib/version/torversion.h"
@@ -131,9 +132,6 @@ static const config_var_t state_vars_[] = {
VAR("CircuitBuildTimeBin", LINELIST_S, BuildtimeHistogram, NULL),
VAR("BuildtimeHistogram", LINELIST_V, BuildtimeHistogram, NULL),
V(MinutesSinceUserActivity, POSINT, NULL),
V(Dormant, AUTOBOOL, "auto"),
END_OF_CONFIG_VARS
};
@@ -168,6 +166,7 @@ static const config_format_t state_format = {
.vars = state_vars_,
.legacy_validate_fn = or_state_validate_cb,
.extra = &state_extra_var,
.has_config_suite = true,
.config_suite_offset = offsetof(or_state_t, substates_),
};
@@ -175,11 +174,13 @@ static const config_format_t state_format = {
static config_mgr_t *state_mgr = NULL;
/** Return the configuration manager for state-file objects. */
static const config_mgr_t *
STATIC const config_mgr_t *
get_state_mgr(void)
{
if (PREDICT_UNLIKELY(state_mgr == NULL)) {
state_mgr = config_mgr_new(&state_format);
int rv = subsystems_register_state_formats(state_mgr);
tor_assert(rv == 0);
config_mgr_freeze(state_mgr);
}
return state_mgr;
@@ -313,6 +314,9 @@ or_state_set(or_state_t *new_state)
tor_assert(new_state);
config_free(get_state_mgr(), global_state);
global_state = new_state;
if (subsystems_set_state(get_state_mgr(), global_state) < 0) {
ret = -1;
}
if (entry_guards_parse_state(global_state, 1, &err)<0) {
log_warn(LD_GENERAL,"%s",err);
tor_free(err);
@@ -327,7 +331,6 @@ or_state_set(or_state_t *new_state)
get_circuit_build_times_mutable(),global_state) < 0) {
ret = -1;
}
netstatus_load_from_state(global_state, time(NULL));
return ret;
}
@@ -516,10 +519,10 @@ or_state_save(time_t now)
/* Call everything else that might dirty the state even more, in order
* to avoid redundant writes. */
(void) subsystems_flush_state(get_state_mgr(), global_state);
entry_guards_update_state(global_state);
rep_hist_update_state(global_state);
circuit_build_times_update_state(get_circuit_build_times(), global_state);
netstatus_flush_to_state(global_state, now);
if (accounting_is_enabled(get_options()))
accounting_run_housekeeping(now);
src/app/config/statefile.h
+2
View File
@@ -31,6 +31,8 @@ STATIC struct config_line_t *get_transport_in_state_by_name(
STATIC void or_state_free_(or_state_t *state);
#define or_state_free(st) FREE_AND_NULL(or_state_t, or_state_free_, (st))
STATIC or_state_t *or_state_new(void);
struct config_mgr_t;
STATIC const struct config_mgr_t *get_state_mgr(void);
#endif /* defined(STATEFILE_PRIVATE) */
#endif /* !defined(TOR_STATEFILE_H) */
src/app/main/main.c
-10
View File
@@ -592,9 +592,6 @@ tor_init(int argc, char *argv[])
return 1;
}
/* The options are now initialised */
const or_options_t *options = get_options();
/* Initialize channelpadding and circpad parameters to defaults
* until we get a consensus */
channelpadding_new_consensus_params(NULL);
@@ -616,13 +613,6 @@ tor_init(int argc, char *argv[])
"and you probably shouldn't.");
#endif
if (crypto_global_init(options->HardwareAccel,
options->AccelName,
options->AccelDir)) {
log_err(LD_BUG, "Unable to initialize OpenSSL. Exiting.");
return -1;
}
/* Scan/clean unparseable descriptors; after reading config */
routerparse_init();
src/app/main/subsysmgr.c
+215 -11
View File
@@ -14,10 +14,12 @@
#include "orconfig.h"
#include "app/main/subsysmgr.h"
#include "lib/confmgt/confmgt.h"
#include "lib/dispatch/dispatch_naming.h"
#include "lib/dispatch/msgtypes.h"
#include "lib/err/torerr.h"
#include "lib/log/log.h"
#include "lib/log/util_bug.h"
#include "lib/malloc/malloc.h"
#include "lib/pubsub/pubsub_build.h"
#include "lib/pubsub/pubsub_connect.h"
@@ -31,12 +33,42 @@
**/
static bool subsystem_array_validated = false;
/** Index value indicating that a subsystem has no options/state object, and
* so that object does not have an index. */
#define IDX_NONE (-1)
/**
* Runtime status of a single subsystem.
**/
typedef struct subsys_status_t {
/** True if the given subsystem is initialized. */
bool initialized;
/** Index for this subsystem's options object, or IDX_NONE for none. */
int options_idx;
/** Index for this subsystem's state object, or IDX_NONE for none. */
int state_idx;
} subsys_status_t;
/** An overestimate of the number of subsystems. */
#define N_SYS_STATUS 128
/**
* True if a given subsystem is initialized. Expand this array if there
* are more than this number of subsystems. (We'd rather not
* dynamically allocate in this module.)
**/
static bool sys_initialized[128];
static subsys_status_t sys_status[N_SYS_STATUS];
/** Set <b>status</b> to a default (not set-up) state. */
static void
subsys_status_clear(subsys_status_t *status)
{
if (!status)
return;
memset(status, 0, sizeof(*status));
status->initialized = false;
status->state_idx = IDX_NONE;
status->options_idx = IDX_NONE;
}
/**
* Exit with a raw assertion if the subsystems list is inconsistent;
@@ -48,8 +80,8 @@ check_and_setup(void)
if (subsystem_array_validated)
return;
raw_assert(ARRAY_LENGTH(sys_initialized) >= n_tor_subsystems);
memset(sys_initialized, 0, sizeof(sys_initialized));
raw_assert(ARRAY_LENGTH(sys_status) >= n_tor_subsystems);
memset(sys_status, 0, sizeof(sys_status));
int last_level = MIN_SUBSYS_LEVEL;
@@ -67,6 +99,8 @@ check_and_setup(void)
sys->name, i, sys->level, last_level);
raw_assert_unreached_msg("There is a bug in subsystem_list.c");
}
subsys_status_clear(&sys_status[i]);
last_level = sys->level;
}
@@ -97,7 +131,7 @@ subsystems_init_upto(int target_level)
continue;
if (sys->level > target_level)
break;
if (sys_initialized[i])
if (sys_status[i].initialized)
continue;
int r = 0;
if (sys->initialize) {
@@ -112,7 +146,7 @@ subsystems_init_upto(int target_level)
sys->name, i);
raw_assert_unreached_msg("A subsystem couldn't be initialized.");
}
sys_initialized[i] = true;
sys_status[i].initialized = true;
}
return 0;
@@ -132,7 +166,7 @@ subsystems_add_pubsub_upto(pubsub_builder_t *builder,
continue;
if (sys->level > target_level)
break;
if (! sys_initialized[i])
if (! sys_status[i].initialized)
continue;
int r = 0;
if (sys->add_pubsub) {
@@ -186,13 +220,13 @@ subsystems_shutdown_downto(int target_level)
continue;
if (sys->level <= target_level)
break;
if (! sys_initialized[i])
if (! sys_status[i].initialized)
continue;
if (sys->shutdown) {
log_debug(LD_GENERAL, "Shutting down %s", sys->name);
sys->shutdown();
}
sys_initialized[i] = false;
subsys_status_clear(&sys_status[i]);
}
}
@@ -208,7 +242,7 @@ subsystems_prefork(void)
const subsys_fns_t *sys = tor_subsystems[i];
if (!sys->supported)
continue;
if (! sys_initialized[i])
if (! sys_status[i].initialized)
continue;
if (sys->prefork) {
log_debug(LD_GENERAL, "Pre-fork: %s", sys->name);
@@ -229,7 +263,7 @@ subsystems_postfork(void)
const subsys_fns_t *sys = tor_subsystems[i];
if (!sys->supported)
continue;
if (! sys_initialized[i])
if (! sys_status[i].initialized)
continue;
if (sys->postfork) {
log_debug(LD_GENERAL, "Post-fork: %s", sys->name);
@@ -250,7 +284,7 @@ subsystems_thread_cleanup(void)
const subsys_fns_t *sys = tor_subsystems[i];
if (!sys->supported)
continue;
if (! sys_initialized[i])
if (! sys_status[i].initialized)
continue;
if (sys->thread_cleanup) {
log_debug(LD_GENERAL, "Thread cleanup: %s", sys->name);
@@ -258,3 +292,173 @@ subsystems_thread_cleanup(void)
}
}
}
/**
* Register all subsystem-declared options formats in <b>mgr</b>.
*
* Return 0 on success, -1 on failure.
**/
int
subsystems_register_options_formats(config_mgr_t *mgr)
{
tor_assert(mgr);
check_and_setup();
for (unsigned i = 0; i < n_tor_subsystems; ++i) {
const subsys_fns_t *sys = tor_subsystems[i];
if (sys->options_format) {
int options_idx = config_mgr_add_format(mgr, sys->options_format);
sys_status[i].options_idx = options_idx;
log_debug(LD_CONFIG, "Added options format for %s with index %d",
sys->name, options_idx);
}
}
return 0;
}
/**
* Register all subsystem-declared state formats in <b>mgr</b>.
*
* Return 0 on success, -1 on failure.
**/
int
subsystems_register_state_formats(config_mgr_t *mgr)
{
tor_assert(mgr);
check_and_setup();
for (unsigned i = 0; i < n_tor_subsystems; ++i) {
const subsys_fns_t *sys = tor_subsystems[i];
if (sys->state_format) {
int state_idx = config_mgr_add_format(mgr, sys->state_format);
sys_status[i].state_idx = state_idx;
log_debug(LD_CONFIG, "Added state format for %s with index %d",
sys->name, state_idx);
}
}
return 0;
}
#ifdef TOR_UNIT_TESTS
/**
* Helper: look up the index for <b>sys</b>. Return -1 if the subsystem
* is not recognized.
**/
static int
subsys_get_idx(const subsys_fns_t *sys)
{
for (unsigned i = 0; i < n_tor_subsystems; ++i) {
if (sys == tor_subsystems[i])
return (int)i;
}
return -1;
}
/**
* Return the current state-manager's index for any state held by the
* subsystem <b>sys</b>. If <b>sys</b> has no options, return -1.
*
* Using raw indices can be error-prone: only do this from the unit
* tests. If you need a way to access another subsystem's configuration,
* that subsystem should provide access functions.
**/
int
subsystems_get_options_idx(const subsys_fns_t *sys)
{
int i = subsys_get_idx(sys);
tor_assert(i >= 0);
return sys_status[i].options_idx;
}
/**
* Return the current state-manager's index for any state held by the
* subsystem <b>sys</b>. If <b>sys</b> has no state, return -1.
*
* Using raw indices can be error-prone: only do this from the unit
* tests. If you need a way to access another subsystem's state
* that subsystem should provide access functions.
**/
int
subsystems_get_state_idx(const subsys_fns_t *sys)
{
int i = subsys_get_idx(sys);
tor_assert(i >= 0);
return sys_status[i].state_idx;
}
#endif
/**
* Call all appropriate set_options() methods to tell the various subsystems
* about a new set of torrc options. Return 0 on success, -1 on
* nonrecoverable failure.
**/
int
subsystems_set_options(const config_mgr_t *mgr, struct or_options_t *options)
{
/* XXXX This does not yet handle reversible option assignment; I'll
* do that later in this branch. */
for (unsigned i = 0; i < n_tor_subsystems; ++i) {
const subsys_fns_t *sys = tor_subsystems[i];
if (sys_status[i].options_idx >= 0 && sys->set_options) {
void *obj = config_mgr_get_obj_mutable(mgr, options,
sys_status[i].options_idx);
int rv = sys->set_options(obj);
if (rv < 0) {
log_err(LD_CONFIG, "Error when handling option for %s; "
"cannot proceed.", sys->name);
return -1;
}
}
}
return 0;
}
/**
* Call all appropriate set_state() methods to tell the various subsystems
* about an initial DataDir/state file. Return 0 on success, -1 on
* nonrecoverable failure.
**/
int
subsystems_set_state(const config_mgr_t *mgr, struct or_state_t *state)
{
for (unsigned i = 0; i < n_tor_subsystems; ++i) {
const subsys_fns_t *sys = tor_subsystems[i];
if (sys_status[i].state_idx >= 0 && sys->set_state) {
void *obj = config_mgr_get_obj_mutable(mgr, state,
sys_status[i].state_idx);
int rv = sys->set_state(obj);
if (rv < 0) {
log_err(LD_CONFIG, "Error when handling state for %s; "
"cannot proceed.", sys->name);
return -1;
}
}
}
return 0;
}
/**
* Call all appropriate flush_state() methods to tell the various subsystems
* to update the state objects in <b>state</b>. Return 0 on success,
* -1 on failure.
**/
int
subsystems_flush_state(const config_mgr_t *mgr, struct or_state_t *state)
{
int result = 0;
for (unsigned i = 0; i < n_tor_subsystems; ++i) {
const subsys_fns_t *sys = tor_subsystems[i];
if (sys_status[i].state_idx >= 0 && sys->flush_state) {
void *obj = config_mgr_get_obj_mutable(mgr, state,
sys_status[i].state_idx);
int rv = sys->flush_state(obj);
if (rv < 0) {
log_warn(LD_CONFIG, "Error when flushing state to state object for %s",
sys->name);
result = -1;
}
}
}
return result;
}
src/app/main/subsysmgr.h
+17
View File
@@ -31,4 +31,21 @@ void subsystems_prefork(void);
void subsystems_postfork(void);
void subsystems_thread_cleanup(void);
struct config_mgr_t;
int subsystems_register_options_formats(struct config_mgr_t *mgr);
int subsystems_register_state_formats(struct config_mgr_t *mgr);
struct or_options_t;
struct or_state_t;
int subsystems_set_options(const struct config_mgr_t *mgr,
struct or_options_t *options);
int subsystems_set_state(const struct config_mgr_t *mgr,
struct or_state_t *state);
int subsystems_flush_state(const struct config_mgr_t *mgr,
struct or_state_t *state);
#ifdef TOR_UNIT_TESTS
int subsystems_get_options_idx(const subsys_fns_t *sys);
int subsystems_get_state_idx(const subsys_fns_t *sys);
#endif
#endif /* !defined(TOR_SUBSYSMGR_T) */
src/core/include.am
+2
View File
@@ -245,6 +245,8 @@ noinst_HEADERS += \
src/core/mainloop/cpuworker.h \
src/core/mainloop/mainloop.h \
src/core/mainloop/mainloop_pubsub.h \
src/core/mainloop/mainloop_state.inc \
src/core/mainloop/mainloop_state_st.h \
src/core/mainloop/mainloop_sys.h \
src/core/mainloop/netstatus.h \
src/core/mainloop/periodic.h \
src/core/mainloop/.may_include
+3 -1
View File
@@ -2,6 +2,7 @@
orconfig.h
lib/conf/*.h
lib/container/*.h
lib/dispatch/*.h
lib/evloop/*.h
@@ -17,4 +18,5 @@ lib/geoip/*.h
lib/sandbox/*.h
lib/compress/*.h
core/mainloop/*.h
core/mainloop/*.h
core/mainloop/*.inc
src/core/mainloop/mainloop_state.inc
+19
View File
@@ -0,0 +1,19 @@
/**
* @file mainloop_state.inc
* @brief Declare configuration options for the crypto_ops module.
**/
/** Holds state for the mainloop, corresponding to part of the state
* file in Tor's DataDirectory. */
BEGIN_CONF_STRUCT(mainloop_state_t)
/** Number of minutes since the last user-initiated request (as defined by
* the dormant net-status system.) Set to zero if we are dormant. */
CONF_VAR(MinutesSinceUserActivity, POSINT, 0, NULL)
/** True if we were dormant when we last wrote the file; false if we
* weren't. "auto" on initial startup. */
CONF_VAR(Dormant, AUTOBOOL, 0, "auto")
END_CONF_STRUCT(mainloop_state_t)
src/core/mainloop/mainloop_state_st.h
+23
View File
@@ -0,0 +1,23 @@
/* 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 mainloop_state_st.h
* @brief Declare a state structure for mainloop-relevant fields
**/
#ifndef TOR_CORE_MAINLOOP_MAINLOOP_STATE_ST_H
#define TOR_CORE_MAINLOOP_MAINLOOP_STATE_ST_H
#include "lib/conf/confdecl.h"
#define CONF_CONTEXT STRUCT
#include "core/mainloop/mainloop_state.inc"
#undef CONF_CONTEXT
typedef struct mainloop_state_t mainloop_state_t;
#endif /* !defined(TOR_CORE_MAINLOOP_MAINLOOP_STATE_ST_H) */
src/core/mainloop/mainloop_sys.c
+52
View File
@@ -12,6 +12,10 @@
#include "core/or/or.h"
#include "core/mainloop/mainloop_sys.h"
#include "core/mainloop/mainloop.h"
#include "core/mainloop/mainloop_state_st.h"
#include "core/mainloop/netstatus.h"
#include "lib/conf/conftypes.h"
#include "lib/conf/confdecl.h"
#include "lib/subsys/subsys.h"
@@ -28,10 +32,58 @@ subsys_mainloop_shutdown(void)
tor_mainloop_free_all();
}
/** Declare a list of state variables for mainloop state. */
#define CONF_CONTEXT TABLE
#include "core/mainloop/mainloop_state.inc"
#undef CONF_CONTEXT
/** Magic number for mainloop state objects */
#define MAINLOOP_STATE_MAGIC 0x59455449
/**
* Format object for mainloop state.
**/
static config_format_t mainloop_state_fmt = {
.size = sizeof(mainloop_state_t),
.magic = { "mainloop_state",
MAINLOOP_STATE_MAGIC,
offsetof(mainloop_state_t, magic)
},
.vars = mainloop_state_t_vars,
};
/**
*/
static int
mainloop_set_state(void *arg)
{
const mainloop_state_t *state = arg;
tor_assert(state->magic == MAINLOOP_STATE_MAGIC);
netstatus_load_from_state(state, approx_time());
return 0;
}
static int
mainloop_flush_state(void *arg)
{
mainloop_state_t *state = arg;
tor_assert(state->magic == MAINLOOP_STATE_MAGIC);
netstatus_flush_to_state(state, approx_time());
return 0;
}
const struct subsys_fns_t sys_mainloop = {
.name = "mainloop",
.supported = true,
.level = 5,
.initialize = subsys_mainloop_initialize,
.shutdown = subsys_mainloop_shutdown,
.state_format = &mainloop_state_fmt,
.set_state = mainloop_set_state,
.flush_state = mainloop_flush_state,
};
src/core/mainloop/netstatus.c
+3 -2
View File
@@ -12,6 +12,7 @@
#include "core/or/or.h"
#include "core/mainloop/netstatus.h"
#include "core/mainloop/mainloop.h"
#include "core/mainloop/mainloop_state_st.h"
#include "app/config/config.h"
#include "feature/hibernate/hibernate.h"
@@ -115,7 +116,7 @@ is_participating_on_network(void)
* Update 'state' with the last time at which we were active on the network.
**/
void
netstatus_flush_to_state(or_state_t *state, time_t now)
netstatus_flush_to_state(mainloop_state_t *state, time_t now)
{
state->Dormant = ! participating_on_network;
if (participating_on_network) {
@@ -130,7 +131,7 @@ netstatus_flush_to_state(or_state_t *state, time_t now)
* Update our current view of network participation from an or_state_t object.
**/
void
netstatus_load_from_state(const or_state_t *state, time_t now)
netstatus_load_from_state(const mainloop_state_t *state, time_t now)
{
time_t last_activity;
if (state->Dormant == -1) { // Initial setup.
src/core/mainloop/netstatus.h
+5 -2
View File
@@ -22,8 +22,11 @@ time_t get_last_user_activity_time(void);
void set_network_participation(bool participation);
bool is_participating_on_network(void);
void netstatus_flush_to_state(or_state_t *state, time_t now);
void netstatus_load_from_state(const or_state_t *state, time_t now);
struct mainloop_state_t;
void netstatus_flush_to_state(struct mainloop_state_t *state, time_t now);
void netstatus_load_from_state(const struct mainloop_state_t *state,
time_t now);
void netstatus_note_clock_jumped(time_t seconds_diff);
#endif /* !defined(TOR_NETSTATUS_H) */
src/feature/dirauth/shared_random_state.c
-1
View File
@@ -92,7 +92,6 @@ static const config_format_t state_format = {
},
.vars = state_vars,
.extra = &state_extra_var,
.config_suite_offset = -1,
};
/** Global configuration manager for the shared-random state file */
src/feature/nodelist/routerset.h
+1
View File
@@ -46,6 +46,7 @@ int routerset_len(const routerset_t *set);
struct var_type_def_t;
extern const struct var_type_def_t ROUTERSET_type_defn;
typedef routerset_t config_decl_ROUTERSET;
#ifdef ROUTERSET_PRIVATE
#include "lib/container/bitarray.h"
src/feature/relay/router.c
-9
View File
@@ -887,15 +887,6 @@ init_keys_common(void)
if (!key_lock)
key_lock = tor_mutex_new();
/* There are a couple of paths that put us here before we've asked
* openssl to initialize itself. */
if (crypto_global_init(get_options()->HardwareAccel,
get_options()->AccelName,
get_options()->AccelDir)) {
log_err(LD_BUG, "Unable to initialize OpenSSL. Exiting.");
return -1;
}
return 0;
}
src/lib/cc/include.am
+1
View File
@@ -3,4 +3,5 @@
noinst_HEADERS += \
src/lib/cc/compat_compiler.h \
src/lib/cc/ctassert.h \
src/lib/cc/tokpaste.h \
src/lib/cc/torint.h
src/lib/cc/tokpaste.h
+30
View File
@@ -0,0 +1,30 @@
/* 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 tokpaste.h
* @brief Token-pasting macros.
**/
#ifndef TOR_LIB_CC_TOKPASTE_H
#define TOR_LIB_CC_TOKPASTE_H
/**
* Concatenate `a` and `b` in a way that allows their result itself to be
* expanded by the preprocessor.
*
* Ordinarily you could just say `a ## b` in a macro definition. But doing so
* results in a symbol which the preprocessor will not then expand. If you
* wanted to use `a ## b` to create the name of a macro and have the
* preprocessor expand _that_ macro, you need to have another level of
* indirection, as this macro provides.
**/
#define PASTE(a,b) PASTE__(a,b)
/** Helper for PASTE(). */
#define PASTE__(a,b) a ## b
#endif /* !defined(TOR_LIB_CC_TOKPASTE_H) */
src/lib/conf/confdecl.h
+197
View File
@@ -0,0 +1,197 @@
/* 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 confdecl.h
* @brief Macros for generating a configuration struct from a list
* of its individual fields.
*
* This header defines three important macros: BEGIN_CONF_STRUCT(),
* END_CONF_STRUCT(), and CONF_VAR(). They're meant to be used together to
* define a configuration structure and the means for encoding and decoding
* it.
*
* To use them, make a new header with a name like `MOD_options.inc`. Start
* it with a BEGIN_CONF_STRUCT(), then define your variables with CONF_VAR(),
* then end the header with END_CONF_STRUCT(), as in:
*
* BEGIN_CONF_STRUCT(module_options_t)
* CONF_VAR(ModuleIsActive, BOOLEAN, 0, "1")
* END_CONF_STRUCT(module_options_t)
*
* Once you've done that, you can use that header to define a configuration
* structure by saying:
*
* typedef struct module_options_t module_options_t;
* #define CONF_CONTEXT STRUCT
* #include "MOD_options.inc"
* #undef CONF_CONTEXT
*
* And you can define your field definition table by saying:
*
* #define CONF_CONTEXT TABLE
* #include "MOD_options.inc"
* #undef CONF_CONTEXT
*
* The two above snippets will define a structure called `module_options_t`
* with appropriate members, and a table of config_var_t objects called
* `module_options_t_vars[]`.
*
* For lower-level modules, you can say `#define CONF_TABLE LL_TABLE`, and get
* a table definition suitable for use in modules that are at a lower level
* than lib/confmgt. Note that the types for these tables cannot include any
* extended types.
**/
#ifndef TOR_LIB_CONF_CONFDECL_H
#define TOR_LIB_CONF_CONFDECL_H
#undef CONF_CONTEXT
#include "lib/cc/tokpaste.h"
/**
* Begin the definition of a configuration object called `name`.
**/
#define BEGIN_CONF_STRUCT(name) \
PASTE(BEGIN_CONF_STRUCT__, CONF_CONTEXT)(name)
/**
* End the definition of a configuration object called `name`.
**/
#define END_CONF_STRUCT(name) \
PASTE(END_CONF_STRUCT__, CONF_CONTEXT)(name)
/**
* Declare a single configuration field with name `varname`, type `vartype`,
* flags `varflags`, and initial value `initval`.
**/
#define CONF_VAR(varname, vartype, varflags, initval) \
PASTE(CONF_VAR__, CONF_CONTEXT)(varname, vartype, varflags, initval)
#ifndef COCCI
/**
* @defgroup STRUCT_MACROS Internal macros: struct definitions.
* Implementation helpers: the regular confdecl macros expand to these
* when CONF_CONTEXT is defined to STRUCT. Don't use them directly.
* @{*/
#define BEGIN_CONF_STRUCT__STRUCT(name) \
struct name { \
uint32_t magic;
#define END_CONF_STRUCT__STRUCT(name) \
};
#define CONF_VAR__STRUCT(varname, vartype, varflags, initval) \
config_decl_ ## vartype varname;
/** @} */
/**
* @defgroup TABLE_MACROS Internal macros: table definitions.
* Implementation helpers: the regular confdecl macros expand to these
* when CONF_CONTEXT is defined to TABLE. Don't use them directly.
* @{*/
#define BEGIN_CONF_STRUCT__TABLE(structname) \
/* We use this typedef so we can refer to the config type */ \
/* without having its name as a macro argument to CONF_VAR. */ \
typedef struct structname config_var_reference__obj; \
static const config_var_t structname##_vars[] = {
#define END_CONF_STRUCT__TABLE(structname) \
{ .member = { .name = NULL } } \
};
#define CONF_VAR__TABLE(varname, vartype, varflags, initval) \
{ \
.member = \
{ .name = #varname, \
.type = CONFIG_TYPE_EXTENDED, \
.type_def = &vartype ## _type_defn, \
.offset=offsetof(config_var_reference__obj, varname), \
}, \
.flags = varflags, \
.initvalue = initval \
},
/**@}*/
/**
* @defgroup LL_TABLE_MACROS Internal macros: low-level table definitions.
* Implementation helpers: the regular confdecl macros expand to these
* when CONF_CONTEXT is defined to LL_TABLE. Don't use them directly.
* @{*/
#define BEGIN_CONF_STRUCT__LL_TABLE(structname) \
/* We use this typedef so we can refer to the config type */ \
/* without having its name as a macro argument to CONF_VAR. */ \
typedef struct structname config_var_reference__obj; \
static const config_var_t structname##_vars[] = {
#define END_CONF_STRUCT__LL_TABLE(structname) \
{ .member = { .name = NULL } } \
};
#define CONF_VAR__LL_TABLE(varname, vartype, varflags, initval) \
{ \
.member = \
{ .name = #varname, \
.type = CONFIG_TYPE_ ## vartype, \
.offset=offsetof(config_var_reference__obj, varname), \
}, \
.flags = varflags, \
.initvalue = initval \
},
/**@}*/
#endif
/** Type aliases for the "commonly used" configuration types.
*
* Defining them in this way allows our CONF_VAR__STRUCT() macro to declare
* structure members corresponding to the configuration types. For example,
* when the macro sees us declare a configuration option "foo" of type STRING,
* it can emit `config_decl_STRING foo;`, which is an alias for `char *foo`.
*/
/**{*/
typedef char *config_decl_STRING;
typedef char *config_decl_FILENAME;
/* Yes, "POSINT" is really an int, and not an unsigned int. For
* historical reasons, many configuration values are restricted
* to the range [0,INT_MAX], and stored in signed ints.
*/
typedef int config_decl_POSINT;
typedef uint64_t config_decl_UINT64;
typedef int config_decl_INT;
typedef int config_decl_INTERVAL;
typedef int config_decl_MSEC_INTERVAL;
typedef uint64_t config_decl_MEMUNIT;
typedef double config_decl_DOUBLE;
typedef int config_decl_BOOL;
typedef int config_decl_AUTOBOOL;
typedef time_t config_decl_ISOTIME;
typedef struct smartlist_t config_decl_CSV;
typedef int config_decl_CSV_INTERVAL;
typedef struct config_line_t *config_decl_LINELIST;
typedef struct config_line_t *config_decl_LINELIST_V;
typedef struct nonexistent_struct *config_decl_LINELIST_S;
/**@}*/
struct var_type_def_t;
/* Forward declarations for configuration type definitions. These are used by
* the CONF_VAR__TABLE macro to set the definition of each variable type
* correctly.
*/
/**@{*/
extern const struct var_type_def_t STRING_type_defn;
extern const struct var_type_def_t FILENAME_type_defn;
extern const struct var_type_def_t POSINT_type_defn;
extern const struct var_type_def_t UINT64_type_defn;
extern const struct var_type_def_t INT_type_defn;
extern const struct var_type_def_t INTERVAL_type_defn;
extern const struct var_type_def_t MSEC_INTERVAL_type_defn;
extern const struct var_type_def_t MEMUNIT_type_defn;
extern const struct var_type_def_t DOUBLE_type_defn;
extern const struct var_type_def_t BOOL_type_defn;
extern const struct var_type_def_t AUTOBOOL_type_defn;
extern const struct var_type_def_t ISOTIME_type_defn;
extern const struct var_type_def_t CSV_type_defn;
extern const struct var_type_def_t CSV_INTERVAL_type_defn;
extern const struct var_type_def_t LINELIST_type_defn;
extern const struct var_type_def_t LINELIST_V_type_defn;
extern const struct var_type_def_t LINELIST_S_type_defn;
extern const struct var_type_def_t OBSOLETE_type_defn;
/**@}*/
#endif /* !defined(TOR_LIB_CONF_CONFDECL_H) */
src/lib/conf/conftypes.h
+8 -2
View File
@@ -335,8 +335,14 @@ typedef struct config_format_t {
/** 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. */
/**
* If true, this format describes a top-level configuration, with
* a suite containing multiple sub-configuration objects.
*/
bool has_config_suite;
/** The position of a config_suite_t pointer within the toplevel object.
* Ignored unless have_config_suite is true.
*/
ptrdiff_t config_suite_offset;
} config_format_t;
src/lib/conf/include.am
+1
View File
@@ -1,6 +1,7 @@
# ADD_C_FILE: INSERT HEADERS HERE.
noinst_HEADERS += \
src/lib/conf/confdecl.h \
src/lib/conf/conftesting.h \
src/lib/conf/conftypes.h \
src/lib/conf/confmacros.h
src/lib/confmgt/confmgt.c
+9 -4
View File
@@ -169,9 +169,14 @@ config_mgr_register_fmt(config_mgr_t *mgr,
"it had been frozen.");
if (object_idx != IDX_TOPLEVEL) {
tor_assertf(fmt->config_suite_offset < 0,
tor_assertf(! fmt->has_config_suite,
"Tried to register a toplevel format in a non-toplevel position");
}
if (fmt->config_suite_offset) {
tor_assertf(fmt->has_config_suite,
"config_suite_offset was set, but has_config_suite was not.");
}
tor_assertf(fmt != mgr->toplevel &&
! smartlist_contains(mgr->subconfigs, fmt),
"Tried to register an already-registered format.");
@@ -223,7 +228,7 @@ config_mgr_add_format(config_mgr_t *mgr,
static inline config_suite_t **
config_mgr_get_suite_ptr(const config_mgr_t *mgr, void *toplevel)
{
if (mgr->toplevel->config_suite_offset < 0)
if (! mgr->toplevel->has_config_suite)
return NULL;
return STRUCT_VAR_P(toplevel, mgr->toplevel->config_suite_offset);
}
@@ -237,7 +242,7 @@ config_mgr_get_suite_ptr(const config_mgr_t *mgr, void *toplevel)
* to configuration objects for other modules. This function gets
* the sub-object for a particular module.
*/
STATIC void *
void *
config_mgr_get_obj_mutable(const config_mgr_t *mgr, void *toplevel, int idx)
{
tor_assert(mgr);
@@ -256,7 +261,7 @@ config_mgr_get_obj_mutable(const config_mgr_t *mgr, void *toplevel, int idx)
}
/** As config_mgr_get_obj_mutable(), but return a const pointer. */
STATIC const void *
const void *
config_mgr_get_obj(const config_mgr_t *mgr, const void *toplevel, int idx)
{
return config_mgr_get_obj_mutable(mgr, (void*)toplevel, idx);
src/lib/confmgt/confmgt.h
+5 -4
View File
@@ -123,13 +123,14 @@ bool config_var_is_listable(const config_var_t *var);
#define CFG_EQ_LINELIST(a,b,opt) config_lines_eq((a)->opt, (b)->opt)
#define CFG_EQ_ROUTERSET(a,b,opt) routerset_equal((a)->opt, (b)->opt)
void *config_mgr_get_obj_mutable(const config_mgr_t *mgr,
void *toplevel, int idx);
const void *config_mgr_get_obj(const config_mgr_t *mgr,
const void *toplevel, int idx);
#ifdef CONFMGT_PRIVATE
STATIC void config_reset_line(const config_mgr_t *mgr, void *options,
const char *key, int use_defaults);
STATIC void *config_mgr_get_obj_mutable(const config_mgr_t *mgr,
void *toplevel, int idx);
STATIC const void *config_mgr_get_obj(const config_mgr_t *mgr,
const void *toplevel, int idx);
#endif /* defined(CONFMGT_PRIVATE) */
#endif /* !defined(TOR_CONFMGT_H) */
src/lib/confmgt/type_defs.c
+79 -42
View File
@@ -17,6 +17,7 @@
#include "orconfig.h"
#include "lib/conf/conftypes.h"
#include "lib/conf/confdecl.h"
#include "lib/confmgt/typedvar.h"
#include "lib/confmgt/type_defs.h"
#include "lib/confmgt/unitparse.h"
@@ -720,50 +721,86 @@ static const var_type_fns_t ignore_fns = {
.encode = ignore_encode,
};
const var_type_def_t STRING_type_defn = {
.name="String", .fns=&string_fns };
const var_type_def_t FILENAME_type_defn = {
.name="Filename", .fns=&string_fns };
const var_type_def_t INT_type_defn = {
.name="SignedInteger", .fns=&int_fns,
.params=&INT_PARSE_UNRESTRICTED };
const var_type_def_t POSINT_type_defn = {
.name="Integer", .fns=&int_fns,
.params=&INT_PARSE_POSINT };
const var_type_def_t UINT64_type_defn = {
.name="Integer", .fns=&uint64_fns, };
const var_type_def_t MEMUNIT_type_defn = {
.name="DataSize", .fns=&memunit_fns,
.params=&memory_units };
const var_type_def_t INTERVAL_type_defn = {
.name="TimeInterval", .fns=&interval_fns,
.params=&time_units };
const var_type_def_t MSEC_INTERVAL_type_defn = {
.name="TimeMsecInterval",
.fns=&interval_fns,
.params=&time_msec_units };
const var_type_def_t DOUBLE_type_defn = {
.name="Float", .fns=&double_fns, };
const var_type_def_t BOOL_type_defn = {
.name="Boolean", .fns=&enum_fns,
.params=&enum_table_bool };
const var_type_def_t AUTOBOOL_type_defn = {
.name="Boolean+Auto", .fns=&enum_fns,
.params=&enum_table_autobool };
const var_type_def_t ISOTIME_type_defn = {
.name="Time", .fns=&time_fns, };
const var_type_def_t CSV_type_defn = {
.name="CommaList", .fns=&csv_fns, };
const var_type_def_t CSV_INTERVAL_type_defn = {
.name="TimeInterval",
.fns=&legacy_csv_interval_fns, };
const var_type_def_t LINELIST_type_defn = {
.name="LineList", .fns=&linelist_fns,
.flags=CFLG_NOREPLACE };
/*
* A "linelist_s" is a derived view of a linelist_v: inspecting
* it gets part of a linelist_v, and setting it adds to the linelist_v.
*/
const var_type_def_t LINELIST_S_type_defn = {
.name="Dependent", .fns=&linelist_s_fns,
.flags=CFLG_NOREPLACE|
/* The operations we disable here are
* handled by the linelist_v. */
CFLG_NOCOPY|CFLG_NOCMP|CFLG_NODUMP };
const var_type_def_t LINELIST_V_type_defn = {
.name="Virtual", .fns=&linelist_v_fns,
.flags=CFLG_NOREPLACE|CFLG_NOSET };
const var_type_def_t OBSOLETE_type_defn = {
.name="Obsolete", .fns=&ignore_fns,
.flags=CFLG_GROUP_OBSOLETE,
};
/**
* Table mapping conf_type_t values to var_type_def_t objects.
**/
static const var_type_def_t type_definitions_table[] = {
[CONFIG_TYPE_STRING] = { .name="String", .fns=&string_fns },
[CONFIG_TYPE_FILENAME] = { .name="Filename", .fns=&string_fns },
[CONFIG_TYPE_INT] = { .name="SignedInteger", .fns=&int_fns,
.params=&INT_PARSE_UNRESTRICTED },
[CONFIG_TYPE_POSINT] = { .name="Integer", .fns=&int_fns,
.params=&INT_PARSE_POSINT },
[CONFIG_TYPE_UINT64] = { .name="Integer", .fns=&uint64_fns, },
[CONFIG_TYPE_MEMUNIT] = { .name="DataSize", .fns=&memunit_fns,
.params=&memory_units },
[CONFIG_TYPE_INTERVAL] = { .name="TimeInterval", .fns=&interval_fns,
.params=&time_units },
[CONFIG_TYPE_MSEC_INTERVAL] = { .name="TimeMsecInterval",
.fns=&interval_fns,
.params=&time_msec_units },
[CONFIG_TYPE_DOUBLE] = { .name="Float", .fns=&double_fns, },
[CONFIG_TYPE_BOOL] = { .name="Boolean", .fns=&enum_fns,
.params=&enum_table_bool },
[CONFIG_TYPE_AUTOBOOL] = { .name="Boolean+Auto", .fns=&enum_fns,
.params=&enum_table_autobool },
[CONFIG_TYPE_ISOTIME] = { .name="Time", .fns=&time_fns, },
[CONFIG_TYPE_CSV] = { .name="CommaList", .fns=&csv_fns, },
[CONFIG_TYPE_CSV_INTERVAL] = { .name="TimeInterval",
.fns=&legacy_csv_interval_fns, },
[CONFIG_TYPE_LINELIST] = { .name="LineList", .fns=&linelist_fns,
.flags=CFLG_NOREPLACE },
/*
* A "linelist_s" is a derived view of a linelist_v: inspecting
* it gets part of a linelist_v, and setting it adds to the linelist_v.
*/
[CONFIG_TYPE_LINELIST_S] = { .name="Dependent", .fns=&linelist_s_fns,
.flags=CFLG_NOREPLACE|
/* The operations we disable here are
* handled by the linelist_v. */
CFLG_NOCOPY|CFLG_NOCMP|CFLG_NODUMP },
[CONFIG_TYPE_LINELIST_V] = { .name="Virtual", .fns=&linelist_v_fns,
.flags=CFLG_NOREPLACE|CFLG_NOSET },
[CONFIG_TYPE_OBSOLETE] = {
.name="Obsolete", .fns=&ignore_fns,
.flags=CFLG_GROUP_OBSOLETE,
}
static const var_type_def_t *type_definitions_table[] = {
[CONFIG_TYPE_STRING] = &STRING_type_defn,
[CONFIG_TYPE_FILENAME] = &FILENAME_type_defn,
[CONFIG_TYPE_INT] = &INT_type_defn,
[CONFIG_TYPE_POSINT] = &POSINT_type_defn,
[CONFIG_TYPE_UINT64] = &UINT64_type_defn,
[CONFIG_TYPE_MEMUNIT] = &MEMUNIT_type_defn,
[CONFIG_TYPE_INTERVAL] = &INTERVAL_type_defn,
[CONFIG_TYPE_MSEC_INTERVAL] = &MSEC_INTERVAL_type_defn,
[CONFIG_TYPE_DOUBLE] = &DOUBLE_type_defn,
[CONFIG_TYPE_BOOL] = &BOOL_type_defn,
[CONFIG_TYPE_AUTOBOOL] = &AUTOBOOL_type_defn,
[CONFIG_TYPE_ISOTIME] = &ISOTIME_type_defn,
[CONFIG_TYPE_CSV] = &CSV_type_defn,
[CONFIG_TYPE_CSV_INTERVAL] = &CSV_INTERVAL_type_defn,
[CONFIG_TYPE_LINELIST] = &LINELIST_type_defn,
[CONFIG_TYPE_LINELIST_S] = &LINELIST_S_type_defn,
[CONFIG_TYPE_LINELIST_V] = &LINELIST_V_type_defn,
[CONFIG_TYPE_OBSOLETE] = &OBSOLETE_type_defn,
};
/**
@@ -777,5 +814,5 @@ lookup_type_def(config_type_t type)
tor_assert(t >= 0);
if (t >= (int)ARRAY_LENGTH(type_definitions_table))
return NULL;
return &type_definitions_table[t];
return type_definitions_table[t];
}
src/lib/crypt_ops/.may_include
+3
View File
@@ -1,6 +1,7 @@
orconfig.h
lib/arch/*.h
lib/cc/*.h
lib/conf/*.h
lib/container/*.h
lib/crypt_ops/*.h
lib/ctime/*.h
@@ -17,6 +18,8 @@ lib/testsupport/*.h
lib/thread/*.h
lib/log/*.h
lib/crypt_ops/*.inc
trunnel/pwbox.h
keccak-tiny/*.h
src/lib/crypt_ops/crypto_init.c
+66
View File
@@ -23,6 +23,9 @@
#include "lib/crypt_ops/crypto_nss_mgt.h"
#include "lib/crypt_ops/crypto_rand.h"
#include "lib/crypt_ops/crypto_sys.h"
#include "lib/crypt_ops/crypto_options_st.h"
#include "lib/conf/conftypes.h"
#include "lib/log/util_bug.h"
#include "lib/subsys/subsys.h"
@@ -252,6 +255,66 @@ subsys_crypto_thread_cleanup(void)
crypto_thread_cleanup();
}
/** Magic number for crypto_options_t. */
#define CRYPTO_OPTIONS_MAGIC 0x68757368
/**
* Return 0 if <b>arg</b> is a valid crypto_options_t. Otherwise return -1
* and set *<b>msg_out</b> to a freshly allocated error string.
**/
static int
crypto_options_validate(const void *arg, char **msg_out)
{
const crypto_options_t *opt = arg;
tor_assert(opt->magic == CRYPTO_OPTIONS_MAGIC);
tor_assert(msg_out);
if (opt->AccelDir && !opt->AccelName) {
*msg_out = tor_strdup("Can't use hardware crypto accelerator dir "
"without engine name.");
return -1;
}
return 0;
}
/* Declare the options field table for crypto_options */
#define CONF_CONTEXT LL_TABLE
#include "lib/crypt_ops/crypto_options.inc"
#undef CONF_CONTEXT
/**
* Declares the configuration options for this module.
**/
static const config_format_t crypto_options_fmt = {
.size = sizeof(crypto_options_t),
.magic = { "crypto_options_t",
CRYPTO_OPTIONS_MAGIC,
offsetof(crypto_options_t, magic) },
.vars = crypto_options_t_vars,
.validate_fn = crypto_options_validate,
};
/**
* Invoked from subsysmgr.c when a new set of options arrives.
**/
static int
crypto_set_options(void *arg)
{
const crypto_options_t *options = arg;
const bool hardware_accel = options->HardwareAccel || options->AccelName;
// This call already checks for crypto_global_initialized_, so it
// will only initialize the subsystem the first time it's called.
if (crypto_global_init(hardware_accel,
options->AccelName,
options->AccelDir)) {
log_err(LD_BUG, "Unable to initialize the crypto subsystem. Exiting.");
return -1;
}
return 0;
}
const struct subsys_fns_t sys_crypto = {
.name = "crypto",
.supported = true,
@@ -261,4 +324,7 @@ const struct subsys_fns_t sys_crypto = {
.prefork = subsys_crypto_prefork,
.postfork = subsys_crypto_postfork,
.thread_cleanup = subsys_crypto_thread_cleanup,
.options_format = &crypto_options_fmt,
.set_options = crypto_set_options,
};
src/lib/crypt_ops/crypto_openssl_mgt.c
+24 -4
View File
@@ -275,8 +275,14 @@ log_engine(const char *fn, ENGINE *e)
}
#endif /* !defined(DISABLE_ENGINES) */
/** Initialize engines for openssl (if enabled). */
static void
/** Initialize engines for openssl (if enabled). Load all the built-in
* engines, along with the one called <b>accelName</b> (which may be NULL).
* If <b>accelName is prefixed with "!", then it is required: return -1
* if it can't be loaded. Otherwise return 0.
*
* If <b>accelDir</b> is not NULL, it is the path from which the engine should
* be loaded. */
static int
crypto_openssl_init_engines(const char *accelName,
const char *accelDir)
{
@@ -284,6 +290,12 @@ crypto_openssl_init_engines(const char *accelName,
(void)accelName;
(void)accelDir;
log_warn(LD_CRYPTO, "No OpenSSL hardware acceleration support enabled.");
if (accelName && accelName[0] == '!') {
log_warn(LD_CRYPTO, "Unable to load required dynamic OpenSSL engine "
"\"%s\".", accelName+1);
return -1;
}
return 0;
#else
ENGINE *e = NULL;
@@ -292,6 +304,9 @@ crypto_openssl_init_engines(const char *accelName,
ENGINE_register_all_complete();
if (accelName) {
const bool required = accelName[0] == '!';
if (required)
++accelName;
if (accelDir) {
log_info(LD_CRYPTO, "Trying to load dynamic OpenSSL engine \"%s\""
" via path \"%s\".", accelName, accelDir);
@@ -302,8 +317,11 @@ crypto_openssl_init_engines(const char *accelName,
e = ENGINE_by_id(accelName);
}
if (!e) {
log_warn(LD_CRYPTO, "Unable to load dynamic OpenSSL engine \"%s\".",
log_warn(LD_CRYPTO, "Unable to load %sdynamic OpenSSL engine \"%s\".",
required?"required ":"",
accelName);
if (required)
return -1;
} else {
log_info(LD_CRYPTO, "Loaded dynamic OpenSSL engine \"%s\".",
accelName);
@@ -340,6 +358,7 @@ crypto_openssl_init_engines(const char *accelName,
#ifdef NID_aes_256_gcm
log_engine("AES-256-GCM", ENGINE_get_cipher_engine(NID_aes_256_gcm));
#endif
return 0;
#endif /* defined(DISABLE_ENGINES) */
}
@@ -350,7 +369,8 @@ crypto_openssl_late_init(int useAccel, const char *accelName,
const char *accelDir)
{
if (useAccel > 0) {
crypto_openssl_init_engines(accelName, accelDir);
if (crypto_openssl_init_engines(accelName, accelDir) < 0)
return -1;
} else {
log_info(LD_CRYPTO, "NOT using OpenSSL engine support.");
}
src/lib/crypt_ops/crypto_options.inc
+19
View File
@@ -0,0 +1,19 @@
/**
* @file crypto_options.inc
* @brief Declare configuration options for the crypto_ops module.
**/
/** Holds configuration about our cryptography options. */
BEGIN_CONF_STRUCT(crypto_options_t)
/** Should we enable extra OpenSSL hardware acceleration (where available)? */
CONF_VAR(HardwareAccel, BOOL, CFLG_IMMUTABLE, "0")
/** Optional OpenSSL hardware-acceleration engine name */
CONF_VAR(AccelName, STRING, CFLG_IMMUTABLE, NULL)
/** Optional OpenSSL hardware-acceleration engine search directory. */
CONF_VAR(AccelDir, FILENAME, CFLG_IMMUTABLE, NULL)
END_CONF_STRUCT(crypto_options_t)
src/lib/crypt_ops/crypto_options_st.h
+23
View File
@@ -0,0 +1,23 @@
/* 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 crypto_options_st.h
* @brief Header for lib/crypt_ops/crypto_options_st.c
**/
#ifndef TOR_LIB_CRYPT_OPS_CRYPTO_OPTIONS_ST_H
#define TOR_LIB_CRYPT_OPS_CRYPTO_OPTIONS_ST_H
#include "lib/conf/confdecl.h"
#define CONF_CONTEXT STRUCT
#include "lib/crypt_ops/crypto_options.inc"
#undef CONF_CONTEXT
typedef struct crypto_options_t crypto_options_t;
#endif /* !defined(TOR_LIB_CRYPT_OPS_CRYPTO_OPTIONS_ST_H) */
src/lib/crypt_ops/include.am
+2
View File
@@ -68,6 +68,8 @@ noinst_HEADERS += \
src/lib/crypt_ops/crypto_nss_mgt.h \
src/lib/crypt_ops/crypto_openssl_mgt.h \
src/lib/crypt_ops/crypto_ope.h \
src/lib/crypt_ops/crypto_options.inc \
src/lib/crypt_ops/crypto_options_st.h \
src/lib/crypt_ops/crypto_pwbox.h \
src/lib/crypt_ops/crypto_rand.h \
src/lib/crypt_ops/crypto_rsa.h \
src/lib/subsys/subsys.h
+42
View File
@@ -14,6 +14,7 @@
#include <stdbool.h>
struct pubsub_connector_t;
struct config_format_t;
/**
* A subsystem is a part of Tor that is initialized, shut down, configured,
@@ -88,6 +89,47 @@ typedef struct subsys_fns_t {
**/
void (*shutdown)(void);
/**
* A config_format_t describing all of the torrc fields owned by this
* subsystem.
**/
const struct config_format_t *options_format;
/**
* A config_format_t describing all of the DataDir/state fields owned by
* this subsystem.
**/
const struct config_format_t *state_format;
/**
* Receive an options object as defined by options_format. Return 0
* on success, -1 on failure.
*
* It is safe to store the pointer to the object until set_options()
* is called again. */
int (*set_options)(void *);
/* XXXX Add an implementation for options_act_reversible() later in this
* branch. */
/**
* Receive a state object as defined by state_format. Return 0 on success,
* -1 on failure.
*
* It is safe to store the pointer to the object; set_state() is only
* called on startup.
**/
int (*set_state)(void *);
/**
* Update any information that needs to be stored in the provided state
* object (as defined by state_format). Return 0 on success, -1 on failure.
*
* The object provided here will be the same one as provided earlier to
* set_state(). This method is called when we are about to save the state
* to disk.
**/
int (*flush_state)(void *);
} subsys_fns_t;
/**
src/test/conf_examples/crypto_accel/expected
+2
View File
@@ -0,0 +1,2 @@
AccelName nonexistent_chartreuse_accelerator
HardwareAccel 1
src/test/conf_examples/crypto_accel/torrc
+3
View File
@@ -0,0 +1,3 @@
AccelName nonexistent_chartreuse_accelerator
HardwareAccel 1
src/test/conf_examples/crypto_accel_req/error
+1
View File
@@ -0,0 +1 @@
Unable to load required dynamic OpenSSL engine "nonexistent_chartreuse_accelerator"
src/test/conf_examples/crypto_accel_req/expected_nss
+2
View File
@@ -0,0 +1,2 @@
AccelName !nonexistent_chartreuse_accelerator
HardwareAccel 1
src/test/conf_examples/crypto_accel_req/torrc
+3
View File
@@ -0,0 +1,3 @@
AccelName !nonexistent_chartreuse_accelerator
HardwareAccel 1
src/test/test_confmgr.c
+1 -2
View File
@@ -193,6 +193,7 @@ static const config_format_t pasture_fmt = {
offsetof(pasture_cfg_t, magic)
},
.vars = pasture_vars,
.has_config_suite = true,
.config_suite_offset = offsetof(pasture_cfg_t, subobjs),
.legacy_validate_fn = legacy_validate_pasture,
};
@@ -205,7 +206,6 @@ static const config_format_t llama_fmt = {
offsetof(llama_cfg_t, magic)
},
.vars = llama_vars,
.config_suite_offset = -1,
.deprecations = llama_deprecations,
.abbrevs = llama_abbrevs,
.clear_fn = clear_llama_cfg,
@@ -221,7 +221,6 @@ static const config_format_t alpaca_fmt = {
offsetof(alpaca_cfg_t, magic)
},
.vars = alpaca_vars,
.config_suite_offset = -1,
.deprecations = alpaca_deprecations,
.pre_normalize_fn = pre_normalize_alpaca,
.check_transition_fn = check_transition_alpaca,
src/test/test_confparse.c
-2
View File
@@ -129,7 +129,6 @@ static const config_format_t test_fmt = {
.deprecations = test_deprecation_notes,
.vars = test_vars,
.legacy_validate_fn = test_validate_cb,
.config_suite_offset = -1,
};
/* Make sure that config_init sets everything to the right defaults. */
@@ -824,7 +823,6 @@ static config_format_t etest_fmt = {
.vars = test_vars,
.legacy_validate_fn = test_validate_cb,
.extra = &extra,
.config_suite_offset = -1,
};
/* Try out the feature where we can store unrecognized lines and dump them
src/test/test_mainloop.c
+16 -4
View File
@@ -13,9 +13,13 @@
#include "test/test.h"
#include "test/log_test_helpers.h"
#include "lib/confmgt/confmgt.h"
#include "core/or/or.h"
#include "core/mainloop/connection.h"
#include "core/mainloop/mainloop.h"
#include "core/mainloop/mainloop_state_st.h"
#include "core/mainloop/mainloop_sys.h"
#include "core/mainloop/netstatus.h"
#include "feature/hs/hs_service.h"
@@ -24,6 +28,8 @@
#include "app/config/statefile.h"
#include "app/config/or_state_st.h"
#include "app/main/subsysmgr.h"
static const uint64_t BILLION = 1000000000;
static void
@@ -287,7 +293,13 @@ static void
test_mainloop_dormant_load_state(void *arg)
{
(void)arg;
or_state_t *state = or_state_new();
or_state_t *or_state = or_state_new();
mainloop_state_t *state;
{
int idx = subsystems_get_state_idx(&sys_mainloop);
tor_assert(idx >= 0);
state = config_mgr_get_obj_mutable(get_state_mgr(), or_state, idx);
}
const time_t start = 1543956575;
reset_user_activity(0);
@@ -326,14 +338,14 @@ test_mainloop_dormant_load_state(void *arg)
tt_i64_op(get_last_user_activity_time(), OP_EQ, start);
done:
or_state_free(state);
or_state_free(or_state);
}
static void
test_mainloop_dormant_save_state(void *arg)
{
(void)arg;
or_state_t *state = or_state_new();
mainloop_state_t *state = tor_malloc_zero(sizeof(mainloop_state_t));
const time_t start = 1543956575;
// Can we save a non-dormant state correctly?
@@ -352,7 +364,7 @@ test_mainloop_dormant_save_state(void *arg)
tt_int_op(state->MinutesSinceUserActivity, OP_EQ, 0);
done:
or_state_free(state);
tor_free(state);
}
#define MAINLOOP_TEST(name) \
src/test/test_options.c
+14 -3
View File
@@ -17,8 +17,11 @@
#define ROUTERSET_PRIVATE
#include "feature/nodelist/routerset.h"
#include "core/mainloop/mainloop.h"
#include "app/main/subsysmgr.h"
#include "test/log_test_helpers.h"
#include "test/resolve_test_helpers.h"
#include "lib/crypt_ops/crypto_options_st.h"
#include "lib/crypt_ops/crypto_sys.h"
#include "lib/sandbox/sandbox.h"
#include "lib/memarea/memarea.h"
@@ -3985,6 +3988,14 @@ test_options_validate__testing_options(void *ignored)
tor_free(msg);
}
static crypto_options_t *
get_crypto_options(or_options_t *opt)
{
int idx = subsystems_get_options_idx(&sys_crypto);
tor_assert(idx >= 0);
return config_mgr_get_obj_mutable(get_options_mgr(), opt, idx);
}
static void
test_options_validate__accel(void *ignored)
{
@@ -3997,15 +4008,15 @@ test_options_validate__accel(void *ignored)
tdata = get_options_test_data("AccelName foo\n");
ret = options_validate(NULL, tdata->opt, &msg);
tt_int_op(ret, OP_EQ, 0);
tt_int_op(tdata->opt->HardwareAccel, OP_EQ, 1);
tt_int_op(get_crypto_options(tdata->opt)->HardwareAccel, OP_EQ, 0);
tor_free(msg);
free_options_test_data(tdata);
tdata = get_options_test_data("AccelName foo\n");
tdata->opt->HardwareAccel = 2;
get_crypto_options(tdata->opt)->HardwareAccel = 2;
ret = options_validate(NULL, tdata->opt, &msg);
tt_int_op(ret, OP_EQ, 0);
tt_int_op(tdata->opt->HardwareAccel, OP_EQ, 2);
tt_int_op(get_crypto_options(tdata->opt)->HardwareAccel, OP_EQ, 2);
tor_free(msg);
free_options_test_data(tdata);