data

type AccessTokenData ¶

type AccessTokenData struct {
	ResultData    map[string]interface{}
	ResultJsonStr string
	// contains filtered or unexported fields
}

AccessTokenData is a struct that stores data for build JWT access token (jwtCommonInfo, rawUserInfo) and result (ResultData, ResultJsonStr) this token = jwtCommonInfo + rawUserInfo

func CreateAccessToken(commonData *JwtCommonInfo, userData User) *AccessTokenData

func (token *AccessTokenData) Init()

func (token *AccessTokenData) Valid() error

type Authentication ¶

type Authentication struct {
	Type       AuthenticationType
	Value      string
	Attributes interface{}
}

Authentication struct for Clients authentication data, for ClientIdAndSecrets Value stores ClientSecret

type AuthenticationDefs ¶ added in v0.9.2

type AuthenticationDefs struct {
	SupportedGrantTypes    []string
	SupportedResponseTypes []string
	SupportedResponses     []string
	SupportedScopes        []string
	SupportedClaimTypes    []string
	SupportedClaims        []string
}

type AuthenticationType ¶

type AuthenticationType int

const (
	ClientIdAndSecrets AuthenticationType = 1
)

type Client ¶

type Client struct {
	Type ClientType
	ID   uuid.UUID
	Name string
	Auth Authentication
}

Client is a realm client, represents an application nad set of rules for interacting with Authorization server

type ClientType ¶

type ClientType string

ClientType is type of client security, Confidential clients must provide ClientSecret

const (
	Public       ClientType = "public"
	Confidential            = "confidential"
)

type ExtendedIdentifier ¶ added in v0.9.2

type ExtendedIdentifier struct {
	ID   uuid.UUID
	Name string
}

ExtendedIdentifier is a service struct that is using for association identifier and name of object like Client and User

type JwtCommonInfo ¶

type JwtCommonInfo struct {
	IssuedAt     time.Time `json:"iat"`
	ExpiredAt    time.Time `json:"exp"`
	JwtId        uuid.UUID `json:"jti"`
	Type         string    `json:"typ"`
	Issuer       string    `json:"iss"`
	Audience     string    `json:"aud"`
	Subject      uuid.UUID `json:"sub"`
	SessionState uuid.UUID `json:"session_state"`
	SessionId    uuid.UUID `json:"sid"`
	Scope        string    `json:"scope"`
}

JwtCommonInfo - struct with all field for representing token in JWT format

type KeyCloakUser ¶

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

KeyCloakUser this structure is for user data that looks similar to KeyCloak, Users in Keycloak have info field with preferred_username and sub and others fields, Ferrum users have credentials built-in in user (temporary it stores in non encrypted mode)

func (user *KeyCloakUser) GetFederationId() string

func (user *KeyCloakUser) GetId() uuid.UUID

this function use internal map to navigate over info.sun keys to retrieve a user id
* Parameters: no
* Returns: user id

func (user *KeyCloakUser) GetJsonString() string

func (user *KeyCloakUser) GetPasswordHash() string

this function use internal map to navigate over credentials.password keys to retrieve a hash of password
* Parameters: no
* Returns: hash of password

func (user *KeyCloakUser) GetRawData() interface{}

func (user *KeyCloakUser) GetUserInfo() interface{}

this function use internal map to navigate over key info ant retrieve all public userinfo
* Parameters: no
* Returns: user info

func (user *KeyCloakUser) GetUsername() string

this function use internal map to navigate over info.preferred_username keys, the last one key is a login key
* We are expecting that username is unique in the Realm
* Parameters: no
* Returns: username

func (user *KeyCloakUser) IsFederatedUser() bool

this function determines whether user stores outside the database i.e. in ActiveDirectory or other systems
* navigation property for this federation.name
* Parameters: no

func (user *KeyCloakUser) SetPassword(password string, encoder *encoding.PasswordJsonEncoder) error

this function changes a raw password to its hash in the user's rawData and jsonRawData and sets it
* Parameters:
*	- password - new password
*	- encoder - encoder object with salt and hasher

