# mulesoft WSS Module - Full Documentation --- product: WSS Module version: 1.0 --- # Apply Operation Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The `apply` operation applies WSS information to a SOAP response according to the configuration specified in `WssOutboundConfig`.
Table 1. Parameters
NameMESDefault ValueTypeDescription

response

Yes

No

-

TypedValue <InputStream>

SOAP response

version

No

Yes

SOAP_12

SoapVersion

SOAP version: SOAP_11 or SOAP_12

The output is a SOAP response that contains the header element ``, resulting from applying the outbound configuration. The operation does not return any attributes.
Table 2. Errors
NamespaceTypeParentDescription

WSS

SECURITY_APPLYING

n.a.

Thrown when failing to apply WSS in the response

WSS

MISSING_CERTIFICATE

n.a.

Thrown when unable to get a certificate from either the trustStore or the keystore

## Encrypt > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to apply encryption using a keystore: Encryption Example ```XML ``` ## Sign > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to sign a SOAP response using a keystore and the `RSAwithSHA1` algorithm: Signature Example ```XML ``` ## Encrypt and Sign a Certificate > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example validates a signed request, saves the signing certificate, and uses it later in the `apply-wss` operation to sign the response: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxx+xxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Encryption Example ```XML ``` --- product: WSS Module version: 1.1 --- # Apply Operation Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The `apply` operation applies WSS information to a SOAP response according to the configuration specified in `WssOutboundConfig`.
Table 1. Parameters
NameMESDefault ValueTypeDescription

response

Yes

No

-

TypedValue <InputStream>

SOAP response

version

No

Yes

SOAP_12

SoapVersion

SOAP version: SOAP_11 or SOAP_12

The output is a SOAP response that contains the header element ``, resulting from applying the outbound configuration. The operation does not return any attributes.
Table 2. Errors
NamespaceTypeParentDescription

WSS

SECURITY_APPLYING

n.a.

Thrown when failing to apply WSS in the response

WSS

MISSING_CERTIFICATE

n.a.

Thrown when unable to get a certificate from either the trustStore or the keystore

## Encrypt > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to apply encryption using a keystore: Encyption Example ```XML ``` ## Sign > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This exampe shows you how to sign a SOAP response using a keystore and the `RSAwithSHA1` algorithm: Signature Example ```XML ``` ## Encrypt and Sign a Certificate > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example validates a signed request, saves the signing certificate, and uses it later in the `apply-wss` operation to sign the response: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxx+xxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Encyption Example ```XML ``` --- product: WSS Module version: 1.2 --- # Apply Operation Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The `apply` operation applies WSS information to a SOAP response according to the configuration specified in `WssOutboundConfig`.
Table 1. Parameters
NameMESDefault ValueTypeDescription

response

Yes

No

-

TypedValue <InputStream>

SOAP response

version

No

Yes

SOAP_12

SoapVersion

SOAP version: SOAP_11 or SOAP_12

The output is a SOAP response that contains the header element ``, resulting from applying the outbound configuration. The operation does not return any attributes.
Table 2. Errors
NamespaceTypeParentDescription

WSS

SECURITY_APPLYING

n.a.

Thrown when failing to apply WSS in the response

WSS

MISSING_CERTIFICATE

n.a.

Thrown when unable to get a certificate from either the trustStore or the keystore

## Encrypt > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to apply encryption using a keystore: Encyption Example ```XML ``` ## Sign > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This exampe shows you how to sign a SOAP response using a keystore and the `RSAwithSHA1` algorithm: Signature Example ```XML ``` ## Encrypt and Sign a Certificate > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example validates a signed request, saves the signing certificate, and uses it later in the `apply-wss` operation to sign the response: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxx+xxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Encyption Example ```XML ``` --- product: WSS Module version: 2.0 --- # Apply Operation Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The `apply` operation applies WSS information to a SOAP response according to the configuration specified in `WssOutboundConfig`.
Table 1. Parameters
NameMESDefault ValueTypeDescription

response

Yes

No

-

TypedValue <InputStream>

SOAP response

version

No

Yes

SOAP_12

SoapVersion

SOAP version: SOAP_11 or SOAP_12

The output is a SOAP response that contains the header element ``, resulting from applying the outbound configuration. The operation does not return any attributes.
Table 2. Errors
NamespaceTypeParentDescription

WSS

SECURITY_APPLYING

n.a.

Thrown when failing to apply WSS in the response

WSS

MISSING_CERTIFICATE

n.a.

Thrown when unable to get a certificate from either the trustStore or the keystore

## Encrypt > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to apply encryption using a keystore: Encyption Example ```XML ``` ## Sign > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This exampe shows you how to sign a SOAP response using a keystore and the `RSAwithSHA1` algorithm: Signature Example ```XML ``` ## Encrypt and Sign a Certificate > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example validates a signed request, saves the signing certificate, and uses it later in the `apply-wss` operation to sign the response: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxx+xxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Encyption Example ```XML ``` --- product: WSS Module version: 2.1 --- # Apply Operation Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The `apply` operation applies WSS information to a SOAP response according to the configuration specified in `WssOutboundConfig`.
Table 1. Parameters
NameMESDefault ValueTypeDescription

response

Yes

No

-

TypedValue <InputStream>

SOAP response

version

No

Yes

SOAP_12

SoapVersion

SOAP version: SOAP_11 or SOAP_12

The output is a SOAP response that contains the header element ``, resulting from applying the outbound configuration. The operation does not return any attributes.
Table 2. Errors
NamespaceTypeParentDescription

WSS

SECURITY_APPLYING

n.a.

Thrown when failing to apply WSS in the response

WSS

MISSING_CERTIFICATE

n.a.

Thrown when unable to get a certificate from either the trustStore or the keystore

## Encrypt > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to apply encryption using a keystore: Encryption Example ```XML ``` ## Sign > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to sign a SOAP response using a keystore and the `RSAwithSHA256` algorithm: Signature Example ```XML ``` ## Encrypt and Sign a Certificate > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example validates a signed request, saves the signing certificate, and uses it later in the `apply-wss` operation to sign the response: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxx+xxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Encryption Example ```XML ``` --- product: WSS Module version: 2.2 is-latest-version: true --- # Apply Operation Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The `apply` operation applies WSS information to a SOAP response according to the configuration specified in `WssOutboundConfig`.
Table 1. Parameters
NameMESDefault ValueTypeDescription

response

Yes

No

-

TypedValue <InputStream>

SOAP response

version

No

Yes

SOAP_12

SoapVersion

SOAP version: SOAP_11 or SOAP_12

The output is a SOAP response that contains the header element ``, resulting from applying the outbound configuration. The operation does not return any attributes.
Table 2. Errors
NamespaceTypeParentDescription

WSS

SECURITY_APPLYING

n.a.

Thrown when failing to apply WSS in the response

WSS

MISSING_CERTIFICATE

n.a.

Thrown when unable to get a certificate from either the trustStore or the keystore

## Encrypt > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to apply encryption using a keystore: Encryption Example ```XML ``` ## Sign > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to sign a SOAP response using a keystore and the `RSAwithSHA256` algorithm: Signature Example ```XML ``` ## Encrypt and Sign a Certificate > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example validates a signed request, saves the signing certificate, and uses it later in the `apply-wss` operation to sign the response: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxx+xxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Encryption Example ```XML ``` --- product: WSS Module version: 2.0 --- # Upgrading and Migrating WSS Module to Version 2.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Upgrade WSS Module to version 2.x. ## Supported Upgrade Paths
From VersionTo Version

1.x

2.x

## Changes in This Release WSS Module 2.0 includes these changes. - WSS Module (and its dependencies) are now compilable and compatible only with Java 17. - To align with modern development practices and ensure continued compatibility with secure and supported libraries, WSS Module is upgraded from Spring 5.x to Spring 6.x. - In the **Encryption Config** type, the `EMBEDDED_KEY_NAME` option has been removed from the **Encryption Key Identifier** field. ## Upgrade Prerequisites Before you perform the upgrade, you must create a backup of your files, data, and configurations in case you need to restore them. ## Upgrade Steps Follow these steps to perform the upgrade: 1. In Anypoint Studio, right-click the project and select **Manage Dependencies** > **Manage Modules**. 2. Select `Web Service Security Module` and click **Update version**. 3. Click **Apply and Close**. 4. Verify that the WSS Module dependency version is `2.0.0` in the `pom.xml` file in the Mule project. Alternatively, you can manually update the WSS Module dependency version in the `pom.xml` file in the Mule project, or simply add the updated module to the project. ### Verify the Upgrade After you upgrade the connector, follow these steps to verify the upgrade: 1. In Studio, verify that there are no errors in the **Problems** or **Console** views. 2. Verify that there are no problems in the project `pom.xml` file. 3. Test the connection to verify that the operations work. ## Troubleshoot If there are problems with caching the parameters and caching the metadata, try restarting Anypoint Studio. ### Revert the Upgrade If it is necessary to revert to the previous version of WSS Module, change the WSS Module dependency version `2.0.0` in the project’s `pom.xml` to the previous version. You must update the project’s `pom.xml` in Anypoint Studio. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [WSS Module Reference](https://docs.mulesoft.com/wss-module/2.0/wss-reference) - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 2.1 --- # Upgrading and Migrating WSS Module to Version 2.1 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Upgrade WSS Module to version 2.x. ## Supported Upgrade Paths
From VersionTo Version

2.0.x

2.1.x

## Changes in This Release WSS Module 2.1 includes these changes. - WSS Module upgrades the default hashing algorithm from SHA-1 to SHA-256 to enhance cryptographic security and align with FIPS 140-3 approved standards. ## Upgrade Prerequisites Before you perform the upgrade, you must create a backup of your files, data, and configurations in case you must restore them. ## Upgrade Steps Follow these steps to perform the upgrade: 1. In Anypoint Studio, right-click the project and select **Manage Dependencies** > **Manage Modules**. 2. Select `Web Service Security Module` and click **Update version**. 3. Click **Apply and Close**. 4. Verify that the WSS Module dependency version is `2.1.0` in the `pom.xml` file in the Mule project. Alternatively, you can manually update the WSS Module dependency version in the `pom.xml` file in the Mule project, or simply add the updated module to the project. ### Verify the Upgrade After you upgrade the connector, follow these steps to verify the upgrade: 1. In Studio, verify that there are no errors in the **Problems** or **Console** views. 2. Verify that there are no problems in the project `pom.xml` file. 3. Test the connection to verify that the operations work. ## Troubleshoot If there are problems with caching the parameters and caching the metadata, try restarting Anypoint Studio. ### Revert the Upgrade If it’s necessary to revert to the previous version of WSS Module, change the WSS Module dependency version `2.1.0` in the project’s `pom.xml` to the previous version. You must update the project’s `pom.xml` in Anypoint Studio. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [WSS Module Reference](https://docs.mulesoft.com/wss-module/2.1/wss-reference) - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 2.2 is-latest-version: true --- # Upgrading and Migrating WSS Module to Version 2.2 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Upgrade WSS Module to version 2.x. ## Supported Upgrade Paths
From VersionTo Version

2.1.x

2.2.x

## Changes in This Release WSS Module 2.2 includes this change. - WSS Module 2.2.0 introduces dynamic telemetry traces to improve API operation identification and observability. ## Upgrade Prerequisites Before you perform the upgrade, you must create a backup of your files, data, and configurations in case you must restore them. ## Upgrade Steps Follow these steps to perform the upgrade: 1. In Anypoint Studio, right-click the project and select **Manage Dependencies** > **Manage Modules**. 2. Select `Web Service Security Module` and click **Update version**. 3. Click **Apply and Close**. 4. Verify that the WSS Module dependency version is `2.2.x` (for example, `2.2.3`) in the `pom.xml` file in the Mule project. Alternatively, you can manually update the WSS Module dependency version in the `pom.xml` file in the Mule project, or simply add the updated module to the project. ### Verify the Upgrade After you upgrade the connector, follow these steps to verify the upgrade: 1. In Studio, verify that there are no errors in the **Problems** or **Console** views. 2. Verify that there are no problems in the project `pom.xml` file. 3. Test the connection to verify that the operations work. ## Troubleshoot If there are problems with caching the parameters and caching the metadata, try restarting Anypoint Studio. ### Revert the Upgrade If it’s necessary to revert to the previous version of WSS Module, change the WSS Module dependency version `2.2.x` in the project’s `pom.xml` to the previous version. You must update the project’s `pom.xml` in Anypoint Studio. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [WSS Module Reference](https://docs.mulesoft.com/wss-module/latest/wss-reference) - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 1.0 --- # Using Anypoint Studio to Configure WSS Module > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). After you configure and run the connector, you can view the app log, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If you need additional information about the connector fields after reading the Studio topic, see [WSS Module Reference](https://docs.mulesoft.com/wss-module/1.0/wss-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add WSS Module to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `WSS Module` in the search field. 3. Click the connector name in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure an Input Source An input source initiates a flow when a specified condition is met. You can configure one of these input sources to use with WSS Module: <\* connector-specific input source> \* `HTTP Listener`, which initiates a flow each time it receives a request on the configured host and port \* `Scheduler`, which initiates a flow when a time-based condition is met For example, to configure an HTTP listener, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (+) next to the **Connector configuration** field to configure a global element that can be used by all instances of `HTTP Listener` in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for WSS Module, follow these steps: 1. In the **Mule Palette** view, select **WSS Module** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials the connector uses to access the target WSS Module system. WSS Module supports . To configure the global element for WSS Module, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields. ## View the App Log You can view the app log (`log4j2.xml`) as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. App log output is available at the location specified by the log path, which defaults to `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## See Also - [WSS Module Reference](https://docs.mulesoft.com/wss-module/1.0/wss-reference) - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 1.1 --- # Using Anypoint Studio to Configure WSS Module > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). After you configure and run the connector, you can view the app log, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If you need additional information about the connector fields after reading the Studio topic, see [WSS Module Reference](https://docs.mulesoft.com/wss-module/1.1/wss-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add WSS Module to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `WSS Module` in the search field. 3. Click the connector name in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure an Input Source An input source initiates a flow when a specified condition is met. You can configure one of these input sources to use with WSS Module: <\* connector-specific input source> \* `HTTP Listener`, which initiates a flow each time it receives a request on the configured host and port \* `Scheduler`, which initiates a flow when a time-based condition is met For example, to configure an HTTP listener, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (+) next to the **Connector configuration** field to configure a global element that can be used by all instances of `HTTP Listener` in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for WSS Module, follow these steps: 1. In the **Mule Palette** view, select **WSS Module** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials the connector uses to access the target WSS Module system. WSS Module supports . To configure the global element for WSS Module, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields. ## View the App Log You can view the app log (`log4j2.xml`) as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. App log output is available at the location specified by the log path, which defaults to `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## See Also - [WSS Module Reference](https://docs.mulesoft.com/wss-module/1.1/wss-reference) - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 1.2 --- # Using Anypoint Studio to Configure WSS Module > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). After you configure and run the connector, you can view the app log, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If you need additional information about the connector fields after reading the Studio topic, see [WSS Module Reference](https://docs.mulesoft.com/wss-module/1.2/wss-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add WSS Module to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `WSS Module` in the search field. 3. Click the connector name in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure an Input Source An input source initiates a flow when a specified condition is met. You can configure one of these input sources to use with WSS Module: <\* connector-specific input source> \* `HTTP Listener`, which initiates a flow each time it receives a request on the configured host and port \* `Scheduler`, which initiates a flow when a time-based condition is met For example, to configure an HTTP listener, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (+) next to the **Connector configuration** field to configure a global element that can be used by all instances of `HTTP Listener` in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for WSS Module, follow these steps: 1. In the **Mule Palette** view, select **WSS Module** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials the connector uses to access the target WSS Module system. WSS Module supports . To configure the global element for WSS Module, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields. ## View the App Log You can view the app log (`log4j2.xml`) as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. App log output is available at the location specified by the log path, which defaults to `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## See Also - [WSS Module Reference](https://docs.mulesoft.com/wss-module/1.2/wss-reference) - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 2.0 --- # Using Anypoint Studio to Configure WSS Module > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). After you configure and run the connector, you can view the app log, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If you need additional information about the connector fields after reading the Studio topic, see [WSS Module Reference](https://docs.mulesoft.com/wss-module/2.0/wss-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add WSS Module to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `WSS Module` in the search field. 3. Click the connector name in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure an Input Source An input source initiates a flow when a specified condition is met. You can configure one of these input sources to use with WSS Module: <\* connector-specific input source> \* `HTTP Listener`, which initiates a flow each time it receives a request on the configured host and port \* `Scheduler`, which initiates a flow when a time-based condition is met For example, to configure an HTTP listener, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (+) next to the **Connector configuration** field to configure a global element that can be used by all instances of `HTTP Listener` in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for WSS Module, follow these steps: 1. In the **Mule Palette** view, select **WSS Module** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials the connector uses to access the target WSS Module system. WSS Module supports . To configure the global element for WSS Module, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields. ## View the App Log You can view the app log (`log4j2.xml`) as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. App log output is available at the location specified by the log path, which defaults to `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## See Also - [WSS Module Reference](https://docs.mulesoft.com/wss-module/2.0/wss-reference) - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 2.1 --- # Using Anypoint Studio to Configure WSS Module > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). After you configure and run the connector, you can view the app log, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If you need additional information about the connector fields after reading the Studio topic, see [WSS Module Reference](https://docs.mulesoft.com/wss-module/2.1/wss-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add WSS Module to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `WSS Module` in the search field. 3. Click the connector name in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure an Input Source An input source initiates a flow when a specified condition is met. You can configure one of these input sources to use with WSS Module: <\* connector-specific input source> \* `HTTP Listener`, which initiates a flow each time it receives a request on the configured host and port \* `Scheduler`, which initiates a flow when a time-based condition is met For example, to configure an HTTP listener, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (+) next to the **Connector configuration** field to configure a global element that can be used by all instances of `HTTP Listener` in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for WSS Module, follow these steps: 1. In the **Mule Palette** view, select **WSS Module** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials the connector uses to access the target WSS Module system. WSS Module supports . To configure the global element for WSS Module, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields. ## View the App Log You can view the app log (`log4j2.xml`) as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. App log output is available at the location specified by the log path, which defaults to `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## See Also - [WSS Module Reference](https://docs.mulesoft.com/wss-module/2.1/wss-reference) - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 2.2 is-latest-version: true --- # Using Anypoint Studio to Configure WSS Module > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). After you configure and run the connector, you can view the app log, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If you need additional information about the connector fields after reading the Studio topic, see [WSS Module Reference](https://docs.mulesoft.com/wss-module/latest/wss-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add WSS Module to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `WSS Module` in the search field. 3. Click the connector name in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure an Input Source An input source initiates a flow when a specified condition is met. You can configure one of these input sources to use with WSS Module: <\* connector-specific input source> \* `HTTP Listener`, which initiates a flow each time it receives a request on the configured host and port \* `Scheduler`, which initiates a flow when a time-based condition is met For example, to configure an HTTP listener, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (+) next to the **Connector configuration** field to configure a global element that can be used by all instances of `HTTP Listener` in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for WSS Module, follow these steps: 1. In the **Mule Palette** view, select **WSS Module** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials the connector uses to access the target WSS Module system. WSS Module supports . To configure the global element for WSS Module, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields. ## View the App Log You can view the app log (`log4j2.xml`) as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. App log output is available at the location specified by the log path, which defaults to `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## See Also - [WSS Module Reference](https://docs.mulesoft.com/wss-module/latest/wss-reference) - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 1.0 --- # Validate Operation Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This `validate` operation validates an incoming SOAP request that contains WSS information. The WSS module validates the request against a `WssInboundConfig` configuration.
Table 1. Parameters
NameMESDefault ValueTypeDescription

