| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/xdoc/quick-start.xml at 01 Dec 2024 |
| | Rendered using Apache Maven Fluido Skin 2.0.0-M11 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> |
| <title>Apache Rampart</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-2.0.0-M11.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script src="./js/apache-maven-fluido-2.0.0-M11.min.js"></script> |
| </head> |
| <body> |
| <div class="container-fluid container-fluid-top"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h1><img class="class java.lang.Object" src="images/apache-rampart-logo.jpg" /></h1></div></div> |
| <div class="pull-right"><div id="bannerRight"><h1><a href="http://www.apache.org"><img class="class java.lang.Object" src="http://www.apache.org/images/asf_logo_wide.png" /></a></h1></div></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 01 Dec 2024<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 1.8.0</li> |
| <li class="pull-right"><a href="../core/">Apache Axis2/Java</a></li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Apache Rampart</li> |
| <li><a href="index.html">Home</a></li> |
| <li><a href="javascript:void(0)"><span class="icon-chevron-down"></span>Downloads</a> |
| <ul class="nav nav-list"> |
| <li><a href="download.html">Releases</a></li> |
| </ul></li> |
| <li><a href="javascript:void(0)"><span class="icon-chevron-down"></span>Release Notes</a> |
| <ul class="nav nav-list"> |
| <li><a href="release-notes/1.6.1.html">1.6.1</a></li> |
| <li><a href="release-notes/1.6.2.html">1.6.2</a></li> |
| <li><a href="release-notes/1.6.3.html">1.6.3</a></li> |
| <li><a href="release-notes/1.6.4.html">1.6.4</a></li> |
| <li><a href="release-notes/1.7.0.html">1.7.0</a></li> |
| <li><a href="release-notes/1.8.0.html">1.8.0</a></li> |
| </ul></li> |
| <li class="nav-header">Documentation</li> |
| <li class="active"><a>Getting Started</a></li> |
| <li><a href="samples.html">Samples</a></li> |
| <li><a href="http://wiki.apache.org/ws/FrontPage/Rampart/FAQ" class="externalLink">FAQ</a></li> |
| <li><a href="rampartconfig-guide.html">Rampart Configuration</a></li> |
| <li><a href="setting-up-sts.html">STS Configuration</a></li> |
| <li><a href="developer-guide.html">Developer Guide</a></li> |
| <li class="nav-header">Resources</li> |
| <li><a href="articles.html">Articles</a></li> |
| <li><a href="specifications.html">Specifications</a></li> |
| <li><a href="apidocs/index.html">Online Javadocs</a></li> |
| <li class="nav-header">Project Information</li> |
| <li><a href="team.html">Project Team</a></li> |
| <li><a href="http://issues.apache.org/jira/browse/Rampart" class="externalLink">Issue Tracking</a></li> |
| <li><a href="mailing-lists.html">Mailing Lists</a></li> |
| <li><a href="https://github.com/apache/axis-axis2-java-rampart" class="externalLink">Source Code</a></li> |
| <li><a href="http://www.apache.org/licenses/" class="externalLink">License</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsorship</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a></li> |
| <li><a href="http://www.apache.org/security/" class="externalLink">Security</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| |
| <section><a id="Rampart_Quick_Start_Guide"></a> |
| <h1>Rampart Quick Start Guide</h1> |
| |
| <section><section><a id="Installing_Rampart_module_in_Axis2"></a> |
| <h3>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> |
| |
| </section><section><a id="Engaging_Rampart"></a> |
| <h3>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> |
| |
| <pre> |
| ServiceClient client = new ServiceClient(ctx, null); |
| client.engageModule("rampart"); |
| </pre> |
| </section><section><a id="Understanding_policy"></a> |
| <h3>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> |
| |
| </section><section><a id="Viewing_the_Message_on_wire"></a> |
| <h3>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> |
| |
| |
| |
| </section></section> |
| </html> </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>© 2005–2024 |
| <a href="http://www.apache.org">Apache Software Foundation</a> |
| </p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
