All files / lib/agent/authentication samlSap.js

100% Statements 107/107
90.69% Branches 39/43
100% Functions 32/32
100% Lines 107/107

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494    1x 1x 1x                                 5x 5x     3x 3x     3x 2x       1x     1x 1x       2x 2x         1x                                   1x         3x     3x             3x 2x 2x               1x                                               1x       3x         2x     2x 2x 2x 1x   2x         2x       1x                                       1x           5x 5x 5x 2x   3x 2x                                           1x 5x 2x 2x                   1x     1x     1x                           8x 8x                       8x                           8x 8x                                       1x               3x     3x   3x 2x 2x       4x         1x   4x 4x       2x 1x   1x                 3x                               1x     3x       3x   3x 1x 2x 1x   1x               3x 1x   3x 1x   3x 3x             3x                               1x             2x       2x 1x 1x               1x 1x             2x                         1x 2x 2x     2x                             1x 4x 4x   4x         2x 2x           4x                       1x     4x 1x 1x 1x     3x     4x     1x  
"use strict";
 
const parseXML = require("xml2js").parseString;
const _ = require("lodash");
const { JSDOM } = require("jsdom");
 
/**
 * Try to load service endpoint with SAP specific SAML authentication
 *
 * @public
 *
 * @param {Object} settings - normalized OData library settings. contains
 *        user creadentials
 * @param {agent} agent - instance of  HTTP client
 * @param {String} endpointUrl - url which is used for testing
 *
 * @return {Promise} the promise is resolved when endpoint is correctly loaded,
 *                       the promise is rejected othewise
 */
function authenticate(settings, agent, endpointUrl) {
  let response;
  return new Promise((resolve, reject) => {
    agent
      .fetch(endpointUrl)
      .then((res) => {
        response = res;
        return authenticate.isPossible(response);
      })
      .then((isPossible) => {
        if (isPossible) {
          authenticate
            .samlHandshake(settings, agent, response)
            .then(resolve, reject);
        } else {
          let err = new Error(
            "OData server does not support SAP - SAML authentification."
          );
          err.unsupported = true;
          reject(err);
        }
      })
      .catch((err) => {
        err.unsupported = err.status === 401;
        reject(err);
      });
  });
}
 
authenticate.authenticatorName = "SAML SAP";
 
/**
 * Main function which goes thru SAML redirects to login form. Fill login form
 * and check result from its. Redirects SAML response back to destinatioin system
 * and resolve endpoint response after authentification.
 *
 * @private
 *
 * @param {Object} settings - normalized OData library settings. contains
 *        user creadentials
 * @param {agent} agent - instance of agent HTTP client
 * @param {Object} responseFromEndpointUrl - structure which contains all information
 *        about request and response from endpoint url before authentication
 *
 * @returns {Promise} promise which is resolve by response from endpont url after
 *        authentication or rejected for invalid credentials.
 */
authenticate.samlHandshake = function (
  settings,
  agent,
  responseFromEndpointUrl
) {
  return authenticate
    .submitRedirectToLoginForm(settings, agent, responseFromEndpointUrl)
    .then((responseWithLoginForm) => {
      return authenticate.submitLoginForm(
        settings,
        agent,
        responseWithLoginForm
      );
    })
    .then((responseFromLoginForm) => {
      if (authenticate.checkResponseFromLoginPage(responseFromLoginForm)) {
        return new Promise((resolve, reject) => {
          authenticate
            .submitRedirectFromLoginForm(settings, agent, responseFromLoginForm)
            .then(resolve)
            .catch(
              authenticate.processDestinationSystemError.bind(null, reject)
            );
        });
      } else {
        return Promise.reject(
          new Error(
            `SAML Identify provider rejected authentification for ${_.get(
              settings,
              "auth.username",
              ""
            )}.`
          )
        );
      }
    });
};
 
/**
 * Process and reject error from endpointurl after SAML authentication.
 * Destination service could reject authorization or it could be down ...
 *
 * @private
 *
 * @param {Function} callBackError - reject function from new promise
 *        it is called with error
 * @param {Function} errorHttp - http error with response which contains
 *        error details
 */
authenticate.processDestinationSystemError = function (
  callBackError,
  errorHttp
) {
  if (
    _.get(errorHttp, "response.header.content-type", "").match(
      "application/xml"
    )
  ) {
    parseXML(
      _.get(errorHttp, "response.res.text", ""),
      (errorParseXML, parsedXML) => {
        let customizedError = errorHttp;
        let messages = _.get(parsedXML, "error.message");
        if (_.isArray(messages) && messages.length > 0) {
          customizedError = new Error(
            _.chain(_.get(parsedXML, "error.message"))
              .map((message) => _.get(message, "_"))
              .join("\n")
              .value()
          );
        }
        callBackError(customizedError);
      }
    );
  } else {
    callBackError(errorHttp);
  }
};
 
