2.0.1

.gitignore

@@ -8,12 +8,13 @@ pages/
 # installs
 node_modules/
 
-# caches and builds
+# caches
 .yarn/
 .cache/
+.rpt2_cache
+
+# builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -1,144 +1,122 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
+
+before_script:
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
 
 # ====================
 # security stage
 # ====================
-mirror:
+# ====================
+# security stage
+# ====================
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-  - npmci git mirror
+     - npmci command npm config set registry https://registry.npmjs.org
+     - npmci command pnpm audit --audit-level=high --prod
   tags:
-  - docker
-  - notpriv
-
-snyk:
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
-  tags:
-  - docker
-  - notpriv
-
-sast:
-  stage: security
-  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
-  variables:
-    DOCKER_DRIVER: overlay2
+    - lossless
+    - docker
   allow_failure: true
-  services:
-    - docker:stable-dind
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
   script:
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command npm run build
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
-        --volume "$PWD:/code"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
-  artifacts:
-    reports:
-      sast: gl-sast-report.json
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command pnpm audit --audit-level=high --dev
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - docker
 
-testSTABLE:
+testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - docker
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
+  only:
+    - tags
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g typescript
+    - npmci npm prepare
+    - npmci npm install
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
-    - npmci npm prepare
+    - npmci node install stable
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command npm run buildDocs
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -146,5 +124,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -1,10 +1,11 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartjwt",
-      "shortDescription": "a package for handling jwt",
+      "description": "a package for handling jwt",
       "npmPackagename": "@pushrocks/smartjwt",
       "license": "MIT",
       "projectDomain": "push.rocks"

package.json

@@ -1,26 +1,43 @@
 {
   "name": "@pushrocks/smartjwt",
-  "version": "1.0.4",
+  "version": "2.0.1",
   "private": false,
   "description": "a package for handling jwt",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
     "build": "(tsbuild)",
-    "format": "(gitzone format)"
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^11.9.5",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.15.0"
+    "@gitzone/tsbuild": "^2.1.28",
+    "@gitzone/tsrun": "^1.2.39",
+    "@gitzone/tstest": "^1.0.74",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.11.17"
   },
   "dependencies": {
-    "jsonwebtoken": "^8.5.0"
-  }
+    "@pushrocks/smartcrypto": "^2.0.1",
+    "@types/jsonwebtoken": "^8.5.5",
+    "jsonwebtoken": "^9.0.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "type": "module"
 }

readme.md

