[ARCH-330] Add keystore file storage (#1633)

Author: pavel-raykov

keystore/admin_test.go

@@ -7,10 +7,10 @@ import (
 	"sync"
 	"testing"
 
-	"github.com/smartcontractkit/chainlink-common/keystore"
-	"github.com/smartcontractkit/chainlink-common/keystore/storage"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	"github.com/smartcontractkit/chainlink-common/keystore"
 )
 
 func TestKeystore_CreateDeleteReadKeys(t *testing.T) {
@@ -110,7 +110,7 @@ func TestKeystore_CreateDeleteReadKeys(t *testing.T) {
 
 	for _, tt := range tt {
 		t.Run(tt.name, func(t *testing.T) {
-			storage := storage.NewMemoryStorage()
+			storage := keystore.NewMemoryStorage()
 			ks, err := keystore.LoadKeystore(ctx, storage, keystore.EncryptionParams{
 				Password:     "test-password",
 				ScryptParams: keystore.FastScryptParams,
@@ -162,7 +162,7 @@ func TestKeystore_ConcurrentCreateAndRead(t *testing.T) {
 	t.Parallel()
 
 	ctx := context.Background()
-	st := storage.NewMemoryStorage()
+	st := keystore.NewMemoryStorage()
 	ks, err := keystore.LoadKeystore(ctx, st, keystore.EncryptionParams{
 		Password:     "test",
 		ScryptParams: keystore.FastScryptParams,

keystore/file.go

@@ -0,0 +1,29 @@
+package keystore
+
+import (
+	"context"
+	"os"
+)
+
+const readWritePerms = os.FileMode(0600)
+
+var _ Storage = &FileStorage{}
+
+// FileStorage implements Storage using a file
+type FileStorage struct {
+	name string
+}
+
+func NewFileStorage(name string) *FileStorage {
+	return &FileStorage{
+		name: name,
+	}
+}
+
+func (f *FileStorage) GetEncryptedKeystore(ctx context.Context) ([]byte, error) {
+	return os.ReadFile(f.name)
+}
+
+func (f *FileStorage) PutEncryptedKeystore(ctx context.Context, encryptedKeystore []byte) error {
+	return os.WriteFile(f.name, encryptedKeystore, readWritePerms)
+}

keystore/file_test.go

@@ -0,0 +1,21 @@
+package keystore_test
+
+import (
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/smartcontractkit/chainlink-common/keystore"
+)
+
+func TestFileStorage(t *testing.T) {
+	t.Parallel()
+	storage := keystore.NewFileStorage(filepath.Join(t.TempDir(), "out.txt"))
+	_, err := storage.GetEncryptedKeystore(t.Context())
+	require.ErrorContains(t, err, "no such file or directory")
+	require.NoError(t, storage.PutEncryptedKeystore(t.Context(), []byte("test")))
+	got, err := storage.GetEncryptedKeystore(t.Context())
+	require.NoError(t, err)
+	require.Equal(t, []byte("test"), got)
+}

keystore/keystore.go

@@ -13,10 +13,10 @@ import (
 
 	gethkeystore "github.com/ethereum/go-ethereum/accounts/keystore"
 	gethcrypto "github.com/ethereum/go-ethereum/crypto"
+	"google.golang.org/protobuf/proto"
+
 	"github.com/smartcontractkit/chainlink-common/keystore/internal"
 	"github.com/smartcontractkit/chainlink-common/keystore/serialization"
-	"github.com/smartcontractkit/chainlink-common/keystore/storage"
-	"google.golang.org/protobuf/proto"
 )
 
 type KeyType string
@@ -162,11 +162,11 @@ func publicKeyFromPrivateKey(privateKeyBytes internal.Raw, keyType KeyType) ([]b
 type keystore struct {
 	mu       sync.RWMutex
 	keystore map[string]key
-	storage  storage.Storage
+	storage  Storage
 	enc      EncryptionParams
 }
 
-func LoadKeystore(ctx context.Context, storage storage.Storage, enc EncryptionParams) (Keystore, error) {
+func LoadKeystore(ctx context.Context, storage Storage, enc EncryptionParams) (Keystore, error) {
 	ks := &keystore{
 		storage: storage,
 		enc:     enc,

keystore/storage/memory.go keystore/memory.gokeystore/storage/memory.go renamed to keystore/memory.go

@@ -1,10 +1,12 @@
-package storage
+package keystore
 
 import (
 	"context"
 	"sync"
 )
 
+var _ Storage = &MemoryStorage{}
+
 // MemoryStorage implements Storage using in-memory storage
 type MemoryStorage struct {
 	mu   sync.RWMutex

keystore/memory_test.go

@@ -0,0 +1,18 @@
+package keystore_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/smartcontractkit/chainlink-common/keystore"
+)
+
+func TestMemoryStorage(t *testing.T) {
+	t.Parallel()
+	storage := keystore.NewMemoryStorage()
+	require.NoError(t, storage.PutEncryptedKeystore(t.Context(), []byte("test")))
+	got, err := storage.GetEncryptedKeystore(t.Context())
+	require.NoError(t, err)
+	require.Equal(t, []byte("test"), got)
+}

keystore/storage/storage.go keystore/storage.gokeystore/storage/storage.go renamed to keystore/storage.go

@@ -1,4 +1,4 @@
-package storage
+package keystore
 
 import "context"