lib/HACKING

   1 HACKING file for libradsec (in Emacs -*- org -*- mode).
   2
   3 Status as of libradsec-0.0.2.dev (2011-03-24).
   4
   5 * Build instructions
   6 sh autogen.sh
   7 ./configure #--enable-tls
   8 make
   9
  10 examples/client -r examples/client.conf blocking-tls; echo $?
  11
  12 * Design of the API
  13 - There are three usage modes
  14   - Application use the send and receive calls (blocking mode)
  15   - Application registers callbacks and runs the libevent dispatch
  16     loop (a.k.a. user dispatch mode)
  17   - Application runs its own event loop, using fd's for select and
  18     performs I/O using the libradsec send/receive calls
  19     (a.k.a. on-your-own mode)
  20 - Fully reentrant
  21 - User chooses allocation regime
  22
  23 Note that as of 0.0.2.dev libradsec suffers from way too much focus on
  24 the behaviour of a blocking client and is totally useless as a server.
  25 Not only does it lack most of the functions needed for writing a
  26 server but it also contains at least one architectural mishap which
  27 kills the server idea -- a connection timeout (TCP) or a retransmit
  28 timeout (UDP) will result in the event loop being broken. The same
  29 thing will happen if there's an error on a TCP connection, f.ex. a
  30 failing certificate validation (TLS).
  31
  32 * Dependencies
  33 Details (within parentheses) apply to Debian Wheezy.
  34
  35 - libconfuse (2.7-4)
  36   sudo apt-get install libconfuse-dev libconfuse0
  37 - libevent2 (2.0.19-stable-3)
  38   sudo apt-get install libevent-dev libevent-2.0-5
  39 - OpenSSL (1.0.1c-4) -- optional, for TLS and DTLS support
  40   sudo apt-get install libssl-dev libssl1.0.0
  41
  42 * Functionality and quality
  43 ** Not well tested
  44 - reading config file
  45 - [TCP] short read
  46 - [TCP] short write
  47 - [TLS] basic tls support
  48 - [TLS] preshared key support
  49 - [TLS] verification of CN
  50
  51 ** Known issues
  52 - error stack is only one entry deep
  53 - custom allocation scheme is not used in all places
  54
  55 ** Not implemented
  56 - [client] server failover
  57 - [DTLS] support
  58 - [server] support
  59
  60 * Found a bug?
  61 Please report it. That is how we improve the quality of the code.
  62
  63 If possible, please build the library with DEBUG defined (CFLAGS="-g
  64 -DDEBUG") and reproduce the problem. With DEBUG defined, lots of
  65 asserts are enabled which might give a hint about what's gone wrong.
  66
  67 Running the library under gdb is another good idea. If you experience
  68 a crash, catching the crash in gdb and providing a backtrace is highly
  69 valuable for debugging.
  70
  71 Contact: mailto:linus+libradsec@nordu.net