accounts

package
v1.5.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 14, 2016 License: GPL-3.0 Imports: 30 Imported by: 0

Documentation

Overview

Package accounts implements encrypted storage of secp256k1 private keys.

Keys are stored as encrypted JSON files according to the Web3 Secret Storage specification. See https://github.com/ethereum/wiki/wiki/Web3-Secret-Storage-Definition for more information.

Index

Constants

View Source
const (

	// StandardScryptN is the N parameter of Scrypt encryption algorithm, using 256MB
	// memory and taking approximately 1s CPU time on a modern processor.
	StandardScryptN = 1 << 18

	// StandardScryptP is the P parameter of Scrypt encryption algorithm, using 256MB
	// memory and taking approximately 1s CPU time on a modern processor.
	StandardScryptP = 1

	// LightScryptN is the N parameter of Scrypt encryption algorithm, using 4MB
	// memory and taking approximately 100ms CPU time on a modern processor.
	LightScryptN = 1 << 12

	// LightScryptP is the P parameter of Scrypt encryption algorithm, using 4MB
	// memory and taking approximately 100ms CPU time on a modern processor.
	LightScryptP = 6
)

Variables

View Source
var (
	ErrLocked  = errors.New("account is locked")
	ErrNoMatch = errors.New("no key for given address or file")
	ErrDecrypt = errors.New("could not decrypt key with given passphrase")
)

Functions

func EncryptKey added in v1.4.0

func EncryptKey(key *Key, auth string, scryptN, scryptP int) ([]byte, error)

EncryptKey encrypts a key using the specified scrypt parameters into a json blob that can be decrypted later on.

Types

type Account

type Account struct {
	Address common.Address // Ethereum account address derived from the key

	// File contains the key file name.
	// When Acccount is used as an argument to select a key, File can be left blank to
	// select just by address or set to the basename or absolute path of a file in the key
	// directory. Accounts returned by Manager will always contain an absolute path.
	File string
}

Account represents a stored key. When used as an argument, it selects a unique key file to act on.

func (*Account) MarshalJSON added in v1.4.0

func (acc *Account) MarshalJSON() ([]byte, error)

func (*Account) UnmarshalJSON added in v1.4.0

func (acc *Account) UnmarshalJSON(raw []byte) error

type AmbiguousAddrError added in v1.4.0

type AmbiguousAddrError struct {
	Addr    common.Address
	Matches []Account
}

AmbiguousAddrError is returned when attempting to unlock an address for which more than one file exists.

func (*AmbiguousAddrError) Error added in v1.4.0

func (err *AmbiguousAddrError) Error() string

type Key added in v1.4.0

type Key struct {
	Id uuid.UUID // Version 4 "random" for unique id not derived from key data
	// to simplify lookups we also store the address
	Address common.Address
	// we only store privkey as pubkey/address can be derived from it
	// privkey in this struct is always in plaintext
	PrivateKey *ecdsa.PrivateKey
}

func DecryptKey added in v1.4.0

func DecryptKey(keyjson []byte, auth string) (*Key, error)

DecryptKey decrypts a key from a json blob, returning the private key itself.

func NewKeyForDirectICAP added in v1.4.0

func NewKeyForDirectICAP(rand io.Reader) *Key

NewKeyForDirectICAP generates a key whose address fits into < 155 bits so it can fit into the Direct ICAP spec. for simplicity and easier compatibility with other libs, we retry until the first byte is 0.

func (*Key) MarshalJSON added in v1.4.0

func (k *Key) MarshalJSON() (j []byte, err error)

func (*Key) UnmarshalJSON added in v1.4.0

func (k *Key) UnmarshalJSON(j []byte) (err error)

type Manager

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

Manager manages a key storage directory on disk.

func NewManager

func NewManager(keydir string, scryptN, scryptP int) *Manager

NewManager creates a manager for the given directory.

func NewPlaintextManager added in v1.4.0

func NewPlaintextManager(keydir string) *Manager