type OperationError ¶

type OperationError struct {
	Msg         string
	Description string
}

OperationError is a struct that represents Error and contains title of error (Msg) and detailed information (Description)

type RawUserInfo ¶

type RawUserInfo interface{}

RawUserInfo is a type that is using for place all public user data (in Keycloak - "info":{...} struct) into JWT encoded token

type Realm ¶

type Realm struct {
	Name                   string                        `json:"name"`
	Clients                []Client                      `json:"clients"`
	Users                  []interface{}                 `json:"users"`
	TokenExpiration        int                           `json:"token_expiration"`
	RefreshTokenExpiration int                           `json:"refresh_expiration"`
	UserFederationServices []UserFederationServiceConfig `json:"user_federation_services"`
	PasswordSalt           string                        `json:"password_salt"`
	Encoder                *encoding.PasswordJsonEncoder
}

Realm is a struct that describes typical Realm

It was originally designed to efficiently work in memory with small amount of data therefore it contains relations with Clients and Users
* But in a systems with thousands of users working at the same time it is too expensive to fetch Realm with all relations therefore
* in such systems Clients && Users would be empty, and we should to get User or Client separately

type ServerData ¶

type ServerData struct {
	Realms []Realm
}

ServerData is used in managers.FileDataManager

type TokenRefreshData ¶

type TokenRefreshData struct {
	JwtCommonInfo
}

TokenRefreshData is a JWT token with embedded just a common data (JwtCommonInfo)

func CreateRefreshToken(commonData *JwtCommonInfo) *TokenRefreshData

func (token *TokenRefreshData) Valid() error

type User ¶

type User interface {
	GetUsername() string
	GetPasswordHash() string
	SetPassword(password string, encoder *encoding.PasswordJsonEncoder) error
	GetId() uuid.UUID
	GetUserInfo() interface{}
	GetRawData() interface{}
	GetJsonString() string
	IsFederatedUser() bool
	// GetFederationId actually Federation Name
	GetFederationId() string
}

User is a common user interface with all Required methods to get information about user, in future we probably won't have GetPassword method because Password is not an only method for authentication

func CreateUser(rawData interface{}, encoder *encoding.PasswordJsonEncoder) User

Function create User instance from any json (interface{})
* Parameters:
*    - rawData - any json
* Return: instance of User as KeyCloakUser

type UserFederationServiceConfig ¶ added in v0.9.2

type UserFederationServiceConfig struct {
	Type UserFederationServiceType `json:"type"`
	// Url is a base url to fetch data
	Url string `json:"url"`
	// Name is internal Unique identifier, MUST be unique across all providers
	Name string `json:"name"`
	// SysUser is a system User, if SysUser == "" then mode IsAnonymous
	SysUser string `json:"sys_user"`
	// SysPassword is a system password
	SysPassword string `json:"sys_password"`
	// TlsCfg is an HTTPS configuration options, use InsecureSkipVerify=true to allow to use self-signed certificate
	// TlsCfg tls.Config `json:"tls_cfg"`
	// EntryPoint is case of LDAP is a catalog where we should fetch data, i.e.
	EntryPoint string `json:"entry_point"`
}

func (u UserFederationServiceConfig) IsAnonymousAccess() bool

type UserFederationServiceType ¶ added in v0.9.2

type UserFederationServiceType string

const (
	LDAP    UserFederationServiceType = "ldap"
	FreeIPA UserFederationServiceType = "freeipa"
)

type UserSession ¶

type UserSession struct {
	Id              uuid.UUID
	UserId          uuid.UUID
	Started         time.Time
	Expired         time.Time
	RefreshExpired  time.Time
	JwtAccessToken  string
	JwtRefreshToken string
}

UserSession is a struct that is using for store info about users logged in a Ferrum authorization server

UserId - uuid representing unique user identifier
* Started - time when token was Issued
* Expired - time when session expires
* RefreshExpired - time when refresh expires
* JwtAccessToken and JwtRefreshToken - access and refresh tokens