# digitalcredentials/signing-service architecture

> Architecture diagram of the GitHub repository digitalcredentials/signing-service, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/digitalcredentials/signing-service
- Repository: https://github.com/digitalcredentials/signing-service

## Overview

##### Main System Components

a) HTTP Server Layer
- Express.js server handling four main endpoints:
- POST /instance/:instanceId/credentials/sign
- GET /did-key-generator
- POST /did-web-generator
- GET /healthz

b) Tenant Management System
- Multi-tenant architecture supporting multiple signing keys
- Tenant configuration management
- Seed storage and management

c) Signing System
- Credential signing logic
- DID key generation and management
- Support for both did:key and did:web methods

d) Middleware Layer
- Access logging
- Error handling
- Error logging
- Invalid path handling

##### External Integrations

Connections to:
- DID Registries (for key verification)
- Health check notification systems (SMTP/Slack)
- Docker health check system

**[HTTP Layer] → [Middleware Layer] → [Tenant Management] → [Signing System]**

##### Component Relationships

Key flows:

a) Credential Signing Flow:
**Client → HTTP Endpoint → Tenant Validation → Signing Process → Signed Credential**

b) DID Generation Flow:
**Client → Generator Endpoint → Key Generation → DID Document Creation → Response**

c) Health Check Flow:
**Docker → Health Check → Service Test → Notification System**

##### Important Details

a) Configuration Elements:
- Environment variables
- Tenant configurations
- Logging settings

b) Security Boundaries:
- DID verification zones
- Tenant isolation
- Key management boundaries

c) Monitoring Points:
- Health check paths
- Logging points
- Error handling flows

##### Technical Specifications

Technical details:

- Node.js/Express.js as the primary runtime
- Docker containerization
- Support for both did:key and did:web methods
- Logging levels and destinations
- Health check mechanisms

##### Integration Points

Integration points for:
- DCC issuer-coordinator
- DCC workflow-coordinator
- External DID registries
- Monitoring systems

Remember to emphasize the service's role within the larger DCC ecosystem while showing its capability to function as a standalone service.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Client
        C[Client Applications]
    end

    subgraph "HTTP Server Layer"
        SRV["Server Entry Point"]
        APP["Express App"]
        EP1["/instance/:instanceId/credentials/sign"]:::endpoint
        EP2["/did-key-generator"]:::endpoint
        EP3["/did-web-generator"]:::endpoint
        EP4["/healthz"]:::endpoint
    end

    subgraph "Middleware Layer"
        AL["Access Logger"]
        EH["Error Handler"]
        EL["Error Logger"]
        IPH["Invalid Path Handler"]
    end

    subgraph "Core Services"
        direction TB
        TM["Tenant Management"]
        CFG["Configuration System"]
        SIG["Signing System"]
        DID["DID Generation"]
        SD["Seed Management"]
        LOG["Logging Utility"]
    end

    subgraph "Health Monitoring"
        HC["Health Check System"]
        NF["Notification Systems"]
    end

    subgraph "External Systems"
        DR["DID Registries"]
        DC["Docker Container"]
    end

    C --> EP1 & EP2 & EP3 & EP4
    EP1 & EP2 & EP3 & EP4 --> AL
    AL --> EH
    EH --> EL
    EL --> IPH
    IPH --> TM
    TM --> CFG
    CFG --> SIG
    CFG --> DID
    SIG --> SD
    DID --> SD
    SIG & DID --> LOG
    EP4 --> HC
    HC --> NF
    SIG --> DR
    DC --> HC

    classDef endpoint fill:#f96,stroke:#333
    classDef external fill:#ccf,stroke:#333

    click SRV "https://github.com/digitalcredentials/signing-service/blob/main/server.js"
    click APP "https://github.com/digitalcredentials/signing-service/blob/main/src/app.js"
    click DID "https://github.com/digitalcredentials/signing-service/blob/main/src/generate.js"
    click SIG "https://github.com/digitalcredentials/signing-service/blob/main/src/issue.js"
    click AL "https://github.com/digitalcredentials/signing-service/blob/main/src/middleware/accessLogger.js"
    click EH "https://github.com/digitalcredentials/signing-service/blob/main/src/middleware/errorHandler.js"
    click EL "https://github.com/digitalcredentials/signing-service/blob/main/src/middleware/errorLogger.js"
    click IPH "https://github.com/digitalcredentials/signing-service/blob/main/src/middleware/invalidPathHandler.js"
    click CFG "https://github.com/digitalcredentials/signing-service/blob/main/src/config.js"
    click SD "https://github.com/digitalcredentials/signing-service/blob/main/src/utils/decodeSeed.js"
    click LOG "https://github.com/digitalcredentials/signing-service/blob/main/src/utils/logger.js"
    click HC "https://github.com/digitalcredentials/signing-service/blob/main/healthcheck.js"
```