request

Yes

No

n.a.

TypedValue <InputStream>

SOAP request

version

No

No

SOAP_12

SoapVersion

SOAP protocol version

The output is the same SOAP request received. The operation does not return any attributes.
Table 2. Errors
NamespaceTypeParentDescription

WSS

SECURITY_VALIDATING

n.a.

Thrown when the request is not valid or no WS-Security information is found

WSS

MISSING_CERTIFICATE

n.a.

Thrown when unable to get a certificate from either the truststore or the keystore

## Decryption > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to decrpyt a request using a keystore: Request Example ```XML CN=OLEKSIYS-W3T,OU=Sun Java System Application Server,O=Sun Microsystems,L=Santa Clara,ST=California,C=US1182300426xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= ``` Multipart Request Example ```XML ------=_Part_8049_2119795515.1555963425591 Content-Type: application/soap+xml Content-ID: main CN=OLEKSIYS-W3T,OU=Sun Java System Application Server,O=Sun Microsystems,L=Santa Clara,ST=California,C=US1182300426xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= ------=_Part_8049_2119795515.1555963425591 Content-Type: application/json Content-Disposition: related; name="file1"; filename="a.json" Content-ID: file1 { "title": "Java 8 in Action", "author": "Mario Fusco", "year": 2014 } ------=_Part_8049_2119795515.1555963425591-- ``` Decryption Example ```XML ``` ## UsernameToken Validation > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. The following examples show you how to validate against either an [LDAP server](#ldap-validate) or a provided [username/password credentials pair](#username-password). Use LDAP authentication to validate multiple users. Credentials validation does not support validation of multiple users. ### LDAP Authentication This example shows `usernameToken` validation against an LDAP server. The username and password from the request are validated in the LDAP server. Request Example ```XML username password test username ``` Validation Example ```XML ``` ### Credentials Authentication This example shows a `usernameToken` validation against a configured pair of username and password: Request Example ```XML username username test username ``` Multipart Request Example ```XML ------=_Part_8049_2119795515.1555963425591 Content-Type: application/soap+xml Content-ID: main username username test username ------=_Part_8049_2119795515.1555963425591 Content-Type: application/json Content-Disposition: related; name="file1"; filename="a.json" Content-ID: file1 { "title": "Java 8 in Action", "author": "Mario Fusco", "year": 2014 } ------=_Part_8049_2119795515.1555963425591-- ``` Validation Example ```XML ``` ## Validate Signature The following examples show you how to validate signatures in your incoming requests against a configured [trustore](#validate-trustore-signature), a [binary security token](#validate-binary-security-token), or a [X.509 certificate](#validate-x509-certificate). ### Trustore > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of validation of the request signature against a configured truststore to ensure that only valid messages from trusted senders are received: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxX+xxxxxxxxxxxxxxxxxxxx/xxxxxxxx xxxxxxx/xxxxxxxxxx xxxxxxxx+xxx/xxxxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Validation Example ```XML ``` ### BinarySecurityToken Signature > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of validation against the truststore of a request signed with a binary security token. Request Example ```XML xxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxx+xxxxxx/xxxxxxxxxxxxxxH/d9uuvKNSGhJPNoJtm1DhWBQmI=xxxxxxxxx+xxxx/xxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx== ? ? ? ? ? ? ? ? ? ? ``` Validation Example ```XML ``` ### X.509 Certificate > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. The following example shows validation of an X.509 certificate issuer by pattern: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Validation Example ```XML ``` ## Validate Timestamp > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to validate the `` element in your incoming SOAP requests: Request Example ```XML 2001-09-13T08:42:00Z 2001-10-13T09:00:00Z test timestamp ``` Timestamp Validation Example ```XML ``` ## Validate SAML The following examples show you how to validate both [signed](#signed-saml) or [unsigned](#unsigned-saml) SAML assertions in your incoming SOAP requests. ### Signed SAML Assertion > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of a signed SAML assertion that requires the `Subject Confirmation Method` to be `Bearer`: Request Example ```XML WssTestxX+xxxxxxxxxx=mT9648OrsRiYV/xxxx/xxxxxxxx/xxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=USxxxxxxxxxxxx+xxxxxxxxxxxxxxxxxx=o=test test ``` Signed SAML Assertion Validation Example ```XML ``` ### Unsigned SAML Assertion > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of SAML assertion of unsigned SOAP message: Request Example ```XML WssTesto=test test ``` Unsigned SAML Assertion Validation Example ```XML ``` --- product: WSS Module version: 1.1 --- # Validate Operation Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This `validate` operation validates an incoming SOAP request that contains WSS information. The WSS module validates the request against a `WssInboundConfig` configuration.
Table 1. Parameters
NameMESDefault ValueTypeDescription

request

Yes

No

n.a.

TypedValue <InputStream>

SOAP request

version

No

No

SOAP_12

SoapVersion

SOAP protocol version

The output is the same SOAP request received. The operation does not return any attributes.
Table 2. Errors
NamespaceTypeParentDescription

WSS

SECURITY_VALIDATING

n.a.

Thrown when the request is not valid or no WS-Security information is found

WSS

MISSING_CERTIFICATE

n.a.

Thrown when unable to get a certificate from either the truststore or the keystore

## Decryption > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to decrpyt a request using a keystore: Request Example ```XML CN=OLEKSIYS-W3T,OU=Sun Java System Application Server,O=Sun Microsystems,L=Santa Clara,ST=California,C=US1182300426xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= ``` Multipart Request Example ```XML ------=_Part_8049_2119795515.1555963425591 Content-Type: application/soap+xml Content-ID: main CN=OLEKSIYS-W3T,OU=Sun Java System Application Server,O=Sun Microsystems,L=Santa Clara,ST=California,C=US1182300426xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= ------=_Part_8049_2119795515.1555963425591 Content-Type: application/json Content-Disposition: related; name="file1"; filename="a.json" Content-ID: file1 { "title": "Java 8 in Action", "author": "Mario Fusco", "year": 2014 } ------=_Part_8049_2119795515.1555963425591-- ``` Decryption Example ```XML ``` ## UsernameToken Validation > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. The following examples show you how to validate against either an [LDAP server](#ldap-validate) or a provided [username/password credentials pair](#username-password). Use LDAP authentication to validate multiple users. Credentials validation does not support validation of multiple users. ### LDAP Authentication This example shows `usernameToken` validation against an LDAP server. The username and password from the request are validated in the LDAP server. Request Example ```XML username password test username ``` Validation Example ```XML ``` ### Credentials Authentication This example shows a `usernameToken` validation against a configured pair of username and password: Request Example ```XML username username test username ``` Multipart Request Example ```XML ------=_Part_8049_2119795515.1555963425591 Content-Type: application/soap+xml Content-ID: main username username test username ------=_Part_8049_2119795515.1555963425591 Content-Type: application/json Content-Disposition: related; name="file1"; filename="a.json" Content-ID: file1 { "title": "Java 8 in Action", "author": "Mario Fusco", "year": 2014 } ------=_Part_8049_2119795515.1555963425591-- ``` Validation Example ```XML ``` ## Validate Signature The following examples show you how to validate signatures in your incoming requests against a configured [trustore](#validate-trustore-signature), a [binary security token](#validate-binary-security-token), or a [X.509 certificate](#validate-x509-certificate). ### Trustore > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of validation of the request signature against a configured truststore to ensure that only valid messages from trusted senders are received: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxX+xxxxxxxxxxxxxxxxxxxx/xxxxxxxx xxxxxxx/xxxxxxxxxx xxxxxxxx+xxx/xxxxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Validation Example ```XML ``` ### BinarySecurityToken Signature > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of validation against the truststore of a request signed with a binary security token. Request Example ```XML xxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxx+xxxxxx/xxxxxxxxxxxxxxH/d9uuvKNSGhJPNoJtm1DhWBQmI=xxxxxxxxx+xxxx/xxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx== ? ? ? ? ? ? ? ? ? ? ``` Validation Example ```XML ``` ### X.509 Certificate > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. The following example shows validation of an X.509 certificate issuer by pattern: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Validation Example ```XML ``` ## Validate Timestamp > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to validate the `` element in your incoming SOAP requests: Request Example ```XML 2001-09-13T08:42:00Z 2001-10-13T09:00:00Z test timestamp ``` Timestamp Validation Example ```XML ``` ## Validate SAML The following examples show you how to validate both [signed](#signed-saml) or [unsigned](#unsigned-saml) SAML assertions in your incoming SOAP requests. ### Signed SAML Assertion > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of a signed SAML assertion that requires the `Subject Confirmation Method` to be `Bearer`: Request Example ```XML WssTestxX+xxxxxxxxxx=mT9648OrsRiYV/xxxx/xxxxxxxx/xxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=USxxxxxxxxxxxx+xxxxxxxxxxxxxxxxxx=o=test test ``` Signed SAML Assertion Validation Example ```XML ``` ### Unsigned SAML Assertion > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of SAML assertion of unsigned SOAP message: Request Example ```XML WssTesto=test test ``` Unsigned SAML Assertion Validation Example ```XML ``` --- product: WSS Module version: 1.2 --- # Validate Operation Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This `validate` operation validates an incoming SOAP request that contains WSS information. The WSS module validates the request against a `WssInboundConfig` configuration.
Table 1. Parameters
NameMESDefault ValueTypeDescription

request

Yes

No

n.a.

TypedValue <InputStream>

SOAP request

version

No

No

SOAP_12

SoapVersion

SOAP protocol version

The output is the same SOAP request received. The operation does not return any attributes.
Table 2. Errors
NamespaceTypeParentDescription

WSS

SECURITY_VALIDATING

n.a.

Thrown when the request is not valid or no WS-Security information is found

WSS

MISSING_CERTIFICATE

n.a.

Thrown when unable to get a certificate from either the truststore or the keystore

## Decryption > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to decrpyt a request using a keystore: Request Example ```XML CN=OLEKSIYS-W3T,OU=Sun Java System Application Server,O=Sun Microsystems,L=Santa Clara,ST=California,C=US1182300426xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= ``` Multipart Request Example ```XML ------=_Part_8049_2119795515.1555963425591 Content-Type: application/soap+xml Content-ID: main CN=OLEKSIYS-W3T,OU=Sun Java System Application Server,O=Sun Microsystems,L=Santa Clara,ST=California,C=US1182300426xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= ------=_Part_8049_2119795515.1555963425591 Content-Type: application/json Content-Disposition: related; name="file1"; filename="a.json" Content-ID: file1 { "title": "Java 8 in Action", "author": "Mario Fusco", "year": 2014 } ------=_Part_8049_2119795515.1555963425591-- ``` Decryption Example ```XML ``` ## UsernameToken Validation > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. The following examples show you how to validate against either an [LDAP server](#ldap-validate) or a provided [username/password credentials pair](#username-password). Use LDAP authentication to validate multiple users. Credentials validation does not support validation of multiple users. ### LDAP Authentication This example shows `usernameToken` validation against an LDAP server. The username and password from the request are validated in the LDAP server. Request Example ```XML username password test username ``` Validation Example ```XML ``` ### Credentials Authentication This example shows a `usernameToken` validation against a configured pair of username and password: Request Example ```XML username username test username ``` Multipart Request Example ```XML ------=_Part_8049_2119795515.1555963425591 Content-Type: application/soap+xml Content-ID: main username username test username ------=_Part_8049_2119795515.1555963425591 Content-Type: application/json Content-Disposition: related; name="file1"; filename="a.json" Content-ID: file1 { "title": "Java 8 in Action", "author": "Mario Fusco", "year": 2014 } ------=_Part_8049_2119795515.1555963425591-- ``` Validation Example ```XML ``` ## Validate Signature The following examples show you how to validate signatures in your incoming requests against a configured [trustore](#validate-trustore-signature), a [binary security token](#validate-binary-security-token), or a [X.509 certificate](#validate-x509-certificate). ### Trustore > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of validation of the request signature against a configured truststore to ensure that only valid messages from trusted senders are received: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxX+xxxxxxxxxxxxxxxxxxxx/xxxxxxxx xxxxxxx/xxxxxxxxxx xxxxxxxx+xxx/xxxxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Validation Example ```XML ``` ### BinarySecurityToken Signature > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of validation against the truststore of a request signed with a binary security token. Request Example ```XML xxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxx+xxxxxx/xxxxxxxxxxxxxxH/d9uuvKNSGhJPNoJtm1DhWBQmI=xxxxxxxxx+xxxx/xxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx== ? ? ? ? ? ? ? ? ? ? ``` Validation Example ```XML ``` ### X.509 Certificate > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. The following example shows validation of an X.509 certificate issuer by pattern: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Validation Example ```XML ``` ## Validate Timestamp > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to validate the `` element in your incoming SOAP requests: Request Example ```XML 2001-09-13T08:42:00Z 2001-10-13T09:00:00Z test timestamp ``` Timestamp Validation Example ```XML ``` ## Validate SAML The following examples show you how to validate both [signed](#signed-saml) or [unsigned](#unsigned-saml) SAML assertions in your incoming SOAP requests. ### Signed SAML Assertion > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of a signed SAML assertion that requires the `Subject Confirmation Method` to be `Bearer`: Request Example ```XML WssTestxX+xxxxxxxxxx=mT9648OrsRiYV/xxxx/xxxxxxxx/xxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=USxxxxxxxxxxxx+xxxxxxxxxxxxxxxxxx=o=test test ``` Signed SAML Assertion Validation Example ```XML ``` ### Unsigned SAML Assertion > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of SAML assertion of unsigned SOAP message: Request Example ```XML WssTesto=test test ``` Unsigned SAML Assertion Validation Example ```XML ``` --- product: WSS Module version: 2.0 --- # Validate Operation Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This `validate` operation validates an incoming SOAP request that contains WSS information. The WSS module validates the request against a `WssInboundConfig` configuration.
Table 1. Parameters
NameMESDefault ValueTypeDescription

