Module signer

Source
Expand description

Core signer domain model and business logic.

This module provides the central Signer type that represents signers throughout the relayer system, including:

  • Domain Model: Core Signer struct with validation and configuration
  • Business Logic: Update operations and validation rules
  • Error Handling: Comprehensive validation error types
  • Interoperability: Conversions between API, config, and repository representations

The signer model supports multiple signer types including local keys, AWS KMS, Google Cloud KMS, Vault, and Turnkey service integrations.

Structs§

AwsKmsSignerConfig
AWS KMS signer configuration The configuration supports:
AwsKmsSignerConfigStorage
Storage representations for other signer types (these are simpler as they don’t contain secrets that need encoding)
AwsKmsSignerFileConfig
AwsKmsSignerRequestConfig
AWS KMS signer configuration for API requests
GoogleCloudKmsKeyFileConfig
GoogleCloudKmsServiceAccountFileConfig
GoogleCloudKmsSignerConfig
Google Cloud KMS signer configuration
GoogleCloudKmsSignerConfigStorage
GoogleCloudKmsSignerFileConfig
GoogleCloudKmsSignerKeyConfig
Google Cloud KMS key configuration
GoogleCloudKmsSignerKeyConfigStorage
GoogleCloudKmsSignerKeyRequestConfig
Google Cloud KMS key configuration for API requests
GoogleCloudKmsSignerKeyResponseConfig
GoogleCloudKmsSignerRequestConfig
Google Cloud KMS signer configuration for API requests
GoogleCloudKmsSignerServiceAccountConfig
Google Cloud KMS service account configuration
GoogleCloudKmsSignerServiceAccountConfigStorage
GoogleCloudKmsSignerServiceAccountRequestConfig
Google Cloud KMS service account configuration for API requests
GoogleCloudKmsSignerServiceAccountResponseConfig
LocalSignerConfig
Local signer configuration for storing private keys
LocalSignerConfigStorage
Local signer configuration for storage (with base64 encoding)
LocalSignerFileConfig
LocalSignerRequestConfig
Local signer configuration for API requests
Signer
Core signer domain model containing both metadata and configuration
SignerCreateRequest
Request model for creating a new signer
SignerFileConfig
Individual signer configuration from config file
SignerRepoModel
Repository model for signer storage and retrieval
SignerResponse
SignerUpdateRequest
Request model for updating an existing signer At the moment, we don’t allow updating signers
SignersFileConfig
Collection of signer configurations
TurnkeySignerConfig
Turnkey signer configuration
TurnkeySignerConfigStorage
TurnkeySignerFileConfig
TurnkeySignerRequestConfig
Turnkey signer configuration for API requests
VaultSignerConfig
Vault signer configuration
VaultSignerConfigStorage
VaultSignerFileConfig
VaultSignerRequestConfig
Vault signer configuration for API requests
VaultTransitSignerConfig
Vault Transit signer configuration
VaultTransitSignerConfigStorage
VaultTransitSignerFileConfig
VaultTransitSignerRequestConfig
Vault Transit signer configuration for API requests

Enums§

SignerConfig
Domain signer configuration enum containing all supported signer types
SignerConfigRequest
Signer configuration enum for API requests (without type discriminator)
SignerConfigResponse
Signer configuration response Does not include sensitive information like private keys
SignerConfigStorage
SignerFileConfigEnum
Main enum for all signer config types
SignerType
Signer type enum used for validation and API responses
SignerTypeRequest
Signer type enum for API requests
SignerValidationError
Validation errors for signers