kauth-sdk-node 2.0.12 → 2.0.13-alpha.1

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.
@@ -24,6 +24,9 @@ export interface KauthConfig {
24
24
  loginHandler?: (ctx: any, authInfo: AuthenticationInformation) => Promise<void>;
25
25
  authHandler?: (ctx: any, sub: number) => Promise<void>;
26
26
  mockHandler?: (ctx: any) => Promise<void>;
27
+ authCookieDomain?: string;
28
+ authCookieName?: string;
29
+ callbackWhitelist?: string[];
27
30
  lruMaxAge?: number;
28
31
  lruMax?: number;
29
32
  apiInjected?: boolean;
@@ -26,11 +26,15 @@ export declare const ListRolesByExtendValueUri = "/api/backend/listRolesByExtend
26
26
  export declare const ListRolesByUserIdUri = "/api/backend/listRolesByUserId";
27
27
  export declare const ListRolesByNamesAndExtendValueUri = "/api/backend/listRolesByExtendValueAndNames";
28
28
  export declare const CreateRoleUri = "/api/backend/createRole";
29
+ export declare const BindUserByRoleUri = "/api/backend/bindUserByRole";
30
+ export declare const UnbindUserByRoleUri = "/api/backend/unbindUserByRole";
29
31
  export declare const CreateRolesByUsersAndPermissionsUri = "/api/backend/createRolesByUsersAndPermissions";
30
32
  export declare const UpdateRolesWithPermissionsUri = "/api/backend/updateRolesWithPermissions";
31
33
  export declare const ListPermissionsUri = "/api/backend/listPermissions";
32
34
  export declare const ListPermissionsByUserIdUri = "/api/backend/listPermissionsByUserId";
33
35
  export declare const CreatePermissionUri = "/api/backend/createPermission";
36
+ export declare const BindRoleByPermissionUri = "/api/backend/bindRoleByPermission";
37
+ export declare const UnbindRoleByPermissionUri = "/api/backend/unbindRoleByPermission";
34
38
  export declare const BindUserByRolesUri = "/api/backend/bindUserByRoles";
35
39
  export declare const BindUserByRoleNamesAndExtendValueUri = "/api/backend/bindUserByRolesInRoleNamesAndExtendValue";
36
40
  export declare const BindUserByRolesAndExtendValueUri = "/api/backend/bindUserByRolesAndExtendValue";
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CompleteGraphServiceTaskUri = exports.GetGraphStateMachineSnapshotUri = exports.StartGraphProcessUri = exports.GetProcinstUserUri = exports.InstanceUri = exports.ServiceTaskUri = exports.ProcessUri = exports.CommitPreAuthorizationUri = exports.ProcessPreAuthorizationUri = exports.RefreshPreAuthorizationUri = exports.GetPreAuthorizationUri = exports.CreatePreAuthorizationUri = exports.BindRoleWithUsersUri = exports.BindRoleByPermissionsUri = exports.BindUsersByRoleNameAndExtendValueUri = exports.BindUserByRolesAndExtendValueUri = exports.BindUserByRoleNamesAndExtendValueUri = exports.BindUserByRolesUri = exports.CreatePermissionUri = exports.ListPermissionsByUserIdUri = exports.ListPermissionsUri = exports.UpdateRolesWithPermissionsUri = exports.CreateRolesByUsersAndPermissionsUri = exports.CreateRoleUri = exports.ListRolesByNamesAndExtendValueUri = exports.ListRolesByUserIdUri = exports.ListRolesByExtendValueUri = exports.ListRolesUri = exports.GetRoleWithUsersUri = exports.ListUsersByPermissionNameAndExtendValueUri = exports.ListUsersByPermissionIdUri = exports.ListUsersByRoleNameAndExtendValueUri = exports.ListUsersByRoleIdUri = exports.ListUsersWithUserAccountsAndRolesByRoleExtendValueUri = exports.ListUsersWithUserAccountsAndRolesUri = exports.ListUsersUri = exports.SearchUsersWithUserAccountsAndRolesUri = exports.GetUserByIdUri = exports.UnbindUri = exports.MiniprogramAuthenticationInformationUri = exports.MiniprogramBindUri = exports.MiniprogramAuthenticateUri = exports.MiniprogramAuthorizeUri = exports.GoogleAuthenticationInformationUri = exports.GoogleBindUri = exports.GoogleAuthenticateUri = exports.GoogleAuthorizeUri = exports.MoziAuthenticationInformationUri = exports.MoziBindUri = exports.MoziAuthenticateUri = exports.MoziAuthorizeUri = void 0;
3
+ exports.CompleteGraphServiceTaskUri = exports.GetGraphStateMachineSnapshotUri = exports.StartGraphProcessUri = exports.GetProcinstUserUri = exports.InstanceUri = exports.ServiceTaskUri = exports.ProcessUri = exports.CommitPreAuthorizationUri = exports.ProcessPreAuthorizationUri = exports.RefreshPreAuthorizationUri = exports.GetPreAuthorizationUri = exports.CreatePreAuthorizationUri = exports.BindRoleWithUsersUri = exports.BindRoleByPermissionsUri = exports.BindUsersByRoleNameAndExtendValueUri = exports.BindUserByRolesAndExtendValueUri = exports.BindUserByRoleNamesAndExtendValueUri = exports.BindUserByRolesUri = exports.UnbindRoleByPermissionUri = exports.BindRoleByPermissionUri = exports.CreatePermissionUri = exports.ListPermissionsByUserIdUri = exports.ListPermissionsUri = exports.UpdateRolesWithPermissionsUri = exports.CreateRolesByUsersAndPermissionsUri = exports.UnbindUserByRoleUri = exports.BindUserByRoleUri = exports.CreateRoleUri = exports.ListRolesByNamesAndExtendValueUri = exports.ListRolesByUserIdUri = exports.ListRolesByExtendValueUri = exports.ListRolesUri = exports.GetRoleWithUsersUri = exports.ListUsersByPermissionNameAndExtendValueUri = exports.ListUsersByPermissionIdUri = exports.ListUsersByRoleNameAndExtendValueUri = exports.ListUsersByRoleIdUri = exports.ListUsersWithUserAccountsAndRolesByRoleExtendValueUri = exports.ListUsersWithUserAccountsAndRolesUri = exports.ListUsersUri = exports.SearchUsersWithUserAccountsAndRolesUri = exports.GetUserByIdUri = exports.UnbindUri = exports.MiniprogramAuthenticationInformationUri = exports.MiniprogramBindUri = exports.MiniprogramAuthenticateUri = exports.MiniprogramAuthorizeUri = exports.GoogleAuthenticationInformationUri = exports.GoogleBindUri = exports.GoogleAuthenticateUri = exports.GoogleAuthorizeUri = exports.MoziAuthenticationInformationUri = exports.MoziBindUri = exports.MoziAuthenticateUri = exports.MoziAuthorizeUri = void 0;
4
4
  // kauth
5
5
  exports.MoziAuthorizeUri = '/api/authenticator/mozi/authorizeUrl';
6
6
  exports.MoziAuthenticateUri = '/api/authenticator/mozi/authenticate';
@@ -30,11 +30,15 @@ exports.ListRolesByExtendValueUri = '/api/backend/listRolesByExtendValue';
30
30
  exports.ListRolesByUserIdUri = '/api/backend/listRolesByUserId';
31
31
  exports.ListRolesByNamesAndExtendValueUri = '/api/backend/listRolesByExtendValueAndNames';
32
32
  exports.CreateRoleUri = '/api/backend/createRole';
33
+ exports.BindUserByRoleUri = '/api/backend/bindUserByRole';
34
+ exports.UnbindUserByRoleUri = '/api/backend/unbindUserByRole';
33
35
  exports.CreateRolesByUsersAndPermissionsUri = '/api/backend/createRolesByUsersAndPermissions';
34
36
  exports.UpdateRolesWithPermissionsUri = '/api/backend/updateRolesWithPermissions';
35
37
  exports.ListPermissionsUri = '/api/backend/listPermissions';
36
38
  exports.ListPermissionsByUserIdUri = '/api/backend/listPermissionsByUserId';
37
39
  exports.CreatePermissionUri = '/api/backend/createPermission';
40
+ exports.BindRoleByPermissionUri = '/api/backend/bindRoleByPermission';
41
+ exports.UnbindRoleByPermissionUri = '/api/backend/unbindRoleByPermission';
38
42
  exports.BindUserByRolesUri = '/api/backend/bindUserByRoles';
39
43
  exports.BindUserByRoleNamesAndExtendValueUri = '/api/backend/bindUserByRolesInRoleNamesAndExtendValue';
40
44
  exports.BindUserByRolesAndExtendValueUri = '/api/backend/bindUserByRolesAndExtendValue';
@@ -1,11 +1,11 @@
1
1
  import { KauthConfig } from '../config/config';
2
- import { KauthAuthenticateRequest, KauthCreatePermissionRequest, KauthCreateRoleRequest, KauthCreateRolesByPermissionsAndUsersRequest, KauthBindUsersByRoleNameAndExtendValueRequest, KauthBindRequest, KauthBindRoleByPermissionsRequest, KauthBindUserByRolesRequest, KauthBindUserByRolesAndExtendValueRequest, KauthUpdateRolesWithPermissionsRequest, KauthBindRoleWithUsersRequest, KauthBindUserByRoleNamesAndExtendValueRequest, KauthSearchUsersWithUserAccountsAndRoleRequest, KauthCreatePreAuthorizationRequest, GetPreAuthorizationRequest, RefreshPreAuthorizatioRequest, ProcessPreAuthorizatioRequest } from './request/kauth';
2
+ import { KauthAuthenticateRequest, KauthCreatePermissionRequest, KauthCreateRoleRequest, KauthCreateRolesByPermissionsAndUsersRequest, KauthBindUsersByRoleNameAndExtendValueRequest, KauthBindRequest, KauthBindRoleByPermissionsRequest, KauthBindUserByRolesRequest, KauthBindUserByRolesAndExtendValueRequest, KauthUpdateRolesWithPermissionsRequest, KauthBindRoleWithUsersRequest, KauthBindUserByRoleNamesAndExtendValueRequest, KauthSearchUsersWithUserAccountsAndRoleRequest, KauthCreatePreAuthorizationRequest, GetPreAuthorizationRequest, RefreshPreAuthorizatioRequest, ProcessPreAuthorizatioRequest, KauthBindRoleByPermissionRequest, KauthUnbindRoleByPermissionRequest, KauthBindUserByRoleRequest, KauthUnbindUserByRoleRequest } from './request/kauth';
3
3
  import { KauthMoziAuthenticationInformation, KauthGoogleAuthenticationInformation, KauthPermission, KauthMiniprogramAuthenticationInformation, KauthRole, KauthUser, KauthPagable, KauthPreAuthorization } from './response/kauth';
4
4
  import { PreAuthorizationAllowed } from '../../authenticator/base';
5
5
  export declare class KauthApi {
6
6
  private marmotUtil;
7
7
  private cache;
8
- constructor({ kauthOrigin, marmotTenantId, marmotAccessKeyId, marmotAccessKeySecret, kauthServiceName, kauthServicePort, lruMaxAge, lruMax, }: KauthConfig);
8
+ constructor({ kauthOrigin, marmotTenantId, marmotAccessKeyId, marmotAccessKeySecret, kauthServiceName, kauthServicePort, authCookieName, lruMaxAge, lruMax, }: KauthConfig);
9
9
  setTraceId(traceId: string): void;
10
10
  setSpanId(spanId: string): void;
11
11
  setUserId(userId: string): void;
@@ -32,12 +32,16 @@ export declare class KauthApi {
32
32
  listUsersByPermissionNameAndExtendValue(permissionName: string, permissionExtendValue: string): Promise<KauthUser[]>;
33
33
  listPermissions(): Promise<KauthPermission[]>;
34
34
  createPermission(data: KauthCreatePermissionRequest): Promise<unknown>;
35
+ bindRoleByPermission(data: KauthBindRoleByPermissionRequest): Promise<unknown>;
36
+ unbindRoleByPermission(data: KauthUnbindRoleByPermissionRequest): Promise<unknown>;
35
37
  getRoleWithUsers(name: string, extendValue?: string): Promise<unknown>;
36
38
  listRoles(): Promise<KauthRole[]>;
37
39
  listRolesByExtendValue(extendValue: string): Promise<KauthRole[]>;
38
40
  listRolesByUserId(id: number): Promise<KauthRole[]>;
39
41
  listRolesByNamesAndExtendValue(names: string[], extendValue: string): Promise<KauthRole[]>;
40
42
  createRole(data: KauthCreateRoleRequest): Promise<unknown>;
43
+ bindUserByRole(data: KauthBindUserByRoleRequest): Promise<unknown>;
44
+ unbindUserByRole(data: KauthUnbindUserByRoleRequest): Promise<unknown>;
41
45
  unbind(userAccountId: number): Promise<void>;
42
46
  /**
43
47
  * cache with user and permission
@@ -9,8 +9,8 @@ const http_1 = require("../constant/http");
9
9
  const lru_cache_1 = __importDefault(require("lru-cache"));
10
10
  let cache;
11
11
  class KauthApi {
12
- constructor({ kauthOrigin, marmotTenantId, marmotAccessKeyId, marmotAccessKeySecret, kauthServiceName, kauthServicePort, lruMaxAge = 2 * 1000, lruMax = 100, }) {
13
- this.marmotUtil = new marmot_1.MarmotUtil(kauthOrigin, marmotTenantId, marmotAccessKeyId, marmotAccessKeySecret, kauthServiceName, kauthServicePort);
12
+ constructor({ kauthOrigin, marmotTenantId, marmotAccessKeyId, marmotAccessKeySecret, kauthServiceName, kauthServicePort, authCookieName, lruMaxAge = 2 * 1000, lruMax = 100, }) {
13
+ this.marmotUtil = new marmot_1.MarmotUtil(kauthOrigin, marmotTenantId, marmotAccessKeyId, marmotAccessKeySecret, kauthServiceName, kauthServicePort, authCookieName);
14
14
  if (cache) {
15
15
  this.cache = cache;
16
16
  }
@@ -105,6 +105,12 @@ class KauthApi {
105
105
  async createPermission(data) {
106
106
  return this.marmotUtil.post(http_1.CreatePermissionUri, data);
107
107
  }
108
+ async bindRoleByPermission(data) {
109
+ return this.marmotUtil.post(http_1.BindRoleByPermissionUri, data);
110
+ }
111
+ async unbindRoleByPermission(data) {
112
+ return this.marmotUtil.post(http_1.UnbindRoleByPermissionUri, data);
113
+ }
108
114
  async getRoleWithUsers(name, extendValue) {
109
115
  return this.marmotUtil.get(http_1.GetRoleWithUsersUri, {
110
116
  name,
@@ -127,6 +133,12 @@ class KauthApi {
127
133
  async createRole(data) {
128
134
  return this.marmotUtil.post(http_1.CreateRoleUri, data);
129
135
  }
136
+ async bindUserByRole(data) {
137
+ return this.marmotUtil.post(http_1.BindUserByRoleUri, data);
138
+ }
139
+ async unbindUserByRole(data) {
140
+ return this.marmotUtil.post(http_1.UnbindUserByRoleUri, data);
141
+ }
130
142
  async unbind(userAccountId) {
131
143
  return this.marmotUtil.post(http_1.UnbindUri + userAccountId);
132
144
  }
@@ -14,13 +14,28 @@ export interface KauthBindRequest extends ParsedUrlQueryInput, MarmotOptions {
14
14
  }
15
15
  export interface KauthCreatePermissionRequest extends MarmotOptions {
16
16
  name: string;
17
- type: number;
18
17
  extend_value: string;
19
18
  }
19
+ export interface KauthBindRoleByPermissionRequest extends MarmotOptions {
20
+ role_id: number;
21
+ permission_id: number;
22
+ }
23
+ export interface KauthUnbindRoleByPermissionRequest extends MarmotOptions {
24
+ role_id: number;
25
+ permission_id: number;
26
+ }
20
27
  export interface KauthCreateRoleRequest extends MarmotOptions {
21
28
  name: string;
22
29
  extend_value: string;
23
30
  }
31
+ export interface KauthBindUserByRoleRequest extends MarmotOptions {
32
+ user_id: number;
33
+ role_id: number;
34
+ }
35
+ export interface KauthUnbindUserByRoleRequest extends MarmotOptions {
36
+ user_id: number;
37
+ role_id: number;
38
+ }
24
39
  export interface KauthCreateRolesByPermissionsAndUsersRequest extends MarmotOptions {
25
40
  roles: Array<{
26
41
  name: string;
@@ -39,7 +39,8 @@ export declare class MarmotUtil {
39
39
  private traceId?;
40
40
  private spanId?;
41
41
  private traceConsumers?;
42
- constructor(origin: string, tenantId?: number, accessKeyId?: string, accessKeySecret?: string, serviceName?: string, servicePort?: string);
42
+ private authCookieName?;
43
+ constructor(origin: string, tenantId?: number, accessKeyId?: string, accessKeySecret?: string, serviceName?: string, servicePort?: string, authCookieName?: string);
43
44
  setUserId(userId: string): void;
44
45
  setTraceId(traceId: string): void;
45
46
  setSpanId(spanId: string): void;
@@ -18,7 +18,7 @@ var BasicStatus;
18
18
  BasicStatus[BasicStatus["InternalServerError"] = 10500] = "InternalServerError";
19
19
  })(BasicStatus || (BasicStatus = {}));
20
20
  class MarmotUtil {
21
- constructor(origin, tenantId, accessKeyId, accessKeySecret, serviceName, servicePort) {
21
+ constructor(origin, tenantId, accessKeyId, accessKeySecret, serviceName, servicePort, authCookieName) {
22
22
  this.origin = origin.replace(/\/+$/, '');
23
23
  this.tenantId = tenantId;
24
24
  this.accessKeyId = accessKeyId;
@@ -26,6 +26,7 @@ class MarmotUtil {
26
26
  this.serviceName = serviceName;
27
27
  this.servicePort = servicePort;
28
28
  this.proxyMatched = Boolean(accessKeyId && accessKeySecret && serviceName && servicePort);
29
+ this.authCookieName = authCookieName || 'authorization';
29
30
  }
30
31
  setUserId(userId) {
31
32
  this.userId = userId;
@@ -113,7 +114,7 @@ class MarmotUtil {
113
114
  const signature = this.sign(method.toUpperCase(), uri, this.accessKeySecret);
114
115
  headers['x-service-name'] = this.serviceName;
115
116
  headers['x-service-port'] = this.servicePort;
116
- headers.authorization = `Marmot ${this.accessKeyId}:${signature}`;
117
+ headers[this.authCookieName] = `Marmot ${this.accessKeyId}:${signature}`;
117
118
  return headers;
118
119
  }
119
120
  sign(method, path, accessKeySecret) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "kauth-sdk-node",
3
- "version": "2.0.12",
3
+ "version": "2.0.13-alpha.1",
4
4
  "description": "",
5
5
  "main": "dist/index.js",
6
6
  "files": [
@@ -9,14 +9,14 @@
9
9
  "types": "dist",
10
10
  "scripts": {
11
11
  "clean": "rm -rf dist coverage",
12
- "build": "npm run clean && tsc",
12
+ "build": "tsc",
13
13
  "watch": "tsc -w",
14
14
  "type-check": "tsc --noEmit",
15
- "lint": "npm run type-check && eslint . --fix --ext .ts",
15
+ "lint": "eslint . --fix --ext .ts",
16
16
  "test": "multi='spec=- mocha-junit-reporter=-' mocha --reporter=mocha-multi --recursive --require ts-node/register 'test/**/*.ts'",
17
17
  "ci": "nyc -t coverage --reporter=cobertura npm run test",
18
18
  "version": "conventional-changelog -p angular -i CHANGELOG.md -s && git add .",
19
- "prepublishOnly": "rm -rf dist && npm run build"
19
+ "prepublishOnly": "rm -rf dist && tsc"
20
20
  },
21
21
  "author": "",
22
22
  "license": "ISC",
@@ -30,7 +30,8 @@
30
30
  "devDependencies": {
31
31
  "@types/jsonwebtoken": "^8.5.0",
32
32
  "@types/lru-cache": "^5.1.0",
33
- "@types/mocha": "^8.0.0",
33
+ "@types/mocha": "^10.0.1",
34
+ "@types/node": "^16.18.69",
34
35
  "@types/sinon": "^9.0.4",
35
36
  "@typescript-eslint/eslint-plugin": "^3.7.1",
36
37
  "@typescript-eslint/parser": "^3.7.1",
@@ -40,9 +41,9 @@
40
41
  "eslint-config-prettier": "^7.1.0",
41
42
  "eslint-plugin-prettier": "^3.3.1",
42
43
  "lint-staged": "^10.5.3",
43
- "mocha": "^8.0.1",
44
+ "mocha": "^10.2.0",
44
45
  "mocha-junit-reporter": "^2.0.2",
45
- "mocha-multi": "^1.1.6",
46
+ "mocha-multi": "^1.1.7",
46
47
  "nyc": "^15.1.0",
47
48
  "prettier": "^2.2.1",
48
49
  "sinon": "^9.0.2",