Compare commits
8 Commits
Author | SHA1 | Date | |
---|---|---|---|
85d958e424 | |||
0dc089f811 | |||
f4448d8501 | |||
d36056bd46 | |||
96287ed710 | |||
ceb48fd45e | |||
0ebd3c9872 | |||
397b6f13a7 |
4
.gitignore
vendored
4
.gitignore
vendored
@ -15,8 +15,6 @@ node_modules/
|
||||
|
||||
# builds
|
||||
dist/
|
||||
dist_web/
|
||||
dist_serve/
|
||||
dist_ts_web/
|
||||
dist_*/
|
||||
|
||||
# custom
|
102
.gitlab-ci.yml
102
.gitlab-ci.yml
@ -3,14 +3,14 @@ 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
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
@ -18,21 +18,37 @@ stages:
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
- npmci git mirror
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
- 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 --ignore-scripts
|
||||
- npmci command snyk test
|
||||
- npmci command npm install --production --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=prod --production
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=dev
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
@ -41,37 +57,36 @@ snyk:
|
||||
testStable:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- priv
|
||||
- docker
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run build
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run 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
|
||||
@ -79,36 +94,39 @@ release:
|
||||
codequality:
|
||||
stage: metadata
|
||||
allow_failure: true
|
||||
only:
|
||||
- tags
|
||||
script:
|
||||
- npmci command npm install -g tslint typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||
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-dbase:npmci
|
||||
services:
|
||||
- docker:stable-dind
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
@ -116,5 +134,5 @@ pages:
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
- public
|
||||
allow_failure: true
|
||||
|
11
.vscode/launch.json
vendored
Normal file
11
.vscode/launch.json
vendored
Normal file
@ -0,0 +1,11 @@
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"request": "launch",
|
||||
"type": "node-terminal"
|
||||
}
|
||||
]
|
||||
}
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@ -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"]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
@ -1,5 +1,6 @@
|
||||
{
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
|
25838
package-lock.json
generated
25838
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
36
package.json
36
package.json
@ -1,10 +1,10 @@
|
||||
{
|
||||
"name": "@pushrocks/smartjwt",
|
||||
"version": "1.0.10",
|
||||
"version": "1.0.14",
|
||||
"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,27 +13,31 @@
|
||||
"format": "(gitzone format)"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.17",
|
||||
"@gitzone/tstest": "^1.0.24",
|
||||
"@pushrocks/tapbundle": "^3.0.13",
|
||||
"@types/node": "^12.7.8",
|
||||
"tslint": "^5.20.0",
|
||||
"@gitzone/tsbuild": "^2.1.27",
|
||||
"@gitzone/tstest": "^1.0.57",
|
||||
"@pushrocks/tapbundle": "^3.2.14",
|
||||
"@types/node": "^16.9.6",
|
||||
"tslint": "^6.1.3",
|
||||
"tslint-config-prettier": "^1.15.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@pushrocks/smartcrypto": "^1.0.7",
|
||||
"@types/jsonwebtoken": "^8.3.4",
|
||||
"@pushrocks/smartcrypto": "^1.0.11",
|
||||
"@types/jsonwebtoken": "^8.5.5",
|
||||
"jsonwebtoken": "^8.5.1"
|
||||
},
|
||||
"files": [
|
||||
"ts/*",
|
||||
"ts_web/*",
|
||||
"dist/*",
|
||||
"dist_web/*",
|
||||
"dist_ts_web/*",
|
||||
"assets/*",
|
||||
"ts/**/*",
|
||||
"ts_web/**/*",
|
||||
"dist/**/*",
|
||||
"dist_*/**/*",
|
||||
"dist_ts/**/*",
|
||||
"dist_ts_web/**/*",
|
||||
"assets/**/*",
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
]
|
||||
}
|
||||
|
30
readme.md
30
readme.md
@ -8,16 +8,32 @@ a package for handling jwt
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartjwt/)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/smartjwt/commits/master)
|
||||
[](https://gitlab.com/pushrocks/smartjwt/commits/master)
|
||||
[](https://www.npmjs.com/package/@pushrocks/smartjwt)
|
||||
[](https://snyk.io/test/npm/@pushrocks/smartjwt)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://prettier.io/)
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](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.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
|
12
test/test.ts
12
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();
|
||||
|
@ -8,7 +8,7 @@ export interface ISmartJWTJSONKeypair {
|
||||
/**
|
||||
* 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;
|
||||
@ -18,19 +18,20 @@ export class SmartJwt {
|
||||
/**
|
||||
* 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) {
|
||||
return plugins.jsonwebtoken.verify(jwtArg, this.publicKey.toPemString(), {
|
||||
algorithms: ['RS256']
|
||||
public async verifyJWTAndGetData(jwtArg: string): Promise<T> {
|
||||
const result = plugins.jsonwebtoken.verify(jwtArg, this.publicKey.toPemString(), {
|
||||
algorithms: ['RS256'],
|
||||
});
|
||||
return result as any;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -53,7 +54,7 @@ export class SmartJwt {
|
||||
public getKeyPairAsJson(): ISmartJWTJSONKeypair {
|
||||
return {
|
||||
privatePem: this.privateKey.toPemString(),
|
||||
publicPem: this.publicKey.toPemString()
|
||||
publicPem: this.publicKey.toPemString(),
|
||||
};
|
||||
}
|
||||
|
||||
@ -74,6 +75,14 @@ export class SmartJwt {
|
||||
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();
|
||||
}
|
||||
|
Reference in New Issue
Block a user