keystore

Documentation

Index

• type BlockchainKeystore
  • func (bks *BlockchainKeystore) GetDatabase(username, password string) (database.Database, error)
• type Client
  • func NewClient(uri string, requestTimeout time.Duration) *Client
  • func (c *Client) CreateUser(user api.UserPass) (bool, error)
  • func (c *Client) DeleteUser(user api.UserPass) (bool, error)
  • func (c *Client) ExportUser(user api.UserPass) ([]byte, error)
  • func (c *Client) ImportUser(user api.UserPass, account []byte) (bool, error)
  • func (c *Client) ListUsers() ([]string, error)
• type ExportUserArgs
• type ExportUserReply
• type ImportUserArgs
• type KeyValuePair
• type Keystore
  • func CreateTestKeystore() (*Keystore, error)
  • func (ks *Keystore) AddUser(username, pword string) error
  • func (ks *Keystore) CreateHandler() (*common.HTTPHandler, error)
  • func (ks *Keystore) CreateUser(_ *http.Request, args *api.UserPass, reply *api.SuccessResponse) error
  • func (ks *Keystore) DeleteUser(_ *http.Request, args *api.UserPass, reply *api.SuccessResponse) error
  • func (ks *Keystore) ExportUser(_ *http.Request, args *ExportUserArgs, reply *ExportUserReply) error
  • func (ks *Keystore) GetDatabase(bID ids.ID, username, password string) (database.Database, error)
  • func (ks *Keystore) ImportUser(r *http.Request, args *ImportUserArgs, reply *api.SuccessResponse) error
  • func (ks *Keystore) Initialize(log logging.Logger, db database.Database) error
  • func (ks *Keystore) ListUsers(_ *http.Request, args *struct{}, reply *ListUsersReply) error
  • func (ks *Keystore) NewBlockchainKeyStore(blockchainID ids.ID) *BlockchainKeystore
• type ListUsersReply
• type UserDB

Types

type BlockchainKeystore

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

BlockchainKeystore ...

func (*BlockchainKeystore) GetDatabase

func (bks *BlockchainKeystore) GetDatabase(username, password string) (database.Database, error)

GetDatabase ...

type Client

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

Client ...

func NewClient

func NewClient(uri string, requestTimeout time.Duration) *Client

NewClient ...

func (*Client) CreateUser

func (c *Client) CreateUser(user api.UserPass) (bool, error)

CreateUser ...

func (*Client) DeleteUser

func (c *Client) DeleteUser(user api.UserPass) (bool, error)

DeleteUser removes [user] from the node's keystore users

func (*Client) ExportUser

func (c *Client) ExportUser(user api.UserPass) ([]byte, error)

ExportUser returns the byte representation of the requested [user]

func (*Client) ImportUser

func (c *Client) ImportUser(user api.UserPass, account []byte) (bool, error)

ImportUser imports the keystore user in [account] under [user]

func (*Client) ListUsers

func (c *Client) ListUsers() ([]string, error)

ListUsers lists the usernames of all keystore users on the node

type ExportUserArgs

type ExportUserArgs struct {
	// The username and password
	api.UserPass
	// The encoding for the exported user ("hex" or "cb58")
	Encoding formatting.Encoding `json:"encoding"`
}

ExportUserArgs ...

type ExportUserReply

type ExportUserReply struct {
	// String representation of the user
	User string `json:"user"`
	// The encoding for the exported user ("hex" or "cb58")
	Encoding formatting.Encoding `json:"encoding"`
}

ExportUserReply is the reply from ExportUser

type ImportUserArgs

type ImportUserArgs struct {
	// The username and password of the user being imported
	api.UserPass
	// The string representation of the user
	User string `json:"user"`
	// The encoding of [User] ("hex" or "cb58")
	Encoding formatting.Encoding `json:"encoding"`
}

ImportUserArgs are arguments for ImportUser

type KeyValuePair

type KeyValuePair struct {
	Key   []byte `serialize:"true"`
	Value []byte `serialize:"true"`
}

KeyValuePair ...

type Keystore

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

Keystore is the RPC interface for keystore management

func CreateTestKeystore

func CreateTestKeystore() (*Keystore, error)

CreateTestKeystore returns a new keystore that can be utilized for testing

func (*Keystore) AddUser

func (ks *Keystore) AddUser(username, pword string) error

AddUser attempts to register this username and password as a new user of the keystore.

func (*Keystore) CreateHandler

func (ks *Keystore) CreateHandler() (*common.HTTPHandler, error)

CreateHandler returns a new service object that can send requests to thisAPI.

func (*Keystore) CreateUser

func (ks *Keystore) CreateUser(_ *http.Request, args *api.UserPass, reply *api.SuccessResponse) error

CreateUser creates an empty user with the provided username and password

func (*Keystore) DeleteUser

func (ks *Keystore) DeleteUser(_ *http.Request, args *api.UserPass, reply *api.SuccessResponse) error

DeleteUser deletes user with the provided username and password.

func (*Keystore) ExportUser

func (ks *Keystore) ExportUser(_ *http.Request, args *ExportUserArgs, reply *ExportUserReply) error

ExportUser exports a serialized encoding of a user's information complete with encrypted database values

func (*Keystore) GetDatabase

func (ks *Keystore) GetDatabase(bID ids.ID, username, password string) (database.Database, error)

GetDatabase ...

func (*Keystore) ImportUser

func (ks *Keystore) ImportUser(r *http.Request, args *ImportUserArgs, reply *api.SuccessResponse) error

ImportUser imports a serialized encoding of a user's information complete with encrypted database values, integrity checks the password, and adds it to the database

func (*Keystore) Initialize

func (ks *Keystore) Initialize(log logging.Logger, db database.Database) error

Initialize the keystore

func (*Keystore) ListUsers

func (ks *Keystore) ListUsers(_ *http.Request, args *struct{}, reply *ListUsersReply) error

ListUsers lists all the registered usernames

func (*Keystore) NewBlockchainKeyStore

func (ks *Keystore) NewBlockchainKeyStore(blockchainID ids.ID) *BlockchainKeystore

NewBlockchainKeyStore ...

type ListUsersReply

type ListUsersReply struct {
	Users []string `json:"users"`
}

ListUsersReply is the reply from ListUsers

type UserDB

type UserDB struct {
	password.Hash `serialize:"true"`
	Data          []KeyValuePair `serialize:"true"`
}

UserDB describes the full content of a user