summaryrefslogtreecommitdiff
path: root/lib/HACKING
diff options
context:
space:
mode:
authorLinus Nordberg <linus@nordberg.se>2013-01-21 10:50:53 +0100
committerLinus Nordberg <linus@nordberg.se>2013-01-21 10:59:42 +0100
commitb8260ee68d9bc60f3204f860cc6919964a6e9464 (patch)
treef463a573a83951fb229a358425e08d9c7484268b /lib/HACKING
parent8f6155f3fa89f0b8c16bdc3b73db2d479105aab4 (diff)
Update README and HACKING.libradsec-new-client
Whitespace fixes. Say Debian instead of Ubuntu. Update versions of library dependencies. HACKING: Revive the "fully reentrant" design goal. Admit that we don't implement a server API.
Diffstat (limited to 'lib/HACKING')
-rw-r--r--lib/HACKING31
1 files changed, 17 insertions, 14 deletions
diff --git a/lib/HACKING b/lib/HACKING
index 36287b8..b9ccd6b 100644
--- a/lib/HACKING
+++ b/lib/HACKING
@@ -18,6 +18,7 @@ examples/client -r examples/client.conf blocking-tls; echo $?
- Application runs its own event loop, using fd's for select and
performs I/O using the libradsec send/receive calls
(a.k.a. on-your-own mode)
+- Fully reentrant
- User chooses allocation regime
Note that as of 0.0.2.dev libradsec suffers from way too much focus on
@@ -25,20 +26,19 @@ the behaviour of a blocking client and is totally useless as a server.
Not only does it lack most of the functions needed for writing a
server but it also contains at least one architectural mishap which
kills the server idea -- a connection timeout (TCP) or a retransmit
-timeout (UDP) will result in the event loop being broken. The same
+timeout (UDP) will result in the event loop being broken. The same
thing will happen if there's an error on a TCP connection, f.ex. a
failing certificate validation (TLS).
+
* Dependencies
-Details apply to Ubuntu 10.10.
+Details (within parentheses) apply to Debian Wheezy.
-- libconfuse (2.7-1)
+- libconfuse (2.7-4)
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
-- OpenSSL (optional, for TLS and DTLS support)
- sudo apt-get install libssl-dev
+- libevent2 (2.0.19-stable-3)
+ sudo apt-get install libevent-dev libevent-2.0-5
+- OpenSSL (1.0.1c-4) -- optional, for TLS and DTLS support
+ sudo apt-get install libssl-dev libssl1.0.0
* Functionality and quality
** Not well tested
@@ -48,22 +48,25 @@ Details apply to Ubuntu 10.10.
- [TLS] basic tls support
- [TLS] preshared key support
- [TLS] verification of CN
+
** Known issues
- error stack is only one entry deep
- custom allocation scheme is not used in all places
+
** Not implemented
-- server failover
+- [client] server failover
- [DTLS] support
+- [server] support
* Found a bug?
-Please report it. This is how we improve the quality of the code.
+Please report it. That is how we improve the quality of the code.
If possible, please build the library with DEBUG defined (CFLAGS="-g
--DDEBUG") and reproduce the problem. With DEBUG defined, lots of
+-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 it in gdb and providing a backtrace is highly
+Running the library under gdb is another good idea. If you experience
+a crash, catching the crash in gdb and providing a backtrace is highly
valuable for debugging.
Contact: mailto:linus+libradsec@nordu.net