cybersource-rest-client 0.0.76 → 0.0.77

package/src/api/UnifiedCheckoutV1CaptureContextApi.js

@@ -0,0 +1,120 @@
+/**
+ * CyberSource Merged Spec
+ * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
+ *
+ * OpenAPI spec version: 0.0.1
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.4.38
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as an anonymous module.
+    define(['Authentication/MLEUtility', 'ApiClient', 'model/GenerateUnifiedCheckoutV1CaptureContextRequest', 'model/InlineResponse4001'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../authentication/util/MLEUtility'), require('../ApiClient'), require('../model/GenerateUnifiedCheckoutV1CaptureContextRequest'), require('../model/InlineResponse4001'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.CyberSource) {
+      root.CyberSource = {};
+    }
+    root.CyberSource.UnifiedCheckoutV1CaptureContextApi = factory(root.Authentication.MLEUtility, root.CyberSource.ApiClient, root.CyberSource.GenerateUnifiedCheckoutV1CaptureContextRequest, root.CyberSource.InlineResponse4001);
+  }
+}(this, function(MLEUtility, ApiClient, GenerateUnifiedCheckoutV1CaptureContextRequest, InlineResponse4001) {
+  'use strict';
+
+  /**
+   * UnifiedCheckoutV1CaptureContext service.
+   * @module api/UnifiedCheckoutV1CaptureContextApi
+   * @version 0.0.1
+   */
+
+  /**
+   * Constructs a new UnifiedCheckoutV1CaptureContextApi. 
+   * @alias module:api/UnifiedCheckoutV1CaptureContextApi
+   * @class
+   * @param {module:ApiClient} apiClient Optional API client implementation to use,
+   * default to {@link module:ApiClient#instance} if unspecified.
+   */
+  var exports = function(configObject, apiClient) {
+    this.apiClient = apiClient || ApiClient.instance;
+
+	this.apiClient.setConfiguration(configObject);
+	
+
+    /**
+     * Callback function to receive the result of the generateUnifiedCheckoutV1CaptureContext operation.
+     * @callback module:api/UnifiedCheckoutV1CaptureContextApi~generateUnifiedCheckoutV1CaptureContextCallback
+     * @param {String} error Error message, if any.
+     * @param {'String'} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Generate Unified Checkout V1 Capture Context
+     * Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions. Click to Pay Drop-in UI is built on the Unified Checkout platform. For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](https://github.com/CyberSource/cybersource-unified-checkout-sample-java). Generate Unified Checkout V1 Capture Context Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page
+     * @param {module:model/GenerateUnifiedCheckoutV1CaptureContextRequest} generateUnifiedCheckoutV1CaptureContextRequest 
+     * @param {module:api/UnifiedCheckoutV1CaptureContextApi~generateUnifiedCheckoutV1CaptureContextCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link 'String'}
+     */
+    this.generateUnifiedCheckoutV1CaptureContext = function(generateUnifiedCheckoutV1CaptureContextRequest, callback) {
+      var postBody = generateUnifiedCheckoutV1CaptureContextRequest;
+
+      // verify the required parameter 'generateUnifiedCheckoutV1CaptureContextRequest' is set
+      if (generateUnifiedCheckoutV1CaptureContextRequest === undefined || generateUnifiedCheckoutV1CaptureContextRequest === null) {
+        throw new Error("Missing the required parameter 'generateUnifiedCheckoutV1CaptureContextRequest' when calling generateUnifiedCheckoutV1CaptureContext");
+      }
+
+      var SdkTracker = require('../utilities/tracking/SdkTracker');
+
+      var sdkTracker = new SdkTracker();
+      postBody = sdkTracker.insertDeveloperIdTracker(postBody, 'module:model/GenerateUnifiedCheckoutV1CaptureContextRequest', this.apiClient.merchantConfig.runEnvironment, this.apiClient.merchantConfig.defaultDeveloperId);
+
+
+      var pathParams = {
+      };
+      var queryParams = {
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+
+      var authNames = [];
+      var contentTypes = ['application/json;charset=utf-8'];
+      var accepts = ['application/jwt'];
+      var returnType = 'String';
+
+      //check isMLE for an api method 'this.generateUnifiedCheckoutV1CaptureContext'
+      var inboundMLEStatus = 'false';
+      var isMLEForApi = MLEUtility.checkIsMLEForAPI(this.apiClient.merchantConfig, inboundMLEStatus, 'generateUnifiedCheckoutV1CaptureContext');
+      const isResponseMLEForApi = MLEUtility.checkIsResponseMLEForAPI(this.apiClient.merchantConfig, ['generateUnifiedCheckoutV1CaptureContext']);
+
+      if (isMLEForApi === true) {
+        MLEUtility.encryptRequestPayload(this.apiClient.merchantConfig, postBody).then(postBody => {
+          return this.apiClient.callApi(
+            '/uc/v1/sessions', 'POST',
+            pathParams, queryParams, headerParams, formParams, postBody,
+            authNames, contentTypes, accepts, returnType, isResponseMLEForApi, callback
+          );
+        });
+      } else {
+        return this.apiClient.callApi(
+          '/uc/v1/sessions', 'POST',
+          pathParams, queryParams, headerParams, formParams, postBody,
+          authNames, contentTypes, accepts, returnType, isResponseMLEForApi, callback
+        );
+      }
+    }
+  };
+
+  return exports;
+}));

