Badcow\DNS\Rdata\DHCID

Complexity

Total Complexity

24

Size/Duplication

Total Lines	233
Duplicated Lines	0 %

Test Coverage

Coverage

80%

Importance

Changes	1
Bugs	0	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	getDigest()	0	3	1
A	setFqdn()	0	6	2
A	getIdentifierType()	0	3	1
A	getFqdn()	0	3	1
A	getHtype()	0	3	1
A	setIdentifier()	0	4	1
A	setIdentifierType()	0	6	2
A	fromText()	0	12	2
A	setHtype()	0	6	2
A	getDigestType()	0	3	1
A	setDigest()	0	3	1
A	toText()	0	3	1
A	toWire()	0	7	2
A	calculateDigest()	0	13	4
A	fromWire()	0	10	1
A	getIdentifier()	0	3	1

<?php

declare(strict_types=1);

/*
 * This file is part of Badcow DNS Library.
 *
 * (c) Samuel Williams <sam@badcow.co>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Badcow\DNS\Rdata;

use Badcow\DNS\Validator;

/**
 * {@link https://tools.ietf.org/html/rfc4701}.
 */
class DHCID implements RdataInterface
{
    use RdataTrait;

    const TYPE = 'DHCID';
    const TYPE_CODE = 49;

    /**
     * 16-bit DHCID RR Identifier Type Code specifies what data from the DHCP
     * client's request was used as input into the hash function.
     *
     * @var int
     */
    private $identifierType;

    /**
     * The 1-octet 'htype' followed by 'hlen' octets of 'chaddr' from a DHCPv4
     * client's DHCPREQUEST.
     *
     * The data octets (i.e., the Type and Client-Identifier fields) from a
     * DHCPv4 client's Client Identifier option.
     *
     * The client's DUID (i.e., the data octets of a DHCPv6 client's Client
     * Identifier option or the DUID field from a DHCPv4 client's Client
     * Identifier option).
     *
     * @var string
     */
    private $identifier;

    /**
     * Hardware Type {@link https://tools.ietf.org/html/rfc2131}.
     *
     * @var int Hardware type used if identifier is DHCPv4 DHCPREQUEST carrying client hardware address (chaddr or MAC)
     */
    private $htype = 1;

    /**
     * The Fully Qualified Domain Name of the DHCP client.
     *
     * @var string
     */
    private $fqdn;

    /**
     * The digest type. Only one type is defined by IANA, SHA256 with value 1.
     *
     * @var int
     */
    private $digestType = 1;

    /**
     * @var string
     */
    private $digest;

    /**
     * @param int $identifierType
     */
    public function setIdentifierType(int $identifierType): void
    {
        if (!Validator::isUnsignedInteger($identifierType, 16)) {
            throw new \InvalidArgumentException('Identifier type must be a 16-bit integer.');
        }
        $this->identifierType = $identifierType;
    }

    /**
     * @return int
     */
    public function getIdentifierType(): int
    {
        return $this->identifierType;
    }

    /**
     * @return string
     */
    public function getIdentifier(): string
    {
        return $this->identifier;
    }

    /**
     * @return int
     */
    public function getHtype(): int
    {
        return $this->htype;
    }

    /**
     * @param int $htype
     */
    public function setHtype(int $htype): void
    {
        if (!Validator::isUnsignedInteger($htype, 8)) {
            throw new \InvalidArgumentException('HType must be an 8-bit integer.');
        }
        $this->htype = $htype;
    }

    /**
     * @param int    $identifierType
     * @param string $identifier
     *
     * @throws \InvalidArgumentException
     */
    public function setIdentifier(int $identifierType, string $identifier): void
    {
        $this->setIdentifierType($identifierType);
        $this->identifier = $identifier;
    }

    /**
     * @return string
     */
    public function getFqdn(): string
    {
        return $this->fqdn;
    }

    /**
     * @param string $fqdn
     */
    public function setFqdn(string $fqdn): void
    {
        if (!Validator::fullyQualifiedDomainName($fqdn)) {
            throw new \InvalidArgumentException(sprintf('"%s" is not a fully qualified domain name.', $fqdn));
        }
        $this->fqdn = $fqdn;
    }

    /**
     * @return int
     */
    public function getDigestType(): int
    {
        return $this->digestType;
    }

    /**
     * @return string Digest as hexadecimal string
     */
    public function getDigest(): string
    {
        return $this->digest;
    }

    /**
     * @param string $digest Digest as hexadecimal string
     */
    public function setDigest(string $digest): void
    {
        $this->digest = $digest;
    }

    /**
     * Calculate the digest from the identifier and fully qualified domain name already set on the object.
     *
     * @throws \BadMethodCallException
     */
    public function calculateDigest(): void
    {
        if (null === $this->identifier || null === $this->fqdn) {
            throw new \BadMethodCallException('Identifier and Fully Qualified Domain Name (FQDN) must both be set on DHCID object before calling calculateDigest().');
        }

        $fqdn = self::encodeName($this->fqdn);
        $identifier = pack('H*', str_replace(':', '', strtolower($this->identifier)));
        if (0 === $this->identifierType) {
            $identifier = chr($this->htype).$identifier;
        }

        $this->digest = hash('sha256', $identifier.$fqdn);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \BadMethodCallException
     */
    public function toText(): string
    {
        return base64_encode($this->toWire());
    }

    /**
     * {@inheritdoc}
     */
    public function toWire(): string
    {
        if (null === $this->digest) {
            $this->calculateDigest();
        }

        return pack('nCH*', $this->identifierType, $this->digestType, $this->digest);
    }

    /**
     * {@inheritdoc}
     *
     * @return DHCID
     *
     * @throws \Exception
     */
    public static function fromText(string $text): RdataInterface
    {
        if (false === $decoded = base64_decode($text, true)) {
            throw new \Exception(sprintf('Unable to base64 decode text "%s".', $text));
        }

        $rdata = unpack('nIdentifierType/CDigestType/H*Digest', $decoded);
        $dhcid = new self();
        $dhcid->setIdentifierType((int) $rdata['IdentifierType']);
        $dhcid->setDigest((string) $rdata['Digest']);

        return $dhcid;
    }

    /**
     * {@inheritdoc}
     */
    public static function fromWire(string $rdata, int &$offset = 0, ?int $rdLength = null): RdataInterface
    {
        $rdLength = $rdLength ?? strlen($rdata);
        $rdata = unpack('nIdentifierType/CDigestType/H*Digest', substr($rdata, $offset, $rdLength));
        $dhcid = new self();
        $dhcid->setIdentifierType((int) $rdata['IdentifierType']);
        $dhcid->setDigest((string) $rdata['Digest']);
        $offset += $rdLength;

        return $dhcid;
    }
}