@lindorm-io/koa-jwt

Token issuer middleware for @lindorm-io/koa applications.

Installation

1npm install --save @lindorm-io/koa-jwt

Peer Dependencies

This package has the following peer dependencies:

• @lindorm-io/jwt
• @lindorm-io/key-pair
• @lindorm-io/koa
• @lindorm-io/koa-jwt
• @lindorm-io/winston

Usage

Token Issuer Middleware

1koaApp.addMiddleware(
2  tokenIssuerMiddleware({
3    issuer: "https://authentication.service", // used for token validation
4  }),
5);

Token Validation Middleware

1const middleware = tokenValidationMiddleware({
2  audiences: [configuration.server_oauth_client_id], // OPTIONAL | array | used when all tokens of this type require specific audience
3  clockTolerance: 300, // OPTIONAL | number | giving some tolerance for time validation
4  contextKey: "tokenKey", // REQUIRED | string | used to set validated token on context (ctx.token.tokenKey)
5  issuer: "https://authorization.service", // REQURIED | uri | used for token validation
6  subjectHint: "identity", // OPTIONAL [ string ]
7  types: ["refresh_token"], // REQUIRED | string | token type
8});
9
10router.use(
11  middleware(
12    "request.body.tokenName", // REQUIRED | string | path used to find token
13    {
14      adjustedAccessLevel: 2, // OPTIONAL | number
15      audiences: [configuration.server_oauth_client_id], // OPTIONAL | array | used when token on specific route requires specific audiences
16      levelOfAssurance: 3, // OPTIONAL | number
17      maxAge: 400, // OPTIONAL | number
18      permissions: ["admin"], // OPTIONAL | array
19      scopes: ["openid"], // OPTIONAL | array
20
21      fromPath: {
22        audience: "query.clientId", // OPTIONAL | string | path to string
23        nonce: "entity.entityName.nonce", // OPTIONAL | string | path to string
24        subject: "token.bearerToken.subject", // OPTIONAL | string | path to string
25      }, // OPTIONAL | object
26
27      optional: false, // OPTIONAL [ boolean ] - determines if middleware should throw when token is missing
28    },
29  ),
30);