Zwartpet / php-certificate-toolbox

examples/exampleDNSInit.php

Indentation +24 added lines, -24 removed lines

@@ -22,36 +22,36 @@
 try {
 // Initiating the client instance. In this case using the staging server (argument 2) and outputting all status
 // and debug information (argument 3).
-    $client = new LEClient($email, true, $logger);
+	$client = new LEClient($email, true, $logger);
 // Initiating the order instance. The keys and certificate will be stored in /example.org/ (argument 1) and the
 // domains in the array (argument 2) will be on the certificate.
-    $order = $client->getOrCreateOrder($basename, $domains);
+	$order = $client->getOrCreateOrder($basename, $domains);
 // Check whether there are any authorizations pending. If that is the case, try to verify the pending authorizations.
-    if (!$order->allAuthorizationsValid()) {
-        // Get the DNS challenges from the pending authorizations.
-        $pending = $order->getPendingAuthorizations(LEOrder::CHALLENGE_TYPE_DNS);
-        // Walk the list of pending authorization DNS challenges.
-        if (!empty($pending)) {
-            foreach ($pending as $challenge) {
-                // For the purpose of this example, a fictitious functions creates or updates the ACME challenge DNS
-                // record for this domain.
-                //setDNSRecord($challenge['identifier'], $challenge['DNSDigest']);
-                printf(
-                    "DNS Challengage identifier = %s digest = %s\n",
-                    $challenge['identifier'],
-                    $challenge['DNSDigest']
-                );
-            }
-        }
-    }
+	if (!$order->allAuthorizationsValid()) {
+		// Get the DNS challenges from the pending authorizations.
+		$pending = $order->getPendingAuthorizations(LEOrder::CHALLENGE_TYPE_DNS);
+		// Walk the list of pending authorization DNS challenges.
+		if (!empty($pending)) {
+			foreach ($pending as $challenge) {
+				// For the purpose of this example, a fictitious functions creates or updates the ACME challenge DNS
+				// record for this domain.
+				//setDNSRecord($challenge['identifier'], $challenge['DNSDigest']);
+				printf(
+					"DNS Challengage identifier = %s digest = %s\n",
+					$challenge['identifier'],
+					$challenge['DNSDigest']
+				);
+			}
+		}
+	}
 }
 catch (\Exception $e) {
-    echo $e->getMessage()."\n";
-    echo $e->getTraceAsString()."\n";
+	echo $e->getMessage()."\n";
+	echo $e->getTraceAsString()."\n";
 
-    echo "\nDiagnostic logs\n";
-    $logger->dumpConsole();
-    exit;
+	echo "\nDiagnostic logs\n";
+	$logger->dumpConsole();
+	exit;
 }
 
 echo "\nDiagnostic logs\n";

examples/exampleDNSFinish.php

Indentation +2 added lines, -2 removed lines

@@ -49,8 +49,8 @@
 	if($order->isFinalized()) $order->getCertificate();
 
 	//finally, here's how we revoke
-    //echo "REVOKING...\n";
-    //$order->revokeCertificate();
+	//echo "REVOKING...\n";
+	//$order->revokeCertificate();
 }
 
 

examples/exampleHTTP.php

