c5f348ea2e
* Add validation to all annotations * Add annotation validation for fcgi * Fix reviews and fcgi e2e * Add flag to disable cross namespace validation * Add risk, flag for validation, tests * Add missing formating * Enable validation by default on tests * Test validation flag * remove ajp from list * Finalize validation changes * Add validations to CI * Update helm docs * Fix code review * Use a better name for annotation risk
93 lines
2.4 KiB
Go
93 lines
2.4 KiB
Go
/*
|
|
Copyright 2017 The Kubernetes 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 alias
|
|
|
|
import (
|
|
"sort"
|
|
"strings"
|
|
|
|
networking "k8s.io/api/networking/v1"
|
|
"k8s.io/apimachinery/pkg/util/sets"
|
|
|
|
"k8s.io/ingress-nginx/internal/ingress/annotations/parser"
|
|
"k8s.io/ingress-nginx/internal/ingress/resolver"
|
|
)
|
|
|
|
const (
|
|
serverAliasAnnotation = "server-alias"
|
|
)
|
|
|
|
var aliasAnnotation = parser.Annotation{
|
|
Group: "alias",
|
|
Annotations: parser.AnnotationFields{
|
|
serverAliasAnnotation: {
|
|
Validator: parser.ValidateArrayOfServerName,
|
|
Scope: parser.AnnotationScopeIngress,
|
|
Risk: parser.AnnotationRiskHigh, // High as this allows regex chars
|
|
Documentation: `this annotation can be used to define additional server
|
|
aliases for this Ingress`,
|
|
},
|
|
},
|
|
}
|
|
|
|
type alias struct {
|
|
r resolver.Resolver
|
|
annotationConfig parser.Annotation
|
|
}
|
|
|
|
// NewParser creates a new Alias annotation parser
|
|
func NewParser(r resolver.Resolver) parser.IngressAnnotation {
|
|
return alias{
|
|
r: r,
|
|
annotationConfig: aliasAnnotation,
|
|
}
|
|
}
|
|
|
|
func (a alias) GetDocumentation() parser.AnnotationFields {
|
|
return a.annotationConfig.Annotations
|
|
}
|
|
|
|
// Parse parses the annotations contained in the ingress rule
|
|
// used to add an alias to the provided hosts
|
|
func (a alias) Parse(ing *networking.Ingress) (interface{}, error) {
|
|
val, err := parser.GetStringAnnotation(serverAliasAnnotation, ing, a.annotationConfig.Annotations)
|
|
if err != nil {
|
|
return []string{}, err
|
|
}
|
|
|
|
aliases := sets.NewString()
|
|
for _, alias := range strings.Split(val, ",") {
|
|
alias = strings.TrimSpace(alias)
|
|
if len(alias) == 0 {
|
|
continue
|
|
}
|
|
|
|
if !aliases.Has(alias) {
|
|
aliases.Insert(alias)
|
|
}
|
|
}
|
|
|
|
l := aliases.List()
|
|
sort.Strings(l)
|
|
|
|
return l, nil
|
|
}
|
|
|
|
func (a alias) Validate(anns map[string]string) error {
|
|
maxrisk := parser.StringRiskToRisk(a.r.GetSecurityConfiguration().AnnotationsRiskLevel)
|
|
return parser.CheckAnnotationRisk(anns, maxrisk, aliasAnnotation.Annotations)
|
|
}
|