@@ -8,21 +8,34 @@ a package for handling jwt
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartjwt/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/smartjwt/badges/master/build.svg)](https://gitlab.com/pushrocks/smartjwt/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartjwt/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartjwt/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartjwt.svg)](https://www.npmjs.com/package/@pushrocks/smartjwt)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartjwt/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartjwt)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartjwt/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartjwt/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartjwt)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartjwt)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartjwt)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartjwt)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartjwt)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
-This package is intended for being used serverside. There is a corresponding client package for browsers calls @pushrocks/webtoken
-
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -1,8 +1,51 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartjwt from '../ts/index';
+import * as smartjwt from '../ts/index.js';
 
-tap.test('first test', async () => {
-  console.log(smartjwt.standardExport);
+let smartjwtInstance: smartjwt.SmartJwt;
+let testJwt: string;
+
+tap.test('should create a valid instance', async () => {
+  smartjwtInstance = new smartjwt.SmartJwt();
+  await smartjwtInstance.createNewKeyPair();
+  console.log(smartjwtInstance);
+});
+
+tap.test('should create a valid jwt', async () => {
+  await smartjwtInstance.createNewKeyPair();
+});
+
+tap.test('should create a new jwt', async () => {
+  testJwt = await smartjwtInstance.createJWT({ hi: 'there' });
+  console.log(testJwt);
+});
+
+tap.test('should verify a jwt', async () => {
+  const data = await smartjwtInstance.verifyJWTAndGetData(testJwt);
+  // tslint:disable-next-line: no-unused-expression
+  expect(data).not.toBeNull();
+  console.log(data);
+  console.log(smartjwtInstance.publicKey.toPemString());
+});
+
+tap.test('should not verify a wrong jwt', async () => {
+  const jwt2 = await smartjwtInstance.createJWT({ wow: 'soclear' });
+  const jwt2Array = jwt2.split('.');
+  const testJwtArray = testJwt.split('.');
+  const newJwt = `${testJwtArray[0]}.${jwt2Array[1]}.${testJwtArray[2]}`;
+  let error: Error;
+  try {
+    await smartjwtInstance.verifyJWTAndGetData(newJwt);
+  } catch (e: any) {
+    error = e;
+  }
+  expect(error).toBeInstanceOf(Error);
+});
+
+tap.test('should verify a jwt on another instance', async () => {
+  const secondSmartJwtInstance = new smartjwt.SmartJwt();
+  secondSmartJwtInstance.setPublicPemKeyForVerification(smartjwtInstance.publicKey.toPemString());
+  const result = secondSmartJwtInstance.verifyJWTAndGetData(testJwt);
+  console.log(result);
 });
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartjwt',
+  version: '2.0.1',
+  description: 'a package for handling jwt'
+}

ts/index.ts

@@ -1,5 +1 @@
-import * as plugins from './smartjwt.plugins';
-
-export class SmartJwt {
-  
-}
+export * from './smartjwt.classes.smartjwt.js';

ts/smartjwt.classes.smartjwt.ts

@@ -0,0 +1,89 @@
+import * as plugins from './smartjwt.plugins.js';
+
+export interface ISmartJWTJSONKeypair {
+  privatePem: string;
+  publicPem: string;
+}
+
+/**
+ * A class to create and validate JWTs and their keys
+ */
+export class SmartJwt<T extends object = any> {
+  public smartcryptoInstance = new plugins.smartcrypto.Smartcrypto();
+  public publicKey: plugins.smartcrypto.PublicKey;
+  public privateKey: plugins.smartcrypto.PrivateKey;
+
+  constructor() {}
+
+  /**
+   * creates a JWT
+   */
+  public async createJWT(payloadArg: T) {
+    return plugins.jsonwebtoken.sign(payloadArg, this.privateKey.toPemString(), {
+      algorithm: 'RS256',
+    });
+  }
+
+  /**
+   * checks a JWT
+   */
+  public async verifyJWTAndGetData(jwtArg: string): Promise<T> {
+    const result = plugins.jsonwebtoken.verify(jwtArg, this.publicKey.toPemString(), {
+      algorithms: ['RS256'],
+    });
+    return result as any;
+  }
+
+  /**
+   * sets a private key to create jwts with
+   */
+  public async setPrivateKey(privateKey: plugins.smartcrypto.PrivateKey) {
+    this.privateKey = privateKey;
+  }
+
+  /**
+   * sets a public key
+   */
+  public async setPublicKey(publicKey: plugins.smartcrypto.PublicKey) {
+    this.publicKey = publicKey;
+  }
+
+  /**
+   * gets the currently set kaypair as json
+   */
+  public getKeyPairAsJson(): ISmartJWTJSONKeypair {
+    return {
+      privatePem: this.privateKey.toPemString(),
+      publicPem: this.publicKey.toPemString(),
+    };
+  }
+
+  /**
+   * sets the currently set keypair as json
+   */
+  public setKeyPairAsJson(jsonKeyPair: ISmartJWTJSONKeypair) {
+    this.privateKey = plugins.smartcrypto.PrivateKey.fromPemString(jsonKeyPair.privatePem);
+    this.publicKey = plugins.smartcrypto.PublicKey.fromPemString(jsonKeyPair.publicPem);
+  }
+
+  /**
+   * creates a new keypair
+   */
+  public async createNewKeyPair() {
+    const keypair = await this.smartcryptoInstance.createKeyPair();
+    this.setPrivateKey(keypair.privateKey);
+    this.setPublicKey(keypair.publicKey);
+  }
+
+  /**
+   * when you just want to validate something
+   * @param publicPemKey
+   */
+  public setPublicPemKeyForVerification(publicPemKey: string) {
+    this.publicKey = plugins.smartcrypto.PublicKey.fromPemString(publicPemKey);
+  }
+
+  public async init() {
+    await this.createNewKeyPair();
+  }
+}

ts/smartjwt.plugins.ts

@@ -1,4 +1,8 @@
-import * as jsonwebtoken from 'jsonwebtoken';
-export {
-  jsonwebtoken
-};
+// @pushrocks scope
+import * as smartcrypto from '@pushrocks/smartcrypto';
+
+export { smartcrypto };
+
+// thirdparty scope
+import jsonwebtoken from 'jsonwebtoken';
+export { jsonwebtoken };

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true
+  }
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}