auth

package module

Go to main page

Versions in this module

v0

v0.3.2

Oct 31, 2025

v0.3.2-beta

Oct 29, 2025

v0.3.1

Mar 21, 2025

Changes in this version

type AccountManager

+ func (am *AccountManager) SignInByEmailAndPasswordWithExtraFields(email string, password string, extraFields map[string]any) (*Account, error)

+ func (am *AccountManager) SignInByPhoneAndPasswordWithExtraFields(phoneCode int, phoneNumber string, password string, extraFields map[string]any) (*Account, error)

type AuthProvider

+ SignInByEmailAndPasswordWithExtraFields func(email string, password string, extraFields map[string]any) (*Account, error)

+ SignInByPhoneAndPasswordWithExtraFields func(phoneCode int, phoneNumber string, password string, extraFields map[string]any) (*Account, error)

type FirebaseAuth

+ func (fa *FirebaseAuth) SignInByEmailAndPasswordWithExtraFields(email string, password string, extraFields map[string]any) (*Account, error)

+ func (fa *FirebaseAuth) SignInByPhoneAndPasswordWithExtraFields(phoneCode int, phoneNumber string, password string, extraFields map[string]any) (*Account, error)

type JWTAuth

+ func (ja *JWTAuth) SignInByEmailAndPasswordWithExtraFields(email string, password string, extraFields map[string]any) (*Account, error)

+ func (ja *JWTAuth) SignInByPhoneAndPasswordWithExtraFields(phoneCode int, phoneNumber string, password string, extraFields map[string]any) (*Account, error)

v0.3.1-beta

Mar 21, 2025

v0.3.0

Jul 14, 2024

Changes in this version

+ const XCoreAPIKey

+ const XHasuraAcceptLanguage

+ const XHasuraAvatarURL

+ const XHasuraFirstName

+ const XHasuraGroupIDs

+ const XHasuraLastName

+ const XHasuraPermissions

+ const XHasuraPhoneCode

+ const XHasuraPhoneNumber

+ func GetRequestIP(r *http.Request) string

+ func GetRequestIpFromHeader(r http.Header) string

type AccountManager

+ func (am *AccountManager) GetAnonymousRole() string

type AuthScope

+ const ScopeRole

+ type Role string

+ const RoleBackend

+ const RoleCustomer

+ const RoleModerator

+ const RoleUser

v0.2.6

Dec 25, 2023

v0.2.5

Dec 22, 2023

v0.2.4

Dec 22, 2023

v0.2.3

Dec 21, 2023

Changes in this version

type AccountManagerConfig

+ Logger *zerolog.Logger

v0.2.2

Dec 16, 2023

Changes in this version

type AccountManagerConfig

+ AutoLinkProvider bool

v0.2.1

Dec 6, 2023

v0.2.0

Oct 3, 2023

Changes in this version

+ const ActivityLogin

+ const ActivityLoginFailure

+ const ActivityLogout

+ const ActivityOTP

+ const ActivityOTP2FA

+ const ActivityOTP2FASuccess

+ const ActivityOTPFailure

+ const Auth2FASms

+ const AuthBearer

+ const AuthFirebase

+ const AuthJWT

+ const AuthorizationHeader

+ const ErrCodeAPIKeyExpired

+ const ErrCodeAPIKeyInvalidFQDN

+ const ErrCodeAPIKeyInvalidIP

+ const ErrCodeAPIKeyNotFound

+ const ErrCodeAPIKeyRequired

+ const ErrCodeAccountDisabled

+ const ErrCodeAccountExisted

+ const ErrCodeAccountInsertZero

+ const ErrCodeAccountNoProvider

+ const ErrCodeAccountNotAnonymous

+ const ErrCodeAccountNotFound

+ const ErrCodeAccountProviderInsertZero

+ const ErrCodeAccountTemporarilyLocked

+ const ErrCodeCurrentPasswordNotMatch

+ const ErrCodeCurrentPasswordRequired

+ const ErrCodeEmailRequired

+ const ErrCodeInvalidAuthProvider

+ const ErrCodeInvalidOTP

+ const ErrCodeInvalidPhone

+ const ErrCodeJWTInvalidIssuer

+ const ErrCodeNewPasswordEqualCurrentPassword

+ const ErrCodeNewPasswordRequired

+ const ErrCodeOTPAlreadySent

+ const ErrCodePasswordNotMatch

+ const ErrCodePasswordRequired

+ const ErrCodePhoneNotRegistered

+ const ErrCodePhoneRequired

+ const ErrCodeRefreshTokenAudienceMismatched

