From d12b1b6ba42073b2c5dfe617286b5b3af43df866 Mon Sep 17 00:00:00 2001
From: Linus Nordberg <linus@nordu.net>
Date: Sat, 12 Mar 2011 14:43:36 +0100
Subject: Update README and HACKING.

---
 lib/HACKING | 36 ++++++++++++++++++++----------------
 lib/README  |  8 ++++----
 2 files changed, 24 insertions(+), 20 deletions(-)

(limited to 'lib')

diff --git a/lib/HACKING b/lib/HACKING
index 6708c19..2be4d67 100644
--- a/lib/HACKING
+++ b/lib/HACKING
@@ -1,15 +1,14 @@
 HACKING file for libradsec (in Emacs -*- org -*- mode).
 
-Status as of libradsec-0.0.1-dev (2011-02-28).
+Status as of libradsec-0.0.1-dev (2011-03-12).
 
 * Build instructions
 cd libradsec/lib
 sh autogen.sh
-./configure
+./configure #--enable-tls
 make
 
-
-examples/client -r examples/client-tls.conf blocking-tls ; echo $?
+examples/client -r examples/client-tls.conf blocking-tls; echo $?
 
 * Design of the API
 - There are three usage modes
@@ -21,25 +20,30 @@ examples/client -r examples/client-tls.conf blocking-tls ; echo $?
 - Fully reentrant (FIXME: any issues with libfreeradius-radius?)
 
 * Dependencies
-- libfreeradius-radius -- no i/o used
-- libconfuse
-- libevent 2.0.x
+This is on Ubuntu 10.10.
 
+- libfreeradius-radius (2.1.9+dfsg-1ubuntu1)
+  sudo apt-get install libfreeradius-dev libfreeradius2
+- libconfuse (2.7-1)
+  sudo apt-get install libconfuse-dev libconfuse0
+- libevent from source (release-2.0.10-stable)
+  git clone --branch release-2.0.10-stable git://levent.git.sourceforge.net/gitroot/levent/levent
+  cd levent; sh autogen.sh && ./configure --enable-openssl
+  make && sudo make install
+  
 * Functionality and quality
 ** Tested and verified
 ** Not well tested
 - reading config file
-- short read
-- short write
-- basic tls support
+- [TCP] short read
+- [TCP] short write
+- [TLS] basic tls support
 ** Known issues
 - leaking memory
-- udp issues with libevent
-- error stack is one entry deep
+- error stack is only one entry deep
 ** Not implemented
-- client: udp (resending packets), access-challenge, read/write timeout
 - custom allocation scheme used in all places
 - server failover
-- TLS: verify CNAME
-- TLS preshared key support
-- DTLS support
+- [TLS] verification of CNAME
+- [TLS] preshared key support
+- [DTLS] support
diff --git a/lib/README b/lib/README
index 2e51aeb..3a2556a 100644
--- a/lib/README
+++ b/lib/README
@@ -8,7 +8,7 @@ libradsec depends on
 - libradius from the FreeRADIUS freeradius-server
 - libevent2
 - libconfuse
-- openssl (if configured with tls or dtls support)
+- openssl (if configured with --enable-tls)
 
 
 To compile the library and the examples, do something like
@@ -16,14 +16,14 @@ To compile the library and the examples, do something like
  sh autogen.sh && ./configure && make
 
 If any of the libraries are not found, try setting environment
-variable LDFLAGS at configure time.
+variable LDFLAGS at configure time like so:
 
  LDFLAGS="-L/usr/lib/freeradius -L/usr/local/lib" ./configure
 
 
 The parts of the library which has been tested has been so on Linux
-(Ubuntu 10.04) with libfreeradius2 (2.1.8+dfsg-1ubuntu1), libconfuse0
-(2.6-2) and libevent-2.0.7-rc-dev (http://monkey.org/~provos/).
+(Ubuntu 10.10) with libfreeradius2 (2.1.9+dfsg-1ubuntu1), libconfuse0
+(2.7-1) and libevent-2.0.10-stable (http://monkey.org/~provos/).
 
 The file HACKING contains more detailed info on the state of the
 various parts of the library.
-- 
cgit v1.1