api

package

Go to main page

Versions in this module

v0

v0.5.0

Sep 25, 2018

Changes in this version

type RequestMetadata

+ OrgPubKey []byte

+ func (m *RequestMetadata) GetOrgPubKey() []byte

type ResponseMetadata

+ OrgPubKey []byte

+ func (m *ResponseMetadata) GetOrgPubKey() []byte

v0.4.0

May 31, 2018

Changes in this version

+ var Endpoints = []Endpoint

+ type Endpoint int

+ const All

+ const Find

+ const Get

+ const Introduce

+ const Put

+ const Store

+ const Subscribe

+ const Verify

+ func (e Endpoint) String() string

v0.3.0

Jan 26, 2018

Changes in this version

+ var ErrDiffAuthorPubs = errors.New("page and entry have different author public keys")

+ var ErrEmptyPageKeys = errors.New("empty page keys")

+ var ErrMissingCiphertextSize = errors.New("missing CiphertextSize")

+ var ErrMissingDocument = errors.New("missing document")

+ var ErrMissingEntry = errors.New("missing entry")

+ var ErrMissingEnvelope = errors.New("missing envelope")

+ var ErrMissingMediaType = errors.New("missing MediaType")

+ var ErrMissingPage = errors.New("missing page")

+ var ErrMissingPageKeys = errors.New("missing page keys")

+ var ErrMissingPublication = errors.New("missing Publication")

+ var ErrMissingSubscription = errors.New("missing Subscription")

+ var ErrMissingUncompressedSize = errors.New("missing UncompressedSize")

+ var ErrZeroCreatedTime = errors.New("created time is zero")

v0.2.0

Nov 26, 2017

Changes in this version

+ var CompressionCodec_name = map[int32]string

+ var CompressionCodec_value = map[string]int32

+ func ValidateEntryMetadata(m *EntryMetadata) error

+ type CompressionCodec int32

+ const CompressionCodec_GZIP

+ const CompressionCodec_NONE

+ func (CompressionCodec) EnumDescriptor() ([]byte, []int)

+ func (x CompressionCodec) String() string

type Entry

+ Page *Page

+ PageKeys [][]byte

+ type EntryMetadata struct

+ CiphertextMac []byte

+ CiphertextSize uint64

+ CompressionCodec CompressionCodec

+ DataDictionary *SchemaArtifact

+ Filepath string

+ MediaType string

+ Properties map[string][]byte

+ Schema *SchemaArtifact

+ UncompressedMac []byte

+ UncompressedSize uint64

+ func (*EntryMetadata) Descriptor() ([]byte, []int)

+ func (*EntryMetadata) ProtoMessage()

+ func (m *EntryMetadata) GetCiphertextMac() []byte

+ func (m *EntryMetadata) GetCiphertextSize() uint64

+ func (m *EntryMetadata) GetCompressionCodec() CompressionCodec

+ func (m *EntryMetadata) GetDataDictionary() *SchemaArtifact

+ func (m *EntryMetadata) GetFilepath() string

+ func (m *EntryMetadata) GetMediaType() string

+ func (m *EntryMetadata) GetProperties() map[string][]byte

+ func (m *EntryMetadata) GetSchema() *SchemaArtifact

+ func (m *EntryMetadata) GetUncompressedMac() []byte

+ func (m *EntryMetadata) GetUncompressedSize() uint64

+ func (m *EntryMetadata) MarshalLogObject(oe zapcore.ObjectEncoder) error

+ func (m *EntryMetadata) Reset()

+ func (m *EntryMetadata) String() string

+ type SchemaArtifact struct

+ Group string

+ Name string

+ Path string

+ Project string

+ Version string

+ func (*SchemaArtifact) Descriptor() ([]byte, []int)

+ func (*SchemaArtifact) ProtoMessage()

+ func (m *SchemaArtifact) GetGroup() string

+ func (m *SchemaArtifact) GetName() string

+ func (m *SchemaArtifact) GetPath() string

+ func (m *SchemaArtifact) GetProject() string

+ func (m *SchemaArtifact) GetVersion() string

