Build TLS as a loadable module
* Support BUILD_TLS=module to be loaded as a module via config file or
command line. e.g. redis-server --loadmodule redis-tls.so
* Updates to redismodule.h to allow it to be used side by side with
server.h by defining REDISMODULE_CORE_MODULE
* Changes to server.h, redismodule.h and module.c to avoid repeated
type declarations (gcc 4.8 doesn't like these)
* Add a mechanism for non-ABI neutral modules (ones who include
server.h) to refuse loading if they detect not being built together with
redis (release.c)
* Fix wrong signature of RedisModuleDefragFunc, this could break
compilation of a module, but not the ABI
* Move initialization of listeners in server.c to be after loading
the modules
* Config TLS after initialization of listeners
* Init cluster after initialization of listeners
* Add TLS module to CI
* Fix a test suite race conditions:
Now that the listeners are initialized later, it's not sufficient to
wait for the PID message in the log, we need to wait for the "Server
Initialized" message.
* Fix issues with moduleconfigs test as a result from start_server
waiting for "Server Initialized"
* Fix issues with modules/infra test as a result of an additional module
present
Notes about Sentinel:
Sentinel can't really rely on the tls module, since it uses hiredis to
initiate connections and depends on OpenSSL (won't be able to use any
other connection modules for that), so it was decided that when TLS is
built as a module, sentinel does not support TLS at all.
This means that it keeps using redis_tls_ctx and redis_tls_client_ctx directly.
Example code of config in redis-tls.so(may be use in the future):
RedisModuleString *tls_cfg = NULL;
void tlsInfo(RedisModuleInfoCtx *ctx, int for_crash_report) {
UNUSED(for_crash_report);
RedisModule_InfoAddSection(ctx, "");
RedisModule_InfoAddFieldLongLong(ctx, "var", 42);
}
int tlsCommand(RedisModuleCtx *ctx, RedisModuleString **argv, int argc)
{
if (argc != 2) return RedisModule_WrongArity(ctx);
return RedisModule_ReplyWithString(ctx, argv[1]);
}
RedisModuleString *getStringConfigCommand(const char *name, void *privdata) {
REDISMODULE_NOT_USED(name);
REDISMODULE_NOT_USED(privdata);
return tls_cfg;
}
int setStringConfigCommand(const char *name, RedisModuleString *new, void *privdata, RedisModuleString **err) {
REDISMODULE_NOT_USED(name);
REDISMODULE_NOT_USED(err);
REDISMODULE_NOT_USED(privdata);
if (tls_cfg) RedisModule_FreeString(NULL, tls_cfg);
RedisModule_RetainString(NULL, new);
tls_cfg = new;
return REDISMODULE_OK;
}
int RedisModule_OnLoad(void *ctx, RedisModuleString **argv, int argc)
{
....
if (RedisModule_CreateCommand(ctx,"tls",tlsCommand,"",0,0,0) == REDISMODULE_ERR)
return REDISMODULE_ERR;
if (RedisModule_RegisterStringConfig(ctx, "cfg", "", REDISMODULE_CONFIG_DEFAULT, getStringConfigCommand, setStringConfigCommand, NULL, NULL) == REDISMODULE_ERR)
return REDISMODULE_ERR;
if (RedisModule_LoadConfigs(ctx) == REDISMODULE_ERR) {
if (tls_cfg) {
RedisModule_FreeString(ctx, tls_cfg);
tls_cfg = NULL;
}
return REDISMODULE_ERR;
}
...
}
Co-authored-by: zhenwei pi <pizhenwei@bytedance.com>
Signed-off-by: zhenwei pi <pizhenwei@bytedance.com>
This commit is contained in:
Oran Agra
@@ -5,18 +5,21 @@ test {modules config rewrite} {
|
||||
start_server {tags {"modules"}} {
|
||||
r module load $testmodule
|
||||
|
||||
assert_equal [lindex [lindex [r module list] 0] 1] infotest
|
||||
set modules [lmap x [r module list] {dict get $x name}]
|
||||
assert_not_equal [lsearch $modules infotest] -1
|
||||
|
||||
r config rewrite
|
||||
restart_server 0 true false
|
||||
|
||||
assert_equal [lindex [lindex [r module list] 0] 1] infotest
|
||||
set modules [lmap x [r module list] {dict get $x name}]
|
||||
assert_not_equal [lsearch $modules infotest] -1
|
||||
|
||||
assert_equal {OK} [r module unload infotest]
|
||||
|
||||
r config rewrite
|
||||
restart_server 0 true false
|
||||
|
||||
assert_equal [llength [r module list]] 0
|
||||
set modules [lmap x [r module list] {dict get $x name}]
|
||||
assert_equal [lsearch $modules infotest] -1
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,7 +5,7 @@ start_server {tags {"modules"}} {
|
||||
r module load $testmodule
|
||||
test {Config get commands work} {
|
||||
# Make sure config get module config works
|
||||
assert_equal [lindex [lindex [r module list] 0] 1] moduleconfigs
|
||||
assert_not_equal [lsearch [lmap x [r module list] {dict get $x name}] moduleconfigs] -1
|
||||
assert_equal [r config get moduleconfigs.mutable_bool] "moduleconfigs.mutable_bool yes"
|
||||
assert_equal [r config get moduleconfigs.immutable_bool] "moduleconfigs.immutable_bool no"
|
||||
assert_equal [r config get moduleconfigs.memory_numeric] "moduleconfigs.memory_numeric 1024"
|
||||
@@ -94,7 +94,7 @@ start_server {tags {"modules"}} {
|
||||
|
||||
test {test loadex functionality} {
|
||||
r module loadex $testmodule CONFIG moduleconfigs.mutable_bool no CONFIG moduleconfigs.immutable_bool yes CONFIG moduleconfigs.memory_numeric 2mb CONFIG moduleconfigs.string tclortickle
|
||||
assert_equal [lindex [lindex [r module list] 0] 1] moduleconfigs
|
||||
assert_not_equal [lsearch [lmap x [r module list] {dict get $x name}] moduleconfigs] -1
|
||||
assert_equal [r config get moduleconfigs.mutable_bool] "moduleconfigs.mutable_bool no"
|
||||
assert_equal [r config get moduleconfigs.immutable_bool] "moduleconfigs.immutable_bool yes"
|
||||
assert_equal [r config get moduleconfigs.memory_numeric] "moduleconfigs.memory_numeric 2097152"
|
||||
@@ -157,7 +157,7 @@ start_server {tags {"modules"}} {
|
||||
test {test config rewrite with dynamic load} {
|
||||
#translates to: super \0secret password
|
||||
r module loadex $testmodule CONFIG moduleconfigs.string \x73\x75\x70\x65\x72\x20\x00\x73\x65\x63\x72\x65\x74\x20\x70\x61\x73\x73\x77\x6f\x72\x64 ARGS
|
||||
assert_equal [lindex [lindex [r module list] 0] 1] moduleconfigs
|
||||
assert_not_equal [lsearch [lmap x [r module list] {dict get $x name}] moduleconfigs] -1
|
||||
assert_equal [r config get moduleconfigs.string] "moduleconfigs.string {super \0secret password}"
|
||||
r config set moduleconfigs.mutable_bool yes
|
||||
r config set moduleconfigs.memory_numeric 750
|
||||
@@ -207,7 +207,7 @@ start_server {tags {"modules"}} {
|
||||
test {test 1.module load 2.config rewrite 3.module unload 4.config rewrite works} {
|
||||
# Configs need to be removed from the old config file in this case.
|
||||
r module loadex $testmodule CONFIG moduleconfigs.memory_numeric 500 ARGS
|
||||
assert_equal [lindex [lindex [r module list] 0] 1] moduleconfigs
|
||||
assert_not_equal [lsearch [lmap x [r module list] {dict get $x name}] moduleconfigs] -1
|
||||
r config rewrite
|
||||
r module unload moduleconfigs
|
||||
r config rewrite
|
||||
@@ -217,34 +217,18 @@ start_server {tags {"modules"}} {
|
||||
}
|
||||
test {startup moduleconfigs} {
|
||||
# No loadmodule directive
|
||||
set nomodload [start_server [list overrides [list moduleconfigs.string "hello"]]]
|
||||
wait_for_condition 100 50 {
|
||||
! [is_alive $nomodload]
|
||||
} else {
|
||||
fail "startup should've failed with no load and module configs supplied"
|
||||
}
|
||||
set stdout [dict get $nomodload stdout]
|
||||
assert_equal [count_message_lines $stdout "Module Configuration detected without loadmodule directive or no ApplyConfig call: aborting"] 1
|
||||
catch {exec src/redis-server --moduleconfigs.string "hello"} err
|
||||
assert_match {*Module Configuration detected without loadmodule directive or no ApplyConfig call: aborting*} $err
|
||||
|
||||
# Bad config value
|
||||
set badconfig [start_server [list overrides [list loadmodule "$testmodule" moduleconfigs.string "rejectisfreed"]]]
|
||||
wait_for_condition 100 50 {
|
||||
! [is_alive $badconfig]
|
||||
} else {
|
||||
fail "startup with bad moduleconfigs should've failed"
|
||||
}
|
||||
set stdout [dict get $badconfig stdout]
|
||||
assert_equal [count_message_lines $stdout "Issue during loading of configuration moduleconfigs.string : Cannot set string to 'rejectisfreed'"] 1
|
||||
catch {exec src/redis-server --loadmodule "$testmodule" --moduleconfigs.string "rejectisfreed"} err
|
||||
assert_match {*Issue during loading of configuration moduleconfigs.string : Cannot set string to 'rejectisfreed'*} $err
|
||||
|
||||
set noload [start_server [list overrides [list loadmodule "$testmodule noload" moduleconfigs.string "hello"]]]
|
||||
wait_for_condition 100 50 {
|
||||
! [is_alive $noload]
|
||||
} else {
|
||||
fail "startup with moduleconfigs and no loadconfigs call should've failed"
|
||||
}
|
||||
set stdout [dict get $noload stdout]
|
||||
assert_equal [count_message_lines $stdout "Module Configurations were not set, likely a missing LoadConfigs call. Unloading the module."] 1
|
||||
# missing LoadConfigs call
|
||||
catch {exec src/redis-server --loadmodule "$testmodule" noload --moduleconfigs.string "hello"} err
|
||||
assert_match {*Module Configurations were not set, likely a missing LoadConfigs call. Unloading the module.*} $err
|
||||
|
||||
# successful
|
||||
start_server [list overrides [list loadmodule "$testmodule" moduleconfigs.string "bootedup" moduleconfigs.enum two moduleconfigs.flags "two four"]] {
|
||||
assert_equal [r config get moduleconfigs.string] "moduleconfigs.string bootedup"
|
||||
assert_equal [r config get moduleconfigs.mutable_bool] "moduleconfigs.mutable_bool yes"
|
||||
|
||||
Reference in New Issue
Block a user