security

Apr 21, 2025

Changes in this version

type ExtraData

+ func Claims2Extra(claims Claims, ext map[string]string) ExtraData

+ func Policy2Extra(policy Policy, ext map[string]string) ExtraData

+ func WithExtraData(ext map[string]string) ExtraData

Jan 2, 2025

Changes in this version

type RefreshTokenizer

+ CreateRefreshToken func(context.Context, Claims) (string, error)

+ DestroyRefreshToken func(context.Context, string) error

+ ValidateRefreshToken func(context.Context, string) (bool, error)

type RegisteredPolicy

+ Permission []string

Dec 25, 2024

Changes in this version

+ type TokenService interface

+ Close func(context.Context) error

+ Remove func(context.Context, string) error

+ Store func(context.Context, string, time.Duration) error

+ Validate func(context.Context, string) (bool, error)

+ func DefaultTokenService(ss ...StorageSetting) TokenService

Dec 19, 2024

Changes in this version

type UserClaims

+ IsRoot func() bool

Dec 16, 2024

Changes in this version

type Authenticator

+ CreateRefreshToken func(context.Context, Claims) (string, error)

+ CreateRefreshTokenContext func(context.Context, TokenType, Claims) (context.Context, error)

Dec 13, 2024

Changes in this version

type Authenticator

+ CreateIdentityClaimsContext func(context.Context, TokenType, string) (context.Context, error)

+ VerifyContext func(context.Context, TokenType) (bool, error)

Dec 13, 2024

Changes in this version

type Policy

+ Action string

+ Domain []string

+ Extra map[string]string

+ Object string

+ Subject string

type UserClaimsParser

+ Parse func(ctx context.Context, id string) (UserClaims, error)

Dec 10, 2024

Changes in this version

+ const TokenCacheNS

+ func NewMapCache() cache.Cache

+ type TokenCacheService interface

+ Close func(context.Context) error

+ Remove func(context.Context, string) error

+ Store func(context.Context, string, time.Duration) error

+ Validate func(context.Context, string) (bool, error)

+ func DefaultTokenCacheService(ss ...StorageSetting) TokenCacheService

type TokenType

+ const ContentTypeMetadata

Dec 10, 2024

Changes in this version

type TokenType

+ const ContextTypeHeader

Dec 9, 2024

Changes in this version

+ func FromToken(ctx context.Context) string

+ func NewToken(ctx context.Context, token string) context.Context

Dec 9, 2024

Changes in this version

type Authenticator

+ AuthenticateToken func(string) (Claims, error)

+ AuthenticateTokenContext func(context.Context, ContextType) (Claims, error)

+ Close func()

+ CreateTokenContext func(context.Context, ContextType, Claims) (context.Context, error)

+ DestroyTokenContext func(context.Context, ContextType, string) error

+ type ContextType string

type Policy

+ GetExtra func() map[string]string

+ type PolicyChecker interface

+ CheckPolicy func(Policy) bool

+ CheckPolicyContext func(context.Context, ContextType, Policy) bool

type PolicyManager

+ GetPolicy func(subject string, object string, action string, domain []string, ...) Policy

+ SetPolicy func(subject string, object string, action string, domain []string, ...)

Nov 25, 2024

Changes in this version

+ func NewSecurityCache() cache.Cache

Sep 29, 2024

Changes in this version

+ const ErrInvalidToken

+ const ErrNotFound

+ const TokenNamespace

type Claims

+ Audience []string

+ Custom map[string]interface{}

+ ExpiresAt int64

+ ID string

+ IssuedAt int64

+ Issuer string

+ NotBefore int64

+ Subject string

+ type Decoder interface

+ Decode func(string) (string, bool)

+ type Encoder interface

+ Encode func(args ...any) (string, error)

type Security

+ func NewSecurity(serializer TokenSerializer, ss ...Setting) Security

+ DestroyToken func(ctx context.Context, tokenStr string) error

+ GenerateToken func(ctx context.Context, subject string) (Token, error)

+ ParseSubject func(ctx context.Context, tokenStr string) (string, error)

+ Release func(ctx context.Context) error

+ ValidateAccess func(ctx context.Context, tokenStr string) error

+ type Setting = settings.Setting[security]

+ func WithStorage(store TokenStorage) Setting

+ type StorageOption struct

+ Cache cache.Cache

+ Namespace string

type StorageSetting

+ func WithNamespace(ns string) StorageSetting

type Token

+ Claims *Claims