+ func (m *SchemaArtifact) Reset()

+ func (m *SchemaArtifact) String() string

v0.1.0

Aug 23, 2017

Changes in this version

+ const AESKeyLength

+ const BlockCipherIVLength

+ const DocumentKeyLength

+ const ECPubKeyLength

+ const EEKCiphertextLength

+ const EEKLength

+ const HMAC256Length

+ const HMACKeyLength

+ const KEKLength

+ const MetadataEntryCiphertextMAC

+ const MetadataEntryCiphertextSize

+ const MetadataEntryFilepath

+ const MetadataEntryMediaType

+ const MetadataEntrySchema

+ const MetadataEntryUncompressedMAC

+ const MetadataEntryUncompressedSize

+ const PageIVSeedLength

+ var ErrEmptySubscriptionFilters = errors.New("subscription has empty filters")

+ var ErrUnexpectedDocumentType = errors.New("unexpected document type")

+ var ErrUnexpectedKey = errors.New("unexpected key for value")

+ var ErrUnexpectedNilValue = errors.New("unexpected nil value")

+ var ErrUnexpectedZero = errors.New("unexpected zero value")

+ var ErrUnknownDocumentType = errors.New("unknown document type")

+ var PutOperation_name = map[int32]string

+ var PutOperation_value = map[string]int32

+ func GetAuthorPub(d *Document) []byte

+ func GetEntryPageKeys(entry *Document) ([]id.ID, error)

+ func GetKey(value proto.Message) (id.ID, error)

+ func RandBytes(rng *rand.Rand, length int) []byte

+ func RegisterLibrarianServer(s *grpc.Server, srv LibrarianServer)

+ func ValidateAESKey(value []byte) error

+ func ValidateBytes(value []byte, expectedLen int, name string) error

+ func ValidateDocument(d *Document) error

+ func ValidateEntry(e *Entry) error

+ func ValidateEnvelope(e *Envelope) error

+ func ValidateHMAC256(value []byte) error

+ func ValidateHMACKey(value []byte) error

+ func ValidateMetadata(m *Metadata) error

+ func ValidateMetadataIV(value []byte) error

+ func ValidateNotEmpty(value []byte, name string) error

+ func ValidatePage(p *Page) error

+ func ValidatePageIVSeed(value []byte) error

+ func ValidatePageKeys(pk *PageKeys) error

+ func ValidatePublicKey(value []byte) error

+ func ValidatePublication(p *Publication) error

+ func ValidateSubscription(s *Subscription) error

+ type BloomFilter struct

+ Encoded []byte

+ func (*BloomFilter) Descriptor() ([]byte, []int)

+ func (*BloomFilter) ProtoMessage()

+ func (m *BloomFilter) GetEncoded() []byte

+ func (m *BloomFilter) Reset()

+ func (m *BloomFilter) String() string

+ type Document struct

+ Contents isDocument_Contents

+ func GetPageDocument(page *Page) (*Document, id.ID, error)

+ func NewTestDocument(rng *rand.Rand) (*Document, id.ID)

+ func (*Document) Descriptor() ([]byte, []int)

+ func (*Document) ProtoMessage()

+ func (*Document) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)

+ func (m *Document) GetContents() isDocument_Contents

+ func (m *Document) GetEntry() *Entry

+ func (m *Document) GetEnvelope() *Envelope

+ func (m *Document) GetPage() *Page

+ func (m *Document) Reset()

+ func (m *Document) String() string

+ type Document_Entry struct

+ Entry *Entry

+ type Document_Envelope struct

+ Envelope *Envelope

+ type Document_Page struct

+ Page *Page

+ type Entry struct

+ AuthorPublicKey []byte

+ Contents isEntry_Contents

+ CreatedTime int64

+ MetadataCiphertext []byte

+ MetadataCiphertextMac []byte

+ func NewTestMultiPageEntry(rng *rand.Rand) *Entry

+ func NewTestSinglePageEntry(rng *rand.Rand) *Entry

+ func (*Entry) Descriptor() ([]byte, []int)

+ func (*Entry) ProtoMessage()

+ func (*Entry) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)

