Author: nandana
Date: Mon Jun 23 07:34:59 2008
New Revision: 670633
URL: http://svn.apache.org/viewvc?rev=670633&view=rev
Log:
Giving Rampart site a new look :)
Modified:
webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/quick-start.xml
Modified:
webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/quick-start.xml
URL:
http://svn.apache.org/viewvc/webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/quick-start.xml?rev=670633&r1=670632&r2=670633&view=diff
==============================================================================
---
webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/quick-start.xml
(original)
+++
webservices/rampart/trunk/java/modules/documentation/src/site/xdoc/quick-start.xml
Mon Jun 23 07:34:59 2008
@@ -3,94 +3,35 @@
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd";>
<html xmlns="http://www.w3.org/1999/xhtml";>
<head>
- <title>Apache Rampart - Source Repository</title>
</head>
<body>
- <h2>Rampart Quick Start Guide</h2>
+ <h1>Rampart Quick Start Guide</h1>
- <h3>Installing Rampart in Axis2</h3>
+ <h3>Installing Rampart module in Axis2</h3>
<p>Steps to install</p>
<ol>
<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 "samples" directory to copy the
required libraries and modules to relevant directories in AXIS2_HOME.</li>
- <li>Download xalan-2.7.0.jar from <a
href="http://www.apache.org/dist/java-repository/xalan/jars/";>here</a> and put
under AXIS2_HOME\lib folder, if you use JDK 1.5.</li>
- <li>Download log4j.jar from <a
href="http://people.apache.org/repo/m1-ibiblio-rsync-repository/log4j/jars/";>here</a>
and put under AXIS2_HOME\lib</li>
</ol>
<p></p>
- <h3>Running Samples</h3>
- <p>Now we'll look at how to run the first sample inside
samples/policy folder.</p>
- <ol>
- <li>Open a console and change the directory to
sample/policy and give the following command. This will start the server at
port 8080</li>
- <pre>
-<code>$ant service.01</code>
- </pre>
- <li>Open a new console and change the directory to
sample/policy and type the following command.</li>
- <pre>
-<code>$ant client.01</code>
- </pre>
- </ol>
- <p>Congratulations! Now you have executed the first sample.
Rest of the samples can be run by changing the sample number.</p>
- <h3>Understanding the first sample</h3>
-
- <ul>
- <li>Engaging Rampart</li>
- </ul>
+ <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);<br/>
-client.engageModule("rampart");
-</pre>
- <ul>
- <li>Understanding policy</li>
- </ul>
+ ServiceClient client = new ServiceClient(ctx, null);<br/>
+ client.engageModule("rampart");
+ </pre>
+ <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>
- <ul>
- <li>Viewing the Message on wire</li>
- </ul>
+ <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>
- <h3>Setting up a Security Token Service</h3>
- <p>Security Token Service can be set up as per WS-Trust
specification using Rampart. The default security token service shipped with
the rampart distribution is contained in the rampart-trust.mar module. It can
issue SCT tokens and SAML tokens. Sample05 contains a client that connects to
the default STS and obtain a SAML token. The services.xml in the sample
contains "saml-issuer-config" parameter that is used to configure the default
SAML issuer.</p>
- <strong>STS with a custom issuer</strong>
- <p>First the default rampart.mar has to be removed from the
modules. Then write you own issuer implementing the
<code>"org.apache.rahas.TokenIssuer"</code> interface. Let's say that your
issuer is <code>"org.custom.MyIssuer"</code>. Then create a Axis2 service
archive with the following in the services.xml. Drop the archive into the
repository and you have a STS with a CustomToken issuer.</p>
-
- <pre>
-
-<module ref="rampart" />
-
-<operation name="IssueToken"
- mep="http://www.w3.org/2006/01/wsdl/in-out">
- <messageReceiver
- class="org.apache.rahas.STSMessageReceiver"/>
-
- <!-- Action mapping to accept RST requests -->
-
<actionMapping>http://schemas.xmlsoap.org/ws/2005/02/trust/RST/SCT</actionMapping>
-
<actionMapping>http://schemas.xmlsoap.org/ws/2005/02/trust/RST/Issue</actionMapping>
-
<actionMapping>http://schemas.xmlsoap.org/ws/2005/02/trust/RST/Renew</actionMapping>
-
<actionMapping>http://schemas.xmlsoap.org/ws/2005/02/trust/RST/Cancel</actionMapping>
-
<actionMapping>http://schemas.xmlsoap.org/ws/2005/02/trust/RST/SCT/Cancel</actionMapping>
-
<actionMapping>http://schemas.xmlsoap.org/ws/2005/02/trust/RST/Validate</actionMapping>
-
- <parameter name="token-dispatcher-configuration">
- <token-dispatcher-configuration>
- <!-- Issuers. You may have many issuers. -->
- <issuer class="org.custom.MyIssuer" default="true">
- <configuration
-
type="parameter">saml-issuer-config</configuration>
-
<tokenType>http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1</tokenType>
- </issuer>
- </token-dispatcher-configuration>
- </parameter>
-
-</operation>
-</pre>
</body>
</html>
