Title: WS-Security in ODE
Category: documentation

<a name="WS-SecurityinODE-HowtouseWS-SecurityinODE?"></a>
## How to use WS-Security in ODE?

[TOC]

<div class="alert alert-warning"><h4 class="alert-heading">Only in 1.3.2+</h4></div>

ODE 1.3.2 introduces support for WS-Security: secure services can now be invoked from a process, and the process service itself might be secured. A first part will explain how to invoke a secured service, a second part how to secure the process service.

ODE has an [Integration Layer based on Axis2](/developerguide/architectural-overview.html#ODE-Integration-Layers) so using Rampart, the Axis2 security modules, goes without saying. As a result this section will only focus on Rampart integration. Rampart and WS-Security specifications won't be detailed here. Please refer to their ad-hoc documentations for further details.

### Quick Rampart introduction

As any other Axis2 module, Rampart is configurable with [Axis2 Service configuration files](http://ws.apache.org/axis2/1_0/axis2config.html#Service_Configuration). For instance a service.xml document, using the parameter based configuration model, might be:

    :::xml
    <service>

        <module ref="rampart" />

        <parameter name="OutflowSecurity">
          <action>
            <items>Timestamp Signature</items>
            <user>client</user>
            <signaturePropFile>TestRampartBasic/secured-services/client.properties</signaturePropFile>
            <passwordCallbackClass>org.apache.rampart.samples.sample04.PWCBHandler</passwordCallbackClass>
            <signatureKeyIdentifier>DirectReference</signatureKeyIdentifier>
          </action>
        </parameter>

        <parameter name="InflowSecurity">
          <action>
            <items>Timestamp Signature</items>
            <signaturePropFile>TestRampartBasic/secured-services/client.properties</signaturePropFile>
          </action>
        </parameter>

     </service>


Another example using WS-Security Policy based configuration model is listed below. See the full document [here](http://svn.apache.org/viewvc/ode/branches/APACHE_ODE_1.X/axis2-war/src/test/resources/TestRampartPolicy/secured-services/process-sample04_policy_in_service.xml/sample04-policy.axis2?view=markup).

    :::xml
    <service>

        <module ref="rampart"/>

        <wsp:Policy wsu:Id="SecConvPolicy2" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
            <wsp:ExactlyOne>
                <wsp:All>
                    <sp:SymmetricBinding xmlns:sp="http://schemas.xmlsoap.org/ws/2005/07/securitypolicy">
                        <wsp:Policy>
                                 <!-- truncated, see original document ny following the link above -->
                        </wsp:Policy>
                    </sp:SymmetricBinding>
                    <sp:Wss11 xmlns:sp="http://schemas.xmlsoap.org/ws/2005/07/securitypolicy">
                        <wsp:Policy>
                                 <!-- truncated, see original document ny following the link above -->
                        </wsp:Policy>
                    </sp:Wss11>
                    <sp:Trust10 xmlns:sp="http://schemas.xmlsoap.org/ws/2005/07/securitypolicy">
                        <wsp:Policy>
                                 <!-- truncated, see original document ny following the link above -->
                        </wsp:Policy>
                    </sp:Trust10>
                    <sp:EncryptedParts xmlns:sp="http://schemas.xmlsoap.org/ws/2005/07/securitypolicy">
                        <sp:Body/>
                    </sp:EncryptedParts>
                    <ramp:RampartConfig xmlns:ramp="http://ws.apache.org/rampart/policy">
                        <ramp:user>client</ramp:user>
                        <ramp:encryptionUser>service</ramp:encryptionUser>
                        <ramp:passwordCallbackClass>org.apache.rampart.samples.policy.sample04.PWCBHandler</ramp:passwordCallbackClass>

                        <ramp:signatureCrypto>
                            <ramp:crypto provider="org.apache.ws.security.components.crypto.Merlin">
                                <ramp:property name="org.apache.ws.security.crypto.merlin.keystore.type">JKS</ramp:property>
                                <ramp:property name="org.apache.ws.security.crypto.merlin.file">TestRampartPolicy/secured-services/client.jks</ramp:property>
                                <ramp:property name="org.apache.ws.security.crypto.merlin.keystore.password">apache</ramp:property>
                            </ramp:crypto>
                        </ramp:signatureCrypto>
                        <ramp:encryptionCypto>
                            <ramp:crypto provider="org.apache.ws.security.components.crypto.Merlin">
                                <ramp:property name="org.apache.ws.security.crypto.merlin.keystore.type">JKS</ramp:property>
                                <ramp:property name="org.apache.ws.security.crypto.merlin.file">TestRampartPolicy/secured-services/client.jks</ramp:property>
                                <ramp:property name="org.apache.ws.security.crypto.merlin.keystore.password">apache</ramp:property>
                            </ramp:crypto>
                        </ramp:encryptionCypto>

                    </ramp:RampartConfig>
                </wsp:All>
            </wsp:ExactlyOne>
        </wsp:Policy>

    </service>

The important thing to notice is that these documents are plain [Axis2 Service configuration files](http://ws.apache.org/axis2/1_0/axis2config.html#Service_Configuration). And as explained in the [ODE User Guide](endpoint-configuration.html#Additional-Configuration-for-SOAP-Endpoints), a mechanism to handle these files already exists. So all we have to do is reuse this mechanism, the rest is pure Rampart configuration.

Let's take an example and see the actual required steps.

### How to invoke a secure web service?

#### Prepare your service document
Assuming your process needs to invoke the secure service {http://sample03.policy.samples.rampart.apache.org}Sample03, the _first step_ is to prepare a service document named ${process_bundle_dir}/Sample03.axis2 and containing your desired Rampart configuration.

The _second step_ is to to make sure the resources needed to invoke the services are available to Rampart through ODE webapp classpath. Typical resources are:

* password callback handler classes
* Java keystores
* property files containing keystore information

#### Add resources to ODE webapp classpath
How you add these resources to ODE classpath might vary depending on your application server, your global architecture or other criteria. So it's up to you to figure this out. However typical locations are:

* ode/WEB-INF/classes
* ode/WEB-INF/lib

#### An alternative for WS-Security Policies
If you're using the policy base configuration model, an alternative is available to you: use the [endpoint property mechanism](endpoint-configuration.html) to attach the policy to the service. In that configuration, ODE will engage the Rampart module and load the policy when the service is invoked.

To do so:

* save the Policy document (not the service document) in the file of your choice. For instance mypolicy.xml
* create an endpoint file linking the service and the policy file. Basically with the two properties listed below. Note that if the path assigned to the "security.policy.file" property is relative it will be resolved against the process bundle directory. Of course if the path is absolute, it will be used as is.

<!-- let markdown notice that the list block is finished -->

    :::properties
    alias.sample03-ns=http://sample03.policy.samples.rampart.apache.org
    sample03-ns.sample03-policy.ode.security.policy.file=mypolicy.xml

### How to secure the web service exposed by a process?

Applying security to a process service is no different from invoking a secured service. If the process service you're exposing is {http://mycompany.com}AbscenceRequest. All you have to do is prepare a service document named ${process_bundle_dir}/AbscenceRequest.axis2 and containing your Rampart configuration. Once again, it's up to you to add the required resources in ODE webapp classpath.

You can also use the property 'security.policy.file' to secure the process service.

### Do I need to install Rampart myself?

No. ODE comes with the following Axis2 modules (and the jars they depend on): Rampart, Rahas and Addressing.

### Useful resources

#### Rampart material
* the [list](http://wso2.org/projects/rampart/java) of Web Services Security specifications supported by Rampart
* [Rampart articles](http://ws.apache.org/rampart/articles.html)
* [Rampart samples](http://ws.apache.org/rampart/samples.html)
* [a Rampart tutorial](https://wiki.internet2.edu/confluence/display/GrouperWG/The+Newcastle+University+Grouper+page)

### ODE test cases

#### How to run them

    :::text
    $ cd axis2-war
    $ buildr test:Secure

#### Where are the processes executed by the unit tests?

The executed processes are generated by the build, so run the tests once, then look into the following directories. Process directories are prefixed with "process-".

* axis2-war/target/test-classes/TestRampartPolicy/secured-services/
* axis2-war/target/test-classes/TestRampartPolicy/secured-processes/
* axis2-war/target/test-classes/TestRampartBasic/secured-services/
* axis2-war/target/test-classes/TestRampartBasic/secured-processes/

#### the nitty-gritty details

The integration with Rampart described in this section is tested with a decent suite of unit tests. These unit tests are based on the [Rampart samples](http://ws.apache.org/rampart/samples.html). The [related resources](http://svn.apache.org/repos/asf/webservices/rampart/branches/java/1_3/modules/rampart-samples/) were imported into ODE repository.

These tests are divided into two parts: tests using the parameter base configuration model aka "basic tests" and tests using the policy base configuration model aka "policy tests".

ODE test cases reuse these test cases in two different scenarii:

* the security configuration is applied to an "external" web service, and a ODE process invokes it.
* the security configuration is applied to the web service exposed by a process.

These partitions lead to four resource directories:

* [TestRampartBasic/secured-services](http://svn.apache.org/viewvc/ode/branches/APACHE_ODE_1.X/axis2-war/src/test/resources/TestRampartBasic/secured-services/)
* [TestRampartBasic/secured-processes](http://svn.apache.org/viewvc/ode/branches/APACHE_ODE_1.X/axis2-war/src/test/resources/TestRampartBasic/secured-processes/)

* [TestRampartPolicy/secured-services](http://svn.apache.org/viewvc/ode/branches/APACHE_ODE_1.X/axis2-war/src/test/resources/TestRampartPolicy/secured-services/)
* [TestRampartPolicy/secured-processes](http://svn.apache.org/viewvc/ode/branches/APACHE_ODE_1.X/axis2-war/src/test/resources/TestRampartPolicy/secured-processes/)

Everything describes for TestRampartBasic applies to TestRampartPolicy. So for now on we will mention only TestRampartBasic.

For the "secured-services" scenario, the "external" web services are Axis [archives](http://svn.apache.org/viewvc/ode/branches/APACHE_ODE_1.X/axis2-war/src/test/resources/TestRampartBasic/secured-services/services/) deployed in an Axis2 webapp.

The corresponding unit test classes are [SecuredServicesTest.java and SecuredProcessTest.java](http://svn.apache.org/viewvc/ode/branches/APACHE_ODE_1.X/axis2-war/src/test/java/org/apache/ode/axis2/rampart/basic/). Each test class will start a list of processes that must succeed (as many processes as Rampart samples actually).

To avoid duplication these processes are generated by the build based on two process templates: [one](http://svn.apache.org/viewvc/ode/branches/APACHE_ODE_1.X/axis2-war/src/test/resources/TestRampartBasic/secured-services/process-template/) for the secured-services case, [another](http://svn.apache.org/viewvc/ode/branches/APACHE_ODE_1.X/axis2-war/src/test/resources/TestRampartBasic/secured-processes/process-template/) for the secured-processes case.

The build generates processes into:

* axis2-war/target/test-classes/TestRampartPolicy/secured-services/process-*
* axis2-war/target/test-classes/TestRampartPolicy/secured-processes/process-*
* axis2-war/target/test-classes/TestRampartBasic/secured-services/process-*
* axis2-war/target/test-classes/TestRampartBasic/secured-processes/process-*