NewPlaintextManager creates a manager for the given directory. Deprecated: Use NewManager.

func (*Manager) AccountByIndex added in v1.4.0

func (am *Manager) AccountByIndex(i int) (Account, error)

AccountByIndex returns the ith account.

func (*Manager) Accounts

func (am *Manager) Accounts() []Account

Accounts returns all key files present in the directory.

func (*Manager) DeleteAccount

func (am *Manager) DeleteAccount(a Account, passphrase string) error

DeleteAccount deletes the key matched by account if the passphrase is correct. If a contains no filename, the address must match a unique key.

func (*Manager) Export

func (am *Manager) Export(a Account, passphrase, newPassphrase string) (keyJSON []byte, err error)

Export exports as a JSON key, encrypted with newPassphrase.

func (*Manager) Find added in v1.5.0

func (am *Manager) Find(a Account) (Account, error)

Find resolves the given account into a unique entry in the keystore.

func (*Manager) HasAddress added in v1.4.0

func (am *Manager) HasAddress(addr common.Address) bool

HasAddress reports whether a key with the given address is present.

func (*Manager) Import

func (am *Manager) Import(keyJSON []byte, passphrase, newPassphrase string) (Account, error)

Import stores the given encrypted JSON key into the key directory.

func (*Manager) ImportECDSA added in v1.4.0

func (am *Manager) ImportECDSA(priv *ecdsa.PrivateKey, passphrase string) (Account, error)

ImportECDSA stores the given key into the key directory, encrypting it with the passphrase.

func (*Manager) ImportPreSaleKey

func (am *Manager) ImportPreSaleKey(keyJSON []byte, passphrase string) (Account, error)

ImportPreSaleKey decrypts the given Ethereum presale wallet and stores a key file in the key directory. The key file is encrypted with the same passphrase.

func (*Manager) Lock added in v1.4.0

func (am *Manager) Lock(addr common.Address) error

Lock removes the private key with the given address from memory.

func (*Manager) NewAccount

func (am *Manager) NewAccount(passphrase string) (Account, error)

NewAccount generates a new key and stores it into the key directory, encrypting it with the passphrase.

func (*Manager) Sign

func (am *Manager) Sign(addr common.Address, hash []byte) ([]byte, error)

Sign calculates a ECDSA signature for the given hash. Note, Ethereum signatures have a particular format as described in the yellow paper. Use the SignEthereum function to calculate a signature in Ethereum format.

func (*Manager) SignEthereum added in v1.5.0

func (am *Manager) SignEthereum(addr common.Address, hash []byte) ([]byte, error)

SignEthereum calculates a ECDSA signature for the given hash. The signature has the format as described in the Ethereum yellow paper.

func (*Manager) SignWithPassphrase added in v1.4.5

func (am *Manager) SignWithPassphrase(addr common.Address, passphrase string, hash []byte) (signature []byte, err error)

SignWithPassphrase signs hash if the private key matching the given address can be decrypted with the given passphrase.

func (*Manager) TimedUnlock

func (am *Manager) TimedUnlock(a Account, passphrase string, timeout time.Duration) error

TimedUnlock unlocks the given account with the passphrase. The account stays unlocked for the duration of timeout. A timeout of 0 unlocks the account until the program exits. The account must match a unique key file.

If the account address is already unlocked for a duration, TimedUnlock extends or shortens the active unlock timeout. If the address was previously unlocked indefinitely the timeout is not altered.

func (*Manager) Unlock

func (am *Manager) Unlock(a Account, passphrase string) error

Unlock unlocks the given account indefinitely.

func (*Manager) Update

func (am *Manager) Update(a Account, passphrase, newPassphrase string) error

Update changes the passphrase of an existing account.

Directories

Path Synopsis
abi
Package abi implements the Ethereum ABI (Application Binary Interface).
Package abi implements the Ethereum ABI (Application Binary Interface).
bind
Package bind generates Ethereum contract Go bindings.
Package bind generates Ethereum contract Go bindings.

Jump to

Keyboard shortcuts

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