identity

README

identity

Package identity provides type that allows to authorize request

Download:

go get -u github.com/bradishungry/go-api-learning/pkg/identity

---

Package identity provides type that allows to authorize request

Documentation

Overview

Package identity provides type that allows to authorize request

Index

• func ContextWithIdentity(ctx context.Context, i *Identity) context.Context
• type Identity
  • func FromContext(ctx context.Context) (*Identity, bool)
• type Permission
  • func (p Permission) Add(flag Permission) Permission
  • func (p Permission) Has(flag Permission) bool
  • func (p Permission) Remove(flag Permission) Permission

Functions

func ContextWithIdentity

func ContextWithIdentity(ctx context.Context, i *Identity) context.Context

ContextWithIdentity returns a new Context that carries value i.

Types

type Identity

type Identity struct {
	Token        string     `json:"token"`
	Permission   Permission `json:"permission"`
	UserID       uuid.UUID  `json:"user_id"`
	ClientID     uuid.UUID  `json:"client_id,omitempty"`
	ClientDomain string     `json:"client_domain,omitempty"`
}

Identity data to be encode in auth token

func FromContext

func FromContext(ctx context.Context) (*Identity, bool)

FromContext returns the Identity value stored in ctx, if any.

type Permission

type Permission uint8

Flag type

const (
	PermissionUserRead Permission = 1 << iota
	PermissionUserWrite
	PermissionClientWrite
	PermissionClientRead
	PermissionTokenRead
)

Execution context flags

func (Permission) Add

func (p Permission) Add(flag Permission) Permission

Add permission

func (Permission) Has

func (p Permission) Has(flag Permission) bool

Has permission

func (Permission) Remove

func (p Permission) Remove(flag Permission) Permission

Remove permission