@lindorm/okp 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 0.1.0 (2024-05-12)
+
+### Features
+
+- initialise okp package ([8ecd15f](https://github.com/lindorm-io/monorepo/commit/8ecd15f0079ea9cd830d1d006ea2fb0433a264e2))

package/README.md

@@ -0,0 +1 @@
+# @lindorm/okp

package/dist/classes/OkpKit.d.ts

@@ -0,0 +1,10 @@
+import { OkpKitOptions } from "../types";
+export declare class OkpKit {
+    private readonly format;
+    private readonly kryptos;
+    constructor(options: OkpKitOptions);
+    sign(data: string): string;
+    verify(data: string, signature: string): boolean;
+    assert(data: string, signature: string): void;
+}
+//# sourceMappingURL=OkpKit.d.ts.map

package/dist/classes/OkpKit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OkpKit.d.ts","sourceRoot":"","sources":["../../src/classes/OkpKit.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAsB,MAAM,UAAU,CAAC;AAO7D,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiC;IACxD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;gBAEf,OAAO,EAAE,aAAa;IAKlC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAQ1B,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO;IAShD,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAQrD"}

package/dist/classes/OkpKit.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OkpKit = void 0;
+const okp_signature_1 = require("../utils/private/okp-signature");
+class OkpKit {
+    format;
+    kryptos;
+    constructor(options) {
+        this.format = options.format;
+        this.kryptos = options.kryptos;
+    }
+    sign(data) {
+        return (0, okp_signature_1._createOkpSignature)({
+            data,
+            format: this.format,
+            kryptos: this.kryptos,
+        });
+    }
+    verify(data, signature) {
+        return (0, okp_signature_1._verifyOkpSignature)({
+            data,
+            format: this.format,
+            kryptos: this.kryptos,
+            signature,
+        });
+    }
+    assert(data, signature) {
+        return (0, okp_signature_1._assertOkpSignature)({
+            data,
+            format: this.format,
+            kryptos: this.kryptos,
+            signature,
+        });
+    }
+}
+exports.OkpKit = OkpKit;
+//# sourceMappingURL=OkpKit.js.map

package/dist/classes/OkpKit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OkpKit.js","sourceRoot":"","sources":["../../src/classes/OkpKit.ts"],"names":[],"mappings":";;;AAEA,kEAIwC;AAExC,MAAa,MAAM;IACA,MAAM,CAAiC;IACvC,OAAO,CAAU;IAElC,YAAmB,OAAsB;QACvC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IACjC,CAAC;IAEM,IAAI,CAAC,IAAY;QACtB,OAAO,IAAA,mCAAmB,EAAC;YACzB,IAAI;YACJ,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,IAAY,EAAE,SAAiB;QAC3C,OAAO,IAAA,mCAAmB,EAAC;YACzB,IAAI;YACJ,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS;SACV,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,IAAY,EAAE,SAAiB;QAC3C,OAAO,IAAA,mCAAmB,EAAC;YACzB,IAAI;YACJ,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS;SACV,CAAC,CAAC;IACL,CAAC;CACF;AAlCD,wBAkCC"}

package/dist/classes/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./OkpKit";
+//# sourceMappingURL=index.d.ts.map

package/dist/classes/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/classes/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC"}

package/dist/classes/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./OkpKit"), exports);
+//# sourceMappingURL=index.js.map

package/dist/classes/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/classes/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB"}

package/dist/errors/OkpError.d.ts

@@ -0,0 +1,4 @@
+import { LindormError } from "@lindorm/errors";
+export declare class OkpError extends LindormError {
+}
+//# sourceMappingURL=OkpError.d.ts.map

package/dist/errors/OkpError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OkpError.d.ts","sourceRoot":"","sources":["../../src/errors/OkpError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,qBAAa,QAAS,SAAQ,YAAY;CAAG"}

package/dist/errors/OkpError.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OkpError = void 0;
+const errors_1 = require("@lindorm/errors");
+class OkpError extends errors_1.LindormError {
+}
+exports.OkpError = OkpError;
+//# sourceMappingURL=OkpError.js.map

package/dist/errors/OkpError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OkpError.js","sourceRoot":"","sources":["../../src/errors/OkpError.ts"],"names":[],"mappings":";;;AAAA,4CAA+C;AAE/C,MAAa,QAAS,SAAQ,qBAAY;CAAG;AAA7C,4BAA6C"}

package/dist/errors/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./OkpError";
+//# sourceMappingURL=index.d.ts.map

package/dist/errors/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC"}

package/dist/errors/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./OkpError"), exports);
+//# sourceMappingURL=index.js.map

package/dist/errors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./classes";
+export * from "./errors";
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./classes"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,2CAAyB;AACzB,0CAAwB"}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./okp-kit";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC"}

