diff --git a/INSTALL b/INSTALL index cabd5c08..a0a3f2a2 100644 --- a/INSTALL +++ b/INSTALL @@ -1,6 +1,8 @@ Installing QCA -------------- +QCA requires Qt 4.2 or greater. + For Unix/Linux/Mac: ./configure @@ -15,5 +17,21 @@ For Windows: installwin +Notes +----- + - On unix, use --prefix=$PWD to build in-place + - On windows, run configwin without arguments to see possible build modes + + +Building from SVN +------------------ +First, install the 'qconf' program, at least version 1.3. You can download +the source here: + http://delta.affinix.com/qconf/ + +Then, go into the QCA source tree and type 'qconf'. You should now have a +configure script to execute, just like from a normal source package. + + Please report problems to: delta@lists.affinix.com diff --git a/README b/README index 33bb195f..b79938b5 100644 --- a/README +++ b/README @@ -1,50 +1,61 @@ -Qt Cryptographic Architecture (QCA) ------------------------------------ +Qt Cryptographic Architecture (QCA) version 2.0.0 +------------------------------------------------- +Date: July 5th, 2007 +Website: http://delta.affinix.com/qca/ +Mailing List: Delta Project -Author: Justin Karneges +Project Lead/Maintainer (2003-current): + Justin Karneges + +Development, Documentation, Unittests (2004-current): + Brad Hards + +Special Thanks: + Alon Bar-Lev, for smart card and design assistance + Jack Lloyd, for Botan and X.509 mentoring + L. Peter Deutsch, for the public domain MD5 implementation + Steve Reid, for the public domain SHA1 implementation -About QCA ---------- -This library provides an easy API for a range of cryptographic -features, including SSL/TLS, X.509 certificates, SASL, symmetric -ciphers, public key ciphers, hashes and much more. + For installation or compiling instructions, see the INSTALL file. -Functionality is supplied via plugins. This is useful for avoiding -dependence on a particular crypto library and makes upgrading easier, -as there is no need to recompile your application when adding or -upgrading a crypto plugin. Also, by pushing crypto functionality into -plugins, your application is free of legal issues, such as export -regulation. + This library is licensed under the Lesser GNU General Public License. See + the COPYING file for more information. -Building from a Source package ------------------------------- - -See the 'INSTALL' file. +Changes +------- + New in 2.0.0 + - Rewritten for Qt 4 + - MAC algorithms + - DSA + - Diffie-Hellman + - Secure random + - Secure memory + - Extensive X.509 API, supporting chains, crls, and validation + - Smart cards and other key storage + - OpenPGP + - Cryptographic Message Syntax (for S/MIME) + - probably more -Building from CVS/SVN ---------------------- +Description +----------- -First, install the 'qconf' program, at least version 1.3. You can download -the source here: - http://delta.affinix.com/qconf/ + QCA is a library that provides an easy API for a range of crypographic + features, including SSL/TLS, X.509 certificates, SASL, OpenPGP, smartcards, + and much more. -Then, go into the QCA source tree and type 'qconf'. You should now have a -configure script to execute. + Functionality is supplied via plugins. This is useful for avoiding + dependence on a particular crypto library and makes upgrading easier, + as there is no need to recompile your application when adding or + upgrading a crypto plugin. -When you execute that script, you should see something like the following: + In order for QCA to be of much use, you'll want to install some plugins. - Configuring Qt Cryptographic Architecture (QCA) ... - Verifying Qt 4 build environment ... ok - Checking for certstore ... using bundled - - Good, your configure finished. Now run /usr/bin/gmake. - -If so, you can just run (g)make to build QCA. If not, have a look at -conf.log to see what might have gone wrong. + QCA was originally created to support the security needs of the + Psi XMPP/Jabber client project ( http://psi-im.org/ ). -You will also need to build appropriate plugins to get support for -many of the QCA features. +Have fun, +-Justin diff --git a/TODO b/TODO index fdbc758d..d6bcdfc5 100644 --- a/TODO +++ b/TODO @@ -1,9 +1,3 @@ -* beta7 - api: - prompting for unavailable entries - other: - update README/INSTALL, special thanks to Jack Lloyd - * test1 doc: documentation overhaul