mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 17:41:29 +00:00
0e29c416b1
Closes one 2026-04-24 audit finding (P2):
- cat-s6-efc7f6f6bd50: 30 strings.Contains(err.Error(), ...) sites
in internal/api/handler/ — brittle to repository-layer message
changes, untyped against the actual failure mode.
Approach (Option B from prompt design notes):
- New typed sentinels in internal/repository/errors.go:
ErrNotFound, ErrForeignKeyConstraint
IsForeignKeyError(err) helper (the only place substring
matching at the lib/pq boundary is allowed; isolates the
DB-driver string knowledge to one function).
- New typed sentinel in internal/domain/errors.go:
ErrValidation (reserved for future per-entity validation
wrappers; not yet used by all handlers).
- 49 sites in internal/repository/postgres/*.go updated to wrap
sql.ErrNoRows-derived errors via fmt.Errorf("...: %w",
repository.ErrNotFound).
- 18 not-found handler sites + 2 FK-constraint handler sites
refactored to errors.Is(err, repository.ErrNotFound) /
repository.IsForeignKeyError(err).
- 23 inline `fmt.Errorf("X not found")` test fixtures across
handler tests rewrapped to wrap repository.ErrNotFound.
- test_utils.go::ErrMockNotFound rewrapped to wrap
repository.ErrNotFound; renewal_policy.go closure docblock
updated to reflect the new convention.
- integration test mockJobRepository.Get wraps repository.ErrNotFound.
CI regression guardrail:
- .github/workflows/ci.yml::"Forbidden strings.Contains(err.Error())
regression guard (S-2)" greps for the three patterns ("not found",
"violates foreign key", "RESTRICT") under internal/api/handler/
and fails the build on regression.
Verification:
- go build ./... — clean
- go vet ./... — clean
- go test ./... -short -count=1 — all packages pass (handler +
repository + service + integration)
- golangci-lint v2.11.4 run ./... — 0 issues
- S-2 guardrail dry-run on post-fix tree → empty (good)
- All sibling guardrails (S-1, G-3, D-1+D-2, B-1, L-1, H-1, C-1, F-1, P-1) pass
Audit findings closed:
- cat-s6-efc7f6f6bd50 (P2)
Deferred follow-ups:
- 6 domain-specific substring patterns still inline in handlers
("cannot approve", "cannot reject", "cannot be parsed",
"no certificates found", "challenge password", "invalid"/
"required" validation chains in profiles + agent_groups). Each
needs its own typed sentinel, scoped per service. Documented
by the S-2 CI guardrail's allowlist for closure-comments only.
- Per-entity not-found sentinels (Option A — ErrCertificateNotFound,
ErrAgentNotFound, etc.) deferred. Generic ErrNotFound covers the
current dispatch needs; per-entity precision would let handlers
return entity-aware error bodies without a domain.Type field,
but not blocking.
228 lines
6.4 KiB
Go
228 lines
6.4 KiB
Go
package postgres
|
|
|
|
import (
|
|
"github.com/shankar0123/certctl/internal/repository"
|
|
"context"
|
|
"database/sql"
|
|
"encoding/json"
|
|
"fmt"
|
|
"time"
|
|
|
|
"github.com/google/uuid"
|
|
"github.com/shankar0123/certctl/internal/domain"
|
|
)
|
|
|
|
// ProfileRepository implements repository.CertificateProfileRepository
|
|
type ProfileRepository struct {
|
|
db *sql.DB
|
|
}
|
|
|
|
// NewProfileRepository creates a new ProfileRepository
|
|
func NewProfileRepository(db *sql.DB) *ProfileRepository {
|
|
return &ProfileRepository{db: db}
|
|
}
|
|
|
|
// List returns all certificate profiles
|
|
func (r *ProfileRepository) List(ctx context.Context) ([]*domain.CertificateProfile, error) {
|
|
rows, err := r.db.QueryContext(ctx, `
|
|
SELECT id, name, description, allowed_key_algorithms, max_ttl_seconds,
|
|
allowed_ekus, required_san_patterns, spiffe_uri_pattern,
|
|
allow_short_lived, enabled, created_at, updated_at
|
|
FROM certificate_profiles
|
|
ORDER BY created_at DESC
|
|
`)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to query profiles: %w", err)
|
|
}
|
|
defer rows.Close()
|
|
|
|
var profiles []*domain.CertificateProfile
|
|
for rows.Next() {
|
|
p, err := scanProfile(rows)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
profiles = append(profiles, p)
|
|
}
|
|
|
|
if err := rows.Err(); err != nil {
|
|
return nil, fmt.Errorf("error iterating profile rows: %w", err)
|
|
}
|
|
|
|
return profiles, nil
|
|
}
|
|
|
|
// Get retrieves a certificate profile by ID
|
|
func (r *ProfileRepository) Get(ctx context.Context, id string) (*domain.CertificateProfile, error) {
|
|
row := r.db.QueryRowContext(ctx, `
|
|
SELECT id, name, description, allowed_key_algorithms, max_ttl_seconds,
|
|
allowed_ekus, required_san_patterns, spiffe_uri_pattern,
|
|
allow_short_lived, enabled, created_at, updated_at
|
|
FROM certificate_profiles
|
|
WHERE id = $1
|
|
`, id)
|
|
|
|
p, err := scanProfile(row)
|
|
if err != nil {
|
|
if err == sql.ErrNoRows {
|
|
return nil, fmt.Errorf("profile not found: %w", repository.ErrNotFound)
|
|
}
|
|
return nil, fmt.Errorf("failed to query profile: %w", err)
|
|
}
|
|
|
|
return p, nil
|
|
}
|
|
|
|
// Create stores a new certificate profile
|
|
func (r *ProfileRepository) Create(ctx context.Context, profile *domain.CertificateProfile) error {
|
|
if profile.ID == "" {
|
|
profile.ID = uuid.New().String()
|
|
}
|
|
if profile.CreatedAt.IsZero() {
|
|
profile.CreatedAt = time.Now()
|
|
}
|
|
if profile.UpdatedAt.IsZero() {
|
|
profile.UpdatedAt = time.Now()
|
|
}
|
|
|
|
algJSON, err := json.Marshal(profile.AllowedKeyAlgorithms)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to marshal allowed_key_algorithms: %w", err)
|
|
}
|
|
ekuJSON, err := json.Marshal(profile.AllowedEKUs)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to marshal allowed_ekus: %w", err)
|
|
}
|
|
sanJSON, err := json.Marshal(profile.RequiredSANPatterns)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to marshal required_san_patterns: %w", err)
|
|
}
|
|
|
|
err = r.db.QueryRowContext(ctx, `
|
|
INSERT INTO certificate_profiles (
|
|
id, name, description, allowed_key_algorithms, max_ttl_seconds,
|
|
allowed_ekus, required_san_patterns, spiffe_uri_pattern,
|
|
allow_short_lived, enabled, created_at, updated_at
|
|
) VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12)
|
|
RETURNING id
|
|
`, profile.ID, profile.Name, profile.Description, algJSON, profile.MaxTTLSeconds,
|
|
ekuJSON, sanJSON, profile.SPIFFEURIPattern,
|
|
profile.AllowShortLived, profile.Enabled, profile.CreatedAt, profile.UpdatedAt).Scan(&profile.ID)
|
|
|
|
if err != nil {
|
|
return fmt.Errorf("failed to create profile: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Update modifies an existing certificate profile
|
|
func (r *ProfileRepository) Update(ctx context.Context, profile *domain.CertificateProfile) error {
|
|
profile.UpdatedAt = time.Now()
|
|
|
|
algJSON, err := json.Marshal(profile.AllowedKeyAlgorithms)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to marshal allowed_key_algorithms: %w", err)
|
|
}
|
|
ekuJSON, err := json.Marshal(profile.AllowedEKUs)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to marshal allowed_ekus: %w", err)
|
|
}
|
|
sanJSON, err := json.Marshal(profile.RequiredSANPatterns)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to marshal required_san_patterns: %w", err)
|
|
}
|
|
|
|
result, err := r.db.ExecContext(ctx, `
|
|
UPDATE certificate_profiles SET
|
|
name = $1,
|
|
description = $2,
|
|
allowed_key_algorithms = $3,
|
|
max_ttl_seconds = $4,
|
|
allowed_ekus = $5,
|
|
required_san_patterns = $6,
|
|
spiffe_uri_pattern = $7,
|
|
allow_short_lived = $8,
|
|
enabled = $9,
|
|
updated_at = $10
|
|
WHERE id = $11
|
|
`, profile.Name, profile.Description, algJSON, profile.MaxTTLSeconds,
|
|
ekuJSON, sanJSON, profile.SPIFFEURIPattern,
|
|
profile.AllowShortLived, profile.Enabled, profile.UpdatedAt, profile.ID)
|
|
|
|
if err != nil {
|
|
return fmt.Errorf("failed to update profile: %w", err)
|
|
}
|
|
|
|
rows, err := result.RowsAffected()
|
|
if err != nil {
|
|
return fmt.Errorf("failed to get rows affected: %w", err)
|
|
}
|
|
|
|
if rows == 0 {
|
|
return fmt.Errorf("profile not found: %w", repository.ErrNotFound)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Delete removes a certificate profile
|
|
func (r *ProfileRepository) Delete(ctx context.Context, id string) error {
|
|
result, err := r.db.ExecContext(ctx, "DELETE FROM certificate_profiles WHERE id = $1", id)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to delete profile: %w", err)
|
|
}
|
|
|
|
rows, err := result.RowsAffected()
|
|
if err != nil {
|
|
return fmt.Errorf("failed to get rows affected: %w", err)
|
|
}
|
|
|
|
if rows == 0 {
|
|
return fmt.Errorf("profile not found: %w", repository.ErrNotFound)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// scanProfile scans a certificate profile from a row or rows
|
|
func scanProfile(scanner interface {
|
|
Scan(...interface{}) error
|
|
}) (*domain.CertificateProfile, error) {
|
|
var p domain.CertificateProfile
|
|
var algJSON, ekuJSON, sanJSON []byte
|
|
|
|
err := scanner.Scan(
|
|
&p.ID, &p.Name, &p.Description, &algJSON, &p.MaxTTLSeconds,
|
|
&ekuJSON, &sanJSON, &p.SPIFFEURIPattern,
|
|
&p.AllowShortLived, &p.Enabled, &p.CreatedAt, &p.UpdatedAt,
|
|
)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to scan profile: %w", err)
|
|
}
|
|
|
|
if len(algJSON) > 0 {
|
|
if err := json.Unmarshal(algJSON, &p.AllowedKeyAlgorithms); err != nil {
|
|
return nil, fmt.Errorf("failed to unmarshal allowed_key_algorithms: %w", err)
|
|
}
|
|
} else {
|
|
p.AllowedKeyAlgorithms = domain.DefaultKeyAlgorithms()
|
|
}
|
|
|
|
if len(ekuJSON) > 0 {
|
|
if err := json.Unmarshal(ekuJSON, &p.AllowedEKUs); err != nil {
|
|
return nil, fmt.Errorf("failed to unmarshal allowed_ekus: %w", err)
|
|
}
|
|
} else {
|
|
p.AllowedEKUs = domain.DefaultEKUs()
|
|
}
|
|
|
|
if len(sanJSON) > 0 {
|
|
if err := json.Unmarshal(sanJSON, &p.RequiredSANPatterns); err != nil {
|
|
return nil, fmt.Errorf("failed to unmarshal required_san_patterns: %w", err)
|
|
}
|
|
}
|
|
|
|
return &p, nil
|
|
}
|