Implement annotation validation (#9673)

* 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
This commit is contained in:
Ricardo Katz 2023-07-22 00:32:07 -03:00 committed by GitHub
parent 86c00a2310
commit c5f348ea2e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
109 changed files with 4320 additions and 586 deletions

View file

@ -23,18 +23,48 @@ import (
"k8s.io/ingress-nginx/internal/ingress/resolver"
)
const (
upstreamVhostAnnotation = "upstream-vhost"
)
var upstreamVhostAnnotations = parser.Annotation{
Group: "backend",
Annotations: parser.AnnotationFields{
upstreamVhostAnnotation: {
Validator: parser.ValidateServerName,
Scope: parser.AnnotationScopeLocation,
Risk: parser.AnnotationRiskLow, // Low, as it allows regexes but on a very limited set
Documentation: `This configuration setting allows you to control the value for host in the following statement: proxy_set_header Host $host, which forms part of the location block.
This is useful if you need to call the upstream server by something other than $host`,
},
},
}
type upstreamVhost struct {
r resolver.Resolver
r resolver.Resolver
annotationConfig parser.Annotation
}
// NewParser creates a new upstream VHost annotation parser
func NewParser(r resolver.Resolver) parser.IngressAnnotation {
return upstreamVhost{r}
return upstreamVhost{
r: r,
annotationConfig: upstreamVhostAnnotations,
}
}
// Parse parses the annotations contained in the ingress rule
// used to indicate if the location/s contains a fragment of
// configuration to be included inside the paths of the rules
func (a upstreamVhost) Parse(ing *networking.Ingress) (interface{}, error) {
return parser.GetStringAnnotation("upstream-vhost", ing)
return parser.GetStringAnnotation(upstreamVhostAnnotation, ing, a.annotationConfig.Annotations)
}
func (a upstreamVhost) GetDocumentation() parser.AnnotationFields {
return a.annotationConfig.Annotations
}
func (a upstreamVhost) Validate(anns map[string]string) error {
maxrisk := parser.StringRiskToRisk(a.r.GetSecurityConfiguration().AnnotationsRiskLevel)
return parser.CheckAnnotationRisk(anns, maxrisk, upstreamVhostAnnotations.Annotations)
}

View file

@ -36,7 +36,7 @@ func TestParse(t *testing.T) {
}
data := map[string]string{}
data[parser.GetAnnotationWithPrefix("upstream-vhost")] = "ok.com"
data[parser.GetAnnotationWithPrefix(upstreamVhostAnnotation)] = "ok.com"
ing.SetAnnotations(data)