1 | /**
|
---|
2 | * @file
|
---|
3 | * DHCPv6 protocol definitions
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (c) 2017 Simon Goldschmidt <goldsimon@gmx.de>
|
---|
8 | * All rights reserved.
|
---|
9 | *
|
---|
10 | * Redistribution and use in source and binary forms, with or without modification,
|
---|
11 | * are permitted provided that the following conditions are met:
|
---|
12 | *
|
---|
13 | * 1. Redistributions of source code must retain the above copyright notice,
|
---|
14 | * this list of conditions and the following disclaimer.
|
---|
15 | * 2. Redistributions in binary form must reproduce the above copyright notice,
|
---|
16 | * this list of conditions and the following disclaimer in the documentation
|
---|
17 | * and/or other materials provided with the distribution.
|
---|
18 | * 3. The name of the author may not be used to endorse or promote products
|
---|
19 | * derived from this software without specific prior written permission.
|
---|
20 | *
|
---|
21 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
|
---|
22 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
---|
23 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
|
---|
24 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
---|
25 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
|
---|
26 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
---|
27 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
---|
28 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
|
---|
29 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
|
---|
30 | * OF SUCH DAMAGE.
|
---|
31 | *
|
---|
32 | * This file is part of the lwIP TCP/IP stack.
|
---|
33 | *
|
---|
34 | * Author: Simon Goldschmidt <goldsimon@gmx.de>
|
---|
35 | *
|
---|
36 | */
|
---|
37 | #ifndef LWIP_HDR_PROT_DHCP6_H
|
---|
38 | #define LWIP_HDR_PROT_DHCP6_H
|
---|
39 |
|
---|
40 | #include "lwip/opt.h"
|
---|
41 |
|
---|
42 | #ifdef __cplusplus
|
---|
43 | extern "C" {
|
---|
44 | #endif
|
---|
45 |
|
---|
46 | #define DHCP6_CLIENT_PORT 546
|
---|
47 | #define DHCP6_SERVER_PORT 547
|
---|
48 |
|
---|
49 |
|
---|
50 | /* DHCPv6 message item offsets and length */
|
---|
51 | #define DHCP6_TRANSACTION_ID_LEN 3
|
---|
52 |
|
---|
53 | #ifdef PACK_STRUCT_USE_INCLUDES
|
---|
54 | # include "arch/bpstruct.h"
|
---|
55 | #endif
|
---|
56 | PACK_STRUCT_BEGIN
|
---|
57 | /** minimum set of fields of any DHCPv6 message */
|
---|
58 | struct dhcp6_msg
|
---|
59 | {
|
---|
60 | PACK_STRUCT_FLD_8(u8_t msgtype);
|
---|
61 | PACK_STRUCT_FLD_8(u8_t transaction_id[DHCP6_TRANSACTION_ID_LEN]);
|
---|
62 | /* options follow */
|
---|
63 | } PACK_STRUCT_STRUCT;
|
---|
64 | PACK_STRUCT_END
|
---|
65 | #ifdef PACK_STRUCT_USE_INCLUDES
|
---|
66 | # include "arch/epstruct.h"
|
---|
67 | #endif
|
---|
68 |
|
---|
69 |
|
---|
70 | /* DHCP6 client states */
|
---|
71 | typedef enum {
|
---|
72 | DHCP6_STATE_OFF = 0,
|
---|
73 | DHCP6_STATE_STATELESS_IDLE = 1,
|
---|
74 | DHCP6_STATE_REQUESTING_CONFIG = 2
|
---|
75 | } dhcp6_state_enum_t;
|
---|
76 |
|
---|
77 | /* DHCPv6 message types */
|
---|
78 | #define DHCP6_SOLICIT 1
|
---|
79 | #define DHCP6_ADVERTISE 2
|
---|
80 | #define DHCP6_REQUEST 3
|
---|
81 | #define DHCP6_CONFIRM 4
|
---|
82 | #define DHCP6_RENEW 5
|
---|
83 | #define DHCP6_REBIND 6
|
---|
84 | #define DHCP6_REPLY 7
|
---|
85 | #define DHCP6_RELEASE 8
|
---|
86 | #define DHCP6_DECLINE 9
|
---|
87 | #define DHCP6_RECONFIGURE 10
|
---|
88 | #define DHCP6_INFOREQUEST 11
|
---|
89 | #define DHCP6_RELAYFORW 12
|
---|
90 | #define DHCP6_RELAYREPL 13
|
---|
91 | /* More message types see https://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xhtml */
|
---|
92 |
|
---|
93 | /** DHCPv6 status codes */
|
---|
94 | #define DHCP6_STATUS_SUCCESS 0 /* Success. */
|
---|
95 | #define DHCP6_STATUS_UNSPECFAIL 1 /* Failure, reason unspecified; this status code is sent by either a client or a server to indicate a failure not explicitly specified in this document. */
|
---|
96 | #define DHCP6_STATUS_NOADDRSAVAIL 2 /* Server has no addresses available to assign to the IA(s). */
|
---|
97 | #define DHCP6_STATUS_NOBINDING 3 /* Client record (binding) unavailable. */
|
---|
98 | #define DHCP6_STATUS_NOTONLINK 4 /* The prefix for the address is not appropriate for the link to which the client is attached. */
|
---|
99 | #define DHCP6_STATUS_USEMULTICAST 5 /* Sent by a server to a client to force the client to send messages to the server using the All_DHCP_Relay_Agents_and_Servers address. */
|
---|
100 | /* More status codes see https://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xhtml */
|
---|
101 |
|
---|
102 | /** DHCPv6 DUID types */
|
---|
103 | #define DHCP6_DUID_LLT 1 /* LLT: Link-layer Address Plus Time */
|
---|
104 | #define DHCP6_DUID_EN 2 /* EN: Enterprise number */
|
---|
105 | #define DHCP6_DUID_LL 3 /* LL: Link-layer Address */
|
---|
106 | #define DHCP6_DUID_UUID 4 /* UUID (RFC 6355) */
|
---|
107 |
|
---|
108 | /* DHCPv6 options */
|
---|
109 | #define DHCP6_OPTION_CLIENTID 1
|
---|
110 | #define DHCP6_OPTION_SERVERID 2
|
---|
111 | #define DHCP6_OPTION_IA_NA 3
|
---|
112 | #define DHCP6_OPTION_IA_TA 4
|
---|
113 | #define DHCP6_OPTION_IAADDR 5
|
---|
114 | #define DHCP6_OPTION_ORO 6
|
---|
115 | #define DHCP6_OPTION_PREFERENCE 7
|
---|
116 | #define DHCP6_OPTION_ELAPSED_TIME 8
|
---|
117 | #define DHCP6_OPTION_RELAY_MSG 9
|
---|
118 | #define DHCP6_OPTION_AUTH 11
|
---|
119 | #define DHCP6_OPTION_UNICAST 12
|
---|
120 | #define DHCP6_OPTION_STATUS_CODE 13
|
---|
121 | #define DHCP6_OPTION_RAPID_COMMIT 14
|
---|
122 | #define DHCP6_OPTION_USER_CLASS 15
|
---|
123 | #define DHCP6_OPTION_VENDOR_CLASS 16
|
---|
124 | #define DHCP6_OPTION_VENDOR_OPTS 17
|
---|
125 | #define DHCP6_OPTION_INTERFACE_ID 18
|
---|
126 | #define DHCP6_OPTION_RECONF_MSG 19
|
---|
127 | #define DHCP6_OPTION_RECONF_ACCEPT 20
|
---|
128 | /* More options see https://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xhtml */
|
---|
129 | #define DHCP6_OPTION_DNS_SERVERS 23 /* RFC 3646 */
|
---|
130 | #define DHCP6_OPTION_DOMAIN_LIST 24 /* RFC 3646 */
|
---|
131 | #define DHCP6_OPTION_SNTP_SERVERS 31 /* RFC 4075 */
|
---|
132 |
|
---|
133 |
|
---|
134 | #ifdef __cplusplus
|
---|
135 | }
|
---|
136 | #endif
|
---|
137 |
|
---|
138 | #endif /* LWIP_HDR_PROT_DHCP6_H */
|
---|