auth

package

Go to main page

Versions in this module

v0

v0.21.6

Sep 3, 2020

v0.21.5

Sep 3, 2020

v0.21.4

Sep 2, 2020

v0.21.3

Sep 2, 2020

Changes in this version

type TokenerOption

+ func TokenerAccount(model Account) TokenerOption

+ func TokenerTimeFunc(tf func() time.Time) TokenerOption

type TokenerOptions

+ Model Account

+ TimeFunc func() time.Time

v0.21.2

Sep 2, 2020

v0.21.1

Sep 2, 2020

v0.21.0

Sep 2, 2020

v0.20.3

Aug 31, 2020

v0.20.2

Aug 31, 2020

v0.20.1

Aug 29, 2020

v0.20.0

Aug 29, 2020

v0.19.1

Aug 27, 2020

v0.19.0

Aug 27, 2020

v0.18.0

Aug 25, 2020

Changes in this version

+ type Audiencer interface

+ Audience func() string

type Claims

+ Subject func() string

+ type Issuer interface

+ Issuer func() string

+ type NotBeforer interface

+ NotBefore func() int64

+ type Salter interface

+ type Scoper interface

+ Scope func() string

type TokenOption

+ func TokenScope(scope string) TokenOption

+ func TokenWithAudience(audience string) TokenOption

+ func TokenWithIssuer(issuer string) TokenOption

+ func TokenWithNotBefore(notBefore time.Time) TokenOption

type TokenOptions

+ Audience string

+ Issuer string

+ NotBefore time.Time

+ Scope string

type TokenerOption

+ func TokenerStore(s store.Store) TokenerOption

v0.17.2

Aug 17, 2020

v0.17.1

Aug 16, 2020

v0.17.0

Aug 16, 2020

Changes in this version

+ var ErrAccountAlreadyExists = errors.Wrap(ErrAuth, "an account with provided username already exists")

+ var ErrAccountModelNotDefined = errors.Wrap(ErrAuth, "account model not defined")

+ var ErrAccountNotValid = errors.Wrap(ErrAuth, "account not valid")

+ var ErrAuth = errors.New("Auth")

+ var ErrInternalError = errors.Wrap(errors.ErrInternal, "auth")

+ var ErrInvalidECDSAKey = errors.Wrap(ErrInitialization, "invalid ECDSA key")

+ var ErrInvalidPassword = errors.Wrap(ErrAuthentication, "provided invalid secret")

+ var ErrInvalidRSAKey = errors.Wrap(ErrInitialization, "invalid RSA key")

+ var ErrInvalidUsername = errors.Wrap(ErrAuthentication, "invalid username")

+ var ErrNoRequiredOption = errors.Wrap(ErrAuthentication, "provided no required option")

+ var ErrRoleAlreadyGranted = errors.Wrap(ErrAuthorization, "role already granter")

+ var ErrTokenNotValidYet = errors.Wrap(ErrToken, "not valid yet")

+ var ErrTokenRevoked = errors.Wrap(ErrToken, "revoked")

+ func CompareHashPassword(h hash.Hash, password string, hashedPassword, salt []byte) (bool, error)

+ func CompareMD5Password(password string, hashedPassword, salt []byte) (bool, error)

+ func CompareSHA256Password(password string, hashedPassword, salt []byte) (bool, error)

+ func CompareSHA512Password(password string, hashedPassword, salt []byte) (bool, error)

+ func CtxWithAccount(ctx context.Context, account Account) context.Context

+ func DefaultPasswordScorer(pw *Password)

+ func DefaultPasswordValidator(p *Password) error

+ func DefaultUsernameValidator(username string) error

+ func GenerateSalt(saltLength int) ([]byte, error)

+ func ParsePemECDSAPrivateKey(key []byte) (*ecdsa.PrivateKey, error)

+ func ParsePemRsaPrivateKey(pemPrivateKey []byte) (*rsa.PrivateKey, error)

+ type AccessClaims interface

+ GetAccount func() Account

+ type Account interface

+ GetPasswordHash func() []byte

+ GetUsername func() string

+ PasswordHashField func() string

+ SetPasswordHash func(hash []byte)

+ SetUsername func(username string)

+ UsernameField func() string

+ func CtxGetAccount(ctx context.Context) (Account, bool)

+ type AuthenticateMethod int

+ const BCrypt

+ const MD5

+ const SHA256

+ const SHA512

type Authenticator

+ ComparePassword func(account Account, password string) error

+ HashAndSetPassword func(account Account, password *Password) error

+ type AuthenticatorOption func(o *AuthenticatorOptions)

+ func AuthenticatorAccountModel(op Account) AuthenticatorOption

+ func AuthenticatorBCryptCost(op int) AuthenticatorOption

