api

package

Go to main page

Versions in this module

v1

v1.0.7

May 11, 2021

v1.0.6

Jul 26, 2019

Changes in this version

+ const FeedContentType

+ const MimeOctetStream

+ var ErrCannotLoadFeedManifest = errors.New("Cannot load feed manifest")

+ var ErrCannotResolveFeed = errors.New("Cannot resolve Feed")

+ var ErrCannotResolveFeedURI = errors.New("Cannot resolve Feed URI")

+ var ErrNotAFeedManifest = errors.New("Not a feed manifest")

+ func DetectContentType(fileName string, f io.ReadSeeker) (string, error)

+ func DoACT(ctx *cli.Context, privateKey *ecdsa.PrivateKey, salt []byte, grantees []string, ...) (accessKey []byte, ae *AccessEntry, actManifest *Manifest, err error)

type API

+ func (a *API) FeedsLookup(ctx context.Context, query *feed.Query) ([]byte, error)

+ func (a *API) FeedsNewRequest(ctx context.Context, feed *feed.Feed) (*feed.Request, error)

+ func (a *API) FeedsUpdate(ctx context.Context, request *feed.Request) (storage.Address, error)

+ func (a *API) NewFeedManifest(ctx context.Context, feed *feed.Feed) (storage.Address, error)

+ func (a *API) ResolveFeed(ctx context.Context, uri *URI, values feed.Values) (*feed.Feed, error)

+ func (a *API) ResolveFeedManifest(ctx context.Context, addr storage.Address) (*feed.Feed, error)

type AccessEntry

+ func DoPK(ctx *cli.Context, privateKey *ecdsa.PrivateKey, granteePublicKey string, ...) (sessionKey []byte, ae *AccessEntry, err error)

+ func DoPassword(ctx *cli.Context, password string, salt []byte) (sessionKey []byte, ae *AccessEntry, err error)

type Config

+ BootnodeMode bool

+ GlobalStoreAPI string

+ MaxStreamPeerServers int

+ SyncingSkipCheck bool

+ type HasInfo struct

+ Addr string

+ Has bool

+ type Inspector struct

+ func NewInspector(api *API, hive *network.Hive, netStore *storage.NetStore) *Inspector

+ func (inspector *Inspector) Has(chunkAddresses []storage.Address) []HasInfo

+ func (inspector *Inspector) Hive() string

type ManifestEntry

+ Feed *feed.Feed

type URI

+ func (u *URI) Feed() bool

v1.0.4

Dec 7, 2018

Changes in this version

+ const AccessTypeACT

+ const AccessTypePK

+ const AccessTypePass

+ const EMPTY_CREDENTIALS

+ var AllowedDecryptDomains = []string

+ var DefaultKdfParams = NewKdfParams(262144, 1, 8)

+ var ErrDecrypt = errors.New("cant decrypt - forbidden")

+ var ErrDecryptDomainForbidden = errors.New("decryption request domain forbidden - can only decrypt on localhost")

+ var ErrNotFound = errors.New("not found")

+ var ErrUnknownAccessType = errors.New("unknown access type (or not implemented)")

+ func DoACTNew(ctx *cli.Context, privateKey *ecdsa.PrivateKey, salt []byte, grantees []string) (accessKey []byte, ae *AccessEntry, actManifest *Manifest, err error)

+ func NOOPDecrypt(*ManifestEntry) error

+ func NewSessionKeyPK(private *ecdsa.PrivateKey, public *ecdsa.PublicKey, salt []byte) ([]byte, error)

+ func NewSessionKeyPassword(password string, accessEntry *AccessEntry) ([]byte, error)

type API

+ Decryptor func(context.Context, string) DecryptFunc

+ func (a *API) NodeSessionKey(privateKey *ecdsa.PrivateKey, publicKey *ecdsa.PublicKey, salt []byte) ([]byte, error)

+ func (a *API) ResolveURI(ctx context.Context, uri *URI, credentials string) (storage.Address, error)

+ type AccessEntry struct

+ Act string

+ KdfParams *KdfParams

+ Publisher string

+ Salt []byte

+ Type AccessType

+ func DoPKNew(ctx *cli.Context, privateKey *ecdsa.PrivateKey, granteePublicKey string, ...) (sessionKey []byte, ae *AccessEntry, err error)

+ func DoPasswordNew(ctx *cli.Context, password string, salt []byte) (sessionKey []byte, ae *AccessEntry, err error)

+ func NewAccessEntryACT(publisher string, salt []byte, act string) (*AccessEntry, error)

