HACKING file for libradsec (in Emacs -*- org -*- mode).
-Status as of libradsec-0.0.1 (2010-10-05).
+Status as of libradsec-0.0.1-dev (2011-03-24).
* Build instructions
cd libradsec/lib
-ln -s /usr/share/libtool/config/ltmain.sh .. # bug
sh autogen.sh
-./configure # bug -- won't complain when missing libraries
+./configure #--enable-tls
make
-examples/client examples/client.conf blocking ; echo $?
+
+examples/client -r examples/client.conf blocking-tls; echo $?
* Design of the API
-- There are three usage models.
- - You use the send and receive calls in blocking mode.
- - You run the libevent loop and get callbacks instead of doing
- blocking reads.
- - You run your own event loop, using fd's for select and do the i/o
- using the libradsec send/receive calls.
+- 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
-- libfreeradius-radius -- no i/o used
-- libconfuse
-- libevent 2.0.x -- not packaged yet!
+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
-** Tested and verified
** Not well tested
- reading config file
-- short read
-- short write
-- autoconf/automake/libtool
+- [TCP] short read
+- [TCP] short write
+- [TLS] basic tls support
** Known issues
-- leaking memory
-- udp issues with libevent
+- error stack is only one entry deep
** Not implemented
-- client: matching responses, resending packets
- custom allocation scheme used in all places
-- callbacks invoked properly
+ issue: libfreeradius-radius
- server failover
-- TLS support
-- TLS preshared key support
-- DTLS support
+- [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
projects / radsecproxy.git / blobdiff