Documentation ¶
Index ¶
- Constants
- func AwsErrorErrorNotFound(err error) bool
- func NewAppStorage(db *DB) (model.AppStorage, error)
- func NewTokenBlacklist(db *DB) (model.TokenBlacklist, error)
- func NewTokenStorage(db *DB) (model.TokenStorage, error)
- func NewUserStorage(db *DB) (model.UserStorage, error)
- func NewVerificationCodeStorage(db *DB) (model.VerificationCodeStorage, error)
- func PasswordHash(pwd string) string
- type AppData
- func (ad *AppData) Active() bool
- func (ad *AppData) AnonymousRegistrationAllowed() bool
- func (ad *AppData) AppleInfo() *model.AppleInfo
- func (ad *AppData) AuthzModel() string
- func (ad *AppData) AuthzPolicy() string
- func (ad *AppData) AuthzWay() model.AuthorizationWay
- func (ad *AppData) DebugTFACode() string
- func (ad *AppData) Description() string
- func (ad *AppData) ID() string
- func (ad *AppData) InviteTokenLifespan() int64
- func (ad AppData) Marshal() ([]byte, error)
- func (ad *AppData) Name() string
- func (ad *AppData) NewUserDefaultRole() string
- func (ad *AppData) Offline() bool
- func (ad *AppData) RedirectURLs() []string
- func (ad *AppData) RefreshTokenLifespan() int64
- func (ad *AppData) RegistrationForbidden() bool
- func (ad *AppData) RolesBlacklist() []string
- func (ad *AppData) RolesWhitelist() []string
- func (ad *AppData) Sanitize()
- func (ad *AppData) Scopes() []string
- func (ad *AppData) Secret() string
- func (ad *AppData) SetSecret(secret string)
- func (ad *AppData) TFAStatus() model.TFAStatus
- func (ad *AppData) TokenLifespan() int64
- func (ad *AppData) TokenPayload() []string
- func (ad *AppData) Type() model.AppType
- type AppStorage
- func (as *AppStorage) ActiveAppByID(appID string) (model.AppData, error)
- func (as *AppStorage) AppByID(id string) (model.AppData, error)
- func (as *AppStorage) Close()
- func (as *AppStorage) CreateApp(app model.AppData) (model.AppData, error)
- func (as *AppStorage) DeleteApp(id string) error
- func (as *AppStorage) DisableApp(app model.AppData) error
- func (as *AppStorage) FetchApps(filterString string, skip, limit int) ([]model.AppData, int, error)
- func (as *AppStorage) ImportJSON(data []byte) error
- func (as *AppStorage) NewAppData() model.AppData
- func (as *AppStorage) TestDatabaseConnection() error
- func (as *AppStorage) UpdateApp(appID string, newApp model.AppData) (model.AppData, error)
- type DB
- type Error
- type Token
- type TokenBlacklist
- type TokenStorage
- type User
- func (u *User) AccessRole() string
- func (u *User) Active() bool
- func (u *User) Deanonimize()
- func (u *User) Email() string
- func (u *User) ID() string
- func (u *User) IsAnonymous() bool
- func (u *User) PasswordHash() string
- func (u *User) Phone() string
- func (u *User) Sanitize()
- func (u *User) SetEmail(email string)
- func (u *User) SetTFAInfo(tfaInfo model.TFAInfo)
- func (u *User) SetUsername(username string)
- func (u *User) TFAInfo() model.TFAInfo
- func (u *User) Username() string
- type UserStorage
- func (us *UserStorage) AddNewUser(usr model.User, password string) (model.User, error)
- func (us *UserStorage) AddUserByNameAndPassword(username, password, role string, isAnonymous bool) (model.User, error)
- func (us *UserStorage) AddUserByPhone(phone, role string) (model.User, error)
- func (us *UserStorage) AddUserWithFederatedID(provider model.FederatedIdentityProvider, federatedID, role string) (model.User, error)
- func (us *UserStorage) AttachDeviceToken(id, token string) error
- func (us *UserStorage) Close()
- func (us *UserStorage) DeleteUser(id string) error
- func (us *UserStorage) DetachDeviceToken(token string) error
- func (us *UserStorage) FetchUsers(filterString string, skip, limit int) ([]model.User, int, error)
- func (us *UserStorage) IDByName(name string) (string, error)
- func (us *UserStorage) ImportJSON(data []byte) error
- func (us *UserStorage) NewUser() model.User
- func (us *UserStorage) RequestScopes(userID string, scopes []string) ([]string, error)
- func (us *UserStorage) ResetPassword(id, password string) error
- func (us *UserStorage) ResetUsername(id, username string) error
- func (us *UserStorage) Scopes() []string
- func (us *UserStorage) UpdateLoginMetadata(userID string)
- func (us *UserStorage) UpdateUser(userID string, newUser model.User) (model.User, error)
- func (us *UserStorage) UserByEmail(email string) (model.User, error)
- func (us *UserStorage) UserByFederatedID(provider model.FederatedIdentityProvider, id string) (model.User, error)
- func (us *UserStorage) UserByID(id string) (model.User, error)
- func (us *UserStorage) UserByNamePassword(name, password string) (model.User, error)
- func (us *UserStorage) UserByPhone(phone string) (model.User, error)
- func (us *UserStorage) UserExists(name string) bool
- type VerificationCodeStorage
Constants ¶
const ( //ErrorInternalError internal error ErrorInternalError = Error("Internal error") // ErrorInactiveUser means user is inactive ErrorInactiveUser = Error("User is inactive") // ErrorEmptyAppID means appID params is empty ErrorEmptyAppID = Error("Empty appID param") // ErrorInactiveApp means app is inactive ErrorInactiveApp = Error("App is inactive") )
Variables ¶
This section is empty.
Functions ¶
func AwsErrorErrorNotFound ¶
AwsErrorErrorNotFound checks if error has type dynamodb.ErrCodeResourceNotFoundException.
func NewAppStorage ¶
func NewAppStorage(db *DB) (model.AppStorage, error)
NewAppStorage creates new DynamoDB AppStorage implementation.
func NewTokenBlacklist ¶
func NewTokenBlacklist(db *DB) (model.TokenBlacklist, error)
NewTokenBlacklist creates new DynamoDB token storage.
func NewTokenStorage ¶
func NewTokenStorage(db *DB) (model.TokenStorage, error)
NewTokenStorage creates new DynamoDB token storage.
func NewUserStorage ¶
func NewUserStorage(db *DB) (model.UserStorage, error)
NewUserStorage creates and provisions new user storage instance.
func NewVerificationCodeStorage ¶
func NewVerificationCodeStorage(db *DB) (model.VerificationCodeStorage, error)
NewVerificationCodeStorage creates and provisions new DynamoDB verification code storage.
func PasswordHash ¶
PasswordHash creates hash with salt for password.
Types ¶
type AppData ¶
type AppData struct {
// contains filtered or unexported fields
}
AppData is DynamoDB model for model.AppData.
func AppDataFromJSON ¶
AppDataFromJSON deserializes data from JSON.
func MakeAppData ¶
func MakeAppData(id, secret string, active bool, name, description string, scopes []string, offline bool, redirectURLs []string, refreshTokenLifespan, inviteTokenLifespan, tokenLifespan int64, tokenPayload []string, registrationForbidden bool, anonymousRegistrationAllowed bool, tfaStatus model.TFAStatus, debugTFACode string, authzWay model.AuthorizationWay, authzModel, authzPolicy string, rolesWhitelist, rolesBlacklist []string, newUserDefaultRole string) (AppData, error)
MakeAppData creates new DynamoDB app data instance.
func NewAppData ¶
NewAppData instantiates DynamoDB app data model from the general one.
func (*AppData) AnonymousRegistrationAllowed ¶ added in v0.0.5
AnonymousRegistrationAllowed implements model.AppData interface.
func (*AppData) AuthzModel ¶
AuthzModel implements model.AppData interface.
func (*AppData) AuthzPolicy ¶
AuthzPolicy implements model.AppData interface.
func (*AppData) AuthzWay ¶
func (ad *AppData) AuthzWay() model.AuthorizationWay
AuthzWay implements model.AppData interface.
func (*AppData) DebugTFACode ¶
DebugTFACode implements model.AppData interface.
func (*AppData) Description ¶
Description implements model.AppData interface.
func (*AppData) InviteTokenLifespan ¶
InviteTokenLifespan a inviteToken lifespan in seconds, if 0 - default one is used.
func (*AppData) NewUserDefaultRole ¶
NewUserDefaultRole implements model.AppData interface.
func (*AppData) RedirectURLs ¶
RedirectURLs implements model.AppData interface.
func (*AppData) RefreshTokenLifespan ¶
RefreshTokenLifespan implements model.AppData interface.
func (*AppData) RegistrationForbidden ¶
RegistrationForbidden implements model.AppData interface.
func (*AppData) RolesBlacklist ¶
RolesBlacklist implements model.AppData interface.
func (*AppData) RolesWhitelist ¶
RolesWhitelist implements model.AppData interface.
func (*AppData) TokenLifespan ¶
TokenLifespan implements model.AppData interface.
func (*AppData) TokenPayload ¶
TokenPayload implements model.AppData interface.
type AppStorage ¶
type AppStorage struct {
// contains filtered or unexported fields
}
AppStorage a is fully functional app storage.
func (*AppStorage) ActiveAppByID ¶
func (as *AppStorage) ActiveAppByID(appID string) (model.AppData, error)
ActiveAppByID returns app by id only if it's active.
func (*AppStorage) AppByID ¶
func (as *AppStorage) AppByID(id string) (model.AppData, error)
AppByID returns app from DynamoDB by ID. IDs are generated with https://github.com/rs/xid.
func (*AppStorage) DeleteApp ¶
func (as *AppStorage) DeleteApp(id string) error
DeleteApp deletes app by id.
func (*AppStorage) DisableApp ¶
func (as *AppStorage) DisableApp(app model.AppData) error
DisableApp disables app in DynamoDB storage.
func (*AppStorage) FetchApps ¶
FetchApps fetches apps which name satisfies provided filterString. Supports pagination. Search is case-senstive for now.
func (*AppStorage) ImportJSON ¶
func (as *AppStorage) ImportJSON(data []byte) error
ImportJSON imports data from JSON.
func (*AppStorage) NewAppData ¶
func (as *AppStorage) NewAppData() model.AppData
NewAppData returns pointer to newly created app data.
func (*AppStorage) TestDatabaseConnection ¶
func (as *AppStorage) TestDatabaseConnection() error
TestDatabaseConnection checks whether we can fetch the first document in the applications table.
type DB ¶
DB represents connection to AWS DynamoDB service or local instance.
type Token ¶
type Token struct {
Token string `json:"token,omitempty"`
}
Token is a struct to store tokens in the database.
type TokenBlacklist ¶
type TokenBlacklist struct {
// contains filtered or unexported fields
}
TokenBlacklist is a DynamoDB storage for blacklisted tokens.
func (*TokenBlacklist) Add ¶
func (tb *TokenBlacklist) Add(token string) error
Add adds token to the blacklist.
func (*TokenBlacklist) IsBlacklisted ¶
func (tb *TokenBlacklist) IsBlacklisted(token string) bool
IsBlacklisted returns true if token is blacklisted.
type TokenStorage ¶
type TokenStorage struct {
// contains filtered or unexported fields
}
TokenStorage is a DynamoDB token storage.
func (*TokenStorage) DeleteToken ¶
func (ts *TokenStorage) DeleteToken(token string) error
DeleteToken removes token from the storage.
func (*TokenStorage) HasToken ¶
func (ts *TokenStorage) HasToken(token string) bool
HasToken returns true if token is present in the storage.
func (*TokenStorage) SaveToken ¶
func (ts *TokenStorage) SaveToken(token string) error
SaveToken saves token in the database.
type User ¶
type User struct {
// contains filtered or unexported fields
}
User is a user data structure for DynamoDB storage.
func UserFromJSON ¶
UserFromJSON deserializes user data from JSON.
func (*User) AccessRole ¶
AccessRole implements model.User interface.
func (*User) Deanonimize ¶ added in v0.0.2
func (u *User) Deanonimize()
Deanonimize implements model.User interface.
func (*User) IsAnonymous ¶ added in v0.0.2
IsAnonymous implements model.User interface.
func (*User) PasswordHash ¶
PasswordHash implements model.User interface.
func (*User) SetTFAInfo ¶
SetTFAInfo implements model.User interface.
func (*User) SetUsername ¶
SetUsername implements model.User interface.
type UserStorage ¶
type UserStorage struct {
// contains filtered or unexported fields
}
UserStorage stores and manages data in DynamoDB storage.
func (*UserStorage) AddNewUser ¶
AddNewUser adds new user.
func (*UserStorage) AddUserByNameAndPassword ¶
func (us *UserStorage) AddUserByNameAndPassword(username, password, role string, isAnonymous bool) (model.User, error)
AddUserByNameAndPassword registers new user.
func (*UserStorage) AddUserByPhone ¶
func (us *UserStorage) AddUserByPhone(phone, role string) (model.User, error)
AddUserByPhone registers new user with phone number.
func (*UserStorage) AddUserWithFederatedID ¶
func (us *UserStorage) AddUserWithFederatedID(provider model.FederatedIdentityProvider, federatedID, role string) (model.User, error)
AddUserWithFederatedID adds new user with social ID.
func (*UserStorage) AttachDeviceToken ¶
func (us *UserStorage) AttachDeviceToken(id, token string) error
AttachDeviceToken do nothing here TODO: implement device storage
func (*UserStorage) DeleteUser ¶
func (us *UserStorage) DeleteUser(id string) error
DeleteUser deletes user by id.
func (*UserStorage) DetachDeviceToken ¶
func (us *UserStorage) DetachDeviceToken(token string) error
DetachDeviceToken do nothing here yet TODO: implement
func (*UserStorage) FetchUsers ¶
FetchUsers fetches users which name satisfies provided filterString. Supports pagination. Search is case-senstive for now.
func (*UserStorage) IDByName ¶
func (us *UserStorage) IDByName(name string) (string, error)
IDByName returns userID by name.
func (*UserStorage) ImportJSON ¶
func (us *UserStorage) ImportJSON(data []byte) error
ImportJSON imports data from JSON.
func (*UserStorage) NewUser ¶
func (us *UserStorage) NewUser() model.User
NewUser returns pointer to newly created user.
func (*UserStorage) RequestScopes ¶
func (us *UserStorage) RequestScopes(userID string, scopes []string) ([]string, error)
RequestScopes for now returns requested scope TODO: implement scope logic
func (*UserStorage) ResetPassword ¶
func (us *UserStorage) ResetPassword(id, password string) error
ResetPassword sets new user password.
func (*UserStorage) ResetUsername ¶
func (us *UserStorage) ResetUsername(id, username string) error
ResetUsername sets user username.
func (*UserStorage) Scopes ¶
func (us *UserStorage) Scopes() []string
Scopes returns supported scopes, could be static data of database.
func (*UserStorage) UpdateLoginMetadata ¶
func (us *UserStorage) UpdateLoginMetadata(userID string)
UpdateLoginMetadata updates user's login metadata.
func (*UserStorage) UpdateUser ¶
UpdateUser updates user in DynamoDB storage.
func (*UserStorage) UserByEmail ¶
func (us *UserStorage) UserByEmail(email string) (model.User, error)
UserByEmail returns user by its email.
func (*UserStorage) UserByFederatedID ¶
func (us *UserStorage) UserByFederatedID(provider model.FederatedIdentityProvider, id string) (model.User, error)
UserByFederatedID returns user by federated ID.
func (*UserStorage) UserByID ¶
func (us *UserStorage) UserByID(id string) (model.User, error)
UserByID returns user by its ID.
func (*UserStorage) UserByNamePassword ¶
func (us *UserStorage) UserByNamePassword(name, password string) (model.User, error)
UserByNamePassword returns user by name and password.
func (*UserStorage) UserByPhone ¶
func (us *UserStorage) UserByPhone(phone string) (model.User, error)
UserByPhone fetches user by the phone number.
func (*UserStorage) UserExists ¶
func (us *UserStorage) UserExists(name string) bool
UserExists checks if user with provided name exists.
type VerificationCodeStorage ¶
type VerificationCodeStorage struct {
// contains filtered or unexported fields
}
VerificationCodeStorage implements verification code storage interface.
func (*VerificationCodeStorage) Close ¶
func (vcs *VerificationCodeStorage) Close()
Close does nothing here.
func (*VerificationCodeStorage) CreateVerificationCode ¶
func (vcs *VerificationCodeStorage) CreateVerificationCode(phone, code string) error
CreateVerificationCode inserts new verification code to the database.
func (*VerificationCodeStorage) IsVerificationCodeFound ¶
func (vcs *VerificationCodeStorage) IsVerificationCodeFound(phone, code string) (bool, error)
IsVerificationCodeFound checks whether verification code can be found.