request

Yes

No

n.a.

TypedValue <InputStream>

SOAP request

version

No

No

SOAP_12

SoapVersion

SOAP protocol version

The output is the same SOAP request received. The operation does not return any attributes.
Table 2. Errors
NamespaceTypeParentDescription

WSS

SECURITY_VALIDATING

n.a.

Thrown when the request is not valid or no WS-Security information is found

WSS

MISSING_CERTIFICATE

n.a.

Thrown when unable to get a certificate from either the truststore or the keystore

## Decryption > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to decrpyt a request using a keystore: Request Example ```XML CN=OLEKSIYS-W3T,OU=Sun Java System Application Server,O=Sun Microsystems,L=Santa Clara,ST=California,C=US1182300426xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= ``` Multipart Request Example ```XML ------=_Part_8049_2119795515.1555963425591 Content-Type: application/soap+xml Content-ID: main CN=OLEKSIYS-W3T,OU=Sun Java System Application Server,O=Sun Microsystems,L=Santa Clara,ST=California,C=US1182300426xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= ------=_Part_8049_2119795515.1555963425591 Content-Type: application/json Content-Disposition: related; name="file1"; filename="a.json" Content-ID: file1 { "title": "Java in Action", "author": "Mario Fusco", "year": 2014 } ------=_Part_8049_2119795515.1555963425591-- ``` Decryption Example ```XML ``` ## UsernameToken Validation > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. The following examples show you how to validate against either an [LDAP server](#ldap-validate) or a provided [username/password credentials pair](#username-password). Use LDAP authentication to validate multiple users. Credentials validation does not support validation of multiple users. ### LDAP Authentication This example shows `usernameToken` validation against an LDAP server. The username and password from the request are validated in the LDAP server. Request Example ```XML username password test username ``` Validation Example ```XML ``` ### Credentials Authentication This example shows a `usernameToken` validation against a configured pair of username and password: Request Example ```XML username username test username ``` Multipart Request Example ```XML ------=_Part_8049_2119795515.1555963425591 Content-Type: application/soap+xml Content-ID: main username username test username ------=_Part_8049_2119795515.1555963425591 Content-Type: application/json Content-Disposition: related; name="file1"; filename="a.json" Content-ID: file1 { "title": "Java in Action", "author": "Mario Fusco", "year": 2014 } ------=_Part_8049_2119795515.1555963425591-- ``` Validation Example ```XML ``` ## Validate Signature The following examples show you how to validate signatures in your incoming requests against a configured [trustore](#validate-trustore-signature), a [binary security token](#validate-binary-security-token), or a [X.509 certificate](#validate-x509-certificate). ### Trustore > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of validation of the request signature against a configured truststore to ensure that only valid messages from trusted senders are received: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxX+xxxxxxxxxxxxxxxxxxxx/xxxxxxxx xxxxxxx/xxxxxxxxxx xxxxxxxx+xxx/xxxxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Validation Example ```XML ``` ### BinarySecurityToken Signature > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of validation against the truststore of a request signed with a binary security token. Request Example ```XML xxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxx+xxxxxx/xxxxxxxxxxxxxxH/d9uuvKNSGhJPNoJtm1DhWBQmI=xxxxxxxxx+xxxx/xxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx== ? ? ? ? ? ? ? ? ? ? ``` Validation Example ```XML ``` ### X.509 Certificate > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. The following example shows validation of an X.509 certificate issuer by pattern: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Validation Example ```XML ``` ## Validate Timestamp > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to validate the `` element in your incoming SOAP requests: Request Example ```XML 2001-09-13T08:42:00Z 2001-10-13T09:00:00Z test timestamp ``` Timestamp Validation Example ```XML ``` ## Validate SAML The following examples show you how to validate both [signed](#signed-saml) or [unsigned](#unsigned-saml) SAML assertions in your incoming SOAP requests. ### Signed SAML Assertion > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of a signed SAML assertion that requires the `Subject Confirmation Method` to be `Bearer`: Request Example ```XML WssTestxX+xxxxxxxxxx=mT9648OrsRiYV/xxxx/xxxxxxxx/xxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=USxxxxxxxxxxxx+xxxxxxxxxxxxxxxxxx=o=test test ``` Signed SAML Assertion Validation Example ```XML ``` ### Unsigned SAML Assertion > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of SAML assertion of unsigned SOAP message: Request Example ```XML WssTesto=test test ``` Unsigned SAML Assertion Validation Example ```XML ``` --- product: WSS Module version: 2.1 --- # Validate Operation Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This `validate` operation validates an incoming SOAP request that contains WSS information. The WSS module validates the request against a `WssInboundConfig` configuration.
Table 1. Parameters
NameMESDefault ValueTypeDescription

request

Yes

No

n.a.

TypedValue <InputStream>

SOAP request

version

No

No

SOAP_12

SoapVersion

SOAP protocol version

The output is the same SOAP request received. The operation does not return any attributes.
Table 2. Errors
NamespaceTypeParentDescription

WSS

SECURITY_VALIDATING

n.a.

Thrown when the request isn’t valid or no WS-Security information is found

WSS

MISSING_CERTIFICATE

n.a.

Thrown when unable to get a certificate from either the truststore or the keystore

## Decryption > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to decrypt a request using a keystore: Request Example ```XML CN=OLEKSIYS-W3T,OU=Sun Java System Application Server,O=Sun Microsystems,L=Santa Clara,ST=California,C=US1182300426xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= ``` Multipart Request Example ```XML ------=_Part_8049_2119795515.1555963425591 Content-Type: application/soap+xml Content-ID: main CN=OLEKSIYS-W3T,OU=Sun Java System Application Server,O=Sun Microsystems,L=Santa Clara,ST=California,C=US1182300426xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= ------=_Part_8049_2119795515.1555963425591 Content-Type: application/json Content-Disposition: related; name="file1"; filename="a.json" Content-ID: file1 { "title": "Java in Action", "author": "Mario Fusco", "year": 2014 } ------=_Part_8049_2119795515.1555963425591-- ``` Decryption Example ```XML ``` ## UsernameToken Validation > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. These examples show you how to validate against either an [LDAP server](#ldap-validate) or a provided [username/password credentials pair](#username-password). Use LDAP authentication to validate multiple users. Credentials validation does not support validation of multiple users. ### LDAP Authentication This example shows `usernameToken` validation against an LDAP server. The username and password from the request are validated in the LDAP server. Request Example ```XML username password test username ``` Validation Example ```XML ``` ### Credentials Authentication This example shows a `usernameToken` validation against a configured pair of username and password: Request Example ```XML username username test username ``` Multipart Request Example ```XML ------=_Part_8049_2119795515.1555963425591 Content-Type: application/soap+xml Content-ID: main username username test username ------=_Part_8049_2119795515.1555963425591 Content-Type: application/json Content-Disposition: related; name="file1"; filename="a.json" Content-ID: file1 { "title": "Java in Action", "author": "Mario Fusco", "year": 2014 } ------=_Part_8049_2119795515.1555963425591-- ``` Validation Example ```XML ``` ## Validate Signature These examples show you how to validate signatures in your incoming requests against a configured [truststore](#validate-trustore-signature), a [binary security token](#validate-binary-security-token), or a [X.509 certificate](#validate-x509-certificate). ### Truststore > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example validates the request signature against a configured truststore to verify that only valid messages from trusted senders are received: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxX+xxxxxxxxxxxxxxxxxxxx/xxxxxxxx xxxxxxx/xxxxxxxxxx xxxxxxxx+xxx/xxxxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Validation Example ```XML ``` ### BinarySecurityToken Signature > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of validation against the truststore of a request signed with a binary security token. Request Example ```XML xxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxx+xxxxxx/xxxxxxxxxxxxxxH/d9uuvKNSGhJPNoJtm1DhWBQmI=xxxxxxxxx+xxxx/xxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx== ? ? ? ? ? ? ? ? ? ? ``` Validation Example ```XML ``` ### X.509 Certificate > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows validation of an X.509 certificate issuer by pattern: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Validation Example ```XML ``` ## Validate Timestamp > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to validate the `` element in your incoming SOAP requests: Request Example ```XML 2001-09-13T08:42:00Z 2001-10-13T09:00:00Z test timestamp ``` Timestamp Validation Example ```XML ``` ## Validate SAML These examples show you how to validate both [signed](#signed-saml) and [unsigned](#unsigned-saml) security assertions in your incoming SOAP requests. ### Signed SAML Assertion > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of a signed SAML assertion that requires the `Subject Confirmation Method` to be `Bearer`: Request Example ```XML WssTestxX+xxxxxxxxxx=mT9648OrsRiYV/xxxx/xxxxxxxx/xxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=USxxxxxxxxxxxx+xxxxxxxxxxxxxxxxxx=o=test test ``` Signed SAML Assertion Validation Example ```XML ``` ### Unsigned SAML Assertion > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of SAML assertion of unsigned SOAP message: Request Example ```XML WssTesto=test test ``` Unsigned SAML Assertion Validation Example ```XML ``` --- product: WSS Module version: 2.2 is-latest-version: true --- # Validate Operation Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt This `validate` operation validates an incoming SOAP request that contains WSS information. The WSS module validates the request against a `WssInboundConfig` configuration.
Table 1. Parameters
NameMESDefault ValueTypeDescription

request

Yes

No

n.a.

TypedValue <InputStream>

SOAP request

version

No

No

SOAP_12

SoapVersion

SOAP protocol version

The output is the same SOAP request received. The operation does not return any attributes.
Table 2. Errors
NamespaceTypeParentDescription

WSS

SECURITY_VALIDATING

n.a.

Thrown when the request isn’t valid or no WS-Security information is found

WSS

MISSING_CERTIFICATE

n.a.

Thrown when unable to get a certificate from either the truststore or the keystore

