Sop\X509\Certificate\Extension\CertificatePolicy\PolicyInformation

Complexity

Total Complexity

20

Size/Duplication

Total Lines	207
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	CPSQualifier()	0	6	2
A	has()	0	3	1
A	hasUserNoticeQualifier()	0	3	1
A	hasCPSQualifier()	0	3	1
A	oid()	0	3	1
A	__construct()	0	6	2
A	isAnyPolicy()	0	3	1
A	qualifiers()	0	3	1
A	fromASN1()	0	11	2
A	toASN1()	0	11	2
A	getIterator()	0	3	1
A	get()	0	6	2
A	count()	0	3	1
A	userNoticeQualifier()	0	6	2

<?php

declare(strict_types = 1);

namespace Sop\X509\Certificate\Extension\CertificatePolicy;

use Sop\ASN1\Type\Constructed\Sequence;
use Sop\ASN1\Type\Primitive\ObjectIdentifier;
use Sop\ASN1\Type\UnspecifiedType;

/**
 * Implements *PolicyInformation* ASN.1 type used by 'Certificate Policies'
 * certificate extension.
 *
 * @see https://tools.ietf.org/html/rfc5280#section-4.2.1.4
 */
class PolicyInformation implements \Countable, \IteratorAggregate
{
    /**
     * Wildcard policy.
     *
     * @var string
     */
    const OID_ANY_POLICY = '2.5.29.32.0';

    /**
     * Policy identifier.
     *
     * @var string
     */
    protected $_oid;

    /**
     * Policy qualifiers.
     *
     * @var PolicyQualifierInfo[]
     */
    protected $_qualifiers;

    /**
     * Constructor.
     *
     * @param string              $oid
     * @param PolicyQualifierInfo ...$qualifiers
     */
    public function __construct(string $oid, PolicyQualifierInfo ...$qualifiers)
    {
        $this->_oid = $oid;
        $this->_qualifiers = [];
        foreach ($qualifiers as $qual) {
            $this->_qualifiers[$qual->oid()] = $qual;
        }
    }

    /**
     * Initialize from ASN.1.
     *
     * @param Sequence $seq
     *
     * @return self
     */
    public static function fromASN1(Sequence $seq): self
    {
        $oid = $seq->at(0)->asObjectIdentifier()->oid();
        $qualifiers = [];
        if (count($seq) > 1) {
            $qualifiers = array_map(
                function (UnspecifiedType $el) {
                    return PolicyQualifierInfo::fromASN1($el->asSequence());
                }, $seq->at(1)->asSequence()->elements());
        }
        return new self($oid, ...$qualifiers);
    }

    /**
     * Get policy identifier.
     *
     * @return string
     */
    public function oid(): string
    {
        return $this->_oid;
    }

    /**
     * Check whether this policy is anyPolicy.
     *
     * @return bool
     */
    public function isAnyPolicy(): bool
    {
        return self::OID_ANY_POLICY === $this->_oid;
    }

    /**
     * Get policy qualifiers.
     *
     * @return PolicyQualifierInfo[]
     */
    public function qualifiers(): array
    {
        return array_values($this->_qualifiers);
    }

    /**
     * Check whether qualifier is present.
     *
     * @param string $oid
     *
     * @return bool
     */
    public function has(string $oid): bool
    {
        return isset($this->_qualifiers[$oid]);
    }

    /**
     * Get qualifier by OID.
     *
     * @param string $oid
     *
     * @throws \LogicException IF not set
     *
     * @return PolicyQualifierInfo
     */
    public function get(string $oid): PolicyQualifierInfo
    {
        if (!$this->has($oid)) {
            throw new \LogicException("No {$oid} qualifier.");
        }
        return $this->_qualifiers[$oid];
    }

    /**
     * Check whether CPS qualifier is present.
     *
     * @return bool
     */
    public function hasCPSQualifier(): bool
    {
        return $this->has(PolicyQualifierInfo::OID_CPS);
    }

    /**
     * Get CPS qualifier.
     *
     * @throws \LogicException If not set
     *
     * @return CPSQualifier
     */
    public function CPSQualifier(): CPSQualifier
    {
        if (!$this->hasCPSQualifier()) {
            throw new \LogicException('CPS qualifier not set.');
        }
        return $this->get(PolicyQualifierInfo::OID_CPS);
    }

    /**
     * Check whether user notice qualifier is present.
     *
     * @return bool
     */
    public function hasUserNoticeQualifier(): bool
    {
        return $this->has(PolicyQualifierInfo::OID_UNOTICE);
    }

    /**
     * Get user notice qualifier.
     *
     * @throws \LogicException If not set
     *
     * @return UserNoticeQualifier
     */
    public function userNoticeQualifier(): UserNoticeQualifier
    {
        if (!$this->hasUserNoticeQualifier()) {
            throw new \LogicException('User notice qualifier not set.');
        }
        return $this->get(PolicyQualifierInfo::OID_UNOTICE);
    }

    /**
     * Get ASN.1 structure.
     *
     * @return Sequence
     */
    public function toASN1(): Sequence
    {
        $elements = [new ObjectIdentifier($this->_oid)];
        if (count($this->_qualifiers)) {
            $qualifiers = array_map(
                function (PolicyQualifierInfo $pqi) {
                    return $pqi->toASN1();
                }, array_values($this->_qualifiers));
            $elements[] = new Sequence(...$qualifiers);
        }
        return new Sequence(...$elements);
    }

    /**
     * Get number of qualifiers.
     *
     * @see \Countable::count()
     *
     * @return int
     */
    public function count(): int
    {
        return count($this->_qualifiers);
    }

    /**
     * Get iterator for qualifiers.
     *
     * @see \IteratorAggregate::getIterator()
     *
     * @return \ArrayIterator
     */
    public function getIterator(): \ArrayIterator
    {
        return new \ArrayIterator($this->_qualifiers);
    }
}