@rockcarver/frodo-cli 0.10.4 → 0.11.1-2

package/src/ops/RealmOps.js

@@ -1,139 +0,0 @@
-import {
-  createKeyValueTable,
-  createTable,
-  printMessage,
-} from './utils/Console.js';
-import { getRealmByName, getRealms, putRealm } from '../api/RealmApi.js';
-
-/**
- * List realms
- * @param {boolean} long Long list format with details
- */
-export async function listRealms(long = false) {
-  try {
-    const realms = (await getRealms()).data.result;
-    if (long) {
-      const table = createTable([
-        'Name'.brightCyan,
-        'Status'.brightCyan,
-        'Custom Domains'.brightCyan,
-        'Parent'.brightCyan,
-      ]);
-      realms.forEach((realmConfig) => {
-        table.push([
-          realmConfig.name,
-          realmConfig.active ? 'active'.brightGreen : 'inactive'.brightRed,
-          realmConfig.aliases.join('\n'),
-          realmConfig.parentPath,
-        ]);
-      });
-      printMessage(table.toString());
-    } else {
-      realms.forEach((realmConfig) => {
-        printMessage(realmConfig.name, 'info');
-      });
-    }
-  } catch (error) {
-    printMessage(`Error listing realms: ${error.rmessage}`, 'error');
-    printMessage(error.response.data, 'error');
-  }
-}
-
-/**
- * Describe realm
- * @param {String} realm realm name
- */
-export async function describe(realm) {
-  try {
-    const realmConfig = await getRealmByName(realm);
-    const table = createKeyValueTable();
-    table.push(['Name'.brightCyan, realmConfig.name]);
-    table.push([
-      'Status'.brightCyan,
-      realmConfig.active ? 'active'.brightGreen : 'inactive'.brightRed,
-    ]);
-    table.push(['Custom Domains'.brightCyan, realmConfig.aliases.join('\n')]);
-    table.push(['Parent'.brightCyan, realmConfig.parentPath]);
-    table.push(['Id'.brightCyan, realmConfig._id]);
-    printMessage(table.toString());
-  } catch (error) {
-    printMessage(`Realm ${realm} not found!`, 'error');
-  }
-}
-
-/**
- * Add custom DNS domain name (realm DNS alias)
- * @param {String} realm realm name
- * @param {String} domain domain name
- */
-export async function addCustomDomain(realm, domain) {
-  try {
-    let realmConfig = await getRealmByName(realm);
-    let exists = false;
-    realmConfig.aliases.forEach((alias) => {
-      if (domain.toLowerCase() === alias.toLowerCase()) {
-        exists = true;
-      }
-    });
-    if (!exists) {
-      try {
-        realmConfig.aliases.push(domain.toLowerCase());
-        realmConfig = (await putRealm(realmConfig._id, realmConfig)).data;
-        const table = createKeyValueTable();
-        table.push(['Name'.brightCyan, realmConfig.name]);
-        table.push([
-          'Status'.brightCyan,
-          realmConfig.active ? 'active'.brightGreen : 'inactive'.brightRed,
-        ]);
-        table.push([
-          'Custom Domains'.brightCyan,
-          realmConfig.aliases.join('\n'),
-        ]);
-        table.push(['Parent'.brightCyan, realmConfig.parentPath]);
-        table.push(['Id'.brightCyan, realmConfig._id]);
-        printMessage(table.toString());
-      } catch (error) {
-        printMessage(`Error adding custom domain: ${error.message}`, 'error');
-      }
-    }
-  } catch (error) {
-    printMessage(`${error.message}`, 'error');
-  }
-}
-
-/**
- * Remove custom DNS domain name (realm DNS alias)
- * @param {String} realm realm name
- * @param {String} domain domain name
- */
-export async function removeCustomDomain(realm, domain) {
-  try {
-    let realmConfig = await getRealmByName(realm);
-    const aliases = realmConfig.aliases.filter(
-      (alias) => domain.toLowerCase() !== alias.toLowerCase()
-    );
-    if (aliases.length < realmConfig.aliases.length) {
-      try {
-        realmConfig.aliases = aliases;
-        realmConfig = (await putRealm(realmConfig._id, realmConfig)).data;
-        const table = createKeyValueTable();
-        table.push(['Name'.brightCyan, realmConfig.name]);
-        table.push([
-          'Status'.brightCyan,
-          realmConfig.active ? 'active'.brightGreen : 'inactive'.brightRed,
-        ]);
-        table.push([
-          'Custom Domains'.brightCyan,
-          realmConfig.aliases.join('\n'),
-        ]);
-        table.push(['Parent'.brightCyan, realmConfig.parentPath]);
-        table.push(['Id'.brightCyan, realmConfig._id]);
-        printMessage(table.toString());
-      } catch (error) {
-        printMessage(`Error removing custom domain: ${error.message}`, 'error');
-      }
-    }
-  } catch (error) {
-    printMessage(`${error.message}`, 'error');
-  }
-}