+ func AuthenticatorMethod(op AuthenticateMethod) AuthenticatorOption

+ func AuthenticatorSaltLength(op int) AuthenticatorOption

+ func AuthenticatorStore(op store.Store) AuthenticatorOption

+ type AuthenticatorOptions struct

+ AccountModel Account

+ AuthenticateMethod AuthenticateMethod

+ BCryptCost int

+ SaltLength int

+ Store store.Store

+ type Claims interface

+ ExpiresIn func() int64

+ Valid func() error

+ type HierarchicalRole interface

+ HierarchyValue func() int

+ type ListRoleOption func(o *ListRoleOptions)

+ type ListRoleOptions struct

+ Account Account

+ Limit int

+ Offset int

+ SortByHierarchy bool

+ SortOrder query.SortOrder

+ type ListScopeOption func(o *ListScopeOptions)

+ type ListScopeOptions struct

+ Limit int

+ Offset int

+ Role Role

+ type Password struct

+ Lowers int

+ Numbers int

+ Password string

+ Score int

+ Specials int

+ UniqueRunes int

+ Uppers int

+ func NewPassword(password string, scorer ...PasswordScorer) *Password

+ func (p *Password) Hash(h hash.Hash, salt []byte) ([]byte, error)

+ func (p *Password) MD5(salt []byte) (password []byte, err error)

+ func (p *Password) SHA256(salt []byte) ([]byte, error)

+ func (p *Password) SHA512(salt []byte) ([]byte, error)

+ func (p *Password) UniqueRunesRatio() float64

+ type PasswordScorer func(pw *Password)

+ type PasswordValidator func(*Password) error

+ type RefreshClaims interface

+ GetAccountID func() string

+ type RoleScoper interface

+ ClearRoleScopes func(ctx context.Context, roles ...Role) error

+ GrantRoleScope func(ctx context.Context, role Role, scope Scope) error

+ ListRoleScopes func(ctx context.Context, options ...ListScopeOption) ([]Scope, error)

+ RevokeRoleScope func(ctx context.Context, role Role, scope Scope) error

+ type Roler interface

+ ClearRoles func(ctx context.Context, account Account) error

+ FindRoles func(ctx context.Context, options ...ListRoleOption) ([]Role, error)

+ GrantRole func(ctx context.Context, account Account, role Role) error

+ RevokeRole func(ctx context.Context, account Account, role Role) error

+ type SaltFielder interface

+ SaltField func() string

+ type SaltGetter interface

+ GetSalt func() []byte

+ type SaltSetter interface

+ SetSalt func(salt []byte)

+ type SigningMethod interface

+ Alg func() string

+ Sign func(signingString string, key interface{}) (string, error)

+ Verify func(signingString, signature string, key interface{}) error

type Token

+ ExpiresIn int

+ TokenType string

type TokenOption

+ func TokenRefreshExpirationTime(d time.Duration) TokenOption

type TokenOptions

+ RefreshExpirationTime time.Duration

type Tokener

+ RevokeToken func(ctx context.Context, token string) error

+ type TokenerOption func(o *TokenerOptions)

+ func TokenerEcdsaPrivateKey(key *ecdsa.PrivateKey) TokenerOption

+ func TokenerRefreshTokenExpiration(op time.Duration) TokenerOption

+ func TokenerRsaPrivateKey(key *rsa.PrivateKey) TokenerOption

+ func TokenerSecret(secret []byte) TokenerOption

+ func TokenerSigningMethod(op SigningMethod) TokenerOption

+ func TokenerTokenExpiration(op time.Duration) TokenerOption

+ type TokenerOptions struct

+ EcdsaPrivateKey *ecdsa.PrivateKey

+ RefreshTokenExpiration time.Duration

+ RsaPrivateKey *rsa.PrivateKey

+ Secret []byte

+ SigningMethod SigningMethod

+ Store store.Store

+ TokenExpiration time.Duration

+ type UsernameValidator func(username string) error

+ type Verifier interface

+ Verify func(ctx context.Context, account Account, options ...VerifyOption) error

+ type VerifyOption func(o *VerifyOptions)

+ func VerifyAllowedRoles(allowedRoles ...Role) VerifyOption

+ func VerifyDisallowedRoles(disallowedRoles ...Role) VerifyOption

+ func VerifyScopes(scopes ...Scope) VerifyOption

+ type VerifyOptions struct

+ AllowedRoles []Role

+ DisallowedRoles []Role

+ Scopes []Scope

v0.16.1

Aug 9, 2020

Changes in this version

+ var ErrAccountNotFound = errors.Wrap(ErrAuthentication, "account not found")

+ var ErrAuthentication = errors.New("authentication")

