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.2.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
- - 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?)
+ - 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
+thing will happen if there's an error on a TCP connection, f.ex. a
+failing certificate validation (TLS).
* Dependencies
-- libfreeradius-radius -- no i/o used
-- libconfuse
-- libevent 2.0.x
+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
-** 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
+- [TLS] preshared key support
+- [TLS] verification of CN
** Known issues
-- leaking memory
-- udp issues with libevent
-- error stack is one entry deep
+- error stack is only one entry deep
+- custom allocation scheme is not used in all places
** Not implemented
-- client: udp (resending packets), access-challenge, read/write timeout
-- custom allocation scheme used in all places
- server failover
-- TLS: verify CNAME
-- TLS preshared key support
-- DTLS support
+- [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
projects / radsecproxy.git / blobdiff