+ func (m *Entry) GetAuthorPublicKey() []byte

+ func (m *Entry) GetContents() isEntry_Contents

+ func (m *Entry) GetCreatedTime() int64

+ func (m *Entry) GetMetadataCiphertext() []byte

+ func (m *Entry) GetMetadataCiphertextMac() []byte

+ func (m *Entry) GetPage() *Page

+ func (m *Entry) GetPageKeys() *PageKeys

+ func (m *Entry) Reset()

+ func (m *Entry) String() string

+ type Entry_Page struct

+ Page *Page

+ type Entry_PageKeys struct

+ PageKeys *PageKeys

+ type Envelope struct

+ AuthorPublicKey []byte

+ EekCiphertext []byte

+ EekCiphertextMac []byte

+ EntryKey []byte

+ ReaderPublicKey []byte

+ func NewTestEnvelope(rng *rand.Rand) *Envelope

+ func (*Envelope) Descriptor() ([]byte, []int)

+ func (*Envelope) ProtoMessage()

+ func (m *Envelope) GetAuthorPublicKey() []byte

+ func (m *Envelope) GetEekCiphertext() []byte

+ func (m *Envelope) GetEekCiphertextMac() []byte

+ func (m *Envelope) GetEntryKey() []byte

+ func (m *Envelope) GetReaderPublicKey() []byte

+ func (m *Envelope) Reset()

+ func (m *Envelope) String() string

+ type FindRequest struct

+ Key []byte

+ Metadata *RequestMetadata

+ NumPeers uint32

+ func (*FindRequest) Descriptor() ([]byte, []int)

+ func (*FindRequest) ProtoMessage()

+ func (m *FindRequest) GetKey() []byte

+ func (m *FindRequest) GetMetadata() *RequestMetadata

+ func (m *FindRequest) GetNumPeers() uint32

+ func (m *FindRequest) Reset()

+ func (m *FindRequest) String() string

+ type FindResponse struct

+ Metadata *ResponseMetadata

+ Peers []*PeerAddress

+ Value *Document

+ func (*FindResponse) Descriptor() ([]byte, []int)

+ func (*FindResponse) ProtoMessage()

+ func (m *FindResponse) GetMetadata() *ResponseMetadata

+ func (m *FindResponse) GetPeers() []*PeerAddress

+ func (m *FindResponse) GetValue() *Document

+ func (m *FindResponse) Reset()

+ func (m *FindResponse) String() string

+ type Finder interface

+ Find func(ctx context.Context, in *FindRequest, opts ...grpc.CallOption) (*FindResponse, error)

+ type GetRequest struct

+ Key []byte

+ Metadata *RequestMetadata

+ func (*GetRequest) Descriptor() ([]byte, []int)

+ func (*GetRequest) ProtoMessage()

+ func (m *GetRequest) GetKey() []byte

+ func (m *GetRequest) GetMetadata() *RequestMetadata

+ func (m *GetRequest) Reset()

+ func (m *GetRequest) String() string

+ type GetResponse struct

+ Metadata *ResponseMetadata

+ Value *Document

+ func (*GetResponse) Descriptor() ([]byte, []int)

+ func (*GetResponse) ProtoMessage()

+ func (m *GetResponse) GetMetadata() *ResponseMetadata

+ func (m *GetResponse) GetValue() *Document

+ func (m *GetResponse) Reset()

+ func (m *GetResponse) String() string

+ type Getter interface

+ Get func(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*GetResponse, error)

+ type IntroduceRequest struct

+ Metadata *RequestMetadata

+ NumPeers uint32

+ Self *PeerAddress

+ func (*IntroduceRequest) Descriptor() ([]byte, []int)

+ func (*IntroduceRequest) ProtoMessage()

+ func (m *IntroduceRequest) GetMetadata() *RequestMetadata

+ func (m *IntroduceRequest) GetNumPeers() uint32

+ func (m *IntroduceRequest) GetSelf() *PeerAddress

+ func (m *IntroduceRequest) Reset()

+ func (m *IntroduceRequest) String() string

+ type IntroduceResponse struct

