auth

Documentation

Index

• func ClientWithDatabaseRead(db db.Manager) common.Option[clientManager]
• func ClientWithExecuteMigration(enabled bool, dir ...string) common.Option[clientManager]
• func ClientWithLazyLoadData(v bool) common.Option[clientManager]
• func ClientWithLogger(v logger.Manager) common.Option[clientManager]
• type Client
• type ClientManager
  • func NewClientManager(db db.Manager, opts ...common.Option[clientManager]) ClientManager
• type ClientScope
• type ClientScopes
• type ClientWithScopes
• type Clients
• type ClientsWithScopes
• type OAuthManager
  • func NewOAuthManager(opts ...common.Option[oauthManager]) OAuthManager
• type OAuthPermission
• type OAuthPermissions
• type Scope
  • func (s Scope) FromHttpMethod(method string) Scope
  • func (s *Scope) Scan(src interface{}) error
  • func (s Scope) String() string
  • func (s Scope) Value() (driver.Value, error)
• type Scopes
  • func (s Scopes) AllowedTo(scope Scope) bool
  • func (s Scopes) AllowedToRead() bool
  • func (s Scopes) AllowedToWrite() bool
  • func (s Scopes) FromStringArray(values []string) Scopes
  • func (s Scopes) IsAllowedByHttpMethod(method string) bool
  • func (s *Scopes) Scan(src interface{}) error
  • func (s Scopes) ToStringArray() []string
  • func (s Scopes) Value() (driver.Value, error)

Functions

func ClientWithDatabaseRead

func ClientWithDatabaseRead(db db.Manager) common.Option[clientManager]

func ClientWithExecuteMigration

func ClientWithExecuteMigration(enabled bool, dir ...string) common.Option[clientManager]

func ClientWithLazyLoadData

func ClientWithLazyLoadData(v bool) common.Option[clientManager]

func ClientWithLogger

func ClientWithLogger(v logger.Manager) common.Option[clientManager]

Types

type Client

type Client struct {
	ID         int        `db:"id"`
	Name       string     `db:"name"`
	Secret     string     `db:"secret"`
	ExpiredAt  *time.Time `db:"expire_at"`
	Disabled   bool       `db:"disabled"`
	CreatedAt  time.Time  `db:"created_at"`
	UpdatedAt  *time.Time `db:"updated_at"`
	DisabledAt *time.Time `db:"disabled_at"`
}

type ClientManager

type ClientManager interface {
	AddClients(ctx context.Context, items Clients) error
	AddScopes(ctx context.Context, items ClientScopes) error
	AddClientsWithScopes(ctx context.Context, items ClientWithScopes) error

	GetClientsWithScopesBy(ctx context.Context, by db.IHelper) (ClientsWithScopes, error)

	VoidClientsByIds(ctx context.Context, ids ...int) error
	VoidScopeByIds(ctx context.Context, id ...int) error

	IsAllowed(secret, resource, scope string) (clientName string, allowed bool)

	Init() error
	MustInit() ClientManager
	AddOptions(opts ...common.Option[clientManager]) ClientManager
	// contains filtered or unexported methods
}

func NewClientManager

func NewClientManager(db db.Manager, opts ...common.Option[clientManager]) ClientManager

type ClientScope

type ClientScope struct {
	ID         int        `db:"id"`
	ClientID   int        `db:"client_id"`
	Resource   string     `db:"resource"`
	Scopes     Scopes     `db:"scopes"`
	Disabled   bool       `db:"disabled"`
	CreatedAt  time.Time  `db:"created_at"`
	UpdatedAt  *time.Time `db:"updated_at"`
	DisabledAt *time.Time `db:"disabled_at"`
}

type ClientScopes

type ClientScopes []*ClientScope

type ClientWithScopes

type ClientWithScopes struct {
	*Client
	Scopes ClientScopes
}

type Clients

type Clients []*Client

type ClientsWithScopes

type ClientsWithScopes []*ClientWithScopes

type OAuthManager

type OAuthManager interface {
	GetPermissions(ctx context.Context, token, realm string) (OAuthPermissions, error)
}

func NewOAuthManager

func NewOAuthManager(opts ...common.Option[oauthManager]) OAuthManager

type OAuthPermission

type OAuthPermission struct {
	ResourceName string   `json:"resource_name"`
	Scopes       []string `json:"scopes"`
}

type OAuthPermissions

type OAuthPermissions []*OAuthPermission

type Scope

type Scope string

const (
	ScopeRead      Scope = "read"
	ScopeWrite     Scope = "write"
	ScopeDelete    Scope = "delete"
	ScopeUndefined Scope = "undefined"
)

func (Scope) FromHttpMethod

func (s Scope) FromHttpMethod(method string) Scope

func (*Scope) Scan

func (s *Scope) Scan(src interface{}) error

Scan implements the sql.Scanner interface.

func (Scope) String

func (s Scope) String() string

func (Scope) Value

func (s Scope) Value() (driver.Value, error)

Value implements the driver.Valuer interface.

type Scopes

type Scopes []Scope

func (Scopes) AllowedTo

func (s Scopes) AllowedTo(scope Scope) bool

func (Scopes) AllowedToRead

func (s Scopes) AllowedToRead() bool

func (Scopes) AllowedToWrite

func (s Scopes) AllowedToWrite() bool

func (Scopes) FromStringArray

func (s Scopes) FromStringArray(values []string) Scopes

func (Scopes) IsAllowedByHttpMethod

func (s Scopes) IsAllowedByHttpMethod(method string) bool

func (*Scopes) Scan

func (s *Scopes) Scan(src interface{}) error

Scan implements the sql.Scanner interface.

func (Scopes) ToStringArray

func (s Scopes) ToStringArray() []string

func (Scopes) Value

func (s Scopes) Value() (driver.Value, error)

Value implements the driver.Valuer interface.