models

Documentation

Index

• Constants
• Variables
• type Bundle
• type BundlePolicy
• type Condition
• type EntityIDToPolicies
• type Error
  • func NewError(ctx context.Context, cause error, code string, description string, ...) *Error
  • func (e *Error) Error() string
• type ErrorResponse
  • func NewErrorResponse(statusCode int, headers map[string]string, errors ...error) *ErrorResponse
• type Operator
  • func (operator Operator) IsValid() bool
  • func (operator Operator) String() string
• type Policy
• type PolicyInfo
  • func CreatePolicy(reader io.Reader) (*PolicyInfo, error)
  • func (policy *PolicyInfo) GetPolicy(id string) *Policy
  • func (policy *PolicyInfo) ValidatePolicy() error
• type Role
• type Roles
• type SuccessResponse
  • func NewSuccessResponse(jsonBody []byte, statusCode int, headers map[string]string) *SuccessResponse
• type UpdateResult

Constants

const (
	JSONMarshalError                           = "JSONMarshalError"
	JSONUnmarshalError                         = "JSONUnmarshalError"
	WriteResponseError                         = "WriteResponseError"
	InvalidQueryParameterError                 = "InvalidQueryParameter"
	InvalidLimitQueryParameterMaxExceededError = "InvalidLimitQueryParameterMaxExceeded"
	RoleNotFoundError                          = "RoleNotFoundError"
	GetRoleError                               = "GetRoleError"
	GetRolesError                              = "GetRolesError"
	GetPermissionBundleError                   = "GetPermissionBundleError"
	PolicyNotFoundError                        = "PolicyNotFoundError"
	GetPolicyError                             = "GetPolicyError"
	DeletePolicyError                          = "DeletePolicyError"
	InvalidPolicyError                         = "InvalidPolicyError"
	CreateNewPolicyError                       = "CreateNewPolicyError"
	UpdatePolicyError                          = "UpdatePolicyError"
)

API error codes

const (
	InternalServerErrorDescription                   = "internal server error"
	MarshalFailedDescription                         = "failed to marshal the request body"
	UnmarshalFailedDescription                       = "unable to unmarshal request body"
	ErrorMarshalFailedDescription                    = "failed to marshal the error"
	WriteResponseFailedDescription                   = "failed to write http response"
	InvalidQueryParameterDescription                 = "invalid query parameter"
	InvalidLimitQueryParameterMaxExceededDescription = "invalid query parameter: maximum exceeded"
	RoleNotFoundDescription                          = "role not found"
	GetRoleErrorDescription                          = "retrieving role from DB returned an error"
	GetRolesErrorDescription                         = "retrieving roles from DB returned an error"
	GetPermissionBundleErrorDescription              = "failed to get permissions bundle"
	PolicyNotFoundDescription                        = "policy not found"
	GetPolicyErrorDescription                        = "retrieving policy from DB returned an error"
	DeletePolicyErrorDescription                     = "deleting policy from DB returned an error"
	CreateNewPolicyErrorDescription                  = "failed to create new policy"
	UpdatePolicyErrorDescription                     = "failed to update policy"
)

API error descriptions

const (
	PoliciesRead   string = "policies:read"
	PoliciesCreate        = "policies:create"
	PoliciesUpdate        = "policies:update"
	PoliciesDelete        = "policies:delete"

	OperatorStringEquals Operator = "StringEquals"
	OperatorStartsWith   Operator = "StartsWith"
)

policies permissions

const (
	RolesRead   string = "roles:read"
	RolesCreate        = "roles:create"
	RolesUpdate        = "roles:update"
	RolesDelete        = "roles:delete"
)

roles permissions

Variables

var (
	ErrorReadingBody = errors.New("failed to read message body")
	ErrorParsingBody = errors.New("failed to parse json body")
)

A list of errors returned from package

Types

type Bundle

type Bundle map[string]EntityIDToPolicies

Bundle is the optimised lookup table for permissions.

