From 13c235484ae52b1fbe603a8be1cefd5cf5e50135 Mon Sep 17 00:00:00 2001 From: Drew DeVault Date: Fri, 22 Mar 2024 13:44:30 +0100 Subject: [PATCH] TLS.md: Redis => Redict Not sure how I missed this yesterday. Signed-off-by: Drew DeVault --- TLS.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/TLS.md b/TLS.md index b9bce7edc..84fe44910 100644 --- a/TLS.md +++ b/TLS.md @@ -9,58 +9,58 @@ Getting Started To build with TLS support you'll need OpenSSL development libraries (e.g. libssl-dev on Debian/Ubuntu). -To build TLS support as Redis built-in: +To build TLS support as Redict built-in: Run `make BUILD_TLS=yes`. -Or to build TLS as Redis module: +Or to build TLS as Redict module: Run `make BUILD_TLS=module`. Note that sentinel mode does not support TLS module. ### Tests -To run Redis test suite with TLS, you'll need TLS support for TCL (i.e. +To run Redict test suite with TLS, you'll need TLS support for TCL (i.e. `tcl-tls` package on Debian/Ubuntu). 1. Run `./utils/gen-test-certs.sh` to generate a root CA and a server certificate. -2. Run `./runtest --tls` or `./runtest-cluster --tls` to run Redis and Redis +2. Run `./runtest --tls` or `./runtest-cluster --tls` to run Redict and Redict Cluster tests in TLS mode. 3. Run `./runtest --tls-module` or `./runtest-cluster --tls-module` to - run Redis and Redis cluster tests in TLS mode with Redis module. + run Redict and Redict cluster tests in TLS mode with Redict module. ### Running manually -To manually run a Redis server with TLS mode (assuming `gen-test-certs.sh` was +To manually run a Redict server with TLS mode (assuming `gen-test-certs.sh` was invoked so sample certificates/keys are available): For TLS built-in mode: - ./src/redis-server --tls-port 6379 --port 0 \ - --tls-cert-file ./tests/tls/redis.crt \ - --tls-key-file ./tests/tls/redis.key \ + ./src/redict-server --tls-port 6379 --port 0 \ + --tls-cert-file ./tests/tls/redict.crt \ + --tls-key-file ./tests/tls/redict.key \ --tls-ca-cert-file ./tests/tls/ca.crt For TLS module mode: - ./src/redis-server --tls-port 6379 --port 0 \ - --tls-cert-file ./tests/tls/redis.crt \ - --tls-key-file ./tests/tls/redis.key \ + ./src/redict-server --tls-port 6379 --port 0 \ + --tls-cert-file ./tests/tls/redict.crt \ + --tls-key-file ./tests/tls/redict.key \ --tls-ca-cert-file ./tests/tls/ca.crt \ - --loadmodule src/redis-tls.so + --loadmodule src/redict-tls.so -To connect to this Redis server with `redis-cli`: +To connect to this Redict server with `redict-cli`: - ./src/redis-cli --tls \ - --cert ./tests/tls/redis.crt \ - --key ./tests/tls/redis.key \ + ./src/redict-cli --tls \ + --cert ./tests/tls/redict.crt \ + --key ./tests/tls/redict.key \ --cacert ./tests/tls/ca.crt This will disable TCP and enable TLS on port 6379. It's also possible to have both TCP and TLS available, but you'll need to assign different ports. To make a Replica connect to the master using TLS, use `--tls-replication yes`, -and to make Redis Cluster use TLS across nodes use `--tls-cluster yes`. +and to make Redict Cluster use TLS across nodes use `--tls-cluster yes`. Connections ----------- @@ -85,18 +85,18 @@ but there are probably other good reasons to improve that part anyway. To-Do List ---------- -- [ ] redis-benchmark support. The current implementation is a mix of using +- [ ] redict-benchmark support. The current implementation is a mix of using hiredis for parsing and basic networking (establishing connections), but directly manipulating sockets for most actions. This will need to be cleaned up for proper TLS support. The best approach is probably to migrate to hiredis async mode. -- [ ] redis-cli `--slave` and `--rdb` support. +- [ ] redict-cli `--slave` and `--rdb` support. Multi-port ---------- Consider the implications of allowing TLS to be configured on a separate port, -making Redis listening on multiple ports: +making Redict listening on multiple ports: 1. Startup banner port notification 2. Proctitle