@mondaydotcomorg/monday-authorization 1.1.9-featureliorshonehourjwttoken.465 → 1.1.9-featuremosheauthorizationesm.3695

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 (61) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/README.md +57 -0
  3. package/dist/attributions-service.d.ts +3 -0
  4. package/dist/attributions-service.js +55 -0
  5. package/dist/authorization-attributes-service.d.ts +44 -0
  6. package/dist/authorization-attributes-service.js +144 -0
  7. package/dist/authorization-internal-service.d.ts +13 -0
  8. package/dist/authorization-internal-service.js +80 -0
  9. package/dist/{lib/authorization-middleware.d.ts → authorization-middleware.d.ts} +2 -1
  10. package/dist/authorization-middleware.js +48 -0
  11. package/dist/{lib/authorization-service.d.ts → authorization-service.d.ts} +2 -1
  12. package/dist/authorization-service.js +176 -0
  13. package/dist/constants/sns.d.ts +3 -0
  14. package/dist/constants/sns.js +9 -0
  15. package/dist/esm/attributions-service.d.ts +3 -0
  16. package/dist/esm/attributions-service.mjs +53 -0
  17. package/dist/esm/authorization-attributes-service.d.ts +44 -0
  18. package/dist/esm/authorization-attributes-service.mjs +138 -0
  19. package/dist/esm/authorization-internal-service.d.ts +13 -0
  20. package/dist/esm/authorization-internal-service.mjs +57 -0
  21. package/dist/esm/authorization-middleware.d.ts +6 -0
  22. package/dist/esm/authorization-middleware.mjs +39 -0
  23. package/dist/esm/authorization-service.d.ts +29 -0
  24. package/dist/esm/authorization-service.mjs +172 -0
  25. package/dist/esm/constants/sns.d.ts +3 -0
  26. package/dist/esm/constants/sns.mjs +5 -0
  27. package/dist/esm/index.d.ts +13 -0
  28. package/dist/esm/index.mjs +21 -0
  29. package/dist/esm/prometheus-service.mjs +45 -0
  30. package/dist/esm/testKit/index.d.ts +11 -0
  31. package/dist/esm/testKit/index.mjs +44 -0
  32. package/dist/esm/types/authorization-attributes-contracts.d.ts +27 -0
  33. package/dist/esm/types/authorization-attributes-contracts.mjs +7 -0
  34. package/dist/esm/types/express.mjs +1 -0
  35. package/dist/esm/types/general.mjs +1 -0
  36. package/dist/esm/types/scoped-actions-contracts.mjs +8 -0
  37. package/dist/index.d.ts +5 -2
  38. package/dist/index.js +18 -14
  39. package/dist/prometheus-service.d.ts +10 -0
  40. package/dist/{lib/prometheus-service.js → prometheus-service.js} +11 -10
  41. package/dist/testKit/index.d.ts +11 -0
  42. package/dist/testKit/index.js +48 -0
  43. package/dist/types/authorization-attributes-contracts.d.ts +27 -0
  44. package/dist/types/authorization-attributes-contracts.js +7 -0
  45. package/dist/types/express.d.ts +10 -0
  46. package/dist/types/express.js +1 -0
  47. package/dist/types/general.d.ts +30 -0
  48. package/dist/types/general.js +1 -0
  49. package/dist/types/scoped-actions-contracts.d.ts +38 -0
  50. package/dist/{lib/types → types}/scoped-actions-contracts.js +3 -4
  51. package/package.json +30 -7
  52. package/dist/lib/authorization-internal-service.d.ts +0 -6
  53. package/dist/lib/authorization-internal-service.js +0 -17
  54. package/dist/lib/authorization-middleware.js +0 -54
  55. package/dist/lib/authorization-service.js +0 -233
  56. package/dist/lib/types/express.js +0 -1
  57. package/dist/lib/types/general.js +0 -2
  58. /package/dist/{lib → esm}/prometheus-service.d.ts +0 -0
  59. /package/dist/{lib → esm}/types/express.d.ts +0 -0
  60. /package/dist/{lib → esm}/types/general.d.ts +0 -0
  61. /package/dist/{lib → esm}/types/scoped-actions-contracts.d.ts +0 -0
