npmpackage.info

Gathering detailed insights and metrics for middy-middleware-jwt-auth

middy-middleware-jwt-auth

A Middy middleware for authentication via JSON web tokens

6.1.0

MIT

TypeScript

24.12 kB

229,292 2.6

Installations

npm install middy-middleware-jwt-auth

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

16.20.2

NPM Version

8.19.4 Score

69.3

Supply Chain

97.3

Quality

73.5

Maintenance

100

Vulnerability

98.6

License

Pull Requests

Open

1

Total

440

Closed

197

Merged

242

Issues

Open

0

Total

15

Closed

15

Releases

6.1.0

Updated on Jan 27, 2024

6.0.0

Updated on Mar 03, 2023

5.1.1

Updated on Nov 27, 2022

View All 3 releases

Contributors

Unable to fetch Contributors

View All 6 Contributors

Languages

TypeScript

JavaScript

TypeScript (94.88%)

JavaScript (5.12%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

dbartholomae

Download Statistics

Total Downloads

229,292

Last Day

191

Last Week

784

Last Month

3,922

Last Year

60,858

GitHub Statistics

MIT License

25 Stars

685 Commits

8 Forks

3 Watchers

4 Branches

6 Contributors

Updated on Oct 18, 2024

Bundle Size

80.71 kB

Minified

24.12 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

6.1.0

Package Id

middy-middleware-jwt-auth@6.1.0

Unpacked Size

39.16 kB

Size

10.48 kB

File Count

NPM Version

8.19.4

Node Version

16.20.2

Published on

Jan 27, 2024

Total Downloads

Cumulative downloads

Total Downloads

229,292

Last Day

-17%

191

Compared to previous day

Last Week

-20.1%

784

Compared to previous week

Last Month

31.4%

3,922

Compared to previous month

Last Year

-1.8%

60,858

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

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

Binary-Artifacts

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

10

Dangerous-Workflow

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

10

License

Determines if the project has defined a license.

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

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

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: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/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/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 2025-02-10

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

middy-middleware-jwt-auth

Installations

Developer Guide

Yes

CommonJS

16.20.2

8.19.4

Score

Pull Requests

1

440

197

242

Issues

0

15

15

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

dbartholomae

Download Statistics

GitHub Statistics

Bundle Size

80.71 kB

24.12 kB

Maintainers

Package Meta Information

Total Downloads

229,292

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