@backstage-community/plugin-blackduck-backend 0.3.0 → 0.3.2

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 CHANGED
@@ -1,5 +1,23 @@
1
1
  # @backstage-community/plugin-blackduck-backend
2
2
 
3
+ ## 0.3.2
4
+
5
+ ### Patch Changes
6
+
7
+ - 455a018: Fixed a bug when the project name contains special characters and also fixed typos in log messages
8
+
9
+ ## 0.3.1
10
+
11
+ ### Patch Changes
12
+
13
+ - 638b35b: Added `@backstage-community/plugin-blackduck-node` as dependency
14
+
15
+ **BREAKING** `BlackDuckConfig` & `BlackDuckHostConfig` are moved to `@backstage-community/plugin-blackduck-node` package.
16
+
17
+ - Updated dependencies [638b35b]
18
+ - @backstage-community/plugin-blackduck-common@0.2.1
19
+ - @backstage-community/plugin-blackduck-node@0.0.1
20
+
3
21
  ## 0.3.0
4
22
 
5
23
  ### Minor Changes
package/dist/index.cjs.js CHANGED
@@ -3,12 +3,10 @@
3
3
  Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var router = require('./service/router.cjs.js');
6
- var BlackDuckConfig = require('./service/BlackDuckConfig.cjs.js');
7
6
  var plugin = require('./plugin.cjs.js');
8
7
 
9
8
 
10
9
 
11
10
  exports.createRouter = router.createRouter;
12
- exports.BlackDuckConfig = BlackDuckConfig.BlackDuckConfig;
13
11
  exports.default = plugin.blackduckPlugin;
14
12
  //# sourceMappingURL=index.cjs.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;"}
1
+ {"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}
package/dist/index.d.ts CHANGED
@@ -1,27 +1,5 @@
1
- import { Config } from '@backstage/config';
2
1
  import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
3
2
 
4
- /**
5
- * @public
6
- */
7
- interface BlackDuckHostConfig {
8
- name: string;
9
- host: string;
10
- token: string;
11
- }
12
- /**
13
- * blackduckPlugin config
14
- *
15
- * @public
16
- */
17
- declare class BlackDuckConfig {
18
- private readonly hosts;
19
- private readonly defaultHost;
20
- constructor(hosts: BlackDuckHostConfig[], defaultHost: string);
21
- static fromConfig(config: Config): BlackDuckConfig;
22
- getHostConfigByName(name: string): BlackDuckHostConfig;
23
- }
24
-
25
3
  /**
26
4
  * blackduckPlugin backend plugin
27
5
  *
@@ -29,4 +7,4 @@ declare class BlackDuckConfig {
29
7
  */
30
8
  declare const blackduckPlugin: _backstage_backend_plugin_api.BackendFeature;
31
9
 
32
- export { BlackDuckConfig, type BlackDuckHostConfig, blackduckPlugin as default };
10
+ export { blackduckPlugin as default };
@@ -1,7 +1,7 @@
1
1
  'use strict';
2
2
 
3
3
  var backendPluginApi = require('@backstage/backend-plugin-api');
4
- var BlackDuckConfig = require('./service/BlackDuckConfig.cjs.js');
4
+ var pluginBlackduckNode = require('@backstage-community/plugin-blackduck-node');
5
5
  var router = require('./service/router.cjs.js');
6
6
 
7
7
  const blackduckPlugin = backendPluginApi.createBackendPlugin({
@@ -29,9 +29,8 @@ const blackduckPlugin = backendPluginApi.createBackendPlugin({
29
29
  logger,
30
30
  config,
31
31
  permissions,
32
- discovery,
33
32
  httpAuth,
34
- blackDuckConfig: BlackDuckConfig.BlackDuckConfig.fromConfig(config)
33
+ blackDuckConfig: pluginBlackduckNode.BlackDuckConfig.fromConfig(config)
35
34
  })
36
35
  );
37
36
  httpRouter.addAuthPolicy({
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { BlackDuckConfig } from './service/BlackDuckConfig';\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 blackDuckConfig: BlackDuckConfig.fromConfig(config),\n }),\n );\n httpRouter.addAuthPolicy({\n path: '/health',\n allow: 'unauthenticated',\n });\n },\n });\n },\n});\n"],"names":["createBackendPlugin","coreServices","createRouter","BlackDuckConfig"],"mappings":";;;;;;AA2BO,MAAM,kBAAkBA,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;AAAA,OACzB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,UAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,WAAA;AAAA,QACA,SAAA;AAAA,QACA;AAAA,OACC,EAAA;AACD,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,mBAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,MAAA;AAAA,YACA,WAAA;AAAA,YACA,SAAA;AAAA,YACA,QAAA;AAAA,YACA,eAAA,EAAiBC,+BAAgB,CAAA,UAAA,CAAW,MAAM;AAAA,WACnD;AAAA,SACH;AACA,QAAA,UAAA,CAAW,aAAc,CAAA;AAAA,UACvB,IAAM,EAAA,SAAA;AAAA,UACN,KAAO,EAAA;AAAA,SACR,CAAA;AAAA;AACH,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}
1
+ {"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { BlackDuckConfig } from '@backstage-community/plugin-blackduck-node';\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 blackDuckConfig: BlackDuckConfig.fromConfig(config),\n }),\n );\n httpRouter.addAuthPolicy({\n path: '/health',\n allow: 'unauthenticated',\n });\n },\n });\n },\n});\n"],"names":["createBackendPlugin","coreServices","createRouter","BlackDuckConfig"],"mappings":";;;;;;AA2BO,MAAM,kBAAkBA,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;AAAA,OACzB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,UAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,WAAA;AAAA,QACA,SAAA;AAAA,QACA;AAAA,OACC,EAAA;AACD,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,mBAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,MAAA;AAAA,YACA,WAAA;AAAA,YAEA,QAAA;AAAA,YACA,eAAA,EAAiBC,mCAAgB,CAAA,UAAA,CAAW,MAAM;AAAA,WACnD;AAAA,SACH;AACA,QAAA,UAAA,CAAW,aAAc,CAAA;AAAA,UACvB,IAAM,EAAA,SAAA;AAAA,UACN,KAAO,EAAA;AAAA,SACR,CAAA;AAAA;AACH,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}
@@ -7,7 +7,7 @@ var pluginPermissionNode = require('@backstage/plugin-permission-node');
7
7
  var errors = require('@backstage/errors');