package/dist/types/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./okp-kit"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B"}

package/dist/types/okp-kit.d.ts

@@ -0,0 +1,18 @@
+import { Kryptos } from "@lindorm/kryptos";
+export type OkpSignatureFormat = "base64" | "base64url" | "hex";
+export type CreateOkpSignatureOptions = {
+    data: string;
+    format?: OkpSignatureFormat;
+    kryptos: Kryptos;
+};
+export type VerifyOkpSignatureOptions = {
+    data: string;
+    format?: OkpSignatureFormat;
+    signature: string;
+    kryptos: Kryptos;
+};
+export type OkpKitOptions = {
+    format?: OkpSignatureFormat;
+    kryptos: Kryptos;
+};
+//# sourceMappingURL=okp-kit.d.ts.map

package/dist/types/okp-kit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"okp-kit.d.ts","sourceRoot":"","sources":["../../src/types/okp-kit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,WAAW,GAAG,KAAK,CAAC;AAEhE,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC"}

package/dist/types/okp-kit.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=okp-kit.js.map

package/dist/types/okp-kit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"okp-kit.js","sourceRoot":"","sources":["../../src/types/okp-kit.ts"],"names":[],"mappings":""}

package/dist/utils/private/okp-signature.d.ts

@@ -0,0 +1,5 @@
+import { CreateOkpSignatureOptions, VerifyOkpSignatureOptions } from "../../types/okp-kit";
+export declare const _createOkpSignature: ({ data, format, kryptos, }: CreateOkpSignatureOptions) => string;
+export declare const _verifyOkpSignature: ({ data, format, kryptos, signature, }: VerifyOkpSignatureOptions) => boolean;
+export declare const _assertOkpSignature: ({ data, format, kryptos, signature, }: VerifyOkpSignatureOptions) => void;
+//# sourceMappingURL=okp-signature.d.ts.map

package/dist/utils/private/okp-signature.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"okp-signature.d.ts","sourceRoot":"","sources":["../../../src/utils/private/okp-signature.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,yBAAyB,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAE3F,eAAO,MAAM,mBAAmB,+BAI7B,yBAAyB,KAAG,MAY9B,CAAC;AAEF,eAAO,MAAM,mBAAmB,0CAK7B,yBAAyB,KAAG,OAY9B,CAAC;AAEF,eAAO,MAAM,mBAAmB,0CAK7B,yBAAyB,KAAG,IAG9B,CAAC"}

