shogo82148 / Redis-Fast

fast perl binding for Redis database
https://metacpan.org/release/Redis-Fast
Other
25 stars 21 forks source link

Add SSL/TLS support #150

Closed thomas-netcraft closed 7 months ago

thomas-netcraft commented 7 months ago

Summary

Add SSL support the Redis::Fast client.

hireds already supports SSL so it is just a matter of pulling that support through to the Perl bindings. In order to facilitate unit testing, we also add support for various SSL verification modes. Interface consistency with Perl's standard Redis client is maintained.

Resolves https://github.com/shogo82148/Redis-Fast/issues/143

Unit testing

Changes to unit tests were heavily inspired by https://github.com/PerlRedis/perl-redis/pull/129

Connecting to a local Redis server over an encrypted connection is done by instantiating stunnel with dummy certificates.

Setting the environment variable USE_SSL to a truthy value causes all unit tests which support SSL to be carried out with an encrypted connection.

Benchmarking

To get a rough idea of the performance impact, the benchmarking script was run against an AWS ElastiCache instance, using both the Redis and Redis::Fast clients with & without SSL enabled.

image

Intentionally unsupported features

Summary by CodeRabbit

coderabbitai[bot] commented 7 months ago

Walkthrough

This update introduces TLS support to a Redis client library, enhancing security by enabling encrypted connections. It includes adding SSL configuration options, ensuring SSL connections are handled correctly, and disabling SSL for sentinel connections due to compatibility concerns. The changes span across initialization, connection handling, and testing, demonstrating a comprehensive effort to integrate SSL support while maintaining functionality.

Changes

Files Changes
builder/MyBuilder.pm, src/Redis__Fast.xs, lib/Redis/Fast.pm, lib/Redis/Fast/Sentinel.pm Added SSL support, including configuration options and connection handling. Disabled SSL for sentinels.
t/*.t Enhanced tests to support SSL, including initialization with SSL parameters, and added cleanup logic.
t/tlib/Test/SpawnRedisServer.pm Implemented SSL/TLS mode handling and stunnel setup for Redis server in testing environment.

Assessment against linked issues

Objective Addressed Explanation
Add support for TLS (#143)

Poem

In the land of code where the bits do hop, Came a change, a leap, with a bouncy plop. 🐇 With whiskers twitching, eyes aglow, Secure connections, now they flow. Through tunnels of SSL, so sleek and fast, Our rabbit ensures your data's cast. In a burrow so deep, where secrets keep, 🥕 Rest easy, dear user, your connections leap.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips ### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.