+ ExpiresIn int64

+ Expiry time.Time

+ RefreshToken string

+ func (t Token) Encode(args ...any) (string, error)

+ type TokenStorage interface

+ Close func(ctx context.Context) error

+ Delete func(ctx context.Context, tokenStr string) error

+ Set func(ctx context.Context, tokenStr string, expiration time.Duration) error

+ Validate func(ctx context.Context, tokenStr string) error

+ func NewTokenStorage(ss ...StorageSetting) TokenStorage

Aug 21, 2024

Changes in this version

+ func BasicAuth(userid, password string) (string, error)

+ func ErrAuthType(t TokenType) error

+ func RFC7617UserPass(userid, password string) (string, error)

type Scheme

+ Credentials string

+ Type TokenType

+ func ParseScheme(token string) Scheme

+ type Token interface

+ AccessToken func() string

+ Domain func() string

+ ExpiresAt func() int64

+ Others func() map[string]any

+ Subject func() string

+ TokenType func() TokenType

+ type TokenSerializer interface

+ Generate func(subject string) Token

+ Parse func(token string) (Token, error)

type TokenType

+ const AWS4HMACSHA256Token

+ const AnonymousToken

+ const BasicToken

+ const BearerToken

+ const DPoPToken

+ const DigestToken

+ const GNAPToken

+ const HOBAToken

+ const InvalidToken

+ const MutualToken

+ const NTLMToken

+ const NegotiateToken

+ const OAuthToken

+ const PrivateTokenToken

+ const SCRAMSHA1Token

+ const SCRAMSHA256Token

+ const SCRAMToken

+ const VAPIDToken

Mar 28, 2025

Changes in this version

+ func NewPolicyContext(ctx context.Context, policy Policy) context.Context

+ type Auditor interface

+ LogAuthEvent func(ctx context.Context, event AuditorEvent) error

+ type AuditorEvent struct

+ Action string

+ ClientIP string

+ Object string

+ Subject string

+ Success bool

+ Timestamp time.Time

+ UserAgent string

type Authenticator

+ AuthenticateContext func(context.Context, TokenSource) (Claims, error)

+ DestroyRefreshToken func(context.Context, string) error

+ DestroyToken func(context.Context, string) error

type Authorizer

+ AuthorizedWithDomain func(ctx context.Context, policy Policy, object string, action string, ...) (bool, error)

+ AuthorizedWithExtra func(ctx context.Context, data ExtraData) (bool, error)

type Claims

+ func ClaimsWithExtra(claims Claims, ext map[string]string) Claims

+ GetID func() string

+ type Extra interface

+ Get func(key string) (string, bool)

+ GetExtra func() map[string]string

+ Set func(key string, value string)

+ func ExtraObject(extra any) (Extra, bool)

+ type ExtraClaims struct

+ Claims Claims

+ Extra Extra

+ func (e ExtraClaims) Get(key string) (string, bool)

+ func (e ExtraClaims) GetAudience() []string

+ func (e ExtraClaims) GetExpiration() int64

+ func (e ExtraClaims) GetExtra() map[string]string

+ func (e ExtraClaims) GetID() string

+ func (e ExtraClaims) GetIssuedAt() int64

+ func (e ExtraClaims) GetIssuer() string

+ func (e ExtraClaims) GetNotBefore() int64

+ func (e ExtraClaims) GetScopes() map[string]bool

+ func (e ExtraClaims) GetSubject() string

+ func (e ExtraClaims) Set(key string, value string)

+ type ExtraData interface

+ GetClaims func() (Claims, bool)

+ GetPolicy func() (Policy, bool)

+ HasClaims func() bool

+ HasPolicy func() bool

+ func DataWithExtra(claims Claims, policy Policy, ext map[string]string) ExtraData

+ type ExtraPolicy struct

+ Extra Extra

+ Policy Policy

+ func (e ExtraPolicy) Get(key string) (string, bool)

+ func (e ExtraPolicy) GetAction() string

+ func (e ExtraPolicy) GetDomain() string

+ func (e ExtraPolicy) GetExtra() map[string]string

+ func (e ExtraPolicy) GetObject() string

+ func (e ExtraPolicy) GetPermissions() []string

+ func (e ExtraPolicy) GetRoles() []string

+ func (e ExtraPolicy) GetSubject() string

+ func (e ExtraPolicy) Set(key string, value string)

+ type Policy interface

+ GetAction func() string

+ GetDomain func() string

+ GetObject func() string

