lib/HACKING

   1 HACKING file for libradsec (in Emacs -*- org -*- mode).
   2
   3 Status as of libradsec-0.0.1 (2010-10-05).
   4
   5 * Build instructions
   6 cd libradsec/lib
   7 ln -s /usr/share/libtool/config/ltmain.sh ..    # bug
   8 sh autogen.sh
   9 ./configure     # bug -- won't complain when missing libraries
  10 make
  11 examples/client examples/client.conf blocking ; echo $?
  12
  13 * Design of the API
  14 - There are three usage models.
  15   - You use the send and receive calls in blocking mode.
  16   - You run the libevent loop and get callbacks instead of doing
  17     blocking reads.
  18   - You run your own event loop, using fd's for select and do the i/o
  19     using the libradsec send/receive calls.
  20 - Fully reentrant (FIXME: any issues with libfreeradius-radius?)
  21
  22 * Dependencies
  23 - libfreeradius-radius -- no i/o used
  24 - libconfuse
  25 - libevent 2.0.x -- not packaged yet!
  26
  27 * Functionality and quality
  28 ** Tested and verified
  29 ** Not well tested
  30 - reading config file
  31 - short read
  32 - short write
  33 - autoconf/automake/libtool
  34 ** Known issues
  35 - leaking memory
  36 - udp issues with libevent
  37 ** Not implemented
  38 - client: matching responses, resending packets
  39 - custom allocation scheme used in all places
  40 - callbacks invoked properly
  41 - server failover
  42 - TLS support
  43 - TLS preshared key support
  44 - DTLS support