forked from metal3-io/cluster-api-provider-metal3
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request metal3-io#1041 from Nordix/jawad/capm3-tls-configu…
…ration-flags ✨ Add TLS configuration flags for CAPM3
- Loading branch information
Showing
2 changed files
with
227 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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 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,111 @@ | ||
| /* | ||
| Copyright 2023 The Metal3 Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "testing" | ||
|
|
||
| . "github.com/onsi/gomega" | ||
| "k8s.io/klog/v2" | ||
| ctrl "sigs.k8s.io/controller-runtime" | ||
| ) | ||
|
|
||
| func TestTLSInsecureCiperSuite(t *testing.T) { | ||
| t.Run("test insecure cipher suite passed as TLS flag", func(t *testing.T) { | ||
| g := NewWithT(t) | ||
| tlsMockOptions := TLSOptions{ | ||
| TLSMaxVersion: "TLS13", | ||
| TLSMinVersion: "TLS12", | ||
| TLSCipherSuites: "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", | ||
| } | ||
| ctrl.Log.WithName("setup") | ||
| ctrl.SetLogger(klog.Background()) | ||
|
|
||
| bufWriter := bytes.NewBuffer(nil) | ||
| klog.SetOutput(bufWriter) | ||
| klog.LogToStderr(false) // this is important, because klog by default logs to stderr only | ||
| _, err := GetTLSOptionOverrideFuncs(tlsMockOptions) | ||
| g.Expect(err).Should(BeNil()) | ||
| g.Expect(bufWriter.String()).Should(ContainSubstring("use of insecure cipher 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' detected.")) | ||
| }) | ||
| } | ||
|
|
||
| func TestTLSMinAndMaxVersion(t *testing.T) { | ||
| t.Run("should fail if TLS min version is greater than max version.", func(t *testing.T) { | ||
| g := NewWithT(t) | ||
| tlsMockOptions := TLSOptions{ | ||
| TLSMaxVersion: "TLS12", | ||
| TLSMinVersion: "TLS13", | ||
| } | ||
| _, err := GetTLSOptionOverrideFuncs(tlsMockOptions) | ||
| g.Expect(err.Error()).To(Equal("TLS version flag min version (TLS13) is greater than max version (TLS12)")) | ||
| }) | ||
| } | ||
|
|
||
| func Test13CipherSuite(t *testing.T) { | ||
| t.Run("should reset ciphersuite flag if TLS min and max version are set to 1.3", func(t *testing.T) { | ||
| g := NewWithT(t) | ||
|
|
||
| // Here TLS_RSA_WITH_AES_128_CBC_SHA is a tls12 cipher suite. | ||
| tlsMockOptions := TLSOptions{ | ||
| TLSMaxVersion: "TLS13", | ||
| TLSMinVersion: "TLS13", | ||
| TLSCipherSuites: "TLS_RSA_WITH_AES_128_CBC_SHA,TLS_AES_256_GCM_SHA384", | ||
| } | ||
|
|
||
| ctrl.Log.WithName("setup") | ||
| ctrl.SetLogger(klog.Background()) | ||
|
|
||
| bufWriter := bytes.NewBuffer(nil) | ||
| klog.SetOutput(bufWriter) | ||
| klog.LogToStderr(false) // this is important, because klog by default logs to stderr only | ||
| _, err := GetTLSOptionOverrideFuncs(tlsMockOptions) | ||
| g.Expect(bufWriter.String()).Should(ContainSubstring("warning: Cipher suites should not be set for TLS version 1.3. Ignoring ciphers")) | ||
| g.Expect(err).Should(BeNil()) | ||
| }) | ||
| } | ||
|
|
||
| func TestGetTLSVersion(t *testing.T) { | ||
| t.Run("should error out when incorrect tls version passed", func(t *testing.T) { | ||
| g := NewWithT(t) | ||
| tlsVersion := "TLS11" | ||
| _, err := GetTLSVersion(tlsVersion) | ||
| g.Expect(err.Error()).Should(Equal("unexpected TLS version \"TLS11\" (must be one of: TLS12, TLS13)")) | ||
| }) | ||
| t.Run("should pass and output correct tls version", func(t *testing.T) { | ||
| const VersionTLS12 uint16 = 771 | ||
| g := NewWithT(t) | ||
| tlsVersion := "TLS12" | ||
| version, err := GetTLSVersion(tlsVersion) | ||
| g.Expect(version).To(Equal(VersionTLS12)) | ||
| g.Expect(err).Should(BeNil()) | ||
| }) | ||
| } | ||
|
|
||
| func TestTLSOptions(t *testing.T) { | ||
| t.Run("should pass with all the correct options below with no error.", func(t *testing.T) { | ||
| g := NewWithT(t) | ||
| tlsMockOptions := TLSOptions{ | ||
| TLSMinVersion: "TLS12", | ||
| TLSMaxVersion: "TLS13", | ||
| TLSCipherSuites: "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", | ||
| } | ||
| _, err := GetTLSOptionOverrideFuncs(tlsMockOptions) | ||
| g.Expect(err).Should(BeNil()) | ||
| }) | ||
| } |