Updated the technical API documentation generated via PHPDoc.

api/files/AsymmetricEncryption/Rsa1024.php.txt

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * The RSA-1024 encryption algorithm class.
+ */
+
+namespace CryptoManana\AsymmetricEncryption;
+
+use \CryptoManana\Core\Abstractions\MessageEncryption\AbstractRsaEncryption as RsaAlgorithm;
+
+/**
+ * Class Rsa1024 - The RSA-1024 encryption algorithm object.
+ *
+ * @package CryptoManana\AsymmetricEncryption
+ */
+class Rsa1024 extends RsaAlgorithm
+{
+ /**
+ * The internal key size measured in raw bytes length for the algorithm
+ *
+ * @internal For the current algorithm: 1024 bits (128 bytes)
+ */
+ const KEY_SIZE = 1024;
+}
+

api/files/AsymmetricEncryption/Rsa2048.php.txt

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * The RSA-2048 encryption algorithm class.
+ */
+
+namespace CryptoManana\AsymmetricEncryption;
+
+use \CryptoManana\Core\Abstractions\MessageEncryption\AbstractRsaEncryption as RsaAlgorithm;
+
+/**
+ * Class Rsa2048 - The RSA-2048 encryption algorithm object.
+ *
+ * @package CryptoManana\AsymmetricEncryption
+ */
+class Rsa2048 extends RsaAlgorithm
+{
+ /**
+ * The internal key size measured in raw bytes length for the algorithm
+ *
+ * @internal For the current algorithm: 2048 bits (256 bytes)
+ */
+ const KEY_SIZE = 2048;
+}
+

api/files/AsymmetricEncryption/Rsa3072.php.txt

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * The RSA-3072 encryption algorithm class.
+ */
+
+namespace CryptoManana\AsymmetricEncryption;
+
+use \CryptoManana\Core\Abstractions\MessageEncryption\AbstractRsaEncryption as RsaAlgorithm;
+
+/**
+ * Class Rsa3072 - The RSA-3072 encryption algorithm object.
+ *
+ * @package CryptoManana\AsymmetricEncryption
+ */
+class Rsa3072 extends RsaAlgorithm
+{
+ /**
+ * The internal key size measured in raw bytes length for the algorithm
+ *
+ * @internal For the current algorithm: 3072 bits (384 bytes)
+ */
+ const KEY_SIZE = 3072;
+}
+

api/files/AsymmetricEncryption/Rsa4096.php.txt

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * The RSA-4096 encryption algorithm class.
+ */
+
+namespace CryptoManana\AsymmetricEncryption;
+
+use \CryptoManana\Core\Abstractions\MessageEncryption\AbstractRsaEncryption as RsaAlgorithm;
+
+/**
+ * Class Rsa4096 - The RSA-4096 encryption algorithm object.
+ *
+ * @package CryptoManana\AsymmetricEncryption
+ */
+class Rsa4096 extends RsaAlgorithm
+{
+ /**
+ * The internal key size measured in raw bytes length for the algorithm
+ *
+ * @internal For the current algorithm: 4096 bits (512 bytes)
+ */
+ const KEY_SIZE = 4096;
+}
+

api/files/Core/Abstractions/ErrorHandling/AbstractException.php.txt

@@ -29,7 +29,7 @@ abstract class AbstractException extends PhpException implements EditablePropert
  abstract public function getFrameworkErrorCode();
 
  /**
- * Change the exception's error message via a fluent interface call.
+ * Change the exception's error message via fluent interface call.
  *
  * @param string|mixed $message Set a different error message.
  *
@@ -45,7 +45,7 @@ abstract class AbstractException extends PhpException implements EditablePropert
  }
 
  /**
- * Change the exception's error code via a fluent interface call.
+ * Change the exception's error code via fluent interface call.
  *
  * @param int $code Set a different exception error code.
  *
@@ -59,7 +59,7 @@ abstract class AbstractException extends PhpException implements EditablePropert
  }
 
  /**
- * Change the file location where the exception occurred via a fluent interface call.
+ * Change the file location where the exception occurred via fluent interface call.
  *
  * @param string|mixed $file Set a different file path for the exception.
  *
@@ -75,7 +75,7 @@ abstract class AbstractException extends PhpException implements EditablePropert
  }
 
  /**
- * Change the file location where the exception occurred via a fluent interface call.
+ * Change the file location where the exception occurred via fluent interface call.
  *
  * @param int $line Set a different file line for the exception.
  *

api/files/Core/Abstractions/MessageEncryption/AbstractAsymmetricEncryptionAlgorithm.php.txt

@@ -0,0 +1,75 @@
+<?php
+
+/**
+ * The asymmetric encryption/signature algorithm abstraction specification.
+ */
+
+namespace CryptoManana\Core\Abstractions\MessageEncryption;
+
+use \CryptoManana\Core\Interfaces\MessageEncryption\KeyPairInterface as PublicKeyCipher;
+use \CryptoManana\Core\Traits\MessageEncryption\KeyPairTrait as PublicPrivateKeyPair;
+
+/**
+ * Class AbstractAsymmetricEncryptionAlgorithm - The asymmetric algorithm abstraction representation.
+ *
+ * @package CryptoManana\Core\Abstractions\MessageEncryption
+ *
+ * @mixin PublicPrivateKeyPair
+ */
+abstract class AbstractAsymmetricEncryptionAlgorithm implements PublicKeyCipher
+{
+ /**
+ * The asymmetric public and private key capabilities.
+ *
+ * {@internal Reusable implementation of `KeyPairInterface`. }}
+ */
+ use PublicPrivateKeyPair;
+
+ /**
+ * The internal name of the algorithm.
+ */
+ const ALGORITHM_NAME = 'none';
+
+ /**
+ * The internal key size measured in raw bytes length for the algorithm
+ */
+ const KEY_SIZE = 0;
+
+ /**
+ * The private key string property storage.
+ *
+ * @var string The private key string value.
+ */
+ protected $privateKey = '';
+
+ /**
+ * The public key string property storage.
+ *
+ * @var string The public key string value.
+ */
+ protected $publicKey = '';
+
+ /**
+ * Internal method for the validation of plain data used at encryption/signing operations.
+ *
+ * @param string $plainData The plain input string.
+ *
+ * @throws \Exception Validation errors.
+ */
+ abstract protected function validatePlainData($plainData);
+
+ /**
+ * Internal method for the validation of cipher/signature data used at decryption/verifying operations.
+ *
+ * @param string $cipherOrSignatureData The encrypted input string or a signature string.
+ *
+ * @throws \Exception Validation errors.
+ */
+ abstract protected function validateCipherOrSignatureData($cipherOrSignatureData);
+
+ /**
+ * Asymmetrical algorithm constructor.
+ */
+ abstract public function __construct();
+}
+

api/files/Core/Abstractions/MessageEncryption/AbstractBlockCipherAlgorithm.php.txt

@@ -76,7 +76,7 @@ abstract class AbstractBlockCipherAlgorithm extends SymmetricCipherAlgorithm imp
  /**
  * The final block padding operation property.
  *
- * @var int The final block padding operation string value.
+ * @var int The final block padding operation integer code value.
  */
  protected $padding = self::PKCS7_PADDING;
 
@@ -211,7 +211,7 @@ abstract class AbstractBlockCipherAlgorithm extends SymmetricCipherAlgorithm imp
 
  // Wrong format verification
  if ($plainData === false) {
- throw new \RuntimeException(
+ throw new \InvalidArgumentException(
  "The passed string was not from the chosen outputting format `{$this->getCipherFormat()}`."
  );
  }