auth

Documentation

Index

• Constants
• Variables
• type AuthenticatedUser
• type Credential
  • func (c *Credential) String() string
• type CredentialType
  • func (c CredentialType) String() string
• type Realm
• type Role
  • func (r *Role) HasApp(appID string) bool
  • func (r *Role) HasGroup(groupID string) bool
  • func (r *Role) Validate(credType string) error
• type RoleType
  • func (r RoleType) Is(rt RoleType) bool
  • func (r RoleType) IsValid() bool
  • func (r RoleType) String() string

Constants

const (
	CredentialTypeBasic  = CredentialType("BASIC")
	CredentialTypeAPIKey = CredentialType("BEARER")
	CredentialTypeJWT    = CredentialType("JWT")
)

const (
	RoleSuperUser = RoleType("super_user")
	RoleAdmin     = RoleType("admin")
	RoleAPI       = RoleType("api")
)

Variables

var (
	ErrCredentialNotFound = errors.New("credential not found")
)

Types

type AuthenticatedUser

type AuthenticatedUser struct {
	AuthenticatedByRealm string      `json:"-"` // Name of realm that authenticated this user
	Credential           Credential  `json:"credential"`
	Role                 Role        `json:"role"`
	Metadata             interface{} `json:"-"` // Additional data set by the realm that authenticated the user, see the jwt realm for an example
}

type Credential

type Credential struct {
	Type     CredentialType `json:"type"`
	Username string         `json:"username"`
	Password string         `json:"password"`
	APIKey   string         `json:"api_key"`
	Token    string         `json:"token"`
}

func (*Credential) String

func (c *Credential) String() string

type CredentialType

type CredentialType string

func (CredentialType) String

func (c CredentialType) String() string

type Realm

type Realm interface {
	GetName() string
	Authenticate(ctx context.Context, cred *Credential) (*AuthenticatedUser, error)
}

type Role

type Role struct {
	Type  RoleType `json:"type"`
	Group string   `json:"group"`
	App   string   `json:"app,omitempty"`
}

Role represents the permission a user is given, if the Type is RoleSuperUser, Then the user will have access to everything regardless of the value of Group.

func (*Role) HasApp

func (r *Role) HasApp(appID string) bool

func (*Role) HasGroup

func (r *Role) HasGroup(groupID string) bool

func (*Role) Validate

func (r *Role) Validate(credType string) error

type RoleType

type RoleType string

func (RoleType) Is

func (r RoleType) Is(rt RoleType) bool

func (RoleType) IsValid

func (r RoleType) IsValid() bool

func (RoleType) String

func (r RoleType) String() string