Merge branch 'libradsec' into libradsec-server-support
[libradsec.git] / lib / README
1 Libradsec is a RADIUS library for clients doing RADIUS over UDP or
2 TLS. The goal is to eventually add transports TCP and DTLS.
3
4
5  * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE *
6
7 This branch (libradsec-server-support) is extremely unstable and will
8 see changes its to public API:s for sure. It _will_ be rebased without
9 any warning what so ever. Yuo probably don't want to follow this
10 branch.
11
12  * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE *
13
14
15 The canonical pickup point is
16 http://git.nordu.net/?p=radsecproxy.git;a=shortlog;h=refs/heads/libradsec
17
18
19 The source code is licensed under a 3-clause BSD license. See the
20 LICENSE file.
21
22
23 Libradsec depends on
24 - libconfuse
25 - libevent2
26 - openssl (if configured with --enable-tls)
27
28
29 For changes between releases, see the CHANGES file.
30
31
32 To compile the library and the examples, do something like
33
34   sh autogen.sh && ./configure && make
35
36
37 There are a couple of options that can be used when configuring. See
38
39   ./configure --help
40
41 for the full list. Worth mentioning here is --enable-tls and
42 --enable-tls-psk.
43
44 If the preprocessor has a hard time finding some of the header files
45 are, try setting environment variable CPPFLAGS at configure
46 time. Example:
47
48   CPPFLAGS="-I/usr/local/include" ./configure --enable-tls
49
50 If the link editor has trouble finding any of the libraries needed,
51 try setting environment variable LDFLAGS at configure time. Example:
52
53   LDFLAGS="-L/usr/local/lib" ./configure --enable-tls
54
55
56 The parts of the library which has been tested has been so on Linux
57 (Debian) with libconfuse (2.7), libevent (2.0.19) and OpenSSL
58 (1.0.1c).
59
60 The file HACKING contains more detailed info on the state of the
61 various parts of the library.