Indentation +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
 		foreach($pending as $challenge)
 		{
 			// Define the folder in which to store the challenge. For the purpose of this example, a fictitious path is
-            // set.
+			// set.
 			$folder = '/path/to/' . $challenge['identifier'] . '/.well-known/acme-challenge/';
 			// Check if that directory yet exists. If not, create it.
 			if(!file_exists($folder)) mkdir($folder, 0777, true);

src/DiagnosticLogger.php

Indentation +84 added lines, -84 removed lines

@@ -13,88 +13,88 @@
  */
 class DiagnosticLogger extends AbstractLogger
 {
-    private $logs = [];
-
-    public function log($level, $message, array $context = [])
-    {
-        $this->logs[] = [$level, $message, $context];
-    }
-
-    public function dumpConsole($useColours = true)
-    {
-        $colours = [
-            'alert' => "\e[97m\e[41m",
-            'emergency' => "\e[97m\e[41m",
-            'critical' => "\e[97m\e[41m",
-            'error' => "\e[91m",
-            'warning' => "\e[93m",
-            'notice' => "\e[96m",
-            'info' => "\e[92m",
-            'debug' => "\e[2m",
-        ];
-
-        $reset = $useColours ? "\e[0m" : '';
-
-        foreach ($this->logs as $log) {
-            $col = $useColours ? $colours[$log[0]] : '';
-            echo $col . $log[0] . ': ' . $this->interpolateMessage($log[1], $log[2]) . $reset . "\n";
-        }
-    }
-
-    public function dumpHTML($echo = true)
-    {
-        $html = '<div class="liblynx-diagnostic-log">';
-        $html .= '<table class="table"><thead><tr><th>Level</th><th>Message</th></tr></thead><tbody>';
-        $html .= "\n";
-
-        foreach ($this->logs as $log) {
-            $html .= '<tr class="level-' . $log[0] . '"><td>' . $log[0] . '</td><td>' .
-                htmlentities($this->interpolateMessage($log[1], $log[2])) .
-                "</td></tr>\n";
-        }
-        $html .= "</tbody></table></div>\n";
-
-        if ($echo) {
-            echo $html; //@codeCoverageIgnore
-        }
-        return $html;
-    }
-
-    /**
-     * Interpolates context values into the message placeholders.
-     */
-    private function interpolateMessage($message, array $context = [])
-    {
-        // build a replacement array with braces around the context keys
-        $replace = [];
-        foreach ($context as $key => $val) {
-            // check that the value can be casted to string
-            if (!is_array($val) && (!is_object($val) || method_exists($val, '__toString'))) {
-                $replace['{' . $key . '}'] = $val;
-            }
-        }
-
-        // interpolate replacement values into the message and return
-        return strtr($message, $replace);
-    }
-
-
-    public function cleanLogs()
-    {
-        $logs = $this->logs;
-        $this->logs = [];
-
-        return $logs;
-    }
-
-    public function countLogs($level)
-    {
-        $count = 0;
-        foreach ($this->logs as $log) {
-            if ($log[0] == $level) {
-                $count++;
-            }
-        }
-        return $count;
-    }
+	private $logs = [];
+
+	public function log($level, $message, array $context = [])
+	{
+		$this->logs[] = [$level, $message, $context];
+	}
+
+	public function dumpConsole($useColours = true)
+	{
+		$colours = [
+			'alert' => "\e[97m\e[41m",
+			'emergency' => "\e[97m\e[41m",
+			'critical' => "\e[97m\e[41m",
+			'error' => "\e[91m",
+			'warning' => "\e[93m",
+			'notice' => "\e[96m",
+			'info' => "\e[92m",
+			'debug' => "\e[2m",
+		];
+
+		$reset = $useColours ? "\e[0m" : '';
+
+		foreach ($this->logs as $log) {
+			$col = $useColours ? $colours[$log[0]] : '';
+			echo $col . $log[0] . ': ' . $this->interpolateMessage($log[1], $log[2]) . $reset . "\n";
+		}
+	}
+
+	public function dumpHTML($echo = true)
+	{
+		$html = '<div class="liblynx-diagnostic-log">';
+		$html .= '<table class="table"><thead><tr><th>Level</th><th>Message</th></tr></thead><tbody>';
+		$html .= "\n";
+
+		foreach ($this->logs as $log) {
+			$html .= '<tr class="level-' . $log[0] . '"><td>' . $log[0] . '</td><td>' .
+				htmlentities($this->interpolateMessage($log[1], $log[2])) .
+				"</td></tr>\n";
+		}
+		$html .= "</tbody></table></div>\n";
+
+		if ($echo) {
+			echo $html; //@codeCoverageIgnore
+		}
+		return $html;
+	}
+
+	/**
+	 * Interpolates context values into the message placeholders.
+	 */
+	private function interpolateMessage($message, array $context = [])
+	{
+		// build a replacement array with braces around the context keys
+		$replace = [];
+		foreach ($context as $key => $val) {
+			// check that the value can be casted to string
+			if (!is_array($val) && (!is_object($val) || method_exists($val, '__toString'))) {
+				$replace['{' . $key . '}'] = $val;
+			}
+		}
+
+		// interpolate replacement values into the message and return
+		return strtr($message, $replace);
+	}
+
+
+	public function cleanLogs()
+	{
+		$logs = $this->logs;
+		$this->logs = [];
+
+		return $logs;
+	}
+
+	public function countLogs($level)
+	{
+		$count = 0;
+		foreach ($this->logs as $log) {
+			if ($log[0] == $level) {
+				$count++;
+			}
+		}
+		return $count;
+	}
 }

src/LEFunctions.php

Indentation +102 added lines, -102 removed lines

@@ -14,106 +14,106 @@
  */
 class LEFunctions
 {
-    /**
-     * Generates a new RSA keypair and returns both
-     *
-     * @param integer $keySize RSA key size, must be between 2048 and 4096 (default is 4096)
-     * @return array containing public and private indexes containing the new keys
-     */
-    public static function RSAGenerateKeys($keySize = 4096)
-    {
-
-        if ($keySize < 2048 || $keySize > 4096) {
-            throw new LogicException("RSA key size must be between 2048 and 4096");
-        }
-
-        $res = openssl_pkey_new([
-            "private_key_type" => OPENSSL_KEYTYPE_RSA,
-            "private_key_bits" => intval($keySize),
-        ]);
-
-        if (!openssl_pkey_export($res, $privateKey)) {
-            throw new RuntimeException("RSA keypair export failed!"); //@codeCoverageIgnore
-        }
-
-        $details = openssl_pkey_get_details($res);
-
-        $result = ['public' => $details['key'], 'private' => $privateKey];
-
-        openssl_pkey_free($res);
-
-        return $result;
-    }
-
-
-    /**
-     * Generates a new EC prime256v1 keypair and saves both keys to a new file.
-     *
-     * @param integer $keySize EC key size, possible values are 256 (prime256v1) or 384 (secp384r1),
-     *                               default is 256
-     * @return array containing public and private indexes containing the new keys
-     */
-    public static function ECGenerateKeys($keySize = 256)
-    {
-        if (version_compare(PHP_VERSION, '7.1.0') == -1) {
-            throw new RuntimeException("PHP 7.1+ required for EC keys"); //@codeCoverageIgnore
-        }
-
-        if ($keySize == 256) {
-            $res = openssl_pkey_new([
-                "private_key_type" => OPENSSL_KEYTYPE_EC,
-                "curve_name" => "prime256v1",
-            ]);
-        } elseif ($keySize == 384) {
-            $res = openssl_pkey_new([
-                "private_key_type" => OPENSSL_KEYTYPE_EC,
-                "curve_name" => "secp384r1",
-            ]);
-        } else {
-            throw new LogicException("EC key size must be 256 or 384");
-        }
-
-
-        if (!openssl_pkey_export($res, $privateKey)) {
-            throw new RuntimeException("EC keypair export failed!"); //@codeCoverageIgnore
-        }
-
-        $details = openssl_pkey_get_details($res);
-
-        $result = ['public' => $details['key'], 'private' => $privateKey];
-
-        openssl_pkey_free($res);
-
-        return $result;
-    }
-
-
-    /**
-     * Encodes a string input to a base64 encoded string which is URL safe.
-     *
-     * @param string $input The input string to encode.
-     *
-     * @return string   Returns a URL safe base64 encoded string.
-     */
-    public static function base64UrlSafeEncode($input)
-    {
-        return str_replace('=', '', strtr(base64_encode($input), '+/', '-_'));
-    }
-
-    /**
-     * Decodes a string that is URL safe base64 encoded.
-     *
-     * @param string $input The encoded input string to decode.
-     *
-     * @return string   Returns the decoded input string.
-     */
-    public static function base64UrlSafeDecode($input)
-    {
-        $remainder = strlen($input) % 4;
-        if ($remainder) {
-            $padlen = 4 - $remainder;
-            $input .= str_repeat('=', $padlen);
-        }
-        return base64_decode(strtr($input, '-_', '+/'));
-    }
+	/**
+	 * Generates a new RSA keypair and returns both
+	 *
+	 * @param integer $keySize RSA key size, must be between 2048 and 4096 (default is 4096)
+	 * @return array containing public and private indexes containing the new keys
+	 */
+	public static function RSAGenerateKeys($keySize = 4096)
+	{
+
+		if ($keySize < 2048 || $keySize > 4096) {
+			throw new LogicException("RSA key size must be between 2048 and 4096");
+		}
+
+		$res = openssl_pkey_new([
+			"private_key_type" => OPENSSL_KEYTYPE_RSA,
+			"private_key_bits" => intval($keySize),
+		]);
+
+		if (!openssl_pkey_export($res, $privateKey)) {
+			throw new RuntimeException("RSA keypair export failed!"); //@codeCoverageIgnore
+		}
+
+		$details = openssl_pkey_get_details($res);
+
+		$result = ['public' => $details['key'], 'private' => $privateKey];
+
+		openssl_pkey_free($res);
+
+		return $result;
+	}
+
+
+	/**
+	 * Generates a new EC prime256v1 keypair and saves both keys to a new file.
+	 *
+	 * @param integer $keySize EC key size, possible values are 256 (prime256v1) or 384 (secp384r1),
+	 *                               default is 256
+	 * @return array containing public and private indexes containing the new keys
+	 */
+	public static function ECGenerateKeys($keySize = 256)
+	{
+		if (version_compare(PHP_VERSION, '7.1.0') == -1) {
+			throw new RuntimeException("PHP 7.1+ required for EC keys"); //@codeCoverageIgnore
+		}
+
+		if ($keySize == 256) {
+			$res = openssl_pkey_new([
+				"private_key_type" => OPENSSL_KEYTYPE_EC,
+				"curve_name" => "prime256v1",
+			]);
+		} elseif ($keySize == 384) {
+			$res = openssl_pkey_new([
+				"private_key_type" => OPENSSL_KEYTYPE_EC,
+				"curve_name" => "secp384r1",
+			]);
+		} else {
+			throw new LogicException("EC key size must be 256 or 384");
+		}
+
+
+		if (!openssl_pkey_export($res, $privateKey)) {
+			throw new RuntimeException("EC keypair export failed!"); //@codeCoverageIgnore
+		}
+
+		$details = openssl_pkey_get_details($res);
+
+		$result = ['public' => $details['key'], 'private' => $privateKey];
+
+		openssl_pkey_free($res);
+
+		return $result;
+	}
+
+
+	/**
+	 * Encodes a string input to a base64 encoded string which is URL safe.
+	 *
+	 * @param string $input The input string to encode.
+	 *
+	 * @return string   Returns a URL safe base64 encoded string.
+	 */
+	public static function base64UrlSafeEncode($input)
+	{
+		return str_replace('=', '', strtr(base64_encode($input), '+/', '-_'));
+	}
+
+	/**
+	 * Decodes a string that is URL safe base64 encoded.
+	 *
+	 * @param string $input The encoded input string to decode.
+	 *
+	 * @return string   Returns the decoded input string.
+	 */
+	public static function base64UrlSafeDecode($input)
+	{
+		$remainder = strlen($input) % 4;
+		if ($remainder) {
+			$padlen = 4 - $remainder;
+			$input .= str_repeat('=', $padlen);
+		}
+		return base64_decode(strtr($input, '-_', '+/'));
+	}
 }

src/DNSValidator/DNSOverHTTPS.php

Indentation +89 added lines, -89 removed lines

@@ -39,93 +39,93 @@
 class DNSOverHTTPS implements DNSValidatorInterface
 {
 
-    const DNS_GOOGLE     = 'https://dns.google.com/resolve';
-    const DNS_MOZILLA    = 'https://mozilla.cloudflare-dns.com/dns-query';
-    const DNS_CLOUDFLARE = 'https://cloudflare-dns.com/dns-query';
-
-    /**
-     * What DNS-over-HTTPS service to use
-     *
-     * @var null|string
-     */
-    private $baseURI;
-
-    /**
-     * Guzzle client handler
-     *
-     * @var Client object
-     */
-    private $client;
-
-    /**
-     * DNSOverHTTPS constructor.
-     * @param string|null $baseURI
-     */
-    public function __construct(string $baseURI = null)
-    {
-        //Default to Google, seems like a safe bet...
-        if ($baseURI === null) {
-            $this->baseURI = self::DNS_GOOGLE;
-        } else {
-            $this->baseURI = $baseURI;
-        }
-
-        $this->client = new Client([
-            'base_uri' => $this->baseURI
-        ]);
-    }
-
-    public function checkChallenge($domain, $requiredDigest) : bool
-    {
-        $hostname = '_acme-challenge.' . str_replace('*.', '', $domain);
-
-        $records = $this->get($hostname, 'TXT');
-        if ($records->Status == 0) {
-            foreach ($records->Answer as $record) {
-                if ((rtrim($record->name, ".") == $hostname) &&
-                    ($record->type == 16) &&
-                    (trim($record->data, '"') == $requiredDigest)) {
-                    return true;
-                }
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * @param string $name
-     * @param string $type per experimental spec this can be string OR int, we force string
-     * @return \stdClass
-     */
-    public function get(string $name, string $type) : \stdClass
-    {
-        $query = [
-            'query' => [
-                'name'               => $name,
-                'type'               => $type,
-                'edns_client_subnet' => '0.0.0.0/0',            //disable geotagged dns results
-                'ct'                 => 'application/dns-json', //cloudflare requires this
-            ],
-            'headers' => [
-                'Accept' => 'application/dns-json'
-            ]
-        ];
-
-        try {
-            $response = $this->client->get(null, $query);
-        } catch (BadResponseException $e) {
-            throw new RuntimeException("GET {$this->baseURI} failed", 0, $e);
-        }
-
-        $decode = json_decode($response->getBody());
-
-        if (json_last_error() !== JSON_ERROR_NONE) {
-            throw new RuntimeException(
-                'Attempted to decode expected JSON response, however server returned something unexpected.'
-            );
-        }
-
-        return $decode;
-    }
+	const DNS_GOOGLE     = 'https://dns.google.com/resolve';
+	const DNS_MOZILLA    = 'https://mozilla.cloudflare-dns.com/dns-query';
+	const DNS_CLOUDFLARE = 'https://cloudflare-dns.com/dns-query';
+
+	/**
+	 * What DNS-over-HTTPS service to use
+	 *
+	 * @var null|string
+	 */
+	private $baseURI;
+
+	/**
+	 * Guzzle client handler
+	 *
+	 * @var Client object
+	 */
+	private $client;
+
+	/**
+	 * DNSOverHTTPS constructor.
+	 * @param string|null $baseURI
+	 */
+	public function __construct(string $baseURI = null)
+	{
+		//Default to Google, seems like a safe bet...
+		if ($baseURI === null) {
+			$this->baseURI = self::DNS_GOOGLE;
+		} else {
+			$this->baseURI = $baseURI;
+		}
+
+		$this->client = new Client([
+			'base_uri' => $this->baseURI
+		]);
+	}
+
+	public function checkChallenge($domain, $requiredDigest) : bool
+	{
+		$hostname = '_acme-challenge.' . str_replace('*.', '', $domain);
+
+		$records = $this->get($hostname, 'TXT');
+		if ($records->Status == 0) {
+			foreach ($records->Answer as $record) {
+				if ((rtrim($record->name, ".") == $hostname) &&
+					($record->type == 16) &&
+					(trim($record->data, '"') == $requiredDigest)) {
+					return true;
+				}
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * @param string $name
+	 * @param string $type per experimental spec this can be string OR int, we force string
+	 * @return \stdClass
+	 */
+	public function get(string $name, string $type) : \stdClass
+	{
+		$query = [
+			'query' => [
+				'name'               => $name,
+				'type'               => $type,
+				'edns_client_subnet' => '0.0.0.0/0',            //disable geotagged dns results
+				'ct'                 => 'application/dns-json', //cloudflare requires this
+			],
+			'headers' => [
+				'Accept' => 'application/dns-json'
+			]
+		];
+
+		try {
+			$response = $this->client->get(null, $query);
+		} catch (BadResponseException $e) {
+			throw new RuntimeException("GET {$this->baseURI} failed", 0, $e);
+		}
+
+		$decode = json_decode($response->getBody());
+
+		if (json_last_error() !== JSON_ERROR_NONE) {
+			throw new RuntimeException(
+				'Attempted to decode expected JSON response, however server returned something unexpected.'
+			);
+		}
+
+		return $decode;
+	}
 }

src/DNSValidator/DNSValidatorInterface.php

Indentation +10 added lines, -10 removed lines

@@ -10,14 +10,14 @@
  */
 interface DNSValidatorInterface
 {
-    /**
-     * This will strip any leading *. wildcard and prepend _acme-challenge. to form the challenge domain,
-     * and will then request TXT record for that domain. If the record is found, and the content matches
-     * the given digest, return true. Otherwise, return false
-     *
-     * @param $domain string base domain for certificate, which can include wildcard
-     * @param $requiredDigest string expected digest value
-     * @return bool
-     */
-    public function checkChallenge($domain, $requiredDigest) : bool;
+	/**
+	 * This will strip any leading *. wildcard and prepend _acme-challenge. to form the challenge domain,
+	 * and will then request TXT record for that domain. If the record is found, and the content matches
+	 * the given digest, return true. Otherwise, return false
+	 *
+	 * @param $domain string base domain for certificate, which can include wildcard
+	 * @param $requiredDigest string expected digest value
+	 * @return bool
+	 */
+	public function checkChallenge($domain, $requiredDigest) : bool;
 }

src/DNSValidator/NativeDNS.php

Indentation +11 added lines, -11 removed lines

@@ -10,15 +10,15 @@
  */
 class NativeDNS implements DNSValidatorInterface
 {
-    public function checkChallenge($domain, $requiredDigest) : bool
-    {
-        $hostname = '_acme-challenge.' . str_replace('*.', '', $domain);
-        $records =  dns_get_record($hostname, DNS_TXT);
-        foreach ($records as $record) {
-            if ($record['host'] == $hostname && $record['type'] == 'TXT' && $record['txt'] == $requiredDigest) {
-                return true;
-            }
-        }
-        return false;
-    }
+	public function checkChallenge($domain, $requiredDigest) : bool
+	{
+		$hostname = '_acme-challenge.' . str_replace('*.', '', $domain);
+		$records =  dns_get_record($hostname, DNS_TXT);
+		foreach ($records as $record) {
+			if ($record['host'] == $hostname && $record['type'] == 'TXT' && $record['txt'] == $requiredDigest) {
+				return true;
+			}
+		}
+		return false;
+	}
 }

src/Sleep.php

Indentation +4 added lines, -4 removed lines

@@ -10,8 +10,8 @@
  */
 class Sleep
 {
-    public function for($seconds)
-    {
-        sleep($seconds);
-    }
+	public function for($seconds)
+	{
+		sleep($seconds);
+	}
 }