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) assignment of addresses to source interface
  13         b) handling of valid and preferred lifetimes
  14         c) duplicate address detection
  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
  24 3. Stateless fallback-support
  25
  26 4. State script support
  27
  28 5. Support for requesting and parsing Router Advertisements
  29         a) parsing of prefixes, routes, MTU and RDNSS options
  30
  31
  32 ** Compiling **
  33
  34 odhcp6c uses cmake:
  35 * To prepare a Makefile use:  "cmake ."
  36 * To build / install use: "make" / "make install" afterwards.
  37 * To build DEB or RPM packages use: "make package" afterwards.
  38
  39
  40 ** State Script **
  41
  42 The state script is called whenever the DHCPv6 state changes.
  43 The script is called with the following parameters: <interface> <state>
  44
  45
  46 States:
  47 * started               The DHCPv6 client has been started
  48 * bound                 A suitable server was found and addresses or prefixes acquired
  49 * informed              A stateless information request returned updated information
  50 * updated               Updated information was received from the DHCPv6 server
  51 * ra-updated    Updated information was received from via Router Advertisement
  52 * rebound               The DHCPv6 client switched to another server
  53 * unbound               The DHCPv6 client lost all DHCPv6 servers and will restart
  54 * stopped               The DHCPv6 client has been stopped
  55
  56
  57 Environment:
  58 * RDNSS                 A space-separated list of recursive DNS servers
  59 * DOMAINS               A space-separated list of DNS search domains
  60 * SNTP_IP               A space-separated list of SNTP server IP addresses
  61 * SNTP_FQDN             A space-separated list of SNTP server FQDNs
  62 * SIP_IP                A space-separated list of SIP servers
  63 * SIP_DOMAIN            A space-separated list of SIP domains
  64 * OPTION_<num>  Custom option received as base-16
  65 * PREFIXES              A space-separated list of prefixes currently assigned
  66                                 Format: <prefix>/<length>,preferred,valid
  67 * ADDRESSES             A space-separated list of addresses currently assigned
  68                                 Format: <address>/<length>,preferred,valid
  69 * RA_ADDRESSES  A space-separated list of addresses from RA-prefixes
  70                                 Format: <address>/<length>,preferred,valid
  71 * RA_ROUTES             A space-separated list of routes from the RA
  72                                 Format: <address>/<length>,gateway,valid,metric
  73 * RA_DNS                A space-separated list of recursive DNS servers from the RA