/**
 * Go thru SAML request/responses which is implemented as chain of the
 * requests/responses with HTML pages with forms
 *
 * @private
 *
 * @param {Function} requestGenerator - function which generates promise
 *        for next HTTP request or return null if previous requests was
 *        last in the request chain
 * @param {Promise} previousRequestPromise - promise which is resolved/rejected
 *        from previous requests in requests chain
 * @param {Function} callBack - resolve function from Promise object constructor
 *        it is called when requests chain is done
 * @param {Function} callBackError - reject function from new promise
 *        it is called with error on any request in chain
 */
authenticate.followRequests = function (
  requestGenerator,
  previousRequestPromise,
  callBack,
  callBackError
) {
  previousRequestPromise.then(authenticate.readDom).then((response) => {
    let nextRequestPromise = requestGenerator(response);
    if (!nextRequestPromise) {
      callBack(response);
    } else {
      nextRequestPromise.then(() => {
        authenticate.followRequests(
          requestGenerator,
          nextRequestPromise,
          callBack,
          callBackError
        );
      }, callBackError);
    }
  }, callBackError);
};
 
/**
 * Generates handler which process SAML requests and responses
 *
 * @private
 *
 * @param {String} actionFunctionName - name of the function which
 *        creates requests for specified SAML chain (SAMLRequest,
 *        SAMLResponse or login form)
 *
 * @returns {Function} generated handler
 */
authenticate.generateFormHandler = function (actionFunctionName) {
  return function (settings, localAgent, responseFromEndpointUrl) {
    return new Promise((resolve, reject) => {
      authenticate.followRequests(
        authenticate[actionFunctionName].bind(null, settings, localAgent),
        Promise.resolve(responseFromEndpointUrl),
        resolve,
        reject
      );
    });
  };
};
 
authenticate.submitRedirectToLoginForm = authenticate.generateFormHandler(
  "submitRedirectToLoginFormAction"
);
authenticate.submitLoginForm = authenticate.generateFormHandler(
  "submitLoginFormAction"
);
authenticate.submitRedirectFromLoginForm = authenticate.generateFormHandler(
  "submitRedirectFromLoginFormAction"
);
 
/**
 * Convert parameter defined by object to urlencoded form parameter
 *
 * @param {URLSearchParams} urlParametersToSend parameters to send via fetch
 * @param {Object} formParameter object with keys name and value which
 *        corresponds with the form input
 *
 * @returns {agent} updated agent request
 */
function reduceFormParameter(urlParametersToSend, formParameter) {
  urlParametersToSend.append(formParameter.name, formParameter.value);
  return urlParametersToSend;
}
 
/**
 * Filter for inputs which has name parameter
 *
 * @param {Object} formParameter object with keys name and value which
 *        corresponds with the form input
 *
 * @returns {Boolean} true if parameter name is correct
 */
function filterFormInputs(formParameter) {
  return formParameter.name;
}
 
/**
 * Filter for inputs which has name parameter
 *
 * @param {HTMLFormElement} samlForm object which represents SAML form
 * @param {*} placeholder just follow lodash API
 * @param {Number} index index of element in the form
 *
 * @returns {Object} object with name and value keys which corresponds
 *        with input element
 */
function mapFormInputs(samlForm, placeholder, index) {
  let input = samlForm.elements[index];
  return {
    value: input.getAttribute("value"),
    name: input.getAttribute("name"),
  };
}
 
/**
 * Follow SAML from redirects to login form
 *
 * @private
 *
 * @param {Object} settings - normalized OData library settings. contains
 *        user creadentials
 * @param {agent} localAgent - instance of agent HTTP client
 * @param {Object} response from endpointUrl which is starting point for SAML authentificaton
 * @param {String} contentText content of response
 *
 * @return {agent} request (which mimic Promise) and is is resolved/rejected when login page
 *         is found
 */
authenticate.submitRedirectToLoginFormAction = function (
  settings,
  localAgent,
  response
) {
  let samlForm;
  let postAction;
  let formParameters;
  let samlRequest = response.dom.window.document.querySelector(
    'input[name="SAMLRequest"]'
  );
  let loginForm = false;
 
  if (samlRequest) {
    samlForm = samlRequest.form;
    formParameters = _.chain(new Array(samlForm.elements.length))
      .map(mapFormInputs.bind(null, samlForm))
      .filter(filterFormInputs)
      .map((formParameter) => {
        if (
          formParameter.name.match(
            /username$/ || formParameter.name.match(/password$/)
          )
        ) {
          loginForm = true;
        }
        formParameter.value = formParameter.value || "";
        return formParameter;
      })
      .reduce(reduceFormParameter, new URLSearchParams())
      .value();
    if (loginForm) {
      postAction = null;
    } else {
      postAction = localAgent.fetch(
        localAgent.nextRequestUrl(samlForm.getAttribute("action"), response),
        {
          method: "POST",
          body: formParameters,
        }
      );
    }
  }
  return postAction;
};
 