## Decryption > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to decrypt a request using a keystore: Request Example ```XML CN=OLEKSIYS-W3T,OU=Sun Java System Application Server,O=Sun Microsystems,L=Santa Clara,ST=California,C=US1182300426xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= ``` Multipart Request Example ```XML ------=_Part_8049_2119795515.1555963425591 Content-Type: application/soap+xml Content-ID: main CN=OLEKSIYS-W3T,OU=Sun Java System Application Server,O=Sun Microsystems,L=Santa Clara,ST=California,C=US1182300426xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= ------=_Part_8049_2119795515.1555963425591 Content-Type: application/json Content-Disposition: related; name="file1"; filename="a.json" Content-ID: file1 { "title": "Java in Action", "author": "Mario Fusco", "year": 2014 } ------=_Part_8049_2119795515.1555963425591-- ``` Decryption Example ```XML ``` ## UsernameToken Validation > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. These examples show you how to validate against either an [LDAP server](#ldap-validate) or a provided [username/password credentials pair](#username-password). Use LDAP authentication to validate multiple users. Credentials validation does not support validation of multiple users. ### LDAP Authentication This example shows `usernameToken` validation against an LDAP server. The username and password from the request are validated in the LDAP server. Request Example ```XML username password test username ``` Validation Example ```XML ``` ### Credentials Authentication This example shows a `usernameToken` validation against a configured pair of username and password: Request Example ```XML username username test username ``` Multipart Request Example ```XML ------=_Part_8049_2119795515.1555963425591 Content-Type: application/soap+xml Content-ID: main username username test username ------=_Part_8049_2119795515.1555963425591 Content-Type: application/json Content-Disposition: related; name="file1"; filename="a.json" Content-ID: file1 { "title": "Java in Action", "author": "Mario Fusco", "year": 2014 } ------=_Part_8049_2119795515.1555963425591-- ``` Validation Example ```XML ``` ## Validate Signature These examples show you how to validate signatures in your incoming requests against a configured [truststore](#validate-trustore-signature), a [binary security token](#validate-binary-security-token), or a [X.509 certificate](#validate-x509-certificate). ### Truststore > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example validates the request signature against a configured truststore to verify that only valid messages from trusted senders are received: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxxxx+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxX+xxxxxxxxxxxxxxxxxxxx/xxxxxxxx xxxxxxx/xxxxxxxxxx xxxxxxxx+xxx/xxxxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Validation Example ```XML ``` ### BinarySecurityToken Signature > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of validation against the truststore of a request signed with a binary security token. Request Example ```XML xxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxx+xxxxxx/xxxxxxxxxxxxxxH/d9uuvKNSGhJPNoJtm1DhWBQmI=xxxxxxxxx+xxxx/xxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx== ? ? ? ? ? ? ? ? ? ? ``` Validation Example ```XML ``` ### X.509 Certificate > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows validation of an X.509 certificate issuer by pattern: Request Example ```XML yLFLEkH4/MjYbZ4viZxjou9/4os=xxxxxxxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=US1545521240 test ``` Validation Example ```XML ``` ## Validate Timestamp > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. This example shows you how to validate the `` element in your incoming SOAP requests: Request Example ```XML 2001-09-13T08:42:00Z 2001-10-13T09:00:00Z test timestamp ``` Timestamp Validation Example ```XML ``` ## Validate SAML These examples show you how to validate both [signed](#signed-saml) and [unsigned](#unsigned-saml) security assertions in your incoming SOAP requests. ### Signed SAML Assertion > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of a signed SAML assertion that requires the `Subject Confirmation Method` to be `Bearer`: Request Example ```XML WssTestxX+xxxxxxxxxx=mT9648OrsRiYV/xxxx/xxxxxxxx/xxxxxx==CN=Unknown,OU=Unknown,O=Unknown,L=Unknown,ST=Unknown,C=USxxxxxxxxxxxx+xxxxxxxxxxxxxxxxxx=o=test test ``` Signed SAML Assertion Validation Example ```XML ``` ### Unsigned SAML Assertion > [!NOTE] Do not apply transformations to your message’s payload when performing cryptographic > operations. Transform operations don’t exclude cryptographic signatures. Example of SAML assertion of unsigned SOAP message: Request Example ```XML WssTesto=test test ``` Unsigned SAML Assertion Validation Example ```XML ``` --- product: WSS Module version: 1.0 --- # WSS Module > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint WSS module enables you to process and validate an inbound SOAP request against a given Web Service Security (WSS) extension configuration to, for example, validate the request’s signature, perform an LDAP authentication, or decrypt the inbound message. The WSS module also enables you to sign your response by adding a WSS header to it, or to encrypt your outbound message. For information about compatibility and fixed issues, see WSS Module Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The WSS module’s API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Studio Before creating an app, you must have access to: - The WSS module target resource - Anypoint Platform - Anypoint Studio or Anypoint Code Builder - Web Services Security (WSS) extension for SOAP ## Common Use Cases For the Connector The WSS module enables you to validate WSS headers in inbound SOAP requests to your application to: - Decrypt a SOAP envelope according to the encryption information - Validate a signature - Verify the freshness of the message using `timestamp` information - Verify the `Username` and `Password` credentials of `UsernameToken` - Verify the `LDAP` credentials of `UsernameToken` - Determine whether `UsernameToken` is expired - Determine whether a SAML assertion expired - Verify the signature of a SAML assertion. - Verify that a SAML assertion has a specific confirmation method. Using the WSS module, you can also add WSS headers to your outbound SOAP response to: - Encrypt some or all of your SOAP message content - Sign your SOAP message See the [WSS Module Examples](https://docs.mulesoft.com/wss-module/1.0/wss-examples) section for detailed examples. ## Audience - New user To create your Mule app, see: - [Studio Configuration](https://docs.mulesoft.com/wss-module/1.0/wss-studio) to help extend your understanding of WSS module. - [Examples](https://docs.mulesoft.com/wss-module/1.0/wss-examples), with use case information for the connector - Advanced user Read the following: - [XML and Maven Support](https://docs.mulesoft.com/wss-module/1.0/wss-xml-maven) - [Examples](https://docs.mulesoft.com/wss-module/1.0/wss-examples), with use case information for the connector ## Next Step After you complete the prerequisites and experiment with templates and examples, you are ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/wss-module/1.0/wss-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [WSS Module on Exchange](https://www.mulesoft.com/exchange/?search=wss-module&type=connector) - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 1.1 --- # WSS Module > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint WSS module enables you to process and validate an inbound SOAP request against a given Web Service Security (WSS) extension configuration to, for example, validate the request’s signature, perform an LDAP authentication, or decrypt the inbound message. The WSS module also enables you to sign your response by adding a WSS header to it, or to encrypt your outbound message. For information about compatibility and fixed issues, see WSS Module Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The WSS module’s API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Studio Before creating an app, you must have access to: - The WSS module target resource - Anypoint Platform - Anypoint Studio or Anypoint Code Builder - Web Services Security (WSS) extension for SOAP ## Common Use Cases For the Connector The WSS module enables you to validate WSS headers in inbound SOAP requests to your application to: - Decrypt a SOAP envelope according to the encryption information - Validate a signature - Verify the freshness of the message using `timestamp` information - Verify the `Username` and `Password` credentials of `UsernameToken` - Verify the `LDAP` credentials of `UsernameToken` - Determine whether `UsernameToken` is expired - Determine whether a SAML assertion expired - Verify the signature of a SAML assertion. - Verify that a SAML assertion has a specific confirmation method. Using the WSS module, you can also add WSS headers to your outbound SOAP response to: - Encrypt some or all of your SOAP message content - Sign your SOAP message See the [WSS Module Examples](https://docs.mulesoft.com/wss-module/1.1/wss-examples) section for detailed examples. ## Audience - New user To create your Mule app, see: - [Studio Configuration](https://docs.mulesoft.com/wss-module/1.1/wss-studio) to help extend your understanding of WSS module. - [Examples](https://docs.mulesoft.com/wss-module/1.1/wss-examples), with use case information for the connector - Advanced user Read the following: - [XML and Maven Support](https://docs.mulesoft.com/wss-module/1.1/wss-xml-maven) - [Examples](https://docs.mulesoft.com/wss-module/1.1/wss-examples), with use case information for the connector ## Next Step After you complete the prerequisites and experiment with templates and examples, you are ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/wss-module/1.1/wss-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [WSS Module on Exchange](https://www.mulesoft.com/exchange/?search=wss-module&type=connector) - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 1.0 --- # WSS Module - Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The following WSS module examples show you how to validate a Web Service Security (WSS) configuration in your incoming SOAP requests: - [Validate Operation Examples](https://docs.mulesoft.com/wss-module/1.0/validate-wss-examples) - [Decrypt Message Example](https://docs.mulesoft.com/wss-module/1.0/validate-wss-examples#decrypt) - [Validate UsernameToken Examples](https://docs.mulesoft.com/wss-module/1.0/validate-wss-examples#usernameToken) - [LDAP Authentication](https://docs.mulesoft.com/wss-module/1.0/validate-wss-examples#ldap-validate) - [Credentials Authentication](https://docs.mulesoft.com/wss-module/1.0/validate-wss-examples#username-password) - [Validate Signature Examples](https://docs.mulesoft.com/wss-module/1.0/validate-wss-examples#signature) - [Trustore](https://docs.mulesoft.com/wss-module/1.0/validate-wss-examples#validate-trustore-signature) - [Binary Security Token](https://docs.mulesoft.com/wss-module/1.0/validate-wss-examples#validate-binary-security-token) - [X.509 Certificate](https://docs.mulesoft.com/wss-module/1.0/validate-wss-examples#validate-x509-certificate) - [Validate Timestamp Example](https://docs.mulesoft.com/wss-module/1.0/validate-wss-examples#timestamp) - [Validate SAML Examples](https://docs.mulesoft.com/wss-module/1.0/validate-wss-examples#saml) - [Signed SAML](https://docs.mulesoft.com/wss-module/1.0/validate-wss-examples#signed-saml) - [Unsigned SAML](https://docs.mulesoft.com/wss-module/1.0/validate-wss-examples#unsigned-saml) The following WSS module examples show you how to apply a Web Service Security (WSS) configuration to your outgoing SOAP responses: - [Apply Operation Examples](https://docs.mulesoft.com/wss-module/1.0/apply-wss-examples) - [Encrypt Example](https://docs.mulesoft.com/wss-module/1.0/apply-wss-examples#encrypt) - [Sign Example](https://docs.mulesoft.com/wss-module/1.0/apply-wss-examples#signature) - [Encrypt and Sign Example](https://docs.mulesoft.com/wss-module/1.0/apply-wss-examples#encryption-signing-certificate) ## See Also - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 1.1 --- # WSS Module - Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The following WSS module examples show you how to validate a Web Service Security (WSS) configuration in your incoming SOAP requests: - [Validate Operation Examples](https://docs.mulesoft.com/wss-module/1.1/validate-wss-examples) - [Decrypt Message Example](https://docs.mulesoft.com/wss-module/1.1/validate-wss-examples#decrypt) - [Validate UsernameToken Examples](https://docs.mulesoft.com/wss-module/1.1/validate-wss-examples#usernameToken) - [LDAP Authentication](https://docs.mulesoft.com/wss-module/1.1/validate-wss-examples#ldap-validate) - [Credentials Authentication](https://docs.mulesoft.com/wss-module/1.1/validate-wss-examples#username-password) - [Validate Signature Examples](https://docs.mulesoft.com/wss-module/1.1/validate-wss-examples#signature) - [Trustore](https://docs.mulesoft.com/wss-module/1.1/validate-wss-examples#validate-trustore-signature) - [Binary Security Token](https://docs.mulesoft.com/wss-module/1.1/validate-wss-examples#validate-binary-security-token) - [X.509 Certificate](https://docs.mulesoft.com/wss-module/1.1/validate-wss-examples#validate-x509-certificate) - [Validate Timestamp Example](https://docs.mulesoft.com/wss-module/1.1/validate-wss-examples#timestamp) - [Validate SAML Examples](https://docs.mulesoft.com/wss-module/1.1/validate-wss-examples#saml) - [Signed SAML](https://docs.mulesoft.com/wss-module/1.1/validate-wss-examples#signed-saml) - [Unsigned SAML](https://docs.mulesoft.com/wss-module/1.1/validate-wss-examples#unsigned-saml) The following WSS module examples show you how to apply a Web Service Security (WSS) configuration to your outgoing SOAP responses: - [Apply Operation Examples](https://docs.mulesoft.com/wss-module/1.1/apply-wss-examples) - [Encrypt Example](https://docs.mulesoft.com/wss-module/1.1/apply-wss-examples#encrypt) - [Sign Example](https://docs.mulesoft.com/wss-module/1.1/apply-wss-examples#signature) - [Encrypt and Sign Example](https://docs.mulesoft.com/wss-module/1.1/apply-wss-examples#encryption-signing-certificate) ## See Also - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 1.2 --- # WSS Module - Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The following WSS module examples show you how to validate a Web Service Security (WSS) configuration in your incoming SOAP requests: - [Validate Operation Examples](https://docs.mulesoft.com/wss-module/1.2/validate-wss-examples) - [Decrypt Message Example](https://docs.mulesoft.com/wss-module/1.2/validate-wss-examples#decrypt) - [Validate UsernameToken Examples](https://docs.mulesoft.com/wss-module/1.2/validate-wss-examples#usernameToken) - [LDAP Authentication](https://docs.mulesoft.com/wss-module/1.2/validate-wss-examples#ldap-validate) - [Credentials Authentication](https://docs.mulesoft.com/wss-module/1.2/validate-wss-examples#username-password) - [Validate Signature Examples](https://docs.mulesoft.com/wss-module/1.2/validate-wss-examples#signature) - [Trustore](https://docs.mulesoft.com/wss-module/1.2/validate-wss-examples#validate-trustore-signature) - [Binary Security Token](https://docs.mulesoft.com/wss-module/1.2/validate-wss-examples#validate-binary-security-token) - [X.509 Certificate](https://docs.mulesoft.com/wss-module/1.2/validate-wss-examples#validate-x509-certificate) - [Validate Timestamp Example](https://docs.mulesoft.com/wss-module/1.2/validate-wss-examples#timestamp) - [Validate SAML Examples](https://docs.mulesoft.com/wss-module/1.2/validate-wss-examples#saml) - [Signed SAML](https://docs.mulesoft.com/wss-module/1.2/validate-wss-examples#signed-saml) - [Unsigned SAML](https://docs.mulesoft.com/wss-module/1.2/validate-wss-examples#unsigned-saml) The following WSS module examples show you how to apply a Web Service Security (WSS) configuration to your outgoing SOAP responses: - [Apply Operation Examples](https://docs.mulesoft.com/wss-module/1.2/apply-wss-examples) - [Encrypt Example](https://docs.mulesoft.com/wss-module/1.2/apply-wss-examples#encrypt) - [Sign Example](https://docs.mulesoft.com/wss-module/1.2/apply-wss-examples#signature) - [Encrypt and Sign Example](https://docs.mulesoft.com/wss-module/1.2/apply-wss-examples#encryption-signing-certificate) ## See Also - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 2.0 --- # WSS Module - Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The following WSS module examples show you how to validate a Web Service Security (WSS) configuration in your incoming SOAP requests: - [Validate Operation Examples](https://docs.mulesoft.com/wss-module/2.0/validate-wss-examples) - [Decrypt Message Example](https://docs.mulesoft.com/wss-module/2.0/validate-wss-examples#decrypt) - [Validate UsernameToken Examples](https://docs.mulesoft.com/wss-module/2.0/validate-wss-examples#usernameToken) - [LDAP Authentication](https://docs.mulesoft.com/wss-module/2.0/validate-wss-examples#ldap-validate) - [Credentials Authentication](https://docs.mulesoft.com/wss-module/2.0/validate-wss-examples#username-password) - [Validate Signature Examples](https://docs.mulesoft.com/wss-module/2.0/validate-wss-examples#signature) - [Trustore](https://docs.mulesoft.com/wss-module/2.0/validate-wss-examples#validate-trustore-signature) - [Binary Security Token](https://docs.mulesoft.com/wss-module/2.0/validate-wss-examples#validate-binary-security-token) - [X.509 Certificate](https://docs.mulesoft.com/wss-module/2.0/validate-wss-examples#validate-x509-certificate) - [Validate Timestamp Example](https://docs.mulesoft.com/wss-module/2.0/validate-wss-examples#timestamp) - [Validate SAML Examples](https://docs.mulesoft.com/wss-module/2.0/validate-wss-examples#saml) - [Signed SAML](https://docs.mulesoft.com/wss-module/2.0/validate-wss-examples#signed-saml) - [Unsigned SAML](https://docs.mulesoft.com/wss-module/2.0/validate-wss-examples#unsigned-saml) The following WSS module examples show you how to apply a Web Service Security (WSS) configuration to your outgoing SOAP responses: - [Apply Operation Examples](https://docs.mulesoft.com/wss-module/2.0/apply-wss-examples) - [Encrypt Example](https://docs.mulesoft.com/wss-module/2.0/apply-wss-examples#encrypt) - [Sign Example](https://docs.mulesoft.com/wss-module/2.0/apply-wss-examples#signature) - [Encrypt and Sign Example](https://docs.mulesoft.com/wss-module/2.0/apply-wss-examples#encryption-signing-certificate) ## See Also - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 2.1 --- # WSS Module - Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The following WSS module examples show you how to validate a Web Service Security (WSS) configuration in your incoming SOAP requests: - [Validate Operation Examples](https://docs.mulesoft.com/wss-module/2.1/validate-wss-examples) - [Decrypt Message Example](https://docs.mulesoft.com/wss-module/2.1/validate-wss-examples#decrypt) - [Validate UsernameToken Examples](https://docs.mulesoft.com/wss-module/2.1/validate-wss-examples#usernameToken) - [LDAP Authentication](https://docs.mulesoft.com/wss-module/2.1/validate-wss-examples#ldap-validate) - [Credentials Authentication](https://docs.mulesoft.com/wss-module/2.1/validate-wss-examples#username-password) - [Validate Signature Examples](https://docs.mulesoft.com/wss-module/2.1/validate-wss-examples#signature) - [Trustore](https://docs.mulesoft.com/wss-module/2.1/validate-wss-examples#validate-trustore-signature) - [Binary Security Token](https://docs.mulesoft.com/wss-module/2.1/validate-wss-examples#validate-binary-security-token) - [X.509 Certificate](https://docs.mulesoft.com/wss-module/2.1/validate-wss-examples#validate-x509-certificate) - [Validate Timestamp Example](https://docs.mulesoft.com/wss-module/2.1/validate-wss-examples#timestamp) - [Validate SAML Examples](https://docs.mulesoft.com/wss-module/2.1/validate-wss-examples#saml) - [Signed SAML](https://docs.mulesoft.com/wss-module/2.1/validate-wss-examples#signed-saml) - [Unsigned SAML](https://docs.mulesoft.com/wss-module/2.1/validate-wss-examples#unsigned-saml) The following WSS module examples show you how to apply a Web Service Security (WSS) configuration to your outgoing SOAP responses: - [Apply Operation Examples](https://docs.mulesoft.com/wss-module/2.1/apply-wss-examples) - [Encrypt Example](https://docs.mulesoft.com/wss-module/2.1/apply-wss-examples#encrypt) - [Sign Example](https://docs.mulesoft.com/wss-module/2.1/apply-wss-examples#signature) - [Encrypt and Sign Example](https://docs.mulesoft.com/wss-module/2.1/apply-wss-examples#encryption-signing-certificate) ## See Also - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 2.2 is-latest-version: true --- # WSS Module - Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The following WSS module examples show you how to validate a Web Service Security (WSS) configuration in your incoming SOAP requests: - [Validate Operation Examples](https://docs.mulesoft.com/wss-module/latest/validate-wss-examples) - [Decrypt Message Example](https://docs.mulesoft.com/wss-module/latest/validate-wss-examples#decrypt) - [Validate UsernameToken Examples](https://docs.mulesoft.com/wss-module/latest/validate-wss-examples#usernameToken) - [LDAP Authentication](https://docs.mulesoft.com/wss-module/latest/validate-wss-examples#ldap-validate) - [Credentials Authentication](https://docs.mulesoft.com/wss-module/latest/validate-wss-examples#username-password) - [Validate Signature Examples](https://docs.mulesoft.com/wss-module/latest/validate-wss-examples#signature) - [Trustore](https://docs.mulesoft.com/wss-module/latest/validate-wss-examples#validate-trustore-signature) - [Binary Security Token](https://docs.mulesoft.com/wss-module/latest/validate-wss-examples#validate-binary-security-token) - [X.509 Certificate](https://docs.mulesoft.com/wss-module/latest/validate-wss-examples#validate-x509-certificate) - [Validate Timestamp Example](https://docs.mulesoft.com/wss-module/latest/validate-wss-examples#timestamp) - [Validate SAML Examples](https://docs.mulesoft.com/wss-module/latest/validate-wss-examples#saml) - [Signed SAML](https://docs.mulesoft.com/wss-module/latest/validate-wss-examples#signed-saml) - [Unsigned SAML](https://docs.mulesoft.com/wss-module/latest/validate-wss-examples#unsigned-saml) The following WSS module examples show you how to apply a Web Service Security (WSS) configuration to your outgoing SOAP responses: - [Apply Operation Examples](https://docs.mulesoft.com/wss-module/latest/apply-wss-examples) - [Encrypt Example](https://docs.mulesoft.com/wss-module/latest/apply-wss-examples#encrypt) - [Sign Example](https://docs.mulesoft.com/wss-module/latest/apply-wss-examples#signature) - [Encrypt and Sign Example](https://docs.mulesoft.com/wss-module/latest/apply-wss-examples#encryption-signing-certificate) ## See Also - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 1.2 --- # WSS Module 1.2 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint WSS module enables you to process and validate an inbound SOAP request against a given Web Service Security (WSS) extension configuration to, for example, validate the request’s signature, perform an LDAP authentication, or decrypt the inbound message. The WSS module also enables you to sign your response by adding a WSS header to it, or to encrypt your outbound message. For information about compatibility and fixed issues, see WSS Module Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The WSS module’s API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Studio Before creating an app, you must have access to: - The WSS module target resource - Anypoint Platform - Anypoint Studio or Anypoint Code Builder - Web Services Security (WSS) extension for SOAP ## Common Use Cases For the Connector The WSS module enables you to validate WSS headers in inbound SOAP requests to your application to: - Decrypt a SOAP envelope according to the encryption information - Validate a signature - Verify the freshness of the message using `timestamp` information - Verify the `Username` and `Password` credentials of `UsernameToken` - Verify the `LDAP` credentials of `UsernameToken` - Determine whether `UsernameToken` is expired - Determine whether a SAML assertion expired - Verify the signature of a SAML assertion. - Verify that a SAML assertion has a specific confirmation method. Using the WSS module, you can also add WSS headers to your outbound SOAP response to: - Encrypt some or all of your SOAP message content - Sign your SOAP message See the [WSS Module Examples](https://docs.mulesoft.com/wss-module/1.2/wss-examples) section for detailed examples. ## Audience - New user To create your Mule app, see: - [Studio Configuration](https://docs.mulesoft.com/wss-module/1.2/wss-studio) to help extend your understanding of WSS module. - [Examples](https://docs.mulesoft.com/wss-module/1.2/wss-examples), with use case information for the connector - Advanced user Read the following: - [XML and Maven Support](https://docs.mulesoft.com/wss-module/1.2/wss-xml-maven) - [Examples](https://docs.mulesoft.com/wss-module/1.2/wss-examples), with use case information for the connector ## Next Step After you complete the prerequisites and experiment with templates and examples, you are ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/wss-module/1.2/wss-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [WSS Module on Exchange](https://www.mulesoft.com/exchange/?search=wss-module&type=connector) - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 1.2 --- # WSS Module 1.2 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt WSS Module enables you to process and validate an inbound SOAP request against a given Web Service Security (WSS) extension configuration. ## Configurations --- ### Inbound #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Actor

