Skip to content

Instantly share code, notes, and snippets.

@xenago
Created May 29, 2023 21:07
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save xenago/5fb22c34cfcbbf901107b629ff81b695 to your computer and use it in GitHub Desktop.
Save xenago/5fb22c34cfcbbf901107b629ff81b695 to your computer and use it in GitHub Desktop.
<?php
/*
CertSage (support@griffin.software)
Copyright 2022 Griffin Software (https://griffin.software)
PHP 7.0+ required
Permission is granted to distribute this software in its original form.
Permission is denied to distribute any works derived from this software.
No guarantees or warranties of any kind are made as to the fitness of this software for any purpose.
Usage of this software constitutes acceptance of full liability for any consequences resulting from its usage.
*/
class CertSage
{
public $version = "1.4.1";
public $dataDirectory = "../CertSage";
private $password;
private $accountKey;
private $accountUrl;
private $thumbprint;
private $nonce;
private $acmeDirectory;
private $responses;
private function createDirectory($directoryPath, $permissions)
{
clearstatcache(true, $directoryPath);
if (file_exists($directoryPath))
return;
if (!mkdir($directoryPath, $permissions))
throw new Exception("could not create directory: $directoryPath");
}
private function readFile($filePath)
{
clearstatcache(true, $filePath);
if (!file_exists($filePath))
return null;
$string = file_get_contents($filePath);
if ($string === false)
throw new Exception("could not read file: $filePath");
return $string;
}
private function writeFile($filePath, $string, $permissions)
{
if (file_put_contents($filePath, $string, LOCK_EX) === false)
throw new Exception("could not write file: $filePath");
if (!chmod($filePath, $permissions))
throw new Exception("could not set permissions for file: $filePath");
}
private function deleteFile($filePath)
{
clearstatcache(true, $filePath);
if (!file_exists($filePath))
return;
if (!unlink($filePath))
throw new Exception("could not delete file: $filePath");
}
private function encodeJSON($data)
{
$string = json_encode($data, JSON_UNESCAPED_SLASHES);
if (json_last_error() != JSON_ERROR_NONE)
throw new Exception("encode JSON failed");
return $string;
}
private function decodeJSON($string)
{
$data = json_decode($string, true);
if (json_last_error() != JSON_ERROR_NONE)
throw new Exception("decode JSON failed");
return $data;
}
private function encodeBase64($string)
{
return strtr(rtrim(base64_encode($string), "="), "+/", "-_");
}
private function decodeBase64($base64)
{
// consider strict mode to handle non-Base64 characters
return base64_decode(strtr($base64, "-_", "+/"));
}
private function findHeader($response, $target, $required = true)
{
$regex = "~^$target: ([^\r\n]+)[\r\n]*$~i";
foreach ($response["headers"] as $header)
{
$outcome = preg_match($regex, $header, $matches);
if ($outcome === false)
throw new Exception("regular expression match failed when extracting header");
if ($outcome === 1)
return $matches[1];
}
if ($required)
throw new Exception("missing $target header");
return null;
}
private function sendRequest($url, $expectedResponseCode, $payload = null, $jwk = null)
{
$headers = [];
$headerSize = 0;
$ch = curl_init($url);
if ($ch === false)
throw new Exception("cURL initialization failed");
if (!curl_setopt($ch, CURLOPT_USERAGENT, "CertSage/" . $this->version . " (support@griffin.software)"))
throw new Exception("cURL set user agent option failed");
if (!curl_setopt($ch, CURLOPT_RETURNTRANSFER, true))
throw new Exception("cURL set return transfer option failed");
if (isset($payload))
{
if (!isset($this->nonce))
{
$response = $this->sendRequest($this->acmeDirectory["newNonce"], 204);
if (!isset($this->nonce))
throw new Exception("get new nonce failed");
}
$protected = [
"url" => $url,
"alg" => "RS256",
"nonce" => $this->nonce
];
if (isset($jwk))
$protected["jwk"] = $jwk;
else
$protected["kid"] = $this->accountUrl;
$protected = $this->encodeBase64($this->encodeJSON($protected));
$payload = $payload === ""
? ""
: $this->encodeBase64($this->encodeJSON($payload));
if (openssl_sign("$protected.$payload", $signature, $this->accountKey, "sha256WithRSAEncryption") === false)
throw new Exception("openssl sign failed");
$signature = $this->encodeBase64($signature);
$josejson = $this->encodeJSON([
"protected" => $protected,
"payload" => $payload,
"signature" => $signature
]);
if (!curl_setopt($ch, CURLOPT_POSTFIELDS, $josejson))
throw new Exception("cURL set post fields option failed");
if (!curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/jose+json", "Content-Length: " . strlen($josejson)]))
throw new Exception("cURL set http header option failed");
}
if (!curl_setopt($ch, CURLOPT_HEADER, true))
throw new Exception("cURL set header option failed");
if (!curl_setopt($ch, CURLOPT_HEADERFUNCTION,
function($ch, $header) use (&$headers, &$headerSize)
{
$headers[] = $header;
$length = strlen($header);
$headerSize += $length;
return $length;
}))
throw new Exception("cURL set header function option failed");
$body = curl_exec($ch);
if ($body === false)
throw new Exception("cURL execution failed: $url");
$this->responses[] = $body;
$responseCode = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($responseCode === false)
throw new Exception("cURL get response code info failed");
/*
$headerSize = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
if ($headerSize === false)
throw new Exception("cURL get header size info failed");
*/
$length = strlen($body);
if ($headerSize > $length)
throw new Exception("improper response header size");
$body = $headerSize == $length
? ""
: substr($body, $headerSize);
if ($body === false)
throw new Exception("could not truncate headers from response");
$response = [
"headers" => $headers,
"body" => $body
];
if ($responseCode !== $expectedResponseCode)
{
if ($this->findHeader($response, "content-type", false) === "application/problem+json")
{
$problem = $this->decodeJSON($response["body"]);
if (isset($problem["type"], $problem["detail"]))
throw new Exception($problem["type"] . "<br>" . $problem["detail"]);
}
throw new Exception("unexpected response code: $responseCode vs $expectedResponseCode");
}
$this->nonce = $this->findHeader($response, "replay-nonce", false);
return $response;
}
public function initialize()
{
// *** CREATE DATA DIRECTORY ***
$this->createDirectory($this->dataDirectory, 0755);
// *** READ PASSWORD FILE ***
$this->password = $this->readFile($this->dataDirectory . "/password.txt");
if (isset($this->password))
return;
// *** GENERATE RANDOM PASSWORD ***
$this->password = $this->encodeBase64(openssl_random_pseudo_bytes(15));
// *** WRITE PASSWORD FILE ***
$this->writeFile($this->dataDirectory . "/password.txt",
$this->password,
0644);
}
public function extractDomainNames()
{
// *** READ CERTIFICATE ***
$certificate = $this->readFile($this->dataDirectory . "/certificate.crt");
if (!isset($certificate))
return "";
// *** EXTRACT CERTIFICATE ***
$regex = "~^(-----BEGIN CERTIFICATE-----\n(?:[A-Za-z0-9+/]{64}\n)*(?:(?:[A-Za-z0-9+/]{4}){0,15}(?:[A-Za-z0-9+/]{2}(?:[A-Za-z0-9+/]|=)=)?\n)?-----END CERTIFICATE-----)~";
$outcome = preg_match($regex, $certificate, $matches);
if ($outcome === false)
throw new Exception("extract certificate failed");
if ($outcome === 0)
throw new Exception("certificate format mismatch");
$certificate = $matches[1];
// *** CHECK CERTIFICATE ***
$certificateObject = openssl_x509_read($certificate);
if ($certificateObject === false)
throw new Exception("check certificate failed");
// *** EXTRACT DOMAIN NAMES ***
$certificateData = openssl_x509_parse($certificateObject);
if ($certificateData === false)
throw new Exception("parse certificate failed");
if (!isset($certificateData["extensions"]["subjectAltName"]))
return "";
$sans = explode(", ", $certificateData["extensions"]["subjectAltName"]);
foreach ($sans as &$san)
{
list($type, $value) = explode(":", $san);
if ($type !== "DNS")
return "";
$san = $value;
}
unset($san);
return implode("\n", $sans);
}
public function checkPassword()
{
// *** CHECK PASSWORD ***
if (!isset($_POST["password"]))
throw new Exception("password was missing");
if (!is_string($_POST["password"]))
throw new Exception("password was not a string");
if ($_POST["password"] !== $this->password)
throw new Exception("password was incorrect");
}
private function establishAccount()
{
// *** ESTABLISH ENVIRONMENT ***
if (!isset($_POST["environment"]))
throw new Exception("environment was missing");
if (!is_string($_POST["environment"]))
throw new Exception("environment was not a string");
switch ($_POST["environment"])
{
case "production":
$fileName = "account.key";
$url = "https://acme-v02.api.letsencrypt.org/directory";
break;
case "staging":
$fileName = "account-staging.key";
$url = "https://acme-staging-v02.api.letsencrypt.org/directory";
break;
default:
throw new Exception("unknown environment: " . $_POST["environment"]);
}
// *** READ ACCOUNT KEY ***
$this->accountKey = $this->readFile($this->dataDirectory . "/$fileName");
$accountKeyExists = isset($this->accountKey);
if ($accountKeyExists)
{
// *** CHECK ACCOUNT KEY ***
$accountKeyObject = openssl_pkey_get_private($this->accountKey);
if ($accountKeyObject === false)
throw new Exception("check account key failed");
}
else
{
// *** GENERATE ACCOUNT KEY ***
$options = [
"digest_alg" => "sha256",
"private_key_bits" => 2048,
"private_key_type" => OPENSSL_KEYTYPE_RSA
];
$accountKeyObject = openssl_pkey_new($options);
if ($accountKeyObject === false)
throw new Exception("generate account key failed");
if (!openssl_pkey_export($accountKeyObject, $this->accountKey))
throw new Exception("export account key failed");
}
// *** GET ACCOUNT KEY DETAILS ***
$accountKeyDetails = openssl_pkey_get_details($accountKeyObject);
if ($accountKeyDetails === false)
throw new Exception("get account key details failed");
// *** CONSTRUCT JWK ***
$jwk = [
"e" => $this->encodeBase64($accountKeyDetails["rsa"]["e"]), // public exponent
"kty" => "RSA",
"n" => $this->encodeBase64($accountKeyDetails["rsa"]["n"]) // modulus
];
// *** CALCULATE THUMBPRINT ***
$digest = openssl_digest($this->encodeJSON($jwk), "sha256", true);
if ($digest === false)
throw new Exception("digest JWK failed");
$this->thumbprint = $this->encodeBase64($digest);
// *** GET ACME DIRECTORY ***
$response = $this->sendRequest($url, 200);
$this->acmeDirectory = $this->decodeJSON($response["body"]);
if ($accountKeyExists)
{
// *** LOOKUP ACCOUNT ***
$url = $this->acmeDirectory["newAccount"];
$payload = [
"onlyReturnExisting" => true
];
$response = $this->sendRequest($url, 200, $payload, $jwk);
}
else
{
// *** REGISTER ACCOUNT ***
$url = $this->acmeDirectory["newAccount"];
$payload = [
"termsOfServiceAgreed" => true
];
$response = $this->sendRequest($url, 201, $payload, $jwk);
// *** WRITE ACCOUNT KEY ***
$this->writeFile($this->dataDirectory . "/$fileName",
$this->accountKey,
0644);
}
$this->accountUrl = $this->findHeader($response, "location");
}
private function dumpResponses()
{
$this->writeFile($this->dataDirectory . "/responses.txt",
implode("\n\n-----\n\n", array_reverse($this->responses)),
0644);
}
public function acquireCertificate()
{
$this->responses = [];
try
{
$this->establishAccount();
// *** CREATE NEW ORDER ***
if (!isset($_POST["domainNames"]))
throw new Exception("domainNames was missing");
if (!is_string($_POST["domainNames"]))
throw new Exception("domainNames was not a string");
$identifiers = [];
for ($domainName = strtok($_POST["domainNames"], "\r\n");
$domainName !== false;
$domainName = strtok("\r\n"))
$identifiers[] = [
"type" => "dns",
"value" => $domainName
];
$url = $this->acmeDirectory["newOrder"];
$payload = [
"identifiers" => $identifiers
];
$response = $this->sendRequest($url, 201, $payload);
$orderurl = $this->findHeader($response, "location");
$order = $this->decodeJSON($response["body"]);
// *** GET CHALLENGES ***
$authorizationurls = [];
$challengeurls = [];
$challengetokens = [];
$payload = ""; // empty
foreach ($order["authorizations"] as $url)
{
$response = $this->sendRequest($url, 200, $payload);
$authorization = $this->decodeJSON($response["body"]);
if ($authorization["status"] === "valid")
continue;
$authorizationurls[] = $url;
foreach ($authorization["challenges"] as $challenge)
{
if ($challenge["type"] === "http-01")
{
$challengeurls[] = $challenge["url"];
$challengetokens[] = $challenge["token"];
continue 2;
}
}
throw new Exception("no http-01 challenge found");
}
// *** CREATE HTTP-01 CHALLENGE DIRECTORIES ***
$this->createDirectory("./.well-known", 0755);
$this->createDirectory("./.well-known/acme-challenge", 0755);
try
{
// *** WRITE HTTP-01 CHALLENGE FILES ***
foreach ($challengetokens as $challengetoken)
$this->writeFile("./.well-known/acme-challenge/$challengetoken",
"$challengetoken." . $this->thumbprint,
0644);
// *** CONFIRM CHALLENGES ***
sleep(2);
$payload = (object)[]; // empty object
foreach ($challengeurls as $url)
$challenge = $this->sendRequest($url, 200, $payload);
// *** CHECK AUTHORIZATIONS ***
$payload = ""; // empty
foreach ($authorizationurls as $url)
{
for ($attempt = 1; true; ++$attempt)
{
sleep(1);
$response = $this->sendRequest($url, 200, $payload);
$authorization = $this->decodeJSON($response["body"]);
if ($authorization["status"] !== "pending")
break;
if ($attempt == 10)
throw new Exception("authorization still pending after $attempt attempts");
}
if ($authorization["status"] !== "valid")
throw new Exception($authorization["challenges"][0]["error"]["type"] . "<br>" . $authorization["challenges"][0]["error"]["detail"]);
}
}
finally
{
// *** DELETE HTTP-01 CHALLENGE FILES ***
foreach ($challengetokens as $challengetoken)
$this->deleteFile("./.well-known/acme-challenge/$challengetoken");
}
// *** GENERATE CERTIFICATE KEY ***
$options = [
"digest_alg" => "sha256",
"private_key_bits" => 2048,
"private_key_type" => OPENSSL_KEYTYPE_RSA
];
$certificateKeyObject = openssl_pkey_new($options);
if ($certificateKeyObject === false)
throw new Exception("generate certificate key failed");
if (!openssl_pkey_export($certificateKeyObject, $certificateKey))
throw new Exception("export certificate key failed");
// *** GENERATE CSR ***
$dn = [
"commonName" => $identifiers[0]["value"]
];
$options = [
"digest_alg" => "sha256",
"config" => $this->dataDirectory . "/openssl.cnf"
];
$opensslcnf =
"[req]\n" .
"distinguished_name = req_distinguished_name\n" .
"req_extensions = v3_req\n\n" .
"[req_distinguished_name]\n\n" .
"[v3_req]\n" .
"subjectAltName = @san\n\n" .
"[san]\n";
$i = 0;
foreach ($identifiers as $identifier)
{
++$i;
$opensslcnf .= "DNS.$i = " . $identifier["value"] . "\n";
}
try
{
$this->writeFile($this->dataDirectory . "/openssl.cnf",
$opensslcnf,
0644);
$csrObject = openssl_csr_new($dn, $certificateKey, $options);
if ($csrObject === false)
throw new Exception("generate csr failed");
}
finally
{
$this->deleteFile($this->dataDirectory . "/openssl.cnf");
}
if (!openssl_csr_export($csrObject, $csr))
throw new Exception("export csr failed");
// *** FINALIZE ORDER ***
$url = $order["finalize"];
$regex = "~^-----BEGIN CERTIFICATE REQUEST-----([A-Za-z0-9+/]+)=?=?-----END CERTIFICATE REQUEST-----$~";
$outcome = preg_match($regex, str_replace("\n", "", $csr), $matches);
if ($outcome === false)
throw new Exception("extract csr failed");
if ($outcome === 0)
throw new Exception("csr format mismatch");
$payload = [
"csr" => strtr($matches[1], "+/", "-_")
];
$response = $this->sendRequest($url, 200, $payload);
$order = $this->decodeJSON($response["body"]);
if ($order["status"] !== "valid")
{
// *** CHECK ORDER ***
$url = $orderurl;
$payload = ""; // empty
for ($attempt = 1; true; ++$attempt)
{
sleep(1);
$response = $this->sendRequest($url, 200, $payload);
$order = $this->decodeJSON($response["body"]);
if (!( $order["status"] === "pending"
|| $order["status"] === "processing"
|| $order["status"] === "ready"))
break;
if ($attempt == 10)
throw new Exception("order still pending after $attempt attempts");
}
if ($order["status"] !== "valid")
throw new Exception("order failed");
}
// *** DOWNLOAD CERTIFICATE ***
$url = $order["certificate"];
$payload = ""; // empty
$response = $this->sendRequest($url, 200, $payload);
$certificate = $response["body"];
if ($_POST["environment"] == "production")
{
// *** WRITE CERTIFICATE AND CERTIFICATE KEY ***
$this->writeFile($this->dataDirectory . "/certificate.crt",
$certificate,
0644);
$this->writeFile($this->dataDirectory . "/certificate.key",
$certificateKey,
0644);
}
}
finally
{
$this->dumpResponses();
}
}
public function installCertificate()
{
// *** READ CERTIFICATE ***
$certificate = $this->readFile($this->dataDirectory . "/certificate.crt");
if (!isset($certificate))
throw new Exception("certificate file does not exist");
// *** EXTRACT CERTIFICATE ***
$regex = "~^(-----BEGIN CERTIFICATE-----\n(?:[A-Za-z0-9+/]{64}\n)*(?:(?:[A-Za-z0-9+/]{4}){0,15}(?:[A-Za-z0-9+/]{2}(?:[A-Za-z0-9+/]|=)=)?\n)?-----END CERTIFICATE-----)~";
$outcome = preg_match($regex, $certificate, $matches);
if ($outcome === false)
throw new Exception("extract certificate failed");
if ($outcome === 0)
throw new Exception("certificate format mismatch");
$certificate = $matches[1];
// *** CHECK CERTIFICATE ***
$certificateObject = openssl_x509_read($certificate);
if ($certificateObject === false)
throw new Exception("check certificate failed");
// *** READ CERTIFICATE KEY ***
$certificateKey = $this->readFile($this->dataDirectory . "/certificate.key");
if (!isset($certificateKey))
throw new Exception("certificate key file does not exist");
// *** EXTRACT CERTIFICATE KEY ***
$regex = "~^(-----BEGIN PRIVATE KEY-----\n(?:[A-Za-z0-9+/]{64}\n)*(?:(?:[A-Za-z0-9+/]{4}){0,15}(?:[A-Za-z0-9+/]{2}(?:[A-Za-z0-9+/]|=)=)?\n)?-----END PRIVATE KEY-----)~";
$outcome = preg_match($regex, $certificateKey, $matches);
if ($outcome === false)
throw new Exception("extract certificate key failed");
if ($outcome === 0)
throw new Exception("certificate key format mismatch");
$certificateKey = $matches[1];
// *** CHECK CERTIFICATE KEY ***
$certificateKeyObject = openssl_pkey_get_private($certificateKey);
if ($certificateKeyObject === false)
throw new Exception("check certificate key failed");
// *** VERIFY CERTIFICATE AND CERTIFICATE KEY CORRESPOND ***
if (!openssl_x509_check_private_key($certificateObject, $certificateKeyObject))
throw new Exception("certificate and certificate key do not correspond");
// *** EXTRACT DOMAIN NAMES ***
$certificateData = openssl_x509_parse($certificateObject);
if ($certificateData === false)
throw new Exception("parse certificate failed");
if (!isset($certificateData["extensions"]["subjectAltName"]))
throw new Exception("No SANs found in certificate");
$sans = explode(", ", $certificateData["extensions"]["subjectAltName"]);
foreach ($sans as &$san)
{
list($type, $value) = explode(":", $san);
if ($type !== "DNS")
throw new Exception("Non-DNS SAN found in certificate");
$san = $value;
}
unset($san);
// *** INSTALL CERTIFICATE ***
$domain = $sans[0];
$domainLength = strlen($sans[0]);
foreach ($sans as $san)
{
$sanLength = strlen($san);
if ($domainLength <= $sanLength)
continue;
$domain = $san;
$domainLength = $sanLength;
}
$cert = rawurlencode($certificate);
$key = rawurlencode($certificateKey);
$output = `uapi SSL install_ssl domain=$domain cert=$cert key=$key --output=json`;
// !!! need to test with shell turned off in cPanel
if ($output === false)
throw new Exception("shell execution pipe could not be established");
if (!isset($output))
throw new Exception("uapi SSL install_ssl failed");
$output = `uapi SSL toggle_ssl_redirect_for_domains domains=$domain state=1 --output=json`;
if ($output === false)
throw new Exception("shell execution pipe could not be established");
if (!isset($output))
throw new Exception("uapi SSL toggle_ssl_redirect_for_domains failed");
}
public function updateContact()
{
$this->responses = [];
try
{
$this->establishAccount();
// *** UPDATE CONTACT ***
if (!isset($_POST["emailAddresses"]))
throw new Exception("emailAddresses was missing");
if (!is_string($_POST["emailAddresses"]))
throw new Exception("emailAddresses was not a string");
$contact = [];
for ($emailAddress = strtok($_POST["emailAddresses"], "\r\n");
$emailAddress !== false;
$emailAddress = strtok("\r\n"))
$contact[] = "mailto:$emailAddress";
$url = $this->accountUrl;
$payload = [
"contact" => $contact
];
$response = $this->sendRequest($url, 200, $payload);
}
finally
{
$this->dumpResponses();
}
}
}
// *** MAIN ***
try
{
$certsage = new CertSage();
$certsage->initialize();
if (!isset($_POST["action"]))
{
$domainNames = $certsage->extractDomainNames();
$page = "welcome";
}
elseif (!is_string($_POST["action"]))
throw new Exception("action was not a string");
else
{
$certsage->checkpassword();
switch ($_POST["action"])
{
case "acquirecertificate":
$certsage->acquireCertificate();
break;
case "installcertificate":
$certsage->installCertificate();
break;
case "updatecontact":
$certsage->updateContact();
break;
default:
throw new Exception("unknown action: " . $_POST["action"]);
}
$page = "success";
}
}
catch (Exception $e)
{
$error = $e->getMessage();
$page = "trouble";
}
?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>CertSage</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="theme-color" content="#e1b941">
<meta name="referrer" content="origin">
<style>
*
{
box-sizing: border-box;
outline: none;
margin: 0;
border: none;
padding: 0;
}
html
{
background: #4169e1;
font: 100%/1.5 sans-serif;
color: black;
}
body
{
margin: auto;
max-width: 34rem;
padding: 1.5rem;
}
header, main, footer, hr, article,
h1, h2, h3, h4, h5, h6, p, form
{
margin-bottom: 1.5rem;
}
:last-child
{
margin-bottom: 0;
}
hr
{
border-bottom: 1px solid;
}
header, article
{
border-radius: 1.5rem;
padding: 1.5rem;
background: rgba(255,255,255,0.80);
}
header
{
text-align: center;
}
header > span
{
font-size: 2rem;
font-family: fantasy;
}
header a
{
text-decoration: none;
color: inherit;
}
footer
{
text-align: center;
color: rgba(255,255,255,0.80);
}
footer a
{
color: inherit;
}
h1, h2, h3, h4, h5, h6
{
text-align: center;
font-weight: normal;
line-height: 1;
}
h1
{
font-size: calc(24rem / 12);
}
h2
{
font-size: calc(18rem / 12);
}
h3
{
font-size: calc(14rem / 12);
}
h4
{
font-size: calc(16rem / 12);
}
h5
{
font-size: calc(10rem / 12);
}
h6
{
font-size: calc(8rem / 12);
}
a
{
-webkit-tap-highlight-color: transparent;
}
form
{
text-align: center;
}
textarea, input
{
display: inline-block;
margin-top: 0.75rem;
box-shadow: 0 0 0.375rem 0 black;
width: 100%;
border-radius: 0.75rem;
padding: 0.75rem;
resize: none;
background: white;
font: inherit;
color: inherit;
}
textarea
{
text-align: left;
}
input[type=radio]
{
display: none;
}
input[type=radio] + span, button
{
display: inline-block;
margin: 0.75rem 0.375rem 0;
box-shadow: 0 0 0.375rem 0 black;
border: 0.1875rem solid rgba(0,0,0,0.25);
border-radius: 0.75rem;
padding: 0.75rem;
background: lightgray;
font-size: 1rem;
line-height: 1;
}
button
{
-webkit-tap-highlight-color: transparent;
font: inherit;
color: inherit;
}
input[type=radio]:checked + span, button:active
{
box-shadow: 0 0 0.375rem 0 black inset;
border: 0.1875rem solid rgba(0,0,0,0.50);
font-weight: bold;
}
#wait
{
display: none;
position: fixed;
top: 0;
left: 0;
width: 100vw;
height: 100vh;
background: rgba(0,0,0,0.75);
}
#hourglass
{
position: relative;
top: calc(50% - 12.5vmin);
left: calc(50% - 12.5vmin);
width: 25vmin;
height: 25vmin;
font-size: 25vmin;
line-height: 1;
}
</style>
</head>
<body>
<header>
<span>&#x1F9D9;&#x1F3FC;&#x200D;&#x2642;&#xFE0F; CertSage</span><br>
version <?= $certsage->version ?><br>
<a href="mailto:support@griffin.software">support@griffin.software</a>
</header>
<main>
<article>
<?php
switch ($page):
case "welcome":
?>
<h1>Welcome!</h1>
<p>
CertSage is an <a href="https://tools.ietf.org/html/rfc8555" target="_blank">ACME</a> client that acquires free <a href="https://en.m.wikipedia.org/wiki/Domain-validated_certificate" target="_blank">DV TLS/SSL certificates</a> from <a href="https://letsencrypt.org/about/" target="_blank">Let's Encrypt</a> by satisfying an <a href="https://letsencrypt.org/docs/challenge-types/#http-01-challenge" target="_blank">HTTP-01 challenge</a> for each <a href="https://en.m.wikipedia.org/wiki/Domain_name" target="_blank">domain name</a> to be covered by a certificate.
By using CertSage, you are agreeing to the <a href="https://letsencrypt.org/repository/" target="_blank">Let's Encrypt Subscriber Agreement</a>.
Please use the <a href="https://letsencrypt.org/docs/staging-environment/" target="_blank">staging environment</a> for testing to avoid hitting the <a href="https://letsencrypt.org/docs/rate-limits/" target="_blank">rate limits</a>.
</p>
<hr>
<form autocomplete="off" method="post" onsubmit="document.getElementById('wait').style.display = 'block';">
<h2>Acquire Certificate</h2>
<p>
One domain name per line<br>
No wildcards (*) allowed<br>
<textarea name="domainNames" rows="5"><?= $domainNames ?></textarea>
</p>
<p>
Password<br>
Contents of <?= $certsage->dataDirectory ?>/password.txt<br>
<input name="password" type="password">
</p>
<input name="action" value="acquirecertificate" type="hidden">
<button name="environment" value="staging" type="submit">Acquire Staging Certificate</button>
<button name="environment" value="production" type="submit">Acquire Production Certificate</button>
</form>
<hr>
<form autocomplete="off" method="post" onsubmit="document.getElementById('wait').style.display = 'block';">
<h2>Install Certificate into cPanel</h2>
<p>
Password<br>
Contents of <?= $certsage->dataDirectory ?>/password.txt<br>
<input name="password" type="password">
</p>
<input name="action" value="installcertificate" type="hidden">
<button name="environment" value="production" type="submit">Install Certificate into cPanel</button>
</form>
<hr>
<form autocomplete="off" method="post" onsubmit="document.getElementById('wait').style.display = 'block';">
<h2>Receive Certificate Expiration Notifications</h2>
<p>
One email address per line<br>
Leave blank to unsubscribe<br>
<textarea name="emailAddresses" rows="5"></textarea>
</p>
<p>
Password<br>
Contents of <?= $certsage->dataDirectory ?>/password.txt<br>
<input name="password" type="password">
</p>
<input name="action" value="updatecontact" type="hidden">
<button name="environment" value="production" type="submit">Update Contact Information</button>
</form>
<?php
break;
case "success":
switch ($_POST["action"]):
case "acquirecertificate":
switch ($_POST["environment"]):
case "staging":
?>
<h1>Success!</h1>
<p>Your staging certificate was acquired. It was not saved to prevent accidental installation.</p>
<p>Your likely next step is to go back to the beginning to acquire your production certificate.</p>
<p>If you like free and easy certificates, please consider donating to CertSage and Let's Encrypt using the links at the bottom of this page.</p>
<p><a href="">Go back to the beginning</a></p>
<?php
break;
case "production":
?>
<h1>Success!</h1>
<p>Your production certificate was acquired. It was saved in <?= $certsage->dataDirectory ?>.</p>
<p>Your likely next step is to go back to the beginning to install your certificate into cPanel.</p>
<p>If you like free and easy certificates, please consider donating to CertSage and Let's Encrypt using the links at the bottom of this page.</p>
<p><a href="">Go back to the beginning</a></p>
<?php
break;
endswitch;
break;
case "installcertificate":
switch ($_POST["environment"]):
case "staging":
?>
<?php
break;
case "production":
?>
<h1>Success!</h1>
<p>Your certificate was installed into cPanel.</p>
<p>Your likely next step is to go back to the beginning to update your contact information.</p>
<p>If you like free and easy certificates, please consider donating to CertSage and Let's Encrypt using the links at the bottom of this page.</p>
<p><a href="">Go back to the beginning</a></p>
<?php
break;
endswitch;
break;
case "updatecontact":
switch ($_POST["environment"]):
case "staging":
?>
<?php
break;
case "production":
?>
<h1>Success!</h1>
<p>Your contact information was updated.</p>
<p>You are likely good to go.</p>
<p>If you like free and easy certificates, please consider donating to CertSage and Let's Encrypt using the links at the bottom of this page.</p>
<p><a href="">Go back to the beginning</a></p>
<?php
break;
endswitch;
break;
endswitch;
break;
case "trouble":
?>
<h1>Trouble...</h1>
<p><?= $error ?></p>
<p>If you need help with resolving this issue, please post a topic in the help category of the <a href="https://community.letsencrypt.org/" target="_blank">Let's Encrypt Community</a>.</p>
<p><a href="">Go back to the beginning</a></p>
<?php
break;
endswitch;
?>
</article>
</main>
<footer>
<a href="https://venmo.com/code?user_id=3205885367156736024" target="_blank">Donate to @CertSage via Venmo</a><br>
<br>
<a href="https://paypal.me/CertSage" target="_blank">Donate to @CertSage via PayPal</a><br>
<br>
<a href="https://letsencrypt.org/donate/" target="_blank">Donate to Let's Encrypt</a><br>
<br>
&copy; 2022 <a href="https://griffin.software" target="_blank">Griffin Software</a>
</footer>
<div id="wait"><span id="hourglass">&#x23F3;</span></div>
</body>
</html>
@xenago
Copy link
Author

xenago commented May 29, 2023

Jonathan Griffin (/u/griffin on the Let's Encrypt Community forum) posted this useful certsage code with a nonfree license; however, the license does permit redistribution if no changes are made. This gist is a mirror without changes.

The following is a partial quote from the post accompanying version 1.4.1, including a link to the original hosting location. Please view the entire thread/discussion for full details.

Introduction

CertSage was designed for people of all ages and experience levels who want an incredibly quick and easy way to acquire Let's Encrypt TLS/SSL certificates. CertSage is especially helpful if you are using a shared hosting plan that does not allow root access, such as GoDaddy or tsoHost shared hosting. It's free, of course!

Requirements

PHP 7.0+

Installation

Assuming that your domain name is example.com...

  1. Download certsage.txt.
  2. Upload certsage.txt into the webroot directory of your website (often something like public_html) that contains the content that you access when you visit http://example.com.
  3. Rename certsage.txt to certsage.php.

Usage

Assuming that your domain name is example.com...

  • Visit http://example.com/certsage.php.
  • Your password can be found in the password.txt file in your CertSage directory, which by default is located in the parent directory of the directory where you installed CertSage. The CertSage directory and password.txt are created automatically by CertSage when you visit the CertSage page in your browser. Should you wish to change your password, simply replace the contents of password.txt with whatever password you wish to use.
  • Most people will want to enter example.com and www.example.com as their domain names when acquiring a certificate.
  • To ensure that your CertSage installation is working, you can acquire a staging (fake) certificate.
  • Once you are confident that your CertSage installation is working, you can acquire a production (real) certificate.
  • Once you have successfully acquired a production certificate, you can have CertSage install it into cPanel by pushing a single button.
  • To renew your certificate, simply revisit http://example.com/certsage.php every 60 days to acquire and install a new production certificate.
  • You can subscribe to receive certificate expiration notifications from Let's Encrypt to serve as backup reminders to renew your certificate. Once you have subscribed, you will continue to receive certificate expiration notifications for all future certificates you acquire with CertSage. Should you wish to use different email address(es) after subscribing, simply enter all the email addresses you wish to use in the email address box then click Update Contact Information. Should you wish to stop receiving certificate expiration notifications, simply leave the email address box blank then click Update Contact Information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment