Update README and HACKING.

[radsecproxy.git] / lib / HACKING

diff --git a/lib/HACKING b/lib/HACKING
index ed9717d..e4d8d9f 100644 (file)
--- a/lib/HACKING
+++ b/lib/HACKING
@@ -1,15 +1,62 @@
 HACKING file for libradsec (in Emacs -*- org -*- mode).
-* Design of the libraray
-* Features
-** Not implemented
+
+Status as of libradsec-0.0.1-dev (2011-03-24).
+
+* Build instructions
+cd libradsec/lib
+sh autogen.sh
+./configure #--enable-tls
+make
+
+examples/client -r examples/client.conf blocking-tls; echo $?
+
+* Design of the API
+- There are three usage modes
+  - You use the send and receive calls (blocking mode)
+  - You register callbacks and run the libevent dispatch loop (user
+    dispatch mode)
+  - You run your own event loop, using fd's for select and do the I/O
+    using the libradsec send/receive calls (on-your-own mode)
+- Fully reentrant (FIXME: any issues with libfreeradius-radius?)
+
+* Dependencies
+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
+** Not well tested
 - reading config file
-- server fail over
-- resending packets
-- matching responses
-- TLS, DTLS
-- TLS PSK
-- autoconf/automake/libtool
-** Not tested
-- short read
-- short write
-** Tested and verified
+- [TCP] short read
+- [TCP] short write
+- [TLS] basic tls support
+** Known issues
+- error stack is only one entry deep
+** Not implemented
+- custom allocation scheme used in all places
+  issue: libfreeradius-radius
+- server failover
+- [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