Compare commits
14 Commits
b9aaf8ddac
...
ci/make-ch
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
efa8647166 | ||
|
|
044ad92feb | ||
|
|
386baaea70 | ||
|
|
8edc629dd6 | ||
|
|
59839309b3 | ||
|
|
66a390d685 | ||
|
|
7b84aa345f | ||
|
|
a8ce1ff7c8 | ||
|
|
afa4f799da | ||
|
|
9ada080821 | ||
| 25febccec1 | |||
|
|
b68e1eb3d1 | ||
|
|
cbca2e59c5 | ||
| a3d3fb3b69 |
@@ -17,5 +17,4 @@ coverage.out
|
|||||||
.claude/
|
.claude/
|
||||||
|
|
||||||
# Local settings
|
# Local settings
|
||||||
.golangci.yml
|
|
||||||
.claude/settings.local.json
|
.claude/settings.local.json
|
||||||
9
.gitea/workflows/check.yml
Normal file
9
.gitea/workflows/check.yml
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
name: check
|
||||||
|
on: [push]
|
||||||
|
jobs:
|
||||||
|
check:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
# actions/checkout v4.2.2, 2026-02-28
|
||||||
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
||||||
|
- run: docker build --ulimit memlock=-1:-1 .
|
||||||
58
Dockerfile
58
Dockerfile
@@ -1,50 +1,46 @@
|
|||||||
# Build stage
|
# Lint stage — fast feedback on formatting and lint issues
|
||||||
FROM golang:1.24-alpine AS builder
|
# golangci/golangci-lint v2.1.6 (2026-03-10)
|
||||||
|
FROM golangci/golangci-lint@sha256:568ee1c1c53493575fa9494e280e579ac9ca865787bafe4df3023ae59ecf299b AS lint
|
||||||
|
|
||||||
# Install build dependencies
|
WORKDIR /src
|
||||||
RUN apk add --no-cache \
|
|
||||||
gcc \
|
|
||||||
musl-dev \
|
|
||||||
make \
|
|
||||||
git
|
|
||||||
|
|
||||||
# Set working directory
|
|
||||||
WORKDIR /build
|
|
||||||
|
|
||||||
# Copy go mod files
|
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
|
|
||||||
# Download dependencies
|
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
|
|
||||||
# Copy source code
|
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
# Build the binary
|
RUN make fmt-check
|
||||||
RUN CGO_ENABLED=1 go build -v -o secret cmd/secret/main.go
|
RUN make lint
|
||||||
|
|
||||||
|
# Build stage — tests and compilation
|
||||||
|
# golang 1.24.13-alpine (2026-03-10)
|
||||||
|
FROM golang@sha256:8bee1901f1e530bfb4a7850aa7a479d17ae3a18beb6e09064ed54cfd245b7191 AS builder
|
||||||
|
|
||||||
|
# Force BuildKit to run the lint stage
|
||||||
|
COPY --from=lint /src/go.sum /dev/null
|
||||||
|
|
||||||
|
RUN apk add --no-cache gcc musl-dev make git gnupg
|
||||||
|
|
||||||
|
WORKDIR /build
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
RUN make test
|
||||||
|
RUN make build
|
||||||
|
|
||||||
# Runtime stage
|
# Runtime stage
|
||||||
FROM alpine:latest
|
# alpine 3.23 (2026-03-10)
|
||||||
|
FROM alpine@sha256:25109184c71bdad752c8312a8623239686a9a2071e8825f20acb8f2198c3f659
|
||||||
|
|
||||||
# Install runtime dependencies
|
RUN apk add --no-cache ca-certificates gnupg
|
||||||
RUN apk add --no-cache \
|
|
||||||
ca-certificates \
|
|
||||||
gnupg
|
|
||||||
|
|
||||||
# Create non-root user
|
|
||||||
RUN adduser -D -s /bin/sh secret
|
RUN adduser -D -s /bin/sh secret
|
||||||
|
|
||||||
# Copy binary from builder
|
|
||||||
COPY --from=builder /build/secret /usr/local/bin/secret
|
COPY --from=builder /build/secret /usr/local/bin/secret
|
||||||
|
|
||||||
# Ensure binary is executable
|
|
||||||
RUN chmod +x /usr/local/bin/secret
|
RUN chmod +x /usr/local/bin/secret
|
||||||
|
|
||||||
# Switch to non-root user
|
|
||||||
USER secret
|
USER secret
|
||||||
|
|
||||||
# Set working directory
|
|
||||||
WORKDIR /home/secret
|
WORKDIR /home/secret
|
||||||
|
|
||||||
# Set entrypoint
|
|
||||||
ENTRYPOINT ["secret"]
|
ENTRYPOINT ["secret"]
|
||||||
7
Makefile
7
Makefile
@@ -17,7 +17,7 @@ build: ./secret
|
|||||||
vet:
|
vet:
|
||||||
go vet ./...
|
go vet ./...
|
||||||
|
|
||||||
test: lint vet
|
test: vet
|
||||||
go test ./... || go test -v ./...
|
go test ./... || go test -v ./...
|
||||||
|
|
||||||
fmt:
|
fmt:
|
||||||
@@ -26,7 +26,7 @@ fmt:
|
|||||||
lint:
|
lint:
|
||||||
golangci-lint run --timeout 5m
|
golangci-lint run --timeout 5m
|
||||||
|
|
||||||
check: build test
|
check: build lint test fmt-check
|
||||||
|
|
||||||
# Build Docker container
|
# Build Docker container
|
||||||
docker:
|
docker:
|
||||||
@@ -42,3 +42,6 @@ clean:
|
|||||||
|
|
||||||
install: ./secret
|
install: ./secret
|
||||||
cp ./secret $(HOME)/bin/secret
|
cp ./secret $(HOME)/bin/secret
|
||||||
|
|
||||||
|
fmt-check:
|
||||||
|
@test -z "$$(gofmt -l .)" || (echo "Files need formatting:" && gofmt -l . && exit 1)
|
||||||
|
|||||||
17
README.md
17
README.md
@@ -184,6 +184,7 @@ Creates a new unlocker of the specified type:
|
|||||||
- `passphrase`: Traditional passphrase-protected unlocker
|
- `passphrase`: Traditional passphrase-protected unlocker
|
||||||
- `pgp`: Uses an existing GPG key for encryption/decryption
|
- `pgp`: Uses an existing GPG key for encryption/decryption
|
||||||
- `keychain`: macOS Keychain integration (macOS only)
|
- `keychain`: macOS Keychain integration (macOS only)
|
||||||
|
- `secure-enclave`: Hardware-backed Secure Enclave protection (macOS only)
|
||||||
|
|
||||||
**Options:**
|
**Options:**
|
||||||
- `--keyid <id>`: GPG key ID (optional for PGP type, uses default key if not specified)
|
- `--keyid <id>`: GPG key ID (optional for PGP type, uses default key if not specified)
|
||||||
@@ -286,11 +287,11 @@ Unlockers provide different authentication methods to access the long-term keys:
|
|||||||
- Automatic unlocking when Keychain is unlocked
|
- Automatic unlocking when Keychain is unlocked
|
||||||
- Cross-application integration
|
- Cross-application integration
|
||||||
|
|
||||||
4. **Secure Enclave Unlockers** (macOS - planned):
|
4. **Secure Enclave Unlockers** (macOS):
|
||||||
- Hardware-backed key storage using Apple Secure Enclave
|
- Hardware-backed key storage using Apple Secure Enclave
|
||||||
- Currently partially implemented but non-functional
|
- Uses `sc_auth` / CryptoTokenKit for SE key management (no Apple Developer Program required)
|
||||||
- Requires Apple Developer Program membership and code signing entitlements
|
- ECIES encryption: vault long-term key encrypted directly by SE hardware
|
||||||
- Full implementation blocked by entitlement requirements
|
- Protected by biometric authentication (Touch ID) or system password
|
||||||
|
|
||||||
Each vault maintains its own set of unlockers and one long-term key. The long-term key is encrypted to each unlocker, allowing any authorized unlocker to access vault secrets.
|
Each vault maintains its own set of unlockers and one long-term key. The long-term key is encrypted to each unlocker, allowing any authorized unlocker to access vault secrets.
|
||||||
|
|
||||||
@@ -330,8 +331,7 @@ Each vault maintains its own set of unlockers and one long-term key. The long-te
|
|||||||
|
|
||||||
- Hardware token support via PGP/GPG integration
|
- Hardware token support via PGP/GPG integration
|
||||||
- macOS Keychain integration for system-level security
|
- macOS Keychain integration for system-level security
|
||||||
- Secure Enclave support planned (requires paid Apple Developer Program for
|
- Secure Enclave integration for hardware-backed key protection (macOS, via `sc_auth` / CryptoTokenKit)
|
||||||
signed entitlements to access the SEP and doxxing myself to Apple)
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -385,6 +385,7 @@ secret vault remove personal --force
|
|||||||
secret unlocker add passphrase # Password-based
|
secret unlocker add passphrase # Password-based
|
||||||
secret unlocker add pgp --keyid ABCD1234 # GPG key
|
secret unlocker add pgp --keyid ABCD1234 # GPG key
|
||||||
secret unlocker add keychain # macOS Keychain (macOS only)
|
secret unlocker add keychain # macOS Keychain (macOS only)
|
||||||
|
secret unlocker add secure-enclave # macOS Secure Enclave (macOS only)
|
||||||
|
|
||||||
# List unlockers
|
# List unlockers
|
||||||
secret unlocker list
|
secret unlocker list
|
||||||
@@ -443,7 +444,7 @@ secret decrypt encryption/mykey --input document.txt.age --output document.txt
|
|||||||
|
|
||||||
### Cross-Platform Support
|
### Cross-Platform Support
|
||||||
|
|
||||||
- **macOS**: Full support including Keychain and planned Secure Enclave integration
|
- **macOS**: Full support including Keychain and Secure Enclave integration
|
||||||
- **Linux**: Full support (excluding macOS-specific features)
|
- **Linux**: Full support (excluding macOS-specific features)
|
||||||
|
|
||||||
## Security Considerations
|
## Security Considerations
|
||||||
@@ -487,7 +488,7 @@ go test -tags=integration -v ./internal/cli # Integration tests
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Multiple Authentication Methods**: Supports passphrase, PGP, and macOS Keychain unlockers
|
- **Multiple Authentication Methods**: Supports passphrase, PGP, macOS Keychain, and Secure Enclave unlockers
|
||||||
- **Vault Isolation**: Complete separation between different vaults
|
- **Vault Isolation**: Complete separation between different vaults
|
||||||
- **Per-Secret Encryption**: Each secret has its own encryption key
|
- **Per-Secret Encryption**: Each secret has its own encryption key
|
||||||
- **BIP39 Mnemonic Support**: Keyless operation using mnemonic phrases
|
- **BIP39 Mnemonic Support**: Keyless operation using mnemonic phrases
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
package cli
|
package cli
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"log"
|
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
|
"log"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"runtime"
|
"runtime"
|
||||||
"strings"
|
"strings"
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
package cli
|
package cli
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"log"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"log"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
|||||||
@@ -48,7 +48,7 @@ func TestMain(m *testing.M) {
|
|||||||
code := m.Run()
|
code := m.Run()
|
||||||
|
|
||||||
// Clean up the binary
|
// Clean up the binary
|
||||||
os.Remove(filepath.Join(projectRoot, "secret"))
|
_ = os.Remove(filepath.Join(projectRoot, "secret"))
|
||||||
|
|
||||||
os.Exit(code)
|
os.Exit(code)
|
||||||
}
|
}
|
||||||
@@ -450,10 +450,10 @@ func test02ListVaults(t *testing.T, runSecret func(...string) (string, error)) {
|
|||||||
|
|
||||||
func test03CreateVault(t *testing.T, tempDir string, runSecret func(...string) (string, error)) {
|
func test03CreateVault(t *testing.T, tempDir string, runSecret func(...string) (string, error)) {
|
||||||
// Set environment variables for vault creation
|
// Set environment variables for vault creation
|
||||||
os.Setenv("SB_SECRET_MNEMONIC", testMnemonic)
|
_ = os.Setenv("SB_SECRET_MNEMONIC", testMnemonic)
|
||||||
os.Setenv("SB_UNLOCK_PASSPHRASE", "test-passphrase")
|
_ = os.Setenv("SB_UNLOCK_PASSPHRASE", "test-passphrase")
|
||||||
defer os.Unsetenv("SB_SECRET_MNEMONIC")
|
defer func() { _ = os.Unsetenv("SB_SECRET_MNEMONIC") }()
|
||||||
defer os.Unsetenv("SB_UNLOCK_PASSPHRASE")
|
defer func() { _ = os.Unsetenv("SB_UNLOCK_PASSPHRASE") }()
|
||||||
|
|
||||||
// Create work vault
|
// Create work vault
|
||||||
output, err := runSecret("vault", "create", "work")
|
output, err := runSecret("vault", "create", "work")
|
||||||
@@ -489,6 +489,7 @@ func test03CreateVault(t *testing.T, tempDir string, runSecret func(...string) (
|
|||||||
assert.Contains(t, output, "work", "should list work vault")
|
assert.Contains(t, output, "work", "should list work vault")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
//nolint:unused // TODO: re-enable when vault import is implemented
|
||||||
func test04ImportMnemonic(t *testing.T, tempDir, testMnemonic, testPassphrase string, runSecretWithEnv func(map[string]string, ...string) (string, error)) {
|
func test04ImportMnemonic(t *testing.T, tempDir, testMnemonic, testPassphrase string, runSecretWithEnv func(map[string]string, ...string) (string, error)) {
|
||||||
// Import mnemonic into work vault
|
// Import mnemonic into work vault
|
||||||
output, err := runSecretWithEnv(map[string]string{
|
output, err := runSecretWithEnv(map[string]string{
|
||||||
@@ -1667,9 +1668,9 @@ func test19DisasterRecovery(t *testing.T, tempDir, secretPath, testMnemonic stri
|
|||||||
assert.Equal(t, testSecretValue, strings.TrimSpace(toolOutput), "tool output should match original")
|
assert.Equal(t, testSecretValue, strings.TrimSpace(toolOutput), "tool output should match original")
|
||||||
|
|
||||||
// Clean up temporary files
|
// Clean up temporary files
|
||||||
os.Remove(ltPrivKeyPath)
|
_ = os.Remove(ltPrivKeyPath)
|
||||||
os.Remove(versionPrivKeyPath)
|
_ = os.Remove(versionPrivKeyPath)
|
||||||
os.Remove(decryptedValuePath)
|
_ = os.Remove(decryptedValuePath)
|
||||||
}
|
}
|
||||||
|
|
||||||
func test20VersionTimestamps(t *testing.T, tempDir, secretPath, testMnemonic string, runSecretWithEnv func(map[string]string, ...string) (string, error)) {
|
func test20VersionTimestamps(t *testing.T, tempDir, secretPath, testMnemonic string, runSecretWithEnv func(map[string]string, ...string) (string, error)) {
|
||||||
@@ -1788,7 +1789,7 @@ func test23ErrorHandling(t *testing.T, tempDir, secretPath, testMnemonic string,
|
|||||||
|
|
||||||
// Add secret without mnemonic or unlocker
|
// Add secret without mnemonic or unlocker
|
||||||
unsetMnemonic := os.Getenv("SB_SECRET_MNEMONIC")
|
unsetMnemonic := os.Getenv("SB_SECRET_MNEMONIC")
|
||||||
os.Unsetenv("SB_SECRET_MNEMONIC")
|
_ = os.Unsetenv("SB_SECRET_MNEMONIC")
|
||||||
cmd := exec.Command(secretPath, "add", "test/nomnemonic")
|
cmd := exec.Command(secretPath, "add", "test/nomnemonic")
|
||||||
cmd.Env = []string{
|
cmd.Env = []string{
|
||||||
fmt.Sprintf("SB_SECRET_STATE_DIR=%s", tempDir),
|
fmt.Sprintf("SB_SECRET_STATE_DIR=%s", tempDir),
|
||||||
@@ -2128,7 +2129,7 @@ func test30BackupRestore(t *testing.T, tempDir, secretPath, testMnemonic string,
|
|||||||
versionsPath := filepath.Join(secretPath, "versions")
|
versionsPath := filepath.Join(secretPath, "versions")
|
||||||
if _, err := os.Stat(versionsPath); os.IsNotExist(err) {
|
if _, err := os.Stat(versionsPath); os.IsNotExist(err) {
|
||||||
// This is a malformed secret directory, remove it
|
// This is a malformed secret directory, remove it
|
||||||
os.RemoveAll(secretPath)
|
_ = os.RemoveAll(secretPath)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2178,7 +2179,7 @@ func test30BackupRestore(t *testing.T, tempDir, secretPath, testMnemonic string,
|
|||||||
require.NoError(t, err, "restore vaults should succeed")
|
require.NoError(t, err, "restore vaults should succeed")
|
||||||
|
|
||||||
// Restore currentvault
|
// Restore currentvault
|
||||||
os.Remove(currentVaultSrc)
|
_ = os.Remove(currentVaultSrc)
|
||||||
restoredData := readFile(t, currentVaultDst)
|
restoredData := readFile(t, currentVaultDst)
|
||||||
writeFile(t, currentVaultSrc, restoredData)
|
writeFile(t, currentVaultSrc, restoredData)
|
||||||
|
|
||||||
@@ -2284,6 +2285,8 @@ func verifyFileExists(t *testing.T, path string) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// verifyFileNotExists checks if a file does not exist at the given path
|
// verifyFileNotExists checks if a file does not exist at the given path
|
||||||
|
//
|
||||||
|
//nolint:unused // kept for future use
|
||||||
func verifyFileNotExists(t *testing.T, path string) {
|
func verifyFileNotExists(t *testing.T, path string) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
_, err := os.Stat(path)
|
_, err := os.Stat(path)
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
package cli
|
package cli
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"log"
|
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
|
"log"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
package cli
|
package cli
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"log"
|
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"log"
|
||||||
"os"
|
"os"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
package cli
|
package cli
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"log"
|
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"log"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
package cli
|
package cli
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"log"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"log"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
"text/tabwriter"
|
"text/tabwriter"
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
//go:build darwin
|
||||||
|
|
||||||
#ifndef SECURE_ENCLAVE_H
|
#ifndef SECURE_ENCLAVE_H
|
||||||
#define SECURE_ENCLAVE_H
|
#define SECURE_ENCLAVE_H
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
//go:build darwin
|
||||||
|
|
||||||
#import <Foundation/Foundation.h>
|
#import <Foundation/Foundation.h>
|
||||||
#import <Security/Security.h>
|
#import <Security/Security.h>
|
||||||
#include "secure_enclave.h"
|
#include "secure_enclave.h"
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
//go:build darwin
|
||||||
|
|
||||||
package secret
|
package secret
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -24,12 +26,12 @@ type realVault struct {
|
|||||||
func (v *realVault) GetDirectory() (string, error) {
|
func (v *realVault) GetDirectory() (string, error) {
|
||||||
return filepath.Join(v.stateDir, "vaults.d", v.name), nil
|
return filepath.Join(v.stateDir, "vaults.d", v.name), nil
|
||||||
}
|
}
|
||||||
func (v *realVault) GetName() string { return v.name }
|
func (v *realVault) GetName() string { return v.name }
|
||||||
func (v *realVault) GetFilesystem() afero.Fs { return v.fs }
|
func (v *realVault) GetFilesystem() afero.Fs { return v.fs }
|
||||||
|
|
||||||
// Unused by getLongTermPrivateKey — these satisfy VaultInterface.
|
// Unused by getLongTermPrivateKey — these satisfy VaultInterface.
|
||||||
func (v *realVault) AddSecret(string, *memguard.LockedBuffer, bool) error { panic("not used") }
|
func (v *realVault) AddSecret(string, *memguard.LockedBuffer, bool) error { panic("not used") }
|
||||||
func (v *realVault) GetCurrentUnlocker() (Unlocker, error) { panic("not used") }
|
func (v *realVault) GetCurrentUnlocker() (Unlocker, error) { panic("not used") }
|
||||||
func (v *realVault) CreatePassphraseUnlocker(*memguard.LockedBuffer) (*PassphraseUnlocker, error) {
|
func (v *realVault) CreatePassphraseUnlocker(*memguard.LockedBuffer) (*PassphraseUnlocker, error) {
|
||||||
panic("not used")
|
panic("not used")
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,33 +1,11 @@
|
|||||||
package secret
|
package secret
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"crypto/rand"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"math/big"
|
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
)
|
)
|
||||||
|
|
||||||
// generateRandomString generates a random string of the specified length using the given character set
|
|
||||||
func generateRandomString(length int, charset string) (string, error) {
|
|
||||||
if length <= 0 {
|
|
||||||
return "", fmt.Errorf("length must be positive")
|
|
||||||
}
|
|
||||||
|
|
||||||
result := make([]byte, length)
|
|
||||||
charsetLen := big.NewInt(int64(len(charset)))
|
|
||||||
|
|
||||||
for i := range length {
|
|
||||||
randomIndex, err := rand.Int(rand.Reader, charsetLen)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("failed to generate random number: %w", err)
|
|
||||||
}
|
|
||||||
result[i] = charset[randomIndex.Int64()]
|
|
||||||
}
|
|
||||||
|
|
||||||
return string(result), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// DetermineStateDir determines the state directory based on environment variables and OS.
|
// DetermineStateDir determines the state directory based on environment variables and OS.
|
||||||
// It returns an error if no usable directory can be determined.
|
// It returns an error if no usable directory can be determined.
|
||||||
func DetermineStateDir(customConfigDir string) (string, error) {
|
func DetermineStateDir(customConfigDir string) (string, error) {
|
||||||
|
|||||||
29
internal/secret/helpers_darwin.go
Normal file
29
internal/secret/helpers_darwin.go
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
//go:build darwin
|
||||||
|
|
||||||
|
package secret
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/rand"
|
||||||
|
"fmt"
|
||||||
|
"math/big"
|
||||||
|
)
|
||||||
|
|
||||||
|
// generateRandomString generates a random string of the specified length using the given character set
|
||||||
|
func generateRandomString(length int, charset string) (string, error) {
|
||||||
|
if length <= 0 {
|
||||||
|
return "", fmt.Errorf("length must be positive")
|
||||||
|
}
|
||||||
|
|
||||||
|
result := make([]byte, length)
|
||||||
|
charsetLen := big.NewInt(int64(len(charset)))
|
||||||
|
|
||||||
|
for i := range length {
|
||||||
|
randomIndex, err := rand.Int(rand.Reader, charsetLen)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("failed to generate random number: %w", err)
|
||||||
|
}
|
||||||
|
result[i] = charset[randomIndex.Int64()]
|
||||||
|
}
|
||||||
|
|
||||||
|
return string(result), nil
|
||||||
|
}
|
||||||
@@ -24,7 +24,7 @@ func TestPassphraseUnlockerWithRealFS(t *testing.T) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("Failed to create temp dir: %v", err)
|
t.Fatalf("Failed to create temp dir: %v", err)
|
||||||
}
|
}
|
||||||
defer os.RemoveAll(tempDir) // Clean up after test
|
defer func() { _ = os.RemoveAll(tempDir) }() // Clean up after test
|
||||||
|
|
||||||
// Use the real filesystem
|
// Use the real filesystem
|
||||||
fs := afero.NewOsFs()
|
fs := afero.NewOsFs()
|
||||||
@@ -155,7 +155,7 @@ func TestPassphraseUnlockerWithRealFS(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
// Unset the environment variable to test interactive prompt
|
// Unset the environment variable to test interactive prompt
|
||||||
os.Unsetenv(secret.EnvUnlockPassphrase)
|
_ = os.Unsetenv(secret.EnvUnlockPassphrase)
|
||||||
|
|
||||||
// Test getting identity from prompt (this would require mocking the prompt)
|
// Test getting identity from prompt (this would require mocking the prompt)
|
||||||
// For real integration tests, we'd need to provide a way to mock the passphrase input
|
// For real integration tests, we'd need to provide a way to mock the passphrase input
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
//go:build darwin
|
||||||
|
|
||||||
package secret_test
|
package secret_test
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -140,7 +142,7 @@ func TestPGPUnlockerWithRealFS(t *testing.T) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("Failed to create temp dir: %v", err)
|
t.Fatalf("Failed to create temp dir: %v", err)
|
||||||
}
|
}
|
||||||
defer os.RemoveAll(tempDir) // Clean up after test
|
defer func() { _ = os.RemoveAll(tempDir) }() // Clean up after test
|
||||||
|
|
||||||
// Create a temporary GNUPGHOME
|
// Create a temporary GNUPGHOME
|
||||||
gnupgHomeDir := filepath.Join(tempDir, "gnupg")
|
gnupgHomeDir := filepath.Join(tempDir, "gnupg")
|
||||||
|
|||||||
@@ -284,11 +284,11 @@ func TestSecretNameValidation(t *testing.T) {
|
|||||||
{"valid/path/name", true},
|
{"valid/path/name", true},
|
||||||
{"123valid", true},
|
{"123valid", true},
|
||||||
{"", false},
|
{"", false},
|
||||||
{"Valid-Upper-Name", true}, // uppercase allowed
|
{"Valid-Upper-Name", true}, // uppercase allowed
|
||||||
{"2025-11-21-ber1app1-vaultik-test-bucket-AKI", true}, // real-world uppercase key ID
|
{"2025-11-21-ber1app1-vaultik-test-bucket-AKI", true}, // real-world uppercase key ID
|
||||||
{"MixedCase/Path/Name", true}, // mixed case with path
|
{"MixedCase/Path/Name", true}, // mixed case with path
|
||||||
{"invalid name", false}, // space not allowed
|
{"invalid name", false}, // space not allowed
|
||||||
{"invalid@name", false}, // @ not allowed
|
{"invalid@name", false}, // @ not allowed
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, test := range tests {
|
for _, test := range tests {
|
||||||
|
|||||||
@@ -60,7 +60,10 @@ func (s *SecureEnclaveUnlocker) GetIdentity() (*age.X25519Identity, error) {
|
|||||||
encryptedPath := filepath.Join(s.Directory, seLongtermFilename)
|
encryptedPath := filepath.Join(s.Directory, seLongtermFilename)
|
||||||
encryptedData, err := afero.ReadFile(s.fs, encryptedPath)
|
encryptedData, err := afero.ReadFile(s.fs, encryptedPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("failed to read SE-encrypted long-term key: %w", err)
|
return nil, fmt.Errorf(
|
||||||
|
"failed to read SE-encrypted long-term key: %w",
|
||||||
|
err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
DebugWith("Read SE-encrypted long-term key",
|
DebugWith("Read SE-encrypted long-term key",
|
||||||
@@ -70,7 +73,10 @@ func (s *SecureEnclaveUnlocker) GetIdentity() (*age.X25519Identity, error) {
|
|||||||
// Decrypt using the Secure Enclave (ECDH happens inside SE hardware)
|
// Decrypt using the Secure Enclave (ECDH happens inside SE hardware)
|
||||||
decryptedData, err := macse.Decrypt(seKeyLabel, encryptedData)
|
decryptedData, err := macse.Decrypt(seKeyLabel, encryptedData)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("failed to decrypt long-term key with SE: %w", err)
|
return nil, fmt.Errorf(
|
||||||
|
"failed to decrypt long-term key with SE: %w",
|
||||||
|
err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Parse the decrypted long-term private key
|
// Parse the decrypted long-term private key
|
||||||
@@ -82,7 +88,10 @@ func (s *SecureEnclaveUnlocker) GetIdentity() (*age.X25519Identity, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("failed to parse long-term private key: %w", err)
|
return nil, fmt.Errorf(
|
||||||
|
"failed to parse long-term private key: %w",
|
||||||
|
err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
DebugWith("Successfully decrypted long-term key via SE",
|
DebugWith("Successfully decrypted long-term key via SE",
|
||||||
@@ -165,7 +174,11 @@ func (s *SecureEnclaveUnlocker) getSEKeyInfo() (label string, hash string, err e
|
|||||||
}
|
}
|
||||||
|
|
||||||
// NewSecureEnclaveUnlocker creates a new SecureEnclaveUnlocker instance.
|
// NewSecureEnclaveUnlocker creates a new SecureEnclaveUnlocker instance.
|
||||||
func NewSecureEnclaveUnlocker(fs afero.Fs, directory string, metadata UnlockerMetadata) *SecureEnclaveUnlocker {
|
func NewSecureEnclaveUnlocker(
|
||||||
|
fs afero.Fs,
|
||||||
|
directory string,
|
||||||
|
metadata UnlockerMetadata,
|
||||||
|
) *SecureEnclaveUnlocker {
|
||||||
return &SecureEnclaveUnlocker{
|
return &SecureEnclaveUnlocker{
|
||||||
Directory: directory,
|
Directory: directory,
|
||||||
Metadata: metadata,
|
Metadata: metadata,
|
||||||
@@ -182,13 +195,22 @@ func generateSEKeyLabel(vaultName string) (string, error) {
|
|||||||
|
|
||||||
enrollmentDate := time.Now().UTC().Format("2006-01-02")
|
enrollmentDate := time.Now().UTC().Format("2006-01-02")
|
||||||
|
|
||||||
return fmt.Sprintf("%s.%s-%s-%s", seKeyLabelPrefix, vaultName, hostname, enrollmentDate), nil
|
return fmt.Sprintf(
|
||||||
|
"%s.%s-%s-%s",
|
||||||
|
seKeyLabelPrefix,
|
||||||
|
vaultName,
|
||||||
|
hostname,
|
||||||
|
enrollmentDate,
|
||||||
|
), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// CreateSecureEnclaveUnlocker creates a new SE unlocker.
|
// CreateSecureEnclaveUnlocker creates a new SE unlocker.
|
||||||
// The vault's long-term private key is encrypted directly by the Secure Enclave
|
// The vault's long-term private key is encrypted directly by the Secure Enclave
|
||||||
// using ECIES. No intermediate age keypair is used.
|
// using ECIES. No intermediate age keypair is used.
|
||||||
func CreateSecureEnclaveUnlocker(fs afero.Fs, stateDir string) (*SecureEnclaveUnlocker, error) {
|
func CreateSecureEnclaveUnlocker(
|
||||||
|
fs afero.Fs,
|
||||||
|
stateDir string,
|
||||||
|
) (*SecureEnclaveUnlocker, error) {
|
||||||
if err := checkMacOSAvailable(); err != nil {
|
if err := checkMacOSAvailable(); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -216,14 +238,20 @@ func CreateSecureEnclaveUnlocker(fs afero.Fs, stateDir string) (*SecureEnclaveUn
|
|||||||
// Step 2: Get the vault's long-term private key
|
// Step 2: Get the vault's long-term private key
|
||||||
ltPrivKeyData, err := getLongTermKeyForSE(fs, vault)
|
ltPrivKeyData, err := getLongTermKeyForSE(fs, vault)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("failed to get long-term private key: %w", err)
|
return nil, fmt.Errorf(
|
||||||
|
"failed to get long-term private key: %w",
|
||||||
|
err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
defer ltPrivKeyData.Destroy()
|
defer ltPrivKeyData.Destroy()
|
||||||
|
|
||||||
// Step 3: Encrypt the long-term key directly with the SE (ECIES)
|
// Step 3: Encrypt the long-term key directly with the SE (ECIES)
|
||||||
encryptedLtKey, err := macse.Encrypt(seKeyLabel, ltPrivKeyData.Bytes())
|
encryptedLtKey, err := macse.Encrypt(seKeyLabel, ltPrivKeyData.Bytes())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("failed to encrypt long-term key with SE: %w", err)
|
return nil, fmt.Errorf(
|
||||||
|
"failed to encrypt long-term key with SE: %w",
|
||||||
|
err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Step 4: Create unlocker directory and write files
|
// Step 4: Create unlocker directory and write files
|
||||||
@@ -235,13 +263,19 @@ func CreateSecureEnclaveUnlocker(fs afero.Fs, stateDir string) (*SecureEnclaveUn
|
|||||||
unlockerDirName := fmt.Sprintf("se-%s", filepath.Base(seKeyLabel))
|
unlockerDirName := fmt.Sprintf("se-%s", filepath.Base(seKeyLabel))
|
||||||
unlockerDir := filepath.Join(vaultDir, "unlockers.d", unlockerDirName)
|
unlockerDir := filepath.Join(vaultDir, "unlockers.d", unlockerDirName)
|
||||||
if err := fs.MkdirAll(unlockerDir, DirPerms); err != nil {
|
if err := fs.MkdirAll(unlockerDir, DirPerms); err != nil {
|
||||||
return nil, fmt.Errorf("failed to create unlocker directory: %w", err)
|
return nil, fmt.Errorf(
|
||||||
|
"failed to create unlocker directory: %w",
|
||||||
|
err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Write SE-encrypted long-term key
|
// Write SE-encrypted long-term key
|
||||||
ltKeyPath := filepath.Join(unlockerDir, seLongtermFilename)
|
ltKeyPath := filepath.Join(unlockerDir, seLongtermFilename)
|
||||||
if err := afero.WriteFile(fs, ltKeyPath, encryptedLtKey, FilePerms); err != nil {
|
if err := afero.WriteFile(fs, ltKeyPath, encryptedLtKey, FilePerms); err != nil {
|
||||||
return nil, fmt.Errorf("failed to write SE-encrypted long-term key: %w", err)
|
return nil, fmt.Errorf(
|
||||||
|
"failed to write SE-encrypted long-term key: %w",
|
||||||
|
err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Write metadata
|
// Write metadata
|
||||||
@@ -274,12 +308,40 @@ func CreateSecureEnclaveUnlocker(fs afero.Fs, stateDir string) (*SecureEnclaveUn
|
|||||||
|
|
||||||
// getLongTermKeyForSE retrieves the vault's long-term private key
|
// getLongTermKeyForSE retrieves the vault's long-term private key
|
||||||
// either from the mnemonic env var or by unlocking via the current unlocker.
|
// either from the mnemonic env var or by unlocking via the current unlocker.
|
||||||
func getLongTermKeyForSE(fs afero.Fs, vault VaultInterface) (*memguard.LockedBuffer, error) {
|
func getLongTermKeyForSE(
|
||||||
|
fs afero.Fs,
|
||||||
|
vault VaultInterface,
|
||||||
|
) (*memguard.LockedBuffer, error) {
|
||||||
envMnemonic := os.Getenv(EnvMnemonic)
|
envMnemonic := os.Getenv(EnvMnemonic)
|
||||||
if envMnemonic != "" {
|
if envMnemonic != "" {
|
||||||
ltIdentity, err := agehd.DeriveIdentity(envMnemonic, 0)
|
// Read vault metadata to get the correct derivation index
|
||||||
|
vaultDir, err := vault.GetDirectory()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("failed to derive long-term key from mnemonic: %w", err)
|
return nil, fmt.Errorf("failed to get vault directory: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
metadataPath := filepath.Join(vaultDir, "vault-metadata.json")
|
||||||
|
metadataBytes, err := afero.ReadFile(fs, metadataPath)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to read vault metadata: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var metadata VaultMetadata
|
||||||
|
if err := json.Unmarshal(metadataBytes, &metadata); err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to parse vault metadata: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Use mnemonic with the vault's actual derivation index
|
||||||
|
ltIdentity, err := agehd.DeriveIdentity(
|
||||||
|
envMnemonic,
|
||||||
|
metadata.DerivationIndex,
|
||||||
|
)
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf(
|
||||||
|
"failed to derive long-term key from mnemonic: %w",
|
||||||
|
err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
return memguard.NewBufferFromBytes([]byte(ltIdentity.String())), nil
|
return memguard.NewBufferFromBytes([]byte(ltIdentity.String())), nil
|
||||||
@@ -292,17 +354,29 @@ func getLongTermKeyForSE(fs afero.Fs, vault VaultInterface) (*memguard.LockedBuf
|
|||||||
|
|
||||||
currentIdentity, err := currentUnlocker.GetIdentity()
|
currentIdentity, err := currentUnlocker.GetIdentity()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("failed to get current unlocker identity: %w", err)
|
return nil, fmt.Errorf(
|
||||||
|
"failed to get current unlocker identity: %w",
|
||||||
|
err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// All unlocker types store longterm.age in their directory
|
// All unlocker types store longterm.age in their directory
|
||||||
longtermPath := filepath.Join(currentUnlocker.GetDirectory(), "longterm.age")
|
longtermPath := filepath.Join(
|
||||||
|
currentUnlocker.GetDirectory(),
|
||||||
|
"longterm.age",
|
||||||
|
)
|
||||||
encryptedLtKey, err := afero.ReadFile(fs, longtermPath)
|
encryptedLtKey, err := afero.ReadFile(fs, longtermPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("failed to read encrypted long-term key: %w", err)
|
return nil, fmt.Errorf(
|
||||||
|
"failed to read encrypted long-term key: %w",
|
||||||
|
err,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
ltPrivKeyBuffer, err := DecryptWithIdentity(encryptedLtKey, currentIdentity)
|
ltPrivKeyBuffer, err := DecryptWithIdentity(
|
||||||
|
encryptedLtKey,
|
||||||
|
currentIdentity,
|
||||||
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("failed to decrypt long-term key: %w", err)
|
return nil, fmt.Errorf("failed to decrypt long-term key: %w", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,10 +4,16 @@
|
|||||||
package secret
|
package secret
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"fmt"
|
||||||
|
|
||||||
"filippo.io/age"
|
"filippo.io/age"
|
||||||
"github.com/spf13/afero"
|
"github.com/spf13/afero"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
var errSENotSupported = fmt.Errorf(
|
||||||
|
"secure enclave unlockers are only supported on macOS",
|
||||||
|
)
|
||||||
|
|
||||||
// SecureEnclaveUnlockerMetadata is a stub for non-Darwin platforms.
|
// SecureEnclaveUnlockerMetadata is a stub for non-Darwin platforms.
|
||||||
type SecureEnclaveUnlockerMetadata struct {
|
type SecureEnclaveUnlockerMetadata struct {
|
||||||
UnlockerMetadata
|
UnlockerMetadata
|
||||||
@@ -22,42 +28,57 @@ type SecureEnclaveUnlocker struct {
|
|||||||
fs afero.Fs
|
fs afero.Fs
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetIdentity panics on non-Darwin platforms.
|
// GetIdentity returns an error on non-Darwin platforms.
|
||||||
func (s *SecureEnclaveUnlocker) GetIdentity() (*age.X25519Identity, error) {
|
func (s *SecureEnclaveUnlocker) GetIdentity() (*age.X25519Identity, error) {
|
||||||
panic("secure enclave unlockers are only supported on macOS")
|
return nil, errSENotSupported
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetType panics on non-Darwin platforms.
|
// GetType returns the unlocker type.
|
||||||
func (s *SecureEnclaveUnlocker) GetType() string {
|
func (s *SecureEnclaveUnlocker) GetType() string {
|
||||||
panic("secure enclave unlockers are only supported on macOS")
|
return "secure-enclave"
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetMetadata panics on non-Darwin platforms.
|
// GetMetadata returns the unlocker metadata.
|
||||||
func (s *SecureEnclaveUnlocker) GetMetadata() UnlockerMetadata {
|
func (s *SecureEnclaveUnlocker) GetMetadata() UnlockerMetadata {
|
||||||
panic("secure enclave unlockers are only supported on macOS")
|
return s.Metadata
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetDirectory panics on non-Darwin platforms.
|
// GetDirectory returns the unlocker directory.
|
||||||
func (s *SecureEnclaveUnlocker) GetDirectory() string {
|
func (s *SecureEnclaveUnlocker) GetDirectory() string {
|
||||||
panic("secure enclave unlockers are only supported on macOS")
|
return s.Directory
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetID panics on non-Darwin platforms.
|
// GetID returns the unlocker ID.
|
||||||
func (s *SecureEnclaveUnlocker) GetID() string {
|
func (s *SecureEnclaveUnlocker) GetID() string {
|
||||||
panic("secure enclave unlockers are only supported on macOS")
|
return fmt.Sprintf(
|
||||||
|
"%s-secure-enclave",
|
||||||
|
s.Metadata.CreatedAt.Format("2006-01-02.15.04"),
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Remove panics on non-Darwin platforms.
|
// Remove returns an error on non-Darwin platforms.
|
||||||
func (s *SecureEnclaveUnlocker) Remove() error {
|
func (s *SecureEnclaveUnlocker) Remove() error {
|
||||||
panic("secure enclave unlockers are only supported on macOS")
|
return errSENotSupported
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewSecureEnclaveUnlocker panics on non-Darwin platforms.
|
// NewSecureEnclaveUnlocker creates a stub SecureEnclaveUnlocker on non-Darwin platforms.
|
||||||
func NewSecureEnclaveUnlocker(_ afero.Fs, _ string, _ UnlockerMetadata) *SecureEnclaveUnlocker {
|
// The returned instance's methods that require macOS functionality will return errors.
|
||||||
panic("secure enclave unlockers are only supported on macOS")
|
func NewSecureEnclaveUnlocker(
|
||||||
|
fs afero.Fs,
|
||||||
|
directory string,
|
||||||
|
metadata UnlockerMetadata,
|
||||||
|
) *SecureEnclaveUnlocker {
|
||||||
|
return &SecureEnclaveUnlocker{
|
||||||
|
Directory: directory,
|
||||||
|
Metadata: metadata,
|
||||||
|
fs: fs,
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// CreateSecureEnclaveUnlocker panics on non-Darwin platforms.
|
// CreateSecureEnclaveUnlocker returns an error on non-Darwin platforms.
|
||||||
func CreateSecureEnclaveUnlocker(_ afero.Fs, _ string) (*SecureEnclaveUnlocker, error) {
|
func CreateSecureEnclaveUnlocker(
|
||||||
panic("secure enclave unlockers are only supported on macOS")
|
_ afero.Fs,
|
||||||
|
_ string,
|
||||||
|
) (*SecureEnclaveUnlocker, error) {
|
||||||
|
return nil, errSENotSupported
|
||||||
}
|
}
|
||||||
|
|||||||
90
internal/secret/seunlocker_stub_test.go
Normal file
90
internal/secret/seunlocker_stub_test.go
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
//go:build !darwin
|
||||||
|
// +build !darwin
|
||||||
|
|
||||||
|
package secret
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/spf13/afero"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestNewSecureEnclaveUnlocker(t *testing.T) {
|
||||||
|
fs := afero.NewMemMapFs()
|
||||||
|
dir := "/tmp/test-se-unlocker"
|
||||||
|
metadata := UnlockerMetadata{
|
||||||
|
Type: "secure-enclave",
|
||||||
|
CreatedAt: time.Date(2026, 1, 15, 10, 30, 0, 0, time.UTC),
|
||||||
|
Flags: []string{"secure-enclave", "macos"},
|
||||||
|
}
|
||||||
|
|
||||||
|
unlocker := NewSecureEnclaveUnlocker(fs, dir, metadata)
|
||||||
|
require.NotNil(t, unlocker, "NewSecureEnclaveUnlocker should return a valid instance")
|
||||||
|
|
||||||
|
// Test GetType returns correct type
|
||||||
|
assert.Equal(t, "secure-enclave", unlocker.GetType())
|
||||||
|
|
||||||
|
// Test GetMetadata returns the metadata we passed in
|
||||||
|
assert.Equal(t, metadata, unlocker.GetMetadata())
|
||||||
|
|
||||||
|
// Test GetDirectory returns the directory we passed in
|
||||||
|
assert.Equal(t, dir, unlocker.GetDirectory())
|
||||||
|
|
||||||
|
// Test GetID returns a formatted string with the creation timestamp
|
||||||
|
expectedID := "2026-01-15.10.30-secure-enclave"
|
||||||
|
assert.Equal(t, expectedID, unlocker.GetID())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSecureEnclaveUnlockerGetIdentityReturnsError(t *testing.T) {
|
||||||
|
fs := afero.NewMemMapFs()
|
||||||
|
metadata := UnlockerMetadata{
|
||||||
|
Type: "secure-enclave",
|
||||||
|
CreatedAt: time.Now().UTC(),
|
||||||
|
}
|
||||||
|
|
||||||
|
unlocker := NewSecureEnclaveUnlocker(fs, "/tmp/test", metadata)
|
||||||
|
|
||||||
|
identity, err := unlocker.GetIdentity()
|
||||||
|
assert.Nil(t, identity)
|
||||||
|
assert.Error(t, err)
|
||||||
|
assert.ErrorIs(t, err, errSENotSupported)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSecureEnclaveUnlockerRemoveReturnsError(t *testing.T) {
|
||||||
|
fs := afero.NewMemMapFs()
|
||||||
|
metadata := UnlockerMetadata{
|
||||||
|
Type: "secure-enclave",
|
||||||
|
CreatedAt: time.Now().UTC(),
|
||||||
|
}
|
||||||
|
|
||||||
|
unlocker := NewSecureEnclaveUnlocker(fs, "/tmp/test", metadata)
|
||||||
|
|
||||||
|
err := unlocker.Remove()
|
||||||
|
assert.Error(t, err)
|
||||||
|
assert.ErrorIs(t, err, errSENotSupported)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCreateSecureEnclaveUnlockerReturnsError(t *testing.T) {
|
||||||
|
fs := afero.NewMemMapFs()
|
||||||
|
|
||||||
|
unlocker, err := CreateSecureEnclaveUnlocker(fs, "/tmp/test")
|
||||||
|
assert.Nil(t, unlocker)
|
||||||
|
assert.Error(t, err)
|
||||||
|
assert.ErrorIs(t, err, errSENotSupported)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSecureEnclaveUnlockerImplementsInterface(t *testing.T) {
|
||||||
|
fs := afero.NewMemMapFs()
|
||||||
|
metadata := UnlockerMetadata{
|
||||||
|
Type: "secure-enclave",
|
||||||
|
CreatedAt: time.Now().UTC(),
|
||||||
|
}
|
||||||
|
|
||||||
|
unlocker := NewSecureEnclaveUnlocker(fs, "/tmp/test", metadata)
|
||||||
|
|
||||||
|
// Verify the stub implements the Unlocker interface
|
||||||
|
var _ Unlocker = unlocker
|
||||||
|
}
|
||||||
101
internal/secret/seunlocker_test.go
Normal file
101
internal/secret/seunlocker_test.go
Normal file
@@ -0,0 +1,101 @@
|
|||||||
|
//go:build darwin
|
||||||
|
// +build darwin
|
||||||
|
|
||||||
|
package secret
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/spf13/afero"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestNewSecureEnclaveUnlocker(t *testing.T) {
|
||||||
|
fs := afero.NewMemMapFs()
|
||||||
|
dir := "/tmp/test-se-unlocker"
|
||||||
|
metadata := UnlockerMetadata{
|
||||||
|
Type: "secure-enclave",
|
||||||
|
CreatedAt: time.Date(2026, 1, 15, 10, 30, 0, 0, time.UTC),
|
||||||
|
Flags: []string{"secure-enclave", "macos"},
|
||||||
|
}
|
||||||
|
|
||||||
|
unlocker := NewSecureEnclaveUnlocker(fs, dir, metadata)
|
||||||
|
require.NotNil(t, unlocker, "NewSecureEnclaveUnlocker should return a valid instance")
|
||||||
|
|
||||||
|
// Test GetType returns correct type
|
||||||
|
assert.Equal(t, seUnlockerType, unlocker.GetType())
|
||||||
|
|
||||||
|
// Test GetMetadata returns the metadata we passed in
|
||||||
|
assert.Equal(t, metadata, unlocker.GetMetadata())
|
||||||
|
|
||||||
|
// Test GetDirectory returns the directory we passed in
|
||||||
|
assert.Equal(t, dir, unlocker.GetDirectory())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSecureEnclaveUnlockerImplementsInterface(t *testing.T) {
|
||||||
|
fs := afero.NewMemMapFs()
|
||||||
|
metadata := UnlockerMetadata{
|
||||||
|
Type: "secure-enclave",
|
||||||
|
CreatedAt: time.Now().UTC(),
|
||||||
|
}
|
||||||
|
|
||||||
|
unlocker := NewSecureEnclaveUnlocker(fs, "/tmp/test", metadata)
|
||||||
|
|
||||||
|
// Verify the darwin implementation implements the Unlocker interface
|
||||||
|
var _ Unlocker = unlocker
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSecureEnclaveUnlockerGetIDFormat(t *testing.T) {
|
||||||
|
fs := afero.NewMemMapFs()
|
||||||
|
metadata := UnlockerMetadata{
|
||||||
|
Type: "secure-enclave",
|
||||||
|
CreatedAt: time.Date(2026, 3, 10, 14, 30, 0, 0, time.UTC),
|
||||||
|
}
|
||||||
|
|
||||||
|
unlocker := NewSecureEnclaveUnlocker(fs, "/tmp/test", metadata)
|
||||||
|
id := unlocker.GetID()
|
||||||
|
|
||||||
|
// ID should contain the timestamp and "secure-enclave" type
|
||||||
|
assert.Contains(t, id, "2026-03-10.14.30")
|
||||||
|
assert.Contains(t, id, seUnlockerType)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGenerateSEKeyLabel(t *testing.T) {
|
||||||
|
label, err := generateSEKeyLabel("test-vault")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// Label should contain the prefix and vault name
|
||||||
|
assert.Contains(t, label, seKeyLabelPrefix)
|
||||||
|
assert.Contains(t, label, "test-vault")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSecureEnclaveUnlockerGetIdentityMissingFile(t *testing.T) {
|
||||||
|
fs := afero.NewMemMapFs()
|
||||||
|
dir := "/tmp/test-se-unlocker-missing"
|
||||||
|
|
||||||
|
// Create unlocker directory with metadata but no encrypted key file
|
||||||
|
require.NoError(t, fs.MkdirAll(dir, DirPerms))
|
||||||
|
|
||||||
|
metadataJSON := `{
|
||||||
|
"type": "secure-enclave",
|
||||||
|
"createdAt": "2026-01-15T10:30:00Z",
|
||||||
|
"seKeyLabel": "berlin.sneak.app.secret.se.test",
|
||||||
|
"seKeyHash": "abc123"
|
||||||
|
}`
|
||||||
|
require.NoError(t, afero.WriteFile(fs, dir+"/unlocker-metadata.json", []byte(metadataJSON), FilePerms))
|
||||||
|
|
||||||
|
metadata := UnlockerMetadata{
|
||||||
|
Type: "secure-enclave",
|
||||||
|
CreatedAt: time.Date(2026, 1, 15, 10, 30, 0, 0, time.UTC),
|
||||||
|
}
|
||||||
|
|
||||||
|
unlocker := NewSecureEnclaveUnlocker(fs, dir, metadata)
|
||||||
|
|
||||||
|
// GetIdentity should fail because the encrypted longterm key file is missing
|
||||||
|
identity, err := unlocker.GetIdentity()
|
||||||
|
assert.Nil(t, identity)
|
||||||
|
assert.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "failed to read SE-encrypted long-term key")
|
||||||
|
}
|
||||||
148
internal/secret/validation_darwin_test.go
Normal file
148
internal/secret/validation_darwin_test.go
Normal file
@@ -0,0 +1,148 @@
|
|||||||
|
//go:build darwin
|
||||||
|
|
||||||
|
package secret
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestValidateKeychainItemName(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
itemName string
|
||||||
|
wantErr bool
|
||||||
|
}{
|
||||||
|
// Valid cases
|
||||||
|
{
|
||||||
|
name: "valid simple name",
|
||||||
|
itemName: "my-secret-key",
|
||||||
|
wantErr: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "valid name with dots",
|
||||||
|
itemName: "com.example.app.key",
|
||||||
|
wantErr: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "valid name with underscores",
|
||||||
|
itemName: "my_secret_key_123",
|
||||||
|
wantErr: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "valid alphanumeric",
|
||||||
|
itemName: "Secret123Key",
|
||||||
|
wantErr: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "valid with hyphen at start",
|
||||||
|
itemName: "-my-key",
|
||||||
|
wantErr: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "valid with dot at start",
|
||||||
|
itemName: ".hidden-key",
|
||||||
|
wantErr: false,
|
||||||
|
},
|
||||||
|
|
||||||
|
// Invalid cases
|
||||||
|
{
|
||||||
|
name: "empty item name",
|
||||||
|
itemName: "",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with spaces",
|
||||||
|
itemName: "my secret key",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with semicolon",
|
||||||
|
itemName: "key;rm -rf /",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with pipe",
|
||||||
|
itemName: "key|cat /etc/passwd",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with backticks",
|
||||||
|
itemName: "key`whoami`",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with dollar sign",
|
||||||
|
itemName: "key$(whoami)",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with quotes",
|
||||||
|
itemName: "key\"name",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with single quotes",
|
||||||
|
itemName: "key'name",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with backslash",
|
||||||
|
itemName: "key\\name",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with newline",
|
||||||
|
itemName: "key\nname",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with carriage return",
|
||||||
|
itemName: "key\rname",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with ampersand",
|
||||||
|
itemName: "key&echo test",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with redirect",
|
||||||
|
itemName: "key>/tmp/test",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with null byte",
|
||||||
|
itemName: "key\x00name",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with parentheses",
|
||||||
|
itemName: "key(test)",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with brackets",
|
||||||
|
itemName: "key[test]",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with asterisk",
|
||||||
|
itemName: "key*",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "item name with question mark",
|
||||||
|
itemName: "key?",
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
err := validateKeychainItemName(tt.itemName)
|
||||||
|
if (err != nil) != tt.wantErr {
|
||||||
|
t.Errorf("validateKeychainItemName() error = %v, wantErr %v", err, tt.wantErr)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -154,144 +154,3 @@ func TestValidateGPGKeyID(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestValidateKeychainItemName(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
itemName string
|
|
||||||
wantErr bool
|
|
||||||
}{
|
|
||||||
// Valid cases
|
|
||||||
{
|
|
||||||
name: "valid simple name",
|
|
||||||
itemName: "my-secret-key",
|
|
||||||
wantErr: false,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "valid name with dots",
|
|
||||||
itemName: "com.example.app.key",
|
|
||||||
wantErr: false,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "valid name with underscores",
|
|
||||||
itemName: "my_secret_key_123",
|
|
||||||
wantErr: false,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "valid alphanumeric",
|
|
||||||
itemName: "Secret123Key",
|
|
||||||
wantErr: false,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "valid with hyphen at start",
|
|
||||||
itemName: "-my-key",
|
|
||||||
wantErr: false,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "valid with dot at start",
|
|
||||||
itemName: ".hidden-key",
|
|
||||||
wantErr: false,
|
|
||||||
},
|
|
||||||
|
|
||||||
// Invalid cases
|
|
||||||
{
|
|
||||||
name: "empty item name",
|
|
||||||
itemName: "",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with spaces",
|
|
||||||
itemName: "my secret key",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with semicolon",
|
|
||||||
itemName: "key;rm -rf /",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with pipe",
|
|
||||||
itemName: "key|cat /etc/passwd",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with backticks",
|
|
||||||
itemName: "key`whoami`",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with dollar sign",
|
|
||||||
itemName: "key$(whoami)",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with quotes",
|
|
||||||
itemName: "key\"name",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with single quotes",
|
|
||||||
itemName: "key'name",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with backslash",
|
|
||||||
itemName: "key\\name",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with newline",
|
|
||||||
itemName: "key\nname",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with carriage return",
|
|
||||||
itemName: "key\rname",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with ampersand",
|
|
||||||
itemName: "key&echo test",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with redirect",
|
|
||||||
itemName: "key>/tmp/test",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with null byte",
|
|
||||||
itemName: "key\x00name",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with parentheses",
|
|
||||||
itemName: "key(test)",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with brackets",
|
|
||||||
itemName: "key[test]",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with asterisk",
|
|
||||||
itemName: "key*",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "item name with question mark",
|
|
||||||
itemName: "key?",
|
|
||||||
wantErr: true,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
|
||||||
err := validateKeychainItemName(tt.itemName)
|
|
||||||
if (err != nil) != tt.wantErr {
|
|
||||||
t.Errorf("validateKeychainItemName() error = %v, wantErr %v", err, tt.wantErr)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
Reference in New Issue
Block a user