String

 

Extract Security Header

Boolean

false

 

Validate Username Token

 

Validate Signature

 

Decrypt Message

 

Validate Timestamp

 

Validate SAML Assertion

 

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

#### Associated Operations - [Validate WSS](#validateWss)   --- ### Outbound #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Signature Configuration

 

Encryption Configuration

 

Timestamp Configuration

 

'Must Understand' Attribute

Boolean

false

 

#### Associated Operations - [Apply WSS](#applyWss)   ## Operations ### Validate WSS `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Request

Binary

#[payload]

 

Version

Enumeration, one of:

  • SOAP_11

  • SOAP_12

SOAP_12

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

#### Output

Type

Binary

#### For Configurations. - [Inbound](#inbound)   #### Throws - WSS:MISSING\_CERTIFICATE   - WSS:SECURITY\_APPLYING   - WSS:SECURITY\_VALIDATING   ### Apply WSS `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Response

Binary

#[payload]

 

Version

Enumeration, one of:

  • SOAP_11

  • SOAP_12

SOAP_12

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

#### Output

Type

Binary

#### For Configurations. - [Outbound](#outbound)   #### Throws - WSS:MISSING\_CERTIFICATE   - WSS:SECURITY\_APPLYING   - WSS:SECURITY\_VALIDATING   ## Types ### Verify Username Token Config
FieldTypeDescriptionDefault ValueRequired

Authenticate User Config

Specific type for the authentication configuration. See AuthenticateUserConfig sub-types.

x

Time To Live

Number

The time difference between creation and expiry time in seconds in the UsernameToken Created element.

30

Check Nonce

Boolean

Whether to check the Nonce Element in the UsernameToken. A Nonce is a random value that the sender creates to include in each UsernameToken that it sends. Only checked if included.

true

### Verify Signature Config
FieldTypeDescriptionDefault ValueRequired

Truststore Config

TrustStore configuration used for validating the signature.

x

Issuer Pattern

String

Certificate Issuer pattern.

Subject Pattern

String

Certificate Subject pattern.

### Trust Store Configuration
FieldTypeDescriptionDefault ValueRequired

Path

String

x

Password

String

x

Type

String

jks

### Decryption Config
FieldTypeDescriptionDefault ValueRequired

Keystore Config

KeyStore configuration used for decryption.

x

### Key Store Configuration
FieldTypeDescriptionDefault ValueRequired

Path

String

x

Password

String

x

Alias

String

Key Password

String

Type

String

jks

### Verify Timestamp Config
FieldTypeDescriptionDefault ValueRequired

Time To Live

Number

The time within which the Timestamp element is valid. The default is 5 minutes.

300

Skew Time

Number

The time difference between server and client. The default is 60 seconds.

60

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive configuration.

SECONDS

Strict

Boolean

If set to true then validates if the timestamp contains an expires element and the semantics are expired.

true

Require Expires Header

Boolean

Whether timestamp Expires header is required.

true

Precision In Milliseconds

Boolean

If set to true then use timestamps with milliseconds, otherwise omit the milliseconds.

true

### Verify Saml Config
FieldTypeDescriptionDefault ValueRequired

Saml Version

Enumeration, one of:

  • SAML10

  • SAML11

  • SAML20

SAML Version.

SAML10

Time To Live

Number

The time in seconds within which a SAML Assertion is valid, if it does not contain a NotOnOrAfter Condition. The default is 30 minutes.

1800

Skew Time

Number

The time difference between server and client. The default is 60 seconds.

60

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive and skewTime configuration.

SECONDS

Require Standard Subject Confirmation Method

Boolean

If set, at least one of the standard Subject Confirmation Methods in SamlConfirmationMethod must be present in the assertion (Bearer / SenderVouches / HolderOfKey).

false

Require Bearer Signature

Boolean

If set, an Assertion with a Bearer Subject Confirmation Method must be signed.

false

Validate Signature Against Profile

Boolean

Whether to validate the signature of the Assertion (if it exists) against the relevant profile. Default is true.

false

Required Subject Confirmation Method

Enumeration, one of:

  • BEARER

  • HOLDER_OF_KEY

  • SENDER_VOUCHES

If set, the value must appear as one of the Subject Confirmation Methods SamlConfirmationMethod.

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

### Repeatable In Memory Stream
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

### Repeatable File Store Stream
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

### Signature Config
FieldTypeDescriptionDefault ValueRequired

Key Identifier

Enumeration, one of:

  • ISSUER_SERIAL

  • DIRECT_REFERENCE

  • X509_KEY_IDENTIFIER

  • THUMBPRINT

  • SKI_KEY_IDENTIFIER

  • KEY_VALUE

The key identifier type to use for signature. See SignatureKeyIdentifierConstants

ISSUER_SERIAL

Algorithm

Enumeration, one of:

  • RSAwithSHA256

  • ECDSAwithSHA256

  • DSAwithSHA1

  • RSAwithSHA1

  • RSAwithSHA224

  • RSAwithSHA384

  • RSAwithSHA512

  • ECDSAwithSHA1

  • ECDSAwithSHA224

  • ECDSAwithSHA384

  • ECDSAwithSHA512

  • DSAwithSHA256

The signature algorithm to use. The default is set by the data in the certificate. See SignatureAlgorithmConstants

Digest Algorithm

Enumeration, one of:

  • SHA1

  • SHA256

  • SHA224

  • SHA384

  • SHA512

The signature digest algorithm to use. See SignatureDigestAlgorithmConstants

SHA1

C14n Algorithm

Enumeration, one of:

  • CanonicalXML_1_0

  • CanonicalXML_1_1

  • ExclusiveXMLCanonicalization_1_0

Defines which signature c14n (canonicalization) algorithm to use. See SignatureC14nAlgorithmConstants

ExclusiveXMLCanonicalization_1_0

Keystore Config

KeyStore configuration used for signing.

x

Wss Parts

Array of Wss Part

Lists of parts to be encrypted. If any part is specified, the SOAP Body will be encrypted.

### Wss Part
FieldTypeDescriptionDefault ValueRequired

Encode

Enumeration, one of:

  • ELEMENT

  • CONTENT

CONTENT

Namespace

String

x

Localname

String

x

### Encryption Config
FieldTypeDescriptionDefault ValueRequired

Encryption Key Identifier

Enumeration, one of:

  • ISSUER_SERIAL

  • DIRECT_REFERENCE

  • X509_KEY_IDENTIFIER

  • THUMBPRINT

  • SKI_KEY_IDENTIFIER

  • ENCRYPTED_KEY_SHA1

  • EMBEDDED_KEY_NAME

The key identifier type to use for encryption.

ISSUER_SERIAL

Encryption Sym Algorithm

Enumeration, one of:

  • TRIPLE_DES

  • AES_128

  • AES_256

  • AES_192

  • AES_128_GCM

  • AES_192_GCM

  • AES_256_GCM

The symmetric encryption algorithm to use.

AES_128

Encryption Key Transport Algorithm

Enumeration, one of:

  • KEYTRANSPORT_RSA15

  • KEYTRANSPORT_RSAOAEP

  • KEYTRANSPORT_RSAOAEP_XENC11

The algorithm used to encrypt the generated symmetric key.

KEYTRANSPORT_RSAOAEP

Encryption Digest Algorithm

Enumeration, one of:

  • SHA1

  • SHA256

  • SHA384

  • SHA512

The encryption digest algorithm to use with the key transport algorithm.

SHA1

Keystore Config

KeyStore configuration used for encryption.

Wss Parts

Array of Wss Part

Lists of parts to be encrypted. If any part is specified, the SOAP Body will be encrypted.

### Timestamp Config
FieldTypeDescriptionDefault ValueRequired

Time To Live

Number

The time within which the Timestamp element is valid. The default is 5 minutes.

300

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive configuration.

SECONDS

Precision In Milliseconds

Boolean

If set to true then use timestamps with milliseconds, otherwise omit the milliseconds.

true

### Credentials Config
FieldTypeDescriptionDefault ValueRequired

Username

String

Username.

x

Password

String

Password.

x

### LDAP Config
FieldTypeDescriptionDefault ValueRequired

Provider Url

String

LDAP Server URL.

x

User Dn

String

User that will authenticate to the directory.

x

Password

String

Credentials to use for getting authenticated contexts.

x

Search Base

String

The search base defines the starting point for the search in the directory tree.

x

Search Filter

String

Filters can be used to restrict the numbers of users or groups that are permitted to access an application.

x

Search In Subtree

Boolean

Whether to search in subtree.

false

--- product: WSS Module version: 2.0 --- # WSS Module 2.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt WSS Module enables you to process and validate an inbound SOAP request against a given Web Service Security (WSS) extension configuration to, for example, validate the request’s signature, perform an LDAP authentication, or decrypt the inbound message. WSS module also enables you to sign your response by adding a WSS header to it, or to encrypt your outbound message. For information about compatibility and fixed issues, see the WSS Module Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The WSS Module API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Studio Before creating an app, you must have access to: - The WSS Module target resource - Anypoint Platform - Anypoint Studio or Anypoint Code Builder - Web Services Security (WSS) extension for SOAP ## Common Use Cases For the Connector WSS Module enables you to validate WSS headers in inbound SOAP requests to your application to: - Decrypt a SOAP envelope according to the encryption information - Validate a signature - Verify the freshness of the message using `timestamp` information - Verify the `Username` and `Password` credentials of `UsernameToken` - Verify the `LDAP` credentials of `UsernameToken` - Determine whether `UsernameToken` is expired - Determine whether a SAML assertion expired - Verify the signature of a SAML assertion. - Verify that a SAML assertion has a specific confirmation method. Using WSS Module, you can also add WSS headers to your outbound SOAP response to: - Encrypt some or all of your SOAP message content - Sign your SOAP message See the [WSS Module Examples](https://docs.mulesoft.com/wss-module/2.0/wss-examples) section for detailed examples. ## Audience - New user To create your Mule app, see: - [Studio Configuration](https://docs.mulesoft.com/wss-module/2.0/wss-studio) to help extend your understanding of WSS module. - [Examples](https://docs.mulesoft.com/wss-module/2.0/wss-examples), with use case information for the connector - Advanced user Read the following: - [XML and Maven Support](https://docs.mulesoft.com/wss-module/2.0/wss-xml-maven) - [Examples](https://docs.mulesoft.com/wss-module/2.0/wss-examples), with use case information for the connector ## Next Step After you complete the prerequisites and experiment with templates and examples, you are ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/wss-module/2.0/wss-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [WSS Module on Exchange](https://www.mulesoft.com/exchange/?search=wss-module&type=connector) - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 2.0 --- # WSS Module 2.0 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt WSS Module enables you to process and validate an inbound SOAP request against a given Web Service Security (WSS) extension configuration. ## Configurations --- ### Inbound #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Actor

String

 

Extract Security Header

Boolean

false

 

Validate Username Token

 

Validate Signature

 

Decrypt Message

 

Validate Timestamp

 

Validate SAML Assertion

 

Name

String

The identifier of this element used to reference it in other components.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

#### Associated Operations - [Validate WSS](#validateWss)   --- ### Outbound #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Signature Configuration

 

Encryption Configuration

 

Timestamp Configuration

 

'Must Understand' Attribute

Boolean

false

 

Name

String

The identifier of this element used to reference it in other components.

x

#### Associated Operations - [Apply WSS](#applyWss)   ## Operations ### Validate WSS `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Request

Binary

#[payload]

 

Version

Enumeration, one of:

  • SOAP_11

  • SOAP_12

SOAP_12

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Config Ref

ConfigurationProvider

The name of the configuration used to execute this component.

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Error Mappings

Array of Error Mapping

Set of error mappings.

#### Output

Type

Binary

#### For Configurations. - [Inbound](#inbound)   #### Throws - WSS:MISSING\_CERTIFICATE   - WSS:SECURITY\_APPLYING   - WSS:SECURITY\_VALIDATING   ### Apply WSS `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Response

Binary

#[payload]

 

Version

Enumeration, one of:

  • SOAP_11

  • SOAP_12

SOAP_12

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Config Ref

ConfigurationProvider

The name of the configuration used to execute this component.

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Error Mappings

Array of Error Mapping

Set of error mappings.

#### Output

Type

Binary

#### For Configurations. - [Outbound](#outbound)   #### Throws - WSS:MISSING\_CERTIFICATE   - WSS:SECURITY\_APPLYING   - WSS:SECURITY\_VALIDATING   ## Types ### Verify Username Token Config
FieldTypeDescriptionDefault ValueRequired

Authenticate User Config

Specific type for the authentication configuration. See AuthenticateUserConfig sub-types.

x

Time To Live

Number

The time difference between creation and expiry time in seconds in the UsernameToken Created element.

30

Check Nonce

Boolean

Whether to check the Nonce Element in the UsernameToken. A Nonce is a random value that the sender creates to include in each UsernameToken that it sends. Only checked if included.

true

### Verify Signature Config
FieldTypeDescriptionDefault ValueRequired

Truststore Config

TrustStore configuration used for validating the signature.

x

Issuer Pattern

String

Certificate Issuer pattern.

Subject Pattern

String

Certificate Subject pattern.

### Trust Store Configuration
FieldTypeDescriptionDefault ValueRequired

Path

String

x

Password

String

x

Type

String

jks

### Decryption Config
FieldTypeDescriptionDefault ValueRequired

Keystore Config

KeyStore configuration used for decryption.

x

### Key Store Configuration
FieldTypeDescriptionDefault ValueRequired

Path

String

x

Password

String

x

Alias

String

Key Password

String

Type

String

jks

### Verify Timestamp Config
FieldTypeDescriptionDefault ValueRequired

Time To Live

Number

The time within which the Timestamp element is valid. The default is 5 minutes.

300

Skew Time

Number

The time difference between server and client. The default is 60 seconds.

60

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive configuration.

SECONDS

Strict

Boolean

If set to true then validates if the timestamp contains an expires element and the semantics are expired.

true

Require Expires Header

Boolean

Whether timestamp Expires header is required.

true

Precision In Milliseconds

Boolean

If set to true then use timestamps with milliseconds, otherwise omit the milliseconds.

true

### Verify Saml Config
FieldTypeDescriptionDefault ValueRequired

Saml Version

Enumeration, one of:

  • SAML10

  • SAML11

  • SAML20

SAML Version.

SAML10

Time To Live

Number

The time in seconds within which a SAML Assertion is valid, if it does not contain a NotOnOrAfter Condition. The default is 30 minutes.

1800

Skew Time

Number

The time difference between server and client. The default is 60 seconds.

60

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive and skewTime configuration.

SECONDS

Require Standard Subject Confirmation Method

Boolean

If set, at least one of the standard Subject Confirmation Methods in SamlConfirmationMethod must be present in the assertion (Bearer / SenderVouches / HolderOfKey).

false

Require Bearer Signature

Boolean

If set, an Assertion with a Bearer Subject Confirmation Method must be signed.

false

Validate Signature Against Profile

Boolean

Whether to validate the signature of the Assertion (if it exists) against the relevant profile. Default is true.

false

Required Subject Confirmation Method

Enumeration, one of:

  • BEARER

  • HOLDER_OF_KEY

  • SENDER_VOUCHES

If set, the value must appear as one of the Subject Confirmation Methods SamlConfirmationMethod.

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

### Repeatable In Memory Stream
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

### Repeatable File Store Stream
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

### Error Mapping
FieldTypeDescriptionDefault ValueRequired

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Target

String

x

### Signature Config
FieldTypeDescriptionDefault ValueRequired

Key Identifier

Enumeration, one of:

  • ISSUER_SERIAL

  • DIRECT_REFERENCE

  • X509_KEY_IDENTIFIER

  • THUMBPRINT

  • SKI_KEY_IDENTIFIER

  • KEY_VALUE

The key identifier type to use for signature. See SignatureKeyIdentifierConstants

