secure: install extra (documention) files
[olsrd.git] / lib / secure / README_SECURE
1
2
3 Secure OLSR 0.4 implementation notes
4 (c)Andreas Tonnesen 2004
5
6 This document contains information on how to
7 use the secure OLSR plugin with the UniK olsr daemon.
8 It does _not_ cover secure OLSR protocol issues.
9
10 Lines starting with '# ' indicates shell commands.
11
12 The plugin encrypts all traffic on an OLSRd network, and uses a shared secret
13 key for signature generation and verification. For nodes to participate in the
14 OLSR routing domain they need to use the key used by the other nodes.
15
16 NOTES
17
18   The plugin interface and olsrd output buffering was
19   heavily rewritten for the 0.4.8 release. The plugin
20   should work with this release - but has not been
21   tested much.
22
23 COMPILING
24
25   To compile simply do:
26   # make
27   This compiles the local MD5 function and the plugin has
28   no external dependencies.
29   If you want the plugin to use SHA-1 using the openssl libs
30   do:
31   # make USE_OPENSSL=1
32
33 INSTALLING
34
35   To install:
36   # make install
37
38   This will run ldconfig to update the dynamic linker.
39   It might take a while.
40
41 USAGE
42
43   To make olsrd load the secure OLSR plugin add the
44   following in the olsrd configuration file:
45
46 LoadPlugin "olsrd_secure.so.0.6"
47 {
48     # PlParam     "keyfile"            "/etc/olsr-keyfile.txt"
49 }
50
51   replacing FILENAME with the full path of the file
52   containing the shared key.
53
54   The plugin uses this shared secret key for signature
55   generation and verification. For nodes to participate 
56   in the OLSR routing domain they need to use the key 
57   used by the other nodes.
58   The key is 128-bits of size and is read from the
59   specified file from the config file or by default from:
60   /etc/olsrd.d/olsrd_secure_key
61
62   Copy the key to this file an all nodes. The plugin
63   will terminate olsrd if this file cannot be found.
64
65   Now start olsrd and the let the plugin do its
66   thing :)
67
68 - Andreas