+ func NewAccessEntryPK(publisher string, salt []byte) (*AccessEntry, error)

+ func NewAccessEntryPassword(salt []byte, kdfParams *KdfParams) (*AccessEntry, error)

+ func (a *AccessEntry) MarshalJSON() (out []byte, err error)

+ func (a *AccessEntry) UnmarshalJSON(value []byte) error

+ type AccessType string

type Config

+ LightNodeEnabled bool

+ type DecryptFunc func(*ManifestEntry) error

+ type KdfParams struct

+ N int

+ P int

+ R int

+ func NewKdfParams(n, p, r int) *KdfParams

type Manifest

+ func GenerateAccessControlManifest(ctx *cli.Context, ref string, accessKey []byte, ae *AccessEntry) (*Manifest, error)

type ManifestEntry

+ Access *AccessEntry

+ type RefEncryption struct

+ func NewRefEncryption(refSize int) *RefEncryption

+ func (re *RefEncryption) Decrypt(ref []byte, key []byte) ([]byte, error)

+ func (re *RefEncryption) Encrypt(ref []byte, key []byte) ([]byte, error)

type URI

+ func (u *URI) MarshalJSON() (out []byte, err error)

+ func (u *URI) UnmarshalJSON(value []byte) error

v1.0.3

Sep 18, 2018

Changes in this version

+ const DefaultHTTPListenAddr

+ const DefaultHTTPPort

+ const ManifestType

+ const ResourceContentType

+ var ErrSkipManifest = errors.New("skip this manifest")

+ func RegularSlashes(path string) (res string)

+ type API struct

+ func NewAPI(fileStore *storage.FileStore, dns Resolver, resourceHandler *mru.Handler) (self *API)

+ func (a *API) AddFile(ctx context.Context, mhash, path, fname string, content []byte, ...) (storage.Address, string, error)

+ func (a *API) AppendFile(ctx context.Context, mhash, path, fname string, existingSize int64, ...) (storage.Address, string, error)

+ func (a *API) BuildDirectoryTree(ctx context.Context, mhash string, nameresolver bool) (addr storage.Address, manifestEntryMap map[string]*manifestTrieEntry, ...)

+ func (a *API) Delete(ctx context.Context, addr string, path string) (storage.Address, error)

+ func (a *API) Get(ctx context.Context, manifestAddr storage.Address, path string) (reader storage.LazySectionReader, mimeType string, status int, ...)

+ func (a *API) GetDirectoryTar(ctx context.Context, uri *URI) (io.ReadCloser, error)

+ func (a *API) GetManifestList(ctx context.Context, addr storage.Address, prefix string) (list ManifestList, err error)

+ func (a *API) Modify(ctx context.Context, addr storage.Address, ...) (storage.Address, error)

+ func (a *API) NewManifest(ctx context.Context, toEncrypt bool) (storage.Address, error)

+ func (a *API) NewManifestWalker(ctx context.Context, addr storage.Address, quitC chan bool) (*ManifestWalker, error)

+ func (a *API) NewManifestWriter(ctx context.Context, addr storage.Address, quitC chan bool) (*ManifestWriter, error)

+ func (a *API) NewResourceManifest(ctx context.Context, resourceAddr string) (storage.Address, error)

+ func (a *API) Put(ctx context.Context, content string, contentType string, toEncrypt bool) (k storage.Address, wait func(context.Context) error, err error)

+ func (a *API) RemoveFile(ctx context.Context, mhash string, path string, fname string, ...) (string, error)

+ func (a *API) Resolve(ctx context.Context, uri *URI) (storage.Address, error)

+ func (a *API) ResolveResourceManifest(ctx context.Context, addr storage.Address) (storage.Address, error)

+ func (a *API) ResourceCreate(ctx context.Context, request *mru.Request) error

+ func (a *API) ResourceHashSize() int

+ func (a *API) ResourceLookup(ctx context.Context, params *mru.LookupParams) (string, []byte, error)

+ func (a *API) ResourceNewRequest(ctx context.Context, rootAddr storage.Address) (*mru.Request, error)

+ func (a *API) ResourceUpdate(ctx context.Context, request *mru.SignedResourceUpdate) (storage.Address, error)

+ func (a *API) Retrieve(ctx context.Context, addr storage.Address) (reader storage.LazySectionReader, isEncrypted bool)

+ func (a *API) Store(ctx context.Context, data io.Reader, size int64, toEncrypt bool) (addr storage.Address, wait func(ctx context.Context) error, err error)

