diff --git a/go.mod b/go.mod index 86c568b70..dc1fea13e 100644 --- a/go.mod +++ b/go.mod @@ -34,6 +34,7 @@ require ( kubevirt.io/controller-lifecycle-operator-sdk/api v0.2.4 kubevirt.io/qe-tools v0.1.8 kubevirt.io/ssp-operator/api v0.0.0 + kubevirt.io/vm-console-proxy/api v0.7.0 sigs.k8s.io/controller-runtime v0.18.5 sigs.k8s.io/yaml v1.4.0 ) diff --git a/go.sum b/go.sum index 44bdbe371..61924d6af 100644 --- a/go.sum +++ b/go.sum @@ -843,6 +843,8 @@ kubevirt.io/controller-lifecycle-operator-sdk/api v0.2.4 h1:fZYvD3/Vnitfkx6IJxjL kubevirt.io/controller-lifecycle-operator-sdk/api v0.2.4/go.mod h1:018lASpFYBsYN6XwmA2TIrPCx6e0gviTd/ZNtSitKgc= kubevirt.io/qe-tools v0.1.8 h1:Ar7qicmzHdd+Ia+6rjHDg3D7GReIyq7QFXoC4F7TjhQ= kubevirt.io/qe-tools v0.1.8/go.mod h1:+Tr/WZGHIDQa/4pQgzM7+4J6YeVbUWAXESXtL2/zxqc= +kubevirt.io/vm-console-proxy/api v0.7.0 h1:yhzTtywJDqDx3ddIDhuMmN9O19EdGZS0NDqtGwEwk9c= +kubevirt.io/vm-console-proxy/api v0.7.0/go.mod h1:7q967W73c6/Iczl3xJkOjQOASAJ2wXBTEbCbiqD9bXE= rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8= rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0= rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA= diff --git a/internal/operands/vm-console-proxy/reconcile.go b/internal/operands/vm-console-proxy/reconcile.go index ff0e6f6f1..c231ca879 100644 --- a/internal/operands/vm-console-proxy/reconcile.go +++ b/internal/operands/vm-console-proxy/reconcile.go @@ -4,14 +4,18 @@ import ( "context" "fmt" + ocpv1 "github.com/openshift/api/config/v1" routev1 "github.com/openshift/api/route/v1" + "github.com/openshift/library-go/pkg/crypto" apps "k8s.io/api/apps/v1" core "k8s.io/api/core/v1" rbac "k8s.io/api/rbac/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" utilruntime "k8s.io/apimachinery/pkg/util/runtime" apiregv1 "k8s.io/kube-aggregator/pkg/apis/apiregistration/v1" + proxyv1 "kubevirt.io/vm-console-proxy/api/v1" "sigs.k8s.io/controller-runtime/pkg/client" + "sigs.k8s.io/yaml" "kubevirt.io/ssp-operator/internal/common" "kubevirt.io/ssp-operator/internal/env" @@ -302,6 +306,15 @@ func reconcileRoleBinding(roleBinding *rbac.RoleBinding) common.ReconcileFunc { func reconcileConfigMap(configMap core.ConfigMap) common.ReconcileFunc { return func(request *common.Request) (common.ReconcileResult, error) { configMap.Namespace = request.Instance.Namespace + + tlsConfigYaml, err := createTlsConfigFile(request.Instance.Spec.TLSSecurityProfile) + if err != nil { + return common.ReconcileResult{}, err + } + + const tlsConfigFilename = "tls-profile-v1.yaml" + configMap.Data[tlsConfigFilename] = tlsConfigYaml + return common.CreateOrUpdate(request). NamespacedResource(&configMap). WithAppLabels(operandName, operandComponent). @@ -354,6 +367,51 @@ func getVmConsoleProxyImage() string { return env.EnvOrDefault(env.VmConsoleProxyImageKey, defaultVmConsoleProxyImage) } +func createTlsConfigFile(tlsProfile *ocpv1.TLSSecurityProfile) (string, error) { + if tlsProfile == nil { + // Returning empty config yaml. Default configuration will be used. + return "{}", nil + } + + var profileSpec *ocpv1.TLSProfileSpec + if tlsProfile.Type == ocpv1.TLSProfileCustomType { + if tlsProfile.Custom == nil { + return "", fmt.Errorf("tlsProfile is invalid: custom filed is empty") + } + profileSpec = tlsProfile.Custom.TLSProfileSpec.DeepCopy() + } else { + predefinedProfile, found := ocpv1.TLSProfiles[tlsProfile.Type] + if !found { + return "", fmt.Errorf("tlsProfile type is invalid: %s", tlsProfile.Type) + } + profileSpec = predefinedProfile.DeepCopy() + } + + result := proxyv1.TlsProfile{} + + switch profileSpec.MinTLSVersion { + case ocpv1.VersionTLS10: + result.MinTLSVersion = proxyv1.VersionTLS10 + case ocpv1.VersionTLS11: + result.MinTLSVersion = proxyv1.VersionTLS11 + case ocpv1.VersionTLS12: + result.MinTLSVersion = proxyv1.VersionTLS12 + case ocpv1.VersionTLS13: + result.MinTLSVersion = proxyv1.VersionTLS13 + default: + return "", fmt.Errorf("unsupported TLS version: %s", profileSpec.MinTLSVersion) + } + + result.Ciphers = crypto.OpenSSLToIANACipherSuites(profileSpec.Ciphers) + + yamlBytes, err := yaml.Marshal(result) + if err != nil { + return "", fmt.Errorf("failed to marshal TLS profile cofing to yaml: %w", err) + } + + return string(yamlBytes), nil +} + func findResourcesUsingLabels[PtrL interface { *L client.ObjectList diff --git a/internal/operands/vm-console-proxy/reconcile_test.go b/internal/operands/vm-console-proxy/reconcile_test.go index 7ef5d45ad..8ccf92fea 100644 --- a/internal/operands/vm-console-proxy/reconcile_test.go +++ b/internal/operands/vm-console-proxy/reconcile_test.go @@ -9,6 +9,7 @@ import ( . "github.com/onsi/gomega" "k8s.io/apimachinery/pkg/api/errors" + ocpv1 "github.com/openshift/api/config/v1" routev1 "github.com/openshift/api/route/v1" libhandler "github.com/operator-framework/operator-lib/handler" apps "k8s.io/api/apps/v1" @@ -22,10 +23,12 @@ import ( apiregv1 "k8s.io/kube-aggregator/pkg/apis/apiregistration/v1" "k8s.io/utils/ptr" kubevirt "kubevirt.io/api/core" + proxyv1 "kubevirt.io/vm-console-proxy/api/v1" "sigs.k8s.io/controller-runtime/pkg/client" "sigs.k8s.io/controller-runtime/pkg/client/fake" logf "sigs.k8s.io/controller-runtime/pkg/log" "sigs.k8s.io/controller-runtime/pkg/reconcile" + "sigs.k8s.io/yaml" ssp "kubevirt.io/ssp-operator/api/v1beta2" "kubevirt.io/ssp-operator/internal/common" @@ -140,6 +143,30 @@ var _ = Describe("VM Console Proxy Operand", func() { To(MatchError(errors.IsNotFound, "errors.IsNotFound")) }) + It("should write TLS configuration to ConfigMap", func() { + request.Instance.Spec.TLSSecurityProfile = &ocpv1.TLSSecurityProfile{ + Type: ocpv1.TLSProfileIntermediateType, + Intermediate: &ocpv1.IntermediateTLSProfile{}, + } + + _, err := operand.Reconcile(&request) + Expect(err).ToNot(HaveOccurred()) + + configMapKey := client.ObjectKeyFromObject(bundle.ConfigMap) + + configMap := &core.ConfigMap{} + Expect(request.Client.Get(request.Context, configMapKey, configMap)).To(Succeed()) + + const tlsConfigFilename = "tls-profile-v1.yaml" + tlsConfig, exists := configMap.Data[tlsConfigFilename] + Expect(exists).To(BeTrue(), "ConfigMap should have TLS configuration file: "+tlsConfigFilename) + + proxyProfile := &proxyv1.TlsProfile{} + Expect(yaml.Unmarshal([]byte(tlsConfig), proxyProfile)).To(Succeed()) + + Expect(proxyProfile.MinTLSVersion).To(Equal(proxyv1.VersionTLS12)) + }) + It("should remove cluster resources on cleanup", func() { _, err := operand.Reconcile(&request) Expect(err).ToNot(HaveOccurred()) diff --git a/vendor/kubevirt.io/vm-console-proxy/api/LICENSE b/vendor/kubevirt.io/vm-console-proxy/api/LICENSE new file mode 100644 index 000000000..03f21251b --- /dev/null +++ b/vendor/kubevirt.io/vm-console-proxy/api/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2022 The VM Console Proxy 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. diff --git a/vendor/kubevirt.io/vm-console-proxy/api/v1/constants.go b/vendor/kubevirt.io/vm-console-proxy/api/v1/constants.go new file mode 100644 index 000000000..ab6958e06 --- /dev/null +++ b/vendor/kubevirt.io/vm-console-proxy/api/v1/constants.go @@ -0,0 +1,6 @@ +package v1 + +const ( + Group = "token.kubevirt.io" + Version = "v1" +) diff --git a/vendor/kubevirt.io/vm-console-proxy/api/v1/types.go b/vendor/kubevirt.io/vm-console-proxy/api/v1/types.go new file mode 100644 index 000000000..c5d33fae0 --- /dev/null +++ b/vendor/kubevirt.io/vm-console-proxy/api/v1/types.go @@ -0,0 +1,31 @@ +package v1 + +import ( + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" +) + +// TokenResponse is the response object from /token endpoint. +type TokenResponse struct { + Token string `json:"token"` + ExpirationTimestamp metav1.Time `json:"expirationTimestamp"` +} + +// TlsProfile is the TLS configuration for the proxy. +type TlsProfile struct { + Ciphers []string `json:"ciphers,omitempty"` + MinTLSVersion TLSProtocolVersion `json:"minTLSVersion,omitempty"` +} + +// TLSProtocolVersion is a way to specify the protocol version used for TLS connections. +type TLSProtocolVersion string + +const ( + // VersionTLS10 is version 1.0 of the TLS security protocol. + VersionTLS10 TLSProtocolVersion = "VersionTLS10" + // VersionTLS11 is version 1.1 of the TLS security protocol. + VersionTLS11 TLSProtocolVersion = "VersionTLS11" + // VersionTLS12 is version 1.2 of the TLS security protocol. + VersionTLS12 TLSProtocolVersion = "VersionTLS12" + // VersionTLS13 is version 1.3 of the TLS security protocol. + VersionTLS13 TLSProtocolVersion = "VersionTLS13" +) diff --git a/vendor/modules.txt b/vendor/modules.txt index 5c610f8cf..709b18d84 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -887,6 +887,9 @@ kubevirt.io/qe-tools/pkg/polarion-xml ## explicit; go 1.22.4 kubevirt.io/ssp-operator/api/v1beta2 kubevirt.io/ssp-operator/api/v1beta3 +# kubevirt.io/vm-console-proxy/api v0.7.0 +## explicit; go 1.22.4 +kubevirt.io/vm-console-proxy/api/v1 # sigs.k8s.io/controller-runtime v0.18.5 ## explicit; go 1.22.0 sigs.k8s.io/controller-runtime