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

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

/***
  Copyright © 2014 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 <sys/types.h>

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

#include "_sd-common.h"

_SD_BEGIN_DECLARATIONS;

enum {
        SD_DHCP6_CLIENT_EVENT_STOP                      = 0,
        SD_DHCP6_CLIENT_EVENT_RESEND_EXPIRE             = 10,
        SD_DHCP6_CLIENT_EVENT_RETRANS_MAX               = 11,
        SD_DHCP6_CLIENT_EVENT_IP_ACQUIRE                = 12,
        SD_DHCP6_CLIENT_EVENT_INFORMATION_REQUEST       = 13,
};

enum {
        SD_DHCP6_OPTION_CLIENTID                   = 1,
        SD_DHCP6_OPTION_SERVERID                   = 2,
        SD_DHCP6_OPTION_IA_NA                      = 3,
        SD_DHCP6_OPTION_IA_TA                      = 4,
        SD_DHCP6_OPTION_IAADDR                     = 5,
        SD_DHCP6_OPTION_ORO                        = 6,
        SD_DHCP6_OPTION_PREFERENCE                 = 7,
        SD_DHCP6_OPTION_ELAPSED_TIME               = 8,
        SD_DHCP6_OPTION_RELAY_MSG                  = 9,
        /* option code 10 is unassigned */
        SD_DHCP6_OPTION_AUTH                       = 11,
        SD_DHCP6_OPTION_UNICAST                    = 12,
        SD_DHCP6_OPTION_STATUS_CODE                = 13,
        SD_DHCP6_OPTION_RAPID_COMMIT               = 14,
        SD_DHCP6_OPTION_USER_CLASS                 = 15,
        SD_DHCP6_OPTION_VENDOR_CLASS               = 16,
        SD_DHCP6_OPTION_VENDOR_OPTS                = 17,
        SD_DHCP6_OPTION_INTERFACE_ID               = 18,
        SD_DHCP6_OPTION_RECONF_MSG                 = 19,
        SD_DHCP6_OPTION_RECONF_ACCEPT              = 20,

        SD_DHCP6_OPTION_DNS_SERVERS                = 23,  /* RFC 3646 */
        SD_DHCP6_OPTION_DOMAIN_LIST                = 24,  /* RFC 3646 */
        SD_DHCP6_OPTION_IA_PD                      = 25,  /* RFC 3633, prefix delegation */
        SD_DHCP6_OPTION_IA_PD_PREFIX               = 26,  /* RFC 3633, prefix delegation */

        SD_DHCP6_OPTION_SNTP_SERVERS               = 31,  /* RFC 4075, deprecated */
        SD_DHCP6_OPTION_INFORMATION_REFRESH_TIME   = 32,  /* RFC 8415, sec. 21.23 */

        /* option code 35 is unassigned */

        SD_DHCP6_OPTION_FQDN                       = 39,  /* RFC 4704 */

        SD_DHCP6_OPTION_NTP_SERVER                 = 56,  /* RFC 5908 */
        SD_DHCP6_OPTION_MUD_URL                    = 112, /* RFC 8250 */

        /* option codes 89-142 are unassigned */
        /* option codes 144-65535 are unassigned */
};

typedef struct sd_dhcp6_client sd_dhcp6_client;

typedef void (*sd_dhcp6_client_callback_t)(sd_dhcp6_client *client, int event, void *userdata);
int sd_dhcp6_client_set_callback(
                sd_dhcp6_client *client,
                sd_dhcp6_client_callback_t cb,
                void *userdata);

int sd_dhcp6_client_set_ifindex(
                sd_dhcp6_client *client,
                int interface_index);
int sd_dhcp6_client_set_local_address(
                sd_dhcp6_client *client,
                const struct in6_addr *local_address);
int sd_dhcp6_client_set_mac(
                sd_dhcp6_client *client,
                const uint8_t *addr,
                size_t addr_len,
                uint16_t arp_type);
int sd_dhcp6_client_set_duid(
                sd_dhcp6_client *client,
                uint16_t duid_type,
                const void *duid,
                size_t duid_len);
int sd_dhcp6_client_set_duid_llt(
                sd_dhcp6_client *client,
                uint64_t llt_time);
int sd_dhcp6_client_set_iaid(
                sd_dhcp6_client *client,
                uint32_t iaid);
int sd_dhcp6_client_get_iaid(
                sd_dhcp6_client *client,
                uint32_t *iaid);
int sd_dhcp6_client_duid_as_string(
                sd_dhcp6_client *client,
                char **duid);
int sd_dhcp6_client_set_fqdn(
                sd_dhcp6_client *client,
                const char *fqdn);
int sd_dhcp6_client_set_information_request(
                sd_dhcp6_client *client,
                int enabled);
int sd_dhcp6_client_get_information_request(
                sd_dhcp6_client *client,
                int *enabled);
int sd_dhcp6_client_set_request_option(
                sd_dhcp6_client *client,
                uint16_t option);
int sd_dhcp6_client_set_request_mud_url(
                sd_dhcp6_client *client,
                const char *mudurl);
int sd_dhcp6_client_set_request_user_class(
                sd_dhcp6_client *client,
                char** user_class);
int sd_dhcp6_client_set_request_vendor_class(
                sd_dhcp6_client *client,
                char** vendor_class);
int sd_dhcp6_client_set_prefix_delegation_hint(
                sd_dhcp6_client *client,
                uint8_t prefixlen,
                const struct in6_addr *pd_address);
int sd_dhcp6_client_get_prefix_delegation(sd_dhcp6_client *client,
                                          int *delegation);
int sd_dhcp6_client_set_prefix_delegation(sd_dhcp6_client *client,
                                          int delegation);
int sd_dhcp6_client_get_address_request(sd_dhcp6_client *client,
                                        int *request);
int sd_dhcp6_client_set_address_request(sd_dhcp6_client *client,
                                        int request);
int sd_dhcp6_client_set_transaction_id(sd_dhcp6_client *client,
                                       uint32_t transaction_id);
int sd_dhcp6_client_add_vendor_option(sd_dhcp6_client *client,
                                      sd_dhcp6_option *v);

int sd_dhcp6_client_get_lease(
                sd_dhcp6_client *client,
                sd_dhcp6_lease **ret);

int sd_dhcp6_client_add_option(sd_dhcp6_client *client, sd_dhcp6_option *v);

int sd_dhcp6_client_stop(sd_dhcp6_client *client);
int sd_dhcp6_client_start(sd_dhcp6_client *client);
int sd_dhcp6_client_is_running(sd_dhcp6_client *client);
int sd_dhcp6_client_attach_event(
                sd_dhcp6_client *client,
                sd_event *event,
                int64_t priority);
int sd_dhcp6_client_detach_event(sd_dhcp6_client *client);
sd_event *sd_dhcp6_client_get_event(sd_dhcp6_client *client);
sd_dhcp6_client *sd_dhcp6_client_ref(sd_dhcp6_client *client);
sd_dhcp6_client *sd_dhcp6_client_unref(sd_dhcp6_client *client);
int sd_dhcp6_client_new(sd_dhcp6_client **ret);

_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_dhcp6_client, sd_dhcp6_client_unref);

_SD_END_DECLARATIONS;

#endif
Commit	Line	Data
53e1b683	1	/* SPDX-License-Identifier: LGPL-2.1+ */
139b011a PF	2	#ifndef foosddhcp6clienthfoo
	3	#define foosddhcp6clienthfoo
	4
	5	/***
810adae9	6	Copyright © 2014 Intel Corporation. All rights reserved.
139b011a 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>
139b011a	23	#include <net/ethernet.h>
04c01369	24	#include <sys/types.h>
139b011a	25
ea3b3a75	26	#include "sd-dhcp6-lease.h"
e7d5fe17	27	#include "sd-dhcp6-option.h"
71d35b6b	28	#include "sd-event.h"
ea3b3a75	29
04c01369 LP	30	#include "_sd-common.h"
	31
	32	_SD_BEGIN_DECLARATIONS;
	33
139b011a	34	enum {
10c9ce61 DH	35	SD_DHCP6_CLIENT_EVENT_STOP = 0,
	36	SD_DHCP6_CLIENT_EVENT_RESEND_EXPIRE = 10,
	37	SD_DHCP6_CLIENT_EVENT_RETRANS_MAX = 11,
	38	SD_DHCP6_CLIENT_EVENT_IP_ACQUIRE = 12,
	39	SD_DHCP6_CLIENT_EVENT_INFORMATION_REQUEST = 13,
139b011a PF	40	};
139b011a PF	41
2c1ab8ca BG	42	enum {
	43	SD_DHCP6_OPTION_CLIENTID = 1,
	44	SD_DHCP6_OPTION_SERVERID = 2,
	45	SD_DHCP6_OPTION_IA_NA = 3,
	46	SD_DHCP6_OPTION_IA_TA = 4,
	47	SD_DHCP6_OPTION_IAADDR = 5,
	48	SD_DHCP6_OPTION_ORO = 6,
	49	SD_DHCP6_OPTION_PREFERENCE = 7,
	50	SD_DHCP6_OPTION_ELAPSED_TIME = 8,
	51	SD_DHCP6_OPTION_RELAY_MSG = 9,
	52	/* option code 10 is unassigned */
	53	SD_DHCP6_OPTION_AUTH = 11,
	54	SD_DHCP6_OPTION_UNICAST = 12,
	55	SD_DHCP6_OPTION_STATUS_CODE = 13,
	56	SD_DHCP6_OPTION_RAPID_COMMIT = 14,
	57	SD_DHCP6_OPTION_USER_CLASS = 15,
	58	SD_DHCP6_OPTION_VENDOR_CLASS = 16,
	59	SD_DHCP6_OPTION_VENDOR_OPTS = 17,
	60	SD_DHCP6_OPTION_INTERFACE_ID = 18,
	61	SD_DHCP6_OPTION_RECONF_MSG = 19,
	62	SD_DHCP6_OPTION_RECONF_ACCEPT = 20,
	63
	64	SD_DHCP6_OPTION_DNS_SERVERS = 23, /* RFC 3646 */
	65	SD_DHCP6_OPTION_DOMAIN_LIST = 24, /* RFC 3646 */
831ad964 PF	66	SD_DHCP6_OPTION_IA_PD = 25, /* RFC 3633, prefix delegation */
831ad964 PF	67	SD_DHCP6_OPTION_IA_PD_PREFIX = 26, /* RFC 3633, prefix delegation */
2c1ab8ca BG	68
2c1ab8ca BG	69	SD_DHCP6_OPTION_SNTP_SERVERS = 31, /* RFC 4075, deprecated */
fcb51238	70	SD_DHCP6_OPTION_INFORMATION_REFRESH_TIME = 32, /* RFC 8415, sec. 21.23 */
2c1ab8ca BG	71
	72	/* option code 35 is unassigned */
	73
8006aa32 SA	74	SD_DHCP6_OPTION_FQDN = 39, /* RFC 4704 */
8006aa32 SA	75
2c1ab8ca	76	SD_DHCP6_OPTION_NTP_SERVER = 56, /* RFC 5908 */
de8d6e55	77	SD_DHCP6_OPTION_MUD_URL = 112, /* RFC 8250 */
2c1ab8ca BG	78
	79	/* option codes 89-142 are unassigned */
	80	/* option codes 144-65535 are unassigned */
	81	};
	82
139b011a PF	83	typedef struct sd_dhcp6_client sd_dhcp6_client;
139b011a PF	84
4b558378 ZJS	85	typedef void (sd_dhcp6_client_callback_t)(sd_dhcp6_client client, int event, void *userdata);
	86	int sd_dhcp6_client_set_callback(
	87	sd_dhcp6_client *client,
	88	sd_dhcp6_client_callback_t cb,
	89	void *userdata);
	90
2f8e7633	91	int sd_dhcp6_client_set_ifindex(
4b558378 ZJS	92	sd_dhcp6_client *client,
	93	int interface_index);
	94	int sd_dhcp6_client_set_local_address(
	95	sd_dhcp6_client *client,
	96	const struct in6_addr *local_address);
	97	int sd_dhcp6_client_set_mac(
	98	sd_dhcp6_client *client,
	99	const uint8_t *addr,
	100	size_t addr_len,
	101	uint16_t arp_type);
	102	int sd_dhcp6_client_set_duid(
	103	sd_dhcp6_client *client,
	104	uint16_t duid_type,
f7a92d1a	105	const void *duid,
4b558378	106	size_t duid_len);
7e90a499 YW	107	int sd_dhcp6_client_set_duid_llt(
	108	sd_dhcp6_client *client,
	109	uint64_t llt_time);
4b558378 ZJS	110	int sd_dhcp6_client_set_iaid(
	111	sd_dhcp6_client *client,
	112	uint32_t iaid);
d69d4038 SS	113	int sd_dhcp6_client_get_iaid(
	114	sd_dhcp6_client *client,
	115	uint32_t *iaid);
6b7d5b6e SS	116	int sd_dhcp6_client_duid_as_string(
	117	sd_dhcp6_client *client,
	118	char **duid);
8006aa32 SA	119	int sd_dhcp6_client_set_fqdn(
	120	sd_dhcp6_client *client,
	121	const char *fqdn);
4b558378 ZJS	122	int sd_dhcp6_client_set_information_request(
	123	sd_dhcp6_client *client,
	124	int enabled);
	125	int sd_dhcp6_client_get_information_request(
	126	sd_dhcp6_client *client,
	127	int *enabled);
	128	int sd_dhcp6_client_set_request_option(
	129	sd_dhcp6_client *client,
	130	uint16_t option);
de8d6e55 SS	131	int sd_dhcp6_client_set_request_mud_url(
de8d6e55 SS	132	sd_dhcp6_client *client,
feb7d7a2	133	const char *mudurl);
33923925 SS	134	int sd_dhcp6_client_set_request_user_class(
	135	sd_dhcp6_client *client,
	136	char** user_class);
73c8ced7 SS	137	int sd_dhcp6_client_set_request_vendor_class(
	138	sd_dhcp6_client *client,
	139	char** vendor_class);
2805536b SS	140	int sd_dhcp6_client_set_prefix_delegation_hint(
	141	sd_dhcp6_client *client,
	142	uint8_t prefixlen,
	143	const struct in6_addr *pd_address);
d8c51121 PF	144	int sd_dhcp6_client_get_prefix_delegation(sd_dhcp6_client *client,
d8c51121 PF	145	int *delegation);
7c3de8f8	146	int sd_dhcp6_client_set_prefix_delegation(sd_dhcp6_client *client,
d8c51121	147	int delegation);
f311a62b PF	148	int sd_dhcp6_client_get_address_request(sd_dhcp6_client *client,
	149	int *request);
	150	int sd_dhcp6_client_set_address_request(sd_dhcp6_client *client,
	151	int request);
99ccb8ff SS	152	int sd_dhcp6_client_set_transaction_id(sd_dhcp6_client *client,
	153	uint32_t transaction_id);
	154	int sd_dhcp6_client_add_vendor_option(sd_dhcp6_client *client,
	155	sd_dhcp6_option *v);
4b558378 ZJS	156
	157	int sd_dhcp6_client_get_lease(
	158	sd_dhcp6_client *client,
	159	sd_dhcp6_lease **ret);
ea3b3a75	160
e7d5fe17 AD	161	int sd_dhcp6_client_add_option(sd_dhcp6_client client, sd_dhcp6_option v);
e7d5fe17 AD	162
139b011a PF	163	int sd_dhcp6_client_stop(sd_dhcp6_client *client);
139b011a PF	164	int sd_dhcp6_client_start(sd_dhcp6_client *client);
f667c150	165	int sd_dhcp6_client_is_running(sd_dhcp6_client *client);
4b558378 ZJS	166	int sd_dhcp6_client_attach_event(
	167	sd_dhcp6_client *client,
	168	sd_event *event,
	169	int64_t priority);
139b011a PF	170	int sd_dhcp6_client_detach_event(sd_dhcp6_client *client);
	171	sd_event sd_dhcp6_client_get_event(sd_dhcp6_client client);
	172	sd_dhcp6_client sd_dhcp6_client_ref(sd_dhcp6_client client);
	173	sd_dhcp6_client sd_dhcp6_client_unref(sd_dhcp6_client client);
	174	int sd_dhcp6_client_new(sd_dhcp6_client **ret);
	175
4afd3348 LP	176	_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_dhcp6_client, sd_dhcp6_client_unref);
4afd3348 LP	177
04c01369 LP	178	_SD_END_DECLARATIONS;
04c01369 LP	179
139b011a	180	#endif