package/src/ops/SamlOps.js

@@ -1,541 +0,0 @@
-import fs from 'fs';
-import _ from 'lodash';
-import { decode, encode, encodeBase64Url } from '../api/utils/Base64.js';
-import {
-  createTable,
-  printMessage,
-  createProgressBar,
-  updateProgressBar,
-  stopProgressBar,
-  createObjectTable,
-} from './utils/Console.js';
-import {
-  getProviders,
-  findProviders,
-  getProviderByLocationAndId,
-  getProviderMetadata,
-  createProvider,
-  getProviderMetadataUrl,
-} from '../api/Saml2Api.js';
-import { getScript } from '../api/ScriptApi.js';
-import {
-  convertBase64TextToArray,
-  convertBase64UrlTextToArray,
-  convertTextArrayToBase64,
-  convertTextArrayToBase64Url,
-  getRealmString,
-  getTypedFilename,
-  saveJsonToFile,
-  saveTextToFile,
-  validateImport,
-} from './utils/ExportImportUtils.js';
-import { createOrUpdateScript } from './ScriptOps.js';
-
-const roleMap = {
-  identityProvider: 'IDP',
-  serviceProvider: 'SP',
-  attributeQueryProvider: 'AttrQuery',
-  xacmlPolicyEnforcementPoint: 'XACML PEP',
-};
-
-// use a function vs a template variable to avoid problems in loops
-function getFileDataTemplate() {
-  return {
-    meta: {},
-    script: {},
-    saml: {
-      hosted: {},
-      remote: {},
-      metadata: {},
-    },
-  };
-}
-
-/**
- * List entity providers
- * @param {boolean} long Long list format with details
- */
-export async function listProviders(long = false) {
-  const providerList = (await getProviders()).data.result;
-  providerList.sort((a, b) => a._id.localeCompare(b._id));
-  if (!long) {
-    providerList.forEach((item) => {
-      printMessage(`${item.entityId}`, 'data');
-    });
-  } else {
-    const table = createTable([
-      'Entity Id'.brightCyan,
-      'Location'.brightCyan,
-      'Role(s)'.brightCyan,
-    ]);
-    providerList.forEach((provider) => {
-      table.push([
-        provider.entityId,
-        provider.location,
-        provider.roles.map((role) => roleMap[role]).join(', '),
-      ]);
-    });
-    printMessage(table.toString());
-  }
-}
-
-/**
- * Include dependencies in the export file
- * @param {Object} providerData Object representing a SAML entity provider
- * @param {Object} fileData File data object to add dependencies to
- */
-async function exportDependencies(providerData, fileData) {
-  const attrMapperScriptId = _.get(providerData, [
-    'identityProvider',
-    'assertionProcessing',
-    'attributeMapper',
-    'attributeMapperScript',
-  ]);
-  if (attrMapperScriptId && attrMapperScriptId !== '[Empty]') {
-    const scriptData = (await getScript(attrMapperScriptId)).data;
-    scriptData.script = convertBase64TextToArray(scriptData.script);
-    // eslint-disable-next-line no-param-reassign
-    fileData.script[attrMapperScriptId] = scriptData;
-  }
-  const idpAdapterScriptId = _.get(providerData, [
-    'identityProvider',
-    'advanced',
-    'idpAdapter',
-    'idpAdapterScript',
-  ]);
-  if (idpAdapterScriptId && idpAdapterScriptId !== '[Empty]') {
-    const scriptData = (await getScript(idpAdapterScriptId)).data;
-    scriptData.script = convertBase64TextToArray(scriptData.script);
-    // eslint-disable-next-line no-param-reassign
-    fileData.script[idpAdapterScriptId] = scriptData;
-  }
-  const metaDataResponse = await getProviderMetadata(providerData.entityId);
-  // eslint-disable-next-line no-param-reassign
-  fileData.saml.metadata[providerData._id] = convertBase64UrlTextToArray(
-    encodeBase64Url(metaDataResponse.data)
-  );
-}
-
-/**
- * Export a single entity provider to file
- * @param {String} entityId Provider entity id
- * @param {String} file Optional filename
- */
-export async function exportProvider(entityId, file = null) {
-  let fileName = file;
-  if (!fileName) {
-    fileName = getTypedFilename(entityId, 'saml');
-  }
-  createProgressBar(1, `Exporting provider ${entityId}`);
-  const found = await findProviders(`entityId eq '${entityId}'`, 'location');
-  switch (found.data.resultCount) {
-    case 0:
-      printMessage(`No provider with entity id '${entityId}' found`, 'error');
-      break;
-    case 1:
-      {
-        const { location } = found.data.result[0];
-        const id = found.data.result[0]._id;
-        getProviderByLocationAndId(location, id)
-          .then(async (response) => {
-            const providerData = response.data;
-            updateProgressBar(`Writing file ${fileName}`);
-            const fileData = getFileDataTemplate();
-            fileData.saml[location][providerData._id] = providerData;
-            await exportDependencies(providerData, fileData);
-            saveJsonToFile(fileData, fileName);
-            stopProgressBar(
-              `Exported ${entityId.brightCyan} to ${fileName.brightCyan}.`
-            );
-          })
-          .catch((err) => {
-            stopProgressBar(`${err}`);
-            printMessage(err, 'error');
-          });
-      }
-      break;
-    default:
-      printMessage(
-        `Multiple providers with entity id '${entityId}' found`,
-        'error'
-      );
-  }
-}
-
-/**
- * Export provider metadata to file
- * @param {String} entityId Provider entity id
- * @param {String} file Optional filename
- */
-export async function exportMetadata(entityId, file = null) {
-  let fileName = file;
-  if (!fileName) {
-    fileName = getTypedFilename(entityId, 'metadata', 'xml');
-  }
-  createProgressBar(1, `Exporting metadata for: ${entityId}`);
-  getProviderMetadata(entityId)
-    .then(async (response) => {
-      updateProgressBar(`Writing file ${fileName}`);
-      // printMessage(response.data, 'error');
-      const metaData = response.data;
-      saveTextToFile(metaData, fileName);
-      stopProgressBar(
-        `Exported ${entityId.brightCyan} metadata to ${fileName.brightCyan}.`
-      );
-    })
-    .catch((err) => {
-      stopProgressBar(`${err}`);
-      printMessage(err, 'error');
-    });
-}
-
-/**
- * Describe an entity provider's configuration
- * @param {String} entityId Provider entity id
- */
-export async function describeProvider(entityId) {
-  const found = await findProviders(
-    `entityId eq '${entityId}'`,
-    'location,roles'
-  );
-  switch (found.data.resultCount) {
-    case 0:
-      printMessage(`No provider with entity id '${entityId}' found`, 'error');
-      break;
-    case 1:
-      {
-        const { location } = found.data.result[0];
-        const id = found.data.result[0]._id;
-        const roles = found.data.result[0].roles
-          .map((role) => roleMap[role])
-          .join(', ');
-        getProviderByLocationAndId(location, id)
-          .then(async (response) => {
-            const rawProviderData = response.data;
-            delete rawProviderData._id;
-            delete rawProviderData._rev;
-            rawProviderData.location = location;
-            rawProviderData.roles = roles;
-            rawProviderData.metadataUrl = getProviderMetadataUrl(entityId);
-            // const fullProviderData = getFileDataTemplate();
-            // fullProviderData.saml[location][rawProviderData._id] =
-            //   rawProviderData;
-            // await exportDependencies(rawProviderData, fullProviderData);
-            // describe the provider
-            const table = createObjectTable(rawProviderData);
-            printMessage(table.toString());
-          })
-          .catch((err) => {
-            printMessage(err, 'error');
-          });
-      }
-      break;
-    default:
-      printMessage(
-        `Multiple providers with entity id '${entityId}' found`,
-        'error'
-      );
-  }
-}
-
-/**
- * Export all entity providers to one file
- * @param {String} file Optional filename
- */
-export async function exportProvidersToFile(file = null) {
-  let fileName = file;
-  if (!fileName) {
-    fileName = getTypedFilename(`all${getRealmString()}Providers`, 'saml');
-  }
-  const fileData = getFileDataTemplate();
-  const found = await getProviders();
-  if (found.status < 200 || found.status > 399) {
-    printMessage(found, 'data');
-    printMessage(`exportProvidersToFile: ${found.status}`, 'error');
-  } else if (found.data.resultCount > 0) {
-    createProgressBar(found.data.resultCount, 'Exporting providers');
-    for (const stubData of found.data.result) {
-      updateProgressBar(`Exporting provider ${stubData.entityId}`);
-      // eslint-disable-next-line no-await-in-loop
-      const response = await getProviderByLocationAndId(
-        stubData.location,
-        stubData._id
-      );
-      const providerData = response.data;
-      // eslint-disable-next-line no-await-in-loop
-      await exportDependencies(providerData, fileData);
-      fileData.saml[stubData.location][providerData._id] = providerData;
-    }
-    saveJsonToFile(fileData, fileName);
-    stopProgressBar(
-      `${found.data.resultCount} providers exported to ${fileName}.`
-    );
-  } else {
-    printMessage('No entity providers found.', 'info');
-  }
-}
-
-/**
- * Export all entity providers to individual files
- */
-export async function exportProvidersToFiles() {
-  const found = await getProviders();
-  if (found.data.resultCount > 0) {
-    createProgressBar(found.data.resultCount, 'Exporting providers');
-    for (const stubData of found.data.result) {
-      updateProgressBar(`Exporting provider ${stubData.entityId}`);
-      const fileName = getTypedFilename(stubData.entityId, 'saml');
-      const fileData = getFileDataTemplate();
-      // eslint-disable-next-line no-await-in-loop
-      const response = await getProviderByLocationAndId(
-        stubData.location,
-        stubData._id
-      );
-      const providerData = response.data;
-      // eslint-disable-next-line no-await-in-loop
-      await exportDependencies(providerData, fileData);
-      fileData.saml[stubData.location][providerData._id] = providerData;
-      saveJsonToFile(fileData, fileName);
-    }
-    stopProgressBar(`${found.data.resultCount} providers exported.`);
-  } else {
-    printMessage('No entity providers found.', 'info');
-  }
-}
-
-/**
- * Include dependencies from the import file
- * @param {Object} providerData Object representing a SAML entity provider
- * @param {Object} fileData File data object to read dependencies from
- */
-async function importDependencies(providerData, fileData) {
-  const attrMapperScriptId = _.get(providerData, [
-    'identityProvider',
-    'assertionProcessing',
-    'attributeMapper',
-    'attributeMapperScript',
-  ]);
-  if (attrMapperScriptId && attrMapperScriptId !== '[Empty]') {
-    const scriptData = _.get(fileData, ['script', attrMapperScriptId]);
-    scriptData.script = convertTextArrayToBase64(scriptData.script);
-    await createOrUpdateScript(attrMapperScriptId, scriptData);
-  }
-  const idpAdapterScriptId = _.get(providerData, [
-    'identityProvider',
-    'advanced',
-    'idpAdapter',
-    'idpAdapterScript',
-  ]);
-  if (idpAdapterScriptId && idpAdapterScriptId !== '[Empty]') {
-    const scriptData = _.get(fileData, ['script', idpAdapterScriptId]);
-    scriptData.script = convertTextArrayToBase64(scriptData.script);
-    await createOrUpdateScript(attrMapperScriptId, scriptData);
-  }
-}
-
-/**
- * Find provider in import file and return its location
- * @param {String} entityId64 Base64-encoded provider entity id
- * @param {Object} fileData Import file json data
- * @returns {String} 'hosted' or 'remote' if found, undefined otherwise
- */
-function getLocation(entityId64, fileData) {
-  if (_.get(fileData, ['saml', 'hosted', entityId64])) {
-    return 'hosted';
-  }
-  if (_.get(fileData, ['saml', 'remote', entityId64])) {
-    return 'remote';
-  }
-  return undefined;
-}
-
-/**
- * Import a SAML entity provider by entity id from file
- * @param {String} entityId Provider entity id
- * @param {String} file Import file name
- */
-export async function importProvider(entityId, file) {
-  const entityId64 = encode(entityId, false);
-  fs.readFile(file, 'utf8', async (err, data) => {
-    if (err) throw err;
-    const fileData = JSON.parse(data);
-    if (validateImport(fileData.meta)) {
-      createProgressBar(1, 'Importing provider...');
-      const location = getLocation(entityId64, fileData);
-      if (location) {
-        const providerData = _.get(fileData, ['saml', location, entityId64]);
-        updateProgressBar(`Importing ${entityId}`);
-        await importDependencies(providerData, fileData);
-        let metaData = null;
-        if (location === 'remote') {
-          metaData = convertTextArrayToBase64Url(
-            fileData.saml.metadata[entityId64]
-          );
-        }
-        createProvider(location, providerData, metaData)
-          .then(() => {
-            stopProgressBar(`Successfully imported provider ${entityId}.`);
-          })
-          .catch((createProviderErr) => {
-            printMessage(`\nError importing provider ${entityId}`, 'error');
-            printMessage(createProviderErr.response, 'error');
-          });
-      } else {
-        stopProgressBar(
-          `Provider ${entityId.brightCyan} not found in ${file.brightCyan}!`
-        );
-      }
-    } else {
-      printMessage('Import validation failed...', 'error');
-    }
-  });
-}
-
-/**
- * Import first SAML entity provider from file
- * @param {String} file Import file name
- */
-export async function importFirstProvider(file) {
-  fs.readFile(file, 'utf8', async (err, data) => {
-    if (err) throw err;
-    const fileData = JSON.parse(data);
-    if (validateImport(fileData.meta)) {
-      createProgressBar(1, 'Importing provider...');
-      // find providers in hosted and if none exist in remote
-      let location = 'hosted';
-      let providerIds = _.keys(fileData.saml[location]);
-      if (providerIds.length === 0) {
-        location = 'remote';
-        providerIds = _.keys(fileData.saml[location]);
-        if (providerIds.length === 0) {
-          location = null;
-        }
-      }
-      if (location) {
-        const entityId64 = providerIds[0];
-        const entityId = decode(entityId64);
-        const providerData = _.get(fileData, ['saml', location, entityId64]);
-        updateProgressBar(`Importing ${entityId}`);
-        await importDependencies(providerData, fileData);
-        let metaData = null;
-        if (location === 'remote') {
-          metaData = convertTextArrayToBase64Url(
-            fileData.saml.metadata[entityId64]
-          );
-        }
-        createProvider(location, providerData, metaData)
-          .then(() => {
-            stopProgressBar(`Successfully imported provider ${entityId}.`);
-          })
-          .catch((createProviderErr) => {
-            stopProgressBar(`Error importing provider ${entityId}`);
-            printMessage(`\nError importing provider ${entityId}`, 'error');
-            printMessage(createProviderErr.response.data, 'error');
-          });
-      } else {
-        stopProgressBar(`No providers found in ${file.brightCyan}!`);
-      }
-    } else {
-      printMessage('Import validation failed...', 'error');
-    }
-  });
-}
-
-/**
- * Import all SAML entity providers from file
- * @param {String} file Import file name
- */
-export async function importProvidersFromFile(file) {
-  fs.readFile(file, 'utf8', async (err, data) => {
-    if (err) throw err;
-    const fileData = JSON.parse(data);
-    if (validateImport(fileData.meta)) {
-      // find providers in hosted and in remote and map locations
-      const hostedIds = _.keys(fileData.saml.hosted);
-      const remoteIds = _.keys(fileData.saml.remote);
-      const providerIds = hostedIds.concat(remoteIds);
-      createProgressBar(providerIds.length, 'Importing providers...');
-      for (const entityId64 of providerIds) {
-        const location = hostedIds.includes(entityId64) ? 'hosted' : 'remote';
-        const entityId = decode(entityId64);
-        const providerData = _.get(fileData, ['saml', location, entityId64]);
-        // eslint-disable-next-line no-await-in-loop
-        await importDependencies(providerData, fileData);
-        let metaData = null;
-        if (location === 'remote') {
-          metaData = convertTextArrayToBase64Url(
-            fileData.saml.metadata[entityId64]
-          );
-        }
-        try {
-          // eslint-disable-next-line no-await-in-loop
-          await createProvider(location, providerData, metaData);
-          updateProgressBar(`Imported ${entityId}`);
-        } catch (createProviderErr) {
-          printMessage(`\nError importing provider ${entityId}`, 'error');
-          printMessage(createProviderErr.response.data, 'error');
-        }
-      }
-      stopProgressBar(`Providers imported.`);
-    } else {
-      printMessage('Import validation failed...', 'error');
-    }
-  });
-}
-
-/**
- * Import all SAML entity providers from all *.saml.json files in the current directory
- */
-export async function importProvidersFromFiles() {
-  const names = fs.readdirSync('.');
-  const jsonFiles = names.filter((name) =>
-    name.toLowerCase().endsWith('.saml.json')
-  );
-  createProgressBar(jsonFiles.length, 'Importing providers...');
-  let total = 0;
-  let totalErrors = 0;
-  for (const file of jsonFiles) {
-    const data = fs.readFileSync(file, 'utf8');
-    const fileData = JSON.parse(data);
-    if (validateImport(fileData.meta)) {
-      // find providers in hosted and in remote and map locations
-      const hostedIds = _.keys(fileData.saml.hosted);
-      const remoteIds = _.keys(fileData.saml.remote);
-      const providerIds = hostedIds.concat(remoteIds);
-      total += providerIds.length;
-      let errors = 0;
-      for (const entityId64 of providerIds) {
-        const location = hostedIds.includes(entityId64) ? 'hosted' : 'remote';
-        const entityId = decode(entityId64);
-        const providerData = _.get(fileData, ['saml', location, entityId64]);
-        importDependencies(providerData, fileData);
-        let metaData = null;
-        if (location === 'remote') {
-          metaData = convertTextArrayToBase64Url(
-            fileData.saml.metadata[entityId64]
-          );
-        }
-        try {
-          // eslint-disable-next-line no-await-in-loop
-          await createProvider(location, providerData, metaData);
-          // updateProgressBar(`Imported ${entityId}`);
-        } catch (createProviderErr) {
-          errors += 1;
-          printMessage(`\nError importing provider ${entityId}`, 'error');
-          printMessage(createProviderErr.response.data, 'error');
-        }
-      }
-      totalErrors += errors;
-      updateProgressBar(
-        `Imported ${providerIds.length - errors} provider(s) from ${file}`
-      );
-    } else {
-      printMessage(`Validation of ${file} failed!`, 'error');
-    }
-  }
-  stopProgressBar(
-    `Imported ${total - totalErrors} of ${total} provider(s) from ${
-      jsonFiles.length
-    } file(s).`
-  );
-}