/**
 * Submit SAP SAML login form
 *
 * @private
 *
 * @param {Object} settings - normalized OData library settings. contains
 *        user creadentials
 * @param {agent} localAgent - instance of agent HTTP client
 * @param {Object} response from endpointUrl which is starting point for SAML authentificaton
 *
 * @return {agent} request (which mimic Promise) and is is resolved/rejected when login page
 *         is found
 */
authenticate.submitLoginFormAction = function (settings, localAgent, response) {
  let samlForm;
  let submitLoginFormAction;
  let samlRequest = response.dom.window.document.querySelector(
    'input[name="SAMLRequest"]'
  );
  let errorDiv =
    response.dom.window.document.querySelector('div[role="alert"]');
 
  if (errorDiv) {
    submitLoginFormAction = Promise.reject(new Error(errorDiv.textContent));
  } else if (samlRequest) {
    samlForm = samlRequest.form;
 
    submitLoginFormAction = localAgent.fetch(
      localAgent.nextRequestUrl(samlForm.getAttribute("action"), response),
      {
        method: "POST",
        body: _.chain(new Array(samlForm.elements.length))
          .map(mapFormInputs.bind(null, samlForm))
          .filter(filterFormInputs)
          .map((formParameter) => {
            if (formParameter.name.match(/username$/)) {
              formParameter.value = _.get(settings, "auth.username", "");
            }
            if (formParameter.name.match(/password$/)) {
              formParameter.value = _.get(settings, "auth.password", "");
            }
            formParameter.value = formParameter.value || "";
            return formParameter;
          })
          .reduce(reduceFormParameter, new URLSearchParams())
          .value(),
      }
    );
  }
  return submitLoginFormAction;
};
 
/**
 * Process SAML response redirects by forms
 *
 * @private
 *
 * @param {Object} settings - normalized OData library settings. contains
 *        user creadentials
 * @param {agent} agent - instance of agent HTTP client
 * @param {Object} response from login page request
 *
 * @return {agent} request (which mimic Promise) and is is resolved/rejected when all SAML response
 *         forms are processed
 */
authenticate.submitRedirectFromLoginFormAction = function (
  settings,
  agent,
  response
) {
  let samlForm;
  let postAction;
  let samlRequest = response.dom.window.document.querySelector(
    'input[name="SAMLResponse"]'
  );
 
  if (samlRequest) {
    samlForm = samlRequest.form;
    postAction = agent.fetch(
      agent.nextRequestUrl(samlForm.getAttribute("action"), response),
      {
        method: "POST",
        body: _.chain(new Array(samlForm.elements.length))
          .map(mapFormInputs.bind(null, samlForm))
          .filter(filterFormInputs)
          .map((formParameter) => {
            formParameter.value = formParameter.value || "";
            return formParameter;
          })
          .reduce(reduceFormParameter, new URLSearchParams())
          .value(),
      }
    );
  }
  return postAction;
};
 
/**
 * Check valid response from login page. If response contains SAMLRequests
 * (sumbit from login page returns login page again) credentials is invalid.
 *
 * @private
 *
 * @param {Object} responseAfterLoginSubmit from login page request
 *
 * @return {Boolean} credentials are correct/incorrect true/false
 */
authenticate.checkResponseFromLoginPage = function (responseAfterLoginSubmit) {
  let dom = new JSDOM(responseAfterLoginSubmit.body);
  let samlRequest = dom.window.document.querySelector(
    'input[name="SAMLRequest"]'
  );
  return !samlRequest;
};
 
/**
 * Try to load service endpoint with SAP specific SAML authentication
 *
 * @private
 *
 * @param {Object} response - object generated by HTTP Client which
 *        contains all informations about HTTP response and HTTP request
 *        to OData endpoint
 *
 * @return {Promise} the promise is resolved when endpoint is correctly loaded,
 *                       the promise is rejected othewise
 */
authenticate.isPossible = function (response) {
  let promise = Promise.resolve(false, response);
  let contentType = response.headers.get("content-type");
 
  if (
    response.status === 200 &&
    _.isString(contentType) &&
    contentType.match(/text\/html/)
  ) {
    promise = authenticate.readDom(response).then(() => {
      return !!response.dom.window.document.querySelector(
        'input[name="SAMLRequest"'
      );
    });
  }
 
  return promise;
};
 
/**
 * Parse text from HTTP response to DOM
 *
 * @private
 *
 * @param {Object} response - object generated by fetch with HTTP response
 *
 * @return {Promise} the promise is resolved when DOM is parsed
 */
authenticate.readDom = function (response) {
  let promise;
 
  if (!response.dom) {
    promise = response.text().then((textContent) => {
      response.dom = new JSDOM(textContent);
      return response;
    });
  } else {
    promise = Promise.resolve(response);
  }
 
  return promise;
};
 
module.exports = authenticate;