permissions

README

Dapps permissions service

To enable:

{
  "PermissionsConfig": {
    "Enabled": true,
  },
  APIModules: "permissions"
}

API

permissions_addDappPermissions

Stores provided permissions for dapp. On update replaces previous version of the object.

{
  "dapp": "first",
  "permissions": [
    "r",
    "x"
  ]
}

permissions_getDappPermissions

Returns all permissions for dapps. Order is not deterministic.

permissions_deleteDappPermissions

Delete dapp by a name.

Documentation

Index

• type API
  • func NewAPI(db *Database) *API
  • func (api *API) AddDappPermissions(ctx context.Context, perms DappPermissions) error
  • func (api *API) DeleteDappPermissions(ctx context.Context, name string) error
  • func (api *API) GetDappPermissions(ctx context.Context) ([]DappPermissions, error)
• type DappPermissions
• type Database
  • func NewDB(db *sql.DB) *Database
  • func (db *Database) AddPermissions(perms DappPermissions) (err error)
  • func (db Database) Close() error
  • func (db *Database) DeleteDappPermission(dappName, permission string) error
  • func (db *Database) DeletePermission(name string) error
  • func (db *Database) GetPermissions() (rst []DappPermissions, err error)
  • func (db *Database) GetPermissionsByDappName(dappName string) (rst *DappPermissions, err error)
  • func (db *Database) HasPermission(dappName string, permission string) (bool, error)
• type Service
  • func NewService(db *Database) *Service
  • func (s *Service) APIs() []rpc.API
  • func (s *Service) Protocols() []p2p.Protocol
  • func (s *Service) Start() error
  • func (s *Service) Stop() error

Types

type API

type API struct {
	// contains filtered or unexported fields
}

API is class with methods available over RPC.

func NewAPI

func NewAPI(db *Database) *API

func (*API) AddDappPermissions

func (api *API) AddDappPermissions(ctx context.Context, perms DappPermissions) error

func (*API) DeleteDappPermissions

func (api *API) DeleteDappPermissions(ctx context.Context, name string) error

func (*API) GetDappPermissions

func (api *API) GetDappPermissions(ctx context.Context) ([]DappPermissions, error)

type DappPermissions

type DappPermissions struct {
	Name        string   `json:"dapp"`
	Permissions []string `json:"permissions,omitempty"`
}

type Database

type Database struct {
	// contains filtered or unexported fields
}

Database sql wrapper for operations with browser objects.

func NewDB

func NewDB(db *sql.DB) *Database

func (*Database) AddPermissions

func (db *Database) AddPermissions(perms DappPermissions) (err error)

func (Database) Close

func (db Database) Close() error

Close closes database.

func (*Database) DeleteDappPermission

func (db *Database) DeleteDappPermission(dappName, permission string) error

func (*Database) DeletePermission

func (db *Database) DeletePermission(name string) error

func (*Database) GetPermissions

func (db *Database) GetPermissions() (rst []DappPermissions, err error)

func (*Database) GetPermissionsByDappName

func (db *Database) GetPermissionsByDappName(dappName string) (rst *DappPermissions, err error)

func (*Database) HasPermission

func (db *Database) HasPermission(dappName string, permission string) (bool, error)

type Service

type Service struct {
	// contains filtered or unexported fields
}

func NewService

func NewService(db *Database) *Service

NewService initializes service instance.

func (*Service) APIs

func (s *Service) APIs() []rpc.API

APIs returns list of available RPC APIs.

func (*Service) Protocols

func (s *Service) Protocols() []p2p.Protocol

Protocols returns list of p2p protocols.

func (*Service) Start

func (s *Service) Start() error

Start a service.

func (*Service) Stop

func (s *Service) Stop() error

Stop a service.