| Methods |
public
|
__construct()
{{{ void __construct(void)
{{{ void __construct(void)
|
#
|
public
|
supported(): bool
Let's Encrypt is supported on this platform
Let's Encrypt is supported on this platform
|
#
|
public
|
permitted(): bool
Client may generate a LE certificate
Client may generate a LE certificate
|
#
|
public
|
debug(): bool
Let's Encrypt issues bogus certificates
Let's Encrypt issues bogus certificates
|
#
|
public
|
renew(bool|null $verifyip = null): bool
Renew Let's Encrypt SSL
Parameters
| $verifyip |
perform IP verification prior to issuance
|
|
#
|
public
|
renew_expiring(): void
Renew all expiring certificates
Renew all expiring certificates
|
#
|
public
|
challenges(string|array $hostnames): array
Get ACME challenges associated with hostnames
Get ACME challenges associated with hostnames
"payload" must be converted to sha256 hash when entering as a TXT record
|
#
|
public
|
solve(string|array $hostname, string|null $solver = null): array
Solve pending challenges
Parameters
| $hostname |
array of hostnames or map of hostname: solver
|
| $solver |
type of "http", "dns", or "alpn"
|
Throws
|
#
|
public
|
use_mechanism(string $domain, string|null $mechanism): bool
Set authorization mechanism
Set authorization mechanism
Parameters
| $mechanism |
mechanism to use or null to unset
|
|
#
|
public
|
mechanism(string|null $domain): array|null|string
Get authorization mechanism for hostname
Get authorization mechanism for hostname
Parameters
| $domain |
optional domain to filter
|
Returns
all configured mechanisms
|
#
|
public
|
request(array|string $cnames, bool $verifyip = null, bool $strict = null): bool|null
Request a Let's Encrypt certificate for the given common names
Request a Let's Encrypt certificate for the given common names
Because there is no unreasonable limit on SANs, a www and non-www
variant for each CN will be generated
Parameters
| $cnames |
list of hosts
|
| $verifyip |
verify IP matches account before issuing
|
| $strict |
loss of any hostname from certificate causes operation to fail
|
|
#
|
public
|
is_ca(string $crt): bool
Certificate is generated by LE
Certificate is generated by LE
Parameters
|
#
|
public
|
append(string|array $cnames, bool|null $verifyip = null): bool
Append hostnames to request in non-destructive manner
Append hostnames to request in non-destructive manner
|
#
|
public
|
revoke(): bool
Invalidate issued certificate
Invalidate issued certificate
|
#
|
public
|
exists(): bool
|
#
|
public
|
storage_path(string $site): string
Retrieve absolute storage path for site certificate
Retrieve absolute storage path for site certificate
|
#
|
public
|
bootstrap(int|null $attempt = null): bool|null
Request a SSL certificate for all domains on the account
Request a SSL certificate for all domains on the account
bootstrap verifies IP address before attempt
Parameters
Returns
boolean on success (or error), null on reschedule
|
#
|
public
|
_housekeeping()
|
#
|
public
|
_edit()
|
#
|
public
|
_delete()
|
#
|
public
|
_verify_conf(ConfigurationContext $ctx): bool
|
#
|
public
|
_create()
|
#
|
public
|
_create_user(string $user)
|
#
|
public
|
_delete_user(string $user)
|
#
|
public
|
_edit_user(string $userold, string $usernew, array $oldpwd)
|
#
|
public
|
_reload(string $why = '', array $args = [])
|
#
|