pkg/config/analysis/analyzers/virtualservice/regexes.go

// Copyright Istio 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 virtualservice

import (
	"fmt"
	"regexp"
)

import (
	"istio.io/api/networking/v1alpha3"
)

import (
	"github.com/apache/dubbo-go-pixiu/pkg/config/analysis"
	"github.com/apache/dubbo-go-pixiu/pkg/config/analysis/analyzers/util"
	"github.com/apache/dubbo-go-pixiu/pkg/config/analysis/msg"
	"github.com/apache/dubbo-go-pixiu/pkg/config/resource"
	"github.com/apache/dubbo-go-pixiu/pkg/config/schema/collection"
	"github.com/apache/dubbo-go-pixiu/pkg/config/schema/collections"
)

// RegexAnalyzer checks all regexes in a virtual service
type RegexAnalyzer struct{}

var _ analysis.Analyzer = &RegexAnalyzer{}

// Metadata implements Analyzer
func (a *RegexAnalyzer) Metadata() analysis.Metadata {
	return analysis.Metadata{
		Name:        "virtualservice.RegexAnalyzer",
		Description: "Checks regex syntax",
		Inputs: collection.Names{
			collections.IstioNetworkingV1Alpha3Virtualservices.Name(),
		},
	}
}

// Analyze implements Analyzer
func (a *RegexAnalyzer) Analyze(ctx analysis.Context) {
	ctx.ForEach(collections.IstioNetworkingV1Alpha3Virtualservices.Name(), func(r *resource.Instance) bool {
		a.analyzeVirtualService(r, ctx)
		return true
	})
}

func (a *RegexAnalyzer) analyzeVirtualService(r *resource.Instance, ctx analysis.Context) {
	vs := r.Message.(*v1alpha3.VirtualService)

	for i, route := range vs.GetHttp() {
		for j, m := range route.GetMatch() {

			analyzeStringMatch(r, m.GetUri(), ctx, "uri",
				fmt.Sprintf(util.URISchemeMethodAuthorityRegexMatch, i, j, "uri"))
			analyzeStringMatch(r, m.GetScheme(), ctx, "scheme",
				fmt.Sprintf(util.URISchemeMethodAuthorityRegexMatch, i, j, "scheme"))
			analyzeStringMatch(r, m.GetMethod(), ctx, "method",
				fmt.Sprintf(util.URISchemeMethodAuthorityRegexMatch, i, j, "method"))
			analyzeStringMatch(r, m.GetAuthority(), ctx, "authority",
				fmt.Sprintf(util.URISchemeMethodAuthorityRegexMatch, i, j, "authority"))
			for key, h := range m.GetHeaders() {
				analyzeStringMatch(r, h, ctx, "headers",
					fmt.Sprintf(util.HeaderAndQueryParamsRegexMatch, i, j, "headers", key))
			}
			for key, qp := range m.GetQueryParams() {
				analyzeStringMatch(r, qp, ctx, "queryParams",
					fmt.Sprintf(util.HeaderAndQueryParamsRegexMatch, i, j, "queryParams", key))
			}
			// We don't validate withoutHeaders, because they are undocumented
		}
		for j, origin := range route.GetCorsPolicy().GetAllowOrigins() {
			analyzeStringMatch(r, origin, ctx, "corsPolicy.allowOrigins",
				fmt.Sprintf(util.AllowOriginsRegexMatch, i, j))
		}
	}
}

func analyzeStringMatch(r *resource.Instance, sm *v1alpha3.StringMatch, ctx analysis.Context, where string, key string) {
	re := sm.GetRegex()
	if re == "" {
		return
	}

	_, err := regexp.Compile(re)
	if err == nil {
		return
	}

	m := msg.NewInvalidRegexp(r, where, re, err.Error())

	// Get line number for different match field
	if line, ok := util.ErrorLine(r, key); ok {
		m.Line = line
	}

	ctx.Report(collections.IstioNetworkingV1Alpha3Virtualservices.Name(), m)
}