gdhcp/gdhcp.h

   1 /*
   2  *
   3  *  DHCP library with GLib integration
   4  *
   5  *  Copyright (C) 2009-2012  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 <stdint.h>
  26
  27 #include <glib.h>
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /* DHCP Client part*/
  34 struct _GDHCPClient;
  35
  36 typedef struct _GDHCPClient GDHCPClient;
  37
  38 typedef enum {
  39         G_DHCP_CLIENT_ERROR_NONE,
  40         G_DHCP_CLIENT_ERROR_INTERFACE_UNAVAILABLE,
  41         G_DHCP_CLIENT_ERROR_INTERFACE_IN_USE,
  42         G_DHCP_CLIENT_ERROR_INTERFACE_DOWN,
  43         G_DHCP_CLIENT_ERROR_NOMEM,
  44         G_DHCP_CLIENT_ERROR_INVALID_INDEX,
  45         G_DHCP_CLIENT_ERROR_INVALID_OPTION
  46 } GDHCPClientError;
  47
  48 typedef enum {
  49         G_DHCP_CLIENT_EVENT_LEASE_AVAILABLE,
  50         G_DHCP_CLIENT_EVENT_IPV4LL_AVAILABLE,
  51         G_DHCP_CLIENT_EVENT_NO_LEASE,
  52         G_DHCP_CLIENT_EVENT_LEASE_LOST,
  53         G_DHCP_CLIENT_EVENT_IPV4LL_LOST,
  54         G_DHCP_CLIENT_EVENT_ADDRESS_CONFLICT,
  55         G_DHCP_CLIENT_EVENT_INFORMATION_REQ,
  56         G_DHCP_CLIENT_EVENT_SOLICITATION,
  57         G_DHCP_CLIENT_EVENT_ADVERTISE,
  58         G_DHCP_CLIENT_EVENT_REQUEST,
  59         G_DHCP_CLIENT_EVENT_RENEW,
  60         G_DHCP_CLIENT_EVENT_REBIND,
  61         G_DHCP_CLIENT_EVENT_RELEASE,
  62 } GDHCPClientEvent;
  63
  64 typedef enum {
  65         G_DHCP_IPV4,
  66         G_DHCP_IPV6,
  67         G_DHCP_IPV4LL,
  68 } GDHCPType;
  69
  70 #define G_DHCP_SUBNET           0x01
  71 #define G_DHCP_ROUTER           0x03
  72 #define G_DHCP_TIME_SERVER      0x04
  73 #define G_DHCP_DNS_SERVER       0x06
  74 #define G_DHCP_DOMAIN_NAME      0x0f
  75 #define G_DHCP_HOST_NAME        0x0c
  76 #define G_DHCP_NTP_SERVER       0x2a
  77 #define G_DHCP_CLIENT_ID        0x3d
  78
  79 #define G_DHCPV6_CLIENTID       1
  80 #define G_DHCPV6_SERVERID       2
  81 #define G_DHCPV6_IA_NA          3
  82 #define G_DHCPV6_IA_TA          4
  83 #define G_DHCPV6_IAADDR         5
  84 #define G_DHCPV6_ORO            6
  85 #define G_DHCPV6_STATUS_CODE    13
  86 #define G_DHCPV6_RAPID_COMMIT   14
  87 #define G_DHCPV6_DNS_SERVERS    23
  88 #define G_DHCPV6_SNTP_SERVERS   31
  89
  90 #define G_DHCPV6_ERROR_SUCCESS  0
  91 #define G_DHCPV6_ERROR_FAILURE  1
  92 #define G_DHCPV6_ERROR_NO_ADDR  2
  93 #define G_DHCPV6_ERROR_BINDING  3
  94 #define G_DHCPV6_ERROR_LINK     4
  95 #define G_DHCPV6_ERROR_MCAST    5
  96
  97 typedef enum {
  98         G_DHCPV6_DUID_LLT = 1,
  99         G_DHCPV6_DUID_EN  = 2,
 100         G_DHCPV6_DUID_LL  = 3,
 101 } GDHCPDuidType;
 102
 103 typedef void (*GDHCPClientEventFunc) (GDHCPClient *client, gpointer user_data);
 104
 105 typedef void (*GDHCPDebugFunc)(const char *str, gpointer user_data);
 106
 107 GDHCPClient *g_dhcp_client_new(GDHCPType type, int index,
 108                                                 GDHCPClientError *error);
 109
 110 int g_dhcp_client_start(GDHCPClient *client, const char *last_address);
 111 void g_dhcp_client_stop(GDHCPClient *client);
 112
 113 GDHCPClient *g_dhcp_client_ref(GDHCPClient *client);
 114 void g_dhcp_client_unref(GDHCPClient *client);
 115
 116 void g_dhcp_client_register_event(GDHCPClient *client,
 117                                         GDHCPClientEvent event,
 118                                         GDHCPClientEventFunc func,
 119                                         gpointer user_data);
 120
 121 GDHCPClientError g_dhcp_client_set_request(GDHCPClient *client,
 122                                                 unsigned int option_code);
 123 void g_dhcp_client_clear_requests(GDHCPClient *dhcp_client);
 124 void g_dhcp_client_clear_values(GDHCPClient *dhcp_client);
 125 GDHCPClientError g_dhcp_client_set_id(GDHCPClient *client);
 126 GDHCPClientError g_dhcp_client_set_send(GDHCPClient *client,
 127                                                 unsigned char option_code,
 128                                                 const char *option_value);
 129
 130 char *g_dhcp_client_get_address(GDHCPClient *client);
 131 char *g_dhcp_client_get_netmask(GDHCPClient *client);
 132 GList *g_dhcp_client_get_option(GDHCPClient *client,
 133                                                 unsigned char option_code);
 134 int g_dhcp_client_get_index(GDHCPClient *client);
 135
 136 void g_dhcp_client_set_debug(GDHCPClient *client,
 137                                 GDHCPDebugFunc func, gpointer user_data);
 138 int g_dhcpv6_create_duid(GDHCPDuidType duid_type, int index, int type,
 139                         unsigned char **duid, int *duid_len);
 140 int g_dhcpv6_client_set_duid(GDHCPClient *dhcp_client, unsigned char *duid,
 141                         int duid_len);
 142 void g_dhcpv6_client_set_send(GDHCPClient *dhcp_client, uint16_t option_code,
 143                         uint8_t *option_value, uint16_t option_len);
 144 uint16_t g_dhcpv6_client_get_status(GDHCPClient *dhcp_client);
 145 int g_dhcpv6_client_set_oro(GDHCPClient *dhcp_client, int args, ...);
 146 void g_dhcpv6_client_create_iaid(GDHCPClient *dhcp_client, int index,
 147                                 unsigned char *iaid);
 148 int g_dhcpv6_client_get_timeouts(GDHCPClient *dhcp_client,
 149                                 uint32_t *T1, uint32_t *T2,
 150                                 time_t *last_renew, time_t *last_rebind,
 151                                 time_t *expire);
 152 uint32_t g_dhcpv6_client_get_iaid(GDHCPClient *dhcp_client);
 153 int g_dhcpv6_client_set_ia(GDHCPClient *dhcp_client, int index,
 154                 int code, uint32_t *T1, uint32_t *T2, gboolean add_iaaddr);
 155 void g_dhcpv6_client_reset_renew(GDHCPClient *dhcp_client);
 156 void g_dhcpv6_client_reset_rebind(GDHCPClient *dhcp_client);
 157 void g_dhcpv6_client_set_expire(GDHCPClient *dhcp_client, uint32_t timeout);
 158
 159 /* DHCP Server */
 160 typedef enum {
 161         G_DHCP_SERVER_ERROR_NONE,
 162         G_DHCP_SERVER_ERROR_INTERFACE_UNAVAILABLE,
 163         G_DHCP_SERVER_ERROR_INTERFACE_IN_USE,
 164         G_DHCP_SERVER_ERROR_INTERFACE_DOWN,
 165         G_DHCP_SERVER_ERROR_NOMEM,
 166         G_DHCP_SERVER_ERROR_INVALID_INDEX,
 167         G_DHCP_SERVER_ERROR_INVALID_OPTION,
 168         G_DHCP_SERVER_ERROR_IP_ADDRESS_INVALID
 169 } GDHCPServerError;
 170
 171 typedef void (*GDHCPSaveLeaseFunc) (unsigned char *mac,
 172                         unsigned int nip, unsigned int expire);
 173 struct _GDHCPServer;
 174
 175 typedef struct _GDHCPServer GDHCPServer;
 176
 177 GDHCPServer *g_dhcp_server_new(GDHCPType type,
 178                 int ifindex, GDHCPServerError *error);
 179 int g_dhcp_server_start(GDHCPServer *server);
 180 void g_dhcp_server_stop(GDHCPServer *server);
 181
 182 GDHCPServer *g_dhcp_server_ref(GDHCPServer *server);
 183 void g_dhcp_server_unref(GDHCPServer *server);
 184
 185 int g_dhcp_server_set_option(GDHCPServer *server,
 186                 unsigned char option_code, const char *option_value);
 187 int g_dhcp_server_set_ip_range(GDHCPServer *server,
 188                 const char *start_ip, const char *end_ip);
 189 void g_dhcp_server_load_lease(GDHCPServer *dhcp_server, unsigned int expire,
 190                                 unsigned char *mac, unsigned int lease_ip);
 191 void g_dhcp_server_set_debug(GDHCPServer *server,
 192                                 GDHCPDebugFunc func, gpointer user_data);
 193 void g_dhcp_server_set_lease_time(GDHCPServer *dhcp_server,
 194                                                 unsigned int lease_time);
 195 void g_dhcp_server_set_save_lease(GDHCPServer *dhcp_server,
 196                                 GDHCPSaveLeaseFunc func, gpointer user_data);
 197 #ifdef __cplusplus
 198 }
 199 #endif
 200
 201 #endif /* __G_DHCP_H */