// Copyright (C) 2006-2017 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#ifndef DHCP6_H
#define DHCP6_H

/// @note Code points in comments are those assigned by IANA
/// but not yet implemented in Kea.
/// To implement a standard option, remove the comment characters,
/// add an entry in std_option_defs.h, add a stdOptionDefs6 unit test
/// in tests/libdhcp++_unittest.cc and update dhcp6-std-options-list in
/// the dhcp6-srv.xml source file of the user guide.

/* DHCPv6 Option codes: */

#define D6O_CLIENTID                            1 /* RFC3315 */
#define D6O_SERVERID                            2
#define D6O_IA_NA                               3
#define D6O_IA_TA                               4
#define D6O_IAADDR                              5
#define D6O_ORO                                 6
#define D6O_PREFERENCE                          7
#define D6O_ELAPSED_TIME                        8
#define D6O_RELAY_MSG                           9
/* Option code 10 unassigned. */
#define D6O_AUTH                                11
#define D6O_UNICAST                             12
#define D6O_STATUS_CODE                         13
#define D6O_RAPID_COMMIT                        14
#define D6O_USER_CLASS                          15
#define D6O_VENDOR_CLASS                        16
#define D6O_VENDOR_OPTS                         17
#define D6O_INTERFACE_ID                        18
#define D6O_RECONF_MSG                          19
#define D6O_RECONF_ACCEPT                       20
#define D6O_SIP_SERVERS_DNS                     21 /* RFC3319 */
#define D6O_SIP_SERVERS_ADDR                    22 /* RFC3319 */
#define D6O_NAME_SERVERS                        23 /* RFC3646 */
#define D6O_DOMAIN_SEARCH                       24 /* RFC3646 */
#define D6O_IA_PD                               25 /* RFC3633 */
#define D6O_IAPREFIX                            26 /* RFC3633 */
#define D6O_NIS_SERVERS                         27 /* RFC3898 */
#define D6O_NISP_SERVERS                        28 /* RFC3898 */
#define D6O_NIS_DOMAIN_NAME                     29 /* RFC3898 */
#define D6O_NISP_DOMAIN_NAME                    30 /* RFC3898 */
#define D6O_SNTP_SERVERS                        31 /* RFC4075 */
#define D6O_INFORMATION_REFRESH_TIME            32 /* RFC4242 */
#define D6O_BCMCS_SERVER_D                      33 /* RFC4280 */
#define D6O_BCMCS_SERVER_A                      34 /* RFC4280 */
/* 35 is unassigned */
#define D6O_GEOCONF_CIVIC                       36 /* RFC4776 */
#define D6O_REMOTE_ID                           37 /* RFC4649 */
#define D6O_SUBSCRIBER_ID                       38 /* RFC4580 */
#define D6O_CLIENT_FQDN                         39 /* RFC4704 */
#define D6O_PANA_AGENT                          40 /* paa-option */
#define D6O_NEW_POSIX_TIMEZONE                  41 /* RFC4833 */
#define D6O_NEW_TZDB_TIMEZONE                   42 /* RFC4833 */
#define D6O_ERO                                 43 /* RFC4994 */
#define D6O_LQ_QUERY                            44 /* RFC5007 */
#define D6O_CLIENT_DATA                         45 /* RFC5007 */
#define D6O_CLT_TIME                            46 /* RFC5007 */
#define D6O_LQ_RELAY_DATA                       47 /* RFC5007 */
#define D6O_LQ_CLIENT_LINK                      48 /* RFC5007 */
//#define D6O_MIP6_HNIDF                          49 /* RFC6610 */
//#define D6O_MIP6_VDINF                          50 /* RFC6610 */
//#define D6O_V6_LOST                             51 /* RFC5223 */
//#define D6O_CAPWAP_AC_V6                        52 /* RFC5417 */
//#define D6O_RELAY_ID                            53 /* RFC5460 */
//#define D6O_IPV6_ADDRESS_MOS                    54 /* RFC5678 */
//#define D6O_IPV6_FQDN_MOS                       55 /* RFC5678 */
//#define D6O_NTP_SERVER                          56 /* RFC5908 */
//#define D6O_V6_ACCESS_DOMAIN                    57 /* RFC5986 */
//#define D6O_SIP_UA_CS_LIST                      58 /* RFC6011 */
#define D6O_BOOTFILE_URL                        59 /* RFC5970 */
#define D6O_BOOTFILE_PARAM                      60 /* RFC5970 */
#define D6O_CLIENT_ARCH_TYPE                    61 /* RFC5970 */
#define D6O_NII                                 62 /* RFC5970 */
//#define D6O_GEOLOCATION                         63 /* RFC6225 */
#define D6O_AFTR_NAME                           64 /* RFC6334 */
#define D6O_ERP_LOCAL_DOMAIN_NAME               65 /* RFC6440 */
#define D6O_RSOO                                66 /* RFC6422 */
#define D6O_PD_EXCLUDE                          67 /* RFC6603 */
//#define D6O_VSS                                 68 /* RFC6607 */
//#define D6O_MIP6_IDINF                          69 /* RFC6610 */
//#define D6O_MIP6_UDINF                          70 /* RFC6610 */
//#define D6O_MIP6_HNP                            71 /* RFC6610 */
//#define D6O_MIP6_HAA                            72 /* RFC6610 */
//#define D6O_MIP6_HAF                            73 /* RFC6610 */
//#define D6O_RDNSS_SELECTION                     74 /* RFC6731 */
//#define D6O_KRB_PRINCIPAL_NAME                  75 /* RFC6784 */
//#define D6O_KRB_REALM_NAME                      76 /* RFC6784 */
//#define D6O_KRB_DEFAULT_REALM_NAME              77 /* RFC6784 */
//#define D6O_KRB_KDC                             78 /* RFC6784 */
#define D6O_CLIENT_LINKLAYER_ADDR               79 /* RFC6939 */
//#define D6O_LINK_ADDRESS                        80 /* RFC6977 */
//#define D6O_RADIUS                              81 /* RFC7037 */
//#define D6O_SOL_MAX_RT                          82 /* RFC7083 */
//#define D6O_INF_MAX_RT                          83 /* RFC7083 */
//#define D6O_ADDRSEL                             84 /* RFC7078 */
//#define D6O_ADDRSEL_TABLE                       85 /* RFC7078 */
//#define D6O_V6_PCP_SERVER                       86 /* RFC7291 */
#define D6O_DHCPV4_MSG                          87 /* RFC7341 */
#define D6O_DHCPV4_O_DHCPV6_SERVER              88 /* RFC7341 */
//#define D6O_4RD                                 97 /* RFC7600 */
//#define D6O_4RD_MAP_RULE                        98 /* RFC7600 */
//#define D6O_4RD_NON_MAP_RULE                    99 /* RFC7600 */
//#define D6O_LQ_BASE_TIME                       100 /* RFC7653 */
//#define D6O_LQ_START_TIME                      101 /* RFC7653 */
//#define D6O_LQ_END_TIME                        102 /* RFC7653 */
/* 103-142 unassigned */
//#define D6O_IPV6_ADDRESS_ANDSF                 143 /* RFC6153 */

