Merge pull request #52 from axa-group/em/events

Support Nodejs 14 LTS... and minor doco updates

Author: nulltoken

.github/workflows/main.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        node-version: [^10, ^12]
+        node-version: [^10.13, ^12.13, ^14.15]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v2

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
+## [3.0.2](https://github.com/axa-group/oauth2-mock-server/compare/v3.0.1...v3.0.2) — 2020-10-29
+
+### Added
+
+- Support Nodejs 14.15 LTS
+
 ## [3.0.1](https://github.com/axa-group/oauth2-mock-server/compare/v3.0.0...v3.0.1) — 2020-10-23
 
 ### Fixed

README.md

@@ -18,6 +18,8 @@ The purpose of this package is to provide an easily configurable OAuth 2 server,
 
 ## How to use
 
+### Installation
+
 Add it to your Node.js project as a development dependency:
 
 With yarn...
@@ -30,6 +32,8 @@ yarn add -D oauth2-mock-server
 npm install --save-dev oauth2-mock-server
 ```
 
+### Quickstart
+
 Here is an example for creating and running a server instance with a single random RSA key:
 
 ```js
@@ -84,54 +88,67 @@ request.get(
 );
 ```
 
+### Customization hooks
+
 It also provides a convenient way, through event emitters, to programmatically customize:
 
 - The JWT access token
+
+  ```js
+  //Modify the expiration time on next token produced
+  service.once('beforeTokenSigning', (token, _req) => {
+    const timestamp = Math.floor(Date.now() / 1000);
+    token.payload.exp = timestamp + 400;
+  });
+  ```
+
+  ```js
+  //Add the client ID to a token
+  const basicAuth = require('basic-auth');
+  service.once('beforeTokenSigning', (token, req) => {
+    const credentials = basicAuth(req);
+    const clientId = credentials ? credentials.name : req.body.client_id;
+    token.payload.client_id = clientId;
+  });
+  ```
+
 - The token endpoint response body and status
-- The userinfo endpoint response body and status
-- The revoke endpoint response body and status
 
-This is particularly useful when expecting the oidc service to behave in a specific way on one single test.
+  ```js
+  //Force the oidc service to provide an invalid_grant response on next call to the token endpoint
+  service.once('beforeResponse', (tokenEndpointResponse, req) => {
+    tokenEndpointResponse.body = {
+      error: 'invalid_grant',
+    };
+    tokenEndpointResponse.statusCode = 400;
+  });
+  ```
 
-```js
-//Force the oidc service to provide an invalid_grant response on next call to the token endpoint
-service.once('beforeResponse', (tokenEndpointResponse, req) => {
-  tokenEndpointResponse.body = {
-    error: 'invalid_grant'
-  };
-  tokenEndpointResponse.statusCode = 400;
-});
+- The userinfo endpoint response body and status
 
-//Force the oidc service to provide an error on next call to userinfo endpoint
-service.once('beforeUserinfo', (userInfoResponse, req) => {
-  userInfoResponse.body = {
-    error: 'invalid_token',
-    error_message: 'token is expired',
-  };
-  userInfoResponse.statusCode = 401;
-});
+  ```js
+  //Force the oidc service to provide an error on next call to userinfo endpoint
+  service.once('beforeUserinfo', (userInfoResponse, req) => {
+    userInfoResponse.body = {
+      error: 'invalid_token',
+      error_message: 'token is expired',
+    };
+    userInfoResponse.statusCode = 401;
+  });
+  ```
 
-//Add the client ID to a token
-const basicAuth = require('basic-auth');
-service.once('beforeTokenSigning', (token, req) => {
-  const credentials = basicAuth(req);
-  const clientId = credentials ? credentials.name : req.body.client_id;
-  token.payload.client_id = clientId;
-});
+- The revoke endpoint response body and status
 
-//Modify the expiration time on next token produced
-service.issuer.once('beforeSigning', (token) => {
-  const timestamp = Math.floor(Date.now() / 1000);
-  token.payload.exp = timestamp + 400;
-});
+  ```js
+  //Simulates a custom token revocation body
+  service.once('beforeRevoke', (revokeResponse, req) => {
+    revokeResponse.body = {
+      result: 'revoked',
+    };
+  });
+  ```
 
