typepki-asn1gen 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Kenji Urushima
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,12 @@
+typepki-asn1gen: ASN.1 data generator for TypePKI library
+=========================================================
+
+[TOP](https://kjur.github.io/typepki-asn1gen/) | [github](https://github.com/kjur/typepki-asn1gen) | [npm](https://www.npmjs.com/package/typepki-asn1gen) | [TypePKI](https://kjur.github.com/typepki/) 
+
+The 'TypePKI' library is an opensource free TypeScript PKI library which is the successor of the long lived [jsrsasign](https://kjur.github.io/jsrsasign) library.
+
+The 'typepki-asn1gen' is a ASN.1 encoded data generator sub module for TypePKI library. 
+
+## FEATURE
+- Dual CommonJS/ES module package supporting CommonJS(CJS) and ES modules
+

package/dist/import/index.d.mts

@@ -0,0 +1,51 @@
+/**
+ * ASN.1 data object definition
+ * @example
+ * let d: ASN1Data = { t: "int", v: "1234" };
+ */
+export interface ASN1Data {
+    t: string;
+    v: any;
+}
+/**
+ * generate ASN.1 DER/BER encoded hexadecimal string from JSON data
+ * @param p - JSON object representing ASN.1 structure
+ * @return hexadecimal string of ASN.1 DER/BER encoded hexadecimal string
+ * @example
+ * getASN1({ t: "int", v: "12ab" }) -> "020212ab"
+ * getASN1({ t: "seq", v: [
+ *   { t: "int", v: "01" },
+ *   { t: "int", v: "02" }
+ * ]}) -> "3006020101020102"
+ */
+export declare function getASN1(p: ASN1Data): string;
+/**
+ * convert hexadecimal positive integer to ASN.1 integer value
+ * @param h - hexadecimal string of positive integer
+ * @return ASN.1 Integer DER encoded hexadecimal string
+ * @example
+ * pospad("01") -> "01"
+ * pospad("ab") -> "00ab"
+ * pospad("00000012") -> "12"
+ * pospad("000000ab") -> "00ab"
+ */
+export declare function pospad(h: string): string;
+/**
+ * get ASN.1 TLV length octet(s) by TLV value octet length
+ * @param n - TLV value octet length
+ * @return hexadecimal string of TLV length octets
+ * @example
+ * getLength(3) -> "03"
+ * getLength(128) -> "8180"
+ */
+export declare function getLength(n: number): string;
+/**
+ * zero padding for hexadecimal string
+ * @param s - odd or even length hexadecimal string
+ * @return even length zero padded hexadecimal string
+ * @example
+ * hexpad("1") -> "01"
+ * hexpad("ab3c") -> "ab3c"
+ */
+export declare function hexpad(s: string): string;
+//# sourceMappingURL=index.d.mts.map

package/dist/import/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/index.mts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,GAAG,CAAC;CACR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,QAAQ,GAAG,MAAM,CAQ3C;AAiBD;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAIxC;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAU3C;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAExC"}

package/dist/import/index.mjs

@@ -0,0 +1 @@
+function r(t){return!(t.length%2===1||t.match(/^[0-9a-f]+$/)==null)}function u(t){switch(t.t){case"int":return i(t.v);case"seq":return l(t.v)}return""}function i(t){return typeof t=="string"&&r(t)?`02${s(t.length/2)}${t}`:""}function l(t){let e="";for(let n=0;n<t.length;n++)e+=u(t[n]);return`30${s(e.length/2)}${e}`}function h(t){return t=t.replace(/^(00){1,}/,""),t.match(/^[8-9a-f]/)?"00"+t:t}function s(t){let e;return t<128?(e=o(t.toString(16)),e):(e=o(t.toString(16)),(128+e.length/2).toString(16)+e)}function o(t){return t.length%2===1?`0${t}`:t}export{u as getASN1,s as getLength,o as hexpad,h as pospad};

package/dist/require/index.cjs

@@ -0,0 +1 @@
+"use strict";var s=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var $=Object.getOwnPropertyNames;var m=Object.prototype.hasOwnProperty;var l=(t,e)=>()=>(t&&(e=t(t=0)),e);var b=(t,e)=>{for(var n in e)s(t,n,{get:e[n],enumerable:!0})},d=(t,e,n,o)=>{if(e&&typeof e=="object"||typeof e=="function")for(let r of $(e))!m.call(t,r)&&r!==n&&s(t,r,{get:()=>e[r],enumerable:!(o=p(e,r))||o.enumerable});return t};var x=t=>d(s({},"__esModule",{value:!0}),t);function a(t){return!(t.length%2===1||t.match(/^[0-9a-f]+$/)==null)}var f=l(()=>{});var h={};b(h,{getASN1:()=>c,getLength:()=>i,hexpad:()=>u,pospad:()=>I});function c(t){switch(t.t){case"int":return w(t.v);case"seq":return S(t.v)}return""}function w(t){return typeof t=="string"&&a(t)?`02${i(t.length/2)}${t}`:""}function S(t){let e="";for(let n=0;n<t.length;n++)e+=c(t[n]);return`30${i(e.length/2)}${e}`}function I(t){return t=t.replace(/^(00){1,}/,""),t.match(/^[8-9a-f]/)?"00"+t:t}function i(t){let e;return t<128?(e=u(t.toString(16)),e):(e=u(t.toString(16)),(128+e.length/2).toString(16)+e)}function u(t){return t.length%2===1?`0${t}`:t}var g=l(()=>{"use strict";f()});module.exports=(g(),x(h));

package/dist/require/index.d.cts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.cts.map

package/dist/require/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/index.cts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "typepki-asn1gen",
+  "version": "0.1.0",
+  "author": "Kenji Urushima <kenji.urushima@gmail.com>",
+  "description": "ASN.1 data generator for TypePKI library (beta)",
+  "homepage": "https://kjur.github.io/typepki-asn1gen",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kjur/typepki-asn1gen.git"
+  },
+  "bugs": {
+    "url": "https://github.com/kjur/typepki-asn1gen/issues"
+  },
+  "keywords": [
+    "ASN.1"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "deploy": "",
+    "build": "run-z build:transpile,build:esm,build:cjs",
+    "build:transpile": "bun build.mts",
+    "build:esm": "tsc --project tsconfig.build.esm.json",
+    "build:cjs": "tsc --project tsconfig.build.cjs.json",
+    "check": "run-z check:type,check:static",
+    "check:type": "tsc --noEmit",
+    "check:static": "biome check .",
+    "fix": "$npm_execpath run check:static --apply-unsafe",
+    "test": "bun test",
+    "precommit": "run-z check:type fix test build",
+    "prepublish": "attw --pack .",
+    "run-z": "run-z",
+    "doc": "typedoc --includeVersion --cleanOutputDir false --tsconfig ./tsconfig.typedoc.json --options ./typedoc.json src/index.mts"
+  },
+  "files": [
+    "src",
+    "dist",
+    "package.json",
+    "tsconfig.json",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/import/index.d.mts",
+        "default": "./dist/import/index.mjs"
+      },
+      "require": {
+        "types": "./dist/require/index.d.cts",
+        "default": "./dist/require/index.cjs"
+      }
+    }
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.15.0",
+    "@biomejs/biome": "1.5.3",
+    "@changesets/cli": "^2.27.1",
+    "@types/bun": "^1.1.1",
+    "bun-types": "^1.1.4",
+    "esbuild": "^0.20.0",
+    "jest": "^29.7.0",
+    "run-z": "^2.0.0",
+    "typedoc": "^0.25.13",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "typepki-strconv": "^0.3.0"
+  }
+}

