The Tcpdump Group git mirrors - tcpdump/blob - dhcp6.h

   1 /*
   2  * Copyright (C) 1998 and 1999 WIDE Project.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. Neither the name of the project nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29 /*
  30  * draft-ietf-dhc-dhcpv6-15
  31  */
  32
  33 #ifndef __DHCP6_H_DEFINED
  34 #define __DHCP6_H_DEFINED
  35
  36 /* Error Values */
  37 #define DH6ERR_FAILURE          16
  38 #define DH6ERR_AUTHFAIL         17
  39 #define DH6ERR_POORLYFORMED     18
  40 #define DH6ERR_UNAVAIL          19
  41 #define DH6ERR_NOBINDING        20
  42 #define DH6ERR_INVALIDSOURCE    21
  43 #define DH6ERR_NOSERVER         23
  44 #define DH6ERR_ICMPERROR        64
  45
  46 /* Message type */
  47 #define DH6_SOLICIT     1
  48 #define DH6_ADVERT      2
  49 #define DH6_REQUEST     3
  50 #define DH6_REPLY       4
  51 #define DH6_RELEASE     5
  52 #define DH6_RECONFIG    6
  53
  54 /* Predefined addresses */
  55 #define DH6ADDR_ALLAGENT        "ff02::1:2"
  56 #define DH6ADDR_ALLSERVER       "ff05::1:3"
  57 #define DH6ADDR_ALLRELAY        "ff05::1:4"
  58 #define DH6PORT_DOWNSTREAM      "546"
  59 #define DH6PORT_UPSTREAM        "547"
  60
  61 /* Protocol constants */
  62 #define ADV_CLIENT_WAIT         2       /* sec */
  63 #define DEFAULT_SOLICIT_HOPCOUNT        4
  64 #define SERVER_MIN_ADV_DELAY    100     /* msec */
  65 #define SERVER_MAX_ADV_DELAY    1000    /* msec */
  66 #define REPLY_MSG_TIMEOUT       2       /* sec */
  67 #define REQUEST_MSG_MIN_RETRANS 10      /* retransmissions */
  68 #define RECONF_MSG_MIN_RETRANS  10      /* retransmissions */
  69 #define RECONF_MSG_RETRANS_INTERVAL     12      /* sec */
  70 #define RECONF_MMSG_MIN_RESP    2       /* sec */
  71 #define RECONF_MMSG_MAX_RESP    10      /* sec */
  72 #define RECONF_MULTICAST_REQUEST_WAIT   120     /* sec */
  73 #define MIN_SOLICIT_DELAY       1       /* sec */
  74 #define MAX_SOLICIT_DELAY       5       /* sec */
  75 #define XID_TIMEOUT             600     /* sec */
  76
  77 /* DHCP6 base packet format */
  78 struct dhcp6_solicit {
  79         u_int8_t dh6sol_msgtype;                /* DH6_SOLICIT */
  80         u_int8_t dh6sol_flags;
  81 #define DH6SOL_CLOSE    0x80
  82 #define DH6SOL_PREFIX   0x40
  83         /* XXX: solicit-ID is a 9-bit field...ugly! */
  84 #define DH6SOL_SOLICIT_ID_MASK 0x01ff
  85 #define DH6SOL_SOLICIT_ID_SHIFT 0
  86 #define DH6SOL_SOLICIT_ID(x) \
  87     (((x) & DH6SOL_SOLICIT_ID_MASK) >> DH6SOL_SOLICIT_ID_SHIFT)
  88 #define DH6SOL_SOLICIT_PLEN_MASK 0xfe00
  89 #define DH6SOL_SOLICIT_PLEN_SHIFT 9
  90 #define DH6SOL_SOLICIT_PLEN(x) \
  91     (((x) & DH6SOL_SOLICIT_PLEN_MASK) >> DH6SOL_SOLICIT_PLEN_SHIFT)
  92         u_int16_t dh6sol_plen_id; /* prefix-len and solict-ID */
  93         struct in6_addr dh6sol_cliaddr; /* client's lladdr */
  94         struct in6_addr dh6sol_relayaddr; /* relay agent's lladdr */
  95 };
  96
  97 struct dhcp6_advert {
  98         u_int8_t dh6adv_msgtype;                /* DH6_ADVERT */
  99         u_int8_t dh6adv_rsv_id; /* reserved and uppermost bit of ID */
 100         u_int8_t dh6adv_solcit_id; /* lower 8 bits of solicit-ID */
 101         u_int8_t dh6adv_pref;
 102         struct in6_addr dh6adv_cliaddr; /* client's link-local addr */
 103         struct in6_addr dh6adv_relayaddr; /* relay agent's (non-ll) addr */
 104         struct in6_addr dh6adv_serveraddr; /* server's addr */
 105         /* extensions */
 106 };
 107
 108 struct dhcp6_request {
 109         u_int8_t dh6req_msgtype;                /* DH6_REQUEST */
 110         u_int8_t dh6req_flags;
 111 #define DH6REQ_CLOSE            0x80
 112 #define DH6REQ_REBOOT           0x40
 113         u_int16_t dh6req_xid;           /* transaction-ID */
 114         struct in6_addr dh6req_cliaddr; /* client's lladdr */
 115         struct in6_addr dh6req_relayaddr; /* relay agent's (non-ll) addr */
 116         struct in6_addr dh6req_serveraddr; /* server's addr */
 117         /* extensions */
 118 };
 119
 120 struct dhcp6_reply {
 121         u_int8_t dh6rep_msgtype;                /* DH6_REPLY */
 122         u_int8_t dh6rep_flagandstat;
 123 #define DH6REP_RELAYPRESENT     0x80
 124 #define DH6REP_STATMASK         0x7f
 125         u_int16_t dh6rep_xid;           /* transaction-ID */
 126         struct in6_addr dh6rep_cliaddr; /* client's lladdr */
 127         /* struct in6_addr dh6rep_relayaddr; optional: relay address */
 128         /* extensions */
 129 };
 130
 131 /* XXX: followings are based on older drafts */
 132 struct dhcp6_release {
 133         u_int8_t dh6rel_msgtype;                /* DH6_RELEASE */
 134         u_int8_t dh6rel_flags;
 135 #define DH6REL_DIRECT   0x80
 136         u_int16_t dh6rel_xid;           /* transaction-ID */
 137         struct in6_addr dh6rel_cliaddr; /* client's lladdr */
 138         struct in6_addr dh6rel_relayaddr; /* relay agent's (non-ll) addr */
 139         struct in6_addr dh6rel_reladdr; /* server's addr to be released */
 140         /* extensions */
 141 };
 142
 143 struct dhcp6_reconfig {
 144         u_int8_t dh6cfg_msgtype;                /* DH6_RECONFIG */
 145         u_int8_t dh6cfg_flags;
 146 #define DH6REP_NOREPLY  0x80
 147         u_int16_t dh6cfg_xid;           /* transaction-ID */
 148         struct in6_addr dh6cfg_servaddr; /* server's addr */
 149         /* extensions */
 150 };
 151
 152 union dhcp6 {
 153         u_int8_t dh6_msgtype;
 154         struct dhcp6_solicit dh6_sol;
 155         struct dhcp6_advert dh6_adv;
 156         struct dhcp6_request dh6_req;
 157         struct dhcp6_reply dh6_rep;
 158         struct dhcp6_release dh6_rel;
 159         struct dhcp6_reconfig dh6_cfg;
 160 };
 161
 162 /* DHCP6 extension */
 163 struct dhcp6e_ipaddr {
 164         u_int16_t dh6eip_type;
 165         u_int16_t dh6eip_len;
 166         u_int8_t dh6eip_status;
 167 #define DH6EX_IP_SUCCESS        0       /* request granted, no errors */
 168 #define DH6EX_IP_SECFAIL        18      /* Security parameters failed */
 169 #define DH6EX_IP_AAAAFAIL       20      /* AAAA Record Parameter Problem */
 170 #define DH6EX_IP_PTRFAIL        21      /* PTR Record Parameter Problem */
 171 #define DH6EX_IP_PARAMFAIL      22      /* Unable to honor required params */
 172 #define DH6EX_IP_DNSNAMEFAIL    23      /* DNS name string error */
 173 #define DH6EX_IP_NODYNDNS       24      /* dynDNS Not Implemented */
 174 #define DH6EX_IP_NOAUTHDNS      25      /* Authoritative DNS Server not found */
 175 #define DH6EX_IP_DNSFORMFAIL    33      /* DNS format error */
 176 #define DH6EX_IP_SERVFAIL       34      /* dynDNS unavailable at this time */
 177 #define DH6EX_IP_NXDOMAIN       35      /* name does not exist */
 178 #define DH6EX_IP_NOTIMP         36      /* DNS does not support the Opcode */
 179 #define DH6EX_IP_REFUSED        37      /* DNS refuses specified operation */
 180 #define DH6EX_IP_YXDOMAIN       38      /* name does not exist */
 181 #define DH6EX_IP_YXRRSET        39      /* RRset does not exist */
 182 #define DH6EX_IP_NXRRSET        40      /* RRset does not exist */
 183 #define DH6EX_IP_NOTAUTH        41      /* non authoritative name server */
 184 #define DH6EX_IP_NOTZONE        42      /* prerequisite out of zone */
 185         u_int8_t dh6eip_flags;
 186 #define DH6EX_IP_CLIANTADDR     0x80    /* C: cliant's addr */
 187 #define DH6EX_IP_LIFETIME       0x40    /* L: preferred/valid lifetime */
 188 #define DH6EX_IP_FORCEOPTS      0x20    /* Q: options are mandatory */
 189 #define DH6EX_IP_AAAA           0x10    /* A: DNS dynamic update for AAAA */
 190 #define DH6EX_IP_PTR            0x08    /* P: DNS dynamic update for PTR*/
 191         u_int8_t dh6eip_pad;
 192         u_int8_t dh6eip_prefixlen;
 193         /* struct in6_addr: client's address (if C bit = 1) */
 194         /* u_int: preferred lifetime (if L bit = 1) */
 195         /* u_int: valid lifetime (if L bit = 1) */
 196         /* string: DNS name */
 197 };
 198
 199 #endif /*__DHCP6_H_DEFINED*/