lib/HACKING


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

HACKING file for libradsec (in Emacs -*- org -*- mode).

Status as of libradsec-0.0.1-dev (2011-03-12).

* Build instructions
cd libradsec/lib
sh autogen.sh
./configure #--enable-tls
make

examples/client -r examples/client-tls.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?)

* Dependencies
This is on 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
  
* Functionality and quality
** Tested and verified
** Not well tested
- reading config file
- [TCP] short read
- [TCP] short write
- [TLS] basic tls support
** Known issues
- leaking memory
- error stack is only one entry deep
** Not implemented
- custom allocation scheme used in all places
- server failover
- [TLS] verification of CNAME
- [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.