-//Simulates a custom token revocation body
-service.once('beforeRevoke', (revokeResponse, req) => {
-  revokeResponse.body = {
-    result: 'revoked'
-  };
-});
-```
+This is particularly useful when expecting the oidc service to behave in a specific way on one single test.
 
 ## Supported endpoints
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "oauth2-mock-server",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "OAuth 2 mock server",
   "keywords": [
     "oauth",
@@ -19,7 +19,7 @@
   },
   "license": "MIT",
   "engines": {
-    "node": "^10.13 || ^12.13",
+    "node": "^10.13 || ^12.13 || ^14.15",
     "yarn": "^1.15.2"
   },
   "repository": {

src/lib/oauth2-issuer.ts

@@ -26,6 +26,7 @@ import { JWK } from 'node-jose';
 import { JWKStore } from './jwk-store';
 import { assertIsAlgorithm, assertIsString } from './helpers';
 import type { Header, MutableToken, Payload, ScopesOrTransform } from './types';
+import { InternalEvents } from './types';
 
 /**
  * Represents an OAuth 2 issuer.
@@ -117,7 +118,7 @@ export class OAuth2Issuer extends EventEmitter {
      * @event OAuth2Issuer#beforeSigning
      * @param {MutableToken} token The JWT header and payload.
      */
-    this.emit('beforeSigning', token);
+    this.emit(InternalEvents.BeforeSigning, token);
 
     const options: jwt.SignOptions = {
       algorithm: arguments.length === 0 || signed ? getKeyAlg(key) : 'none',

src/lib/oauth2-service.ts

@@ -35,6 +35,7 @@ import type {
   MutableToken,
   ScopesOrTransform,
 } from './types';
+import { InternalEvents, PublicEvents } from './types';
 
 const OPENID_CONFIGURATION_PATH = '/.well-known/openid-configuration';
 const TOKEN_ENDPOINT_PATH = '/token';
@@ -93,15 +94,15 @@ export class OAuth2Service extends EventEmitter {
     expiresIn: number,
     req: IncomingMessage
   ): string {
-    this.issuer.once('beforeSigning', (token: MutableToken) => {
+    this.issuer.once(InternalEvents.BeforeSigning, (token: MutableToken) => {
       /**
        * Before token signing event.
        *
        * @event OAuth2Service#beforeTokenSigning
        * @param {MutableToken} token The unsigned JWT header and payload.
        * @param {IncomingMessage} req The incoming HTTP request.
        */
-      this.emit('beforeTokenSigning', token, req);
+      this.emit(PublicEvents.BeforeTokenSigning, token, req);
     });
 
     return this.issuer.buildToken(
@@ -262,7 +263,7 @@ export class OAuth2Service extends EventEmitter {
      * @param {MutableResponse} response The response body and status code.
      * @param {IncomingMessage} req The incoming HTTP request.
      */
-    this.emit('beforeResponse', tokenEndpointResponse, req);
+    this.emit(PublicEvents.BeforeResponse, tokenEndpointResponse, req);
 
     return res
       .status(tokenEndpointResponse.statusCode)
@@ -327,7 +328,7 @@ export class OAuth2Service extends EventEmitter {
      * @param {MutableResponse} response The response body and status code.
      * @param {IncomingMessage} req The incoming HTTP request.
      */
-    this.emit('beforeUserinfo', userInfoResponse, req);
+    this.emit(PublicEvents.BeforeUserinfo, userInfoResponse, req);
 
     res.status(userInfoResponse.statusCode).json(userInfoResponse.body);
   };
@@ -345,7 +346,7 @@ export class OAuth2Service extends EventEmitter {
      * @param {MutableResponse} response The response body and status code.
      * @param {IncomingMessage} req The incoming HTTP request.
      */
-    this.emit('beforeRevoke', revokeResponse, req);
+    this.emit(PublicEvents.BeforeRevoke, revokeResponse, req);
 
     return res.status(revokeResponse.statusCode).json(revokeResponse.body);
   };

src/lib/types.ts

@@ -44,3 +44,14 @@ export type ScopesOrTransform = string | string[] | JwtTransform;
 export interface JwtTransform {
   (header: Header, payload: Payload): void;
 }
+
+export enum PublicEvents {
+  BeforeTokenSigning = 'beforeTokenSigning',
+  BeforeResponse = 'beforeResponse',
+  BeforeUserinfo = 'beforeUserinfo',
+  BeforeRevoke = 'beforeRevoke',
+}
+
+export enum InternalEvents {
+  BeforeSigning = 'beforeSigning',
+}