README
¶
Secure FileSystem Signer
This package provides a secure implementation of a signer that stores cryptographic keys on the filesystem. The implementation follows security best practices to ensure that private keys are never stored in plain text on disk.
Features
- Secure Key Storage: Private keys are encrypted using AES-GCM before being stored on disk
- Passphrase Protection: Keys are protected by a user-provided passphrase
- In-Memory Operation: Once loaded, keys remain in memory for signing operations
- Automatic Key Generation: If keys don't exist, they are automatically generated
- Thread Safety: Concurrent access to the signer is protected by mutex locks
Security Measures
- Encryption: Private keys are encrypted using AES-GCM, a secure authenticated encryption mode
- Permissions: Key files are stored with 0600 permissions (readable and writable only by the owner)
- Directory Creation: Key directories are created with 0700 permissions
- No Plain Text: Private keys are never stored in plain text on disk
- Passphrase Derivation: A key derivation function is used to derive encryption keys from passphrases
Usage
// Create a new signer (or load existing keys)
passphrase := []byte("your-secure-passphrase")
keyPath := "/path/to/secure/keys.json"
signer, err := NewFileSystemSigner(keyPath, passphrase)
if err != nil {
// Handle error
}
// Sign a message
message := []byte("Message to sign")
signature, err := signer.Sign(context.Background(), message)
if err != nil {
// Handle error
}
// Get the public key
pubKey, err := signer.GetPublic()
if err != nil {
// Handle error
}
Production Considerations
For production use, consider the following enhancements:
- Stronger KDF: Replace the simple key derivation function with Argon2 or PBKDF2
- Secure Passphrase Handling: Implement secure methods for obtaining and handling passphrases
Implementation Details
The FileSystemSigner stores keys in a JSON file with the following structure:
{
"priv_key_encrypted": "...", // Base64-encoded encrypted private key
"nonce": "...", // Base64-encoded nonce for AES-GCM
"pub_key": "..." // Base64-encoded public key
}
The encryption process:
- Generate a random nonce
- Derive an encryption key from the passphrase
- Encrypt the private key using AES-GCM with the derived key and nonce
- Store the encrypted private key, nonce, and public key in the JSON file
The decryption process:
- Read the JSON file
- Derive the encryption key from the passphrase
- Decrypt the private key using AES-GCM with the derived key and stored nonce
- Load the keys into memory for use
Documentation
¶
Overview ¶
File Remote Signer implements the Signer interface using a file to store the keys.
The keys are stored in a file in the local filesystem.
passphrase := []byte("your-secure-passphrase")
keyPath := "/path/to/secure/keys.json"
// Create or load a signer
signer, err := NewFileSystemSigner(keyPath, passphrase)
if err != nil {
panic(err)
}
// Sign a message
message := []byte("Message to sign")
signature, err := signer.Sign(context.Background(), message)
if err != nil {
panic(err)
}
// Get the public key
pubKey, err := signer.GetPublic()
if err != nil {
panic(err)
}
// Verify the signature (typically done by another party)
valid, err := pubKey.Verify(message, signature)
if err != nil {
panic(err)
}
Example ¶
Example demonstrates how to use the FileSystemSigner
// In a real application, you would use a secure passphrase
passphrase := []byte("your-secure-passphrase")
keyPath := "/path/to/secure/keys.json"
// Create or load a signer
signer, err := CreateFileSystemSigner(keyPath, passphrase)
if err != nil {
panic(err)
}
// Sign a message
message := []byte("Message to sign")
signature, err := signer.Sign(context.Background(), message)
if err != nil {
panic(err)
}
// Get the public key
pubKey, err := signer.GetPublic()
if err != nil {
panic(err)
}
// Verify the signature (typically done by another party)
valid, err := pubKey.Verify(message, signature)
if err != nil {
panic(err)
}
if valid {
// Signature is valid
} else {
// Signature is invalid
}
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ExportPrivateKey ¶
ExportPrivateKey decrypts and returns the raw private key from the key file. It is intended for key backup and migration purposes. WARNING: Handle the returned private key with extreme care.
Types ¶
type FileSystemSigner ¶
type FileSystemSigner struct {
// contains filtered or unexported fields
}
FileSystemSigner implements a signer that securely stores keys on disk and loads them into memory only when needed.
func CreateFileSystemSigner ¶
func CreateFileSystemSigner(keyPath string, passphrase []byte) (*FileSystemSigner, error)
CreateFileSystemSigner creates a new key pair and saves it encrypted to disk.
func LoadFileSystemSigner ¶
func LoadFileSystemSigner(keyPath string, passphrase []byte) (*FileSystemSigner, error)
LoadFileSystemSigner loads existing keys from an encrypted file on disk.
func (*FileSystemSigner) GetAddress ¶
func (s *FileSystemSigner) GetAddress() ([]byte, error)
GetAddress returns the address of the signer
Source Files