utils

Documentation

Index

• Constants
• Variables
• func AnyToMessage(a *pany.Any) (proto.Message, error)
• func DeleteResources(existingResources sk_resources.ResourceList, refsToDelete []*core.ResourceRef) sk_resources.ResourceList
• func EnsureRouteAction(out *envoy_config_route_v3.Route) error
• func EnvoyPathAsString(matcher *envoy_config_route_v3.RouteMatch) string
• func FilterLogLevel(r io.ReadCloser, level LogLevel) strings.Builder
• func GetCommonTlsContextFromUpstreamOptions(options *v1.UpstreamOptions) (*envoyauth.CommonTlsContext, error)
• func GetVhostReportsFromListenerReport(listenerReport *validation.ListenerReport) []*validation.VirtualHostReport
• func GetVirtualHostsForListener(listener *v1.Listener) []*v1.VirtualHost
• func MatchedRouteConfigName(listener *v1.Listener, matcher *v1.Matcher) string
• func MergeResourceLists(existingResources sk_resources.ResourceList, ...) sk_resources.ResourceList
• func MessageToAny(msg proto.Message) (*pany.Any, error)
• func MustAnyToMessage(a *pany.Any) proto.Message
• func NewSslConfigTranslator() *sslConfigTranslator
• func PathAsString(matcher *matchers.Matcher) string
• func ResourceListToSecretList(resourceList sk_resources.ResourceList) gloov1.SecretList
• func ResourceListToUpstreamList(resourceList sk_resources.ResourceList) gloov1.UpstreamList
• func RouteConfigName(listener *v1.Listener) string
• func SanitizeForEnvoy(ctx context.Context, resourceName, resourceTypeName string) string
• func SortGatewayRoutesByPath(routes []*gatewayv1.Route)
• func SortRoutesByPath(routes []*v1.Route)
• func UpstreamsToResourceList(upstreams []*gloov1.Upstream) sk_resources.ResourceList
• type CertSource
• type LogLevel
  • func (l LogLevel) String() string
• type SslConfigTranslator

Constants

const (
	MetadataPluginName = "envoy.grpc_credentials.file_based_metadata"
)

Variables

var (
	TlsVersionNotFoundError = func(v ssl.SslParameters_ProtocolVersion) error {
		return eris.Errorf("tls version %v not found", v)
	}

	SslSecretNotFoundError = func(err error) error {
		return eris.Wrapf(err, "SSL secret not found")
	}

	NotTlsSecretError = func(ref *core.ResourceRef) error {
		return eris.Errorf("%v is not a TLS secret", ref)
	}

	InvalidTlsSecretError = func(ref *core.ResourceRef, err error) error {
		if ref == nil {
			return eris.Wrapf(err, "Invalid TLS secret")
		} else {
			errorString := fmt.Sprintf("%v is not a valid TLS secret", ref)
			return eris.Wrapf(err, errorString)
		}
	}

	NoCertificateFoundError = eris.New("no certificate information found")

	MissingValidationContextError = eris.Errorf("must provide validation context name if verifying SAN")

	RootCaMustBeProvidedError = eris.Errorf("a root_ca must be provided if verify_subject_alt_name is not empty")
)

var (
	InvalidRouteActionError = errors.New("cannot use this plugin on non-Route_Route route actions")
)

Functions

func AnyToMessage

func AnyToMessage(a *pany.Any) (proto.Message, error)

func DeleteResources

func DeleteResources(existingResources sk_resources.ResourceList, refsToDelete []*core.ResourceRef) sk_resources.ResourceList

Deletes the resources with the given refs from the list, and returns the updated list.

func EnsureRouteAction

func EnsureRouteAction(out *envoy_config_route_v3.Route) error

func EnvoyPathAsString

func EnvoyPathAsString(matcher *envoy_config_route_v3.RouteMatch) string

func FilterLogLevel

func FilterLogLevel(r io.ReadCloser, level LogLevel) strings.Builder

Filter JSON logs with level

func GetCommonTlsContextFromUpstreamOptions

func GetCommonTlsContextFromUpstreamOptions(options *v1.UpstreamOptions) (*envoyauth.CommonTlsContext, error)