// The following are EXPERIMENTAL and may change when IANA assigns official
// values.
/* secure DHCPv6 (draft-ietf-dhc-sedhcpv6-08) */
/* temporary values for hackathon 93 */
#define D6O_PUBLIC_KEY                         701
#define D6O_CERTIFICATE                        702
#define D6O_SIGNATURE                          703
#define D6O_TIMESTAMP                          704

/*
 * Status Codes, from RFC 3315 section 24.4, and RFC 3633, 5007, 5460.
 */
#define STATUS_Success                   0
#define STATUS_UnspecFail                1
#define STATUS_NoAddrsAvail              2
#define STATUS_NoBinding                 3
#define STATUS_NotOnLink                 4
#define STATUS_UseMulticast              5
#define STATUS_NoPrefixAvail             6
#define STATUS_UnknownQueryType          7
#define STATUS_MalformedQuery            8
#define STATUS_NotConfigured             9
#define STATUS_NotAllowed               10
//#define STATUS_QueryTerminated          11
/* draft-ietf-dhc-dhcpv6-active-leasequery-04 */
//#define STATUS_DataMissing              12
//#define STATUS_CatchUpComplete          13
//#define STATUS_NotSupported             14
//#define STATUS_TLSConnectionRefused     15

// The following are EXPERIMENTAL and may change when IANA assigns official
// values.
/* secure DHCPv6 (draft-ietf-dhc-sedhcpv6-08) */
/* temporary values for hackathon 93 */
#define STATUS_AlgorithmNotSupported   705
#define STATUS_AuthenticationFail      706
#define STATUS_TimestampFail           707
#define STATUS_SignatureFail           708

/*
 * DHCPv6 message types, defined in section 5.3 of RFC 3315
 */
#define DHCPV6_SOLICIT              1
#define DHCPV6_ADVERTISE            2
#define DHCPV6_REQUEST              3
#define DHCPV6_CONFIRM              4
#define DHCPV6_RENEW                5
#define DHCPV6_REBIND               6
#define DHCPV6_REPLY                7
#define DHCPV6_RELEASE              8
#define DHCPV6_DECLINE              9
#define DHCPV6_RECONFIGURE         10
#define DHCPV6_INFORMATION_REQUEST 11
#define DHCPV6_RELAY_FORW          12
#define DHCPV6_RELAY_REPL          13
/* RFC 5007 */
#define DHCPV6_LEASEQUERY          14
#define DHCPV6_LEASEQUERY_REPLY    15
/* RFC 5460 */
//#define DHCPV6_LEASEQUERY_DONE     16
//#define DHCPV6_LEASEQUERY_DATA     17
/* RFC 6977 */
//#define DHCPV6_RECONFIGURE_REQUEST 18
//#define DHCPV6_RECONFIGURE_REPLY   19
/* RFC 7341 */
#define DHCPV6_DHCPV4_QUERY        20
#define DHCPV6_DHCPV4_RESPONSE     21
/* RFC 7653 */
//#define DHCPV6_ACTIVELEASEQUERY    22
//#define DHCPV6_STARTTLS            23