+ Metadata *ResponseMetadata

+ Peers []*PeerAddress

+ Self *PeerAddress

+ func (*IntroduceResponse) Descriptor() ([]byte, []int)

+ func (*IntroduceResponse) ProtoMessage()

+ func (m *IntroduceResponse) GetMetadata() *ResponseMetadata

+ func (m *IntroduceResponse) GetPeers() []*PeerAddress

+ func (m *IntroduceResponse) GetSelf() *PeerAddress

+ func (m *IntroduceResponse) Reset()

+ func (m *IntroduceResponse) String() string

+ type Introducer interface

+ Introduce func(ctx context.Context, in *IntroduceRequest, opts ...grpc.CallOption) (*IntroduceResponse, error)

+ type LibrarianClient interface

+ Find func(ctx context.Context, in *FindRequest, opts ...grpc.CallOption) (*FindResponse, error)

+ Get func(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*GetResponse, error)

+ Introduce func(ctx context.Context, in *IntroduceRequest, opts ...grpc.CallOption) (*IntroduceResponse, error)

+ Put func(ctx context.Context, in *PutRequest, opts ...grpc.CallOption) (*PutResponse, error)

+ Store func(ctx context.Context, in *StoreRequest, opts ...grpc.CallOption) (*StoreResponse, error)

+ Subscribe func(ctx context.Context, in *SubscribeRequest, opts ...grpc.CallOption) (Librarian_SubscribeClient, error)

+ Verify func(ctx context.Context, in *VerifyRequest, opts ...grpc.CallOption) (*VerifyResponse, error)

+ func NewLibrarianClient(cc *grpc.ClientConn) LibrarianClient

+ type LibrarianServer interface

+ Find func(context.Context, *FindRequest) (*FindResponse, error)

+ Get func(context.Context, *GetRequest) (*GetResponse, error)

+ Introduce func(context.Context, *IntroduceRequest) (*IntroduceResponse, error)

+ Put func(context.Context, *PutRequest) (*PutResponse, error)

+ Store func(context.Context, *StoreRequest) (*StoreResponse, error)

+ Subscribe func(*SubscribeRequest, Librarian_SubscribeServer) error

+ Verify func(context.Context, *VerifyRequest) (*VerifyResponse, error)

+ type Librarian_SubscribeClient interface

+ Recv func() (*SubscribeResponse, error)

+ type Librarian_SubscribeServer interface

+ Send func(*SubscribeResponse) error

+ type Metadata struct

+ Properties map[string][]byte

+ func NewEntryMetadata(mediaType string, ciphertextSize uint64, ciphertextMAC []byte, ...) (*Metadata, error)

+ func (*Metadata) Descriptor() ([]byte, []int)

+ func (*Metadata) ProtoMessage()

+ func (m *Metadata) GetBytes(key string) ([]byte, bool)

+ func (m *Metadata) GetCiphertextMAC() ([]byte, bool)

+ func (m *Metadata) GetCiphertextSize() (uint64, bool)

+ func (m *Metadata) GetMediaType() (string, bool)

+ func (m *Metadata) GetProperties() map[string][]byte

+ func (m *Metadata) GetString(key string) (string, bool)

+ func (m *Metadata) GetUint64(key string) (uint64, bool)

+ func (m *Metadata) GetUncompressedMAC() ([]byte, bool)

+ func (m *Metadata) GetUncompressedSize() (uint64, bool)

+ func (m *Metadata) MarshalLogObject(oe zapcore.ObjectEncoder) error

+ func (m *Metadata) Reset()

+ func (m *Metadata) SetBytes(key string, value []byte)

+ func (m *Metadata) SetString(key string, value string)

+ func (m *Metadata) SetUint64(key string, value uint64)

+ func (m *Metadata) String() string

+ type Page struct

+ AuthorPublicKey []byte

+ Ciphertext []byte

+ CiphertextMac []byte

+ Index uint32

+ func NewTestPage(rng *rand.Rand) *Page

+ func (*Page) Descriptor() ([]byte, []int)

+ func (*Page) ProtoMessage()

