domain

Documentation

Index

• Variables
• type Auth
• type LoginEvent
• type LogoutEvent
• type TokenExtras
  • func (te *TokenExtras) Add(key string, value string)
  • func (te *TokenExtras) Get(key string) (string, bool)
• type User
  • func (u User) Get(name string) string
• type UserMappingService
  • func (ums *UserMappingService) Inject(config ...)
  • func (ums *UserMappingService) MapToUser(claims map[string]interface{}, session *web.Session) *User
  • func (ums *UserMappingService) UserFromIDToken(idToken *oidc.IDToken, session *web.Session) (*User, error)
• type UserType

Variables

var Guest = &User{
	Name: "Guest",
	Type: GUEST,
}

Guest is our default guest user

var OAuthRoleUser = domain.StringRole(domain.PermissionAuthorized)

OAuthRoleUser represents basic role for authorized user

Types

type Auth

type Auth struct {
	TokenSource oauth2.TokenSource
	IDToken     *oidc.IDToken
}

Auth information

type LoginEvent

type LoginEvent struct {
	Session *web.Session
}

LoginEvent for the current session

type LogoutEvent

type LogoutEvent struct {
	Session *web.Session
}

LogoutEvent for the current session

type TokenExtras

type TokenExtras map[string]string

TokenExtras for openID Connect

func (*TokenExtras) Add

func (te *TokenExtras) Add(key string, value string)

Add a value to a key

func (*TokenExtras) Get

func (te *TokenExtras) Get(key string) (string, bool)

Get a calue from a key

type User

type User struct {
	Sub          string
	Name         string
	Email        string
	Salutation   string
	FirstName    string
	LastName     string
	Street       string
	ZipCode      string
	City         string
	DateOfBirth  string
	Country      string
	CustomFields map[string]string
	Type         UserType
	Groups       []string
}

User is a basic authenticated user

func (User) Get

func (u User) Get(name string) string

Get a custom field by the name

type UserMappingService

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

UserMappingService maps a user based on data available via the idTokenMapping setting

func (*UserMappingService) Inject

func (ums *UserMappingService) Inject(config *struct {
	IDTokenMapping config.Map `inject:"config:core.oauth.mapping.idToken"`
})

Inject dependencies

func (*UserMappingService) MapToUser

func (ums *UserMappingService) MapToUser(claims map[string]interface{}, session *web.Session) *User

MapToUser returns the user mapped from the claims

func (*UserMappingService) UserFromIDToken

func (ums *UserMappingService) UserFromIDToken(idToken *oidc.IDToken, session *web.Session) (*User, error)

UserFromIDToken returns a user mapped with data from a provided OpenID connect token

type UserType

type UserType string

UserType such as guest or user

const (
	// GUEST user
	GUEST UserType = "guest"

	// USER is an authenticated user
	USER UserType = "user"
)