TemplateParser marked deprecated

Author: adapik

src/ASN1/Mapper/Mapper.php

@@ -1,6 +1,7 @@
 <?php
 
 namespace FG\ASN1\Mapper;
+
 use FG\ASN1\AbstractTaggedObject;
 use FG\ASN1\ASN1ObjectInterface;
 use FG\ASN1\Identifier;

src/ASN1/TemplateParser.php

@@ -0,0 +1,79 @@
+<?php
+/*
+ * This file is part of the PHPASN1 library.
+ *
+ * Copyright © Friedrich Große <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FG\ASN1;
+
+use Exception;
+use FG\ASN1\Exception\ParserException;
+use FG\ASN1\Universal\Sequence;
+
+/**
+ * @deprecated
+ *
+ * use \FG\ASN1\Mapper\Mapper instead
+ */
+class TemplateParser
+{
+    /**
+     * @param string $data
+     * @param array  $template
+     *
+     * @return \FG\ASN1\ASN1Object|Sequence
+     * @throws ParserException if there was an issue parsing
+     */
+    public function parseBase64($data, array $template)
+    {
+        // TODO test with invalid data
+        return $this->parseBinary(base64_decode($data), $template);
+    }
+
+    /**
+     * @param string $binary
+     * @param array  $template
+     *
+     * @return \FG\ASN1\ASN1Object|Sequence
+     * @throws ParserException if there was an issue parsing
+     */
+    public function parseBinary($binary, array $template)
+    {
+        $parsedObject = ASN1Object::fromBinary($binary);
+
+        foreach ($template as $key => $value) {
+            $this->validate($parsedObject, $key, $value);
+        }
+
+        return $parsedObject;
+    }
+
+    private function validate(ASN1Object $object, $key, $value)
+    {
+        if (is_array($value)) {
+            $this->assertTypeId($key, $object);
+
+            /* @var Construct $object */
+            $childrenCount = count($value);
+            reset($value);
+            for ($i = 0; $i < $childrenCount; $i++) {
+                $this->validate($object->getChildren()[$i], key($value), current($value));
+                next($value);
+            }
+        } else {
+            $this->assertTypeId($value, $object);
+        }
+    }
+
+    private function assertTypeId($expectedTypeId, ASN1Object $object)
+    {
+        $actualType = $object->getIdentifier()->getTagNumber();
+        if ($expectedTypeId !== $actualType) {
+            throw new Exception("Expected type ($expectedTypeId) does not match actual type ($actualType");
+        }
+    }
+}

tests/ASN1/TemplateParserTest.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace FG\Test\ASN1;
+
+use FG\ASN1\Identifier;
+use FG\ASN1\TemplateParser;
+use FG\ASN1\Universal\BitString;
+use FG\ASN1\Universal\Integer;
+use FG\ASN1\Universal\ObjectIdentifier;
+use FG\ASN1\Universal\Sequence;
+use FG\ASN1\Universal\Set;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @deprecated
+ */
+class TemplateParserTest extends TestCase
+{
+    public function testParseBase64()
+    {
+        $sequence = Sequence::create([
+            Set::create([
+                ObjectIdentifier::create('1.2.250.1.16.9'),
+                Sequence::create([
+                    Integer::create(42),
+                    BitString::createFromHexString('A0120043'),
+                ])
+            ])
+        ]);
+
+        $data = base64_encode($sequence->getBinary());
+
+        $template = [
+            Identifier::SEQUENCE => [
+                Identifier::SET => [
+                    Identifier::OBJECT_IDENTIFIER,
+                    Identifier::SEQUENCE => [
+                        Identifier::INTEGER,
+                        Identifier::BITSTRING,
+                    ],
+                ],
+            ],
+        ];
+
+        $parser = new TemplateParser();
+        $object = $parser->parseBase64($data, $template);
+        $this->assertInstanceOf(Set::class, $object->getChildren()[0]);
+        $this->assertInstanceOf(ObjectIdentifier::class, $object->getChildren()[0]->getChildren()[0]);
+        $this->assertInstanceOf(Sequence::class, $object->getChildren()[0]->getChildren()[1]);
+        $this->assertInstanceOf(Integer::class, $object->getChildren()[0]->getChildren()[1]->getChildren()[0]);
+        $this->assertInstanceOf(BitString::class, $object->getChildren()[0]->getChildren()[1]->getChildren()[1]);
+    }
+}