|
| 1 | +[](https://shields.io/) |
| 2 | + |
| 3 | +# Message Level Encryption (MLE) Feature |
| 4 | + |
| 5 | +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. |
| 6 | + |
| 7 | +## Configuration |
| 8 | + |
| 9 | +### Global MLE Configuration |
| 10 | + |
| 11 | +In the `merchantConfig` object, set the `useMLEGlobally` variable to enable or disable MLE for all supported APIs for the Rest SDK. |
| 12 | + |
| 13 | +- **Variable**: `useMLEGlobally` |
| 14 | +- **Type**: `Boolean` |
| 15 | +- **Default**: `false` |
| 16 | +- **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`. |
| 17 | + |
| 18 | +### API-level MLE Control |
| 19 | + |
| 20 | +Optionally, you can control the MLE feature at the API level using the `mapToControlMLEonAPI` variable in the `merchantConfig` object. |
| 21 | + |
| 22 | +- **Variable**: `mapToControlMLEonAPI` |
| 23 | +- **Type**: `Map<String,Boolean>` |
| 24 | +- **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. |
| 25 | + |
| 26 | +### MLE Key Alias |
| 27 | + |
| 28 | +Another optional parameter for MLE is `mleKeyAlias`, which specifies the key alias used to retrieve the MLE certificate from the JWT P12 file. |
| 29 | + |
| 30 | +- **Variable**: `mleKeyAlias` |
| 31 | +- **Type**: `String` |
| 32 | +- **Default**: `CyberSource_SJC_US` |
| 33 | +- **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. |
| 34 | + |
| 35 | +## Notes |
| 36 | +- If `useMLEGlobally` is set to true, it will enable MLE for all API calls that support MLE by CyberSource, unless overridden by mapToControlMLEonAPI. |
| 37 | +- If `mapToControlMLEonAPI` is not provided or does not contain a specific API function name, the global useMLEGlobally setting will be applied. |
| 38 | +- 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. |
| 39 | + |
| 40 | +## Example Configuration |
| 41 | +``` |
| 42 | + { |
| 43 | + "merchantConfig": { |
| 44 | + "useMLEGlobally": true //globally MLE will be enabled for all MLE supported APIs |
| 45 | + } |
| 46 | + } |
| 47 | + OR |
| 48 | +//Set MLE Settings in Merchant Configuration |
| 49 | +Properties merchantProps = new Properties(); |
| 50 | +merchantProps.setProperty("useMLEGlobally", "true"); |
| 51 | + ``` |
| 52 | +Or |
| 53 | + |
| 54 | +``` |
| 55 | +{ |
| 56 | + "merchantConfig": { |
| 57 | + "useMLEGlobally": true, //globally MLE will be enabled for all MLE supported APIs |
| 58 | + "mapToControlMLEonAPI": { |
| 59 | + "apiFunctionName1": false, //if want to disable the particular api from list of MLE supported APIs |
| 60 | + "apiFunctionName2": true //if want to enable MLE on API which is not in the list of supported MLE APIs for used version of Rest SDK |
| 61 | + }, |
| 62 | + "mleKeyAlias": "Custom_Key_Alias" //optional if any custom value provided by Cybs |
| 63 | + } |
| 64 | +} |
| 65 | + OR |
| 66 | +//Set MLE Settings in Merchant Configuration |
| 67 | +Map<String,Boolean> mleMap = new HashMap<>(); |
| 68 | +mleMap.put("apiFunctionName1", false); |
| 69 | +mleMap.put("apiFunctionName2", true); |
| 70 | +
|
| 71 | +Properties merchantProps = new Properties(); |
| 72 | +merchantProps.setProperty("useMLEGlobally", "true"); |
| 73 | +merchantProps.put("mapToControlMLEonAPI", mleMap); |
| 74 | +merchantProps.setProperty("mleKeyAlias", "Custom_Key_Alias"); |
| 75 | +``` |
| 76 | +Or |
| 77 | + |
| 78 | +``` |
| 79 | +{ |
| 80 | + "merchantConfig": { |
| 81 | + "useMLEGlobally": false, //globally MLE will be disabled for all APIs |
| 82 | + "mapToControlMLEonAPI": { |
| 83 | + "apiFunctionName1": true, //if want to enable MLE for API1 |
| 84 | + "apiFunctionName2": true //if want to enable MLE for API2 |
| 85 | + }, |
| 86 | + "mleKeyAlias": "Custom_Key_Alias" //optional if any custom value provided by Cybs |
| 87 | + } |
| 88 | +} |
| 89 | + OR |
| 90 | +//Set MLE Settings in Merchant Configuration |
| 91 | +Map<String,Boolean> mleMap = new HashMap<>(); |
| 92 | +mleMap.put("apiFunctionName1", true); |
| 93 | +mleMap.put("apiFunctionName2", true); |
| 94 | +
|
| 95 | +Properties merchantProps = new Properties(); |
| 96 | +merchantProps.setProperty("useMLEGlobally", "false"); |
| 97 | +merchantProps.put("mapToControlMLEonAPI", mleMap); |
| 98 | +merchantProps.setProperty("mleKeyAlias", "Custom_Key_Alias"); |
| 99 | +``` |
| 100 | + |
| 101 | +In the above examples: |
| 102 | +- MLE is enabled/disabled globally (`useMLEGlobally` is true/false). |
| 103 | +- `apiFunctionName1` will have MLE disabled/enabled based on value provided. |
| 104 | +- `apiFunctionName2` will have MLE enabled. |
| 105 | +- `mleKeyAlias` is set to `Custom_Key_Alias`, overriding the default value. |
| 106 | + |
| 107 | +Please refer given link for sample codes with MLE: |
| 108 | +https://github.com/CyberSource/cybersource-rest-samples-java/tree/master/src/main/java/samples/MLEFeature |
| 109 | + |
| 110 | +## Additional Information |
| 111 | + |
| 112 | +### API Support |
| 113 | +- MLE is initially designed to support a few APIs. |
| 114 | +- It can be extended to support more APIs in the future based on requirements and updates. |
| 115 | +### Authentication Type |
| 116 | +- MLE is only supported with `JWT (JSON Web Token)` authentication type within the SDK. |
| 117 | +### Using the SDK |
| 118 | +To use the MLE feature in the SDK, configure the `merchantConfig` object as shown above and pass it to the SDK initialization. |
| 119 | + |
| 120 | +## Contact |
| 121 | +For any issues or further assistance, please open an issue on the GitHub repository or contact our support team. |
0 commit comments