-
-
Notifications
You must be signed in to change notification settings - Fork 586
feat(valkey): add TLS support for Valkey #3131
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| package valkey | ||
|
|
||
| import ( | ||
| "crypto/tls" | ||
| "fmt" | ||
| "net" | ||
|
|
||
| "github.com/mdelapenya/tlscert" | ||
|
|
||
| "github.com/testcontainers/testcontainers-go" | ||
| ) | ||
|
|
||
| type options struct { | ||
| tlsEnabled bool | ||
| tlsConfig *tls.Config | ||
| } | ||
|
|
||
| // Compiler check to ensure that Option implements the testcontainers.ContainerCustomizer interface. | ||
| var _ testcontainers.ContainerCustomizer = (Option)(nil) | ||
|
|
||
| // Option is an option for the Redpanda container. | ||
| type Option func(*options) error | ||
|
|
||
| // Customize is a NOOP. It's defined to satisfy the testcontainers.ContainerCustomizer interface. | ||
| func (o Option) Customize(*testcontainers.GenericContainerRequest) error { | ||
| // NOOP to satisfy interface. | ||
| return nil | ||
| } | ||
|
|
||
| // WithTLS sets the TLS configuration for the redis container, setting | ||
| // the 6380/tcp port to listen on for TLS connections and using a secure URL (rediss://). | ||
| func WithTLS() Option { | ||
| return func(o *options) error { | ||
| o.tlsEnabled = true | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| // createTLSCerts creates a CA certificate, a client certificate and a Valkey certificate. | ||
| func createTLSCerts() (caCert *tlscert.Certificate, clientCert *tlscert.Certificate, valkeyCert *tlscert.Certificate, err error) { | ||
| // ips is the extra list of IPs to include in the certificates. | ||
| // It's used to allow the client and Valkey certificates to be used in the same host | ||
| // when the tests are run using a remote docker daemon. | ||
| ips := []net.IP{net.ParseIP("127.0.0.1")} | ||
|
|
||
| // Generate CA certificate | ||
| caCert, err = tlscert.SelfSignedFromRequestE(tlscert.Request{ | ||
| Host: "localhost", | ||
| IPAddresses: ips, | ||
| Name: "ca", | ||
| SubjectCommonName: "ca", | ||
| IsCA: true, | ||
| }) | ||
| if err != nil { | ||
| return nil, nil, nil, fmt.Errorf("generate CA certificate: %w", err) | ||
| } | ||
|
|
||
| // Generate client certificate | ||
| clientCert, err = tlscert.SelfSignedFromRequestE(tlscert.Request{ | ||
| Host: "localhost", | ||
| Name: "Redis Client", | ||
| SubjectCommonName: "localhost", | ||
| IPAddresses: ips, | ||
| Parent: caCert, | ||
| }) | ||
| if err != nil { | ||
| return nil, nil, nil, fmt.Errorf("generate client certificate: %w", err) | ||
| } | ||
|
|
||
| // Generate Valkey certificate | ||
| valkeyCert, err = tlscert.SelfSignedFromRequestE(tlscert.Request{ | ||
| Host: "localhost", | ||
| IPAddresses: ips, | ||
| Name: "Valkey Server", | ||
| Parent: caCert, | ||
| }) | ||
| if err != nil { | ||
| return nil, nil, nil, fmt.Errorf("generate Valkey certificate: %w", err) | ||
| } | ||
|
|
||
| return caCert, clientCert, valkeyCert, nil | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: not needed for this PR but as this is a very common pattern we should create a noop customiser we can just embed to avoid this repeating boilerplate.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense! Thanks for the suggestion!