mgorootkeystore

Documentation

Overview

Package mgorootkeystore provides an implementation of bakery.RootKeyStore that uses MongoDB as a persistent store.

Index

• func ContextWithMgoSession(ctx context.Context, s *mgo.Session) context.Context
• type Policy
• type RootKeys
  • func NewRootKeys(maxCacheSize int) *RootKeys
  • func (s *RootKeys) EnsureIndex(c *mgo.Collection) error
  • func (s *RootKeys) NewStore(c *mgo.Collection, policy Policy) bakery.RootKeyStore

Functions

func ContextWithMgoSession

func ContextWithMgoSession(ctx context.Context, s *mgo.Session) context.Context

ContextWithMgoSession adds the given mgo.Session to the given context.Context. Any operations requiring database access that are made using a context with an attached session will use the session from the context to access mongodb, rather than the session in the collection used when the RootKeyStore was created.

Types

type Policy

type Policy dbrootkeystore.Policy

Policy holds a store policy for root keys.

type RootKeys

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

RootKeys represents a cache of macaroon root keys.

func NewRootKeys

func NewRootKeys(maxCacheSize int) *RootKeys

NewRootKeys returns a root-keys cache that is limited in size to approximately the given size.

The NewStore method returns a store implementation that uses a specific mongo collection and store policy.

func (*RootKeys) EnsureIndex

func (s *RootKeys) EnsureIndex(c *mgo.Collection) error

EnsureIndex ensures that the required indexes exist on the collection that will be used for root key store. This should be called at least once before using NewStore.

func (*RootKeys) NewStore

func (s *RootKeys) NewStore(c *mgo.Collection, policy Policy) bakery.RootKeyStore

NewStore returns a new RootKeyStore implementation that stores and obtains root keys from the given collection.

Root keys will be generated and stored following the given store policy.

It is expected that all collections passed to a given Store's NewStore method should refer to the same underlying collection.