Files
sonr/app/commands/keys_vrf.go
T
40eadc995e Feat/1285 es ucan formatting (#1302)
* feat: Add Enclave Usage Examples

* feat(es/ucan): Add comprehensive integration tests

- Create integration.test.ts with full UCAN token lifecycle testing
- Cover end-to-end token creation, parsing, and validation
- Test capability attenuation and delegation chains
- Validate multi-algorithm support and timestamp scenarios
- Implement error recovery and performance test scenarios

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>

* No commit suggestions generated

* No commit suggestions generated

* chore: Remove migrated components and add migration documentation

Removed all code and references for components that have been moved to separate repositories:

**Moved to sonr-io/hway:**
- bridge/ - HTTP service with OAuth2/OIDC/WebAuthn handlers
- cmd/hway/ - Highway service binary
- internal/migrations/ - PostgreSQL schema migrations

**Moved to sonr-io/motr:**
- cmd/motr/ - Motor worker service (WASM vault operations)
- cmd/vault/ - Vault CLI tool
- crypto/ - Comprehensive cryptographic library
- packages/ - TypeScript SDK packages (es, sdk, ui, com, pkl)
- web/auth/ - Authentication web application
- web/dash/ - Dashboard web application

**Updated Configuration:**
- Makefile: Removed build/test/release targets for moved components
- CLAUDE.md: Simplified to focus on core blockchain components
- devbox.json: Removed scripts for moved services
- docker-compose.yml: Removed hway, postgres, redis, auth, dash services
- .github/scopes.yml: Removed CI scopes for migrated components
- .goreleaser.yml: Updated release configuration

**Added Migration Documentation:**
- MIGRATE_HWAY.md: Comprehensive Highway service architecture and migration guide
- MIGRATE_MOTR.md: Comprehensive Motor/Worker/Vault architecture and migration guide

These migration documents provide complete context for setting up the new repositories including architecture diagrams, component breakdowns, API documentation, and migration checklists.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* No commit suggestions generated

* chore: Remove contracts references and documentation

Removed all references to the contracts directory that was migrated to a separate repository.

**Changes:**
- .gitignore: Removed contract-specific ignore patterns for DAO and wSNR contracts
- .gitignore: Removed hway and motr binary references (already migrated)
- .rgignore: Removed contracts, chains, and crypto directory references
- docs/reference/contracts/: Removed DAO.mdx and wSNR.mdx documentation files

This completes the cleanup of migrated components from the repository.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* docs: add crypto library migration documentation

Added comprehensive migration documentation for the crypto library that was
moved to sonr-io/crypto repository. This documentation provides complete context
for understanding the cryptographic primitives and protocols used throughout
the Sonr ecosystem.

## Key Documentation Added

### MIGRATE_CRYPTO.md
Complete documentation of the crypto library covering:

**Core Cryptographic Primitives**
- Elliptic curve implementations (Ed25519, Secp256k1, P-256, BLS12-381, Pallas/Vesta)
- Native curve arithmetic with optimized field operations
- Pairing-friendly curves for BLS signatures

**Multi-Party Computation (MPC)**
- MPC enclave for vault key generation and management
- Threshold cryptography (TECDSA, TED25519 with FROST protocol)
- Distributed Key Generation (DKG) via Gennaro and FROST protocols
- Secret sharing schemes (Shamir, Feldman VSS, Pedersen VSS)

**Digital Signature Schemes**
- BLS signatures with aggregation support
- BBS+ signatures for selective disclosure
- Schnorr signatures (standard and Mina/NEM variants)
- ECDSA with deterministic nonce generation

**Zero-Knowledge Proofs**
- Bulletproofs for range proofs
- Inner Product Arguments (IPA)
- Batch verification support

**Advanced Cryptographic Protocols**
- Cryptographic accumulators for set membership proofs
- Paillier homomorphic encryption
- Oblivious Transfer (OT) protocols
- Verifiable Random Functions (VRF)

**Key Management & Identity**
- DID key management with multi-chain support
- Multi-algorithm public key handling
- Wallet address derivation (Bitcoin, Ethereum, Cosmos, Solana, etc.)

**UCAN Integration**
- User-Controlled Authorization Networks
- Capability delegation and attenuation
- JWT-based capability tokens
- MPC-enabled UCAN signing

**Security Utilities**
- AEAD encryption (AES-GCM, AES-SIV)
- Argon2 key derivation
- ECIES encryption
- Secure memory handling

### MIGRATE_MOTR.md Updates
Updated Motor migration documentation to clarify that the crypto library
is now a separate external dependency at github.com/sonr-io/crypto v1.0.1

## Repository Context

The crypto library has been successfully migrated to its own repository
and is published as a Go module. It serves as the foundational cryptographic
layer for:
- Sonr blockchain (snrd) - DID signatures, vault operations
- Highway service (hway) - UCAN token signing, WebAuthn
- Motor/Worker (motr) - MPC vault operations, threshold signatures

## Integration Impact

All Sonr ecosystem components now depend on the external crypto library:
```go
require github.com/sonr-io/crypto v1.0.1
```

The migration enables independent versioning and maintenance of cryptographic
primitives while maintaining security and compatibility across the ecosystem.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* No commit suggestions generated

* No commit suggestions generated

* No commit suggestions generated

---------

Co-authored-by: Claude <noreply@anthropic.com>
2025-10-10 11:47:18 -04:00

268 lines
8.8 KiB
Go

// Package commands contains utility functions for the snrd command
package commands
import (
"crypto/sha256"
"encoding/hex"
"fmt"
"os"
"path/filepath"
"github.com/sonr-io/sonr/app"
"github.com/sonr-io/crypto/vrf"
"github.com/spf13/cobra"
)
// VRFKeysCmd returns the VRF key management command
func VRFKeysCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "vrf",
Short: "Manage VRF (Verifiable Random Function) keys",
Long: `Manage VRF keys used for consensus-based encryption in multi-validator networks.
VRF keys are required for:
- Multi-validator encryption key derivation
- Consensus-based key rotation
- Deterministic randomness in distributed systems
VRF keys are automatically generated during 'snrd init', but this command
allows you to inspect or regenerate them if needed.`,
}
cmd.AddCommand(
vrfGenerateCmd(),
vrfShowCmd(),
vrfVerifyCmd(),
)
return cmd
}
// vrfGenerateCmd creates a command to generate new VRF keys
func vrfGenerateCmd() *cobra.Command {
var chainID string
var force bool
cmd := &cobra.Command{
Use: "generate",
Short: "Generate new VRF keypair",
Long: `Generate a new VRF keypair for the node.
The keypair is generated deterministically from the chain-id to ensure
reproducibility. Keys are stored at ~/.sonr/vrf_secret.key with 0600 permissions.
WARNING: Regenerating VRF keys will invalidate any existing consensus-based
encryption keys. Only do this if you understand the implications.`,
Example: ` # Generate VRF keys for a specific chain
snrd keys vrf generate --chain-id sonrtest_1-1
# Force regenerate (overwrite existing keys)
snrd keys vrf generate --chain-id sonrtest_1-1 --force`,
RunE: func(cmd *cobra.Command, args []string) error {
// Get chain-id
if chainID == "" {
// Try to read from genesis file
var err error
chainID, err = getChainIDFromGenesis()
if err != nil {
return fmt.Errorf("chain-id not provided and could not be read from genesis: %w\n"+
"Please provide --chain-id flag", err)
}
}
vrfKeyPath := filepath.Join(app.DefaultNodeHome, "vrf_secret.key")
// Check if keys already exist
if _, err := os.Stat(vrfKeyPath); err == nil && !force {
return fmt.Errorf("VRF keys already exist at %s\n"+
"Use --force flag to overwrite existing keys\n"+
"WARNING: Overwriting keys will invalidate existing consensus encryption", vrfKeyPath)
}
// Backup existing keys if they exist
if _, err := os.Stat(vrfKeyPath); err == nil && force {
backupPath := vrfKeyPath + ".backup"
if err := os.Rename(vrfKeyPath, backupPath); err != nil {
return fmt.Errorf("failed to backup existing VRF keys: %w", err)
}
fmt.Printf("Backed up existing keys to: %s\n", backupPath)
}
// Generate VRF keys
fmt.Printf("Generating VRF keypair for chain-id: %s\n", chainID)
entropySource, err := createChainIDEntropySource(chainID)
if err != nil {
return fmt.Errorf("failed to create entropy source: %w", err)
}
privateKey, err := vrf.GenerateKey(entropySource)
if err != nil {
return fmt.Errorf("failed to generate VRF keypair: %w", err)
}
// Validate keypair
if len(privateKey) != vrf.PrivateKeySize {
return fmt.Errorf("invalid VRF private key size: expected %d, got %d",
vrf.PrivateKeySize, len(privateKey))
}
publicKey, ok := privateKey.Public()
if !ok {
return fmt.Errorf("failed to derive public key from VRF private key")
}
// Ensure directory exists
if err := os.MkdirAll(app.DefaultNodeHome, 0o750); err != nil {
return fmt.Errorf("failed to create node home directory: %w", err)
}
// Store VRF secret key with restrictive permissions
if err := os.WriteFile(vrfKeyPath, privateKey, 0o600); err != nil {
return fmt.Errorf("failed to save VRF secret key: %w", err)
}
fmt.Printf("✓ VRF keypair generated successfully\n")
fmt.Printf("✓ Private key stored at: %s\n", vrfKeyPath)
fmt.Printf("✓ Public key (hex): %s\n", hex.EncodeToString(publicKey))
fmt.Printf("✓ Key size: %d bytes\n", len(privateKey))
fmt.Printf("✓ Permissions: 0600 (owner read/write only)\n")
return nil
},
}
cmd.Flags().StringVar(&chainID, "chain-id", "", "Chain ID for deterministic key generation")
cmd.Flags().BoolVar(&force, "force", false, "Force overwrite existing VRF keys (creates backup)")
return cmd
}
// vrfShowCmd creates a command to display VRF key information
func vrfShowCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "show",
Short: "Show VRF public key information",
Long: `Display information about the node's VRF public key.
This command shows the public key without exposing the private key.
Useful for verifying that VRF keys are properly installed.`,
Example: ` # Show VRF key information
snrd keys vrf show`,
RunE: func(cmd *cobra.Command, args []string) error {
vrfKeyPath := filepath.Join(app.DefaultNodeHome, "vrf_secret.key")
// Read VRF private key
// #nosec G304 - vrfKeyPath is constructed from trusted DefaultNodeHome constant
privateKeyData, err := os.ReadFile(vrfKeyPath)
if err != nil {
return fmt.Errorf("failed to read VRF keys from %s: %w\n"+
"VRF keys may not be initialized. Run 'snrd init' or 'snrd keys vrf generate'",
vrfKeyPath, err)
}
// Validate key size
if len(privateKeyData) != vrf.PrivateKeySize {
return fmt.Errorf("invalid VRF private key size: expected %d, got %d",
vrf.PrivateKeySize, len(privateKeyData))
}
privateKey := vrf.PrivateKey(privateKeyData)
publicKey, ok := privateKey.Public()
if !ok {
return fmt.Errorf("failed to derive public key from VRF private key")
}
// Get file info
fileInfo, err := os.Stat(vrfKeyPath)
if err != nil {
return fmt.Errorf("failed to stat VRF key file: %w", err)
}
fmt.Println("VRF Key Information:")
fmt.Println("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━")
fmt.Printf("Key Path: %s\n", vrfKeyPath)
fmt.Printf("Public Key: %s\n", hex.EncodeToString(publicKey))
fmt.Printf("Key Size: %d bytes\n", len(privateKeyData))
fmt.Printf("Public Key Size: %d bytes\n", len(publicKey))
fmt.Printf("Permissions: %s\n", fileInfo.Mode().Perm())
fmt.Printf("Modified: %s\n", fileInfo.ModTime().Format("2006-01-02 15:04:05"))
// Verify permissions
if fileInfo.Mode().Perm() != 0o600 {
fmt.Println("\n⚠️ WARNING: VRF key file has incorrect permissions!")
fmt.Printf(" Current: %s, Expected: 0600\n", fileInfo.Mode().Perm())
fmt.Println(" Run: chmod 0600 " + vrfKeyPath)
} else {
fmt.Println("\n✓ VRF keys are properly configured")
}
return nil
},
}
return cmd
}
// vrfVerifyCmd creates a command to verify VRF key functionality
func vrfVerifyCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "verify",
Short: "Verify VRF key functionality",
Long: `Verify that VRF keys are properly installed and functional.
This command performs a test VRF computation to ensure the keys work correctly.`,
Example: ` # Verify VRF keys
snrd keys vrf verify`,
RunE: func(cmd *cobra.Command, args []string) error {
vrfKeyPath := filepath.Join(app.DefaultNodeHome, "vrf_secret.key")
// Read VRF private key
// #nosec G304 - vrfKeyPath is constructed from trusted DefaultNodeHome constant
privateKeyData, err := os.ReadFile(vrfKeyPath)
if err != nil {
return fmt.Errorf("failed to read VRF keys: %w", err)
}
if len(privateKeyData) != vrf.PrivateKeySize {
return fmt.Errorf("invalid VRF private key size: expected %d, got %d",
vrf.PrivateKeySize, len(privateKeyData))
}
privateKey := vrf.PrivateKey(privateKeyData)
publicKey, ok := privateKey.Public()
if !ok {
return fmt.Errorf("failed to derive public key")
}
// Test VRF computation with proof
testInput := []byte("test-input-for-verification")
vrfOutput, proof := privateKey.Prove(testInput)
// Verify the output
if !publicKey.Verify(testInput, vrfOutput, proof) {
return fmt.Errorf("VRF verification failed - keys may be corrupted")
}
// Compute output hash
outputHash := sha256.Sum256(vrfOutput)
fmt.Println("VRF Key Verification:")
fmt.Println("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━")
fmt.Printf("✓ VRF keys loaded successfully\n")
fmt.Printf("✓ Public key derived successfully\n")
fmt.Printf("✓ VRF proof generated successfully\n")
fmt.Printf("✓ VRF verification successful\n")
fmt.Printf("\nTest Output (hex): %s\n", hex.EncodeToString(vrfOutput))
fmt.Printf("Proof (hex): %s\n", hex.EncodeToString(proof))
fmt.Printf("Output Hash: %s\n", hex.EncodeToString(outputHash[:]))
fmt.Println("\n✓ VRF keys are fully functional")
return nil
},
}
return cmd
}