1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
<?php
class Acme
{
const PROP_ERROR = 'acme.error-string';
const PROP_PROVIDER = 'acme.provider';
const PROP_KEY_ID = 'acme.key-id';
const PROP_HMAC_KEY = 'acme.hmac-key';
const PROP_DOMAINS = 'acme.domains';
const PROP_MAIL = 'acme.mail';
const PROP_CUSTOM_ACME_URL = 'acme.server-url';
const VALID_PROVIDERS = [
'harica' => 'HARICA',
'letsencrypt' => "Let's Encrypt",
'zerossl' => 'ZeroSSL.com',
//'geant/sectigo' => 'GEANT via Sectigo',
'custom' => '...',
];
const PROVIDER_ALIASES = [
'geant/sectigo' => 'https://acme.sectigo.com/v2/GEANTOV',
'harica' => 'https://acme-v02.harica.gr/acme/directory',
];
public static function getLastError(): ?string
{
return Property::get(self::PROP_ERROR, null);
}
public static function getProvider(): ?string
{
return Property::get(self::PROP_PROVIDER, null);
}
public static function getServerUrl(): ?string
{
return Property::get(self::PROP_CUSTOM_ACME_URL, null);
}
public static function getKeyId(): ?string
{
return Property::get(self::PROP_KEY_ID, null);
}
public static function getHmacKey(): ?string
{
return Property::get(self::PROP_HMAC_KEY, null);
}
/**
* @return string[] list of [id] => friendly name
*/
public static function getProviders(): array
{
return self::VALID_PROVIDERS;
}
public static function getMail(): ?string
{
return Property::get(self::PROP_MAIL, null);
}
public static function getDomains(): array
{
return explode(' ', Property::get(self::PROP_DOMAINS));
}
/**
* Sets the configuration to the specified provider with optional server URL and authentication keys.
*
* @param string $provider The provider identifier, either 'custom' or a key in the valid providers list.
* @param string $mail The email address associated with the provider.
* @param string|null $serverUrl The custom server URL for the provider, required for the 'custom' provider and must use HTTPS.
* @param string|null $keyId The optional key ID used for authentication.
* @param string|null $hmacKey The optional HMAC key for authentication.
*
* @return bool Returns true if the configuration is successfully set, false otherwise.
*/
public static function setConfig(string $provider, string $mail, ?string $serverUrl = null,
?string $keyId = null, ?string $hmacKey = null): bool
{
if ($provider === 'custom') {
if (substr($serverUrl, 0, 6) !== 'https:') {
Message::addError('webinterface.acme-invalid-url', $serverUrl);
return false;
}
Property::set(self::PROP_CUSTOM_ACME_URL, $serverUrl); // Only update if custom is selected
} elseif (!isset(self::VALID_PROVIDERS[$provider])) {
Message::addError('webinterface.acme-invalid-provider', $provider);
return false;
}
Property::set(self::PROP_PROVIDER, $provider);
Property::set(self::PROP_MAIL, $mail);
Property::set(self::PROP_KEY_ID, $keyId);
Property::set(self::PROP_HMAC_KEY, $hmacKey);
return true;
}
public static function setDomains(array $list): void
{
Property::set(self::PROP_DOMAINS, implode(' ', $list));
}
private static function handleAcmeResultAsync($task): void
{
if (!is_array($task) || !Taskmanager::isTask($task))
return;
$task = Taskmanager::waitComplete($task, 250);
$args = [
'user' => User::getLogin(),
'previous' => Property::get(WebInterface::PROP_TYPE), // Remember in case of failure
];
if (Taskmanager::isFinished($task)) {
self::callbackErrorCheck($task, $args);
} else {
Property::set(WebInterface::PROP_TYPE, 'acme');
Property::set(self::PROP_ERROR, false);
TaskmanagerCallback::addCallback($task, 'acmeErrors', $args);
}
}
public static function callbackErrorCheck(array $task, $args): void
{
if (!Taskmanager::isFinished($task))
return;
$otherError = false;
if (isset($task['data']['error'])) {
// This should never happen, so make it an error
if (strpos($task['data']['error'], " is not an issued domain, skipping.") !== false) {
$otherError = true;
}
}
if (Taskmanager::isFailed($task) || $otherError) {
if (isset($args['previous']) && Property::get(WebInterface::PROP_TYPE) === 'acme') {
Property::set(WebInterface::PROP_TYPE, $args['previous']);
}
if (($args['user'] ?? null) === null) {
EventLog::warning('Automatic ACME renewal of HTTPS certificate failed', print_r($task, true));
}
Property::set(self::PROP_ERROR, $task['data']['error'] ?? 'Unknown error');
} else {
// If the cronjob called us and there is nothing to do, suppress the event log entry
if (($args['user'] ?? null) !== null
|| strpos($task['data']['error'] ?? '', 'Skipping. Next renewal time is: ') === false) {
EventLog::info('ACME issue/renewal of HTTPS certificate by ' . ($args['user'] ?? 'automatic cronjob'), print_r($task, true));
}
Property::set(self::PROP_ERROR, false);
}
}
/**
* Issues a new certificate using the configured ACME provider and other relevant details.
*
* @param bool $wipeAll Indicates whether all existing certificates and accounts should be wiped before issuing a new one.
* @return ?string The task ID of the certificate issuance process, or null if an error occurred.
*/
public static function issueNewCertificate(bool $wipeAll = false): ?string
{
$provider = self::getProvider();
if ($provider === 'custom') {
$provider = Property::get(self::PROP_CUSTOM_ACME_URL, null);
}
if ($provider === null) {
Message::addError('webinterface.acme-no-provider');
return null;
}
$mail = self::getMail();
if (empty($mail)) {
Message::addError('webinterface.acme-no-mail');
return null;
}
$domains = self::getDomains();
if (empty($domains)) {
Message::addError('webinterface.acme-no-domains');
return null;
}
$redirect = Property::get(WebInterface::PROP_REDIRECT);
$task = Taskmanager::submit('LighttpdHttps', [
'redirect' => $redirect,
'acmeMode' => 'issue',
'acmeMail' => $mail,
'acmeDomains' => $domains,
'acmeProvider' => self::PROVIDER_ALIASES[$provider] ?? $provider,
'acmeKeyId' => self::getKeyId(),
'acmeHmacKey' => self::getHmacKey(),
'acmeWipeAll' => $wipeAll,
]);
self::handleAcmeResultAsync($task);
return $task['id'] ?? null;
}
/**
* Renews certificates based on available domains.
* This expects a valid configuration and existing account.
*
* @return ?string ID of the submitted task for the renewal process or null if no domains are available
*/
public static function renew(): ?string
{
error_log("Renew called");
$domains = self::getDomains();
if (empty($domains)) {
Message::addError('webinterface.acme-no-domains');
return null;
}
$redirect = Property::get(WebInterface::PROP_REDIRECT);
$task = Taskmanager::submit('LighttpdHttps', [
'redirect' => $redirect,
'acmeMode' => 'renew',
'acmeDomains' => $domains,
]);
self::handleAcmeResultAsync($task);
return $task['id'] ?? null;
}
public static function tryEnable(): bool
{
$redirect = Property::get(WebInterface::PROP_REDIRECT);
$task = Taskmanager::submit('LighttpdHttps', [
'redirect' => $redirect,
'acmeMode' => 'try-enable',
]);
$task = Taskmanager::waitComplete($task, 10000);
return Taskmanager::isFinished($task) && !Taskmanager::isFailed($task);
}
}
|