+ var ErrAuthenticationNoRequiredOption = errors.Wrap(ErrAuthentication, "provided no required option")

+ var ErrAuthorization = errors.New("authorization")

+ var ErrAuthorizationHeader = errors.Wrap(ErrAuthorization, "invalid or no header")

+ var ErrAuthorizationScope = errors.Wrap(ErrAuthorization, "scope")

+ var ErrForbidden = errors.Wrap(ErrAuthorization, "forbidden access")

+ var ErrInitialization = errors.New("auth initialization failed")

+ var ErrInvalidRole = errors.Wrap(ErrAuthorization, "invalid role")

+ var ErrInvalidSecret = errors.Wrap(ErrAuthentication, "provided invalid secret")

+ var ErrToken = errors.Wrap(ErrAuthorization, "invalid token")

+ var ErrTokenExpired = errors.Wrap(ErrToken, "expired")

v0.16.0

Aug 7, 2020

Changes in this version

+ var ClassAccountNotFound errors.Class

+ var ClassAuthorizationHeader errors.Class

+ var ClassForbidden errors.Class

+ var ClassInitialization errors.Class

+ var ClassInternal errors.Class

+ var ClassInvalidRole errors.Class

+ var ClassInvalidSecret errors.Class

+ var ClassInvalidToken errors.Class

+ var ClassNoRequiredOption errors.Class

+ var ClassScope errors.Class

+ var ClassTokenExpired errors.Class

+ var MjrAuthorization errors.Major

+ var MnrToken errors.Minor

+ func CtxAccountID(ctx context.Context) interface

+ func CtxWithAccountID(ctx context.Context, accountID interface{}) context.Context

+ type Authenticator interface

+ Authenticate func(ctx context.Context, username, password string) (accountID interface{}, err error)

+ type Authorizer interface

+ Authorize func(ctx context.Context, accountID interface{}, scopes ...string) error

+ type Option func(o *Options)

+ type Options struct

+ PasswordCost int

+ PrivateKey string

+ PublicKey string

+ RefreshTokenExpiration time.Duration

+ Secret string

+ TokenExpiration time.Duration

+ type Role interface

+ RoleName func() string

+ type RoleAuthorizer interface

+ AddRole func(ctx context.Context, db database.DB, accountID interface{}, role string) error

+ ClearRoles func(ctx context.Context, db database.DB, accountID interface{}) error

+ CreateRole func(ctx context.Context, role, description string) (Role, error)

+ DeleteRole func(ctx context.Context, role string) error

+ FindRoles func(ctx context.Context, options ...RoleFindOption) (roles []Role, err error)

+ GetRoles func(ctx context.Context, accountID interface{}) (roles []Role, err error)

+ GrantRole func(ctx context.Context, db database.DB, role, scope string) error

+ RemoveRole func(ctx context.Context, db database.DB, accountID interface{}, role string) error

+ RevokeRole func(ctx context.Context, db database.DB, role, scope string) error

+ SetRoles func(ctx context.Context, db database.DB, accountID interface{}, roles ...string) error

+ type RoleFindOption func(o *RoleFindOptions)

+ func RolesWithAccountIDs(accountIDs ...interface{}) RoleFindOption

+ func RolesWithScopes(scopes ...string) RoleFindOption

+ type RoleFindOptions struct

+ AccountIDs []interface{}

+ Scopes []string

+ type Scope interface

+ ScopeName func() string

+ type ScopeCollection interface

+ CreateScope func(ctx context.Context, db database.DB, scope, description string) (Scope, error)

+ DeleteScope func(ctx context.Context, db database.DB, scope string) error

+ GetScope func(ctx context.Context, db database.DB, scope string) (Scope, error)

+ type Token struct

+ AccessToken string

+ RefreshToken string

+ type TokenOption func(o *TokenOptions)

+ func TokenAccountID(id interface{}) TokenOption

+ func TokenExpirationTime(d time.Duration) TokenOption

+ func TokenRefreshToken(refresh string) TokenOption

+ type TokenOptions struct

+ AccountID interface{}

+ ExpirationTime time.Duration

+ RefreshToken string

+ type Tokener interface

+ InspectToken func(token string) (claims interface{}, err error)

+ RefreshToken func(ctx context.Context, refreshToken string) (Token, error)

+ Token func(ctx context.Context, options ...TokenOption) (Token, error)

+ type TwoFactorAuthenticator interface

+ GenerateTwoFactorAuth func(accountID interface{}) (secret string, err error)

+ HasTwoFactorAuth func(accountID interface{}) (bool, error)

+ TwoFactorCreate func(accountID interface{}) (err error)

+ TwoFactorVerify func(accountID interface{}, code string) error

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