mirrors/acme2certifier
1
0
Fork 0
mirror of https://github.com/grindsa/acme2certifier.git synced 2025-12-31 01:51:01 +02:00
Code Issues Projects Releases Packages Wiki Activity
Page: Reporting and Housekeeping support
Pages
# How to build an acme2certifier cluster on Ubuntu 22.04 <! wiki title: DEB Installation on Ubuntu 22.04 <! wiki title: External Account Binding <! wiki title: Hooks <! wiki title: Installation on Apache2 Running on Ubuntu 22.04 <! wiki title: Installation on NGINX Running on Alma Linux 9 <! wiki title: Pass Information from ACME Client to CA Handler <! wiki title: Reporting and Housekeeping <! wiki title: Support for ACME profiling <! wiki title: Support for External Databases ACME CA handler Asynchronous Mode (`async_mode`) in acme2certifier CA Handler for Microsoft Certification Authority Web Enrollment Service CA Handler for Microsoft Windows Client Certificate Enrollment Protocol (MS WCCE) CA Handler for NetGuard Certificate Lifecycle Manager CA Handler for OpenXPKI CA Handler for XCA CA Handler for an OpenSSL based CA Stored on Local File System CA Polling to Check Pending Enrollment Requests CA Trigger CA handler for Digicert CertCentral CA handler for EJBCA CA handler for Entrust ECS Enterprise CA handler for Insta ActiveCMS CA handler for Insta CA handler for Microsoft Certification Authority Web Enrollment Service CA handler for Microsoft Windows Client Certificate Enrollment Protocol (MS WCCE) CA handler for NetGuard Certificate Lifecycle Manager CA handler for NetGuard Certificate Manager and Insta Certifier CA handler for OpenXPKI CA handler for XCA CA handler for an openssl based CA stored on local file system CA handler using CMPv2 protocol CA handler using EST protocol CA polling to check pending enrollment requests CA trigger CA‐handler for Hashicorp Vault PKI Configuration options for acme2certifier Containerized Installation Using Apache2 or Nginx as Web Server with WSGI or Django Containerized installation DEB installation on Ubuntu 22.04 Database scheme Enrollment of End User Certificates according to RFC8823 Enrollment profiling via external account binding Example commands for acme clients External Account Binding (EAB) External Account Binding Home Hooks support Hooks How to Create Your Own CA Handler How to build am acme2certifier cluster on Ubuntu 22.04 How to build an acme2certifier cluster on Alma Linux 9 How to build an acme2certifier cluster on Ubuntu 22.04 How to contribute to this project How to create your own CA Handler Installation on Apache2 Running on Ubuntu 22.04 Installation on NGINX Running on Alma Linux 9 Installation on Nginx Running on Ubuntu 22.04 Installation on nginx running on Ubuntu 22.04 Pass Information from ACME Client to CA Handler Prevalidated Domain List Feature for ACME Authorization Proxy Support in acme2certifier Proxy support in acme2certifier RPM Installation on AlmaLinux 9 RPM installation on Alma Linux 9 RPM installation on alma Linux 9 Reporting and Housekeeping support SOAP CA Handler Prototype SOAP CA handler protopype Security Policy Support for ACME profiling Support for External Databases Support for TNAuthList Identifier and tkauth 01 Challenges Support for TNAuthList identifier and tkauth 01 challenges Upgrading acme2certifier Using cert manager to enroll certificate in Kubernetes environments acme_srv.cfg configuration options upgrading acme2certifier vault
1 Reporting and Housekeeping support
grindsa edited this page 2025-11-24 16:43:06 +00:00
Table of Contents

Reporting and Housekeeping

The Housekeeping class contains several methods for internal reporting and database maintenance.

To use it, you need to import the class into your script:

from acme.housekeeping import Housekeeping

Then, create a corresponding context handler:

with Housekeeping(LOGGER, DEBUG) as housekeeping:
  • LOGGER is an instance of a logging object. It is recommended to use the logger_setup() method from acme.helper to create it:
from acme.helper import logger_setup

LOGGER = logger_setup()
  • DEBUG (True/False) - Enables or disables debug mode.

Reporting

There are two methods for generating reports. Both methods return the report as a dictionary. Optionally, the reports can be saved to a file. The report name and format can be specified as shown below.

  • accountreport_get(report_format, report_name, nested): Generates a report containing a list of accounts along with corresponding orders, authorizations, and challenges.

    • report_format: Optional - csv/json - Specifies the report format (default: csv).
    • nested: Optional - False/True - Creates a nested JSON report structure (default: False).
    • report_name: Optional - Specifies the report file name (default: account_report_YY-MM-DD-HHMM.<report_format>).

  • certificatereport_get(report_format, report_name): Generates a report containing a list of certificates along with corresponding accounts and orders.

    • report_format: Optional - csv/json - Specifies the report format (default: csv).
    • report_name: Optional - Specifies the report file name.

Example reports and the database used to generate the reports can be found in the examples/reports directory.

Housekeeping

There are several methods for internal database maintenance.

  • certificate_cleanup(uts, purge, report_format, report_name): Identifies expired certificates from the certificate table. This method can either remove the X.509 object to reduce database size or delete the entire dataset. Optionally, a report of the selected certificates can be saved to a file.

    • uts: Optional - Unix timestamp to compare certificates against. If not specified, the current Unix timestamp will be used.
    • purge: Optional - True/False. If set to True, the entry is removed from the certificate table. If False, the X.509 object is overwritten with the string "removed by acme2certifier". Use this option carefully and back up acme_srv.db before cleaning your database.
    • report_format: Optional - csv/json - Specifies the report format (default: csv).
    • report_name: Optional - Specifies the report file name.

  • order_invalidate(uts, report_format, report_name): Sets all expired orders to the "invalid" state. This method must be run regularly if the expiry_check_disable parameter is enabled in the [orders] section of acme_srv.cfg.

    • uts: Optional - Unix timestamp for order comparison. If not specified, the current Unix timestamp will be used.
    • report_format: Optional - csv/json - Specifies the report format (default: csv).
    • report_name: Optional - Specifies the report file name.

  • authorization_invalidate(uts, report_format, report_name): Sets all expired authorizations to the "invalid" state. This method must be run regularly if the expiry_check_disable parameter is enabled in the [authorization] section of acme_srv.cfg.

    • uts: Optional - Unix timestamp for authorization comparison. If not specified, the current Unix timestamp will be used.
    • report_format: Optional - csv/json - Specifies the report format (default: csv).
    • report_name: Optional - Specifies the report file name.