src/systemd/sd-dhcp-client.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #ifndef foosddhcpclienthfoo
   3 #define foosddhcpclienthfoo
   4
   5 /***
   6   Copyright © 2013 Intel Corporation. All rights reserved.
   7
   8   systemd is free software; you can redistribute it and/or modify it
   9   under the terms of the GNU Lesser General Public License as published by
  10   the Free Software Foundation; either version 2.1 of the License, or
  11   (at your option) any later version.
  12
  13   systemd is distributed in the hope that it will be useful, but
  14   WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16   Lesser General Public License for more details.
  17
  18   You should have received a copy of the GNU Lesser General Public License
  19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  20 ***/
  21
  22 #include <inttypes.h>
  23 #include <net/ethernet.h>
  24 #include <netinet/in.h>
  25 #include <sys/types.h>
  26 #include <stdbool.h>
  27
  28 #include "sd-dhcp-lease.h"
  29 #include "sd-dhcp-option.h"
  30 #include "sd-event.h"
  31
  32 #include "_sd-common.h"
  33
  34 _SD_BEGIN_DECLARATIONS;
  35
  36 enum {
  37         SD_DHCP_CLIENT_EVENT_STOP               = 0,
  38         SD_DHCP_CLIENT_EVENT_IP_ACQUIRE         = 1,
  39         SD_DHCP_CLIENT_EVENT_IP_CHANGE          = 2,
  40         SD_DHCP_CLIENT_EVENT_EXPIRED            = 3,
  41         SD_DHCP_CLIENT_EVENT_RENEW              = 4,
  42         SD_DHCP_CLIENT_EVENT_SELECTING          = 5,
  43 };
  44
  45 enum {
  46         SD_DHCP_OPTION_PAD                         = 0,
  47         SD_DHCP_OPTION_SUBNET_MASK                 = 1,
  48         SD_DHCP_OPTION_TIME_OFFSET                 = 2,
  49         SD_DHCP_OPTION_ROUTER                      = 3,
  50         SD_DHCP_OPTION_DOMAIN_NAME_SERVER          = 6,
  51         SD_DHCP_OPTION_HOST_NAME                   = 12,
  52         SD_DHCP_OPTION_BOOT_FILE_SIZE              = 13,
  53         SD_DHCP_OPTION_DOMAIN_NAME                 = 15,
  54         SD_DHCP_OPTION_ROOT_PATH                   = 17,
  55         SD_DHCP_OPTION_ENABLE_IP_FORWARDING        = 19,
  56         SD_DHCP_OPTION_ENABLE_IP_FORWARDING_NL     = 20,
  57         SD_DHCP_OPTION_POLICY_FILTER               = 21,
  58         SD_DHCP_OPTION_INTERFACE_MDR               = 22,
  59         SD_DHCP_OPTION_INTERFACE_TTL               = 23,
  60         SD_DHCP_OPTION_INTERFACE_MTU_AGING_TIMEOUT = 24,
  61         SD_DHCP_OPTION_INTERFACE_MTU               = 26,
  62         SD_DHCP_OPTION_BROADCAST                   = 28,
  63        /* Windows 10 option to send when Anonymize=true */
  64         SD_DHCP_OPTION_ROUTER_DISCOVER             = 31,
  65         SD_DHCP_OPTION_STATIC_ROUTE                = 33,
  66         SD_DHCP_OPTION_NTP_SERVER                  = 42,
  67         SD_DHCP_OPTION_VENDOR_SPECIFIC             = 43,
  68        /* Windows 10 option to send when Anonymize=true */
  69         SD_DHCP_OPTION_NETBIOS_NAMESERVER          = 44,
  70        /* Windows 10 option to send when Anonymize=true */
  71         SD_DHCP_OPTION_NETBIOS_NODETYPE            = 46,
  72        /* Windows 10 option to send when Anonymize=true */
  73         SD_DHCP_OPTION_NETBIOS_SCOPE               = 47,
  74         SD_DHCP_OPTION_REQUESTED_IP_ADDRESS        = 50,
  75         SD_DHCP_OPTION_IP_ADDRESS_LEASE_TIME       = 51,
  76         SD_DHCP_OPTION_OVERLOAD                    = 52,
  77         SD_DHCP_OPTION_MESSAGE_TYPE                = 53,
  78         SD_DHCP_OPTION_SERVER_IDENTIFIER           = 54,
  79         SD_DHCP_OPTION_PARAMETER_REQUEST_LIST      = 55,
  80         SD_DHCP_OPTION_ERROR_MESSAGE               = 56,
  81         SD_DHCP_OPTION_MAXIMUM_MESSAGE_SIZE        = 57,
  82         SD_DHCP_OPTION_RENEWAL_T1_TIME             = 58,
  83         SD_DHCP_OPTION_REBINDING_T2_TIME           = 59,
  84         SD_DHCP_OPTION_VENDOR_CLASS_IDENTIFIER     = 60,
  85         SD_DHCP_OPTION_CLIENT_IDENTIFIER           = 61,
  86         SD_DHCP_OPTION_SMTP_SERVER                 = 69,
  87         SD_DHCP_OPTION_POP3_SERVER                 = 70,
  88         SD_DHCP_OPTION_USER_CLASS                  = 77,
  89         SD_DHCP_OPTION_FQDN                        = 81,
  90         SD_DHCP_OPTION_NEW_POSIX_TIMEZONE          = 100,
  91         SD_DHCP_OPTION_NEW_TZDB_TIMEZONE           = 101,
  92         SD_DHCP_OPTION_DOMAIN_SEARCH_LIST          = 119,
  93         SD_DHCP_OPTION_SIP_SERVER                  = 120,
  94         SD_DHCP_OPTION_CLASSLESS_STATIC_ROUTE      = 121,
  95         SD_DHCP_OPTION_PRIVATE_BASE                = 224,
  96        /* Windows 10 option to send when Anonymize=true */
  97         SD_DHCP_OPTION_PRIVATE_CLASSLESS_STATIC_ROUTE = 249,
  98        /* Windows 10 option to send when Anonymize=true */
  99         SD_DHCP_OPTION_PRIVATE_PROXY_AUTODISCOVERY = 252,
 100         SD_DHCP_OPTION_PRIVATE_LAST                = 254,
 101         SD_DHCP_OPTION_END                         = 255,
 102 };
 103
 104 typedef struct sd_dhcp_client sd_dhcp_client;
 105
 106 typedef int (*sd_dhcp_client_callback_t)(sd_dhcp_client *client, int event, void *userdata);
 107 int sd_dhcp_client_set_callback(
 108                 sd_dhcp_client *client,
 109                 sd_dhcp_client_callback_t cb,
 110                 void *userdata);
 111
 112 int sd_dhcp_client_set_request_option(
 113                 sd_dhcp_client *client,
 114                 uint8_t option);
 115 int sd_dhcp_client_set_request_address(
 116                 sd_dhcp_client *client,
 117                 const struct in_addr *last_address);
 118 int sd_dhcp_client_set_request_broadcast(
 119                 sd_dhcp_client *client,
 120                 int broadcast);
 121 int sd_dhcp_client_set_ifindex(
 122                 sd_dhcp_client *client,
 123                 int interface_index);
 124 int sd_dhcp_client_set_mac(
 125                 sd_dhcp_client *client,
 126                 const uint8_t *addr,
 127                 size_t addr_len,
 128                 uint16_t arp_type);
 129 int sd_dhcp_client_set_client_id(
 130                 sd_dhcp_client *client,
 131                 uint8_t type,
 132                 const uint8_t *data,
 133                 size_t data_len);
 134 int sd_dhcp_client_set_iaid_duid(
 135                 sd_dhcp_client *client,
 136                 bool iaid_set,
 137                 uint32_t iaid,
 138                 uint16_t duid_type,
 139                 const void *duid,
 140                 size_t duid_len);
 141 int sd_dhcp_client_set_iaid_duid_llt(
 142                 sd_dhcp_client *client,
 143                 bool iaid_set,
 144                 uint32_t iaid,
 145                 uint64_t llt_time);
 146 int sd_dhcp_client_set_duid(
 147                 sd_dhcp_client *client,
 148                 uint16_t duid_type,
 149                 const void *duid,
 150                 size_t duid_len);
 151 int sd_dhcp_client_set_duid_llt(
 152                 sd_dhcp_client *client,
 153                 uint64_t llt_time);
 154 int sd_dhcp_client_get_client_id(
 155                 sd_dhcp_client *client,
 156                 uint8_t *type,
 157                 const uint8_t **data,
 158                 size_t *data_len);
 159 int sd_dhcp_client_set_mtu(
 160                 sd_dhcp_client *client,
 161                 uint32_t mtu);
 162 int sd_dhcp_client_set_max_attempts(
 163                 sd_dhcp_client *client,
 164                 uint64_t attempt);
 165 int sd_dhcp_client_set_client_port(
 166                 sd_dhcp_client *client,
 167                 uint16_t port);
 168 int sd_dhcp_client_set_hostname(
 169                 sd_dhcp_client *client,
 170                 const char *hostname);
 171 int sd_dhcp_client_set_vendor_class_identifier(
 172                 sd_dhcp_client *client,
 173                 const char *vci);
 174 int sd_dhcp_client_set_user_class(
 175                 sd_dhcp_client *client,
 176                 const char* const *user_class);
 177 int sd_dhcp_client_get_lease(
 178                 sd_dhcp_client *client,
 179                 sd_dhcp_lease **ret);
 180 int sd_dhcp_client_set_service_type(
 181                 sd_dhcp_client *client,
 182                 int type);
 183
 184 int sd_dhcp_client_add_option(sd_dhcp_client *client, sd_dhcp_option *v);
 185 int sd_dhcp_client_add_vendor_option(sd_dhcp_client *client, sd_dhcp_option *v);
 186
 187 int sd_dhcp_client_stop(sd_dhcp_client *client);
 188 int sd_dhcp_client_start(sd_dhcp_client *client);
 189 int sd_dhcp_client_send_release(sd_dhcp_client *client);
 190 int sd_dhcp_client_send_decline(sd_dhcp_client *client);
 191 int sd_dhcp_client_send_renew(sd_dhcp_client *client);
 192
 193 sd_dhcp_client *sd_dhcp_client_ref(sd_dhcp_client *client);
 194 sd_dhcp_client *sd_dhcp_client_unref(sd_dhcp_client *client);
 195
 196 /* NOTE: anonymize parameter is used to initialize PRL memory with different
 197  * options when using RFC7844 Anonymity Profiles */
 198 int sd_dhcp_client_new(sd_dhcp_client **ret, int anonymize);
 199
 200 int sd_dhcp_client_attach_event(
 201                 sd_dhcp_client *client,
 202                 sd_event *event,
 203                 int64_t priority);
 204 int sd_dhcp_client_detach_event(sd_dhcp_client *client);
 205 sd_event *sd_dhcp_client_get_event(sd_dhcp_client *client);
 206
 207 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_dhcp_client, sd_dhcp_client_unref);
 208
 209 _SD_END_DECLARATIONS;
 210
 211 #endif