@heavybit/pendoadmin-shared-lib 1.5.0 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/common/gateway-signature.d.ts +49 -0
- package/dist/common/gateway-signature.d.ts.map +1 -0
- package/dist/common/gateway-signature.js +99 -0
- package/dist/common/gateway-signature.js.map +1 -0
- package/dist/common/index.d.ts +2 -0
- package/dist/common/index.d.ts.map +1 -1
- package/dist/common/index.js +2 -0
- package/dist/common/index.js.map +1 -1
- package/dist/common/permission.utils.d.ts +11 -0
- package/dist/common/permission.utils.d.ts.map +1 -0
- package/dist/common/permission.utils.js +16 -0
- package/dist/common/permission.utils.js.map +1 -0
- package/dist/express/auth.middleware.d.ts +5 -4
- package/dist/express/auth.middleware.d.ts.map +1 -1
- package/dist/express/auth.middleware.js +49 -65
- package/dist/express/auth.middleware.js.map +1 -1
- package/dist/express/permission.guard.d.ts.map +1 -1
- package/dist/express/permission.guard.js +2 -5
- package/dist/express/permission.guard.js.map +1 -1
- package/dist/logging/index.d.ts +1 -0
- package/dist/logging/index.d.ts.map +1 -1
- package/dist/logging/index.js +5 -2
- package/dist/logging/index.js.map +1 -1
- package/dist/logging/redact.d.ts +16 -0
- package/dist/logging/redact.d.ts.map +1 -0
- package/dist/logging/redact.js +83 -0
- package/dist/logging/redact.js.map +1 -0
- package/dist/nestjs/auth.guard.d.ts +2 -0
- package/dist/nestjs/auth.guard.d.ts.map +1 -1
- package/dist/nestjs/auth.guard.js +11 -3
- package/dist/nestjs/auth.guard.js.map +1 -1
- package/dist/nestjs/permission.guard.js +5 -4
- package/dist/nestjs/permission.guard.js.map +1 -1
- package/dist/rate-limit/create-rate-limiter.d.ts +7 -1
- package/dist/rate-limit/create-rate-limiter.d.ts.map +1 -1
- package/dist/rate-limit/create-rate-limiter.js +12 -2
- package/dist/rate-limit/create-rate-limiter.js.map +1 -1
- package/dist/rate-limit/index.d.ts +1 -1
- package/dist/rate-limit/index.d.ts.map +1 -1
- package/dist/rate-limit/index.js +1 -1
- package/dist/rate-limit/index.js.map +1 -1
- package/dist/types/index.d.ts +2 -0
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js +2 -0
- package/dist/types/index.js.map +1 -1
- package/package.json +2 -2
- package/src/common/gateway-signature.ts +124 -0
- package/src/common/index.ts +2 -0
- package/src/common/permission.utils.ts +18 -0
- package/src/express/auth.middleware.ts +46 -64
- package/src/express/permission.guard.ts +2 -5
- package/src/logging/index.ts +6 -2
- package/src/logging/redact.ts +84 -0
- package/src/nestjs/auth.guard.ts +12 -3
- package/src/nestjs/permission.guard.ts +5 -5
- package/src/rate-limit/create-rate-limiter.ts +13 -3
- package/src/rate-limit/index.ts +1 -1
- package/src/types/index.ts +2 -0
- package/tests/auth-middleware.test.mjs +91 -0
- package/tests/gateway-signature.test.mjs +93 -0
- package/tests/nestjs-guards.test.mjs +45 -0
- package/tests/permission.utils.test.mjs +59 -0
- package/tests/rate-limit-key.test.mjs +25 -0
- package/tests/redact.test.mjs +61 -0
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { CanActivate, ExecutionContext } from '@nestjs/common';
|
|
2
2
|
import { Reflector } from '@nestjs/core';
|
|
3
3
|
export declare const IS_PUBLIC_KEY = "isPublic";
|
|
4
|
+
/** Request property AuthGuard sets when the caller came from signed gateway headers. */
|
|
5
|
+
export declare const GATEWAY_VERIFIED_FLAG = "gatewayVerified";
|
|
4
6
|
/**
|
|
5
7
|
* NestJS Guard: validates JWT or trusts gateway-injected headers.
|
|
6
8
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"auth.guard.d.ts","sourceRoot":"","sources":["../../src/nestjs/auth.guard.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,WAAW,EACX,gBAAgB,EAEjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"auth.guard.d.ts","sourceRoot":"","sources":["../../src/nestjs/auth.guard.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,WAAW,EACX,gBAAgB,EAEjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAezC,eAAO,MAAM,aAAa,aAAa,CAAC;AAExC,wFAAwF;AACxF,eAAO,MAAM,qBAAqB,oBAAoB,CAAC;AAEvD;;GAEG;AACH,qBACa,SAAU,YAAW,WAAW;IAC/B,OAAO,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAElC,WAAW,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;CAmD/D"}
|
|
@@ -10,6 +10,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
|
|
|
10
10
|
import { Injectable, UnauthorizedException, } from '@nestjs/common';
|
|
11
11
|
import { Reflector } from '@nestjs/core';
|
|
12
12
|
import { verifyToken } from '../common/jwt.utils.js';
|
|
13
|
+
import { isTrustedGatewayIdentity, isDirectJwtFallbackAllowed } from '../common/gateway-signature.js';
|
|
13
14
|
import { GATEWAY_HEADERS } from '../types/index.js';
|
|
14
15
|
/** Parse a header value that may be a JSON array string or comma-separated. */
|
|
15
16
|
function parseArrayHeader(value) {
|
|
@@ -25,6 +26,8 @@ function parseArrayHeader(value) {
|
|
|
25
26
|
return trimmed.split(',').filter(Boolean);
|
|
26
27
|
}
|
|
27
28
|
export const IS_PUBLIC_KEY = 'isPublic';
|
|
29
|
+
/** Request property AuthGuard sets when the caller came from signed gateway headers. */
|
|
30
|
+
export const GATEWAY_VERIFIED_FLAG = 'gatewayVerified';
|
|
28
31
|
/**
|
|
29
32
|
* NestJS Guard: validates JWT or trusts gateway-injected headers.
|
|
30
33
|
*/
|
|
@@ -41,9 +44,10 @@ let AuthGuard = class AuthGuard {
|
|
|
41
44
|
if (isPublic)
|
|
42
45
|
return true;
|
|
43
46
|
const request = context.switchToHttp().getRequest();
|
|
44
|
-
// Trust gateway-injected headers
|
|
47
|
+
// Trust gateway-injected headers only with a valid gateway signature
|
|
45
48
|
const gatewayUserId = request.headers[GATEWAY_HEADERS.USER_ID];
|
|
46
|
-
if (gatewayUserId) {
|
|
49
|
+
if (gatewayUserId && isTrustedGatewayIdentity(request.headers)) {
|
|
50
|
+
request[GATEWAY_VERIFIED_FLAG] = true;
|
|
47
51
|
request.user = {
|
|
48
52
|
id: gatewayUserId,
|
|
49
53
|
companyId: request.headers[GATEWAY_HEADERS.COMPANY_ID] || undefined,
|
|
@@ -54,7 +58,11 @@ let AuthGuard = class AuthGuard {
|
|
|
54
58
|
};
|
|
55
59
|
return true;
|
|
56
60
|
}
|
|
57
|
-
// Fallback to direct JWT validation
|
|
61
|
+
// Fallback to direct JWT validation — development only; production
|
|
62
|
+
// requests must arrive through the gateway.
|
|
63
|
+
if (!isDirectJwtFallbackAllowed()) {
|
|
64
|
+
throw new UnauthorizedException('Authentication required');
|
|
65
|
+
}
|
|
58
66
|
const authHeader = request.headers.authorization;
|
|
59
67
|
if (!authHeader?.startsWith('Bearer ')) {
|
|
60
68
|
throw new UnauthorizedException('Missing authentication token');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"auth.guard.js","sourceRoot":"","sources":["../../src/nestjs/auth.guard.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EACL,UAAU,EAGV,qBAAqB,GACtB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAkB,MAAM,mBAAmB,CAAC;AAEpE,+EAA+E;AAC/E,SAAS,gBAAgB,CAAC,KAAyB;IACjD,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IACtB,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7B,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5B,IAAI,CAAC;YAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAAC,CAAC;QAAC,MAAM,CAAC,CAAC,kBAAkB,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC;AAExC;;GAEG;AAEI,IAAM,SAAS,GAAf,MAAM,SAAS;IACA;IAApB,YAAoB,SAAoB;QAApB,cAAS,GAAT,SAAS,CAAW;IAAG,CAAC;IAE5C,KAAK,CAAC,WAAW,CAAC,OAAyB;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAU,aAAa,EAAE;YACxE,OAAO,CAAC,UAAU,EAAE;YACpB,OAAO,CAAC,QAAQ,EAAE;SACnB,CAAC,CAAC;QACH,IAAI,QAAQ;YAAE,OAAO,IAAI,CAAC;QAE1B,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;QAEpD,
|
|
1
|
+
{"version":3,"file":"auth.guard.js","sourceRoot":"","sources":["../../src/nestjs/auth.guard.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EACL,UAAU,EAGV,qBAAqB,GACtB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,MAAM,gCAAgC,CAAC;AACtG,OAAO,EAAE,eAAe,EAAkB,MAAM,mBAAmB,CAAC;AAEpE,+EAA+E;AAC/E,SAAS,gBAAgB,CAAC,KAAyB;IACjD,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IACtB,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7B,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5B,IAAI,CAAC;YAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAAC,CAAC;QAAC,MAAM,CAAC,CAAC,kBAAkB,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC;AAExC,wFAAwF;AACxF,MAAM,CAAC,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;AAEvD;;GAEG;AAEI,IAAM,SAAS,GAAf,MAAM,SAAS;IACA;IAApB,YAAoB,SAAoB;QAApB,cAAS,GAAT,SAAS,CAAW;IAAG,CAAC;IAE5C,KAAK,CAAC,WAAW,CAAC,OAAyB;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAU,aAAa,EAAE;YACxE,OAAO,CAAC,UAAU,EAAE;YACpB,OAAO,CAAC,QAAQ,EAAE;SACnB,CAAC,CAAC;QACH,IAAI,QAAQ;YAAE,OAAO,IAAI,CAAC;QAE1B,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;QAEpD,qEAAqE;QACrE,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,aAAa,IAAI,wBAAwB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/D,OAAO,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;YACtC,OAAO,CAAC,IAAI,GAAG;gBACb,EAAE,EAAE,aAAa;gBACjB,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,UAAU,CAAC,IAAI,SAAS;gBACnE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,UAAU,CAAC,IAAI,SAAS;gBAC/D,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,UAAU,CAAW,CAAC;gBAC9E,WAAW,EAAE,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,gBAAgB,CAAW,CAAC;gBAC1F,YAAY,EACV,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,KAAK,MAAM;aAC/C,CAAC;YACf,OAAO,IAAI,CAAC;QACd,CAAC;QAED,mEAAmE;QACnE,4CAA4C;QAC5C,IAAI,CAAC,0BAA0B,EAAE,EAAE,CAAC;YAClC,MAAM,IAAI,qBAAqB,CAAC,yBAAyB,CAAC,CAAC;QAC7D,CAAC;QACD,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;QACjD,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,qBAAqB,CAAC,8BAA8B,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAClC,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,UAAW,CAAC,CAAC;YAC5D,OAAO,CAAC,IAAI,GAAG;gBACb,EAAE,EAAE,OAAO,CAAC,GAAG;gBACf,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE;gBAC1B,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,EAAE;gBACtC,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,KAAK;aAC/B,CAAC;YACf,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,qBAAqB,CAAC,0BAA0B,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;CACF,CAAA;AAtDY,SAAS;IADrB,UAAU,EAAE;qCAEoB,SAAS;GAD7B,SAAS,CAsDrB"}
|
|
@@ -10,7 +10,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
|
|
|
10
10
|
import { Injectable, ForbiddenException, } from '@nestjs/common';
|
|
11
11
|
import { Reflector } from '@nestjs/core';
|
|
12
12
|
import { PERMISSIONS_KEY, REQUIRE_ALL_KEY, ROLES_KEY, } from './permission.decorator.js';
|
|
13
|
-
import { IS_PUBLIC_KEY } from './auth.guard.js';
|
|
13
|
+
import { IS_PUBLIC_KEY, GATEWAY_VERIFIED_FLAG } from './auth.guard.js';
|
|
14
14
|
/**
|
|
15
15
|
* NestJS Guard: checks permissions/roles from decorators.
|
|
16
16
|
* Must be used after AuthGuard so that request.user is populated.
|
|
@@ -37,9 +37,10 @@ let PermissionGuard = class PermissionGuard {
|
|
|
37
37
|
if (user.isSuperAdmin)
|
|
38
38
|
return true;
|
|
39
39
|
// M2M / gateway-authenticated clients: the gateway already verified the JWT
|
|
40
|
-
// and injected headers
|
|
41
|
-
// is overly restrictive
|
|
42
|
-
|
|
40
|
+
// and signed the injected headers (AuthGuard checked the signature).
|
|
41
|
+
// Requiring human roles on top of scoped permissions is overly restrictive
|
|
42
|
+
// for API access.
|
|
43
|
+
const isGatewayAuth = request[GATEWAY_VERIFIED_FLAG] === true;
|
|
43
44
|
// Check permissions first — they are the primary authorization mechanism
|
|
44
45
|
const requiredPermissions = this.reflector.getAllAndOverride(PERMISSIONS_KEY, [context.getHandler(), context.getClass()]);
|
|
45
46
|
const requireAll = this.reflector.getAllAndOverride(REQUIRE_ALL_KEY, [context.getHandler(), context.getClass()]);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"permission.guard.js","sourceRoot":"","sources":["../../src/nestjs/permission.guard.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EACL,UAAU,EAGV,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EACL,eAAe,EACf,eAAe,EACf,SAAS,GACV,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"permission.guard.js","sourceRoot":"","sources":["../../src/nestjs/permission.guard.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EACL,UAAU,EAGV,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EACL,eAAe,EACf,eAAe,EACf,SAAS,GACV,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAGvE;;;GAGG;AAEI,IAAM,eAAe,GAArB,MAAM,eAAe;IACN;IAApB,YAAoB,SAAoB;QAApB,cAAS,GAAT,SAAS,CAAW;IAAG,CAAC;IAE5C,WAAW,CAAC,OAAyB;QACnC,0CAA0C;QAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAU,aAAa,EAAE;YACxE,OAAO,CAAC,UAAU,EAAE;YACpB,OAAO,CAAC,QAAQ,EAAE;SACnB,CAAC,CAAC;QACH,IAAI,QAAQ;YAAE,OAAO,IAAI,CAAC;QAE1B,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;QACpD,MAAM,IAAI,GAA0B,OAAO,CAAC,IAAI,CAAC;QAEjD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,kBAAkB,CAAC,wBAAwB,CAAC,CAAC;QACzD,CAAC;QAED,4CAA4C;QAC5C,IAAI,IAAI,CAAC,YAAY;YAAE,OAAO,IAAI,CAAC;QAEnC,4EAA4E;QAC5E,qEAAqE;QACrE,2EAA2E;QAC3E,kBAAkB;QAClB,MAAM,aAAa,GAAG,OAAO,CAAC,qBAAqB,CAAC,KAAK,IAAI,CAAC;QAE9D,yEAAyE;QACzE,MAAM,mBAAmB,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAC1D,eAAe,EACf,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAC3C,CAAC;QAEF,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CACjD,eAAe,EACf,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAC3C,CAAC;QAEF,IAAI,sBAAsB,GAAG,IAAI,CAAC;QAClC,IAAI,mBAAmB,EAAE,MAAM,EAAE,CAAC;YAChC,sBAAsB,GAAG,UAAU;gBACjC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;gBACxE,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5E,CAAC;QAED,oEAAoE;QACpE,mEAAmE;QACnE,uEAAuE;QACvE,wEAAwE;QACxE,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CACpD,SAAS,EACT,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAC3C,CAAC;QACF,IAAI,aAAa,EAAE,MAAM,EAAE,CAAC;YAC1B,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;YAChF,gEAAgE;YAChE,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,aAAa,IAAI,sBAAsB,CAAC,EAAE,CAAC;gBAC3D,MAAM,IAAI,kBAAkB,CAAC,mBAAmB,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QAED,IAAI,mBAAmB,EAAE,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAC3D,MAAM,IAAI,kBAAkB,CAAC,0BAA0B,CAAC,CAAC;QAC3D,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAA;AAnEY,eAAe;IAD3B,UAAU,EAAE;qCAEoB,SAAS;GAD7B,eAAe,CAmE3B"}
|
|
@@ -10,7 +10,7 @@ export interface RateLimitConfig {
|
|
|
10
10
|
keyPrefix?: string;
|
|
11
11
|
/** Optional Redis client — falls back to in-memory if omitted */
|
|
12
12
|
redisClient?: Redis | null;
|
|
13
|
-
/** Extract the rate-limit key from the request. Default:
|
|
13
|
+
/** Extract the rate-limit key from the request. Default: signed gateway user id → IP → "unknown" */
|
|
14
14
|
keyExtractor?: (req: Request) => string;
|
|
15
15
|
}
|
|
16
16
|
export interface RateLimitResult {
|
|
@@ -20,4 +20,10 @@ export interface RateLimitResult {
|
|
|
20
20
|
middleware: (req: Request, res: Response, next: NextFunction) => Promise<void>;
|
|
21
21
|
}
|
|
22
22
|
export declare function createRateLimiter(cfg?: RateLimitConfig): RateLimitResult;
|
|
23
|
+
/**
|
|
24
|
+
* The gateway user id only when its signature verifies — an unsigned
|
|
25
|
+
* x-user-id is caller-controlled, and a fresh value per request would get a
|
|
26
|
+
* fresh budget. Otherwise the client IP.
|
|
27
|
+
*/
|
|
28
|
+
export declare function defaultKeyExtractor(req: Request): string;
|
|
23
29
|
//# sourceMappingURL=create-rate-limiter.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"create-rate-limiter.d.ts","sourceRoot":"","sources":["../../src/rate-limit/create-rate-limiter.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC1D,OAAO,EAAuC,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjG,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"create-rate-limiter.d.ts","sourceRoot":"","sources":["../../src/rate-limit/create-rate-limiter.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC1D,OAAO,EAAuC,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjG,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AAKjC,MAAM,WAAW,eAAe;IAC9B,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4FAA4F;IAC5F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iEAAiE;IACjE,WAAW,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;IAC3B,oGAAoG;IACpG,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,MAAM,CAAC;CACzC;AAED,MAAM,WAAW,eAAe;IAC9B,mDAAmD;IACnD,OAAO,EAAE,mBAAmB,CAAC;IAC7B,yBAAyB;IACzB,UAAU,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAChF;AAID,wBAAgB,iBAAiB,CAAC,GAAG,GAAE,eAAoB,GAAG,eAAe,CAmE5E;AAID;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,CAMxD"}
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
// Factory that creates a dual-layer (Redis + memory fallback) rate limiter.
|
|
4
4
|
// Available for any Express-based service.
|
|
5
5
|
import { RateLimiterRedis, RateLimiterMemory } from "rate-limiter-flexible";
|
|
6
|
+
import { isTrustedGatewayIdentity } from "../common/gateway-signature.js";
|
|
6
7
|
// ─── Factory ────────────────────────────────────────────
|
|
7
8
|
export function createRateLimiter(cfg = {}) {
|
|
8
9
|
const { maxRequests = 100, windowMs = 60_000, keyPrefix = "rl:service", redisClient = null, keyExtractor = defaultKeyExtractor, } = cfg;
|
|
@@ -54,7 +55,16 @@ export function createRateLimiter(cfg = {}) {
|
|
|
54
55
|
return { limiter, middleware };
|
|
55
56
|
}
|
|
56
57
|
// ─── Defaults ───────────────────────────────────────────
|
|
57
|
-
|
|
58
|
-
|
|
58
|
+
/**
|
|
59
|
+
* The gateway user id only when its signature verifies — an unsigned
|
|
60
|
+
* x-user-id is caller-controlled, and a fresh value per request would get a
|
|
61
|
+
* fresh budget. Otherwise the client IP.
|
|
62
|
+
*/
|
|
63
|
+
export function defaultKeyExtractor(req) {
|
|
64
|
+
const userId = req.headers["x-user-id"];
|
|
65
|
+
if (typeof userId === "string" && userId && isTrustedGatewayIdentity(req.headers)) {
|
|
66
|
+
return `user:${userId}`;
|
|
67
|
+
}
|
|
68
|
+
return `ip:${req.ip || "unknown"}`;
|
|
59
69
|
}
|
|
60
70
|
//# sourceMappingURL=create-rate-limiter.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"create-rate-limiter.js","sourceRoot":"","sources":["../../src/rate-limit/create-rate-limiter.ts"],"names":[],"mappings":"AAAA,8DAA8D;AAC9D,EAAE;AACF,4EAA4E;AAC5E,2CAA2C;AAG3C,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAuB,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"create-rate-limiter.js","sourceRoot":"","sources":["../../src/rate-limit/create-rate-limiter.ts"],"names":[],"mappings":"AAAA,8DAA8D;AAC9D,EAAE;AACF,4EAA4E;AAC5E,2CAA2C;AAG3C,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAuB,MAAM,uBAAuB,CAAC;AAEjG,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAwB1E,2DAA2D;AAE3D,MAAM,UAAU,iBAAiB,CAAC,MAAuB,EAAE;IACzD,MAAM,EACJ,WAAW,GAAG,GAAG,EACjB,QAAQ,GAAG,MAAM,EACjB,SAAS,GAAG,YAAY,EACxB,WAAW,GAAG,IAAI,EAClB,YAAY,GAAG,mBAAmB,GACnC,GAAG,GAAG,CAAC;IAER,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC;IAE9D,MAAM,aAAa,GAAG,IAAI,iBAAiB,CAAC;QAC1C,SAAS;QACT,MAAM,EAAE,WAAW;QACnB,QAAQ,EAAE,YAAY;KACvB,CAAC,CAAC;IAEH,IAAI,OAA4B,CAAC;IAEjC,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,GAAG,IAAI,gBAAgB,CAAC;YAC7B,WAAW,EAAE,WAAW;YACxB,SAAS;YACT,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,YAAY;YACtB,aAAa,EAAE,CAAC;YAChB,gBAAgB,EAAE,aAAa;SAChC,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,aAAa,CAAC;IAC1B,CAAC;IAED,wDAAwD;IAExD,KAAK,UAAU,UAAU,CACvB,GAAY,EACZ,GAAa,EACb,IAAkB;QAElB,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;YAC9B,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE1C,GAAG,CAAC,SAAS,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC;YAChD,GAAG,CAAC,SAAS,CAAC,uBAAuB,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;YAC/D,GAAG,CAAC,SAAS,CACX,mBAAmB,EACnB,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,CACzD,CAAC;YACF,IAAI,EAAE,CAAC;QACT,CAAC;QAAC,OAAO,MAAW,EAAE,CAAC;YACrB,iDAAiD;YACjD,IAAI,OAAO,MAAM,EAAE,YAAY,KAAK,QAAQ,EAAE,CAAC;gBAC7C,OAAO,CAAC,KAAK,CAAC,cAAc,SAAS,qBAAqB,EAAE,MAAM,EAAE,OAAO,IAAI,MAAM,CAAC,CAAC;gBACvF,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;YACD,GAAG,CAAC,SAAS,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC;YAChD,GAAG,CAAC,SAAS,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC;YAC1C,GAAG,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC;YACpE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBACnB,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,4CAA4C;aACtD,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AACjC,CAAC;AAED,2DAA2D;AAE3D;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,GAAY;IAC9C,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACxC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,IAAI,wBAAwB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;QAClF,OAAO,QAAQ,MAAM,EAAE,CAAC;IAC1B,CAAC;IACD,OAAO,MAAM,GAAG,CAAC,EAAE,IAAI,SAAS,EAAE,CAAC;AACrC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/rate-limit/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/rate-limit/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAClF,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC"}
|
package/dist/rate-limit/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export { createRateLimiter } from "./create-rate-limiter.js";
|
|
1
|
+
export { createRateLimiter, defaultKeyExtractor } from "./create-rate-limiter.js";
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/rate-limit/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/rate-limit/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC"}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -213,5 +213,7 @@ export declare const GATEWAY_HEADERS: {
|
|
|
213
213
|
readonly IS_SUPERADMIN: "x-is-superadmin";
|
|
214
214
|
readonly CORRELATION_ID: "x-correlation-id";
|
|
215
215
|
readonly SERVICE_NAME: "x-service-name";
|
|
216
|
+
readonly GATEWAY_SIGNATURE: "x-gateway-signature";
|
|
217
|
+
readonly GATEWAY_TIMESTAMP: "x-gateway-ts";
|
|
216
218
|
};
|
|
217
219
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,OAAO,CAAC;IACvB,SAAS,EAAE,OAAO,CAAC;IACnB,cAAc,EAAE,OAAO,CAAC;IACxB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,YAAY,EAAE,IAAI,GAAG,IAAI,CAAC;IAC1B,0BAA0B,EAAE,OAAO,CAAC;IACpC,aAAa,EAAE,IAAI,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAC3B,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,aAAa,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IACtB,mFAAmF;IACnF,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;CACvB;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,SAAS,EACf,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,GACjC,MAAM,CAKR;AAED,oDAAoD;AACpD,eAAO,MAAM,qBAAqB,yCAAyC,CAAC;AAE5E,8FAA8F;AAC9F,wBAAgB,qBAAqB,CACnC,IAAI,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,WAAW,GAAG,cAAc,CAAC,GAAG,IAAI,GAC1D,OAAO,CAET;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,WAAW,GAAG,cAAc,CAAC,EACnD,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,GACjC,MAAM,GAAG,SAAS,CAIpB;AAMD,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAMD,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,EAAE,OAAO,CAAC;IACxB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,IAAI,CAAC;CAClB;AAMD,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,OAAO;IACvC,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAClC,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,IAAI,EAAE,eAAe,CAAC;CACvB;AAMD,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB;AAMD,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;CACxB;AAMD,eAAO,MAAM,eAAe
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,OAAO,CAAC;IACvB,SAAS,EAAE,OAAO,CAAC;IACnB,cAAc,EAAE,OAAO,CAAC;IACxB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,YAAY,EAAE,IAAI,GAAG,IAAI,CAAC;IAC1B,0BAA0B,EAAE,OAAO,CAAC;IACpC,aAAa,EAAE,IAAI,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAC3B,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,aAAa,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IACtB,mFAAmF;IACnF,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;CACvB;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,SAAS,EACf,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,GACjC,MAAM,CAKR;AAED,oDAAoD;AACpD,eAAO,MAAM,qBAAqB,yCAAyC,CAAC;AAE5E,8FAA8F;AAC9F,wBAAgB,qBAAqB,CACnC,IAAI,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,WAAW,GAAG,cAAc,CAAC,GAAG,IAAI,GAC1D,OAAO,CAET;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,WAAW,GAAG,cAAc,CAAC,EACnD,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,GACjC,MAAM,GAAG,SAAS,CAIpB;AAMD,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAMD,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,EAAE,OAAO,CAAC;IACxB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,IAAI,CAAC;CAClB;AAMD,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,OAAO;IACvC,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAClC,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,IAAI,EAAE,eAAe,CAAC;CACvB;AAMD,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB;AAMD,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;CACxB;AAMD,eAAO,MAAM,eAAe;;;;;;;;;;;CAWlB,CAAC"}
|
package/dist/types/index.js
CHANGED
|
@@ -48,5 +48,7 @@ export const GATEWAY_HEADERS = {
|
|
|
48
48
|
IS_SUPERADMIN: 'x-is-superadmin',
|
|
49
49
|
CORRELATION_ID: 'x-correlation-id',
|
|
50
50
|
SERVICE_NAME: 'x-service-name',
|
|
51
|
+
GATEWAY_SIGNATURE: 'x-gateway-signature',
|
|
52
|
+
GATEWAY_TIMESTAMP: 'x-gateway-ts',
|
|
51
53
|
};
|
|
52
54
|
//# sourceMappingURL=index.js.map
|
package/dist/types/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,iDAAiD;AACjD,oBAAoB;AACpB,iDAAiD;AA2EjD;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC9B,IAAe,EACf,kBAAkC;IAElC,IAAI,IAAI,CAAC,YAAY,IAAI,kBAAkB,EAAE,CAAC;QAC5C,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC;AACxB,CAAC;AAED,oDAAoD;AACpD,MAAM,CAAC,MAAM,qBAAqB,GAAG,sCAAsC,CAAC;AAE5E,8FAA8F;AAC9F,MAAM,UAAU,qBAAqB,CACnC,IAA2D;IAE3D,OAAO,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,qBAAqB,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;AACnF,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,mBAAmB,CACjC,IAAmD,EACnD,kBAAkC;IAElC,IAAI,qBAAqB,CAAC,IAAI,CAAC;QAAE,OAAO,kBAAkB,IAAI,SAAS,CAAC;IACxE,IAAI,CAAC,IAAI,CAAC,SAAS;QAAE,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,2BAA2B,CAAC,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;IACtG,OAAO,IAAI,CAAC,SAAS,CAAC;AACxB,CAAC;AAwJD,iDAAiD;AACjD,uBAAuB;AACvB,iDAAiD;AAEjD,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,OAAO,EAAE,WAAW;IACpB,UAAU,EAAE,cAAc;IAC1B,UAAU,EAAE,cAAc;IAC1B,UAAU,EAAE,cAAc;IAC1B,gBAAgB,EAAE,oBAAoB;IACtC,aAAa,EAAE,iBAAiB;IAChC,cAAc,EAAE,kBAAkB;IAClC,YAAY,EAAE,gBAAgB;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,iDAAiD;AACjD,oBAAoB;AACpB,iDAAiD;AA2EjD;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC9B,IAAe,EACf,kBAAkC;IAElC,IAAI,IAAI,CAAC,YAAY,IAAI,kBAAkB,EAAE,CAAC;QAC5C,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC;AACxB,CAAC;AAED,oDAAoD;AACpD,MAAM,CAAC,MAAM,qBAAqB,GAAG,sCAAsC,CAAC;AAE5E,8FAA8F;AAC9F,MAAM,UAAU,qBAAqB,CACnC,IAA2D;IAE3D,OAAO,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,qBAAqB,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;AACnF,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,mBAAmB,CACjC,IAAmD,EACnD,kBAAkC;IAElC,IAAI,qBAAqB,CAAC,IAAI,CAAC;QAAE,OAAO,kBAAkB,IAAI,SAAS,CAAC;IACxE,IAAI,CAAC,IAAI,CAAC,SAAS;QAAE,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,2BAA2B,CAAC,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;IACtG,OAAO,IAAI,CAAC,SAAS,CAAC;AACxB,CAAC;AAwJD,iDAAiD;AACjD,uBAAuB;AACvB,iDAAiD;AAEjD,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,OAAO,EAAE,WAAW;IACpB,UAAU,EAAE,cAAc;IAC1B,UAAU,EAAE,cAAc;IAC1B,UAAU,EAAE,cAAc;IAC1B,gBAAgB,EAAE,oBAAoB;IACtC,aAAa,EAAE,iBAAiB;IAChC,cAAc,EAAE,kBAAkB;IAClC,YAAY,EAAE,gBAAgB;IAC9B,iBAAiB,EAAE,qBAAqB;IACxC,iBAAiB,EAAE,cAAc;CACzB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@heavybit/pendoadmin-shared-lib",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.7.0",
|
|
4
4
|
"description": "Shared library for PendoAdmin microservices",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"build": "tsc",
|
|
30
30
|
"dev": "tsc --watch",
|
|
31
31
|
"clean": "rm -rf dist",
|
|
32
|
-
"test": "npm run build && node --test tests
|
|
32
|
+
"test": "npm run build && node --test tests/*.test.mjs"
|
|
33
33
|
},
|
|
34
34
|
"exports": {
|
|
35
35
|
".": "./dist/index.js",
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import crypto from 'node:crypto';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Signed gateway identity.
|
|
5
|
+
*
|
|
6
|
+
* The api-gateway (and any internal service forwarding a caller's identity)
|
|
7
|
+
* signs the identity headers it injects with GATEWAY_SIGNING_SECRET. Downstream
|
|
8
|
+
* services verify the signature before trusting x-user-id / x-is-superadmin /
|
|
9
|
+
* x-user-permissions, so a request that reaches a service port directly, or
|
|
10
|
+
* slips past the gateway with its own headers, cannot impersonate anyone.
|
|
11
|
+
*
|
|
12
|
+
* The api-gateway keeps its own copy of the signer
|
|
13
|
+
* (api-gateway/src/utils/gateway-signature.ts). Any change to the canonical
|
|
14
|
+
* string below must be made in both places — the shared test vector in both
|
|
15
|
+
* test suites pins the format.
|
|
16
|
+
*/
|
|
17
|
+
|
|
18
|
+
export const GATEWAY_SIGNATURE_HEADER = 'x-gateway-signature';
|
|
19
|
+
export const GATEWAY_TIMESTAMP_HEADER = 'x-gateway-ts';
|
|
20
|
+
const SIGNATURE_VERSION = 'v1';
|
|
21
|
+
|
|
22
|
+
/** Identity headers covered by the signature, in canonical order. */
|
|
23
|
+
export const GATEWAY_IDENTITY_HEADERS = [
|
|
24
|
+
'x-user-id',
|
|
25
|
+
'x-user-email',
|
|
26
|
+
'x-company-id',
|
|
27
|
+
'x-company-slug',
|
|
28
|
+
'x-user-roles',
|
|
29
|
+
'x-user-permissions',
|
|
30
|
+
'x-is-superadmin',
|
|
31
|
+
'x-otp-verified',
|
|
32
|
+
] as const;
|
|
33
|
+
|
|
34
|
+
/** Default allowed clock skew between signer and verifier. */
|
|
35
|
+
export const GATEWAY_SIGNATURE_MAX_SKEW_SECONDS = 60;
|
|
36
|
+
|
|
37
|
+
type HeaderBag = Record<string, string | string[] | undefined>;
|
|
38
|
+
|
|
39
|
+
function headerValue(headers: HeaderBag, name: string): string {
|
|
40
|
+
const value = headers[name];
|
|
41
|
+
return (Array.isArray(value) ? value[0] : value) ?? '';
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
function canonicalString(headers: HeaderBag, timestamp: string): string {
|
|
45
|
+
return [
|
|
46
|
+
SIGNATURE_VERSION,
|
|
47
|
+
timestamp,
|
|
48
|
+
headerValue(headers, 'x-correlation-id'),
|
|
49
|
+
...GATEWAY_IDENTITY_HEADERS.map((name) => headerValue(headers, name)),
|
|
50
|
+
].join('\n');
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
function hmac(secret: string, payload: string): string {
|
|
54
|
+
return crypto.createHmac('sha256', secret).update(payload).digest('hex');
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* Signature headers for the identity headers already present in `headers`
|
|
59
|
+
* (lower-case names). Merge the result into the outgoing request headers.
|
|
60
|
+
*/
|
|
61
|
+
export function signGatewayIdentity(
|
|
62
|
+
headers: HeaderBag,
|
|
63
|
+
secret: string,
|
|
64
|
+
nowMs: number = Date.now(),
|
|
65
|
+
): Record<typeof GATEWAY_SIGNATURE_HEADER | typeof GATEWAY_TIMESTAMP_HEADER, string> {
|
|
66
|
+
const timestamp = String(Math.floor(nowMs / 1000));
|
|
67
|
+
return {
|
|
68
|
+
[GATEWAY_SIGNATURE_HEADER]: hmac(secret, canonicalString(headers, timestamp)),
|
|
69
|
+
[GATEWAY_TIMESTAMP_HEADER]: timestamp,
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export interface VerifyGatewayIdentityOptions {
|
|
74
|
+
maxSkewSeconds?: number;
|
|
75
|
+
nowMs?: number;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
/** True when the identity headers carry a valid, fresh signature from `secret`. */
|
|
79
|
+
export function verifyGatewayIdentity(
|
|
80
|
+
headers: HeaderBag,
|
|
81
|
+
secret: string,
|
|
82
|
+
options: VerifyGatewayIdentityOptions = {},
|
|
83
|
+
): boolean {
|
|
84
|
+
if (!secret) return false;
|
|
85
|
+
const { maxSkewSeconds = GATEWAY_SIGNATURE_MAX_SKEW_SECONDS, nowMs = Date.now() } = options;
|
|
86
|
+
|
|
87
|
+
const timestamp = headerValue(headers, GATEWAY_TIMESTAMP_HEADER);
|
|
88
|
+
const signature = headerValue(headers, GATEWAY_SIGNATURE_HEADER);
|
|
89
|
+
if (!/^\d+$/.test(timestamp) || !/^[0-9a-f]{64}$/.test(signature)) return false;
|
|
90
|
+
if (Math.abs(nowMs / 1000 - Number(timestamp)) > maxSkewSeconds) return false;
|
|
91
|
+
|
|
92
|
+
const expected = Buffer.from(hmac(secret, canonicalString(headers, timestamp)), 'hex');
|
|
93
|
+
const provided = Buffer.from(signature, 'hex');
|
|
94
|
+
return expected.length === provided.length && crypto.timingSafeEqual(expected, provided);
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* The secret services sign and verify gateway identity with. Unset means
|
|
99
|
+
* unsigned identity is accepted only outside production (see
|
|
100
|
+
* isUnsignedGatewayIdentityAllowed).
|
|
101
|
+
*/
|
|
102
|
+
export function gatewaySigningSecret(): string {
|
|
103
|
+
return process.env.GATEWAY_SIGNING_SECRET || '';
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
/** Local development may run services without a signing secret; production never trusts unsigned identity. */
|
|
107
|
+
export function isUnsignedGatewayIdentityAllowed(): boolean {
|
|
108
|
+
return !gatewaySigningSecret() && process.env.NODE_ENV !== 'production';
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* Whether a request's gateway identity headers can be trusted: a valid
|
|
113
|
+
* signature when a secret is configured, otherwise only outside production.
|
|
114
|
+
*/
|
|
115
|
+
export function isTrustedGatewayIdentity(headers: HeaderBag): boolean {
|
|
116
|
+
const secret = gatewaySigningSecret();
|
|
117
|
+
if (secret) return verifyGatewayIdentity(headers, secret);
|
|
118
|
+
return isUnsignedGatewayIdentityAllowed();
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
/** Direct JWT validation is a development convenience only; production requests must come through the gateway. */
|
|
122
|
+
export function isDirectJwtFallbackAllowed(): boolean {
|
|
123
|
+
return process.env.NODE_ENV !== 'production';
|
|
124
|
+
}
|
package/src/common/index.ts
CHANGED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { IAuthUser } from '../types/index.js';
|
|
2
|
+
|
|
3
|
+
/** The API-key scope that grants every permission the key's company has. */
|
|
4
|
+
export const ALL_PERMISSIONS_SCOPE = '*';
|
|
5
|
+
|
|
6
|
+
export type PermissionHolder = Pick<IAuthUser, 'isSuperAdmin' | 'permissions'>;
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* True when the user may act with ANY of the listed permissions: super admins always,
|
|
10
|
+
* API keys holding the '*' scope always, otherwise when one of the permissions is granted.
|
|
11
|
+
* This is the rule `requirePermission` enforces; use it for in-service checks so the two never drift.
|
|
12
|
+
*/
|
|
13
|
+
export function hasPermission(user: PermissionHolder | null | undefined, ...permissions: string[]): boolean {
|
|
14
|
+
if (!user) return false;
|
|
15
|
+
if (user.isSuperAdmin) return true;
|
|
16
|
+
const granted = user.permissions ?? [];
|
|
17
|
+
return granted.includes(ALL_PERMISSIONS_SCOPE) || permissions.some(p => granted.includes(p));
|
|
18
|
+
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { Request, Response, NextFunction } from 'express';
|
|
2
2
|
import { verifyToken, extractBearerToken } from '../common/jwt.utils.js';
|
|
3
|
+
import { isTrustedGatewayIdentity, isDirectJwtFallbackAllowed } from '../common/gateway-signature.js';
|
|
3
4
|
import { GATEWAY_HEADERS, type IAuthUser } from '../types/index.js';
|
|
4
5
|
|
|
5
6
|
/** Parse a header value that may be a JSON array string or comma-separated. */
|
|
@@ -21,83 +22,64 @@ declare global {
|
|
|
21
22
|
}
|
|
22
23
|
}
|
|
23
24
|
|
|
25
|
+
/** The caller from signed gateway headers, or null when absent or unsigned/forged. */
|
|
26
|
+
function userFromGatewayHeaders(req: Request): IAuthUser | null {
|
|
27
|
+
const userId = req.headers[GATEWAY_HEADERS.USER_ID] as string;
|
|
28
|
+
if (!userId || !isTrustedGatewayIdentity(req.headers)) return null;
|
|
29
|
+
return {
|
|
30
|
+
id: userId,
|
|
31
|
+
email: req.headers[GATEWAY_HEADERS.USER_EMAIL] as string || '',
|
|
32
|
+
companyId: req.headers[GATEWAY_HEADERS.COMPANY_ID] as string || '',
|
|
33
|
+
roles: parseArrayHeader(req.headers[GATEWAY_HEADERS.USER_ROLES] as string),
|
|
34
|
+
permissions: parseArrayHeader(req.headers[GATEWAY_HEADERS.USER_PERMISSIONS] as string),
|
|
35
|
+
isSuperAdmin: req.headers[GATEWAY_HEADERS.IS_SUPERADMIN] === 'true',
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
/** The caller from a bearer JWT — development only (direct service access). */
|
|
40
|
+
function userFromBearerToken(req: Request, jwtSecret?: string): IAuthUser | null {
|
|
41
|
+
if (!jwtSecret || !isDirectJwtFallbackAllowed()) return null;
|
|
42
|
+
const token = extractBearerToken(req.headers.authorization);
|
|
43
|
+
if (!token) return null;
|
|
44
|
+
try {
|
|
45
|
+
const payload = verifyToken(token, jwtSecret);
|
|
46
|
+
return {
|
|
47
|
+
id: payload.sub,
|
|
48
|
+
email: payload.email,
|
|
49
|
+
companyId: payload.companyId,
|
|
50
|
+
roles: payload.roles || [],
|
|
51
|
+
permissions: payload.permissions || [],
|
|
52
|
+
isSuperAdmin: payload.isSuperAdmin || false,
|
|
53
|
+
};
|
|
54
|
+
} catch {
|
|
55
|
+
return null;
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
|
|
24
59
|
/**
|
|
25
60
|
* Auth middleware for downstream services (behind API gateway).
|
|
26
|
-
* Reads user context from gateway-injected headers
|
|
27
|
-
*
|
|
61
|
+
* Reads user context from gateway-injected headers, trusted only with a valid
|
|
62
|
+
* gateway signature (GATEWAY_SIGNING_SECRET). Outside production it falls back
|
|
63
|
+
* to direct JWT validation for local development.
|
|
28
64
|
*/
|
|
29
65
|
export function authenticateFromGateway(jwtSecret?: string) {
|
|
30
|
-
return (req: Request,
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
req.user = {
|
|
35
|
-
id: userId,
|
|
36
|
-
email: req.headers[GATEWAY_HEADERS.USER_EMAIL] as string || '',
|
|
37
|
-
companyId: req.headers[GATEWAY_HEADERS.COMPANY_ID] as string || '',
|
|
38
|
-
roles: parseArrayHeader(req.headers[GATEWAY_HEADERS.USER_ROLES] as string),
|
|
39
|
-
permissions: parseArrayHeader(req.headers[GATEWAY_HEADERS.USER_PERMISSIONS] as string),
|
|
40
|
-
isSuperAdmin: req.headers[GATEWAY_HEADERS.IS_SUPERADMIN] === 'true',
|
|
41
|
-
};
|
|
66
|
+
return (req: Request, res: Response, next: NextFunction): void => {
|
|
67
|
+
const user = userFromGatewayHeaders(req) ?? userFromBearerToken(req, jwtSecret);
|
|
68
|
+
if (user) {
|
|
69
|
+
req.user = user;
|
|
42
70
|
return next();
|
|
43
71
|
}
|
|
44
|
-
|
|
45
|
-
// Method 2: Direct JWT validation (for development / direct access)
|
|
46
|
-
if (jwtSecret) {
|
|
47
|
-
const token = extractBearerToken(req.headers.authorization);
|
|
48
|
-
if (token) {
|
|
49
|
-
try {
|
|
50
|
-
const payload = verifyToken(token, jwtSecret);
|
|
51
|
-
req.user = {
|
|
52
|
-
id: payload.sub,
|
|
53
|
-
email: payload.email,
|
|
54
|
-
companyId: payload.companyId,
|
|
55
|
-
roles: payload.roles || [],
|
|
56
|
-
permissions: payload.permissions || [],
|
|
57
|
-
isSuperAdmin: payload.isSuperAdmin || false,
|
|
58
|
-
};
|
|
59
|
-
return next();
|
|
60
|
-
} catch {
|
|
61
|
-
// Fall through to 401
|
|
62
|
-
}
|
|
63
|
-
}
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
_res.status(401).json({ success: false, message: 'Authentication required' });
|
|
72
|
+
res.status(401).json({ success: false, message: 'Authentication required' });
|
|
67
73
|
};
|
|
68
74
|
}
|
|
69
75
|
|
|
70
76
|
/**
|
|
71
|
-
* Optional auth — attaches user if present, continues if not.
|
|
77
|
+
* Optional auth — attaches user if present (and trusted), continues if not.
|
|
72
78
|
*/
|
|
73
79
|
export function optionalAuthFromGateway(jwtSecret?: string) {
|
|
74
80
|
return (req: Request, _res: Response, next: NextFunction): void => {
|
|
75
|
-
const
|
|
76
|
-
if (
|
|
77
|
-
req.user = {
|
|
78
|
-
id: userId,
|
|
79
|
-
email: req.headers[GATEWAY_HEADERS.USER_EMAIL] as string || '',
|
|
80
|
-
companyId: req.headers[GATEWAY_HEADERS.COMPANY_ID] as string || '',
|
|
81
|
-
roles: parseArrayHeader(req.headers[GATEWAY_HEADERS.USER_ROLES] as string),
|
|
82
|
-
permissions: parseArrayHeader(req.headers[GATEWAY_HEADERS.USER_PERMISSIONS] as string),
|
|
83
|
-
isSuperAdmin: req.headers[GATEWAY_HEADERS.IS_SUPERADMIN] === 'true',
|
|
84
|
-
};
|
|
85
|
-
} else if (jwtSecret) {
|
|
86
|
-
const token = extractBearerToken(req.headers.authorization);
|
|
87
|
-
if (token) {
|
|
88
|
-
try {
|
|
89
|
-
const payload = verifyToken(token, jwtSecret);
|
|
90
|
-
req.user = {
|
|
91
|
-
id: payload.sub,
|
|
92
|
-
email: payload.email,
|
|
93
|
-
companyId: payload.companyId,
|
|
94
|
-
roles: payload.roles || [],
|
|
95
|
-
permissions: payload.permissions || [],
|
|
96
|
-
isSuperAdmin: payload.isSuperAdmin || false,
|
|
97
|
-
};
|
|
98
|
-
} catch { /* ignore */ }
|
|
99
|
-
}
|
|
100
|
-
}
|
|
81
|
+
const user = userFromGatewayHeaders(req) ?? userFromBearerToken(req, jwtSecret);
|
|
82
|
+
if (user) req.user = user;
|
|
101
83
|
next();
|
|
102
84
|
};
|
|
103
85
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { Request, Response, NextFunction } from 'express';
|
|
2
|
+
import { hasPermission } from '../common/permission.utils.js';
|
|
2
3
|
|
|
3
4
|
/**
|
|
4
5
|
* Require a specific permission. Superadmins bypass all checks.
|
|
@@ -10,11 +11,7 @@ export function requirePermission(...permissions: string[]) {
|
|
|
10
11
|
return;
|
|
11
12
|
}
|
|
12
13
|
|
|
13
|
-
if (req.user
|
|
14
|
-
|
|
15
|
-
// API keys may hold the '*' scope meaning all permissions the key's company has.
|
|
16
|
-
const hasPermission = req.user!.permissions.includes('*') || permissions.some(p => req.user!.permissions.includes(p));
|
|
17
|
-
if (!hasPermission) {
|
|
14
|
+
if (!hasPermission(req.user, ...permissions)) {
|
|
18
15
|
res.status(403).json({
|
|
19
16
|
success: false,
|
|
20
17
|
message: 'Insufficient permissions',
|
package/src/logging/index.ts
CHANGED
|
@@ -2,6 +2,9 @@ import winston from 'winston';
|
|
|
2
2
|
import DailyRotateFile from 'winston-daily-rotate-file';
|
|
3
3
|
import { mkdirSync } from 'fs';
|
|
4
4
|
import { resolve } from 'path';
|
|
5
|
+
import { redactFormat } from './redact.js';
|
|
6
|
+
|
|
7
|
+
export { redactFormat, redactSensitive, isSensitiveKey, REDACTED } from './redact.js';
|
|
5
8
|
|
|
6
9
|
const { combine, timestamp, json, errors, colorize, printf, splat } = winston.format;
|
|
7
10
|
|
|
@@ -118,7 +121,8 @@ export function createLogger(service: string, level?: string): winston.Logger {
|
|
|
118
121
|
return winston.createLogger({
|
|
119
122
|
level: resolvedLevel,
|
|
120
123
|
defaultMeta: { service },
|
|
121
|
-
|
|
124
|
+
// redactFormat runs after splat so metadata passed as extra arguments is covered too.
|
|
125
|
+
format: combine(errors({ stack: true }), splat(), redactFormat(), timestamp()),
|
|
122
126
|
transports,
|
|
123
127
|
});
|
|
124
128
|
}
|
|
@@ -137,7 +141,7 @@ export function createAuditLogger(service: string): winston.Logger {
|
|
|
137
141
|
return winston.createLogger({
|
|
138
142
|
level: 'info',
|
|
139
143
|
defaultMeta: { service, type: 'audit' },
|
|
140
|
-
format: combine(splat(), timestamp(), json()),
|
|
144
|
+
format: combine(splat(), redactFormat(), timestamp(), json()),
|
|
141
145
|
transports,
|
|
142
146
|
});
|
|
143
147
|
}
|