index

Documentation

Index

• Constants
• Variables
• type SecureIndex
  • func NewSecureIndex(ctx context.Context, keyProvider key.Provider, ioProvider io.Provider, ...) (SecureIndex, error)
  • func (i *SecureIndex) Add(ctx context.Context, token, keyword, identifier string) error
  • func (i *SecureIndex) Delete(ctx context.Context, token, keyword, identifier string) error
  • func (i *SecureIndex) Search(ctx context.Context, token, keyword string) ([]string, error)

Constants

const MasterKeyLength = 32

The length of the master key.

Variables

var ErrInvalidMasterKeyLength = fmt.Errorf("invalid key length, accepted key length is %d bytes", MasterKeyLength)

Error returned if a master key with invalid length is used.

var ErrNodeAlreadyExists = errors.New("node already exists")

Error returned if an node already exists in the IO Provider.

var ErrNodeNotFound = errors.New("node not found")

Error returned if an node was not found in the IO Provider.

var ErrNotAuthenticated = errors.New("user not authenticated")

Error returned if the caller cannot be authenticated by the Identity Provider.

var ErrNotAuthorized = errors.New("user not authorized")

Error returned if a user tries to access data they are not authorized for.

Types

type SecureIndex

type SecureIndex struct {
	// contains filtered or unexported fields
}

func NewSecureIndex

func NewSecureIndex(ctx context.Context, keyProvider key.Provider, ioProvider io.Provider, idProvider id.Provider) (SecureIndex, error)

NewSecureIndex creates a SecureIndex which is used to manage keyword/identifier pairs.

func (*SecureIndex) Add

func (i *SecureIndex) Add(ctx context.Context, token, keyword, identifier string) error

Add adds a keyword/identifier pair to the secure index.

func (*SecureIndex) Delete

func (i *SecureIndex) Delete(ctx context.Context, token, keyword, identifier string) error

Delete deletes all occurrences of a keyword/identifier pair from the secure index.

func (*SecureIndex) Search

func (i *SecureIndex) Search(ctx context.Context, token, keyword string) ([]string, error)

Search returns all identifiers that the given keyword is contained in.