]> git.decadent.org.uk Git - odhcp6c.git/blob - README
First hnet-based version.
[odhcp6c.git] / README
1 odhcp6c - Embedded DHCPv6 Client
2
3
4 ** Abstract **
5
6 odhcp6c is a minimalistic DHCPv6 client for use in embedded Linux systems.
7
8
9 ** Features **
10
11 1. Handling of non-temporary addresses
12         a) assignment of addresses to source interface
13         b) handling of valid and preferred lifetimes
14         c) duplicate address detection
15
16 2. Handling of IPv6-Prefixes (Prefix Delegation)
17         a) requesting of prefixes
18
19 3. Stateless fallback-support
20
21 4. State script support
22
23
24 ** Compiling **
25
26 odhcp6c uses cmake:
27 * To prepare a Makefile use:  "cmake ." 
28 * To build / install use: "make" / "make install" afterwards.
29 * To build DEB or RPM packages use: "make package" afterwards.
30
31
32 ** State Script **
33
34 The state script is called whenever the DHCPv6 state changes.
35 The script is called with the following parameters: <interface> <state>
36
37
38 States:
39 * started               The DHCPv6 client has been started
40 * bound                 A suitable server was found and addresses or prefixes acquired          
41 * informed              A stateless information request returned updated information
42 * updated               Updated information was received from the DHCPv6 server
43 * ra-updated    Updated information was received from via Router Advertisement
44 * rebound               The DHCPv6 client switched to another server
45 * unbound               The DHCPv6 client lost all DHCPv6 servers and will restart
46 * stopped               The DHCPv6 client has been stopped
47
48
49 Environment:
50 * RDNSS                 A space-separated list of recursive DNS servers
51 * DOMAINS               A space-separated list of DNS search domains
52 * SNTP_IP               A space-separated list of SNTP server IP addresses
53 * SNTP_FQDN             A space-separated list of SNTP server FQDNs
54 * SIP_IP                A space-separated list of SIP servers
55 * SIP_DOMAIN            A space-separated list of SIP domains
56 * OPTION_<num>  Custom option received as base-16
57 * PREFIXES              A space-separated list of prefixes currently assigned
58                                 Format: <prefix>/<length>,preferred,valid[,cls]
59 * ADDRESSES             A space-separated list of addresses currently assigned
60                                 Format: <address>/<length>,preferred,valid
61 * RA_ADDRESSES  A space-separated list of addresses from RA-prefixes
62                                 Format: <address>/<length>,preferred,valid
63 * RA_ROUTES             A space-separated list of routes from the RA
64                                 Format: <address>/<length>,gateway,valid,metric
65 * RA_DNS                A space-separated list of recursive DNS servers from the RA
66
67
68
69
70 ** Wishlist **
71
72 Features that I would like to see implemented in the near or far future:
73
74 * Reconfigure Authentication