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 na...@apache.org on 2007/07/12 01:06:48 UTC
svn commit: r555431 - /webservices/rampart/trunk/c/xdocs/docs/installationguide.html

Author: nabeel
Date: Wed Jul 11 16:06:47 2007
New Revision: 555431

URL: http://svn.apache.org/viewvc?view=rev&rev=555431
Log:
Fixed typos and updated to make the guide clearer for the windows installation section

Modified:
    webservices/rampart/trunk/c/xdocs/docs/installationguide.html

Modified: webservices/rampart/trunk/c/xdocs/docs/installationguide.html
URL: http://svn.apache.org/viewvc/webservices/rampart/trunk/c/xdocs/docs/installationguide.html?view=diff&rev=555431&r1=555430&r2=555431
==============================================================================
--- webservices/rampart/trunk/c/xdocs/docs/installationguide.html (original)
+++ webservices/rampart/trunk/c/xdocs/docs/installationguide.html Wed Jul 11 16:06:47 2007
@@ -1,227 +1,224 @@
-<?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> 0.9.8 (or above) 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/C 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 to specify the Axis2/C deploy path and OpenSSL installation path</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\&gt; 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 &lt;your MS Visual
-    Studio install Directory&gt;\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&gt;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>   
- &lt;module ref="rampart"/&gt;
-</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>    
- &lt;parameter name="OutflowSecurityPolicy"&gt;/your/path/to/outgoing-secpolicy.xml&lt;/parameter&gt;
- &lt;parameter name="InflowSecurityPolicy"&gt;/your/path/to/incoming-secpolicy.xml&lt;/parameter&gt;
-</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>
-<strong>CLIENT SIDE:</strong>
-<p>axis2.xml</p>
-<pre>    
- &lt;module ref="rampart"/&gt;
- &lt;parameter name="OutflowSecurityPolicy"&gt;/../../outgoing-secpolicy.xml&lt;/parameter&gt;
- &lt;parameter name="InflowSecurityPolicy"&gt;/../../incoming-secpolicy.xml&lt;/parameter&gt;
-</pre>    
-
-<strong>SERVER SIDE:</strong>
-<p>services.xml(or axis2.xml)</p>
-<pre>    
- &lt;module ref="rampart"/&gt;
- &lt;parameter name="OutflowSecurityPolicy"&gt;/../../outgoing-secpolicy.xml&lt;/parameter&gt;
- &lt;parameter name="InflowSecurityPolicy"&gt;/../../incoming-secpolicy.xml&gt;/parameter&gt;
-</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>
-<p>Go to each and every scenario and see how Rampart/C is configured using the policy assertions available in respective policy files.
-<br>For each scenario there are four policy files</p>
-<ol>
-    <li>client-outgoing-secpolicy.xml : Defines how the security configurations for client's out going messages</li>
-    <li>service-incoming-secpolicy.xml : Defines how the security configurations for server's in coming messages</li>
-    <li>service-outgoing-secpolicy.xml : Defines how the security configurations for server's out going messages</li>
-    <li>client-incoming-secpolicy.xml : Defines how the security configurations for client's in coming messages</li>
-</ol>
-<p><strong>NOTE:</strong> If you have changed an outgoing policy file, make sure that you change the corresponding incoming policy file as well, and vise versa </p>
-</body>
-</html>
+<?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> 0.9.8 (or above) 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/C 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 axis2_http_server and run the echo client in the samples/client/sec_echo 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 to specify the Axis2/C repository path and the OpenSSL installation path</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\&gt; 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 &lt;your MS Visual
+    Studio install Directory&gt;\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&gt;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 axis2_http_server and run the echo client in the samples/client/sec_echo to consume the secured service
+</ul>
+<a id="src_run"></a>
+
+<h4><a id="engage"/></h4>
+
+<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 the following entry either to axis2.xml(gloabl level) or in services.xml(service level) corresponding to the service you want to secure.</p>
+<pre>   
+ &lt;module ref="rampart"/&gt;
+</pre>
+
+<p>Apart from that you must define security policies for outgoing messages and incoming messages.
+This can be done by adding parameters in the same descriptor file that you engaged rampart as follows.</p>
+<pre>    
+ &lt;parameter name="OutflowSecurityPolicy"&gt;/your/path/to/outgoing-secpolicy.xml&lt;/parameter&gt;
+ &lt;parameter name="InflowSecurityPolicy"&gt;/your/path/to/incoming-secpolicy.xml&lt;/parameter&gt;
+</pre>
+<p>
+<strong>NOTE:</strong> There are several sample security policy xml files for different scenarios under samples/secpolicy/. 
+        Please refer to the README file inside this folder for more information.
+</p>
+<p>
+The final configuration setup should be as follows:
+</p>
+<strong>CLIENT SIDE:</strong>
+<p>In axis2.xml</p>
+<pre>    
+ &lt;module ref="rampart"/&gt;
+ &lt;parameter name="OutflowSecurityPolicy"&gt;/../../outgoing-secpolicy.xml&lt;/parameter&gt;
+ &lt;parameter name="InflowSecurityPolicy"&gt;/../../incoming-secpolicy.xml&lt;/parameter&gt;
+</pre>    
+
+<strong>SERVER SIDE:</strong>
+<p>In services.xml(or axis2.xml)</p>
+<pre>    
+ &lt;module ref="rampart"/&gt;
+ &lt;parameter name="OutflowSecurityPolicy"&gt;/../../outgoing-secpolicy.xml&lt;/parameter&gt;
+ &lt;parameter name="InflowSecurityPolicy"&gt;/../../incoming-secpolicy.xml&gt;/parameter&gt;
+</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>
+<p>You may go to each and every scenario and see how Rampart/C is configured using the policy assertions available in respective policy files.
+<br>
+For each scenario there are four policy files:</p>
+<ol>
+    <li>client-outgoing-secpolicy.xml : Defines what the security configurations are for  outgoing messages from the client</li>
+  <li>service-incoming-secpolicy.xml : Defines what the security configurations are for incoming messages to the server</li>
+  <li>service-outgoing-secpolicy.xml : Defines what the security configurations are for  outgoing messages from the server</li>
+  <li>client-incoming-secpolicy.xml : Defines what the security configurations are for incoming messages to the client</li>
+</ol>
+<p><strong>NOTE:</strong> If you have changed an outgoing policy file, make sure that you change the corresponding incoming policy file as well, and vise versa. </p>
+</body>
+</html>