usecase

Documentation

Index

• Constants
• type Administration
  • func NewAdministration() *Administration
  • func (u *Administration) AttachGroupToPrincipal(ctx Context, principalID, groupID string) (*membership.Principal, error)
  • func (u *Administration) AttachPermissionToRole(ctx Context, roleID, permissionID string) (*membership.Role, error)
  • func (u *Administration) AttachRoleToGroup(ctx Context, groupID, roleID string) (*membership.Group, error)
  • func (u *Administration) AttachRoleToPrincipal(ctx Context, principalID, roleID string) (*membership.Principal, error)
  • func (u *Administration) CreateAPIKey(ctx Context, principalID, name string) (*membership.AuthAPIKey, string, error)
  • func (u *Administration) CreateGroup(ctx Context, name, description string) (*membership.Group, error)
  • func (u *Administration) CreateMappingRule(ctx Context, name, description string, ruleType int, ...) (*membership.MappingRule, error)
  • func (u *Administration) CreatePermission(ctx Context, name, description string) (*membership.Permission, error)
  • func (u *Administration) CreatePrincipal(ctx Context, name, description string) (*membership.Principal, error)
  • func (u *Administration) CreateRole(ctx Context, name, description string) (*membership.Role, error)
  • func (u *Administration) DeleteGroup(ctx Context, id string) error
  • func (u *Administration) DeletePermission(ctx Context, id string) error
  • func (u *Administration) DeletePrincipal(ctx Context, id string) error
  • func (u *Administration) DeleteRole(ctx Context, id string) error
  • func (u *Administration) DetachGroupFromPrincipal(ctx Context, principalID, groupID string) (*membership.Principal, error)
  • func (u *Administration) DetachPermissionFromRole(ctx Context, roleID, permissionID string) (*membership.Role, error)
  • func (u *Administration) DetachRoleFromGroup(ctx Context, groupID, roleID string) (*membership.Group, error)
  • func (u *Administration) DetachRoleFromPrincipal(ctx Context, principalID, roleID string) (*membership.Principal, error)
  • func (u *Administration) FetchGroup(ctx Context, id string) (*membership.Group, error)
  • func (u *Administration) FetchMappingRule(ctx Context, id string) (*membership.MappingRule, error)
  • func (u *Administration) FetchPermission(ctx Context, id string) (*membership.Permission, error)
  • func (u *Administration) FetchRole(ctx Context, id string) (*membership.Role, error)
  • func (u *Administration) ListGroups(ctx Context) ([]*membership.Group, error)
  • func (u *Administration) ListMappingRules(ctx Context) ([]*membership.MappingRule, error)
  • func (u *Administration) ListPermissions(ctx Context) ([]*membership.Permission, error)
  • func (u *Administration) ListPrincipals(ctx Context) ([]*membership.Principal, error)
  • func (u *Administration) ListRoles(ctx Context) ([]*membership.Role, error)
  • func (u *Administration) ShowPrincipal(ctx Context, principalID string) (*membership.Principal, error)
  • func (u *Administration) UpdateGroup(ctx Context) (*membership.Group, error)
  • func (u *Administration) UpdateMappingRule(ctx Context, id string) (*membership.MappingRule, error)
  • func (u *Administration) UpdatePermission(ctx Context) (*membership.Permission, error)
  • func (u *Administration) UpdateRole(ctx Context, id string) (*membership.Role, error)
• type AuthSession
  • func (as *AuthSession) Restore(data string) error
  • func (as *AuthSession) String() string
• type Authentication
  • func NewAuthentication() *Authentication
  • func (u *Authentication) Authorization(ctx Context, is *IDSession) (string, *payload.SessionPrincipal, error)
  • func (u *Authentication) NeedAuthPrompt(ctx Context, expireAt time.Time) bool
  • func (u *Authentication) StartAuth(returnPath string) (*AuthSession, time.Time, string)
  • func (u *Authentication) VerifyAuth(ctx Context, as *AuthSession, state, code string) (is *IDSession, expireAt time.Time, path string, reserr error)
• type Context
• type Error
  • func (e Error) Detail() error
  • func (e Error) Error() string
  • func (e Error) Type() ErrorType
• type ErrorType
• type IDSession
  • func (is *IDSession) Restore(data string) error
  • func (is *IDSession) String() string
• type MembershipToken

Constants

const IDSeparator string = "('-'o)"

Types

type Administration

type Administration struct {
}

func NewAdministration

func NewAdministration() *Administration

func (*Administration) AttachGroupToPrincipal

func (u *Administration) AttachGroupToPrincipal(ctx Context, principalID, groupID string) (*membership.Principal, error)

func (*Administration) AttachPermissionToRole

func (u *Administration) AttachPermissionToRole(ctx Context, roleID, permissionID string) (*membership.Role, error)

func (*Administration) AttachRoleToGroup

func (u *Administration) AttachRoleToGroup(ctx Context, groupID, roleID string) (*membership.Group, error)

func (*Administration) AttachRoleToPrincipal

func (u *Administration) AttachRoleToPrincipal(ctx Context, principalID, roleID string) (*membership.Principal, error)

func (*Administration) CreateAPIKey

func (u *Administration) CreateAPIKey(ctx Context, principalID, name string) (*membership.AuthAPIKey, string, error)

