node-server-engine 1.1.6 → 1.1.8

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.
Files changed (65) hide show
  1. package/.env.example +0 -38
  2. package/.nycrc +9 -3
  3. package/README.md +2 -3
  4. package/dist/const/tokenIssuer.d.ts +2 -4
  5. package/dist/const/tokenIssuer.js +0 -1
  6. package/dist/const/tokenIssuer.js.map +1 -1
  7. package/dist/entities/Endpoint/Endpoint.types.d.ts +2 -19
  8. package/dist/entities/Endpoint/Endpoint.types.js +1 -8
  9. package/dist/entities/Endpoint/Endpoint.types.js.map +1 -1
  10. package/dist/entities/Server/Server.js +5 -0
  11. package/dist/entities/Server/Server.js.map +1 -1
  12. package/dist/middleware/index.d.ts +0 -1
  13. package/dist/middleware/index.js +0 -11
  14. package/dist/middleware/index.js.map +1 -1
  15. package/dist/utils/index.d.ts +0 -1
  16. package/dist/utils/index.js +0 -11
  17. package/dist/utils/index.js.map +1 -1
  18. package/dist/utils/jwt/jwt.d.ts +0 -1
  19. package/dist/utils/jwt/jwt.js +2 -23
  20. package/dist/utils/jwt/jwt.js.map +1 -1
  21. package/dist/utils/report/report.js +1 -2
  22. package/dist/utils/report/report.js.map +1 -1
  23. package/package.json +9 -7
  24. package/src/const/tokenIssuer.ts +1 -3
  25. package/src/entities/Endpoint/Endpoint.test.ts +0 -89
  26. package/src/entities/Endpoint/Endpoint.types.ts +3 -30
  27. package/src/entities/KeySet/KeySet.test.ts +1 -1
  28. package/src/entities/Server/Server.ts +9 -0
  29. package/src/middleware/index.ts +0 -1
  30. package/src/utils/index.ts +0 -1
  31. package/src/utils/jwt/jwt.test.ts +0 -13
  32. package/src/utils/jwt/jwt.ts +2 -25
  33. package/src/utils/report/report.ts +1 -2
  34. package/test/env.ts +0 -5
  35. package/test/hooks.ts +0 -2
  36. package/dist/middleware/authAdmin/authAdmin.d.ts +0 -4
  37. package/dist/middleware/authAdmin/authAdmin.js +0 -105
  38. package/dist/middleware/authAdmin/authAdmin.js.map +0 -1
  39. package/dist/middleware/authAdmin/authAdmin.types.d.ts +0 -16
  40. package/dist/middleware/authAdmin/authAdmin.types.js +0 -2
  41. package/dist/middleware/authAdmin/authAdmin.types.js.map +0 -1
  42. package/dist/middleware/authAdmin/index.d.ts +0 -2
  43. package/dist/middleware/authAdmin/index.js +0 -28
  44. package/dist/middleware/authAdmin/index.js.map +0 -1
  45. package/dist/utils/getDynamicLink/getDynamicLink.d.ts +0 -3
  46. package/dist/utils/getDynamicLink/getDynamicLink.js +0 -28
  47. package/dist/utils/getDynamicLink/getDynamicLink.js.map +0 -1
  48. package/dist/utils/getDynamicLink/getDynamicLink.types.d.ts +0 -10
  49. package/dist/utils/getDynamicLink/getDynamicLink.types.js +0 -2
  50. package/dist/utils/getDynamicLink/getDynamicLink.types.js.map +0 -1
  51. package/dist/utils/getDynamicLink/getDynamicLink.validate.d.ts +0 -2
  52. package/dist/utils/getDynamicLink/getDynamicLink.validate.js +0 -14
  53. package/dist/utils/getDynamicLink/getDynamicLink.validate.js.map +0 -1
  54. package/dist/utils/getDynamicLink/index.d.ts +0 -2
  55. package/dist/utils/getDynamicLink/index.js +0 -28
  56. package/dist/utils/getDynamicLink/index.js.map +0 -1
  57. package/src/middleware/authAdmin/authAdmin.test.ts +0 -199
  58. package/src/middleware/authAdmin/authAdmin.ts +0 -114
  59. package/src/middleware/authAdmin/authAdmin.types.ts +0 -19
  60. package/src/middleware/authAdmin/index.ts +0 -2
  61. package/src/utils/getDynamicLink/getDynamicLink.test.ts +0 -51
  62. package/src/utils/getDynamicLink/getDynamicLink.ts +0 -28
  63. package/src/utils/getDynamicLink/getDynamicLink.types.ts +0 -11
  64. package/src/utils/getDynamicLink/getDynamicLink.validate.ts +0 -6
  65. package/src/utils/getDynamicLink/index.ts +0 -2
