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 cd libradsec/lib
   7 sh autogen.sh
   8 ./configure #--enable-tls
   9 make
  10
  11 examples/client -r examples/client.conf blocking-tls; echo $?
  12
  13 * Design of the API
  14 - There are three usage modes
  15   - Application use the send and receive calls (blocking mode)
  16   - Application registers callbacks and runs the libevent dispatch
  17     loop (a.k.a. user dispatch mode)
  18   - Application runs its own event loop, using fd's for select and
  19     performs I/O using the libradsec send/receive calls
  20     (a.k.a. on-your-own mode)
  21 - User chooses allocation regime
  22
  23 * Dependencies
  24 Details apply to Ubuntu 10.10.
  25
  26 - libconfuse (2.7-1)
  27   sudo apt-get install libconfuse-dev libconfuse0
  28 - libevent from source (release-2.0.10-stable)
  29   git clone --branch release-2.0.10-stable git://levent.git.sourceforge.net/gitroot/levent/levent
  30   cd levent; sh autogen.sh && ./configure --enable-openssl
  31   make && sudo make install
  32 - OpenSSL (optional, for TLS and DTLS support)
  33   sudo apt-get install libssl-dev
  34
  35 * Functionality and quality
  36 ** Not well tested
  37 - reading config file
  38 - [TCP] short read
  39 - [TCP] short write
  40 - [TLS] basic tls support
  41 ** Known issues
  42 - error stack is only one entry deep
  43 - custom allocation scheme is not used in all places
  44 ** Not implemented
  45 - server failover
  46 - [TLS] verification of CN
  47 - [TLS] preshared key support
  48 - [DTLS] support
  49
  50 * Found a bug?
  51 Please report it.  This is how we improve the quality of the code.
  52
  53 If possible, please build the library with DEBUG defined (CFLAGS="-g
  54 -DDEBUG") and reproduce the problem.  With DEBUG defined, lots of
  55 asserts are enabled which might give a hint about what's gone wrong.
  56
  57 Running the library under gdb is another good idea.  If you experience
  58 a crash, catching it in gdb and providing a backtrace is highly
  59 valuable for debugging.
  60
  61 Contact: mailto:linus+libradsec@nordu.net