@rockcarver/frodo-lib 1.0.0 → 2.0.0-1

package/esm/ops/Saml2Ops.mjs

@@ -1,11 +1,156 @@
 import _ from 'lodash';
 import { Saml2ProiderLocation } from '../api/ApiTypes';
-import { createProvider, updateProvider, deleteRawProvider, findProviders, getProviderByLocationAndId as _getProviderByLocationAndId, getProviderMetadata as _getProviderMetadata, getProviderMetadataUrl as _getProviderMetadataUrl, getRawProvider as _getRawProvider, getProviders, getRawProviders as _getRawProviders, putRawProvider as _putRawProvider, deleteProviderByLocationAndId } from '../api/Saml2Api';
+import { createProvider, updateProvider, findProviders, getProviderByLocationAndId as _getProviderByLocationAndId, getProviderMetadata as _getProviderMetadata, getProviderMetadataUrl as _getProviderMetadataUrl, getProviders, deleteProviderByLocationAndId } from '../api/Saml2Api';
 import { getScript } from '../api/ScriptApi';
 import { decode, decodeBase64Url, encode, encodeBase64Url } from '../api/utils/Base64';
 import { putScript } from './ScriptOps';
 import { debugMessage, printMessage } from './utils/Console';
 import { convertBase64TextToArray, convertBase64UrlTextToArray, convertTextArrayToBase64, convertTextArrayToBase64Url, getMetadata } from './utils/ExportImportUtils';
