package
0.0.0-20241014201404-b3670d1a0383
Repository: https://github.com/tknie/services.git
Documentation: pkg.go.dev
# Functions
BasicAuth basic authentication on REST.
CallbackAuthenticate authenticate user and password to callback.
CallbackInit init login service realm and authorization instances of user using callbacks or plugins.
CheckPasswordFileUser auth user and password for default realm.
ClearCallbacks clear callbacks.
CountLoginUser count number of registered login user.
DecryptData decsrypt base64 data to string.
EncryptData encrypt data to base64 string.
GenerateHash generate hash by given hash algorithm.
InitLoginService init login service realm and authorization instances of user.
InitPasswordFile init password to file data.
InvalidateUUID invalidate UUID not valid any more.
LoadUsers load permission rights.
MethodType parse method type out of string.
NewAppendPasswordFile new append password file to append only.
NewInitFileRealm new init file realm (Create new one if not available).
NewSessionInfo create a new Session Info instance with created and UUID filled.
PerDatabase authenticate user and password to database.
Register register principal hooks.
RegisterCallback register callback.
RegisterDatabaseForAuth register principal hooks.
RegisterPlugin register plugin.
RegisterTargetForAuth register principal hooks.
RemoveLoginService remove login service realm and authorization instances of user.
RemovePasswordFile remove password to file data.
UUIDInfo get UUID info User information.
ValidAdmin check the role of the user.
ValidUser check the role of the user.
# Constants
AdministratorRole use of administration user.
CallbackMethod callback method.
CheckDefaultPassword check default password must be changed.
FileMethod password file method.
LDAPMethod LDAP method.
OpenIDMethod OpenID method.
PluginMethod plugin method.
Note: new type must be added at the end of list to maintain compatibility.
Note: new type must be added at the end of list to maintain compatibility.
Note: new type must be added at the end of list to maintain compatibility.
SQLDatabaseMethod database method.
SystemMethod System method.
UnknownMethod unknown.
UserRole user access role.
# Variables
AllowedAdministrators allowed user reading data.
AllowedUsers allowed user reading data.
AuthenticationConfig authentication config base.
DefaultRoles default roles set for users.
JWTOperator JWT operator check for UUID.
PrincipalCreater creator of an principal instance.
TriggerInvalidUUID trigger if UUID is invalidated.
WebTokenConfig web token JWT configuration.
# Structs
Authentication authenticator base.
AuthenticationServer authentication server.
Default default rights.
DefaultJWTHandler default local Map instance.
JWTClaims describes the format of our JWT token's claims.
PasswordFileStruct password file struct.
SearchResult : user data.
SessionInfo session information context.
Source Basic LDAP authentication service.
User REST user.
UserInfo user information context.
Users REST user list allowed accessing data.
WebToken Web token configuration.
# Interfaces
CallbackInterface callback interface for auth.
JWTValidate JWT validate instance.
PrincipalInterface principal independent to model.
# Type aliases
AccessRole access role.
Method method of authenticate.
SecurityProtocol integer protocol type.