@axway/axway-central-cli 3.10.0-rc.6 → 3.11.0-rc.0

package/.security-profile-latest.json

@@ -0,0 +1,18 @@
+{
+	"version": "1.0",
+	"project": "Amplify - APIC CLI",
+	"repo_url": "https://git.ecd.axway.org/apigov/apicentral-cli",
+	"security_guide": "https://docs.axway.com/bundle/axway_resources/page/amplify_api_management_platform_security_white_paper.html",
+	"requirements": {
+		"fortify": false,
+		"irius-risk": false,
+		"pentest": false,
+		"twistlock": false,
+		"blackduck": true,
+		"third-party-policy-violation": false,
+		"appspider": false,
+		"insightvm": false
+	},
+	"suppressions": [
+	]
+}

package/dist/commands/install/agents.js

@@ -34,6 +34,7 @@ var softwareAGWebMethodsAgent = _interopRequireWildcard(require("./softwareAGWeb
 var traceableAgent = _interopRequireWildcard(require("./traceableAgents"));
 var platform = _interopRequireWildcard(require("./platform"));
 var backstageAgent = _interopRequireWildcard(require("./backstageAgents"));
+var sapApiPortalAgent = _interopRequireWildcard(require("./sapApiPortalAgents"));
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
@@ -59,7 +60,8 @@ const agentInstallFlows = {
   [_types.GatewayTypes.IBMAPICONNECT]: ibmAPIConnectAgent.IBMAPIConnectInstallMethods,
   [_types.GatewayTypes.SOFTWAREAGWEBMETHODS]: softwareAGWebMethodsAgent.SoftwareAGWebMethodsInstallMethods,
   [_types.GatewayTypes.TRACEABLE]: traceableAgent.TraceableInstallMethods,
-  [_types.GatewayTypes.BACKSTAGE]: backstageAgent.BackstageInstallMethods
+  [_types.GatewayTypes.BACKSTAGE]: backstageAgent.BackstageInstallMethods,
+  [_types.GatewayTypes.SAPAPIPORTAL]: sapApiPortalAgent.SAPAPIPortalInstallMethods
 };
 const saasAgentInstallFlows = {
   [_types.SaaSGatewayTypes.AWS_GATEWAY]: awsSaaSAgents.AWSSaaSInstallMethods,

package/dist/commands/install/awsAgents.js

@@ -20,6 +20,7 @@ const {
 } = (0, _snooplogg.default)('central: install: agents: aws');
 const daImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.AWS_DA}`;
 const taImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.AWS_TA}`;
+const STAGE_TAG_NAME_LENGTH = 127;
 
 // DeploymentTypes - ways the agents may be deployed with an AWS APIGW setup
 let DeploymentTypes = exports.DeploymentTypes = /*#__PURE__*/function (DeploymentTypes) {
@@ -66,6 +67,7 @@ const AWSPrompts = exports.AWSPrompts = {
   CONFIG_BUCKET_EXISTS: 'Does this bucket already exist on AWS, or will you create beforehand?',
   CONFIG_SERVICE: 'Do you want to setup config service?',
   DA_LOG_GROUP: 'Enter the log group name the discovery agent will log to',
+  STAGE_TAG_NAME: 'Enter the name of the tag on AWS API Gateway Stage that holds mapped stage on Amplify Central',
   DA_QUEUE: 'Enter the discovery queue name',
   DEPLOYMENT: 'Select the type of deployment you wish to configure',
   EC2_TYPE: 'Select the EC2 instance type',
@@ -276,6 +278,13 @@ const gatewayConnectivity = async installConfig => {
   awsAgentValues.logGroup = apiGWTrafficLogGroupName;
   awsAgentValues.cloudFormationConfig.APIGWTrafficLogGroupName = apiGWTrafficLogGroupName;
 
+  // StageTagName
+  const stageTagName = await (0, _basicPrompts.askInput)({
+    msg: AWSPrompts.STAGE_TAG_NAME,
+    validate: (0, _basicPrompts.validateInputLength)(STAGE_TAG_NAME_LENGTH, "Maximum length of 'stage tag name' is 127")
+  });
+  awsAgentValues.stageTagName = stageTagName;
+
   // FullTransactionLogging
   const fullTransactionLogging = (await (0, _basicPrompts.askList)({
     msg: AWSPrompts.FULL_TRANSACTION_LOGGING,

package/dist/commands/install/awsSaasAgents.js

@@ -21,6 +21,7 @@ function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e =
 const {
   log
 } = (0, _snooplogg.default)('central: install: agents: saas');
+const STAGE_TAG_NAME_LENGTH = 127;
 class DataplaneConfig {
   constructor(type) {
     _defineProperty(this, "type", void 0);
@@ -108,6 +109,7 @@ class SaasAWSAgentValues extends SaasAgentValues {
     _defineProperty(this, "externalID", void 0);
     _defineProperty(this, "accessLogARN", void 0);
     _defineProperty(this, "fullTransactionLogging", void 0);
+    _defineProperty(this, "stageTagName", void 0);
     this.authType = AWSAuthType.ASSUME;
     this.accessKey = '';
     this.secretKey = '';
@@ -116,6 +118,7 @@ class SaasAWSAgentValues extends SaasAgentValues {
     this.externalID = '';
     this.accessLogARN = '';
     this.fullTransactionLogging = false;
+    this.stageTagName = '';
   }
   getAccessData() {
     let data = JSON.stringify({
@@ -150,6 +153,7 @@ const SaasPrompts = {
   ASSUME_ROLE: 'Enter the Role ARN that the agent will Assume',
   EXTERNAL_ID: 'Enter the External ID the Assume Role expects',
   ACCESS_LOG_ARN: 'Enter the ARN for the Access Log that the Discovery will add and the Traceability will use',
+  STAGE_TAG_NAME: 'Enter the name of the tag on AWS API Gateway Stage that holds mapped stage on Amplify Central',
   FULL_TRANSACTION_LOGGING: 'Do you want to enable Full Transaction Logging? Please note that CloudWatch costs would increase when Full Transaction Logging is enabled',
   DA_FREQUENCY: 'How often should the discovery run, leave blank for integrating in CI/CD process',
   DA_FILTER: 'Please enter the filter conditions for discovery of API Services based on tags',
@@ -335,6 +339,10 @@ const gatewayConnectivity = async installConfig => {
     // AWS connection details
     hostedAgentValues = new SaasAWSAgentValues();
     hostedAgentValues = await askForAWSCredentials(hostedAgentValues);
+    hostedAgentValues.stageTagName = await (0, _basicPrompts.askInput)({
+      msg: SaasPrompts.STAGE_TAG_NAME,
+      validate: (0, _basicPrompts.validateInputLength)(STAGE_TAG_NAME_LENGTH, "Maximum length of 'stage tag name' is 127")
+    });
     if (installConfig.switches.isTaEnabled) {
       console.log(_chalk.default.gray('\nThe access log ARN is a cloud watch log group amazon resource name'));
       hostedAgentValues.accessLogARN = await (0, _basicPrompts.askInput)({
@@ -403,12 +411,59 @@ const completeInstall = async (installConfig, apiServerClient, defsManager) => {
    */
   console.log('\n');
   let awsAgentValues = installConfig.gatewayConfig;
-
+  let resourceFuncsForCleanup = [];
+  let referencedIDPs = [];
+  let providedIDPs = installConfig.idpConfig[0];
+  let providedIDPAuths = installConfig.idpConfig[1];
+  // create Identity Provider resource
+  try {
+    for (let i = 0; i < providedIDPs.length; i++) {
+      let idpResource = await helpers.createNewIDPResource(apiServerClient, defsManager, providedIDPs[i]);
+      let cleanupFunc = async () => await helpers.deleteByResourceType(apiServerClient, defsManager, idpResource === null || idpResource === void 0 ? void 0 : idpResource.name, 'IdentityProvider', 'idp');
+      resourceFuncsForCleanup.push(cleanupFunc);
+      referencedIDPs.push({
+        name: idpResource === null || idpResource === void 0 ? void 0 : idpResource.name
+      });
+      log(idpResource);
+      let encryptedAccessData = await createEncryptedAccessData(providedIDPAuths[i], idpResource);
+      providedIDPAuths[i].setAccessData(encryptedAccessData);
+      let idpSecResource = await helpers.createNewIDPSecretResource(apiServerClient, defsManager, providedIDPAuths[i], idpResource);
+      let anotherCleanupFunc = async () => await helpers.deleteByResourceType(apiServerClient, defsManager, idpSecResource === null || idpSecResource === void 0 ? void 0 : idpSecResource.name, 'IdentityProviderSecret', 'idpsec', idpResource === null || idpResource === void 0 ? void 0 : idpResource.name);
+      resourceFuncsForCleanup.push(anotherCleanupFunc);
+    }
+  } catch (error) {
+    log(error);
+    console.log(_chalk.default.redBright('rolling back installation. Could not create the Identity Provider resources'));
+    await cleanResources(resourceFuncsForCleanup);
+    return;
+  }
+  let refIDPsSubResources = {
+    references: {
+      identityProviders: referencedIDPs
+    }
+  };
   // create the environment, if necessary
-  installConfig.centralConfig.environment = installConfig.centralConfig.ampcEnvInfo.isNew ? await helpers.createByResourceType(apiServerClient, defsManager, installConfig.centralConfig.ampcEnvInfo.name, 'Environment', 'env', {
-    axwayManaged: installConfig.centralConfig.axwayManaged,
-    production: installConfig.centralConfig.production
-  }) : installConfig.centralConfig.ampcEnvInfo.name;
+  if (installConfig.centralConfig.ampcEnvInfo.isNew) {
+    installConfig.centralConfig.environment = await helpers.createByResourceType(apiServerClient, defsManager, installConfig.centralConfig.ampcEnvInfo.name, 'Environment', 'env', {
+      axwayManaged: installConfig.centralConfig.axwayManaged,
+      production: installConfig.centralConfig.production
+    }, '', refIDPsSubResources);
+    let cleanupFunc = async () => await helpers.deleteByResourceType(apiServerClient, defsManager, installConfig.centralConfig.ampcEnvInfo.name, 'Environment', 'env');
+    resourceFuncsForCleanup.push(cleanupFunc);
+  } else {
+    // if the env exists, we simply update the references with the newly created IDPs, while preserving the existing IDP references
+    // In the case of any failure during the whole process, we return everything back to how it was before.
+    installConfig.centralConfig.environment = installConfig.centralConfig.ampcEnvInfo.name;
+    refIDPsSubResources.references.identityProviders.push(...installConfig.centralConfig.ampcEnvInfo.referencedIdentityProviders);
+    await helpers.updateSubResourceType(apiServerClient, defsManager, installConfig.centralConfig.ampcEnvInfo.name, 'Environment', 'env', '', refIDPsSubResources);
+    let oldIDPRef = {
+      references: {
+        identityProviders: installConfig.centralConfig.ampcEnvInfo.referencedIdentityProviders
+      }
+    };
+    let cleanupFunc = async () => await helpers.updateSubResourceType(apiServerClient, defsManager, installConfig.centralConfig.ampcEnvInfo.name, 'Environment', 'env', '', oldIDPRef);
+    resourceFuncsForCleanup.push(cleanupFunc);
+  }
   if (installConfig.gatewayType === _types.GatewayTypes.AWS_GATEWAY) {
     if (installConfig.switches.isTaEnabled) {
       awsAgentValues.dataplaneConfig = new AWSDataplaneConfig(awsAgentValues.accessLogARN, awsAgentValues.fullTransactionLogging);
@@ -418,18 +473,25 @@ const completeInstall = async (installConfig, apiServerClient, defsManager) => {
   }
 
   // create the data plane resource
-  let dataplaneRes = await helpers.createNewDataPlaneResource(apiServerClient, defsManager, installConfig.centralConfig.environment, _types.GatewayTypeToDataPlane[installConfig.gatewayType], awsAgentValues.dataplaneConfig);
+  let dataplaneRes;
+  try {
+    dataplaneRes = await helpers.createNewDataPlaneResource(apiServerClient, defsManager, installConfig.centralConfig.environment, _types.GatewayTypeToDataPlane[installConfig.gatewayType], awsAgentValues.dataplaneConfig);
+    let cleanupFunc = async () => await helpers.deleteByResourceType(apiServerClient, defsManager, dataplaneRes.name, 'Dataplane', 'dp', installConfig.centralConfig.environment);
+    resourceFuncsForCleanup.push(cleanupFunc);
+  } catch (error) {
+    console.log(_chalk.default.redBright('rolling back installation. Please check the configuration data before re-running install'));
+    await cleanResources(resourceFuncsForCleanup);
+    return;
+  }
 
   // create data plane secret resource
   try {
-    await helpers.createNewDataPlaneSecretResource(apiServerClient, defsManager, installConfig.centralConfig.environment, _types.GatewayTypeToDataPlane[installConfig.gatewayType], dataplaneRes.name, await createEncryptedAccessData(awsAgentValues, dataplaneRes));
+    let dataplaneSecretRes = await helpers.createNewDataPlaneSecretResource(apiServerClient, defsManager, installConfig.centralConfig.environment, _types.GatewayTypeToDataPlane[installConfig.gatewayType], dataplaneRes.name, await createEncryptedAccessData(awsAgentValues, dataplaneRes));
+    let cleanupFunc = async () => await helpers.deleteByResourceType(apiServerClient, defsManager, dataplaneSecretRes === null || dataplaneSecretRes === void 0 ? void 0 : dataplaneSecretRes.name, 'DataplaneSecret', 'dps', installConfig.centralConfig.environment);
+    resourceFuncsForCleanup.push(cleanupFunc);
   } catch (error) {
     console.log(_chalk.default.redBright('rolling back installation. Please check the credential data before re-running install'));
-    if (installConfig.centralConfig.ampcEnvInfo.isNew) {
-      await helpers.deleteByResourceType(apiServerClient, defsManager, installConfig.centralConfig.ampcEnvInfo.name, 'Environment', 'env');
-    } else {
-      await helpers.deleteByResourceType(apiServerClient, defsManager, dataplaneRes.name, 'Dataplane', 'dp', installConfig.centralConfig.environment);
-    }
+    await cleanResources(resourceFuncsForCleanup);
     return;
   }
 
@@ -450,6 +512,7 @@ const AWSSaaSInstallMethods = exports.AWSSaaSInstallMethods = {
   GetBundleType: askBundleType,
   GetDeploymentType: askConfigType,
   AskGatewayQuestions: gatewayConnectivity,
+  AddIDP: true,
   FinalizeGatewayInstall: completeInstall,
   ConfigFiles: [],
   AgentNameMap: {
@@ -466,4 +529,12 @@ const testables = exports.testables = {
   AWSAuthType,
   SaasPrompts,
   ConfigFiles
+};
+// These are useful because there are multiple resources created in a specific order and in case of failure, this goes through
+// everything that was created and deletes it one by one. It deletes the resources in opposite order because resources added
+// at the beginning might be referred by resources added afterwards
+const cleanResources = async cleanupFuncs => {
+  for (let i = cleanupFuncs.length - 1; i >= 0; i--) {
+    await cleanupFuncs[i]();
+  }
 };

package/dist/commands/install/helpers/index.js

@@ -259,7 +259,8 @@ const agentsDocsUrl = exports.agentsDocsUrl = {
   IBMAPICONNECT: '',
   SOFTWAREAGWEBMETHODS: '',
   TRACEABLE: '',
-  BACKSTAGE: ''
+  BACKSTAGE: '',
+  SAPAPIPORTAL: ''
 };
 
 // export * from './updaters';

package/dist/commands/install/helpers/regex.js

@@ -37,7 +37,8 @@ const AWSRegexPatterns = exports.AWSRegexPatterns = {
 
 // APIGEEXRegexPatterns - regex patters to validate user inputs
 const APIGEEXRegexPatterns = exports.APIGEEXRegexPatterns = {
-  APIGEEX_REGEXP_PROJECT_ID: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$'
+  APIGEEX_REGEXP_PROJECT_ID: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
+  APIGEEX_REGEXP_EMAIL_ADDRESS: '^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|.(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$'
 };
 
 // AzureRegexPatterns - regex patters to validate user inputs

package/dist/commands/install/helpers/templates/awsTemplates.js

@@ -17,6 +17,7 @@ class AWSAgentValues {
     _defineProperty(this, "accessKey", void 0);
     _defineProperty(this, "secretKey", void 0);
     _defineProperty(this, "logGroup", void 0);
+    _defineProperty(this, "stageTagName", void 0);
     _defineProperty(this, "fullTransactionLogging", void 0);
     _defineProperty(this, "region", void 0);
     _defineProperty(this, "apigwAgentConfigZipFile", void 0);
@@ -36,6 +37,7 @@ class AWSAgentValues {
     this.accessKey = awsDeployment === 'Other' ? '**Insert Access Key**' : '';
     this.secretKey = awsDeployment === 'Other' ? '**Insert Secret Key**' : '';
     this.logGroup = '';
+    this.stageTagName = '';
     this.fullTransactionLogging = false;
     this.region = '';
     this.apigwAgentConfigZipFile = '';
@@ -107,6 +109,7 @@ AWS_AUTH_ACCESSKEY={{accessKey}}
 AWS_AUTH_SECRETKEY={{secretKey}}
 {{/if}}
 AWS_LOGGROUP={{logGroup}}
+AWS_STAGETAGNAME={{stageTagName}}
 
 # Amplify Central configs
 CENTRAL_AGENTNAME={{centralConfig.daAgentName}}

package/dist/commands/install/helpers/templates/sapApiPortalTemplates.js

@@ -0,0 +1,118 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.sapAPIPortalTAEnvVarTemplate = exports.sapAPIPortalDAEnvVarTemplate = exports.SAPApiPortalAgentValues = void 0;
+var _types = require("../../../../common/types");
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+/**
+ * @description Parameters to provide to the SAP API Portal handlebars templates.
+ */
+class SAPApiPortalAgentValues {
+  constructor() {
+    _defineProperty(this, "authTokenURL", void 0);
+    _defineProperty(this, "authAPIPortalBaseURL", void 0);
+    _defineProperty(this, "authAPIPortalClientID", void 0);
+    _defineProperty(this, "authAPIPortalClientSecret", void 0);
+    _defineProperty(this, "authDevPortalBaseURL", void 0);
+    _defineProperty(this, "authDevPortalClientID", void 0);
+    _defineProperty(this, "authDevPortalClientSecret", void 0);
+    _defineProperty(this, "developerEmail", void 0);
+    _defineProperty(this, "specCreateUnstructuredAPI", void 0);
+    _defineProperty(this, "centralConfig", void 0);
+    _defineProperty(this, "traceabilityConfig", void 0);
+    this.authTokenURL = '';
+    this.authAPIPortalBaseURL = '';
+    this.authAPIPortalClientID = '';
+    this.authAPIPortalClientSecret = '';
+    this.authDevPortalBaseURL = '';
+    this.authDevPortalClientID = '';
+    this.authDevPortalClientSecret = '';
+    this.developerEmail = '';
+    this.specCreateUnstructuredAPI = false;
+    this.centralConfig = new _types.CentralAgentConfig();
+    this.traceabilityConfig = new _types.TraceabilityConfig();
+  }
+}
+
+/**
+ * @description Generates the SAP API Portal DA env vars file.
+ */
+exports.SAPApiPortalAgentValues = SAPApiPortalAgentValues;
+const sapAPIPortalDAEnvVarTemplate = () => {
+  return `# SAP API Portal configs
+SAP_AUTH_TOKENURL={{authTokenURL}}
+SAP_AUTH_APIPORTAL_BASEURL={{authAPIPortalBaseURL}}
+SAP_AUTH_APIPORTAL_CLIENTID={{authAPIPortalClientID}}
+SAP_AUTH_APIPORTAL_CLIENTSECRET={{authAPIPortalClientSecret}}
+SAP_AUTH_DEVPORTAL_BASEURL={{authDevPortalBaseURL}}
+SAP_AUTH_DEVPORTAL_CLIENTID={{authDevPortalClientID}}
+SAP_AUTH_DEVPORTAL_CLIENTSECRET={{authDevPortalClientSecret}}
+SAP_DEVELOPEREMAIL={{developerEmail}}
+SAP_SPEC_CREATEUNSTRUCTUREDAPI={{specCreateUnstructuredAPI}}
+
+# Amplify Central configs
+CENTRAL_AGENTNAME={{centralConfig.daAgentName}}
+CENTRAL_AUTH_CLIENTID={{centralConfig.dosaAccount.clientId}}
+CENTRAL_AUTH_PRIVATEKEY={{centralConfig.dosaAccount.templatePrivateKey}}
+CENTRAL_AUTH_PUBLICKEY={{centralConfig.dosaAccount.templatePublicKey}}
+CENTRAL_ENVIRONMENT={{centralConfig.environment}}
+CENTRAL_ORGANIZATIONID={{centralConfig.orgId}}
+CENTRAL_TEAM={{centralConfig.ampcTeamName}}
+CENTRAL_REGION={{centralConfig.region}}
+
+# Logging configs
+# Define the logging level: info, debug, error
+LOG_LEVEL=info
+# Specify where to send the log: stdout, file, both
+LOG_OUTPUT=stdout
+# Define where the log files are written
+LOG_FILE_PATH=logs
+`;
+};
+
+/**
+ * @description Generates the SAP API Portal TA env vars file.
+ */
+exports.sapAPIPortalDAEnvVarTemplate = sapAPIPortalDAEnvVarTemplate;
+const sapAPIPortalTAEnvVarTemplate = () => {
+  return `# SAP API Portal configs
+SAP_AUTH_TOKENURL={{authTokenURL}}
+SAP_AUTH_APIPORTAL_BASEURL={{authAPIPortalBaseURL}}
+SAP_AUTH_APIPORTAL_CLIENTID={{authAPIPortalClientID}}
+SAP_AUTH_APIPORTAL_CLIENTSECRET={{authAPIPortalClientSecret}}
+
+# Amplify Central configs
+{{#if traceabilityConfig.usageReportingOffline}}
+CENTRAL_USAGEREPORTING_OFFLINE={{traceabilityConfig.usageReportingOffline}}
+CENTRAL_ENVIRONMENTID={{centralConfig.environmentId}}
+CENTRAL_AGENTNAME={{centralConfig.taAgentName}}
+{{else}}
+CENTRAL_AGENTNAME={{centralConfig.taAgentName}}
+CENTRAL_AUTH_CLIENTID={{centralConfig.dosaAccount.clientId}}
+CENTRAL_AUTH_PRIVATEKEY={{centralConfig.dosaAccount.templatePrivateKey}}
+CENTRAL_AUTH_PUBLICKEY={{centralConfig.dosaAccount.templatePublicKey}}
+CENTRAL_ENVIRONMENT={{centralConfig.environment}}
+CENTRAL_ORGANIZATIONID={{centralConfig.orgId}}
+CENTRAL_TEAM={{centralConfig.ampcTeamName}}
+CENTRAL_REGION={{centralConfig.region}}
+
+{{#compare . traceabilityConfig.protocol "https"}}
+TRACEABILITY_PROTOCOL={{traceabilityConfig.protocol}}
+{{/compare}}
+TRACEABILITY_SAMPLING_PERCENTAGE={{traceabilityConfig.samplingPercentage}}
+{{/if}}
+
+# Logging configs
+# Define the logging level: info, debug, error
+LOG_LEVEL=info
+# Specify where to send the log: stdout, file, both
+LOG_OUTPUT=stdout
+# Define where the log files are written
+LOG_FILE_PATH=logs
+`;
+};
+exports.sapAPIPortalTAEnvVarTemplate = sapAPIPortalTAEnvVarTemplate;

package/dist/commands/install/sapApiPortalAgents.js

@@ -0,0 +1,199 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.testables = exports.gatewayConnectivity = exports.defaultLogFiles = exports.completeInstall = exports.askConfigType = exports.askBundleType = exports.SAPAPIPortalInstallMethods = exports.ConfigFiles = void 0;
+var _chalk = _interopRequireDefault(require("chalk"));
+var _snooplogg = _interopRequireDefault(require("snooplogg"));
+var _basicPrompts = require("../../common/basicPrompts");
+var _types = require("../../common/types");
+var _utils = require("../../common/utils");
+var helpers = _interopRequireWildcard(require("./helpers"));
+var _sapApiPortalTemplates = require("./helpers/templates/sapApiPortalTemplates");
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// @ts-ignore
+const {
+  log
+} = (0, _snooplogg.default)('central: install: agents: SAP API Portal');
+const daImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.SAPAPIPORTAL_DA}`;
+const taImage = `${_types.PublicDockerRepoBaseUrl}${_types.BasePaths.DockerAgentPublicRepo}/${_types.AgentNames.SAPAPIPORTAL_TA}`;
+const defaultLogFiles = exports.defaultLogFiles = '/group-*_instance-*.log';
+
+// ConfigFiles - all the config file that are used in the setup
+const ConfigFiles = exports.ConfigFiles = {
+  DAEnvVars: `${helpers.configFiles.DA_ENV_VARS}`,
+  TAEnvVars: `${helpers.configFiles.TA_ENV_VARS}`,
+  SAPAPIPortalDABinaryFile: 'discovery_agent',
+  SAPAPIPortalDAYaml: 'discovery_agent.yml',
+  SAPAPIPortalTABinaryFile: 'traceability_agent',
+  SAPAPIPortalTAYaml: 'traceability_agent.yml'
+};
+
+// SAPAPIPortalPrompts - prompts for user inputs
+const SAPAPIPortalPrompts = {
+  configTypeMsg: 'Select the mode of installation',
+  enterAuthTokenURL: 'Enter the token URL used for agent authentication to SAP',
+  enterAuthAPIPortalBaseURL: 'Enter the SAP API Portal baseURL',
+  enterAuthAPIPortalClientID: 'Enter the SAP API Portal ClientID',
+  enterAuthAPIPortalClientSecret: 'Enter the SAP API Portal ClientSecret',
+  enterAuthDevPortalBaseURL: 'Enter the SAP Dev Portal baseURL',
+  enterAuthDevPortalClientID: 'Enter the SAP Dev Portal ClientID',
+  enterAuthDevPortalClientSecret: 'Enter the SAP Dev Portal ClientSecret',
+  enterDeveloperEmail: 'Enter the SAP developer email',
+  selectSpecCreateUnstructuredAPI: 'Select whether to create unstructured APIs for invalid/unknown API specs'
+};
+const askBundleType = async () => {
+  return await (0, _basicPrompts.askList)({
+    msg: helpers.agentMessages.selectAgentType,
+    choices: [_types.BundleType.ALL_AGENTS, _types.BundleType.DISCOVERY, _types.BundleType.TRACEABILITY]
+  });
+};
+exports.askBundleType = askBundleType;
+const askConfigType = async () => {
+  return _types.AgentConfigTypes.DOCKERIZED;
+};
+
+//
+// Questions for the configuration of IBM API Connect agents
+//
+exports.askConfigType = askConfigType;
+const askAuthTokenURL = async () => await (0, _basicPrompts.askInput)({
+  msg: SAPAPIPortalPrompts.enterAuthTokenURL
+});
+const askAuthAPIPortalBaseURL = async () => await (0, _basicPrompts.askInput)({
+  msg: SAPAPIPortalPrompts.enterAuthAPIPortalBaseURL
+});
+const askAuthAPIPortalClientID = async () => await (0, _basicPrompts.askInput)({
+  msg: SAPAPIPortalPrompts.enterAuthAPIPortalClientID
+});
+const askAuthAPIPortalClientSecret = async () => await (0, _basicPrompts.askInput)({
+  msg: SAPAPIPortalPrompts.enterAuthAPIPortalClientSecret
+});
+const askAuthDevPortalBaseURL = async () => await (0, _basicPrompts.askInput)({
+  msg: SAPAPIPortalPrompts.enterAuthDevPortalBaseURL
+});
+const askAuthDevPortalClientID = async () => await (0, _basicPrompts.askInput)({
+  msg: SAPAPIPortalPrompts.enterAuthDevPortalClientID
+});
+const askAuthDevPortalClientSecret = async () => await (0, _basicPrompts.askInput)({
+  msg: SAPAPIPortalPrompts.enterAuthDevPortalClientSecret
+});
+const askDeveloperEmail = async () => await (0, _basicPrompts.askInput)({
+  msg: SAPAPIPortalPrompts.enterDeveloperEmail
+});
+const askSpecCreateUnstructuredAPI = async () => (await (0, _basicPrompts.askList)({
+  msg: SAPAPIPortalPrompts.selectSpecCreateUnstructuredAPI,
+  default: _types.YesNo.No,
+  choices: _types.YesNoChoices
+})) === _types.YesNo.Yes;
+const gatewayConnectivity = async installConfig => {
+  const agentValues = new _sapApiPortalTemplates.SAPApiPortalAgentValues();
+  console.log('\nCONNECTION TO IBM API Connect:');
+  console.log(_chalk.default.gray(`The discovery agent needs to connect to the IBM API Connect Gateway to discover API's for publishing to Amplify.\nThe traceability agent needs to connect to IBM API Connect for collecting APIs transactions. These will be forwarded to the Business Insights.\n`));
+  await askCommonPrompts(agentValues);
+
+  // SAP API Portal Discovery Agent Prompts
+  if (installConfig.switches.isDaEnabled) {
+    console.log(_chalk.default.gray(`\nDiscovery Agent Configuration\n`));
+    await askDiscoveryPrompts(agentValues);
+  }
+  return agentValues;
+};
+exports.gatewayConnectivity = gatewayConnectivity;
+const generateSuccessHelpMsg = installConfig => {
+  if (installConfig.centralConfig.ampcDosaInfo.isNew && !installConfig.switches.isHelmInstall) {
+    console.log(_chalk.default.yellow('\nPlease make sure to copy the "private_key.pem" and "public_key.pem" files for the existing service account you selected.'));
+  }
+  dockerSuccessMsg(installConfig);
+  console.log(_chalk.default.gray(`\nAdditional information about agent features can be found here:\n${helpers.agentsDocsUrl.SAPAPIPORTAL}`));
+};
+const dockerSuccessMsg = installConfig => {
+  let dockerInfo;
+  const runDaLinuxMsg = `docker run -it --env-file ${helpers.pwd}/${helpers.configFiles.DA_ENV_VARS} -v ${helpers.pwd}:/keys ${helpers.eolChar}`;
+  const runDaWinMsg = `docker run -it --env-file ${helpers.pwdWin}/${helpers.configFiles.DA_ENV_VARS} -v ${helpers.pwdWin}:/keys ${helpers.eolCharWin}`;
+  const runTaLinuxMsg = `docker run -it --env-file ${helpers.pwd}/${helpers.configFiles.TA_ENV_VARS} -v ${helpers.pwd}:/keys ${helpers.eolChar}`;
+  const runTaWinMsg = `docker run -it --env-file ${helpers.pwdWin}/${helpers.configFiles.TA_ENV_VARS} -v ${helpers.pwdWin}:/keys ${helpers.eolCharWin}`;
+  const startDaLinuxMsg = `\nStart the Discovery Agent on a Linux based machine`;
+  const startDaWinMsg = `\nStart the Discovery Agent on a Windows machine`;
+  const startTaLinuxMsg = `\nStart the Traceability Agent on a Linux based machine`;
+  const startTaWinMsg = `\nStart the Traceability Agent on a Windows machine`;
+  if (installConfig.switches.isDaEnabled && installConfig.switches.isTaEnabled) {
+    dockerInfo = `To utilize the agents, pull the latest Docker images and run them using the appropriate supplied environment files, (${helpers.configFiles.DA_ENV_VARS} & ${helpers.configFiles.TA_ENV_VARS}):`;
+  } else if (installConfig.switches.isDaEnabled) {
+    dockerInfo = `To utilize the discovery agent, pull the latest Docker image and run it using the supplied environment file, (${helpers.configFiles.DA_ENV_VARS}):`;
+  } else {
+    dockerInfo = `To utilize the traceability agent, pull the latest Docker image and run it using the supplied environment file, (${helpers.configFiles.TA_ENV_VARS}):`;
+  }
+  console.log(_chalk.default.whiteBright(dockerInfo), '\n');
+  if (installConfig.switches.isDaEnabled) {
+    const daImageVersion = `${daImage}:${installConfig.daVersion}`;
+    console.log(_chalk.default.white('Pull the latest image of the Discovery Agent:'));
+    console.log(_chalk.default.cyan(`docker pull ${daImageVersion}`));
+    console.log(_chalk.default.white(_utils.isWindows ? startDaWinMsg : startDaLinuxMsg));
+    console.log(_chalk.default.cyan(_utils.isWindows ? runDaWinMsg : runDaLinuxMsg));
+    console.log('\t', _chalk.default.cyan(`-v /data ${daImageVersion}`), '\n');
+  }
+  if (installConfig.switches.isTaEnabled) {
+    const taImageVersion = `${taImage}:${installConfig.taVersion}`;
+    console.log(_chalk.default.white('Pull the latest image of the Traceability Agent:'));
+    console.log(_chalk.default.cyan(`docker pull ${taImageVersion}`));
+    console.log(_chalk.default.white(_utils.isWindows ? startTaWinMsg : startTaLinuxMsg));
+    console.log(_chalk.default.cyan(_utils.isWindows ? runTaWinMsg : runTaLinuxMsg));
+    console.log('\t', _chalk.default.cyan(`-v /data ${taImageVersion}`), '\n');
+  }
+};
+async function askCommonPrompts(agentValues) {
+  agentValues.authTokenURL = await askAuthTokenURL();
+  agentValues.authAPIPortalBaseURL = await askAuthAPIPortalBaseURL();
+  agentValues.authAPIPortalClientID = await askAuthAPIPortalClientID();
+  agentValues.authAPIPortalClientSecret = await askAuthAPIPortalClientSecret();
+}
+
+// IBM API Connect DA prompts
+async function askDiscoveryPrompts(agentValues) {
+  agentValues.authDevPortalBaseURL = await askAuthDevPortalBaseURL();
+  agentValues.authDevPortalClientID = await askAuthDevPortalClientID();
+  agentValues.authDevPortalClientSecret = await askAuthDevPortalClientSecret();
+  agentValues.developerEmail = await askDeveloperEmail();
+  agentValues.specCreateUnstructuredAPI = await askSpecCreateUnstructuredAPI();
+}
+const completeInstall = async installConfig => {
+  /**
+   * Create agent resources
+   */
+  const agentValues = installConfig.gatewayConfig;
+
+  // Add final settings to SAP API Portal agentValues
+  agentValues.centralConfig = installConfig.centralConfig;
+  agentValues.traceabilityConfig = installConfig.traceabilityConfig;
+  console.log('Generating the configuration file(s)...');
+  if (installConfig.switches.isDaEnabled) {
+    (0, _utils.writeTemplates)(ConfigFiles.DAEnvVars, agentValues, _sapApiPortalTemplates.sapAPIPortalDAEnvVarTemplate);
+  }
+  if (installConfig.switches.isTaEnabled) {
+    (0, _utils.writeTemplates)(ConfigFiles.TAEnvVars, agentValues, _sapApiPortalTemplates.sapAPIPortalTAEnvVarTemplate);
+  }
+  console.log('Configuration file(s) have been successfully created.\n');
+  generateSuccessHelpMsg(installConfig);
+};
+exports.completeInstall = completeInstall;
+const SAPAPIPortalInstallMethods = exports.SAPAPIPortalInstallMethods = {
+  GetBundleType: askBundleType,
+  GetDeploymentType: askConfigType,
+  AskGatewayQuestions: gatewayConnectivity,
+  FinalizeGatewayInstall: completeInstall,
+  ConfigFiles: Object.values(ConfigFiles),
+  AgentNameMap: {
+    [_types.AgentTypes.da]: _types.AgentNames.SAPAPIPORTAL_DA,
+    [_types.AgentTypes.ta]: _types.AgentNames.SAPAPIPORTAL_TA
+  },
+  GatewayDisplay: _types.GatewayTypes.SAPAPIPORTAL
+};
+const testables = exports.testables = {
+  SAPAPIPortalPrompts,
+  ConfigFiles,
+  defaultLogFiles
+};

package/dist/common/basicPrompts.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.verifyApigeeXCredentialFile = exports.validateValueRange = exports.validateValidRegex = exports.validateRegex = exports.validateNonEmptyInput = exports.validateInputIsNew = exports.runValidations = exports.filterEmptyNumberInput = exports.askUsernameAndPassword = exports.askList = exports.askInputValidation = exports.askInput = exports.MAX_FILE_SIZE = void 0;
+exports.verifyApigeeXCredentialFile = exports.validateValueRange = exports.validateValidRegex = exports.validateRegex = exports.validateNonEmptyInput = exports.validateInputLength = exports.validateInputIsNew = exports.runValidations = exports.filterEmptyNumberInput = exports.askUsernameAndPassword = exports.askList = exports.askInputValidation = exports.askInput = exports.MAX_FILE_SIZE = void 0;
 var _inquirer = _interopRequireDefault(require("inquirer"));
 var _fsExtra = require("fs-extra");
 var _path = require("path");
@@ -30,6 +30,10 @@ const validateRegex = (regexp, message) => input => {
   return input.toString().match(regexp) ? true : message;
 };
 exports.validateRegex = validateRegex;
+const validateInputLength = (length, message) => input => {
+  return input.toString().length <= length ? true : message;
+};
+exports.validateInputLength = validateInputLength;
 const MAX_FILE_SIZE = exports.MAX_FILE_SIZE = process.env.NODE_ENV === 'test' ? 1e5 : 20 * 1024 * 1024;
 const verifyApigeeXCredentialFile = () => input => {
   let stats;

package/dist/common/types.js

@@ -237,9 +237,11 @@ let AgentNames = exports.AgentNames = /*#__PURE__*/function (AgentNames) {
   AgentNames["IBMAPICONNECT_DA"] = "ibm-apiconnect-discovery-agent";
   AgentNames["IBMAPICONNECT_TA"] = "ibm-apiconnect-traceability-agent";
   AgentNames["TRACEABLE_TA"] = "traceable-agent";
-  AgentNames["SOFTWAREAGWEBMETHODS_DA"] = "software-ag-web-methods-discovery-agent";
-  AgentNames["SOFTWAREAGWEBMETHODS_TA"] = "software-ag-web-methods-traceability-agent";
+  AgentNames["SOFTWAREAGWEBMETHODS_DA"] = "software-ag-webmethods-discovery-agent";
+  AgentNames["SOFTWAREAGWEBMETHODS_TA"] = "software-ag-webmethods-traceability-agent";
   AgentNames["BACKSTAGE_DA"] = "backstage-discovery-agent";
+  AgentNames["SAPAPIPORTAL_DA"] = "sap-discovery-agent";
+  AgentNames["SAPAPIPORTAL_TA"] = "sap-traceability-agent";
   return AgentNames;
 }({});
 let GatewayTypes = exports.GatewayTypes = /*#__PURE__*/function (GatewayTypes) {
@@ -257,6 +259,7 @@ let GatewayTypes = exports.GatewayTypes = /*#__PURE__*/function (GatewayTypes) {
   GatewayTypes["SOFTWAREAGWEBMETHODS"] = "Software AG WebMethods";
   GatewayTypes["TRACEABLE"] = "Traceable";
   GatewayTypes["BACKSTAGE"] = "Backstage";
+  GatewayTypes["SAPAPIPORTAL"] = "SAP API Portal";
   return GatewayTypes;
 }({});
 let SaaSGatewayTypes = exports.SaaSGatewayTypes = /*#__PURE__*/function (SaaSGatewayTypes) {
@@ -282,6 +285,7 @@ let DataPlaneNames = exports.DataPlaneNames = /*#__PURE__*/function (DataPlaneNa
   DataPlaneNames["TRACEABLE"] = "Traceable";
   DataPlaneNames["MULESOFT"] = "Mulesoft";
   DataPlaneNames["BACKSTAGE"] = "Backstage";
+  DataPlaneNames["SAPAPIPORTAL"] = "SAP API Portal";
   DataPlaneNames["OTHER"] = "Unidentified";
   return DataPlaneNames;
 }({});
@@ -301,7 +305,8 @@ const GatewayTypeToDataPlane = exports.GatewayTypeToDataPlane = {
   [GatewayTypes.GRAYLOG]: DataPlaneNames.GRAYLOG,
   [GatewayTypes.IBMAPICONNECT]: DataPlaneNames.IBMAPICONNECT,
   [GatewayTypes.TRACEABLE]: DataPlaneNames.TRACEABLE,
-  [GatewayTypes.BACKSTAGE]: DataPlaneNames.BACKSTAGE
+  [GatewayTypes.BACKSTAGE]: DataPlaneNames.BACKSTAGE,
+  [GatewayTypes.SAPAPIPORTAL]: DataPlaneNames.SAPAPIPORTAL
 };
 let AgentResourceKind = exports.AgentResourceKind = /*#__PURE__*/function (AgentResourceKind) {
   AgentResourceKind["da"] = "DiscoveryAgent";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axway/axway-central-cli",
-	"version": "3.10.0-rc.6",
+	"version": "3.11.0-rc.0",
 	"description": "Manage APIs, services and publish to the Amplify Marketplace",
 	"homepage": "https://platform.axway.com",
 	"author": {