model

Documentation

Index

• Constants
• Variables
• func IsValidIdentifier(in string) bool
• func NormalizeIdentifier(in string) (string, error)
• type ArrowPermission
• type Changes
• type Diff
• type ExclusionPermission
• type Identifier
  • func (i Identifier) Valid() bool
• type Metadata
• type Model
  • func New(r io.Reader) (*Model, error)
  • func (m *Model) Diff(newModel *Model) *Diff
  • func (m *Model) Reader() (io.Reader, error)
  • func (m *Model) Write(w io.Writer) error
• type Object
• type ObjectName
• type Permission
• type PermissionName
• type Relation
• type RelationName
• type SubjectRelation

Constants

const ModelVersion int = 1

Variables

var ErrInvalidIdentifier = errors.New("invalid identifier")

Functions

func IsValidIdentifier

func IsValidIdentifier(in string) bool

func NormalizeIdentifier

func NormalizeIdentifier(in string) (string, error)

Types

type ArrowPermission

type ArrowPermission struct {
	Relation   string `json:"relation,omitempty"`
	Permission string `json:"permission,omitempty"`
}

type Changes

type Changes struct {
	Objects   []ObjectName
	Relations map[ObjectName][]RelationName
}

type Diff

type Diff struct {
	Added   Changes
	Removed Changes
}

type ExclusionPermission

type ExclusionPermission struct {
	Base     string `json:"base,omitempty"`
	Subtract string `json:"subtract,omitempty"`
}

type Identifier

type Identifier string

Identifier is the string representation of an object, relation and permission type name.

Identifiers are bounded by the underlying defined regex definition (reIdentifier).

An identifier MUST be: - all lowercase characters - have a minimum length of 3 characters - have a maximum length of 64 characters - start with a character (a-z) - end with a character of a digit (a-z0-9) - can contain dots, underscores and dashes, between the first and last position.

func (Identifier) Valid

func (i Identifier) Valid() bool

type Metadata

type Metadata struct {
	UpdatedAt time.Time `json:"updated_at"`
	ETag      string    `json:"etag"`
}

type Model

type Model struct {
	Version  int                    `json:"version"`
	Objects  map[ObjectName]*Object `json:"types"`
	Metadata *Metadata              `json:"metadata"`
}

func New

func New(r io.Reader) (*Model, error)

func (*Model) Diff

func (m *Model) Diff(newModel *Model) *Diff

func (*Model) Reader

func (m *Model) Reader() (io.Reader, error)

func (*Model) Write

func (m *Model) Write(w io.Writer) error

type Object

type Object struct {
	Relations   map[RelationName][]*Relation   `json:"relations,omitempty"`
	Permissions map[PermissionName]*Permission `json:"permissions,omitempty"`
}

type ObjectName

type ObjectName Identifier

type Permission

type Permission struct {
	Union        []string             `json:"union,omitempty"`
	Intersection []string             `json:"intersection,omitempty"`
	Exclusion    *ExclusionPermission `json:"exclusion,omitempty"`
	Arrow        *ArrowPermission     `json:"arrow,omitempty"`
}

type PermissionName

type PermissionName Identifier

type Relation

type Relation struct {
	Direct   ObjectName       `json:"direct,omitempty"`
	Subject  *SubjectRelation `json:"subject,omitempty"`
	Wildcard ObjectName       `json:"wildcard,omitempty"`
}

type RelationName

type RelationName Identifier

type SubjectRelation

type SubjectRelation struct {
	Object   ObjectName   `json:"object,omitempty"`
	Relation RelationName `json:"relation,omitempty"`
}