1.0.12

.gitignore

@@ -8,9 +8,12 @@ pages/
 # installs
 node_modules/
 
-# caches and builds
+# caches
 .yarn/
 .cache/
+.rpt2_cache
+
+# builds
 dist/
 dist_web/
 dist_serve/

.gitlab-ci.yml

@@ -1,5 +1,5 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
@@ -34,48 +34,11 @@ snyk:
   - 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
-  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
-  tags:
-  - docker
-  - priv
-
 # ====================
 # test stage
 # ====================
 
-testLTS:
-  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:
+testStable:
   stage: test
   script:
   - npmci npm prepare
@@ -85,6 +48,18 @@ testSTABLE:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - priv
+
+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
   - notpriv
 
 release:
@@ -103,19 +78,12 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   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 tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
   - docker
   - priv
@@ -131,13 +99,15 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:stable-dind
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - 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:
     - docker
     - notpriv

npmextra.json

@@ -2,10 +2,10 @@
   "gitzone": {
     "module": {
       "githost": "gitlab.com",
-      "gituser": "pushrocks",
+      "gitscope": "pushrocks",
       "gitrepo": "smartjwt",
       "shortDescription": "a package for handling jwt",
-      "npmPackageName": "@pushrocks/smartjwt",
+      "npmPackagename": "@pushrocks/smartjwt",
       "license": "MIT",
       "projectDomain": "push.rocks"
     }
@@ -14,4 +14,4 @@
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
   }
-}
+}

package.json

@@ -1,10 +1,10 @@
 {
   "name": "@pushrocks/smartjwt",
-  "version": "1.0.2",
+  "version": "1.0.12",
   "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": {
@@ -13,12 +13,27 @@
     "format": "(gitzone format)"
   },
   "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",
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tstest": "^1.0.52",
+    "@pushrocks/tapbundle": "^3.2.10",
+    "@types/node": "^14.14.25",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
-  "dependencies": {}
+  "dependencies": {
+    "@pushrocks/smartcrypto": "^1.0.9",
+    "@types/jsonwebtoken": "^8.5.0",
+    "jsonwebtoken": "^8.5.1"
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "dist_ts_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -0,0 +1,26 @@
+# @pushrocks/smartjwt
+a package for handling jwt
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartjwt)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartjwt)
+* [github.com (source mirror)](https://github.com/pushrocks/smartjwt)
+* [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/)
+
+## Usage
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![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';
 
-tap.test('first test', async () => {
-  console.log(smartjwt.standardExport)
-})
+let smartjwtInstance: smartjwt.SmartJwt;
+let testJwt: string;
 
-tap.start()
+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).to.not.be.null;
+  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) {
+    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/index.ts

@@ -1,3 +1 @@
-import * as plugins from './smartjwt.plugins';
-
-export let standardExport = 'Hi there! :) This is an exported string';
+export * from './smartjwt.classes.smartjwt';

ts/smartjwt.classes.smartjwt.ts

@@ -0,0 +1,89 @@
+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<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 @@
-const removeme = {};
-export {
-  removeme
-}
+// @pushrocks scope
+import * as smartcrypto from '@pushrocks/smartcrypto';
+
+export { smartcrypto };
+
+// thirdparty scope
+import * as jsonwebtoken from 'jsonwebtoken';
+export { jsonwebtoken };