package/src/index.cts

@@ -0,0 +1 @@
+module.exports = require("./index.mts");

package/src/index.mts

@@ -0,0 +1,95 @@
+import { ishex } from "typepki-strconv";
+
+/**
+ * ASN.1 data object definition
+ * @example
+ * let d: ASN1Data = { t: "int", v: "1234" };
+ */
+export interface ASN1Data {
+  t: string;
+  v: any;
+}
+
+/**
+ * generate ASN.1 DER/BER encoded hexadecimal string from JSON data
+ * @param p - JSON object representing ASN.1 structure
+ * @return hexadecimal string of ASN.1 DER/BER encoded hexadecimal string
+ * @example
+ * getASN1({ t: "int", v: "12ab" }) -> "020212ab"
+ * getASN1({ t: "seq", v: [
+ *   { t: "int", v: "01" },
+ *   { t: "int", v: "02" }
+ * ]}) -> "3006020101020102"
+ */
+export function getASN1(p: ASN1Data): string {
+  switch (p.t) {
+    case "int":
+      return generateASN1_int(p.v);
+    case "seq":
+      return generateASN1_seq(p.v);
+  }
+  return "";
+}
+
+function generateASN1_int(v: string | object): string {
+  if (typeof v == "string" && ishex(v)) {
+    return `02${getLength(v.length / 2)}${v}`;
+  }
+  return "";
+}
+
+function generateASN1_seq(v: Array<ASN1Data>): string {
+  let hV = "";
+  for (let i = 0; i < v.length; i++) {
+    hV += getASN1(v[i]);
+  }
+  return `30${getLength(hV.length / 2)}${hV}`;
+}
+
+/**
+ * convert hexadecimal positive integer to ASN.1 integer value
+ * @param h - hexadecimal string of positive integer
+ * @return ASN.1 Integer DER encoded hexadecimal string
+ * @example
+ * pospad("01") -> "01"
+ * pospad("ab") -> "00ab"
+ * pospad("00000012") -> "12"
+ * pospad("000000ab") -> "00ab"
+ */
+export function pospad(h: string): string {
+  h = h.replace(/^(00){1,}/, '');
+  if (h.match(/^[8-9a-f]/)) return "00" + h;
+  return h;  
+}
+
+/**
+ * get ASN.1 TLV length octet(s) by TLV value octet length
+ * @param n - TLV value octet length
+ * @return hexadecimal string of TLV length octets
+ * @example
+ * getLength(3) -> "03"
+ * getLength(128) -> "8180"
+ */
+export function getLength(n: number): string {
+  let hL;
+  if (n < 128) {
+    hL = hexpad(n.toString(16));
+    return hL;
+  }
+  hL = hexpad(n.toString(16));
+  const iTop = 128 + (hL.length / 2);
+  const hTop = iTop.toString(16);
+  return hTop + hL;
+}
+
+/**
+ * zero padding for hexadecimal string
+ * @param s - odd or even length hexadecimal string
+ * @return even length zero padded hexadecimal string
+ * @example
+ * hexpad("1") -> "01"
+ * hexpad("ab3c") -> "ab3c"
+ */
+export function hexpad(s: string): string {
+  return (s.length % 2 === 1) ? `0${s}` : s;
+}

