auth

Documentation

Index

• Constants
• Variables
• func GetDisableDoubleEncoding(ctx context.Context) (value bool, ok bool)
• func SetDisableDoubleEncoding(ctx context.Context, value bool) context.Context
• type AuthenticationScheme
  • func GetAuthenticationSchemes(p *smithy.Properties) ([]AuthenticationScheme, error)
• type AuthenticationSchemeNone
• type AuthenticationSchemeV4
• type AuthenticationSchemeV4A
• type HTTPAuthScheme
  • func NewHTTPAuthScheme(schemeID string, signer smithyhttp.Signer) *HTTPAuthScheme
  • func (s *HTTPAuthScheme) IdentityResolver(o auth.IdentityResolverOptions) auth.IdentityResolver
  • func (s *HTTPAuthScheme) SchemeID() string
  • func (s *HTTPAuthScheme) Signer() smithyhttp.Signer
  • func (s *HTTPAuthScheme) WithSigner(signer smithyhttp.Signer) *HTTPAuthScheme
• type NoAuthenticationSchemesFoundError
  • func (e *NoAuthenticationSchemesFoundError) Error() string
• type UnSupportedAuthenticationSchemeSpecifiedError
  • func (e *UnSupportedAuthenticationSchemeSpecifiedError) Error() string

Constants

const None = "none"

None is a constant representing the None Authentication Scheme

const SigV4 = "sigv4"

SigV4 is a constant representing Authentication Scheme Signature Version 4

const SigV4A = "sigv4a"

SigV4A is a constant representing Authentication Scheme Signature Version 4A

const SigV4S3Express = "sigv4-s3express"

SigV4S3Express identifies the S3 S3Express auth scheme.

Variables

var SupportedSchemes = map[string]bool{
	SigV4:          true,
	SigV4A:         true,
	SigV4S3Express: true,
	None:           true,
}

SupportedSchemes is a data structure that indicates the list of supported AWS authentication schemes

Functions

func GetDisableDoubleEncoding

func GetDisableDoubleEncoding(ctx context.Context) (value bool, ok bool)

GetDisableDoubleEncoding retrieves the disable double encoding option from the context.

Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

func SetDisableDoubleEncoding

func SetDisableDoubleEncoding(ctx context.Context, value bool) context.Context

SetDisableDoubleEncoding sets or modifies the disable double encoding option on the context.

Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

Types

type AuthenticationScheme

type AuthenticationScheme interface {
	// contains filtered or unexported methods
}

AuthenticationScheme is a representation of AWS authentication schemes

func GetAuthenticationSchemes

func GetAuthenticationSchemes(p *smithy.Properties) ([]AuthenticationScheme, error)

GetAuthenticationSchemes extracts the relevant authentication scheme data into a custom strongly typed Go data structure.

type AuthenticationSchemeNone

type AuthenticationSchemeNone struct{}

AuthenticationSchemeNone is a representation for the none auth scheme

type AuthenticationSchemeV4

type AuthenticationSchemeV4 struct {
	Name                  string
	SigningName           *string
	SigningRegion         *string
	DisableDoubleEncoding *bool
}

AuthenticationSchemeV4 is a AWS SigV4 representation

type AuthenticationSchemeV4A

type AuthenticationSchemeV4A struct {
	Name                  string
	SigningName           *string
	SigningRegionSet      []string
	DisableDoubleEncoding *bool
}

AuthenticationSchemeV4A is a AWS SigV4A representation

type HTTPAuthScheme

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

HTTPAuthScheme is the SDK's internal implementation of smithyhttp.AuthScheme for pre-existing implementations where the signer was added to client config. SDK clients will key off of this type and ensure per-operation updates to those signers persist on the scheme itself.

func NewHTTPAuthScheme

func NewHTTPAuthScheme(schemeID string, signer smithyhttp.Signer) *HTTPAuthScheme

NewHTTPAuthScheme returns an auth scheme instance with the given config.

func (*HTTPAuthScheme) IdentityResolver

func (s *HTTPAuthScheme) IdentityResolver(o auth.IdentityResolverOptions) auth.IdentityResolver

IdentityResolver gets the identity resolver for the auth scheme.

func (*HTTPAuthScheme) SchemeID

func (s *HTTPAuthScheme) SchemeID() string

SchemeID identifies the auth scheme.

func (*HTTPAuthScheme) Signer

func (s *HTTPAuthScheme) Signer() smithyhttp.Signer

Signer gets the signer for the auth scheme.

func (*HTTPAuthScheme) WithSigner

func (s *HTTPAuthScheme) WithSigner(signer smithyhttp.Signer) *HTTPAuthScheme

WithSigner returns a new instance of the auth scheme with the updated signer.

type NoAuthenticationSchemesFoundError

type NoAuthenticationSchemesFoundError struct{}

NoAuthenticationSchemesFoundError is used in signaling that no authentication schemes have been specified.

func (*NoAuthenticationSchemesFoundError) Error

func (e *NoAuthenticationSchemesFoundError) Error() string

type UnSupportedAuthenticationSchemeSpecifiedError

type UnSupportedAuthenticationSchemeSpecifiedError struct {
	UnsupportedSchemes []string
}

UnSupportedAuthenticationSchemeSpecifiedError is used in signaling that only unsupported authentication schemes were specified.

func (*UnSupportedAuthenticationSchemeSpecifiedError) Error

func (e *UnSupportedAuthenticationSchemeSpecifiedError) Error() string