dhcpinternals.h

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
/* @file dhcpinternals.h
 *  @brief IPv4 DHCP Client Header File for Internal Features
 */
 
/* @addtogroup groupDhcpIPv4 DHCP - IPv4 DHCP Client
 * @ingroup groupDhcp
 * \IncludeFileName \n\n
 * @{
 */
 
#include <basictypes.h>
#include <netinterface.h>
#include <string.h>
 
#ifndef _NB_DHCP_H
#define _NB_DHCP_H
 
#define OPT_SIZE 255        //< Size of options area
#define DHCP_OPT_OFFS 236   //< Offset into DHCP Message for options data
#define DHCP_CLIENT_PORT 68 //< Standard port assignment for client
#define DHCP_SERVER_PORT 67 //< Standard port assignment for server
 
#define DHCPDISCOVER 1 //< @b
#define DHCPOFFER 2    //< @b
#define DHCPREQUEST 3  //< @b
#define DHCPDECLINE 4  //< @b
#define DHCPACK 5      //< @b
#define DHCPNAK 6      //< @b
#define DHCPRELEASE 7  //< @b
#define DHCPINFORM 8   //< @b
#define DHCPERROR 99   //< @b
#define BOOTREQUEST 1 //< @b
#define BOOTREPLY 2   //< @b
#define DHCPOPT_SUBNET_MASK 1    //< Client subnet mask
#define DHCPOPT_ROUTER 3         //< Routers
#define DHCPOPT_TIME_SERVER 4    //< Time Servers
#define DHCPOPT_DNS_SERVER 6     //< DNS Server
#define DHCPOPT_LOG_SERVER 7     //< Log Server
#define DHCPOPT_HOST_NAME 12     //< Specifies name of client (Host Name Opt)
#define DHCPOPT_DOMAIN_NAME 15   //< Domain Name for hosts
#define DHCPOPT_NTP_SERVER 42    //< NTP Servers (different from tim)
#define DHCPOPT_REQ_IPADDR4 50   //< Client requested IP address
#define DHCPOPT_LEASE_TIME 51    //< IP addr lease time assigned by server
#define DHCPOPT_MSG_TYPE 53      //< Type of DHCP message
#define DHCPOPT_SERVER_ID 54     //< DHCP Server identifier
#define DHCPOPT_PARAM_REQ 55     //< Parameter request list
#define DHCPOPT_RENEW_TIME 58    //< # of seconds until client renewal state
#define DHCPOPT_REBIND_TIME 59   //< # of seconds until client rebinding state
#define DHCPOPT_CLIENT_ID 61     //< Unique client identifier
#define DHCPOPT_TFTP_SERVER 66   //< TFTP Server name/IP
#define DHCPOPT_BOOTFILE 67      //< TFTP Bootfile name
#define DHCPOPT_SMTP_SERVER 69   //< SMTP Server name/IP
 
#define DHCPOPT_END 255   //< End of options marker
#define DHCPCOOKIE0 (uint8_t)99  //< @b
#define DHCPCOOKIE1 (uint8_t)130 //< @b
#define DHCPCOOKIE2 (uint8_t)83  //< @b
#define DHCPCOOKIE3 (uint8_t)99  //< @b
#define PDM_DHCPOFFER   1  //< Received DHCPOFFER message
#define PDM_DHCPACK     2  //< Received DHCPACK message
#define PDM_DHCPNAK     3  //< Received DHCPNAK message
#define PDM_COMPLETE    4  //< DHCP configuration complete
#define PDM_ERROR      10  //< Received unknown message
typedef struct dhcp_msg
{
    uint8_t op;                  //< Message opcode; 1=bootrequest, 2=bootreply
    uint8_t htype;               //< Hardware address type; 1=10Mb ethernet
    uint8_t hlen;                //< Hardware address length; 6=10Mb ethernet
    uint8_t hops;                //< Client sets this to 0
    beuint32_t xid;              //< Transaction ID; random number
    beuint16_t secs;             //< Seconds elapsed since client request
    beuint16_t flags;            //< @b
    IPADDR4 ciaddr;              //< Clinet IP address if renew; filled by client
    IPADDR4 yiaddr;              //< Assigned client IP address
    IPADDR4 siaddr;              //< IP address of next server to use in bootstrap
    IPADDR4 giaddr;              //< Relay agent IP address (Gateway)
    uint8_t chaddr[16];          //< Client hardware address
    uint8_t sname[64];           //< Optional server host name
    uint8_t file[128];           //< Boot file name, null terminated string
    uint8_t options[OPT_SIZE];   //< Optional parameters field
} __attribute__((packed)) DHCP_MESSAGE;
class InterfaceBlock;
 
class DHCPMessage
{
   private:
    DHCP_MESSAGE Msg;
 
   public:
    // constructors
    DHCPMessage();
    DHCPMessage(puint8_t pData);
 
