You are viewing a plain text version of this content. The canonical link for it is here.
Posted to rampart-dev@ws.apache.org by ka...@apache.org on 2007/05/08 14:13:02 UTC
svn commit: r536170 - in /webservices/rampart/trunk/c/xdocs/docs: ./
index.html installationguide.html rampartc_manual.html
Author: kaushalye
Date: Tue May 8 05:13:01 2007
New Revision: 536170
URL: http://svn.apache.org/viewvc?view=rev&rev=536170
Log:
Adding docs directory and related files in Rampart/C site
Added:
webservices/rampart/trunk/c/xdocs/docs/
webservices/rampart/trunk/c/xdocs/docs/index.html
webservices/rampart/trunk/c/xdocs/docs/installationguide.html
webservices/rampart/trunk/c/xdocs/docs/rampartc_manual.html
Added: webservices/rampart/trunk/c/xdocs/docs/index.html
URL: http://svn.apache.org/viewvc/webservices/rampart/trunk/c/xdocs/docs/index.html?view=auto&rev=536170
==============================================================================
--- webservices/rampart/trunk/c/xdocs/docs/index.html (added)
+++ webservices/rampart/trunk/c/xdocs/docs/index.html Tue May 8 05:13:01 2007
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+ <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
+ <title>Documentation</title>
+</head>
+
+<body>
+<h1>Apache Rampart/C Documentation</h1>
+
+<h2>Getting Started</h2>
+<ul>
+ <li><a href="installationguide.html">Installation Guide</a></li>
+</ul>
+
+<h2>Manual</h2>
+<ul>
+<li><a href="rampartc_manual.html">Rampart/C Manual</a></li>
+</ul>
+
+<h2>Additional References</h2>
+<ul>
+ <li><a href="http://ws.apache.org/axis2/c/index.html">Apache Axis2/C</a></li>
+ <li><a href="http://ws.apache.org/axis2/c/docs/om_tutorial.html">AXIOM Tutorial</a></li>
+ <li><a href="http://ws.apache.org/axis2/c/coding_conventions.html">Coding Conventions in Axis2/C</a></li>
+</ul>
+
+</body>
+</html>
Added: webservices/rampart/trunk/c/xdocs/docs/installationguide.html
URL: http://svn.apache.org/viewvc/webservices/rampart/trunk/c/xdocs/docs/installationguide.html?view=auto&rev=536170
==============================================================================
--- webservices/rampart/trunk/c/xdocs/docs/installationguide.html (added)
+++ webservices/rampart/trunk/c/xdocs/docs/installationguide.html Tue May 8 05:13:01 2007
@@ -0,0 +1,218 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html>
+<head>
+ <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
+ <title>Installation Guide</title>
+</head>
+
+<body>
+<h1>Apache Rampart/C Installation Guide</h1>
+
+<p>This document guides you on how to install Rampart/C.</p>
+<p>You must have <a href="http://www.openssl.org">OpenSSL</a> installed in you system.</p>
+<p>This release comes in two forms, source and binary. This document covers
+both forms.</p>
+
+<p>Please send your feedback to the developer mailing list: <a
+href="mailto:rampart-c-dev@ws.apache.org">rampart-c-dev@ws.apache.org</a>
+(Subscription details are available on the <a
+href="http://ws.apache.org/rampart/c/mail-lists.html">Rampart site</a>.</p>
+
+<h2>Contents</h2>
+<ul>
+ <li><a href="#linux">Installing and Running on Linux</a>
+ <ul>
+ <li><a href="#linux_binary">Using the Binary Release</a></li>
+ <li><a href="#linux_source">Using the Source Release</a></li>
+ </ul>
+ </li>
+ <li><a href="#win">Installing and Running on Microsoft Windows (win32)</a>
+ <ul>
+ <li><a href="#win_binary">Using the Binary Release</a></li>
+ <li><a href="#win_source">Using the Source Release</a></li>
+ </ul>
+ </li>
+ <li><a href="#engage">Engage Rampart/C with Axis2/C</a></li>
+ </li>
+</ul>
+<a id="linux"></a>
+
+<h2>1. Installing and Running on Linux</h2>
+
+<p>This can be done using binary or source distributions. (<a
+href="http://ws.apache.org/rampart/c/download.cgi">Download</a> the two
+distributions)</p>
+
+<a id="linux_binary"/>
+
+<h3>1.1. Installing the Binary Distribution</h3>
+
+<p>The following steps have to be followed to install and run the Rampart/C
+binary distribution on Linux : </p>
+<ol>
+ <li>Extract the binary tar package to a folder.</li>
+ <li>Set the AXIS2C_HOME environment variable pointing to the location where
+ you have extracted Axis2/C
+ <ul>
+ <li>AXIS2C_HOME='/your_path_to_axis2c'</li>
+ <li>export AXIS2C_HOME</li>
+ </ul>
+ </li>
+ <li>Copy modules/rampart to $AXIS2C_HOME/modules
+ <li>Engage Rampart/C as specified in the section <a href="#engage">Engage Rampart/C with Axis2/C</a>
+ <li>Start the server and run the client to consume the secured service
+</ol>
+<a id="linux_source"></a>
+
+<h3>1.2. Installing the Source Distribution</h3>
+
+<p>The following steps have to be followed to install and run Rampart/C using
+the source distribution on Linux :</p>
+<ol>
+ <li>Extract the source tar package to a folder.</li>
+ <li>Set the AXIS2C_HOME environment variable pointing to the location where
+ you want to install Axis2/C
+ <ul>
+ <li>AXIS2C_HOME='/your_desired_path_to_axis2c_installation'</li>
+ <li>export AXIS2C_HOME</li>
+ </ul>
+ </li>
+ <li>Then go to the folder where you extracted the source.
+ </li>
+ <li>Build the source
+ <ul>
+ <li>This can be done using the following command sequence, in the
+ directory where you have extracted the source:
+ <ul>
+ <li>./configure</li>
+ <li>make</li>
+ <li>make install</li>
+ </ul>
+ </li>
+ <li>Please run "./configure --help" in the samples folder for more
+ information on the configure options.</li>
+ </ul>
+ </li>
+ <li>Engage Rampart/C as specified in the section <a href="#engage">Engage Rampart/C with Axis2/C</a>
+ <li>Start the server and run the client to consume the secured service
+</ol>
+<a id="win"></a>
+
+<h2>2. Installing and Running on Microsoft Windows</h2>
+
+<p>This too can be done using binary or source distributions. (<a
+href="http://ws.apache.org/rampart/c/download.cgi">Download</a> the two
+distributions.) </p>
+
+<a id="win_binary"></a>
+
+<h3>2. 1. Installing the Binary Distribution </h3>
+
+
+<ol>
+ <li>Extract the binary distribution to a folder of your choice. (example:
+ C:\rampartc)</li>
+ <li>Copy modules/rampart to %AXIS2C_HOME%\modules</li>
+ <li>Engage Rampart/C as specified in the section <a href="#engage">Engage Rampart/C with Axis2/C</a>
+ <li>Start the server and run the client to consume the secured service
+</ol>
+<a id="bin_run"></a>
+
+<a id="win_source"></a>
+
+<h3>2. 2. Installing Source Distribution</h3>
+
+<h4>2.2.1. Requirements</h4>
+<ul>
+ <li>The makefile shipped with this version needs Microsoft Visual Studio
+ Compiler (cl) and the NMake build tool.</li>
+
+ <p>(Note: You can <a
+ href="http://msdn.microsoft.com/vstudio/express/downloads/">download the
+ Microsoft VSExpress2005 edition and Platform SDK</a> from the Microsoft Web
+ site. You will need to add the path to the Platform SDK Include and Lib
+ folders to the makefile)</p>
+ </li>
+</ul>
+<a id="edit"></a>
+
+<a id="src_compile"></a>
+
+<h4>2.2.2. Compiling the Source</h4>
+
+<p>The following steps will take you through the source compilation.</p>
+<ul>
+ <li>Extract the source distribution to a folder of your choice. (Example:
+ C:\rampartc)</li>
+ <li>Edit the configure.in file as explained in the section 2.2.3</li>
+ <li>Open a DOS shell</li>
+ <li>cd C:\rampartc\build\win32</li>
+ <li>to access .Net tools, run
+ <ul>
+ <li>C:\rampartc\build\win32< vcvars32.bat</li>
+ </ul>
+ <p>(<strong>Note</strong>: You may have to set the PATH environment
+ variable to vcvars32.bat if MS Windows gives an error indicating that it
+ cannot find this batch file. This file is located in >your MS Visual
+ Studio install Directory<\VC\bin directory.)</p>
+ </li>
+ <li>To build the system and create the binary files in a directory named
+ deploy under the build directory,
+ <ul>
+ <li>C:\rampartc\build\win32<nmake install</li>
+ </ul>
+ </li>
+ <li>Engage Rampart/C as specified in the section <a href="#engage">Engage Rampart/C with Axis2/C</a>
+ <li>Start the server and run the client to consume the secured service
+
+</ul>
+<a id="src_run"></a>
+
+<h4>2.2.5. Running the Binaries</h4>
+
+<ul>
+</ul>
+<a id="engage"/>
+<h2>Engage Rampart/C with axis2/C </h2>
+
+<p>You can engage Rampart/C in global level or in service level.</p>
+<p>Just add following entry either to axis2.xml(gloabl level) or in services.xml(service level).</p>
+<pre>
+ <module ref="rampart"/>
+</pre>
+
+<p>Apart from that you must define security policies for outgoing messages and incoming messages.
+This can be done adding parameters as follows in the same descriptor file that you engaged rampart.</p>
+<pre>
+ <parameter name="OutflowSecurityPolicy">/your/path/to/outgoing-secpolicy.xml</parameter>
+ <parameter name="InflowSecurityPolicy">/your/path/to/incoming-secpolicy.xml</parameter>
+</pre>
+<p>
+<strong>NOTE:</strong> There are several samples security policy xml files for different scenarios under samples/secpolicy/
+ Please refer the README file for more information
+</p>
+<p>
+The final configuration setup should be as follows
+</p>
+<h3>CLIENT SIDE:</h3>
+<p>axis2.xml</p>
+<pre>
+ <module ref="rampart"/>
+ <parameter name="OutflowSecurityPolicy">/../../outgoing-secpolicy.xml</parameter>
+ <parameter name="InflowSecurityPolicy">/../../incoming-secpolicy.xml</parameter>
+</pre>
+
+<h3>SERVER SIDE:</h3>
+<p>services.xml(or axis2.xml)</p>
+<pre>
+ <module ref="rampart"/>
+ <parameter name="OutflowSecurityPolicy">/../../outgoing-secpolicy.xml</parameter>
+ <parameter name="InflowSecurityPolicy">/../../incoming-secpolicy.xml>/parameter>
+</pre>
+
+<p><strong>NOTE:</strong> Please find sample security policy files that are located under <a href="http://svn.apache.org/repos/asf/webservices/rampart/trunk/c/samples/secpolicy/">samples/secpolicy</a></p>
+</body>
+</html>
Added: webservices/rampart/trunk/c/xdocs/docs/rampartc_manual.html
URL: http://svn.apache.org/viewvc/webservices/rampart/trunk/c/xdocs/docs/rampartc_manual.html?view=auto&rev=536170
==============================================================================
--- webservices/rampart/trunk/c/xdocs/docs/rampartc_manual.html (added)
+++ webservices/rampart/trunk/c/xdocs/docs/rampartc_manual.html Tue May 8 05:13:01 2007
@@ -0,0 +1,25 @@
+<html>
+<head>
+ <title>Manual</title>
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+</head>
+
+<body lang="en-US" dir="ltr">
+<h2>Preamble</h2>
+
+<p style="margin-bottom: 0in">This document is intended to be a reference
+manual for <a href="http://ws.apache.org/rampart/c">Apache Rampart/C</a>.</p>
+<br>
+--MORE--
+<br>
+<p>For further details please refer the <a href="http://ws.apache.org/axis2/c/docs/axis2c_manual.html">Apache Axis2/C manual</a></p>
+
+<p style="margin-bottom: 0in">Please send your feedback to the Apache Axis2/C
+developer mailing list (<a
+href="mailto:axis-c-dev@apache.org">axis-c-dev@apache.org</a>). Subscription
+details are available on the <a
+href="http://ws.apache.org/axis2/c/mail-lists.html">Axis2 site</a>.</p>
+
+
+</body>
+</html>