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