{"_id":"@arsa-dev/keycloak-backend","_rev":"4-7399c4b7331a2e15dd0e263f7f2aa38b","name":"@arsa-dev/keycloak-backend","dist-tags":{"latest":"2.1.3"},"versions":{"2.1.1":{"name":"@arsa-dev/keycloak-backend","version":"2.1.1","description":"Keycloak Node.js minimalist connector for backend services integration. ","main":"src/index.js","scripts":{"transpile":"babel libs --out-dir src --ignore templates/* --copy-files","lint":"standard","format":"standard --fix","test":"echo 'TODO'"},"repository":{"type":"git","url":"git+https://github.com/jkyberneees/keycloak-backend.git"},"keywords":["keycloak","auth","oauth","jwt","rest"],"author":{"name":"Rolando Santamaria Maso","email":"kyberneees@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/jkyberneees/keycloak-backend/issues"},"homepage":"https://github.com/jkyberneees/keycloak-backend#readme","dependencies":{"axios":"^0.21.0","jsonwebtoken":"^8.5.1"},"devDependencies":{"babel-cli":"^6.26.0","babel-preset-env":"^1.7.0","standard":"^15.0.0"},"gitHead":"6889827e619b681cacb559c2c5a0594459b3d053","_id":"@arsa-dev/keycloak-backend@2.1.1","_nodeVersion":"16.17.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-rdFPPYDh5FC9vP+y7Y6AGxitG0i2P5KzwA7WMmwFhcTHRxxTWn6xjbI59kylFV2Y+ZjJ5xpERDC95+YZHNwTfA==","shasum":"eb476c31959fe6886566d8824368da7f55581cb7","tarball":"https://registry.npmjs.org/@arsa-dev/keycloak-backend/-/keycloak-backend-2.1.1.tgz","fileCount":8,"unpackedSize":12468,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBbNCiF3taYL0fzP53I1UYkhONsxDoQ92zMcpAVB51FEAiEApgDVfEUM1SVkGFKITRF5qc4r6se0/ZW0iEQ3L74Ej6Y="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjPzNpACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrSBQ/+KVNSW6eTpRfgyNX9NqRqUUbAgVU8O+JR5x30iXOW//MdGqSW\r\n3T1ZzPnNBkClxgu+q8GrumsgRJYfDjwAfpZO/FnIVJL16//C/nJi42hzrm2a\r\nrjoGZNh1Jswzl9Ln4xybHoX7x00/ffG7fk5UkepKoVGT+6aLoNmgUMMho6Rz\r\nMMLmxc5OUDll+b/TdeRWsDG4cPzHWWCgVRF5dY0hEuBE3wwW1SL5Hf68OsUM\r\nVDYfZBSGzh+TaHtSMc8xulMUZnnjF9jCM+/bruOCv9KePbD3Ry/6f1QFjtIr\r\nMhIjWo6EnMdeAqlQNF3l52P7hvh13PU2rDr4dV020UFsdexo28ws+36D8N2D\r\nyc4UJfTpaJemCNZQXXRLh1102ShZMXLqEVMWfM8yodGRmrDha5U4/qsYhwB9\r\nfmy8xtkcdaBfnafUXfdVoQn+nrHZeP5Zcmx6xkSUmQAnXGPz2JuUEG5+7cd4\r\newxdx2KMWqzT49Xs32bJpC/CDOrRM0E/CL2c1RhvP+D6DXqmG5tE4urrex4C\r\nMcjC9v6y1htpUlh0bAylcX59GSL7A08kmoeJFU8QgjFgH6XqU5bgKPyf7x8N\r\nyy6vuvv2apWH8TUJR6pmwaVTeslglcgDILIxubSJZUSqr3XiGzPF9BF3PYl9\r\nyDxJzI7/9M2X9fsr8aZxOCIlk5u9jNcc1B0=\r\n=OGZy\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"arsa-dev","email":"antonioramonsm@gmail.com"},"directories":{},"maintainers":[{"name":"arsa-dev","email":"antonioramonsm@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/keycloak-backend_2.1.1_1665086313128_0.34090633026723194"},"_hasShrinkwrap":false,"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"2.1.2":{"name":"@arsa-dev/keycloak-backend","version":"2.1.2","description":"Keycloak Node.js minimalist connector for backend services integration. ","main":"src/index.js","scripts":{"transpile":"babel libs --out-dir src --ignore templates/* --copy-files","lint":"standard","format":"standard --fix","test":"echo 'TODO'"},"repository":{"type":"git","url":"git+https://github.com/jkyberneees/keycloak-backend.git"},"keywords":["keycloak","auth","oauth","jwt","rest"],"author":{"name":"Rolando Santamaria Maso","email":"kyberneees@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/jkyberneees/keycloak-backend/issues"},"homepage":"https://github.com/jkyberneees/keycloak-backend#readme","dependencies":{"axios":"^0.21.0","jsonwebtoken":"^8.5.1"},"devDependencies":{"babel-cli":"^6.26.0","babel-preset-env":"^1.7.0","standard":"^15.0.0"},"gitHead":"6889827e619b681cacb559c2c5a0594459b3d053","_id":"@arsa-dev/keycloak-backend@2.1.2","_nodeVersion":"16.17.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-wwAeyC2yu4VXXjG5oHLRHDgQpIvYjcFvNA8Zk7CItIFbI8rAd26sB9rVRbTflBlLA9a/DxajC9ZMlq5CzSWt9A==","shasum":"b7a522bc026feeb00f666ace60ee07d381d3b9a6","tarball":"https://registry.npmjs.org/@arsa-dev/keycloak-backend/-/keycloak-backend-2.1.2.tgz","fileCount":8,"unpackedSize":12464,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGGPou+orvB2L1J2v9V4QzkQ7ZTwawz+mNjT6FR60RR7AiBAt17OeGj21ZFQ/6jGo3can38tshxUuHECp1LA+FdeCw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjPzWIACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpEbA//XaHCUhxv0Wj0M/54BE4P4C0gT0E5Nu/cwaZQVYuMjVHpEsYS\r\nrBOBTkF/44yNye3XmefLkXvQ/2MT0UIuFeTr0hX+6a04E+3qZ13tAW5pMZW1\r\n1eLUUaWdrm9FnaARAR1INdkP9ygiZ4zQXHTjDGwQN61juU4V2DmMTx8nA2of\r\nz7kc3yiakx4YmyfZFdRcXbtsyNDyDwQ5qJBieukNonsQE1dSCkUrEJtbZIkq\r\n2sJNiC8g07ofA8YoAy9l/7XIOycI2mMfxwff2+pkngKBApNnU9NWLrbQctMX\r\nY58AHBqv77moFC9AvmSmRByTctEDpq0axGadBTYliR2G8zoGM/3JxNI72Ht9\r\n1f3a0ArWXzUHDRHd8B8+ibG7Kk1cPXwjooBDY9CCwgVKo7kR8Yvdf2OphsWG\r\npA7kf1xDL+hs3QaM7FIfG0B3BU3TaxnyBK1E6ny1jOCp98yDX8ouTfTtl9u6\r\n/D9mapB1VPLRyc36wgLgwwSCj+qYo0lpCjgD/tHBoNsOOn+ChW54vb1ruatg\r\nz7Rgyajy0fsakJxt8M0REkoYPJtL++IBa6o6AKWvAJvUi0Q4BjqmigBBjJmx\r\n2S20prL6X2fEl0CclLwZwECZ20+YP0V9D5Ne25RPWo5Vj+2f45+PHEFgROh9\r\nKsryloRHKhbxwa4LxFfrDqJ7eUwNjJGmTmI=\r\n=MhCl\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"arsa-dev","email":"antonioramonsm@gmail.com"},"directories":{},"maintainers":[{"name":"arsa-dev","email":"antonioramonsm@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/keycloak-backend_2.1.2_1665086856571_0.19292924268717848"},"_hasShrinkwrap":false,"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"2.1.3":{"name":"@arsa-dev/keycloak-backend","version":"2.1.3","description":"Keycloak Node.js minimalist connector for backend services integration. ","main":"src/index.js","scripts":{"transpile":"babel libs --out-dir src --ignore templates/* --copy-files","lint":"standard","format":"standard --fix","test":"echo 'TODO'"},"repository":{"type":"git","url":"git+https://github.com/jkyberneees/keycloak-backend.git"},"keywords":["keycloak","auth","oauth","jwt","rest"],"author":{"name":"Rolando Santamaria Maso","email":"kyberneees@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/jkyberneees/keycloak-backend/issues"},"homepage":"https://github.com/jkyberneees/keycloak-backend#readme","dependencies":{"axios":"^0.21.0","jsonwebtoken":"^8.5.1"},"devDependencies":{"babel-cli":"^6.26.0","babel-preset-env":"^1.7.0","standard":"^15.0.0"},"gitHead":"f535f1f1d0754c7d8923a3d047051658c293c873","_id":"@arsa-dev/keycloak-backend@2.1.3","_nodeVersion":"16.17.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-Rwtf+PNHb0kYB9Mx91HQnq28EwzluXE6inR8Lzks1bjhBghBaJG6SdeWG2fMgP1vss7Ax5eGZILV+cyigq+WhQ==","shasum":"484f61ffd629d25382a1fdbcae69cb11592d1207","tarball":"https://registry.npmjs.org/@arsa-dev/keycloak-backend/-/keycloak-backend-2.1.3.tgz","fileCount":3,"unpackedSize":5315,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCz3V1YQDD4zm9EghLZtK+tsetlGqTNC8tZQQkq054kegIgaE3tGCI0+oCzTqZ/rJlK4LjJ40PpqKDqyukOmIAmLVI="}]},"_npmUser":{"name":"arsa-dev","email":"antonioramonsm@gmail.com"},"directories":{},"maintainers":[{"name":"arsa-dev","email":"antonioramonsm@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/keycloak-backend_2.1.3_1688493436867_0.8230559288827402"},"_hasShrinkwrap":false,"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"time":{"created":"2022-10-06T19:58:32.987Z","2.1.1":"2022-10-06T19:58:33.341Z","modified":"2023-07-04T17:58:12.364Z","2.1.2":"2022-10-06T20:07:36.800Z","2.1.3":"2023-07-04T17:57:17.028Z"},"maintainers":[{"name":"arsa-dev","email":"antonioramonsm@gmail.com"}],"description":"Keycloak Node.js minimalist connector for backend services integration. ","homepage":"https://github.com/jkyberneees/keycloak-backend#readme","keywords":["keycloak","auth","oauth","jwt","rest"],"repository":{"type":"git","url":"git+https://github.com/jkyberneees/keycloak-backend.git"},"author":{"name":"Rolando Santamaria Maso","email":"kyberneees@gmail.com"},"bugs":{"url":"https://github.com/jkyberneees/keycloak-backend/issues"},"license":"MIT","readme":"# DEPRECATED\n\nOriginal package got updated and rewritted in typescript, supporting new versions of keycloak. See and download it at https://github.com/BackendStack21/keycloak-backend\n\n# keycloak-backend\nKeycloak Node.js minimalist connector for backend services integration. It aims to serve as base for high performance authorization middlewares.\n\n> Note: Version 2.x uses `jsonwebtoken 8.x`\n\n## Keycloak Introduction\nThe awesome open-source Identity and Access Management solution develop by RedHat.\nKeycloak support those very nice features you are looking for:\n- Single-Sign On\n- LDAP and Active Directory\n- Standard Protocols\n- Social Login\n- Clustering\n- Custom Themes\n- Centralized Management\n- Identity Brokering\n- Extensible\n- Adapters\n- High Performance\n- Password Policies\n\nMore about Keycloak: http://www.keycloak.org/\n\n## Using the keycloak-backend module\n### Instantiating\n```js\nconst keycloak = require('keycloak-backend')({\n    \"realm\": \"your realm name\",\n    \"auth-server-url\": \"http://keycloak.dev:8080\",\n    \"client_id\": \"your client name\",\n    \"client_secret\": \"c88a2c21-9d1a-4f83-a18d-66d75c4d8020\", // if required\n    \"username\": \"your service username\",\n    \"password\": \"your service password\"\n});\n```\n\n### Validating access tokens\n#### Online validation:\nThis method requires online connection to the Keycloak service to validate the access token. It is highly secure since it also check for the possible token invalidation. The disadvantage is that a request to the Keycloak service happens on every validation attempt.\n```js\nlet token = await keycloak.jwt.verify(someAccessToken);\n//console.log(token.isExpired());\n//console.log(token.hasRealmRole('user'));\n//console.log(token.hasApplicationRole('app-client-name', 'some-role'));\n```\n\n#### Offline validation:\nThis method perform offline JWT verification against the access token using the Keycloak Realm public key. Performance is higher compared to the online method, the disadvantage is that access token invalidation will not work until the token is expired.\n```js\nlet cert = fs.readFileSync('public_cert.pem');\ntoken = await keycloak.jwt.verifyOffline(someAccessToken, cert);\n//console.log(token.isExpired());\n//console.log(token.hasRealmRole('user'));\n//console.log(token.hasApplicationRole('app-client-name', 'some-role'));\n```\n\n### Generating service access token\nEfficiently maintaining a valid access token can be hard. Get it easy by using:\n```js\nlet accessToken = await keycloak.accessToken.get()\n```\nThen:\n```js\nrequest.get('http://serviceb.com/v1/fetch/accounts', {\n  'auth': {\n    'bearer': await keycloak.accessToken.get()\n  }\n});\n```\n> For this feature, the authentication details described in the configuration options are used.\n\n### Retrieve users information by id\nSometimes backend services only have a target user identifier to digg for details, in such cases, you can contact the Keycloak service by:\n\n#### Retrieve user details by id\n```js\nlet details = await keycloak.users.details(uid);\n```\n\n#### Retrieve user roles by id\n```js\nlet details = await keycloak.users.roles(uid, [\n    // clients id here for roles retrieval\n  ],\n  true // include realm roles ?\n);\n```\n\n## Tests\nWIP\n","readmeFilename":"README.md"}