+ func (a *API) UpdateManifest(ctx context.Context, addr storage.Address, ...) (storage.Address, error)

+ func (a *API) Upload(ctx context.Context, uploadDir, index string, toEncrypt bool) (hash string, err error)

+ func (a *API) UploadTar(ctx context.Context, bodyReader io.ReadCloser, manifestPath string, ...) (storage.Address, error)

+ type Config struct

+ BootNodes string

+ BzzAccount string

+ BzzKey string

+ Contract common.Address

+ Cors string

+ DeliverySkipCheck bool

+ EnsAPIs []string

+ EnsRoot common.Address

+ ListenAddr string

+ NetworkID uint64

+ NodeID string

+ Path string

+ Port string

+ Pss *pss.PssParams

+ PublicKey string

+ Swap *swap.LocalProfile

+ SwapAPI string

+ SwapEnabled bool

+ SyncEnabled bool

+ SyncUpdateDelay time.Duration

+ func NewConfig() (c *Config)

+ func (c *Config) Init(prvKey *ecdsa.PrivateKey)

+ func (c *Config) ShiftPrivateKey() (privKey *ecdsa.PrivateKey)

+ type Control struct

+ func NewControl(api *API, hive *network.Hive) *Control

+ func (c *Control) Hive() string

+ type ErrResolve error

+ type FileSystem struct

+ func NewFileSystem(api *API) *FileSystem

+ func (fs *FileSystem) Download(bzzpath, localpath string) error

+ func (fs *FileSystem) Upload(lpath, index string, toEncrypt bool) (string, error)

+ type Manifest struct

+ Entries []ManifestEntry

+ type ManifestEntry struct

+ ContentType string

+ Hash string

+ ModTime time.Time

+ Mode int64

+ Path string

+ Size int64

+ Status int

+ type ManifestList struct

+ CommonPrefixes []string

+ Entries []*ManifestEntry

+ type ManifestWalker struct

+ func (m *ManifestWalker) Walk(walkFn WalkFn) error

+ type ManifestWriter struct

+ func (m *ManifestWriter) AddEntry(ctx context.Context, data io.Reader, e *ManifestEntry) (storage.Address, error)

+ func (m *ManifestWriter) RemoveEntry(path string) error

+ func (m *ManifestWriter) Store() (storage.Address, error)

+ type MultiResolver struct

+ func NewMultiResolver(opts ...MultiResolverOption) (m *MultiResolver)

+ func (m *MultiResolver) HeaderByNumber(ctx context.Context, name string, blockNr *big.Int) (*types.Header, error)

+ func (m *MultiResolver) Resolve(addr string) (h common.Hash, err error)

+ func (m *MultiResolver) SetNameHash(nameHash func(string) common.Hash)

+ func (m *MultiResolver) ValidateOwner(name string, address common.Address) (bool, error)

+ type MultiResolverOption func(*MultiResolver)

+ func MultiResolverOptionWithNameHash(nameHash func(string) common.Hash) MultiResolverOption

+ func MultiResolverOptionWithResolver(r ResolveValidator, tld string) MultiResolverOption

+ type NoResolverError struct

+ TLD string

+ func NewNoResolverError(tld string) *NoResolverError

+ func (e *NoResolverError) Error() string

+ type ResolveValidator interface

+ HeaderByNumber func(context.Context, *big.Int) (*types.Header, error)

+ Owner func(node [32]byte) (common.Address, error)

+ type Resolver interface

+ Resolve func(string) (common.Hash, error)

+ type Response struct

+ Content string

+ MimeType string

+ Size int64

+ Status int

+ type Storage struct

+ func NewStorage(api *API) *Storage

+ func (s *Storage) Get(ctx context.Context, bzzpath string) (*Response, error)

+ func (s *Storage) Modify(ctx context.Context, rootHash, path, contentHash, contentType string) (newRootHash string, err error)

+ func (s *Storage) Put(ctx context.Context, content string, contentType string, toEncrypt bool) (storage.Address, func(context.Context) error, error)

+ type URI struct

+ Addr string

+ Path string

+ Scheme string

+ func Parse(rawuri string) (*URI, error)

+ func (u *URI) Address() storage.Address

+ func (u *URI) Hash() bool

+ func (u *URI) Immutable() bool

+ func (u *URI) List() bool

+ func (u *URI) Raw() bool

+ func (u *URI) Resource() bool

+ func (u *URI) String() string

+ type WalkFn func(entry *ManifestEntry) error

v1.0.3-v3

Sep 26, 2018

v1.0.3-v2

Sep 21, 2018

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