@mondaydotcomorg/monday-authorization 1.2.2 → 1.2.4
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/CHANGELOG.md +6 -0
- package/README.md +32 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +28 -1
- package/dist/lib/authorization-attributes-service.d.ts +23 -0
- package/dist/lib/authorization-attributes-service.js +65 -0
- package/dist/lib/authorization-internal-service.d.ts +9 -0
- package/dist/lib/authorization-internal-service.js +62 -1
- package/dist/lib/authorization-middleware.d.ts +2 -1
- package/dist/lib/authorization-middleware.js +4 -1
- package/dist/lib/authorization-service.d.ts +1 -1
- package/dist/lib/authorization-service.js +12 -63
- package/dist/lib/testKit/index.d.ts +11 -0
- package/dist/lib/testKit/index.js +58 -0
- package/dist/lib/types/authorization-attributes-contracts.d.ts +10 -0
- package/dist/lib/types/authorization-attributes-contracts.js +2 -0
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](http://keepachangelog.com/)
|
|
6
6
|
and this project adheres to [Semantic Versioning](http://semver.org/).
|
|
7
7
|
|
|
8
|
+
## [1.2.3] - 2024-06-10
|
|
9
|
+
### Added
|
|
10
|
+
|
|
11
|
+
- [`feature/yarden/resource-attributes-api-support-authz-sdk (#5826)`](https://github.com/DaPulse/monday-npm-packages/pull/5826)
|
|
12
|
+
- `AuthorizationAttributesService` - now supports upsert (`upsertResourceAttributesSync`) and delete (`deleteResourceAttributesSync`) resource attributes in the authorization MS
|
|
13
|
+
|
|
8
14
|
## [1.2.0] - 2024-01-05
|
|
9
15
|
### Added
|
|
10
16
|
- `isAuthorized` now return the unauthorized objects - regardless to the unauthorized ids (which may be missing resource ids if resource has no id, like `feature` e.g.)
|
package/README.md
CHANGED
|
@@ -136,3 +136,35 @@ const canActionInScopeMultipleResponse: ScopedActionResponseObject[] =
|
|
|
136
136
|
* ]
|
|
137
137
|
* /
|
|
138
138
|
```
|
|
139
|
+
|
|
140
|
+
### Authorization Attributes API
|
|
141
|
+
|
|
142
|
+
Use `AuthorizationAttributesService.upsertResourceAttributesSync` to upsert multiple resource attributes in the authorization MS synchronously.
|
|
143
|
+
|
|
144
|
+
```ts
|
|
145
|
+
import { AuthorizationAttributesService, ResourceAttributeAssignment, ResourceAttributeResponse } from '@mondaydotcomorg/monday-authorization';
|
|
146
|
+
|
|
147
|
+
const accountId = 739630;
|
|
148
|
+
const userId = 4;
|
|
149
|
+
const resourceAttributesAssignments: ResourceAttributeAssignment[] = [
|
|
150
|
+
{ resourceId: 18, resourceType: 'workspace', key: 'is_default_workspace', value: 'true' },
|
|
151
|
+
{ resourceId: 23, resourceType: 'board', key: 'board_kind', value: 'private' }
|
|
152
|
+
];
|
|
153
|
+
|
|
154
|
+
const response: ResourceAttributeResponse = await AuthorizationAttributesService.upsertResourceAttributesSync(accountId, userId, resourceAttributesAssignments);
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
Use `AuthorizationAttributesService.deleteResourceAttributesSync` to delete single resource's attributes in the authorization MS synchronously.
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
```ts
|
|
161
|
+
import { AuthorizationAttributesService, ResourceAttributeResponse, Resource } from '@mondaydotcomorg/monday-authorization';
|
|
162
|
+
|
|
163
|
+
const accountId = 739630;
|
|
164
|
+
const userId = 4;
|
|
165
|
+
const resource: Resource = { type: 'workspace', id: 18 };
|
|
166
|
+
const attributeKeys: string[] = ['is_default_workspace', 'workspace_kind'];
|
|
167
|
+
|
|
168
|
+
const response: ResourceAttributeResponse = await AuthorizationAttributesService.deleteResourceAttributesSync(accountId, userId, resource, attributeKeys);
|
|
169
|
+
```
|
|
170
|
+
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { MondayFetchOptions } from '@mondaydotcomorg/monday-fetch';
|
|
2
|
+
import * as TestKit from './lib/testKit';
|
|
2
3
|
export interface InitOptions {
|
|
3
4
|
prometheus?: any;
|
|
4
5
|
mondayFetchOptions?: MondayFetchOptions;
|
|
@@ -8,3 +9,5 @@ export interface InitOptions {
|
|
|
8
9
|
export declare function init(options?: InitOptions): void;
|
|
9
10
|
export { authorizationCheckMiddleware, getAuthorizationMiddleware, skipAuthorizationMiddleware, } from './lib/authorization-middleware';
|
|
10
11
|
export { AuthorizationService } from './lib/authorization-service';
|
|
12
|
+
export { AuthorizationAttributesService } from './lib/authorization-attributes-service';
|
|
13
|
+
export { TestKit };
|
package/dist/index.js
CHANGED
|
@@ -1,8 +1,33 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
2
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.AuthorizationService = exports.skipAuthorizationMiddleware = exports.getAuthorizationMiddleware = exports.authorizationCheckMiddleware = exports.init = void 0;
|
|
26
|
+
exports.TestKit = exports.AuthorizationAttributesService = exports.AuthorizationService = exports.skipAuthorizationMiddleware = exports.getAuthorizationMiddleware = exports.authorizationCheckMiddleware = exports.init = void 0;
|
|
4
27
|
const prometheus_service_1 = require("./lib/prometheus-service");
|
|
5
28
|
const authorization_service_1 = require("./lib/authorization-service");
|
|
29
|
+
const TestKit = __importStar(require("./lib/testKit"));
|
|
30
|
+
exports.TestKit = TestKit;
|
|
6
31
|
function init(options = {}) {
|
|
7
32
|
if (options.prometheus) {
|
|
8
33
|
(0, prometheus_service_1.setPrometheus)(options.prometheus);
|
|
@@ -21,3 +46,5 @@ Object.defineProperty(exports, "getAuthorizationMiddleware", { enumerable: true,
|
|
|
21
46
|
Object.defineProperty(exports, "skipAuthorizationMiddleware", { enumerable: true, get: function () { return authorization_middleware_1.skipAuthorizationMiddleware; } });
|
|
22
47
|
var authorization_service_2 = require("./lib/authorization-service");
|
|
23
48
|
Object.defineProperty(exports, "AuthorizationService", { enumerable: true, get: function () { return authorization_service_2.AuthorizationService; } });
|
|
49
|
+
var authorization_attributes_service_1 = require("./lib/authorization-attributes-service");
|
|
50
|
+
Object.defineProperty(exports, "AuthorizationAttributesService", { enumerable: true, get: function () { return authorization_attributes_service_1.AuthorizationAttributesService; } });
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { ResourceAttributeAssignment, ResourceAttributeResponse } from './types/authorization-attributes-contracts';
|
|
2
|
+
import { Resource } from './types/general';
|
|
3
|
+
export declare class AuthorizationAttributesService {
|
|
4
|
+
/**
|
|
5
|
+
* Upsert resource attributes synchronously, performing http call to the authorization MS to assign the given attributes to the given resource.
|
|
6
|
+
* @param accountId
|
|
7
|
+
* @param userId
|
|
8
|
+
* @param resourceAttributeAssignments - Array of resource (resourceType, resourceId) and attribute (key, value) pairs to upsert in the authorization MS.
|
|
9
|
+
* e.g. [{ resourceType: 'board', resourceId: 123, key: 'board_kind', value: 'private' }]
|
|
10
|
+
* @returns ResourceAttributeResponse - The affected (created and updated_ resource attributes assignments in the `attributes` field.
|
|
11
|
+
*/
|
|
12
|
+
static upsertResourceAttributes(accountId: number, userId: number, resourceAttributeAssignments: ResourceAttributeAssignment[]): Promise<ResourceAttributeResponse>;
|
|
13
|
+
/**
|
|
14
|
+
* Delete resource attributes assignments synchronously, performing http call to the authorization MS to delete the given attributes from the given singular resource.
|
|
15
|
+
* @param accountId
|
|
16
|
+
* @param userId
|
|
17
|
+
* @param resource - The resource (resourceType, resourceId) to delete the attributes for.
|
|
18
|
+
* @param attributeKeys - Array of attribute keys to delete for the resource.
|
|
19
|
+
* @returns ResourceAttributeResponse - The affected (deleted) resource attributes assignments in the `attributes` field.
|
|
20
|
+
*/
|
|
21
|
+
static deleteResourceAttributes(accountId: number, userId: number, resource: Resource, attributeKeys: string[]): Promise<ResourceAttributeResponse>;
|
|
22
|
+
private static getResourceAttributesUrl;
|
|
23
|
+
}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.AuthorizationAttributesService = void 0;
|
|
13
|
+
const monday_fetch_1 = require("@mondaydotcomorg/monday-fetch");
|
|
14
|
+
const authorization_internal_service_1 = require("./authorization-internal-service");
|
|
15
|
+
class AuthorizationAttributesService {
|
|
16
|
+
/**
|
|
17
|
+
* Upsert resource attributes synchronously, performing http call to the authorization MS to assign the given attributes to the given resource.
|
|
18
|
+
* @param accountId
|
|
19
|
+
* @param userId
|
|
20
|
+
* @param resourceAttributeAssignments - Array of resource (resourceType, resourceId) and attribute (key, value) pairs to upsert in the authorization MS.
|
|
21
|
+
* e.g. [{ resourceType: 'board', resourceId: 123, key: 'board_kind', value: 'private' }]
|
|
22
|
+
* @returns ResourceAttributeResponse - The affected (created and updated_ resource attributes assignments in the `attributes` field.
|
|
23
|
+
*/
|
|
24
|
+
static upsertResourceAttributes(accountId, userId, resourceAttributeAssignments) {
|
|
25
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
26
|
+
const internalAuthToken = authorization_internal_service_1.AuthorizationInternalService.generateInternalAuthToken(accountId, userId);
|
|
27
|
+
const response = yield (0, monday_fetch_1.fetch)(this.getResourceAttributesUrl(accountId), {
|
|
28
|
+
method: 'POST',
|
|
29
|
+
headers: { Authorization: internalAuthToken, 'Content-Type': 'application/json' },
|
|
30
|
+
timeout: authorization_internal_service_1.AuthorizationInternalService.getRequestTimeout(),
|
|
31
|
+
body: JSON.stringify({ resourceAttributeAssignments }),
|
|
32
|
+
}, authorization_internal_service_1.AuthorizationInternalService.getRequestFetchOptions());
|
|
33
|
+
const responseBody = yield response.json();
|
|
34
|
+
authorization_internal_service_1.AuthorizationInternalService.throwOnHttpErrorIfNeeded(response, 'upsertResourceAttributesSync');
|
|
35
|
+
return { attributes: responseBody['attributes'] };
|
|
36
|
+
});
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Delete resource attributes assignments synchronously, performing http call to the authorization MS to delete the given attributes from the given singular resource.
|
|
40
|
+
* @param accountId
|
|
41
|
+
* @param userId
|
|
42
|
+
* @param resource - The resource (resourceType, resourceId) to delete the attributes for.
|
|
43
|
+
* @param attributeKeys - Array of attribute keys to delete for the resource.
|
|
44
|
+
* @returns ResourceAttributeResponse - The affected (deleted) resource attributes assignments in the `attributes` field.
|
|
45
|
+
*/
|
|
46
|
+
static deleteResourceAttributes(accountId, userId, resource, attributeKeys) {
|
|
47
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
48
|
+
const internalAuthToken = authorization_internal_service_1.AuthorizationInternalService.generateInternalAuthToken(accountId, userId);
|
|
49
|
+
const url = `${this.getResourceAttributesUrl(accountId)}/${resource.type}/${resource.id}`;
|
|
50
|
+
const response = yield (0, monday_fetch_1.fetch)(url, {
|
|
51
|
+
method: 'DELETE',
|
|
52
|
+
headers: { Authorization: internalAuthToken, 'Content-Type': 'application/json' },
|
|
53
|
+
timeout: authorization_internal_service_1.AuthorizationInternalService.getRequestTimeout(),
|
|
54
|
+
body: JSON.stringify({ keys: attributeKeys }),
|
|
55
|
+
}, authorization_internal_service_1.AuthorizationInternalService.getRequestFetchOptions());
|
|
56
|
+
const responseBody = yield response.json();
|
|
57
|
+
authorization_internal_service_1.AuthorizationInternalService.throwOnHttpErrorIfNeeded(response, 'deleteResourceAttributesSync');
|
|
58
|
+
return { attributes: responseBody['attributes'] };
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
static getResourceAttributesUrl(accountId) {
|
|
62
|
+
return `${process.env.AUTHORIZATION_URL}/attributes/${accountId}/resource`;
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
exports.AuthorizationAttributesService = AuthorizationAttributesService;
|
|
@@ -1,6 +1,15 @@
|
|
|
1
|
+
/// <reference types="bunyan" />
|
|
1
2
|
import { Request } from 'express';
|
|
3
|
+
import { fetch, MondayFetchOptions } from '@mondaydotcomorg/monday-fetch';
|
|
4
|
+
import * as MondayLogger from '@mondaydotcomorg/monday-logger';
|
|
5
|
+
export declare const logger: MondayLogger.Logger;
|
|
2
6
|
export declare class AuthorizationInternalService {
|
|
3
7
|
static skipAuthorization(requset: Request): void;
|
|
4
8
|
static markAuthorized(request: Request): void;
|
|
5
9
|
static failIfNotCoveredByAuthorization(request: Request): void;
|
|
10
|
+
static throwOnHttpErrorIfNeeded(response: Awaited<ReturnType<typeof fetch>>, placement: string): void;
|
|
11
|
+
static generateInternalAuthToken(accountId: number, userId: number): string;
|
|
12
|
+
static setRequestFetchOptions(customMondayFetchOptions: MondayFetchOptions): void;
|
|
13
|
+
static getRequestFetchOptions(): MondayFetchOptions;
|
|
14
|
+
static getRequestTimeout(): 60000 | 2000;
|
|
6
15
|
}
|
|
@@ -1,6 +1,46 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
2
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.AuthorizationInternalService = void 0;
|
|
26
|
+
exports.AuthorizationInternalService = exports.logger = void 0;
|
|
27
|
+
const monday_jwt_1 = require("@mondaydotcomorg/monday-jwt");
|
|
28
|
+
const MondayLogger = __importStar(require("@mondaydotcomorg/monday-logger"));
|
|
29
|
+
const INTERNAL_APP_NAME = 'internal_ms';
|
|
30
|
+
const defaultMondayFetchOptions = {
|
|
31
|
+
retries: 3,
|
|
32
|
+
callback: logOnFetchFail,
|
|
33
|
+
};
|
|
34
|
+
function logOnFetchFail(retriesLeft, error) {
|
|
35
|
+
if (retriesLeft == 0) {
|
|
36
|
+
exports.logger.error({ retriesLeft, error }, 'Authorization attempt failed due to network issues');
|
|
37
|
+
}
|
|
38
|
+
else {
|
|
39
|
+
exports.logger.info({ retriesLeft, error }, 'Authorization attempt failed due to network issues, trying again');
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
let mondayFetchOptions = defaultMondayFetchOptions;
|
|
43
|
+
exports.logger = MondayLogger.getLogger();
|
|
4
44
|
class AuthorizationInternalService {
|
|
5
45
|
static skipAuthorization(requset) {
|
|
6
46
|
requset.authorizationSkipPerformed = true;
|
|
@@ -13,5 +53,26 @@ class AuthorizationInternalService {
|
|
|
13
53
|
throw 'Endpoint is not covered by authorization check';
|
|
14
54
|
}
|
|
15
55
|
}
|
|
56
|
+
static throwOnHttpErrorIfNeeded(response, placement) {
|
|
57
|
+
if (response.ok) {
|
|
58
|
+
return;
|
|
59
|
+
}
|
|
60
|
+
const status = response.status;
|
|
61
|
+
exports.logger.error({ tag: 'authorization-service', placement, status }, 'AuthorizationService: authorization request failed');
|
|
62
|
+
throw new Error(`AuthorizationService: [${placement}] authorization request failed with status ${status}`);
|
|
63
|
+
}
|
|
64
|
+
static generateInternalAuthToken(accountId, userId) {
|
|
65
|
+
return (0, monday_jwt_1.signAuthorizationHeader)({ appName: INTERNAL_APP_NAME, accountId, userId });
|
|
66
|
+
}
|
|
67
|
+
static setRequestFetchOptions(customMondayFetchOptions) {
|
|
68
|
+
mondayFetchOptions = Object.assign(Object.assign({}, defaultMondayFetchOptions), customMondayFetchOptions);
|
|
69
|
+
}
|
|
70
|
+
static getRequestFetchOptions() {
|
|
71
|
+
return mondayFetchOptions;
|
|
72
|
+
}
|
|
73
|
+
static getRequestTimeout() {
|
|
74
|
+
const isDevEnv = process.env.NODE_ENV === 'development';
|
|
75
|
+
return isDevEnv ? 60000 : 2000;
|
|
76
|
+
}
|
|
16
77
|
}
|
|
17
78
|
exports.AuthorizationInternalService = AuthorizationInternalService;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { NextFunction } from 'express';
|
|
2
|
-
import { Action, BaseRequest, BaseResponse, ContextGetter, ResourceGetter } from './types/general';
|
|
2
|
+
import { Action, BaseRequest, BaseResponse, Context, ContextGetter, ResourceGetter } from './types/general';
|
|
3
3
|
export declare function getAuthorizationMiddleware(action: Action, resourceGetter: ResourceGetter, contextGetter?: ContextGetter): (request: BaseRequest, response: BaseResponse, next: NextFunction) => Promise<void>;
|
|
4
4
|
export declare function skipAuthorizationMiddleware(request: BaseRequest, response: BaseResponse, next: NextFunction): void;
|
|
5
5
|
export declare function authorizationCheckMiddleware(request: BaseRequest, response: BaseResponse, next: NextFunction): void;
|
|
6
|
+
export declare function defaultContextGetter(request: BaseRequest): Context;
|
|
@@ -12,10 +12,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
12
12
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
13
13
|
};
|
|
14
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
-
exports.authorizationCheckMiddleware = exports.skipAuthorizationMiddleware = exports.getAuthorizationMiddleware = void 0;
|
|
15
|
+
exports.defaultContextGetter = exports.authorizationCheckMiddleware = exports.skipAuthorizationMiddleware = exports.getAuthorizationMiddleware = void 0;
|
|
16
16
|
const on_headers_1 = __importDefault(require("on-headers"));
|
|
17
17
|
const authorization_internal_service_1 = require("./authorization-internal-service");
|
|
18
18
|
const authorization_service_1 = require("./authorization-service");
|
|
19
|
+
// getAuthorizationMiddleware is duplicated in testKit/index.ts
|
|
20
|
+
// If you are making changes to this function, please make sure to update the other file as well
|
|
19
21
|
function getAuthorizationMiddleware(action, resourceGetter, contextGetter) {
|
|
20
22
|
return function authorizationMiddleware(request, response, next) {
|
|
21
23
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -52,3 +54,4 @@ exports.authorizationCheckMiddleware = authorizationCheckMiddleware;
|
|
|
52
54
|
function defaultContextGetter(request) {
|
|
53
55
|
return request.payload;
|
|
54
56
|
}
|
|
57
|
+
exports.defaultContextGetter = defaultContextGetter;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { MondayFetchOptions } from '@mondaydotcomorg/monday-fetch';
|
|
2
2
|
import { Action, AuthorizationObject, Resource } from './types/general';
|
|
3
|
-
import { ScopedAction, ScopedActionPermit, ScopedActionResponseObject, ScopeOptions } from '
|
|
3
|
+
import { ScopedAction, ScopedActionPermit, ScopedActionResponseObject, ScopeOptions } from './types/scoped-actions-contracts';
|
|
4
4
|
export interface AuthorizeResponse {
|
|
5
5
|
isAuthorized: boolean;
|
|
6
6
|
unauthorizedIds?: number[];
|
|
@@ -1,27 +1,4 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
-
}) : function(o, v) {
|
|
16
|
-
o["default"] = v;
|
|
17
|
-
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
-
if (mod && mod.__esModule) return mod;
|
|
20
|
-
var result = {};
|
|
21
|
-
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
-
__setModuleDefault(result, mod);
|
|
23
|
-
return result;
|
|
24
|
-
};
|
|
25
2
|
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
26
3
|
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
27
4
|
return new (P || (P = Promise))(function (resolve, reject) {
|
|
@@ -35,20 +12,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
35
12
|
exports.AuthorizationService = exports.setRedisClient = exports.setRequestFetchOptions = void 0;
|
|
36
13
|
const lodash_1 = require("lodash");
|
|
37
14
|
const perf_hooks_1 = require("perf_hooks");
|
|
38
|
-
const monday_jwt_1 = require("@mondaydotcomorg/monday-jwt");
|
|
39
|
-
const MondayLogger = __importStar(require("@mondaydotcomorg/monday-logger"));
|
|
40
15
|
const monday_fetch_1 = require("@mondaydotcomorg/monday-fetch");
|
|
41
16
|
const prometheus_service_1 = require("./prometheus-service");
|
|
42
|
-
const
|
|
43
|
-
const logger = MondayLogger.getLogger();
|
|
17
|
+
const authorization_internal_service_1 = require("./authorization-internal-service");
|
|
44
18
|
const GRANTED_FEATURE_CACHE_EXPIRATION_SECONDS = 5 * 60;
|
|
45
|
-
const defaultMondayFetchOptions = {
|
|
46
|
-
retries: 3,
|
|
47
|
-
callback: logOnFetchFail,
|
|
48
|
-
};
|
|
49
|
-
let mondayFetchOptions = defaultMondayFetchOptions;
|
|
50
19
|
function setRequestFetchOptions(customMondayFetchOptions) {
|
|
51
|
-
|
|
20
|
+
authorization_internal_service_1.AuthorizationInternalService.setRequestFetchOptions(customMondayFetchOptions);
|
|
52
21
|
}
|
|
53
22
|
exports.setRequestFetchOptions = setRequestFetchOptions;
|
|
54
23
|
function setRedisClient(client, grantedFeatureRedisExpirationInSeconds = GRANTED_FEATURE_CACHE_EXPIRATION_SECONDS) {
|
|
@@ -57,7 +26,7 @@ function setRedisClient(client, grantedFeatureRedisExpirationInSeconds = GRANTED
|
|
|
57
26
|
AuthorizationService.grantedFeatureRedisExpirationInSeconds = grantedFeatureRedisExpirationInSeconds;
|
|
58
27
|
}
|
|
59
28
|
else {
|
|
60
|
-
logger.warn({ grantedFeatureRedisExpirationInSeconds }, 'Invalid input for grantedFeatureRedisExpirationInSeconds, must be positive number. using default ttl.');
|
|
29
|
+
authorization_internal_service_1.logger.warn({ grantedFeatureRedisExpirationInSeconds }, 'Invalid input for grantedFeatureRedisExpirationInSeconds, must be positive number. using default ttl.');
|
|
61
30
|
AuthorizationService.grantedFeatureRedisExpirationInSeconds = GRANTED_FEATURE_CACHE_EXPIRATION_SECONDS;
|
|
62
31
|
}
|
|
63
32
|
}
|
|
@@ -117,20 +86,20 @@ class AuthorizationService {
|
|
|
117
86
|
}
|
|
118
87
|
static canActionInScopeMultiple(accountId, userId, scopedActions) {
|
|
119
88
|
return __awaiter(this, void 0, void 0, function* () {
|
|
120
|
-
const internalAuthToken =
|
|
89
|
+
const internalAuthToken = authorization_internal_service_1.AuthorizationInternalService.generateInternalAuthToken(accountId, userId);
|
|
121
90
|
const scopedActionsPayload = scopedActions.map(scopedAction => {
|
|
122
91
|
return Object.assign(Object.assign({}, scopedAction), { scope: (0, lodash_1.mapKeys)(scopedAction.scope, (_, key) => (0, lodash_1.snakeCase)(key)) }); // for example: { workspaceId: 1 } => { workspace_id: 1 }
|
|
123
92
|
});
|
|
124
93
|
const response = yield (0, monday_fetch_1.fetch)(getCanActionsInScopesUrl(), {
|
|
125
94
|
method: 'POST',
|
|
126
95
|
headers: { Authorization: internalAuthToken, 'Content-Type': 'application/json' },
|
|
127
|
-
timeout: getRequestTimeout(),
|
|
96
|
+
timeout: authorization_internal_service_1.AuthorizationInternalService.getRequestTimeout(),
|
|
128
97
|
body: JSON.stringify({
|
|
129
98
|
user_id: userId,
|
|
130
99
|
scoped_actions: scopedActionsPayload,
|
|
131
100
|
}),
|
|
132
|
-
},
|
|
133
|
-
throwOnHttpErrorIfNeeded(response, 'canActionInScopeMultiple');
|
|
101
|
+
}, authorization_internal_service_1.AuthorizationInternalService.getRequestFetchOptions());
|
|
102
|
+
authorization_internal_service_1.AuthorizationInternalService.throwOnHttpErrorIfNeeded(response, 'canActionInScopeMultiple');
|
|
134
103
|
const responseBody = yield response.json();
|
|
135
104
|
const camelCaseKeys = (obj) => Object.fromEntries(Object.entries(obj).map(([key, value]) => [(0, lodash_1.camelCase)(key), value]));
|
|
136
105
|
const scopedActionsResponseObjects = responseBody.result.map(responseObject => {
|
|
@@ -150,22 +119,22 @@ class AuthorizationService {
|
|
|
150
119
|
}
|
|
151
120
|
static isAuthorizedMultiple(accountId, userId, authorizationRequestObjects) {
|
|
152
121
|
return __awaiter(this, void 0, void 0, function* () {
|
|
153
|
-
const internalAuthToken =
|
|
122
|
+
const internalAuthToken = authorization_internal_service_1.AuthorizationInternalService.generateInternalAuthToken(accountId, userId);
|
|
154
123
|
const startTime = perf_hooks_1.performance.now();
|
|
155
124
|
const response = yield (0, monday_fetch_1.fetch)(getAuthorizeUrl(), {
|
|
156
125
|
method: 'POST',
|
|
157
126
|
headers: { Authorization: internalAuthToken, 'Content-Type': 'application/json' },
|
|
158
|
-
timeout: getRequestTimeout(),
|
|
127
|
+
timeout: authorization_internal_service_1.AuthorizationInternalService.getRequestTimeout(),
|
|
159
128
|
body: JSON.stringify({
|
|
160
129
|
user_id: userId,
|
|
161
130
|
authorize_request_objects: authorizationRequestObjects,
|
|
162
131
|
}),
|
|
163
|
-
},
|
|
132
|
+
}, authorization_internal_service_1.AuthorizationInternalService.getRequestFetchOptions());
|
|
164
133
|
const endTime = perf_hooks_1.performance.now();
|
|
165
134
|
const time = endTime - startTime;
|
|
166
135
|
const responseStatus = response.status;
|
|
167
136
|
(0, prometheus_service_1.sendAuthorizationChecksPerRequestMetric)(responseStatus, authorizationRequestObjects.length);
|
|
168
|
-
throwOnHttpErrorIfNeeded(response, 'isAuthorizedMultiple');
|
|
137
|
+
authorization_internal_service_1.AuthorizationInternalService.throwOnHttpErrorIfNeeded(response, 'isAuthorizedMultiple');
|
|
169
138
|
const responseBody = yield response.json();
|
|
170
139
|
const unauthorizedObjects = [];
|
|
171
140
|
responseBody.result.forEach(function (isAuthorized, index) {
|
|
@@ -176,7 +145,7 @@ class AuthorizationService {
|
|
|
176
145
|
(0, prometheus_service_1.sendAuthorizationCheckResponseTimeMetric)(authorizationObject.resource_type, authorizationObject.action, isAuthorized, responseStatus, time);
|
|
177
146
|
});
|
|
178
147
|
if (unauthorizedObjects.length > 0) {
|
|
179
|
-
logger.info({
|
|
148
|
+
authorization_internal_service_1.logger.info({
|
|
180
149
|
resources: JSON.stringify(unauthorizedObjects),
|
|
181
150
|
}, 'AuthorizationService: resource is unauthorized');
|
|
182
151
|
const unauthorizedIds = unauthorizedObjects
|
|
@@ -205,29 +174,9 @@ function createAuthorizationParams(resources, action) {
|
|
|
205
174
|
};
|
|
206
175
|
return params;
|
|
207
176
|
}
|
|
208
|
-
function logOnFetchFail(retriesLeft, error) {
|
|
209
|
-
if (retriesLeft == 0) {
|
|
210
|
-
logger.error({ retriesLeft, error }, 'Authorization attempt failed due to network issues');
|
|
211
|
-
}
|
|
212
|
-
else {
|
|
213
|
-
logger.info({ retriesLeft, error }, 'Authorization attempt failed due to network issues, trying again');
|
|
214
|
-
}
|
|
215
|
-
}
|
|
216
177
|
function getAuthorizeUrl() {
|
|
217
178
|
return `${process.env.MONDAY_INTERNAL_URL}/internal_ms/authorization/authorize`;
|
|
218
179
|
}
|
|
219
180
|
function getCanActionsInScopesUrl() {
|
|
220
181
|
return `${process.env.MONDAY_INTERNAL_URL}/internal_ms/authorization/can_actions_in_scopes`;
|
|
221
182
|
}
|
|
222
|
-
function getRequestTimeout() {
|
|
223
|
-
const isDevEnv = process.env.NODE_ENV === 'development';
|
|
224
|
-
return isDevEnv ? 60000 : 2000;
|
|
225
|
-
}
|
|
226
|
-
function throwOnHttpErrorIfNeeded(response, placement) {
|
|
227
|
-
if (response.ok) {
|
|
228
|
-
return;
|
|
229
|
-
}
|
|
230
|
-
const status = response.status;
|
|
231
|
-
logger.error({ tag: 'authorization-service', placement, status }, 'AuthorizationService: authorization request failed');
|
|
232
|
-
throw new Error(`AuthorizationService: [${placement}] authorization request failed with status ${status}`);
|
|
233
|
-
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { NextFunction } from "express";
|
|
2
|
+
import { Action, BaseRequest, BaseResponse, ContextGetter, Resource, ResourceGetter } from "lib/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,58 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.getTestAuthorizationMiddleware = exports.clearTestPermittedActions = exports.addTestPermittedAction = void 0;
|
|
13
|
+
const authorization_middleware_1 = require("lib/authorization-middleware");
|
|
14
|
+
const authorization_internal_service_1 = require("lib/authorization-internal-service");
|
|
15
|
+
let testPermittedActions = [];
|
|
16
|
+
const addTestPermittedAction = (accountId, userId, resources, action) => {
|
|
17
|
+
testPermittedActions.push({ accountId, userId, resources, action });
|
|
18
|
+
};
|
|
19
|
+
exports.addTestPermittedAction = addTestPermittedAction;
|
|
20
|
+
const clearTestPermittedActions = () => {
|
|
21
|
+
testPermittedActions = [];
|
|
22
|
+
};
|
|
23
|
+
exports.clearTestPermittedActions = clearTestPermittedActions;
|
|
24
|
+
const isActionAuthorized = (accountId, userId, resources, action) => {
|
|
25
|
+
return {
|
|
26
|
+
isAuthorized: resources.every(resource => {
|
|
27
|
+
return testPermittedActions.some(combination => {
|
|
28
|
+
return combination.accountId === accountId &&
|
|
29
|
+
combination.userId === userId &&
|
|
30
|
+
combination.action === action &&
|
|
31
|
+
combination.resources.some(combinationResource => {
|
|
32
|
+
return resources.some(resource => {
|
|
33
|
+
return combinationResource.id === resource.id &&
|
|
34
|
+
combinationResource.type === resource.type &&
|
|
35
|
+
JSON.stringify(combinationResource.wrapperData) === JSON.stringify(resource.wrapperData);
|
|
36
|
+
});
|
|
37
|
+
});
|
|
38
|
+
});
|
|
39
|
+
})
|
|
40
|
+
};
|
|
41
|
+
};
|
|
42
|
+
const getTestAuthorizationMiddleware = (action, resourceGetter, contextGetter) => {
|
|
43
|
+
return function authorizationMiddleware(request, response, next) {
|
|
44
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
45
|
+
contextGetter || (contextGetter = authorization_middleware_1.defaultContextGetter);
|
|
46
|
+
const { userId, accountId } = contextGetter(request);
|
|
47
|
+
const resources = resourceGetter(request);
|
|
48
|
+
const { isAuthorized } = isActionAuthorized(accountId, userId, resources, action);
|
|
49
|
+
authorization_internal_service_1.AuthorizationInternalService.markAuthorized(request);
|
|
50
|
+
if (!isAuthorized) {
|
|
51
|
+
response.status(403).json({ message: 'Access denied' });
|
|
52
|
+
return;
|
|
53
|
+
}
|
|
54
|
+
next();
|
|
55
|
+
});
|
|
56
|
+
};
|
|
57
|
+
};
|
|
58
|
+
exports.getTestAuthorizationMiddleware = getTestAuthorizationMiddleware;
|
|
@@ -0,0 +1,10 @@
|
|
|
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
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mondaydotcomorg/monday-authorization",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.4",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"types": "dist/index.d.ts",
|
|
6
6
|
"license": "BSD-3-Clause",
|
|
@@ -32,5 +32,5 @@
|
|
|
32
32
|
"files": [
|
|
33
33
|
"dist/"
|
|
34
34
|
],
|
|
35
|
-
"gitHead": "
|
|
35
|
+
"gitHead": "47bf6aa370ecde3f62e92667fab5767b5e8047b8"
|
|
36
36
|
}
|