gdhcp/gdhcp.h

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