Merge pull request #176 from CyberSource/feature/add-mle-encrypt

PHP SDK MLE Implementation

Author: gaubansa

MLE.md

@@ -0,0 +1,99 @@
+[![Generic badge](https://img.shields.io/badge/MLE-NEW-GREEN.svg)](https://shields.io/)
+
+# Message Level Encryption (MLE) Feature
+
+This feature provides an implementation of Message Level Encryption (MLE) for APIs provided by CyberSource, integrated within our SDK. This feature ensures secure communication by encrypting messages at the application level before they are sent over the network.
+
+## Configuration
+
+### Global MLE Configuration
+
+In the `merchantConfig` object, set the `useMLEGlobally` variable to enable or disable MLE for all supported APIs for the Rest SDK.
+
+- **Variable**: `useMLEGlobally`
+- **Type**: `boolean`
+- **Default**: `false`
+- **Description**: Enables MLE globally for all APIs when set to `true`. If set to `true`, it will enable MLE for all API calls that support MLE by CyberSource, unless overridden by `mapToControlMLEonAPI`.
+
+### API-level MLE Control
+
+Optionally, you can control the MLE feature at the API level using the `mapToControlMLEonAPI` variable in the `merchantConfig` object.
+
+- **Variable**: `mapToControlMLEonAPI`
+- **Type**: `map = [string, boolean]`
+- **Description**: Overrides the global MLE setting for specific APIs. The key is the function name of the API in the SDK, and the value is a boolean indicating whether MLE should be enabled (`true`) or disabled (`false`) for that specific API call.
+
+### MLE Key Alias
+
+Another optional parameter for MLE is `mleKeyAlias`, which specifies the key alias used to retrieve the MLE certificate from the JWT P12 file.
+
+- **Variable**: `mleKeyAlias`
+- **Type**: `string`
+- **Default**: `CyberSource_SJC_US`
+- **Description**: By default, CyberSource uses the `CyberSource_SJC_US` public certificate to encrypt the payload. However, users can override this default value by setting their own key alias.
+
+## Notes
+- If `useMLEGlobally` is set to true, it will enable MLE for all API calls that support MLE by CyberSource, unless overridden by mapToControlMLEonAPI.
+- If `mapToControlMLEonAPI` is not provided or does not contain a specific API function name, the global useMLEGlobally setting will be applied.
+- The `mleKeyAlias` parameter is optional and defaults to CyberSource_SJC_US if not specified by the user. Users can override this default value by setting their own key alias.
+
+## Example Configuration
+
+```php
+// Enable MLE globally for all supported APIs
+$merchantConfig->setUseMLEGlobally(true);
+```
+
+Or
+
+```php
+// Enable MLE globally for all supported APIs
+$merchantConfig->setUseMLEGlobally(true);
+
+// Optionally, control MLE at the API level
+$merchantConfig->setMapToControlMLEonAPI([
+    'apiFunctionName1' => false, // Disable MLE for this specific API
+    'apiFunctionName2' => true   // Enable MLE for this specific API
+]);
+
+// Optionally, set a custom MLE key alias
+$merchantConfig->setMleKeyAlias('Custom_Key_Alias');
+```
+
+Or
+
+```php
+// Disable MLE globally for all supported APIs
+$merchantConfig->setUseMLEGlobally(false);
+
+// Optionally, enable MLE for some APIs
+$merchantConfig->setMapToControlMLEonAPI([
+    'apiFunctionName1' => true, // Enable MLE for this specific API
+    'apiFunctionName2' => true  // Enable MLE for this specific API
+]);
+
+// Optionally, set a custom MLE key alias
+$merchantConfig->setMleKeyAlias('Custom_Key_Alias');
+```
+
+In the above examples:
+- MLE is enabled/disabled globally (`useMLEGlobally` is true/false).
+- `apiFunctionName1` will have MLE disabled/enabled based on value provided.
+- `apiFunctionName2` will have MLE enabled.
+- `mleKeyAlias` is set to `Custom_Key_Alias`, overriding the default value.
+
+Please refer given link for sample codes with MLE:
+https://github.com/CyberSource/cybersource-rest-samples-php/tree/master/Samples/MLEFeature
+
+## Additional Information
+
+### API Support
+- MLE is initially designed to support a few APIs.
+- It can be extended to support more APIs in the future based on requirements and updates.
+### Authentication Type
+- MLE is only supported with `JWT (JSON Web Token)` authentication type within the SDK.
+### Using the SDK
+To use the MLE feature in the SDK, configure the `merchantConfig` object as shown above and pass it to the SDK initialization.
+
+## Contact
+For any issues or further assistance, please open an issue on the GitHub repository or contact our support team.

README.md

@@ -100,6 +100,13 @@ More information about this new logging framework can be found in this file : [L
 
 ## Features
 
+### Message Level Encryption (MLE) Feature
+[![Generic badge](https://img.shields.io/badge/MLE-NEW-GREEN.svg)](https://shields.io/)
+
+This feature provides an implementation of Message Level Encryption (MLE) for APIs provided by CyberSource, integrated within our SDK. This feature ensures secure communication by encrypting messages at the application level before they are sent over the network.
+
+More information about this new MLE feature can be found in this file : [MLE.md](MLE.md)
+
 ### MetaKey Support
 
 A Meta Key is a single key that can be used by one, some, or all merchants (or accounts, if created by a Portfolio user) in the portfolio.

generator/cybersource-php-template/api.mustache

@@ -243,7 +243,7 @@ use \Exception;
                 $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
             } catch (Exception $e) {
                 self::$logger->error("Failed to encrypt request body:  $e");
-                throw new ApiException("Failed to encrypt request body : " + $e->getMessage());
+                throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
             }
         }
 

lib/Api/BatchesApi.php

@@ -167,7 +167,7 @@ public function getBatchReportWithHttpInfo($batchId)
                 $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
             } catch (Exception $e) {
                 self::$logger->error("Failed to encrypt request body:  $e");
-                throw new ApiException("Failed to encrypt request body : " + $e->getMessage());
+                throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
             }
         }
 
@@ -289,7 +289,7 @@ public function getBatchStatusWithHttpInfo($batchId)
                 $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
             } catch (Exception $e) {
                 self::$logger->error("Failed to encrypt request body:  $e");
-                throw new ApiException("Failed to encrypt request body : " + $e->getMessage());
+                throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
             }
         }
 