+ GetPermissions func() []string

+ GetRoles func() []string

+ GetSubject func() string

+ func PolicyFromContext(ctx context.Context) Policy

+ func PolicyWithExtra(policy Policy, ext map[string]string) Policy

+ type PolicyMap map[string]any

+ type PolicyParser func(ctx context.Context, claims Claims) (Policy, error)

+ type PolicyRegistry interface

+ AddPolicy func(sec string, pt string, rule []string) error

+ RemovePolicy func(sec string, pt string, rule []string) error

+ SetPolicies func(ctx context.Context, policies PolicyMap) error

+ SetPolicyRoles func(ctx context.Context, policies PolicyMap, roles RoleMap) error

+ SetRoles func(ctx context.Context, roles RoleMap) error

+ type RefreshTokenizer interface

+ CreateRefreshClaims func(context.Context, string) (Claims, error)

+ type RegisteredClaims struct

+ Audience []string

+ Expiration int64

+ ID string

+ IssuedAt int64

+ Issuer string

+ NotBefore int64

+ Scopes map[string]bool

+ Subject string

+ func (r RegisteredClaims) GetAudience() []string

+ func (r RegisteredClaims) GetExpiration() int64

+ func (r RegisteredClaims) GetID() string

+ func (r RegisteredClaims) GetIssuedAt() int64

+ func (r RegisteredClaims) GetIssuer() string

+ func (r RegisteredClaims) GetNotBefore() int64

+ func (r RegisteredClaims) GetScopes() map[string]bool

+ func (r RegisteredClaims) GetSubject() string

+ type RegisteredPolicy struct

+ Action string

+ Domain string

+ Object string

+ Permissions []string

+ Roles []string

+ Subject string

+ func (r RegisteredPolicy) GetAction() string

+ func (r RegisteredPolicy) GetDomain() string

+ func (r RegisteredPolicy) GetObject() string

+ func (r RegisteredPolicy) GetPermissions() []string

+ func (r RegisteredPolicy) GetRoles() []string

+ func (r RegisteredPolicy) GetSubject() string

+ type RoleMap map[string]any

+ type Security interface

+ type TokenSource int

+ const TokenSourceClientHeader

+ const TokenSourceContext

+ const TokenSourceCookie

+ const TokenSourceForm

+ const TokenSourceHeader

+ const TokenSourceMetadata

+ const TokenSourceMetadataClient

+ const TokenSourceMetadataServer

+ const TokenSourceQueryParameter

+ const TokenSourceRequestBody

+ const TokenSourceServerHeader

+ const TokenSourceSession

+ const TokenSourceURLParameter

+ const TokenSourceUnknown

+ func (i TokenSource) String() string

type Tokenizer

+ CreateClaims func(context.Context, string) (Claims, error)

+ ParseClaims func(context.Context, string) (Claims, error)

+ Validate func(context.Context, string) (bool, error)

type UnimplementedClaims

+ func (u UnimplementedClaims) GetID() string

+ type UnimplementedPolicy struct

+ func (u UnimplementedPolicy) GetAction() string

+ func (u UnimplementedPolicy) GetDomain() string

+ func (u UnimplementedPolicy) GetObject() string

+ func (u UnimplementedPolicy) GetPermissions() []string

+ func (u UnimplementedPolicy) GetRoles() []string

+ func (u UnimplementedPolicy) GetSubject() string

Dec 30, 2024

Changes in this version

+ const HeaderAuthorize

+ const HeaderContentLength

+ const HeaderContentType

+ const HeaderOrigin

+ const HeaderReferer

+ const HeaderUserAgent

+ const SchemeNTLM

+ const TokenCacheAccess

+ const TokenCacheRefresh

+ func ContextIsRoot(ctx context.Context) bool

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

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

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

+ func TokenFromContext(ctx context.Context) string

+ func WithRootContext(ctx context.Context) context.Context

+ type Authenticator interface

+ Authenticate func(context.Context, string) (Claims, error)

+ CreateIdentityClaims func(context.Context, string, bool) (Claims, error)

+ CreateToken func(context.Context, Claims) (string, error)

+ Verify func(context.Context, string) (bool, error)

+ type Authorizer interface

+ Authorized func(ctx context.Context, claims UserClaims) (bool, error)

+ SetPolicies func(ctx context.Context, policies map[string]any, roles map[string]any) error

+ type CacheStorage interface

+ Close func(context.Context) error

+ Exist func(context.Context, string) (bool, error)

