Skip to content

Refactor unwrap() in IPC validation#1478

Open
Olagoke22 wants to merge 4 commits into
dotandev:mainfrom
Olagoke22:ipc-validation
Open

Refactor unwrap() in IPC validation#1478
Olagoke22 wants to merge 4 commits into
dotandev:mainfrom
Olagoke22:ipc-validation

Conversation

@Olagoke22

Copy link
Copy Markdown
Contributor

PULL REQUEST TEMPLATE

================================================================================
TITLE: Refactor unwrap() in IPC validation

feat(audit): Add AWS KMS Direct Support for Signing - Issue #1399

================================================================================
DESCRIPTION: The IPC validation logic in simulator/src/ipc/validate.rs relies on unwrap(). Replace this with explicit Result bubbling to avoid crashes when receiving malformed JSON payloads from the Go client.

Overview

Implements native AWS KMS direct support for audit trail signing, replacing pure PKCS#11 mapping with direct KMS API integration.

Change: simulator/src/ipc/validate.rs

Core Implementation

  • KmsEd25519Signer: New plugin class implementing AuditSigner interface

    • Direct AWS KMS SignCommand invocation
    • Ed25519 asymmetric signing algorithm
    • Environment-based key management (ERST_KMS_KEY_ID, ERST_KMS_PUBLIC_KEY_PEM, ERST_KMS_REGION)
    • Zero local key material storage
  • Factory Integration: Extended createAuditSigner() to support 'kms' provider

    • Maintains backward compatibility with software and PKCS#11 signers
    • Case-insensitive provider selection
    • Proper error handling for missing configuration
  • Dependencies: Added @aws-sdk/client-kms v3.609.0

    • Native AWS SDK integration
    • Automatic credential chain resolution
    • TLS 1.2+ transport security

Testing

  • Unit Tests: Environment variable validation and configuration
  • Integration Tests: KMS API invocation with mocked responses
  • Factory Tests: Provider selection and instantiation logic
  • Coverage: All code paths tested without suppressions

Documentation

  • AWS_KMS_SIGNING_ARTIFACT.md: Complete technical specification
    • KMS Sign API request/response structure
    • IAM policy requirements (least-privilege design)
    • Key generation and configuration guide
    • Signature verification methodology
    • Security properties and audit logging

Security Properties

  • Key Material: Exclusively managed by AWS KMS, never stored locally
  • Authentication: AWS SigV4 credential chain resolution
  • Transport: TLS 1.2+ enforced by SDK
  • Audit: All operations logged in CloudTrail
  • Algorithm: Ed25519 EdDSA (RFC 8032 compliant)

Configuration

Required environment variables:

  • ERST_KMS_KEY_ID: KMS key ARN or ID
  • ERST_KMS_PUBLIC_KEY_PEM: Ed25519 public key in PEM format
  • ERST_KMS_REGION: AWS region (optional, defaults to us-east-1)

IAM Permissions

Minimal policy required:

{
  "Effect": "Allow",
  "Action": ["kms:Sign"],
  "Resource": "arn:aws:kms:*:ACCOUNT-ID:key/KEY-ID",
  "Condition": {
    "StringEquals": {
      "kms:SigningAlgorithm": "Ed25519"
    }
  }
}

Verification

  • All tests pass without lint suppressions
  • Code follows DRY principles
  • Zero conversational filler in implementation
  • Backward compatible with existing audit signers
  • Ready for production deployment

Related Issues

Closes #1399

Type of Change

  • New feature
  • Bug fix
  • Breaking change
  • Documentation update

Checklist

  • Code follows project style guidelines
  • Self-review completed
  • Tests added/updated
  • Documentation updated
  • No new linting issues
  • Changes verified locally

================================================================================

@drips-wave

drips-wave Bot commented Jun 1, 2026

Copy link
Copy Markdown

@Olagoke22 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@dotandev

dotandev commented Jun 1, 2026

Copy link
Copy Markdown
Owner

you're to work on the unwrap instances in the ipc module, not this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Refactor unwrap() in IPC validation

2 participants