aboutsummaryrefslogtreecommitdiffstats
path: root/crypto/key_store_plain.go
diff options
context:
space:
mode:
Diffstat (limited to 'crypto/key_store_plain.go')
-rw-r--r--crypto/key_store_plain.go133
1 files changed, 80 insertions, 53 deletions
diff --git a/crypto/key_store_plain.go b/crypto/key_store_plain.go
index e3150e9a9..d785fdf68 100644
--- a/crypto/key_store_plain.go
+++ b/crypto/key_store_plain.go
@@ -31,18 +31,15 @@ import (
"io/ioutil"
"os"
"path/filepath"
- "sort"
- "syscall"
"time"
"github.com/ethereum/go-ethereum/common"
)
-// TODO: rename to KeyStore when replacing existing KeyStore
-type KeyStore2 interface {
+type KeyStore interface {
// create new key using io.Reader entropy source and optionally using auth string
GenerateNewKey(io.Reader, string) (*Key, error)
- GetKey(common.Address, string) (*Key, error) // key from addr and auth string
+ GetKey(common.Address, string) (*Key, error) // get key from addr and auth string
GetKeyAddresses() ([]common.Address, error) // get all addresses
StoreKey(*Key, string) error // store key optionally using auth string
DeleteKey(common.Address, string) error // delete key by addr and auth string
@@ -52,7 +49,7 @@ type keyStorePlain struct {
keysDirPath string
}
-func NewKeyStorePlain(path string) KeyStore2 {
+func NewKeyStorePlain(path string) KeyStore {
return &keyStorePlain{path}
}
@@ -60,7 +57,7 @@ func (ks keyStorePlain) GenerateNewKey(rand io.Reader, auth string) (key *Key, e
return GenerateNewKeyDefault(ks, rand, auth)
}
-func GenerateNewKeyDefault(ks KeyStore2, rand io.Reader, auth string) (key *Key, err error) {
+func GenerateNewKeyDefault(ks KeyStore, rand io.Reader, auth string) (key *Key, err error) {
defer func() {
if r := recover(); r != nil {
err = fmt.Errorf("GenerateNewKey error: %v", r)
@@ -72,81 +69,111 @@ func GenerateNewKeyDefault(ks KeyStore2, rand io.Reader, auth string) (key *Key,
}
func (ks keyStorePlain) GetKey(keyAddr common.Address, auth string) (key *Key, err error) {
- fileContent, err := GetKeyFile(ks.keysDirPath, keyAddr)
+ key = new(Key)
+ err = getKey(ks.keysDirPath, keyAddr, key)
+ return
+}
+
+func getKey(keysDirPath string, keyAddr common.Address, content interface{}) (err error) {
+ fileContent, err := getKeyFile(keysDirPath, keyAddr)
if err != nil {
- return nil, err
+ return
}
-
- key = new(Key)
- err = json.Unmarshal(fileContent, key)
- return key, err
+ return json.Unmarshal(fileContent, content)
}
func (ks keyStorePlain) GetKeyAddresses() (addresses []common.Address, err error) {
- return GetKeyAddresses(ks.keysDirPath)
+ return getKeyAddresses(ks.keysDirPath)
}
func (ks keyStorePlain) StoreKey(key *Key, auth string) (err error) {
keyJSON, err := json.Marshal(key)
if err != nil {
- return err
+ return
}
- err = WriteKeyFile(key.Address, ks.keysDirPath, keyJSON)
- return err
+ err = writeKeyFile(key.Address, ks.keysDirPath, keyJSON)
+ return
}
func (ks keyStorePlain) DeleteKey(keyAddr common.Address, auth string) (err error) {
- keyDirPath := filepath.Join(ks.keysDirPath, keyAddr.Hex())
- err = os.RemoveAll(keyDirPath)
- return err
+ return deleteKey(ks.keysDirPath, keyAddr)
+}
+
+func deleteKey(keysDirPath string, keyAddr common.Address) (err error) {
+ var keyFilePath string
+ keyFilePath, err = getKeyFilePath(keysDirPath, keyAddr)
+ if err == nil {
+ err = os.Remove(keyFilePath)
+ }
+ return
+}
+
+func getKeyFilePath(keysDirPath string, keyAddr common.Address) (keyFilePath string, err error) {
+ addrHex := hex.EncodeToString(keyAddr[:])
+ matches, err := filepath.Glob(filepath.Join(keysDirPath, fmt.Sprintf("*--%s", addrHex)))
+ if len(matches) > 0 {
+ if err == nil {
+ keyFilePath = matches[len(matches)-1]
+ }
+ return
+ }
+ keyFilePath = filepath.Join(keysDirPath, addrHex, addrHex)
+ _, err = os.Stat(keyFilePath)
+ return
}
-func GetKeyFile(keysDirPath string, keyAddr common.Address) (fileContent []byte, err error) {
- fileName := hex.EncodeToString(keyAddr[:])
- return ioutil.ReadFile(filepath.Join(keysDirPath, fileName, fileName))
+func getKeyFile(keysDirPath string, keyAddr common.Address) (fileContent []byte, err error) {
+ var keyFilePath string
+ keyFilePath, err = getKeyFilePath(keysDirPath, keyAddr)
+ if err == nil {
+ fileContent, err = ioutil.ReadFile(keyFilePath)
+ }
+ return
}
-func WriteKeyFile(addr common.Address, keysDirPath string, content []byte) (err error) {
- addrHex := hex.EncodeToString(addr[:])
- keyDirPath := filepath.Join(keysDirPath, addrHex)
- keyFilePath := filepath.Join(keyDirPath, addrHex)
- err = os.MkdirAll(keyDirPath, 0700) // read, write and dir search for user
+func writeKeyFile(addr common.Address, keysDirPath string, content []byte) (err error) {
+ filename := keyFileName(addr)
+ // read, write and dir search for user
+ err = os.MkdirAll(keysDirPath, 0700)
if err != nil {
return err
}
- return ioutil.WriteFile(keyFilePath, content, 0600) // read, write for user
+ // read, write for user
+ return ioutil.WriteFile(filepath.Join(keysDirPath, filename), content, 0600)
}
-func GetKeyAddresses(keysDirPath string) (addresses []common.Address, err error) {
+// keyFilePath implements the naming convention for keyfiles:
+// UTC--<created_at UTC ISO8601>-<address hex>
+func keyFileName(keyAddr common.Address) string {
+ ts := time.Now().UTC()
+ return fmt.Sprintf("UTC--%s--%s", toISO8601(ts), hex.EncodeToString(keyAddr[:]))
+}
+
+func toISO8601(t time.Time) string {
+ var tz string
+ name, offset := t.Zone()
+ if name == "UTC" {
+ tz = "Z"
+ } else {
+ tz = fmt.Sprintf("%03d00", offset/3600)
+ }
+ return fmt.Sprintf("%04d-%02d-%02dT%02d:%02d:%02d.%09d%s", t.Year(), t.Month(), t.Day(), t.Hour(), t.Minute(), t.Second(), t.Nanosecond(), tz)
+}
+
+func getKeyAddresses(keysDirPath string) (addresses []common.Address, err error) {
fileInfos, err := ioutil.ReadDir(keysDirPath)
if err != nil {
return nil, err
}
- var kfis keyFileInfos
for _, fileInfo := range fileInfos {
- stat := fileInfo.Sys().(*syscall.Stat_t)
- ctime := time.Unix(int64(stat.Ctimespec.Sec), int64(stat.Ctimespec.Nsec))
- kfis = append(kfis, keyFileInfo{fileInfo.Name(), ctime})
- }
- sort.Sort(kfis)
- for _, kfi := range kfis {
- address, err := hex.DecodeString(kfi.name)
- if err != nil {
- continue
+ filename := fileInfo.Name()
+ if len(filename) >= 40 {
+ addr := filename[len(filename)-40 : len(filename)]
+ address, err := hex.DecodeString(addr)
+ if err == nil {
+ addresses = append(addresses, common.BytesToAddress(address))
+ }
}
- addresses = append(addresses, common.BytesToAddress(address))
}
return addresses, err
}
-
-type keyFileInfo struct {
- name string
- ctime time.Time
-}
-type keyFileInfos []keyFileInfo
-
-func (a keyFileInfos) Len() int { return len(a) }
-func (a keyFileInfos) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
-func (a keyFileInfos) Less(i, j int) bool {
- return a[i].ctime.Before(a[j].ctime)
-}