You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@santuario.apache.org by bl...@apache.org on 2003/06/15 11:35:07 UTC

cvs commit: xml-security/doc/site/src/documentation/content/xdocs/c faq.xml index.xml installation.xml releases.xml

blautenb    2003/06/15 02:35:07

  Modified:    doc/site status.xml
               doc/site/src/documentation skinconf.xml
               doc/site/src/documentation/content/xdocs index.xml
               doc/site/src/documentation/content/xdocs/c faq.xml index.xml
                        installation.xml releases.xml
  Log:
  Started updates in preparation for C1.00 release
  
  Revision  Changes    Path
  1.3       +10 -0     xml-security/doc/site/status.xml
  
  Index: status.xml
  ===================================================================
  RCS file: /home/cvs/xml-security/doc/site/status.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- status.xml	5 May 2003 12:31:09 -0000	1.2
  +++ status.xml	15 Jun 2003 09:35:06 -0000	1.3
  @@ -13,6 +13,16 @@
     <changes>
       <!-- Add new releases here; action attributes: type:(add | fix | update); -->
       <!-- context:(docs | java_something | c_something ) -->
  +    <release version="C++ 1.00" date="July 2003">
  +      <action dev="BL" type="add" context="c_rel">
  +	    <ul>
  +		  <li>First stable release</li>
  +		  <li>Support for FreeBSD, NetBSD and Cygwin builds</li>
  +		  <li>All KeyInfo elements now available</li>
  +		  <li>Various bug fixes</li>
  +		</ul>
  +      </action>
  +	</release>
       <release version="C++ 0.20" date="May 2003">
         <action dev="BL" type="add" context="c_rel">
   	    <ul>
  
  
  
  1.2       +1 -1      xml-security/doc/site/src/documentation/skinconf.xml
  
  Index: skinconf.xml
  ===================================================================
  RCS file: /home/cvs/xml-security/doc/site/src/documentation/skinconf.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- skinconf.xml	15 Mar 2003 04:44:02 -0000	1.1
  +++ skinconf.xml	15 Jun 2003 09:35:06 -0000	1.2
  @@ -71,7 +71,7 @@
     <host-logo></host-logo>
   
     <!-- The following are used to construct a copyright statement -->
  -  <year>2002</year>
  +  <year>2002-2003</year>
     <vendor>The Apache Software Foundation.</vendor>
   
     <!-- Some skins use this to form a 'breadcrumb trail' of links. If you don't
  
  
  
  1.3       +9 -0      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.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- index.xml	5 May 2003 12:31:09 -0000	1.2
  +++ index.xml	15 Jun 2003 09:35:06 -0000	1.3
  @@ -7,6 +7,15 @@
     <body> 
       <section>
         <title>News</title>
  +      <section>
  +        <title>July 2003</title>
  +        <p>
  +          Version 1.00 of the C++ library is now released.  This is the first
  +          stable release of the library.  Functionality is still fairly basic,
  +          but all mandatory parts of the the DSIG standard are fully 
  +          implemented.
  +        </p>
  +      </section>
   	  <section>
   		<title>May 2003</title>
   		<p>
  
  
  
  1.2       +38 -5     xml-security/doc/site/src/documentation/content/xdocs/c/faq.xml
  
  Index: faq.xml
  ===================================================================
  RCS file: /home/cvs/xml-security/doc/site/src/documentation/content/xdocs/c/faq.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- faq.xml	15 Mar 2003 04:44:03 -0000	1.1
  +++ faq.xml	15 Jun 2003 09:35:07 -0000	1.2
  @@ -13,14 +13,47 @@
         </question>
         <answer>
   		<p>
  -		  At this time, the xml-security-c library requires OpenSSL to perform
  -		  cryptographic operations.  However the library has been written to
  -		  easily interface to other cryptographic providers.  Future versions
  -		  will provide interface layers to libgcrypt (the GNU Privacy Guard
  -		  crypto library) and the Windows Crypto API.
  +		  The main development work for the library is done using OpenSSL, so
  +		  this is the recommended option.  However, a developmental Windows
  +		  Crypto API interface is also now provided.
  +		</p>
  +		<p>
  +		  It is also possible to implement interfaces for other cryptographic
  +		  libraries and pass them into the xml-security-c library during
  +		  initialisation (via the <em>XSECPlatformUtils::Initialise()</em>
  +		  call).
   		</p>
         </answer>
       </faq>
  +	<faq id="openssl2_c">
  +	  <question>
  +		Does the library provide a full C++ wrapper for OpenSSL?
  +	  </question>
  +	  <answer>
  +		<p>
  +		  The C++ crypto interface layer provided for the library provides only
  +		  the smallest subset of cryptographic functions necessary for the
  +		  library to make calls to the provided library.  Applications will
  +		  need to work directly with OpenSSL (or other libraries) to read and
  +		  manipulate encryption keys that should then be wrapped in XSECCrypto*
  +		  objects and passed into the library.
  +		</p>
  +	  </answer>
  +	</faq>
  +	<faq id="wincapi_c">
  +	  <question>
  +		What is WinCAPI?
  +	  </question>
  +	  <answer>
  +		<p>
  +		  WinCAPI is the developmental interface being built to give
  +		  users of the library access to the Windows Cryptographic library.
  +		</p>
  +		<p>
  +		  It is <em>not</em> a C API wrapper for the overall library.
  +		</p>
  +	  </answer>
  +	</faq>
       <faq id="xalan_c">
         <question>
   		Is Xalan required?
  
  
  
  1.3       +28 -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.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- index.xml	5 May 2003 12:31:09 -0000	1.2
  +++ index.xml	15 Jun 2003 09:35:07 -0000	1.3
  @@ -7,20 +7,18 @@
     
     <body>
       <section>
  -      <title>News</title>
  +      <title>News - July 2003</title>
         <p>
  -		Beta 0.2 has been released.  It covers :
  +		Version 1.00 of the library has now been released.  It features :
   	  </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>
  +		<li>the first stable release</li>
  +		<li>full implementation of all mandatory requirements of DSIG</li>
  +		<li>FreeBSD, NetBSD and Cygwin builds</li>
   	  </ul>
   	  <p>
  -		Beta 0.2 is has been tested with Xerces-C v2.2 and the newly 
  -		released Xalan-C v1.5.
  +		Version 1.00 is has been tested with Xerces-C v2.2 and the newly 
  +		released Xalan-C v1.5.  Xerces-C v2.3 is also supported.
   	  </p>
       </section>
       <section>
  @@ -28,8 +26,7 @@
         <p>
           The C++ library is an implementation of the XML Digital Signature
           specification.  It is designed to be easily ported to new platforms,
  -        and has been tested on Solaris, Linux and Windows.  The next version
  -        will have ports to FreeBSD and HP-UX.
  +        and has been tested on Solaris, Linux, FreeBSD, NetBSD and Windows.
         </p>
         <p>
           The library makes use of the Apache XML project's Xerces-C XML Parser
  @@ -40,13 +37,30 @@
         <p>
           In addition, the library currently uses OpenSSL to provide 
           cryptographic functionality.  The cryptographic interface is
  -        implemented via a thin wrapper layer, which will be expanded to
  -        support the GNU Privacy Guard cryptographic library (libgcrypt) and
  -        Windows CAPI in the near future.
  +        implemented via a thin wrapper layer, and a development version of
  +		an implementation for the Windows Cryptographic API has also been
  +		implemented.
         </p>
       </section>
   	<section>
   	  <title>Old News</title>
  +	  <section>
  +		<title>May 2003</title>
  +		<p>
  +		  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>February 2003</title>
   		<p>
  
  
  
  1.3       +32 -16    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.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- installation.xml	5 May 2003 12:31:09 -0000	1.2
  +++ installation.xml	15 Jun 2003 09:35:07 -0000	1.3
  @@ -17,8 +17,8 @@
   		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
  +		Version 1.00 of the library has been tested with version 2.2 and 2.3 of
  +		Xerces-C, version 1.5 of Xalan-C and Version 0.9.7 (and above) of
   		OpenSSL.
   	  </p>
       </section>
  @@ -26,17 +26,17 @@
       <section>
         <title>Getting the source</title>
         <p>
  -	You can download the sources via WWW in the distribution directory
  -	from one of the Apache  
  -	<jump href="site:about/download">
  -	  mirrors
  -	</jump>.
  +		You can download the sources via WWW in the distribution directory
  +		from one of the Apache  
  +		<jump href="site:about/download">
  +		  mirrors
  +		</jump>.
         </p>
         <p>
  -	This project's CVS repository can be checked out through anonymous
  -	(pserver) CVS with the following instruction set. The module you wish
  -	to check out must be specified as the modulename. When prompted for a
  -	password for anonymous, simply enter "anoncvs" without quotes: 
  +		This project's CVS repository can be checked out through anonymous
  +		(pserver) CVS with the following instruction set. The module you wish
  +		to check out must be specified as the modulename. When prompted for a
  +		password for anonymous, simply enter "anoncvs" without quotes: 
         </p>
         <source>cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic login
   	password: anoncvs
  @@ -44,16 +44,18 @@
   	xml-security
         </source>
         <p>
  -	A HTTP interface to browse the sources online is available via 
  -	<jump href="site:getting-involved/CVS">http://cvs.apache.org/viewcvs.cgi/xml-security/</jump>
  +		A HTTP interface to browse the sources online is available via 
  +		<jump href="site:getting-involved/CVS">http://cvs.apache.org/viewcvs.cgi/xml-security/</jump>
         </p>
       </section>
       
       <section>
   	  <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 3.2 and GNU make.
  +		XML-Security-C is currently fully supported on Linux, FreeBSD and 
  +		Solaris.  It is partially supported (in cases where Xalan is not 
  +		required) on NetBSD and Cygwin.  It has been built and tested using 
  +		GNU gcc 3.2, gcc 2.95.4, Forte C++ 5.4 (Solaris) and GNU make.
   	  </p>
   	  <note>
   		The UNIX XML-Security-C build process has changed radically since
  @@ -142,6 +144,15 @@
   		  to remove all binaries and libraries (former) and build scripts (latter)
   		</p>
   	  </section>
  +	  <section>
  +		<title>Install</title>
  +		<p>
  +		  <em>make install</em> can be used to install the library and the
  +		  include files into the relevant directories (which can be set via
  +		  the <em>configure</em> script using the various <em>--prefix=</em>
  +		  options.
  +		</p>
  +	  </section>
   	</section>
   	<section>
   	  <title>Building for Windows</title>
  @@ -198,13 +209,18 @@
   		  XSEC workspace.
   		</p>
   		<p>
  +		  To enable support for the Windows Crypto API, edit the 
  +		  XSECW32Config.hpp file and uncomment the line 
  +		  <code>#define HAVE_WINCAPI 1</code>
  +		</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
  +		  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>
  
  
  
  1.3       +26 -29    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.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- releases.xml	5 May 2003 12:31:09 -0000	1.2
  +++ releases.xml	15 Jun 2003 09:35:07 -0000	1.3
  @@ -13,14 +13,36 @@
   		various releases of the library
   	  </p>
   	  <section>
  -	    <title>Current Release - Beta 0.20</title>
  +		<title>Version 1.00</title>
  +		<p>
  +		  Version 1.00 is the first release of the library considered basically
  +		  stable.  The interface is fairly simple, but all the mandatory
  +		  requirements of the XML Digital Signature standard are implemented.
  +		</p>
  +		<p>
  +		  Changes from version 0.20 include :
  +		</p>
  +		<ul>
  +		  <li>Implementation of remaining KeyInfo elements (SPKIData,
  +			PGPData and MgmtData</li>
  +		  <li>Re-implementation of XSECXPathNodeList using a binary search 
  +			to speed up list searches</li>
  +		  <li>Support for FreeBSD 4.7 (gcc) builds, Intel Compiler 6.0 on
  +			Linux and Forte CC (CC 5.4) on Solaris</li>
  +		  <li>Limited support (i.e. without Xalan integration for NetBSD and 
  +			Cygwin</li>
  +		  <li>A number of minor bug fixes</li>
  +		</ul>
  +	  </section>
  +	  <section>
  +	    <title>Changes from 0.10 - 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>
  +		<title>Beta release 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
  @@ -86,32 +108,6 @@
   	</section>
   	<section>
   	  <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.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.
  -	  </p>
  -	  <p>
  -		XML Encryption will be added post 1.00
  -	  </p>
  -	  <p>
  -		The majority of activity from now to 1.00 will concentrate on: 
  -	  </p>
  -	  <ul>
  -		<li>Fixing bugs and memory leaks</li>
  -		<li>Ensure API is reasonably consistant</li>
  -		<li>Improvements in the API for manipulating a signature 
  -		  in memory</li>
  -		<li>Support for KeyInfo elements not currently implemented (PGP and
  -		  SPKI)</li>
  -		<li>NetBSD/FreeBSD builds</li>
  -		<li>Install capability in make files</li>
  -	  </ul>
  -	</section>
  -	<section>
  -	  <title>Beyond a stable release</title>
   	  <p>A number of items are planned for after the 1.0 major release.</p>
   	  <ul>
   		<li>XML Encryption Support</li>
  @@ -120,7 +116,8 @@
   		<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>Support for PGP/GPG key based 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>