gdhcp/gdhcp.h

   1 /*
   2  *
   3  *  DHCP library with GLib integration
   4  *
   5  *  Copyright (C) 2009-2013  Intel Corporation. All rights reserved.
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License version 2 as
   9  *  published by the Free Software Foundation.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  */
  21
  22 #ifndef __G_DHCP_H
  23 #define __G_DHCP_H
  24
  25 #include <stdbool.h>
  26 #include <stdint.h>
  27 #include <arpa/inet.h>
  28
  29 #include <glib.h>
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 /* DHCP Client part*/
  36 struct _GDHCPClient;
  37
  38 typedef struct _GDHCPClient GDHCPClient;
  39
  40 typedef enum {
  41         G_DHCP_CLIENT_ERROR_NONE,
  42         G_DHCP_CLIENT_ERROR_INTERFACE_UNAVAILABLE,
  43         G_DHCP_CLIENT_ERROR_INTERFACE_IN_USE,
  44         G_DHCP_CLIENT_ERROR_INTERFACE_DOWN,
  45         G_DHCP_CLIENT_ERROR_NOMEM,
  46         G_DHCP_CLIENT_ERROR_INVALID_INDEX,
  47         G_DHCP_CLIENT_ERROR_INVALID_OPTION
  48 } GDHCPClientError;
  49
  50 typedef enum {
  51         G_DHCP_CLIENT_EVENT_LEASE_AVAILABLE,
  52         G_DHCP_CLIENT_EVENT_IPV4LL_AVAILABLE,
  53         G_DHCP_CLIENT_EVENT_NO_LEASE,
  54         G_DHCP_CLIENT_EVENT_LEASE_LOST,
  55         G_DHCP_CLIENT_EVENT_IPV4LL_LOST,
  56         G_DHCP_CLIENT_EVENT_ADDRESS_CONFLICT,
  57         G_DHCP_CLIENT_EVENT_INFORMATION_REQ,
  58         G_DHCP_CLIENT_EVENT_SOLICITATION,
  59         G_DHCP_CLIENT_EVENT_ADVERTISE,
  60         G_DHCP_CLIENT_EVENT_REQUEST,
  61         G_DHCP_CLIENT_EVENT_RENEW,
  62         G_DHCP_CLIENT_EVENT_REBIND,
  63         G_DHCP_CLIENT_EVENT_RELEASE,
  64         G_DHCP_CLIENT_EVENT_CONFIRM,
  65         G_DHCP_CLIENT_EVENT_DECLINE,
  66 } GDHCPClientEvent;
  67
  68 typedef enum {
  69         G_DHCP_IPV4,
  70         G_DHCP_IPV6,
  71         G_DHCP_IPV4LL,
  72 } GDHCPType;
  73
  74 #define G_DHCP_SUBNET           0x01
  75 #define G_DHCP_ROUTER           0x03
  76 #define G_DHCP_TIME_SERVER      0x04
  77 #define G_DHCP_DNS_SERVER       0x06
  78 #define G_DHCP_DOMAIN_NAME      0x0f
  79 #define G_DHCP_HOST_NAME        0x0c
  80 #define G_DHCP_NTP_SERVER       0x2a
  81 #define G_DHCP_CLIENT_ID        0x3d
  82
  83 #define G_DHCPV6_CLIENTID       1
  84 #define G_DHCPV6_SERVERID       2
  85 #define G_DHCPV6_IA_NA          3
  86 #define G_DHCPV6_IA_TA          4
  87 #define G_DHCPV6_IAADDR         5
  88 #define G_DHCPV6_ORO            6
  89 #define G_DHCPV6_PREFERENCE     7
  90 #define G_DHCPV6_ELAPSED_TIME   8
  91 #define G_DHCPV6_STATUS_CODE    13
  92 #define G_DHCPV6_RAPID_COMMIT   14
  93 #define G_DHCPV6_DNS_SERVERS    23
  94 #define G_DHCPV6_DOMAIN_LIST    24
  95 #define G_DHCPV6_IA_PD          25
  96 #define G_DHCPV6_IA_PREFIX      26
  97 #define G_DHCPV6_SNTP_SERVERS   31
  98
  99 #define G_DHCPV6_ERROR_SUCCESS  0
 100 #define G_DHCPV6_ERROR_FAILURE  1
 101 #define G_DHCPV6_ERROR_NO_ADDR  2
 102 #define G_DHCPV6_ERROR_BINDING  3
 103 #define G_DHCPV6_ERROR_LINK     4
 104 #define G_DHCPV6_ERROR_MCAST    5
 105 #define G_DHCPV6_ERROR_NO_PREFIX 6
 106
 107 typedef enum {
 108         G_DHCPV6_DUID_LLT = 1,
 109         G_DHCPV6_DUID_EN  = 2,
 110         G_DHCPV6_DUID_LL  = 3,
 111 } GDHCPDuidType;
 112
 113 typedef struct {
 114         /*
 115          * Note that no field in this struct can be allocated
 116          * from heap or there will be a memory leak when the
 117          * struct is freed by client.c:remove_option_value()
 118          */
 119         struct in6_addr prefix;
 120         unsigned char prefixlen;
 121         uint32_t preferred;
 122         uint32_t valid;
 123         time_t expire;
 124 } GDHCPIAPrefix;
 125
 126 typedef void (*GDHCPClientEventFunc) (GDHCPClient *client, gpointer user_data);
 127
 128 typedef void (*GDHCPDebugFunc)(const char *str, gpointer user_data);
 129
 130 GDHCPClient *g_dhcp_client_new(GDHCPType type, int index,
 131                                                 GDHCPClientError *error);
 132
 133 int g_dhcp_client_start(GDHCPClient *client, const char *last_address);
 134 void g_dhcp_client_stop(GDHCPClient *client);
 135
 136 GDHCPClient *g_dhcp_client_ref(GDHCPClient *client);
 137 void g_dhcp_client_unref(GDHCPClient *client);
 138
 139 void g_dhcp_client_register_event(GDHCPClient *client,
 140                                         GDHCPClientEvent event,
 141                                         GDHCPClientEventFunc func,
 142                                         gpointer user_data);
 143
 144 GDHCPClientError g_dhcp_client_set_request(GDHCPClient *client,
 145                                                 unsigned int option_code);
 146 void g_dhcp_client_clear_requests(GDHCPClient *dhcp_client);
 147 void g_dhcp_client_clear_values(GDHCPClient *dhcp_client);
 148 GDHCPClientError g_dhcp_client_set_id(GDHCPClient *client);
 149 GDHCPClientError g_dhcp_client_set_send(GDHCPClient *client,
 150                                                 unsigned char option_code,
 151                                                 const char *option_value);
 152
 153 char *g_dhcp_client_get_server_address(GDHCPClient *client);
 154 char *g_dhcp_client_get_address(GDHCPClient *client);
 155 char *g_dhcp_client_get_netmask(GDHCPClient *client);
 156 GList *g_dhcp_client_get_option(GDHCPClient *client,
 157                                                 unsigned char option_code);
 158 int g_dhcp_client_get_index(GDHCPClient *client);
 159
 160 void g_dhcp_client_set_debug(GDHCPClient *client,
 161                                 GDHCPDebugFunc func, gpointer user_data);
 162 int g_dhcpv6_create_duid(GDHCPDuidType duid_type, int index, int type,
 163                         unsigned char **duid, int *duid_len);
 164 int g_dhcpv6_client_set_duid(GDHCPClient *dhcp_client, unsigned char *duid,
 165                         int duid_len);
 166 int g_dhcpv6_client_set_pd(GDHCPClient *dhcp_client, uint32_t *T1, uint32_t *T2,
 167                         GSList *prefixes);
 168 GSList *g_dhcpv6_copy_prefixes(GSList *prefixes);
 169 gboolean g_dhcpv6_client_clear_send(GDHCPClient *dhcp_client, uint16_t code);
 170 void g_dhcpv6_client_set_send(GDHCPClient *dhcp_client, uint16_t option_code,
 171                         uint8_t *option_value, uint16_t option_len);
 172 uint16_t g_dhcpv6_client_get_status(GDHCPClient *dhcp_client);
 173 int g_dhcpv6_client_set_oro(GDHCPClient *dhcp_client, int args, ...);
 174 void g_dhcpv6_client_create_iaid(GDHCPClient *dhcp_client, int index,
 175                                 unsigned char *iaid);
 176 int g_dhcpv6_client_get_timeouts(GDHCPClient *dhcp_client,
 177                                 uint32_t *T1, uint32_t *T2,
 178                                 time_t *started, time_t *expire);
 179 uint32_t g_dhcpv6_client_get_iaid(GDHCPClient *dhcp_client);
 180 void g_dhcpv6_client_set_iaid(GDHCPClient *dhcp_client, uint32_t iaid);
 181 int g_dhcpv6_client_set_ia(GDHCPClient *dhcp_client, int index,
 182                         int code, uint32_t *T1, uint32_t *T2,
 183                         bool add_addresses, const char *address);
 184 int g_dhcpv6_client_set_ias(GDHCPClient *dhcp_client, int index,
 185                         int code, uint32_t *T1, uint32_t *T2,
 186                         GSList *addresses);
 187 void g_dhcpv6_client_reset_request(GDHCPClient *dhcp_client);
 188 void g_dhcpv6_client_set_retransmit(GDHCPClient *dhcp_client);
 189 void g_dhcpv6_client_clear_retransmit(GDHCPClient *dhcp_client);
 190
 191 /* DHCP Server */
 192 typedef enum {
 193         G_DHCP_SERVER_ERROR_NONE,
 194         G_DHCP_SERVER_ERROR_INTERFACE_UNAVAILABLE,
 195         G_DHCP_SERVER_ERROR_INTERFACE_IN_USE,
 196         G_DHCP_SERVER_ERROR_INTERFACE_DOWN,
 197         G_DHCP_SERVER_ERROR_NOMEM,
 198         G_DHCP_SERVER_ERROR_INVALID_INDEX,
 199         G_DHCP_SERVER_ERROR_INVALID_OPTION,
 200         G_DHCP_SERVER_ERROR_IP_ADDRESS_INVALID
 201 } GDHCPServerError;
 202
 203 typedef void (*GDHCPSaveLeaseFunc) (unsigned char *mac,
 204                         unsigned int nip, unsigned int expire);
 205
 206 typedef void (*GDHCPLeaseAddedCb) (unsigned char *mac, uint32_t ip);
 207
 208 struct _GDHCPServer;
 209
 210 typedef struct _GDHCPServer GDHCPServer;
 211
 212 typedef void (*GDHCPSaveACKLeaseFunc) (char *hostname,
 213                         unsigned char *mac, unsigned int nip);
 214
 215 GDHCPServer *g_dhcp_server_new(GDHCPType type,
 216                 int ifindex, GDHCPServerError *error);
 217 int g_dhcp_server_start(GDHCPServer *server);
 218 void g_dhcp_server_stop(GDHCPServer *server);
 219
 220 GDHCPServer *g_dhcp_server_ref(GDHCPServer *server);
 221 void g_dhcp_server_unref(GDHCPServer *server);
 222
 223 int g_dhcp_server_set_option(GDHCPServer *server,
 224                 unsigned char option_code, const char *option_value);
 225 int g_dhcp_server_set_ip_range(GDHCPServer *server,
 226                 const char *start_ip, const char *end_ip);
 227 void g_dhcp_server_set_debug(GDHCPServer *server,
 228                                 GDHCPDebugFunc func, gpointer user_data);
 229 void g_dhcp_server_set_lease_time(GDHCPServer *dhcp_server,
 230                                                 unsigned int lease_time);
 231 void g_dhcp_server_set_save_lease(GDHCPServer *dhcp_server,
 232                                 GDHCPSaveLeaseFunc func, gpointer user_data);
 233 void g_dhcp_server_set_lease_added_cb(GDHCPServer *dhcp_server,
 234                                                         GDHCPLeaseAddedCb cb);
 235 void g_dhcp_server_set_save_ack_lease(GDHCPServer *dhcp_server,
 236                                 GDHCPSaveACKLeaseFunc func, gpointer user_data);
 237
 238 int dhcp_get_random(uint64_t *val);
 239 void dhcp_cleanup_random(void);
 240
 241 #ifdef __cplusplus
 242 }
 243 #endif
 244
 245 #endif /* __G_DHCP_H */