src/systemd/sd-dhcp-client.h

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