8
8
  var pluginPermissionCommon = require('@backstage/plugin-permission-common');
9
9
  var pluginBlackduckCommon = require('@backstage-community/plugin-blackduck-common');
10
- var BlackDuckRestApi = require('../api/BlackDuckRestApi.cjs.js');
10
+ var pluginBlackduckNode = require('@backstage-community/plugin-blackduck-node');
11
11
 
12
12
  function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
13
13
 
@@ -70,7 +70,7 @@ async function createRouter(options) {
70
70
  if (decision.result !== pluginPermissionCommon.AuthorizeResult.ALLOW) {
71
71
  throw new errors.NotAllowedError("Unauthorized");
72
72
  }
73
- const blackDuck = new BlackDuckRestApi.BlackDuckRestApi(logger, host, token);
73
+ const blackDuck = new pluginBlackduckNode.BlackDuckRestApi(logger, host, token);
74
74
  await blackDuck.auth();
75
75
  const risk_profile = await blackDuck.getRiskProfile(
76
76
  projectName,
@@ -122,7 +122,7 @@ async function createRouter(options) {
122
122
  if (decision.result !== pluginPermissionCommon.AuthorizeResult.ALLOW) {
123
123
  throw new errors.NotAllowedError("Unauthorized");
124
124
  }
125
- const blackDuck = new BlackDuckRestApi.BlackDuckRestApi(logger, host, token);
125
+ const blackDuck = new pluginBlackduckNode.BlackDuckRestApi(logger, host, token);
126
126
  await blackDuck.auth();
127
127
  const vulns = await blackDuck.getVulnerableComponents(
128
128
  projectName,
@@ -1 +1 @@
1
- {"version":3,"file":"router.cjs.js","sources":["../../src/service/router.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { 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 {\n blackduckPermissions,\n blackduckRiskProfileReadPermission,\n blackduckVulnerabilitiesReadPermission,\n} from '@backstage-community/plugin-blackduck-common';\nimport { BlackDuckRestApi } from '../api/BlackDuckRestApi';\nimport { BlackDuckConfig } from './BlackDuckConfig';\n\n/** @internal */\nexport interface RouterOptions {\n logger: LoggerService;\n config: Config;\n permissions: PermissionsService;\n discovery: DiscoveryService;\n httpAuth: HttpAuthService;\n blackDuckConfig: BlackDuckConfig;\n}\n\n/** @internal */\nexport async function createRouter(\n options: RouterOptions,\n): Promise<express.Router> {\n const { logger, permissions, config, blackDuckConfig, httpAuth } = options;\n const permissionIntegrationRouter = createPermissionIntegrationRouter({\n permissions: blackduckPermissions,\n });\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/:hostKey/:projectName/:projectVersion',\n async (_request, response) => {\n logger.debug('getting vulnarabilities..');\n const { hostKey, projectName, projectVersion } = _request.params;\n\n if (!hostKey || !projectName || !projectVersion) {\n response.status(400).json({\n message: 'The hostKey, projectName and projectVersion are required',\n });\n return;\n }\n\n let host: string;\n let token: string;\n\n try {\n const hostConfig = blackDuckConfig.getHostConfigByName(hostKey);\n host = hostConfig.host;\n token = hostConfig.token;\n } catch (error) {\n response.status(400).json({\n message: 'The hostKey is not valid.',\n });\n return;\n }\n\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 const blackDuck = new BlackDuckRestApi(logger, host, token);\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/:hostKey/:projectName/:projectVersion',\n async (_request, response) => {\n const { hostKey, projectName, projectVersion } = _request.params;\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 if (!hostKey || !projectName || !projectVersion) {\n response.status(400).json({\n message: 'The hostKey, projectName and projectVersion are required',\n });\n return;\n }\n\n let host: string;\n let token: string;\n\n try {\n const hostConfig = blackDuckConfig.getHostConfigByName(hostKey);\n host = hostConfig.host;\n token = hostConfig.token;\n } catch (error) {\n response.status(400).json({\n message: 'The hostKey is not valid.',\n });\n return;\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 const blackDuck = new BlackDuckRestApi(logger, host, token);\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"],"names":["createPermissionIntegrationRouter","blackduckPermissions","Router","express","MiddlewareFactory","InputError","blackduckRiskProfileReadPermission","AuthorizeResult","NotAllowedError","BlackDuckRestApi","blackduckVulnerabilitiesReadPermission"],"mappings":";;;;;;;;;;;;;;;;AA+CA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,MAAM,EAAE,MAAQ,EAAA,WAAA,EAAa,MAAQ,EAAA,eAAA,EAAiB,UAAa,GAAA,OAAA;AACnE,EAAA,MAAM,8BAA8BA,sDAAkC,CAAA;AAAA,IACpE,WAAa,EAAAC;AAAA,GACd,CAAA;AAED,EAAA,MAAM,SAASC,uBAAO,EAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA;AACzB,EAAA,MAAA,CAAO,IAAI,2BAA2B,CAAA;AAEtC,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,CAAC,CAAA,EAAG,QAAa,KAAA;AACrC,IAAA,MAAA,CAAO,KAAK,OAAO,CAAA;AACnB,IAAA,QAAA,CAAS,IAAK,CAAA,EAAE,MAAQ,EAAA,IAAA,EAAM,CAAA;AAAA,GAC/B,CAAA;AAED,EAAA,MAAM,aAAaC,gCAAkB,CAAA,MAAA,CAAO,EAAE,MAAA,EAAQ,QAAQ,CAAA;AAE9D,EAAO,MAAA,CAAA,IAAA;AAAA,IACL,qDAAA;AAAA,IACA,OAAO,UAAU,QAAa,KAAA;AAC5B,MAAA,MAAA,CAAO,MAAM,2BAA2B,CAAA;AACxC,MAAA,MAAM,EAAE,OAAA,EAAS,WAAa,EAAA,cAAA,KAAmB,QAAS,CAAA,MAAA;AAE1D,MAAA,IAAI,CAAC,OAAA,IAAW,CAAC,WAAA,IAAe,CAAC,cAAgB,EAAA;AAC/C,QAAS,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,UACxB,OAAS,EAAA;AAAA,SACV,CAAA;AACD,QAAA;AAAA;AAGF,MAAI,IAAA,IAAA;AACJ,MAAI,IAAA,KAAA;AAEJ,MAAI,IAAA;AACF,QAAM,MAAA,UAAA,GAAa,eAAgB,CAAA,mBAAA,CAAoB,OAAO,CAAA;AAC9D,QAAA,IAAA,GAAO,UAAW,CAAA,IAAA;AAClB,QAAA,KAAA,GAAQ,UAAW,CAAA,KAAA;AAAA,eACZ,KAAO,EAAA;AACd,QAAS,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,UACxB,OAAS,EAAA;AAAA,SACV,CAAA;AACD,QAAA;AAAA;AAGF,MAAA,MAAM,WAAc,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,QAAQ,CAAA;AACvD,MAAM,MAAA,SAAA,GAAY,SAAS,IAAK,CAAA,SAAA;AAChC,MAAO,MAAA,CAAA,IAAA,CAAK,sCAAsC,SAAS,CAAA;AAC3D,MAAI,IAAA,OAAO,cAAc,QAAU,EAAA;AACjC,QAAM,MAAA,IAAIC,kBAAW,iCAAiC,CAAA;AAAA;AAGxD,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,WAAY,CAAA,SAAA;AAAA,QAChB;AAAA,UACE;AAAA,YACE,UAAY,EAAAC,wDAAA;AAAA,YACZ,WAAa,EAAA;AAAA;AACf,SACF;AAAA,QACA;AAAA,UACE;AAAA;AACF,SAEF,CAAC,CAAA;AAEH,MAAI,IAAA,QAAA,CAAS,MAAW,KAAAC,sCAAA,CAAgB,KAAO,EAAA;AAC7C,QAAM,MAAA,IAAIC,uBAAgB,cAAc,CAAA;AAAA;AAG1C,MAAA,MAAM,SAAY,GAAA,IAAIC,iCAAiB,CAAA,MAAA,EAAQ,MAAM,KAAK,CAAA;AAE1D,MAAA,MAAM,UAAU,IAAK,EAAA;AACrB,MAAM,MAAA,YAAA,GAAe,MAAM,SAAU,CAAA,cAAA;AAAA,QACnC,WAAA;AAAA,QACA;AAAA,OACF;AACA,MAAA,QAAA,CAAS,KAAK,YAAY,CAAA;AAAA;AAC5B,GACF;AAEA,EAAO,MAAA,CAAA,IAAA;AAAA,IACL,8CAAA;AAAA,IACA,OAAO,UAAU,QAAa,KAAA;AAC5B,MAAA,MAAM,EAAE,OAAA,EAAS,WAAa,EAAA,cAAA,KAAmB,QAAS,CAAA,MAAA;AAC1D,MAAA,MAAM,WAAc,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,QAAQ,CAAA;AACvD,MAAM,MAAA,SAAA,GAAY,SAAS,IAAK,CAAA,SAAA;AAChC,MAAO,MAAA,CAAA,IAAA,CAAK,yCAAyC,SAAS,CAAA;AAC9D,MAAI,IAAA,OAAO,cAAc,QAAU,EAAA;AACjC,QAAM,MAAA,IAAIJ,kBAAW,iCAAiC,CAAA;AAAA;AAGxD,MAAA,IAAI,CAAC,OAAA,IAAW,CAAC,WAAA,IAAe,CAAC,cAAgB,EAAA;AAC/C,QAAS,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,UACxB,OAAS,EAAA;AAAA,SACV,CAAA;AACD,QAAA;AAAA;AAGF,MAAI,IAAA,IAAA;AACJ,MAAI,IAAA,KAAA;AAEJ,MAAI,IAAA;AACF,QAAM,MAAA,UAAA,GAAa,eAAgB,CAAA,mBAAA,CAAoB,OAAO,CAAA;AAC9D,QAAA,IAAA,GAAO,UAAW,CAAA,IAAA;AAClB,QAAA,KAAA,GAAQ,UAAW,CAAA,KAAA;AAAA,eACZ,KAAO,EAAA;AACd,QAAS,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,UACxB,OAAS,EAAA;AAAA,SACV,CAAA;AACD,QAAA;AAAA;AAGF,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,WAAY,CAAA,SAAA;AAAA,QAChB;AAAA,UACE;AAAA,YACE,UAAY,EAAAK,4DAAA;AAAA,YACZ,WAAa,EAAA;AAAA;AACf,SACF;AAAA,QACA;AAAA,UACE;AAAA;AACF,SAEF,CAAC,CAAA;AACH,MAAO,MAAA,CAAA,IAAA,CAAK,YAAY,QAAQ,CAAA;AAChC,MAAI,IAAA,QAAA,CAAS,MAAW,KAAAH,sCAAA,CAAgB,KAAO,EAAA;AAC7C,QAAM,MAAA,IAAIC,uBAAgB,cAAc,CAAA;AAAA;AAG1C,MAAA,MAAM,SAAY,GAAA,IAAIC,iCAAiB,CAAA,MAAA,EAAQ,MAAM,KAAK,CAAA;AAE1D,MAAA,MAAM,UAAU,IAAK,EAAA;AACrB,MAAM,MAAA,KAAA,GAAQ,MAAM,SAAU,CAAA,uBAAA;AAAA,QAC5B,WAAA;AAAA,QACA;AAAA,OACF;AACA,MAAA,QAAA,CAAS,KAAK,KAAK,CAAA;AAAA;AACrB,GACF;AAEA,EAAO,MAAA,CAAA,GAAA,CAAI,UAAW,CAAA,KAAA,EAAO,CAAA;AAC7B,EAAO,OAAA,MAAA;AACT;;;;"}
1
+ {"version":3,"file":"router.cjs.js","sources":["../../src/service/router.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { 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 {\n blackduckPermissions,\n blackduckRiskProfileReadPermission,\n blackduckVulnerabilitiesReadPermission,\n} from '@backstage-community/plugin-blackduck-common';\nimport {\n BlackDuckRestApi,\n BlackDuckConfig,\n} from '@backstage-community/plugin-blackduck-node';\n\n/** @internal */\nexport interface RouterOptions {\n logger: LoggerService;\n config: Config;\n permissions: PermissionsService;\n discovery: DiscoveryService;\n httpAuth: HttpAuthService;\n blackDuckConfig: BlackDuckConfig;\n}\n\n/** @internal */\nexport async function createRouter(\n options: RouterOptions,\n): Promise<express.Router> {\n const { logger, permissions, config, blackDuckConfig, httpAuth } = options;\n const permissionIntegrationRouter = createPermissionIntegrationRouter({\n permissions: blackduckPermissions,\n });\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/:hostKey/:projectName/:projectVersion',\n async (_request, response) => {\n logger.debug('getting vulnarabilities..');\n const { hostKey, projectName, projectVersion } = _request.params;\n\n if (!hostKey || !projectName || !projectVersion) {\n response.status(400).json({\n message: 'The hostKey, projectName and projectVersion are required',\n });\n return;\n }\n\n let host: string;\n let token: string;\n\n try {\n const hostConfig = blackDuckConfig.getHostConfigByName(hostKey);\n host = hostConfig.host;\n token = hostConfig.token;\n } catch (error) {\n response.status(400).json({\n message: 'The hostKey is not valid.',\n });\n return;\n }\n\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 const blackDuck = new BlackDuckRestApi(logger, host, token);\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/:hostKey/:projectName/:projectVersion',\n async (_request, response) => {\n const { hostKey, projectName, projectVersion } = _request.params;\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 if (!hostKey || !projectName || !projectVersion) {\n response.status(400).json({\n message: 'The hostKey, projectName and projectVersion are required',\n });\n return;\n }\n\n let host: string;\n let token: string;\n\n try {\n const hostConfig = blackDuckConfig.getHostConfigByName(hostKey);\n host = hostConfig.host;\n token = hostConfig.token;\n } catch (error) {\n response.status(400).json({\n message: 'The hostKey is not valid.',\n });\n return;\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 const blackDuck = new BlackDuckRestApi(logger, host, token);\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"],"names":["createPermissionIntegrationRouter","blackduckPermissions","Router","express","MiddlewareFactory","InputError","blackduckRiskProfileReadPermission","AuthorizeResult","NotAllowedError","BlackDuckRestApi","blackduckVulnerabilitiesReadPermission"],"mappings":";;;;;;;;;;;;;;;;AAiDA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,MAAM,EAAE,MAAQ,EAAA,WAAA,EAAa,MAAQ,EAAA,eAAA,EAAiB,UAAa,GAAA,OAAA;AACnE,EAAA,MAAM,8BAA8BA,sDAAkC,CAAA;AAAA,IACpE,WAAa,EAAAC;AAAA,GACd,CAAA;AAED,EAAA,MAAM,SAASC,uBAAO,EAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA;AACzB,EAAA,MAAA,CAAO,IAAI,2BAA2B,CAAA;AAEtC,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,CAAC,CAAA,EAAG,QAAa,KAAA;AACrC,IAAA,MAAA,CAAO,KAAK,OAAO,CAAA;AACnB,IAAA,QAAA,CAAS,IAAK,CAAA,EAAE,MAAQ,EAAA,IAAA,EAAM,CAAA;AAAA,GAC/B,CAAA;AAED,EAAA,MAAM,aAAaC,gCAAkB,CAAA,MAAA,CAAO,EAAE,MAAA,EAAQ,QAAQ,CAAA;AAE9D,EAAO,MAAA,CAAA,IAAA;AAAA,IACL,qDAAA;AAAA,IACA,OAAO,UAAU,QAAa,KAAA;AAC5B,MAAA,MAAA,CAAO,MAAM,2BAA2B,CAAA;AACxC,MAAA,MAAM,EAAE,OAAA,EAAS,WAAa,EAAA,cAAA,KAAmB,QAAS,CAAA,MAAA;AAE1D,MAAA,IAAI,CAAC,OAAA,IAAW,CAAC,WAAA,IAAe,CAAC,cAAgB,EAAA;AAC/C,QAAS,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,UACxB,OAAS,EAAA;AAAA,SACV,CAAA;AACD,QAAA;AAAA;AAGF,MAAI,IAAA,IAAA;AACJ,MAAI,IAAA,KAAA;AAEJ,MAAI,IAAA;AACF,QAAM,MAAA,UAAA,GAAa,eAAgB,CAAA,mBAAA,CAAoB,OAAO,CAAA;AAC9D,QAAA,IAAA,GAAO,UAAW,CAAA,IAAA;AAClB,QAAA,KAAA,GAAQ,UAAW,CAAA,KAAA;AAAA,eACZ,KAAO,EAAA;AACd,QAAS,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,UACxB,OAAS,EAAA;AAAA,SACV,CAAA;AACD,QAAA;AAAA;AAGF,MAAA,MAAM,WAAc,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,QAAQ,CAAA;AACvD,MAAM,MAAA,SAAA,GAAY,SAAS,IAAK,CAAA,SAAA;AAChC,MAAO,MAAA,CAAA,IAAA,CAAK,sCAAsC,SAAS,CAAA;AAC3D,MAAI,IAAA,OAAO,cAAc,QAAU,EAAA;AACjC,QAAM,MAAA,IAAIC,kBAAW,iCAAiC,CAAA;AAAA;AAGxD,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,WAAY,CAAA,SAAA;AAAA,QAChB;AAAA,UACE;AAAA,YACE,UAAY,EAAAC,wDAAA;AAAA,YACZ,WAAa,EAAA;AAAA;AACf,SACF;AAAA,QACA;AAAA,UACE;AAAA;AACF,SAEF,CAAC,CAAA;AAEH,MAAI,IAAA,QAAA,CAAS,MAAW,KAAAC,sCAAA,CAAgB,KAAO,EAAA;AAC7C,QAAM,MAAA,IAAIC,uBAAgB,cAAc,CAAA;AAAA;AAG1C,MAAA,MAAM,SAAY,GAAA,IAAIC,oCAAiB,CAAA,MAAA,EAAQ,MAAM,KAAK,CAAA;AAE1D,MAAA,MAAM,UAAU,IAAK,EAAA;AACrB,MAAM,MAAA,YAAA,GAAe,MAAM,SAAU,CAAA,cAAA;AAAA,QACnC,WAAA;AAAA,QACA;AAAA,OACF;AACA,MAAA,QAAA,CAAS,KAAK,YAAY,CAAA;AAAA;AAC5B,GACF;AAEA,EAAO,MAAA,CAAA,IAAA;AAAA,IACL,8CAAA;AAAA,IACA,OAAO,UAAU,QAAa,KAAA;AAC5B,MAAA,MAAM,EAAE,OAAA,EAAS,WAAa,EAAA,cAAA,KAAmB,QAAS,CAAA,MAAA;AAC1D,MAAA,MAAM,WAAc,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,QAAQ,CAAA;AACvD,MAAM,MAAA,SAAA,GAAY,SAAS,IAAK,CAAA,SAAA;AAChC,MAAO,MAAA,CAAA,IAAA,CAAK,yCAAyC,SAAS,CAAA;AAC9D,MAAI,IAAA,OAAO,cAAc,QAAU,EAAA;AACjC,QAAM,MAAA,IAAIJ,kBAAW,iCAAiC,CAAA;AAAA;AAGxD,MAAA,IAAI,CAAC,OAAA,IAAW,CAAC,WAAA,IAAe,CAAC,cAAgB,EAAA;AAC/C,QAAS,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,UACxB,OAAS,EAAA;AAAA,SACV,CAAA;AACD,QAAA;AAAA;AAGF,MAAI,IAAA,IAAA;AACJ,MAAI,IAAA,KAAA;AAEJ,MAAI,IAAA;AACF,QAAM,MAAA,UAAA,GAAa,eAAgB,CAAA,mBAAA,CAAoB,OAAO,CAAA;AAC9D,QAAA,IAAA,GAAO,UAAW,CAAA,IAAA;AAClB,QAAA,KAAA,GAAQ,UAAW,CAAA,KAAA;AAAA,eACZ,KAAO,EAAA;AACd,QAAS,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,UACxB,OAAS,EAAA;AAAA,SACV,CAAA;AACD,QAAA;AAAA;AAGF,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,WAAY,CAAA,SAAA;AAAA,QAChB;AAAA,UACE;AAAA,YACE,UAAY,EAAAK,4DAAA;AAAA,YACZ,WAAa,EAAA;AAAA;AACf,SACF;AAAA,QACA;AAAA,UACE;AAAA;AACF,SAEF,CAAC,CAAA;AACH,MAAO,MAAA,CAAA,IAAA,CAAK,YAAY,QAAQ,CAAA;AAChC,MAAI,IAAA,QAAA,CAAS,MAAW,KAAAH,sCAAA,CAAgB,KAAO,EAAA;AAC7C,QAAM,MAAA,IAAIC,uBAAgB,cAAc,CAAA;AAAA;AAG1C,MAAA,MAAM,SAAY,GAAA,IAAIC,oCAAiB,CAAA,MAAA,EAAQ,MAAM,KAAK,CAAA;AAE1D,MAAA,MAAM,UAAU,IAAK,EAAA;AACrB,MAAM,MAAA,KAAA,GAAQ,MAAM,SAAU,CAAA,uBAAA;AAAA,QAC5B,WAAA;AAAA,QACA;AAAA,OACF;AACA,MAAA,QAAA,CAAS,KAAK,KAAK,CAAA;AAAA;AACrB,GACF;AAEA,EAAO,MAAA,CAAA,GAAA,CAAI,UAAW,CAAA,KAAA,EAAO,CAAA;AAC7B,EAAO,OAAA,MAAA;AACT;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage-community/plugin-blackduck-backend",
3
- "version": "0.3.0",
3
+ "version": "0.3.2",
4
4
  "main": "dist/index.cjs.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "license": "Apache-2.0",
@@ -20,7 +20,8 @@
20
20
  "pluginPackages": [
21
21
  "@backstage-community/plugin-blackduck",
22
22
  "@backstage-community/plugin-blackduck-backend",
23
- "@backstage-community/plugin-blackduck-common"
23
+ "@backstage-community/plugin-blackduck-common",
24
+ "@backstage-community/plugin-blackduck-node"
24
25
  ]
25
26
  },
26
27
  "scripts": {
@@ -33,7 +34,8 @@
33
34
  "postpack": "backstage-cli package postpack"
34
35
  },
35
36
  "dependencies": {
36
- "@backstage-community/plugin-blackduck-common": "^0.2.0",
37
+ "@backstage-community/plugin-blackduck-common": "^0.2.1",
38
+ "@backstage-community/plugin-blackduck-node": "^0.0.1",
37
39
  "@backstage/backend-defaults": "^0.7.0",
38
40
  "@backstage/backend-plugin-api": "^1.1.1",
39
41
  "@backstage/config": "^1.3.2",
@@ -1,134 +0,0 @@
1
- 'use strict';
2
-
3
- class BlackDuckRestApi {
4
- constructor(logger, host, token) {
5
- this.logger = logger;
6
- this.host = host;
7
- this.token = token;
8
- this._bearer = "";
9
- this._limit = 1e3;
10
- }
11
- _bearer;
12
- _limit;
13
- async auth() {
14
- try {
15
- const auth = await fetch(`${this.host}/tokens/authenticate`, {
16
- method: "POST",
17
- headers: {
18
- Authorization: `token ${this.token}`,
19
- Accept: "application/vnd.blackducksoftware.user-4+json",
20
- "Content-Type": "application/json"
21
- }
22
- });
23
- const token = await auth.json();
24
- this.logger.info("Auth Successfull");
25
- this._bearer = token.bearerToken;
26
- return token.bearerToken;
27
- } catch (error) {
28
- throw error;
29
- }
30
- }
31
- async getProjects(name) {
32
- const projects = await fetch(
33
- `${this.host}/projects?limit=999&q=name:${name}`,
34
- {
35
- method: "GET",
36
- headers: {
37
- Authorization: `Bearer ${this._bearer}`,
38
- Accept: "application/vnd.blackducksoftware.project-detail-4+json",
39
- "Content-Type": "application/json"
40
- }
41
- }
42
- );
43
- this.logger.debug("Retrived Projects!!");
44
- return projects.json();
45
- }
46
- async getVersions(projectUrl, versionName) {
47
- const versions = await fetch(
48
- `${projectUrl}/versions?limit=999&q=versionName:${versionName}`,
49
- {
50
- method: "GET",
51
- headers: {
52
- Authorization: `Bearer ${this._bearer}`,
53
- Accept: "application/vnd.blackducksoftware.project-detail-5+json",
54
- "Content-Type": "application/json"
55
- }
56
- }
57
- );
58
- this.logger.debug("Retrived Versions!!");
59
- return versions.json();
60
- }
61
- async getProjectVersionDetails(projectName, projectVersion) {
62
- let projectDetail;
63
- let versionDetail;
64
- const projects = await this.getProjects(
65
- projectName
66
- );
67
- projects.items.forEach((item) => {
68
- if (item.name === projectName) {
69
- projectDetail = item;
70
- }
71
- });
72
- if (projectDetail === void 0) {
73
- this.logger.error("Provide full project name");
74
- }
75
- this.logger.debug(`Fetched Project : ${projectName} details`);
76
- const versions = await this.getVersions(
77
- projectDetail._meta.href,
78
- projectVersion
79
- );
80
- versions.items.forEach((item) => {
81
- if (item.versionName === projectVersion) {
82
- versionDetail = item;
83
- }
84
- });
85
- if (versionDetail === void 0) {
86
- this.logger.error("Provide full version name");
87
- }
88
- this.logger.debug(
89
- `Fetched Project : ${projectName}, Version: ${projectVersion} details`
90
- );
91
- return versionDetail;
92
- }
93
- async getVulnerableComponents(projectName, projectVersion) {
94
- const versionDetail = await this.getProjectVersionDetails(
95
- projectName,
96
- projectVersion
97
- );
98
- const vuln_url = `${versionDetail._meta.href}/vulnerable-bom-components?limit=${this._limit}`;
99
- const vulns = await fetch(vuln_url, {
100
- method: "GET",
101
- headers: {
102
- Authorization: `Bearer ${this._bearer}`,
103
- Accept: "application/vnd.blackducksoftware.bill-of-materials-6+json",
104
- "Content-Type": "application/json"
105
- }
106
- });
107
- this.logger.debug(
108
- `Fetched Project : ${projectName}, Version: ${projectVersion} Vulnerable Components`
109
- );
110
- return vulns.json();
111
- }
112
- async getRiskProfile(projectName, projectVersion) {
113
- const versionDetail = await this.getProjectVersionDetails(
114
- projectName,
115
- projectVersion
116
- );
117
- const risk_profile_url = `${versionDetail._meta.href}/risk-profile`;
118
- const risk_profile = await fetch(risk_profile_url, {
119
- method: "GET",
120
- headers: {
121
- Authorization: `Bearer ${this._bearer}`,
122
- // Accept: 'application/vnd.blackducksoftware.component-detail-5+json',
123
- "Content-Type": "application/json"
124
- }
125
- });
126
- this.logger.debug(
127
- `Fetched Project : ${projectName}, Version: ${projectVersion} risk profile`
128
- );
129
- return risk_profile.json();
130
- }
131
- }
132
-
133
- exports.BlackDuckRestApi = BlackDuckRestApi;
134
- //# sourceMappingURL=BlackDuckRestApi.cjs.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"BlackDuckRestApi.cjs.js","sources":["../../src/api/BlackDuckRestApi.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { 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"],"names":[],"mappings":";;AAwBO,MAAM,gBAAiB,CAAA;AAAA,EAGrB,WAAA,CACY,MACA,EAAA,IAAA,EACA,KACjB,EAAA;AAHiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AACA,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA;AAEjB,IAAA,IAAA,CAAK,OAAU,GAAA,EAAA;AACf,IAAA,IAAA,CAAK,MAAS,GAAA,GAAA;AAAA;AAChB,EATQ,OAAA;AAAA,EACA,MAAA;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;AAAA;AAClB,OACD,CAAA;AACD,MAAM,MAAA,KAAA,GAAQ,MAAM,IAAA,CAAK,IAAK,EAAA;AAC9B,MAAK,IAAA,CAAA,MAAA,CAAO,KAAK,kBAAkB,CAAA;AACnC,MAAA,IAAA,CAAK,UAAU,KAAM,CAAA,WAAA;AACrB,MAAA,OAAO,KAAM,CAAA,WAAA;AAAA,aACN,KAAO,EAAA;AACd,MAAM,MAAA,KAAA;AAAA;AACR;AACF,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;AAAA;AAClB;AACF,KACF;AACA,IAAK,IAAA,CAAA,MAAA,CAAO,MAAM,qBAAqB,CAAA;AACvC,IAAA,OAAO,SAAS,IAAK,EAAA;AAAA;AACvB,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;AAAA;AAClB;AACF,KACF;AACA,IAAK,IAAA,CAAA,MAAA,CAAO,MAAM,qBAAqB,CAAA;AACvC,IAAA,OAAO,SAAS,IAAK,EAAA;AAAA;AACvB,EAEA,MAAa,wBACX,CAAA,WAAA,EACA,cACA,EAAA;AACA,IAAI,IAAA,aAAA;AACJ,IAAI,IAAA,aAAA;AACJ,IAAM,MAAA,QAAA,GAAqC,MAAM,IAAK,CAAA,WAAA;AAAA,MACpD;AAAA,KACF;AACA,IAAS,QAAA,CAAA,KAAA,CAAM,OAAQ,CAAA,CAAC,IAAc,KAAA;AACpC,MAAI,IAAA,IAAA,CAAK,SAAS,WAAa,EAAA;AAC7B,QAAgB,aAAA,GAAA,IAAA;AAAA;AAClB,KACD,CAAA;AACD,IAAA,IAAI,kBAAkB,KAAW,CAAA,EAAA;AAC/B,MAAK,IAAA,CAAA,MAAA,CAAO,MAAM,2BAA2B,CAAA;AAAA;AAE/C,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAqB,kBAAA,EAAA,WAAW,CAAU,QAAA,CAAA,CAAA;AAC5D,IAAM,MAAA,QAAA,GAAqC,MAAM,IAAK,CAAA,WAAA;AAAA,MACpD,cAAc,KAAM,CAAA,IAAA;AAAA,MACpB;AAAA,KACF;AACA,IAAS,QAAA,CAAA,KAAA,CAAM,OAAQ,CAAA,CAAC,IAAc,KAAA;AACpC,MAAI,IAAA,IAAA,CAAK,gBAAgB,cAAgB,EAAA;AACvC,QAAgB,aAAA,GAAA,IAAA;AAAA;AAClB,KACD,CAAA;AACD,IAAA,IAAI,kBAAkB,KAAW,CAAA,EAAA;AAC/B,MAAK,IAAA,CAAA,MAAA,CAAO,MAAM,2BAA2B,CAAA;AAAA;AAE/C,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAAA,kBAAA,EAAqB,WAAW,CAAA,WAAA,EAAc,cAAc,CAAA,QAAA;AAAA,KAC9D;AAEA,IAAO,OAAA,aAAA;AAAA;AACT,EAEA,MAAa,uBACX,CAAA,WAAA,EACA,cACA,EAAA;AACA,IAAM,MAAA,aAAA,GAAgB,MAAM,IAAK,CAAA,wBAAA;AAAA,MAC/B,WAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,MAAM,WAAW,CAAG,EAAA,aAAA,CAAc,MAAM,IAAI,CAAA,iCAAA,EAAoC,KAAK,MAAM,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;AAAA;AAClB,KACD,CAAA;AACD,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAAA,kBAAA,EAAqB,WAAW,CAAA,WAAA,EAAc,cAAc,CAAA,sBAAA;AAAA,KAC9D;AACA,IAAA,OAAO,MAAM,IAAK,EAAA;AAAA;AACpB,EAEA,MAAa,cAAe,CAAA,WAAA,EAAqB,cAAwB,EAAA;AACvE,IAAM,MAAA,aAAA,GAAgB,MAAM,IAAK,CAAA,wBAAA;AAAA,MAC/B,WAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,MAAM,gBAAmB,GAAA,CAAA,EAAG,aAAc,CAAA,KAAA,CAAM,IAAI,CAAA,aAAA,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;AAAA;AAClB,KACD,CAAA;AACD,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAAA,kBAAA,EAAqB,WAAW,CAAA,WAAA,EAAc,cAAc,CAAA,aAAA;AAAA,KAC9D;AACA,IAAA,OAAO,aAAa,IAAK,EAAA;AAAA;AAE7B;;;;"}
@@ -1,45 +0,0 @@
1
- 'use strict';
2
-
3
- const DEFAULT_HOST_NAME = "default";
4
- class BlackDuckConfig {
5
- constructor(hosts, defaultHost) {
6
- this.hosts = hosts;
7
- this.defaultHost = defaultHost;
8
- }
9
- static fromConfig(config) {
10
- let hosts = [];
11
- let defaultHost = DEFAULT_HOST_NAME;
12
- if (config.has("blackduck.host") && config.has("blackduck.hosts")) {
13
- throw new Error("Cannot have both blackduck.host and blackduck.hosts");
14
- }
15
- if (config.has("blackduck.host") && config.has("blackduck.token")) {
16
- const singleHost = {
17
- name: "default",
18
- host: config.getString("blackduck.host"),
19
- token: config.getString("blackduck.token")
20
- };
21
- hosts = [singleHost];
22
- } else if (config.has("blackduck.hosts") && config.has("blackduck.default")) {
23
- hosts = config.getConfigArray("blackduck.hosts").map((hostConfig) => ({
24
- name: hostConfig.getString("name"),
25
- host: hostConfig.getString("host"),
26
- token: hostConfig.getString("token")
27
- }));
28
- defaultHost = config.getString("blackduck.default");
29
- } else {
30
- throw new Error("Invalid BlackDuck config found");
31
- }
32
- return new BlackDuckConfig(hosts, defaultHost);
33
- }
34
- getHostConfigByName(name) {
35
- const hostName = name === DEFAULT_HOST_NAME ? this.defaultHost : name;
36
- const hostConfig = this.hosts.find((host) => host.name === hostName);
37
- if (!hostConfig) {
38
- throw new Error(`No host found with name: ${name}`);
39
- }
40
- return hostConfig;
41
- }
42
- }
43
-
44
- exports.BlackDuckConfig = BlackDuckConfig;
45
- //# sourceMappingURL=BlackDuckConfig.cjs.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"BlackDuckConfig.cjs.js","sources":["../../src/service/BlackDuckConfig.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { Config } from '@backstage/config';\n\n/**\n * @public\n */\nexport interface BlackDuckHostConfig {\n name: string;\n host: string;\n token: string;\n}\n\nconst DEFAULT_HOST_NAME = 'default';\n\n/**\n * blackduckPlugin config\n *\n * @public\n */\nexport class BlackDuckConfig {\n constructor(\n private readonly hosts: BlackDuckHostConfig[],\n private readonly defaultHost: string,\n ) {}\n\n static fromConfig(config: Config): BlackDuckConfig {\n let hosts: BlackDuckHostConfig[] = [];\n let defaultHost: string = DEFAULT_HOST_NAME;\n\n if (config.has('blackduck.host') && config.has('blackduck.hosts')) {\n throw new Error('Cannot have both blackduck.host and blackduck.hosts');\n }\n\n if (config.has('blackduck.host') && config.has('blackduck.token')) {\n const singleHost = {\n name: 'default',\n host: config.getString('blackduck.host'),\n token: config.getString('blackduck.token'),\n };\n hosts = [singleHost];\n } else if (\n config.has('blackduck.hosts') &&\n config.has('blackduck.default')\n ) {\n hosts = config.getConfigArray('blackduck.hosts').map(hostConfig => ({\n name: hostConfig.getString('name'),\n host: hostConfig.getString('host'),\n token: hostConfig.getString('token'),\n }));\n defaultHost = config.getString('blackduck.default');\n } else {\n throw new Error('Invalid BlackDuck config found');\n }\n\n return new BlackDuckConfig(hosts, defaultHost);\n }\n\n getHostConfigByName(name: string): BlackDuckHostConfig {\n const hostName = name === DEFAULT_HOST_NAME ? this.defaultHost : name;\n\n const hostConfig = this.hosts.find(host => host.name === hostName);\n\n if (!hostConfig) {\n throw new Error(`No host found with name: ${name}`);\n }\n\n return hostConfig;\n }\n}\n"],"names":[],"mappings":";;AA0BA,MAAM,iBAAoB,GAAA,SAAA;AAOnB,MAAM,eAAgB,CAAA;AAAA,EAC3B,WAAA,CACmB,OACA,WACjB,EAAA;AAFiB,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA;AACA,IAAA,IAAA,CAAA,WAAA,GAAA,WAAA;AAAA;AAChB,EAEH,OAAO,WAAW,MAAiC,EAAA;AACjD,IAAA,IAAI,QAA+B,EAAC;AACpC,IAAA,IAAI,WAAsB,GAAA,iBAAA;AAE1B,IAAA,IAAI,OAAO,GAAI,CAAA,gBAAgB,KAAK,MAAO,CAAA,GAAA,CAAI,iBAAiB,CAAG,EAAA;AACjE,MAAM,MAAA,IAAI,MAAM,qDAAqD,CAAA;AAAA;AAGvE,IAAA,IAAI,OAAO,GAAI,CAAA,gBAAgB,KAAK,MAAO,CAAA,GAAA,CAAI,iBAAiB,CAAG,EAAA;AACjE,MAAA,MAAM,UAAa,GAAA;AAAA,QACjB,IAAM,EAAA,SAAA;AAAA,QACN,IAAA,EAAM,MAAO,CAAA,SAAA,CAAU,gBAAgB,CAAA;AAAA,QACvC,KAAA,EAAO,MAAO,CAAA,SAAA,CAAU,iBAAiB;AAAA,OAC3C;AACA,MAAA,KAAA,GAAQ,CAAC,UAAU,CAAA;AAAA,KACrB,MAAA,IACE,OAAO,GAAI,CAAA,iBAAiB,KAC5B,MAAO,CAAA,GAAA,CAAI,mBAAmB,CAC9B,EAAA;AACA,MAAA,KAAA,GAAQ,MAAO,CAAA,cAAA,CAAe,iBAAiB,CAAA,CAAE,IAAI,CAAe,UAAA,MAAA;AAAA,QAClE,IAAA,EAAM,UAAW,CAAA,SAAA,CAAU,MAAM,CAAA;AAAA,QACjC,IAAA,EAAM,UAAW,CAAA,SAAA,CAAU,MAAM,CAAA;AAAA,QACjC,KAAA,EAAO,UAAW,CAAA,SAAA,CAAU,OAAO;AAAA,OACnC,CAAA,CAAA;AACF,MAAc,WAAA,GAAA,MAAA,CAAO,UAAU,mBAAmB,CAAA;AAAA,KAC7C,MAAA;AACL,MAAM,MAAA,IAAI,MAAM,gCAAgC,CAAA;AAAA;AAGlD,IAAO,OAAA,IAAI,eAAgB,CAAA,KAAA,EAAO,WAAW,CAAA;AAAA;AAC/C,EAEA,oBAAoB,IAAmC,EAAA;AACrD,IAAA,MAAM,QAAW,GAAA,IAAA,KAAS,iBAAoB,GAAA,IAAA,CAAK,WAAc,GAAA,IAAA;AAEjE,IAAA,MAAM,aAAa,IAAK,CAAA,KAAA,CAAM,KAAK,CAAQ,IAAA,KAAA,IAAA,CAAK,SAAS,QAAQ,CAAA;AAEjE,IAAA,IAAI,CAAC,UAAY,EAAA;AACf,MAAA,MAAM,IAAI,KAAA,CAAM,CAA4B,yBAAA,EAAA,IAAI,CAAE,CAAA,CAAA;AAAA;AAGpD,IAAO,OAAA,UAAA;AAAA;AAEX;;;;"}