LEAccount::changeAccountKeys() - Code Metrics - Inspection of "Yourivw master" - Zwartpet/php-certificate-toolbox - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#8)

by John
created 2021-02-18 12:17 UTC
LEAccount::changeAccountKeys() A

↳ Parent: LEAccount
Complexity

Conditions	4
Paths	4
Size

Total Lines	32
Code Lines	22
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	20
CRAP Score	4
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	4
eloc	22
c	1
b	0
f	0
nc	4
nop	0
dl	0
loc	32
rs	9.568
ccs	20
cts	20
cp	1
crap	4
<?php

namespace LEClient;

use LEClient\Exceptions\LEAccountException;

/**
 * LetsEncrypt Account class, containing the functions and data associated with a LetsEncrypt account.
 *
 * PHP version 5.2.0
 *
 * MIT License
 *
 * Copyright (c) 2018 Youri van Weegberg
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * @author     Youri van Weegberg <[email protected]>
 * @copyright  2018 Youri van Weegberg
 * @license    https://opensource.org/licenses/mit-license.php  MIT License
 * @link       https://github.com/yourivw/LEClient
 * @since      Class available since Release 1.0.0
 */
class LEAccount
{
	private $connector;
	private $accountKeys;

	public $id;
	public $key;
	public $contact;
	public $agreement;
	public $initialIp;
	public $createdAt;
	public $status;

	private $log;

    /**
     * Initiates the LetsEncrypt Account class.
     *
     * @param LEConnector	$connector 		The LetsEncrypt Connector instance to use for HTTP requests.
     * @param int 			$log 			The level of logging. Defaults to no logging. LOG_OFF, LOG_STATUS, LOG_DEBUG accepted.
     * @param array 		$email	 		The array of strings containing e-mail addresses. Only used when creating a new account.
     * @param array 		$accountKeys 	Array containing location of account keys files.
     */
	public function __construct($connector, $log, $email, $accountKeys)
	{
		$this->connector = $connector;
		$this->accountKeys = $accountKeys;
		$this->log = $log;

		if(!file_exists($this->accountKeys['private_key']) OR !file_exists($this->accountKeys['public_key']))
		{
			if($this->log instanceof \Psr\Log\LoggerInterface) 

			{
				$this->log->info('No account found, attempting to create account.');
			}
			else if($this->log >= LECLient::LOG_STATUS) LEFunctions::log('No account found, attempting to create account.', 'function LEAccount __construct');
			else if($this->log >= LECLient::LOG_STATUS) LEFunctions::log(/** @scrutinizer ignore-type */ 'No account found, attempting to create account.', 'function LEAccount __construct');
			
			LEFunctions::RSAgenerateKeys(null, $this->accountKeys['private_key'], $this->accountKeys['public_key']);
			$this->connector->accountURL = $this->createLEAccount($email);
		}
		else
		{
			$this->connector->accountURL = $this->getLEAccount();
		}
		if($this->connector->accountURL == false) throw LEAccountException::AccountNotFoundException();

		$this->getLEAccountData();
	}

    /**
     * Creates a new LetsEncrypt account.
     *
     * @param array 	$email 	The array of strings containing e-mail addresses.
     *
     * @return object	Returns the new account URL when the account was successfully created, false if not.
     */
	private function createLEAccount($email)
	{
		$contact = array_map(function($addr) { return empty($addr) ? '' : (strpos($addr, 'mailto') === false ? 'mailto:' . $addr : $addr); }, $email);

		$sign = $this->connector->signRequestJWK(array('contact' => $contact, 'termsOfServiceAgreed' => true), $this->connector->newAccount);
		$post = $this->connector->post($this->connector->newAccount, $sign);
		$post = $this->connector->post($this->connector->newAccount, /** @scrutinizer ignore-type */ $sign);
		if($post['status'] === 201)
		{
			if(preg_match('~Location: (\S+)~i', $post['header'], $matches)) return trim($matches[1]);
		}
		return false;
	}

    /**
     * Gets the LetsEncrypt account URL associated with the stored account keys.
     *
     * @return object	Returns the account URL if it is found, or false when none is found.
     */
	private function getLEAccount()
	{
		$sign = $this->connector->signRequestJWK(array('onlyReturnExisting' => true), $this->connector->newAccount);
		$post = $this->connector->post($this->connector->newAccount, $sign);
		$post = $this->connector->post($this->connector->newAccount, /** @scrutinizer ignore-type */ $sign);

		if($post['status'] === 200)
		{
			if(preg_match('~Location: (\S+)~i', $post['header'], $matches)) return trim($matches[1]);
		}
		return false;
	}

    /**
     * Gets the LetsEncrypt account data from the account URL.
     */
	private function getLEAccountData()
	{
		$sign = $this->connector->signRequestKid(array('' => ''), $this->connector->accountURL, $this->connector->accountURL);
		$post = $this->connector->post($this->connector->accountURL, $sign);
		$post = $this->connector->post($this->connector->accountURL, /** @scrutinizer ignore-type */ $sign);
		if($post['status'] === 200)
		{
			$this->id = isset($post['body']['id']) ? $post['body']['id'] : '';
			$this->key = $post['body']['key'];
			$this->contact = $post['body']['contact'];
			$this->agreement = isset($post['body']['agreement']) ? $post['body']['agreement'] : '';
			$this->initialIp = $post['body']['initialIp'];
			$this->createdAt = $post['body']['createdAt'];
			$this->status = $post['body']['status'];
		}
		else
		{
			throw LEAccountException::AccountNotFoundException();
		}
	}

