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
- Variables
- func EncryptKey(key *Key, auth string, scryptN, scryptP int) ([]byte, error)
- type Account
- type AmbiguousAddrError
- type Key
- type Manager
- func (am *Manager) AccountByIndex(i int) (Account, error)
- func (am *Manager) Accounts() []Account
- func (am *Manager) DeleteAccount(a Account, passphrase string) error
- func (am *Manager) Export(a Account, passphrase, newPassphrase string) (keyJSON []byte, err error)
- func (am *Manager) Find(a Account) (Account, error)
- func (am *Manager) HasAddress(addr common.Address) bool
- func (am *Manager) Import(keyJSON []byte, passphrase, newPassphrase string) (Account, error)
- func (am *Manager) ImportECDSA(priv *ecdsa.PrivateKey, passphrase string) (Account, error)
- func (am *Manager) ImportPreSaleKey(keyJSON []byte, passphrase string) (Account, error)
- func (am *Manager) Lock(addr common.Address) error
- func (am *Manager) NewAccount(passphrase string) (Account, error)
- func (am *Manager) Sign(addr common.Address, hash []byte) ([]byte, error)
- func (am *Manager) SignWithPassphrase(a Account, passphrase string, hash []byte) (signature []byte, err error)
- func (am *Manager) TimedUnlock(a Account, passphrase string, timeout time.Duration) error
- func (am *Manager) Unlock(a Account, passphrase string) error
- func (am *Manager) Update(a Account, passphrase, newPassphrase string) error
Constants ¶
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 ¶
Functions ¶
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 (*Account) UnmarshalJSON ¶ added in v1.4.0
type AmbiguousAddrError ¶ added in v1.4.0
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
DecryptKey decrypts a key from a json blob, returning the private key itself.
func NewKeyForDirectICAP ¶ added in v1.4.0
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 (*Key) UnmarshalJSON ¶ added in v1.4.0
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
Manager manages a key storage directory on disk.
func NewManager ¶
NewManager creates a manager for the given directory.
func NewPlaintextManager ¶ added in v1.4.0
NewPlaintextManager creates a manager for the given directory. Deprecated: Use NewManager.
func (*Manager) AccountByIndex ¶ added in v1.4.0
AccountByIndex returns the ith account.
func (*Manager) DeleteAccount ¶ added in v0.9.39
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 ¶ added in v0.9.39
Export exports as a JSON key, encrypted with newPassphrase.
func (*Manager) HasAddress ¶ added in v1.4.0
HasAddress reports whether a key with the given address is present.
func (*Manager) Import ¶ added in v0.9.39
Import stores the given encrypted JSON key into the key directory.
func (*Manager) ImportECDSA ¶ added in v1.4.0
ImportECDSA stores the given key into the key directory, encrypting it with the passphrase.
func (*Manager) ImportPreSaleKey ¶ added in v0.9.39
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
Lock removes the private key with the given address from memory.
func (*Manager) NewAccount ¶ added in v0.9.39
NewAccount generates a new key and stores it into the key directory, encrypting it with the passphrase.
func (*Manager) Sign ¶ added in v0.9.39
Sign calculates a ECDSA signature for the given hash. The produced signature is in the [R || S || V] format where V is 0 or 1.
func (*Manager) SignWithPassphrase ¶ added in v1.4.5
func (am *Manager) SignWithPassphrase(a Account, 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. The produced signature is in the [R || S || V] format where V is 0 or 1.
func (*Manager) TimedUnlock ¶ added in v0.9.39
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.