github
/
portainer
mirror of https://github.com/portainer/portainer
1
0
Fork 0
Code Issues Releases Wiki Activity

fix(custom-templates): relax custom template validation and enforce stack name validation [EE-7102] (#11937) 

Co-authored-by: testa113 <testa113>
pull/11972/head
Ali 2024-06-17 09:24:50 +12:00 committed by GitHub
parent 5182220d0a
commit e7af3296fc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
17 changed files with 207 additions and 180 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
app/kubernetes/react/components/index.ts
View File

@ -142,7 +142,14 @@ export const ngModule = angular
),
{ stackName: 'setStackName' }
),
['setStackName', 'stackName', 'stacks', 'inputClassName', 'textTip']
[
'setStackName',
'stackName',
'stacks',
'inputClassName',
'textTip',
'error',
]
)
)
.component(

2
app/kubernetes/views/applications/create/createApplication.html
View File

@ -172,6 +172,7 @@
text-tip="'Enter or select a \'stack\' name to group multiple deployments together, or else leave empty to ignore.'"
stacks="ctrl.stacks"
input-class-name="'col-lg-10 col-sm-9'"
error="ctrl.state.stackNameError"
></kube-stack-name>
<!-- #endregion -->
@ -234,6 +235,7 @@
text-tip="'Enter or select a \'stack\' name to group multiple deployments together, or else leave empty to ignore.'"
stacks="ctrl.stacks"
input-class-name="'col-lg-10 col-sm-9'"
error="ctrl.state.stackNameError"
></kube-stack-name>
<!-- #endregion -->

16
app/kubernetes/views/applications/create/createApplicationController.js
View File

@ -28,6 +28,7 @@ import { confirmUpdateAppIngress } from '@/react/kubernetes/applications/CreateV
import { confirm, confirmUpdate, confirmWebEditorDiscard } from '@@/modals/confirm';
import { buildConfirmButton } from '@@/modals/utils';
import { ModalType } from '@@/modals';
import { KUBE_STACK_NAME_VALIDATION_REGEX } from '@/react/kubernetes/DeployView/StackName/constants';
class KubernetesCreateApplicationController {
/* #region CONSTRUCTOR */
@ -127,6 +128,7 @@ class KubernetesCreateApplicationController {
// a validation message will be shown. isExistingCPUReservationUnchanged and isExistingMemoryReservationUnchanged (with available resources being exceeded) is used to decide whether to show the message or not.
isExistingCPUReservationUnchanged: false,
isExistingMemoryReservationUnchanged: false,
stackNameError: '',
};
this.isAdmin = this.Authentication.isAdmin();
@ -186,9 +188,16 @@ class KubernetesCreateApplicationController {
}
/* #endregion */
onChangeStackName(stackName) {
onChangeStackName(name) {
return this.$async(async () => {
this.formValues.StackName = stackName;
if (KUBE_STACK_NAME_VALIDATION_REGEX.test(name) || name === '') {
this.state.stackNameError = '';
} else {
this.state.stackNameError =
"Stack must consist of alphanumeric characters, '-', '_' or '.', must start and end with an alphanumeric character and must be 63 characters or less (e.g. 'my-name', or 'abc-123').";
}
this.formValues.StackName = name;
});
}
@ -644,7 +653,8 @@ class KubernetesCreateApplicationController {
const invalid = !this.isValid();
const hasNoChanges = this.isEditAndNoChangesMade();
const nonScalable = this.isNonScalable();
return overflow || autoScalerOverflow || inProgress || invalid || hasNoChanges || nonScalable;
const stackNameInvalid = this.state.stackNameError !== '';
return overflow || autoScalerOverflow || inProgress || invalid || hasNoChanges || nonScalable || stackNameInvalid;
}
isUpdateApplicationViaWebEditorButtonDisabled() {

7
app/kubernetes/views/deploy/deploy.html
View File

@ -90,7 +90,12 @@
<div class="w-fit mb-4">
<stack-name-label-insight></stack-name-label-insight>
</div>
<kube-stack-name stack-name="ctrl.formValues.StackName" set-stack-name="(ctrl.setStackName)" stacks="ctrl.stacks"></kube-stack-name>
<kube-stack-name
stack-name="ctrl.formValues.StackName"
set-stack-name="(ctrl.setStackName)"
stacks="ctrl.stacks"
error="ctrl.state.stackNameError"
></kube-stack-name>
</div>
<!-- !namespace -->

15
app/kubernetes/views/deploy/deployController.js
View File

@ -12,6 +12,7 @@ import { parseAutoUpdateResponse, transformAutoUpdateViewModel } from '@/react/p
import { baseStackWebhookUrl, createWebhookId } from '@/portainer/helpers/webhookHelper';
import { confirmWebEditorDiscard } from '@@/modals/confirm';
import { getVariablesFieldDefaultValues } from '@/react/portainer/custom-templates/components/CustomTemplatesVariablesField';
import { KUBE_STACK_NAME_VALIDATION_REGEX } from '@/react/kubernetes/DeployView/StackName/constants';
class KubernetesDeployController {
/* @ngInject */
@ -57,6 +58,7 @@ class KubernetesDeployController {
templateLoadFailed: false,
isEditorReadOnly: false,
selectedHelmChart: '',
stackNameError: '',
};
this.currentUser = {
@ -117,7 +119,16 @@ class KubernetesDeployController {
}
setStackName(name) {
return this.$async(async () => {
if (KUBE_STACK_NAME_VALIDATION_REGEX.test(name) || name === '') {
this.state.stackNameError = '';
} else {
this.state.stackNameError =
"Stack must consist of alphanumeric characters, '-', '_' or '.', must start and end with an alphanumeric character and must be 63 characters or less (e.g. 'my-name', or 'abc-123').";
}
this.formValues.StackName = name;
});
}
renderTemplate() {
@ -197,9 +208,9 @@ class KubernetesDeployController {
const isWebEditorInvalid = this.state.BuildMethod === KubernetesDeployBuildMethods.WEB_EDITOR && _.isEmpty(this.formValues.EditorContent);
const isURLFormInvalid = this.state.BuildMethod === KubernetesDeployBuildMethods.URL && _.isEmpty(this.formValues.ManifestURL);
const isCustomTemplateInvalid = this.state.BuildMethod === KubernetesDeployBuildMethods.CUSTOM_TEMPLATE && _.isEmpty(this.formValues.EditorContent);
const isStackNameInvalid = this.state.stackNameError !== '';
const isNamespaceInvalid = _.isEmpty(this.formValues.Namespace);
return isWebEditorInvalid || isURLFormInvalid || isCustomTemplateInvalid || this.state.actionInProgress || isNamespaceInvalid;
return isWebEditorInvalid || isURLFormInvalid || isCustomTemplateInvalid || this.state.actionInProgress || isNamespaceInvalid || isStackNameInvalid;
}
onChangeFormValues(newValues) {

4
app/portainer/components/forms/stack-from-template-form/stackFromTemplateForm.html
View File

@ -1,4 +1,3 @@
<div class="col-sm-12">
<rd-widget>
<rd-widget-custom-header icon="$ctrl.template.Logo" title-text="$ctrl.template.Title"></rd-widget-custom-header>
<rd-widget-body classes="padding">
@ -16,7 +15,7 @@
<div class="form-group">
<label for="template_name" class="col-sm-2 control-label text-left">Name</label>
<div class="col-sm-6">
<input type="text" name="template_name" class="form-control" ng-model="$ctrl.formValues.name" ng-pattern="$ctrl.nameRegex" placeholder="e.g. myStack" required />
<input type="text" name="template_name" class="form-control" ng-model="$ctrl.formValues.name" ng-pattern="$ctrl.nameRegex" placeholder="e.g. mystack" required />
<div class="form-group" ng-if="stackTemplateForm.template_name.$invalid">
<div class="col-sm-12 small text-warning">
<div ng-messages="stackTemplateForm.template_name.$error">
@ -83,4 +82,3 @@
</form>
</rd-widget-body>
</rd-widget>
</div>

2
app/portainer/views/custom-templates/custom-templates-view/customTemplatesView.html
View File

@ -1,6 +1,7 @@
<page-header title="'Custom Templates'" breadcrumbs="['Custom Templates']" reload="true"> </page-header>
<div class="row">
<div class="col-sm-12">
<stack-from-template-form
ng-if="$ctrl.state.selectedTemplate"
template="$ctrl.state.selectedTemplate"
@ -62,6 +63,7 @@
</advanced-form>
</stack-from-template-form>
</div>
</div>
<custom-templates-list
templates="$ctrl.templates"

2
app/portainer/views/custom-templates/custom-templates-view/customTemplatesViewController.js
View File

@ -218,7 +218,7 @@ class CustomTemplatesViewController {
return o.Name === 'bridge';
});
this.formValues.name = template.Title ? template.Title : '';
this.formValues.name = '';
this.state.selectedTemplate = template;
this.$anchorScroll('view-top');
const applicationState = this.StateManager.getState();

3
app/portainer/views/templates/templates.html
View File

@ -2,15 +2,18 @@
<div class="row">
<!-- stack-form -->
<div class="col-sm-12">
<stack-from-template-form
ng-if="state.selectedTemplate && (state.selectedTemplate.Type === 2 || state.selectedTemplate.Type === 3)"
template="state.selectedTemplate"
form-values="formValues"
name-regex="state.templateNameRegex"
state="state"
create-template="createTemplate"
unselect-template="unselectTemplate"
>
</stack-from-template-form>
</div>
<!-- !stack-form -->
<!-- container-form -->
<div class="col-sm-12" ng-if="state.selectedTemplate && state.selectedTemplate.Type === 1">

2
app/portainer/views/templates/templatesController.js
View File

@ -1,5 +1,6 @@
import _ from 'lodash-es';
import { TemplateType } from '@/react/portainer/templates/app-templates/types';
import { TEMPLATE_NAME_VALIDATION_REGEX } from '@/react/portainer/custom-templates/components/CommonFields';
import { AccessControlFormData } from '../../components/accessControlForm/porAccessControlFormModel';
angular.module('portainer.app').controller('TemplatesController', [
@ -47,6 +48,7 @@ angular.module('portainer.app').controller('TemplatesController', [
showAdvancedOptions: false,
formValidationError: '',
actionInProgress: false,
templateNameRegex: TEMPLATE_NAME_VALIDATION_REGEX,
};
$scope.enabledTypes = [TemplateType.Container, TemplateType.ComposeStack];

2
app/react/common/stacks/common/form-texts.tsx
View File

@ -33,7 +33,7 @@ export const textByType = {
(Deployment, Secret, ConfigMap...)
</p>
<p>
You can get more information about Kubernetes file format in the
You can get more information about Kubernetes file format in the{' '}
<a
href="https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/"
target="_blank"

6
app/react/kubernetes/DeployView/StackName/StackName.tsx
View File

@ -6,6 +6,7 @@ import { Link } from '@@/Link';
import { TextTip } from '@@/Tip/TextTip';
import { Tooltip } from '@@/Tip/Tooltip';
import { AutocompleteSelect } from '@@/form-components/AutocompleteSelect';
import { FormError } from '@@/form-components/FormError';
type Props = {
stackName: string;
@ -13,6 +14,7 @@ type Props = {
stacks?: string[];
inputClassName?: string;
textTip?: string;
error?: string;
};
export function StackName({
@ -21,6 +23,7 @@ export function StackName({
stacks = [],
inputClassName,
textTip = "Enter or select a 'stack' name to group multiple deployments together, or else leave empty to ignore.",
error = '',
}: Props) {
const isAdminQuery = useIsEdgeAdmin();
const stackResults = useMemo(
@ -50,9 +53,11 @@ export function StackName({
return (
<>
{textTip ? (
<TextTip className="mb-4" color="blue">
{textTip}
</TextTip>
) : null}
<div className="form-group">
<label
htmlFor="stack_name"
@ -72,6 +77,7 @@ export function StackName({
placeholder="e.g. myStack"
inputId="stack_name"
/>
{error ? <FormError>{error}</FormError> : null}
</div>
</div>
</>

4
app/react/kubernetes/DeployView/StackName/constants.ts Normal file
View File

@ -0,0 +1,4 @@
// this regex is to satisfy k8s label validation rules
// alphanumeric, lowercase, uppercase, can contain dashes, dots and underscores, max 63 characters
export const KUBE_STACK_NAME_VALIDATION_REGEX =
/^(([a-zA-Z0-9](?:(?:[-a-zA-Z0-9_.]){0,61}[a-zA-Z0-9])?))$/;

29
app/react/portainer/custom-templates/components/CommonFields.tsx
View File

@ -91,14 +91,10 @@ export function CommonFields({
export function validation({
currentTemplateId,
templates = [],
viewType = 'docker',
}: {
currentTemplateId?: CustomTemplate['Id'];
templates?: Array<CustomTemplate>;
viewType?: 'kube' | 'docker' | 'edge';
} = {}): SchemaOf<Values> {
const titlePattern = titlePatternValidation(viewType);
return object({
Title: string()
.required('Title is required.')
@ -112,7 +108,10 @@ export function validation({
template.Title === value && template.Id !== currentTemplateId
)
)
.matches(titlePattern.pattern, titlePattern.error),
.max(
200,
'Custom template title must be less than or equal to 200 characters'
),
Description: string().required('Description is required.'),
Note: string().default(''),
Logo: string().default(''),
@ -120,23 +119,3 @@ export function validation({
}
export const TEMPLATE_NAME_VALIDATION_REGEX = '^[-_a-z0-9]+$';
const KUBE_TEMPLATE_NAME_VALIDATION_REGEX =
'^(([a-z0-9](?:(?:[-a-z0-9_.]){0,61}[a-z0-9])?))$'; // alphanumeric, lowercase, can contain dashes, dots and underscores, max 63 characters
function titlePatternValidation(type: 'kube' | 'docker' | 'edge') {
switch (type) {
case 'kube':
return {
pattern: new RegExp(KUBE_TEMPLATE_NAME_VALIDATION_REGEX),
error:
"This field must consist of lower-case alphanumeric characters, '.', '_' or '-', must start and end with an alphanumeric character and must be 63 characters or less (e.g. 'my-name', or 'abc-123').",
};
default:
return {
pattern: new RegExp(TEMPLATE_NAME_VALIDATION_REGEX),
error:
"This field must consist of lower-case alphanumeric characters, '_' or '-' (e.g. 'my-name', or 'abc-123').",
};
}
}

2
app/react/portainer/environments/wizard/EnvironmentsCreationView/shared/MoreSettingsSection.tsx
View File

@ -6,7 +6,7 @@ import { MetadataFieldset } from './MetadataFieldset';
export function MoreSettingsSection({ children }: PropsWithChildren<unknown>) {
return (
<FormSection title="More settings" isFoldable>
<FormSection title="More settings" className="ml-0" isFoldable>
<div className="ml-8">
{children}

1
app/react/portainer/templates/custom-templates/CreateView/useValidation.tsx
View File

@ -65,7 +65,6 @@ export function useValidation({
}).concat(
commonFieldsValidation({
templates: customTemplatesQuery.data,
viewType,
})
),
[customTemplatesQuery.data, gitCredentialsQuery.data, viewType]

1
app/react/portainer/templates/custom-templates/EditView/useValidation.tsx
View File

@ -55,7 +55,6 @@ export function useValidation({
commonFieldsValidation({
templates: customTemplatesQuery.data,
currentTemplateId: templateId,
viewType,
})
),
[