feat(vm): validate cloud-init userdata #1937
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| /* | ||
| Copyright 2026 Flant JSC | ||
|
|
||
| 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 service | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
|
|
||
| corev1 "k8s.io/api/core/v1" | ||
| k8serrors "k8s.io/apimachinery/pkg/api/errors" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
|
|
||
| "github.com/deckhouse/virtualization/api/core/v1alpha2" | ||
| ) | ||
|
|
||
| const cloudInitUserMaxLen = 2048 | ||
|
|
||
| var ( | ||
| ErrUserDataEmpty = errors.New("provisioning userdata is defined, but it is empty") | ||
| ErrUserDataTooLong = fmt.Errorf("userdata exceeds %d byte limit; should use userDataRef for larger data", cloudInitUserMaxLen) | ||
| ) | ||
|
|
||
| type ProvisioningService struct { | ||
| reader client.Reader | ||
| } | ||
|
|
||
| func NewProvisioningService(reader client.Reader) *ProvisioningService { | ||
| return &ProvisioningService{ | ||
| reader: reader, | ||
| } | ||
| } | ||
|
|
||
| var ErrSecretIsNotValid = errors.New("secret is not valid") | ||
|
|
||
| type SecretNotFoundError string | ||
|
|
||
| func (e SecretNotFoundError) Error() string { | ||
| return fmt.Sprintf("secret %s not found", string(e)) | ||
| } | ||
|
|
||
| type UnexpectedSecretTypeError string | ||
|
|
||
| func (e UnexpectedSecretTypeError) Error() string { | ||
| return fmt.Sprintf("unexpected secret type: %s", string(e)) | ||
| } | ||
|
|
||
| var cloudInitCheckKeys = []string{ | ||
| "userdata", | ||
| "userData", | ||
| } | ||
|
|
||
| func (p *ProvisioningService) Validate(ctx context.Context, key types.NamespacedName) error { | ||
| secret := &corev1.Secret{} | ||
| err := p.reader.Get(ctx, key, secret) | ||
| if err != nil { | ||
| if k8serrors.IsNotFound(err) { | ||
| return SecretNotFoundError(key.String()) | ||
|
Contributor
There was a problem hiding this comment. Overengineering. The error looks cool, but you’re not using its advantages. You’re just putting it into a condition afterward. Just return a simple fmt.Errorf Keep It Simple |
||
| } | ||
| return err | ||
| } | ||
| switch secret.Type { | ||
| case v1alpha2.SecretTypeCloudInit: | ||
| return p.validateCloudInitSecret(secret) | ||
| case v1alpha2.SecretTypeSysprep: | ||
| return p.validateSysprepSecret(secret) | ||
| default: | ||
| return UnexpectedSecretTypeError(secret.Type) | ||
| } | ||
| } | ||
|
|
||
| func (p *ProvisioningService) validateCloudInitSecret(secret *corev1.Secret) error { | ||
| if !p.hasOneOfKeys(secret, cloudInitCheckKeys...) { | ||
| return fmt.Errorf("the secret should have one of data fields %v: %w", cloudInitCheckKeys, ErrSecretIsNotValid) | ||
|
Contributor
There was a problem hiding this comment. "the specified provisioning secret %q must have at least one of the following fields: %v: %w" |
||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (p *ProvisioningService) validateSysprepSecret(_ *corev1.Secret) error { | ||
|
Contributor
There was a problem hiding this comment. Overengineering. Code that does nothing. Remove everything unnecessary Keep It Simple |
||
| return nil | ||
| } | ||
|
|
||
| func (p *ProvisioningService) hasOneOfKeys(secret *corev1.Secret, checkKeys ...string) bool { | ||
| validate := len(checkKeys) == 0 | ||
| for _, key := range checkKeys { | ||
| if _, ok := secret.Data[key]; ok { | ||
| validate = true | ||
|
Contributor
There was a problem hiding this comment. The variable is named incorrectly, and you can actually get rid of it Keep It Simple |
||
| break | ||
| } | ||
| } | ||
| return validate | ||
| } | ||
|
|
||
| func (p *ProvisioningService) ValidateUserDataLen(userData string) error { | ||
| if userData == "" { | ||
|
|
||
| return ErrUserDataEmpty | ||
| } | ||
|
|
||
| if len(userData) > cloudInitUserMaxLen { | ||
| return ErrUserDataTooLong | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
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,57 @@ | ||
| /* | ||
| Copyright 2026 Flant JSC | ||
|
|
||
| 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 service | ||
|
|
||
| import ( | ||
| . "github.com/onsi/ginkgo/v2" | ||
| . "github.com/onsi/gomega" | ||
| ) | ||
|
|
||
| var _ = Describe("ProvisioningService", func() { | ||
| var provisioningService *ProvisioningService | ||
|
|
||
| BeforeEach(func() { | ||
| provisioningService = NewProvisioningService(nil) | ||
| }) | ||
|
|
||
| DescribeTable("ValidateUserDataLen", | ||
| func(userData string, expectedErr error) { | ||
| err := provisioningService.ValidateUserDataLen(userData) | ||
| if expectedErr != nil { | ||
| Expect(err).To(HaveOccurred()) | ||
| Expect(err).To(MatchError(expectedErr)) | ||
| } else { | ||
| Expect(err).ToNot(HaveOccurred()) | ||
| } | ||
| }, | ||
| Entry( | ||
| "empty userdata", | ||
| "", | ||
| ErrUserDataEmpty, | ||
| ), | ||
| Entry( | ||
| "userdata exceeds max limit", | ||
| string(make([]byte, cloudInitUserMaxLen+1)), | ||
| ErrUserDataTooLong, | ||
| ), | ||
| Entry( | ||
| "userdata is within limit", | ||
| string(make([]byte, cloudInitUserMaxLen-1)), | ||
| nil, | ||
| ), | ||
| ) | ||
| }) |
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,62 @@ | ||
| /* | ||
| Copyright 2026 Flant JSC | ||
|
|
||
| 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 validators | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "sigs.k8s.io/controller-runtime/pkg/webhook/admission" | ||
|
|
||
| "github.com/deckhouse/virtualization-controller/pkg/controller/service" | ||
| "github.com/deckhouse/virtualization/api/core/v1alpha2" | ||
| ) | ||
|
|
||
| type ProvisioningValidator struct { | ||
| provisioningService *service.ProvisioningService | ||
| } | ||
|
|
||
| func NewProvisioningValidator(provisioningService *service.ProvisioningService) *ProvisioningValidator { | ||
|
Contributor
There was a problem hiding this comment. It looks like you can use CEL rules instead |
||
| return &ProvisioningValidator{provisioningService: provisioningService} | ||
| } | ||
|
|
||
| func (p *ProvisioningValidator) ValidateCreate(_ context.Context, vm *v1alpha2.VirtualMachine) (admission.Warnings, error) { | ||
| err := p.validateUserDataLen(vm) | ||
| if err != nil { | ||
| return admission.Warnings{}, err | ||
| } | ||
|
|
||
| return nil, nil | ||
| } | ||
|
|
||
| func (p *ProvisioningValidator) ValidateUpdate(_ context.Context, _, newVM *v1alpha2.VirtualMachine) (admission.Warnings, error) { | ||
| err := p.validateUserDataLen(newVM) | ||
| if err != nil { | ||
| return admission.Warnings{}, err | ||
| } | ||
|
|
||
| return nil, nil | ||
| } | ||
|
|
||
| func (p *ProvisioningValidator) validateUserDataLen(vm *v1alpha2.VirtualMachine) error { | ||
| if vm.Spec.Provisioning != nil && vm.Spec.Provisioning.Type == v1alpha2.ProvisioningTypeUserData { | ||
| err := p.provisioningService.ValidateUserDataLen(vm.Spec.Provisioning.UserData) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return 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.
Why is this here and not inside the vm directory?