type BundlePolicy

type BundlePolicy struct {
	ID        string    `bson:"_id"          json:"id,omitempty"`
	Entities  []string  `bson:"entities"   json:"-"`
	Role      string    `bson:"role"      json:"-"`
	Condition Condition `bson:"condition" json:"condition,omitempty"`
}

BundlePolicy represents a policy tailored for the permissions bundle. The permissions bundle json does not include the entities and role fields.

type Condition

type Condition struct {
	Attribute string   `bson:"attribute" json:"attribute"`
	Operator  Operator `bson:"operator" json:"operator"`
	Values    []string `bson:"Values" json:"values"`
}

Condition represents the conditions to be applied for a policy

type EntityIDToPolicies

type EntityIDToPolicies map[string][]*BundlePolicy

EntityIDToPolicies maps an entity ID to a slice of policies.

type Error

type Error struct {
	Cause       error  `json:"-"`
	Code        string `json:"code"`
	Description string `json:"description"`
}

Error represents an error.

func NewError

func NewError(ctx context.Context, cause error, code string, description string, logData log.Data) *Error

NewError creates a new Error. Once created. the error is logged along with logData.

func (*Error) Error

func (e *Error) Error() string

Error returns a string representation of the error. Implements error interface.

type ErrorResponse

type ErrorResponse struct {
	Errors  []error           `json:"errors"`
	Status  int               `json:"-"`
	Headers map[string]string `json:"-"`
}

ErrorResponse represents a slice of errors in a JSON response body.

func NewErrorResponse

func NewErrorResponse(statusCode int, headers map[string]string, errors ...error) *ErrorResponse

type Operator

type Operator string

func (Operator) IsValid

func (operator Operator) IsValid() bool

func (Operator) String

func (operator Operator) String() string

type Policy

type Policy struct {
	ID        string    `bson:"_id"          json:"id,omitempty"`
	Entities  []string  `bson:"entities"   json:"entities"`
	Role      string    `bson:"role"      json:"role"`
	Condition Condition `bson:"condition" json:"condition,omitempty"`
}

Policy represent a structure for a policy in DB

type PolicyInfo

type PolicyInfo struct {
	Entities  []string  `json:"entities"`
	Role      string    `json:"role"`
	Condition Condition `json:"condition,omitempty"`
}

PolicyInfo contains properties required to create or update a policy

func CreatePolicy

func CreatePolicy(reader io.Reader) (*PolicyInfo, error)

CreatePolicy manages the creation of a filter from reader

func (*PolicyInfo) GetPolicy

func (policy *PolicyInfo) GetPolicy(id string) *Policy

GetPolicy creates a policy object with ID

func (*PolicyInfo) ValidatePolicy

func (policy *PolicyInfo) ValidatePolicy() error

ValidatePolicy checks that all the mandatory fields are non-empty and non-empty fields contain valid values

type Role

type Role struct {
	ID          string   `bson:"_id" json:"id"`
	Name        string   `bson:"name" json:"name"`
	Permissions []string `bson:"permissions" json:"permissions"`
}

Role represents the structure for a role

type Roles

type Roles struct {
	Count      int    `json:"count"`
	Offset     int    `json:"offset"`
	Limit      int    `json:"limit"`
	Items      []Role `json:"items"`
	TotalCount int    `json:"total_count"`
}

Roles represents an array of the role model

type SuccessResponse

type SuccessResponse struct {
	Body    []byte            `json:"-"`
	Status  int               `json:"-"`
	Headers map[string]string `json:"-"`
}

SuccessResponse represents a success JSON response body.

func NewSuccessResponse

func NewSuccessResponse(jsonBody []byte, statusCode int, headers map[string]string) *SuccessResponse

NewSuccessResponse creates a new SuccessResponse.

type UpdateResult

type UpdateResult struct {
	ModifiedCount int
	UpsertedCount int
}

UpdateResult represent a result of the upsert policy