Update README and HACKING.

[libradsec.git] / lib / HACKING

diff --git a/lib/HACKING b/lib/HACKING
index 7b1f298..b9ccd6b 100644 (file)
--- a/lib/HACKING
+++ b/lib/HACKING
@@ -18,22 +18,27 @@ examples/client -r examples/client.conf blocking-tls; echo $?
   - Application runs its own event loop, using fd's for select and
     performs I/O using the libradsec send/receive calls
     (a.k.a. on-your-own mode)
-- Fully reentrant (FIXME: issues with libfreeradius-radius?)
+- Fully reentrant
 - User chooses allocation regime
 
+Note that as of 0.0.2.dev libradsec suffers from way too much focus on
+the behaviour of a blocking client and is totally useless as a server.
+Not only does it lack most of the functions needed for writing a
+server but it also contains at least one architectural mishap which
+kills the server idea -- a connection timeout (TCP) or a retransmit
+timeout (UDP) will result in the event loop being broken. The same
+thing will happen if there's an error on a TCP connection, f.ex. a
+failing certificate validation (TLS).
+
 * Dependencies
-Details apply to Ubuntu 10.10.
+Details (within parentheses) apply to Debian Wheezy.
 
-- libfreeradius-radius (2.1.9+dfsg-1ubuntu1)
-  sudo apt-get install libfreeradius-dev libfreeradius2
-- libconfuse (2.7-1)
+- libconfuse (2.7-4)
   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
+- libevent2 (2.0.19-stable-3)
+  sudo apt-get install libevent-dev libevent-2.0-5
+- OpenSSL (1.0.1c-4) -- optional, for TLS and DTLS support
+  sudo apt-get install libssl-dev libssl1.0.0
   
 * Functionality and quality
 ** Not well tested
@@ -41,24 +46,27 @@ Details apply to Ubuntu 10.10.
 - [TCP] short read
 - [TCP] short write
 - [TLS] basic tls support
+- [TLS] preshared key support
+- [TLS] verification of CN
+
 ** Known issues
 - error stack is only one entry deep
 - custom allocation scheme is not used in all places
+
 ** Not implemented
-- server failover
-- [TLS] verification of CN
-- [TLS] preshared key support
+- [client] server failover
 - [DTLS] support
+- [server] support
 
 * Found a bug?
-Please report it.  This is how we improve the quality of the code.
+Please report it. That is how we improve the quality of the code.
 
 If possible, please build the library with DEBUG defined (CFLAGS="-g
--DDEBUG") and reproduce the problem.  With DEBUG defined, lots of
+-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 it in gdb and providing a backtrace is highly
+Running the library under gdb is another good idea. If you experience
+a crash, catching the crash in gdb and providing a backtrace is highly
 valuable for debugging.
 
 Contact: mailto:linus+libradsec@nordu.net