extern const char *dhcpv6_type_names[];
extern const int dhcpv6_type_name_max;

// DUID type definitions (RFC3315 section 9).
// see isc::dhcp::DUID::DUIDType enum in dhcp/duid.h

// Define hardware types
// Taken from http://www.iana.org/assignments/arp-parameters/
#define HWTYPE_ETHERNET    0x0001
#define HWTYPE_INFINIBAND  0x0020

// The following are EXPERIMENTAL and may change when IANA assigns official
// values.
// Secure DHCPv6 (draft-ietf-dhc-sedhcpv6-08.txt)
// (can't use an enum because HashAlgorithm name is already taken)
#define SHA_256                 1
#define SHA_512                 2
#define RSASSA_PKCS1v1_5        1

// Taken from http://www.iana.org/assignments/enterprise-numbers
#define ENTERPRISE_ID_ISC 2495

/* DHCPv4-over-DHCPv6 (RFC 7341) inter-process communication. These are option
   codes for the ISC vendor specific options used in 4o6 */
#define ISC_V6_4O6_INTERFACE                 60000
#define ISC_V6_4O6_SRC_ADDRESS               60001

/* Offsets into IA_*'s where Option spaces commence.  */
#define IA_NA_OFFSET 12 /* IAID, T1, T2, all 4 octets each */
#define IA_TA_OFFSET  4 /* IAID only, 4 octets */
#define IA_PD_OFFSET 12 /* IAID, T1, T2, all 4 octets each */

/* Offset into IAADDR's where Option spaces commence. */
#define IAADDR_OFFSET 24

/* Offset into IAPREFIX's where Option spaces commence. */
#define IAPREFIX_OFFSET 25

/* Offset into LQ_QUERY's where Option spaces commence. */
#define LQ_QUERY_OFFSET 17

/*
 * DHCPv6 well-known multicast addresses, from section 5.1 of RFC 3315
 */
#define ALL_DHCP_RELAY_AGENTS_AND_SERVERS "ff02::1:2"
#define ALL_DHCP_SERVERS "ff05::1:3"

#define DHCP6_CLIENT_PORT 546
#define DHCP6_SERVER_PORT 547

/*
 * DHCPv6 Retransmission Constants (RFC3315 section 5.5, RFC 5007)
 */

#define SOL_MAX_DELAY     1
#define SOL_TIMEOUT       1
#define SOL_MAX_RT      120
#define REQ_TIMEOUT       1
#define REQ_MAX_RT       30
#define REQ_MAX_RC       10
#define CNF_MAX_DELAY     1
#define CNF_TIMEOUT       1
#define CNF_MAX_RT        4
#define CNF_MAX_RD       10
#define REN_TIMEOUT      10
#define REN_MAX_RT      600
#define REB_TIMEOUT      10
#define REB_MAX_RT      600
#define INF_MAX_DELAY     1
#define INF_TIMEOUT       1
#define INF_MAX_RT      120
#define REL_TIMEOUT       1
#define REL_MAX_RC        5
#define DEC_TIMEOUT       1
#define DEC_MAX_RC        5
#define REC_TIMEOUT       2
#define REC_MAX_RC        8
#define HOP_COUNT_LIMIT  32
#define LQ6_TIMEOUT       1
#define LQ6_MAX_RT       10
#define LQ6_MAX_RC        5

/* Leasequery query-types (RFC 5007, RFC 5460) */

#define LQ6QT_BY_ADDRESS        1
#define LQ6QT_BY_CLIENTID       2
//#define LQ6QT_BY_RELAY_ID       3
//#define LQ6QT_BY_LINK_ADDRESS   4
//#define LQ6QT_BY_REMOTE_ID      5

/*
 * DUID time starts 2000-01-01.
 * This constant is the number of seconds since 1970-01-01,
 * when the Unix epoch began.
 */
#define DUID_TIME_EPOCH 946684800

/* Information-Request Time option (RFC 4242) */

#define IRT_DEFAULT     86400
#define IRT_MINIMUM     600

/* DHCPv4-query message flags (see RFC7341) */
#define DHCPV4_QUERY_FLAGS_UNICAST (1 << 23)

#endif /* DHCP6_H */
