You are viewing an old version of this page. View the current version.
Only advanced users should use this feature.
We added AutoSSL functionality to cPanel & WHM version 58, and custom AutoSSL provider modules in version 60.
AutoSSL provider modules allow your server's users to automatically secure locally-hosted domains on their accounts with certificates from that SSL certificate provider. We ship the cPanel (powered by Comodo) provider module with cPanel & WHM, and you can download a plugin to add the Let's Encrypt™ provider module. This document explains how to create your own provider module.
Module development work
When you develop your provider module, we recommend the following workflow:
- Research the supported parameters for your chosen SSL certificate provider.
- Configure a module that subclasses the
/usr/local/cpanel/Cpanel/SSL/Auto/Provider/Provider.pmmodule with overrides that match the supported parameters for your certificate provider.
Do not directly edit the
Authentication deployment workflow
After you develop and configure your provider module, we recommend the following workflow to deploy the module:
- Navigate to WHM's Manage AutoSSL interface (WHM >> Home >> SSL >> Manage AutoSSL).
- Select the provider module.
- Test the provider module with an account on a non-production server.
- Review the log files to confirm that an SSL certificate provided by the provider secure the account's domains.
AutoSSL provider workflow
cPanel-provided AutoSSL provider modules reside in the
Third-party AutoSSL provider modules reside in the
For example, a module for the ExampleSSL third-party provider would reside in the
Module function interfaces
The tables below contain the required, recommended, and inherited methods.
You must configure the following methods in the
Cpanel::SSL::Auto::Provider class. If you do not configure a required method, it will die with a
Cpanel::Exception::NotImplemented exception .
Key-value pairs that declare each virtual host and the domains within those virtual hosts to secure.
You can override the following optional methods in your module:
This method declares when to begin the renewal process. If the certificate will expire in this number of days or fewer, the system will start the renewal process.
if you do not set this value, the system waits until the certificate expires before it attempts to replace it.
The maximum number of domains to request per certificate. This depends on the Certificate Authority's (CA) domain limits.
If you do not set this value, the system assumes that the CA does not limit the number of domains on a certificate, which is not likely true.
This method returns a list of additional key-value pairs that define additional properties for the provider module.
This method sends information to the external provider, such as registration data.
This method resets the server's registration with the remote provider.
This method indicates whether the PEM-encoded certificate that you send to it comes from a valid AutoSSL provider rather than a valid non-AutoSSL provider. This method will vary depending on the Certificate Authority and the type of certificate that they issue.
If you do not define this method, the system assumes that nothing comes from this module.
This method defines the provider's name that the interface will display.
return 'Bogus SSL Provider for Testing Purposes';
This method declares what to run when an administrator renames the account.
This method declares what to run when the administrator terminates the account.
This method declares what to run when a user or administrator removes a domain from the account.
The following methods are inherited, and you should not override them:
This method starts the log for the user that you declare.
If you do not set the
This method appends to an existing log. The
If a log does not exist for the
This method enters the
|This method indents the entries in the log by one level.|
|This method outdents the entries in the log by one level.|
|This method returns the time that this class instance started to log, i n ISO 8601 time value .|
When AutoSSL finishes a check run, it sets that run's log to completed.
However, this method flags the log as in progress. This is useful when the module uses a separate queue to fetch the AutoSSL certificates, as the cPanel module does.
This method installs an SSL certificate for Exim, Apache, and Dovecot.
In cPanel & WHM version 60, this method will also install an SSL certificate for
We may expand this method to install certificates for other services in future versions.
You must pass the following required arguments through this method:
You can pass the following optional arguments through this method:
We strongly recommend that you use the
The following AutoSSL module outline demonstrates a minimal set of functionality.
This is not a fully-functional module. This only demonstrates basic workflow. Your implementation will require more internal logic. Also, this module does not demonstrate the necessary API calls that would allow your module to hook into your SSL certificate provider.
- No labels