    // member functions
    void SetOp(uint8_t n) { Msg.op = n; }
 
    uint8_t GetMsgType() { return msg_type; }
 
    void SetHtype(uint8_t n) { Msg.htype = n; }
    void SetHlen(uint8_t n) { Msg.hlen = n; }
    void SetHops(uint8_t n) { Msg.hops = n; }
 
    void SetXid(uint32_t n) { Msg.xid = n; }
 
    void SetRandomXid(const MACADR &ma);
 
    void SetSecs(uint16_t n) { Msg.secs = n; }
    void SetFlags(uint16_t n) { Msg.flags = n; }
    void SetCiaddr(IPADDR4 i) { Msg.ciaddr = i; }
    void SetYiaddr(IPADDR4 i) { Msg.yiaddr = i; }
    void SetSiaddr(IPADDR4 i) { Msg.siaddr = i; }
    void SetGiaddr(IPADDR4 i) { Msg.giaddr = i; }
    void SetChaddr(MACADR ma)
    {
        memset(Msg.chaddr, 0x0, 16);
        for (int i = 0; i < 6; i++)
        {
            Msg.chaddr[i] = ma.GetByte(i);
        }
    }
 
    void SetSname(char *s) { memcpy(Msg.sname, s, 64); }
    void SetFile(char *s) { memcpy(Msg.file, s, 128); }
    void SetOptions(char *s) { memcpy(Msg.options, s, OPT_SIZE); }
 
    void SetOptionsIp(int &offset, IPADDR4 &ip4)
    {
        uint32_t u32 = (uint32_t)ip4;
        Msg.options[offset++] = ((u32 >> 24) & 0xff);
        Msg.options[offset++] = ((u32 >> 16) & 0xff);
        Msg.options[offset++] = ((u32 >> 8) & 0xff);
        Msg.options[offset++] = (u32 & 0xff);
    }
 
    void SetOptions(int i, uint8_t n) { Msg.options[i] = n; }
 
    uint32_t GetXid() { return Msg.xid; }
    uint16_t GetSecs() { return Msg.secs; }
    uint16_t GetFlags() { return Msg.flags; }
    IPADDR4 GetCiaddr() { return Msg.ciaddr; }
    IPADDR4 GetYiaddr() { return Msg.yiaddr; }
    IPADDR4 GetGiaddr() { return Msg.giaddr; }
    IPADDR4 GetSiaddr() { return Msg.siaddr; }
    uint8_t GetChaddr(int i) { return Msg.chaddr[i]; }
 
    puint8_t GetDataPtr() { return (uint8_t *)(&Msg); }
    int GetDataLen() { return sizeof(DHCP_MESSAGE); }
    void ShowMsg();                                 //< Displays DHCP message for debug purposes
    void CreateReply(uint32_t xid, uint32_t yip);   //< Sets the message as a blank BOOTP reply
    void ClearOptions();                            //< Clears options memory space and adds cookie
    void ResetBytes();                              //< Clear chaddr, sname, file, and option fields
    puint8_t GetOptionData(uint8_t code);           //< Returns option data for specified op code
    puint8_t GetOptionData(uint8_t code, int &length);
    void SendMsg(IPADDR4 IpAddr, InterfaceBlock *pIfb);         //< Send a DHPC message as a UDP packet
    void SendServerMsg(IPADDR4 IpAddr, InterfaceBlock *pIfb);   //< Send a DHPC message as a UDP packet, as server
    BOOL MsgForInterface(InterfaceBlock *pIfb);
    uint8_t msg_type;
};
void CreateDhcpDiscoverMsg(DHCPMessage &NewMsg, InterfaceBlock *pIfb);
void CreateDhcpRequestMsg(DHCPMessage &OfferMsg, DHCPMessage &NewMsg, InterfaceBlock *pIfb);
void CreateDhcpReleaseMsg(DHCPMessage &NewMsg, InterfaceBlock *pIfb);
void ShowDhcpConfig();                       //< Show DHCP configuration paramters
void UpdateIPRuntimeVars(BOOLEAN release);   //< Update DHCP & IP runtime vars
void DHCPTimer();                            //< Tracks lease time
int ExecDHCPClient(int DhcpState);           //< Function that does the work
BOOLEAN ValidDhcpMsg(puint8_t pData);        //< Verify the UDP packet contains a DHCP message
BOOLEAN DhcpConfig(DHCPMessage &Msg);        //< Configure client from DHCPACK message
extern void (*AddDhcpOptionsFunc)(DHCPMessage &NewMsg, int &opt, int MsgType);
extern void (*AddDhcpFieldsFunc)(DHCPMessage &NewMsg, int &opt, int MsgType);
extern void (*ParseDhcpOptions)(DHCPMessage &Msg);
#endif
 
/* @} */