axis2/java/rampart-staging/samples.html - axis-site - Git at Google

 <!DOCTYPE html>


 <!--
  | Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/xdoc/samples.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 Samples – 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><a href="quick-start.html">Getting Started</a></li>
     <li class="active"><a>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">


         <section><a id="Rampart_Samples"></a>
 <h1>Rampart Samples</h1>
         <section><a id="Basic_samples"></a>
 <h2> Basic samples </h2>

 <p>These samples use parameter based configuration model. This will be a great starting point to get a basic understanding of how WS Security really works.  </p>
         </section><section><a id="Policy_samples"></a>
 <h2> Policy samples </h2>

 <p>These samples use WS Security Policy Language for configuration. It is recommended to use policy based configuration model for all production scenarios </p>
         <section><a id="Running_Samples"></a>
 <h3>Running Samples</h3>

 <p>Before beginning, please install Rampart as described <a href="quick-start.html">here</a>.</p>

 <p>Now we'll look at how to run the first sample inside samples/policy folder.</p>

 <ol style="list-style-type: decimal;">

 <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>
         <br /></br>
         <br /></br>
         </section><section><a id="Samples"></a>
 <h3>Samples</h3>
         <br /></br>

 <table class="table table-striped">
             <tbody>

 <tr class="a a">
 <td>Sample 01</td></tr>

 <tr class="b"></tr>
            </tbody>
         </table>

 <div style="margin-left:2px;margin-right:-2px;">UsernameToken Authentication, The policy uses a TransportBinding and requires a SignedSupportingToken which
 is a UsernameToken and the inclusion of a TimeStamp. </div>

 <ul>

 <li><a href="samples/policy/sample01.xml">Policy</a></li>

 <li><a href="samples/msgs/req01.xml">Request Message</a></li>

 <li><a href="samples/msgs/res01.xml">Response Message</a></li>
         </ul>

         <br /></br>

 <table class="table table-striped">
             <tbody>

 <tr class="a a">
 <td>Sample 02</td></tr>

 <tr class="b"></tr>
            </tbody>
         </table>

 <div class="b" style="margin-left:2px;margin-right:-2px;">Sign only, An AsymmetricBinding is used. Entire headers and body to be signed.
 Algorithm suite is TripleDesRsa15.</div>

 <ul>

 <li><a href="samples/policy/sample02.xml">Policy</a></li>

 <li><a href="samples/msgs/req02.xml">Request Message</a></li>

 <li><a href="samples/msgs/res02.xml">Response Message</a></li>
         </ul>
         <br /></br>

 <table class="table table-striped">
             <tbody>

 <tr class="a a">
 <td>Sample 03</td></tr>

 <tr class="b"></tr>
            </tbody>
         </table>

 <div class="b" style="margin-left:2px;margin-right:-2px;">Sign and Encrypt messages, An AsymmetricBinding is used. Entire headers and body to be signed.
 EncryptionParts specifies the Body to be encrypted. </div>

 <ul>

 <li><a href="samples/policy/sample03.xml">Policy</a></li>

 <li><a href="samples/msgs/req03.xml">Request Message</a></li>

 <li><a href="samples/msgs/res03.xml">Response Message</a></li>
         </ul>
         <br /></br>

 <table class="table table-striped">
             <tbody>

 <tr class="a a">
 <td>Sample 04</td></tr>

 <tr class="b"></tr>
            </tbody>
         </table>

 <div class="b" style="margin-left:2px;margin-right:-2px;">SecureConversation , The secure session is bootstrapped using a SymetricBinding which uses derived keys based on an ephemeral key.
 Messages in the secure conversation includes a timestamp, all headers are signed along with the timestamp, signature encrypted and body encrypted.</div>

 <ul>

 <li><a href="samples/policy/sample04.xml">Policy</a></li>

 <li><a href="samples/msgs/rst04.xml">Bootstrap request (RST)</a></li>

 <li><a href="samples/msgs/rstr04.xml">Bootstrap response (RSTR)</a></li>

 <li><a href="samples/msgs/req04.xml">Request Message</a></li>

 <li><a href="samples/msgs/res04.xml">Response Message</a></li>

 <li><a href="samples/msgs/creq04.xml">Cancel request </a></li>

 <li><a href="samples/msgs/cres04.xml">Cancel response</a></li>
         </ul>
         <br /></br>

 <table class="table table-striped">
             <tbody>

 <tr class="a a">
 <td>Sample 05</td></tr>

 <tr class="b"></tr>
            </tbody>
         </table>

 <div class="b" style="margin-left:2px;margin-right:-2px;">WS-Trust - RST - Request Security Token Service - Issuing a SAML token - issuing a token </div>

 <ul>

 <li><a href="samples/policy/sample05.xml">Policy</a></li>

 <li><a href="samples/msgs/req05.xml">Request Message</a></li>

 <li><a href="samples/msgs/res05.xml">Response Message</a></li>
         </ul>
         <br /></br>

 <table class="table table-striped">
             <tbody>

 <tr class="a a">
 <td>Sample 06</td></tr>

 <tr class="b"></tr>
            </tbody>
         </table>

 <div class="b" style="margin-left:2px;margin-right:-2px;">WS-Trust ( With WS Metada Exchange) - RST - Request Security Token Service - Issuing a SAML token  </div>

 <ul>

 <li><a href="samples/policy/sample01.xml">Policy</a></li>

 <li><a href="samples/msgs/req06.xml">Request Message</a></li>

 <li><a href="samples/msgs/res06.xml">Response Message</a></li>
         </ul>
   </section></section>
          </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>
	<!DOCTYPE html>


	<!--
	\| Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/xdoc/samples.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 Samples – 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><a href="quick-start.html">Getting Started</a></li>
	<li class="active"><a>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">


	<section><a id="Rampart_Samples"></a>
	<h1>Rampart Samples</h1>
	<section><a id="Basic_samples"></a>
	<h2> Basic samples </h2>

	<p>These samples use parameter based configuration model. This will be a great starting point to get a basic understanding of how WS Security really works. </p>
	</section><section><a id="Policy_samples"></a>
	<h2> Policy samples </h2>

	<p>These samples use WS Security Policy Language for configuration. It is recommended to use policy based configuration model for all production scenarios </p>
	<section><a id="Running_Samples"></a>
	<h3>Running Samples</h3>

	<p>Before beginning, please install Rampart as described <a href="quick-start.html">here</a>.</p>

	<p>Now we'll look at how to run the first sample inside samples/policy folder.</p>

	<ol style="list-style-type: decimal;">

	<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>
	<br /></br>
	<br /></br>
	</section><section><a id="Samples"></a>
	<h3>Samples</h3>
	<br /></br>

	<table class="table table-striped">
	<tbody>

	<tr class="a a">
	<td>Sample 01</td></tr>

	<tr class="b"></tr>
	</tbody>
	</table>

	<div style="margin-left:2px;margin-right:-2px;">UsernameToken Authentication, The policy uses a TransportBinding and requires a SignedSupportingToken which
	is a UsernameToken and the inclusion of a TimeStamp. </div>

	<ul>

	<li><a href="samples/policy/sample01.xml">Policy</a></li>

	<li><a href="samples/msgs/req01.xml">Request Message</a></li>

	<li><a href="samples/msgs/res01.xml">Response Message</a></li>
	</ul>

	<br /></br>

	<table class="table table-striped">
	<tbody>

	<tr class="a a">
	<td>Sample 02</td></tr>

	<tr class="b"></tr>
	</tbody>
	</table>

	<div class="b" style="margin-left:2px;margin-right:-2px;">Sign only, An AsymmetricBinding is used. Entire headers and body to be signed.
	Algorithm suite is TripleDesRsa15.</div>

	<ul>

	<li><a href="samples/policy/sample02.xml">Policy</a></li>

	<li><a href="samples/msgs/req02.xml">Request Message</a></li>

	<li><a href="samples/msgs/res02.xml">Response Message</a></li>
	</ul>
	<br /></br>

	<table class="table table-striped">
	<tbody>

	<tr class="a a">
	<td>Sample 03</td></tr>

	<tr class="b"></tr>
	</tbody>
	</table>

	<div class="b" style="margin-left:2px;margin-right:-2px;">Sign and Encrypt messages, An AsymmetricBinding is used. Entire headers and body to be signed.
	EncryptionParts specifies the Body to be encrypted. </div>

	<ul>

	<li><a href="samples/policy/sample03.xml">Policy</a></li>

	<li><a href="samples/msgs/req03.xml">Request Message</a></li>

	<li><a href="samples/msgs/res03.xml">Response Message</a></li>
	</ul>
	<br /></br>

	<table class="table table-striped">
	<tbody>

	<tr class="a a">
	<td>Sample 04</td></tr>

	<tr class="b"></tr>
	</tbody>
	</table>

	<div class="b" style="margin-left:2px;margin-right:-2px;">SecureConversation , The secure session is bootstrapped using a SymetricBinding which uses derived keys based on an ephemeral key.
	Messages in the secure conversation includes a timestamp, all headers are signed along with the timestamp, signature encrypted and body encrypted.</div>

	<ul>

	<li><a href="samples/policy/sample04.xml">Policy</a></li>

	<li><a href="samples/msgs/rst04.xml">Bootstrap request (RST)</a></li>

	<li><a href="samples/msgs/rstr04.xml">Bootstrap response (RSTR)</a></li>

	<li><a href="samples/msgs/req04.xml">Request Message</a></li>

	<li><a href="samples/msgs/res04.xml">Response Message</a></li>

	<li><a href="samples/msgs/creq04.xml">Cancel request </a></li>

	<li><a href="samples/msgs/cres04.xml">Cancel response</a></li>
	</ul>
	<br /></br>

	<table class="table table-striped">
	<tbody>

	<tr class="a a">
	<td>Sample 05</td></tr>

	<tr class="b"></tr>
	</tbody>
	</table>

	<div class="b" style="margin-left:2px;margin-right:-2px;">WS-Trust - RST - Request Security Token Service - Issuing a SAML token - issuing a token </div>

	<ul>

	<li><a href="samples/policy/sample05.xml">Policy</a></li>

	<li><a href="samples/msgs/req05.xml">Request Message</a></li>

	<li><a href="samples/msgs/res05.xml">Response Message</a></li>
	</ul>
	<br /></br>

	<table class="table table-striped">
	<tbody>

	<tr class="a a">
	<td>Sample 06</td></tr>

	<tr class="b"></tr>
	</tbody>
	</table>

	<div class="b" style="margin-left:2px;margin-right:-2px;">WS-Trust ( With WS Metada Exchange) - RST - Request Security Token Service - Issuing a SAML token </div>

	<ul>

	<li><a href="samples/policy/sample01.xml">Policy</a></li>

	<li><a href="samples/msgs/req06.xml">Request Message</a></li>

	<li><a href="samples/msgs/res06.xml">Response Message</a></li>
	</ul>
	</section></section>
	</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>