transformation_ee

package
v1.18.0-beta24 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 1, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_github_com_solo_io_gloo_projects_gloo_api_external_envoy_extensions_transformation_ee_transformation_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Action

type Action struct {

	// Identifier for this action.
	// Used mostly to help ID specific actions in logs.
	// If left null will default to unknown
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Deprecated in favor of DlpMatcher
	// List of regexes to apply to the response body to match data which should be masked
	// They will be applied iteratively in the order which they are specified
	//
	// Deprecated: Marked as deprecated in github.com/solo-io/gloo/projects/gloo/api/external/envoy/extensions/transformation_ee/transformation.proto.
	Regex []string `protobuf:"bytes,2,rep,name=regex,proto3" json:"regex,omitempty"`
	// Deprecated in favor of DlpMatcher
	// List of regexes to apply to the response body to match data which should be
	// masked. They will be applied iteratively in the order which they are
	// specified. If this field and `regex` are both provided, all the regexes will
	// be applied iteratively in the order provided, starting with the ones from `regex`
	//
	// Deprecated: Marked as deprecated in github.com/solo-io/gloo/projects/gloo/api/external/envoy/extensions/transformation_ee/transformation.proto.
	RegexActions []*RegexAction `protobuf:"bytes,6,rep,name=regex_actions,json=regexActions,proto3" json:"regex_actions,omitempty"`
	// If specified, this rule will not actually be applied, but only logged.
	Shadow bool `protobuf:"varint,3,opt,name=shadow,proto3" json:"shadow,omitempty"`
	// The percent of the string which should be masked.
	// If not set, defaults to 75%
	Percent *_type.Percent `protobuf:"bytes,4,opt,name=percent,proto3" json:"percent,omitempty"`
	// The character which should overwrite the masked data
	// If left empty, defaults to "X"
	MaskChar string `protobuf:"bytes,5,opt,name=mask_char,json=maskChar,proto3" json:"mask_char,omitempty"`
	// The matcher used to determine which values will be masked by this action.
	Matcher *Action_DlpMatcher `protobuf:"bytes,7,opt,name=matcher,proto3" json:"matcher,omitempty"`
	// contains filtered or unexported fields
}

func (*Action) Descriptor deprecated

func (*Action) Descriptor() ([]byte, []int)

Deprecated: Use Action.ProtoReflect.Descriptor instead.

func (*Action) GetMaskChar

func (x *Action) GetMaskChar() string

func (*Action) GetMatcher added in v1.9.25

func (x *Action) GetMatcher() *Action_DlpMatcher

func (*Action) GetName

func (x *Action) GetName() string

func (*Action) GetPercent

func (x *Action) GetPercent() *_type.Percent

func (*Action) GetRegex deprecated

func (x *Action) GetRegex() []string

Deprecated: Marked as deprecated in github.com/solo-io/gloo/projects/gloo/api/external/envoy/extensions/transformation_ee/transformation.proto.

func (*Action) GetRegexActions deprecated added in v1.8.14

func (x *Action) GetRegexActions() []*RegexAction

Deprecated: Marked as deprecated in github.com/solo-io/gloo/projects/gloo/api/external/envoy/extensions/transformation_ee/transformation.proto.

func (*Action) GetShadow

func (x *Action) GetShadow() bool

func (*Action) ProtoMessage

func (*Action) ProtoMessage()

func (*Action) ProtoReflect added in v1.6.0

func (x *Action) ProtoReflect() protoreflect.Message

func (*Action) Reset

func (x *Action) Reset()

func (*Action) String

func (x *Action) String() string

type Action_DlpMatcher added in v1.9.25

type Action_DlpMatcher struct {

	// Types that are assignable to Matcher:
	//
	//	*Action_DlpMatcher_RegexMatcher
	//	*Action_DlpMatcher_KeyValueMatcher
	Matcher isAction_DlpMatcher_Matcher `protobuf_oneof:"matcher"`
	// contains filtered or unexported fields
}

func (*Action_DlpMatcher) Descriptor deprecated added in v1.9.25

func (*Action_DlpMatcher) Descriptor() ([]byte, []int)

Deprecated: Use Action_DlpMatcher.ProtoReflect.Descriptor instead.

func (*Action_DlpMatcher) GetKeyValueMatcher added in v1.9.25

func (x *Action_DlpMatcher) GetKeyValueMatcher() *Action_KeyValueMatcher

