111c570198d333bc8a7ddc8280883c53c6d25453
[radsecproxy.git] / lib / README
1 Libradsec is a RADIUS library for clients doing RADIUS over UDP or
2 TLS. The goal is to add support for writing servers (and thus proxies)
3 and to add transports TCP and DTLS.
4
5
6 The canonical pickup point is
7 http://git.nordu.net/?p=radsecproxy.git;a=shortlog;h=refs/heads/libradsec
8
9
10 The source code is licensed under a 3-clause BSD license. See the
11 LICENSE file.
12
13
14 Libradsec depends on 
15 - libconfuse
16 - libevent2
17 - openssl (if configured with --enable-tls)
18
19
20 To compile the library and the examples, do something like
21
22   sh autogen.sh && ./configure && make
23
24
25 There are a couple of options that can be used when configuring. See
26
27   ./configure --help
28
29 for the full list. Worth mentioning here is --enable-tls and
30 --enable-tls-psk.
31
32 If the preprocessor has a hard time finding some of the header files
33 are, try setting environment variable CPPFLAGS at configure
34 time. Example:
35
36   CPPFLAGS="-I/usr/local/include" ./configure --enable-tls
37
38 If the link editor has trouble finding any of the libraries needed,
39 try setting environment variable LDFLAGS at configure time. Example:
40
41   LDFLAGS="-L/usr/local/lib" ./configure --enable-tls
42
43
44 The parts of the library which has been tested has been so on Linux
45 (Debian) with libconfuse (2.7), libevent (2.0.19) and OpenSSL
46 (1.0.1c).
47
48 The file HACKING contains more detailed info on the state of the
49 various parts of the library.