+ const ErrCodeTokenAudienceMismatched

+ const ErrCodeTokenExpired

+ const ErrCodeTokenMismatched

+ const ErrCodeUnsupported

+ const ErrCodeUpdatePasswordNonExistentAccount

+ const ErrCodeUpdateProviderNonExistentAccount

+ const HasuraClaims

+ const OTPTestCodeName

+ const XHasuraAllowedRoles

+ const XHasuraDefaultRole

+ const XHasuraDisplayName

+ const XHasuraLatitude

+ const XHasuraLongitude

+ const XHasuraRequestIP

+ const XHasuraUserEmail

+ const XHasuraUserID

+ type APIKey struct

+ AllowedFQDN []string

+ AllowedIPs []string

+ ExpiredAt time.Time

+ HasuraRoles []string

+ ID string

+ PermissionID string

+ Type string

+ type APIKeys []APIKey

+ func (ak APIKeys) Get() []APIKey

+ type APIKeysGetter interface

+ Get func() []APIKey

+ type AccessToken struct

+ AccessToken string

+ ExpiresIn int

+ RefreshToken string

+ Scope string

+ TokenType string

+ type AccessTokenOption interface

+ Type func() string

+ Value func() interface{}

+ func NewTokenClaims(claims map[string]interface{}) AccessTokenOption

+ type Account struct

+ AccountProviders []AccountProvider

+ Password string

+ type AccountManager struct

+ func NewAccountManager(config AccountManagerConfig) (*AccountManager, error)

+ func (am *AccountManager) ChangeAllProvidersPassword(providers []AccountProvider, password string) error

+ func (am *AccountManager) ChangePassword(id string, currentPassword string, newPassword string, isAdmin bool) error

+ func (am *AccountManager) ChangeProviderPassword(uid string, newPassword string) error

+ func (am *AccountManager) CreateAccountWithProvider(input *CreateAccountInput, extraFields map[string]interface{}) (*Account, error)

+ func (am *AccountManager) CreateActivity(sessionVariables map[string]string, accountID string, ...) error

+ func (am *AccountManager) CreateProvider(input AccountProvider) error

+ func (am *AccountManager) CreateProviderAccount(input *CreateAccountInput) (*Account, error)

+ func (am *AccountManager) DeleteUser(id string, softDelete bool) error

+ func (am *AccountManager) DeleteUsers(where map[string]any, softDelete bool) (int, error)

+ func (am *AccountManager) EncodeToken(cred *AccountProvider, scopes []AuthScope, options ...AccessTokenOption) (*AccessToken, error)

+ func (am *AccountManager) FindAccountByEmail(id string) (*Account, error)

+ func (am *AccountManager) FindAccountByID(id string) (*Account, error)

+ func (am *AccountManager) FindAccountByProviderEmail(email string, accountBoolExp map[string]any) (*Account, error)

+ func (am *AccountManager) FindAll(where map[string]interface{}) ([]Account, error)

+ func (am *AccountManager) FindOne(where map[string]interface{}) (*Account, error)

+ func (am *AccountManager) Generate2FaOTP(sessionVariables map[string]string, accountID string, phoneCode int, ...) OTPOutput

+ func (am *AccountManager) GenerateOTP(sessionVariables map[string]string, input GenerateOTPInput) OTPOutput

+ func (am *AccountManager) GetDefaultRole() string

+ func (am *AccountManager) InsertAccount(input map[string]interface{}) (string, error)

+ func (am *AccountManager) PromoteAnonymousUser(accountID string, input *CreateAccountInput) (*Account, error)

+ func (am *AccountManager) RefreshToken(refreshToken string, options ...AccessTokenOption) (*AccessToken, error)

+ func (am *AccountManager) SetCustomClaims(uid string, values map[string]interface{}) error

+ func (am *AccountManager) SetDefaultRole(role string)

+ func (am *AccountManager) SignInWithEmailAndPassword(email string, password string) (*Account, error)

+ func (am *AccountManager) SignInWithPhoneAndPassword(phoneCode int, phoneNumber string, password string) (*Account, error)

+ func (am *AccountManager) Verify2FaOTP(sessionVariables map[string]string, accountID string, otp string, ...) error

+ func (am *AccountManager) VerifyOTP(sessionVariables map[string]string, input VerifyOTPInput) (*Account, error)

+ func (am *AccountManager) VerifyPassword(providerUserID string, password string) error

+ func (am *AccountManager) VerifyRefreshToken(refreshToken string) (*AccountProvider, error)