func (*Action_DlpMatcher) GetMatcher added in v1.9.25

func (m *Action_DlpMatcher) GetMatcher() isAction_DlpMatcher_Matcher

func (*Action_DlpMatcher) GetRegexMatcher added in v1.9.25

func (x *Action_DlpMatcher) GetRegexMatcher() *Action_RegexMatcher

func (*Action_DlpMatcher) ProtoMessage added in v1.9.25

func (*Action_DlpMatcher) ProtoMessage()

func (*Action_DlpMatcher) ProtoReflect added in v1.9.25

func (x *Action_DlpMatcher) ProtoReflect() protoreflect.Message

func (*Action_DlpMatcher) Reset added in v1.9.25

func (x *Action_DlpMatcher) Reset()

func (*Action_DlpMatcher) String added in v1.9.25

func (x *Action_DlpMatcher) String() string

type Action_DlpMatcher_KeyValueMatcher added in v1.9.25

type Action_DlpMatcher_KeyValueMatcher struct {
	KeyValueMatcher *Action_KeyValueMatcher `protobuf:"bytes,2,opt,name=key_value_matcher,json=keyValueMatcher,proto3,oneof"`
}

type Action_DlpMatcher_RegexMatcher added in v1.9.25

type Action_DlpMatcher_RegexMatcher struct {
	RegexMatcher *Action_RegexMatcher `protobuf:"bytes,1,opt,name=regex_matcher,json=regexMatcher,proto3,oneof"`
}

type Action_KeyValueMatcher added in v1.9.25

type Action_KeyValueMatcher struct {
	Keys []string `protobuf:"bytes,1,rep,name=keys,proto3" json:"keys,omitempty"`
	// contains filtered or unexported fields
}

List of headers for which associated values will be masked. Note that enable_header_transformation must be set for this to take effect. Note that if enable_dynamic_metadata_transformation is set, proto struct dynamic metadata (i.e., the values matching any JSON keys specified in `keys`; primarily for json-formatted WAF audit logs) will also be masked accordingly.

func (*Action_KeyValueMatcher) Descriptor deprecated added in v1.9.25

func (*Action_KeyValueMatcher) Descriptor() ([]byte, []int)

Deprecated: Use Action_KeyValueMatcher.ProtoReflect.Descriptor instead.

func (*Action_KeyValueMatcher) GetKeys added in v1.9.25

func (x *Action_KeyValueMatcher) GetKeys() []string

func (*Action_KeyValueMatcher) ProtoMessage added in v1.9.25

func (*Action_KeyValueMatcher) ProtoMessage()

func (*Action_KeyValueMatcher) ProtoReflect added in v1.9.25

func (x *Action_KeyValueMatcher) ProtoReflect() protoreflect.Message

func (*Action_KeyValueMatcher) Reset added in v1.9.25

func (x *Action_KeyValueMatcher) Reset()

func (*Action_KeyValueMatcher) String added in v1.9.25

func (x *Action_KeyValueMatcher) String() string

type Action_RegexMatcher added in v1.9.25

type Action_RegexMatcher struct {
	RegexActions []*RegexAction `protobuf:"bytes,1,rep,name=regex_actions,json=regexActions,proto3" json:"regex_actions,omitempty"`
	// contains filtered or unexported fields
}

List of regexes to apply to the response body to match data which should be masked. They will be applied iteratively in the order which they are specified.

func (*Action_RegexMatcher) Descriptor deprecated added in v1.9.25

func (*Action_RegexMatcher) Descriptor() ([]byte, []int)

Deprecated: Use Action_RegexMatcher.ProtoReflect.Descriptor instead.

func (*Action_RegexMatcher) GetRegexActions added in v1.9.25

func (x *Action_RegexMatcher) GetRegexActions() []*RegexAction

func (*Action_RegexMatcher) ProtoMessage added in v1.9.25

func (*Action_RegexMatcher) ProtoMessage()

func (*Action_RegexMatcher) ProtoReflect added in v1.9.25

func (x *Action_RegexMatcher) ProtoReflect() protoreflect.Message

func (*Action_RegexMatcher) Reset added in v1.9.25

func (x *Action_RegexMatcher) Reset()

func (*Action_RegexMatcher) String added in v1.9.25

func (x *Action_RegexMatcher) String() string

type DlpTransformation

