# go-acme/lego architecture

> Architecture diagram of the GitHub repository go-acme/lego, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/go-acme/lego
- Repository: https://github.com/go-acme/lego

## Overview

##### Main Components Identification

The system should be divided into these major components:

a. Core ACME Components:
- Certificate Management
- Account Management
- Challenge Solvers
- Registration System

b. Provider Integration Layer:
- DNS Providers (130+ implementations)
- HTTP Challenge Handlers
- TLS Challenge Handlers

##### Architectural Layers

a. Client Layer:
- CLI Interface (`cmd/lego/`)
- Library API (`lego/client.go`)

b. Service Layer:
- ACME Protocol Implementation (`acme/api/`)
- Certificate Operations (`certificate/`)
- Challenge Processing (`challenge/`)

c. Provider Layer:
- DNS Providers (`providers/dns/`)
- HTTP Providers (`providers/http/`)

##### Flow Representation

Main operational flows:

a. Certificate Issuance Flow:
**Client Request → Account Validation → Challenge Selection →**
**Challenge Verification → Certificate Issuance**

b. Provider Integration Flow:
**Challenge Request → Provider Selection → Provider Authentication →**
**Challenge Implementation → Verification**

##### Detailed Component Breakdown

Core Components:
**ACME Client**
- Certificate Manager
- Certificate Operations
- Renewal Handler
- Challenge Resolver
- DNS-01
- HTTP-01
- TLS-ALPN-01
- Account Manager
- Registration
- Authorization

##### Integration Points

Interfaces between:
- ACME client and Let's Encrypt servers
- Challenge solvers and DNS providers
- Certificate manager and storage system

**[Client Layer (CLI/Library API)]**
- ↓
**[ACME Protocol Layer]**
- ↓
**[Certificate Management Layer]**
- ↓
**[Challenge Resolution Layer]**
- ↓
**[Provider Integration Layer]**

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles and classes
    classDef client fill:#b3e0ff,stroke:#333,stroke-width:2px
    classDef core fill:#99ccff,stroke:#333,stroke-width:2px
    classDef challenge fill:#99ff99,stroke:#333,stroke-width:2px
    classDef provider fill:#ffcc99,stroke:#333,stroke-width:2px
    classDef platform fill:#e6e6e6,stroke:#333,stroke-width:2px

    %% Client Layer
    subgraph ClientLayer
        CLI["CLI Interface"]:::client
        LibAPI["Library API"]:::client
    end

    %% Core ACME Layer
    subgraph CoreACME
        AccountMgmt["Account Management"]:::core
        CertOps["Certificate Operations"]:::core
        OrderMgmt["Order Management"]:::core
        RegSystem["Registration System"]:::core
    end

    %% Certificate Management Layer
    subgraph CertManagement
        CertCore["Certificate Core"]:::core
        CertAuth["Authorization"]:::core
        CertRenewal["Renewal"]:::core
    end

    %% Challenge Resolution Layer
    subgraph ChallengeLayer
        ChallengeMgr["Challenge Manager"]:::challenge
        DNS01["DNS-01 Challenge"]:::challenge
        HTTP01["HTTP-01 Challenge"]:::challenge
        TLSALPN["TLS-ALPN-01 Challenge"]:::challenge
        Resolver["Challenge Resolver"]:::challenge
        Prober["Challenge Prober"]:::challenge
    end

    %% Provider Layer
    subgraph ProviderLayer
        DNSProviders["DNS Providers"]:::provider
        HTTPProviders["HTTP Providers"]:::provider
    end

    %% Platform Support
    subgraph PlatformSupport
        Config["Configuration"]:::platform
        Wait["Wait Operations"]:::platform
        Testing["Testing Tools"]:::platform
    end

    %% Relationships
    CLI --> LibAPI
    LibAPI --> AccountMgmt
    LibAPI --> CertOps
    AccountMgmt --> RegSystem
    CertOps --> OrderMgmt
    CertOps --> CertCore
    CertCore --> CertAuth
    CertCore --> CertRenewal
    CertAuth --> ChallengeMgr
    ChallengeMgr --> DNS01
    ChallengeMgr --> HTTP01
    ChallengeMgr --> TLSALPN
    ChallengeMgr --> Resolver
    Resolver --> Prober
    DNS01 --> DNSProviders
    HTTP01 --> HTTPProviders
    
    %% Click events for component mapping
    click CLI "https://github.com/go-acme/lego/blob/master/cmd/lego/main.go"
    click LibAPI "https://github.com/go-acme/lego/blob/master/lego/client.go"
    click AccountMgmt "https://github.com/go-acme/lego/blob/master/acme/api/account.go"
    click CertOps "https://github.com/go-acme/lego/blob/master/acme/api/certificate.go"
    click OrderMgmt "https://github.com/go-acme/lego/blob/master/acme/api/order.go"
    click RegSystem "https://github.com/go-acme/lego/blob/master/registration/registar.go"
    click CertCore "https://github.com/go-acme/lego/blob/master/certificate/certificates.go"
    click CertAuth "https://github.com/go-acme/lego/blob/master/certificate/authorization.go"
    click CertRenewal "https://github.com/go-acme/lego/blob/master/certificate/renewal.go"
    click ChallengeMgr "https://github.com/go-acme/lego/blob/master/challenge/challenges.go"
    click DNS01 "https://github.com/go-acme/lego/blob/master/challenge/dns01/dns_challenge.go"
    click HTTP01 "https://github.com/go-acme/lego/blob/master/challenge/http01/http_challenge.go"
    click TLSALPN "https://github.com/go-acme/lego/blob/master/challenge/tlsalpn01/tls_alpn_challenge.go"
    click Resolver "https://github.com/go-acme/lego/blob/master/challenge/resolver/solver_manager.go"
    click Prober "https://github.com/go-acme/lego/blob/master/challenge/resolver/prober.go"
    click DNSProviders "https://github.com/go-acme/lego/tree/master/providers/dns/"
    click HTTPProviders "https://github.com/go-acme/lego/tree/master/providers/http/"
    click Config "https://github.com/go-acme/lego/tree/master/platform/config/"
    click Wait "https://github.com/go-acme/lego/tree/master/platform/wait/"
    click Testing "https://github.com/go-acme/lego/tree/master/platform/tester/"
```
