auth

package

v0.0.2 Latest Latest Go to latest Published: Feb 17, 2022 License: MPL-2.0 Imports: 3 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/frain-dev/convoy

Links

Open Source Insights

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) Validate(credType string) error
type RoleType

Constants ¶

View Source

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

View Source

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

Variables ¶

View Source

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

Functions ¶

This section is empty.

Types ¶

type AuthenticatedUser ¶

type AuthenticatedUser struct {
	AuthenticatedByRealm string     `json:"-"` // Name of realm that authenticated this user
	Credential           Credential `json:"credential"`
	Role                 Role       `json:"role"`
}

type Credential ¶

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

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"`
	Groups []string `json:"groups"`
}

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 Groups.

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
realm
file
native
noop
realm_chain

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL