[thirdparty/systemd.git] / src / systemd / sd-dhcp-client.h

/* SPDX-License-Identifier: LGPL-2.1+ */
#ifndef foosddhcpclienthfoo
#define foosddhcpclienthfoo

/***
  Copyright © 2013 Intel Corporation. All rights reserved.

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/

#include <inttypes.h>
#include <net/ethernet.h>
#include <netinet/in.h>
#include <sys/types.h>
#include <stdbool.h>

#include "sd-dhcp-lease.h"
#include "sd-dhcp-option.h"
#include "sd-event.h"

#include "_sd-common.h"

_SD_BEGIN_DECLARATIONS;

enum {
        SD_DHCP_CLIENT_EVENT_STOP               = 0,
        SD_DHCP_CLIENT_EVENT_IP_ACQUIRE         = 1,
        SD_DHCP_CLIENT_EVENT_IP_CHANGE          = 2,
        SD_DHCP_CLIENT_EVENT_EXPIRED            = 3,
        SD_DHCP_CLIENT_EVENT_RENEW              = 4,
        SD_DHCP_CLIENT_EVENT_SELECTING          = 5,
};

enum {
        SD_DHCP_OPTION_PAD                         = 0,
        SD_DHCP_OPTION_SUBNET_MASK                 = 1,
        SD_DHCP_OPTION_TIME_OFFSET                 = 2,
        SD_DHCP_OPTION_ROUTER                      = 3,
        SD_DHCP_OPTION_DOMAIN_NAME_SERVER          = 6,
        SD_DHCP_OPTION_HOST_NAME                   = 12,
        SD_DHCP_OPTION_BOOT_FILE_SIZE              = 13,
        SD_DHCP_OPTION_DOMAIN_NAME                 = 15,
        SD_DHCP_OPTION_ROOT_PATH                   = 17,
        SD_DHCP_OPTION_ENABLE_IP_FORWARDING        = 19,
        SD_DHCP_OPTION_ENABLE_IP_FORWARDING_NL     = 20,
        SD_DHCP_OPTION_POLICY_FILTER               = 21,
        SD_DHCP_OPTION_INTERFACE_MDR               = 22,
        SD_DHCP_OPTION_INTERFACE_TTL               = 23,
        SD_DHCP_OPTION_INTERFACE_MTU_AGING_TIMEOUT = 24,
        SD_DHCP_OPTION_INTERFACE_MTU               = 26,
        SD_DHCP_OPTION_BROADCAST                   = 28,
       /* Windows 10 option to send when Anonymize=true */
        SD_DHCP_OPTION_ROUTER_DISCOVER             = 31,
        SD_DHCP_OPTION_STATIC_ROUTE                = 33,
        SD_DHCP_OPTION_NTP_SERVER                  = 42,
        SD_DHCP_OPTION_VENDOR_SPECIFIC             = 43,
       /* Windows 10 option to send when Anonymize=true */
        SD_DHCP_OPTION_NETBIOS_NAMESERVER          = 44,
       /* Windows 10 option to send when Anonymize=true */
        SD_DHCP_OPTION_NETBIOS_NODETYPE            = 46,
       /* Windows 10 option to send when Anonymize=true */
        SD_DHCP_OPTION_NETBIOS_SCOPE               = 47,
        SD_DHCP_OPTION_REQUESTED_IP_ADDRESS        = 50,
        SD_DHCP_OPTION_IP_ADDRESS_LEASE_TIME       = 51,
        SD_DHCP_OPTION_OVERLOAD                    = 52,
        SD_DHCP_OPTION_MESSAGE_TYPE                = 53,
        SD_DHCP_OPTION_SERVER_IDENTIFIER           = 54,
        SD_DHCP_OPTION_PARAMETER_REQUEST_LIST      = 55,
        SD_DHCP_OPTION_ERROR_MESSAGE               = 56,
        SD_DHCP_OPTION_MAXIMUM_MESSAGE_SIZE        = 57,
        SD_DHCP_OPTION_RENEWAL_T1_TIME             = 58,
        SD_DHCP_OPTION_REBINDING_T2_TIME           = 59,
        SD_DHCP_OPTION_VENDOR_CLASS_IDENTIFIER     = 60,
        SD_DHCP_OPTION_CLIENT_IDENTIFIER           = 61,
        SD_DHCP_OPTION_USER_CLASS                  = 77,
        SD_DHCP_OPTION_FQDN                        = 81,
        SD_DHCP_OPTION_NEW_POSIX_TIMEZONE          = 100,
        SD_DHCP_OPTION_NEW_TZDB_TIMEZONE           = 101,
        SD_DHCP_OPTION_DOMAIN_SEARCH_LIST          = 119,
        SD_DHCP_OPTION_SIP_SERVER                  = 120,
        SD_DHCP_OPTION_CLASSLESS_STATIC_ROUTE      = 121,
        SD_DHCP_OPTION_PRIVATE_BASE                = 224,
       /* Windows 10 option to send when Anonymize=true */
        SD_DHCP_OPTION_PRIVATE_CLASSLESS_STATIC_ROUTE = 249,
       /* Windows 10 option to send when Anonymize=true */
        SD_DHCP_OPTION_PRIVATE_PROXY_AUTODISCOVERY = 252,
        SD_DHCP_OPTION_PRIVATE_LAST                = 254,
        SD_DHCP_OPTION_END                         = 255,
};

typedef struct sd_dhcp_client sd_dhcp_client;

typedef int (*sd_dhcp_client_callback_t)(sd_dhcp_client *client, int event, void *userdata);
int sd_dhcp_client_set_callback(
                sd_dhcp_client *client,
                sd_dhcp_client_callback_t cb,
                void *userdata);

int sd_dhcp_client_set_request_option(
                sd_dhcp_client *client,
                uint8_t option);
int sd_dhcp_client_set_request_address(
                sd_dhcp_client *client,
                const struct in_addr *last_address);
int sd_dhcp_client_set_request_broadcast(
                sd_dhcp_client *client,
                int broadcast);
int sd_dhcp_client_set_ifindex(
                sd_dhcp_client *client,
                int interface_index);
int sd_dhcp_client_set_mac(
                sd_dhcp_client *client,
                const uint8_t *addr,
                size_t addr_len,
                uint16_t arp_type);
int sd_dhcp_client_set_client_id(
                sd_dhcp_client *client,
                uint8_t type,
                const uint8_t *data,
                size_t data_len);
int sd_dhcp_client_set_iaid_duid(
                sd_dhcp_client *client,
                bool iaid_set,
                uint32_t iaid,
                uint16_t duid_type,
                const void *duid,
                size_t duid_len);
int sd_dhcp_client_set_iaid_duid_llt(
                sd_dhcp_client *client,
                bool iaid_set,
                uint32_t iaid,
                uint64_t llt_time);
int sd_dhcp_client_set_duid(
                sd_dhcp_client *client,
                uint16_t duid_type,
                const void *duid,
                size_t duid_len);
int sd_dhcp_client_set_duid_llt(
                sd_dhcp_client *client,
                uint64_t llt_time);
int sd_dhcp_client_get_client_id(
                sd_dhcp_client *client,
                uint8_t *type,
                const uint8_t **data,
                size_t *data_len);
int sd_dhcp_client_set_mtu(
                sd_dhcp_client *client,
                uint32_t mtu);
int sd_dhcp_client_set_max_attempts(
                sd_dhcp_client *client,
                uint64_t attempt);
int sd_dhcp_client_set_client_port(
                sd_dhcp_client *client,
                uint16_t port);
int sd_dhcp_client_set_hostname(
                sd_dhcp_client *client,
                const char *hostname);
int sd_dhcp_client_set_vendor_class_identifier(
                sd_dhcp_client *client,
                const char *vci);
int sd_dhcp_client_set_user_class(
                sd_dhcp_client *client,
                const char* const *user_class);
int sd_dhcp_client_get_lease(
                sd_dhcp_client *client,
                sd_dhcp_lease **ret);
int sd_dhcp_client_set_service_type(
                sd_dhcp_client *client,
                int type);

int sd_dhcp_client_set_dhcp_option(sd_dhcp_client *client, sd_dhcp_option *v);

int sd_dhcp_client_stop(sd_dhcp_client *client);
int sd_dhcp_client_start(sd_dhcp_client *client);
int sd_dhcp_client_send_release(sd_dhcp_client *client);
int sd_dhcp_client_send_renew(sd_dhcp_client *client);

sd_dhcp_client *sd_dhcp_client_ref(sd_dhcp_client *client);
sd_dhcp_client *sd_dhcp_client_unref(sd_dhcp_client *client);

/* NOTE: anonymize parameter is used to initialize PRL memory with different
 * options when using RFC7844 Anonymity Profiles */
int sd_dhcp_client_new(sd_dhcp_client **ret, int anonymize);

int sd_dhcp_client_attach_event(
                sd_dhcp_client *client,
                sd_event *event,
                int64_t priority);
int sd_dhcp_client_detach_event(sd_dhcp_client *client);
sd_event *sd_dhcp_client_get_event(sd_dhcp_client *client);

_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_dhcp_client, sd_dhcp_client_unref);

_SD_END_DECLARATIONS;

#endif
Commit	Line	Data
53e1b683	1	/* SPDX-License-Identifier: LGPL-2.1+ */
011feef8 PF	2	#ifndef foosddhcpclienthfoo
	3	#define foosddhcpclienthfoo
	4
	5	/***
810adae9	6	Copyright © 2013 Intel Corporation. All rights reserved.
011feef8 PF	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
04c01369	22	#include <inttypes.h>
46a66b79	23	#include <net/ethernet.h>
04c01369 LP	24	#include <netinet/in.h>
04c01369 LP	25	#include <sys/types.h>
8217ed5e	26	#include <stdbool.h>
011feef8	27
fe8db0c5	28	#include "sd-dhcp-lease.h"
461dbb2f	29	#include "sd-dhcp-option.h"
71d35b6b	30	#include "sd-event.h"
d3d8ac2f	31
04c01369 LP	32	#include "_sd-common.h"
	33
	34	_SD_BEGIN_DECLARATIONS;
	35
3e3d8f78	36	enum {
03748142 DH	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,
727b5734	42	SD_DHCP_CLIENT_EVENT_SELECTING = 5,
3e3d8f78 PF	43	};
3e3d8f78 PF	44
22805d92 BG	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,
19b8398f	63	/* Windows 10 option to send when Anonymize=true */
19b8398f	64	SD_DHCP_OPTION_ROUTER_DISCOVER = 31,
22805d92 BG	65	SD_DHCP_OPTION_STATIC_ROUTE = 33,
	66	SD_DHCP_OPTION_NTP_SERVER = 42,
	67	SD_DHCP_OPTION_VENDOR_SPECIFIC = 43,
19b8398f	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,
22805d92 BG	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,
af1c0de0	86	SD_DHCP_OPTION_USER_CLASS = 77,
22805d92 BG	87	SD_DHCP_OPTION_FQDN = 81,
	88	SD_DHCP_OPTION_NEW_POSIX_TIMEZONE = 100,
	89	SD_DHCP_OPTION_NEW_TZDB_TIMEZONE = 101,
b85bc551	90	SD_DHCP_OPTION_DOMAIN_SEARCH_LIST = 119,
299d578f	91	SD_DHCP_OPTION_SIP_SERVER = 120,
22805d92 BG	92	SD_DHCP_OPTION_CLASSLESS_STATIC_ROUTE = 121,
22805d92 BG	93	SD_DHCP_OPTION_PRIVATE_BASE = 224,
19b8398f	94	/* Windows 10 option to send when Anonymize=true */
	95	SD_DHCP_OPTION_PRIVATE_CLASSLESS_STATIC_ROUTE = 249,
	96	/* Windows 10 option to send when Anonymize=true */
	97	SD_DHCP_OPTION_PRIVATE_PROXY_AUTODISCOVERY = 252,
22805d92 BG	98	SD_DHCP_OPTION_PRIVATE_LAST = 254,
	99	SD_DHCP_OPTION_END = 255,
	100	};
	101
011feef8 PF	102	typedef struct sd_dhcp_client sd_dhcp_client;
011feef8 PF	103
727b5734	104	typedef int (sd_dhcp_client_callback_t)(sd_dhcp_client client, int event, void *userdata);
4b558378 ZJS	105	int sd_dhcp_client_set_callback(
	106	sd_dhcp_client *client,
	107	sd_dhcp_client_callback_t cb,
	108	void *userdata);
	109
	110	int sd_dhcp_client_set_request_option(
	111	sd_dhcp_client *client,
	112	uint8_t option);
	113	int sd_dhcp_client_set_request_address(
	114	sd_dhcp_client *client,
	115	const struct in_addr *last_address);
	116	int sd_dhcp_client_set_request_broadcast(
	117	sd_dhcp_client *client,
	118	int broadcast);
2f8e7633	119	int sd_dhcp_client_set_ifindex(
4b558378 ZJS	120	sd_dhcp_client *client,
	121	int interface_index);
	122	int sd_dhcp_client_set_mac(
	123	sd_dhcp_client *client,
	124	const uint8_t *addr,
	125	size_t addr_len,
	126	uint16_t arp_type);
	127	int sd_dhcp_client_set_client_id(
	128	sd_dhcp_client *client,
	129	uint8_t type,
	130	const uint8_t *data,
	131	size_t data_len);
	132	int sd_dhcp_client_set_iaid_duid(
	133	sd_dhcp_client *client,
8217ed5e	134	bool iaid_set,
4b558378 ZJS	135	uint32_t iaid,
4b558378 ZJS	136	uint16_t duid_type,
f7a92d1a	137	const void *duid,
4b558378	138	size_t duid_len);
7e90a499 YW	139	int sd_dhcp_client_set_iaid_duid_llt(
7e90a499 YW	140	sd_dhcp_client *client,
8217ed5e	141	bool iaid_set,
7e90a499 YW	142	uint32_t iaid,
7e90a499 YW	143	uint64_t llt_time);
dace710c YW	144	int sd_dhcp_client_set_duid(
	145	sd_dhcp_client *client,
	146	uint16_t duid_type,
	147	const void *duid,
	148	size_t duid_len);
7e90a499 YW	149	int sd_dhcp_client_set_duid_llt(
	150	sd_dhcp_client *client,
	151	uint64_t llt_time);
4b558378 ZJS	152	int sd_dhcp_client_get_client_id(
	153	sd_dhcp_client *client,
	154	uint8_t *type,
	155	const uint8_t **data,
	156	size_t *data_len);
	157	int sd_dhcp_client_set_mtu(
	158	sd_dhcp_client *client,
	159	uint32_t mtu);
715cedfb SS	160	int sd_dhcp_client_set_max_attempts(
	161	sd_dhcp_client *client,
	162	uint64_t attempt);
9faed222 SS	163	int sd_dhcp_client_set_client_port(
	164	sd_dhcp_client *client,
	165	uint16_t port);
4b558378 ZJS	166	int sd_dhcp_client_set_hostname(
	167	sd_dhcp_client *client,
	168	const char *hostname);
	169	int sd_dhcp_client_set_vendor_class_identifier(
	170	sd_dhcp_client *client,
	171	const char *vci);
af1c0de0 SS	172	int sd_dhcp_client_set_user_class(
	173	sd_dhcp_client *client,
	174	const char* const *user_class);
4b558378 ZJS	175	int sd_dhcp_client_get_lease(
	176	sd_dhcp_client *client,
	177	sd_dhcp_lease **ret);
afe42aef SC	178	int sd_dhcp_client_set_service_type(
	179	sd_dhcp_client *client,
	180	int type);
a6cc569e	181
cb29c156 SS	182	int sd_dhcp_client_set_dhcp_option(sd_dhcp_client client, sd_dhcp_option v);
cb29c156 SS	183
bbdf06d9	184	int sd_dhcp_client_stop(sd_dhcp_client *client);
46a66b79	185	int sd_dhcp_client_start(sd_dhcp_client *client);
1501b429	186	int sd_dhcp_client_send_release(sd_dhcp_client *client);
1c9a2e26	187	int sd_dhcp_client_send_renew(sd_dhcp_client *client);
e5b04c8d PF	188
	189	sd_dhcp_client sd_dhcp_client_ref(sd_dhcp_client client);
	190	sd_dhcp_client sd_dhcp_client_unref(sd_dhcp_client client);
	191
db3d2358	192	/* NOTE: anonymize parameter is used to initialize PRL memory with different
	193	* options when using RFC7844 Anonymity Profiles */
	194	int sd_dhcp_client_new(sd_dhcp_client **ret, int anonymize);
b25ef18b	195
4b558378 ZJS	196	int sd_dhcp_client_attach_event(
	197	sd_dhcp_client *client,
	198	sd_event *event,
	199	int64_t priority);
b25ef18b TG	200	int sd_dhcp_client_detach_event(sd_dhcp_client *client);
b25ef18b TG	201	sd_event sd_dhcp_client_get_event(sd_dhcp_client client);
011feef8	202
4afd3348 LP	203	_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_dhcp_client, sd_dhcp_client_unref);
4afd3348 LP	204
04c01369 LP	205	_SD_END_DECLARATIONS;
04c01369 LP	206
011feef8	207	#endif