ISSUER_SERIAL

Algorithm

Enumeration, one of:

  • RSAwithSHA256

  • ECDSAwithSHA256

  • DSAwithSHA1

  • RSAwithSHA1

  • RSAwithSHA224

  • RSAwithSHA384

  • RSAwithSHA512

  • ECDSAwithSHA1

  • ECDSAwithSHA224

  • ECDSAwithSHA384

  • ECDSAwithSHA512

  • DSAwithSHA256

The signature algorithm to use. The default is set by the data in the certificate. See SignatureAlgorithmConstants

Digest Algorithm

Enumeration, one of:

  • SHA1

  • SHA256

  • SHA224

  • SHA384

  • SHA512

The signature digest algorithm to use. See SignatureDigestAlgorithmConstants

SHA1

C14n Algorithm

Enumeration, one of:

  • CanonicalXML_1_0

  • CanonicalXML_1_1

  • ExclusiveXMLCanonicalization_1_0

Defines which signature c14n (canonicalization) algorithm to use. See SignatureC14nAlgorithmConstants

ExclusiveXMLCanonicalization_1_0

Keystore Config

KeyStore configuration used for signing.

x

Wss Parts

Array of Wss Part

Lists of parts to be encrypted. If any part is specified, the SOAP Body will be encrypted.

### Wss Part
FieldTypeDescriptionDefault ValueRequired

Encode

Enumeration, one of:

  • ELEMENT

  • CONTENT

CONTENT

Namespace

String

x

Localname

String

x

### Encryption Config
FieldTypeDescriptionDefault ValueRequired

Encryption Key Identifier

Enumeration, one of:

  • ISSUER_SERIAL

  • DIRECT_REFERENCE

  • X509_KEY_IDENTIFIER

  • THUMBPRINT

  • SKI_KEY_IDENTIFIER

  • ENCRYPTED_KEY_SHA1

The key identifier type to use for encryption.

ISSUER_SERIAL

Encryption Sym Algorithm

Enumeration, one of:

  • TRIPLE_DES

  • AES_128

  • AES_256

  • AES_192

  • AES_128_GCM

  • AES_192_GCM

  • AES_256_GCM

The symmetric encryption algorithm to use.

AES_128

Encryption Key Transport Algorithm

Enumeration, one of:

  • KEYTRANSPORT_RSA15

  • KEYTRANSPORT_RSAOAEP

  • KEYTRANSPORT_RSAOAEP_XENC11

The algorithm used to encrypt the generated symmetric key.

KEYTRANSPORT_RSAOAEP

Encryption Digest Algorithm

Enumeration, one of:

  • SHA1

  • SHA256

  • SHA384

  • SHA512

The encryption digest algorithm to use with the key transport algorithm.

SHA1

Keystore Config

KeyStore configuration used for encryption.

Wss Parts

Array of Wss Part

Lists of parts to be encrypted. If any part is specified, the SOAP Body will be encrypted.

### Timestamp Config
FieldTypeDescriptionDefault ValueRequired

Time To Live

Number

The time within which the Timestamp element is valid. The default is 5 minutes.

300

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive configuration.

SECONDS

Precision In Milliseconds

Boolean

If set to true then use timestamps with milliseconds, otherwise omit the milliseconds.

true

### Credentials Config
FieldTypeDescriptionDefault ValueRequired

Username

String

Username.

x

Password

String

Password.

x

### LDAP Config
FieldTypeDescriptionDefault ValueRequired

Provider Url

String

LDAP Server URL.

x

User Dn

String

User that will authenticate to the directory.

x

Password

String

Credentials to use for getting authenticated contexts.

x

Search Base

String

The search base defines the starting point for the search in the directory tree.

x

Search Filter

String

Filters can be used to restrict the numbers of users or groups that are permitted to access an application.

x

Search In Subtree

Boolean

Whether to search in subtree.

false

--- product: WSS Module version: 2.1 --- # WSS Module 2.1 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt WSS Module enables you to process and validate an inbound SOAP request against a given Web Service Security (WSS) extension configuration to, for example, validate the request’s signature, perform an LDAP authentication, or decrypt the inbound message. WSS Module also enables you to sign your response by adding a WSS header to it, or to encrypt your outbound message. In version 2.1, the module upgrades the default hashing algorithm from SHA-1 to SHA-256 to enhance cryptographic security and align with FIPS 140-3 approved standards. For information about compatibility and fixed issues, see the WSS Module Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The WSS Module API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Studio Before creating an app, you must have access to: - The WSS Module target resource - Anypoint Platform - Anypoint Studio or Anypoint Code Builder - Web Services Security (WSS) extension for SOAP ## Common Use Cases for the Connector WSS Module enables you to validate WSS headers in inbound SOAP requests to your application to: - Decrypt a SOAP envelope according to the encryption information - Validate a signature - Verify the freshness of the message using `timestamp` information - Verify the `Username` and `Password` credentials of `UsernameToken` - Verify the `LDAP` credentials of `UsernameToken` - Determine whether `UsernameToken` is expired - Determine whether a SAML assertion expired - Verify the signature of a SAML assertion. - Verify that a SAML assertion has a specific confirmation method. Using WSS Module, you can also add WSS headers to your outbound SOAP response to: - Encrypt some or all of your SOAP message content - Sign your SOAP message See the [WSS Module Examples](https://docs.mulesoft.com/wss-module/2.1/wss-examples) section for detailed examples. ## Audience - New user To create your Mule app, see: - [Studio Configuration](https://docs.mulesoft.com/wss-module/2.1/wss-studio) to help extend your understanding of WSS Module. - [Examples](https://docs.mulesoft.com/wss-module/2.1/wss-examples), with use case information for the connector - Advanced user Read the following: - [XML and Maven Support](https://docs.mulesoft.com/wss-module/2.1/wss-xml-maven) - [Examples](https://docs.mulesoft.com/wss-module/2.1/wss-examples), with use case information for the connector ## Next Step After you complete the prerequisites and experiment with templates and examples, you are ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/wss-module/2.1/wss-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [WSS Module on Exchange](https://www.mulesoft.com/exchange/?search=wss-module&type=connector) - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 2.1 --- # WSS Module 2.1 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt WSS Module enables you to process and validate an inbound SOAP request against a given Web Service Security (WSS) extension configuration. ## Configurations --- ### Inbound #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Actor

String

 

Extract Security Header

Boolean

false

 

Validate Username Token

 

Validate Signature

 

Decrypt Message

 

Validate Timestamp

 

Validate SAML Assertion

 

Name

String

The identifier of this element used to reference it in other components.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

#### Associated Operations - [Validate WSS](#validateWss)   --- ### Outbound #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Signature Configuration

 

Encryption Configuration

 

Timestamp Configuration

 

'Must Understand' Attribute

Boolean

false

 

Name

String

The identifier of this element used to reference it in other components.

x

#### Associated Operations - [Apply WSS](#applyWss)   ## Operations ### Validate WSS `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Request

Binary

#[payload]

 

Version

Enumeration, one of:

  • SOAP_11

  • SOAP_12

SOAP_12

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Config Ref

ConfigurationProvider

The name of the configuration used to execute this component.

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Error Mappings

Array of Error Mapping

Set of error mappings.

#### Output

Type

Binary

#### For Configurations. - [Inbound](#inbound)   #### Throws - WSS:MISSING\_CERTIFICATE   - WSS:SECURITY\_APPLYING   - WSS:SECURITY\_VALIDATING   ### Apply WSS `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Response

Binary

#[payload]

 

Version

Enumeration, one of:

  • SOAP_11

  • SOAP_12

SOAP_12

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Config Ref

ConfigurationProvider

The name of the configuration used to execute this component.

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Error Mappings

Array of Error Mapping

Set of error mappings.

#### Output

Type

Binary

#### For Configurations. - [Outbound](#outbound)   #### Throws - WSS:MISSING\_CERTIFICATE   - WSS:SECURITY\_APPLYING   - WSS:SECURITY\_VALIDATING   ## Types ### Verify Username Token Config
FieldTypeDescriptionDefault ValueRequired

Authenticate User Config

Specific type for the authentication configuration. See AuthenticateUserConfig sub-types.

x

Time To Live

Number

The time difference between creation and expiry time in seconds in the UsernameToken Created element.

30

Check Nonce

Boolean

Whether to check the Nonce Element in the UsernameToken. A Nonce is a random value that the sender creates to include in each UsernameToken that it sends. Only checked if included.

true

### Verify Signature Config
FieldTypeDescriptionDefault ValueRequired

Truststore Config

TrustStore configuration used for validating the signature.

x

Issuer Pattern

String

Certificate Issuer pattern.

Subject Pattern

String

Certificate Subject pattern.

### Trust Store Configuration
FieldTypeDescriptionDefault ValueRequired

Path

String

x

Password

String

x

Type

String

jks

### Decryption Config
FieldTypeDescriptionDefault ValueRequired

Keystore Config

KeyStore configuration used for decryption.

x

### Key Store Configuration
FieldTypeDescriptionDefault ValueRequired

Path

String

x

Password

String

x

Alias

String

Key Password

String

Type

String

jks

### Verify Timestamp Config
FieldTypeDescriptionDefault ValueRequired

Time To Live

Number

The time within which the Timestamp element is valid. The default is 5 minutes.

300

Skew Time

Number

The time difference between server and client. The default is 60 seconds.

60

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive configuration.

SECONDS

Strict

Boolean

If set to true then validates if the timestamp contains an expires element and the semantics are expired.

true

Require Expires Header

Boolean

Whether timestamp Expires header is required.

true

Precision In Milliseconds

Boolean

If set to true then use timestamps with milliseconds, otherwise omit the milliseconds.

true

### Verify Saml Config
FieldTypeDescriptionDefault ValueRequired

Saml Version

Enumeration, one of:

  • SAML10

  • SAML11

  • SAML20

SAML Version.

SAML10

Time To Live

Number

The time in seconds within which a SAML Assertion is valid, if it does not contain a NotOnOrAfter Condition. The default is 30 minutes.

1800

Skew Time

Number

The time difference between server and client. The default is 60 seconds.

60

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive and skewTime configuration.

SECONDS

Require Standard Subject Confirmation Method

Boolean

If set, at least one of the standard Subject Confirmation Methods in SamlConfirmationMethod must be present in the assertion (Bearer / SenderVouches / HolderOfKey).

false

Require Bearer Signature

Boolean

If set, an Assertion with a Bearer Subject Confirmation Method must be signed.

false

Validate Signature Against Profile

Boolean

Whether to validate the signature of the Assertion (if it exists) against the relevant profile. Default is true.

false

Required Subject Confirmation Method

Enumeration, one of:

  • BEARER

  • HOLDER_OF_KEY

  • SENDER_VOUCHES

If set, the value must appear as one of the Subject Confirmation Methods SamlConfirmationMethod.

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

### Repeatable In Memory Stream
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

### Repeatable File Store Stream
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

### Error Mapping
FieldTypeDescriptionDefault ValueRequired

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Target

String

x

### Signature Config
FieldTypeDescriptionDefault ValueRequired

Key Identifier

Enumeration, one of:

  • ISSUER_SERIAL

  • DIRECT_REFERENCE

  • X509_KEY_IDENTIFIER

  • THUMBPRINT

  • SKI_KEY_IDENTIFIER

  • KEY_VALUE

The key identifier type to use for signature. See SignatureKeyIdentifierConstants

ISSUER_SERIAL

Algorithm

Enumeration, one of:

  • RSAwithSHA256

  • ECDSAwithSHA256

  • DSAwithSHA1

  • RSAwithSHA1

  • RSAwithSHA224

  • RSAwithSHA384

  • RSAwithSHA512

  • ECDSAwithSHA1

  • ECDSAwithSHA224

  • ECDSAwithSHA384

  • ECDSAwithSHA512

  • DSAwithSHA256

The signature algorithm to use. The default is set by the data in the certificate. See SignatureAlgorithmConstants

Digest Algorithm

Enumeration, one of:

  • SHA1

  • SHA256

  • SHA224

  • SHA384

  • SHA512

The signature digest algorithm to use. See SignatureDigestAlgorithmConstants

SHA256

C14n Algorithm

Enumeration, one of:

  • CanonicalXML_1_0

  • CanonicalXML_1_1

  • ExclusiveXMLCanonicalization_1_0

Defines which signature c14n (canonicalization) algorithm to use. See SignatureC14nAlgorithmConstants

ExclusiveXMLCanonicalization_1_0

Keystore Config

KeyStore configuration used for signing.

x

Wss Parts

Array of Wss Part

Lists of parts to be encrypted. If any part is specified, the SOAP Body will be encrypted.

### Wss Part
FieldTypeDescriptionDefault ValueRequired

Encode

Enumeration, one of:

  • ELEMENT

  • CONTENT

CONTENT

Namespace

String

x

Localname

String

x

### Encryption Config
FieldTypeDescriptionDefault ValueRequired

Encryption Key Identifier

Enumeration, one of:

  • ISSUER_SERIAL

  • DIRECT_REFERENCE

  • X509_KEY_IDENTIFIER

  • THUMBPRINT

  • SKI_KEY_IDENTIFIER

  • ENCRYPTED_KEY_SHA1

The key identifier type to use for encryption.

ISSUER_SERIAL

Encryption Sym Algorithm

Enumeration, one of:

  • TRIPLE_DES

  • AES_128

  • AES_256

  • AES_192

  • AES_128_GCM

  • AES_192_GCM

  • AES_256_GCM

The symmetric encryption algorithm to use.

AES_128

Encryption Key Transport Algorithm

Enumeration, one of:

  • KEYTRANSPORT_RSA15

  • KEYTRANSPORT_RSAOAEP

  • KEYTRANSPORT_RSAOAEP_XENC11

The algorithm used to encrypt the generated symmetric key.

KEYTRANSPORT_RSAOAEP

Encryption Digest Algorithm

Enumeration, one of:

  • SHA1

  • SHA256

  • SHA384

  • SHA512

The encryption digest algorithm to use with the key transport algorithm.

SHA256

Keystore Config

KeyStore configuration used for encryption.

Wss Parts

Array of Wss Part

Lists of parts to be encrypted. If any part is specified, the SOAP Body will be encrypted.

### Timestamp Config
FieldTypeDescriptionDefault ValueRequired

Time To Live

Number

The time within which the Timestamp element is valid. The default is 5 minutes.

300

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive configuration.

SECONDS

Precision In Milliseconds

Boolean

If set to true then use timestamps with milliseconds, otherwise omit the milliseconds.

true

### Credentials Config
FieldTypeDescriptionDefault ValueRequired

Username

String

Username.

x

Password

String

Password.

x

### LDAP Config
FieldTypeDescriptionDefault ValueRequired

Provider Url

String

LDAP Server URL.

x

User Dn

String

User that will authenticate to the directory.

x

Password

String

Credentials to use for getting authenticated contexts.

x

Search Base

String

The search base defines the starting point for the search in the directory tree.

x

Search Filter

String

Filters can be used to restrict the numbers of users or groups that are permitted to access an application.

x

Search In Subtree

Boolean

Whether to search in subtree.

false

--- product: WSS Module version: 2.2 is-latest-version: true --- # WSS Module 2.2 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt WSS Module enables you to process and validate an inbound SOAP request against a given Web Service Security (WSS) extension configuration to, for example, validate the request’s signature, perform an LDAP authentication, or decrypt the inbound message. WSS Module also enables you to sign your response by adding a WSS header to it, or to encrypt your outbound message. Version 2.2 introduces dynamic telemetry traces to improve API operation identification, visibility into API behavior, and troubleshooting. For information about compatibility and fixed issues, see the WSS Module Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The WSS Module API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Studio Before creating an app, you must have access to: - The WSS Module target resource - Anypoint Platform - Anypoint Studio or Anypoint Code Builder - Web Services Security (WSS) extension for SOAP ## Common Use Cases for the Connector WSS Module enables you to validate WSS headers in inbound SOAP requests to your application to: - Decrypt a SOAP envelope according to the encryption information - Validate a signature - Verify the freshness of the message using `timestamp` information - Verify the `Username` and `Password` credentials of `UsernameToken` - Verify the `LDAP` credentials of `UsernameToken` - Determine whether `UsernameToken` is expired - Determine whether a SAML assertion expired - Verify the signature of a SAML assertion. - Verify that a SAML assertion has a specific confirmation method. Using WSS Module, you can also add WSS headers to your outbound SOAP response to: - Encrypt some or all of your SOAP message content - Sign your SOAP message See the [WSS Module Examples](https://docs.mulesoft.com/wss-module/latest/wss-examples) section for detailed examples. ## Audience - New user To create your Mule app, see: - [Studio Configuration](https://docs.mulesoft.com/wss-module/latest/wss-studio) to help extend your understanding of WSS Module. - [Examples](https://docs.mulesoft.com/wss-module/latest/wss-examples), with use case information for the connector - Advanced user Read the following: - [XML and Maven Support](https://docs.mulesoft.com/wss-module/latest/wss-xml-maven) - [Examples](https://docs.mulesoft.com/wss-module/latest/wss-examples), with use case information for the connector ## Next Step After you complete the prerequisites and experiment with templates and examples, you are ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/wss-module/latest/wss-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [WSS Module on Exchange](https://www.mulesoft.com/exchange/?search=wss-module&type=connector) - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 2.2 is-latest-version: true --- # WSS Module 2.2 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt WSS Module enables you to process and validate an inbound SOAP request against a given Web Service Security (WSS) extension configuration. ## Configurations --- ### Inbound #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Actor

