README

   1 odhcp6c - Embedded DHCPv6 Client
   2
   3
   4 ** Abstract **
   5
   6 odhcp6c is a minimal DHCPv6 and RA-client for use in embedded Linux systems.
   7
   8
   9 ** Features **
  10
  11 1. Handling of non-temporary addresses
  12         a) handling of valid and preferred lifetimes
  13         b) duplicate address detection
  14         c) automatic fallback to stateless or PD-only mode
  15
  16 2. Support for DHCPv6 extension
  17         a) Reconfigure-Messages
  18         b) Prefix Delegation
  19         c) Prefix Exclusion
  20         d) DNS Configuration Options
  21         e) NTP Options
  22         f) SIP Options
  23         g) Information-Refresh Options
  24         h) SOL_MAX_RT default to 3600
  25
  26 3. Stateless fallback-support
  27
  28 4. State script support
  29
  30 5. Support for requesting and parsing Router Advertisements
  31         a) parsing of prefixes, routes, MTU and RDNSS options
  32
  33
  34 ** Compiling **
  35
  36 odhcp6c uses cmake:
  37 * To prepare a Makefile use:  "cmake ."
  38 * To build / install use: "make" / "make install" afterwards.
  39 * To build DEB or RPM packages use: "make package" afterwards.
  40
  41
  42 ** State Script **
  43
  44 The state script is called whenever the DHCPv6 state changes.
  45 The script is called with the following parameters: <interface> <state>
  46
  47
  48 States:
  49 * started               The DHCPv6 client has been started
  50 * bound                 A suitable server was found and addresses or prefixes acquired
  51 * informed              A stateless information request returned updated information
  52 * updated               Updated information was received from the DHCPv6 server
  53 * ra-updated    Updated information was received from via Router Advertisement
  54 * rebound               The DHCPv6 client switched to another server
  55 * unbound               The DHCPv6 client lost all DHCPv6 servers and will restart
  56 * stopped               The DHCPv6 client has been stopped
  57
  58
  59 Environment:
  60 * RDNSS                 A space-separated list of recursive DNS servers
  61 * DOMAINS               A space-separated list of DNS search domains
  62 * SNTP_IP               A space-separated list of SNTP server IP addresses
  63 * SNTP_FQDN             A space-separated list of SNTP server FQDNs
  64 * SIP_IP                A space-separated list of SIP servers
  65 * SIP_DOMAIN            A space-separated list of SIP domains
  66 * OPTION_<num>  Custom option received as base-16
  67 * PREFIXES              A space-separated list of prefixes currently assigned
  68                                 Format: <prefix>/<length>,preferred,valid,<excluded-prefix>/<length>
  69 * ADDRESSES             A space-separated list of addresses currently assigned
  70                                 Format: <address>/<length>,preferred,valid
  71 * RA_ADDRESSES  A space-separated list of addresses from RA-prefixes
  72                                 Format: <address>/<length>,preferred,valid
  73 * RA_ROUTES             A space-separated list of routes from the RA
  74                                 Format: <address>/<length>,gateway,valid,metric
  75 * RA_DNS                A space-separated list of recursive DNS servers from the RA