auth

Documentation

Overview

Package auth provides authentication and authorization capability

Index

• type Auth
• type Service
• type Token

Types

type Auth

type Auth interface {
	// Generate a new auth token
	Generate(string) (*Token, error)
	// Revoke an authorization token
	Revoke(*Token) error
	// Grant access to a resource
	Grant(*Token, *Service) error
	// Verify a token can access a resource
	Verify(*Token, *Service) error
}

Auth providers authentication and authorization

type Service

type Service struct {
	// Name of the resource
	Name string
	// Endpoint is the specific endpoint
	Endpoint string
}

Service is some thing to provide access to

type Token

type Token struct {
	// Unique token id
	Id string `json: "id"`
	// Time of token creation
	Created time.Time `json:"created"`
	// Time of token expiry
	Expiry time.Time `json:"expiry"`
	// Roles associated with the token
	Roles []string `json:"roles"`
	// Any other associated metadata
	Metadata map[string]string `json:"metadata"`
}

Token providers by an auth provider