package/src/index.test.mts

@@ -0,0 +1,25 @@
+import { describe, expect, test } from "bun:test";
+import { pospad, getLength, getASN1 } from "./index.mts";
+
+test("pospad", () => {
+  expect(pospad("1234")).toBe("1234");
+  expect(pospad("001234")).toBe("1234");
+  expect(pospad("00001234")).toBe("1234");
+  expect(pospad("0000abcd")).toBe("00abcd");
+  expect(pospad("abcd")).toBe("00abcd");
+});
+
+test("getLength", () => {
+  expect(getLength(1)).toBe("01");
+  expect(getLength(127)).toBe("7f");
+  expect(getLength(128)).toBe("8180");
+  expect(getLength(732)).toBe("8202dc");
+});
+
+test("getASN1", () => {
+  expect(getASN1({t: "int", v: "12ab"})).toBe("020212ab");
+  expect(getASN1({t: "seq", v: [
+    {t: "int", v: "01"},
+    {t: "int", v: "02"}
+  ]})).toBe("3006020101020102");
+});

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "types": ["bun-types"],
+
+    "lib": ["esnext"],
+    "module": "esnext",
+    "target": "esnext",
+    "moduleResolution": "bundler",
+
+    "noEmit": true,
+
+    "allowImportingTsExtensions": true,
+    "moduleDetection": "force",
+
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+
+  },
+  "exclude": ["_work"]
+}