@backstage-community/plugin-blackduck-backend 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# @backstage-community/plugin-blackduck-backend
+
+## 0.0.1
+
+### Patch Changes
+
+- 96e67dc: BlackDuck plugin migrated to @backstage-community plugins
+- Updated dependencies [96e67dc]
+  - @backstage-community/plugin-blackduck-common@0.0.1

package/README.md

@@ -0,0 +1,169 @@
+# blackduck
+
+Welcome to the blackduck backend plugin!
+
+## Installation
+
+This plugin needs to be added to an existing backstage instance.
+
+```bash
+# From your Backstage root directory
+yarn --cwd packages/backend add @backstage-community/plugin-blackduck-backend
+```
+
+### New Backend System
+
+This backend plugin has support for the [new backend system](https://backstage.io/docs/backend-system/), here's how you can set that up:
+
+In your `packages/backend/src/index.ts` make the following changes:
+
+```diff
+import { createBackend } from '@backstage/backend-defaults';
+
+const backend = createBackend();
+
+// ... other feature additions
+
++backend.add(import('@backstage-community/plugin-blackduck-backend'));
+
+// ...
+
+backend.start();
+```
+
+### Legacy Backend System
+
+Create a file called blackduck.ts inside `packages/backend/src/plugins/` and add the following:
+
+### blackduck.ts
+
+```typescript
+import { createRouter } from '@backstage-community/plugin-blackduck-backend';
+import { Router } from 'express';
+import { PluginEnvironment } from '../types';
+
+export default async function createPlugin(
+  env: PluginEnvironment,
+): Promise<Router> {
+  return await createRouter({
+    logger: env.logger,
+    config: env.config,
+    permissions: env.permissions,
+    discovery: env.discovery,
+  });
+}
+```
+
+And import the plugin to `packages/backend/src/index.ts`.
+
+### src/index.ts
+
+```diff
+diff --git a/packages/backend/src/index.ts b/packages/backend/src/index.ts
+index c4736a5..5822302 100644
+--- a/packages/backend/src/index.ts
++++ b/packages/backend/src/index.ts
+@@ -28,6 +28,7 @@ import scaffolder from './plugins/scaffolder';
+ import proxy from './plugins/proxy';
+ import techdocs from './plugins/techdocs';
+ import search from './plugins/search';
++import blackduck from './plugins/blackduck';
+ import { PluginEnvironment } from './types';
+ import { ServerPermissionClient } from '@backstage/plugin-permission-node';
+ import { DefaultIdentityClient } from '@backstage/plugin-auth-node';
+@@ -85,6 +86,7 @@ async function main() {
+   const techdocsEnv = useHotMemoize(module, () => createEnv('techdocs'));
+   const searchEnv = useHotMemoize(module, () => createEnv('search'));
+   const appEnv = useHotMemoize(module, () => createEnv('app'));
++  const blackduckEnv = useHotMemoize(module, () => createEnv('blackduck'));
+
+   const apiRouter = Router();
+   apiRouter.use('/catalog', await catalog(catalogEnv));
+@@ -93,6 +95,7 @@ async function main() {
+   apiRouter.use('/techdocs', await techdocs(techdocsEnv));
+   apiRouter.use('/proxy', await proxy(proxyEnv));
+   apiRouter.use('/search', await search(searchEnv));
++  apiRouter.use('/blackduck', await blackduck(blackduckEnv));
+
+   // Add backends ABOVE this line; this 404 handler is the catch-all fallback
+   apiRouter.use(notFoundHandler());
+
+```
+
+## Configuration
+
+### Integrate Permission Framework
+
+BlackDuck plugin supports permission framework.
+
+```bash
+# From your Backstage root directory
+yarn --cwd packages/backend add @backstage-community/plugin-blackduck-common
+```
+
+In your `packages/backend/src/index.ts` make the following changes:
+
+```diff
+import { createBackend } from '@backstage/backend-defaults';
+const backend = createBackend();
+// ... other feature additions
++backend.add(import('@backstage-community/plugin-blackduck-common'));
+// ...
+```
+
+### Configure Permission
+
+To apply the permission rules add the following in `packages/backend/src/plugins/permissions.ts`
+
+```diff
+...
++ import {
++  blackduckRiskProfileReadPermission
++  blackduckVulnerabilitiesReadPermission } from '@backstage-community/plugin-blackduck-common';
+...
+async handle(
+  request: PolicyQuery,
+  user?: BackstageIdentityResponse,
+): Promise<PolicyDecision> {
++ if ( isPermission(request.permission, blackduckRiskProfileReadPermission) ||
++      isPermission(request.permission, blackduckVulnerabilitiesReadPermission)) {
++    return createCatalogConditionalDecision(
++      request.permission,
++      catalogConditions.isEntityOwner({
++          claims: user?.identity.ownershipEntityRefs ?? [],
++       }),
++    );
++  }
+...
+  return {
+    result: AuthorizeResult.ALLOW,
+  };
+}
+```
+
+## Continue with Frontend Plugin
+
+Follow the Docs from [README.md](https://github.com/backstage/community-plugins/blob/main/workspaces/blackduck/plugins/blackduck/README.md)
+
+### Global Config
+
+Add the following into your `app-config.yaml`
+
+```yaml
+blackduck:
+  host: https://blackduck.yourcompany.com/api
+  token: YOUR_API_TOKEN
+```
+
+### Catalog
+
+Add the following into your catalog
+
+```yaml
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: backstage
+  annotations:
+    blackduck/project: YOUR_PROJECT_NAME/YOUR_PROJECT_VERSION
+```

package/dist/index.cjs.js

@@ -0,0 +1,279 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var rootHttpRouter = require('@backstage/backend-defaults/rootHttpRouter');
+var express = require('express');
+var Router = require('express-promise-router');
+var pluginPermissionNode = require('@backstage/plugin-permission-node');
+var errors = require('@backstage/errors');
+var pluginPermissionCommon = require('@backstage/plugin-permission-common');
+var backendCommon = require('@backstage/backend-common');
+var pluginBlackduckCommon = require('@backstage-community/plugin-blackduck-common');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var express__default = /*#__PURE__*/_interopDefaultCompat(express);
+var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
+
+class BlackDuckRestApi {
+  constructor(logger, host, token) {
+    this.logger = logger;
+    this.host = host;
+    this.token = token;
+    this._bearer = "";
+    this._limit = 1e3;
+  }
+  _bearer;
+  _limit;
+  async auth() {
+    try {
+      const auth = await fetch(`${this.host}/tokens/authenticate`, {
+        method: "POST",
+        headers: {
+          Authorization: `token ${this.token}`,
+          Accept: "application/vnd.blackducksoftware.user-4+json",
+          "Content-Type": "application/json"
+        }
+      });
+      const token = await auth.json();
+      this.logger.info("Auth Successfull");
+      this._bearer = token.bearerToken;
+      return token.bearerToken;
+    } catch (error) {
+      throw error;
+    }
+  }
+  async getProjects(name) {
+    const projects = await fetch(
+      `${this.host}/projects?limit=999&q=name:${name}`,
+      {
+        method: "GET",
+        headers: {
+          Authorization: `Bearer ${this._bearer}`,
+          Accept: "application/vnd.blackducksoftware.project-detail-4+json",
+          "Content-Type": "application/json"
+        }
+      }
+    );
+    this.logger.debug("Retrived Projects!!");
+    return projects.json();
+  }
+  async getVersions(projectUrl, versionName) {
+    const versions = await fetch(
+      `${projectUrl}/versions?limit=999&q=versionName:${versionName}`,
+      {
+        method: "GET",
+        headers: {
+          Authorization: `Bearer ${this._bearer}`,
+          Accept: "application/vnd.blackducksoftware.project-detail-5+json",
+          "Content-Type": "application/json"
+        }
+      }
+    );
+    this.logger.debug("Retrived Versions!!");
+    return versions.json();
+  }
+  async getProjectVersionDetails(projectName, projectVersion) {
+    let projectDetail;
+    let versionDetail;
+    const projects = await this.getProjects(
+      projectName
+    );
+    projects.items.forEach((item) => {
+      if (item.name === projectName) {
+        projectDetail = item;
+      }
+    });
+    if (projectDetail === void 0) {
+      this.logger.error("Provide full project name");
+    }
+    this.logger.debug(`Fetched Project : ${projectName} details`);
+    const versions = await this.getVersions(
+      projectDetail._meta.href,
+      projectVersion
+    );
+    versions.items.forEach((item) => {
+      if (item.versionName === projectVersion) {
+        versionDetail = item;
+      }
+    });
+    if (versionDetail === void 0) {
+      this.logger.error("Provide full version name");
+    }
+    this.logger.debug(
+      `Fetched Project : ${projectName}, Version: ${projectVersion} details`
+    );
+    return versionDetail;
+  }
+  async getVulnerableComponents(projectName, projectVersion) {
+    const versionDetail = await this.getProjectVersionDetails(
+      projectName,
+      projectVersion
+    );
+    const vuln_url = `${versionDetail._meta.href}/vulnerable-bom-components?limit=${this._limit}`;
+    const vulns = await fetch(vuln_url, {
+      method: "GET",
+      headers: {
+        Authorization: `Bearer ${this._bearer}`,
+        Accept: "application/vnd.blackducksoftware.bill-of-materials-6+json",
+        "Content-Type": "application/json"
+      }
+    });
+    this.logger.debug(
+      `Fetched Project : ${projectName}, Version: ${projectVersion} Vulnerable Components`
+    );
+    return vulns.json();
+  }
+  async getRiskProfile(projectName, projectVersion) {
+    const versionDetail = await this.getProjectVersionDetails(
+      projectName,
+      projectVersion
+    );
+    const risk_profile_url = `${versionDetail._meta.href}/risk-profile`;
+    const risk_profile = await fetch(risk_profile_url, {
+      method: "GET",
+      headers: {
+        Authorization: `Bearer ${this._bearer}`,
+        // Accept: 'application/vnd.blackducksoftware.component-detail-5+json',
+        "Content-Type": "application/json"
+      }
+    });
+    this.logger.debug(
+      `Fetched Project : ${projectName}, Version: ${projectVersion} risk profile`
+    );
+    return risk_profile.json();
+  }
+}
+
+async function createRouter(options) {
+  const { logger, config, permissions } = options;
+  const { httpAuth } = backendCommon.createLegacyAuthAdapters(options);
+  const permissionIntegrationRouter = pluginPermissionNode.createPermissionIntegrationRouter({
+    permissions: pluginBlackduckCommon.blackduckPermissions
+  });
+  const bdConfig = config.getConfig("blackduck");
+  const bdHost = bdConfig.getString("host");
+  const bdToken = bdConfig.getString("token");
+  const router = Router__default.default();
+  router.use(express__default.default.json());
+  router.use(permissionIntegrationRouter);
+  router.get("/health", (_, response) => {
+    logger.info("PONG!");
+    response.json({ status: "ok" });
+  });
+  const middleware = rootHttpRouter.MiddlewareFactory.create({ logger, config });
+  router.post(
+    "/risk-profile/:projectName/:projectVersion",
+    async (_request, response) => {
+      logger.debug("getting vulnarabilities..");
+      const { projectName, projectVersion } = _request.params;
+      const blackDuck = new BlackDuckRestApi(logger, bdHost, bdToken);
+      const credentials = await httpAuth.credentials(_request);
+      const entityRef = _request.body.entityRef;
+      logger.info("getting risk profile for project: ", entityRef);
+      if (typeof entityRef !== "string") {
+        throw new errors.InputError("Invalid entityRef, not a string");
+      }
+      const decision = (await permissions.authorize(
+        [
+          {
+            permission: pluginBlackduckCommon.blackduckRiskProfileReadPermission,
+            resourceRef: entityRef
+          }
+        ],
+        {
+          credentials
+        }
+      ))[0];
+      if (decision.result !== pluginPermissionCommon.AuthorizeResult.ALLOW) {
+        throw new errors.NotAllowedError("Unauthorized");
+      }
+      await blackDuck.auth();
+      const risk_profile = await blackDuck.getRiskProfile(
+        projectName,
+        projectVersion
+      );
+      response.json(risk_profile);
+    }
+  );
+  router.post(
+    "/vulns/:projectName/:projectVersion",
+    async (_request, response) => {
+      const { projectName, projectVersion } = _request.params;
+      const blackDuck = new BlackDuckRestApi(logger, bdHost, bdToken);
+      const credentials = await httpAuth.credentials(_request);
+      const entityRef = _request.body.entityRef;
+      logger.info("getting vulnarabilities for project: ", entityRef);
+      if (typeof entityRef !== "string") {
+        throw new errors.InputError("Invalid entityRef, not a string");
+      }
+      const decision = (await permissions.authorize(
+        [
+          {
+            permission: pluginBlackduckCommon.blackduckVulnerabilitiesReadPermission,
+            resourceRef: entityRef
+          }
+        ],
+        {
+          credentials
+        }
+      ))[0];
+      logger.info("decision", decision);
+      if (decision.result !== pluginPermissionCommon.AuthorizeResult.ALLOW) {
+        throw new errors.NotAllowedError("Unauthorized");
+      }
+      await blackDuck.auth();
+      const vulns = await blackDuck.getVulnerableComponents(
+        projectName,
+        projectVersion
+      );
+      response.json(vulns);
+    }
+  );
+  router.use(middleware.error());
+  return router;
+}
+
+const blackduckPlugin = backendPluginApi.createBackendPlugin({
+  pluginId: "blackduck",
+  register(env) {
+    env.registerInit({
+      deps: {
+        httpRouter: backendPluginApi.coreServices.httpRouter,
+        logger: backendPluginApi.coreServices.logger,
+        config: backendPluginApi.coreServices.rootConfig,
+        permissions: backendPluginApi.coreServices.permissions,
+        discovery: backendPluginApi.coreServices.discovery,
+        httpAuth: backendPluginApi.coreServices.httpAuth
+      },
+      async init({
+        httpRouter,
+        logger,
+        config,
+        permissions,
+        discovery,
+        httpAuth
+      }) {
+        httpRouter.use(
+          await createRouter({
+            logger,
+            config,
+            permissions,
+            discovery,
+            httpAuth
+          })
+        );
+        httpRouter.addAuthPolicy({
+          path: "/health",
+          allow: "unauthenticated"
+        });
+      }
+    });
+  }
+});
+
+exports.createRouter = createRouter;
+exports.default = blackduckPlugin;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/api/BlackDuckRestApi.ts","../src/service/router.ts","../src/plugin.ts"],"sourcesContent":["import { LoggerService } from '@backstage/backend-plugin-api';\nimport {\n  BD_REST_API_RESPONSE,\n  BD_PROJECT_DETAIL,\n  BD_VERISON_DETAIL,\n  BD_VERSIONS_API_RESPONSE,\n  BD_PROJECTS_API_RESPONSE,\n} from '@backstage-community/plugin-blackduck-common';\n\nexport class BlackDuckRestApi {\n  private _bearer: string;\n  private _limit: number;\n  public constructor(\n    private readonly logger: LoggerService,\n    private readonly host: string,\n    private readonly token: string,\n  ) {\n    this._bearer = '';\n    this._limit = 1000;\n  }\n\n  public async auth() {\n    try {\n      const auth = await fetch(`${this.host}/tokens/authenticate`, {\n        method: 'POST',\n        headers: {\n          Authorization: `token ${this.token}`,\n          Accept: 'application/vnd.blackducksoftware.user-4+json',\n          'Content-Type': 'application/json',\n        },\n      });\n      const token = await auth.json();\n      this.logger.info('Auth Successfull');\n      this._bearer = token.bearerToken;\n      return token.bearerToken;\n    } catch (error) {\n      throw error;\n    }\n  }\n  public async getProjects(name: string): Promise<BD_REST_API_RESPONSE> {\n    const projects = await fetch(\n      `${this.host}/projects?limit=999&q=name:${name}`,\n      {\n        method: 'GET',\n        headers: {\n          Authorization: `Bearer ${this._bearer}`,\n          Accept: 'application/vnd.blackducksoftware.project-detail-4+json',\n          'Content-Type': 'application/json',\n        },\n      },\n    );\n    this.logger.debug('Retrived Projects!!');\n    return projects.json();\n  }\n\n  public async getVersions(\n    projectUrl: string,\n    versionName: string,\n  ): Promise<BD_VERSIONS_API_RESPONSE> {\n    const versions = await fetch(\n      `${projectUrl}/versions?limit=999&q=versionName:${versionName}`,\n      {\n        method: 'GET',\n        headers: {\n          Authorization: `Bearer ${this._bearer}`,\n          Accept: 'application/vnd.blackducksoftware.project-detail-5+json',\n          'Content-Type': 'application/json',\n        },\n      },\n    );\n    this.logger.debug('Retrived Versions!!');\n    return versions.json();\n  }\n\n  public async getProjectVersionDetails(\n    projectName: string,\n    projectVersion: string,\n  ) {\n    let projectDetail: BD_PROJECT_DETAIL | any;\n    let versionDetail: BD_VERISON_DETAIL | any;\n    const projects: BD_PROJECTS_API_RESPONSE = await this.getProjects(\n      projectName,\n    );\n    projects.items.forEach((item: any) => {\n      if (item.name === projectName) {\n        projectDetail = item;\n      }\n    });\n    if (projectDetail === undefined) {\n      this.logger.error('Provide full project name');\n    }\n    this.logger.debug(`Fetched Project : ${projectName} details`);\n    const versions: BD_VERSIONS_API_RESPONSE = await this.getVersions(\n      projectDetail._meta.href,\n      projectVersion,\n    );\n    versions.items.forEach((item: any) => {\n      if (item.versionName === projectVersion) {\n        versionDetail = item;\n      }\n    });\n    if (versionDetail === undefined) {\n      this.logger.error('Provide full version name');\n    }\n    this.logger.debug(\n      `Fetched Project : ${projectName}, Version: ${projectVersion} details`,\n    );\n\n    return versionDetail;\n  }\n\n  public async getVulnerableComponents(\n    projectName: string,\n    projectVersion: string,\n  ) {\n    const versionDetail = await this.getProjectVersionDetails(\n      projectName,\n      projectVersion,\n    );\n    const vuln_url = `${versionDetail._meta.href}/vulnerable-bom-components?limit=${this._limit}`;\n    const vulns: any = await fetch(vuln_url, {\n      method: 'GET',\n      headers: {\n        Authorization: `Bearer ${this._bearer}`,\n        Accept: 'application/vnd.blackducksoftware.bill-of-materials-6+json',\n        'Content-Type': 'application/json',\n      },\n    });\n    this.logger.debug(\n      `Fetched Project : ${projectName}, Version: ${projectVersion} Vulnerable Components`,\n    );\n    return vulns.json();\n  }\n\n  public async getRiskProfile(projectName: string, projectVersion: string) {\n    const versionDetail = await this.getProjectVersionDetails(\n      projectName,\n      projectVersion,\n    );\n    const risk_profile_url = `${versionDetail._meta.href}/risk-profile`;\n    const risk_profile: any = await fetch(risk_profile_url, {\n      method: 'GET',\n      headers: {\n        Authorization: `Bearer ${this._bearer}`,\n        // Accept: 'application/vnd.blackducksoftware.component-detail-5+json',\n        'Content-Type': 'application/json',\n      },\n    });\n    this.logger.debug(\n      `Fetched Project : ${projectName}, Version: ${projectVersion} risk profile`,\n    );\n    return risk_profile.json();\n  }\n}\n","import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';\nimport {\n  DiscoveryService,\n  HttpAuthService,\n  LoggerService,\n  PermissionsService,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { createPermissionIntegrationRouter } from '@backstage/plugin-permission-node';\nimport { InputError, NotAllowedError } from '@backstage/errors';\nimport { AuthorizeResult } from '@backstage/plugin-permission-common';\nimport { createLegacyAuthAdapters } from '@backstage/backend-common';\nimport {\n  blackduckPermissions,\n  blackduckRiskProfileReadPermission,\n  blackduckVulnerabilitiesReadPermission,\n} from '@backstage-community/plugin-blackduck-common';\nimport { BlackDuckRestApi } from '../api/BlackDuckRestApi';\n\n/** @public */\nexport interface RouterOptions {\n  logger: LoggerService;\n  config: Config;\n  permissions: PermissionsService;\n  discovery: DiscoveryService;\n  httpAuth?: HttpAuthService;\n}\n\n/** @public */\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  const { logger, config, permissions } = options;\n  const { httpAuth } = createLegacyAuthAdapters(options);\n  const permissionIntegrationRouter = createPermissionIntegrationRouter({\n    permissions: blackduckPermissions,\n  });\n\n  const bdConfig = config.getConfig('blackduck');\n  const bdHost = bdConfig.getString('host');\n  const bdToken = bdConfig.getString('token');\n\n  const router = Router();\n  router.use(express.json());\n  router.use(permissionIntegrationRouter);\n\n  router.get('/health', (_, response) => {\n    logger.info('PONG!');\n    response.json({ status: 'ok' });\n  });\n\n  const middleware = MiddlewareFactory.create({ logger, config });\n\n  router.post(\n    '/risk-profile/:projectName/:projectVersion',\n    async (_request, response) => {\n      logger.debug('getting vulnarabilities..');\n      const { projectName, projectVersion } = _request.params;\n      const blackDuck = new BlackDuckRestApi(logger, bdHost, bdToken);\n      const credentials = await httpAuth.credentials(_request);\n      const entityRef = _request.body.entityRef;\n      logger.info('getting risk profile for project: ', entityRef);\n      if (typeof entityRef !== 'string') {\n        throw new InputError('Invalid entityRef, not a string');\n      }\n\n      const decision = (\n        await permissions.authorize(\n          [\n            {\n              permission: blackduckRiskProfileReadPermission,\n              resourceRef: entityRef,\n            },\n          ],\n          {\n            credentials,\n          },\n        )\n      )[0];\n\n      if (decision.result !== AuthorizeResult.ALLOW) {\n        throw new NotAllowedError('Unauthorized');\n      }\n\n      await blackDuck.auth();\n      const risk_profile = await blackDuck.getRiskProfile(\n        projectName,\n        projectVersion,\n      );\n      response.json(risk_profile);\n    },\n  );\n\n  router.post(\n    '/vulns/:projectName/:projectVersion',\n    async (_request, response) => {\n      const { projectName, projectVersion } = _request.params;\n      const blackDuck = new BlackDuckRestApi(logger, bdHost, bdToken);\n      const credentials = await httpAuth.credentials(_request);\n      const entityRef = _request.body.entityRef;\n      logger.info('getting vulnarabilities for project: ', entityRef);\n      if (typeof entityRef !== 'string') {\n        throw new InputError('Invalid entityRef, not a string');\n      }\n\n      const decision = (\n        await permissions.authorize(\n          [\n            {\n              permission: blackduckVulnerabilitiesReadPermission,\n              resourceRef: entityRef,\n            },\n          ],\n          {\n            credentials,\n          },\n        )\n      )[0];\n      logger.info('decision', decision);\n      if (decision.result !== AuthorizeResult.ALLOW) {\n        throw new NotAllowedError('Unauthorized');\n      }\n\n      await blackDuck.auth();\n      const vulns = await blackDuck.getVulnerableComponents(\n        projectName,\n        projectVersion,\n      );\n      response.json(vulns);\n    },\n  );\n\n  router.use(middleware.error());\n  return router;\n}\n","import {\n  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\n\n/**\n * blackduckPlugin backend plugin\n *\n * @public\n */\nexport const blackduckPlugin = createBackendPlugin({\n  pluginId: 'blackduck',\n  register(env) {\n    env.registerInit({\n      deps: {\n        httpRouter: coreServices.httpRouter,\n        logger: coreServices.logger,\n        config: coreServices.rootConfig,\n        permissions: coreServices.permissions,\n        discovery: coreServices.discovery,\n        httpAuth: coreServices.httpAuth,\n      },\n      async init({\n        httpRouter,\n        logger,\n        config,\n        permissions,\n        discovery,\n        httpAuth,\n      }) {\n        httpRouter.use(\n          await createRouter({\n            logger,\n            config,\n            permissions,\n            discovery,\n            httpAuth,\n          }),\n        );\n        httpRouter.addAuthPolicy({\n          path: '/health',\n          allow: 'unauthenticated',\n        });\n      },\n    });\n  },\n});\n"],"names":["createLegacyAuthAdapters","createPermissionIntegrationRouter","blackduckPermissions","Router","express","MiddlewareFactory","InputError","blackduckRiskProfileReadPermission","AuthorizeResult","NotAllowedError","blackduckVulnerabilitiesReadPermission","createBackendPlugin","coreServices"],"mappings":";;;;;;;;;;;;;;;;;;;AASO,MAAM,gBAAiB,CAAA;AAAA,EAGrB,WAAA,CACY,MACA,EAAA,IAAA,EACA,KACjB,EAAA;AAHiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA,CAAA;AACA,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA,CAAA;AAEjB,IAAA,IAAA,CAAK,OAAU,GAAA,EAAA,CAAA;AACf,IAAA,IAAA,CAAK,MAAS,GAAA,GAAA,CAAA;AAAA,GAChB;AAAA,EATQ,OAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EAUR,MAAa,IAAO,GAAA;AAClB,IAAI,IAAA;AACF,MAAA,MAAM,OAAO,MAAM,KAAA,CAAM,CAAG,EAAA,IAAA,CAAK,IAAI,CAAwB,oBAAA,CAAA,EAAA;AAAA,QAC3D,MAAQ,EAAA,MAAA;AAAA,QACR,OAAS,EAAA;AAAA,UACP,aAAA,EAAe,CAAS,MAAA,EAAA,IAAA,CAAK,KAAK,CAAA,CAAA;AAAA,UAClC,MAAQ,EAAA,+CAAA;AAAA,UACR,cAAgB,EAAA,kBAAA;AAAA,SAClB;AAAA,OACD,CAAA,CAAA;AACD,MAAM,MAAA,KAAA,GAAQ,MAAM,IAAA,CAAK,IAAK,EAAA,CAAA;AAC9B,MAAK,IAAA,CAAA,MAAA,CAAO,KAAK,kBAAkB,CAAA,CAAA;AACnC,MAAA,IAAA,CAAK,UAAU,KAAM,CAAA,WAAA,CAAA;AACrB,MAAA,OAAO,KAAM,CAAA,WAAA,CAAA;AAAA,aACN,KAAO,EAAA;AACd,MAAM,MAAA,KAAA,CAAA;AAAA,KACR;AAAA,GACF;AAAA,EACA,MAAa,YAAY,IAA6C,EAAA;AACpE,IAAA,MAAM,WAAW,MAAM,KAAA;AAAA,MACrB,CAAG,EAAA,IAAA,CAAK,IAAI,CAAA,2BAAA,EAA8B,IAAI,CAAA,CAAA;AAAA,MAC9C;AAAA,QACE,MAAQ,EAAA,KAAA;AAAA,QACR,OAAS,EAAA;AAAA,UACP,aAAA,EAAe,CAAU,OAAA,EAAA,IAAA,CAAK,OAAO,CAAA,CAAA;AAAA,UACrC,MAAQ,EAAA,yDAAA;AAAA,UACR,cAAgB,EAAA,kBAAA;AAAA,SAClB;AAAA,OACF;AAAA,KACF,CAAA;AACA,IAAK,IAAA,CAAA,MAAA,CAAO,MAAM,qBAAqB,CAAA,CAAA;AACvC,IAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AAAA,GACvB;AAAA,EAEA,MAAa,WACX,CAAA,UAAA,EACA,WACmC,EAAA;AACnC,IAAA,MAAM,WAAW,MAAM,KAAA;AAAA,MACrB,CAAA,EAAG,UAAU,CAAA,kCAAA,EAAqC,WAAW,CAAA,CAAA;AAAA,MAC7D;AAAA,QACE,MAAQ,EAAA,KAAA;AAAA,QACR,OAAS,EAAA;AAAA,UACP,aAAA,EAAe,CAAU,OAAA,EAAA,IAAA,CAAK,OAAO,CAAA,CAAA;AAAA,UACrC,MAAQ,EAAA,yDAAA;AAAA,UACR,cAAgB,EAAA,kBAAA;AAAA,SAClB;AAAA,OACF;AAAA,KACF,CAAA;AACA,IAAK,IAAA,CAAA,MAAA,CAAO,MAAM,qBAAqB,CAAA,CAAA;AACvC,IAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AAAA,GACvB;AAAA,EAEA,MAAa,wBACX,CAAA,WAAA,EACA,cACA,EAAA;AACA,IAAI,IAAA,aAAA,CAAA;AACJ,IAAI,IAAA,aAAA,CAAA;AACJ,IAAM,MAAA,QAAA,GAAqC,MAAM,IAAK,CAAA,WAAA;AAAA,MACpD,WAAA;AAAA,KACF,CAAA;AACA,IAAS,QAAA,CAAA,KAAA,CAAM,OAAQ,CAAA,CAAC,IAAc,KAAA;AACpC,MAAI,IAAA,IAAA,CAAK,SAAS,WAAa,EAAA;AAC7B,QAAgB,aAAA,GAAA,IAAA,CAAA;AAAA,OAClB;AAAA,KACD,CAAA,CAAA;AACD,IAAA,IAAI,kBAAkB,KAAW,CAAA,EAAA;AAC/B,MAAK,IAAA,CAAA,MAAA,CAAO,MAAM,2BAA2B,CAAA,CAAA;AAAA,KAC/C;AACA,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAqB,kBAAA,EAAA,WAAW,CAAU,QAAA,CAAA,CAAA,CAAA;AAC5D,IAAM,MAAA,QAAA,GAAqC,MAAM,IAAK,CAAA,WAAA;AAAA,MACpD,cAAc,KAAM,CAAA,IAAA;AAAA,MACpB,cAAA;AAAA,KACF,CAAA;AACA,IAAS,QAAA,CAAA,KAAA,CAAM,OAAQ,CAAA,CAAC,IAAc,KAAA;AACpC,MAAI,IAAA,IAAA,CAAK,gBAAgB,cAAgB,EAAA;AACvC,QAAgB,aAAA,GAAA,IAAA,CAAA;AAAA,OAClB;AAAA,KACD,CAAA,CAAA;AACD,IAAA,IAAI,kBAAkB,KAAW,CAAA,EAAA;AAC/B,MAAK,IAAA,CAAA,MAAA,CAAO,MAAM,2BAA2B,CAAA,CAAA;AAAA,KAC/C;AACA,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAAA,kBAAA,EAAqB,WAAW,CAAA,WAAA,EAAc,cAAc,CAAA,QAAA,CAAA;AAAA,KAC9D,CAAA;AAEA,IAAO,OAAA,aAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAa,uBACX,CAAA,WAAA,EACA,cACA,EAAA;AACA,IAAM,MAAA,aAAA,GAAgB,MAAM,IAAK,CAAA,wBAAA;AAAA,MAC/B,WAAA;AAAA,MACA,cAAA;AAAA,KACF,CAAA;AACA,IAAA,MAAM,WAAW,CAAG,EAAA,aAAA,CAAc,MAAM,IAAI,CAAA,iCAAA,EAAoC,KAAK,MAAM,CAAA,CAAA,CAAA;AAC3F,IAAM,MAAA,KAAA,GAAa,MAAM,KAAA,CAAM,QAAU,EAAA;AAAA,MACvC,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA;AAAA,QACP,aAAA,EAAe,CAAU,OAAA,EAAA,IAAA,CAAK,OAAO,CAAA,CAAA;AAAA,QACrC,MAAQ,EAAA,4DAAA;AAAA,QACR,cAAgB,EAAA,kBAAA;AAAA,OAClB;AAAA,KACD,CAAA,CAAA;AACD,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAAA,kBAAA,EAAqB,WAAW,CAAA,WAAA,EAAc,cAAc,CAAA,sBAAA,CAAA;AAAA,KAC9D,CAAA;AACA,IAAA,OAAO,MAAM,IAAK,EAAA,CAAA;AAAA,GACpB;AAAA,EAEA,MAAa,cAAe,CAAA,WAAA,EAAqB,cAAwB,EAAA;AACvE,IAAM,MAAA,aAAA,GAAgB,MAAM,IAAK,CAAA,wBAAA;AAAA,MAC/B,WAAA;AAAA,MACA,cAAA;AAAA,KACF,CAAA;AACA,IAAA,MAAM,gBAAmB,GAAA,CAAA,EAAG,aAAc,CAAA,KAAA,CAAM,IAAI,CAAA,aAAA,CAAA,CAAA;AACpD,IAAM,MAAA,YAAA,GAAoB,MAAM,KAAA,CAAM,gBAAkB,EAAA;AAAA,MACtD,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA;AAAA,QACP,aAAA,EAAe,CAAU,OAAA,EAAA,IAAA,CAAK,OAAO,CAAA,CAAA;AAAA;AAAA,QAErC,cAAgB,EAAA,kBAAA;AAAA,OAClB;AAAA,KACD,CAAA,CAAA;AACD,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAAA,kBAAA,EAAqB,WAAW,CAAA,WAAA,EAAc,cAAc,CAAA,aAAA,CAAA;AAAA,KAC9D,CAAA;AACA,IAAA,OAAO,aAAa,IAAK,EAAA,CAAA;AAAA,GAC3B;AACF;;AC1HA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,MAAQ,EAAA,WAAA,EAAgB,GAAA,OAAA,CAAA;AACxC,EAAA,MAAM,EAAE,QAAA,EAAa,GAAAA,sCAAA,CAAyB,OAAO,CAAA,CAAA;AACrD,EAAA,MAAM,8BAA8BC,sDAAkC,CAAA;AAAA,IACpE,WAAa,EAAAC,0CAAA;AAAA,GACd,CAAA,CAAA;AAED,EAAM,MAAA,QAAA,GAAW,MAAO,CAAA,SAAA,CAAU,WAAW,CAAA,CAAA;AAC7C,EAAM,MAAA,MAAA,GAAS,QAAS,CAAA,SAAA,CAAU,MAAM,CAAA,CAAA;AACxC,EAAM,MAAA,OAAA,GAAU,QAAS,CAAA,SAAA,CAAU,OAAO,CAAA,CAAA;AAE1C,EAAA,MAAM,SAASC,uBAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AACzB,EAAA,MAAA,CAAO,IAAI,2BAA2B,CAAA,CAAA;AAEtC,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,CAAC,CAAA,EAAG,QAAa,KAAA;AACrC,IAAA,MAAA,CAAO,KAAK,OAAO,CAAA,CAAA;AACnB,IAAA,QAAA,CAAS,IAAK,CAAA,EAAE,MAAQ,EAAA,IAAA,EAAM,CAAA,CAAA;AAAA,GAC/B,CAAA,CAAA;AAED,EAAA,MAAM,aAAaC,gCAAkB,CAAA,MAAA,CAAO,EAAE,MAAA,EAAQ,QAAQ,CAAA,CAAA;AAE9D,EAAO,MAAA,CAAA,IAAA;AAAA,IACL,4CAAA;AAAA,IACA,OAAO,UAAU,QAAa,KAAA;AAC5B,MAAA,MAAA,CAAO,MAAM,2BAA2B,CAAA,CAAA;AACxC,MAAA,MAAM,EAAE,WAAA,EAAa,cAAe,EAAA,GAAI,QAAS,CAAA,MAAA,CAAA;AACjD,MAAA,MAAM,SAAY,GAAA,IAAI,gBAAiB,CAAA,MAAA,EAAQ,QAAQ,OAAO,CAAA,CAAA;AAC9D,MAAA,MAAM,WAAc,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,QAAQ,CAAA,CAAA;AACvD,MAAM,MAAA,SAAA,GAAY,SAAS,IAAK,CAAA,SAAA,CAAA;AAChC,MAAO,MAAA,CAAA,IAAA,CAAK,sCAAsC,SAAS,CAAA,CAAA;AAC3D,MAAI,IAAA,OAAO,cAAc,QAAU,EAAA;AACjC,QAAM,MAAA,IAAIC,kBAAW,iCAAiC,CAAA,CAAA;AAAA,OACxD;AAEA,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,WAAY,CAAA,SAAA;AAAA,QAChB;AAAA,UACE;AAAA,YACE,UAAY,EAAAC,wDAAA;AAAA,YACZ,WAAa,EAAA,SAAA;AAAA,WACf;AAAA,SACF;AAAA,QACA;AAAA,UACE,WAAA;AAAA,SACF;AAAA,SAEF,CAAC,CAAA,CAAA;AAEH,MAAI,IAAA,QAAA,CAAS,MAAW,KAAAC,sCAAA,CAAgB,KAAO,EAAA;AAC7C,QAAM,MAAA,IAAIC,uBAAgB,cAAc,CAAA,CAAA;AAAA,OAC1C;AAEA,MAAA,MAAM,UAAU,IAAK,EAAA,CAAA;AACrB,MAAM,MAAA,YAAA,GAAe,MAAM,SAAU,CAAA,cAAA;AAAA,QACnC,WAAA;AAAA,QACA,cAAA;AAAA,OACF,CAAA;AACA,MAAA,QAAA,CAAS,KAAK,YAAY,CAAA,CAAA;AAAA,KAC5B;AAAA,GACF,CAAA;AAEA,EAAO,MAAA,CAAA,IAAA;AAAA,IACL,qCAAA;AAAA,IACA,OAAO,UAAU,QAAa,KAAA;AAC5B,MAAA,MAAM,EAAE,WAAA,EAAa,cAAe,EAAA,GAAI,QAAS,CAAA,MAAA,CAAA;AACjD,MAAA,MAAM,SAAY,GAAA,IAAI,gBAAiB,CAAA,MAAA,EAAQ,QAAQ,OAAO,CAAA,CAAA;AAC9D,MAAA,MAAM,WAAc,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,QAAQ,CAAA,CAAA;AACvD,MAAM,MAAA,SAAA,GAAY,SAAS,IAAK,CAAA,SAAA,CAAA;AAChC,MAAO,MAAA,CAAA,IAAA,CAAK,yCAAyC,SAAS,CAAA,CAAA;AAC9D,MAAI,IAAA,OAAO,cAAc,QAAU,EAAA;AACjC,QAAM,MAAA,IAAIH,kBAAW,iCAAiC,CAAA,CAAA;AAAA,OACxD;AAEA,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,WAAY,CAAA,SAAA;AAAA,QAChB;AAAA,UACE;AAAA,YACE,UAAY,EAAAI,4DAAA;AAAA,YACZ,WAAa,EAAA,SAAA;AAAA,WACf;AAAA,SACF;AAAA,QACA;AAAA,UACE,WAAA;AAAA,SACF;AAAA,SAEF,CAAC,CAAA,CAAA;AACH,MAAO,MAAA,CAAA,IAAA,CAAK,YAAY,QAAQ,CAAA,CAAA;AAChC,MAAI,IAAA,QAAA,CAAS,MAAW,KAAAF,sCAAA,CAAgB,KAAO,EAAA;AAC7C,QAAM,MAAA,IAAIC,uBAAgB,cAAc,CAAA,CAAA;AAAA,OAC1C;AAEA,MAAA,MAAM,UAAU,IAAK,EAAA,CAAA;AACrB,MAAM,MAAA,KAAA,GAAQ,MAAM,SAAU,CAAA,uBAAA;AAAA,QAC5B,WAAA;AAAA,QACA,cAAA;AAAA,OACF,CAAA;AACA,MAAA,QAAA,CAAS,KAAK,KAAK,CAAA,CAAA;AAAA,KACrB;AAAA,GACF,CAAA;AAEA,EAAO,MAAA,CAAA,GAAA,CAAI,UAAW,CAAA,KAAA,EAAO,CAAA,CAAA;AAC7B,EAAO,OAAA,MAAA,CAAA;AACT;;AC7HO,MAAM,kBAAkBE,oCAAoB,CAAA;AAAA,EACjD,QAAU,EAAA,WAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,YAAYC,6BAAa,CAAA,UAAA;AAAA,QACzB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,aAAaA,6BAAa,CAAA,WAAA;AAAA,QAC1B,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,UAAUA,6BAAa,CAAA,QAAA;AAAA,OACzB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,UAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,WAAA;AAAA,QACA,SAAA;AAAA,QACA,QAAA;AAAA,OACC,EAAA;AACD,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAM,YAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,MAAA;AAAA,YACA,WAAA;AAAA,YACA,SAAA;AAAA,YACA,QAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AACA,QAAA,UAAA,CAAW,aAAc,CAAA;AAAA,UACvB,IAAM,EAAA,SAAA;AAAA,UACN,KAAO,EAAA,iBAAA;AAAA,SACR,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { LoggerService, PermissionsService, DiscoveryService, HttpAuthService } from '@backstage/backend-plugin-api';
+import { Config } from '@backstage/config';
+import express from 'express';
+
+/** @public */
+interface RouterOptions {
+    logger: LoggerService;
+    config: Config;
+    permissions: PermissionsService;
+    discovery: DiscoveryService;
+    httpAuth?: HttpAuthService;
+}
+/** @public */
+declare function createRouter(options: RouterOptions): Promise<express.Router>;
+
+/**
+ * blackduckPlugin backend plugin
+ *
+ * @public
+ */
+declare const blackduckPlugin: _backstage_backend_plugin_api.BackendFeatureCompat;
+
+export { type RouterOptions, createRouter, blackduckPlugin as default };

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@backstage-community/plugin-blackduck-backend",
+  "version": "0.0.1",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/community-plugins",
+    "directory": "workspaces/blackduck/plugins/blackduck-backend"
+  },
+  "backstage": {
+    "role": "backend-plugin",
+    "pluginId": "blackduck",
+    "pluginPackages": [
+      "@backstage-community/plugin-blackduck",
+      "@backstage-community/plugin-blackduck-backend",
+      "@backstage-community/plugin-blackduck-common"
+    ]
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage-community/plugin-blackduck-common": "^0.0.1",
+    "@backstage/backend-common": "^0.23.3",
+    "@backstage/backend-defaults": "^0.4.0",
+    "@backstage/backend-plugin-api": "^0.7.0",
+    "@backstage/config": "^1.2.0",
+    "@backstage/errors": "^1.2.4",
+    "@backstage/plugin-permission-common": "^0.8.0",
+    "@backstage/plugin-permission-node": "^0.8.0",
+    "express": "^4.17.1",
+    "express-promise-router": "^4.1.0",
+    "node-fetch": "^2.6.7"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^0.4.4",
+    "@backstage/cli": "^0.26.11",
+    "@backstage/plugin-auth-backend": "^0.22.9",
+    "@backstage/plugin-auth-backend-module-guest-provider": "^0.1.8",
+    "@types/express": "*",
+    "@types/supertest": "^2.0.12",
+    "msw": "^2.3.1",
+    "supertest": "^6.2.4"
+  },
+  "files": [
+    "dist"
+  ]
+}