X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=lib%2FHACKING;h=824cb77b27bb63d7c1bc5e6b99802e77ef232f3f;hb=4b0ff99282a91bba93eec9db37831be73b8134e4;hp=9cbab82ac243fa4fe4b249b8f0fccd7fdb7d12bd;hpb=be4b786700ad03de5226951c043fefb345c0df4c;p=radsecproxy.git

diff --git a/lib/HACKING b/lib/HACKING
index 9cbab82..824cb77 100644
--- a/lib/HACKING
+++ b/lib/HACKING
@@ -1,15 +1,69 @@
 HACKING file for libradsec (in Emacs -*- org -*- mode).
-* Design of the libraray
-* Functionality
-** Not implemented
+
+Status as of libradsec-0.0.2.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
+  - Application use the send and receive calls (blocking mode)
+  - Application registers callbacks and runs the libevent dispatch
+    loop (a.k.a. user dispatch mode)
+  - 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)
+- 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.
+
+- 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
+- [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
+- [DTLS] support
+
+* Found a bug?
+Please report it.  This 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
+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
+valuable for debugging.
+
+Contact: mailto:linus+libradsec@nordu.net