String

 

Extract Security Header

Boolean

false

 

Validate Username Token

 

Validate Signature

 

Decrypt Message

 

Validate Timestamp

 

Validate SAML Assertion

 

Name

String

The identifier of this element used to reference it in other components.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

#### Associated Operations - [Validate WSS](#validateWss)   --- ### Outbound #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Signature Configuration

 

Encryption Configuration

 

Timestamp Configuration

 

'Must Understand' Attribute

Boolean

false

 

Name

String

The identifier of this element used to reference it in other components.

x

#### Associated Operations - [Apply WSS](#applyWss)   ## Operations ### Validate WSS `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Request

Binary

#[payload]

 

Version

Enumeration, one of:

  • SOAP_11

  • SOAP_12

SOAP_12

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Config Ref

ConfigurationProvider

The name of the configuration used to execute this component.

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Error Mappings

Array of Error Mapping

Set of error mappings.

#### Output

Type

Binary

#### For Configurations. - [Inbound](#inbound)   #### Throws - WSS:MISSING\_CERTIFICATE   - WSS:SECURITY\_APPLYING   - WSS:SECURITY\_VALIDATING   ### Apply WSS `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Response

Binary

#[payload]

 

Version

Enumeration, one of:

  • SOAP_11

  • SOAP_12

SOAP_12

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Config Ref

ConfigurationProvider

The name of the configuration used to execute this component.

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Error Mappings

Array of Error Mapping

Set of error mappings.

#### Output

Type

Binary

#### For Configurations. - [Outbound](#outbound)   #### Throws - WSS:MISSING\_CERTIFICATE   - WSS:SECURITY\_APPLYING   - WSS:SECURITY\_VALIDATING   ## Types ### Verify Username Token Config
FieldTypeDescriptionDefault ValueRequired

Authenticate User Config

Specific type for the authentication configuration. See AuthenticateUserConfig sub-types.

x

Time To Live

Number

The time difference between creation and expiry time in seconds in the UsernameToken Created element.

30

Check Nonce

Boolean

Whether to check the Nonce Element in the UsernameToken. A Nonce is a random value that the sender creates to include in each UsernameToken that it sends. Only checked if included.

true

### Verify Signature Config
FieldTypeDescriptionDefault ValueRequired

Truststore Config

TrustStore configuration used for validating the signature.

x

Issuer Pattern

String

Certificate Issuer pattern.

Subject Pattern

String

Certificate Subject pattern.

### Trust Store Configuration
FieldTypeDescriptionDefault ValueRequired

Path

String

x

Password

String

x

Type

String

jks

### Decryption Config
FieldTypeDescriptionDefault ValueRequired

Keystore Config

KeyStore configuration used for decryption.

x

### Key Store Configuration
FieldTypeDescriptionDefault ValueRequired

Path

String

x

Password

String

x

Alias

String

Key Password

String

Type

String

jks

### Verify Timestamp Config
FieldTypeDescriptionDefault ValueRequired

Time To Live

Number

The time within which the Timestamp element is valid. The default is 5 minutes.

300

Skew Time

Number

The time difference between server and client. The default is 60 seconds.

60

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive configuration.

SECONDS

Strict

Boolean

If set to true then validates if the timestamp contains an expires element and the semantics are expired.

true

Require Expires Header

Boolean

Whether timestamp Expires header is required.

true

Precision In Milliseconds

Boolean

If set to true then use timestamps with milliseconds, otherwise omit the milliseconds.

true

### Verify Saml Config
FieldTypeDescriptionDefault ValueRequired

Saml Version

Enumeration, one of:

  • SAML10

  • SAML11

  • SAML20

SAML Version.

SAML10

Time To Live

Number

The time in seconds within which a SAML Assertion is valid, if it does not contain a NotOnOrAfter Condition. The default is 30 minutes.

1800

Skew Time

Number

The time difference between server and client. The default is 60 seconds.

60

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive and skewTime configuration.

SECONDS

Require Standard Subject Confirmation Method

Boolean

If set, at least one of the standard Subject Confirmation Methods in SamlConfirmationMethod must be present in the assertion (Bearer / SenderVouches / HolderOfKey).

false

Require Bearer Signature

Boolean

If set, an Assertion with a Bearer Subject Confirmation Method must be signed.

false

Validate Signature Against Profile

Boolean

Whether to validate the signature of the Assertion (if it exists) against the relevant profile. Default is true.

false

Required Subject Confirmation Method

Enumeration, one of:

  • BEARER

  • HOLDER_OF_KEY

  • SENDER_VOUCHES

If set, the value must appear as one of the Subject Confirmation Methods SamlConfirmationMethod.

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

### Repeatable In Memory Stream
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

### Repeatable File Store Stream
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

### Error Mapping
FieldTypeDescriptionDefault ValueRequired

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Target

String

x

### Signature Config
FieldTypeDescriptionDefault ValueRequired

Key Identifier

Enumeration, one of:

  • ISSUER_SERIAL

  • DIRECT_REFERENCE

  • X509_KEY_IDENTIFIER

  • THUMBPRINT

  • SKI_KEY_IDENTIFIER

  • KEY_VALUE

The key identifier type to use for signature. See SignatureKeyIdentifierConstants

ISSUER_SERIAL

Algorithm

Enumeration, one of:

  • RSAwithSHA256

  • ECDSAwithSHA256

  • DSAwithSHA1

  • RSAwithSHA1

  • RSAwithSHA224

  • RSAwithSHA384

  • RSAwithSHA512

  • ECDSAwithSHA1

  • ECDSAwithSHA224

  • ECDSAwithSHA384

  • ECDSAwithSHA512

  • DSAwithSHA256

The signature algorithm to use. The default is set by the data in the certificate. See SignatureAlgorithmConstants

Digest Algorithm

Enumeration, one of:

  • SHA1

  • SHA256

  • SHA224

  • SHA384

  • SHA512

The signature digest algorithm to use. See SignatureDigestAlgorithmConstants

SHA256

C14n Algorithm

Enumeration, one of:

  • CanonicalXML_1_0

  • CanonicalXML_1_1

  • ExclusiveXMLCanonicalization_1_0

Defines which signature c14n (canonicalization) algorithm to use. See SignatureC14nAlgorithmConstants

ExclusiveXMLCanonicalization_1_0

Keystore Config

KeyStore configuration used for signing.

x

Wss Parts

Array of Wss Part

Lists of parts to be encrypted. If any part is specified, the SOAP Body will be encrypted.

### Wss Part
FieldTypeDescriptionDefault ValueRequired

Encode

Enumeration, one of:

  • ELEMENT

  • CONTENT

CONTENT

Namespace

String

x

Localname

String

x

### Encryption Config
FieldTypeDescriptionDefault ValueRequired

Encryption Key Identifier

Enumeration, one of:

  • ISSUER_SERIAL

  • DIRECT_REFERENCE

  • X509_KEY_IDENTIFIER

  • THUMBPRINT

  • SKI_KEY_IDENTIFIER

  • ENCRYPTED_KEY_SHA1

The key identifier type to use for encryption.

ISSUER_SERIAL

Encryption Sym Algorithm

Enumeration, one of:

  • TRIPLE_DES

  • AES_128

  • AES_256

  • AES_192

  • AES_128_GCM

  • AES_192_GCM

  • AES_256_GCM

The symmetric encryption algorithm to use.

AES_128

Encryption Key Transport Algorithm

Enumeration, one of:

  • KEYTRANSPORT_RSA15

  • KEYTRANSPORT_RSAOAEP

  • KEYTRANSPORT_RSAOAEP_XENC11

The algorithm used to encrypt the generated symmetric key.

KEYTRANSPORT_RSAOAEP

Encryption Digest Algorithm

Enumeration, one of:

  • SHA1

  • SHA256

  • SHA384

  • SHA512

The encryption digest algorithm to use with the key transport algorithm.

SHA256

Keystore Config

KeyStore configuration used for encryption.

Wss Parts

Array of Wss Part

Lists of parts to be encrypted. If any part is specified, the SOAP Body will be encrypted.

### Timestamp Config
FieldTypeDescriptionDefault ValueRequired

Time To Live

Number

The time within which the Timestamp element is valid. The default is 5 minutes.

300

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive configuration.

SECONDS

Precision In Milliseconds

Boolean

If set to true then use timestamps with milliseconds, otherwise omit the milliseconds.

true

### Credentials Config
FieldTypeDescriptionDefault ValueRequired

Username

String

Username.

x

Password

String

Password.

x

### LDAP Config
FieldTypeDescriptionDefault ValueRequired

Provider Url

String

LDAP Server URL.

x

User Dn

String

User that will authenticate to the directory.

x

Password

String

Credentials to use for getting authenticated contexts.

x

Search Base

String

The search base defines the starting point for the search in the directory tree.

x

Search Filter

String

Filters can be used to restrict the numbers of users or groups that are permitted to access an application.

x

Search In Subtree

Boolean

Whether to search in subtree.

false

--- product: WSS Module version: 1.0 --- # WSS Module Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt WSS Module v1.0 enables you to process and validate an inbound SOAP request against a given Web Service Security (WSS) extension configuration. ## Configurations --- ### Inbound #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Actor

String

 

Extract Security Header

Boolean

false

 

Validate Username Token

 

Validate Signature

 

Decrypt Message

 

Validate Timestamp

 

Validate SAML Assertion

 

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

#### Associated Operations - [Validate WSS](#validateWss)   --- ### Outbound #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Signature Configuration

 

Encryption Configuration

 

'Must Understand' Attribute

Boolean

false

 

#### Associated Operations - [Apply WSS](#applyWss)   ## Operations ### Validate WSS `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Request

Binary

#[payload]

 

Version

Enumeration, one of:

  • SOAP_11

  • SOAP_12

SOAP_12

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Streaming Strategy

Configure if repeatable streams should be used and their behavior

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

#### Output

Type

Binary

#### For Configurations. - [Inbound](#inbound)   #### Throws - WSS:MISSING\_CERTIFICATE   - WSS:SECURITY\_APPLYING   - WSS:SECURITY\_VALIDATING   ### Apply WSS `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Response

Binary

#[payload]

 

Version

Enumeration, one of:

  • SOAP_11

  • SOAP_12

SOAP_12

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Streaming Strategy

Configure if repeatable streams should be used and their behavior

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

#### Output

Type

Binary

#### For Configurations. - [Outbound](#outbound)   #### Throws - WSS:MISSING\_CERTIFICATE   - WSS:SECURITY\_APPLYING   - WSS:SECURITY\_VALIDATING   ## Types ### Verify Username Token Config
FieldTypeDescriptionDefault ValueRequired

Authenticate User Config

Specific type for the authentication configuration. See AuthenticateUserConfig sub-types.

x

Time To Live

Number

The time difference between creation and expiry time in seconds in the UsernameToken Created element.

30

Check Nonce

Boolean

Whether to check the Nonce Element in the UsernameToken. A Nonce is a random value that the sender creates to include in each UsernameToken that it sends. Only checked if included.

true

### Verify Signature Config
FieldTypeDescriptionDefault ValueRequired

Truststore Config

TrustStore configuration used for validating the signature.

x

Issuer Pattern

String

Certificate Issuer pattern.

Subject Pattern

String

Certificate Subject pattern.

### Trust Store Configuration
FieldTypeDescriptionDefault ValueRequired

Path

String

x

Password

String

x

Type

String

jks

### Decryption Config
FieldTypeDescriptionDefault ValueRequired

Keystore Config

KeyStore configuration used for decryption.

x

### Key Store Configuration
FieldTypeDescriptionDefault ValueRequired

Path

String

x

Password

String

x

Alias

String

Key Password

String

Type

String

jks

### Verify Timestamp Config
FieldTypeDescriptionDefault ValueRequired

Time To Live

Number

The time within which the Timestamp element is valid. The default is 5 minutes.

300

Skew Time

Number

The time difference between server and client. The default is 60 seconds.

60

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive configuration.

SECONDS

Strict

Boolean

If set to true then validates if the timestamp contains an expires element and the semantics are expired.

true

Require Expires Header

Boolean

Whether timestamp Expires header is required.

true

Precision In Milliseconds

Boolean

If set to true then use timestamps with milliseconds, otherwise omit the milliseconds.

true

### Verify Saml Config
FieldTypeDescriptionDefault ValueRequired

Saml Version

Enumeration, one of:

  • SAML10

  • SAML11

  • SAML20

SAML Version.

SAML10

Time To Live

Number

The time in seconds within which a SAML Assertion is valid, if it does not contain a NotOnOrAfter Condition. The default is 30 minutes.

1800

Skew Time

Number

The time difference between server and client. The default is 60 seconds.

60

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive and skewTime configuration.

SECONDS

Require Standard Subject Confirmation Method

Boolean

If set, at least one of the standard Subject Confirmation Methods in SamlConfirmationMethod must be present in the assertion (Bearer / SenderVouches / HolderOfKey).

false

Require Bearer Signature

Boolean

If set, an Assertion with a Bearer Subject Confirmation Method must be signed.

false

Validate Signature Against Profile

Boolean

Whether to validate the signature of the Assertion (if it exists) against the relevant profile. Default is true.

false

Required Subject Confirmation Method

Enumeration, one of:

  • BEARER

  • HOLDER_OF_KEY

  • SENDER_VOUCHES

If set, the value must appear as one of the Subject Confirmation Methods SamlConfirmationMethod.

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

### Repeatable In Memory Stream
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

### Repeatable File Store Stream
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

### Signature Config
FieldTypeDescriptionDefault ValueRequired

Key Identifier

Enumeration, one of:

  • ISSUER_SERIAL

  • DIRECT_REFERENCE

  • X509_KEY_IDENTIFIER

  • THUMBPRINT

  • SKI_KEY_IDENTIFIER

  • KEY_VALUE

The key identifier type to use for signature. See SignatureKeyIdentifierConstants

ISSUER_SERIAL

Algorithm

Enumeration, one of:

  • RSAwithSHA256

  • ECDSAwithSHA256

  • DSAwithSHA1

  • RSAwithSHA1

  • RSAwithSHA224

  • RSAwithSHA384

  • RSAwithSHA512

  • ECDSAwithSHA1

  • ECDSAwithSHA224

  • ECDSAwithSHA384

  • ECDSAwithSHA512

  • DSAwithSHA256

The signature algorithm to use. The default is set by the data in the certificate. See SignatureAlgorithmConstants

Digest Algorithm

Enumeration, one of:

  • SHA1

  • SHA256

  • SHA224

  • SHA384

  • SHA512

The signature digest algorithm to use. See SignatureDigestAlgorithmConstants

SHA1

C14n Algorithm

Enumeration, one of:

  • CanonicalXML_1_0

  • CanonicalXML_1_1

  • ExclusiveXMLCanonicalization_1_0

Defines which signature c14n (canonicalization) algorithm to use. See SignatureC14nAlgorithmConstants

ExclusiveXMLCanonicalization_1_0

Keystore Config

KeyStore configuration used for signing.

x

Wss Parts

Array of Wss Part

Lists of parts to be encrypted. If any part is specified, the SOAP Body will be encrypted.

### Wss Part
FieldTypeDescriptionDefault ValueRequired

Encode

Enumeration, one of:

  • ELEMENT

  • CONTENT

CONTENT

Namespace

String

x

Localname

String

x

### Encryption Config
FieldTypeDescriptionDefault ValueRequired

Encryption Key Identifier

Enumeration, one of:

  • ISSUER_SERIAL

  • DIRECT_REFERENCE

  • X509_KEY_IDENTIFIER

  • THUMBPRINT

  • SKI_KEY_IDENTIFIER

  • ENCRYPTED_KEY_SHA1

  • EMBEDDED_KEY_NAME

The key identifier type to use for encryption.

ISSUER_SERIAL