@@ -0,0 +1,172 @@
1
+ import { mapKeys, snakeCase, camelCase } from 'lodash';
2
+ import { performance } from 'perf_hooks';
3
+ import { fetch } from '@mondaydotcomorg/monday-fetch';
4
+ import { sendAuthorizationChecksPerRequestMetric, sendAuthorizationCheckResponseTimeMetric } from './prometheus-service.mjs';
5
+ import { AuthorizationInternalService, logger } from './authorization-internal-service.mjs';
6
+ import { getAttributionsFromApi } from './attributions-service.mjs';
7
+
8
+ const GRANTED_FEATURE_CACHE_EXPIRATION_SECONDS = 5 * 60;
9
+ function setRequestFetchOptions(customMondayFetchOptions) {
10
+ AuthorizationInternalService.setRequestFetchOptions(customMondayFetchOptions);
11
+ }
12
+ function setRedisClient(client, grantedFeatureRedisExpirationInSeconds = GRANTED_FEATURE_CACHE_EXPIRATION_SECONDS) {
13
+ AuthorizationService.redisClient = client;
14
+ if (grantedFeatureRedisExpirationInSeconds && grantedFeatureRedisExpirationInSeconds > 0) {
15
+ AuthorizationService.grantedFeatureRedisExpirationInSeconds = grantedFeatureRedisExpirationInSeconds;
16
+ }
17
+ else {
18
+ logger.warn({ grantedFeatureRedisExpirationInSeconds }, 'Invalid input for grantedFeatureRedisExpirationInSeconds, must be positive number. using default ttl.');
19
+ AuthorizationService.grantedFeatureRedisExpirationInSeconds = GRANTED_FEATURE_CACHE_EXPIRATION_SECONDS;
20
+ }
21
+ }
22
+ class AuthorizationService {
23
+ static redisClient;
24
+ static grantedFeatureRedisExpirationInSeconds;
25
+ static async isAuthorized(...args) {
26
+ if (args.length === 3) {
27
+ return this.isAuthorizedMultiple(args[0], args[1], args[2]);
28
+ }
29
+ else if (args.length == 4) {
30
+ return this.isAuthorizedSingular(args[0], args[1], args[2], args[3]);
31
+ }
32
+ else {
33
+ throw new Error('isAuthorized accepts either 3 or 4 arguments');
34
+ }
35
+ }
36
+ static async isUserGrantedWithFeature(accountId, userId, featureName, options = {}) {
37
+ let cachedKey = this.getCachedKeyName(userId, featureName);
38
+ const shouldSkipCache = options.shouldSkipCache ?? false;
39
+ if (this.redisClient && !shouldSkipCache) {
40
+ let grantedFeatureValue = await this.redisClient.get(cachedKey);
41
+ if (!(grantedFeatureValue === undefined || grantedFeatureValue === null)) {
42
+ // redis returns the value as string
43
+ return grantedFeatureValue === 'true';
44
+ }
45
+ }
46
+ let grantedFeatureValue = await this.fetchIsUserGrantedWithFeature(featureName, accountId, userId);
47
+ if (this.redisClient) {
48
+ await this.redisClient.set(cachedKey, grantedFeatureValue, 'EX', this.grantedFeatureRedisExpirationInSeconds);
49
+ }
50
+ return grantedFeatureValue;
51
+ }
52
+ static async fetchIsUserGrantedWithFeature(featureName, accountId, userId) {
53
+ let authorizationObject = {
54
+ action: featureName,
55
+ resource_type: 'feature',
56
+ };
57
+ let authorizeResponsePromise = await this.isAuthorized(accountId, userId, [authorizationObject]);
58
+ return authorizeResponsePromise.isAuthorized;
59
+ }
60
+ static getCachedKeyName(userId, featureName) {
61
+ return `granted-feature-${featureName}-${userId}`;
62
+ }
63
+ static async canActionInScope(accountId, userId, action, scope) {
64
+ const scopedActions = [{ action, scope }];
65
+ const scopedActionResponseObjects = await this.canActionInScopeMultiple(accountId, userId, scopedActions);
66
+ return scopedActionResponseObjects[0].permit;
67
+ }
68
+ static async canActionInScopeMultiple(accountId, userId, scopedActions) {
69
+ const internalAuthToken = AuthorizationInternalService.generateInternalAuthToken(accountId, userId);
70
+ const scopedActionsPayload = scopedActions.map(scopedAction => {
71
+ return { ...scopedAction, scope: mapKeys(scopedAction.scope, (_, key) => snakeCase(key)) }; // for example: { workspaceId: 1 } => { workspace_id: 1 }
72
+ });
73
+ const attributionHeaders = getAttributionsFromApi();
74
+ const response = await fetch(getCanActionsInScopesUrl(), {
75
+ method: 'POST',
76
+ headers: {
77
+ Authorization: internalAuthToken,
78
+ 'Content-Type': 'application/json',
79
+ ...attributionHeaders,
80
+ },
81
+ timeout: AuthorizationInternalService.getRequestTimeout(),
82
+ body: JSON.stringify({
83
+ user_id: userId,
84
+ scoped_actions: scopedActionsPayload,
85
+ }),
86
+ }, AuthorizationInternalService.getRequestFetchOptions());
87
+ AuthorizationInternalService.throwOnHttpErrorIfNeeded(response, 'canActionInScopeMultiple');
88
+ const responseBody = await response.json();
89
+ const camelCaseKeys = obj => Object.fromEntries(Object.entries(obj).map(([key, value]) => [camelCase(key), value]));
90
+ const scopedActionsResponseObjects = responseBody.result.map(responseObject => {
91
+ const { scopedAction, permit } = responseObject;
92
+ const { scope } = scopedAction;
93
+ const transformKeys = obj => camelCaseKeys(obj);
94
+ return {
95
+ ...responseObject,
96
+ scopedAction: { ...scopedAction, scope: transformKeys(scope) },
97
+ permit: transformKeys(permit),
98
+ };
99
+ });
100
+ return scopedActionsResponseObjects;
101
+ }
102
+ static async isAuthorizedSingular(accountId, userId, resources, action) {
103
+ const { authorizationObjects } = createAuthorizationParams(resources, action);
104
+ return this.isAuthorizedMultiple(accountId, userId, authorizationObjects);
105
+ }
106
+ static async isAuthorizedMultiple(accountId, userId, authorizationRequestObjects) {
107
+ const internalAuthToken = AuthorizationInternalService.generateInternalAuthToken(accountId, userId);
108
+ const startTime = performance.now();
109
+ const attributionHeaders = getAttributionsFromApi();
110
+ const response = await fetch(getAuthorizeUrl(), {
111
+ method: 'POST',
112
+ headers: {
113
+ Authorization: internalAuthToken,
114
+ 'Content-Type': 'application/json',
115
+ ...attributionHeaders,
116
+ },
117
+ timeout: AuthorizationInternalService.getRequestTimeout(),
118
+ body: JSON.stringify({
119
+ user_id: userId,
120
+ authorize_request_objects: authorizationRequestObjects,
121
+ }),
122
+ }, AuthorizationInternalService.getRequestFetchOptions());
123
+ const endTime = performance.now();
124
+ const time = endTime - startTime;
125
+ const responseStatus = response.status;
126
+ sendAuthorizationChecksPerRequestMetric(responseStatus, authorizationRequestObjects.length);
127
+ AuthorizationInternalService.throwOnHttpErrorIfNeeded(response, 'isAuthorizedMultiple');
128
+ const responseBody = await response.json();
129
+ const unauthorizedObjects = [];
130
+ responseBody.result.forEach(function (isAuthorized, index) {
131
+ const authorizationObject = authorizationRequestObjects[index];
132
+ if (!isAuthorized) {
133
+ unauthorizedObjects.push(authorizationObject);
134
+ }
135
+ sendAuthorizationCheckResponseTimeMetric(authorizationObject.resource_type, authorizationObject.action, isAuthorized, responseStatus, time);
136
+ });
137
+ if (unauthorizedObjects.length > 0) {
138
+ logger.info({
139
+ resources: JSON.stringify(unauthorizedObjects),
140
+ }, 'AuthorizationService: resource is unauthorized');
141
+ const unauthorizedIds = unauthorizedObjects
142
+ .filter(obj => !!obj.resource_id)
143
+ .map(obj => obj.resource_id);
144
+ return { isAuthorized: false, unauthorizedIds, unauthorizedObjects };
145
+ }
146
+ return { isAuthorized: true };
147
+ }
148
+ }
149
+ function createAuthorizationParams(resources, action) {
150
+ const params = {
151
+ authorizationObjects: resources.map((resource) => {
152
+ const authorizationObject = {
153
+ resource_id: resource.id,
154
+ resource_type: resource.type,
155
+ action,
156
+ };
157
+ if (resource.wrapperData) {
158
+ authorizationObject.wrapper_data = resource.wrapperData;
159
+ }
160
+ return authorizationObject;
161
+ }),
162
+ };
163
+ return params;
164
+ }
165
+ function getAuthorizeUrl() {
166
+ return `${process.env.MONDAY_INTERNAL_URL}/internal_ms/authorization/authorize`;
167
+ }
168
+ function getCanActionsInScopesUrl() {
169
+ return `${process.env.MONDAY_INTERNAL_URL}/internal_ms/authorization/can_actions_in_scopes`;
170
+ }
171
+
172
+ export { AuthorizationService, setRedisClient, setRequestFetchOptions };
@@ -0,0 +1,3 @@
1
+ export declare const RESOURCE_ATTRIBUTES_SNS_ARN_SECRET_NAME = "AUTHORIZATION_RESOURCE_ATTRIBUTES_SNS_TOPIC";
2
+ export declare const RESOURCE_ATTRIBUTES_SNS_UPDATE_OPERATION_MESSAGE_KIND = "resourceAttributeModification";
3
+ export declare const ASYNC_RESOURCE_ATTRIBUTES_MAX_OPERATIONS_PER_MESSAGE = 100;
@@ -0,0 +1,5 @@
1
+ const RESOURCE_ATTRIBUTES_SNS_ARN_SECRET_NAME = 'AUTHORIZATION_RESOURCE_ATTRIBUTES_SNS_TOPIC';
2
+ const RESOURCE_ATTRIBUTES_SNS_UPDATE_OPERATION_MESSAGE_KIND = 'resourceAttributeModification';
3
+ const ASYNC_RESOURCE_ATTRIBUTES_MAX_OPERATIONS_PER_MESSAGE = 100;
4
+
5
+ export { ASYNC_RESOURCE_ATTRIBUTES_MAX_OPERATIONS_PER_MESSAGE, RESOURCE_ATTRIBUTES_SNS_ARN_SECRET_NAME, RESOURCE_ATTRIBUTES_SNS_UPDATE_OPERATION_MESSAGE_KIND };
@@ -0,0 +1,13 @@
1
+ import { MondayFetchOptions } from '@mondaydotcomorg/monday-fetch';
2
+ import * as TestKit from './testKit';
3
+ export interface InitOptions {
4
+ prometheus?: any;
5
+ mondayFetchOptions?: MondayFetchOptions;
6
+ redisClient?: any;
7
+ grantedFeatureRedisExpirationInSeconds?: number;
8
+ }
9
+ export declare function init(options?: InitOptions): void;
10
+ export { authorizationCheckMiddleware, getAuthorizationMiddleware, skipAuthorizationMiddleware, } from './authorization-middleware';
11
+ export { AuthorizationService } from './authorization-service';
12
+ export { AuthorizationAttributesService } from './authorization-attributes-service';
13
+ export { TestKit };
@@ -0,0 +1,21 @@
1
+ import { setPrometheus } from './prometheus-service.mjs';
2
+ import { setRequestFetchOptions, setRedisClient } from './authorization-service.mjs';
3
+ export { AuthorizationService } from './authorization-service.mjs';
4
+ import * as testKit_index from './testKit/index.mjs';
5
+ export { testKit_index as TestKit };
6
+ export { authorizationCheckMiddleware, getAuthorizationMiddleware, skipAuthorizationMiddleware } from './authorization-middleware.mjs';
7
+ export { AuthorizationAttributesService } from './authorization-attributes-service.mjs';
8
+
9
+ function init(options = {}) {
10
+ if (options.prometheus) {
11
+ setPrometheus(options.prometheus);
12
+ }
13
+ if (options.mondayFetchOptions) {
14
+ setRequestFetchOptions(options.mondayFetchOptions);
15
+ }
16
+ if (options.redisClient) {
17
+ setRedisClient(options.redisClient, options.grantedFeatureRedisExpirationInSeconds);
18
+ }
19
+ }
20
+
21
+ export { init };
@@ -0,0 +1,45 @@
1
+ let prometheus = null;
2
+ let authorizationChecksPerRequestMetric = null;
3
+ let authorizationCheckResponseTimeMetric = null;
4
+ const METRICS = {
5
+ AUTHORIZATION_CHECK: 'authorization_check',
6
+ AUTHORIZATION_CHECKS_PER_REQUEST: 'authorization_checks_per_request',
7
+ AUTHORIZATION_CHECK_RESPONSE_TIME: 'authorization_check_response_time',
8
+ };
9
+ const authorizationChecksPerRequestMetricConfig = {
10
+ name: METRICS.AUTHORIZATION_CHECKS_PER_REQUEST,
11
+ labels: ['responseStatus'],
12
+ description: 'Authorization checks per request summary',
13
+ };
14
+ const authorizationCheckResponseTimeMetricConfig = {
15
+ name: METRICS.AUTHORIZATION_CHECK_RESPONSE_TIME,
16
+ labels: ['resourceType', 'action', 'isAuthorized', 'responseStatus'],
17
+ description: 'Authorization check response time summary',
18
+ };
19
+ function setPrometheus(customPrometheus) {
20
+ prometheus = customPrometheus;
21
+ const { METRICS_TYPES } = prometheus;
22
+ authorizationChecksPerRequestMetric = getMetricsManager().addMetric(METRICS_TYPES.SUMMARY, authorizationChecksPerRequestMetricConfig.name, authorizationChecksPerRequestMetricConfig.labels, authorizationChecksPerRequestMetricConfig.description);
23
+ authorizationCheckResponseTimeMetric = getMetricsManager().addMetric(METRICS_TYPES.SUMMARY, authorizationCheckResponseTimeMetricConfig.name, authorizationCheckResponseTimeMetricConfig.labels, authorizationCheckResponseTimeMetricConfig.description);
24
+ }
25
+ function getMetricsManager() {
26
+ return prometheus?.metricsManager;
27
+ }
28
+ function sendAuthorizationChecksPerRequestMetric(responseStatus, amountOfAuthorizationObjects) {
29
+ try {
30
+ if (authorizationChecksPerRequestMetric) {
31
+ authorizationChecksPerRequestMetric.labels(responseStatus).observe(amountOfAuthorizationObjects);
32
+ }
33
+ }
34
+ catch (e) { }
35
+ }
36
+ function sendAuthorizationCheckResponseTimeMetric(resourceType, action, isAuthorized, responseStatus, time) {
37
+ try {
38
+ if (authorizationCheckResponseTimeMetric) {
39
+ authorizationCheckResponseTimeMetric.labels(resourceType, action, isAuthorized, responseStatus).observe(time);
40
+ }
41
+ }
42
+ catch (e) { }
43
+ }
44
+
45
+ export { METRICS, getMetricsManager, sendAuthorizationCheckResponseTimeMetric, sendAuthorizationChecksPerRequestMetric, setPrometheus };
@@ -0,0 +1,11 @@
1
+ import { NextFunction } from "express";
2
+ import { Action, BaseRequest, BaseResponse, ContextGetter, Resource, ResourceGetter } from "../types/general";
3
+ export type TestPermittedAction = {
4
+ accountId: number;
5
+ userId: number;
6
+ resources: Resource[];
7
+ action: Action;
8
+ };
9
+ export declare const addTestPermittedAction: (accountId: number, userId: number, resources: Resource[], action: Action) => void;
10
+ export declare const clearTestPermittedActions: () => void;
11
+ export declare const getTestAuthorizationMiddleware: (action: Action, resourceGetter: ResourceGetter, contextGetter?: ContextGetter) => (request: BaseRequest, response: BaseResponse, next: NextFunction) => Promise<void>;
@@ -0,0 +1,44 @@
1
+ import { defaultContextGetter } from '../authorization-middleware.mjs';
2
+ import { AuthorizationInternalService } from '../authorization-internal-service.mjs';
3
+
4
+ let testPermittedActions = [];
5
+ const addTestPermittedAction = (accountId, userId, resources, action) => {
6
+ testPermittedActions.push({ accountId, userId, resources, action });
7
+ };
8
+ const clearTestPermittedActions = () => {
9
+ testPermittedActions = [];
10
+ };
11
+ const isActionAuthorized = (accountId, userId, resources, action) => {
12
+ return {
13
+ isAuthorized: resources.every(resource => {
14
+ return testPermittedActions.some(combination => {
15
+ return combination.accountId === accountId &&
16
+ combination.userId === userId &&
17
+ combination.action === action &&
18
+ combination.resources.some(combinationResource => {
19
+ return resources.some(resource => {
20
+ return combinationResource.id === resource.id &&
21
+ combinationResource.type === resource.type &&
22
+ JSON.stringify(combinationResource.wrapperData) === JSON.stringify(resource.wrapperData);
23
+ });
24
+ });
25
+ });
26
+ })
27
+ };
28
+ };
29
+ const getTestAuthorizationMiddleware = (action, resourceGetter, contextGetter) => {
30
+ return async function authorizationMiddleware(request, response, next) {
31
+ contextGetter ||= defaultContextGetter;
32
+ const { userId, accountId } = contextGetter(request);
33
+ const resources = resourceGetter(request);
34
+ const { isAuthorized } = isActionAuthorized(accountId, userId, resources, action);
35
+ AuthorizationInternalService.markAuthorized(request);
36
+ if (!isAuthorized) {
37
+ response.status(403).json({ message: 'Access denied' });
38
+ return;
39
+ }
40
+ next();
41
+ };
42
+ };
43
+
44
+ export { addTestPermittedAction, clearTestPermittedActions, getTestAuthorizationMiddleware };
@@ -0,0 +1,27 @@
1
+ import { Resource } from './general';
2
+ export interface ResourceAttributeAssignment {
3
+ resourceType: Resource['type'];
4
+ resourceId: Resource['id'];
5
+ key: string;
6
+ value: string;
7
+ }
8
+ export interface ResourceAttributeResponse {
9
+ attributes: ResourceAttributeAssignment[];
10
+ }
11
+ export interface ResourceAttributeDelete {
12
+ resourceType: Resource['type'];
13
+ resourceId: Resource['id'];
14
+ key: string;
15
+ }
16
+ export declare enum ResourceAttributeOperationEnum {
17
+ UPSERT = "upsert",
18
+ DELETE = "delete"
19
+ }
20
+ interface UpsertResourceAttributeOperation extends ResourceAttributeAssignment {
21
+ operationType: ResourceAttributeOperationEnum.UPSERT;
22
+ }
23
+ interface DeleteResourceAttributeOperation extends ResourceAttributeDelete {
24
+ operationType: ResourceAttributeOperationEnum.DELETE;
25
+ }
26
+ export type ResourceAttributesOperation = UpsertResourceAttributeOperation | DeleteResourceAttributeOperation;
27
+ export {};
@@ -0,0 +1,7 @@
1
+ var ResourceAttributeOperationEnum;
2
+ (function (ResourceAttributeOperationEnum) {
3
+ ResourceAttributeOperationEnum["UPSERT"] = "upsert";
4
+ ResourceAttributeOperationEnum["DELETE"] = "delete";
5
+ })(ResourceAttributeOperationEnum || (ResourceAttributeOperationEnum = {}));
6
+
7
+ export { ResourceAttributeOperationEnum };
@@ -0,0 +1 @@
1
+
@@ -0,0 +1 @@
1
+
@@ -0,0 +1,8 @@
1
+ var PermitTechnicalReason;
2
+ (function (PermitTechnicalReason) {
3
+ PermitTechnicalReason[PermitTechnicalReason["NO_REASON"] = 0] = "NO_REASON";
4
+ PermitTechnicalReason[PermitTechnicalReason["NOT_ELIGIBLE"] = 1] = "NOT_ELIGIBLE";
5
+ PermitTechnicalReason[PermitTechnicalReason["BY_ROLE_IN_SCOPE"] = 2] = "BY_ROLE_IN_SCOPE";
6
+ })(PermitTechnicalReason || (PermitTechnicalReason = {}));
7
+
8
+ export { PermitTechnicalReason };
package/dist/index.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { MondayFetchOptions } from '@mondaydotcomorg/monday-fetch';
2
+ import * as TestKit from './testKit';
2
3
  export interface InitOptions {
3
4
  prometheus?: any;
4
5
  mondayFetchOptions?: MondayFetchOptions;
@@ -6,5 +7,7 @@ export interface InitOptions {
6
7
  grantedFeatureRedisExpirationInSeconds?: number;
7
8
  }
8
9
  export declare function init(options?: InitOptions): void;
9
- export { authorizationCheckMiddleware, getAuthorizationMiddleware, skipAuthorizationMiddleware, } from './lib/authorization-middleware';
10
- export { AuthorizationService } from './lib/authorization-service';
10
+ export { authorizationCheckMiddleware, getAuthorizationMiddleware, skipAuthorizationMiddleware, } from './authorization-middleware';
11
+ export { AuthorizationService } from './authorization-service';
12
+ export { AuthorizationAttributesService } from './authorization-attributes-service';
13
+ export { TestKit };
package/dist/index.js CHANGED
@@ -1,23 +1,27 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.AuthorizationService = exports.skipAuthorizationMiddleware = exports.getAuthorizationMiddleware = exports.authorizationCheckMiddleware = exports.init = void 0;
4
- const prometheus_service_1 = require("./lib/prometheus-service");
5
- const authorization_service_1 = require("./lib/authorization-service");
1
+ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
+
3
+ const prometheusService = require('./prometheus-service.js');
4
+ const authorizationService = require('./authorization-service.js');
5
+ const testKit_index = require('./testKit/index.js');
6
+ const authorizationMiddleware = require('./authorization-middleware.js');
7
+ const authorizationAttributesService = require('./authorization-attributes-service.js');
8
+
6
9
  function init(options = {}) {
7
10
  if (options.prometheus) {
8
- (0, prometheus_service_1.setPrometheus)(options.prometheus);
11
+ prometheusService.setPrometheus(options.prometheus);
9
12
  }
10
13
  if (options.mondayFetchOptions) {
11
- (0, authorization_service_1.setRequestFetchOptions)(options.mondayFetchOptions);
14
+ authorizationService.setRequestFetchOptions(options.mondayFetchOptions);
12
15
  }
13
16
  if (options.redisClient) {
14
- (0, authorization_service_1.setRedisClient)(options.redisClient, options.grantedFeatureRedisExpirationInSeconds);
17
+ authorizationService.setRedisClient(options.redisClient, options.grantedFeatureRedisExpirationInSeconds);
15
18
  }
16
19
  }
20
+
21
+ exports.AuthorizationService = authorizationService.AuthorizationService;
22
+ exports.TestKit = testKit_index;
23
+ exports.authorizationCheckMiddleware = authorizationMiddleware.authorizationCheckMiddleware;
24
+ exports.getAuthorizationMiddleware = authorizationMiddleware.getAuthorizationMiddleware;
25
+ exports.skipAuthorizationMiddleware = authorizationMiddleware.skipAuthorizationMiddleware;
26
+ exports.AuthorizationAttributesService = authorizationAttributesService.AuthorizationAttributesService;
17
27
  exports.init = init;
18
- var authorization_middleware_1 = require("./lib/authorization-middleware");
19
- Object.defineProperty(exports, "authorizationCheckMiddleware", { enumerable: true, get: function () { return authorization_middleware_1.authorizationCheckMiddleware; } });
20
- Object.defineProperty(exports, "getAuthorizationMiddleware", { enumerable: true, get: function () { return authorization_middleware_1.getAuthorizationMiddleware; } });
21
- Object.defineProperty(exports, "skipAuthorizationMiddleware", { enumerable: true, get: function () { return authorization_middleware_1.skipAuthorizationMiddleware; } });
22
- var authorization_service_2 = require("./lib/authorization-service");
23
- Object.defineProperty(exports, "AuthorizationService", { enumerable: true, get: function () { return authorization_service_2.AuthorizationService; } });
@@ -0,0 +1,10 @@
1
+ import { Action } from './types/general';
2
+ export declare const METRICS: {
3
+ AUTHORIZATION_CHECK: string;
4
+ AUTHORIZATION_CHECKS_PER_REQUEST: string;
5
+ AUTHORIZATION_CHECK_RESPONSE_TIME: string;
6
+ };
7
+ export declare function setPrometheus(customPrometheus: any): void;
8
+ export declare function getMetricsManager(): any;
9
+ export declare function sendAuthorizationChecksPerRequestMetric(responseStatus: any, amountOfAuthorizationObjects: any): void;
10
+ export declare function sendAuthorizationCheckResponseTimeMetric(resourceType: string, action: Action, isAuthorized: boolean, responseStatus: number, time: number): void;
@@ -1,21 +1,20 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.sendAuthorizationCheckResponseTimeMetric = exports.sendAuthorizationChecksPerRequestMetric = exports.getMetricsManager = exports.setPrometheus = exports.METRICS = void 0;
1
+ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
+
4
3
  let prometheus = null;
5
4
  let authorizationChecksPerRequestMetric = null;
6
5
  let authorizationCheckResponseTimeMetric = null;
7
- exports.METRICS = {
6
+ const METRICS = {
8
7
  AUTHORIZATION_CHECK: 'authorization_check',
9
8
  AUTHORIZATION_CHECKS_PER_REQUEST: 'authorization_checks_per_request',
10
9
  AUTHORIZATION_CHECK_RESPONSE_TIME: 'authorization_check_response_time',
11
10
  };
12
11
  const authorizationChecksPerRequestMetricConfig = {
13
- name: exports.METRICS.AUTHORIZATION_CHECKS_PER_REQUEST,
12
+ name: METRICS.AUTHORIZATION_CHECKS_PER_REQUEST,
14
13
  labels: ['responseStatus'],
15
14
  description: 'Authorization checks per request summary',
16
15
  };
17
16
  const authorizationCheckResponseTimeMetricConfig = {
18
- name: exports.METRICS.AUTHORIZATION_CHECK_RESPONSE_TIME,
17
+ name: METRICS.AUTHORIZATION_CHECK_RESPONSE_TIME,
19
18
  labels: ['resourceType', 'action', 'isAuthorized', 'responseStatus'],
20
19
  description: 'Authorization check response time summary',
21
20
  };
@@ -25,11 +24,9 @@ function setPrometheus(customPrometheus) {
25
24
  authorizationChecksPerRequestMetric = getMetricsManager().addMetric(METRICS_TYPES.SUMMARY, authorizationChecksPerRequestMetricConfig.name, authorizationChecksPerRequestMetricConfig.labels, authorizationChecksPerRequestMetricConfig.description);
26
25
  authorizationCheckResponseTimeMetric = getMetricsManager().addMetric(METRICS_TYPES.SUMMARY, authorizationCheckResponseTimeMetricConfig.name, authorizationCheckResponseTimeMetricConfig.labels, authorizationCheckResponseTimeMetricConfig.description);
27
26
  }
28
- exports.setPrometheus = setPrometheus;
29
27
  function getMetricsManager() {
30
- return prometheus === null || prometheus === void 0 ? void 0 : prometheus.metricsManager;
28
+ return prometheus?.metricsManager;
31
29
  }
32
- exports.getMetricsManager = getMetricsManager;
33
30
  function sendAuthorizationChecksPerRequestMetric(responseStatus, amountOfAuthorizationObjects) {
34
31
  try {
35
32
  if (authorizationChecksPerRequestMetric) {
@@ -38,7 +35,6 @@ function sendAuthorizationChecksPerRequestMetric(responseStatus, amountOfAuthori
38
35
  }
39
36
  catch (e) { }
40
37
  }
41
- exports.sendAuthorizationChecksPerRequestMetric = sendAuthorizationChecksPerRequestMetric;
42
38
  function sendAuthorizationCheckResponseTimeMetric(resourceType, action, isAuthorized, responseStatus, time) {
43
39
  try {
44
40
  if (authorizationCheckResponseTimeMetric) {
@@ -47,4 +43,9 @@ function sendAuthorizationCheckResponseTimeMetric(resourceType, action, isAuthor
47
43
  }
48
44
  catch (e) { }
49
45
  }
46
+
47
+ exports.METRICS = METRICS;
48
+ exports.getMetricsManager = getMetricsManager;
50
49
  exports.sendAuthorizationCheckResponseTimeMetric = sendAuthorizationCheckResponseTimeMetric;
50
+ exports.sendAuthorizationChecksPerRequestMetric = sendAuthorizationChecksPerRequestMetric;
51
+ exports.setPrometheus = setPrometheus;
@@ -0,0 +1,11 @@
1
+ import { NextFunction } from "express";
2
+ import { Action, BaseRequest, BaseResponse, ContextGetter, Resource, ResourceGetter } from "../types/general";
3
+ export type TestPermittedAction = {
4
+ accountId: number;
5
+ userId: number;
6
+ resources: Resource[];
7
+ action: Action;
8
+ };
9
+ export declare const addTestPermittedAction: (accountId: number, userId: number, resources: Resource[], action: Action) => void;
10
+ export declare const clearTestPermittedActions: () => void;
11
+ export declare const getTestAuthorizationMiddleware: (action: Action, resourceGetter: ResourceGetter, contextGetter?: ContextGetter) => (request: BaseRequest, response: BaseResponse, next: NextFunction) => Promise<void>;
@@ -0,0 +1,48 @@
1
+ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
+
3
+ const authorizationMiddleware = require('../authorization-middleware.js');
4
+ const authorizationInternalService = require('../authorization-internal-service.js');
5
+
6
+ let testPermittedActions = [];
7
+ const addTestPermittedAction = (accountId, userId, resources, action) => {
8
+ testPermittedActions.push({ accountId, userId, resources, action });
9
+ };
10
+ const clearTestPermittedActions = () => {
11
+ testPermittedActions = [];
12
+ };
13
+ const isActionAuthorized = (accountId, userId, resources, action) => {
14
+ return {
15
+ isAuthorized: resources.every(resource => {
16
+ return testPermittedActions.some(combination => {
17
+ return combination.accountId === accountId &&
18
+ combination.userId === userId &&
19
+ combination.action === action &&
20
+ combination.resources.some(combinationResource => {
21
+ return resources.some(resource => {
22
+ return combinationResource.id === resource.id &&
23
+ combinationResource.type === resource.type &&
24
+ JSON.stringify(combinationResource.wrapperData) === JSON.stringify(resource.wrapperData);
25
+ });
26
+ });
27
+ });
28
+ })
29
+ };
30
+ };
31
+ const getTestAuthorizationMiddleware = (action, resourceGetter, contextGetter) => {
32
+ return async function authorizationMiddleware$1(request, response, next) {
33
+ contextGetter ||= authorizationMiddleware.defaultContextGetter;
34
+ const { userId, accountId } = contextGetter(request);
35
+ const resources = resourceGetter(request);
36
+ const { isAuthorized } = isActionAuthorized(accountId, userId, resources, action);
37
+ authorizationInternalService.AuthorizationInternalService.markAuthorized(request);
38
+ if (!isAuthorized) {
39
+ response.status(403).json({ message: 'Access denied' });
40
+ return;
41
+ }
42
+ next();
43
+ };
44
+ };
45
+
46
+ exports.addTestPermittedAction = addTestPermittedAction;
47
+ exports.clearTestPermittedActions = clearTestPermittedActions;
48
+ exports.getTestAuthorizationMiddleware = getTestAuthorizationMiddleware;
@@ -0,0 +1,27 @@
1
+ import { Resource } from './general';
2
+ export interface ResourceAttributeAssignment {
3
+ resourceType: Resource['type'];
4
+ resourceId: Resource['id'];
5
+ key: string;
6
+ value: string;
7
+ }
8
+ export interface ResourceAttributeResponse {
9
+ attributes: ResourceAttributeAssignment[];
10
+ }
11
+ export interface ResourceAttributeDelete {
12
+ resourceType: Resource['type'];
13
+ resourceId: Resource['id'];
14
+ key: string;
15
+ }
16
+ export declare enum ResourceAttributeOperationEnum {
17
+ UPSERT = "upsert",
18
+ DELETE = "delete"
19
+ }
20
+ interface UpsertResourceAttributeOperation extends ResourceAttributeAssignment {
21
+ operationType: ResourceAttributeOperationEnum.UPSERT;
22
+ }
23
+ interface DeleteResourceAttributeOperation extends ResourceAttributeDelete {
24
+ operationType: ResourceAttributeOperationEnum.DELETE;
25
+ }
26
+ export type ResourceAttributesOperation = UpsertResourceAttributeOperation | DeleteResourceAttributeOperation;
27
+ export {};
@@ -0,0 +1,7 @@
1
+ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
+
3
+ exports.ResourceAttributeOperationEnum = void 0;
4
+ (function (ResourceAttributeOperationEnum) {
5
+ ResourceAttributeOperationEnum["UPSERT"] = "upsert";
6
+ ResourceAttributeOperationEnum["DELETE"] = "delete";
7
+ })(exports.ResourceAttributeOperationEnum || (exports.ResourceAttributeOperationEnum = {}));
@@ -0,0 +1,10 @@
1
+ declare namespace Express {
2
+ interface Request {
3
+ payload: {
4
+ accountId: number;
5
+ userId: number;
6
+ };
7
+ authorizationCheckPerformed: boolean;
8
+ authorizationSkipPerformed: boolean;
9
+ }
10
+ }
@@ -0,0 +1 @@
1
+
@@ -0,0 +1,30 @@
1
+ import { Request, Response } from 'express';
2
+ export interface Resource {
3
+ id?: number;
4
+ type: string;
5
+ wrapperData?: object;
6
+ }
7
+ export type Action = string;
8
+ export type ResourceGetter = (request: BaseRequest) => Resource[];
9
+ export interface Context {
10
+ accountId: number;
11
+ userId: number;
12
+ }
13
+ export type ContextGetter = (request: BaseRequest) => Context;
14
+ export interface AuthorizationObject {
15
+ resource_id?: Resource['id'];
16
+ resource_type: Resource['type'];
17
+ wrapper_data?: Resource['wrapperData'];
18
+ action: Action;
19
+ }
20
+ export interface AuthorizationParams {
21
+ authorizationObjects: AuthorizationObject[];
22
+ }
23
+ type BasicObject = {};
24
+ export type BaseParameters = BasicObject;
25
+ export type BaseResponseBody = BasicObject;
26
+ export type BaseBodyParameters = BasicObject;
27
+ export type BaseQueryParameters = BasicObject;
28
+ export type BaseRequest = Request<BaseParameters, BaseResponseBody, BaseBodyParameters, BaseQueryParameters>;
29
+ export type BaseResponse = Response<BaseResponseBody>;
30
+ export {};