feat(core-api): role based access control through oauth2 scopes hyper…

…ledger#770 WORK IN PROGRESS Fixes hyperledger#770 Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>
petermetz · Apr 7, 2021 · d3e33c8 · d3e33c8
1 parent e9de9ef
commit d3e33c8
Show file tree

Hide file tree

Showing 43 changed files with 1,128 additions and 43 deletions.
diff --git a/...chain-backend/src/main/typescript/infrastructure/supply-chain-app-dummy-infrastructure.ts b/...chain-backend/src/main/typescript/infrastructure/supply-chain-app-dummy-infrastructure.ts
@@ -77,23 +77,23 @@ export class SupplyChainAppDummyInfrastructure {
   private _quorumAccount: Account | undefined;
   private _besuAccount: Account | undefined;
 
-  public get quorumAccount() {
+  public get quorumAccount(): Account {
     if (!this._quorumAccount) {
       throw new Error(`Must call deployContracts() first.`);
     } else {
       return this._quorumAccount;
     }
   }
 
-  public get besuAccount() {
+  public get besuAccount(): Account {
     if (!this._besuAccount) {
       throw new Error(`Must call deployContracts() first.`);
     } else {
       return this._besuAccount;
     }
   }
 
-  public get className() {
+  public get className(): string {
     return SupplyChainAppDummyInfrastructure.CLASS_NAME;
   }
 

diff --git a/.../src/main/typescript/business-logic-plugin/web-services/insert-bamboo-harvest-endpoint.ts b/.../src/main/typescript/business-logic-plugin/web-services/insert-bamboo-harvest-endpoint.ts
@@ -5,12 +5,19 @@ import {
   Checks,
   LogLevelDesc,
   LoggerProvider,
+  IAsyncProvider,
 } from "@hyperledger/cactus-common";
 import {
+  IAuthorizationOptions,
   IExpressRequestHandler,
   IWebServiceEndpoint,
 } from "@hyperledger/cactus-core-api";
-import { registerWebServiceEndpoint } from "@hyperledger/cactus-core";
+
+import {
+  AuthorizationOptionsProvider,
+  registerWebServiceEndpoint,
+} from "@hyperledger/cactus-core";
+
 import {
   DefaultApi as QuorumApi,
   EthContractInvocationType,
@@ -26,8 +33,14 @@ export interface IInsertBambooHarvestEndpointOptions {
   contractAbi: any;
   apiClient: QuorumApi;
   web3SigningCredential: Web3SigningCredential;
+  authorizationOptionsProvider?: AuthorizationOptionsProvider;
 }
 
+const K_DEFAULT_AUTHORIZATION_OPTIONS: IAuthorizationOptions = {
+  isSecure: true,
+  requiredRoles: [],
+};
+
 export class InsertBambooHarvestEndpoint implements IWebServiceEndpoint {
   public static readonly HTTP_PATH = Constants.HTTP_PATH;
 
@@ -38,6 +51,7 @@ export class InsertBambooHarvestEndpoint implements IWebServiceEndpoint {
   public static readonly CLASS_NAME = "InsertBambooHarvestEndpoint";
 
   private readonly log: Logger;
+  private readonly authorizationOptionsProvider: AuthorizationOptionsProvider;
 
   public get className(): string {
     return InsertBambooHarvestEndpoint.CLASS_NAME;
@@ -57,6 +71,16 @@ export class InsertBambooHarvestEndpoint implements IWebServiceEndpoint {
     const level = this.opts.logLevel || "INFO";
     const label = this.className;
     this.log = LoggerProvider.getOrCreate({ level, label });
+
+    this.authorizationOptionsProvider =
+      opts.authorizationOptionsProvider ||
+      AuthorizationOptionsProvider.of(K_DEFAULT_AUTHORIZATION_OPTIONS, level);
+
+    this.log.debug(`Instantiated ${this.className} OK`);
+  }
+
+  getAuthorizationOptionsProvider(): IAsyncProvider<IAuthorizationOptions> {
+    return this.authorizationOptionsProvider;
   }
 
   public registerExpress(expressApp: Express): IWebServiceEndpoint {

diff --git a/...lugin/src/main/typescript/business-logic-plugin/web-services/insert-bookshelf-endpoint.ts b/...lugin/src/main/typescript/business-logic-plugin/web-services/insert-bookshelf-endpoint.ts
@@ -5,8 +5,10 @@ import {
   Checks,
   LogLevelDesc,
   LoggerProvider,
+  IAsyncProvider,
 } from "@hyperledger/cactus-common";
 import {
+  IAuthorizationOptions,
   IExpressRequestHandler,
   IWebServiceEndpoint,
 } from "@hyperledger/cactus-core-api";
@@ -59,6 +61,16 @@ export class InsertBookshelfEndpoint implements IWebServiceEndpoint {
     this.log = LoggerProvider.getOrCreate({ level, label });
   }
 
+  getAuthorizationOptionsProvider(): IAsyncProvider<IAuthorizationOptions> {
+    // TODO: make this an injectable dependency in the constructor
+    return {
+      get: async () => ({
+        isSecure: true,
+        requiredRoles: [],
+      }),
+    };
+  }
+
   public registerExpress(expressApp: Express): IWebServiceEndpoint {
     registerWebServiceEndpoint(expressApp, this);
     return this;

diff --git a/...plugin/src/main/typescript/business-logic-plugin/web-services/insert-shipment-endpoint.ts b/...plugin/src/main/typescript/business-logic-plugin/web-services/insert-shipment-endpoint.ts
@@ -5,8 +5,10 @@ import {
   Checks,
   LogLevelDesc,
   LoggerProvider,
+  IAsyncProvider,
 } from "@hyperledger/cactus-common";
 import {
+  IAuthorizationOptions,
   IExpressRequestHandler,
   IWebServiceEndpoint,
 } from "@hyperledger/cactus-core-api";
@@ -42,6 +44,16 @@ export class InsertShipmentEndpoint implements IWebServiceEndpoint {
     this.log = LoggerProvider.getOrCreate({ level, label });
   }
 
+  getAuthorizationOptionsProvider(): IAsyncProvider<IAuthorizationOptions> {
+    // TODO: make this an injectable dependency in the constructor
+    return {
+      get: async () => ({
+        isSecure: true,
+        requiredRoles: [],
+      }),
+    };
+  }
+
   public registerExpress(expressApp: Express): IWebServiceEndpoint {
     registerWebServiceEndpoint(expressApp, this);
     return this;

diff --git a/...in/src/main/typescript/business-logic-plugin/web-services/list-bamboo-harvest-endpoint.ts b/...in/src/main/typescript/business-logic-plugin/web-services/list-bamboo-harvest-endpoint.ts
@@ -5,8 +5,10 @@ import {
   Checks,
   LogLevelDesc,
   LoggerProvider,
+  IAsyncProvider,
 } from "@hyperledger/cactus-common";
 import {
+  IAuthorizationOptions,
   IExpressRequestHandler,
   IWebServiceEndpoint,
 } from "@hyperledger/cactus-core-api";
@@ -58,6 +60,16 @@ export class ListBambooHarvestEndpoint implements IWebServiceEndpoint {
     this.log = LoggerProvider.getOrCreate({ level, label });
   }
 
+  getAuthorizationOptionsProvider(): IAsyncProvider<IAuthorizationOptions> {
+    // TODO: make this an injectable dependency in the constructor
+    return {
+      get: async () => ({
+        isSecure: true,
+        requiredRoles: [],
+      }),
+    };
+  }
+
   public registerExpress(expressApp: Express): IWebServiceEndpoint {
     registerWebServiceEndpoint(expressApp, this);
     return this;

diff --git a/...-plugin/src/main/typescript/business-logic-plugin/web-services/list-bookshelf-endpoint.ts b/...-plugin/src/main/typescript/business-logic-plugin/web-services/list-bookshelf-endpoint.ts
@@ -5,8 +5,10 @@ import {
   Checks,
   LogLevelDesc,
   LoggerProvider,
+  IAsyncProvider,
 } from "@hyperledger/cactus-common";
 import {
+  IAuthorizationOptions,
   IExpressRequestHandler,
   IWebServiceEndpoint,
 } from "@hyperledger/cactus-core-api";
@@ -58,6 +60,16 @@ export class ListBookshelfEndpoint implements IWebServiceEndpoint {
     this.log = LoggerProvider.getOrCreate({ level, label });
   }
 
+  getAuthorizationOptionsProvider(): IAsyncProvider<IAuthorizationOptions> {
+    // TODO: make this an injectable dependency in the constructor
+    return {
+      get: async () => ({
+        isSecure: true,
+        requiredRoles: [],
+      }),
+    };
+  }
+
   public registerExpress(expressApp: Express): IWebServiceEndpoint {
     registerWebServiceEndpoint(expressApp, this);
     return this;

diff --git a/...c-plugin/src/main/typescript/business-logic-plugin/web-services/list-shipment-endpoint.ts b/...c-plugin/src/main/typescript/business-logic-plugin/web-services/list-shipment-endpoint.ts
@@ -5,8 +5,10 @@ import {
   Checks,
   LogLevelDesc,
   LoggerProvider,
+  IAsyncProvider,
 } from "@hyperledger/cactus-common";
 import {
+  IAuthorizationOptions,
   IExpressRequestHandler,
   IWebServiceEndpoint,
 } from "@hyperledger/cactus-core-api";
@@ -62,6 +64,16 @@ export class ListShipmentEndpoint implements IWebServiceEndpoint {
     this.log = LoggerProvider.getOrCreate({ level, label });
   }
 
+  getAuthorizationOptionsProvider(): IAsyncProvider<IAuthorizationOptions> {
+    // TODO: make this an injectable dependency in the constructor
+    return {
+      get: async () => ({
+        isSecure: true,
+        requiredRoles: [],
+      }),
+    };
+  }
+
   public registerExpress(expressApp: Express): IWebServiceEndpoint {
     registerWebServiceEndpoint(expressApp, this);
     return this;