FrostFS API documentation and proto files declaration
Find a file
alexvanin afd55ac90b acl: Define target of access control rules
Basic NeoFS ACL applies access rules to request sender. Request
senders are combined in groups that calls `targets`.

Basic ACL rules may be applied to these targets:

  1. User - request sender is the owner of the container,
     used in the request.

  2. System - request sender is the storage node
     within the container used in the request or
     inner ring node.

  3. Others - request sender is none of the above.

 Extended ACL rules may be applied for targets, provided with
 extra information.

  4. PubKey - request sender has provided public key.
2020-04-01 21:02:46 +03:00
.github initialize 2020-01-30 14:43:09 +03:00
accounting Migrate to NeoFS API Go 2020-03-31 09:58:22 +03:00
acl acl: Define target of access control rules 2020-04-01 21:02:46 +03:00
bootstrap Migrate to NeoFS API Go 2020-03-31 09:58:22 +03:00
container Migrate to NeoFS API Go 2020-03-31 09:58:22 +03:00
decimal Migrate to NeoFS API Go 2020-03-31 09:58:22 +03:00
docs initialize 2020-01-30 14:43:09 +03:00
object Migrate to NeoFS API Go 2020-03-31 09:58:22 +03:00
proto-docs update proto docs 2020-03-31 10:17:52 +03:00
query Migrate to NeoFS API Go 2020-03-31 09:58:22 +03:00
refs Migrate to NeoFS API Go 2020-03-31 09:58:22 +03:00
service Migrate to NeoFS API Go 2020-03-31 09:58:22 +03:00
session Migrate to NeoFS API Go 2020-03-31 09:58:22 +03:00
state Migrate to NeoFS API Go 2020-03-31 09:58:22 +03:00
storagegroup Migrate to NeoFS API Go 2020-03-31 09:58:22 +03:00
.gitignore initialize 2020-01-30 14:43:09 +03:00
LICENSE.md initialize 2020-01-30 14:43:09 +03:00
Makefile update netmap library version 2020-03-31 10:36:51 +03:00
README.md docs: Update readme file for public release 2020-04-01 18:23:41 +03:00

NeoFS-API

NeoFS-API repository contains language-agnostic protocol buffers definitions of neofs-node structures and services.

Description

NeoFS-API repository is the basis for language-specific libraries, e.g.:

These libraries contain compiled protocol buffers code, defined in this repository. Use them to integrate applications with NeoFS.

This repository contains:

Protocol packages

Accounting

Accounting package defines services and structures for balance request and cheque operations.

See:

Bootstrap

Bootstrap package defines bootstrap service that connects storage nodes to the network.

See:

Container

Container package defines service and structure of containers. NeoFS stores objects within the registered container according to a specified storage policy.

See:

Object

Object is the storage unit in NeoFS. Object package defines structure of the object and service requests.

See:

Query

Query package defines structure for object search requests.

Refs

Refs package defines identity types: object id, container id, etc.

Service

Service package defines utility structures for all public API requests: TTL, request signature, etc.

Session

Session package defines service and structures to setup session between the node and the client. Session token is required in some object service requests. Node uses session private key to re-sign new objects and requests.

See:

State

State package defines service and structures for metrics gathering.

See:

StorageGroup

Storagegroup package defines structure that contains meta data for data audit. This meta data stored as a header in the NeoFS object.

License

This project is licensed under the GPLv3 License - see the LICENSE.md file for details