+ func (m *Page) GetAuthorPublicKey() []byte

+ func (m *Page) GetCiphertext() []byte

+ func (m *Page) GetCiphertextMac() []byte

+ func (m *Page) GetIndex() uint32

+ func (m *Page) Reset()

+ func (m *Page) String() string

+ type PageKeys struct

+ Keys [][]byte

+ func (*PageKeys) Descriptor() ([]byte, []int)

+ func (*PageKeys) ProtoMessage()

+ func (m *PageKeys) GetKeys() [][]byte

+ func (m *PageKeys) Reset()

+ func (m *PageKeys) String() string

+ type PeerAddress struct

+ Ip string

+ PeerId []byte

+ PeerName string

+ Port uint32

+ func (*PeerAddress) Descriptor() ([]byte, []int)

+ func (*PeerAddress) ProtoMessage()

+ func (m *PeerAddress) GetIp() string

+ func (m *PeerAddress) GetPeerId() []byte

+ func (m *PeerAddress) GetPeerName() string

+ func (m *PeerAddress) GetPort() uint32

+ func (m *PeerAddress) Reset()

+ func (m *PeerAddress) String() string

+ type Publication struct

+ AuthorPublicKey []byte

+ EntryKey []byte

+ EnvelopeKey []byte

+ ReaderPublicKey []byte

+ func GetPublication(key []byte, value *Document) *Publication

+ func NewTestPublication(rng *rand.Rand) *Publication

+ func (*Publication) Descriptor() ([]byte, []int)

+ func (*Publication) ProtoMessage()

+ func (m *Publication) GetAuthorPublicKey() []byte

+ func (m *Publication) GetEntryKey() []byte

+ func (m *Publication) GetEnvelopeKey() []byte

+ func (m *Publication) GetReaderPublicKey() []byte

+ func (m *Publication) Reset()

+ func (m *Publication) String() string

+ type PutOperation int32

+ const PutOperation_LEFT_EXISTING

+ const PutOperation_STORED

+ func (PutOperation) EnumDescriptor() ([]byte, []int)

+ func (x PutOperation) String() string

+ type PutRequest struct

+ Key []byte

+ Metadata *RequestMetadata

+ Value *Document

+ func (*PutRequest) Descriptor() ([]byte, []int)

+ func (*PutRequest) ProtoMessage()

+ func (m *PutRequest) GetKey() []byte

+ func (m *PutRequest) GetMetadata() *RequestMetadata

+ func (m *PutRequest) GetValue() *Document

+ func (m *PutRequest) Reset()

+ func (m *PutRequest) String() string

+ type PutResponse struct

+ Metadata *ResponseMetadata

+ NReplicas uint32

+ Operation PutOperation

+ func (*PutResponse) Descriptor() ([]byte, []int)

+ func (*PutResponse) ProtoMessage()

+ func (m *PutResponse) GetMetadata() *ResponseMetadata

+ func (m *PutResponse) GetNReplicas() uint32

+ func (m *PutResponse) GetOperation() PutOperation

+ func (m *PutResponse) Reset()

+ func (m *PutResponse) String() string

+ type Putter interface

+ Put func(ctx context.Context, in *PutRequest, opts ...grpc.CallOption) (*PutResponse, error)

+ type PutterGetter interface

+ type RequestMetadata struct

+ PubKey []byte

+ RequestId []byte

+ func (*RequestMetadata) Descriptor() ([]byte, []int)

+ func (*RequestMetadata) ProtoMessage()

+ func (m *RequestMetadata) GetPubKey() []byte

+ func (m *RequestMetadata) GetRequestId() []byte

+ func (m *RequestMetadata) Reset()

+ func (m *RequestMetadata) String() string

+ type ResponseMetadata struct

+ PubKey []byte

+ RequestId []byte

+ func (*ResponseMetadata) Descriptor() ([]byte, []int)

+ func (*ResponseMetadata) ProtoMessage()

+ func (m *ResponseMetadata) GetPubKey() []byte

+ func (m *ResponseMetadata) GetRequestId() []byte

+ func (m *ResponseMetadata) Reset()