+export default class Saml2Ops {
+  constructor(state) {
+    this.state = state;
+  }
+
+  /**
+   * Get SAML2 entity provider stubs
+   * @returns {Promise<Saml2ProviderStub[]>} a promise that resolves to an array of saml2 entity stubs
+   */
+  async getSaml2ProviderStubs() {
+    return getSaml2ProviderStubs({
+      state: this.state
+    });
+  }
+
+  /**
+   * Geta SAML2 entity provider by location and id
+   * @param {string} location Entity provider location (hosted or remote)
+   * @param {string} entityId64 Base64-encoded-without-padding provider entity id
+   * @returns {Promise} a promise that resolves to a saml2 entity provider object
+   */
+  async getProviderByLocationAndId(location, entityId64) {
+    return getProviderByLocationAndId({
+      location,
+      entityId64,
+      state: this.state
+    });
+  }
+
+  /**
+   * Get a SAML2 entity provider's metadata URL by entity id
+   * @param {string} entityId SAML2 entity id
+   * @returns {string} the URL to get the metadata from
+   */
+  getProviderMetadataUrl(entityId) {
+    return getProviderMetadataUrl({
+      entityId,
+      state: this.state
+    });
+  }
+
+  /**
+   * Get a SAML2 entity provider's metadata by entity id
+   * @param {string} entityId SAML2 entity id
+   * @returns {Promise<object>} a promise that resolves to an object containing a SAML2 metadata
+   */
+  async getProviderMetadata(entityId) {
+    return getProviderMetadata({
+      entityId,
+      state: this.state
+    });
+  }
+
+  /**
+   *
+   * @param {string} entityId Provider entity id
+   * @returns {Promise<Saml2ProviderStub>} Promise resolving to a Saml2ExportInterface object.
+   */
+  async getSaml2ProviderStub(entityId) {
+    return getSaml2ProviderStub({
+      entityId,
+      state: this.state
+    });
+  }
+
+  /**
+   * Export a single entity provider. The response can be saved to file as is.
+   * @param {string} entityId Provider entity id
+   * @returns {Promise<Saml2ProviderSkeleton>} Promise resolving to a Saml2ExportInterface object.
+   */
+  async getSaml2Provider(entityId) {
+    return getSaml2Provider({
+      entityId,
+      state: this.state
+    });
+  }
+
+  /**
+   * Delete an entity provider. The response can be saved to file as is.
+   * @param {string} entityId Provider entity id
+   * @returns {Promise<Saml2ProviderSkeleton>} Promise resolving to a Saml2ExportInterface object.
+   */
+  async deleteSaml2Provider(entityId) {
+    return deleteSaml2Provider({
+      entityId,
+      state: this.state
+    });
+  }
+
+  /**
+   * Delete all entity providers.
+   * @returns {Promise<Saml2ProviderSkeleton[]>} Promise resolving to an array of Saml2ProviderSkeleton objects.
+   */
+  async deleteSaml2Providers() {
+    return deleteSaml2Providers({
+      state: this.state
+    });
+  }
+
+  /**
+   * Export a single entity provider. The response can be saved to file as is.
+   * @param {string} entityId Provider entity id
+   * @returns {Promise<Saml2ExportInterface>} Promise resolving to a Saml2ExportInterface object.
+   */
+  async exportSaml2Provider(entityId) {
+    return exportSaml2Provider({
+      entityId,
+      state: this.state
+    });
+  }
+
+  /**
+   * Export all entity providers. The response can be saved to file as is.
+   * @returns {Promise<Saml2ExportInterface>} Promise resolving to a Saml2ExportInterface object.
+   */
+  async exportSaml2Providers() {
+    return exportSaml2Providers({
+      state: this.state
+    });
+  }
+
+  /**
+   * Import a SAML entity provider
+   * @param {string} entityId Provider entity id
+   * @param {Saml2ExportInterface} importData Import data
+   */
+  async importSaml2Provider(entityId, importData) {
+    return importSaml2Provider({
+      entityId,
+      importData,
+      state: this.state
+    });
+  }
+
+  /**
+   * Import SAML entity providers
+   * @param {Saml2ExportInterface} importData Import data
+   */
+  async importSaml2Providers(importData) {
+    return importSaml2Providers({
+      importData,
+      state: this.state
+    });
+  }
+}
 export const roleMap = {
   identityProvider: 'IDP',
   serviceProvider: 'SP',
@@ -14,9 +159,13 @@ export const roleMap = {
 };
 
 // use a function vs a template variable to avoid problems in loops
-export function createSaml2ExportTemplate() {
+export function createSaml2ExportTemplate({
+  state
+}) {
   return {
-    meta: getMetadata(),
+    meta: getMetadata({
+      state
+    }),
     script: {},
     saml: {
       hosted: {},
@@ -30,10 +179,14 @@ export function createSaml2ExportTemplate() {
  * Get SAML2 entity provider stubs
  * @returns {Promise<Saml2ProviderStub[]>} a promise that resolves to an array of saml2 entity stubs
  */
-export async function getSaml2ProviderStubs() {
+export async function getSaml2ProviderStubs({
+  state
+}) {
   const {
     result
-  } = await getProviders();
+  } = await getProviders({
+    state
+  });
   return result;
 }
 
@@ -43,8 +196,16 @@ export async function getSaml2ProviderStubs() {
  * @param {string} entityId64 Base64-encoded-without-padding provider entity id
  * @returns {Promise} a promise that resolves to a saml2 entity provider object
  */
-export async function getProviderByLocationAndId(location, entityId64) {
-  return _getProviderByLocationAndId(location, entityId64);
+export async function getProviderByLocationAndId({
+  location,
+  entityId64,
+  state
+}) {
+  return _getProviderByLocationAndId({
+    location,
+    entityId64,
+    state
+  });
 }
 
 /**
@@ -52,8 +213,14 @@ export async function getProviderByLocationAndId(location, entityId64) {
  * @param {string} entityId SAML2 entity id
  * @returns {string} the URL to get the metadata from
  */
-export function getProviderMetadataUrl(entityId) {
-  return _getProviderMetadataUrl(entityId);
+export function getProviderMetadataUrl({
+  entityId,
+  state
+}) {
+  return _getProviderMetadataUrl({
+    entityId,
+    state
+  });
 }
 
 /**
@@ -61,8 +228,14 @@ export function getProviderMetadataUrl(entityId) {
  * @param {string} entityId SAML2 entity id
  * @returns {Promise<object>} a promise that resolves to an object containing a SAML2 metadata
  */
-export async function getProviderMetadata(entityId) {
-  return _getProviderMetadata(entityId);
+export async function getProviderMetadata({
+  entityId,
+  state
+}) {
+  return _getProviderMetadata({
+    entityId,
+    state
+  });
 }
 
 /**
@@ -70,22 +243,38 @@ export async function getProviderMetadata(entityId) {
  * @param {object} providerData Object representing a SAML entity provider
  * @param {object} fileData File data object to add dependencies to
  */
-async function exportDependencies(providerData, fileData) {
+async function exportDependencies({
+  providerData,
+  fileData,
+  state
+}) {
   const attrMapperScriptId = _.get(providerData, ['identityProvider', 'assertionProcessing', 'attributeMapper', 'attributeMapperScript']);
   if (attrMapperScriptId && attrMapperScriptId !== '[Empty]') {
-    const scriptData = await getScript(attrMapperScriptId);
+    const scriptData = await getScript({
+      scriptId: attrMapperScriptId,
+      state
+    });
     scriptData.script = convertBase64TextToArray(scriptData.script);
     fileData.script[attrMapperScriptId] = scriptData;
   }
   const idpAdapterScriptId = _.get(providerData, ['identityProvider', 'advanced', 'idpAdapter', 'idpAdapterScript']);
   if (idpAdapterScriptId && idpAdapterScriptId !== '[Empty]') {
-    const scriptData = await getScript(idpAdapterScriptId);
+    const scriptData = await getScript({
+      scriptId: idpAdapterScriptId,
+      state
+    });
     scriptData.script = convertBase64TextToArray(scriptData.script);
     fileData.script[idpAdapterScriptId] = scriptData;
   }
-  const metaDataResponse = await getProviderMetadata(providerData.entityId);
+  const metaDataResponse = await getProviderMetadata({
+    entityId: providerData.entityId,
+    state
+  });
   if (!metaDataResponse) {
-    throw new Error(`Unable to obtain metadata from ${getProviderMetadataUrl(providerData.entityId)}`);
+    throw new Error(`Unable to obtain metadata from ${getProviderMetadataUrl({
+      entityId: providerData.entityId,
+      state
+    })}`);
   }
   fileData.saml.metadata[providerData._id] = convertBase64UrlTextToArray(encodeBase64Url(metaDataResponse));
 }
@@ -95,9 +284,15 @@ async function exportDependencies(providerData, fileData) {
  * @param {string} entityId Provider entity id
  * @returns {Promise<Saml2ProviderStub>} Promise resolving to a Saml2ExportInterface object.
  */
-export async function getSaml2ProviderStub(entityId) {
+export async function getSaml2ProviderStub({
+  entityId,
+  state
+}) {
   debugMessage(`Saml2Ops.getSaml2ProviderStub: start [entityId=${entityId}]`);
-  const found = await findProviders(`entityId eq '${entityId}'`);
+  const found = await findProviders({
+    filter: `entityId eq '${entityId}'`,
+    state
+  });
   switch (found.resultCount) {
     case 0:
       throw new Error(`No provider with entity id '${entityId}' found`);
@@ -116,14 +311,24 @@ export async function getSaml2ProviderStub(entityId) {
  * @param {string} entityId Provider entity id
  * @returns {Promise<Saml2ProviderSkeleton>} Promise resolving to a Saml2ExportInterface object.
  */
-export async function getSaml2Provider(entityId) {
+export async function getSaml2Provider({
+  entityId,
+  state
+}) {
   debugMessage(`Saml2Ops.getSaml2Provider: start [entityId=${entityId}]`);
-  const stub = await getSaml2ProviderStub(entityId);
+  const stub = await getSaml2ProviderStub({
+    entityId,
+    state
+  });
   const {
     location
   } = stub;
   const id = stub._id;
-  const providerData = await getProviderByLocationAndId(location, id);
+  const providerData = await getProviderByLocationAndId({
+    location,
+    entityId64: id,
+    state
+  });
   debugMessage(`Saml2Ops.getSaml2Provider: end [entityId=${entityId}]`);
   return providerData;
 }
@@ -133,14 +338,24 @@ export async function getSaml2Provider(entityId) {
  * @param {string} entityId Provider entity id
  * @returns {Promise<Saml2ProviderSkeleton>} Promise resolving to a Saml2ExportInterface object.
  */
-export async function deleteSaml2Provider(entityId) {
+export async function deleteSaml2Provider({
+  entityId,
+  state
+}) {
   debugMessage(`Saml2Ops.deleteSaml2Provider: start [entityId=${entityId}]`);
-  const stub = await getSaml2ProviderStub(entityId);
+  const stub = await getSaml2ProviderStub({
+    entityId,
+    state
+  });
   const {
     location
   } = stub;
   const id = stub._id;
-  const providerData = await deleteProviderByLocationAndId(location, id);
+  const providerData = await deleteProviderByLocationAndId({
+    location,
+    entityId64: id,
+    state
+  });
   debugMessage(`Saml2Ops.deleteSaml2Provider: end [entityId=${entityId}]`);
   return providerData;
 }
@@ -149,12 +364,20 @@ export async function deleteSaml2Provider(entityId) {
  * Delete all entity providers.
  * @returns {Promise<Saml2ProviderSkeleton[]>} Promise resolving to an array of Saml2ProviderSkeleton objects.
  */
-export async function deleteSaml2Providers() {
+export async function deleteSaml2Providers({
+  state
+}) {
   debugMessage(`Saml2Ops.deleteSaml2Providers: start`);
   const providers = [];
-  const stubs = await getSaml2ProviderStubs();
+  const stubs = await getSaml2ProviderStubs({
+    state
+  });
   for (const stub of stubs) {
-    const provider = await deleteProviderByLocationAndId(stub.location, stub._id);
+    const provider = await deleteProviderByLocationAndId({
+      location: stub.location,
+      entityId64: stub._id,
+      state
+    });
     providers.push(provider);
   }
   debugMessage(`Saml2Ops.deleteSaml2Providers: end [deleted ${providers.length} providers]`);
@@ -166,18 +389,34 @@ export async function deleteSaml2Providers() {
  * @param {string} entityId Provider entity id
  * @returns {Promise<Saml2ExportInterface>} Promise resolving to a Saml2ExportInterface object.
  */
-export async function exportSaml2Provider(entityId) {
+export async function exportSaml2Provider({
+  entityId,
+  state
+}) {
   debugMessage(`Saml2Ops.exportSaml2Provider: start [entityId=${entityId}]`);
-  const exportData = createSaml2ExportTemplate();
-  const stub = await getSaml2ProviderStub(entityId);
+  const exportData = createSaml2ExportTemplate({
+    state
+  });
+  const stub = await getSaml2ProviderStub({
+    entityId,
+    state
+  });
   const {
     location
   } = stub;
   const id = stub._id;
-  const providerData = await getProviderByLocationAndId(location, id);
+  const providerData = await getProviderByLocationAndId({
+    location,
+    entityId64: id,
+    state
+  });
   exportData.saml[stub.location][providerData._id] = providerData;
   try {
-    await exportDependencies(providerData, exportData);
+    await exportDependencies({
+      providerData,
+      fileData: exportData,
+      state
+    });
   } catch (error) {
     printMessage(error.message, 'error');
   }
@@ -189,13 +428,27 @@ export async function exportSaml2Provider(entityId) {
  * Export all entity providers. The response can be saved to file as is.
  * @returns {Promise<Saml2ExportInterface>} Promise resolving to a Saml2ExportInterface object.
  */
-export async function exportSaml2Providers() {
-  const fileData = createSaml2ExportTemplate();
-  const stubs = await getSaml2ProviderStubs();
+export async function exportSaml2Providers({
+  state
+}) {
+  const fileData = createSaml2ExportTemplate({
+    state
+  });
+  const stubs = await getSaml2ProviderStubs({
+    state
+  });
   for (const stub of stubs) {
-    const providerData = await getProviderByLocationAndId(stub.location, stub._id);
+    const providerData = await getProviderByLocationAndId({
+      location: stub.location,
+      entityId64: stub._id,
+      state
+    });
     try {
-      await exportDependencies(providerData, fileData);
+      await exportDependencies({
+        providerData,
+        fileData,
+        state
+      });
     } catch (error) {
       printMessage(error, 'error');
     }
@@ -209,21 +462,33 @@ export async function exportSaml2Providers() {
  * @param {object} providerData Object representing a SAML entity provider
  * @param {object} fileData File data object to read dependencies from
  */
-async function importDependencies(providerData, fileData) {
+async function importDependencies({
+  providerData,
+  fileData,
+  state
+}) {
   debugMessage(`Saml2Ops.importDependencies: start`);
   const attrMapperScriptId = _.get(providerData, ['identityProvider', 'assertionProcessing', 'attributeMapper', 'attributeMapperScript']);
   if (attrMapperScriptId && attrMapperScriptId !== '[Empty]') {
     debugMessage(`Saml2Ops.importDependencies: attributeMapperScript=${attrMapperScriptId}`);
     const scriptData = _.get(fileData, ['script', attrMapperScriptId]);
     scriptData.script = convertTextArrayToBase64(scriptData.script);
-    await putScript(attrMapperScriptId, scriptData);
+    await putScript({
+      scriptId: attrMapperScriptId,
+      scriptData,
+      state
+    });
   }
   const idpAdapterScriptId = _.get(providerData, ['identityProvider', 'advanced', 'idpAdapter', 'idpAdapterScript']);
   if (idpAdapterScriptId && idpAdapterScriptId !== '[Empty]') {
     debugMessage(`Saml2Ops.importDependencies: idpAdapterScript=${idpAdapterScriptId}`);
     const scriptData = _.get(fileData, ['script', idpAdapterScriptId]);
     scriptData.script = convertTextArrayToBase64(scriptData.script);
-    await putScript(idpAdapterScriptId, scriptData);
+    await putScript({
+      scriptId: idpAdapterScriptId,
+      scriptData,
+      state
+    });
   }
   debugMessage(`Saml2Ops.importDependencies: end`);
 }
@@ -249,22 +514,39 @@ function getLocation(entityId64, data) {
  * @param {string} entityId Provider entity id
  * @param {Saml2ExportInterface} importData Import data
  */
-export async function importSaml2Provider(entityId, importData) {
+export async function importSaml2Provider({
+  entityId,
+  importData,
+  state
+}) {
   debugMessage(`Saml2Ops.importSaml2Provider: start`);
   const entityId64 = encode(entityId, false);
   const location = getLocation(entityId64, importData);
   debugMessage(`Saml2Ops.importSaml2Provider: entityId=${entityId}, entityId64=${entityId64}, location=${location}`);
   if (location) {
     const providerData = importData.saml[location][entityId64];
-    await importDependencies(providerData, importData);
+    await importDependencies({
+      providerData,
+      fileData: importData,
+      state
+    });
     let metaData = null;
     if (location === Saml2ProiderLocation.REMOTE) {
       metaData = convertTextArrayToBase64Url(importData.saml.metadata[entityId64]);
     }
     try {
-      await createProvider(location, providerData, metaData);
+      await createProvider({
+        location,
+        providerData,
+        metaData,
+        state
+      });
     } catch (error) {
-      await updateProvider(location, providerData);
+      await updateProvider({
+        location,
+        providerData,
+        state
+      });
     }
   } else {
     throw new Error(`Provider ${entityId} not found in import data!`);
@@ -277,7 +559,10 @@ export async function importSaml2Provider(entityId, importData) {
  * Import SAML entity providers
  * @param {Saml2ExportInterface} importData Import data
  */
-export async function importSaml2Providers(importData) {
+export async function importSaml2Providers({
+  importData,
+  state
+}) {
   debugMessage(`Saml2Ops.importSaml2Providers: start`);
   const myStatus = {
     total: 0,
@@ -297,7 +582,11 @@ export async function importSaml2Providers(importData) {
       const entityId = decode(entityId64);
       const providerData = importData.saml[location][entityId64];
       try {
-        await importDependencies(providerData, importData);
+        await importDependencies({
+          providerData,
+          fileData: importData,
+          state
+        });
       } catch (importDependenciesErr) {
         myStatus.warnings += 1;
         printMessage(`\nWarning importing dependencies for ${entityId}`, 'warn');
@@ -308,11 +597,20 @@ export async function importSaml2Providers(importData) {
         metaData = convertTextArrayToBase64Url(importData.saml.metadata[entityId64]);
       }
       try {
-        await createProvider(location, providerData, metaData);
+        await createProvider({
+          location,
+          providerData,
+          metaData,
+          state
+        });
         myStatus.successes += 1;
       } catch (createProviderErr) {
         try {
-          await updateProvider(location, providerData);
+          await updateProvider({
+            location,
+            providerData,
+            state
+          });
           myStatus.successes += 1;
         } catch (updateProviderError) {
           var _updateProviderError$;
@@ -330,62 +628,4 @@ export async function importSaml2Providers(importData) {
   debugMessage(`Saml2Ops.importSaml2Providers: end`);
   return myStatus;
 }
-
-// Contributions using legacy APIs. Need to investigate if those will be deprecated in the future
-
-/**
- * Deletes entity provider
- * @param {string} entityId The entity id for the entity to be deleted
- * @returns {Promise<Saml2ProviderSkeleton>} Promise resolving to a Saml2ExportInterface object.
- */
-export async function deleteRawSaml2Provider(entityId) {
-  debugMessage(`Saml2Ops.deleteSaml2Provider: start [entityId=${entityId}]`);
-  const response = await deleteRawProvider(entityId);
-  debugMessage(`Saml2Ops.deleteSaml2Provider: end [entityId=${entityId}]`);
-  return response;
-}
-
-/**
- * Deletes all entity providers.
- */
-export async function deleteRawSaml2Providers() {
-  const applicationList = (await getRawSaml2Providers()).result;
-  const deleteApplicationPromises = [];
-  applicationList.forEach(item => {
-    printMessage(`Deleting Application ${item._id}`, 'error');
-    deleteApplicationPromises.push(deleteRawProvider(item._id));
-  });
-  const deleteApplicationResult = await Promise.all(deleteApplicationPromises);
-  if (deleteApplicationResult.length == applicationList.length) {
-    printMessage('SAML Entity cleanup done', 'info');
-  }
-  return deleteApplicationResult;
-}
-
-/**
- * Retrieves all entity providers using the legacy federation enpoints.
- * @returns {Promise} a promise that resolves to an object containing an array of providers
- */
-export async function getRawSaml2Providers() {
-  return _getRawProviders();
-}
-
-/**
- * Retrieves all entity providers using the legacy federation enpoints.
- * @param {string} entityId The entity provider id
- * @returns {Promise} a promise that resolves to an object containing an array of providers
- */
-export async function getRawSaml2Provider(entityId) {
-  return _getRawProvider(entityId);
-}
-
-/**
- * Stores a new SAML2 entity provider
- * @param {string} entityId The entity provider id
- * @param {string} entityData The actual data containing the entity provider configuration
- * @returns {Promise} Promise that resolves to a provider object
- */
-export async function putRawSaml2Provider(entityId, entityData) {
-  return _putRawProvider(entityId, entityData);
-}
 //# sourceMappingURL=Saml2Ops.js.map