code style, return types and throws

Author: Falseclock

README.md

@@ -1,4 +1,6 @@
 # AdvancedCMS
+A PHP Library that allows you to decode and manipulate CAdES or in other words CMS Advanced Electronic Signatures described in ETSI standart TS 101 733.
+
 Библиотека, которая позволит вам манипулировать CAdES или иначе стандартом электронной подписи, представляющий 
 собой расширенную версию стандарта электронной подписи CMS (Cryptographic Message Syntax) и разработанный ETSI.
 
@@ -20,13 +22,14 @@ composer require falseclock/advanced-cms
 
 Предыстория
 ------------
-Когда в Казахстане и России стала активно внедряться Электронная цифровая подпись (ЭЦП), я с большой для себя неожиданностью обнаружил,
+Когда в Казахстане и России стала активно внедряться Электронная цифровая подпись (ЭЦП), я, с большой для себя неожиданностью, обнаружил,
 что в PHP нет библиотек, позволяющих не только формализовать ASN.1 запись цифровой подписи в объект, но и тем более модифицировать её, путем добавления
 OCSP проверок или TSP меток, удалить электронный контент, чтобы оставить только подписи или просто объединить две разные подписи одних и тех же данных.
 Отправной точкой стала библиотека [adapik/cms](https://github.com/Adapik/CMS), в которой на тот момент не было детального описания всех возможных полей и данных в
 CAdES. Так начался долгий путь чтения RFC и написания [нескольких тысяч строк кода](https://github.com/Adapik/CMS/graphs/contributors) чтобы полностью и 
-детально описать рекомендации в виде библиотеки. Но по договоренности с Александром Даниловым, мы решили, что изначальная библиотека будет, как и раньше,
+детально описать рекомендации в виде библиотеки. Но, по договоренности с [Александром Даниловым](https://github.com/Adapik), мы решили, что изначальная библиотека будет, как и раньше,
 работать исключительно в режиме чтения, а все остальное, если я того желаю, могу сделать в виде отдельного пакета. Что, собственно, и было сделано.
+
 Человеку, не понимающему как работает ЭЦП, как проверяется легитимность и достоверность подписи будет довольно сложно понять суть и смысл этой библиотеки.
 Тем не менее я постарался сделать все возможные unit тесты и 100% покрыть код. Как работать с CMS файлами, изменять или создавать новые вы можете на основе тестов
 в папке [test](https://github.com/Falseclock/AdvancedCMS/tree/master/tests). В дальнейших планах реализация не только манипуляций с подписями, но и также

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "falseclock/advanced-cms",
-  "description": "A PHP Library that allows you to manipulate CMS.",
+  "description": "A PHP Library that allows you to decode and manipulate CAdES or in other words CMS Advanced Electronic Signatures described in ETSI standart TS 101 733.",
   "type": "library",
   "homepage": "https://github.com/Falseclock/AdvancedCMS",
   "license": "MIT",
@@ -25,23 +25,19 @@
     "encoding",
     "decoding",
     "gost",
-    "kalkan"
-  ],
-  "repositories":      [
-    {
-      "name": "adapik/cms",
-      "type": "vcs",
-      "url":  "https://github.com/Falseclock/CMS"
-    }
+    "kalkan",
+    "эцп",
+    "signature",
+    "openssl"
   ],
   "require": {
     "php": ">=7.2",
-    "adapik/phpasn1": "^2.2",
-    "adapik/cms": "dev-master"
+    "adapik/phpasn1": "^2.3",
+    "adapik/cms": "^0.2"
   },
   "require-dev": {
-    "phpunit/phpunit": "^9.4.2",
-    "php-coveralls/php-coveralls": "^2.4.2",
+    "phpunit/phpunit": "^9.5.10",
+    "php-coveralls/php-coveralls": "^2.4.3",
     "ext-curl": "*"
   },
   "autoload": {

phpunit.xml.dist

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
          colors="true"
          bootstrap="vendor/autoload.php">
     <coverage>

src/EncapsulatedContentInfo.php

@@ -26,8 +26,9 @@ class EncapsulatedContentInfo extends \Adapik\CMS\EncapsulatedContentInfo
      * Insert or update data content
      *
      * @param OctetString $octetString
+     *
      * @return EncapsulatedContentInfo
-     * @throws Exception
+     * @throws \Exception
      */
     public function setEContent(OctetString $octetString): self
     {
@@ -42,11 +43,10 @@ public function setEContent(OctetString $octetString): self
         return $this;
     }
 
-
     /**
      * Removing content if exist in case of necessity.
      * Actually we sign content hash and storing content not always strict.
-     * Moreover content can be very huge and heavy
+     * Moreover, content can be very huge and heavy
      *
      * @return EncapsulatedContentInfo
      * @throws Exception

src/OCSPRequest.php

@@ -10,18 +10,9 @@
 
 namespace Falseclock\AdvancedCMS;
 
-use Adapik\CMS\Algorithm;
-use Adapik\CMS\Certificate;
 use Adapik\CMS\CMSBase;
 use Adapik\CMS\Exception\FormatException;
-use Exception;
 use FG\ASN1\Exception\ParserException;
-use FG\ASN1\ExplicitlyTaggedObject;
-use FG\ASN1\Universal\BitString;
-use FG\ASN1\Universal\Integer;
-use FG\ASN1\Universal\NullObject;
-use FG\ASN1\Universal\ObjectIdentifier;
-use FG\ASN1\Universal\OctetString;
 use FG\ASN1\Universal\Sequence;
 
 /**
@@ -35,14 +26,14 @@ class OCSPRequest extends CMSBase
     const CONTENT_TYPE = 'application/ocsp-request';
     const OCSP_DEFAULT_NONCE_LENGTH = 16;
     const OID_OCSPNonce = '1.3.6.1.5.5.7.48.1.2';
-
     /**
      * @var Sequence
      */
     protected $object;
 
     /**
      * @param string $content
+     *
      * @return OCSPRequest
      * @throws FormatException
      */
@@ -51,14 +42,6 @@ public static function createFromContent(string $content): CMSBase
         return new self(self::makeFromContent($content, Maps\OCSPRequest::class, Sequence::class));
     }
 
-    /**
-     * @return TBSRequest
-     */
-    public function getTBSRequest(): TBSRequest
-    {
-        return new TBSRequest($this->object->getChildren()[0]);
-    }
-
     /**
      * @return Signature|null
      * @throws ParserException
@@ -69,9 +52,18 @@ public function getOptionalSignature(): ?Signature
 
         if (count($children) == 2) {
             $binary = $children[1]->getBinaryContent();
+
             return new Signature(Sequence::fromBinary($binary));
         }
 
         return null;
     }
+
+    /**
+     * @return TBSRequest
+     */
+    public function getTBSRequest(): TBSRequest
+    {
+        return new TBSRequest($this->object->getChildren()[0]);
+    }
 }

src/OCSPResponseStatus.php

@@ -52,6 +52,7 @@ public function getMapping(): array
      */
     public function isSuccessful(): bool
     {
+        /** @noinspection PhpCastIsUnnecessaryInspection */
         return intval($this->object->value) === 0;
     }
 }

src/RevocationValues.php

@@ -43,6 +43,8 @@ public static function createFromOCSPResponse(?BasicOCSPResponse $basicOCSPRespo
      * @param CertificateList|null $certificateList
      * @return Sequence
      * @throws ParserException
+     * @throws Exception
+     * @noinspection PhpIncompatibleReturnTypeInspection
      */
     public static function sequenceFromOCSPResponse(?BasicOCSPResponse $basicOCSPResponse = null, ?CertificateList $certificateList = null): Sequence
     {

src/SignedData.php

@@ -65,12 +65,12 @@ public function mergeCMS(SignedData $signedData): SignedData
             $initialContent->appendCertificate($certificate);
         }
 
-/*        $revocationInfoChoices = $newContent->getRevocationInfoChoices();
-        if ($revocationInfoChoices) {
-            foreach ($revocationInfoChoices as $revocationInfoChoice) {
-                $initialContent->appendRevocationInfoChoices($revocationInfoChoice);
-            }
-        }*/
+        /*        $revocationInfoChoices = $newContent->getRevocationInfoChoices();
+                if ($revocationInfoChoices) {
+                    foreach ($revocationInfoChoices as $revocationInfoChoice) {
+                        $initialContent->appendRevocationInfoChoices($revocationInfoChoice);
+                    }
+                }*/
 
         foreach ($newContent->getSignerInfoSet() as $signerInfo) {
             $initialContent->appendSignerInfo($signerInfo);

src/SignedDataContent.php

@@ -31,6 +31,7 @@ class SignedDataContent extends \Adapik\CMS\SignedDataContent
      * @param AlgorithmIdentifier $algorithmIdentifier
      * @return SignedDataContent
      * @throws ParserException
+     * @throws Exception
      */
     public function appendDigestAlgorithmIdentifier(AlgorithmIdentifier $algorithmIdentifier): self
     {
@@ -44,6 +45,7 @@ public function appendDigestAlgorithmIdentifier(AlgorithmIdentifier $algorithmId
      * @param Certificate $certificate
      * @return SignedDataContent
      * @throws ParserException
+     * @throws Exception
      */
     public function appendCertificate(Certificate $certificate): self
     {
@@ -59,15 +61,16 @@ public function appendCertificate(Certificate $certificate): self
      * @return SignedDataContent
      * @todo implement
      */
-/*    public function appendRevocationInfoChoices(RevocationInfoChoices $revocationInfoChoice): self
-    {
-        return $this;
-    }*/
+    /*    public function appendRevocationInfoChoices(RevocationInfoChoices $revocationInfoChoice): self
+        {
+            return $this;
+        }*/
 
     /**
      * @param SignerInfo $signerInfo
      * @return SignedDataContent
      * @throws ParserException
+     * @throws Exception
      */
     public function appendSignerInfo(SignerInfo $signerInfo): self
     {

src/SignerInfo.php

@@ -33,16 +33,17 @@ class SignerInfo extends \Adapik\CMS\SignerInfo
      * @return SignerInfo
      * @throws FormatException
      */
-	public static function createFromContent(string $content): CMSBase
-	{
-		return new self(self::makeFromContent($content, \Adapik\CMS\Maps\SignerInfo::class, Sequence::class));
-	}
+    public static function createFromContent(string $content): CMSBase
+    {
+        return new self(self::makeFromContent($content, \Adapik\CMS\Maps\SignerInfo::class, Sequence::class));
+    }
 
     /**
      * @param UnsignedAttribute $newAttribute
      * @return $this
      * @throws \FG\ASN1\Exception\Exception
      * @throws ParserException
+     * @throws Exception
      */
     public function addUnsignedAttribute(UnsignedAttribute $newAttribute): SignerInfo
     {
@@ -97,6 +98,7 @@ protected function createUnsignedAttributes(): ?UnsignedAttributes
     /**
      * @return $this
      * @throws \FG\ASN1\Exception\Exception
+     * @throws Exception
      */
     public function deleteUnsignedAttributes(): SignerInfo
     {