We support global UpstreamOptions to define SslParameters for all upstreams If an upstream is configure with ssl, it will inherit the defaults here: https://github.com/solo-io/gloo/blob/15da82bdd65ab4bcedbc7fb803ea0bb5f7e926fc/projects/gloo/pkg/translator/clusters.go#L108 However, if an upstream is configured with one-way TLS, we must explicitly apply the defaults, since there is no ssl configuration on the upstream

func GetVhostReportsFromListenerReport

func GetVhostReportsFromListenerReport(listenerReport *validation.ListenerReport) []*validation.VirtualHostReport

func GetVirtualHostsForListener

func GetVirtualHostsForListener(listener *v1.Listener) []*v1.VirtualHost

func MatchedRouteConfigName

func MatchedRouteConfigName(listener *v1.Listener, matcher *v1.Matcher) string

MatchedRouteConfigName returns a unique RouteConfiguration name This name is commonly used for 2 purposes:

1. to associate the RouteConfigurationName between RDS and the HttpConnectionManager NetworkFilter
2. To provide a consistent key function for a map of ListenerReports

func MergeResourceLists

func MergeResourceLists(existingResources sk_resources.ResourceList, modifiedResources sk_resources.ResourceList) sk_resources.ResourceList

Merges the modified resources into the existing resources, overwriting any existing values, and returns the new list

func MessageToAny

func MessageToAny(msg proto.Message) (*pany.Any, error)

MessageToAny takes any given proto message msg and returns the marshalled bytes of the proto, and a url to the type definition for the proto in the form of a *pany.Any, errors if nil or if the proto type doesnt exist or if there is a marshalling error

func MustAnyToMessage

func MustAnyToMessage(a *pany.Any) proto.Message

Deprecated: Use AnyToMessage

func NewSslConfigTranslator

func NewSslConfigTranslator() *sslConfigTranslator

func PathAsString

func PathAsString(matcher *matchers.Matcher) string

func ResourceListToSecretList

func ResourceListToSecretList(resourceList sk_resources.ResourceList) gloov1.SecretList

func ResourceListToUpstreamList

func ResourceListToUpstreamList(resourceList sk_resources.ResourceList) gloov1.UpstreamList

func RouteConfigName

func RouteConfigName(listener *v1.Listener) string

RouteConfigName cannot always be relied on to get the route config name for any listener because the pattern is different for hybrid listeners (see MatchedRouteConfigName below)

func SanitizeForEnvoy

func SanitizeForEnvoy(ctx context.Context, resourceName, resourceTypeName string) string

func SortGatewayRoutesByPath

func SortGatewayRoutesByPath(routes []*gatewayv1.Route)

func SortRoutesByPath

func SortRoutesByPath(routes []*v1.Route)

Matchers sort according to the following rules: 1. exact path < regex path < prefix path 2. lexicographically greater path string < lexicographically smaller path string

func UpstreamsToResourceList

func UpstreamsToResourceList(upstreams []*gloov1.Upstream) sk_resources.ResourceList

Types

type CertSource

type CertSource interface {
	GetSecretRef() *core.ResourceRef
	GetSslFiles() *ssl.SSLFiles
	GetSds() *ssl.SDSConfig
	GetVerifySubjectAltName() []string
	GetParameters() *ssl.SslParameters
	GetAlpnProtocols() []string
}

type LogLevel

type LogLevel int8

A Level is a logging priority. Higher levels are more important.

const (
	LogLevelInfo LogLevel = iota - 1
	LogLevelWarn
	LogLevelError
	LogLevelAll
)

func (LogLevel) String

func (l LogLevel) String() string

String returns a lower-case ASCII representation of the log level.

type SslConfigTranslator

type SslConfigTranslator interface {
	ResolveUpstreamSslConfig(secrets v1.SecretList, uc *ssl.UpstreamSslConfig) (*envoyauth.UpstreamTlsContext, error)
	ResolveDownstreamSslConfig(secrets v1.SecretList, dc *ssl.SslConfig) (*envoyauth.DownstreamTlsContext, error)
	ResolveCommonSslConfig(cs CertSource, secrets v1.SecretList, mustHaveCert bool) (*envoyauth.CommonTlsContext, error)
	ResolveSslParamsConfig(params *ssl.SslParameters) (*envoyauth.TlsParameters, error)
}