+ func (am *AccountManager) VerifyToken(token string, accountBoolExp map[string]any, extraFields map[string]any) (*Account, map[string]interface{}, error)

+ func (am AccountManager) As(providerType AuthProviderType) *AccountManager

+ func (am AccountManager) GetProviderName() AuthProviderType

+ type AccountManagerConfig struct

+ CreateFromToken bool

+ DefaultProvider AuthProviderType

+ DefaultRole string

+ DefaultRoleAnonymous string

+ Enabled2FA bool

+ FirebaseApp *firebase.App

+ GQLClient *gql.Client

+ JWT *JWTAuthConfig

+ OTP AuthOTPConfig

+ type AccountProvider struct

+ AccountID *string

+ Metadata map[string]any

+ Name string

+ ProviderUserID string

+ type ActivityType string

+ type ApiKeyAuth struct

+ func NewAPIKeyAuth(client *gql.Client) *ApiKeyAuth

+ func (ak *ApiKeyAuth) Verify(apiKey string, headers http.Header) (*APIKey, error)

+ func (ak *ApiKeyAuth) VerifyCustomKey(input APIKeysGetter, apiKey string, headers http.Header) (*APIKey, error)

+ type Auth2FAType string

+ type AuthOTPConfig struct

+ DevMode bool

+ DevOTPCode string

+ Enabled bool

+ LoginDisableLimit uint

+ LoginLimit uint

+ LoginLockDuration time.Duration

+ OTPLength uint

+ TTL time.Duration

+ type AuthProvider interface

+ ChangePassword func(uid string, newPassword string) error

+ CreateUser func(*CreateAccountInput) (*Account, error)

+ DeleteUser func(id string) error

+ EncodeToken func(cred *AccountProvider, scopes []AuthScope, options ...AccessTokenOption) (*AccessToken, error)

+ GetName func() AuthProviderType

+ GetOrCreateUserByPhone func(*CreateAccountInput) (*Account, error)

+ GetUserByEmail func(email string) (*Account, error)

+ GetUserByID func(id string) (*Account, error)

+ PromoteAnonymousUser func(string, *CreateAccountInput) (*Account, error)

+ RefreshToken func(refreshToken string, options ...AccessTokenOption) (*AccessToken, error)

+ SetCustomClaims func(uid string, input map[string]interface{}) error

+ SignInWithEmailAndPassword func(email string, password string) (*Account, error)

+ SignInWithPhoneAndPassword func(phoneCode int, phoneNumber string, password string) (*Account, error)

+ UpdateUser func(string, UpdateAccountInput) (*Account, error)

+ VerifyPassword func(uid string, password string) error

+ VerifyRefreshToken func(refreshToken string) (*AccountProvider, error)

+ VerifyToken func(token string) (*AccountProvider, map[string]interface{}, error)

+ type AuthProviderType string

+ func GetAuthProviderTypes() []AuthProviderType

+ func (apt AuthProviderType) IsValid() bool

+ type AuthScope string

+ const ScopeEmail

+ const ScopeOfflineAccess

+ const ScopeOpenID

+ const ScopeProfile

+ type BaseAccount struct

+ Disabled bool

+ DisplayName string

+ Email string

+ EmailEnabled bool

+ ID string

+ PhoneCode int

+ PhoneEnabled bool

+ PhoneNumber string

+ Role string

+ Verified bool

+ type CreateAccountInput struct

+ AuthProviderType *AuthProviderType

+ DisplayName *string

+ Email *string

+ EmailEnabled *bool

+ ID *string

+ Password *string

+ PhoneCode *int

+ PhoneEnabled *bool

+ PhoneNumber *string

+ Role *string

+ Verified *bool

+ func (cai CreateAccountInput) ToBaseAccount() BaseAccount

+ type CreateUserOutput struct

+ ID string

+ type FirebaseAuth struct

+ func NewFirebaseAuth(app *firebase.App) *FirebaseAuth

+ func (fa *FirebaseAuth) ChangePassword(uid string, newPassword string) error

+ func (fa *FirebaseAuth) CreateUser(input *CreateAccountInput) (*Account, error)

+ func (fa *FirebaseAuth) DeleteUser(uid string) error

+ func (fa *FirebaseAuth) EncodeToken(cred *AccountProvider, scopes []AuthScope, options ...AccessTokenOption) (*AccessToken, error)

+ func (fa *FirebaseAuth) GetOrCreateUserByPhone(input *CreateAccountInput) (*Account, error)

+ func (fa *FirebaseAuth) GetUserByEmail(email string) (*Account, error)

+ func (fa *FirebaseAuth) GetUserByID(id string) (*Account, error)

