Add an error code.

[radsecproxy.git] / lib / HACKING

diff --git a/lib/HACKING b/lib/HACKING
index 9027e19..793ac72 100644 (file)
--- a/lib/HACKING
+++ b/lib/HACKING
@@ -1,6 +1,6 @@
 HACKING file for libradsec (in Emacs -*- org -*- mode).
 
-Status as of libradsec-0.0.2-dev (2011-03-24).
+Status as of libradsec-0.0.2.dev (2011-03-24).
 
 * Build instructions
 cd libradsec/lib
@@ -21,6 +21,14 @@ examples/client -r examples/client.conf blocking-tls; echo $?
 - Fully reentrant (FIXME: issues with libfreeradius-radius?)
 - 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 is
+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.
 
@@ -41,13 +49,13 @@ 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
 - [DTLS] support
 
 * Found a bug?