@@ -420,7 +420,7 @@ public function getBatchesListWithHttpInfo($offset = '0', $limit = '20', $fromDa
                 $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
             } catch (Exception $e) {
                 self::$logger->error("Failed to encrypt request body:  $e");
-                throw new ApiException("Failed to encrypt request body : " + $e->getMessage());
+                throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
             }
         }
 
@@ -549,7 +549,7 @@ public function postBatchWithHttpInfo($body)
                 $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
             } catch (Exception $e) {
                 self::$logger->error("Failed to encrypt request body:  $e");
-                throw new ApiException("Failed to encrypt request body : " + $e->getMessage());
+                throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
             }
         }
 

lib/Api/BillingAgreementsApi.php

@@ -181,7 +181,7 @@ public function billingAgreementsDeRegistrationWithHttpInfo($modifyBillingAgreem
                 $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
             } catch (Exception $e) {
                 self::$logger->error("Failed to encrypt request body:  $e");
-                throw new ApiException("Failed to encrypt request body : " + $e->getMessage());
+                throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
             }
         }
 
@@ -321,7 +321,7 @@ public function billingAgreementsIntimationWithHttpInfo($intimateBillingAgreemen
                 $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
             } catch (Exception $e) {
                 self::$logger->error("Failed to encrypt request body:  $e");
-                throw new ApiException("Failed to encrypt request body : " + $e->getMessage());
+                throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
             }
         }
 
@@ -446,7 +446,7 @@ public function billingAgreementsRegistrationWithHttpInfo($createBillingAgreemen
                 $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
             } catch (Exception $e) {
                 self::$logger->error("Failed to encrypt request body:  $e");
-                throw new ApiException("Failed to encrypt request body : " + $e->getMessage());
+                throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
             }
         }
 

lib/Api/BinLookupApi.php

@@ -168,7 +168,7 @@ public function getAccountInfoWithHttpInfo($createBinLookupRequest)
                 $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
             } catch (Exception $e) {
                 self::$logger->error("Failed to encrypt request body:  $e");
-                throw new ApiException("Failed to encrypt request body : " + $e->getMessage());
+                throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
             }
         }
 

lib/Api/CaptureApi.php

@@ -181,7 +181,7 @@ public function capturePaymentWithHttpInfo($capturePaymentRequest, $id)
                 $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
             } catch (Exception $e) {
                 self::$logger->error("Failed to encrypt request body:  $e");
-                throw new ApiException("Failed to encrypt request body : " + $e->getMessage());
+                throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
             }
         }
 

lib/Api/ChargebackDetailsApi.php

@@ -180,7 +180,7 @@ public function getChargebackDetailsWithHttpInfo($startTime, $endTime, $organiza
                 $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
             } catch (Exception $e) {
                 self::$logger->error("Failed to encrypt request body:  $e");
-                throw new ApiException("Failed to encrypt request body : " + $e->getMessage());
+                throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
             }
         }
 

lib/Api/ChargebackSummariesApi.php

@@ -180,7 +180,7 @@ public function getChargebackSummariesWithHttpInfo($startTime, $endTime, $organi
                 $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
             } catch (Exception $e) {
                 self::$logger->error("Failed to encrypt request body:  $e");
-                throw new ApiException("Failed to encrypt request body : " + $e->getMessage());
+                throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
             }
         }
 

lib/Api/ConversionDetailsApi.php

@@ -180,7 +180,7 @@ public function getConversionDetailWithHttpInfo($startTime, $endTime, $organizat
                 $httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
             } catch (Exception $e) {
                 self::$logger->error("Failed to encrypt request body:  $e");
-                throw new ApiException("Failed to encrypt request body : " + $e->getMessage());
+                throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
             }
         }