blautenb 2003/05/05 05:31:10
Modified: doc/site status.xml
doc/site/src/documentation/content/xdocs index.xml
doc/site/src/documentation/content/xdocs/c index.xml
installation.xml releases.xml tools.xml
doc/site/src/documentation/resources/images project-logo.gif
Log:
Documentation updates for C++ library v0.2
Revision Changes Path
1.2 +9 -0 xml-security/doc/site/status.xml
Index: status.xml
===================================================================
RCS file: /home/cvs/xml-security/doc/site/status.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- status.xml 15 Mar 2003 04:44:02 -0000 1.1
+++ status.xml 5 May 2003 12:31:09 -0000 1.2
@@ -13,6 +13,15 @@
<changes>
<!-- Add new releases here; action attributes: type:(add | fix |
update); -->
<!-- context:(docs | java_something | c_something ) -->
+ <release version="C++ 0.20" date="May 2003">
+ <action dev="BL" type="add" context="c_rel">
+ <ul>
+ <li>Windows Crypto API interface</li>
+ <li>Basic functions to extract information from signature
objects</li>
+ <li>Various bug fixes</li>
+ </ul>
+ </action>
+ </release>
<release version="Java 1.0.5" date="unreleased">
<action dev="KW" type="update" context="docs">
<p>Ported the docs to Forrest</p>
1.2 +17 -4
xml-security/doc/site/src/documentation/content/xdocs/index.xml
Index: index.xml
===================================================================
RCS file:
/home/cvs/xml-security/doc/site/src/documentation/content/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 15 Mar 2003 04:44:02 -0000 1.1
+++ index.xml 5 May 2003 12:31:09 -0000 1.2
@@ -7,10 +7,23 @@
<body>
<section>
<title>News</title>
- <p>
- The site has now been re-built using the new xml.apache.org standard,
- using Forrest.
- </p>
+ <section>
+ <title>May 2003</title>
+ <p>
+ The Beta 0.20 of the C++ library has now been released.
Features:
+ </p>
+ <ul>
+ <li>Ability to use the Windows Crypto API as a crypto
provider</li>
+ <li>Several minor bug fixes in transforms and UNIX build
process</li>
+ </ul>
+ </section>
+ <section>
+ <title>February 2003</title>
+ <p>
+ The site has now been re-built using the new xml.apache.org
standard,
+ using Forrest.
+ </p>
+ </section>
</section>
<section>
<title>The Project</title>
1.2 +34 -14
xml-security/doc/site/src/documentation/content/xdocs/c/index.xml
Index: index.xml
===================================================================
RCS file:
/home/cvs/xml-security/doc/site/src/documentation/content/xdocs/c/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 15 Mar 2003 04:44:03 -0000 1.1
+++ index.xml 5 May 2003 12:31:09 -0000 1.2
@@ -9,20 +9,19 @@
<section>
<title>News</title>
<p>
- The C++ library has now been fully transferred into the Apache XML
- project. It was previously hosted on SourceForge.
- </p>
- <p>
- The first release under Apache is 0.10. This is a Beta release,
- with fairly complete documentation, and a stable code base. It
- fully validates the various interop documents held in the
xml-security
- CVS, with the exception of those related to :
- </p>
- <ul>
- <li>MD5 Digests (to be added in next point release)</li>
- <li>XPath Filter (to be added in next point release)</li>
- <li>XML Encryption (to be added post 1.00 release)</li>
- </ul>
+ Beta 0.2 has been released. It covers :
+ </p>
+ <ul>
+ <li>some minor bug-fixes in the code and the UNIX build
system</li>
+ <li>a first cut at a Windows Crypto API provider interface</li>
+ <li>methods to extract information from signature objects;
and</li>
+ <li>updates to tools to allow (and demonstrate) use of Windows
CAPI
+ and new extraction methods</li>
+ </ul>
+ <p>
+ Beta 0.2 is has been tested with Xerces-C v2.2 and the newly
+ released Xalan-C v1.5.
+ </p>
</section>
<section>
<title>Overview of the C++ Library</title>
@@ -46,6 +45,27 @@
Windows CAPI in the near future.
</p>
</section>
+ <section>
+ <title>Old News</title>
+ <section>
+ <title>February 2003</title>
+ <p>
+ The C++ library has now been fully transferred into the
Apache XML
+ project. It was previously hosted on SourceForge.
+ </p>
+ <p>
+ The first release under Apache is 0.10. This is a Beta
release,
+ with fairly complete documentation, and a stable code base.
It
+ fully validates the various interop documents held in the
xml-security
+ CVS, with the exception of those related to :
+ </p>
+ <ul>
+ <li>MD5 Digests (to be added in next point release)</li>
+ <li>XPath Filter (to be added in next point release)</li>
+ <li>XML Encryption (to be added post 1.00 release)</li>
+ </ul>
+ </section>
+ </section>
</body>
</document>
1.2 +41 -2
xml-security/doc/site/src/documentation/content/xdocs/c/installation.xml
Index: installation.xml
===================================================================
RCS file:
/home/cvs/xml-security/doc/site/src/documentation/content/xdocs/c/installation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- installation.xml 15 Mar 2003 04:44:03 -0000 1.1
+++ installation.xml 5 May 2003 12:31:09 -0000 1.2
@@ -16,6 +16,11 @@
The library requires OpenSSL for cryptographic support. Xalan-C
is also required if XPath and/or XSLT transformations are
required.
</p>
+ <p>
+ Version 0.2 of the library has been tested with version 2.2 of
+ Xerces-C, verion 1.5 of Xalan-C and Version 0.9.7 (and above) of
+ OpenSSL.
+ </p>
</section>
<section>
@@ -48,7 +53,7 @@
<title>Building for UNIX</title>
<p>
XML-Security-C is currently supported on Linux and Solaris.
- It has been built and tested using GNU gcc 2.95.4 and GNU make.
+ It has been built and tested using GNU gcc 3.2 and GNU make.
</p>
<note>
The UNIX XML-Security-C build process has changed radically
since
@@ -146,6 +151,11 @@
The following subsections briefly describe how to
rebuild the library, tools and samples using the supplied
workspaces.
</p>
+ <note>
+ As of version 0.2, the library can be built without OpenSSL on a
+ Windows platform. (The WinCAPI provider will be used instead).
+ See below for details on how to do this.
+ </note>
<section>
<title>Setup Directories</title>
<p>
@@ -171,11 +181,40 @@
</section>
<section>
+ <title>Configure</title>
+ <p>
+ If you are using Xalan and OpenSSL, no configuration is
required when
+ building from the Visual C++ v6.0 workspace.
+ </p>
+ <p>
+ If you wish to disable OpenSSL, you should edit the file
+ <em>.../src/framework/XSECW32Config.hpp</em> and comment out
the
+ line <code>#define HAVE_OPENSSL 1</code>. This will
effectively remove
+ support for OpenSSL from the library as it is being compiled.
+ </p>
+ <p>
+ You will also need to remove the library module
<code>libeay32.lib</code>
+ from the link->General settings in each of the projects in the
+ XSEC workspace.
+ </p>
+ <p>
+ To disable support for Xalan, a similar process is followed.
Edit
+ the XSECW32Config.hpp file, and <strong>uncomment</strong>
the XSEC_NO_XALAN
+ line. This will remove all support for Xalan from the various
+ source code files.
+ </p>
+ <p>
+ WHen compiling, using the "...No Xalan configurations for each
+ project. These are the same as the normal debug or release
builds,
+ but the Xalan library is not linked in.
+ </p>
+ </section>
+ <section>
<title>Build Library and Tools</title>
<p>
The main workspace is found in :
</p>
- <p><em>.../src/Projects/VC6.0/xsec/xsec.dsw</em></p>
+ <p><em>.../Projects/VC6.0/xsec/xsec.dsw</em></p>
<p>
You can load this to build the tools or the library using the
relevant
project. (The library is xsec_lib.)
1.2 +11 -5
xml-security/doc/site/src/documentation/content/xdocs/c/releases.xml
Index: releases.xml
===================================================================
RCS file:
/home/cvs/xml-security/doc/site/src/documentation/content/xdocs/c/releases.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- releases.xml 15 Mar 2003 04:44:03 -0000 1.1
+++ releases.xml 5 May 2003 12:31:09 -0000 1.2
@@ -13,7 +13,14 @@
various releases of the library
</p>
<section>
- <title>Current Release - Beta 0.10</title>
+ <title>Current Release - Beta 0.20</title>
+ <p>
+ Includes a number of bug-fixes and a first cut at a provider
for the
+ Windows Crypto API.
+ </p>
+ </section>
+ <section>
+ <title>Changes from 0.10-0.10</title>
<p>
The current release of the xml-security-c library is a beta
of the
XML Digital Signature code, and is the first version of the
library
@@ -81,7 +88,7 @@
<title>Future Release Plans</title>
<p>
The current plans are to stablise the beta code and provide a
sound
- core library for digital signing. Now that the code is at 0.10,
+ core library for digital signing. Now that the code is at 0.20,
some further additions will be made to the digital signature
support,
and a 1.00 release will be made when digital signature support
is
fairly complete.
@@ -99,8 +106,6 @@
in memory</li>
<li>Support for KeyInfo elements not currently implemented (PGP
and
SPKI)</li>
- <li>Implementation of libgcrypt as a crypto provider</li>
- <li>Support for PGP/GPG signatures (using libgcrypt and
gpgme)</li>
<li>NetBSD/FreeBSD builds</li>
<li>Install capability in make files</li>
</ul>
@@ -110,11 +115,12 @@
<p>A number of items are planned for after the 1.0 major release.</p>
<ul>
<li>XML Encryption Support</li>
- <li>A crypto interface for the Windows CAPI</li>
<li>Implementation of a core set of encryption primitives to
allow
decoupling from OpenSSL for "light" applications</li>
<li>Improved <em>KeyInfo</em> resolver interface leading
to...</li>
<li>XKMS client support</li>
+ <li>Implementation of libgcrypt as a crypto provider</li>
+ <li>Support for PGP/GPG signatures (using libgcrypt and
gpgme)</li>
<li>Bring the API in-line with JCP 105 (if appropriate)</li>
<li>Eventually (the GRAND PLAN) an XKMS server
implementation</li>
</ul>
1.2 +3 -0
xml-security/doc/site/src/documentation/content/xdocs/c/tools.xml
Index: tools.xml
===================================================================
RCS file:
/home/cvs/xml-security/doc/site/src/documentation/content/xdocs/c/tools.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- tools.xml 15 Mar 2003 04:44:03 -0000 1.1
+++ tools.xml 5 May 2003 12:31:09 -0000 1.2
@@ -31,6 +31,9 @@
of threads which simultaneously sign and validate documents.
A
number of documents are modified in between (to cause the
signature
validation to fail).</li>
+ <li><em>siginf</em> - A tool to read in an XML Signature and
dump
+ various details about the signature and references to the
terminal
+ </li>
</ul>
<p>
The tools can all be run with no command line arguments to see
their
1.2 +64 -106
xml-security/doc/site/src/documentation/resources/images/project-logo.gif
<<Binary file>>
