Utilities & Shared Packages

Relevant source files

• internal/tools/ftp/client.go
• internal/tools/ftp/config.go
• internal/tools/ftp/file.go
• internal/tools/s3/client.go
• internal/tools/smtp/client.go
• internal/tools/ssh/client.go
• pkg/core/certifier/challengers/http01/s3/s3.go
• pkg/core/notifier/providers/email/email.go
• pkg/logging/handler_hook.go
• pkg/sdk3rd-trimmed/github.com/alibabacloud-go/apig-20240327/v10/client/client.go
• pkg/sdk3rd-trimmed/github.com/alibabacloud-go/apig-20240327/v10/client/client_context_func.go
• pkg/sdk3rd-trimmed/github.com/alibabacloud-go/apig-20240327/v10/client/models.go
• pkg/sdk3rd-trimmed/github.com/volcengine/volcengine-go-sdk/service/vod20260101/api_describe_vod_domain_config.go
• pkg/utils/cert/hostname/hostname_test.go
• pkg/utils/tls/config.go
• ui/src/components/access/forms/AccessConfigFieldsProviderEmail.tsx

This page provides a high-level overview of the shared utility packages and helper tools used across the Certimate codebase. These utilities provide standardized implementations for common tasks such as multi-process communication, SSH management, certificate parsing, and cryptographic operations, ensuring consistency between the backend and frontend.

Overview of Shared Packages

The codebase segregates utilities into two primary areas: internal/tools for internal backend infrastructure and pkg/utils for general-purpose helpers. The frontend also maintains a set of specialized utilities for browser-side certificate handling, UI logic, and internationalization.

Multi-Process Communication (mproc)

Certimate uses a multi-process execution model for sensitive operations like ACME issuance to isolate dependencies and prevent global state pollution. The mproc package facilitates secure Inter-Process Communication (IPC) using encrypted temporary files.

• Sender: Generates a random AES key, encrypts input parameters, and spawns a child process using the current executable with the intercmd subcommand.
• Receiver: Decrypts the input file provided via command-line flags, executes a registered ReceiverHandler, and writes the encrypted result back to an output file.

The certapply command is a primary consumer of this pattern, allowing the ACME logic to run in a separate process space.

Storage & Infrastructure Tools

Certimate provides specialized clients for interacting with external infrastructure:

• S3 Client: A wrapper around the MinIO Go SDK that supports both V2 and V4 signatures internal/tools/s3/client.go74-81 path-style routing internal/tools/s3/client.go87 and insecure TLS configurations internal/tools/s3/client.go91-95
• FTP Client: Manages connections to FTP servers with support for directory traversal and file storage. It includes a Client struct that wraps ftp.ServerConn.
• SSH Client: A robust client supporting jump servers internal/tools/ssh/client.go107-117 multiple authentication methods (Password, Key, None) internal/tools/ssh/client.go146-207 and remote file operations.
• SMTP Client: Handles email notifications via the go-mail library, supporting SSL/TLS and authentication mechanisms internal/tools/smtp/client.go64-102

Utility Diagram: Backend to Code Entities

The following diagram maps high-level backend utility concepts to their corresponding implementations in the Go source.

Sources: internal/tools/s3/client.go40-50 internal/tools/ssh/client.go23-34 internal/tools/smtp/client.go44-62 pkg/utils/tls/config.go30-34 pkg/logging/handler_hook.go26-46

---

Backend Utilities

The backend utility collection covers low-level Go helpers for certificate manipulation, networking, and system interaction.

• Infrastructure Clients: Standardized clients for S3 internal/tools/s3/client.go23-34 SMTP internal/tools/smtp/client.go18-29 and FTP.
• TLS Configuration: Utilities to create compatible TLS configurations for older systems pkg/utils/tls/config.go11-24 and insecure configurations for internal/testing use pkg/utils/tls/config.go30-34
• Logging Extensions: A HookHandler for slog that allows intercepting log records via a WriteFunc, used for piping workflow logs to the database pkg/logging/handler_hook.go10-24
• Notification Providers: Implementations for various channels, such as Email pkg/core/notifier/providers/email/email.go45-48 which utilize the internal smtp tool pkg/core/notifier/providers/email/email.go79-82
• ACME Challengers: Specialized challengers like the S3 HTTP-01 challenger that leverage internal storage tools pkg/core/certifier/challengers/http01/s3/s3.go31-52

For deep technical details on these packages, see Backend Utilities.

---

Frontend Utilities

The frontend (React/TypeScript) includes utilities to handle file I/O, certificate validation, and internationalization.

• Form Validation: Specialized validators for hostnames and port numbers used in access configuration ui/src/components/access/forms/AccessConfigFieldsProviderEmail.tsx7
• Schema Validation: Integration of zod and antd-zod for client-side validation of provider configurations. For example, the email provider schema validates hostnames and port numbers ui/src/components/access/forms/AccessConfigFieldsProviderEmail.tsx126-140
• Internationalization (i18n): Usage of i18next and react-i18next for translating labels and error messages ui/src/components/access/forms/AccessConfigFieldsProviderEmail.tsx1-12
• Certificate Management: UI-side logic for handling certificate metadata and downloads.

Frontend Utility Mapping

This diagram associates frontend utility concepts with their TypeScript domain models and potential utility locations.

Sources: ui/src/components/access/forms/AccessConfigFieldsProviderEmail.tsx7 ui/src/components/access/forms/AccessConfigFieldsProviderEmail.tsx126-140 ui/src/components/access/forms/AccessConfigFieldsProviderEmail.tsx12

For details on the frontend implementation, see Frontend Utilities.

---

Summary Table of Key Utilities

Package/Module	Purpose	Primary Files
smtp	SMTP client wrapper for email notifications	internal/tools/smtp/client.go
s3	S3-compatible storage client for HTTP-01 challenges	internal/tools/s3/client.go
ssh	SSH client for remote execution and file transfer	internal/tools/ssh/client.go
logging	slog hook handler for record interception	pkg/logging/handler_hook.go
tls	Standardized TLS configuration factory	pkg/utils/tls/config.go
email	Email notification provider implementation	pkg/core/notifier/providers/email/email.go
s3challenger	S3-based ACME HTTP-01 challenge provider	pkg/core/certifier/challengers/http01/s3/s3.go

Sources: internal/tools/smtp/client.go1-16 internal/tools/s3/client.go1-21 internal/tools/ssh/client.go1-17 pkg/logging/handler_hook.go1-24 pkg/utils/tls/config.go1-5 pkg/core/notifier/providers/email/email.go1-12 pkg/core/certifier/challengers/http01/s3/s3.go1-8