@rockcarver/frodo-lib 0.16.2-9 → 0.17.1

package/types/index.d.ts

@@ -1,21 +1,23 @@
 export * as AgentRaw from './api/AgentApi';
-export * as EmailTemplateRaw from './api/EmailTemplateApi';
+export * as AuthenticateRaw from './api/AuthenticateApi';
 export * as NodeRaw from './api/NodeApi';
+export * as OAuth2OIDCApi from './api/OAuth2OIDCApi';
 export * as SecretsRaw from './api/SecretsApi';
 export * as StartupRaw from './api/StartupApi';
-export * as ThemeRaw from './api/ThemeApi';
 export * as TreeRaw from './api/TreeApi';
 export * as TypesRaw from './api/ApiTypes';
 export * as VariablesRaw from './api/VariablesApi';
+export * as IdmConfigRaw from './api/IdmConfigApi';
 export * as Admin from './ops/AdminOps';
 export * as Agent from './ops/AgentOps';
 export * as Authenticate from './ops/AuthenticateOps';
 export * as CirclesOfTrust from './ops/CirclesOfTrustOps';
 export * as ConnectionProfile from './ops/ConnectionProfileOps';
 export * as EmailTemplate from './ops/EmailTemplateOps';
-export * as Idm from './ops/IdmOps';
 export * as Idp from './ops/IdpOps';
+export * as Idm from './ops/IdmOps';
 export * as Journey from './ops/JourneyOps';
+export * as Jose from './ops/JoseOps';
 export * as Log from './ops/LogOps';
 export * as ManagedObject from './ops/ManagedObjectOps';
 export * as Node from './ops/NodeOps';
@@ -26,12 +28,16 @@ export * as Saml2 from './ops/Saml2Ops';
 export * as Script from './ops/ScriptOps';
 export * as Service from './ops/ServiceOps';
 export * as Secrets from './ops/SecretsOps';
+export * as ServiceAccount from './ops/ServiceAccountOps';
 export * as Startup from './ops/StartupOps';
 export * as Theme from './ops/ThemeOps';
 export * as Types from './ops/OpsTypes';
 export * as Variables from './ops/VariablesOps';
 export * as Utils from './ops/utils/OpsUtils';
+export * as ValidationUtils from './ops/utils/ValidationUtils';
 export * as LibVersion from './ops/utils/Version';
 export * as ExportImportUtils from './ops/utils/ExportImportUtils';
-export * as state from './storage/SessionStorage';
-export * as OAuth2OIDCApi from './api/OAuth2OIDCApi';
+export * as state from './shared/State';
+export * as constants from './storage/StaticStorage';
+export * as ForgeRockApiMockEngine from './test/mocks/ForgeRockApiMockEngine';
+export { FrodoMockAdapter } from './api/BaseApi';

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAC;AAC3C,OAAO,KAAK,gBAAgB,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAC;AAC3C,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAC;AAC3C,OAAO,KAAK,YAAY,MAAM,oBAAoB,CAAC;AAGnD,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,YAAY,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,cAAc,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,iBAAiB,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,aAAa,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,KAAK,aAAa,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,YAAY,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,YAAY,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAC;AAC1C,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,SAAS,MAAM,oBAAoB,CAAC;AAEhD,OAAO,KAAK,KAAK,MAAM,sBAAsB,CAAC;AAC9C,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,iBAAiB,MAAM,+BAA+B,CAAC;AAGnE,OAAO,KAAK,KAAK,MAAM,0BAA0B,CAAC;AAIlD,OAAO,KAAK,aAAa,MAAM,qBAAqB,CAAC","file":"index.d.ts","sourcesContent":["import Color from 'colors';\n\nColor.enable();\n\n// Api Layer\nexport * as AgentRaw from './api/AgentApi';\nexport * as EmailTemplateRaw from './api/EmailTemplateApi';\nexport * as NodeRaw from './api/NodeApi';\nexport * as SecretsRaw from './api/SecretsApi';\nexport * as StartupRaw from './api/StartupApi';\nexport * as ThemeRaw from './api/ThemeApi';\nexport * as TreeRaw from './api/TreeApi';\nexport * as TypesRaw from './api/ApiTypes';\nexport * as VariablesRaw from './api/VariablesApi';\n\n// Ops Layer\nexport * as Admin from './ops/AdminOps';\nexport * as Agent from './ops/AgentOps';\nexport * as Authenticate from './ops/AuthenticateOps';\nexport * as CirclesOfTrust from './ops/CirclesOfTrustOps';\nexport * as ConnectionProfile from './ops/ConnectionProfileOps';\nexport * as EmailTemplate from './ops/EmailTemplateOps';\nexport * as Idm from './ops/IdmOps';\nexport * as Idp from './ops/IdpOps';\nexport * as Journey from './ops/JourneyOps';\nexport * as Log from './ops/LogOps';\nexport * as ManagedObject from './ops/ManagedObjectOps';\nexport * as Node from './ops/NodeOps';\nexport * as OAuth2Client from './ops/OAuth2ClientOps';\nexport * as Organization from './ops/OrganizationOps';\nexport * as Realm from './ops/RealmOps';\nexport * as Saml2 from './ops/Saml2Ops';\nexport * as Script from './ops/ScriptOps';\nexport * as Service from './ops/ServiceOps';\nexport * as Secrets from './ops/SecretsOps';\nexport * as Startup from './ops/StartupOps';\nexport * as Theme from './ops/ThemeOps';\nexport * as Types from './ops/OpsTypes';\nexport * as Variables from './ops/VariablesOps';\n// TODO: revisit if there are better ways\nexport * as Utils from './ops/utils/OpsUtils';\nexport * as LibVersion from './ops/utils/Version';\nexport * as ExportImportUtils from './ops/utils/ExportImportUtils';\n// TODO: reconsider the aproach to pass in state from client\n// lib should be stateless, an aplication should own its state\nexport * as state from './storage/SessionStorage';\n// TODO: need to figure out if this is the right approach or if we should even\n// use a public oauth2/oidc library. might be ok for now since there is only\n// one place where the cli needs to execute an oauth flow.\nexport * as OAuth2OIDCApi from './api/OAuth2OIDCApi';\n"]}
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAC;AAC3C,OAAO,KAAK,eAAe,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AAIzC,OAAO,KAAK,aAAa,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAC;AAC3C,OAAO,KAAK,YAAY,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,YAAY,MAAM,oBAAoB,CAAC;AAGnD,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,YAAY,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,cAAc,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,iBAAiB,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,aAAa,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,KAAK,aAAa,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,YAAY,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,YAAY,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAC;AAC1C,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,cAAc,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,SAAS,MAAM,oBAAoB,CAAC;AAEhD,OAAO,KAAK,KAAK,MAAM,sBAAsB,CAAC;AAC9C,OAAO,KAAK,eAAe,MAAM,6BAA6B,CAAC;AAC/D,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,iBAAiB,MAAM,+BAA+B,CAAC;AAGnE,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,SAAS,MAAM,yBAAyB,CAAC;AAGrD,OAAO,KAAK,sBAAsB,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC","file":"index.d.ts","sourcesContent":["import Color from 'colors';\n\nColor.enable();\n\n// Api Layer\nexport * as AgentRaw from './api/AgentApi';\nexport * as AuthenticateRaw from './api/AuthenticateApi';\nexport * as NodeRaw from './api/NodeApi';\n// TODO: need to figure out if this is the right approach or if we should even\n// use a public oauth2/oidc library. might be ok for now since there is only\n// one place where the cli needs to execute an oauth flow.\nexport * as OAuth2OIDCApi from './api/OAuth2OIDCApi';\nexport * as SecretsRaw from './api/SecretsApi';\nexport * as StartupRaw from './api/StartupApi';\nexport * as TreeRaw from './api/TreeApi';\nexport * as TypesRaw from './api/ApiTypes';\nexport * as VariablesRaw from './api/VariablesApi';\nexport * as IdmConfigRaw from './api/IdmConfigApi';\n\n// Ops Layer\nexport * as Admin from './ops/AdminOps';\nexport * as Agent from './ops/AgentOps';\nexport * as Authenticate from './ops/AuthenticateOps';\nexport * as CirclesOfTrust from './ops/CirclesOfTrustOps';\nexport * as ConnectionProfile from './ops/ConnectionProfileOps';\nexport * as EmailTemplate from './ops/EmailTemplateOps';\nexport * as Idp from './ops/IdpOps';\nexport * as Idm from './ops/IdmOps';\nexport * as Journey from './ops/JourneyOps';\nexport * as Jose from './ops/JoseOps';\nexport * as Log from './ops/LogOps';\nexport * as ManagedObject from './ops/ManagedObjectOps';\nexport * as Node from './ops/NodeOps';\nexport * as OAuth2Client from './ops/OAuth2ClientOps';\nexport * as Organization from './ops/OrganizationOps';\nexport * as Realm from './ops/RealmOps';\nexport * as Saml2 from './ops/Saml2Ops';\nexport * as Script from './ops/ScriptOps';\nexport * as Service from './ops/ServiceOps';\nexport * as Secrets from './ops/SecretsOps';\nexport * as ServiceAccount from './ops/ServiceAccountOps';\nexport * as Startup from './ops/StartupOps';\nexport * as Theme from './ops/ThemeOps';\nexport * as Types from './ops/OpsTypes';\nexport * as Variables from './ops/VariablesOps';\n// TODO: revisit if there are better ways\nexport * as Utils from './ops/utils/OpsUtils';\nexport * as ValidationUtils from './ops/utils/ValidationUtils';\nexport * as LibVersion from './ops/utils/Version';\nexport * as ExportImportUtils from './ops/utils/ExportImportUtils';\n// TODO: reconsider the aproach to pass in state from client\n// lib should be stateless, an aplication should own its state\nexport * as state from './shared/State';\nexport * as constants from './storage/StaticStorage';\n\n// Mock Engine\nexport * as ForgeRockApiMockEngine from './test/mocks/ForgeRockApiMockEngine';\nexport { FrodoMockAdapter } from './api/BaseApi';\n"]}

package/types/ops/AuthenticateOps.d.ts

@@ -1,6 +1,14 @@
+import { JwkRsa } from './JoseOps';
+/**
+ * Get access token for service account
+ * @param {string} serviceAccountId UUID of service account
+ * @param {JwkRsa} jwk Java Wek Key
+ * @returns {string | null} Access token or null
+ */
+export declare function getAccessTokenForServiceAccount(serviceAccountId: string, jwk: JwkRsa): Promise<string | null>;
 /**
  * Get tokens
  * @param {boolean} save true to save a connection profile upon successful authentication, false otherwise
- * @returns {boolean} true if tokens were successfully obtained, false otherwise
+ * @returns {Promise<boolean>} true if tokens were successfully obtained, false otherwise
  */
-export declare function getTokens(save?: boolean): Promise<boolean>;
+export declare function getTokens(): Promise<boolean>;

