1 HACKING file for libradsec (in Emacs -*- org -*- mode).
3 Status as of libradsec-0.0.4 (2013-12-18).
10 examples/client -r examples/client.conf blocking-tls; echo $?
13 - There are three usage modes:
15 - Application uses blocking send and receive calls (blocking
16 mode). This is typically fine for a simple client.
18 - Application registers callbacks with libradsec and runs the
19 libevent dispatch loop (a.k.a. user dispatch mode). This would
20 probably how to implement a server or a proxy.
22 - Application runs its own event loop, using fd's for select and
23 performs I/O using libradsec send/receive functions
24 (a.k.a. on-your-own mode). Might be useful for an application
25 which already has an event loop that wants to add RadSec
28 - Apart from configuration and error handling, an application
29 shouldn't need to handle TCP and UDP connections
30 differently. Similarly, the use of TLS/DTLS or not shouldn't
31 influence the libradsec calls made by the application.
33 - Configuration is done either by using the API or by pointing at a
34 configuration file which is parsed by libradsec.
38 - Application chooses allocation regime.
40 Note that as of 0.0.4 libradsec suffers from way too much focus on
41 the behaviour of a blocking client and is totally useless as a server.
42 Not only does it lack most of the functions needed for writing a
43 server but it also contains at least one architectural mishap which
44 kills the server idea -- a connection timeout (TCP) or a retransmit
45 timeout (UDP) will result in the event loop being broken. The same
46 thing will happen if there's an error on a TCP connection, f.ex. a
47 failing certificate validation (TLS).
50 Details (within parentheses) apply to Debian Wheezy.
53 sudo apt-get install libconfuse-dev libconfuse0
54 - libevent2 (2.0.19-stable-3)
55 sudo apt-get install libevent-dev libevent-2.0-5
56 - OpenSSL (1.0.1c-4) -- optional, for TLS and DTLS support
57 sudo apt-get install libssl-dev libssl1.0.0
59 * Functionality and quality in 0.0.x
64 - [TLS] basic tls support
65 - [TLS] preshared key support
66 - [TLS] verification of CN
69 - error stack is only one entry deep
70 - custom allocation scheme is not used in all places
73 - dispatch mode (planned for 0.1)
74 - [client] server failover / RFC3539 watchdog (planned for 0.1)
75 - [server] support (planned for 0.2)
76 - [client] TCP keepalive
81 Please report it. That is how we improve the quality of the code.
83 If possible, please build the library with DEBUG defined (CFLAGS="-g
84 -DDEBUG") and reproduce the problem. With DEBUG defined, lots of
85 asserts are enabled which might give a hint about what's gone wrong.
87 Running the library under gdb is another good idea. If you experience
88 a crash, catching the crash in gdb and providing a backtrace is highly
89 valuable for debugging.
91 Contact: mailto:linus+libradsec@nordu.net