security

package
v0.1.25 Latest Latest
Warning

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

 Go to latest Published: Dec 20, 2024 License: MIT Imports: 16 Imported by: 1

Documentation

Overview

Package security implements the functions, types, and interfaces for the module.

Package security implements the functions, types, and interfaces for the module.

Package security implements the functions, types, and interfaces for the module.

Package security implements the functions, types, and interfaces for the module.

Package security implements the functions, types, and interfaces for the module.

Package security implements the functions, types, and interfaces for the module.

Index

Constants

View Source 
const (
	MetadataAuthZ = "x-metadata-security-authz"
	MetadataAuthN = "x-metadata-security-authn"
)
View Source 
const (
	// MetadataSecurityTokenKey is the default token key.
	MetadataSecurityTokenKey = "x-metadata-security-token-key"
	// MetadataSecuritySkipKey is the default skip key.
	MetadataSecuritySkipKey = "x-metadata-security-skip-key"
)
View Source 
const (
	StringBoolTrue  = "true"
	StringBoolFalse = "false"
)
View Source 
const (
	ErrorCreateOptionNil = errors.String("authenticator middleware create failed: option is nil")
)

Variables

View Source 
var (
	ErrInvalidToken          = securityv1.ErrorSecurityErrorReasonBearerTokenMissing("bearer token missing")
	ErrInvalidClaims         = securityv1.ErrorSecurityErrorReasonInvalidClaims("invalid bearer token")
	ErrMissingClaims         = securityv1.ErrorSecurityErrorReasonInvalidClaims("missing scheme")
	ErrMissingToken          = securityv1.ErrorSecurityErrorReasonBearerTokenMissing("bearer token missing")
	ErrInvalidAuthentication = securityv1.ErrorSecurityErrorReasonInvalidAuthentication("unauthenticated")
	ErrInvalidAuthorization  = securityv1.ErrorSecurityErrorReasonInvalidAuthorization("unauthorized")
)

Functions

func ClaimFromTokenTypeContext 

func ClaimFromTokenTypeContext(ctx context.Context, tokenType security.TokenType) (security.Claims, error)

func ClaimsFromContext 

func ClaimsFromContext(ctx context.Context) security.Claims

func FromMetaData 

func FromMetaData(key string) func(ctx context.Context) string

func FromMetaDataKey 

func FromMetaDataKey(ctx context.Context, key string) string

func FromTransportClient 

func FromTransportClient(authorize string, scheme string) func(ctx context.Context) string

func FromTransportServer 

func FromTransportServer(authorize string, scheme string) func(ctx context.Context) string

func IsSkipped 

func IsSkipped(ctx context.Context, key string) bool

func NewAuthN 

func NewAuthN(cfg *configv1.Security, ss ...OptionSetting) (middleware.Middleware, error)

NewAuthN is a server authenticator middleware.

func NewAuthNClient 

func NewAuthNClient(cfg *configv1.Security, ss ...OptionSetting) (middleware.Middleware, error)

NewAuthNClient is a client authenticator middleware.

func NewAuthNServer 

func NewAuthNServer(cfg *configv1.Security, ss ...OptionSetting) (middleware.Middleware, error)

NewAuthNServer is a server authenticator middleware.

func NewAuthZ 

func NewAuthZ(cfg *configv1.Security, ss ...OptionSetting) (middleware.Middleware, error)

NewAuthZ returns a new server middleware.

func NewAuthZClient 

func NewAuthZClient(cfg *configv1.Security, ss ...OptionSetting) (middleware.Middleware, error)

NewAuthZClient returns a new server middleware.

func NewAuthZServer 

func NewAuthZServer(cfg *configv1.Security, ss ...OptionSetting) (middleware.Middleware, error)

NewAuthZServer returns a new server middleware.

func NewClaimsContext 

func NewClaimsContext(ctx context.Context, claims security.Claims) context.Context

func NewSkipContext 

func NewSkipContext(ctx context.Context) context.Context

func NewTokenContext 

func NewTokenContext(ctx context.Context, token string) context.Context

func NewUserClaimsContext 

