catalogacl

Documentation

Overview

Package catalogacl contains the logic to authorise access to catalog resources based on user requesting it.

Index

• type CatalogRules
  • func NewCatalogRules(repository ScopeRepository, mediaAlbumResolver MediaAlbumResolver, ...) CatalogRules
  • func OptimiseRulesWithAccessToken(delegate CatalogRules, claims aclcore.Claims) CatalogRules
• type MediaAlbumResolver
• type ScopeRepository
• type ShareAlbumCase
  • func (s *ShareAlbumCase) ShareAlbumWith(owner, folderName, userEmail string) error
• type ShareAlbumCatalogPort
• type UnShareAlbumCase
  • func (u *UnShareAlbumCase) StopSharingAlbum(owner, folderName, email string) error

Types

type CatalogRules

type CatalogRules interface {
	Owner() (string, error)
	SharedWithUserAlbum() ([]catalog.AlbumId, error)
	SharedByUserGrid(owner string) (map[string][]string, error)
	CanListMediasFromAlbum(owner string, folderName string) error
	CanReadMedia(owner string, id string) error
}

func NewCatalogRules

func NewCatalogRules(repository ScopeRepository, mediaAlbumResolver MediaAlbumResolver, email string) CatalogRules

NewCatalogRules creates an adapter catalogacl -> aclcore which will always request DB layer

func OptimiseRulesWithAccessToken

func OptimiseRulesWithAccessToken(delegate CatalogRules, claims aclcore.Claims) CatalogRules

OptimiseRulesWithAccessToken creates an adapter catalogacl -> aclcore with pre-authorised scopes from the Access Token

type MediaAlbumResolver

type MediaAlbumResolver interface {
	FindAlbumOfMedia(owner, mediaId string) (string, error)
}

type ScopeRepository

type ScopeRepository interface {
	aclcore.ScopesReader
	aclcore.ReverseScopesReader
}

type ShareAlbumCase

type ShareAlbumCase struct {
	ScopeWriter aclcore.ScopeWriter
	CatalogPort ShareAlbumCatalogPort
}

func (*ShareAlbumCase) ShareAlbumWith

func (s *ShareAlbumCase) ShareAlbumWith(owner, folderName, userEmail string) error

type ShareAlbumCatalogPort

type ShareAlbumCatalogPort interface {
	FindAlbum(owner, folderName string) (*catalog.Album, error)
}

type UnShareAlbumCase

type UnShareAlbumCase struct {
	RevokeScopeRepository aclcore.ScopeWriter
}

func (*UnShareAlbumCase) StopSharingAlbum

func (u *UnShareAlbumCase) StopSharingAlbum(owner, folderName, email string) error