+ Remove func(context.Context, string) error

+ Store func(context.Context, string, time.Duration) error

+ func NewCacheStorage(ss ...StorageSetting) CacheStorage

+ type Claims interface

+ GetAudience func() []string

+ GetExpiration func() time.Time

+ GetExtra func() map[string]string

+ GetIssuedAt func() time.Time

+ GetIssuer func() string

+ GetJWTID func() string

+ GetNotBefore func() time.Time

+ GetScopes func() map[string]bool

+ GetSubject func() string

+ func ClaimsFromContext(ctx context.Context) Claims

+ type PolicyManager interface

+ AddPolicy func(sec string, pt string, rule []string) error

+ RemovePolicy func(sec string, pt string, rule []string) error

+ SetPolicies func(context.Context, map[string]any) error

+ type Scheme int

+ const SchemeAWS4HMAC256

+ const SchemeAnonymous

+ const SchemeBasic

+ const SchemeBearer

+ const SchemeDPoP

+ const SchemeDigest

+ const SchemeGNAP

+ const SchemeHOBA

+ const SchemeMax

+ const SchemeMutual

+ const SchemeNegotiate

+ const SchemeOAuth

+ const SchemePrivate

+ const SchemeSCRAM

+ const SchemeUnknown

+ const SchemeVapid

+ func (i Scheme) String() string

+ func (t Scheme) Equal(other string) bool

+ func (t Scheme) Lower() string

+ type Serializer interface

+ Deserialize func(ctx context.Context, data []byte) (Claims, error)

+ Serialize func(ctx context.Context, data Claims) ([]byte, error)

+ type StorageSetting = func(*cacheStorage)

+ func WithCache(c cache.Cache) StorageSetting

+ type TokenType int

+ const ContextTypeBody

+ const ContextTypeClientHeader

+ const ContextTypeContext

+ const ContextTypeCookie

+ const ContextTypeForm

+ const ContextTypeMetadata

+ const ContextTypeMetadataClient

+ const ContextTypeParam

+ const ContextTypeQuery

+ const ContextTypeServerHeader

+ const ContextTypeSession

+ const ContextTypeUnknown

+ func (i TokenType) String() string

+ type Tokenizer interface

+ Authenticate func(context.Context, string) (Claims, error)

+ AuthenticateContext func(context.Context, TokenType) (Claims, error)

+ Close func(context.Context) error

+ CreateIdentityClaims func(context.Context, string, bool) (Claims, error)

+ CreateIdentityClaimsContext func(context.Context, TokenType, string) (context.Context, error)

+ CreateToken func(context.Context, Claims) (string, error)

+ CreateTokenContext func(context.Context, TokenType, Claims) (context.Context, error)

+ DestroyToken func(context.Context, string) error

+ DestroyTokenContext func(context.Context, TokenType) error

+ Verify func(context.Context, string) (bool, error)

+ VerifyContext func(context.Context, TokenType) (bool, error)

+ type UnimplementedClaims struct

+ func (u UnimplementedClaims) GetAudience() []string

+ func (u UnimplementedClaims) GetExpiration() time.Time

+ func (u UnimplementedClaims) GetExtra() map[string]string

+ func (u UnimplementedClaims) GetIssuedAt() time.Time

+ func (u UnimplementedClaims) GetIssuer() string

+ func (u UnimplementedClaims) GetJWTID() string

+ func (u UnimplementedClaims) GetJwtID() string

+ func (u UnimplementedClaims) GetNotBefore() time.Time

+ func (u UnimplementedClaims) GetScopes() map[string]bool

+ func (u UnimplementedClaims) GetSubject() string

+ type UnimplementedUserClaims struct

+ func (u UnimplementedUserClaims) GetAction() string

+ func (u UnimplementedUserClaims) GetClaims() Claims

+ func (u UnimplementedUserClaims) GetDomain() string

+ func (u UnimplementedUserClaims) GetExtra() map[string]string

+ func (u UnimplementedUserClaims) GetObject() string

+ func (u UnimplementedUserClaims) GetSubject() string

+ func (u UnimplementedUserClaims) IsRoot() bool

+ type UserClaims interface

+ GetAction func() string

+ GetClaims func() Claims

+ GetDomain func() string

+ GetExtra func() map[string]string

+ GetObject func() string

+ GetSubject func() string

+ func UserClaimsFromContext(ctx context.Context) UserClaims

+ type UserClaimsParser func(ctx context.Context, claims Claims) (UserClaims, error)