+ func (m *ResponseMetadata) String() string

+ type StoreRequest struct

+ Key []byte

+ Metadata *RequestMetadata

+ Value *Document

+ func (*StoreRequest) Descriptor() ([]byte, []int)

+ func (*StoreRequest) ProtoMessage()

+ func (m *StoreRequest) GetKey() []byte

+ func (m *StoreRequest) GetMetadata() *RequestMetadata

+ func (m *StoreRequest) GetValue() *Document

+ func (m *StoreRequest) Reset()

+ func (m *StoreRequest) String() string

+ type StoreResponse struct

+ Metadata *ResponseMetadata

+ func (*StoreResponse) Descriptor() ([]byte, []int)

+ func (*StoreResponse) ProtoMessage()

+ func (m *StoreResponse) GetMetadata() *ResponseMetadata

+ func (m *StoreResponse) Reset()

+ func (m *StoreResponse) String() string

+ type Storer interface

+ Store func(ctx context.Context, in *StoreRequest, opts ...grpc.CallOption) (*StoreResponse, error)

+ type SubscribeRequest struct

+ Metadata *RequestMetadata

+ Subscription *Subscription

+ func (*SubscribeRequest) Descriptor() ([]byte, []int)

+ func (*SubscribeRequest) ProtoMessage()

+ func (m *SubscribeRequest) GetMetadata() *RequestMetadata

+ func (m *SubscribeRequest) GetSubscription() *Subscription

+ func (m *SubscribeRequest) Reset()

+ func (m *SubscribeRequest) String() string

+ type SubscribeResponse struct

+ Key []byte

+ Metadata *ResponseMetadata

+ Value *Publication

+ func (*SubscribeResponse) Descriptor() ([]byte, []int)

+ func (*SubscribeResponse) ProtoMessage()

+ func (m *SubscribeResponse) GetKey() []byte

+ func (m *SubscribeResponse) GetMetadata() *ResponseMetadata

+ func (m *SubscribeResponse) GetValue() *Publication

+ func (m *SubscribeResponse) Reset()

+ func (m *SubscribeResponse) String() string

+ type Subscriber interface

+ Subscribe func(ctx context.Context, in *SubscribeRequest, opts ...grpc.CallOption) (Librarian_SubscribeClient, error)

+ type Subscription struct

+ AuthorPublicKeys *BloomFilter

+ ReaderPublicKeys *BloomFilter

+ func (*Subscription) Descriptor() ([]byte, []int)

+ func (*Subscription) ProtoMessage()

+ func (m *Subscription) GetAuthorPublicKeys() *BloomFilter

+ func (m *Subscription) GetReaderPublicKeys() *BloomFilter

+ func (m *Subscription) Reset()

+ func (m *Subscription) String() string

+ type Verifier interface

+ Verify func(ctx context.Context, in *VerifyRequest, opts ...grpc.CallOption) (*VerifyResponse, error)

+ type VerifyRequest struct

+ Key []byte

+ MacKey []byte

+ Metadata *RequestMetadata

+ NumPeers uint32

+ func (*VerifyRequest) Descriptor() ([]byte, []int)

+ func (*VerifyRequest) ProtoMessage()

+ func (m *VerifyRequest) GetKey() []byte

+ func (m *VerifyRequest) GetMacKey() []byte

+ func (m *VerifyRequest) GetMetadata() *RequestMetadata

+ func (m *VerifyRequest) GetNumPeers() uint32

+ func (m *VerifyRequest) Reset()

+ func (m *VerifyRequest) String() string

+ type VerifyResponse struct

+ Mac []byte

+ Metadata *ResponseMetadata

+ Peers []*PeerAddress

+ func (*VerifyResponse) Descriptor() ([]byte, []int)

+ func (*VerifyResponse) ProtoMessage()

+ func (m *VerifyResponse) GetMac() []byte

+ func (m *VerifyResponse) GetMetadata() *ResponseMetadata

+ func (m *VerifyResponse) GetPeers() []*PeerAddress

+ func (m *VerifyResponse) Reset()

+ func (m *VerifyResponse) String() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL