Debian Codegraph @

src/libsystemd-network/dhcp-protocol.h

raw
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 #pragma once
3
4 /***
5 Copyright © 2013 Intel Corporation. All rights reserved.
6 ***/
7
8 #include "sd-dhcp-protocol.h" /* IWYU pragma: export */
9
10 #include "dhcp-forward.h"
11 #include "time-util.h"
12
13 /* RFC 8925 - IPv6-Only Preferred Option for DHCPv4 3.4.
14 * MIN_V6ONLY_WAIT: The lower boundary for V6ONLY_WAIT. Value: 300 seconds */
15 #define MIN_V6ONLY_WAIT_USEC (300U * USEC_PER_SEC)
16
17 struct DHCPMessageHeader {
18 uint8_t op;
19 uint8_t htype;
20 uint8_t hlen;
21 uint8_t hops;
22 be32_t xid;
23 be16_t secs;
24 be16_t flags;
25 be32_t ciaddr;
26 be32_t yiaddr;
27 be32_t siaddr;
28 be32_t giaddr;
29 uint8_t chaddr[16];
30 uint8_t sname[64];
31 uint8_t file[128];
32 be32_t magic;
33 } _packed_;
34
35 typedef struct DHCPMessageHeader DHCPMessageHeader;
36
37 #define DHCP_MAGIC_COOKIE (uint32_t)(0x63825363)
38
39 /* The size of BOOTP message. The BOOTP message does not have the magic field, but has the 64-byte
40 * vendor-specific area. */
41 #define BOOTP_MESSAGE_SIZE (offsetof(DHCPMessageHeader, magic) + 64)
42
43 enum {
44 DHCP_PORT_SERVER = 67,
45 DHCP_PORT_CLIENT = 68,
46 };
47
48 typedef enum {
49 BOOTREQUEST = 1,
50 BOOTREPLY = 2,
51 _BOOTP_MESSAGE_TYPE_MAX,
52 _BOOTP_MESSAGE_TYPE_INVALID = -EINVAL,
53 } BOOTPMessageType;
54
55 DECLARE_STRING_TABLE_LOOKUP_TO_STRING(bootp_message_type, BOOTPMessageType);
56
57 typedef enum {
58 DHCP_DISCOVER = 1, /* [RFC2132] */
59 DHCP_OFFER = 2, /* [RFC2132] */
60 DHCP_REQUEST = 3, /* [RFC2132] */
61 DHCP_DECLINE = 4, /* [RFC2132] */
62 DHCP_ACK = 5, /* [RFC2132] */
63 DHCP_NAK = 6, /* [RFC2132] */
64 DHCP_RELEASE = 7, /* [RFC2132] */
65 DHCP_INFORM = 8, /* [RFC2132] */
66 DHCP_FORCERENEW = 9, /* [RFC3203] */
67 DHCP_LEASEQUERY = 10, /* [RFC4388] */
68 DHCP_LEASEUNASSIGNED = 11, /* [RFC4388] */
69 DHCP_LEASEUNKNOWN = 12, /* [RFC4388] */
70 DHCP_LEASEACTIVE = 13, /* [RFC4388] */
71 DHCP_BULKLEASEQUERY = 14, /* [RFC6926] */
72 DHCP_LEASEQUERYDONE = 15, /* [RFC6926] */
73 DHCP_ACTIVELEASEQUERY = 16, /* [RFC7724] */
74 DHCP_LEASEQUERYSTATUS = 17, /* [RFC7724] */
75 DHCP_TLS = 18, /* [RFC7724] */
76 _DHCP_MESSAGE_TYPE_MAX,
77 _DHCP_MESSAGE_TYPE_INVALID = -EINVAL,
78 } DHCPMessageType;
79
80 DECLARE_STRING_TABLE_LOOKUP_TO_STRING(dhcp_message_type, DHCPMessageType);
81
82 typedef enum {
83 DHCP_OVERLOAD_NONE = 0,
84 DHCP_OVERLOAD_FILE = 1 << 0,
85 DHCP_OVERLOAD_SNAME = 1 << 1,
86 _DHCP_OVERLOAD_ALL = DHCP_OVERLOAD_FILE | DHCP_OVERLOAD_SNAME,
87 } DHCPOptionOverload;
88
89 #define DHCP_MAX_FQDN_LENGTH 255
90
91 enum {
92 DHCP_FQDN_FLAG_S = (1 << 0),
93 DHCP_FQDN_FLAG_O = (1 << 1),
94 DHCP_FQDN_FLAG_E = (1 << 2),
95 DHCP_FQDN_FLAG_N = (1 << 3),
96 };
97
98 /* For SD_DHCP_RELAY_AGENT_FLAGS sub-option. */
99 enum {
100 DHCP_RELAY_AGENT_FLAG_UNICAST = 1 << 0,
101 };
102
103 DECLARE_STRING_TABLE_LOOKUP_TO_STRING(dhcp_option_code, int);
104
105 typedef enum DHCPState {
106 DHCP_STATE_STOPPED,
107 DHCP_STATE_INIT,
108 DHCP_STATE_SELECTING,
109 DHCP_STATE_INIT_REBOOT,
110 DHCP_STATE_REBOOTING,
111 DHCP_STATE_REQUESTING,
112 DHCP_STATE_BOUND,
113 DHCP_STATE_RENEWING,
114 DHCP_STATE_REBINDING,
115 _DHCP_STATE_MAX,
116 _DHCP_STATE_INVALID = -EINVAL,
117 } DHCPState;
118
119 DECLARE_STRING_TABLE_LOOKUP_TO_STRING(dhcp_state, DHCPState);