    /**
     * Updates account data. Now just supporting new contact information.
     *
     * @param array 	$email	The array of strings containing e-mail adresses.
     *
     * @return boolean	Returns true if the update is successful, false if not.
     */
	public function updateAccount($email)
	{
		$contact = array_map(function($addr) { return empty($addr) ? '' : (strpos($addr, 'mailto') === false ? 'mailto:' . $addr : $addr); }, $email);

		$sign = $this->connector->signRequestKid(array('contact' => $contact), $this->connector->accountURL, $this->connector->accountURL);
		$post = $this->connector->post($this->connector->accountURL, $sign);
		$post = $this->connector->post($this->connector->accountURL, /** @scrutinizer ignore-type */ $sign);
		if($post['status'] === 200)
		{
			$this->id = isset($post['body']['id']) ? $post['body']['id'] : '';
			$this->key = $post['body']['key'];
			$this->contact = $post['body']['contact'];
			$this->agreement = isset($post['body']['agreement']) ? $post['body']['agreement'] : '';
			$this->initialIp = $post['body']['initialIp'];
			$this->createdAt = $post['body']['createdAt'];
			$this->status = $post['body']['status'];
			if($this->log instanceof \Psr\Log\LoggerInterface) 

			{
				$this->log->info('Account data updated.');
			}
			else if($this->log >= LEClient::LOG_STATUS) LEFunctions::log('Account data updated.', 'function updateAccount');
			else if($this->log >= LEClient::LOG_STATUS) LEFunctions::log(/** @scrutinizer ignore-type */ 'Account data updated.', 'function updateAccount');
			return true;
		}
		else
		{
			return false;
		}
	}

    /**
     * Creates new RSA account keys and updates the keys with LetsEncrypt.
     *
     * @return boolean	Returns true if the update is successful, false if not.
     */
	public function changeAccountKeys()
	{
		LEFunctions::RSAgenerateKeys(null, $this->accountKeys['private_key'].'.new', $this->accountKeys['public_key'].'.new');
		$oldPrivateKey = openssl_pkey_get_private(file_get_contents($this->accountKeys['private_key']));
		$oldDetails = openssl_pkey_get_details($oldPrivateKey);
		$innerPayload = array('account' => $this->connector->accountURL, 'oldKey' => array(
			"kty" => "RSA",
			"n" => LEFunctions::Base64UrlSafeEncode($oldDetails["rsa"]["n"]),
			"e" => LEFunctions::Base64UrlSafeEncode($oldDetails["rsa"]["e"])
		));
		$outerPayload = $this->connector->signRequestJWK($innerPayload, $this->connector->keyChange, $this->accountKeys['private_key'].'.new');
		$sign = $this->connector->signRequestKid($outerPayload, $this->connector->accountURL, $this->connector->keyChange);
		$sign = $this->connector->signRequestKid(/** @scrutinizer ignore-type */ $outerPayload, $this->connector->accountURL, $this->connector->keyChange);
		$post = $this->connector->post($this->connector->keyChange, $sign);
		$post = $this->connector->post($this->connector->keyChange, /** @scrutinizer ignore-type */ $sign);
		if($post['status'] === 200)
		{
			unlink($this->accountKeys['private_key']);
			unlink($this->accountKeys['public_key']);
			rename($this->accountKeys['private_key'].'.new', $this->accountKeys['private_key']);
			rename($this->accountKeys['public_key'].'.new', $this->accountKeys['public_key']);
			
			$this->getLEAccountData();

			if($this->log instanceof \Psr\Log\LoggerInterface) 

			{
				$this->log->info('Account keys changed.');
			}
			elseif($this->log >= LEClient::LOG_STATUS) LEFunctions::log('Account keys changed.', 'function changeAccountKey');
			elseif($this->log >= LEClient::LOG_STATUS) LEFunctions::log(/** @scrutinizer ignore-type */ 'Account keys changed.', 'function changeAccountKey');
			return true;
		}
		else
		{
			return false;
		}
	}

    /**
     * Deactivates the LetsEncrypt account.
     *
     * @return boolean	Returns true if the deactivation is successful, false if not.
     */
	public function deactivateAccount()
	{
		$sign = $this->connector->signRequestKid(array('status' => 'deactivated'), $this->connector->accountURL, $this->connector->accountURL);
		$post = $this->connector->post($this->connector->accountURL, $sign);
		$post = $this->connector->post($this->connector->accountURL, /** @scrutinizer ignore-type */ $sign);
		if($post['status'] === 200)
		{
			$this->connector->accountDeactivated = true;
			if($this->log instanceof \Psr\Log\LoggerInterface) 

			{
				$this->log->info('Account deactivated.');
			}
			elseif($this->log >= LEClient::LOG_STATUS) LEFunctions::log('Account deactivated.', 'function deactivateAccount');
			elseif($this->log >= LEClient::LOG_STATUS) LEFunctions::log(/** @scrutinizer ignore-type */ 'Account deactivated.', 'function deactivateAccount');
			
			return true;
		}
		else
		{
			return false;
		}
	}
}

Zwartpet / php-certificate-toolbox

Pull Request — master (#8)

LEAccount::changeAccountKeys() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
