{"_id":"@applicazza/node-jwt-vault","_rev":"1-ffa9c67288c01d21a37b414ce8280f2d","name":"@applicazza/node-jwt-vault","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@applicazza/node-jwt-vault","version":"0.0.1","author":{"name":"Artyom Sokolov","email":"artyom@applicazza.com"},"description":"Create, sign and validate JWT tokens with Hashicorp Vault","main":"dist/index.js","license":"MIT","dependencies":{"axios":"^0.21.1","base64url":"^3.0.1","openapi-client-axios":"^3.7.8"},"devDependencies":{"@types/axios":"^0.14.0","@types/base64url":"^2.0.0","@types/chai":"^4.2.14","@types/mocha":"^8.2.0","@types/node":"^14.14.20","chai":"^4.2.0","mocha":"^8.2.1","openapi-client-axios-typegen":"^1.1.9","ts-node":"^9.1.1","typescript":"^4.1.3"},"scripts":{"build":"tsc","gen:openapi":"typegen openapi/schema.json > src/vault/index.d.ts","test":"mocha -r ts-node/register tests/**/*.spec.ts"},"gitHead":"1e19ef9ebdc6c6afa1c1863fd735ccb543e699c2","_id":"@applicazza/node-jwt-vault@0.0.1","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-Bbl7l4zrfRoe3allYlnY4af13M3dcu7m5jR4lQpc4puW7oJTxLNVciFE3gkI+ZQLctQ7WC32iRRR5Wr8o+5rmw==","shasum":"fe0a244655fbe0f2e66b3d9e8e8025662c291b3d","tarball":"https://registry.npmjs.org/@applicazza/node-jwt-vault/-/node-jwt-vault-0.0.1.tgz","fileCount":10,"unpackedSize":261081,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgAE2kCRA9TVsSAnZWagAAuMUQAJK9eX8bLkxcpQtuYzon\nNDElQi7JvPRQg41Jux63w1NpaMfT+IyqJXChm6eglr/jRGSHzzo5spKjOneM\nQXCQ9EqlGMelk4FHwFZTuBkjanlT/FBsBa1xEr/BzVETU2E9VCwxzZumrcAT\nX53IYujK5uPVvP5aLUpmdLI4r8CvEWCmBpfbJ21XmBzFmj4SlmhmG52A0BxO\nOjUvkUeFa963EVAMugeoojDSIrTvYTfY/gLyEa2Zra4Wu+Qn8SjC6OXctNJg\nsX0BXEbVEtS1d0gQ/05zlSvHYl+bo8fPqfi6jbIVS5G0aoNSefLXN7y2Ld2N\now2v7FNYIdEdrYpJnisfZA84011/McIPsBzi16qBUpiK7cTh3B7lXzPVvdAx\nQ69+o/N3mxuis2c5WQUKd9ttl6fHBbu4tnKCJ2fa1+H7wz4kMXuigl8sNj79\ndJiUqC4Kj2BqtVaKVdmYNaU6somYFNpkypL+a7VsKWS2m3QuPnu373awTjHo\nAkKLgmKGbdELfHLICTSf3comaznx1+htHDfST+5ISZ9h3QNia0CkM+SyZoRP\n/Zq1NbGV0giaStyzH3aF3Z3ds3/F+WhR1PFXtOuFwyw0IXO8KMK0ZlnGk1/c\n9eaRHC3QT9gafcn4dAWW/TRiKv2aaFcKmG7uQ/HmXFfjRRQcBhEeCpU2wvBN\nxUql\r\n=1mL0\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBsYRSqyx9kX8aLK+ko9qVqkT4+skERhs56lbCwOIA2hAiAnOYJucaIGSJ+Gl/N4tSqKz3Z4Zak1AS/tddfC+rllhg=="}]},"_npmUser":{"name":"applicazza","email":"artyom@applicazza.com"},"directories":{},"maintainers":[{"name":"applicazza","email":"artyom@applicazza.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/node-jwt-vault_0.0.1_1610632612135_0.5251994488399248"},"_hasShrinkwrap":false}},"time":{"created":"2021-01-14T13:56:52.085Z","0.0.1":"2021-01-14T13:56:52.322Z","modified":"2022-04-04T14:55:52.172Z"},"maintainers":[{"name":"applicazza","email":"artyom@applicazza.com"}],"description":"Create, sign and validate JWT tokens with Hashicorp Vault","author":{"name":"Artyom Sokolov","email":"artyom@applicazza.com"},"license":"MIT","readme":"# Node JWT Vault\n\n## Description\n\n## Installation\n\n```shell\nyarn add @applicazza/node-jwt-vault\n```\n\n## Usage\n\n* Initialise `OpenAPIClientAxios`\n\n```typescript\nimport { Document, OpenAPIClientAxios } from 'openapi-client-axios';\nimport { VaultApiClient } from '@applicazza/node-jwt-vault';\n\nconst vaultToken = '00000000-0000-0000-0000-000000000000';\n\nconst vault = new OpenAPIClientAxios({\n    definition: definition as Document,\n    axiosConfigDefaults: {\n        baseURL: 'http://127.0.0.1:8200/v1',\n        headers: {\n            'X-Vault-Token': vaultToken,\n        },\n    }\n});\n\nconst vaultClient = vault.initSync<VaultApiClient>();\n```\n\nOr \n\n```typescript\nimport { OpenAPIClientAxios } from 'openapi-client-axios';\nimport { VaultApiClient } from '@applicazza/node-jwt-vault';\n\nconst vaultToken = '00000000-0000-0000-0000-000000000000';\n\nconst vault = new OpenAPIClientAxios({\n    definition: './path/to/openapi/schema.json',\n    axiosConfigDefaults: {\n        baseURL: 'http://127.0.0.1:8200/v1',\n        headers: {\n            'X-Vault-Token': vaultToken,\n        },\n    }\n});\n\nconst vaultClient = vault.init<VaultApiClient>();\n```\n\nRead more about OpenAPIClientAxios [here](https://github.com/anttiviljami/openapi-client-axios).\n\n* Create and sign token\n\n```typescript\nimport { Algorithms, signToken, verifyToken } from '@applicazza/node-jwt-vault';\n\nconst token = await signToken({\n    algorithm: Algorithms.ES384,\n    claims,\n    keyName,\n    vaultClient,\n});\n```\n\n* Verify token\n\n```typescript\nimport { verifyToken } from '@applicazza/node-jwt-vault';\n\nconst isValid = await verifyToken({token, vaultClient});\n```\n\n## Development\n\n### Testing\n\n* Launch Vault in development mode with simple token\n\n```shell\nVAULT_DEV_ROOT_TOKEN_ID=00000000-0000-0000-0000-000000000000 vault server -dev\n```\n\n* Enable `Transit` engine\n\n```shell\nvault secrets enable transit\n```\n\n* Create key with type rsa-2048\n\n```shell\nvault write -f transit/keys/2048 type=rsa-2048\n```\n\n* Run tests\n\n```\nyarn test\n```\n\n## License\n\nMIT License\n\nCopyright (c) 2021 applicazza\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.","readmeFilename":"README.md"}