Subversion Repositories oidplus

<?php

/*

 * OIDplus 2.0

 * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *     http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

namespace ViaThinkSoft\OIDplus;

// phpcs:disable PSR1.Files.SideEffects

\defined('INSIDE_OIDPLUS') or die;

// phpcs:enable PSR1.Files.SideEffects

class OIDplusOid extends OIDplusObject {

        /**

         * @var string

         */

        private $oid;

        /**

         * @param string $oid

         * @throws OIDplusException

         */

        public function __construct(string $oid) {

                $bak_oid = $oid;

                $oid = sanitizeOID($oid, 'auto');

                if ($oid === false) {

                        throw new OIDplusException(_L('Invalid OID %1',$bak_oid));

                }

                if (($oid != '') && (!oid_valid_dotnotation($oid, false, true, 0))) {

                        // avoid OIDs like 3.0

                        throw new OIDplusException(_L('Invalid OID %1',$bak_oid));

                }

                $this->oid = $oid;

        }

        /**

         * @param string $node_id

         * @return OIDplusOid|null

         * @throws OIDplusException

         */

        public static function parse(string $node_id)/*: ?OIDplusOid*/ {

                @list($namespace, $oid) = explode(':', $node_id, 2);

                if ($namespace !== self::ns()) return null;

                return new self($oid);

        }

        /**

         * @return string

         */

        public static function objectTypeTitle(): string {

                return _L('Object Identifier (OID)');

        }

        /**

         * @return string

         */

        public static function objectTypeTitleShort(): string {

                return _L('OID');

        }

        /**

         * @return string

         */

        public static function ns(): string {

                return 'oid';

        }

        /**

         * @return string

         */

        public static function root(): string {

                return self::ns().':';

        }

        /**

         * @return bool

         */

        public function isRoot(): bool {

                return $this->oid == '';

        }

        /**

         * @param bool $with_ns

         * @return string

         */

        public function nodeId(bool $with_ns=true): string {

                return $with_ns ? self::root().$this->oid : $this->oid;

        }

        /**

         * @param string $str

         * @return string

         * @throws OIDplusException

         */

        public function addString(string $str): string {

                if (!$this->isRoot()) {

                        if (strpos($str,'.') !== false) throw new OIDplusException(_L('Please only submit one arc (not an absolute OID or multiple arcs).'));

                }

                return $this->appendArcs($str)->nodeId();

        }

        /**

         * @param OIDplusObject $parent

         * @return string

         */

        public function crudShowId(OIDplusObject $parent): string {

                if ($parent instanceof OIDplusOid) {

                        return $this->deltaDotNotation($parent);

                } else {

                        return '';

                }

        }

        /**

         * @param OIDplusObject|null $parent

         * @return string

         * @throws OIDplusException

         */

        public function jsTreeNodeName(OIDplusObject $parent = null): string {

                if ($parent == null) return $this->objectTypeTitle();

                if ($parent instanceof OIDplusOid) {

                        return $this->viewGetArcAsn1s($parent);

                } else {

                        return '';

                }

        }

        /**

         * @return string

         */

        public function defaultTitle(): string {

                return _L('OID %1',$this->oid);

        }

        /**

         * @return bool

         */

        public function isLeafNode(): bool {

                return false;

        }

        /**

         * @return array

         * @throws OIDplusException

         */

        private function getTechInfo(): array {

                $tech_info = array();

                $tmp = _L('Dot notation');

                $tmp = str_replace(explode(' ', $tmp, 2)[0], '<a href="https://oid-rep.orange-labs.fr/faq.htm#14" target="_blank">'.explode(' ', $tmp, 2)[0].'</a>', $tmp);

                $tech_info[$tmp] = $this->getDotNotation();

                $tmp = _L('ASN.1 notation');

                $tmp = str_replace(explode(' ', $tmp, 2)[0], '<a href="https://oid-rep.orange-labs.fr/faq.htm#17" target="_blank">'.explode(' ', $tmp, 2)[0].'</a>', $tmp);

                $tech_info[$tmp] = $this->getAsn1Notation();

                $tmp = _L('OID-IRI notation');

                $tmp = str_replace(explode(' ', $tmp, 2)[0], '<a href="https://oid-rep.orange-labs.fr/faq.htm#iri" target="_blank">'.explode(' ', $tmp, 2)[0].'</a>', $tmp);

                $tech_info[$tmp] = $this->getIriNotation();

                $tmp = _L('WEID notation');

                $tmp = str_replace(explode(' ', $tmp, 2)[0], '<a href="https://weid.info/" target="_blank">'.explode(' ', $tmp, 2)[0].'</a>', $tmp);

                $tech_info[$tmp] = $this->getWeidNotation();

                $tmp = _L('DER encoding');

                $tmp = str_replace(explode(' ', $tmp, 2)[0], '<a href="https://misc.daniel-marschall.de/asn.1/oid-converter/online.php" target="_blank">'.explode(' ', $tmp, 2)[0].'</a>', $tmp);

                $tech_info[$tmp] = str_replace(' ', ':', \OidDerConverter::hexarrayToStr(\OidDerConverter::oidToDER($this->nodeId(false))));

                return $tech_info;

        }

        /**

         * @return bool

         */

        protected function isClassCWeid(): bool {

                $dist = oid_distance($this->oid, '1.3.6.1.4.1.37553.8');

                if ($dist === false) return false;

                return $dist >= 0;

        }

        /**

         * @param string $title

         * @param string $content

         * @param string $icon

         * @return void

         * @throws OIDplusException

         */

        public function getContentPage(string &$title, string &$content, string &$icon) {

                if ($this->isClassCWeid()) {

                        // TODO: Also change treeview menu mini-icon?

                        $icon = file_exists(__DIR__.'/img/weid_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/weid_icon.png' : '';

                } else {

                        $icon = file_exists(__DIR__.'/img/main_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon.png' : '';

                }

                if ($this->isRoot()) {

                        $title = OIDplusOid::objectTypeTitle();

                        $res = OIDplus::db()->query("select id from ###objects where parent = ?", array(self::root()));

                        if ($res->any()) {

                                $content = _L('Please select an OID in the tree view at the left to show its contents.');

                        } else {

                                $content = _L('Currently, no OID is registered in the system.');

                        }

                        if (!$this->isLeafNode()) {

                                if (OIDplus::authUtils()->isAdminLoggedIn()) {

                                        $content .= '<h2>'._L('Manage your root OIDs').'</h2>';

                                } else {

                                        $content .= '<h2>'._L('Root OIDs').'</h2>';

                                }

                                $content .= '%%CRUD%%';

                        }

                } else {

                        $title = $this->getTitle();

                        $tech_info = $this->getTechInfo();

                        $tech_info_html = '';

                        if (count($tech_info) > 0) {

                                $tech_info_html .= '<h2>'._L('Technical information').'</h2>';

                                $tech_info_html .= '<table border="0">';

                                foreach ($tech_info as $key => $value) {

                                        $tech_info_html .= '<tr><td>'.$key.': </td><td><code>'.$value.'</code></td></tr>';

                                }

                                $tech_info_html .= '</table>';

                        }

                        $content = $tech_info_html;

                        $content .= '<h2>'._L('Description').'</h2>%%DESC%%'.

                                    '<h2>'._L('Registration Authority').'</h2>%%RA_INFO%%';

                        if (!$this->isLeafNode()) {

                                if ($this->userHasWriteRights()) {

                                        $content .= '<h2>'._L('Create or change subordinate objects').'</h2>';

                                } else {

                                        $content .= '<h2>'._L('Subordinate objects').'</h2>';

                                }

                                $content .= '%%CRUD%%';

                        }

                }

        }

        # ---

        /**

         * Gets the last arc of an WEID

         * @return false|string

         */

        public function weidArc() {

                // Dirty hack: We prepend '0.' in front of the OID to enforce the

                //             creation of a Class A weid (weid:root:) . Otherwise we could not

                //             get the hidden arc value "8" from "weid:4" (which is actually "weid:pen:SZ5-8-?"

                $weid = \Frdl\Weid\WeidOidConverter::oid2weid('0.'.$this->getDotNotation());

                if ($weid === false) return false;

                $ary = explode(':', $weid);

                $weid = array_pop($ary); // remove namespace and sub-namespace if existing

                $x = explode('-', $weid);

                if (count($x) < 2) return ''; // WEID root arc. Has no name

                return $x[count($x)-2];

        }

        /**

         * @param bool $withAbbr

         * @return string

         */

        public function getWeidNotation(bool $withAbbr=true): string {

                $weid = \Frdl\Weid\WeidOidConverter::oid2weid($this->getDotNotation());

                if ($withAbbr) {

                        $ary = explode(':', $weid);

                        $weid = array_pop($ary); // remove namespace and sub-namespace if existing

                        $ns = implode(':', $ary).':';

                        $weid_arcs = explode('-', $weid);

                        foreach ($weid_arcs as $i => &$weid) {

                                if ($i == count($weid_arcs)-1) {

                                        $weid = '<abbr title="'._L('weLuhn check digit').'">'.$weid.'</abbr>';

                                } else {

                                        $oid_arcs = explode('.',$this->oid);

                                        $weid_num = $oid_arcs[(count($oid_arcs)-1)-(count($weid_arcs)-1)+($i+1)];

                                        if ($weid_num != $weid) {

                                                $weid = '<abbr title="'._L('Numeric value').': '.$weid_num.'">'.$weid.'</abbr>';

                                        }

                                }

                        }

                        $base_arc = '???';

                        if ($ns === 'weid:')      $base_arc = '1.3.6.1.4.1.37553.8';

                        if ($ns === 'weid:pen:')  $base_arc = '1.3.6.1.4.1';

                        if ($ns === 'weid:root:') $base_arc = _L('OID tree root');

                        $weid = '<abbr title="'._L('Base OID').': '.$base_arc.'">' . rtrim($ns,':') . '</abbr>:' . implode('-',$weid_arcs);

                }

                return $weid;

        }

        /**

         * @param string|int $arcs

         * @return OIDplusOid

         * @throws OIDplusException

         */

        public function appendArcs($arcs): OIDplusOid {

                $out = new self($this->oid);

                if ($out->isRoot()) {

                        $out->oid .= $arcs;

                } else {

                        $out->oid .= '.' . $arcs;

                }

                $bak_oid = $out->oid;

                $out->oid = sanitizeOID($out->oid);

                if ($out->oid === false) throw new OIDplusException(_L('%1 is not a valid OID!',$bak_oid));

                $maxlen = OIDplus::baseConfig()->getValue('LIMITS_MAX_ID_LENGTH')-strlen(self::root());

                if (strlen($out->oid) > $maxlen) {

                        throw new OIDplusException(_L('The resulting OID "%1" is too long (max allowed length: %2).',$out->oid,$maxlen));

                }

                $depth = 0;

                foreach (explode('.',$out->oid) as $arc) {

                        if (strlen($arc) > OIDplus::baseConfig()->getValue('LIMITS_MAX_OID_ARC_SIZE')) {

                                $maxlen = OIDplus::baseConfig()->getValue('LIMITS_MAX_OID_ARC_SIZE');

                                throw new OIDplusException(_L('Arc "%1" is too long and therefore cannot be appended to the OID "%2" (max allowed arc size is "%3")',$arc,$this->oid,$maxlen));

                        }

                        $depth++;

                }

                if ($depth > OIDplus::baseConfig()->getValue('LIMITS_MAX_OID_DEPTH')) {

                        $maxdepth = OIDplus::baseConfig()->getValue('LIMITS_MAX_OID_DEPTH');

                        throw new OIDplusException(_L('OID %1 has too many arcs (current depth %2, max depth %3)',$out->oid,$depth,$maxdepth));

                }

                return $out;

        }

        /**

         * @param OIDplusOid $parent

         * @return false|string

         */

        public function deltaDotNotation(OIDplusOid $parent) {

                if (!$parent->isRoot()) {

                        if (substr($this->oid, 0, strlen($parent->oid)+1) == $parent->oid.'.') {

                                return substr($this->oid, strlen($parent->oid)+1);

                        } else {

                                return false;

                        }

                } else {

                        return $this->oid;

                }

        }

        /**

         * @return array

         * @throws OIDplusException

         */

        public function getAsn1Ids(): array {

                $asn_ids = array();

                $res_asn = OIDplus::db()->query("select * from ###asn1id where oid = ? order by lfd", array("oid:".$this->oid));

                while ($row_asn = $res_asn->fetch_array()) {

                        $name = $row_asn['name'];

                        $standardized = $row_asn['standardized'] ?? false;

                        $well_known = $row_asn['well_known'] ?? false;

                        $asn_ids[] = new OIDplusOidAsn1Id($name, $standardized, $well_known);

                }

                return $asn_ids;

        }

        /**

         * @return array

         * @throws OIDplusException

         */

        public function getIris(): array {

                $iri_ids = array();

                $res_iri = OIDplus::db()->query("select * from ###iri where oid = ? order by lfd", array("oid:".$this->oid));

                while ($row_iri = $res_iri->fetch_array()) {

                        $name = $row_iri['name'];

                        $longarc = $row_iri['longarc'] ?? false;

                        $well_known = $row_iri['well_known'] ?? false;

                        $iri_ids[] = new OIDplusOidIri($name, $longarc, $well_known);

                }

                return $iri_ids;

        }

        /**

         * @param OIDplusOid|null $parent

         * @param string $separator

         * @return string

         * @throws OIDplusException

         */

        public function viewGetArcAsn1s(OIDplusOid $parent=null, string $separator = ' | '): string {

                $asn_ids = array();

                if (is_null($parent)) $parent = OIDplusOid::parse(self::root());

                $part = $this->deltaDotNotation($parent);

                if (strpos($part, '.') === false) {

                        $asn_id_objs = $this->getAsn1Ids();

                        foreach ($asn_id_objs as $asn_id_obj) {

                                $asn_ids[] = $asn_id_obj->getName().'('.$part.')';

                        }

                }

                if (count($asn_ids) == 0) $asn_ids = array($part);

                return implode($separator, $asn_ids);

        }

        /**

         * @param bool $withAbbr

         * @return string

         * @throws OIDplusException

         */

        public function getAsn1Notation(bool $withAbbr=true): string {

                $asn1_notation = '';

                $arcs = explode('.', $this->oid);

                foreach ($arcs as $arc) {

                        $res = OIDplus::db()->query("select name, standardized from ###asn1id where oid = ? order by lfd", array(self::root().implode('.',$arcs)));

                        $names = array();

                        while ($row = $res->fetch_array()) {

                                $names[] = $row['name']."(".end($arcs).")";

                                if ($row['standardized']) {

                                        $names[] = $row['name'];

                                }

                        }

                        $numeric = array_pop($arcs);

                        if (count($names) > 1) {

                                $first_name = array_shift($names);

                                $abbr = _L('Other identifiers').':
      '.implode('
      ',$names);

                                if ($withAbbr) {

                                        $asn1_notation = '<abbr title="'.$abbr.'">'.$first_name.'</abbr> '.$asn1_notation;

                                } else {

                                        $asn1_notation = $first_name.' '.$asn1_notation;

                                }

                        } else if (count($names) == 1) {

                                $asn1_notation = array_shift($names).' '.$asn1_notation;

                        } else {

                                $asn1_notation = $numeric.' '.$asn1_notation;

                        }

                }

                return "{ ".trim($asn1_notation)." }";

        }

        /**

         * @param bool $withAbbr

         * @return string

         * @throws OIDplusException

         */

        public function getIriNotation(bool $withAbbr=true): string {

                $iri_notation = '';

                $arcs = explode('.', $this->oid);

                foreach ($arcs as $arc) {

                        $res = OIDplus::db()->query("select name, longarc from ###iri where oid = ? order by lfd", array(self::root().implode('.',$arcs)));

                        $is_longarc = false;

                        $names = array();

                        while ($row = $res->fetch_array()) {

                                $is_longarc = $row['longarc'];

                                $names[] = $row['name'];

                                if ($is_longarc) {

                                        $names[] = 'Joint-ISO-ITU-T/'.$row['name']; // Long arcs can only be inside root OID 2

                                }

                        }

                        $names[] = array_pop($arcs);

                        if (count($names) > 2) {

                                $first_name = array_shift($names);

                                $numeric = array_pop($names);

                                $abbr = _L('Other identifiers').':
      '.implode('
      ',$names).'
'._L('Numeric value').': '.$numeric;

                                $iri_notation = $withAbbr ? '<abbr title="'.$abbr.'">'.$first_name.'</abbr>/'.$iri_notation : $first_name.'/'.$iri_notation;

                        } else if (count($names) > 1) {

                                $first_name = array_shift($names);

                                $abbr = _L('Numeric value').': '.array_shift($names);

                                $iri_notation = $withAbbr ? '<abbr title="'.$abbr.'">'.$first_name.'</abbr>/'.$iri_notation : $first_name.'/'.$iri_notation;

                        } else if (count($names) == 1) {

                                $iri_notation = array_shift($names) . '/' . $iri_notation;

                        }

                        if ($is_longarc) break; // we don't write /ITU-T/ at the beginning, when /ITU-T/xyz is a long arc

                }

                return '/' . substr($iri_notation, 0, strlen($iri_notation)-1);

        }

        /**

         * @return string

         */

        public function getDotNotation(): string {

                return $this->oid;

        }

        /**

         * @return bool

         * @throws OIDplusException

         */

        public function isWellKnown(): bool {

                $res = OIDplus::db()->query("select oid from ###asn1id where oid = ? and well_known = ?", array("oid:".$this->oid,true));

                if ($res->any()) return true;

                $res = OIDplus::db()->query("select oid from ###iri where oid = ? and well_known = ?", array("oid:".$this->oid,true));

                if ($res->any()) return true;

                return false;

        }

        /**

         * @param array $demandedASN1s

         * @param bool $simulate

         * @return void

         * @throws OIDplusException

         */

        public function replaceAsn1Ids(array $demandedASN1s=array(), bool $simulate=false) {

                if ($this->isWellKnown()) {

                        throw new OIDplusException(_L('OID "%1" is a "well-known" OID. Its identifiers cannot be changed.',$this->oid));

                }

                // First do a few checks

                foreach ($demandedASN1s as &$asn1) {

                        $asn1 = trim($asn1);

                        if (strlen($asn1) > OIDplus::baseConfig()->getValue('LIMITS_MAX_OID_ASN1_ID_LEN')) {

                                $maxlen = OIDplus::baseConfig()->getValue('LIMITS_MAX_OID_ASN1_ID_LEN');

                                throw new OIDplusException(_L('ASN.1 alphanumeric identifier "%1" is too long (max allowed length %2)',$asn1,$maxlen));

                        }

                        // Validate identifier

                        if (!oid_id_is_valid($asn1)) throw new OIDplusException(_L('"%1" is not a valid ASN.1 identifier!',$asn1));

                        // Check if the (real) parent has any conflict

                        // Unlike IRI identifiers, ASN.1 identifiers may be used multiple times (not recommended), except if one of them is standardized

                        $res = OIDplus::db()->query("select oid from ###asn1id where name = ? and standardized = ?", array($asn1,true));

                        while ($row = $res->fetch_array()) {

                                $check_oid = OIDplusOid::parse($row['oid'])->oid;

                                if ((oid_up($check_oid) === oid_up($this->oid)) && // same parent

                                   ($check_oid !== $this->oid))                    // different OID

                                {

                                        throw new OIDplusException(_L('ASN.1 identifier "%1" is a standardized identifier belonging to OID %2',$asn1,$check_oid));

                                }

                        }

                }

                // Now do the real replacement

                if (!$simulate) {

                        OIDplus::db()->query("delete from ###asn1id where oid = ?", array("oid:".$this->oid));

                        foreach ($demandedASN1s as &$asn1) {

                                OIDplus::db()->query("insert into ###asn1id (oid, name) values (?, ?)", array("oid:".$this->oid, $asn1));

                        }

                }

        }

        /**

         * @param array $demandedIris

         * @param bool $simulate

         * @return void

         * @throws OIDplusException

         */

        public function replaceIris(array $demandedIris=array(), bool $simulate=false) {

                if ($this->isWellKnown()) {

                        throw new OIDplusException(_L('OID "%1" is a "well-known" OID. Its identifiers cannot be changed.',$this->oid));

                }

                // First do a few checks

                foreach ($demandedIris as &$iri) {

                        $iri = trim($iri);

                        if (strlen($iri) > OIDplus::baseConfig()->getValue('LIMITS_MAX_OID_UNICODE_LABEL_LEN')) {

                                $maxlen = OIDplus::baseConfig()->getValue('LIMITS_MAX_OID_UNICODE_LABEL_LEN');

                                throw new OIDplusException(_L('Unicode label "%1" is too long (max allowed length %2)',$iri,$maxlen));

                        }

                        // Validate identifier

                        if (!iri_arc_valid($iri, false)) throw new OIDplusException(_L('"%1" is not a valid IRI!',$iri));

                        // Check if the (real) parent has any conflict

                        $res = OIDplus::db()->query("select oid from ###iri where name = ?", array($iri));

                        while ($row = $res->fetch_array()) {

                                $check_oid = OIDplusOid::parse($row['oid'])->oid;

                                if ((oid_up($check_oid) === oid_up($this->oid)) && // same parent

                                   ($check_oid !== $this->oid))                    // different OID

                                {

                                        throw new OIDplusException(_L('IRI "%1" is already used by another OID (%2)',$iri,$check_oid));

                                }

                        }

                }

                // Now do the real replacement

                if (!$simulate) {

                        OIDplus::db()->query("delete from ###iri where oid = ?", array("oid:".$this->oid));

                        foreach ($demandedIris as &$iri) {

                                OIDplus::db()->query("insert into ###iri (oid, name) values (?, ?)", array("oid:".$this->oid, $iri));

                        }

                }

        }

        /**

         * @return OIDplusOid|null

         */

        public function one_up()/*: ?OIDplusOid*/ {

                return self::parse(self::ns().':'.oid_up($this->oid));

        }