Encryption Sym Algorithm

Enumeration, one of:

  • TRIPLE_DES

  • AES_128

  • AES_256

  • AES_192

  • AES_128_GCM

  • AES_192_GCM

  • AES_256_GCM

The symmetric encryption algorithm to use.

AES_128

Encryption Key Transport Algorithm

Enumeration, one of:

  • KEYTRANSPORT_RSA15

  • KEYTRANSPORT_RSAOAEP

  • KEYTRANSPORT_RSAOAEP_XENC11

The algorithm used to encrypt the generated symmetric key.

KEYTRANSPORT_RSAOAEP

Encryption Digest Algorithm

Enumeration, one of:

  • SHA1

  • SHA256

  • SHA384

  • SHA512

The encryption digest algorithm to use with the key transport algorithm.

SHA1

Keystore Config

KeyStore configuration used for encryption.

Wss Parts

Array of Wss Part

Lists of parts to be encrypted. If any part is specified, the SOAP Body will be encrypted.

### Credentials Config
FieldTypeDescriptionDefault ValueRequired

Username

String

Username.

x

Password

String

Password.

x

### LDAP Config
FieldTypeDescriptionDefault ValueRequired

Provider Url

String

LDAP Server URL.

x

User Dn

String

User that will authenticate to the directory.

x

Password

String

Credentials to use for getting authenticated contexts.

x

Search Base

String

The search base defines the starting point for the search in the directory tree.

x

Search Filter

String

Filters can be used to restrict the numbers of users or groups that are permitted to access an application.

x

Search In Subtree

Boolean

Whether to search in subtree.

false

--- product: WSS Module version: 1.1 --- # WSS Module Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt WSS Module v1.1 enables you to process and validate an inbound SOAP request against a given Web Service Security (WSS) extension configuration. ## Configurations --- ### Inbound #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Actor

String

 

Extract Security Header

Boolean

false

 

Validate Username Token

 

Validate Signature

 

Decrypt Message

 

Validate Timestamp

 

Validate SAML Assertion

 

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

#### Associated Operations - [Validate WSS](#validateWss)   --- ### Outbound #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Signature Configuration

 

Encryption Configuration

 

Timestamp Configuration

 

'Must Understand' Attribute

Boolean

false

 

#### Associated Operations - [Apply WSS](#applyWss)   ## Operations ### Validate WSS `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Request

Binary

#[payload]

 

Version

Enumeration, one of:

  • SOAP_11

  • SOAP_12

SOAP_12

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

#### Output

Type

Binary

#### For Configurations. - [Inbound](#inbound)   #### Throws - WSS:MISSING\_CERTIFICATE   - WSS:SECURITY\_APPLYING   - WSS:SECURITY\_VALIDATING   ### Apply WSS `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Response

Binary

#[payload]

 

Version

Enumeration, one of:

  • SOAP_11

  • SOAP_12

SOAP_12

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Output Encoding

String

The encoding of the payload that this operation outputs.

 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

#### Output

Type

Binary

#### For Configurations. - [Outbound](#outbound)   #### Throws - WSS:MISSING\_CERTIFICATE   - WSS:SECURITY\_APPLYING   - WSS:SECURITY\_VALIDATING   ## Types ### Verify Username Token Config
FieldTypeDescriptionDefault ValueRequired

Authenticate User Config

Specific type for the authentication configuration. See AuthenticateUserConfig sub-types.

x

Time To Live

Number

The time difference between creation and expiry time in seconds in the UsernameToken Created element.

30

Check Nonce

Boolean

Whether to check the Nonce Element in the UsernameToken. A Nonce is a random value that the sender creates to include in each UsernameToken that it sends. Only checked if included.

true

### Verify Signature Config
FieldTypeDescriptionDefault ValueRequired

Truststore Config

TrustStore configuration used for validating the signature.

x

Issuer Pattern

String

Certificate Issuer pattern.

Subject Pattern

String

Certificate Subject pattern.

### Trust Store Configuration
FieldTypeDescriptionDefault ValueRequired

Path

String

x

Password

String

x

Type

String

jks

### Decryption Config
FieldTypeDescriptionDefault ValueRequired

Keystore Config

KeyStore configuration used for decryption.

x

### Key Store Configuration
FieldTypeDescriptionDefault ValueRequired

Path

String

x

Password

String

x

Alias

String

Key Password

String

Type

String

jks

### Verify Timestamp Config
FieldTypeDescriptionDefault ValueRequired

Time To Live

Number

The time within which the Timestamp element is valid. The default is 5 minutes.

300

Skew Time

Number

The time difference between server and client. The default is 60 seconds.

60

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive configuration.

SECONDS

Strict

Boolean

If set to true then validates if the timestamp contains an expires element and the semantics are expired.

true

Require Expires Header

Boolean

Whether timestamp Expires header is required.

true

Precision In Milliseconds

Boolean

If set to true then use timestamps with milliseconds, otherwise omit the milliseconds.

true

### Verify Saml Config
FieldTypeDescriptionDefault ValueRequired

Saml Version

Enumeration, one of:

  • SAML10

  • SAML11

  • SAML20

SAML Version.

SAML10

Time To Live

Number

The time in seconds within which a SAML Assertion is valid, if it does not contain a NotOnOrAfter Condition. The default is 30 minutes.

1800

Skew Time

Number

The time difference between server and client. The default is 60 seconds.

60

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive and skewTime configuration.

SECONDS

Require Standard Subject Confirmation Method

Boolean

If set, at least one of the standard Subject Confirmation Methods in SamlConfirmationMethod must be present in the assertion (Bearer / SenderVouches / HolderOfKey).

false

Require Bearer Signature

Boolean

If set, an Assertion with a Bearer Subject Confirmation Method must be signed.

false

Validate Signature Against Profile

Boolean

Whether to validate the signature of the Assertion (if it exists) against the relevant profile. Default is true.

false

Required Subject Confirmation Method

Enumeration, one of:

  • BEARER

  • HOLDER_OF_KEY

  • SENDER_VOUCHES

If set, the value must appear as one of the Subject Confirmation Methods SamlConfirmationMethod.

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

### Repeatable In Memory Stream
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

### Repeatable File Store Stream
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

### Signature Config
FieldTypeDescriptionDefault ValueRequired

Key Identifier

Enumeration, one of:

  • ISSUER_SERIAL

  • DIRECT_REFERENCE

  • X509_KEY_IDENTIFIER

  • THUMBPRINT

  • SKI_KEY_IDENTIFIER

  • KEY_VALUE

The key identifier type to use for signature. See SignatureKeyIdentifierConstants

ISSUER_SERIAL

Algorithm

Enumeration, one of:

  • RSAwithSHA256

  • ECDSAwithSHA256

  • DSAwithSHA1

  • RSAwithSHA1

  • RSAwithSHA224

  • RSAwithSHA384

  • RSAwithSHA512

  • ECDSAwithSHA1

  • ECDSAwithSHA224

  • ECDSAwithSHA384

  • ECDSAwithSHA512

  • DSAwithSHA256

The signature algorithm to use. The default is set by the data in the certificate. See SignatureAlgorithmConstants

Digest Algorithm

Enumeration, one of:

  • SHA1

  • SHA256

  • SHA224

  • SHA384

  • SHA512

The signature digest algorithm to use. See SignatureDigestAlgorithmConstants

SHA1

C14n Algorithm

Enumeration, one of:

  • CanonicalXML_1_0

  • CanonicalXML_1_1

  • ExclusiveXMLCanonicalization_1_0

Defines which signature c14n (canonicalization) algorithm to use. See SignatureC14nAlgorithmConstants

ExclusiveXMLCanonicalization_1_0

Keystore Config

KeyStore configuration used for signing.

x

Wss Parts

Array of Wss Part

Lists of parts to be encrypted. If any part is specified, the SOAP Body will be encrypted.

### Wss Part
FieldTypeDescriptionDefault ValueRequired

Encode

Enumeration, one of:

  • ELEMENT

  • CONTENT

CONTENT

Namespace

String

x

Localname

String

x

### Encryption Config
FieldTypeDescriptionDefault ValueRequired

Encryption Key Identifier

Enumeration, one of:

  • ISSUER_SERIAL

  • DIRECT_REFERENCE

  • X509_KEY_IDENTIFIER

  • THUMBPRINT

  • SKI_KEY_IDENTIFIER

  • ENCRYPTED_KEY_SHA1

  • EMBEDDED_KEY_NAME

The key identifier type to use for encryption.

ISSUER_SERIAL

Encryption Sym Algorithm

Enumeration, one of:

  • TRIPLE_DES

  • AES_128

  • AES_256

  • AES_192

  • AES_128_GCM

  • AES_192_GCM

  • AES_256_GCM

The symmetric encryption algorithm to use.

AES_128

Encryption Key Transport Algorithm

Enumeration, one of:

  • KEYTRANSPORT_RSA15

  • KEYTRANSPORT_RSAOAEP

  • KEYTRANSPORT_RSAOAEP_XENC11

The algorithm used to encrypt the generated symmetric key.

KEYTRANSPORT_RSAOAEP

Encryption Digest Algorithm

Enumeration, one of:

  • SHA1

  • SHA256

  • SHA384

  • SHA512

The encryption digest algorithm to use with the key transport algorithm.

SHA1

Keystore Config

KeyStore configuration used for encryption.

Wss Parts

Array of Wss Part

Lists of parts to be encrypted. If any part is specified, the SOAP Body will be encrypted.

### Timestamp Config
FieldTypeDescriptionDefault ValueRequired

Time To Live

Number

The time within which the Timestamp element is valid. The default is 5 minutes.

300

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the timeToLive configuration.

SECONDS

Precision In Milliseconds

Boolean

If set to true then use timestamps with milliseconds, otherwise omit the milliseconds.

true

### Credentials Config
FieldTypeDescriptionDefault ValueRequired

Username

String

Username.

x

Password

String

Password.

x

### LDAP Config
FieldTypeDescriptionDefault ValueRequired

Provider Url

String

LDAP Server URL.

x

User Dn

String

User that will authenticate to the directory.

x

Password

String

Credentials to use for getting authenticated contexts.

x

Search Base

String

The search base defines the starting point for the search in the directory tree.

x

Search Filter

String

Filters can be used to restrict the numbers of users or groups that are permitted to access an application.

x

Search In Subtree

Boolean

Whether to search in subtree.

false

--- product: WSS Module version: 1.0 --- # WSS Module XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you manually code a Mule application in XML either from the Studio XML editor or a text editor, you must perform the following actions to get access to a connector: Add the namespace for the connector to your XML flow. Add dependency information to your Maven `pom.xml` file. In the Studio visual editor, when you drag a connector from the Mule Palette to the canvas, Studio automatically populates the XML code with the connector namespace and schema location. ## Add a Namespace for the Connector If you manually code the Mule application in the Studio XML editor or another text editor, paste the following code inside the tag in your XML configuration: ```xml http://www.mulesoft.org/schema/mule/wss http://www.mulesoft.org/schema/mule/wss/current/mule-wss.xsd ``` This example shows how the namespace statements are placed in the `mule` XML block: ```xml ``` ## Add a POM File Dependency The `pom.xml` Apache Maven file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your POM file to enable access to this connector: ```xml org.mule.modules mule-wss-module 1.0.0 mule-plugin ``` To obtain the most up-to-date pom.xml file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `WSS Module`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/wss-module/1.0/wss-examples). ## See Also - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 1.1 --- # WSS Module XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you manually code a Mule application in XML either from the Studio XML editor or a text editor, you must perform the following actions to get access to a connector: Add the namespace for the connector to your XML flow. Add dependency information to your Maven `pom.xml` file. In the Studio visual editor, when you drag a connector from the Mule Palette to the canvas, Studio automatically populates the XML code with the connector namespace and schema location. ## Add a Namespace for the Connector If you manually code the Mule application in the Studio XML editor or another text editor, paste the following code inside the tag in your XML configuration: ```xml http://www.mulesoft.org/schema/mule/wss http://www.mulesoft.org/schema/mule/wss/current/mule-wss.xsd ``` This example shows how the namespace statements are placed in the `mule` XML block: ```xml ``` ## Add a POM File Dependency The `pom.xml` Apache Maven file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your POM file to enable access to this connector: ```xml org.mule.modules mule-wss-module 1.1.1 mule-plugin ``` To obtain the most up-to-date pom.xml file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `WSS Module`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/wss-module/1.1/wss-examples). ## See Also - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 1.2 --- # WSS Module XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you manually code a Mule application in XML either from the Studio XML editor or a text editor, you must perform the following actions to get access to a connector: Add the namespace for the connector to your XML flow. Add dependency information to your Maven `pom.xml` file. In the Studio visual editor, when you drag a connector from the Mule Palette to the canvas, Studio automatically populates the XML code with the connector namespace and schema location. ## Add a Namespace for the Connector If you manually code the Mule application in the Studio XML editor or another text editor, paste the following code inside the tag in your XML configuration: ```xml http://www.mulesoft.org/schema/mule/wss http://www.mulesoft.org/schema/mule/wss/current/mule-wss.xsd ``` This example shows how the namespace statements are placed in the `mule` XML block: ```xml ``` ## Add a POM File Dependency The `pom.xml` Apache Maven file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your POM file to enable access to this connector: ```xml org.mule.modules mule-wss-module 1.1.1 mule-plugin ``` To obtain the most up-to-date pom.xml file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `WSS Module`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/wss-module/1.2/wss-examples). ## See Also - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 2.0 --- # WSS Module XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you manually code a Mule application in XML either from the Studio XML editor or a text editor, you must perform the following actions to get access to a connector: Add the namespace for the connector to your XML flow. Add dependency information to your Maven `pom.xml` file. In the Studio visual editor, when you drag a connector from the Mule Palette to the canvas, Studio automatically populates the XML code with the connector namespace and schema location. ## Add a Namespace for the Connector If you manually code the Mule application in the Studio XML editor or another text editor, paste the following code inside the tag in your XML configuration: ```xml http://www.mulesoft.org/schema/mule/wss http://www.mulesoft.org/schema/mule/wss/current/mule-wss.xsd ``` This example shows how the namespace statements are placed in the `mule` XML block: ```xml ``` ## Add a POM File Dependency The `pom.xml` Apache Maven file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your POM file to enable access to this connector: ```xml org.mule.modules mule-wss-module 1.1.1 mule-plugin ``` To obtain the most up-to-date pom.xml file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `WSS Module`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/wss-module/2.0/wss-examples). ## See Also - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 2.1 --- # WSS Module XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you manually code a Mule application in XML either from the Studio XML editor or a text editor, you must perform the following actions to get access to a connector: Add the namespace for the connector to your XML flow. Add dependency information to your Maven `pom.xml` file. In the Studio visual editor, when you drag a connector from the Mule Palette to the canvas, Studio automatically populates the XML code with the connector namespace and schema location. ## Add a Namespace for the Connector If you manually code the Mule application in the Studio XML editor or another text editor, paste the following code inside the tag in your XML configuration: ```xml http://www.mulesoft.org/schema/mule/wss http://www.mulesoft.org/schema/mule/wss/current/mule-wss.xsd ``` This example shows how the namespace statements are placed in the `mule` XML block: ```xml ``` ## Add a POM File Dependency The `pom.xml` Apache Maven file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your POM file to enable access to this connector: ```xml org.mule.modules mule-wss-module 1.1.1 mule-plugin ``` To obtain the most up-to-date pom.xml file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `WSS Module`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/wss-module/2.1/wss-examples). ## See Also - [Salesforce Help](https://help.salesforce.com) --- product: WSS Module version: 2.2 is-latest-version: true --- # WSS Module XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you manually code a Mule application in XML either from the Studio XML editor or a text editor, you must perform the following actions to get access to a connector: Add the namespace for the connector to your XML flow. Add dependency information to your Maven `pom.xml` file. In the Studio visual editor, when you drag a connector from the Mule Palette to the canvas, Studio automatically populates the XML code with the connector namespace and schema location. ## Add a Namespace for the Connector If you manually code the Mule application in the Studio XML editor or another text editor, paste the following code inside the tag in your XML configuration: ```xml http://www.mulesoft.org/schema/mule/wss http://www.mulesoft.org/schema/mule/wss/current/mule-wss.xsd ``` This example shows how the namespace statements are placed in the `mule` XML block: ```xml ``` ## Add a POM File Dependency The `pom.xml` Apache Maven file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your POM file to enable access to this connector: ```xml org.mule.modules mule-wss-module 1.1.1 mule-plugin ``` To obtain the most up-to-date pom.xml file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `WSS Module`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/wss-module/latest/wss-examples). ## See Also - [Salesforce Help](https://help.salesforce.com)