integreat-authenticator-jwt

1.1.3 • Public • Published

JWT authenticator for Integreat

Signs a JWT token.

npm Version Maintainability

Getting started

Prerequisits

Requires node v18 and Integreat v1.0.

Installing and using

Install from npm:

npm install integreat-authenticator-jwt

The authenticator supports the following options:

  • key: The key to sign the JWT with. Required
  • algorithm: The algorithm to sign with. Default HS256
  • subPath: A dot notation path into the request object, to get the JWT sub claim
  • audience: The JWT audience claim. Required
  • expiresIn: The expiration time for the JWT, as a ms string. When not set, the token will never expire
  • payload: An object whose properties will be set on the JWT payload
  • trustedKeys: A JavaScript Map of trusted keys used for validating JWTs on incoming actions. This is only relevant for the validate() method, and it is also the only option relevant for this method.

Running the tests

The tests can be run with npm test.

Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests.

License

This project is licensed under the ISC License - see the LICENSE file for details.

Readme

Keywords

none

Package Sidebar

Install

npm i integreat-authenticator-jwt

Weekly Downloads

16

Version

1.1.3

License

ISC

Unpacked Size

23.7 kB

Total Files

26

Last publish

Collaborators

  • kjellmorten