type DlpTransformation struct {

	// list of actions to apply
	Actions []*Action `protobuf:"bytes,1,rep,name=actions,proto3" json:"actions,omitempty"`
	// If true, headers will be transformed. Should only be true for the
	// on_stream_complete_transformation route transformation type.
	EnableHeaderTransformation bool `` /* 142-byte string literal not displayed */
	// If true, dynamic metadata will be transformed. Should only be used for the
	// on_stream_complete_transformation route transformation type.
	EnableDynamicMetadataTransformation bool `` /* 171-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*DlpTransformation) Descriptor deprecated

func (*DlpTransformation) Descriptor() ([]byte, []int)

Deprecated: Use DlpTransformation.ProtoReflect.Descriptor instead.

func (*DlpTransformation) GetActions

func (x *DlpTransformation) GetActions() []*Action

func (*DlpTransformation) GetEnableDynamicMetadataTransformation added in v1.7.7

func (x *DlpTransformation) GetEnableDynamicMetadataTransformation() bool

func (*DlpTransformation) GetEnableHeaderTransformation added in v1.7.7

func (x *DlpTransformation) GetEnableHeaderTransformation() bool

func (*DlpTransformation) ProtoMessage

func (*DlpTransformation) ProtoMessage()

func (*DlpTransformation) ProtoReflect added in v1.6.0

func (x *DlpTransformation) ProtoReflect() protoreflect.Message

func (*DlpTransformation) Reset

func (x *DlpTransformation) Reset()

func (*DlpTransformation) String

func (x *DlpTransformation) String() string

type FilterTransformations

type FilterTransformations struct {

	// Specifies transformations based on the route matches. The first matched transformation will be
	// applied. If there are overlapped match conditions, please put the most specific match first.
	Transformations []*TransformationRule `protobuf:"bytes,1,rep,name=transformations,proto3" json:"transformations,omitempty"`
	// contains filtered or unexported fields
}

func (*FilterTransformations) Descriptor deprecated

func (*FilterTransformations) Descriptor() ([]byte, []int)

Deprecated: Use FilterTransformations.ProtoReflect.Descriptor instead.

func (*FilterTransformations) GetTransformations

func (x *FilterTransformations) GetTransformations() []*TransformationRule

func (*FilterTransformations) ProtoMessage

func (*FilterTransformations) ProtoMessage()

func (*FilterTransformations) ProtoReflect added in v1.6.0

func (x *FilterTransformations) ProtoReflect() protoreflect.Message

func (*FilterTransformations) Reset

func (x *FilterTransformations) Reset()

func (*FilterTransformations) String

func (x *FilterTransformations) String() string

type RegexAction added in v1.8.14

type RegexAction struct {

	// The regex to match for masking.
	Regex string `protobuf:"bytes,1,opt,name=regex,proto3" json:"regex,omitempty"`
	// If provided and not 0, only this specific subgroup of the regex will be masked.
	Subgroup uint32 `protobuf:"varint,2,opt,name=subgroup,proto3" json:"subgroup,omitempty"`
	// contains filtered or unexported fields
}

func (*RegexAction) Descriptor deprecated added in v1.8.14

func (*RegexAction) Descriptor() ([]byte, []int)

Deprecated: Use RegexAction.ProtoReflect.Descriptor instead.

func (*RegexAction) GetRegex added in v1.8.14

func (x *RegexAction) GetRegex() string

func (*RegexAction) GetSubgroup added in v1.8.14

func (x *RegexAction) GetSubgroup() uint32

func (*RegexAction) ProtoMessage added in v1.8.14

func (*RegexAction) ProtoMessage()

func (*RegexAction) ProtoReflect added in v1.8.14

func (x *RegexAction) ProtoReflect() protoreflect.Message

func (*RegexAction) Reset added in v1.8.14

func (x *RegexAction) Reset()

func (*RegexAction) String added in v1.8.14

func (x *RegexAction) String() string

type RouteTransformations

type RouteTransformations struct {
	RequestTransformation *Transformation `protobuf:"bytes,1,opt,name=request_transformation,json=requestTransformation,proto3" json:"request_transformation,omitempty"`
	// clear the route cache if the request transformation was applied
	ClearRouteCache        bool            `protobuf:"varint,3,opt,name=clear_route_cache,json=clearRouteCache,proto3" json:"clear_route_cache,omitempty"`
	ResponseTransformation *Transformation `` /* 127-byte string literal not displayed */
	// Apply a transformation in the onStreamComplete callback
	// (for modifying headers and dynamic metadata for access logs)
	OnStreamCompletionTransformation *Transformation `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*RouteTransformations) Descriptor deprecated

func (*RouteTransformations) Descriptor() ([]byte, []int)

Deprecated: Use RouteTransformations.ProtoReflect.Descriptor instead.

func (*RouteTransformations) GetClearRouteCache

func (x *RouteTransformations) GetClearRouteCache() bool

func (*RouteTransformations) GetOnStreamCompletionTransformation added in v1.7.7

func (x *RouteTransformations) GetOnStreamCompletionTransformation() *Transformation

func (*RouteTransformations) GetRequestTransformation

func (x *RouteTransformations) GetRequestTransformation() *Transformation

func (*RouteTransformations) GetResponseTransformation

func (x *RouteTransformations) GetResponseTransformation() *Transformation

func (*RouteTransformations) ProtoMessage

func (*RouteTransformations) ProtoMessage()

func (*RouteTransformations) ProtoReflect added in v1.6.0

func (x *RouteTransformations) ProtoReflect() protoreflect.Message

func (*RouteTransformations) Reset

func (x *RouteTransformations) Reset()

func (*RouteTransformations) String

func (x *RouteTransformations) String() string

type Transformation

type Transformation struct {

	// Template is in the transformed request language domain
	//
	// Types that are assignable to TransformationType:
	//
	//	*Transformation_DlpTransformation
	TransformationType isTransformation_TransformationType `protobuf_oneof:"transformation_type"`
	// contains filtered or unexported fields
}

func (*Transformation) Descriptor deprecated

func (*Transformation) Descriptor() ([]byte, []int)

Deprecated: Use Transformation.ProtoReflect.Descriptor instead.

func (*Transformation) GetDlpTransformation

func (x *Transformation) GetDlpTransformation() *DlpTransformation

func (*Transformation) GetTransformationType

func (m *Transformation) GetTransformationType() isTransformation_TransformationType

func (*Transformation) ProtoMessage

func (*Transformation) ProtoMessage()

func (*Transformation) ProtoReflect added in v1.6.0

func (x *Transformation) ProtoReflect() protoreflect.Message

func (*Transformation) Reset

func (x *Transformation) Reset()

func (*Transformation) String

func (x *Transformation) String() string

type TransformationRule

type TransformationRule struct {

	// The route matching parameter. Only when the match is satisfied, the "requires" field will
	// apply.
	//
	// For example: following match will match all requests.
	//
	// .. code-block:: yaml
	//
	//	match:
	//	  prefix: /
	Match   *route.RouteMatch `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"`
	MatchV3 *v3.RouteMatch    `protobuf:"bytes,3,opt,name=match_v3,json=matchV3,proto3" json:"match_v3,omitempty"`
	// transformation to perform
	RouteTransformations *RouteTransformations `protobuf:"bytes,2,opt,name=route_transformations,json=routeTransformations,proto3" json:"route_transformations,omitempty"`
	// contains filtered or unexported fields
}

func (*TransformationRule) Descriptor deprecated

func (*TransformationRule) Descriptor() ([]byte, []int)

Deprecated: Use TransformationRule.ProtoReflect.Descriptor instead.

func (*TransformationRule) GetMatch

func (x *TransformationRule) GetMatch() *route.RouteMatch

func (*TransformationRule) GetMatchV3 added in v1.9.8

func (x *TransformationRule) GetMatchV3() *v3.RouteMatch

func (*TransformationRule) GetRouteTransformations

func (x *TransformationRule) GetRouteTransformations() *RouteTransformations

func (*TransformationRule) ProtoMessage

func (*TransformationRule) ProtoMessage()

func (*TransformationRule) ProtoReflect added in v1.6.0

func (x *TransformationRule) ProtoReflect() protoreflect.Message

func (*TransformationRule) Reset

func (x *TransformationRule) Reset()

func (*TransformationRule) String

func (x *TransformationRule) String() string

type Transformation_DlpTransformation

type Transformation_DlpTransformation struct {
	DlpTransformation *DlpTransformation `protobuf:"bytes,1,opt,name=dlp_transformation,json=dlpTransformation,proto3,oneof"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL