Update status in HACKING.
[radsecproxy.git] / lib / HACKING
1 HACKING file for libradsec (in Emacs -*- org -*- mode).
2
3 Status as of libradsec-0.0.1-dev (2011-02-28).
4
5 * Build instructions
6 cd libradsec/lib
7 sh autogen.sh
8 ./configure
9 make
10
11
12 examples/client -r examples/client-tls.conf blocking-tls ; echo $?
13
14 * Design of the API
15 - There are three usage modes
16   - You use the send and receive calls (blocking mode)
17   - You register callbacks and run the libevent dispatch loop (user
18     dispatch mode)
19   - You run your own event loop, using fd's for select and do the I/O
20     using the libradsec send/receive calls (on-your-own mode)
21 - Fully reentrant (FIXME: any issues with libfreeradius-radius?)
22
23 * Dependencies
24 - libfreeradius-radius -- no i/o used
25 - libconfuse
26 - libevent 2.0.x
27
28 * Functionality and quality
29 ** Tested and verified
30 ** Not well tested
31 - reading config file
32 - short read
33 - short write
34 - basic tls support
35 ** Known issues
36 - leaking memory
37 - udp issues with libevent
38 - error stack is one entry deep
39 ** Not implemented
40 - client: udp (resending packets), access-challenge, read/write timeout
41 - custom allocation scheme used in all places
42 - server failover
43 - TLS: verify CNAME
44 - TLS preshared key support
45 - DTLS support