npmpackage.info

middy-middleware-jwt-auth

A Middy middleware for authentication via JSON web tokens

6.1.0

MIT

TypeScript

24.12 kB

219,951 2.6

Installations

npm install middy-middleware-jwt-auth

Pull Requests

Open

1

Total

440

Closed

197

Merged

242

Issues

Open

0

Total

15

Closed

15

Releases

6.1.0

Published on 27 Jan 2024

6.0.0

Published on 03 Mar 2023

5.1.1

Published on 27 Nov 2022

View all 3 releases

Developer

dbartholomae

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

16.20.2

NPM Version

8.19.4 Statistics

25 Stars

685 Commits

8 Forks

3 Watching

4 Branches

6 Contributors

Updated on 18 Oct 2024

Bundle Size

80.71 kB

Minified

24.12 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (94.88%)

JavaScript (5.12%)

Total Downloads

Cumulative downloads

Total Downloads

219,951

Last day

88.2%

352

Compared to previous day

Last week

42.1%

1,242

Compared to previous week

Last month

-5.3%

3,668

Compared to previous month

Last year

38.4%

70,983

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

middy-middleware-jwt-auth

npm bundle size Libraries.io dependency status for latest release

A middy JSON web token authorization middleware inspired by express-jwt.

Installation

Download node at nodejs.org and install it, if you haven't already.

1npm install middy-middleware-jwt-auth --save

Documentation

There is additional documentation.

Usage

1import createHttpError from "http-errors";
2import middy from "@middy/core";
3import httpErrorHandler from "@middy/http-error-handler";
4import httpHeaderNormalizer from "@middy/http-header-normalizer";
5import JWTAuthMiddleware, {
6  EncryptionAlgorithms,
7  IAuthorizedEvent,
8} from "middy-middleware-jwt-auth";
9
10// Optionally define the token payload you expect to receive
11interface ITokenPayload {
12  permissions: string[];
13}
14
15// Optionally define a type guard for the token payload
16function isTokenPayload(token: any): token is ITokenPayload {
17  return (
18    token != null &&
19    Array.isArray(token.permissions) &&
20    token.permissions.every((permission: any) => typeof permission === "string")
21  );
22}
23
24// This is your AWS handler
25const helloWorld = async (event: IAuthorizedEvent<ITokenPayload>) => {
26  // The middleware adds auth information if a valid token was added
27  // If no auth was found and credentialsRequired is set to true, a 401 will be thrown. If auth exists you
28  // have to check that it has the expected form.
29  if (event.auth!.payload.permissions.indexOf("helloWorld") === -1) {
30    throw createHttpError(
31      403,
32      `User not authorized for helloWorld, only found permissions [${event.auth!.permissions.join(", ")}]`,
33      {
34        type: "NotAuthorized",
35      },
36    );
37  }
38
39  return {
40    body: JSON.stringify({
41      data: `Hello world! Here's your token: ${event.auth!.token}`,
42    }),
43    statusCode: 200,
44  };
45};
46
47// Let's "middyfy" our handler, then we will be able to attach middlewares to it
48export const handler = middy(helloWorld)
49  .use(httpHeaderNormalizer()) // Make sure authorization header is saved in lower case
50  .use(httpErrorHandler()) // This middleware is needed do handle the errors thrown by the JWTAuthMiddleware
51  .use(
52    JWTAuthMiddleware({
53      /** Algorithm to verify JSON web token signature */
54      algorithm: EncryptionAlgorithms.HS256,
55      /** An optional boolean that enables making authorization mandatory */
56      credentialsRequired: true,
57      /** An optional function that checks whether the token payload is formatted correctly */
58      isPayload: isTokenPayload,
59      /** A string or buffer containing either the secret for HMAC algorithms, or the PEM encoded public key for RSA and ECDSA */
60      secretOrPublicKey: "secret",
61      /**
62       * An optional function used to search for a token e. g. in a query string. By default, and as a fall back,
63       * event.headers.authorization and event.headers.Authorization are used.
64       */
65      tokenSource: (event: any) => event.queryStringParameters.token,
66    }),
67  );

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/dbartholomae/middy-middleware-jwt-auth/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/dbartholomae/middy-middleware-jwt-auth/build.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/dbartholomae/middy-middleware-jwt-auth/build.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:81: update your workflow using https://app.stepsecurity.io/secureworkflow/dbartholomae/middy-middleware-jwt-auth/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/dbartholomae/middy-middleware-jwt-auth/build.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/dbartholomae/middy-middleware-jwt-auth/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/dbartholomae/middy-middleware-jwt-auth/build.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/dbartholomae/middy-middleware-jwt-auth/build.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/dbartholomae/middy-middleware-jwt-auth/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/close-stale-issues.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/dbartholomae/middy-middleware-jwt-auth/close-stale-issues.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-labels.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/dbartholomae/middy-middleware-jwt-auth/update-labels.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-labels.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/dbartholomae/middy-middleware-jwt-auth/update-labels.yml/main?enable=pin
Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 6 third-party GitHubAction dependencies pinned

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

2.6

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to middy-middleware-jwt-auth

@middy/util

6.0.0

🛵 The stylish Node.js middleware engine for AWS Lambda (util package)

@middy/http-json-body-parser

6.0.0

Http JSON body parser middleware for the middy framework

@middy/http-error-handler

6.0.0

Http error handler middleware for the middy framework

@middy/http-cors

6.0.0

CORS (Cross-Origin Resource Sharing) middleware for the middy framework

middy-middleware-jwt-auth

Installations

Pull Requests

1

440

197

242

Issues

0

15

15

Releases

Developer

dbartholomae

Developer Guide

CommonJS

Yes

16.20.2

8.19.4

Statistics

Bundle Size

80.71 kB

24.12 kB

Languages

Total Downloads

219,951

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

middy-middleware-jwt-auth

Installation

Documentation

Usage

10

10

10

1

0

0

0

0

0

0

0

0

0

2.6

/10

Other packages similar to middy-middleware-jwt-auth