files

package
v0.9.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 16, 2025 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	Realm  objectType = "realm"
	Client            = "client"
	User              = "user"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type FileDataManager 

type FileDataManager struct {
	// contains filtered or unexported fields
}

FileDataManager is the simplest Data Storage without any dependencies, it uses single JSON file (it is users and clients RO auth server) This context type is extremely useful for simple systems

func CreateFileDataManager 

func CreateFileDataManager(dataFile string, logger *logging.AppLogger) (*FileDataManager, error)

func CreateFileDataManagerWithInitData 

func CreateFileDataManagerWithInitData(serverData *data.ServerData) (*FileDataManager, error)

CreateFileDataManagerWithInitData initializes instance of FileDataManager and sets loaded data to serverData 

This factory function creates initialize with data instance of  FileDataManager, error reserved for usage but always nil here
* Parameters:
*    serverData already loaded data.ServerData from Json file in memory
* Returns: context and error (currently is nil)

func (*FileDataManager) CreateClient 

func (mn *FileDataManager) CreateClient(realmName string, clientData data.Client) error

CreateClient creates new data.Client in a data store, requires to pass realmName (because client name is not unique), clientData is an unmarshalled json of type data.Client

func (*FileDataManager) CreateRealm 

func (mn *FileDataManager) CreateRealm(realmData data.Realm) error

CreateRealm creates new data.Realm in a data store, receive realmData unmarshalled json in a data.Realm 

*

func (*FileDataManager) CreateUser 

func (mn *FileDataManager) CreateUser(realmName string, userData data.User) error

CreateUser creates new data.User in a data store within a realm with name = realmName

func (*FileDataManager) CreateUserFederationConfig 

func (mn *FileDataManager) CreateUserFederationConfig(realmName string, userFederationConfig data.UserFederationServiceConfig) error

func (*FileDataManager) DeleteClient 

func (mn *FileDataManager) DeleteClient(realmName string, clientName string) error

DeleteClient removes client with name = clientName from realm with name = clientName

func (*FileDataManager) DeleteRealm 

func (mn *FileDataManager) DeleteRealm(realmName string) error

DeleteRealm removes realm from data storage (Should be a CASCADE remove of all related Users and Clients)

func (*FileDataManager) DeleteUser 

func (mn *FileDataManager) DeleteUser(realmName string, userName string) error

DeleteUser removes data.User from data store by user (userName) and realm (realmName) name respectively

func (*FileDataManager) DeleteUserFederationConfig 

func (mn *FileDataManager) DeleteUserFederationConfig(realmName string, configName string) error

func (*FileDataManager) GetClient 

func (mn *FileDataManager) GetClient(realmName string, clientName string) (*data.Client, error)

GetClient function for getting Realm Client by name 

Searches for a client with name realmName in a realm. This function must be used after Realm was found.
* Parameters:
*     - realmName - realm containing clients to search
*     - clientName - name of a client
* Returns: Client and error

func (*FileDataManager) GetRealm 

func (mn *FileDataManager) GetRealm(realmName string) (*data.Realm, error)

GetRealm function for getting Realm by name 

Searches for a realm with name realmName in serverData adn return it. Returns realm with clients but no users
* Parameters:
*     - realmName - name of a realm
* Returns: Realm and error

func (*FileDataManager) GetUser 

func (mn *FileDataManager) GetUser(realmName string, userName string) (data.User, error)

GetUser function for getting Realm User by userName 

Searches for a user with specified name in a realm.  This function must be used after Realm was found.
* Parameters:
*     - realmName - realm containing users to search
*     - userName - name of a user
* Returns: User and error

func (*FileDataManager) GetUserById 

func (mn *FileDataManager) GetUserById(realmName string, userId uuid.UUID) (data.User, error)

GetUserById function for getting Realm User by UserId (uuid) 

same functions as GetUser but uses userId to search instead of username, works by sequential iteration

func (*FileDataManager) GetUserFederationConfig 

func (mn *FileDataManager) GetUserFederationConfig(realmName string, configName string) (*data.UserFederationServiceConfig, error)

func (*FileDataManager) GetUsers 

func (mn *FileDataManager) GetUsers(realmName string) ([]data.User, error)

GetUsers function for getting all Realm User 

This function get realm by name ant extract all its users
* Parameters:
*     - realmName - name of a realm
* Returns: slice of users and error

func (*FileDataManager) IsAvailable 

func (mn *FileDataManager) IsAvailable() bool

IsAvailable methods that checks whether DataContext could be used or not 

Availability means that serverData is not empty, so simple
* Parameters: no
* Returns true if DataContext is available

func (*FileDataManager) UpdateClient 

func (mn *FileDataManager) UpdateClient(realmName string, clientName string, clientData data.Client) error

UpdateClient updates existing data.Client in a data store with name = clientName and new data = clientData

func (*FileDataManager) UpdateRealm 

func (mn *FileDataManager) UpdateRealm(realmName string, realmData data.Realm) error

UpdateRealm updates existing data.Realm in a data store within name = realmData, and new data = realmData

func (*FileDataManager) UpdateUser 

func (mn *FileDataManager) UpdateUser(realmName string, userName string, userData data.User) error

UpdateUser updates existing data.User in a data store with realm name = realName, username = userName and data=userData

func (*FileDataManager) UpdateUserFederationConfig 

func (mn *FileDataManager) UpdateUserFederationConfig(realmName string, configName string, userFederationConfig data.UserFederationServiceConfig) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.