|
| 1 | +import { Injectable, NestMiddleware } from '@nestjs/common'; |
| 2 | +import { NextFunction, Request, Response } from 'express'; |
| 3 | +import logger from '../../logger'; |
| 4 | + |
| 5 | +/** |
| 6 | + * |
| 7 | + * A nest middleware that resolves the user from the API key in the request. |
| 8 | + * |
| 9 | + */ |
| 10 | +@Injectable() |
| 11 | +export class VersionCheckerMiddlewareService implements NestMiddleware { |
| 12 | + async use( |
| 13 | + request: Request, |
| 14 | + response: Response, |
| 15 | + next: NextFunction, |
| 16 | + ): Promise<void> { |
| 17 | + let clientVersion = request.headers['kleinkram-client-version'] as |
| 18 | + | string |
| 19 | + | undefined; |
| 20 | + |
| 21 | + const requestPath = request.originalUrl; |
| 22 | + |
| 23 | + // ignore auth endpoints |
| 24 | + if (requestPath.startsWith('/auth/')) { |
| 25 | + next(); |
| 26 | + return; |
| 27 | + } |
| 28 | + |
| 29 | + // strip away everything after .dev |
| 30 | + if (clientVersion !== undefined) { |
| 31 | + clientVersion = clientVersion.split('.dev')[0]; |
| 32 | + } |
| 33 | + |
| 34 | + // verify if version is of semver format |
| 35 | + const validVersion = /^\d+\.\d+\.\d+$/; |
| 36 | + if (clientVersion !== undefined && !validVersion.test(clientVersion)) { |
| 37 | + this.rejectRequest(response, clientVersion); |
| 38 | + return; |
| 39 | + } |
| 40 | + |
| 41 | + logger.debug( |
| 42 | + `Check Client Version for call to endpoint: ${requestPath} is: ${clientVersion}`, |
| 43 | + ); |
| 44 | + |
| 45 | + if (clientVersion === undefined) { |
| 46 | + this.rejectRequest(response, 'undefined'); |
| 47 | + return; |
| 48 | + } |
| 49 | + |
| 50 | + // forbidden client versions: allows for the following notations |
| 51 | + // - '<0.40.x': versions below 0.40.x are forbidden |
| 52 | + // - '0.41.x': version 0.41.x is forbidden |
| 53 | + const forbiddenClientVersions = ['<0.40.0', '0.41.0', '0.41.1']; |
| 54 | + |
| 55 | + if (this.isVersionForbidden(clientVersion, forbiddenClientVersions)) { |
| 56 | + this.rejectRequest(response, clientVersion); |
| 57 | + return; |
| 58 | + } |
| 59 | + |
| 60 | + next(); |
| 61 | + } |
| 62 | + |
| 63 | + private rejectRequest(response: Response, clientVersion: string): void { |
| 64 | + // reject request with 426 |
| 65 | + response.status(426).json({ |
| 66 | + statusCode: 426, |
| 67 | + message: `Client version ${clientVersion} is not a valid version.`, |
| 68 | + }); |
| 69 | + |
| 70 | + response.send(); |
| 71 | + } |
| 72 | + |
| 73 | + private isVersionForbidden( |
| 74 | + clientVersion: string, |
| 75 | + forbiddenVersions: string[], |
| 76 | + ): boolean { |
| 77 | + for (const forbiddenVersion of forbiddenVersions) { |
| 78 | + if (forbiddenVersion.startsWith('<')) { |
| 79 | + const versionToCompare = forbiddenVersion.slice(1); |
| 80 | + if (this.isLessThan(clientVersion, versionToCompare)) { |
| 81 | + return true; |
| 82 | + } |
| 83 | + } else if (forbiddenVersion.endsWith('.x')) { |
| 84 | + const baseVersion = forbiddenVersion.slice( |
| 85 | + 0, |
| 86 | + Math.max(0, forbiddenVersion.length - 2), |
| 87 | + ); |
| 88 | + if (clientVersion.startsWith(baseVersion)) { |
| 89 | + return true; |
| 90 | + } |
| 91 | + } else if (clientVersion === forbiddenVersion) { |
| 92 | + return true; |
| 93 | + } |
| 94 | + } |
| 95 | + return false; |
| 96 | + } |
| 97 | + |
| 98 | + private isLessThan(version1: string, version2: string): boolean { |
| 99 | + const v1Parts = version1.split('.').map(Number); |
| 100 | + const v2Parts = version2.split('.').map(Number); |
| 101 | + |
| 102 | + const maxLength = Math.max(v1Parts.length, v2Parts.length); |
| 103 | + |
| 104 | + for (let i = 0; i < maxLength; i++) { |
| 105 | + const part1 = v1Parts[i] || 0; |
| 106 | + const part2 = v2Parts[i] || 0; |
| 107 | + |
| 108 | + if (part1 < part2) { |
| 109 | + return true; |
| 110 | + } else if (part1 > part2) { |
| 111 | + return false; |
| 112 | + } |
| 113 | + } |
| 114 | + |
| 115 | + return false; |
| 116 | + } |
| 117 | +} |
0 commit comments