v3alpha

Documentation

Index

• Variables
• type SXG
  • func (*SXG) Descriptor() ([]byte, []int)
  • func (x *SXG) GetCborUrl() string
  • func (x *SXG) GetCertificate() *v3.SdsSecretConfig
  • func (x *SXG) GetClientCanAcceptSxgHeader() string
  • func (x *SXG) GetDuration() *duration.Duration
  • func (x *SXG) GetHeaderPrefixFilters() []string
  • func (x *SXG) GetMiRecordSize() uint64
  • func (x *SXG) GetPrivateKey() *v3.SdsSecretConfig
  • func (x *SXG) GetShouldEncodeSxgHeader() string
  • func (x *SXG) GetValidityUrl() string
  • func (*SXG) ProtoMessage()
  • func (x *SXG) ProtoReflect() protoreflect.Message
  • func (x *SXG) Reset()
  • func (x *SXG) String() string
  • func (m *SXG) Validate() error
  • func (m *SXG) ValidateAll() error
• type SXGMultiError
  • func (m SXGMultiError) AllErrors() []error
  • func (m SXGMultiError) Error() string
• type SXGValidationError
  • func (e SXGValidationError) Cause() error
  • func (e SXGValidationError) Error() string
  • func (e SXGValidationError) ErrorName() string
  • func (e SXGValidationError) Field() string
  • func (e SXGValidationError) Key() bool
  • func (e SXGValidationError) Reason() string

Variables

var File_contrib_envoy_extensions_filters_http_sxg_v3alpha_sxg_proto protoreflect.FileDescriptor

Types

type SXG

type SXG struct {

	// The SDS configuration for the public key data for the SSL certificate that will be used to sign the
	// SXG response.
	Certificate *v3.SdsSecretConfig `protobuf:"bytes,1,opt,name=certificate,proto3" json:"certificate,omitempty"`
	// The SDS configuration for the private key data for the SSL certificate that will be used to sign the
	// SXG response.
	PrivateKey *v3.SdsSecretConfig `protobuf:"bytes,2,opt,name=private_key,json=privateKey,proto3" json:"private_key,omitempty"`
	// The duration for which the generated SXG package will be valid. Default is 604800s (7 days in seconds).
	// Note that in order to account for clock skew, the timestamp will be backdated by a day. So, if duration
	// is set to 7 days, that will be 7 days from 24 hours ago (6 days from now). Also note that while 6/7 days
	// is appropriate for most content, if the downstream service is serving Javascript, or HTML with inline
	// Javascript, 1 day (so, with backdated expiry, 2 days, or 172800 seconds) is more appropriate.
	Duration *duration.Duration `protobuf:"bytes,3,opt,name=duration,proto3" json:"duration,omitempty"`
	// The SXG response payload is Merkle Integrity Content Encoding (MICE) encoded (specification is [here](https://datatracker.ietf.org/doc/html/draft-thomson-http-mice-03))
	// This value indicates the record size in the encoded payload. The default value is 4096.
	MiRecordSize uint64 `protobuf:"varint,4,opt,name=mi_record_size,json=miRecordSize,proto3" json:"mi_record_size,omitempty"`
	// The URI of certificate CBOR file published. Since it is required that the certificate CBOR file
	// be served from the same domain as the SXG document, this should be a relative URI.
	CborUrl string `protobuf:"bytes,5,opt,name=cbor_url,json=cborUrl,proto3" json:"cbor_url,omitempty"`
	// URL to retrieve validity data for signature, a CBOR map. See specification [here](https://tools.ietf.org/html/draft-yasskin-httpbis-origin-signed-exchanges-impl-00#section-3.6)
	ValidityUrl string `protobuf:"bytes,6,opt,name=validity_url,json=validityUrl,proto3" json:"validity_url,omitempty"`
	// Header that will be set if it is determined that the client can accept SXG (typically “accept: application/signed-exchange;v=b3“)
	// If not set, filter will default to: “x-client-can-accept-sxg“
	ClientCanAcceptSxgHeader string `` /* 139-byte string literal not displayed */
	// Header set by downstream service to signal that the response should be transformed to SXG If not set,
	// filter will default to: “x-should-encode-sxg“
	ShouldEncodeSxgHeader string `` /* 128-byte string literal not displayed */
	// Headers that will be stripped from the SXG document, by listing a prefix (i.e. “x-custom-“ will cause
	// all headers prefixed by “x-custom-“ to be omitted from the SXG document)
	HeaderPrefixFilters []string `protobuf:"bytes,9,rep,name=header_prefix_filters,json=headerPrefixFilters,proto3" json:"header_prefix_filters,omitempty"`
	// contains filtered or unexported fields
}

[#next-free-field: 10]

func (*SXG) Descriptor

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

Deprecated: Use SXG.ProtoReflect.Descriptor instead.

func (*SXG) GetCborUrl

func (x *SXG) GetCborUrl() string

func (*SXG) GetCertificate

func (x *SXG) GetCertificate() *v3.SdsSecretConfig

func (*SXG) GetClientCanAcceptSxgHeader

func (x *SXG) GetClientCanAcceptSxgHeader() string

func (*SXG) GetDuration

func (x *SXG) GetDuration() *duration.Duration

func (*SXG) GetHeaderPrefixFilters

func (x *SXG) GetHeaderPrefixFilters() []string

func (*SXG) GetMiRecordSize

func (x *SXG) GetMiRecordSize() uint64

func (*SXG) GetPrivateKey

func (x *SXG) GetPrivateKey() *v3.SdsSecretConfig

func (*SXG) GetShouldEncodeSxgHeader

func (x *SXG) GetShouldEncodeSxgHeader() string

func (*SXG) GetValidityUrl

func (x *SXG) GetValidityUrl() string

func (*SXG) ProtoMessage

func (*SXG) ProtoMessage()

func (*SXG) ProtoReflect

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

func (*SXG) Reset

func (x *SXG) Reset()

func (*SXG) String

func (x *SXG) String() string

func (*SXG) Validate

func (m *SXG) Validate() error

Validate checks the field values on SXG with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*SXG) ValidateAll

func (m *SXG) ValidateAll() error

ValidateAll checks the field values on SXG with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in SXGMultiError, or nil if none found.

type SXGMultiError

type SXGMultiError []error

SXGMultiError is an error wrapping multiple validation errors returned by SXG.ValidateAll() if the designated constraints aren't met.

func (SXGMultiError) AllErrors

func (m SXGMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (SXGMultiError) Error

func (m SXGMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type SXGValidationError

type SXGValidationError struct {
	// contains filtered or unexported fields
}

SXGValidationError is the validation error returned by SXG.Validate if the designated constraints aren't met.

func (SXGValidationError) Cause

func (e SXGValidationError) Cause() error

Cause function returns cause value.

func (SXGValidationError) Error

func (e SXGValidationError) Error() string

Error satisfies the builtin error interface

func (SXGValidationError) ErrorName

func (e SXGValidationError) ErrorName() string

ErrorName returns error name.

func (SXGValidationError) Field

func (e SXGValidationError) Field() string

Field function returns field value.

func (SXGValidationError) Key

func (e SXGValidationError) Key() bool

Key function returns key value.

func (SXGValidationError) Reason

func (e SXGValidationError) Reason() string

Reason function returns reason value.