Update README and HACKING.

[radsecproxy.git] / lib / HACKING

diff --git a/lib/HACKING b/lib/HACKING
index 6708c19..e4d8d9f 100644 (file)
--- 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-24).
 
 * 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.conf blocking-tls; echo $?
 
 * Design of the API
 - There are three usage modes
@@ -21,25 +20,43 @@ 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
+The details below apply to 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
+- OpenSSL (optional, for TLS and DTLS support)
+  sudo apt-get install libssl-dev
+  
 * 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
+  issue: libfreeradius-radius
 - server failover
-- TLS: verify CNAME
-- TLS preshared key support
-- DTLS support
+- [TLS] verification of CN
+- [TLS] preshared key support
+- [DTLS] support
+
+* Found a bug?
+If possible, please build the library with DEBUG defined
+(CFLAGS=-DDEBUG) and reproduce the problem.  With DEBUG defined, lots
+of asserts are enabled which might give a hint about what's gone
+wrong.
+
+Running the library under gdb is another good idea.  If you experience
+a crash, catching that in gdb and providing a backtrace is highly
+valuable for debugging.
+
+Contact: mailto:linus+libradsec@nordu.net