pool

Documentation

Index

• Constants
• Variables
• func Define(c Config) error
• func EncodeToken(t Token, guest *security.Identity) (string, error)
• func List() []string
• func Load(name string) ([]transport.Config, error)
• func Save(name string, configs []transport.Config) error
• type AccessFile
• type Config
  • func GetConfig(name string) (Config, error)
• type Consumer
• type Grant
• type Head
• type Header
• type Identity
• type Keystore
• type Pool
  • func Create(self security.Identity, name string) (*Pool, error)
  • func Open(self security.Identity, name string) (*Pool, error)
  • func (p *Pool) Close()
  • func (p *Pool) Delete() error
  • func (p *Pool) ExportAccessFile(e transport.Exchanger) error
  • func (p *Pool) Get(id uint64, rang *transport.Range, w io.Writer) error
  • func (p *Pool) Identities() ([]Identity, error)
  • func (p *Pool) ImportAccess(e transport.Exchanger) (hash.Hash, error)
  • func (p *Pool) List(afterId uint64, afterTs time.Time) []Head
  • func (p *Pool) Post(name string, r io.Reader, meta []byte) (Head, error)
  • func (p *Pool) Sync()
• type Token
  • func DecodeToken(guest *security.Identity, token string) (Token, error)

Constants

const (
	ID_CREATE       = 0x0
	ID_FORCE_CREATE = 0x1
)

const SafeConfigFile = ".safepool-pool.json"

Variables

var Connections = map[string]transport.Exchanger{}

var ConnectionsMutex = &sync.Mutex{}

var ErrAlreadyExist = errors.New("pool already exists")

var ErrInvalidConfig = errors.New("provided config is invalid: missing name or configs")

var ErrInvalidSignature = errors.New("signature is invalid")

var ErrInvalidToken = errors.New("provided token is invalid: missing name or configs")

var ErrNoExchange = errors.New("no Exchange available")

var ErrNotAuthorized = errors.New("no authorization for this file")

var ErrNotTrusted = errors.New("the author is not a trusted user")

var ForceCreation = false

var ReplicaPeriod = time.Hour

Functions

func Define

func Define(c Config) error

func EncodeToken

func EncodeToken(t Token, guest *security.Identity) (string, error)

func List

func List() []string

func Load

func Load(name string) ([]transport.Config, error)

func Save

func Save(name string, configs []transport.Config) error

Types

type AccessFile

type AccessFile struct {
	Version     float32
	Grants      []Grant
	Nonce       []byte
	MasterKeyId uint64
	Keystore    []byte
}

type Config

type Config struct {
	Name    string
	Configs []transport.Config
}

func GetConfig

func GetConfig(name string) (Config, error)

type Consumer

type Consumer interface {
	TimeOffset(s *Pool) time.Time
	Accept(s *Pool, h Head) bool
}

type Grant

type Grant struct {
	Identity    security.Identity
	Since       uint64
	KeystoreKey []byte
}

type Head

type Head struct {
	Id        uint64
	Name      string
	Size      int64
	Hash      []byte
	ModTime   time.Time
	Author    security.Identity
	Signature []byte
	TimeStamp time.Time `json:"-"`
	Meta      []byte
}

type Header

type Header struct {
	Version float32 `json:"v"`
	Thread  uint64  `json:"t"`
	Key     uint64  `json:"k"`
	Hash    []byte  `json:"h"`
	Name    string  `json:"s"`
}

type Identity

type Identity struct {
	security.Identity
	//Since is the keyId used when the identity was added to the Pool access
	Since uint64
	//AddedOn is the timestamp when the identity is stored on the local DB
	AddedOn time.Time
}

type Keystore

type Keystore map[uint64][]byte

type Pool

type Pool struct {
	Name      string
	Self      security.Identity
	Consumers []Consumer
	// contains filtered or unexported fields
}

func Create

func Create(self security.Identity, name string) (*Pool, error)

func Open

func Open(self security.Identity, name string) (*Pool, error)

Init initialized a domain on the specified exchangers

func (*Pool) Close

func (p *Pool) Close()

func (*Pool) Delete

func (p *Pool) Delete() error

func (*Pool) ExportAccessFile

func (p *Pool) ExportAccessFile(e transport.Exchanger) error

func (*Pool) Get

func (p *Pool) Get(id uint64, rang *transport.Range, w io.Writer) error

func (*Pool) Identities

func (p *Pool) Identities() ([]Identity, error)

func (*Pool) ImportAccess

func (p *Pool) ImportAccess(e transport.Exchanger) (hash.Hash, error)

func (*Pool) List

func (p *Pool) List(afterId uint64, afterTs time.Time) []Head

func (*Pool) Post

func (p *Pool) Post(name string, r io.Reader, meta []byte) (Head, error)

func (*Pool) Sync

func (p *Pool) Sync()

type Token

type Token struct {
	Config Config
	Host   security.Identity
}

func DecodeToken

func DecodeToken(guest *security.Identity, token string) (Token, error)