summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLinus Nordberg <linus@nordu.net>2011-03-24 16:26:55 +0100
committerLinus Nordberg <linus@nordu.net>2011-03-24 16:26:55 +0100
commit147fb0662e21afa27e4ceac0b73450f1fac0a899 (patch)
tree3166d5e6a7c54db455c20540241900fab13152a8
parenta0ce75b4bacbc864070d085f9bd09a31f96d010f (diff)
Update README and HACKING.
-rw-r--r--lib/HACKING15
-rw-r--r--lib/README11
2 files changed, 16 insertions, 10 deletions
diff --git a/lib/HACKING b/lib/HACKING
index 6c502bd..e4d8d9f 100644
--- a/lib/HACKING
+++ b/lib/HACKING
@@ -1,6 +1,6 @@
HACKING file for libradsec (in Emacs -*- org -*- mode).
-Status as of libradsec-0.0.1-dev (2011-03-12).
+Status as of libradsec-0.0.1-dev (2011-03-24).
* Build instructions
cd libradsec/lib
@@ -8,7 +8,7 @@ sh autogen.sh
./configure #--enable-tls
make
-examples/client -r examples/client-tls.conf blocking-tls; echo $?
+examples/client -r examples/client.conf blocking-tls; echo $?
* Design of the API
- There are three usage modes
@@ -20,7 +20,7 @@ examples/client -r examples/client-tls.conf blocking-tls; echo $?
- Fully reentrant (FIXME: any issues with libfreeradius-radius?)
* Dependencies
-This is on Ubuntu 10.10.
+The details below apply to Ubuntu 10.10.
- libfreeradius-radius (2.1.9+dfsg-1ubuntu1)
sudo apt-get install libfreeradius-dev libfreeradius2
@@ -30,21 +30,22 @@ This is on Ubuntu 10.10.
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
* Functionality and quality
-** Tested and verified
** Not well tested
- reading config file
- [TCP] short read
- [TCP] short write
- [TLS] basic tls support
** Known issues
-- leaking memory
- error stack is only one entry deep
** Not implemented
- custom allocation scheme used in all places
+ issue: libfreeradius-radius
- server failover
-- [TLS] verification of CNAME
+- [TLS] verification of CN
- [TLS] preshared key support
- [DTLS] support
@@ -57,3 +58,5 @@ wrong.
Running the library under gdb is another good idea. If you experience
a crash, catching that in gdb and providing a backtrace is highly
valuable for debugging.
+
+Contact: mailto:linus+libradsec@nordu.net
diff --git a/lib/README b/lib/README
index 3a2556a..c76031a 100644
--- a/lib/README
+++ b/lib/README
@@ -1,9 +1,12 @@
-libradsec-0.0.1-dev is a non-working RADIUS library doing UDP, TCP,
-TLS and DTLS.
+libradsec is a RADIUS library for clients doing RADIUS over UDP or
+TLS. The goal is to add support for writing servers (and thus
+proxies) and to add transports TCP and DTLS.
-Canonical pickup point:
+
+The canonical pickup point is
http://git.nordu.net/?p=radsecproxy.git;a=shortlog;h=refs/heads/libradsec
+
libradsec depends on
- libradius from the FreeRADIUS freeradius-server
- libevent2
@@ -18,7 +21,7 @@ To compile the library and the examples, do something like
If any of the libraries are not found, try setting environment
variable LDFLAGS at configure time like so:
- LDFLAGS="-L/usr/lib/freeradius -L/usr/local/lib" ./configure
+ LDFLAGS="-L/usr/lib/freeradius -L/usr/local/lib" ./configure --enable-tls
The parts of the library which has been tested has been so on Linux