完善证书管理与初始化流程

This commit is contained in:
xuans committed 2026-08-27 22:16:10 +08:00
1 parent 07636abe44
commit c74372284a
84 files changed
+10151 -3502

No files matched your search

+197
View File
@@ -0,0 +1,197 @@
package sshkey
import (
"context"
"errors"
"fmt"
"strings"
"time"
"golang.org/x/crypto/ssh"
"git.pcux.cn/xuans/Scert/backend/internal/domain"
"git.pcux.cn/xuans/Scert/backend/internal/secretstore"
)
const (
ReferencePrefix = "secret://ssh/"
secretKind = "ssh_private_key"
MaxPrivateKeyBytes = 1024 * 1024
maxNameLength = 128
maxPassphraseBytes = 4096
)
type Store interface {
Put(ctx context.Context, reference string, value map[string]string) error
Get(ctx context.Context, reference string) (map[string]string, error)
List(ctx context.Context, prefix string) ([]secretstore.Metadata, error)
Delete(ctx context.Context, reference string) error
}
// Metadata 是可安全返回给 API、CLI 和前端的 SSH 私钥元数据。
type Metadata struct {
ID string `json:"id"`
Name string `json:"name"`
Reference string `json:"reference"`
Algorithm string `json:"algorithm"`
Fingerprint string `json:"fingerprint"`
UpdatedAt time.Time `json:"updated_at"`
}
type Service struct {
store Store
}
func NewService(store Store) *Service {
return &Service{store: store}
}
func (s *Service) Create(ctx context.Context, name, privateKey, passphrase string) (Metadata, error) {
if s == nil || s.store == nil {
return Metadata{}, errors.New("SSH 私钥存储未初始化")
}
name = strings.TrimSpace(name)
if name == "" {
return Metadata{}, errors.New("SSH 私钥名称不能为空")
}
if len([]rune(name)) > maxNameLength {
return Metadata{}, fmt.Errorf("SSH 私钥名称不能超过 %d 个字符", maxNameLength)
}
privateKey = strings.TrimSpace(privateKey)
if privateKey == "" {
return Metadata{}, errors.New("SSH 私钥内容不能为空")
}
if len(privateKey) > MaxPrivateKeyBytes {
return Metadata{}, fmt.Errorf("SSH 私钥内容不能超过 %d 字节", MaxPrivateKeyBytes)
}
if len(passphrase) > maxPassphraseBytes {
return Metadata{}, fmt.Errorf("SSH 私钥口令不能超过 %d 字节", maxPassphraseBytes)
}
signer, err := parsePrivateKey(privateKey, passphrase)
if err != nil {
return Metadata{}, err
}
id := domain.NewID()
reference := ReferencePrefix + id
payload := map[string]string{
"kind": secretKind,
"name": name,
"private_key": privateKey + "\n",
"passphrase": passphrase,
"algorithm": signer.PublicKey().Type(),
"fingerprint": ssh.FingerprintSHA256(signer.PublicKey()),
}
if err := s.store.Put(ctx, reference, payload); err != nil {
return Metadata{}, fmt.Errorf("保存 SSH 私钥失败:%w", err)
}
return Metadata{
ID: id, Name: name, Reference: reference, Algorithm: payload["algorithm"],
Fingerprint: payload["fingerprint"], UpdatedAt: time.Now().UTC(),
}, nil
}
func (s *Service) List(ctx context.Context) ([]Metadata, error) {
if s == nil || s.store == nil {
return nil, errors.New("SSH 私钥存储未初始化")
}
items, err := s.store.List(ctx, ReferencePrefix)
if err != nil {
return nil, fmt.Errorf("列出 SSH 私钥失败:%w", err)
}
result := make([]Metadata, 0, len(items))
for _, item := range items {
metadata, err := s.metadata(ctx, item.Reference, item.UpdatedAt, false)
if err != nil {
return nil, err
}
result = append(result, metadata)
}
return result, nil
}
func (s *Service) ValidateReference(ctx context.Context, reference string) (Metadata, error) {
if s == nil || s.store == nil {
return Metadata{}, errors.New("SSH 私钥存储未初始化")
}
return s.metadata(ctx, strings.TrimSpace(reference), time.Time{}, true)
}
func (s *Service) Delete(ctx context.Context, id string) error {
if s == nil || s.store == nil {
return errors.New("SSH 私钥存储未初始化")
}
reference, err := referenceFromID(id)
if err != nil {
return err
}
if _, err := s.metadata(ctx, reference, time.Time{}, false); err != nil {
return err
}
if err := s.store.Delete(ctx, reference); err != nil {
return fmt.Errorf("删除 SSH 私钥失败:%w", err)
}
return nil
}
func (s *Service) Reference(id string) (string, error) {
return referenceFromID(id)
}
func (s *Service) metadata(ctx context.Context, reference string, updatedAt time.Time, validateKey bool) (Metadata, error) {
if !strings.HasPrefix(reference, ReferencePrefix) {
return Metadata{}, errors.New("SSH 私钥引用格式无效")
}
id := strings.TrimPrefix(reference, ReferencePrefix)
if _, err := referenceFromID(id); err != nil {
return Metadata{}, err
}
payload, err := s.store.Get(ctx, reference)
if err != nil {
return Metadata{}, fmt.Errorf("读取 SSH 私钥失败:%w", err)
}
if payload["kind"] != secretKind || strings.TrimSpace(payload["private_key"]) == "" {
return Metadata{}, errors.New("敏感信息引用不是有效的 SSH 私钥")
}
algorithm := payload["algorithm"]
fingerprint := payload["fingerprint"]
if validateKey || algorithm == "" || fingerprint == "" {
signer, parseErr := parsePrivateKey(payload["private_key"], payload["passphrase"])
if parseErr != nil {
return Metadata{}, parseErr
}
algorithm = signer.PublicKey().Type()
fingerprint = ssh.FingerprintSHA256(signer.PublicKey())
}
return Metadata{
ID: id, Name: payload["name"], Reference: reference,
Algorithm: algorithm, Fingerprint: fingerprint, UpdatedAt: updatedAt,
}, nil
}
func parsePrivateKey(privateKey, passphrase string) (ssh.Signer, error) {
var (
signer ssh.Signer
err error
)
if passphrase != "" {
signer, err = ssh.ParsePrivateKeyWithPassphrase([]byte(privateKey), []byte(passphrase))
} else {
signer, err = ssh.ParsePrivateKey([]byte(privateKey))
}
if err != nil {
var missing *ssh.PassphraseMissingError
if errors.As(err, &missing) {
return nil, errors.New("SSH 私钥已加密,请提供私钥口令")
}
return nil, errors.New("SSH 私钥格式或口令无效")
}
return signer, nil
}
func referenceFromID(id string) (string, error) {
id = strings.TrimSpace(id)
if id == "" || strings.ContainsAny(id, "/\\\x00\r\n") {
return "", errors.New("SSH 私钥 ID 无效")
}
return ReferencePrefix + id, nil
}
+119
View File
@@ -0,0 +1,119 @@
package sshkey
import (
"crypto/ed25519"
"crypto/rand"
"crypto/x509"
"encoding/pem"
"strings"
"testing"
"golang.org/x/crypto/ssh"
"git.pcux.cn/xuans/Scert/backend/internal/secretstore"
)
func TestServiceCreatesListsValidatesAndDeletesSSHKey(t *testing.T) {
store, err := secretstore.Open(t.TempDir())
if err != nil {
t.Fatalf("打开敏感信息存储失败:%v", err)
}
service := NewService(store)
privateKey := testPrivateKey(t)
created, err := service.Create(t.Context(), "生产部署私钥", privateKey, "")
if err != nil {
t.Fatalf("创建 SSH 私钥失败:%v", err)
}
if created.ID == "" || !strings.HasPrefix(created.Reference, ReferencePrefix) || created.Algorithm != "ssh-ed25519" || !strings.HasPrefix(created.Fingerprint, "SHA256:") {
t.Fatalf("SSH 私钥元数据无效:%+v", created)
}
items, err := service.List(t.Context())
if err != nil || len(items) != 1 || items[0].Name != "生产部署私钥" {
t.Fatalf("SSH 私钥列表无效:items=%+v err=%v", items, err)
}
validated, err := service.ValidateReference(t.Context(), created.Reference)
if err != nil || validated.Fingerprint != created.Fingerprint {
t.Fatalf("SSH 私钥引用校验失败:metadata=%+v err=%v", validated, err)
}
if err := service.Delete(t.Context(), created.ID); err != nil {
t.Fatalf("删除 SSH 私钥失败:%v", err)
}
if _, err := service.ValidateReference(t.Context(), created.Reference); err == nil {
t.Fatal("已删除的 SSH 私钥引用不应继续通过校验")
}
}
func TestServiceRejectsInvalidSSHKeyWithoutLeakingContent(t *testing.T) {
store, err := secretstore.Open(t.TempDir())
if err != nil {
t.Fatalf("打开敏感信息存储失败:%v", err)
}
privateKey := "very-sensitive-invalid-private-key"
_, err = NewService(store).Create(t.Context(), "错误私钥", privateKey, "")
if err == nil {
t.Fatal("无效 SSH 私钥应被拒绝")
}
if strings.Contains(err.Error(), privateKey) {
t.Fatalf("错误信息不应泄露私钥内容:%v", err)
}
}
func TestServiceSupportsEncryptedSSHKeyAndRejectsWrongPassphrase(t *testing.T) {
store, err := secretstore.Open(t.TempDir())
if err != nil {
t.Fatalf("failed to open secret store: %v", err)
}
privateKey := testEncryptedPrivateKey(t, "correct-passphrase")
service := NewService(store)
created, err := service.Create(t.Context(), "encrypted deployment key", privateKey, "correct-passphrase")
if err != nil {
t.Fatalf("failed to create encrypted SSH key: %v", err)
}
if created.Algorithm != "ssh-ed25519" || !strings.HasPrefix(created.Fingerprint, "SHA256:") {
t.Fatalf("invalid encrypted SSH key metadata: %+v", created)
}
_, err = service.Create(t.Context(), "wrong passphrase key", privateKey, "wrong-passphrase")
if err == nil || strings.Contains(err.Error(), "wrong-passphrase") || strings.Contains(err.Error(), "correct-passphrase") {
t.Fatalf("wrong passphrase was not rejected safely: %v", err)
}
}
func TestServiceRejectsOversizedPrivateKeyAndPassphrase(t *testing.T) {
store, err := secretstore.Open(t.TempDir())
if err != nil {
t.Fatalf("failed to open secret store: %v", err)
}
service := NewService(store)
if _, err := service.Create(t.Context(), "oversized key", strings.Repeat("a", MaxPrivateKeyBytes+1), ""); err == nil {
t.Fatal("oversized SSH private key should be rejected")
}
if _, err := service.Create(t.Context(), "oversized passphrase", testPrivateKey(t), strings.Repeat("p", maxPassphraseBytes+1)); err == nil {
t.Fatal("oversized SSH private key passphrase should be rejected")
}
}
func testPrivateKey(t *testing.T) string {
t.Helper()
_, key, err := ed25519.GenerateKey(rand.Reader)
if err != nil {
t.Fatalf("生成测试私钥失败:%v", err)
}
encoded, err := x509.MarshalPKCS8PrivateKey(key)
if err != nil {
t.Fatalf("编码测试私钥失败:%v", err)
}
return string(pem.EncodeToMemory(&pem.Block{Type: "PRIVATE KEY", Bytes: encoded}))
}
func testEncryptedPrivateKey(t *testing.T, passphrase string) string {
t.Helper()
_, key, err := ed25519.GenerateKey(rand.Reader)
if err != nil {
t.Fatalf("failed to generate test private key: %v", err)
}
block, err := ssh.MarshalPrivateKeyWithPassphrase(key, "scert-test", []byte(passphrase))
if err != nil {
t.Fatalf("failed to encrypt test private key: %v", err)
}
return string(pem.EncodeToMemory(block))
}