| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia at 30 Jul 2017 |
| | Rendered using Apache Maven Fluido Skin 1.4 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="Date-Revision-yyyymmdd" content="20170730" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Apache Rampart – </title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.4.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| |
| |
| <script type="text/javascript" src="./js/apache-maven-fluido-1.4.min.js"></script> |
| |
| |
| </head> |
| <body class="topBarDisabled"> |
| |
| |
| |
| <div class="container-fluid"> |
| <div id="banner"> |
| <div class="pull-left"> |
| <div id="bannerLeft"> |
| <img src="images/apache-rampart-logo.jpg" /> |
| </div> |
| </div> |
| <div class="pull-right"> <a href="http://www.apache.org" id="bannerRight"> |
| <img src="http://www.apache.org/images/asf_logo_wide.png" /> |
| </a> |
| </div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| |
| |
| <li id="publishDate">Last Published: 30 Jul 2017 |
| <span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 1.7.1 |
| </li> |
| |
| |
| |
| |
| |
| <li class="pull-right"> |
| <a href="../core/" title="Apache Axis2/Java"> |
| Apache Axis2/Java</a> |
| </li> |
| |
| </ul> |
| </div> |
| |
| |
| <div class="row-fluid"> |
| <div id="leftColumn" class="span2"> |
| <div class="well sidebar-nav"> |
| |
| |
| <ul class="nav nav-list"> |
| <li class="nav-header">Apache Rampart</li> |
| |
| <li> |
| |
| <a href="index.html" title="Home"> |
| <span class="none"></span> |
| Home</a> |
| </li> |
| |
| <li> |
| |
| <a href="javascript:void(0)" title="Downloads"> |
| <span class="icon-chevron-down"></span> |
| Downloads</a> |
| <ul class="nav nav-list"> |
| |
| <li> |
| |
| <a href="download.html" title="Releases"> |
| <span class="none"></span> |
| Releases</a> |
| </li> |
| |
| <li> |
| |
| <a href="svn.html" title="Source Code"> |
| <span class="none"></span> |
| Source Code</a> |
| </li> |
| </ul> |
| </li> |
| |
| <li> |
| |
| <a href="javascript:void(0)" title="Release Notes"> |
| <span class="icon-chevron-down"></span> |
| Release Notes</a> |
| <ul class="nav nav-list"> |
| |
| <li> |
| |
| <a href="release-notes/1.6.1.html" title="1.6.1"> |
| <span class="none"></span> |
| 1.6.1</a> |
| </li> |
| |
| <li> |
| |
| <a href="release-notes/1.6.2.html" title="1.6.2"> |
| <span class="none"></span> |
| 1.6.2</a> |
| </li> |
| |
| <li> |
| |
| <a href="release-notes/1.6.3.html" title="1.6.3"> |
| <span class="none"></span> |
| 1.6.3</a> |
| </li> |
| |
| <li> |
| |
| <a href="release-notes/1.6.4.html" title="1.6.4"> |
| <span class="none"></span> |
| 1.6.4</a> |
| </li> |
| |
| <li> |
| |
| <a href="release-notes/1.7.0.html" title="1.7.0"> |
| <span class="none"></span> |
| 1.7.0</a> |
| </li> |
| |
| <li> |
| |
| <a href="release-notes/1.7.1.html" title="1.7.1"> |
| <span class="none"></span> |
| 1.7.1</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-header">Documentation</li> |
| |
| <li class="active"> |
| |
| <a href="#"><span class="none"></span>Getting Started</a> |
| </li> |
| |
| <li> |
| |
| <a href="samples.html" title="Samples"> |
| <span class="none"></span> |
| Samples</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://wiki.apache.org/ws/FrontPage/Rampart/FAQ" class="externalLink" title="FAQ"> |
| <span class="none"></span> |
| FAQ</a> |
| </li> |
| |
| <li> |
| |
| <a href="rampartconfig-guide.html" title="Rampart Configuration"> |
| <span class="none"></span> |
| Rampart Configuration</a> |
| </li> |
| |
| <li> |
| |
| <a href="setting-up-sts.html" title="STS Configuration"> |
| <span class="none"></span> |
| STS Configuration</a> |
| </li> |
| |
| <li> |
| |
| <a href="developer-guide.html" title="Developer Guide"> |
| <span class="none"></span> |
| Developer Guide</a> |
| </li> |
| |
| <li> |
| |
| <a href="siteHowTo.html" title="Build the Site"> |
| <span class="none"></span> |
| Build the Site</a> |
| </li> |
| <li class="nav-header">Resources</li> |
| |
| <li> |
| |
| <a href="articles.html" title="Articles"> |
| <span class="none"></span> |
| Articles</a> |
| </li> |
| |
| <li> |
| |
| <a href="specifications.html" title="Specifications"> |
| <span class="none"></span> |
| Specifications</a> |
| </li> |
| |
| <li> |
| |
| <a href="apidocs/index.html" title="Online Javadocs"> |
| <span class="none"></span> |
| Online Javadocs</a> |
| </li> |
| <li class="nav-header">Project Information</li> |
| |
| <li> |
| |
| <a href="team-list.html" title="Project Team"> |
| <span class="none"></span> |
| Project Team</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://issues.apache.org/jira/browse/Rampart" class="externalLink" title="Issue Tracking"> |
| <span class="none"></span> |
| Issue Tracking</a> |
| </li> |
| |
| <li> |
| |
| <a href="mail-lists.html" title="Mailing Lists"> |
| <span class="none"></span> |
| Mailing Lists</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://svn.apache.org/viewvc/axis/axis2/java/rampart/" class="externalLink" title="Source Code"> |
| <span class="none"></span> |
| Source Code</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/licenses/" class="externalLink" title="License"> |
| <span class="none"></span> |
| License</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship"> |
| <span class="none"></span> |
| Sponsorship</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"> |
| <span class="none"></span> |
| Thanks</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/security/" class="externalLink" title="Security"> |
| <span class="none"></span> |
| Security</a> |
| </li> |
| </ul> |
| |
| |
| |
| <hr /> |
| |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /> |
| </a> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="bodyColumn" class="span10" > |
| |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| |
| |
| <h1>Rampart Quick Start Guide</h1> |
| |
| |
| <div class="section"> |
| <h3><a name="Installing_Rampart_module_in_Axis2"></a>Installing Rampart module in Axis2</h3> |
| |
| <p>Steps to install</p> |
| |
| <ol style="list-style-type: decimal"> |
| |
| <li>If you haven't installed Axis2, then download and extract the standard binary distribution. Make sure you have set the AXIS2_HOME environment variable</li> |
| |
| <li>Run ant from the top level directory of the Rampart distribution to copy the required libraries and modules to relevant directories in AXIS2_HOME.</li> |
| </ol> |
| |
| <p></p> |
| |
| </div> |
| <div class="section"> |
| <h3><a name="Engaging_Rampart"></a>Engaging Rampart</h3> |
| |
| <p>When securing a SOAP message, the sender must know the security actions to be performed on the message and the receiver must know enough details to process and validate the security of the message. Therefore when using Rampart with Axis2, it must be engaged at both ends.</p> |
| |
| <p>Observe how module has been engaged in server side by opening samples/policy/sample01/services.xml. The following line has engaged the module.</p> |
| |
| <p>Engaging Rampart at client side is done programatically as follows.</p> |
| |
| <div> |
| <pre> |
| ServiceClient client = new ServiceClient(ctx, null); |
| client.engageModule("rampart"); |
| </pre></div> |
| </div> |
| <div class="section"> |
| <h3><a name="Understanding_policy"></a>Understanding policy</h3> |
| |
| <p>WS-Security Policy can be used to indicate what security actions that needs be performed on SOAP messages and and what actions should be validated. The file 'samples/policy/sample01/policy.xml' configures Rampart to add Username Token with Timestamp to this message. The element <RampartConfig> in policy.xml defines Rampart specific configurations. </p> |
| |
| <p>Policy at serverside is included in samples/policy/sample01/services.xml file. This configures Rampart module at serverside to validate the message for Username Token an Timestamp.</p> |
| |
| <p>More details on RampartConfig can be found <a href="rampartconfig-guide.html">here</a>.</p> |
| |
| </div> |
| <div class="section"> |
| <h3><a name="Viewing_the_Message_on_wire"></a>Viewing the Message on wire</h3> |
| |
| <p>It is interesting to view the secured SOAP message on the wire using TCP monitor. Change the "client.port" property in samples/policy/build.xml file to the listening port of TCP monitor. This will send all the messages through TCP monitor when you execute the ant script. Observe the <wsse:Security> header in the SOAP message.</p> |
| |
| |
| |
| </div> |
| </html> |
| </div> |
| </div> |
| </div> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p >Copyright © 2005–2017 |
| <a href="http://www.apache.org">Apache Software Foundation</a>. |
| All rights reserved. |
| |
| </p> |
| </div> |
| |
| |
| </div> |
| </footer> |
| </body> |
| </html> |
