networking/udhcp/dhcpd.h

   1 /* vi: set sw=4 ts=4: */
   2 /* dhcpd.h */
   3 #ifndef UDHCP_DHCPD_H
   4 #define UDHCP_DHCPD_H 1
   5
   6 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
   7
   8 /************************************/
   9 /* Defaults _you_ may want to tweak */
  10 /************************************/
  11
  12 /* the period of time the client is allowed to use that address */
  13 #define LEASE_TIME              (60*60*24*10) /* 10 days of seconds */
  14 #define LEASES_FILE             CONFIG_DHCPD_LEASES_FILE
  15
  16 /* where to find the DHCP server configuration file */
  17 #define DHCPD_CONF_FILE         "/etc/udhcpd.conf"
  18
  19 struct option_set {
  20         uint8_t *data;
  21         struct option_set *next;
  22 };
  23
  24 struct static_lease {
  25         struct static_lease *next;
  26         uint32_t nip;
  27         uint8_t mac[6];
  28 };
  29
  30 struct server_config_t {
  31         char *interface;                /* interface to use */
  32 //TODO: ifindex, server_nip, server_mac
  33 // are obtained from interface name.
  34 // Instead of querying them *once*, create update_server_network_data_cache()
  35 // and call it before any usage of these fields.
  36 // update_server_network_data_cache() must re-query data
  37 // if more than N seconds have passed after last use.
  38         int ifindex;
  39         uint32_t server_nip;
  40 #if ENABLE_FEATURE_UDHCP_PORT
  41         uint16_t port;
  42 #endif
  43         uint8_t server_mac[6];          /* our MAC address (used only for ARP probing) */
  44         struct option_set *options;     /* list of DHCP options loaded from the config file */
  45         int verbose;
  46         /* start,end are in host order: we need to compare start <= ip <= end */
  47         uint32_t start_ip;              /* start address of leases, in host order */
  48         uint32_t end_ip;                /* end of leases, in host order */
  49         uint32_t lease;                 /* lease time in seconds (host order) */
  50         uint32_t max_leases;            /* maximum number of leases (including reserved address) */
  51         uint32_t auto_time;             /* how long should udhcpd wait before writing a config file.
  52                                          * if this is zero, it will only write one on SIGUSR1 */
  53         uint32_t decline_time;          /* how long an address is reserved if a client returns a
  54                                          * decline message */
  55         uint32_t conflict_time;         /* how long an arp conflict offender is leased for */
  56         uint32_t offer_time;            /* how long an offered address is reserved */
  57         uint32_t min_lease;             /* minimum lease time a client can request */
  58         uint32_t siaddr_nip;            /* "next server" bootp option */
  59         char *lease_file;
  60         char *pidfile;
  61         char *notify_file;              /* what to run whenever leases are written */
  62         char *sname;                    /* bootp server name */
  63         char *boot_file;                /* bootp boot file option */
  64         struct static_lease *static_leases; /* List of ip/mac pairs to assign static leases */
  65 };
  66
  67 #define server_config (*(struct server_config_t*)&bb_common_bufsiz1)
  68 /* client_config sits in 2nd half of bb_common_bufsiz1 */
  69
  70 #if ENABLE_FEATURE_UDHCP_PORT
  71 #define SERVER_PORT (server_config.port)
  72 #else
  73 #define SERVER_PORT 67
  74 #endif
  75
  76
  77 /*** leases.h ***/
  78
  79 typedef uint32_t leasetime_t;
  80 typedef int32_t signed_leasetime_t;
  81
  82 //TODO: (1) rename to dyn_lease (that's what it is. we also have static_lease).
  83 //(2) lease_mac16 may be shortened to lease_mac[6], since e.g. ARP probing uses
  84 //only 6 first bytes anyway. We can check received dhcp packets
  85 //that their "chaddr"s have only 6 first bytes != 0, and complain otherwise.
  86 struct dhcpOfferedAddr {
  87         uint8_t lease_mac16[16];
  88         /* "nip": IP in network order */
  89         uint32_t lease_nip;
  90         /* Unix time when lease expires. Kept in memory in host order.
  91          * When written to file, converted to network order
  92          * and adjusted (current time subtracted) */
  93         leasetime_t expires;
  94         uint8_t hostname[20]; /* (size is a multiply of 4) */
  95 };
  96
  97 extern struct dhcpOfferedAddr *leases;
  98
  99 struct dhcpOfferedAddr *add_lease(
 100                 const uint8_t *chaddr, uint32_t yiaddr,
 101                 leasetime_t leasetime, uint8_t *hostname
 102                 ) FAST_FUNC;
 103 int lease_expired(struct dhcpOfferedAddr *lease) FAST_FUNC;
 104 struct dhcpOfferedAddr *find_lease_by_chaddr(const uint8_t *chaddr) FAST_FUNC;
 105 struct dhcpOfferedAddr *find_lease_by_yiaddr(uint32_t yiaddr) FAST_FUNC;
 106 uint32_t find_free_or_expired_address(const uint8_t *chaddr) FAST_FUNC;
 107
 108
 109 /*** static_leases.h ***/
 110
 111 /* Config file parser will pass static lease info to this function
 112  * which will add it to a data structure that can be searched later */
 113 void add_static_lease(struct static_lease **st_lease_pp, uint8_t *mac, uint32_t nip) FAST_FUNC;
 114 /* Find static lease IP by mac */
 115 uint32_t get_static_nip_by_mac(struct static_lease *st_lease, void *arg) FAST_FUNC;
 116 /* Check to see if an IP is reserved as a static IP */
 117 int is_nip_reserved(struct static_lease *st_lease, uint32_t nip) FAST_FUNC;
 118 /* Print out static leases just to check what's going on (debug code) */
 119 void print_static_leases(struct static_lease **st_lease_pp) FAST_FUNC;
 120
 121
 122 /*** serverpacket.h ***/
 123
 124 int send_offer(struct dhcpMessage *oldpacket) FAST_FUNC;
 125 int send_NAK(struct dhcpMessage *oldpacket) FAST_FUNC;
 126 int send_ACK(struct dhcpMessage *oldpacket, uint32_t yiaddr) FAST_FUNC;
 127 int send_inform(struct dhcpMessage *oldpacket) FAST_FUNC;
 128
 129
 130 /*** files.h ***/
 131
 132 void read_config(const char *file) FAST_FUNC;
 133 void write_leases(void) FAST_FUNC;
 134 void read_leases(const char *file) FAST_FUNC;
 135 struct option_set *find_option(struct option_set *opt_list, uint8_t code) FAST_FUNC;
 136
 137
 138 POP_SAVED_FUNCTION_VISIBILITY
 139
 140 #endif