Subversion Repositories oidplus

/**

 * WEID<=>OID Converter

 * (c) Webfan.de, ViaThinkSoft

 * Revision 2022-02-22

 **/

// What is a WEID?

//     A WEID (WEhowski IDentifier) is an alternative representation of an

//     OID (Object IDentifier) defined by Till Wehowski.

//     In OIDs, arcs are in decimal base 10. In WEIDs, the arcs are in base 36.

//     Also, each WEID has a check digit at the end (called WeLohn Check Digit).

//

// Changes in the December 2021 definition by Daniel Marschall:

//     - There are several classes of WEIDs which have different OID bases:

//           "Class C" WEID:  weid:EXAMPLE-3      (base .1.3.6.1.4.1.37553.8.)

//                            oid:1.3.6.1.4.1.37553.8.32488192274

//           "Class B" WEID:  weid:pen:SX0-7PR-6  (base .1.3.6.1.4.1.)

//                            oid:1.3.6.1.4.1.37476.9999

//           "Class A" WEID:  weid:root:2-RR-2    (base .)

//                            oid:2.999

//     - The namespace (weid:, weid:pen:, weid:root:) is now case insensitive.

//     - Padding with '0' characters is valid (e.g. weid:000EXAMPLE-3)

//       The paddings do not count into the WeLuhn check-digit.

// Requires "mikemcl/bignumber.js" library

var WeidOidConverter = {

        weLuhnCheckDigit: function(str) {

                // Padding zeros don't count to the check digit (December 2021)

                var ary = str.split('-');

                ary.forEach((o,i,a) => {

                        a[i] = a[i].replace(/^0+/, '');

                } );

                str = ary.join('-');

                // remove separators from the WEID string

                var wrkstr = str.replaceAll('-', '');

                // Replace 'a' with '10', 'b' with '1', etc.

                for (var i=0; i<26; i++) {

                        wrkstr = wrkstr.toLowerCase().replaceAll(String.fromCharCode('a'.charCodeAt(0)+i).toLowerCase(), (10+i));

                }

                // At the end, wrkstr should only contain digits! Verify it!

                if (!wrkstr.match(/^\d+$/)) return false;

                // Now do the standard Luhn algorithm

                var nbdigits = wrkstr.length;

                var parity = nbdigits & 1; // mod 2

                var sum = 0;

                for (var n=nbdigits-1; n>=0; n--) {

                        var digit = parseInt(wrkstr.substr(n,1));

                        if ((n & 1) != parity) digit *= 2;

                        if (digit > 9) digit -= 9;

                        sum += digit;

                }

                return (sum%10) == 0 ? 0 : 10-(sum%10);

        },

        // Translates a WEID to an OID

        // "weid:EXAMPLE-3" becomes "1.3.6.1.4.1.37553.8.32488192274"

        // If it failed (e.g. wrong namespace, wrong checksum, etc.) then false is returned.

        // If the weid ends with '?', the checksum will be added

        // Return value is an array with the elements "oid" and "weid".

        // Example:

        //     weid2oid("weid:EXAMPLE-?").weid == "weid:EXAMPLE-3"

        //     weid2oid("weid:EXAMPLE-?").oid  == "1.3.6.1.4.1.37553.8.32488192274"

        weid2oid: function(weid) {

                var p = weid.lastIndexOf(':');

                var namespace = weid.substr(0, p+1);

                var rest = weid.substr(p+1);

                namespace = namespace.toLowerCase(); // namespace is case insensitive

                if (namespace == 'weid:') {

                        // Class C

                        var base = '1-3-6-1-4-1-SZ5-8';

                } else if (namespace == 'weid:pen:') {

                        // Class B

                        var base = '1-3-6-1-4-1';

                } else if (namespace == 'weid:root:') {

                        // Class A

                        var base = '';

                } else {

                        // Wrong namespace

                        return false;

                }

                weid = rest;

                var elements = ((base != '') ? base.split('-') : []).concat(weid.split('-'));

                var actual_checksum = elements.pop();

                var expected_checksum = weLuhnCheckDigit(elements.join('-'));

                if (actual_checksum != '?') {

                        if (actual_checksum != expected_checksum) return false; // wrong checksum

                } else {

                        // If checksum is '?', it will be replaced by the actual checksum,

                        // e.g. weid:EXAMPLE-? becomes weid:EXAMPLE-3

                        weid = weid.replace('?', expected_checksum);

                }

                elements.forEach((o,i,a) => {

                        a[i] = BigNumber(a[i],36).toString(10).toUpperCase();

                });

                var oidstr = elements.join('.');

                weid = namespace.toLowerCase() + weid.toUpperCase(); // add namespace again

                return { "weid": weid, "oid" : oidstr };

        },

        // Converts an OID to WEID

        // "1.3.6.1.4.1.37553.8.32488192274" becomes "weid:EXAMPLE-3"

        oid2weid: function(oid) {

                if (oid.substr(0,1) == '.') oid = oid.substr(1); // remove leading dot

                if (oid != '') {

                        var elements = oid.split('.');

                        elements.forEach((o,i,a) => {

                                var x = BigNumber(a[i],10);

                                a[i] = x.toString(36).toUpperCase();

                        });

                        var weidstr = elements.join("-");

                } else {

                        var weidstr = '';

                }

                var is_class_c = (weidstr.startsWith('1-3-6-1-4-1-SZ5-8-') || (weidstr == '1-3-6-1-4-1-SZ5-8'));

                var is_class_b = (weidstr.startsWith('1-3-6-1-4-1-') || (weidstr == '1-3-6-1-4-1'));

                var is_class_a = !is_class_b && !is_class_c;

                var checksum = weLuhnCheckDigit(weidstr);

                if (is_class_c) {

                        weidstr = weidstr.substr('1-3-6-1-4-1-SZ5-8-'.length);

                        var namespace = 'weid:';

                } else if (is_class_b) {

                        weidstr = weidstr.substr('1-3-6-1-4-1-'.length);

                        var namespace = 'weid:pen:';

                } else if (is_class_a) {

                        // weidstr stays

                        var namespace = 'weid:root:';

                } else {

                        // should not happen

                        console.error("oid2weid: Cannot detect namespace");

                        return false;

                }

                return namespace + (weidstr == '' ? checksum : weidstr + '-' + checksum);

        }

}