@@ -1,105 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.authAdmin = authAdmin;
7
- var _const = require("../../const");
8
- var _EngineError = require("../../entities/EngineError");
9
- var _WebError = require("../../entities/WebError");
10
- var _utils = require("../../utils");
11
- require("./authAdmin.types");
12
- const namespace = 'engine:middleware:authAdmin';
13
-
14
- /** Generate a middleware to authenticate the client connection with a Admin api */
15
- function authAdmin(options) {
16
- if (!options.permission) throw new _EngineError.EngineError({
17
- message: 'Endpoint using admin auth type must specify permission'
18
- });
19
- return async (request, response, next) => {
20
- const [scheme, credentials] = request.headers?.authorization?.split(' ') ?? [];
21
- // No bearer token has been sent
22
- if (!credentials || scheme.toLowerCase() !== 'bearer') {
23
- throw new _WebError.WebError({
24
- errorCode: 'unauthorized',
25
- statusCode: 401,
26
- message: 'No bearer token found',
27
- data: {
28
- authorization: request.headers?.authorization
29
- }
30
- });
31
- }
32
- (0, _utils.reportDebug)({
33
- namespace,
34
- message: 'Performing JWT authentication',
35
- data: {
36
- scheme,
37
- credentials
38
- }
39
- });
40
- // Verify token and extract its payload
41
- const payload = await (0, _utils.jwtVerify)(credentials, _const.TokenIssuer.ADMIN_API);
42
- (0, _utils.reportDebug)({
43
- namespace,
44
- message: 'Extracted user data from JWT',
45
- data: {
46
- payload,
47
- credentials
48
- }
49
- });
50
- if (!payload.per) throw new _WebError.WebError({
51
- errorCode: 'unauthorized',
52
- statusCode: 401,
53
- message: `User token does not contain any permission claim`
54
- });
55
-
56
- // User Permission
57
- const permissions = payload.per;
58
- const userPermissions = permissions instanceof Array ? permissions : [permissions];
59
- (0, _utils.reportDebug)({
60
- namespace,
61
- message: 'Performing Admin Permission check',
62
- data: {
63
- permissions,
64
- endpointPermission: options.permission,
65
- adminPermissions: userPermissions
66
- }
67
- });
68
- if (!checkUserPermissions(userPermissions, options.permission)) {
69
- throw new _WebError.WebError({
70
- errorCode: 'unauthorized',
71
- statusCode: 401,
72
- message: `User does not have required permission "${options.permission}"`,
73
- data: {
74
- userPermissions
75
- }
76
- });
77
- }
78
-
79
- // The user object on the request is hydrated with data from the token
80
- request.admin = {
81
- ...request.admin,
82
- email: payload.sub,
83
- permissions: userPermissions
84
- };
85
- next();
86
- };
87
- }
88
-
89
- /** */
90
- function checkUserPermissions(userPermissions, endpointPermission) {
91
- const endpointPermissionParts = endpointPermission.split(':');
92
- userPermissionLoop: for (const permission of userPermissions) {
93
- const permissionParts = permission.split(':');
94
-
95
- // Ignore if both are not same length
96
- if (permissionParts.length !== endpointPermissionParts.length) continue userPermissionLoop;
97
- for (let i = 0; i < permissionParts.length; i++) {
98
- // Wildcards get automatic validation, otherwise it must match with the same part of the endpoint permission
99
- if (permissionParts[i] !== '*' && permissionParts[i] !== endpointPermissionParts[i]) continue userPermissionLoop;
100
- }
101
- return true;
102
- }
103
- return false;
104
- }
105
- //# sourceMappingURL=authAdmin.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"authAdmin.js","names":["_const","require","_EngineError","_WebError","_utils","namespace","authAdmin","options","permission","EngineError","message","request","response","next","scheme","credentials","headers","authorization","split","toLowerCase","WebError","errorCode","statusCode","data","reportDebug","payload","jwtVerify","TokenIssuer","ADMIN_API","per","permissions","userPermissions","Array","endpointPermission","adminPermissions","checkUserPermissions","admin","email","sub","endpointPermissionParts","userPermissionLoop","permissionParts","length","i"],"sources":["../../../src/middleware/authAdmin/authAdmin.ts"],"sourcesContent":["import { Request, Response, NextFunction } from 'express';\nimport { TokenIssuer } from 'const';\nimport { EndpointAuthParams, EndpointAuthType } from 'entities/Endpoint';\nimport { EngineError } from 'entities/EngineError';\nimport { WebError } from 'entities/WebError';\nimport { reportDebug, jwtVerify } from 'utils';\nimport {} from './authAdmin.types';\n\nconst namespace = 'engine:middleware:authAdmin';\n\n/** Generate a middleware to authenticate the client connection with a Admin api */\nexport function authAdmin(\n options: EndpointAuthParams<EndpointAuthType.ADMIN>\n): (request: Request, response: Response, next: NextFunction) => Promise<void> {\n if (!options.permission)\n throw new EngineError({\n message: 'Endpoint using admin auth type must specify permission'\n });\n return async (\n request: Request,\n response: Response,\n next: NextFunction\n ): Promise<void> => {\n const [scheme, credentials] =\n request.headers?.authorization?.split(' ') ?? [];\n // No bearer token has been sent\n if (!credentials || scheme.toLowerCase() !== 'bearer') {\n throw new WebError({\n errorCode: 'unauthorized',\n statusCode: 401,\n message: 'No bearer token found',\n data: { authorization: request.headers?.authorization }\n });\n }\n reportDebug({\n namespace,\n message: 'Performing JWT authentication',\n data: { scheme, credentials }\n });\n // Verify token and extract its payload\n const payload = await jwtVerify(credentials, TokenIssuer.ADMIN_API);\n reportDebug({\n namespace,\n message: 'Extracted user data from JWT',\n data: { payload, credentials }\n });\n\n if (!payload.per)\n throw new WebError({\n errorCode: 'unauthorized',\n statusCode: 401,\n message: `User token does not contain any permission claim`\n });\n\n // User Permission\n const permissions = payload.per;\n const userPermissions =\n permissions instanceof Array ? permissions : [permissions];\n\n reportDebug({\n namespace,\n message: 'Performing Admin Permission check',\n data: {\n permissions,\n endpointPermission: options.permission,\n adminPermissions: userPermissions\n }\n });\n\n if (!checkUserPermissions(userPermissions, options.permission)) {\n throw new WebError({\n errorCode: 'unauthorized',\n statusCode: 401,\n message: `User does not have required permission \"${options.permission}\"`,\n data: { userPermissions }\n });\n }\n\n // The user object on the request is hydrated with data from the token\n request.admin = {\n ...request.admin,\n email: payload.sub,\n permissions: userPermissions\n };\n\n next();\n };\n}\n\n/** */\nfunction checkUserPermissions(\n userPermissions: Array<string>,\n endpointPermission: string\n): boolean {\n const endpointPermissionParts = endpointPermission.split(':');\n userPermissionLoop: for (const permission of userPermissions) {\n const permissionParts = permission.split(':');\n\n // Ignore if both are not same length\n if (permissionParts.length !== endpointPermissionParts.length)\n continue userPermissionLoop;\n\n for (let i = 0; i < permissionParts.length; i++) {\n // Wildcards get automatic validation, otherwise it must match with the same part of the endpoint permission\n if (\n permissionParts[i] !== '*' &&\n permissionParts[i] !== endpointPermissionParts[i]\n )\n continue userPermissionLoop;\n }\n return true;\n }\n return false;\n}\n"],"mappings":";;;;;;AACA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,YAAA,GAAAD,OAAA;AACA,IAAAE,SAAA,GAAAF,OAAA;AACA,IAAAG,MAAA,GAAAH,OAAA;AACAA,OAAA;AAEA,MAAMI,SAAS,GAAG,6BAA6B;;AAE/C;AACO,SAASC,SAASA,CACvBC,OAAmD,EAC0B;EAC7E,IAAI,CAACA,OAAO,CAACC,UAAU,EACrB,MAAM,IAAIC,wBAAW,CAAC;IACpBC,OAAO,EAAE;EACX,CAAC,CAAC;EACJ,OAAO,OACLC,OAAgB,EAChBC,QAAkB,EAClBC,IAAkB,KACA;IAClB,MAAM,CAACC,MAAM,EAAEC,WAAW,CAAC,GACzBJ,OAAO,CAACK,OAAO,EAAEC,aAAa,EAAEC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE;IAClD;IACA,IAAI,CAACH,WAAW,IAAID,MAAM,CAACK,WAAW,CAAC,CAAC,KAAK,QAAQ,EAAE;MACrD,MAAM,IAAIC,kBAAQ,CAAC;QACjBC,SAAS,EAAE,cAAc;QACzBC,UAAU,EAAE,GAAG;QACfZ,OAAO,EAAE,uBAAuB;QAChCa,IAAI,EAAE;UAAEN,aAAa,EAAEN,OAAO,CAACK,OAAO,EAAEC;QAAc;MACxD,CAAC,CAAC;IACJ;IACA,IAAAO,kBAAW,EAAC;MACVnB,SAAS;MACTK,OAAO,EAAE,+BAA+B;MACxCa,IAAI,EAAE;QAAET,MAAM;QAAEC;MAAY;IAC9B,CAAC,CAAC;IACF;IACA,MAAMU,OAAO,GAAG,MAAM,IAAAC,gBAAS,EAACX,WAAW,EAAEY,kBAAW,CAACC,SAAS,CAAC;IACnE,IAAAJ,kBAAW,EAAC;MACVnB,SAAS;MACTK,OAAO,EAAE,8BAA8B;MACvCa,IAAI,EAAE;QAAEE,OAAO;QAAEV;MAAY;IAC/B,CAAC,CAAC;IAEF,IAAI,CAACU,OAAO,CAACI,GAAG,EACd,MAAM,IAAIT,kBAAQ,CAAC;MACjBC,SAAS,EAAE,cAAc;MACzBC,UAAU,EAAE,GAAG;MACfZ,OAAO,EAAE;IACX,CAAC,CAAC;;IAEJ;IACA,MAAMoB,WAAW,GAAGL,OAAO,CAACI,GAAG;IAC/B,MAAME,eAAe,GACnBD,WAAW,YAAYE,KAAK,GAAGF,WAAW,GAAG,CAACA,WAAW,CAAC;IAE5D,IAAAN,kBAAW,EAAC;MACVnB,SAAS;MACTK,OAAO,EAAE,mCAAmC;MAC5Ca,IAAI,EAAE;QACJO,WAAW;QACXG,kBAAkB,EAAE1B,OAAO,CAACC,UAAU;QACtC0B,gBAAgB,EAAEH;MACpB;IACF,CAAC,CAAC;IAEF,IAAI,CAACI,oBAAoB,CAACJ,eAAe,EAAExB,OAAO,CAACC,UAAU,CAAC,EAAE;MAC9D,MAAM,IAAIY,kBAAQ,CAAC;QACjBC,SAAS,EAAE,cAAc;QACzBC,UAAU,EAAE,GAAG;QACfZ,OAAO,EAAE,2CAA2CH,OAAO,CAACC,UAAU,GAAG;QACzEe,IAAI,EAAE;UAAEQ;QAAgB;MAC1B,CAAC,CAAC;IACJ;;IAEA;IACApB,OAAO,CAACyB,KAAK,GAAG;MACd,GAAGzB,OAAO,CAACyB,KAAK;MAChBC,KAAK,EAAEZ,OAAO,CAACa,GAAG;MAClBR,WAAW,EAAEC;IACf,CAAC;IAEDlB,IAAI,CAAC,CAAC;EACR,CAAC;AACH;;AAEA;AACA,SAASsB,oBAAoBA,CAC3BJ,eAA8B,EAC9BE,kBAA0B,EACjB;EACT,MAAMM,uBAAuB,GAAGN,kBAAkB,CAACf,KAAK,CAAC,GAAG,CAAC;EAC7DsB,kBAAkB,EAAE,KAAK,MAAMhC,UAAU,IAAIuB,eAAe,EAAE;IAC5D,MAAMU,eAAe,GAAGjC,UAAU,CAACU,KAAK,CAAC,GAAG,CAAC;;IAE7C;IACA,IAAIuB,eAAe,CAACC,MAAM,KAAKH,uBAAuB,CAACG,MAAM,EAC3D,SAASF,kBAAkB;IAE7B,KAAK,IAAIG,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGF,eAAe,CAACC,MAAM,EAAEC,CAAC,EAAE,EAAE;MAC/C;MACA,IACEF,eAAe,CAACE,CAAC,CAAC,KAAK,GAAG,IAC1BF,eAAe,CAACE,CAAC,CAAC,KAAKJ,uBAAuB,CAACI,CAAC,CAAC,EAEjD,SAASH,kBAAkB;IAC/B;IACA,OAAO,IAAI;EACb;EACA,OAAO,KAAK;AACd","ignoreList":[]}
@@ -1,16 +0,0 @@
1
- declare global {
2
- namespace Express {
3
- /** Express request object */
4
- interface Request {
5
- /** User that identified using a JWT */
6
- admin?: RequestAdminProps;
7
- }
8
- }
9
- }
10
- /** Admin auth properties of the request */
11
- export interface RequestAdminProps {
12
- /** Email address of the user */
13
- email: string;
14
- /** List of permissions that the user has */
15
- permissions: Array<string>;
16
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- //# sourceMappingURL=authAdmin.types.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"authAdmin.types.js","names":[],"sources":["../../../src/middleware/authAdmin/authAdmin.types.ts"],"sourcesContent":["// Override the Express request object to add the files\ndeclare global {\n // eslint-disable-next-line @typescript-eslint/no-namespace\n namespace Express {\n /** Express request object */\n interface Request {\n /** User that identified using a JWT */\n admin?: RequestAdminProps;\n }\n }\n}\n\n/** Admin auth properties of the request */\nexport interface RequestAdminProps {\n /** Email address of the user */\n email: string;\n /** List of permissions that the user has */\n permissions: Array<string>;\n}\n"],"mappings":"","ignoreList":[]}
@@ -1,2 +0,0 @@
1
- export * from './authAdmin';
2
- export * from './authAdmin.types';
@@ -1,28 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- var _authAdmin = require("./authAdmin");
7
- Object.keys(_authAdmin).forEach(function (key) {
8
- if (key === "default" || key === "__esModule") return;
9
- if (key in exports && exports[key] === _authAdmin[key]) return;
10
- Object.defineProperty(exports, key, {
11
- enumerable: true,
12
- get: function () {
13
- return _authAdmin[key];
14
- }
15
- });
16
- });
17
- var _authAdmin2 = require("./authAdmin.types");
18
- Object.keys(_authAdmin2).forEach(function (key) {
19
- if (key === "default" || key === "__esModule") return;
20
- if (key in exports && exports[key] === _authAdmin2[key]) return;
21
- Object.defineProperty(exports, key, {
22
- enumerable: true,
23
- get: function () {
24
- return _authAdmin2[key];
25
- }
26
- });
27
- });
28
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","names":["_authAdmin","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_authAdmin2"],"sources":["../../../src/middleware/authAdmin/index.ts"],"sourcesContent":["export * from './authAdmin';\nexport * from './authAdmin.types';\n"],"mappings":";;;;;AAAA,IAAAA,UAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,UAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,UAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,UAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,WAAA,GAAAT,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAO,WAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,WAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,WAAA,CAAAL,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}
@@ -1,3 +0,0 @@
1
- import { getDynamicLinksOptions } from './getDynamicLink.types';
2
- /** Fetch a dynamic link from the links service */
3
- export declare function getDynamicLink(path: string, options?: getDynamicLinksOptions): Promise<string>;
@@ -1,28 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.getDynamicLink = getDynamicLink;
7
- var _getDynamicLink = require("./getDynamicLink.validate");
8
- var _tlsRequest = require("../tlsRequest");
9
- /** Fetch a dynamic link from the links service */
10
- async function getDynamicLink(path, options = {}) {
11
- (0, _getDynamicLink.validateDynamicLinkEnvironment)();
12
- const option = {
13
- method: 'get',
14
- url: '/link',
15
- baseURL: process.env.LINKS_SERVICE_URL,
16
- params: {
17
- path,
18
- short: options.short ?? true
19
- }
20
- };
21
- const {
22
- data: {
23
- link
24
- }
25
- } = await (0, _tlsRequest.tlsRequest)(option);
26
- return link;
27
- }
28
- //# sourceMappingURL=getDynamicLink.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"getDynamicLink.js","names":["_getDynamicLink","require","_tlsRequest","getDynamicLink","path","options","validateDynamicLinkEnvironment","option","method","url","baseURL","process","env","LINKS_SERVICE_URL","params","short","data","link","tlsRequest"],"sources":["../../../src/utils/getDynamicLink/getDynamicLink.ts"],"sourcesContent":["import { AxiosRequestConfig } from 'axios';\nimport {\n getDynamicLinksOptions,\n DynamicLinkResponseBody\n} from './getDynamicLink.types';\nimport { validateDynamicLinkEnvironment } from './getDynamicLink.validate';\nimport { tlsRequest } from 'utils/tlsRequest';\n\n/** Fetch a dynamic link from the links service */\nexport async function getDynamicLink(\n path: string,\n options: getDynamicLinksOptions = {}\n): Promise<string> {\n validateDynamicLinkEnvironment();\n const option: AxiosRequestConfig = {\n method: 'get',\n url: '/link',\n baseURL: process.env.LINKS_SERVICE_URL,\n params: {\n path,\n short: options.short ?? true\n }\n };\n const {\n data: { link }\n } = await tlsRequest<DynamicLinkResponseBody>(option);\n return link;\n}\n"],"mappings":";;;;;;AAKA,IAAAA,eAAA,GAAAC,OAAA;AACA,IAAAC,WAAA,GAAAD,OAAA;AAEA;AACO,eAAeE,cAAcA,CAClCC,IAAY,EACZC,OAA+B,GAAG,CAAC,CAAC,EACnB;EACjB,IAAAC,8CAA8B,EAAC,CAAC;EAChC,MAAMC,MAA0B,GAAG;IACjCC,MAAM,EAAE,KAAK;IACbC,GAAG,EAAE,OAAO;IACZC,OAAO,EAAEC,OAAO,CAACC,GAAG,CAACC,iBAAiB;IACtCC,MAAM,EAAE;MACNV,IAAI;MACJW,KAAK,EAAEV,OAAO,CAACU,KAAK,IAAI;IAC1B;EACF,CAAC;EACD,MAAM;IACJC,IAAI,EAAE;MAAEC;IAAK;EACf,CAAC,GAAG,MAAM,IAAAC,sBAAU,EAA0BX,MAAM,CAAC;EACrD,OAAOU,IAAI;AACb","ignoreList":[]}
@@ -1,10 +0,0 @@
1
- /** Options to fetch dynamic links */
2
- export interface getDynamicLinksOptions {
3
- /** Make a shortened link */
4
- short?: boolean;
5
- }
6
- /** Dynamic link query server response */
7
- export interface DynamicLinkResponseBody {
8
- /** The generated dynamic link */
9
- link: string;
10
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- //# sourceMappingURL=getDynamicLink.types.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"getDynamicLink.types.js","names":[],"sources":["../../../src/utils/getDynamicLink/getDynamicLink.types.ts"],"sourcesContent":["/** Options to fetch dynamic links */\nexport interface getDynamicLinksOptions {\n /** Make a shortened link */\n short?: boolean;\n}\n\n/** Dynamic link query server response */\nexport interface DynamicLinkResponseBody {\n /** The generated dynamic link */\n link: string;\n}\n"],"mappings":"","ignoreList":[]}
@@ -1,2 +0,0 @@
1
- /** Environment variable validator for get dynamic link from LinkService */
2
- export declare function validateDynamicLinkEnvironment(): void;
@@ -1,14 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.validateDynamicLinkEnvironment = validateDynamicLinkEnvironment;
7
- var _ = require("./..");
8
- /** Environment variable validator for get dynamic link from LinkService */
9
- function validateDynamicLinkEnvironment() {
10
- (0, _.assertEnvironment)({
11
- LINKS_SERVICE_URL: _.envAssert.isURL()
12
- });
13
- }
14
- //# sourceMappingURL=getDynamicLink.validate.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"getDynamicLink.validate.js","names":["_","require","validateDynamicLinkEnvironment","assertEnvironment","LINKS_SERVICE_URL","envAssert","isURL"],"sources":["../../../src/utils/getDynamicLink/getDynamicLink.validate.ts"],"sourcesContent":["import { assertEnvironment, envAssert } from 'utils';\n\n/** Environment variable validator for get dynamic link from LinkService */\nexport function validateDynamicLinkEnvironment(): void {\n assertEnvironment({ LINKS_SERVICE_URL: envAssert.isURL() });\n}\n"],"mappings":";;;;;;AAAA,IAAAA,CAAA,GAAAC,OAAA;AAEA;AACO,SAASC,8BAA8BA,CAAA,EAAS;EACrD,IAAAC,mBAAiB,EAAC;IAAEC,iBAAiB,EAAEC,WAAS,CAACC,KAAK,CAAC;EAAE,CAAC,CAAC;AAC7D","ignoreList":[]}
@@ -1,2 +0,0 @@
1
- export * from './getDynamicLink';
2
- export * from './getDynamicLink.types';
@@ -1,28 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- var _getDynamicLink = require("./getDynamicLink");
7
- Object.keys(_getDynamicLink).forEach(function (key) {
8
- if (key === "default" || key === "__esModule") return;
9
- if (key in exports && exports[key] === _getDynamicLink[key]) return;
10
- Object.defineProperty(exports, key, {
11
- enumerable: true,
12
- get: function () {
13
- return _getDynamicLink[key];
14
- }
15
- });
16
- });
17
- var _getDynamicLink2 = require("./getDynamicLink.types");
18
- Object.keys(_getDynamicLink2).forEach(function (key) {
19
- if (key === "default" || key === "__esModule") return;
20
- if (key in exports && exports[key] === _getDynamicLink2[key]) return;
21
- Object.defineProperty(exports, key, {
22
- enumerable: true,
23
- get: function () {
24
- return _getDynamicLink2[key];
25
- }
26
- });
27
- });
28
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","names":["_getDynamicLink","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_getDynamicLink2"],"sources":["../../../src/utils/getDynamicLink/index.ts"],"sourcesContent":["export * from './getDynamicLink';\nexport * from './getDynamicLink.types';\n"],"mappings":";;;;;AAAA,IAAAA,eAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,eAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,eAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,eAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,gBAAA,GAAAT,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAO,gBAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,gBAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,gBAAA,CAAAL,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}
@@ -1,199 +0,0 @@
1
- import { factory, generateAccessToken, getBearer } from 'backend-test-tools';
2
- import { expect } from 'chai';
3
- import { Request, Response } from 'express';
4
- import { faker } from '@faker-js/faker';
5
- import { fake } from 'sinon';
6
- import { authAdmin } from './authAdmin';
7
- import {} from './authAdmin.types';
8
-
9
- describe('Middleware - Auth Admin', () => {
10
- it('should authenticate with a JWT (auth-service)', async () => {
11
- const email = faker.internet.email();
12
- const permission = faker.lorem.word();
13
- const request = {
14
- headers: {
15
- authorization: `Bearer ${generateAccessToken(
16
- email,
17
- {
18
- audience: [process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE as string],
19
- issuer: process.env.ADMIN_ACCESS_TOKEN_ISSUER
20
- },
21
- { per: permission }
22
- )}`
23
- }
24
- } as unknown as Request;
25
- const next = fake();
26
-
27
- await authAdmin({ permission })(
28
- request,
29
- undefined as unknown as Response,
30
- next
31
- );
32
-
33
- expect(next).to.have.been.calledOnceWithExactly();
34
- });
35
-
36
- it('should populate the admin object in the request (auth-service)', async () => {
37
- const email = faker.internet.email();
38
- const permission = faker.lorem.word();
39
- const permissions = [permission, faker.lorem.word(), faker.lorem.word()];
40
- const request = {
41
- headers: {
42
- authorization: `Bearer ${generateAccessToken(
43
- email,
44
- {
45
- audience: [process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE as string],
46
- issuer: process.env.ADMIN_ACCESS_TOKEN_ISSUER
47
- },
48
- { per: permissions }
49
- )}`
50
- }
51
- } as unknown as Request;
52
- const next = fake();
53
-
54
- await authAdmin({ permission })(
55
- request,
56
- undefined as unknown as Response,
57
- next
58
- );
59
-
60
- expect(request.admin?.email).to.equal(email);
61
- expect(request.admin?.permissions).to.deep.members(permissions);
62
- });
63
-
64
- it('should throw an error if there is no token', async () => {
65
- const request = { headers: {} } as unknown as Request;
66
- const next = fake();
67
-
68
- await expect(
69
- authAdmin({ permission: faker.lorem.word() })(
70
- request,
71
- undefined as unknown as Response,
72
- next
73
- )
74
- ).to.eventually.be.rejected;
75
- });
76
-
77
- it('should throw an error if the audience is not valid', async () => {
78
- const user = factory.build('user');
79
- const permission = faker.lorem.word();
80
- const request = {
81
- headers: {
82
- authorization: getBearer(
83
- user.id,
84
- { audience: faker.internet.url() },
85
- { per: permission }
86
- )
87
- }
88
- } as unknown as Request;
89
- const next = fake();
90
-
91
- await expect(
92
- authAdmin({ permission })(request, undefined as unknown as Response, next)
93
- ).to.eventually.be.rejected;
94
- });
95
-
96
- it('should check user has permission', async () => {
97
- const email = faker.internet.email();
98
- const permissions = [faker.lorem.word(), faker.lorem.word()];
99
- const request = {
100
- headers: {
101
- authorization: `Bearer ${generateAccessToken(
102
- email,
103
- {
104
- audience: [process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE as string],
105
- issuer: process.env.ADMIN_ACCESS_TOKEN_ISSUER
106
- },
107
- { per: permissions }
108
- )}`
109
- }
110
- } as unknown as Request;
111
- const next = fake();
112
-
113
- await authAdmin({ permission: permissions[0] })(
114
- request,
115
- undefined as unknown as Response,
116
- next
117
- );
118
-
119
- expect(request.admin?.email).to.equal(email);
120
- expect(request.admin?.permissions).to.deep.members(permissions);
121
- });
122
-
123
- it('should all user has endpoint permission', async () => {
124
- const email = faker.internet.email();
125
- const permission = faker.lorem.word();
126
- const request = {
127
- headers: {
128
- authorization: `Bearer ${generateAccessToken(
129
- email,
130
- {
131
- audience: [process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE as string],
132
- issuer: process.env.ADMIN_ACCESS_TOKEN_ISSUER
133
- },
134
- { per: permission }
135
- )}`
136
- }
137
- } as unknown as Request;
138
- const next = fake();
139
-
140
- await authAdmin({ permission })(
141
- request,
142
- undefined as unknown as Response,
143
- next
144
- );
145
-
146
- expect(request.admin?.email).to.equal(email);
147
- expect(request.admin?.permissions).to.includes(permission);
148
- });
149
-
150
- it('should throw error if user does not have permission', async () => {
151
- const email = faker.internet.email();
152
- const permissions = [faker.lorem.word(), faker.lorem.word()];
153
- const request = {
154
- headers: {
155
- authorization: `Bearer ${generateAccessToken(
156
- email,
157
- {
158
- audience: [process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE as string],
159
- issuer: process.env.ADMIN_ACCESS_TOKEN_ISSUER
160
- },
161
- { per: permissions }
162
- )}`
163
- }
164
- } as unknown as Request;
165
- const next = fake();
166
-
167
- await expect(
168
- authAdmin({ permission: faker.lorem.word() })(
169
- request,
170
- undefined as unknown as Response,
171
- next
172
- )
173
- ).to.eventually.rejected;
174
- });
175
-
176
- it('should allow wildcard permissions', async () => {
177
- const email = faker.internet.email();
178
- const permission = faker.lorem.word();
179
- const request = {
180
- headers: {
181
- authorization: `Bearer ${generateAccessToken(
182
- email,
183
- {
184
- audience: [process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE as string],
185
- issuer: process.env.ADMIN_ACCESS_TOKEN_ISSUER
186
- },
187
- { per: `${permission}:*` }
188
- )}`
189
- }
190
- } as unknown as Request;
191
- const next = fake();
192
-
193
- await authAdmin({ permission: `${permission}:${faker.lorem.word()}` })(
194
- request,
195
- undefined as unknown as Response,
196
- next
197
- );
198
- });
199
- });
@@ -1,114 +0,0 @@
1
- import { Request, Response, NextFunction } from 'express';
2
- import { TokenIssuer } from 'const';
3
- import { EndpointAuthParams, EndpointAuthType } from 'entities/Endpoint';
4
- import { EngineError } from 'entities/EngineError';
5
- import { WebError } from 'entities/WebError';
6
- import { reportDebug, jwtVerify } from 'utils';
7
- import {} from './authAdmin.types';
8
-
9
- const namespace = 'engine:middleware:authAdmin';
10
-
11
- /** Generate a middleware to authenticate the client connection with a Admin api */
12
- export function authAdmin(
13
- options: EndpointAuthParams<EndpointAuthType.ADMIN>
14
- ): (request: Request, response: Response, next: NextFunction) => Promise<void> {
15
- if (!options.permission)
16
- throw new EngineError({
17
- message: 'Endpoint using admin auth type must specify permission'
18
- });
19
- return async (
20
- request: Request,
21
- response: Response,
22
- next: NextFunction
23
- ): Promise<void> => {
24
- const [scheme, credentials] =
25
- request.headers?.authorization?.split(' ') ?? [];
26
- // No bearer token has been sent
27
- if (!credentials || scheme.toLowerCase() !== 'bearer') {
28
- throw new WebError({
29
- errorCode: 'unauthorized',
30
- statusCode: 401,
31
- message: 'No bearer token found',
32
- data: { authorization: request.headers?.authorization }
33
- });
34
- }
35
- reportDebug({
36
- namespace,
37
- message: 'Performing JWT authentication',
38
- data: { scheme, credentials }
39
- });
40
- // Verify token and extract its payload
41
- const payload = await jwtVerify(credentials, TokenIssuer.ADMIN_API);
42
- reportDebug({
43
- namespace,
44
- message: 'Extracted user data from JWT',
45
- data: { payload, credentials }
46
- });
47
-
48
- if (!payload.per)
49
- throw new WebError({
50
- errorCode: 'unauthorized',
51
- statusCode: 401,
52
- message: `User token does not contain any permission claim`
53
- });
54
-
55
- // User Permission
56
- const permissions = payload.per;
57
- const userPermissions =
58
- permissions instanceof Array ? permissions : [permissions];
59
-
60
- reportDebug({
61
- namespace,
62
- message: 'Performing Admin Permission check',
63
- data: {
64
- permissions,
65
- endpointPermission: options.permission,
66
- adminPermissions: userPermissions
67
- }
68
- });
69
-
70
- if (!checkUserPermissions(userPermissions, options.permission)) {
71
- throw new WebError({
72
- errorCode: 'unauthorized',
73
- statusCode: 401,
74
- message: `User does not have required permission "${options.permission}"`,
75
- data: { userPermissions }
76
- });
77
- }
78
-
79
- // The user object on the request is hydrated with data from the token
80
- request.admin = {
81
- ...request.admin,
82
- email: payload.sub,
83
- permissions: userPermissions
84
- };
85
-
86
- next();
87
- };
88
- }
89
-
90
- /** */
91
- function checkUserPermissions(
92
- userPermissions: Array<string>,
93
- endpointPermission: string
94
- ): boolean {
95
- const endpointPermissionParts = endpointPermission.split(':');
96
- userPermissionLoop: for (const permission of userPermissions) {
97
- const permissionParts = permission.split(':');
98
-
99
- // Ignore if both are not same length
100
- if (permissionParts.length !== endpointPermissionParts.length)
101
- continue userPermissionLoop;
102
-
103
- for (let i = 0; i < permissionParts.length; i++) {
104
- // Wildcards get automatic validation, otherwise it must match with the same part of the endpoint permission
105
- if (
106
- permissionParts[i] !== '*' &&
107
- permissionParts[i] !== endpointPermissionParts[i]
108
- )
109
- continue userPermissionLoop;
110
- }
111
- return true;
112
- }
113
- return false;
114
- }
@@ -1,19 +0,0 @@
1
- // Override the Express request object to add the files
2
- declare global {
3
- // eslint-disable-next-line @typescript-eslint/no-namespace
4
- namespace Express {
5
- /** Express request object */
6
- interface Request {
7
- /** User that identified using a JWT */
8
- admin?: RequestAdminProps;
9
- }
10
- }
11
- }
12
-
13
- /** Admin auth properties of the request */
14
- export interface RequestAdminProps {
15
- /** Email address of the user */
16
- email: string;
17
- /** List of permissions that the user has */
18
- permissions: Array<string>;
19
- }
@@ -1,2 +0,0 @@
1
- export * from './authAdmin';
2
- export * from './authAdmin.types';