File dhcp.h of Package coovachilli
/*
* DHCP library functions
* Copyright (C) 2003, 2004, 2005 Mondru AB.
* Copyright (c) 2007 David Bird <david@coova.com>
*
* The contents of this file may be used under the terms of the GNU
* General Public License Version 2, provided that the above copyright
* notice and this permission notice is included in all copies or
* substantial portions of the software.
*
* The initial developer of the original code is
* Jens Jakobsen <jj@chillispot.org>
*
*/
#ifndef _DHCP_H
#define _DHCP_H
#include "pkt.h"
#include "garden.h"
/* Option constants */
#define DHCP_OPTION_MAGIC_LEN 4
#define DHCP_OPTION_PAD 0
#define DHCP_OPTION_SUBNET_MASK 1
#define DHCP_OPTION_ROUTER_OPTION 3
#define DHCP_OPTION_DNS 6
#define DHCP_OPTION_DOMAIN_NAME 15
#define DHCP_OPTION_INTERFACE_MTU 26
#define DHCP_OPTION_REQUESTED_IP 50
#define DHCP_OPTION_LEASE_TIME 51
#define DHCP_OPTION_MESSAGE_TYPE 53
#define DHCP_OPTION_SERVER_ID 54
#define DHCP_OPTION_END 255
/* BOOTP Message Types */
#define DHCP_BOOTREQUEST 1
#define DHCP_BOOTREPLY 2
/* DHCP Message Types */
#define DHCPDISCOVER 1
#define DHCPOFFER 2
#define DHCPREQUEST 3
#define DHCPDECLINE 4
#define DHCPACK 5
#define DHCPNAK 6
#define DHCPRELEASE 7
/* UDP Ports */
#define DHCP_BOOTPS 67
#define DHCP_BOOTPC 68
#define DHCP_DNS 53
/* TCP Ports */
#define DHCP_HTTP 80
#define DHCP_HTTPS 443
#define DHCP_ARP_REQUEST 1
#define DHCP_ARP_REPLY 2
#define DHCP_DNS_HLEN 12
struct dhcp_t; /* Forward declaration */
/* Authentication states */
#define DHCP_AUTH_NONE 0
#define DHCP_AUTH_DROP 1
#define DHCP_AUTH_PASS 2
#define DHCP_AUTH_UNAUTH_TOS 3
#define DHCP_AUTH_AUTH_TOS 4
#define DHCP_AUTH_DNAT 5
#define DHCP_DOMAIN_LEN 30
#define DHCP_DNAT_MAX 64
struct dhcp_conn_t {
int inuse; /* Free = 0; Inuse = 1 */
time_t lasttime; /* Last time we heard anything from client */
struct dhcp_conn_t *nexthash; /* Linked list part of hash table */
struct dhcp_conn_t *next; /* Next in linked list. 0: Last */
struct dhcp_conn_t *prev; /* Previous in linked list. 0: First */
struct dhcp_t *parent; /* Parent of all connections */
void *peer; /* Peer protocol handler */
uint8_t ourmac[PKT_ETH_ALEN]; /* Our MAC address */
uint8_t hismac[PKT_ETH_ALEN]; /* Peer's MAC address */
struct in_addr ourip; /* IP address to listen to */
struct in_addr hisip; /* Client IP address */
struct in_addr hismask; /* Client Network Mask */
struct in_addr dns1; /* Client DNS address */
struct in_addr dns2; /* Client DNS address */
char domain[DHCP_DOMAIN_LEN];/* Domain name to use for DNS lookups */
int authstate; /* 0: Unauthenticated, 1: Authenticated */
uint8_t unauth_cp; /* Unauthenticated codepoint */
uint8_t auth_cp; /* Authenticated codepoint */
int nextdnat; /* Next location to use for DNAT */
uint32_t dnatip[DHCP_DNAT_MAX]; /* Destination NAT destination IP address */
uint16_t dnatport[DHCP_DNAT_MAX]; /* Destination NAT source port */
uint8_t dnatmac[DHCP_DNAT_MAX][PKT_ETH_ALEN]; /* Destination NAT source mac */
/* uint16_t mtu; Maximum transfer unit */
};
/* ***********************************************************
* Information storage for each dhcp instance
*
* Normally each instance of the application corresponds to
* one instance of a dhcp instance.
*
*************************************************************/
struct dhcp_t {
/* Parameters related to the network interface */
int numconn; /* Maximum number of connections */
int fd; /* File descriptor to network interface */
char devname[IFNAMSIZ];/* Name of the network interface */
int devflags; /* Original flags of network interface */
unsigned char hwaddr[PKT_ETH_ALEN]; /* Hardware address of interface */
int ifindex; /* Hardware address of interface */
#if defined(__FreeBSD__) || defined (__APPLE__) || defined (__OpenBSD__)
char *rbuf;
size_t rbuf_max;
size_t rbuf_offset;
size_t rbuf_len;
#endif
int arp_fd; /* File descriptor to network interface */
unsigned char arp_hwaddr[PKT_ETH_ALEN]; /* Hardware address of interface */
int arp_ifindex; /* Hardware address of interface */
int eapol_fd; /* File descriptor to network interface */
unsigned char eapol_hwaddr[PKT_ETH_ALEN]; /* Hardware address of interface */
int eapol_ifindex; /* Hardware address of interface */
int debug; /* Set to print debug messages */
struct in_addr ourip; /* IP address to listen to */
int mtu; /* Maximum transfer unit */
uint32_t lease; /* Seconds before reneval */
int usemac; /* Use given mac address */
int promisc; /* Set interface in promisc mode */
int allowdyn; /* Allow allocation of IP address on DHCP request */
struct in_addr uamlisten; /* IP address to redirect HTTP requests to */
uint16_t uamport; /* TCP port to redirect HTTP requests to */
struct in_addr *authip; /* IP address of authentication server */
int authiplen; /* Number of authentication server IP addresses */
int anydns; /* Allow any dns server */
/* Connection management */
struct dhcp_conn_t *conn;
struct dhcp_conn_t *firstfreeconn; /* First free in linked list */
struct dhcp_conn_t *lastfreeconn; /* Last free in linked list */
struct dhcp_conn_t *firstusedconn; /* First used in linked list */
struct dhcp_conn_t *lastusedconn; /* Last used in linked list */
/* Hash related parameters */
int hashsize; /* Size of hash table */
int hashlog; /* Log2 size of hash table */
int hashmask; /* Bitmask for calculating hash */
struct dhcp_conn_t **hash; /* Hashsize array of pointer to member */
pass_through pass_throughs[MAX_PASS_THROUGHS];
size_t num_pass_throughs;
/* Call back functions */
int (*cb_data_ind) (struct dhcp_conn_t *conn, void *pack, size_t len);
int (*cb_eap_ind) (struct dhcp_conn_t *conn, void *pack, size_t len);
int (*cb_request) (struct dhcp_conn_t *conn, struct in_addr *addr);
int (*cb_connect) (struct dhcp_conn_t *conn);
int (*cb_disconnect) (struct dhcp_conn_t *conn, int term_cause);
int (*cb_getinfo) (struct dhcp_conn_t *conn, bstring b, int fmt);
};
/* External API functions */
extern const char* dhcp_version();
extern int
dhcp_new(struct dhcp_t **dhcp, int numconn, char *interface,
int usemac, uint8_t *mac, int promisc,
struct in_addr *listen, int lease, int allowdyn,
struct in_addr *uamlisten, uint16_t uamport,
int useeapol);
extern int
dhcp_set(struct dhcp_t *dhcp, int debug);
extern int
dhcp_free(struct dhcp_t *dhcp);
extern int
dhcp_timeout(struct dhcp_t *this);
extern struct timeval*
dhcp_timeleft(struct dhcp_t *this, struct timeval *tvp);
extern int
dhcp_validate(struct dhcp_t *this);
extern int
dhcp_set_addrs(struct dhcp_conn_t *conn,
struct in_addr *hisip, struct in_addr *hismask,
struct in_addr *ourip,
struct in_addr *dns1, struct in_addr *dns2, char *domain);
/* Called whenever a packet arrives */
extern int
dhcp_decaps(struct dhcp_t *this);
extern int
dhcp_data_req(struct dhcp_conn_t *conn, void *pack, size_t len);
extern int
dhcp_set_cb_data_ind(struct dhcp_t *this,
int (*cb_data_ind) (struct dhcp_conn_t *conn, void *pack, size_t len));
extern int
dhcp_set_cb_request(struct dhcp_t *this,
int (*cb_request) (struct dhcp_conn_t *conn, struct in_addr *addr));
extern int
dhcp_set_cb_disconnect(struct dhcp_t *this,
int (*cb_disconnect) (struct dhcp_conn_t *conn, int term_cause));
extern int
dhcp_set_cb_connect(struct dhcp_t *this,
int (*cb_connect) (struct dhcp_conn_t *conn));
extern int
dhcp_set_cb_eap_ind(struct dhcp_t *this,
int (*cb_eap_ind) (struct dhcp_conn_t *conn, void *pack, size_t len));
extern int
dhcp_set_cb_getinfo(struct dhcp_t *this,
int (*cb_getinfo) (struct dhcp_conn_t *conn, bstring b, int fmt));
extern int
dhcp_hashget(struct dhcp_t *this, struct dhcp_conn_t **conn,
uint8_t *hwaddr);
extern int
dhcp_newconn(struct dhcp_t *this, struct dhcp_conn_t **conn,
uint8_t *hwaddr);
extern
int dhcp_freeconn(struct dhcp_conn_t *conn, int term_cause);
extern int
dhcp_arp_ind(struct dhcp_t *this); /* ARP Indication */
extern int dhcp_sendEAP(struct dhcp_conn_t *conn, void *pack, size_t len);
extern int dhcp_sendEAPreject(struct dhcp_conn_t *conn, void *pack, size_t len);
extern int dhcp_eapol_ind(struct dhcp_t *this);
void dhcp_release_mac(struct dhcp_t *this, uint8_t *hwaddr, int term_cause);
#define LIST_SHORT_FMT 0
#define LIST_LONG_FMT 1
#define LIST_JSON_FMT 2
void dhcp_list(struct dhcp_t *this, int sock, int listfmt);
void dhcp_print(struct dhcp_t *this, int sock, int listfmt, struct dhcp_conn_t *conn);
int dhcp_filterDNS(struct dhcp_conn_t *conn,
struct pkt_ippacket_t *pack,
size_t *plen);
#endif /* !_DHCP_H */
