1.0.14

.gitignore

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

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -19,63 +19,42 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
+    - npmci command npm install --production --ignore-scripts
-    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command snyk test
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
-  - notpriv
-
-sast:
-  stage: security
-  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
-  variables:
-    DOCKER_DRIVER: overlay2
   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 install --ignore-scripts
-    - npmci command npm run build
+    - npmci command npm config set registry https://registry.npmjs.org
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - npmci command npm audit --audit-level=high --only=dev
-    - 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
   tags:
     - docker
-  - priv
+  allow_failure: true
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
   stage: test
   script:
     - npmci npm prepare
@@ -85,7 +64,17 @@ testSTABLE:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
-  - notpriv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
 
 release:
   stage: release
@@ -95,6 +84,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -103,20 +93,16 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
+  only:
-    - docker:stable-dind
+    - tags
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
   tags:
+    - lossless
     - docker
     - priv
 
@@ -127,18 +113,20 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:

.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,5 +1,6 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,10 +1,10 @@
 {
   "name": "@pushrocks/smartjwt",
-  "version": "1.0.7",
+  "version": "1.0.14",
   "private": false,
   "description": "a package for handling jwt",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
@@ -13,16 +13,31 @@
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsbuild": "^2.1.27",
-    "@gitzone/tstest": "^1.0.24",
+    "@gitzone/tstest": "^1.0.57",
-    "@pushrocks/tapbundle": "^3.0.13",
+    "@pushrocks/tapbundle": "^3.2.14",
-    "@types/node": "^12.7.8",
+    "@types/node": "^16.9.6",
-    "tslint": "^5.20.0",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/smartcrypto": "^1.0.5",
+    "@pushrocks/smartcrypto": "^1.0.11",
-    "@types/jsonwebtoken": "^8.3.4",
+    "@types/jsonwebtoken": "^8.5.5",
     "jsonwebtoken": "^8.5.1"
-  }
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -8,21 +8,35 @@ 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)
+Status Category | Status Badge
-[![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)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartjwt/badges/master/pipeline.svg)](https://lossless.cloud)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartjwt/badges/master/coverage.svg)](https://lossless.cloud)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartjwt)](https://lossless.cloud)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+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

@@ -21,7 +21,10 @@ tap.test('should create a new jwt', async () => {
 
 tap.test('should verify a jwt', async () => {
   const data = await smartjwtInstance.verifyJWTAndGetData(testJwt);
+  // tslint:disable-next-line: no-unused-expression
+  expect(data).to.not.be.null;
   console.log(data);
+  console.log(smartjwtInstance.publicKey.toPemString());
 });
 
 tap.test('should not verify a wrong jwt', async () => {
@@ -32,10 +35,17 @@ tap.test('should not verify a wrong jwt', async () => {
   let error: Error;
   try {
     await smartjwtInstance.verifyJWTAndGetData(newJwt);
-  } catch (e) {
+  } catch (e: any) {
     error = e;
   }
   expect(error).to.be.instanceOf(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/smartjwt.classes.smartjwt.ts

@@ -1,31 +1,37 @@
 import * as plugins from './smartjwt.plugins';
 
+export interface ISmartJWTJSONKeypair {
+  privatePem: string;
+  publicPem: string;
+}
+
 /**
- * 
+ * A class to create and validate JWTs and their keys
  */
-export class SmartJwt {
+export class SmartJwt<T extends object = any> {
   public smartcryptoInstance = new plugins.smartcrypto.Smartcrypto();
   public publicKey: plugins.smartcrypto.PublicKey;
   public privateKey: plugins.smartcrypto.PrivateKey;
 
-  constructor() {};
+  constructor() {}
 
   /**
    * creates a JWT
    */
-  public async createJWT(payloadArg: any) {
+  public async createJWT(payloadArg: T) {
     return plugins.jsonwebtoken.sign(payloadArg, this.privateKey.toPemString(), {
-      algorithm: 'RS256'
+      algorithm: 'RS256',
     });
   }
 
   /**
    * checks a JWT
    */
-  public async verifyJWTAndGetData(jwtArg: string) {
+  public async verifyJWTAndGetData(jwtArg: string): Promise<T> {
-    return plugins.jsonwebtoken.verify(jwtArg, this.publicKey.toPemString(), {
+    const result = plugins.jsonwebtoken.verify(jwtArg, this.publicKey.toPemString(), {
-      algorithms: ['RS256']
+      algorithms: ['RS256'],
     });
+    return result as any;
   }
 
   /**
@@ -42,6 +48,23 @@ export class SmartJwt {
     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
@@ -51,4 +74,16 @@ export class SmartJwt {
     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,12 +1,8 @@
 // @pushrocks scope
 import * as smartcrypto from '@pushrocks/smartcrypto';
 
-export {
+export { smartcrypto };
-  smartcrypto
-};
 
 // thirdparty scope
 import * as jsonwebtoken from 'jsonwebtoken';
-export {
+export { jsonwebtoken };
-  jsonwebtoken
-};