func (*Administration) CreateGroup

func (u *Administration) CreateGroup(ctx Context, name, description string) (*membership.Group, error)

func (*Administration) CreateMappingRule

func (u *Administration) CreateMappingRule(ctx Context, name, description string, ruleType int,
	detail, associationType, associationID string) (*membership.MappingRule, error)

func (*Administration) CreatePermission

func (u *Administration) CreatePermission(ctx Context, name, description string) (*membership.Permission, error)

func (*Administration) CreatePrincipal

func (u *Administration) CreatePrincipal(ctx Context, name, description string) (*membership.Principal, error)

func (*Administration) CreateRole

func (u *Administration) CreateRole(ctx Context, name, description string) (*membership.Role, error)

func (*Administration) DeleteGroup

func (u *Administration) DeleteGroup(ctx Context, id string) error

func (*Administration) DeletePermission

func (u *Administration) DeletePermission(ctx Context, id string) error

func (*Administration) DeletePrincipal

func (u *Administration) DeletePrincipal(ctx Context, id string) error

func (*Administration) DeleteRole

func (u *Administration) DeleteRole(ctx Context, id string) error

func (*Administration) DetachGroupFromPrincipal

func (u *Administration) DetachGroupFromPrincipal(ctx Context, principalID, groupID string) (*membership.Principal, error)

func (*Administration) DetachPermissionFromRole

func (u *Administration) DetachPermissionFromRole(ctx Context, roleID, permissionID string) (*membership.Role, error)

func (*Administration) DetachRoleFromGroup

func (u *Administration) DetachRoleFromGroup(ctx Context, groupID, roleID string) (*membership.Group, error)

func (*Administration) DetachRoleFromPrincipal

func (u *Administration) DetachRoleFromPrincipal(ctx Context, principalID, roleID string) (*membership.Principal, error)

func (*Administration) FetchGroup

func (u *Administration) FetchGroup(ctx Context, id string) (*membership.Group, error)

func (*Administration) FetchMappingRule

func (u *Administration) FetchMappingRule(ctx Context, id string) (*membership.MappingRule, error)

func (*Administration) FetchPermission

func (u *Administration) FetchPermission(ctx Context, id string) (*membership.Permission, error)

func (*Administration) FetchRole

func (u *Administration) FetchRole(ctx Context, id string) (*membership.Role, error)

func (*Administration) ListGroups

func (u *Administration) ListGroups(ctx Context) ([]*membership.Group, error)

func (*Administration) ListMappingRules

func (u *Administration) ListMappingRules(ctx Context) ([]*membership.MappingRule, error)

func (*Administration) ListPermissions

func (u *Administration) ListPermissions(ctx Context) ([]*membership.Permission, error)

func (*Administration) ListPrincipals

func (u *Administration) ListPrincipals(ctx Context) ([]*membership.Principal, error)

func (*Administration) ListRoles

func (u *Administration) ListRoles(ctx Context) ([]*membership.Role, error)

func (*Administration) ShowPrincipal

func (u *Administration) ShowPrincipal(ctx Context, principalID string) (*membership.Principal, error)

func (*Administration) UpdateGroup

func (u *Administration) UpdateGroup(ctx Context) (*membership.Group, error)

func (*Administration) UpdateMappingRule

func (u *Administration) UpdateMappingRule(ctx Context, id string) (*membership.MappingRule, error)

func (*Administration) UpdatePermission

func (u *Administration) UpdatePermission(ctx Context) (*membership.Permission, error)

func (*Administration) UpdateRole

func (u *Administration) UpdateRole(ctx Context, id string) (*membership.Role, error)

type AuthSession

type AuthSession struct {
	CSRFToken string
	Path      string
}

func (*AuthSession) Restore

func (as *AuthSession) Restore(data string) error

func (*AuthSession) String

func (as *AuthSession) String() string

type Authentication

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

func NewAuthentication

func NewAuthentication() *Authentication

func (*Authentication) Authorization

func (u *Authentication) Authorization(ctx Context, is *IDSession) (string, *payload.SessionPrincipal, error)

func (*Authentication) NeedAuthPrompt

func (u *Authentication) NeedAuthPrompt(ctx Context, expireAt time.Time) bool

func (*Authentication) StartAuth

func (u *Authentication) StartAuth(returnPath string) (*AuthSession, time.Time, string)

func (*Authentication) VerifyAuth

func (u *Authentication) VerifyAuth(ctx Context, as *AuthSession, state, code string) (is *IDSession, expireAt time.Time, path string, reserr error)

type Context

type Context = context.Context

type Error

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

func (Error) Detail

func (e Error) Detail() error

func (Error) Error

func (e Error) Error() string

func (Error) Type

func (e Error) Type() ErrorType

type ErrorType

type ErrorType int

const (
	SystemError ErrorType = iota
	SecurityError
	VerificationError
	AuthError
)

type IDSession

type IDSession struct {
	Issuer     string
	Subject    string
	Email      string
	Membership MembershipToken
}

func (*IDSession) Restore

func (is *IDSession) Restore(data string) error

func (*IDSession) String

func (is *IDSession) String() string

type MembershipToken

type MembershipToken struct {
	NextCheck time.Time                 `json:"next_check"`
	Principal *payload.SessionPrincipal `json:"principal"`
}