func NewUserClaimsContext(ctx context.Context, claims security.UserClaims) context.Context

func SkipFromContext 

func SkipFromContext(ctx context.Context) bool

func Skipper 

func Skipper(cfg *configv1.Security, ss ...OptionSetting) (middleware.Middleware, bool)

Skipper returns a middleware that skips certain operations based on the provided configuration. It takes a Security configuration and a variable number of OptionSettings. If the Skipper is not configured, it returns nil and false.

func TokenFromContext 

func TokenFromContext(ctx context.Context) string

func TokenFromTypeContext 

func TokenFromTypeContext(ctx context.Context, tokenType security.TokenType, scheme string) (string, error)

TokenFromTypeContext .

func TokenToTypeContext 

func TokenToTypeContext(ctx context.Context, tokenType security.TokenType, scheme string, token string) context.Context

TokenToTypeContext .

func UserClaimsFromContext 

func UserClaimsFromContext(ctx context.Context) security.UserClaims

func UserClaimsFromMetaData 

func UserClaimsFromMetaData(ctx context.Context, key string) string

func UserClaimsToMetaData 

func UserClaimsToMetaData(ctx context.Context, key string, value string) context.Context

func WithSkipContextClient 

func WithSkipContextClient(ctx context.Context, key string) context.Context

func WithSkipContextServer 

func WithSkipContextServer(ctx context.Context, key string) context.Context

Types

type Option 

type Option struct {
	// Authorizer is the authorizer used to authorize the request.
	Authorizer security.Authorizer
	// Authenticator is the authenticator used to authenticate the request.
	Authenticator security.Authenticator
	// Serializer is the serializer used to serialize the claims.
	Serializer security.Serializer
	// TokenKey is the key used to store the token in the context.
	TokenKey string
	// Scheme is the scheme used for the authorization header.
	Scheme string
	// HeaderAuthorize is the name of the authorization header.
	HeaderAuthorize string
	// SkipKey is the key used to skip authentication.
	SkipKey string
	// PublicPaths are the public paths that do not require authentication.
	PublicPaths []string
	// TokenParser is the parser used to parse the token from the context.
	TokenParser func(ctx context.Context) string
	// Parser is the parser used to parse the user claims.
	Parser security.UserClaimsParser
	// Skipper is the function used to skip authentication.
	Skipper func(string) bool
}

Option is a struct that contains the settings for the security middleware.

func (*Option) ApplyDefaults 

func (o *Option) ApplyDefaults()

ApplyDefaults applies the default settings to the option.

func (*Option) ParserUserClaims 

func (o *Option) ParserUserClaims(ctx context.Context, claims security.Claims) (security.UserClaims, error)

ParserUserClaims parses the user claims from the context.

func (*Option) WithConfig 

func (o *Option) WithConfig(cfg *configv1.Security) *Option

WithConfig applies the configuration to the option.

type OptionSetting 

type OptionSetting = func(option *Option)

OptionSetting is a function that sets an option.

func WithAuthenticator 

func WithAuthenticator(authenticator security.Authenticator) OptionSetting

WithAuthenticator sets the authenticator.

func WithAuthorizer 

func WithAuthorizer(authorizer security.Authorizer) OptionSetting

WithAuthorizer sets the authorizer.

func WithConfig 

func WithConfig(cfg *configv1.Security) OptionSetting

WithConfig sets the configuration.

func WithSkipKey 

func WithSkipKey(key string) OptionSetting

WithSkipKey sets the skip key.

func WithSkipper 

func WithSkipper(paths ...string) OptionSetting

WithSkipper sets the public paths.

func WithTokenKey 

func WithTokenKey(key string) OptionSetting

WithTokenKey sets the token key.

func WithTokenParser 

func WithTokenParser(parser func(ctx context.Context) string) OptionSetting

WithTokenParser sets the token parser.

type ResponseWriter 

type ResponseWriter func(context.Context, security.Claims) (string, error)

ResponseWriter is a function that writes a response to the http.ResponseWriter.

type TokenParser 

type TokenParser func(context.Context, string) (security.Claims, error)

TokenParser is a function that parses a token from the context.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.