With this configuration, your api will require a valid Access Token JWT bearer token for all routes.
Successful requests will have the following properties added to them:
app.get('/api/messages',
(req, res, next) => {
const auth = req.auth;
auth.header; // The decoded JWT header.
auth.payload; // The decoded JWT payload.
auth.token; // The raw JWT token.
}
);
Security Headers
Along with the other security best practices in the Express.js documentation, we recommend you use helmet in addition to this middleware which can help protect your app from some well-known web vulnerabilities by setting default security HTTP headers.
Error Handling
This SDK raises errors with err.status and err.headers according to rfc6750. The Express.js default error handler will set the error response with:
res.statusCode set from err.status
res.statusMessage set according to the status code.
The body will be the HTML of the status code message when in production environment, otherwise will be err.stack.
Any headers specified in an err.headers object.
The error_description in the WWW-Authenticate header will contain useful information about the error, which you may not want to disclose in Production.
See the Express.js docs on error handling for more information on writing custom error handlers.
API Reference
auth - Middleware that will return a 401 if a valid Access token JWT bearer token is not provided in the request.
AuthResult - The properties added to req.auth upon successful authorization.
requiredScopes - Check a token's scope claim to include a number of given scopes, raises a 403 insufficient_scope error if the value of the scope claim does not include all the given scopes.
claimEquals - Check a token's claim to be equal a given JSONPrimitive (string, number, boolean or null) raises a 401 invalid_token error if the value of the claim does not match.
claimIncludes - Check a token's claim to include a number of given JSONPrimitives (string, number, boolean or null) raises a 401 invalid_token error if the value of the claim does not include all the given values.
claimCheck - Check the token's claims using a custom method that receives the JWT Payload and should return true if the token is valid. Raises a 401 invalid_token error if the function returns false.
Feedback
Contributing
We appreciate feedback and contribution to this repo! Before you get started, please see the following:
Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.
What is Auth0?
Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?
This project is licensed under the MIT license. See the LICENSE file for more info.
FAQs
Authentication middleware for Express.js that validates JWT bearer access tokens.
We found that express-oauth2-jwt-bearer demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 44 open source maintainers collaborating on the project.
Package last updated on 27 Oct 2022
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
The Python Software Foundation has expanded its CNA scope to include the Pallets Projects, enabling faster, more reliable CVE tracking for critical frameworks used in Python applications.
Elastic’s return to open source with the AGPL license has been met with skepticism, as many developers see it as a strategic move rather than a genuine effort to restore user trust and freedoms.
A new "revival hijack" supply chain attack targets deleted Python packages, with an estimated 22K packages at risk. Socket can detect and block hijacked packages that have added malicious code.