+ func (fa *FirebaseAuth) PromoteAnonymousUser(uid string, input *CreateAccountInput) (*Account, error)

+ func (fa *FirebaseAuth) RefreshToken(refreshToken string, options ...AccessTokenOption) (*AccessToken, error)

+ func (fa *FirebaseAuth) SetCustomClaims(uid string, input map[string]interface{}) error

+ func (fa *FirebaseAuth) SignInWithEmailAndPassword(email string, password string) (*Account, error)

+ func (fa *FirebaseAuth) SignInWithPhoneAndPassword(phoneCode int, phoneNumber string, password string) (*Account, error)

+ func (fa *FirebaseAuth) UpdateUser(uid string, input UpdateAccountInput) (*Account, error)

+ func (fa *FirebaseAuth) VerifyPassword(providerUserId string, password string) error

+ func (fa *FirebaseAuth) VerifyRefreshToken(refreshToken string) (*AccountProvider, error)

+ func (fa *FirebaseAuth) VerifyToken(token string) (*AccountProvider, map[string]interface{}, error)

+ func (fa FirebaseAuth) GetName() AuthProviderType

+ type GenerateOTPInput struct

+ ExtraConditions map[string]any

+ ExtraInputs map[string]any

+ PhoneCode int

+ PhoneNumber string

+ type GeoPoint struct

+ Coordinates []float64

+ Type string

+ type JWTAuth struct

+ func NewJWTAuth(client *gql.Client, config JWTAuthConfig) *JWTAuth

+ func (ja *JWTAuth) ChangePassword(uid string, newPassword string) error

+ func (ja *JWTAuth) CreateUser(input *CreateAccountInput) (*Account, error)

+ func (ja *JWTAuth) DeleteUser(uid string) error

+ func (ja *JWTAuth) EncodeToken(cred *AccountProvider, scopes []AuthScope, options ...AccessTokenOption) (*AccessToken, error)

+ func (ja *JWTAuth) GetOrCreateUserByPhone(input *CreateAccountInput) (*Account, error)

+ func (ja *JWTAuth) GetUserByEmail(email string) (*Account, error)

+ func (ja *JWTAuth) GetUserByID(id string) (*Account, error)

+ func (ja *JWTAuth) PromoteAnonymousUser(providerID string, input *CreateAccountInput) (*Account, error)

+ func (ja *JWTAuth) RefreshToken(refreshToken string, options ...AccessTokenOption) (*AccessToken, error)

+ func (ja *JWTAuth) SetCustomClaims(uid string, input map[string]interface{}) error

+ func (ja *JWTAuth) SignInWithEmailAndPassword(email string, password string) (*Account, error)

+ func (ja *JWTAuth) SignInWithPhoneAndPassword(phoneCode int, phoneNumber string, password string) (*Account, error)

+ func (ja *JWTAuth) UpdateUser(uid string, input UpdateAccountInput) (*Account, error)

+ func (ja *JWTAuth) VerifyPassword(providerUserId string, password string) error

+ func (ja *JWTAuth) VerifyRefreshToken(refreshToken string) (*AccountProvider, error)

+ func (ja *JWTAuth) VerifyToken(token string) (*AccountProvider, map[string]interface{}, error)

+ func (ja JWTAuth) GetName() AuthProviderType

+ type JWTAuthConfig struct

+ Algorithm string

+ ChecksumLength int

+ Cost int

+ HasChecksum bool

+ Issuer string

+ LoginLimit uint

+ LoginLockDuration time.Duration

+ LoginLockLimit uint

+ RefreshTTL time.Duration

+ SessionKey string

+ TTL time.Duration

+ func (jac JWTAuthConfig) Validate() error

+ type OTPOutput struct

+ AccountID string

+ Code string

+ Error string

+ Expiry time.Time

+ LockedDuration uint

+ type UpdateAccountInput struct

+ Disabled *bool

+ DisplayName *string

+ Email *string

+ EmailEnabled *bool

+ Password *string

+ PhoneCode *int

+ PhoneEnabled *bool

+ PhoneNumber *string

+ Role *string

+ Verified *bool

+ func (uai UpdateAccountInput) GetGraphQLType() string

+ func (uai UpdateAccountInput) ToBaseAccount() BaseAccount

+ type VerifyOTPInput struct

+ ExtraConditions map[string]any

+ OTP string

+ PhoneCode int

+ PhoneNumber string

v0.1.2

Dec 27, 2022

v0.1.1

Nov 29, 2022

v0.1.0

Dec 11, 2021

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