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