package/dist/utils/private/okp-signature.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._assertOkpSignature = exports._verifyOkpSignature = exports._createOkpSignature = void 0;
+const kryptos_1 = require("@lindorm/kryptos");
+const crypto_1 = require("crypto");
+const errors_1 = require("../../errors");
+const _createOkpSignature = ({ data, format = "base64", kryptos, }) => {
+    if (!kryptos_1.Kryptos.isOkp(kryptos)) {
+        throw new errors_1.OkpError("Invalid kryptos type");
+    }
+    const { privateKey } = kryptos.export("pem");
+    if (!privateKey) {
+        throw new errors_1.OkpError("Missing private key");
+    }
+    return (0, crypto_1.sign)(undefined, Buffer.from(data, "utf8"), privateKey).toString(format);
+};
+exports._createOkpSignature = _createOkpSignature;
+const _verifyOkpSignature = ({ data, format = "base64", kryptos, signature, }) => {
+    if (!kryptos_1.Kryptos.isOkp(kryptos)) {
+        throw new errors_1.OkpError("Invalid kryptos type");
+    }
+    const { publicKey } = kryptos.export("pem");
+    if (!publicKey) {
+        throw new errors_1.OkpError("Missing private key");
+    }
+    return (0, crypto_1.verify)(undefined, Buffer.from(data, "utf8"), publicKey, Buffer.from(signature, format));
+};
+exports._verifyOkpSignature = _verifyOkpSignature;
+const _assertOkpSignature = ({ data, format, kryptos, signature, }) => {
+    if ((0, exports._verifyOkpSignature)({ data, format, kryptos, signature }))
+        return;
+    throw new errors_1.OkpError("Invalid signature");
+};
+exports._assertOkpSignature = _assertOkpSignature;
+//# sourceMappingURL=okp-signature.js.map

package/dist/utils/private/okp-signature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"okp-signature.js","sourceRoot":"","sources":["../../../src/utils/private/okp-signature.ts"],"names":[],"mappings":";;;AAAA,8CAA2C;AAC3C,mCAAsC;AACtC,yCAAwC;AAGjC,MAAM,mBAAmB,GAAG,CAAC,EAClC,IAAI,EACJ,MAAM,GAAG,QAAQ,EACjB,OAAO,GACmB,EAAU,EAAE;IACtC,IAAI,CAAC,iBAAO,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,iBAAQ,CAAC,sBAAsB,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAE7C,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,iBAAQ,CAAC,qBAAqB,CAAC,CAAC;IAC5C,CAAC;IAED,OAAO,IAAA,aAAI,EAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACjF,CAAC,CAAC;AAhBW,QAAA,mBAAmB,uBAgB9B;AAEK,MAAM,mBAAmB,GAAG,CAAC,EAClC,IAAI,EACJ,MAAM,GAAG,QAAQ,EACjB,OAAO,EACP,SAAS,GACiB,EAAW,EAAE;IACvC,IAAI,CAAC,iBAAO,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,iBAAQ,CAAC,sBAAsB,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAE5C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,iBAAQ,CAAC,qBAAqB,CAAC,CAAC;IAC5C,CAAC;IAED,OAAO,IAAA,eAAM,EAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;AACjG,CAAC,CAAC;AAjBW,QAAA,mBAAmB,uBAiB9B;AAEK,MAAM,mBAAmB,GAAG,CAAC,EAClC,IAAI,EACJ,MAAM,EACN,OAAO,EACP,SAAS,GACiB,EAAQ,EAAE;IACpC,IAAI,IAAA,2BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;QAAE,OAAO;IACtE,MAAM,IAAI,iBAAQ,CAAC,mBAAmB,CAAC,CAAC;AAC1C,CAAC,CAAC;AARW,QAAA,mBAAmB,uBAQ9B"}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@lindorm/okp",
+  "version": "0.1.0",
+  "license": "AGPL-3.0-or-later",
+  "author": "Jonn Nilsson",
+  "repository": {
+    "url": "https://github.com/lindorm-io/monorepo",
+    "directory": "packages/okp"
+  },
+  "bugs": "https://github.com/lindorm-io/monorepo/issues",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "scripts": {
+    "build": "rimraf dist && tsc -b ./tsconfig.build.json",
+    "example": "ts-node example",
+    "integration": "compd --file docker-compose.yml jest --config jest.config.integration.js --watch --",
+    "test:ci": "npm run test:unit",
+    "test:integration": "jest --config jest.config.integration.js --",
+    "test:unit": "jest --config jest.config.js --",
+    "test": "jest --watch --",
+    "typecheck:ci": "tsc",
+    "typecheck": "tsc --watch",
+    "update": "ncu -u"
+  },
+  "dependencies": {
+    "@lindorm/errors": "^0.1.4",
+    "@lindorm/kryptos": "^0.2.1"
+  },
+  "gitHead": "cb57e5e2cc3e7ee6a1db97875e05bebb910a1efe"
+}