Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 3x 3x 3x 2x 1x 1x 2x 2x 1x 1x 2x 3x 3x 3x 3x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 310x 3x 3x 1x 1x 1x 1x 1x 3x 3x 3x 3x 1x 1x 3x 3x 1x 1x 3x 310x 310x 310x 310x 310x 310x 310x 310x 5x 1x 1x 1x 4x 5x 1x 1x 1x 1x 1x 1x 3x 5x 1x 5x 1x 1x 1x 1x 1x 1x 1x 5x 310x 310x 310x 310x 310x 310x 310x 310x 310x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 310x 310x 310x 310x 310x 310x 310x 310x 310x 8x 8x 1x 1x 1x 1x 1x 7x 7x 7x 7x 7x 8x 2x 8x 5x 5x 7x 7x 7x 7x 310x 310x 310x 310x 310x 310x 310x 310x 1x 1x 1x 310x 310x 310x 310x 310x 31x 31x 31x 31x 31x 31x 31x 1x 1x 1x 31x 310x | import http from 'http';
import {MFAMethod} from './mfa-method.js';
import {iCPSError} from '../../../app/error/error.js';
import {MFA_ERR} from '../../../app/error/error-codes.js';
import {Resources} from '../../resources/main.js';
import {iCPSEventMFA, iCPSEventRuntimeWarning} from '../../resources/events-types.js';
import {jsonc} from 'jsonc';
/**
* The MFA timeout value in milliseconds
*/
export const MFA_TIMEOUT_VALUE = 1000 * 60 * 10; // 10 minutes
/**
* Endpoint URI of MFA Server, all expect POST requests
*/
export const MFA_SERVER_ENDPOINTS = {
CODE_INPUT: `/mfa`, // Expecting URL parameter 'code' with 6 digits
RESEND_CODE: `/resend_mfa`, // Expecting URL parameter 'method' (either 'device', 'sms', 'voice') and optionally 'phoneNumberId' (any number > 0)
};
/**
* This objects starts a server, that will listen to incoming MFA codes and other MFA related commands
*/
export class MFAServer {
/**
* The server object
*/
server: http.Server;
/**
* Holds the MFA method used for this server
*/
mfaMethod: MFAMethod;
/**
* Timer object to track timeout of MFA request
*/
mfaTimeout: NodeJS.Timeout;
/**
* Creates the server object
* @emits iCPSEventMFA.ERROR - When an error associated to the server occurs - Provides iCPSError as argument
*/
constructor() {
Resources.logger(this).debug(`Preparing MFA server on port ${Resources.manager().mfaServerPort}`);
this.server = http.createServer(this.handleRequest.bind(this));
this.server.on(`error`, err => {
let icpsErr = new iCPSError(MFA_ERR.SERVER_ERR);
if (Object.hasOwn(err, `code`)) {
if ((err as any).code === `EADDRINUSE`) {
icpsErr = new iCPSError(MFA_ERR.ADDR_IN_USE_ERR).addContext(`port`, Resources.manager().mfaServerPort);
}
if ((err as any).code === `EACCES`) {
icpsErr = new iCPSError(MFA_ERR.INSUFFICIENT_PRIVILEGES).addContext(`port`, Resources.manager().mfaServerPort);
}
}
icpsErr.addCause(err);
Resources.emit(iCPSEventMFA.ERROR, icpsErr);
});
// Default MFA request always goes to device
this.mfaMethod = new MFAMethod();
}
/**
* Starts the server and listens for incoming requests to perform MFA actions
* @emits iCPSEventMFA.STARTED - When the server has started - Provides port number as argument
* @emits iCPSEventMFA.MFA_NOT_PROVIDED - When the MFA code was not provided within timeout period - Provides MFA method and iCPSError as arguments
* @emits iCPSEventMFA.ERROR - When an error associated to the server startup occurs - Provides iCPSError as argument
*/
startServer() {
try {
this.server.listen(Resources.manager().mfaServerPort, () => {
/* c8 ignore start */
// Never starting the server just to see logger message
Resources.emit(iCPSEventMFA.STARTED, Resources.manager().mfaServerPort);
Resources.logger(this).info(`Exposing endpoints: ${jsonc.stringify(Object.values(MFA_SERVER_ENDPOINTS))}`);
/* c8 ignore stop */
});
// MFA code needs to be provided within timeout period
this.mfaTimeout = setTimeout(() => {
Resources.emit(iCPSEventMFA.MFA_NOT_PROVIDED, this.mfaMethod, new iCPSError(MFA_ERR.SERVER_TIMEOUT));
this.stopServer();
}, MFA_TIMEOUT_VALUE);
} catch (err) {
Resources.emit(iCPSEventMFA.ERROR, new iCPSError(MFA_ERR.STARTUP_FAILED).addCause(err));
}
}
/**
* Handles incoming http requests
* @param req - The HTTP request object
* @param res - The HTTP response object
* @emits iCPSEventRuntimeWarning.MFA_ERROR - When the request method or endpoint of server could not be found - Provides iCPSError as argument
*/
handleRequest(req: http.IncomingMessage, res: http.ServerResponse) {
if (req.method === `GET` && req.url === `/`) {
this.sendResponse(res, 200, `MFA Server up & running - ${Resources.PackageInfo.name}@v${Resources.PackageInfo.version}`);
return;
}
if (req.method !== `POST`) {
Resources.emit(iCPSEventRuntimeWarning.MFA_ERROR, new iCPSError(MFA_ERR.METHOD_NOT_FOUND)
.addMessage(`endpoint ${req.url}, method ${req.method}`)
.addContext(`request`, req));
this.sendResponse(res, 400, `Method not supported: ${req.method}`);
return;
}
if (req.url.startsWith(MFA_SERVER_ENDPOINTS.CODE_INPUT)) {
this.handleMFACode(req, res);
} else if (req.url.startsWith(MFA_SERVER_ENDPOINTS.RESEND_CODE)) {
this.handleMFAResend(req, res);
} else {
Resources.emit(iCPSEventRuntimeWarning.MFA_ERROR, new iCPSError(MFA_ERR.ROUTE_NOT_FOUND)
.addMessage(req.url)
.addContext(`request`, req));
this.sendResponse(res, 404, `Route not found, available endpoints: ${jsonc.stringify(Object.values(MFA_SERVER_ENDPOINTS))}`);
}
}
/**
* This function will handle requests send to the MFA code input endpoint
* @param req - The HTTP request object
* @param res - The HTTP response object
* @emits iCPSEventRuntimeWarning.MFA_ERROR - When the MFA code format is not as expected - Provides iCPSError as argument
* @emits iCPSEventMFA.MFA_RECEIVED - When the MFA code was received - Provides MFA method and MFA code as arguments
*/
handleMFACode(req: http.IncomingMessage, res: http.ServerResponse) {
if (!req.url.match(/\?code=\d{6}$/)) {
Resources.emit(iCPSEventRuntimeWarning.MFA_ERROR, new iCPSError(MFA_ERR.CODE_FORMAT)
.addMessage(req.url)
.addContext(`request`, req));
this.sendResponse(res, 400, `Unexpected MFA code format! Expecting 6 digits`);
return;
}
const mfa: string = req.url.slice(-6);
Resources.logger(this).debug(`Received MFA: ${mfa}`);
this.sendResponse(res, 200, `Read MFA code: ${mfa}`);
Resources.emit(iCPSEventMFA.MFA_RECEIVED, this.mfaMethod, mfa);
}
/**
* This function will handle the request send to the MFA code resend endpoint
* @param req - The HTTP request object
* @param res - The HTTP response object
* @emits iCPSEventRuntimeWarning.MFA_ERROR - When the MFA resend method is not as expected - Provides iCPSError as argument
* @emits iCPSEventMFA.MFA_RESEND - When the MFA code resend was requested - Provides MFA method as argument
*/
handleMFAResend(req: http.IncomingMessage, res: http.ServerResponse) {
const methodMatch = req.url.match(/method=(?:sms|voice|device)/);
if (!methodMatch) {
this.sendResponse(res, 400, `Resend method does not match expected format`);
Resources.emit(iCPSEventRuntimeWarning.MFA_ERROR, new iCPSError(MFA_ERR.RESEND_METHOD_FORMAT)
.addContext(`requestURL`, req.url));
return;
}
const methodString = methodMatch[0].slice(7);
const phoneNumberIdMatch = req.url.match(/phoneNumberId=\d+/);
if (phoneNumberIdMatch && methodString !== `device`) {
this.mfaMethod.update(methodString, parseInt(phoneNumberIdMatch[0].slice(14), 10));
} else {
this.mfaMethod.update(methodString);
}
this.sendResponse(res, 200, `Requesting MFA resend with method ${this.mfaMethod}`);
Resources.emit(iCPSEventMFA.MFA_RESEND, this.mfaMethod);
}
/**
* This function will send a response, based on its input variables
* @param res - The response object, to send the response to
* @param code - The status code for the response
* @param msg - The message included in the response
*/
sendResponse(res: http.ServerResponse, code: number, msg: string) {
res.writeHead(code, {"Content-Type": `application/json`});
res.end(jsonc.stringify({message: msg}));
}
/**
* Stops the server and clears any outstanding timeout
*/
stopServer() {
Resources.logger(this).debug(`Stopping server`);
if (this.server) {
this.server.close();
this.server = undefined;
}
if (this.mfaTimeout) {
clearTimeout(this.mfaTimeout);
this.mfaTimeout = undefined;
}
}
} |