dbForConsole = $this->getConsoleDB(); $skipCheck = $this->args['skipRenewCheck'] ?? false; // If true, we won't double-check expiry from cert file $document = new Document($this->args['domain'] ?? []); $domain = new Domain($document->getAttribute('domain', '')); // Get current certificate $certificate = $this->dbForConsole->findOne('certificates', [Query::equal('domain', [$domain->get()])]); // If we don't have certificate for domain yet, let's create new document. At the end we save it if (!$certificate) { $certificate = new Document(); $certificate->setAttribute('domain', $domain->get()); } $success = false; try { // Email for alerts is required by LetsEncrypt $email = App::getEnv('_APP_SYSTEM_SECURITY_EMAIL_ADDRESS'); if (empty($email)) { throw new Exception('You must set a valid security email address (_APP_SYSTEM_SECURITY_EMAIL_ADDRESS) to issue an SSL certificate.'); } // Validate domain and DNS records. Skip if job is forced if (!$skipCheck) { $mainDomain = $this->getMainDomain(); $isMainDomain = !isset($mainDomain) || $domain->get() === $mainDomain; $this->validateDomain($domain, $isMainDomain); } // If certificate exists already, double-check expiry date. Skip if job is forced if (!$skipCheck && !$this->isRenewRequired($domain->get())) { throw new Exception('Renew isn\'t required.'); } // Prepare folder name for certbot. Using this helps prevent miss-match in LetsEncrypt configuration when renewing certificate $folder = ID::unique(); // Generate certificate files using Let's Encrypt $letsEncryptData = $this->issueCertificate($folder, $domain->get(), $email); // Command succeeded, store all data into document $logs = 'Certificate successfully generated.'; $certificate->setAttribute('logs', \mb_strcut($logs, 0, 1000000));// Limit to 1MB // Give certificates to Traefik $this->applyCertificateFiles($folder, $domain->get(), $letsEncryptData); // Update certificate info stored in database $certificate->setAttribute('renewDate', $this->getRenewDate($domain->get())); $certificate->setAttribute('attempts', 0); $certificate->setAttribute('issueDate', DateTime::now()); $success = true; } catch (Throwable $e) { $logs = $e->getMessage(); // Set exception as log in certificate document $certificate->setAttribute('logs', \mb_strcut($logs, 0, 1000000));// Limit to 1MB // Increase attempts count $attempts = $certificate->getAttribute('attempts', 0) + 1; $certificate->setAttribute('attempts', $attempts); // Store cuttent time as renew date to ensure another attempt in next maintenance cycle $certificate->setAttribute('renewDate', DateTime::now()); // Send email to security email $this->notifyError($domain->get(), $e->getMessage(), $attempts); } finally { // All actions result in new updatedAt date $certificate->setAttribute('updated', DateTime::now()); // Save all changes we made to certificate document into database $this->saveCertificateDocument($domain->get(), $certificate, $success); } } public function shutdown(): void { } /** * Save certificate data into database. * * @param string $domain Domain name that certificate is for * @param Document $certificate Certificate document that we need to save * @param bool $success Was certificate generation successful? * * @return void */ private function saveCertificateDocument(string $domain, Document $certificate, bool $success): void { // Check if update or insert required $certificateDocument = $this->dbForConsole->findOne('certificates', [Query::equal('domain', [$domain])]); if (!empty($certificateDocument) && !$certificateDocument->isEmpty()) { // Merge new data with current data $certificate = new Document(\array_merge($certificateDocument->getArrayCopy(), $certificate->getArrayCopy())); $certificate = $this->dbForConsole->updateDocument('certificates', $certificate->getId(), $certificate); } else { $certificate->removeAttribute('$internalId'); $certificate = $this->dbForConsole->createDocument('certificates', $certificate); } $certificateId = $certificate->getId(); $this->updateDomainDocuments($certificateId, $domain, $success); } /** * Get main domain. Needed as we do different checks for main and non-main domains. * * @return null|string Returns main domain. If null, there is no main domain yet. */ private function getMainDomain(): ?string { $envDomain = App::getEnv('_APP_DOMAIN', ''); if (!empty($envDomain) && $envDomain !== 'localhost') { return $envDomain; } return null; } /** * Internal domain validation functionality to prevent unnecessary attempts failed from Let's Encrypt side. We check: * - Domain needs to be public and valid (prevents NFT domains that are not supported by Let's Encrypt) * - Domain must have proper DNS record * * @param Domain $domain Domain which we validate * @param bool $isMainDomain In case of master domain, we look for different DNS configurations * * @return void */ private function validateDomain(Domain $domain, bool $isMainDomain): void { if (empty($domain->get())) { throw new Exception('Missing certificate domain.'); } if (!$domain->isKnown() || $domain->isTest()) { throw new Exception('Unknown public suffix for domain.'); } if (!$isMainDomain) { // TODO: Would be awesome to also support A/AAAA records here. Maybe dry run? // Validate if domain target is properly configured $target = new Domain(App::getEnv('_APP_DOMAIN_TARGET', '')); if (!$target->isKnown() || $target->isTest()) { throw new Exception('Unreachable CNAME target (' . $target->get() . '), please use a domain with a public suffix.'); } // Verify domain with DNS records $validator = new CNAME($target->get()); if (!$validator->isValid($domain->get())) { throw new Exception('Failed to verify domain DNS records.'); } } else { // Main domain validation // TODO: Would be awesome to check A/AAAA record here. Maybe dry run? } } /** * Reads expiry date of certificate from file and decides if renewal is required or not. * * @param string $domain Domain for which we check certificate file * * @return bool True, if certificate needs to be renewed */ private function isRenewRequired(string $domain): bool { $certPath = APP_STORAGE_CERTIFICATES . '/' . $domain . '/cert.pem'; if (\file_exists($certPath)) { $validTo = null; $certData = openssl_x509_parse(file_get_contents($certPath)); $validTo = $certData['validTo_time_t'] ?? 0; if (empty($validTo)) { throw new Exception('Unable to read certificate file (cert.pem).'); } // LetsEncrypt allows renewal 30 days before expiry $expiryInAdvance = (60 * 60 * 24 * 30); if ($validTo - $expiryInAdvance > \time()) { return false; } } return true; } /** * LetsEncrypt communication to issue certificate (using certbot CLI) * * @param string $folder Folder into which certificates should be generated * @param string $domain Domain to generate certificate for * * @return array Named array with keys 'stdout' and 'stderr', both string */ private function issueCertificate(string $folder, string $domain, string $email): array { $stdout = ''; $stderr = ''; $staging = (App::isProduction()) ? '' : ' --dry-run'; $exit = Console::execute("certbot certonly -v --webroot --noninteractive --agree-tos{$staging}" . " --email " . $email . " --cert-name " . $folder . " -w " . APP_STORAGE_CERTIFICATES . " -d {$domain}", '', $stdout, $stderr); // Unexpected error, usually 5XX, API limits, ... if ($exit !== 0) { throw new Exception('Failed to issue a certificate with message: ' . $stderr); } return [ 'stdout' => $stdout, 'stderr' => $stderr ]; } /** * Read new renew date from certificate file generated by Let's Encrypt * * @param string $domain Domain which certificate was generated for * * @return string */ private function getRenewDate(string $domain): string { $certPath = APP_STORAGE_CERTIFICATES . '/' . $domain . '/cert.pem'; $certData = openssl_x509_parse(file_get_contents($certPath)); $validTo = $certData['validTo_time_t'] ?? null; $dt = (new \DateTime())->setTimestamp($validTo); return DateTime::addSeconds($dt, -60 * 60 * 24 * 30); // -30 days } /** * Method to take files from Let's Encrypt, and put it into Traefik. * * @param string $domain Domain which certificate was generated for * @param string $folder Folder in which certificates were generated * @param array $letsEncryptData Let's Encrypt logs to use for additional info when throwing error * * @return void */ private function applyCertificateFiles(string $folder, string $domain, array $letsEncryptData): void { // Prepare folder in storage for domain $path = APP_STORAGE_CERTIFICATES . '/' . $domain; if (!\is_readable($path)) { if (!\mkdir($path, 0755, true)) { throw new Exception('Failed to create path for certificate.'); } } // Move generated files if (!@\rename('/etc/letsencrypt/live/' . $folder . '/cert.pem', APP_STORAGE_CERTIFICATES . '/' . $domain . '/cert.pem')) { throw new Exception('Failed to rename certificate cert.pem. Let\'s Encrypt log: ' . $letsEncryptData['stderr'] . ' ; ' . $letsEncryptData['stdout']); } if (!@\rename('/etc/letsencrypt/live/' . $folder . '/chain.pem', APP_STORAGE_CERTIFICATES . '/' . $domain . '/chain.pem')) { throw new Exception('Failed to rename certificate chain.pem. Let\'s Encrypt log: ' . $letsEncryptData['stderr'] . ' ; ' . $letsEncryptData['stdout']); } if (!@\rename('/etc/letsencrypt/live/' . $folder . '/fullchain.pem', APP_STORAGE_CERTIFICATES . '/' . $domain . '/fullchain.pem')) { throw new Exception('Failed to rename certificate fullchain.pem. Let\'s Encrypt log: ' . $letsEncryptData['stderr'] . ' ; ' . $letsEncryptData['stdout']); } if (!@\rename('/etc/letsencrypt/live/' . $folder . '/privkey.pem', APP_STORAGE_CERTIFICATES . '/' . $domain . '/privkey.pem')) { throw new Exception('Failed to rename certificate privkey.pem. Let\'s Encrypt log: ' . $letsEncryptData['stderr'] . ' ; ' . $letsEncryptData['stdout']); } $config = \implode(PHP_EOL, [ "tls:", " certificates:", " - certFile: /storage/certificates/{$domain}/fullchain.pem", " keyFile: /storage/certificates/{$domain}/privkey.pem" ]); // Save configuration into Traefik using our new cert files if (!\file_put_contents(APP_STORAGE_CONFIG . '/' . $domain . '.yml', $config)) { throw new Exception('Failed to save Traefik configuration.'); } } /** * Method to make sure information about error is delivered to admnistrator. * * @param string $domain Domain that caused the error * @param string $errorMessage Verbose error message * @param int $attempt How many times it failed already * * @return void */ private function notifyError(string $domain, string $errorMessage, int $attempt): void { // Log error into console Console::warning('Cannot renew domain (' . $domain . ') on attempt no. ' . $attempt . ' certificate: ' . $errorMessage); // Send mail to administratore mail $locale = new Locale(App::getEnv('_APP_LOCALE', 'en')); if (!$locale->getText('emails.sender') || !$locale->getText("emails.certificate.hello") || !$locale->getText("emails.certificate.subject") || !$locale->getText("emails.certificate.body") || !$locale->getText("emails.certificate.footer") || !$locale->getText("emails.certificate.thanks") || !$locale->getText("emails.certificate.signature")) { $locale->setDefault('en'); } $body = Template::fromFile(__DIR__ . '/../config/locale/templates/email-base.tpl'); $subject = \sprintf($locale->getText("emails.certificate.subject"), $domain); $body->setParam('{{domain}}', $domain); $body->setParam('{{error}}', $errorMessage); $body->setParam('{{attempt}}', $attempt); $body ->setParam('{{subject}}', $subject) ->setParam('{{hello}}', $locale->getText("emails.certificate.hello")) ->setParam('{{body}}', $locale->getText("emails.certificate.body")) ->setParam('{{redirect}}', 'https://' . $domain) ->setParam('{{footer}}', $locale->getText("emails.certificate.footer")) ->setParam('{{thanks}}', $locale->getText("emails.certificate.thanks")) ->setParam('{{signature}}', $locale->getText("emails.certificate.signature")) ->setParam('{{project}}', 'Console') ->setParam('{{direction}}', $locale->getText('settings.direction')) ->setParam('{{bg-body}}', '#f7f7f7') ->setParam('{{bg-content}}', '#ffffff') ->setParam('{{text-content}}', '#000000'); $body = $body->render(); $mail = new Mail(); $mail ->setRecipient(App::getEnv('_APP_SYSTEM_SECURITY_EMAIL_ADDRESS')) ->setName('Appwrite Administrator') ->trigger(); } /** * Update all existing domain documents so they have relation to correct certificate document. * This solved issues: * - when adding a domain for which there is already a certificate * - when renew creates new document? It might? * - overall makes it more reliable * * @param string $certificateId ID of a new or updated certificate document * @param string $domain Domain that is affected by new certificate * @param bool $success Was certificate generation successful? * * @return void */ private function updateDomainDocuments(string $certificateId, string $domain, bool $success): void { $rule = $this->dbForConsole->findOne('rules', [ Query::equal('domain', [$domain]), ]); if ($rule !== false && !$rule->isEmpty()) { $rule->setAttribute('certificateId', $certificateId); $rule->setAttribute('status', $success ? 'verified' : 'unverified'); $this->dbForConsole->updateDocument('rules', $rule->getId(), $rule); $projectId = $rule->getAttribute('projectId'); // Skip events for console project (triggered by auto-ssl generation for 1 click setups) if ($projectId === 'console') { return; } $project = $this->dbForConsole->getDocument('projects', $projectId); /** Trigger Webhook */ $ruleModel = new Rule(); $ruleUpdate = new Event(Event::WEBHOOK_QUEUE_NAME, Event::WEBHOOK_CLASS_NAME); $ruleUpdate ->setProject($project) ->setEvent('rules.[ruleId].update') ->setParam('ruleId', $rule->getId()) ->setPayload($rule->getArrayCopy(array_keys($ruleModel->getRules()))) ->trigger(); /** Trigger Functions */ $ruleUpdate ->setClass(Event::FUNCTIONS_CLASS_NAME) ->setQueue(Event::FUNCTIONS_QUEUE_NAME) ->trigger(); /** Trigger realtime event */ $allEvents = Event::generateEvents('rules.[ruleId].update', [ 'ruleId' => $rule->getId(), ]); $target = Realtime::fromPayload( // Pass first, most verbose event pattern event: $allEvents[0], payload: $rule, project: $project ); Realtime::send( projectId: 'console', payload: $rule->getArrayCopy(), events: $allEvents, channels: $target['channels'], roles: $target['roles'] ); Realtime::send( projectId: $project->getId(), payload: $rule->getArrayCopy(), events: $allEvents, channels: $target['channels'], roles: $target['roles'] ); } } }