Sop\ASN1\Component\Identifier

Complexity

Total Complexity

27

Size/Duplication

Total Lines	298
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	withTag()	0	5	1
A	isContextSpecific()	0	3	1
A	withClass()	0	5	1
A	toDER()	0	22	4
A	__construct()	0	5	1
A	isConstructed()	0	3	1
A	intTag()	0	3	1
A	typeClass()	0	3	1
A	pc()	0	3	1
A	isUniversal()	0	3	1
A	isPrimitive()	0	3	1
A	isApplication()	0	3	1
A	tag()	0	3	1
A	_decodeLongFormTag()	0	19	4
A	fromDER()	0	23	4
A	isPrivate()	0	3	1
A	classToName()	0	6	2

<?php

declare(strict_types = 1);

namespace Sop\ASN1\Component;

use Sop\ASN1\Exception\DecodeException;
use Sop\ASN1\Feature\Encodable;
use Sop\ASN1\Util\BigInt;

/**
 * Class to represent BER/DER identifier octets.
 */
class Identifier implements Encodable
{
    // Type class enumerations
    const CLASS_UNIVERSAL = 0b00;
    const CLASS_APPLICATION = 0b01;
    const CLASS_CONTEXT_SPECIFIC = 0b10;
    const CLASS_PRIVATE = 0b11;

    /**
     * Mapping from type class to human readable name.
     *
     * @internal
     *
     * @var array
     */
    const MAP_CLASS_TO_NAME = [
        self::CLASS_UNIVERSAL => 'UNIVERSAL',
        self::CLASS_APPLICATION => 'APPLICATION',
        self::CLASS_CONTEXT_SPECIFIC => 'CONTEXT SPECIFIC',
        self::CLASS_PRIVATE => 'PRIVATE',
    ];

    // P/C enumerations
    const PRIMITIVE = 0b0;
    const CONSTRUCTED = 0b1;

    /**
     * Type class.
     *
     * @var int
     */
    private $_class;

    /**
     * Primitive or Constructed.
     *
     * @var int
     */
    private $_pc;

    /**
     * Content type tag.
     *
     * @var BigInt
     */
    private $_tag;

    /**
     * Constructor.
     *
     * @param int        $class Type class
     * @param int        $pc    Primitive / Constructed
     * @param int|string $tag   Type tag number
     */
    public function __construct(int $class, int $pc, $tag)
    {
        $this->_class = 0b11 & $class;
        $this->_pc = 0b1 & $pc;
        $this->_tag = new BigInt($tag);
    }

    /**
     * Decode identifier component from DER data.
     *
     * @param string   $data   DER encoded data
     * @param null|int $offset Reference to the variable that contains offset
     *                         into the data where to start parsing.
     *                         Variable is updated to the offset next to the
     *                         parsed identifier. If null, start from offset 0.
     *
     * @throws DecodeException If decoding fails
     *
     * @return self
     */
    public static function fromDER(string $data, int &$offset = null): Identifier
    {
        $idx = $offset ?? 0;
        $datalen = strlen($data);
        if ($idx >= $datalen) {
            throw new DecodeException('Invalid offset.');
        }
        $byte = ord($data[$idx++]);
        // bits 8 and 7 (class)
        // 0 = universal, 1 = application, 2 = context-specific, 3 = private
        $class = (0b11000000 & $byte) >> 6;
        // bit 6 (0 = primitive / 1 = constructed)
        $pc = (0b00100000 & $byte) >> 5;
        // bits 5 to 1 (tag number)
        $tag = (0b00011111 & $byte);
        // long-form identifier
        if (0x1f === $tag) {
            $tag = self::_decodeLongFormTag($data, $idx);
        }
        if (isset($offset)) {
            $offset = $idx;
        }
        return new self($class, $pc, $tag);
    }