package/src/authentication/core/MerchantConfig.js

@@ -645,6 +645,9 @@ MerchantConfig.prototype.defaultPropValues = function defaultPropValues() {
     {
         ApiException.ApiException(Constants.PORTFOLIO_ID_REQ, logger);
     }
+	else if (this.useMetaKey && typeof (this.portfolioID) !== "string") {
+		this.portfolioID = this.portfolioID.toString();
+	}
 
     if (typeof (this.disableSSLVerification) !== "boolean") {
         this.disableSSLVerification = false;
@@ -730,9 +733,12 @@ MerchantConfig.prototype.defaultPropValues = function defaultPropValues() {
                 this.keyAlias = this.merchantID;
                 logger.warn(Constants.KEY_ALIAS_NULL_EMPTY);
             }
-            else if (this.keyAlias !== this.merchantID) {
+            if (!this.useMetaKey && this.keyAlias !== this.merchantID) {
                 this.keyAlias = this.merchantID;
                 logger.warn(Constants.INCORRECT_KEY_ALIAS);
+            } else if (this.useMetaKey && this.keyAlias !== this.portfolioID) {
+                this.keyAlias = this.portfolioID;
+                logger.warn(Constants.INCORRECT_KEY_ALIAS_FOR_METAKEY);
             }
 
             if (this.keyPass === null || this.keyPass === "" || this.keyPass === undefined) {

package/src/authentication/jwt/JWTSigToken.js

@@ -3,7 +3,6 @@
 const Jwt = require('jwt-simple');
 const Constants = require('../util/Constants');
 const KeyCertificate = require('./KeyCertificateGenerator');
-const DigestGenerator = require('../payloadDigest/DigestGenerator');
 const MLEUtility = require('../util/MLEUtility');
 
 // Constants for algorithms
@@ -20,6 +19,107 @@ const DIGEST_ALGORITHM = 'SHA-256';
  * @module authentication/jwt/JWTSigToken
  */
 
+/**
+ * Generates the payload claim set for the JWT token based on the merchant configuration and request details.
+ * @private
+ * @param {Object} merchantConfig - The merchant configuration object containing necessary details.
+ * @param {boolean} isResponseMLEForApi - Flag indicating if MLE is enabled for this API
+ * @param {Object} logger - Logger instance for logging errors and information.
+ */
+function getPayloadClaimSet(merchantConfig, isResponseMLEForApi, logger) {
+    const { randomUUID } = require('crypto');
+    const DigestGenerator = require('../payloadDigest/DigestGenerator');
+
+    const payloadClaimSet = {};
+
+    // Determine issuer
+    const issuer = merchantConfig.getUseMetaKey()
+        ? merchantConfig.getPortfolioID()
+        : merchantConfig.getMerchantID();
+
+    const requestVerb = merchantConfig.getRequestType().toLowerCase();
+
+    // Add digest claims for POST / PUT / PATCH
+    if ([Constants.POST, Constants.PUT, Constants.PATCH].includes(requestVerb)) {
+        payloadClaimSet["digest"] = DigestGenerator.generateDigest(merchantConfig, logger);
+        payloadClaimSet["digest-algorithm"] = DIGEST_ALGORITHM;
+    }
+
+    // Current UTC time in seconds
+    const nowEpochSeconds = Math.floor(Date.now() / 1000);
+
+    payloadClaimSet["iat"] = nowEpochSeconds;
+    payloadClaimSet["exp"] = nowEpochSeconds + 120; // +2 minutes
+
+    let requestTarget;
+
+    if (merchantConfig.requestTarget.includes("?")) {
+        requestTarget = merchantConfig.requestTarget.substring(0, merchantConfig.requestTarget.indexOf("?"));
+    } else {
+        requestTarget = merchantConfig.requestTarget;
+    }
+
+    // Request metadata
+    payloadClaimSet["request-host"] = merchantConfig.getRunEnvironment();
+    payloadClaimSet["request-resource-path"] = requestTarget;
+    payloadClaimSet["request-method"] = requestVerb;
+
+    // Standard JWT claims
+    payloadClaimSet["iss"] = issuer;
+    payloadClaimSet["jti"] = randomUUID();
+    payloadClaimSet["v-c-jwt-version"] = "2";
+
+    // Merchant ID (if present)
+    if (merchantConfig.getMerchantID() != null) {
+        payloadClaimSet["v-c-merchant-id"] = merchantConfig.getMerchantID();
+    }
+
+    // Optional Response MLE handling
+    try {
+        if (isResponseMLEForApi) {
+            payloadClaimSet["v-c-response-mle-kid"] = MLEUtility.validateAndAutoExtractResponseMleKid(merchantConfig, logger);
+        }
+    } catch (err) {
+        logger.fatal(GlobalLabelParameters.JWT_SIG_FAILED);
+        logger.error(err);
+        throw new Error(`${GlobalLabelParameters.JWT_SIG_FAILED} ${err.message}`);
+    }
+
+    return payloadClaimSet;
+}
+
+/**
+ * Returns the header claim set as a JavaScript object.
+ * @private
+ * @returns {Object} The header claimset object.
+ */
+function getHeaderClaimSet(certificate) {
+    const headerClaimSet = {
+        'header': {
+            'kid': getSerialNumberFromCert(certificate)
+        }
+    };
+    return headerClaimSet;
+}
+
+/**
+ * Gets the serial number from the certificate's subject attributes.
+ * @private
+ * @param {*} cert - The certificate object containing subject attributes.
+ * @returns {string} The serial number extracted from the certificate.
+ */
+function getSerialNumberFromCert(cert) {
+    if (!cert.subject || !cert.subject.attributes) {
+        throw new Error("Subject or attributes are missing in JWT P12 certificate");
+    }
+
+    const serialNumberAttr = cert.subject.attributes.find(attr => attr.name === 'serialNumber');
+    if (serialNumberAttr) {
+        return serialNumberAttr.value;
+    }
+    throw new Error("Serial number attribute not found in cert subject of JWT P12 certificate");
+}
+
 /**
  * Generates a JWT token for authentication
  * 
@@ -31,44 +131,16 @@ const DIGEST_ALGORITHM = 'SHA-256';
  */
 exports.getToken = function (merchantConfig, isResponseMLEForApi, logger) {
     try {
-        // date format is 'Mon, 09 Apr 2018 10:18:57 GMT'
-        const date = new Date(Date.now()).toUTCString();
         const rsaPrivateKey = KeyCertificate.getRSAPrivateKey(merchantConfig, logger);
-        const certificate = KeyCertificate.getX509CertificateInBase64(merchantConfig, logger, merchantConfig.getKeyAlias());
-        const requestType = merchantConfig.getRequestType().toLowerCase();
-        // Create claim set as a regular JavaScript object
-        const claimSetJson = {};
-        
-        if (requestType === Constants.GET || requestType === Constants.DELETE) {
-            claimSetJson.iat = date;
-        }
-        else if (requestType === Constants.POST || requestType === Constants.PUT
-            || requestType === Constants.PATCH) {
-            const digest = DigestGenerator.generateDigest(merchantConfig, logger);
-            claimSetJson.digest = digest;
-            claimSetJson.digestAlgorithm = DIGEST_ALGORITHM;
-            claimSetJson.iat = date;
-        }
-        
-        // Add MLE key ID if MLE is enabled
-        if (isResponseMLEForApi === true) {
-            const responseMleKID = MLEUtility.validateAndAutoExtractResponseMleKid(merchantConfig, logger);
-            // Using bracket notation for property name with hyphens
-            claimSetJson["v-c-response-mle-kid"] = responseMleKID;
-        }
+        const certificate = KeyCertificate.getX509CertificateInCert(merchantConfig, logger, merchantConfig.getKeyAlias());
 
-        const customHeader = {
-            'header': {
-                'v-c-merchant-id': merchantConfig.getMerchantID(),
-                'x5c': [certificate]
-            }
-        };
+        const claimSetJson = getPayloadClaimSet(merchantConfig, isResponseMLEForApi, logger);
+        const customHeader = getHeaderClaimSet(certificate);
 
         // Generating JWToken using the claimSetJson object directly
         const jwtToken = Jwt.encode(claimSetJson, rsaPrivateKey, JWT_ALGORITHM, customHeader);
 
         return jwtToken;
-
     } catch (err) {
         logger.error(`JWT token generation failed: ${err.message}`);
         throw new Error(`Failed to generate JWT token: ${err.message}`);

package/src/authentication/util/Constants.js

@@ -68,6 +68,7 @@ module.exports = {
     REFER_LOG                         :  "Please refer Log for details",
     MERCHANTID_REQ                    :  "MerchantID is mandatory",
     INCORRECT_KEY_ALIAS               :  "The Entered key_alias is Incorrect, Assigining merchantID value",
+    INCORRECT_KEY_ALIAS_FOR_METAKEY   :  "The Entered key_alias is Incorrect for MetaKey, Assigining portfolioID value",
     INCORRECT_KEY_PASS                :  "The Entered keyPass is Incorrect",
     AUTHENTICATION_REQ                :  "AuthenticationType is Mandatory",
     MERCHANT_KEY_ID_REQ               :  "MerchantKeyId is Mandatory",