package/types/ops/AuthenticateOps.d.ts.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/ops/AuthenticateOps.ts"],"names":[],"mappings":"AA4TA;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,IAAI,UAAQ,oBAyC3C","file":"AuthenticateOps.d.ts","sourcesContent":["import url from 'url';\nimport { createHash, randomBytes } from 'crypto';\nimport readlineSync from 'readline-sync';\nimport { encodeBase64Url } from '../api/utils/Base64';\nimport storage from '../storage/SessionStorage';\nimport * as globalConfig from '../storage/StaticStorage';\nimport { printMessage } from './utils/Console';\nimport { getServerInfo, getServerVersionInfo } from '../api/ServerInfoApi';\nimport { step } from '../api/AuthenticateApi';\nimport { accessToken, authorize } from '../api/OAuth2OIDCApi';\nimport {\n  getConnectionProfile,\n  saveConnectionProfile,\n} from './ConnectionProfileOps';\n\nconst adminClientPassword = 'doesnotmatter';\nconst redirectUrlTemplate = '/platform/appAuthHelperRedirect.html';\n\nconst idmAdminScope = 'fr:idm:* openid';\n\nlet adminClientId = 'idmAdminClient';\n\n/**\n * Helper function to get cookie name\n * @returns {String} cookie name\n */\nasync function getCookieName() {\n  try {\n    return (await getServerInfo()).data.cookieName;\n  } catch (error) {\n    printMessage(`Error getting cookie name: ${error}`, 'error');\n    return null;\n  }\n}\n\n/**\n * Helper function to determine if this is a setup mfa prompt in the ID Cloud tenant admin login journey\n * @param {Object} payload response from the previous authentication journey step\n * @returns {Object} an object indicating if 2fa is required and the original payload\n */\nfunction checkAndHandle2FA(payload) {\n  // let skippable = false;\n  if ('callbacks' in payload) {\n    for (const element of payload.callbacks) {\n      if (element.type === 'HiddenValueCallback') {\n        if (element.input[0].value.includes('skip')) {\n          // skippable = true;\n          element.input[0].value = 'Skip';\n          return {\n            need2fa: true,\n            payload,\n          };\n        }\n      }\n      if (element.type === 'NameCallback') {\n        if (element.output[0].value.includes('code')) {\n          // skippable = false;\n          printMessage('2FA is enabled and required for this user...');\n          const code = readlineSync.question(`${element.output[0].value}: `);\n          element.input[0].value = code;\n          return {\n            need2fa: true,\n            payload,\n          };\n        }\n      }\n    }\n    // console.info(\"NO2FA\");\n    return {\n      need2fa: false,\n      payload,\n    };\n  }\n  // console.info(\"NO2FA\");\n  return {\n    need2fa: false,\n    payload,\n  };\n}\n\n/**\n * Helper function to set the default realm by deployment type\n * @param {String} deploymentType deployment type\n */\nfunction determineDefaultRealm(deploymentType) {\n  if (storage.session.getRealm() === globalConfig.DEFAULT_REALM_KEY) {\n    storage.session.setRealm(\n      globalConfig.DEPLOYMENT_TYPE_REALM_MAP[deploymentType]\n    );\n  }\n}\n\n/**\n * Helper function to determine the deployment type\n * @returns {String} deployment type\n */\nasync function determineDeploymentType() {\n  const fidcClientId = 'idmAdminClient';\n  const forgeopsClientId = 'idm-admin-ui';\n\n  const verifier = encodeBase64Url(randomBytes(32));\n  const challenge = encodeBase64Url(\n    createHash('sha256').update(verifier).digest()\n  );\n  const challengeMethod = 'S256';\n  const redirectURL = url.resolve(\n    storage.session.getTenant(),\n    redirectUrlTemplate\n  );\n\n  const config = {\n    maxRedirects: 0,\n  };\n  let bodyFormData = `redirect_uri=${redirectURL}&scope=${idmAdminScope}&response_type=code&client_id=${fidcClientId}&csrf=${storage.session.getCookieValue()}&decision=allow&code_challenge=${challenge}&code_challenge_method=${challengeMethod}`;\n\n  let deploymentType = globalConfig.CLASSIC_DEPLOYMENT_TYPE_KEY;\n  try {\n    await authorize(bodyFormData, config);\n  } catch (e) {\n    if (\n      e.response?.status === 302 &&\n      e.response.headers?.location?.indexOf('code=') > -1\n    ) {\n      printMessage('ForgeRock Identity Cloud ', 'info', false);\n      deploymentType = globalConfig.CLOUD_DEPLOYMENT_TYPE_KEY;\n    } else {\n      try {\n        bodyFormData = `redirect_uri=${redirectURL}&scope=${idmAdminScope}&response_type=code&client_id=${forgeopsClientId}&csrf=${storage.session.getCookieValue()}&decision=allow&code_challenge=${challenge}&code_challenge_method=${challengeMethod}`;\n        await authorize(bodyFormData, config);\n      } catch (ex) {\n        if (\n          ex.response?.status === 302 &&\n          ex.response.headers?.location?.indexOf('code=') > -1\n        ) {\n          adminClientId = forgeopsClientId;\n          printMessage('ForgeOps deployment ', 'info', false);\n          deploymentType = globalConfig.FORGEOPS_DEPLOYMENT_TYPE_KEY;\n        } else {\n          printMessage('Classic deployment ', 'info', false);\n        }\n      }\n    }\n    printMessage('detected.');\n  }\n  determineDefaultRealm(deploymentType);\n  return deploymentType;\n}\n\n/**\n * Helper function to extract the semantic version string from a version info object\n * @param {Object} versionInfo version info object\n * @returns {String} semantic version\n */\nasync function getSemanticVersion(versionInfo) {\n  if ('version' in versionInfo) {\n    const versionString = versionInfo.version;\n    const rx = /([\\d]\\.[\\d]\\.[\\d](\\.[\\d])*)/g;\n    const version = versionString.match(rx);\n    return version[0];\n  }\n  throw new Error('Cannot extract semantic version from version info object.');\n}\n\n/**\n * Helper function to authenticate and obtain and store session cookie\n * @returns {String} empty string or null\n */\nasync function authenticate() {\n  storage.session.setCookieName(await getCookieName());\n  try {\n    const config = {\n      headers: {\n        'X-OpenAM-Username': storage.session.getUsername(),\n        'X-OpenAM-Password': storage.session.getPassword(),\n      },\n    };\n    const response1 = (await step({}, config)).data;\n    const skip2FA = checkAndHandle2FA(response1);\n    let response2 = {};\n    if (skip2FA.need2fa) {\n      response2 = (await step(skip2FA.payload)).data;\n    } else {\n      response2 = skip2FA.payload;\n    }\n    if ('tokenId' in response2) {\n      storage.session.setCookieValue(response2['tokenId']);\n      if (!storage.session.getDeploymentType()) {\n        storage.session.setDeploymentType(await determineDeploymentType());\n      } else {\n        determineDefaultRealm(storage.session.getDeploymentType());\n      }\n      const versionInfo = (await getServerVersionInfo()).data;\n\n      // https://github.com/rockcarver/frodo-cli/issues/109\n      // printMessage(`Connected to ${versionInfo.fullVersion}`);\n\n      // https://github.com/rockcarver/frodo-cli/issues/102\n      printMessage(\n        `Connected to [${storage.session.getTenant()}], [${\n          !storage.session.getRealm() ? 'alpha' : storage.session.getRealm()\n        }] realm, as [${storage.session.getUsername()}]`\n      );\n      const version = await getSemanticVersion(versionInfo);\n      storage.session.setAmVersion(version);\n      return '';\n    }\n    printMessage(`error authenticating`, 'error');\n    printMessage('+++ likely cause, bad credentials!!! +++', 'error');\n    return null;\n  } catch (e) {\n    if (e.response?.status === 401) {\n      printMessage(`error authenticating - ${e.message}`, 'error');\n      printMessage('+++ likely cause, bad credentials +++', 'error');\n    }\n    if (e.message === 'self signed certificate') {\n      printMessage(`error authenticating - ${e.message}`, 'error');\n      printMessage('+++ use -k, --insecure option to allow +++', 'error');\n    } else {\n      printMessage(`error authenticating - ${e.message}`, 'error');\n      printMessage(e.response?.data, 'error');\n    }\n    return null;\n  }\n}\n\n/**\n * Helper function to obtain an oauth2 authorization code\n * @param {String} redirectURL oauth2 redirect uri\n * @param {String} codeChallenge PKCE code challenge\n * @param {String} codeChallengeMethod PKCE code challenge method\n * @returns {String} oauth2 authorization code or null\n */\nasync function getAuthCode(redirectURL, codeChallenge, codeChallengeMethod) {\n  try {\n    const bodyFormData = `redirect_uri=${redirectURL}&scope=${idmAdminScope}&response_type=code&client_id=${adminClientId}&csrf=${storage.session.getCookieValue()}&decision=allow&code_challenge=${codeChallenge}&code_challenge_method=${codeChallengeMethod}`;\n    const config = {\n      headers: {\n        'Content-Type': 'application/x-www-form-urlencoded',\n      },\n    };\n    const response = await authorize(bodyFormData, config);\n    if (response.status < 200 || response.status > 399) {\n      printMessage('error getting auth code', 'error');\n      printMessage(\n        'likely cause: mismatched parameters with OAuth client config',\n        'error'\n      );\n      return null;\n    }\n    const redirectLocationURL = response.request.res.responseUrl;\n    const queryObject = url.parse(redirectLocationURL, true).query;\n    if ('code' in queryObject) {\n      return queryObject.code;\n    }\n    printMessage('auth code not found', 'error');\n    return null;\n  } catch (error) {\n    printMessage(`error getting auth code - ${error.message}`, 'error');\n    printMessage(error.response.data, 'error');\n    return null;\n  }\n}\n\n/**\n * Helper function to obtain oauth2 access token\n * @returns {String} empty string or null\n */\nasync function getAccessToken() {\n  try {\n    const verifier = encodeBase64Url(randomBytes(32));\n    const challenge = encodeBase64Url(\n      createHash('sha256').update(verifier).digest()\n    );\n    const challengeMethod = 'S256';\n    const redirectURL = url.resolve(\n      storage.session.getTenant(),\n      redirectUrlTemplate\n    );\n    const authCode = await getAuthCode(redirectURL, challenge, challengeMethod);\n    if (authCode == null) {\n      printMessage('error getting auth code', 'error');\n      return null;\n    }\n    let response = null;\n    if (\n      storage.session.getDeploymentType() ===\n      globalConfig.CLOUD_DEPLOYMENT_TYPE_KEY\n    ) {\n      const config = {\n        auth: {\n          username: adminClientId,\n          password: adminClientPassword,\n        },\n      };\n      const bodyFormData = `redirect_uri=${redirectURL}&grant_type=authorization_code&code=${authCode}&code_verifier=${verifier}`;\n      response = await accessToken(bodyFormData, config);\n    } else {\n      const bodyFormData = `client_id=${adminClientId}&redirect_uri=${redirectURL}&grant_type=authorization_code&code=${authCode}&code_verifier=${verifier}`;\n      response = await accessToken(bodyFormData);\n    }\n    if (response.status < 200 || response.status > 399) {\n      printMessage(`access token call returned ${response.status}`, 'error');\n      return null;\n    }\n    if ('access_token' in response.data) {\n      storage.session.setBearerToken(response.data.access_token);\n      return '';\n    }\n    printMessage(\"can't get access token\", 'error');\n    return null;\n  } catch (e) {\n    printMessage('error getting access token - ', 'error');\n    return null;\n  }\n}\n\n/**\n * Get tokens\n * @param {boolean} save true to save a connection profile upon successful authentication, false otherwise\n * @returns {boolean} true if tokens were successfully obtained, false otherwise\n */\nexport async function getTokens(save = false) {\n  let credsFromParameters = true;\n  // if username/password on cli are empty, try to read from connections.json\n  if (\n    storage.session.getUsername() == null &&\n    storage.session.getPassword() == null\n  ) {\n    credsFromParameters = false;\n    const conn = await getConnectionProfile();\n    if (conn) {\n      storage.session.setTenant(conn.tenant);\n      storage.session.setUsername(conn.username);\n      storage.session.setPassword(conn.password);\n      storage.session.setAuthenticationService(conn.authenticationService);\n      storage.session.setAuthenticationHeaderOverrides(\n        conn.authenticationHeaderOverrides\n      );\n    } else {\n      return false;\n    }\n  }\n  await authenticate();\n  if (\n    storage.session.getCookieValue() &&\n    !storage.session.getBearerToken() &&\n    (storage.session.getDeploymentType() ===\n      globalConfig.CLOUD_DEPLOYMENT_TYPE_KEY ||\n      storage.session.getDeploymentType() ===\n        globalConfig.FORGEOPS_DEPLOYMENT_TYPE_KEY)\n  ) {\n    await getAccessToken();\n  }\n  if (save && storage.session.getCookieValue() && credsFromParameters) {\n    // valid cookie, which means valid username/password combo. Save it in connections.json\n    saveConnectionProfile();\n    return true;\n  }\n  if (!storage.session.getCookieValue()) {\n    return false;\n  }\n  return true;\n}\n"]}
+{"version":3,"sources":["../src/ops/AuthenticateOps.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,MAAM,EAAwB,MAAM,WAAW,CAAC;AAkTzD;;;;;GAKG;AACH,wBAAsB,+BAA+B,CACnD,gBAAgB,EAAE,MAAM,EACxB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAqBxB;AAqCD;;;;GAIG;AACH,wBAAsB,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,CA6GlD","file":"AuthenticateOps.d.ts","sourcesContent":["import url from 'url';\nimport { createHash, randomBytes } from 'crypto';\nimport readlineSync from 'readline-sync';\nimport { encodeBase64Url } from '../api/utils/Base64';\nimport * as state from '../shared/State';\nimport * as globalConfig from '../storage/StaticStorage';\nimport { debugMessage, printMessage, verboseMessage } from './utils/Console';\nimport { getServerInfo, getServerVersionInfo } from '../api/ServerInfoApi';\nimport { step } from '../api/AuthenticateApi';\nimport { accessToken, authorize } from '../api/OAuth2OIDCApi';\nimport { getConnectionProfile } from './ConnectionProfileOps';\nimport { v4 } from 'uuid';\nimport { parseUrl } from '../api/utils/ApiUtils';\nimport { JwkRsa, createSignedJwtToken } from './JoseOps';\nimport { getManagedObject } from '../api/ManagedObjectApi';\n\nconst adminClientPassword = 'doesnotmatter';\nconst redirectUrlTemplate = '/platform/appAuthHelperRedirect.html';\n\nconst idmAdminScopes = 'fr:idm:* openid';\nconst serviceAccountScopes = 'fr:am:* fr:idm:* fr:idc:esv:*';\n\nlet adminClientId = 'idmAdminClient';\n\n/**\n * Helper function to get cookie name\n * @returns {String} cookie name\n */\nasync function determineCookieName() {\n  try {\n    const { data } = await getServerInfo();\n    debugMessage(\n      `AuthenticateOps.getCookieName: cookieName=${data.cookieName}`\n    );\n    return data.cookieName;\n  } catch (error) {\n    printMessage(`Error getting cookie name: ${error}`, 'error');\n    debugMessage(error.stack);\n    return null;\n  }\n}\n\n/**\n * Helper function to determine if this is a setup mfa prompt in the ID Cloud tenant admin login journey\n * @param {Object} payload response from the previous authentication journey step\n * @returns {Object} an object indicating if 2fa is required and the original payload\n */\nfunction checkAndHandle2FA(payload) {\n  // let skippable = false;\n  if ('callbacks' in payload) {\n    for (const element of payload.callbacks) {\n      if (element.type === 'HiddenValueCallback') {\n        if (element.input[0].value.includes('skip')) {\n          // skippable = true;\n          element.input[0].value = 'Skip';\n          return {\n            need2fa: true,\n            payload,\n          };\n        }\n      }\n      if (element.type === 'NameCallback') {\n        if (element.output[0].value.includes('code')) {\n          // skippable = false;\n          printMessage('2FA is enabled and required for this user...');\n          const code = readlineSync.question(`${element.output[0].value}: `);\n          element.input[0].value = code;\n          return {\n            need2fa: true,\n            payload,\n          };\n        }\n      }\n    }\n    // console.info(\"NO2FA\");\n    return {\n      need2fa: false,\n      payload,\n    };\n  }\n  // console.info(\"NO2FA\");\n  return {\n    need2fa: false,\n    payload,\n  };\n}\n\n/**\n * Helper function to set the default realm by deployment type\n * @param {string} deploymentType deployment type\n */\nfunction determineDefaultRealm(deploymentType: string) {\n  if (\n    !state.getRealm() ||\n    state.getRealm() === globalConfig.DEFAULT_REALM_KEY\n  ) {\n    state.setRealm(globalConfig.DEPLOYMENT_TYPE_REALM_MAP[deploymentType]);\n  }\n}\n\n/**\n * Helper function to determine the deployment type\n * @returns {Promise<string>} deployment type\n */\nasync function determineDeploymentType(): Promise<string> {\n  const cookieValue = state.getCookieValue();\n  // https://bugster.forgerock.org/jira/browse/FRAAS-13018\n  // There is a chance that this will be blocked due to security concerns and thus is probably best not to keep active\n  // if (!cookieValue && getUseBearerTokenForAmApis()) {\n  //   const token = await getTokenInfo();\n  //   cookieValue = token.sessionToken;\n  //   setCookieValue(cookieValue);\n  // }\n\n  // if we are using a service account, we know it's cloud\n  if (state.getUseBearerTokenForAmApis())\n    return globalConfig.CLOUD_DEPLOYMENT_TYPE_KEY;\n\n  const fidcClientId = 'idmAdminClient';\n  const forgeopsClientId = 'idm-admin-ui';\n\n  const verifier = encodeBase64Url(randomBytes(32));\n  const challenge = encodeBase64Url(\n    createHash('sha256').update(verifier).digest()\n  );\n  const challengeMethod = 'S256';\n  const redirectURL = url.resolve(state.getHost(), redirectUrlTemplate);\n\n  const config = {\n    maxRedirects: 0,\n    headers: {\n      [state.getCookieName()]: state.getCookieValue(),\n    },\n  };\n  let bodyFormData = `redirect_uri=${redirectURL}&scope=${idmAdminScopes}&response_type=code&client_id=${fidcClientId}&csrf=${cookieValue}&decision=allow&code_challenge=${challenge}&code_challenge_method=${challengeMethod}`;\n\n  let deploymentType = globalConfig.CLASSIC_DEPLOYMENT_TYPE_KEY;\n  try {\n    await authorize(bodyFormData, config);\n  } catch (e) {\n    // debugMessage(e.response);\n    if (\n      e.response?.status === 302 &&\n      e.response.headers?.location?.indexOf('code=') > -1\n    ) {\n      verboseMessage(`ForgeRock Identity Cloud`['brightCyan'] + ` detected.`);\n      deploymentType = globalConfig.CLOUD_DEPLOYMENT_TYPE_KEY;\n    } else {\n      try {\n        bodyFormData = `redirect_uri=${redirectURL}&scope=${idmAdminScopes}&response_type=code&client_id=${forgeopsClientId}&csrf=${state.getCookieValue()}&decision=allow&code_challenge=${challenge}&code_challenge_method=${challengeMethod}`;\n        await authorize(bodyFormData, config);\n      } catch (ex) {\n        if (\n          ex.response?.status === 302 &&\n          ex.response.headers?.location?.indexOf('code=') > -1\n        ) {\n          adminClientId = forgeopsClientId;\n          verboseMessage(`ForgeOps deployment`['brightCyan'] + ` detected.`);\n          deploymentType = globalConfig.FORGEOPS_DEPLOYMENT_TYPE_KEY;\n        } else {\n          verboseMessage(`Classic deployment`['brightCyan'] + ` detected.`);\n        }\n      }\n    }\n  }\n  return deploymentType;\n}\n\n/**\n * Helper function to extract the semantic version string from a version info object\n * @param {Object} versionInfo version info object\n * @returns {String} semantic version\n */\nasync function getSemanticVersion(versionInfo) {\n  if ('version' in versionInfo) {\n    const versionString = versionInfo.version;\n    const rx = /([\\d]\\.[\\d]\\.[\\d](\\.[\\d])*)/g;\n    const version = versionString.match(rx);\n    return version[0];\n  }\n  throw new Error('Cannot extract semantic version from version info object.');\n}\n\n/**\n * Helper function to authenticate and obtain and store session cookie\n * @returns {string} Session token or null\n */\nasync function authenticate(\n  username: string,\n  password: string\n): Promise<string> {\n  const config = {\n    headers: {\n      'X-OpenAM-Username': username,\n      'X-OpenAM-Password': password,\n    },\n  };\n  const response1 = await step({}, config);\n  const skip2FA = checkAndHandle2FA(response1);\n  let response2 = {};\n  if (skip2FA.need2fa) {\n    response2 = await step(skip2FA.payload);\n  } else {\n    response2 = skip2FA.payload;\n  }\n  if ('tokenId' in response2) {\n    return response2['tokenId'] as string;\n  }\n  return null;\n}\n\n/**\n * Helper function to obtain an oauth2 authorization code\n * @param {string} redirectURL oauth2 redirect uri\n * @param {string} codeChallenge PKCE code challenge\n * @param {string} codeChallengeMethod PKCE code challenge method\n * @returns {string} oauth2 authorization code or null\n */\nasync function getAuthCode(redirectURL, codeChallenge, codeChallengeMethod) {\n  try {\n    const bodyFormData = `redirect_uri=${redirectURL}&scope=${idmAdminScopes}&response_type=code&client_id=${adminClientId}&csrf=${state.getCookieValue()}&decision=allow&code_challenge=${codeChallenge}&code_challenge_method=${codeChallengeMethod}`;\n    const config = {\n      headers: {\n        'Content-Type': 'application/x-www-form-urlencoded',\n      },\n      maxRedirects: 0,\n    };\n    let response = undefined;\n    try {\n      response = await authorize(bodyFormData, config);\n    } catch (error) {\n      response = error.response;\n    }\n    if (response.status < 200 || response.status > 399) {\n      printMessage('error getting auth code', 'error');\n      printMessage(\n        'likely cause: mismatched parameters with OAuth client config',\n        'error'\n      );\n      return null;\n    }\n    const redirectLocationURL = response.headers?.location;\n    const queryObject = url.parse(redirectLocationURL, true).query;\n    if ('code' in queryObject) {\n      return queryObject.code;\n    }\n    printMessage('auth code not found', 'error');\n    return null;\n  } catch (error) {\n    printMessage(`error getting auth code - ${error.message}`, 'error');\n    printMessage(error.response?.data, 'error');\n    debugMessage(error.stack);\n    return null;\n  }\n}\n\n/**\n * Helper function to obtain oauth2 access token\n * @returns {Promise<string | null>} access token or null\n */\nasync function getAccessTokenForUser(): Promise<string | null> {\n  try {\n    const verifier = encodeBase64Url(randomBytes(32));\n    const challenge = encodeBase64Url(\n      createHash('sha256').update(verifier).digest()\n    );\n    const challengeMethod = 'S256';\n    const redirectURL = url.resolve(state.getHost(), redirectUrlTemplate);\n    const authCode = await getAuthCode(redirectURL, challenge, challengeMethod);\n    if (authCode == null) {\n      printMessage('error getting auth code', 'error');\n      return null;\n    }\n    let response = null;\n    if (state.getDeploymentType() === globalConfig.CLOUD_DEPLOYMENT_TYPE_KEY) {\n      const config = {\n        auth: {\n          username: adminClientId,\n          password: adminClientPassword,\n        },\n      };\n      const bodyFormData = `redirect_uri=${redirectURL}&grant_type=authorization_code&code=${authCode}&code_verifier=${verifier}`;\n      response = await accessToken(bodyFormData, config);\n    } else {\n      const bodyFormData = `client_id=${adminClientId}&redirect_uri=${redirectURL}&grant_type=authorization_code&code=${authCode}&code_verifier=${verifier}`;\n      response = await accessToken(bodyFormData);\n    }\n    if ('access_token' in response.data) {\n      return response.data.access_token;\n    }\n    printMessage('No access token in response.', 'error');\n  } catch (error) {\n    debugMessage(`Error getting access token for user: ${error}`);\n    debugMessage(error.response?.data);\n  }\n  return null;\n}\n\nfunction createPayload(serviceAccountId: string) {\n  const u = parseUrl(state.getHost());\n  const aud = `${u.origin}:${\n    u.port ? u.port : u.protocol === 'https' ? '443' : '80'\n  }${u.pathname}/oauth2/access_token`;\n\n  // Cross platform way of setting JWT expiry time 3 minutes in the future, expressed as number of seconds since EPOCH\n  const exp = Math.floor(new Date().getTime() / 1000 + 180);\n\n  // A unique ID for the JWT which is required when requesting the openid scope\n  const jti = v4();\n\n  const iss = serviceAccountId;\n  const sub = serviceAccountId;\n\n  // Create the payload for our bearer token\n  const payload = { iss, sub, aud, exp, jti };\n\n  return payload;\n}\n\n/**\n * Get access token for service account\n * @param {string} serviceAccountId UUID of service account\n * @param {JwkRsa} jwk Java Wek Key\n * @returns {string | null} Access token or null\n */\nexport async function getAccessTokenForServiceAccount(\n  serviceAccountId: string,\n  jwk: JwkRsa\n): Promise<string | null> {\n  debugMessage(`AuthenticateOps.getAccessTokenForServiceAccount: start`);\n  const payload = createPayload(serviceAccountId);\n  debugMessage(`AuthenticateOps.getAccessTokenForServiceAccount: payload:`);\n  debugMessage(payload);\n  const jwt = await createSignedJwtToken(payload, jwk);\n  debugMessage(`AuthenticateOps.getAccessTokenForServiceAccount: jwt:`);\n  debugMessage(jwt);\n  const bodyFormData = `assertion=${jwt}&client_id=service-account&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=${serviceAccountScopes}`;\n  const response = await accessToken(bodyFormData);\n  if ('access_token' in response.data) {\n    debugMessage(`AuthenticateOps.getAccessTokenForServiceAccount: token:`);\n    debugMessage(response.data.access_token);\n    debugMessage(`AuthenticateOps.getAccessTokenForServiceAccount: end`);\n    return response.data.access_token;\n  }\n  debugMessage(\n    `AuthenticateOps.getAccessTokenForServiceAccount: No access token in response.`\n  );\n  debugMessage(`AuthenticateOps.getAccessTokenForServiceAccount: end`);\n  return null;\n}\n\nasync function determineDeploymentTypeAndDefaultRealmAndVersion() {\n  debugMessage(\n    `AuthenticateOps.determineDeploymentTypeAndDefaultRealmAndVersion: start`\n  );\n  if (!state.getDeploymentType()) {\n    state.setDeploymentType(await determineDeploymentType());\n  }\n  determineDefaultRealm(state.getDeploymentType());\n  debugMessage(\n    `AuthenticateOps.determineDeploymentTypeAndDefaultRealmAndVersion: realm=${state.getRealm()}, type=${state.getDeploymentType()}`\n  );\n\n  const versionInfo = (await getServerVersionInfo()).data;\n\n  // https://github.com/rockcarver/frodo-cli/issues/109\n  debugMessage(`Full version: ${versionInfo.fullVersion}`);\n\n  const version = await getSemanticVersion(versionInfo);\n  state.setAmVersion(version);\n  debugMessage(\n    `AuthenticateOps.determineDeploymentTypeAndDefaultRealmAndVersion: end`\n  );\n}\n\nasync function getLoggedInSubject(): Promise<string> {\n  let subjectString = `user ${state.getUsername()}`;\n  if (state.getUseBearerTokenForAmApis()) {\n    const name = (\n      await getManagedObject('svcacct', state.getServiceAccountId(), ['name'])\n    ).data.name;\n    subjectString = `service account ${name} [${state.getServiceAccountId()}]`;\n  }\n  return subjectString;\n}\n\n/**\n * Get tokens\n * @param {boolean} save true to save a connection profile upon successful authentication, false otherwise\n * @returns {Promise<boolean>} true if tokens were successfully obtained, false otherwise\n */\nexport async function getTokens(): Promise<boolean> {\n  if (!state.getHost()) {\n    printMessage(\n      `No host specified and FRODO_HOST env variable not set!`,\n      'error'\n    );\n    return false;\n  }\n  try {\n    // if username/password on cli are empty, try to read from connections.json\n    if (\n      state.getUsername() == null &&\n      state.getPassword() == null &&\n      !state.getServiceAccountId() &&\n      !state.getServiceAccountJwk()\n    ) {\n      const conn = await getConnectionProfile();\n      if (conn) {\n        state.setHost(conn.tenant);\n        state.setUsername(conn.username);\n        state.setPassword(conn.password);\n        state.setAuthenticationService(conn.authenticationService);\n        state.setAuthenticationHeaderOverrides(\n          conn.authenticationHeaderOverrides\n        );\n        state.setServiceAccountId(conn.svcacctId);\n        state.setServiceAccountJwk(conn.svcacctJwk);\n      } else {\n        return false;\n      }\n    }\n    // now that we have the full tenant URL we can lookup the cookie name\n    state.setCookieName(await determineCookieName());\n\n    // use service account to login?\n    if (state.getServiceAccountId() && state.getServiceAccountJwk()) {\n      debugMessage(\n        `AuthenticateOps.getTokens: Authenticating with service account ${state.getServiceAccountId()}`\n      );\n      try {\n        const token = await getAccessTokenForServiceAccount(\n          state.getServiceAccountId(),\n          state.getServiceAccountJwk()\n        );\n        state.setBearerToken(token);\n        state.setUseBearerTokenForAmApis(true);\n        await determineDeploymentTypeAndDefaultRealmAndVersion();\n      } catch (saErr) {\n        throw new Error(\n          `Service account login error: ${\n            saErr.response?.data?.error_description ||\n            saErr.response?.data?.message\n          }`\n        );\n      }\n    }\n    // use user account to login\n    else if (state.getUsername() && state.getPassword()) {\n      debugMessage(\n        `AuthenticateOps.getTokens: Authenticating with user account ${state.getUsername()}`\n      );\n      const token = await authenticate(\n        state.getUsername(),\n        state.getPassword()\n      );\n      if (token) state.setCookieValue(token);\n      await determineDeploymentTypeAndDefaultRealmAndVersion();\n      if (\n        state.getCookieValue() &&\n        !state.getBearerToken() &&\n        (state.getDeploymentType() === globalConfig.CLOUD_DEPLOYMENT_TYPE_KEY ||\n          state.getDeploymentType() ===\n            globalConfig.FORGEOPS_DEPLOYMENT_TYPE_KEY)\n      ) {\n        const accessToken = await getAccessTokenForUser();\n        if (accessToken) state.setBearerToken(accessToken);\n      }\n    }\n    // incomplete or no credentials\n    else {\n      printMessage(`Incomplete or no credentials!`, 'error');\n      return false;\n    }\n    if (\n      state.getCookieValue() ||\n      (state.getUseBearerTokenForAmApis() && state.getBearerToken())\n    ) {\n      // https://github.com/rockcarver/frodo-cli/issues/102\n      printMessage(\n        `Connected to ${state.getHost()} [${\n          state.getRealm() ? state.getRealm() : 'root'\n        }] as ${await getLoggedInSubject()}`,\n        'info'\n      );\n      return true;\n    }\n  } catch (error) {\n    // regular error\n    printMessage(error.message, 'error');\n    // axios error am api\n    printMessage(error.response?.data?.message, 'error');\n    // axios error am oauth2 api\n    printMessage(error.response?.data?.error_description, 'error');\n    // axios error data\n    debugMessage(error.response?.data);\n    // stack trace\n    debugMessage(error.stack || new Error().stack);\n  }\n  return false;\n}\n"]}

package/types/ops/ConnectionProfileOps.d.ts

@@ -1,3 +1,32 @@
+import { JwkRsa } from './JoseOps';
+import { ObjectSkeletonInterface } from '../api/ApiTypes';
+export interface SecureConnectionProfileInterface {
+    tenant: string;
+    username?: string | null;
+    encodedPassword?: string | null;
+    logApiKey?: string | null;
+    encodedLogApiSecret?: string | null;
+    authenticationService?: string | null;
+    authenticationHeaderOverrides?: Record<string, string>;
+    svcacctId?: string | null;
+    encodedSvcacctJwk?: string | null;
+    svcacctName?: string | null;
+}
+export interface ConnectionProfileInterface {
+    tenant: string;
+    username?: string | null;
+    password?: string | null;
+    logApiKey?: string | null;
+    logApiSecret?: string | null;
+    authenticationService?: string | null;
+    authenticationHeaderOverrides?: Record<string, string>;
+    svcacctId?: string | null;
+    svcacctJwk?: JwkRsa;
+    svcacctName?: string | null;
+}
+export interface ConnectionsFileInterface {
+    [key: string]: SecureConnectionProfileInterface;
+}
 /**
  * Get connection profiles file name
  * @returns {String} connection profiles file name
@@ -10,42 +39,41 @@ export declare function getConnectionProfilesPath(): string;
 export declare function listConnectionProfiles(long?: boolean): void;
 /**
  * Initialize connection profiles
+ *
+ * This method is called from app.ts and runs before any of the message handlers are registered.
+ * Therefore none of the Console message functions will produce any output.
  */
-export declare function initConnectionProfiles(): void;
+export declare function initConnectionProfiles(): Promise<void>;
 /**
  * Get connection profile by host
  * @param {String} host host tenant host url or unique substring
  * @returns {Object} connection profile or null
  */
-export declare function getConnectionProfileByHost(host: any): Promise<{
-    tenant: any;
-    username: any;
-    password: any;
-    key: any;
-    secret: any;
-    authenticationService: any;
-    authenticationHeaderOverrides: any;
-}>;
+export declare function getConnectionProfileByHost(host: string): Promise<ConnectionProfileInterface>;
 /**
  * Get connection profile
  * @returns {Object} connection profile or null
  */
-export declare function getConnectionProfile(): Promise<{
-    tenant: any;
-    username: any;
-    password: any;
-    key: any;
-    secret: any;
-    authenticationService: any;
-    authenticationHeaderOverrides: any;
-}>;
+export declare function getConnectionProfile(): Promise<ConnectionProfileInterface>;
 /**
  * Save connection profile
+ * @param {string} host host url for new profiles or unique substring for existing profiles
+ * @returns {Promise<boolean>} true if the operation succeeded, false otherwise
  */
-export declare function saveConnectionProfile(): Promise<void>;
+export declare function saveConnectionProfile(host: string): Promise<boolean>;
 /**
  * Delete connection profile
  * @param {String} host host tenant host url or unique substring
  */
 export declare function deleteConnectionProfile(host: any): void;
-export declare function describeConnectionProfile(host: any, showSecrets: any): Promise<void>;
+/**
+ * Describe connection profile
+ * @param {string} host Host URL or unique substring
+ * @param {boolean} showSecrets Whether secrets should be shown in clear text or not
+ */
+export declare function describeConnectionProfile(host: string, showSecrets: boolean): Promise<void>;
+/**
+ * Create a new service account using auto-generated parameters
+ * @returns {Promise<ObjectSkeletonInterface>} A promise resolving to a service account object
+ */
+export declare function addNewServiceAccount(): Promise<ObjectSkeletonInterface>;

package/types/ops/ConnectionProfileOps.d.ts.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/ops/ConnectionProfileOps.ts"],"names":[],"mappings":"AAeA;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,MAAM,CAMlD;AAoBD;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,UAAQ,QA2BlD;AAED;;GAEG;AACH,wBAAgB,sBAAsB,SAkCrC;AAED;;;;GAIG;AACH,wBAAsB,0BAA0B,CAAC,IAAI,KAAA;;;;;;;;GA0CpD;AAED;;;GAGG;AACH,wBAAsB,oBAAoB;;;;;;;;GAEzC;AAED;;GAEG;AACH,wBAAsB,qBAAqB,kBAoD1C;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,KAAA,QAiC3C;AAED,wBAAsB,yBAAyB,CAAC,IAAI,KAAA,EAAE,WAAW,KAAA,iBAyBhE","file":"ConnectionProfileOps.d.ts","sourcesContent":["import fs from 'fs';\nimport os from 'os';\nimport path from 'path';\nimport storage from '../storage/SessionStorage';\nimport DataProtection from './utils/DataProtection';\nimport { createObjectTable, createTable, printMessage } from './utils/Console';\nimport { FRODO_CONNECTION_PROFILES_PATH_KEY } from '../storage/StaticStorage';\nimport { profile } from 'console';\n\nconst dataProtection = new DataProtection();\n\nconst fileOptions = {\n  indentation: 4,\n};\n\n/**\n * Get connection profiles file name\n * @returns {String} connection profiles file name\n */\nexport function getConnectionProfilesPath(): string {\n  return (\n    storage.session.getConnectionProfilesPath() ||\n    process.env[FRODO_CONNECTION_PROFILES_PATH_KEY] ||\n    `${os.homedir()}/.frodo/.frodorc`\n  );\n}\n\n/**\n * Find connection profile\n * @param {Object} connectionProfiles connection profile object\n * @param {String} host tenant host url or unique substring\n * @returns {Object} connection profile object or null\n */\nfunction findConnectionProfile(connectionProfiles, host) {\n  const profiles = [];\n  for (const tenant in connectionProfiles) {\n    if (tenant.includes(host)) {\n      const foundProfile = connectionProfiles[tenant];\n      foundProfile.tenant = tenant;\n      profiles.push(foundProfile);\n    }\n  }\n  return profiles;\n}\n\n/**\n * List connection profiles\n * @param {boolean} long Long list format with details\n */\nexport function listConnectionProfiles(long = false) {\n  const filename = getConnectionProfilesPath();\n  try {\n    const data = fs.readFileSync(filename, 'utf8');\n    const connectionsData = JSON.parse(data);\n    if (long) {\n      const table = createTable(['Host', 'Username', 'Log API Key']);\n      Object.keys(connectionsData).forEach((c) => {\n        table.push([\n          c,\n          connectionsData[c].username,\n          connectionsData[c].logApiKey,\n        ]);\n      });\n      printMessage(table.toString(), 'data');\n    } else {\n      Object.keys(connectionsData).forEach((c) => {\n        printMessage(`${c}`, 'data');\n      });\n    }\n    printMessage(\n      'Any unique substring of a saved host can be used as the value for host parameter in all commands',\n      'info'\n    );\n  } catch (e) {\n    printMessage(`No connections found in ${filename} (${e.message})`, 'error');\n  }\n}\n\n/**\n * Initialize connection profiles\n */\nexport function initConnectionProfiles() {\n  // create connections.json file if it doesn't exist\n  const filename = getConnectionProfilesPath();\n  const folderName = path.dirname(filename);\n  if (!fs.existsSync(folderName)) {\n    fs.mkdirSync(folderName, { recursive: true });\n    if (!fs.existsSync(filename)) {\n      fs.writeFileSync(\n        filename,\n        JSON.stringify({}, null, fileOptions.indentation)\n      );\n    }\n  }\n  // encrypt the password from clear text to aes-256-GCM\n  else {\n    const data = fs.readFileSync(filename, 'utf8');\n    const connectionsData = JSON.parse(data);\n    let convert = false;\n    Object.keys(connectionsData).forEach(async (conn) => {\n      if (connectionsData[conn].password) {\n        convert = true;\n        connectionsData[conn].encodedPassword = await dataProtection.encrypt(\n          connectionsData[conn].password\n        ); // Buffer.from(connectionsData[conn].password).toString('base64');\n        delete connectionsData[conn].password;\n      }\n    });\n    if (convert) {\n      fs.writeFileSync(\n        filename,\n        JSON.stringify(connectionsData, null, fileOptions.indentation)\n      );\n    }\n  }\n}\n\n/**\n * Get connection profile by host\n * @param {String} host host tenant host url or unique substring\n * @returns {Object} connection profile or null\n */\nexport async function getConnectionProfileByHost(host) {\n  try {\n    const filename = getConnectionProfilesPath();\n    const connectionsData = JSON.parse(fs.readFileSync(filename, 'utf8'));\n    const profiles = findConnectionProfile(connectionsData, host);\n    if (profiles.length == 0) {\n      printMessage(\n        `Profile for ${host} not found. Please specify credentials on command line`,\n        'error'\n      );\n      return null;\n    }\n    if (profiles.length > 1) {\n      printMessage(`Multiple matching profiles found.`, 'error');\n      profiles.forEach((p) => {\n        printMessage(`- ${p.tenant}`, 'error');\n      });\n      printMessage(`Please specify a unique sub-string`, 'error');\n      return null;\n    }\n    return {\n      tenant: profiles[0].tenant,\n      username: profiles[0].username ? profiles[0].username : null,\n      password: profiles[0].encodedPassword\n        ? await dataProtection.decrypt(profiles[0].encodedPassword)\n        : null,\n      key: profiles[0].logApiKey ? profiles[0].logApiKey : null,\n      secret: profiles[0].logApiSecret ? profiles[0].logApiSecret : null,\n      authenticationService: profiles[0].authenticationService\n        ? profiles[0].authenticationService\n        : null,\n      authenticationHeaderOverrides: profiles[0].authenticationHeaderOverrides\n        ? profiles[0].authenticationHeaderOverrides\n        : {},\n    };\n  } catch (e) {\n    printMessage(\n      `Can not read saved connection info, please specify credentials on command line: ${e}`,\n      'error'\n    );\n    return null;\n  }\n}\n\n/**\n * Get connection profile\n * @returns {Object} connection profile or null\n */\nexport async function getConnectionProfile() {\n  return getConnectionProfileByHost(storage.session.getTenant());\n}\n\n/**\n * Save connection profile\n */\nexport async function saveConnectionProfile() {\n  const filename = getConnectionProfilesPath();\n  printMessage(`Saving creds in ${filename}...`);\n  let connectionsData = {};\n  let existingData = {};\n  try {\n    fs.statSync(filename);\n    const data = fs.readFileSync(filename, 'utf8');\n    connectionsData = JSON.parse(data);\n    if (connectionsData[storage.session.getTenant()]) {\n      existingData = connectionsData[storage.session.getTenant()];\n      printMessage(\n        `Updating connection profile ${storage.session.getTenant()}`\n      );\n    } else\n      printMessage(`Adding connection profile ${storage.session.getTenant()}`);\n  } catch (e) {\n    printMessage(\n      `Creating connection profiles file ${filename} with ${storage.session.getTenant()}`\n    );\n  }\n  if (storage.session.getUsername())\n    existingData['username'] = storage.session.getUsername();\n  if (storage.session.getPassword())\n    existingData['encodedPassword'] = await dataProtection.encrypt(\n      storage.session.getPassword()\n    );\n  if (storage.session.getLogApiKey())\n    existingData['logApiKey'] = storage.session.getLogApiKey();\n  if (storage.session.getLogApiSecret())\n    existingData['logApiSecret'] = storage.session.getLogApiSecret();\n\n  // advanced settings\n  if (storage.session.getAuthenticationService()) {\n    existingData['authenticationService'] =\n      storage.session.getAuthenticationService();\n    printMessage(\n      'Advanced setting: Authentication Service: ' +\n        storage.session.getAuthenticationService(),\n      'info'\n    );\n  }\n  if (storage.session.getAuthenticationHeaderOverrides()) {\n    existingData['authenticationHeaderOverrides'] =\n      storage.session.getAuthenticationHeaderOverrides();\n    printMessage('Advanced setting: Authentication Header Overrides: ', 'info');\n    printMessage(storage.session.getAuthenticationHeaderOverrides(), 'info');\n  }\n\n  connectionsData[storage.session.getTenant()] = existingData;\n\n  fs.writeFileSync(filename, JSON.stringify(connectionsData, null, 2));\n}\n\n/**\n * Delete connection profile\n * @param {String} host host tenant host url or unique substring\n */\nexport function deleteConnectionProfile(host) {\n  const filename = getConnectionProfilesPath();\n  let connectionsData = {};\n  fs.stat(filename, (err) => {\n    if (err == null) {\n      const data = fs.readFileSync(filename, 'utf8');\n      connectionsData = JSON.parse(data);\n      const profiles = findConnectionProfile(connectionsData, host);\n      if (profiles.length == 1) {\n        printMessage(`Deleting connection profile ${profiles[0].tenant}`);\n        delete connectionsData[profiles[0].tenant];\n        fs.writeFileSync(filename, JSON.stringify(connectionsData, null, 2));\n      } else {\n        if (profiles.length > 1) {\n          printMessage(`Multiple matching profiles found.`, 'error');\n          profiles.forEach((p) => {\n            printMessage(`- ${p.tenant}`, 'error');\n          });\n          printMessage(`Please specify a unique sub-string`, 'error');\n          return null;\n        } else {\n          printMessage(`No connection profile ${host} found`);\n        }\n      }\n    } else if (err.code === 'ENOENT') {\n      printMessage(`Connection profile file ${filename} not found`);\n    } else {\n      printMessage(\n        `Error in deleting connection profile: ${err.code}`,\n        'error'\n      );\n    }\n  });\n}\n\nexport async function describeConnectionProfile(host, showSecrets) {\n  const profile = await getConnectionProfileByHost(host);\n  if (profile) {\n    if (!showSecrets) {\n      delete profile.password;\n      delete profile.secret;\n    }\n    if (!profile.key) {\n      delete profile.key;\n      delete profile.secret;\n    }\n    const keyMap = {\n      tenant: 'Host',\n      username: 'Username',\n      password: 'Password',\n      key: 'Log API Key',\n      secret: 'Log API Secret',\n      authenticationService: 'Authentication Service',\n      authenticationHeaderOverrides: 'Authentication Header Overrides',\n    };\n    const table = createObjectTable(profile, keyMap);\n    printMessage(table.toString(), 'data');\n  } else {\n    printMessage(`No connection profile ${host} found`);\n  }\n}\n"]}
+{"version":3,"sources":["../src/ops/ConnectionProfileOps.ts"],"names":[],"mappings":"AAaA,OAAO,EAA6C,MAAM,EAAE,MAAM,WAAW,CAAC;AAE9E,OAAO,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAU1D,MAAM,WAAW,gCAAgC;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,6BAA6B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvD,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,6BAA6B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvD,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,wBAAwB;IACvC,CAAC,GAAG,EAAE,MAAM,GAAG,gCAAgC,CAAC;CACjD;AAKD;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,MAAM,CAMlD;AAuBD;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,UAAQ,QA2BlD;AAeD;;;;;GAKG;AACH,wBAAsB,sBAAsB,kBAiD3C;AAED;;;;GAIG;AACH,wBAAsB,0BAA0B,CAC9C,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,0BAA0B,CAAC,CAgDrC;AAED;;;GAGG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,0BAA0B,CAAC,CAEhF;AAED;;;;GAIG;AACH,wBAAsB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CA4F1E;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,KAAA,QAiC3C;AAED;;;;GAIG;AACH,wBAAsB,yBAAyB,CAC7C,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,OAAO,iBAgDrB;AAED;;;GAGG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAqB7E","file":"ConnectionProfileOps.d.ts","sourcesContent":["import fs from 'fs';\nimport os from 'os';\nimport path from 'path';\nimport * as state from '../shared/State';\nimport DataProtection from './utils/DataProtection';\nimport {\n  createObjectTable,\n  createTable,\n  debugMessage,\n  printMessage,\n  verboseMessage,\n} from './utils/Console';\nimport { FRODO_CONNECTION_PROFILES_PATH_KEY } from '../storage/StaticStorage';\nimport { createJwkRsa, createJwks, getJwkRsaPublic, JwkRsa } from './JoseOps';\nimport { createServiceAccount } from './ServiceAccountOps';\nimport { ObjectSkeletonInterface } from '../api/ApiTypes';\nimport { saveJsonToFile } from './utils/ExportImportUtils';\nimport { isValidUrl } from './utils/OpsUtils';\n\nconst crypto = new DataProtection();\n\nconst fileOptions = {\n  indentation: 4,\n};\n\nexport interface SecureConnectionProfileInterface {\n  tenant: string;\n  username?: string | null;\n  encodedPassword?: string | null;\n  logApiKey?: string | null;\n  encodedLogApiSecret?: string | null;\n  authenticationService?: string | null;\n  authenticationHeaderOverrides?: Record<string, string>;\n  svcacctId?: string | null;\n  encodedSvcacctJwk?: string | null;\n  svcacctName?: string | null;\n}\n\nexport interface ConnectionProfileInterface {\n  tenant: string;\n  username?: string | null;\n  password?: string | null;\n  logApiKey?: string | null;\n  logApiSecret?: string | null;\n  authenticationService?: string | null;\n  authenticationHeaderOverrides?: Record<string, string>;\n  svcacctId?: string | null;\n  svcacctJwk?: JwkRsa;\n  svcacctName?: string | null;\n}\n\nexport interface ConnectionsFileInterface {\n  [key: string]: SecureConnectionProfileInterface;\n}\n\nconst legacyProfileFilename = '.frodorc';\nconst newProfileFilename = 'Connections.json';\n\n/**\n * Get connection profiles file name\n * @returns {String} connection profiles file name\n */\nexport function getConnectionProfilesPath(): string {\n  return (\n    state.getConnectionProfilesPath() ||\n    process.env[FRODO_CONNECTION_PROFILES_PATH_KEY] ||\n    `${os.homedir()}/.frodo/${newProfileFilename}`\n  );\n}\n\n/**\n * Find connection profiles\n * @param {ConnectionsFileInterface} connectionProfiles connection profile object\n * @param {string} host host url or unique substring\n * @returns {SecureConnectionProfileInterface[]} Array of connection profiles\n */\nfunction findConnectionProfiles(\n  connectionProfiles: ConnectionsFileInterface,\n  host: string\n): SecureConnectionProfileInterface[] {\n  const profiles: SecureConnectionProfileInterface[] = [];\n  for (const tenant in connectionProfiles) {\n    if (tenant.includes(host)) {\n      const foundProfile = { ...connectionProfiles[tenant] };\n      foundProfile.tenant = tenant;\n      profiles.push(foundProfile);\n    }\n  }\n  return profiles;\n}\n\n/**\n * List connection profiles\n * @param {boolean} long Long list format with details\n */\nexport function listConnectionProfiles(long = false) {\n  const filename = getConnectionProfilesPath();\n  try {\n    const data = fs.readFileSync(filename, 'utf8');\n    const connectionsData = JSON.parse(data);\n    if (long) {\n      const table = createTable(['Host', 'Username', 'Log API Key']);\n      Object.keys(connectionsData).forEach((c) => {\n        table.push([\n          c,\n          connectionsData[c].username,\n          connectionsData[c].logApiKey,\n        ]);\n      });\n      printMessage(table.toString(), 'data');\n    } else {\n      Object.keys(connectionsData).forEach((c) => {\n        printMessage(`${c}`, 'data');\n      });\n    }\n    printMessage(\n      'Any unique substring of a saved host can be used as the value for host parameter in all commands',\n      'info'\n    );\n  } catch (e) {\n    printMessage(`No connections found in ${filename} (${e.message})`, 'error');\n  }\n}\n\n/**\n * Migrate from .frodorc to Connections.json\n */\nfunction migrateFromLegacyProfile() {\n  const legacyPath = `${os.homedir()}/.frodo/${legacyProfileFilename}`;\n  if (fs.existsSync(legacyPath)) {\n    fs.copyFileSync(legacyPath, `${os.homedir()}/.frodo/${newProfileFilename}`);\n    // for now, just add a \"deprecated\" suffix. May delete the old file\n    // in a future release\n    fs.renameSync(legacyPath, `${legacyPath}.deprecated`);\n  }\n}\n\n/**\n * Initialize connection profiles\n *\n * This method is called from app.ts and runs before any of the message handlers are registered.\n * Therefore none of the Console message functions will produce any output.\n */\nexport async function initConnectionProfiles() {\n  // create connections.json file if it doesn't exist\n  const filename = getConnectionProfilesPath();\n  const folderName = path.dirname(filename);\n  if (!fs.existsSync(folderName)) {\n    fs.mkdirSync(folderName, { recursive: true });\n    if (!fs.existsSync(filename)) {\n      fs.writeFileSync(\n        filename,\n        JSON.stringify({}, null, fileOptions.indentation)\n      );\n    }\n  }\n  // encrypt the password and logApiSecret from clear text to aes-256-GCM\n  else {\n    migrateFromLegacyProfile();\n    const data = fs.readFileSync(filename, 'utf8');\n    const connectionsData: ConnectionsFileInterface = JSON.parse(data);\n    let convert = false;\n    for (const conn of Object.keys(connectionsData)) {\n      if (connectionsData[conn]['password']) {\n        convert = true;\n        connectionsData[conn].encodedPassword = await crypto.encrypt(\n          connectionsData[conn]['password']\n        );\n        delete connectionsData[conn]['password'];\n      }\n      if (connectionsData[conn]['logApiSecret']) {\n        convert = true;\n        connectionsData[conn].encodedLogApiSecret = await crypto.encrypt(\n          connectionsData[conn]['logApiSecret']\n        );\n        delete connectionsData[conn]['logApiSecret'];\n      }\n      if (connectionsData[conn]['svcacctJwk']) {\n        convert = true;\n        connectionsData[conn].encodedSvcacctJwk = await crypto.encrypt(\n          connectionsData[conn]['svcacctJwk']\n        );\n        delete connectionsData[conn]['svcacctJwk'];\n      }\n    }\n    if (convert) {\n      fs.writeFileSync(\n        filename,\n        JSON.stringify(connectionsData, null, fileOptions.indentation)\n      );\n    }\n  }\n}\n\n/**\n * Get connection profile by host\n * @param {String} host host tenant host url or unique substring\n * @returns {Object} connection profile or null\n */\nexport async function getConnectionProfileByHost(\n  host: string\n): Promise<ConnectionProfileInterface> {\n  try {\n    const filename = getConnectionProfilesPath();\n    const connectionsData = JSON.parse(fs.readFileSync(filename, 'utf8'));\n    const profiles = findConnectionProfiles(connectionsData, host);\n    if (profiles.length == 0) {\n      printMessage(\n        `Profile for ${host} not found. Please specify credentials on command line`,\n        'error'\n      );\n      return null;\n    }\n    if (profiles.length > 1) {\n      printMessage(`Multiple matching profiles found.`, 'error');\n      profiles.forEach((p) => {\n        printMessage(`- ${p.tenant}`, 'error');\n      });\n      printMessage(`Please specify a unique sub-string`, 'error');\n      return null;\n    }\n    return {\n      tenant: profiles[0].tenant,\n      username: profiles[0].username ? profiles[0].username : null,\n      password: profiles[0].encodedPassword\n        ? await crypto.decrypt(profiles[0].encodedPassword)\n        : null,\n      logApiKey: profiles[0].logApiKey ? profiles[0].logApiKey : null,\n      logApiSecret: profiles[0].encodedLogApiSecret\n        ? await crypto.decrypt(profiles[0].encodedLogApiSecret)\n        : null,\n      authenticationService: profiles[0].authenticationService\n        ? profiles[0].authenticationService\n        : null,\n      authenticationHeaderOverrides: profiles[0].authenticationHeaderOverrides\n        ? profiles[0].authenticationHeaderOverrides\n        : {},\n      svcacctId: profiles[0].svcacctId ? profiles[0].svcacctId : null,\n      svcacctJwk: profiles[0].encodedSvcacctJwk\n        ? await crypto.decrypt(profiles[0].encodedSvcacctJwk)\n        : null,\n    };\n  } catch (e) {\n    printMessage(\n      `Can not read saved connection info, please specify credentials on command line: ${e}`,\n      'error'\n    );\n    return null;\n  }\n}\n\n/**\n * Get connection profile\n * @returns {Object} connection profile or null\n */\nexport async function getConnectionProfile(): Promise<ConnectionProfileInterface> {\n  return getConnectionProfileByHost(state.getHost());\n}\n\n/**\n * Save connection profile\n * @param {string} host host url for new profiles or unique substring for existing profiles\n * @returns {Promise<boolean>} true if the operation succeeded, false otherwise\n */\nexport async function saveConnectionProfile(host: string): Promise<boolean> {\n  const filename = getConnectionProfilesPath();\n  verboseMessage(`Saving connection profile in ${filename}`);\n  let profiles: ConnectionsFileInterface = {};\n  let profile: SecureConnectionProfileInterface = { tenant: '' };\n  try {\n    fs.statSync(filename);\n    const data = fs.readFileSync(filename, 'utf8');\n    profiles = JSON.parse(data);\n\n    // find tenant\n    const found = findConnectionProfiles(profiles, host);\n\n    // replace tenant in session with real tenant url if necessary\n    if (found.length === 1) {\n      profile = found[0];\n      state.setHost(profile.tenant);\n      verboseMessage(`Existing profile: ${profile.tenant}`);\n    }\n\n    // connection profile not found, validate host is a real URL\n    if (found.length === 0) {\n      if (isValidUrl(host)) {\n        state.setHost(host);\n        verboseMessage(`New profile: ${host}`);\n      } else {\n        printMessage(\n          `No existing profile found matching '${host}'. Provide a valid URL as the host argument to create a new profile.`,\n          'error'\n        );\n        return false;\n      }\n    }\n  } catch (error) {\n    verboseMessage(`New profiles file ${filename} with new profile ${host}`);\n  }\n\n  // user account\n  if (state.getUsername()) profile.username = state.getUsername();\n  if (state.getPassword())\n    profile.encodedPassword = await crypto.encrypt(state.getPassword());\n\n  // log API\n  if (state.getLogApiKey()) profile.logApiKey = state.getLogApiKey();\n  if (state.getLogApiSecret())\n    profile.encodedLogApiSecret = await crypto.encrypt(state.getLogApiSecret());\n\n  // service account\n  if (state.getServiceAccountId())\n    profile.svcacctId = state.getServiceAccountId();\n  if (state.getServiceAccountJwk())\n    profile.encodedSvcacctJwk = await crypto.encrypt(\n      state.getServiceAccountJwk()\n    );\n\n  // advanced settings\n  if (state.getAuthenticationService()) {\n    profile.authenticationService = state.getAuthenticationService();\n    printMessage(\n      'Advanced setting: Authentication Service: ' +\n        state.getAuthenticationService(),\n      'info'\n    );\n  }\n  if (\n    state.getAuthenticationHeaderOverrides() &&\n    Object.entries(state.getAuthenticationHeaderOverrides()).length\n  ) {\n    profile.authenticationHeaderOverrides =\n      state.getAuthenticationHeaderOverrides();\n    printMessage('Advanced setting: Authentication Header Overrides: ', 'info');\n    printMessage(state.getAuthenticationHeaderOverrides(), 'info');\n  }\n\n  // remove the helper key 'tenant'\n  delete profile.tenant;\n\n  // update profiles\n  profiles[state.getHost()] = profile;\n\n  // sort profiles\n  const orderedProfiles = Object.keys(profiles)\n    .sort()\n    .reduce((obj, key) => {\n      obj[key] = profiles[key];\n      return obj;\n    }, {});\n\n  // save profiles\n  saveJsonToFile(orderedProfiles, filename, false);\n  verboseMessage(`Saved connection profile ${state.getHost()} in ${filename}`);\n  return true;\n}\n\n/**\n * Delete connection profile\n * @param {String} host host tenant host url or unique substring\n */\nexport function deleteConnectionProfile(host) {\n  const filename = getConnectionProfilesPath();\n  let connectionsData: ConnectionsFileInterface = {};\n  fs.stat(filename, (err) => {\n    if (err == null) {\n      const data = fs.readFileSync(filename, 'utf8');\n      connectionsData = JSON.parse(data);\n      const profiles = findConnectionProfiles(connectionsData, host);\n      if (profiles.length == 1) {\n        delete connectionsData[profiles[0].tenant];\n        fs.writeFileSync(filename, JSON.stringify(connectionsData, null, 2));\n        printMessage(`Deleted connection profile ${profiles[0].tenant}`);\n      } else {\n        if (profiles.length > 1) {\n          printMessage(`Multiple matching profiles found.`, 'error');\n          profiles.forEach((p) => {\n            printMessage(`- ${p.tenant}`, 'error');\n          });\n          printMessage(`Please specify a unique sub-string`, 'error');\n          return null;\n        } else {\n          printMessage(`No connection profile ${host} found`);\n        }\n      }\n    } else if (err.code === 'ENOENT') {\n      printMessage(`Connection profile file ${filename} not found`);\n    } else {\n      printMessage(\n        `Error in deleting connection profile: ${err.code}`,\n        'error'\n      );\n    }\n  });\n}\n\n/**\n * Describe connection profile\n * @param {string} host Host URL or unique substring\n * @param {boolean} showSecrets Whether secrets should be shown in clear text or not\n */\nexport async function describeConnectionProfile(\n  host: string,\n  showSecrets: boolean\n) {\n  const profile = await getConnectionProfileByHost(host);\n  if (profile) {\n    const present = '[present]';\n    const jwk = profile.svcacctJwk;\n    if (!showSecrets) {\n      if (profile.password) profile.password = present;\n      if (profile.logApiSecret) profile.logApiSecret = present;\n      if (profile.svcacctJwk) (profile as unknown)['svcacctJwk'] = present;\n    }\n    if (!profile.username) {\n      delete profile.username;\n      delete profile.password;\n    }\n    if (!profile.logApiKey) {\n      delete profile.logApiKey;\n      delete profile.logApiSecret;\n    }\n    if (!profile.svcacctId) {\n      delete profile.svcacctId;\n      delete profile.svcacctJwk;\n    }\n    if (showSecrets && jwk) {\n      (profile as unknown)['svcacctJwk'] = 'see below';\n    }\n    if (!profile.authenticationService) {\n      delete profile.authenticationService;\n    }\n    const keyMap = {\n      tenant: 'Host',\n      username: 'Username',\n      password: 'Password',\n      logApiKey: 'Log API Key',\n      logApiSecret: 'Log API Secret',\n      authenticationService: 'Authentication Service',\n      authenticationHeaderOverrides: 'Authentication Header Overrides',\n      svcacctId: 'Service Account Id',\n      svcacctJwk: 'Service Account JWK',\n    };\n    const table = createObjectTable(profile, keyMap);\n    printMessage(table.toString(), 'data');\n    if (showSecrets && jwk) {\n      printMessage(jwk, 'data');\n    }\n  } else {\n    printMessage(`No connection profile ${host} found`);\n  }\n}\n\n/**\n * Create a new service account using auto-generated parameters\n * @returns {Promise<ObjectSkeletonInterface>} A promise resolving to a service account object\n */\nexport async function addNewServiceAccount(): Promise<ObjectSkeletonInterface> {\n  debugMessage(`ConnectionProfileOps.addNewServiceAccount: start`);\n  const name = `Frodo-SA-${new Date().getTime()}`;\n  debugMessage(`ConnectionProfileOps.addNewServiceAccount: name=${name}...`);\n  const description = `${state.getUsername()}'s Frodo Service Account`;\n  const scope = ['fr:am:*', 'fr:idm:*', 'fr:idc:esv:*'];\n  const jwkPrivate = await createJwkRsa();\n  const jwkPublic = await getJwkRsaPublic(jwkPrivate);\n  const jwks = createJwks(jwkPublic);\n  const sa = await createServiceAccount(\n    name,\n    description,\n    'Active',\n    scope,\n    jwks\n  );\n  debugMessage(`ConnectionProfileOps.addNewServiceAccount: id=${sa._id}`);\n  state.setServiceAccountId(sa._id);\n  state.setServiceAccountJwk(jwkPrivate);\n  debugMessage(`ConnectionProfileOps.addNewServiceAccount: end`);\n  return sa;\n}\n"]}

package/types/ops/EmailTemplateOps.d.ts

@@ -1,41 +1,22 @@
 /**
- * List email templates
- * @param {boolean} long Long list format with details
- * @return {Promise<unknown[]>} a promise that resolves to an array of email template objects
+ * Email template type key used to build the IDM id: 'emailTemplate/<id>'
  */
-export declare function listEmailTemplates(long?: boolean): Promise<unknown[]>;
+export declare const EMAIL_TEMPLATE_TYPE = "emailTemplate";
 /**
- * Export a single email template to file
- * @param {String} templateId email template id
- * @param {String} file optional filename
+ * Get all email templates
+ * @returns {Promise} a promise that resolves to an array of email template objects
  */
-export declare function exportEmailTemplateToFile(templateId: any, file: any): Promise<void>;
+export declare function getEmailTemplates(): Promise<any>;
 /**
- * Export all email templates to file
- * @param {String} file optional filename
+ * Get email template
+ * @param {string} templateId id/name of the email template without the type prefix
+ * @returns {Promise} a promise that resolves an email template object
  */
-export declare function exportEmailTemplatesToFile(file: any): Promise<void>;
+export declare function getEmailTemplate(templateId: any): Promise<any>;
 /**
- * Export all email templates to separate files
+ * Put email template
+ * @param {string} templateId id/name of the email template without the type prefix
+ * @param {Object} templateData email template object
+ * @returns {Promise} a promise that resolves to an email template object
  */
-export declare function exportEmailTemplatesToFiles(): Promise<void>;
-/**
- * Import email template by id from file
- * @param {String} templateId email template id
- * @param {String} file optional filename
- */
-export declare function importEmailTemplateFromFile(templateId: any, file: any): Promise<void>;
-/**
- * Import all email templates from file
- * @param {String} file optional filename
- */
-export declare function importEmailTemplatesFromFile(file: any): Promise<void>;
-/**
- * Import all email templates from separate files
- */
-export declare function importEmailTemplatesFromFiles(): Promise<void>;
-/**
- * Import first email template from file
- * @param {String} file optional filename
- */
-export declare function importFirstEmailTemplateFromFile(file: any): Promise<void>;
+export declare function putEmailTemplate(templateId: any, templateData: any): Promise<any>;

package/types/ops/EmailTemplateOps.d.ts.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/ops/EmailTemplateOps.ts"],"names":[],"mappings":"AAuCA;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,IAAI,UAAQ,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAmDzE;AAED;;;;GAIG;AACH,wBAAsB,yBAAyB,CAAC,UAAU,KAAA,EAAE,IAAI,KAAA,iBAmB/D;AAED;;;GAGG;AACH,wBAAsB,0BAA0B,CAAC,IAAI,KAAA,iBAuBpD;AAED;;GAEG;AACH,wBAAsB,2BAA2B,kBAkBhD;AAED;;;;GAIG;AACH,wBAAsB,2BAA2B,CAAC,UAAU,KAAA,EAAE,IAAI,KAAA,iBAiCjE;AAED;;;GAGG;AACH,wBAAsB,4BAA4B,CAAC,IAAI,KAAA,iBA8BtD;AAED;;GAEG;AACH,wBAAsB,6BAA6B,kBAyClD;AAED;;;GAGG;AACH,wBAAsB,gCAAgC,CAAC,IAAI,KAAA,iBA2B1D","file":"EmailTemplateOps.d.ts","sourcesContent":["import fs from 'fs';\nimport {\n  EMAIL_TEMPLATE_TYPE,\n  getEmailTemplate,\n  getEmailTemplates,\n  putEmailTemplate,\n} from '../api/EmailTemplateApi';\nimport {\n  createProgressIndicator,\n  createTable,\n  printMessage,\n  stopProgressIndicator,\n  updateProgressIndicator,\n} from './utils/Console';\nimport {\n  getTypedFilename,\n  saveJsonToFile,\n  validateImport,\n} from './utils/ExportImportUtils';\nimport wordwrap from './utils/Wordwrap';\n\n/**\n * Regex to remove email template type from id\n */\nconst regexEmailTemplateType = new RegExp(`${EMAIL_TEMPLATE_TYPE}/`, 'g');\n\n/**\n * Maintain the file type centrally\n */\nconst EMAIL_TEMPLATE_FILE_TYPE = 'template.email';\n\n// use a function vs a template variable to avoid problems in loops\nfunction getFileDataTemplate() {\n  return {\n    meta: {},\n    emailTemplate: {},\n  };\n}\n\n/**\n * List email templates\n * @param {boolean} long Long list format with details\n * @return {Promise<unknown[]>} a promise that resolves to an array of email template objects\n */\nexport async function listEmailTemplates(long = false): Promise<unknown[]> {\n  let emailTemplates = [];\n  try {\n    emailTemplates = (await getEmailTemplates()).result;\n  } catch (error) {\n    printMessage(`Error retrieving email templates: ${error.message}`, 'error');\n  }\n  emailTemplates.sort((a, b) => a._id.localeCompare(b._id));\n  if (!long) {\n    for (const [, emailTemplate] of emailTemplates.entries()) {\n      printMessage(\n        `${emailTemplate._id.replace(`${EMAIL_TEMPLATE_TYPE}/`, '')}`,\n        'data'\n      );\n    }\n  } else {\n    const table = createTable([\n      'Id'['brightCyan'],\n      'Name'['brightCyan'],\n      'Status'['brightCyan'],\n      'Locale(s)'['brightCyan'],\n      'From'['brightCyan'],\n      'Subject'['brightCyan'],\n    ]);\n    for (const emailTemplate of emailTemplates) {\n      table.push([\n        // Id\n        `${emailTemplate._id.replace(`${EMAIL_TEMPLATE_TYPE}/`, '')}`,\n        // Name\n        `${emailTemplate.displayName ? emailTemplate.displayName : ''}`,\n        // Status\n        emailTemplate.enabled === false\n          ? 'disabled'['brightRed']\n          : 'enabled'['brightGreen'],\n        // Locale(s)\n        `${emailTemplate.defaultLocale}${\n          Object.keys(emailTemplate.subject).length > 1\n            ? ` (${Object.keys(emailTemplate.subject)\n                .filter((locale) => locale !== emailTemplate.defaultLocale)\n                .join(',')})`\n            : ''\n        }`,\n        // From\n        `${emailTemplate.from ? emailTemplate.from : ''}`,\n        // Subject\n        wordwrap(emailTemplate.subject[emailTemplate.defaultLocale], 40),\n      ]);\n    }\n    printMessage(table.toString(), 'data');\n  }\n  return emailTemplates;\n}\n\n/**\n * Export a single email template to file\n * @param {String} templateId email template id\n * @param {String} file optional filename\n */\nexport async function exportEmailTemplateToFile(templateId, file) {\n  let fileName = file;\n  if (!fileName) {\n    fileName = getTypedFilename(templateId, EMAIL_TEMPLATE_FILE_TYPE);\n  }\n  createProgressIndicator(1, `Exporting ${templateId}`);\n  try {\n    const templateData = await getEmailTemplate(templateId);\n    updateProgressIndicator(`Writing file ${fileName}`);\n    const fileData = getFileDataTemplate();\n    fileData.emailTemplate[templateId] = templateData;\n    saveJsonToFile(fileData, fileName);\n    stopProgressIndicator(\n      `Exported ${templateId.brightCyan} to ${fileName.brightCyan}.`\n    );\n  } catch (err) {\n    stopProgressIndicator(`${err}`);\n    printMessage(err, 'error');\n  }\n}\n\n/**\n * Export all email templates to file\n * @param {String} file optional filename\n */\nexport async function exportEmailTemplatesToFile(file) {\n  let fileName = file;\n  if (!fileName) {\n    fileName = getTypedFilename(`allEmailTemplates`, EMAIL_TEMPLATE_FILE_TYPE);\n  }\n  try {\n    const fileData = getFileDataTemplate();\n    const response = await getEmailTemplates();\n    const templates = response.result;\n    createProgressIndicator(response.resultCount, 'Exporting email templates');\n    for (const template of templates) {\n      const templateId = template._id.replace(`${EMAIL_TEMPLATE_TYPE}/`, '');\n      updateProgressIndicator(`Exporting ${templateId}`);\n      fileData.emailTemplate[templateId] = template;\n    }\n    saveJsonToFile(fileData, fileName);\n    stopProgressIndicator(\n      `${response.resultCount} templates exported to ${fileName}.`\n    );\n  } catch (err) {\n    stopProgressIndicator(`${err}`);\n    printMessage(err, 'error');\n  }\n}\n\n/**\n * Export all email templates to separate files\n */\nexport async function exportEmailTemplatesToFiles() {\n  try {\n    const response = await getEmailTemplates();\n    const templates = response.result;\n    createProgressIndicator(response.resultCount, 'Exporting email templates');\n    for (const template of templates) {\n      const templateId = template._id.replace(`${EMAIL_TEMPLATE_TYPE}/`, '');\n      const fileName = getTypedFilename(templateId, EMAIL_TEMPLATE_FILE_TYPE);\n      const fileData = getFileDataTemplate();\n      updateProgressIndicator(`Exporting ${templateId}`);\n      fileData.emailTemplate[templateId] = template;\n      saveJsonToFile(fileData, fileName);\n    }\n    stopProgressIndicator(`${response.resultCount} templates exported.`);\n  } catch (err) {\n    stopProgressIndicator(`${err}`);\n    printMessage(err, 'error');\n  }\n}\n\n/**\n * Import email template by id from file\n * @param {String} templateId email template id\n * @param {String} file optional filename\n */\nexport async function importEmailTemplateFromFile(templateId, file) {\n  // eslint-disable-next-line no-param-reassign\n  templateId = templateId.replaceAll(`${EMAIL_TEMPLATE_TYPE}/`, '');\n  fs.readFile(file, 'utf8', async (err, data) => {\n    if (err) throw err;\n    const fileData = JSON.parse(data);\n    if (validateImport(fileData.meta)) {\n      createProgressIndicator(1, `Importing ${templateId}`);\n      if (fileData.emailTemplate[templateId]) {\n        try {\n          await putEmailTemplate(\n            templateId,\n            fileData.emailTemplate[templateId]\n          );\n          updateProgressIndicator(`Importing ${templateId}`);\n          stopProgressIndicator(`Imported ${templateId}`);\n        } catch (putEmailTemplateError) {\n          stopProgressIndicator(`${putEmailTemplateError}`);\n          printMessage(putEmailTemplateError, 'error');\n        }\n      } else {\n        stopProgressIndicator(\n          `Email template ${templateId.brightCyan} not found in ${file.brightCyan}!`\n        );\n        printMessage(\n          `Email template ${templateId.brightCyan} not found in ${file.brightCyan}!`,\n          'error'\n        );\n      }\n    } else {\n      printMessage('Import validation failed...', 'error');\n    }\n  });\n}\n\n/**\n * Import all email templates from file\n * @param {String} file optional filename\n */\nexport async function importEmailTemplatesFromFile(file) {\n  fs.readFile(file, 'utf8', async (err, data) => {\n    if (err) throw err;\n    const fileData = JSON.parse(data);\n    if (validateImport(fileData.meta)) {\n      createProgressIndicator(\n        Object.keys(fileData.emailTemplate).length,\n        `Importing email templates`\n      );\n      for (const id in fileData.emailTemplate) {\n        if ({}.hasOwnProperty.call(fileData.emailTemplate, id)) {\n          const templateId = id.replace(regexEmailTemplateType, '');\n          try {\n            // eslint-disable-next-line no-await-in-loop\n            await putEmailTemplate(\n              templateId,\n              fileData.emailTemplate[templateId]\n            );\n            updateProgressIndicator(`Imported ${templateId}`);\n          } catch (putEmailTemplateError) {\n            printMessage(`\\nError importing ${templateId}`, 'error');\n            printMessage(putEmailTemplateError.response.data, 'error');\n          }\n        }\n      }\n      stopProgressIndicator(`Done.`);\n    } else {\n      printMessage('Import validation failed...', 'error');\n    }\n  });\n}\n\n/**\n * Import all email templates from separate files\n */\nexport async function importEmailTemplatesFromFiles() {\n  const names = fs.readdirSync('.');\n  const jsonFiles = names.filter((name) =>\n    name.toLowerCase().endsWith(`${EMAIL_TEMPLATE_FILE_TYPE}.json`)\n  );\n  createProgressIndicator(jsonFiles.length, 'Importing email templates...');\n  let total = 0;\n  let totalErrors = 0;\n  for (const file of jsonFiles) {\n    const data = fs.readFileSync(file, 'utf8');\n    const fileData = JSON.parse(data);\n    if (validateImport(fileData.meta)) {\n      total += Object.keys(fileData.emailTemplate).length;\n      let errors = 0;\n      for (const id in fileData.emailTemplate) {\n        if ({}.hasOwnProperty.call(fileData.emailTemplate, id)) {\n          const templateId = id.replace(regexEmailTemplateType, '');\n          try {\n            // eslint-disable-next-line no-await-in-loop\n            await putEmailTemplate(\n              templateId,\n              fileData.emailTemplate[templateId]\n            );\n          } catch (putEmailTemplateError) {\n            errors += 1;\n            printMessage(`\\nError importing ${templateId}`, 'error');\n            printMessage(putEmailTemplateError.response.data, 'error');\n          }\n        }\n      }\n      totalErrors += errors;\n      updateProgressIndicator(`Imported ${file}`);\n    } else {\n      printMessage(`Validation of ${file} failed!`, 'error');\n    }\n  }\n  stopProgressIndicator(\n    `Imported ${total - totalErrors} of ${total} email template(s) from ${\n      jsonFiles.length\n    } file(s).`\n  );\n}\n\n/**\n * Import first email template from file\n * @param {String} file optional filename\n */\nexport async function importFirstEmailTemplateFromFile(file) {\n  fs.readFile(file, 'utf8', async (err, data) => {\n    if (err) throw err;\n    const fileData = JSON.parse(data);\n    if (validateImport(fileData.meta)) {\n      createProgressIndicator(1, `Importing first email template`);\n      for (const id in fileData.emailTemplate) {\n        if ({}.hasOwnProperty.call(fileData.emailTemplate, id)) {\n          try {\n            await putEmailTemplate(\n              id.replace(regexEmailTemplateType, ''),\n              fileData.emailTemplate[id]\n            );\n            updateProgressIndicator(`Imported ${id}`);\n            stopProgressIndicator(`Imported ${id}`);\n          } catch (putEmailTemplateError) {\n            stopProgressIndicator(`Error importing email template ${id}`);\n            printMessage(`\\nError importing email template ${id}`, 'error');\n            printMessage(putEmailTemplateError.response.data, 'error');\n          }\n          break;\n        }\n      }\n    } else {\n      printMessage('Import validation failed...', 'error');\n    }\n  });\n}\n"]}
+{"version":3,"sources":["../src/ops/EmailTemplateOps.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,eAAO,MAAM,mBAAmB,kBAAkB,CAAC;AAEnD;;;GAGG;AACH,wBAAsB,iBAAiB,iBAEtC;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,UAAU,KAAA,gBAEhD;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,UAAU,KAAA,EAAE,YAAY,KAAA,gBAE9D","file":"EmailTemplateOps.d.ts","sourcesContent":["import {\n  getConfigEntitiesByType,\n  getConfigEntity,\n  putConfigEntity,\n} from '../api/IdmConfigApi';\n\n/**\n * Email template type key used to build the IDM id: 'emailTemplate/<id>'\n */\nexport const EMAIL_TEMPLATE_TYPE = 'emailTemplate';\n\n/**\n * Get all email templates\n * @returns {Promise} a promise that resolves to an array of email template objects\n */\nexport async function getEmailTemplates() {\n  return getConfigEntitiesByType(EMAIL_TEMPLATE_TYPE);\n}\n\n/**\n * Get email template\n * @param {string} templateId id/name of the email template without the type prefix\n * @returns {Promise} a promise that resolves an email template object\n */\nexport async function getEmailTemplate(templateId) {\n  return getConfigEntity(`${EMAIL_TEMPLATE_TYPE}/${templateId}`);\n}\n\n/**\n * Put email template\n * @param {string} templateId id/name of the email template without the type prefix\n * @param {Object} templateData email template object\n * @returns {Promise} a promise that resolves to an email template object\n */\nexport async function putEmailTemplate(templateId, templateData) {\n  return putConfigEntity(`${EMAIL_TEMPLATE_TYPE}/${templateId}`, templateData);\n}\n"]}

package/types/ops/IdmOps.d.ts

@@ -1,47 +1,39 @@
 /**
- * List all IDM configuration objects
+ * Get all IDM config entities
+ * @returns {Promise} a promise that resolves to all IDM config entities
  */
-export declare function listAllConfigEntities(): Promise<void>;
+export declare function getAllConfigEntities(): Promise<any>;
 /**
- * Export an IDM configuration object.
- * @param {String} id the desired configuration object
- * @param {String} file optional export file
+ * Get IDM config entities by type
+ * @param {String} type the desired type of config entity
+ * @returns {Promise} a promise that resolves to an object containing all IDM config entities of the desired type
  */
-export declare function exportConfigEntity(id: any, file: any): Promise<void>;
+export declare function getConfigEntitiesByType(type: any): Promise<any>;
 /**
- * Export all IDM configuration objects into separate JSON files in a directory specified by <directory>
- * @param {String} directory export directory
+ * Get an IDM config entity
+ * @param {string} entityId the desired config entity
+ * @returns {Promise<unknown>} a promise that resolves to an IDM config entity
  */
-export declare function exportAllRawConfigEntities(directory: any): Promise<void>;
+export declare function getConfigEntity(entityId: any): Promise<any>;
 /**
- * Export all IDM configuration objects
- * @param {String} directory export directory
- * @param {String} entitiesFile JSON file that specifies the config entities to export/import
- * @param {String} envFile File that defines environment specific variables for replacement during configuration export/import
+ * Put IDM config entity
+ * @param {string} entityId config entity id
+ * @param {string} entityData config entity object
+ * @returns {Promise<unknown>} a promise that resolves to an IDM config entity
  */
-export declare function exportAllConfigEntities(directory: any, entitiesFile: any, envFile: any): Promise<void>;
+export declare function putConfigEntity(entityId: string, entityData: string | object): Promise<any>;
 /**
- * Import an IDM configuration object.
- * @param entityId the configuration object to import
- * @param file optional file to import
+ * Query managed objects
+ * @param {String} type managed object type
+ * @param {[String]} fields fields to retrieve
+ * @param {String} pageCookie paged results cookie
+ * @returns {Promise<{result: any[]; resultCount: number; pagedResultsCookie: any; totalPagedResultsPolicy: string; totalPagedResults: number; remainingPagedResults: number;}>} a promise that resolves to managed objects of the desired type
  */
-export declare function importConfigEntity(entityId: string, file?: string, validate?: boolean): Promise<void>;
-/**
- * Import all IDM configuration objects from separate JSON files in a directory specified by <directory>
- * @param baseDirectory export directory
- * @param validate validate script hooks
- */
-export declare function importAllRawConfigEntities(baseDirectory: string, validate?: boolean): Promise<void>;
-/**
- * Import all IDM configuration objects
- * @param baseDirectory import directory
- * @param entitiesFile JSON file that specifies the config entities to export/import
- * @param envFile File that defines environment specific variables for replacement during configuration export/import
- * @param validate validate script hooks
- */
-export declare function importAllConfigEntities(baseDirectory: string, entitiesFile: string, envFile: string, validate?: boolean): Promise<void>;
-/**
- * Count number of managed objects of a given type
- * @param {String} type managed object type, e.g. alpha_user
- */
-export declare function countManagedObjects(type: any): Promise<void>;
+export declare function queryAllManagedObjectsByType(type: any, fields: any, pageCookie: any): Promise<{
+    result: unknown[];
+    resultCount: number;
+    pagedResultsCookie: string;
+    totalPagedResultsPolicy: string;
+    totalPagedResults: number;
+    remainingPagedResults: number;
+}>;

package/types/ops/IdmOps.d.ts.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/ops/IdmOps.ts"],"names":[],"mappings":"AAqBA;;GAEG;AACH,wBAAsB,qBAAqB,kBAgB1C;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,EAAE,KAAA,EAAE,IAAI,KAAA,iBAYhD;AAED;;;GAGG;AACH,wBAAsB,0BAA0B,CAAC,SAAS,KAAA,iBAmEzD;AAED;;;;;GAKG;AACH,wBAAsB,uBAAuB,CAC3C,SAAS,KAAA,EACT,YAAY,KAAA,EACZ,OAAO,KAAA,iBAqER;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CACtC,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,OAAO,iBAqBnB;AAED;;;;GAIG;AACH,wBAAsB,0BAA0B,CAC9C,aAAa,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,OAAO,iBAgEnB;AAED;;;;;;GAMG;AACH,wBAAsB,uBAAuB,CAC3C,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,OAAO,iBAyEnB;AAED;;;GAGG;AACH,wBAAsB,mBAAmB,CAAC,IAAI,KAAA,iBAwB7C","file":"IdmOps.d.ts","sourcesContent":["/* eslint-disable no-await-in-loop */\nimport fs from 'fs';\nimport fse from 'fs-extra';\nimport path from 'path';\nimport propertiesReader from 'properties-reader';\nimport replaceall from 'replaceall';\nimport {\n  getAllConfigEntities,\n  getConfigEntity,\n  putConfigEntity,\n  queryAllManagedObjectsByType,\n} from '../api/IdmConfigApi';\nimport {\n  createProgressIndicator,\n  printMessage,\n  stopProgressIndicator,\n} from './utils/Console';\nimport { getTypedFilename } from './utils/ExportImportUtils';\nimport { readFiles, unSubstituteEnvParams } from './utils/OpsUtils';\nimport { validateScriptHooks } from './utils/ValidationUtils';\n\n/**\n * List all IDM configuration objects\n */\nexport async function listAllConfigEntities() {\n  let configEntities = [];\n  try {\n    configEntities = await getAllConfigEntities();\n  } catch (getAllConfigEntitiesError) {\n    printMessage(getAllConfigEntitiesError, 'error');\n    printMessage(\n      `Error getting config entities: ${getAllConfigEntitiesError}`,\n      'error'\n    );\n  }\n  if ('configurations' in configEntities) {\n    configEntities['configurations'].forEach((configEntity) => {\n      printMessage(`${configEntity._id}`, 'data');\n    });\n  }\n}\n\n/**\n * Export an IDM configuration object.\n * @param {String} id the desired configuration object\n * @param {String} file optional export file\n */\nexport async function exportConfigEntity(id, file) {\n  let fileName = file;\n  if (!fileName) {\n    fileName = getTypedFilename(`${id}`, 'idm');\n  }\n  const configEntity = await getConfigEntity(id);\n  fs.writeFile(fileName, JSON.stringify(configEntity, null, 2), (err) => {\n    if (err) {\n      return printMessage(`ERROR - can't save ${id} export to file`, 'error');\n    }\n    return '';\n  });\n}\n\n/**\n * Export all IDM configuration objects into separate JSON files in a directory specified by <directory>\n * @param {String} directory export directory\n */\nexport async function exportAllRawConfigEntities(directory) {\n  let configEntities = [];\n  try {\n    configEntities = await getAllConfigEntities();\n  } catch (getAllConfigEntitiesError) {\n    printMessage(getAllConfigEntitiesError, 'error');\n    printMessage(\n      `Error getting config entities: ${getAllConfigEntitiesError}`,\n      'error'\n    );\n  }\n  if ('configurations' in configEntities) {\n    if (!fs.existsSync(directory)) {\n      fs.mkdirSync(directory);\n    }\n    createProgressIndicator(\n      undefined,\n      'Exporting config objects...',\n      'indeterminate'\n    );\n    const entityPromises = [];\n    configEntities['configurations'].forEach((x) => {\n      entityPromises.push(\n        getConfigEntity(x._id).catch((getConfigEntityError) => {\n          if (\n            !(\n              getConfigEntityError.response?.status === 403 &&\n              getConfigEntityError.response?.data?.message ===\n                'This operation is not available in ForgeRock Identity Cloud.'\n            ) &&\n            // https://bugster.forgerock.org/jira/browse/OPENIDM-18270\n            !(\n              getConfigEntityError.response?.status === 404 &&\n              getConfigEntityError.response?.data?.message ===\n                'No configuration exists for id org.apache.felix.fileinstall/openidm'\n            )\n          ) {\n            printMessage(getConfigEntityError.response?.data, 'error');\n            printMessage(\n              `Error getting config entity ${x._id}: ${getConfigEntityError}`,\n              'error'\n            );\n          }\n        })\n      );\n    });\n    Promise.all(entityPromises).then((result) => {\n      result.forEach((item) => {\n        if (item != null) {\n          fse.outputFile(\n            `${directory}/${item._id}.json`,\n            JSON.stringify(item, null, 2),\n            // eslint-disable-next-line consistent-return\n            (err) => {\n              if (err) {\n                return printMessage(\n                  `ERROR - can't save config ${item._id} to file - ${err}`,\n                  'error'\n                );\n              }\n            }\n          );\n        }\n      });\n      stopProgressIndicator('Exported config objects.', 'success');\n    });\n  }\n}\n\n/**\n * Export all IDM configuration objects\n * @param {String} directory export directory\n * @param {String} entitiesFile JSON file that specifies the config entities to export/import\n * @param {String} envFile File that defines environment specific variables for replacement during configuration export/import\n */\nexport async function exportAllConfigEntities(\n  directory,\n  entitiesFile,\n  envFile\n) {\n  let entriesToExport = [];\n  // read list of entities to export\n  fs.readFile(entitiesFile, 'utf8', async (err, data) => {\n    if (err) throw err;\n    const entriesData = JSON.parse(data);\n    entriesToExport = entriesData.idm;\n    // console.log(`entriesToExport ${entriesToExport}`);\n\n    // read list of configs to parameterize for environment specific values\n    const envParams = propertiesReader(envFile);\n\n    let configEntities = [];\n    try {\n      configEntities = await getAllConfigEntities();\n    } catch (getAllConfigEntitiesError) {\n      printMessage(getAllConfigEntitiesError, 'error');\n      printMessage(\n        `Error getting config entities: ${getAllConfigEntitiesError}`,\n        'error'\n      );\n    }\n    if ('configurations' in configEntities) {\n      // create export directory if not exist\n      if (!fs.existsSync(directory)) {\n        fs.mkdirSync(directory);\n      }\n      createProgressIndicator(\n        undefined,\n        'Exporting config objects...',\n        'indeterminate'\n      );\n      const entityPromises = [];\n      configEntities['configurations'].forEach((x) => {\n        if (entriesToExport.includes(x._id)) {\n          entityPromises.push(getConfigEntity(x._id));\n        }\n      });\n      Promise.all(entityPromises).then((result) => {\n        result.forEach((item) => {\n          if (item != null) {\n            let configEntityString = JSON.stringify(item, null, 2);\n            envParams.each((key, value) => {\n              configEntityString = replaceall(\n                value,\n                `\\${${key}}`,\n                configEntityString\n              );\n            });\n            fse.outputFile(\n              `${directory}/${item._id}.json`,\n              configEntityString,\n              // eslint-disable-next-line consistent-return\n              (error) => {\n                if (err) {\n                  return printMessage(\n                    `ERROR - can't save config ${item._id} to file - ${error}`,\n                    'error'\n                  );\n                }\n              }\n            );\n          }\n        });\n        stopProgressIndicator(null, 'success');\n      });\n    }\n  });\n}\n\n/**\n * Import an IDM configuration object.\n * @param entityId the configuration object to import\n * @param file optional file to import\n */\nexport async function importConfigEntity(\n  entityId: string,\n  file?: string,\n  validate?: boolean\n) {\n  if (!file) {\n    file = getTypedFilename(entityId, 'idm');\n  }\n\n  const entityData = fs.readFileSync(path.resolve(process.cwd(), file), 'utf8');\n\n  const jsObject = JSON.parse(entityData);\n  const isValid = validateScriptHooks(jsObject);\n  if (validate && !isValid) {\n    printMessage('Invalid IDM configuration object', 'error');\n    return;\n  }\n\n  try {\n    await putConfigEntity(entityId, entityData);\n  } catch (putConfigEntityError) {\n    printMessage(putConfigEntityError, 'error');\n    printMessage(`Error: ${putConfigEntityError}`, 'error');\n  }\n}\n\n/**\n * Import all IDM configuration objects from separate JSON files in a directory specified by <directory>\n * @param baseDirectory export directory\n * @param validate validate script hooks\n */\nexport async function importAllRawConfigEntities(\n  baseDirectory: string,\n  validate?: boolean\n) {\n  if (!fs.existsSync(baseDirectory)) {\n    return;\n  }\n  const files = await readFiles(baseDirectory);\n  const jsonFiles = files\n    .filter(({ path }) => path.toLowerCase().endsWith('.json'))\n    .map(({ path, content }) => ({\n      // Remove .json extension\n      entityId: path.substring(0, path.length - 5),\n      content,\n      path,\n    }));\n\n  let everyScriptValid = true;\n  for (const file of jsonFiles) {\n    const jsObject = JSON.parse(file.content);\n    const isScriptValid = validateScriptHooks(jsObject);\n    if (!isScriptValid) {\n      printMessage(`Invalid script hook in ${file.path}`, 'error');\n      everyScriptValid = false;\n    }\n  }\n\n  if (validate && !everyScriptValid) {\n    return;\n  }\n\n  createProgressIndicator(\n    undefined,\n    'Importing config objects...',\n    'indeterminate'\n  );\n\n  const entityPromises = jsonFiles.map((file) => {\n    return putConfigEntity(file.entityId, file.content);\n  });\n\n  await Promise.allSettled(entityPromises).then((results) => {\n    const errors = results.filter(\n      (result): result is PromiseRejectedResult => result.status === 'rejected'\n    );\n\n    if (errors.length > 0) {\n      printMessage(\n        `Failed to import ${errors.length} config objects:`,\n        'error'\n      );\n      errors.forEach((error) => {\n        printMessage(`- ${error.reason}`, 'error');\n      });\n      stopProgressIndicator(\n        `Failed to import ${errors.length} config objects`,\n        'error'\n      );\n      return;\n    }\n\n    stopProgressIndicator(\n      `Imported ${results.length} config objects`,\n      'success'\n    );\n  });\n}\n\n/**\n * Import all IDM configuration objects\n * @param baseDirectory import directory\n * @param entitiesFile JSON file that specifies the config entities to export/import\n * @param envFile File that defines environment specific variables for replacement during configuration export/import\n * @param validate validate script hooks\n */\nexport async function importAllConfigEntities(\n  baseDirectory: string,\n  entitiesFile: string,\n  envFile: string,\n  validate?: boolean\n) {\n  if (!fs.existsSync(baseDirectory)) {\n    return;\n  }\n  const entriesToImport = JSON.parse(fs.readFileSync(entitiesFile, 'utf8')).idm;\n\n  const envReader = propertiesReader(envFile);\n\n  const files = await readFiles(baseDirectory);\n  const jsonFiles = files\n    .filter(({ path }) => path.toLowerCase().endsWith('.json'))\n    .map(({ content, path }) => ({\n      // Remove .json extension\n      entityId: path.substring(0, path.length - 5),\n      content,\n      path,\n    }));\n\n  let everyScriptValid = true;\n  for (const file of jsonFiles) {\n    const jsObject = JSON.parse(file.content);\n    const isScriptValid = validateScriptHooks(jsObject);\n    if (!isScriptValid) {\n      printMessage(`Invalid script hook in ${file.path}`, 'error');\n      everyScriptValid = false;\n    }\n  }\n\n  if (validate && !everyScriptValid) {\n    return;\n  }\n\n  createProgressIndicator(\n    undefined,\n    'Importing config objects...',\n    'indeterminate'\n  );\n\n  const entityPromises = jsonFiles\n    .filter(({ entityId }) => {\n      return entriesToImport.includes(entityId);\n    })\n    .map(({ entityId, content }) => {\n      const unsubstituted = unSubstituteEnvParams(content, envReader);\n      return putConfigEntity(entityId, unsubstituted);\n    });\n\n  await Promise.allSettled(entityPromises).then((results) => {\n    const errors = results.filter(\n      (result): result is PromiseRejectedResult => result.status === 'rejected'\n    );\n\n    if (errors.length > 0) {\n      printMessage(\n        `Failed to import ${errors.length} config objects:`,\n        'error'\n      );\n      errors.forEach((error) => {\n        printMessage(`- ${error.reason}`, 'error');\n      });\n      stopProgressIndicator(\n        `Failed to import ${errors.length} config objects`,\n        'error'\n      );\n      return;\n    }\n\n    stopProgressIndicator(\n      `Imported ${results.length} config objects`,\n      'success'\n    );\n  });\n}\n\n/**\n * Count number of managed objects of a given type\n * @param {String} type managed object type, e.g. alpha_user\n */\nexport async function countManagedObjects(type) {\n  let count = 0;\n  let result = {\n    result: [],\n    resultCount: 0,\n    pagedResultsCookie: null,\n    totalPagedResultsPolicy: 'NONE',\n    totalPagedResults: -1,\n    remainingPagedResults: -1,\n  };\n  try {\n    do {\n      result = await queryAllManagedObjectsByType(\n        type,\n        [],\n        result.pagedResultsCookie\n      );\n      count += result.resultCount;\n    } while (result.pagedResultsCookie);\n    printMessage(`${type}: ${count}`);\n  } catch (error) {\n    printMessage(error.response.data, 'error');\n    printMessage(`Error querying managed objects by type: ${error}`, 'error');\n  }\n}\n"]}
+{"version":3,"sources":["../src/ops/IdmOps.ts"],"names":[],"mappings":"AAQA;;;GAGG;AACH,wBAAsB,oBAAoB,iBAEzC;AAED;;;;GAIG;AACH,wBAAsB,uBAAuB,CAAC,IAAI,KAAA,gBAEjD;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,QAAQ,KAAA,gBAE7C;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,GAAG,MAAM,gBAG5B;AAED;;;;;;GAMG;AACH,wBAAsB,4BAA4B,CAChD,IAAI,KAAA,EACJ,MAAM,KAAA,EACN,UAAU,KAAA,GACT,OAAO,CAAC;IACT,MAAM,EAAE,OAAO,EAAE,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,uBAAuB,EAAE,MAAM,CAAC;IAChC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,qBAAqB,EAAE,MAAM,CAAC;CAC/B,CAAC,CAED","file":"IdmOps.d.ts","sourcesContent":["import {\n  getAllConfigEntities as getAllConfigEntitiesRaw,\n  getConfigEntity as getConfigEntityRaw,\n  putConfigEntity as putConfigEntityRaw,\n  getConfigEntitiesByType as getConfigEntitiesByTypeRaw,\n  queryAllManagedObjectsByType as queryAllManagedObjectsByTypeRaw,\n} from '../api/IdmConfigApi';\n\n/**\n * Get all IDM config entities\n * @returns {Promise} a promise that resolves to all IDM config entities\n */\nexport async function getAllConfigEntities() {\n  return getAllConfigEntitiesRaw();\n}\n\n/**\n * Get IDM config entities by type\n * @param {String} type the desired type of config entity\n * @returns {Promise} a promise that resolves to an object containing all IDM config entities of the desired type\n */\nexport async function getConfigEntitiesByType(type) {\n  return getConfigEntitiesByTypeRaw(type);\n}\n\n/**\n * Get an IDM config entity\n * @param {string} entityId the desired config entity\n * @returns {Promise<unknown>} a promise that resolves to an IDM config entity\n */\nexport async function getConfigEntity(entityId) {\n  return getConfigEntityRaw(entityId);\n}\n\n/**\n * Put IDM config entity\n * @param {string} entityId config entity id\n * @param {string} entityData config entity object\n * @returns {Promise<unknown>} a promise that resolves to an IDM config entity\n */\nexport async function putConfigEntity(\n  entityId: string,\n  entityData: string | object\n) {\n  return putConfigEntityRaw(entityId, entityData);\n}\n\n/**\n * Query managed objects\n * @param {String} type managed object type\n * @param {[String]} fields fields to retrieve\n * @param {String} pageCookie paged results cookie\n * @returns {Promise<{result: any[]; resultCount: number; pagedResultsCookie: any; totalPagedResultsPolicy: string; totalPagedResults: number; remainingPagedResults: number;}>} a promise that resolves to managed objects of the desired type\n */\nexport async function queryAllManagedObjectsByType(\n  type,\n  fields,\n  pageCookie\n): Promise<{\n  result: unknown[];\n  resultCount: number;\n  pagedResultsCookie: string;\n  totalPagedResultsPolicy: string;\n  totalPagedResults: number;\n  remainingPagedResults: number;\n}> {\n  return queryAllManagedObjectsByTypeRaw(type, fields, pageCookie);\n}\n"]}

package/types/ops/JoseOps.d.ts

@@ -0,0 +1,33 @@
+export interface JwkInterface {
+    kty: string;
+    use?: string;
+    key_ops?: string[];
+    alg: string;
+    kid?: string;
+    x5u?: string;
+    x5c?: string;
+    x5t?: string;
+    'x5t#S256'?: string;
+}
+export type JwkRsa = JwkInterface & {
+    d: string;
+    dp: string;
+    dq: string;
+    e: string;
+    n: string;
+    p: string;
+    q: string;
+    qi: string;
+};
+export type JwkRsaPublic = JwkInterface & {
+    e: string;
+    n: string;
+};
+export interface JwksInterface {
+    keys: JwkInterface[];
+}
+export declare function createJwkRsa(): Promise<JwkRsa>;
+export declare function getJwkRsaPublic(jwkJson: JwkRsa): Promise<JwkRsaPublic>;
+export declare function createJwks(...keys: JwkInterface[]): JwksInterface;
+export declare function createSignedJwtToken(payload: any, jwkJson: JwkRsa): Promise<any>;
+export declare function verifySignedJwtToken(jwt: string, jwkJson: JwkRsaPublic): Promise<any>;

package/types/ops/JoseOps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/ops/JoseOps.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,MAAM,GAAG,YAAY,GAAG;IAClC,CAAC,EAAE,MAAM,CAAC;IACV,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG;IACxC,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,YAAY,EAAE,CAAC;CACtB;AAED,wBAAsB,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAIpD;AAED,wBAAsB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAI5E;AAED,wBAAgB,UAAU,CAAC,GAAG,IAAI,EAAE,YAAY,EAAE,GAAG,aAAa,CAIjE;AAED,wBAAsB,oBAAoB,CAAC,OAAO,KAAA,EAAE,OAAO,EAAE,MAAM,gBAalE;AAED,wBAAsB,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,gBAI5E","file":"JoseOps.d.ts","sourcesContent":["import jose from 'node-jose';\n\nexport interface JwkInterface {\n  kty: string;\n  use?: string;\n  key_ops?: string[];\n  alg: string;\n  kid?: string;\n  x5u?: string;\n  x5c?: string;\n  x5t?: string;\n  'x5t#S256'?: string;\n}\n\nexport type JwkRsa = JwkInterface & {\n  d: string;\n  dp: string;\n  dq: string;\n  e: string;\n  n: string;\n  p: string;\n  q: string;\n  qi: string;\n};\n\nexport type JwkRsaPublic = JwkInterface & {\n  e: string;\n  n: string;\n};\n\nexport interface JwksInterface {\n  keys: JwkInterface[];\n}\n\nexport async function createJwkRsa(): Promise<JwkRsa> {\n  const jwk = await jose.JWK.createKey('RSA', 4096, { alg: 'RS256' });\n  // include the private key\n  return jwk.toJSON(true) as JwkRsa;\n}\n\nexport async function getJwkRsaPublic(jwkJson: JwkRsa): Promise<JwkRsaPublic> {\n  const jwk = await jose.JWK.asKey(jwkJson);\n  // do not include the private key\n  return jwk.toJSON(false) as JwkRsaPublic;\n}\n\nexport function createJwks(...keys: JwkInterface[]): JwksInterface {\n  return {\n    keys,\n  };\n}\n\nexport async function createSignedJwtToken(payload, jwkJson: JwkRsa) {\n  const key = await jose.JWK.asKey(jwkJson);\n  if (typeof payload === 'object') {\n    payload = JSON.stringify(payload);\n  }\n  const jwt = await jose.JWS.createSign(\n    { alg: 'RS256', compact: true, fields: {} },\n    // https://github.com/cisco/node-jose/issues/253\n    { key, reference: false }\n  )\n    .update(payload)\n    .final();\n  return jwt;\n}\n\nexport async function verifySignedJwtToken(jwt: string, jwkJson: JwkRsaPublic) {\n  const jwk = await jose.JWK.asKey(jwkJson);\n  const verifyResult = await jose.JWS.createVerify(jwk).verify(jwt);\n  return verifyResult;\n}\n"]}