    /**
     * {@inheritdoc}
     */
    public function toDER(): string
    {
        $bytes = [];
        $byte = $this->_class << 6 | $this->_pc << 5;
        $tag = $this->_tag->gmpObj();
        if ($tag < 0x1f) {
            $bytes[] = $byte | $tag;
        }
        // long-form identifier
        else {
            $bytes[] = $byte | 0x1f;
            $octets = [];
            for (; $tag > 0; $tag >>= 7) {
                array_push($octets, gmp_intval(0x80 | ($tag & 0x7f)));
            }
            // last octet has bit 8 set to zero
            $octets[0] &= 0x7f;
            foreach (array_reverse($octets) as $octet) {
                $bytes[] = $octet;
            }
        }
        return pack('C*', ...$bytes);
    }

    /**
     * Get class of the type.
     *
     * @return int
     */
    public function typeClass(): int
    {
        return $this->_class;
    }

    /**
     * Get P/C.
     *
     * @return int
     */
    public function pc(): int
    {
        return $this->_pc;
    }

    /**
     * Get the tag number.
     *
     * @return string Base 10 integer string
     */
    public function tag(): string
    {
        return $this->_tag->base10();
    }

    /**
     * Get the tag as an integer.
     *
     * @return int
     */
    public function intTag(): int
    {
        return $this->_tag->intVal();
    }

    /**
     * Check whether type is of an universal class.
     *
     * @return bool
     */
    public function isUniversal(): bool
    {
        return self::CLASS_UNIVERSAL === $this->_class;
    }

    /**
     * Check whether type is of an application class.
     *
     * @return bool
     */
    public function isApplication(): bool
    {
        return self::CLASS_APPLICATION === $this->_class;
    }

    /**
     * Check whether type is of a context specific class.
     *
     * @return bool
     */
    public function isContextSpecific(): bool
    {
        return self::CLASS_CONTEXT_SPECIFIC === $this->_class;
    }

    /**
     * Check whether type is of a private class.
     *
     * @return bool
     */
    public function isPrivate(): bool
    {
        return self::CLASS_PRIVATE === $this->_class;
    }

    /**
     * Check whether content is primitive type.
     *
     * @return bool
     */
    public function isPrimitive(): bool
    {
        return self::PRIMITIVE === $this->_pc;
    }

    /**
     * Check hether content is constructed type.
     *
     * @return bool
     */
    public function isConstructed(): bool
    {
        return self::CONSTRUCTED === $this->_pc;
    }

    /**
     * Get self with given type class.
     *
     * @param int $class One of `CLASS_*` enumerations
     *
     * @return self
     */
    public function withClass(int $class): Identifier
    {
        $obj = clone $this;
        $obj->_class = 0b11 & $class;
        return $obj;
    }

    /**
     * Get self with given type tag.
     *
     * @param int|string $tag Tag number
     *
     * @return self
     */
    public function withTag($tag): Identifier
    {
        $obj = clone $this;
        $obj->_tag = new BigInt($tag);
        return $obj;
    }

    /**
     * Get human readable name of the type class.
     *
     * @param int $class
     *
     * @return string
     */
    public static function classToName(int $class): string
    {
        if (!array_key_exists($class, self::MAP_CLASS_TO_NAME)) {
            return "CLASS {$class}";
        }
        return self::MAP_CLASS_TO_NAME[$class];
    }

    /**
     * Parse long form tag.
     *
     * @param string $data   DER data
     * @param int    $offset Reference to the variable containing offset to data
     *
     * @throws DecodeException If decoding fails
     *
     * @return string Tag number
     */
    private static function _decodeLongFormTag(string $data, int &$offset): string
    {
        $datalen = strlen($data);
        $tag = gmp_init(0, 10);
        while (true) {
            if ($offset >= $datalen) {
                throw new DecodeException(
                    'Unexpected end of data while decoding' .
                    ' long form identifier.');
            }
            $byte = ord($data[$offset++]);
            $tag <<= 7;
            $tag |= 0x7f & $byte;
            // last byte has bit 8 set to zero
            if (!(0x80 & $byte)) {
                break;
            }
        }
        return gmp_strval($tag, 10);
    }
}