Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

macaroons

package

Go to main page

Versions in this module

v0

v0.12.2

Mar 18, 2021

Changes in this version

+ const RootKeyLen

+ var DBFilename = "macaroons.db"

+ var DefaultRootKeyID = []byte("0")

+ var ErrAlreadyUnlocked = fmt.Errorf("macaroon store already unlocked")

+ var ErrContextRootKeyID = fmt.Errorf(...)

+ var ErrDeletionForbidden = fmt.Errorf("the specified ID cannot be deleted")

+ var ErrEncKeyNotFound = fmt.Errorf("macaroon encryption key not found")

+ var ErrKeyValueForbidden = fmt.Errorf("root key ID value is not allowed")

+ var ErrMissingRootKeyID = fmt.Errorf("missing root key ID")

+ var ErrPasswordRequired = fmt.Errorf("a non-nil password is required")

+ var ErrRootKeyBucketNotFound = fmt.Errorf("root key bucket not found")

+ var ErrStoreLocked = fmt.Errorf("macaroon store is locked")

+ var PermissionEntityCustomURI = "uri"

+ var RootKeyIDContextKey = contextKey

+ func AddConstraints(mac *macaroon.Macaroon, cs ...Constraint) (*macaroon.Macaroon, error)

+ func ContextWithRootKeyID(ctx context.Context, value interface{}) context.Context

+ func IPLockChecker() (string, checkers.Func)

+ func IPLockConstraint(ipAddr string) func(*macaroon.Macaroon) error

+ func RootKeyIDFromContext(ctx context.Context) ([]byte, error)

+ func TimeoutConstraint(seconds int64) func(*macaroon.Macaroon) error

+ type Checker func() (string, checkers.Func)

+ type Constraint func(*macaroon.Macaroon) error

+ type MacaroonCredential struct

+ func NewMacaroonCredential(m *macaroon.Macaroon) MacaroonCredential

+ func (m MacaroonCredential) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)

+ func (m MacaroonCredential) RequireTransportSecurity() bool

+ type MacaroonValidator interface

+ ValidateMacaroon func(ctx context.Context, requiredPermissions []bakery.Op, fullMethod string) error

+ type RootKeyStorage struct

+ func NewRootKeyStorage(db kvdb.Backend) (*RootKeyStorage, error)

+ func (r *RootKeyStorage) ChangePassword(oldPw, newPw []byte) error

+ func (r *RootKeyStorage) Close() error

+ func (r *RootKeyStorage) CreateUnlock(password *[]byte) error

+ func (r *RootKeyStorage) DeleteMacaroonID(_ context.Context, rootKeyID []byte) ([]byte, error)

+ func (r *RootKeyStorage) GenerateNewRootKey() error

+ func (r *RootKeyStorage) Get(_ context.Context, id []byte) ([]byte, error)

+ func (r *RootKeyStorage) ListMacaroonIDs(_ context.Context) ([][]byte, error)

+ func (r *RootKeyStorage) RootKey(ctx context.Context) ([]byte, []byte, error)

+ type Service struct

+ ExternalValidators map[string]MacaroonValidator

+ StatelessInit bool

+ func NewService(dir, location string, statelessInit bool, dbTimeout time.Duration, ...) (*Service, error)

+ func (svc *Service) ChangePassword(oldPw, newPw []byte) error

+ func (svc *Service) Close() error

+ func (svc *Service) CreateUnlock(password *[]byte) error

+ func (svc *Service) DeleteMacaroonID(ctxt context.Context, rootKeyID []byte) ([]byte, error)

+ func (svc *Service) GenerateNewRootKey() error

+ func (svc *Service) ListMacaroonIDs(ctxt context.Context) ([][]byte, error)

+ func (svc *Service) NewMacaroon(ctx context.Context, rootKeyID []byte, ops ...bakery.Op) (*bakery.Macaroon, error)

+ func (svc *Service) RegisterExternalValidator(fullMethod string, validator MacaroonValidator) error

+ func (svc *Service) ValidateMacaroon(ctx context.Context, requiredPermissions []bakery.Op, fullMethod string) error

v0.5.1-beta-rc4

Nov 26, 2018

v0.5.1-beta-rc3

Nov 21, 2018

v0.5.1-beta-rc2

Nov 16, 2018

v0.5.1-beta-rc1

Nov 15, 2018

v0.5.1-beta

Nov 28, 2018

v0.4.2-beta

May 29, 2018

v0.4.1-beta

Apr 3, 2018