Debian Codegraph @

rfc5415.html

raw
1 <pre>Network Working Group P. Calhoun, Ed.
2 Request for Comments: 5415 Cisco Systems, Inc.
3 Category: Standards Track M. Montemurro, Ed.
4 Research In Motion
5 D. Stanley, Ed.
6 Aruba Networks
7 March 2009
8
9
10 <span class="h1">Control And Provisioning of Wireless Access Points (CAPWAP)</span>
11 <span class="h1">Protocol Specification</span>
12
13 Status of This Memo
14
15 This document specifies an Internet standards track protocol for the
16 Internet community, and requests discussion and suggestions for
17 improvements. Please refer to the current edition of the "Internet
18 Official Protocol Standards" (STD 1) for the standardization state
19 and status of this protocol. Distribution of this memo is unlimited.
20
21 Copyright Notice
22
23 Copyright (c) 2009 IETF Trust and the persons identified as the
24 document authors. All rights reserved.
25
26 This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
27 Provisions Relating to IETF Documents in effect on the date of
28 publication of this document (<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>).
29 Please review these documents carefully, as they describe your rights
30 and restrictions with respect to this document.
31
32 This document may contain material from IETF Documents or IETF
33 Contributions published or made publicly available before November
34 10, 2008. The person(s) controlling the copyright in some of this
35 material may not have granted the IETF Trust the right to allow
36 modifications of such material outside the IETF Standards Process.
37 Without obtaining an adequate license from the person(s) controlling
38 the copyright in such materials, this document may not be modified
39 outside the IETF Standards Process, and derivative works of it may
40 not be created outside the IETF Standards Process, except to format
41 it for publication as an RFC or to translate it into languages other
42 than English.
43
44
45
46
47
48
49
50
51
52 <span class="grey">Calhoun, et al. Standards Track [Page 1]</span></pre>
53 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
54 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
55
56
57 Abstract
58
59 This specification defines the Control And Provisioning of Wireless
60 Access Points (CAPWAP) Protocol, meeting the objectives defined by
61 the CAPWAP Working Group in <a href="./rfc4564">RFC 4564</a>. The CAPWAP protocol is
62 designed to be flexible, allowing it to be used for a variety of
63 wireless technologies. This document describes the base CAPWAP
64 protocol, while separate binding extensions will enable its use with
65 additional wireless technologies.
66
67 Table of Contents
68
69 <a href="#section-1">1</a>. Introduction ....................................................<a href="#page-7">7</a>
70 <a href="#section-1.1">1.1</a>. Goals ......................................................<a href="#page-8">8</a>
71 <a href="#section-1.2">1.2</a>. Conventions Used in This Document ..........................<a href="#page-9">9</a>
72 <a href="#section-1.3">1.3</a>. Contributing Authors .......................................<a href="#page-9">9</a>
73 <a href="#section-1.4">1.4</a>. Terminology ...............................................<a href="#page-10">10</a>
74 <a href="#section-2">2</a>. Protocol Overview ..............................................<a href="#page-11">11</a>
75 <a href="#section-2.1">2.1</a>. Wireless Binding Definition ...............................<a href="#page-12">12</a>
76 <a href="#section-2.2">2.2</a>. CAPWAP Session Establishment Overview .....................<a href="#page-13">13</a>
77 <a href="#section-2.3">2.3</a>. CAPWAP State Machine Definition ...........................<a href="#page-15">15</a>
78 <a href="#section-2.3.1">2.3.1</a>. CAPWAP Protocol State Transitions ..................<a href="#page-17">17</a>
79 <a href="#section-2.3.2">2.3.2</a>. CAPWAP/DTLS Interface ..............................<a href="#page-31">31</a>
80 <a href="#section-2.4">2.4</a>. Use of DTLS in the CAPWAP Protocol ........................<a href="#page-33">33</a>
81 <a href="#section-2.4.1">2.4.1</a>. DTLS Handshake Processing ..........................<a href="#page-33">33</a>
82 <a href="#section-2.4.2">2.4.2</a>. DTLS Session Establishment .........................<a href="#page-35">35</a>
83 <a href="#section-2.4.3">2.4.3</a>. DTLS Error Handling ................................<a href="#page-35">35</a>
84 <a href="#section-2.4.4">2.4.4</a>. DTLS Endpoint Authentication and Authorization .....<a href="#page-36">36</a>
85 <a href="#section-3">3</a>. CAPWAP Transport ...............................................<a href="#page-40">40</a>
86 <a href="#section-3.1">3.1</a>. UDP Transport .............................................<a href="#page-40">40</a>
87 <a href="#section-3.2">3.2</a>. UDP-Lite Transport ........................................<a href="#page-41">41</a>
88 <a href="#section-3.3">3.3</a>. AC Discovery ..............................................<a href="#page-41">41</a>
89 <a href="#section-3.4">3.4</a>. Fragmentation/Reassembly ..................................<a href="#page-42">42</a>
90 <a href="#section-3.5">3.5</a>. MTU Discovery .............................................<a href="#page-43">43</a>
91 <a href="#section-4">4</a>. CAPWAP Packet Formats ..........................................<a href="#page-43">43</a>
92 <a href="#section-4.1">4.1</a>. CAPWAP Preamble ...........................................<a href="#page-46">46</a>
93 <a href="#section-4.2">4.2</a>. CAPWAP DTLS Header ........................................<a href="#page-46">46</a>
94 <a href="#section-4.3">4.3</a>. CAPWAP Header .............................................<a href="#page-47">47</a>
95 <a href="#section-4.4">4.4</a>. CAPWAP Data Messages ......................................<a href="#page-50">50</a>
96 <a href="#section-4.4.1">4.4.1</a>. CAPWAP Data Channel Keep-Alive .....................<a href="#page-51">51</a>
97 <a href="#section-4.4.2">4.4.2</a>. Data Payload .......................................<a href="#page-52">52</a>
98 <a href="#section-4.4.3">4.4.3</a>. Establishment of a DTLS Data Channel ...............<a href="#page-52">52</a>
99 <a href="#section-4.5">4.5</a>. CAPWAP Control Messages ...................................<a href="#page-52">52</a>
100 <a href="#section-4.5.1">4.5.1</a>. Control Message Format .............................<a href="#page-53">53</a>
101 <a href="#section-4.5.2">4.5.2</a>. Quality of Service .................................<a href="#page-56">56</a>
102 <a href="#section-4.5.3">4.5.3</a>. Retransmissions ....................................<a href="#page-57">57</a>
103 <a href="#section-4.6">4.6</a>. CAPWAP Protocol Message Elements ..........................<a href="#page-58">58</a>
104 <a href="#section-4.6.1">4.6.1</a>. AC Descriptor ......................................<a href="#page-61">61</a>
105
106
107
108 <span class="grey">Calhoun, et al. Standards Track [Page 2]</span></pre>
109 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
110 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
111
112
113 <a href="#section-4.6.2">4.6.2</a>. AC IPv4 List .......................................<a href="#page-64">64</a>
114 <a href="#section-4.6.3">4.6.3</a>. AC IPv6 List .......................................<a href="#page-64">64</a>
115 <a href="#section-4.6.4">4.6.4</a>. AC Name ............................................<a href="#page-65">65</a>
116 <a href="#section-4.6.5">4.6.5</a>. AC Name with Priority ..............................<a href="#page-65">65</a>
117 <a href="#section-4.6.6">4.6.6</a>. AC Timestamp .......................................<a href="#page-66">66</a>
118 <a href="#section-4.6.7">4.6.7</a>. Add MAC ACL Entry ..................................<a href="#page-66">66</a>
119 <a href="#section-4.6.8">4.6.8</a>. Add Station ........................................<a href="#page-67">67</a>
120 <a href="#section-4.6.9">4.6.9</a>. CAPWAP Control IPv4 Address ........................<a href="#page-68">68</a>
121 <a href="#section-4.6.10">4.6.10</a>. CAPWAP Control IPv6 Address .......................<a href="#page-68">68</a>
122 <a href="#section-4.6.11">4.6.11</a>. CAPWAP Local IPv4 Address .........................<a href="#page-69">69</a>
123 <a href="#section-4.6.12">4.6.12</a>. CAPWAP Local IPv6 Address .........................<a href="#page-69">69</a>
124 <a href="#section-4.6.13">4.6.13</a>. CAPWAP Timers .....................................<a href="#page-70">70</a>
125 <a href="#section-4.6.14">4.6.14</a>. CAPWAP Transport Protocol .........................<a href="#page-71">71</a>
126 <a href="#section-4.6.15">4.6.15</a>. Data Transfer Data ................................<a href="#page-72">72</a>
127 <a href="#section-4.6.16">4.6.16</a>. Data Transfer Mode ................................<a href="#page-73">73</a>
128 <a href="#section-4.6.17">4.6.17</a>. Decryption Error Report ...........................<a href="#page-73">73</a>
129 <a href="#section-4.6.18">4.6.18</a>. Decryption Error Report Period ....................<a href="#page-74">74</a>
130 <a href="#section-4.6.19">4.6.19</a>. Delete MAC ACL Entry ..............................<a href="#page-74">74</a>
131 <a href="#section-4.6.20">4.6.20</a>. Delete Station ....................................<a href="#page-75">75</a>
132 <a href="#section-4.6.21">4.6.21</a>. Discovery Type ....................................<a href="#page-75">75</a>
133 <a href="#section-4.6.22">4.6.22</a>. Duplicate IPv4 Address ............................<a href="#page-76">76</a>
134 <a href="#section-4.6.23">4.6.23</a>. Duplicate IPv6 Address ............................<a href="#page-77">77</a>
135 <a href="#section-4.6.24">4.6.24</a>. Idle Timeout ......................................<a href="#page-78">78</a>
136 <a href="#section-4.6.25">4.6.25</a>. ECN Support .......................................<a href="#page-78">78</a>
137 <a href="#section-4.6.26">4.6.26</a>. Image Data ........................................<a href="#page-79">79</a>
138 <a href="#section-4.6.27">4.6.27</a>. Image Identifier ..................................<a href="#page-79">79</a>
139 <a href="#section-4.6.28">4.6.28</a>. Image Information .................................<a href="#page-80">80</a>
140 <a href="#section-4.6.29">4.6.29</a>. Initiate Download .................................<a href="#page-81">81</a>
141 <a href="#section-4.6.30">4.6.30</a>. Location Data .....................................<a href="#page-81">81</a>
142 <a href="#section-4.6.31">4.6.31</a>. Maximum Message Length ............................<a href="#page-81">81</a>
143 <a href="#section-4.6.32">4.6.32</a>. MTU Discovery Padding .............................<a href="#page-82">82</a>
144 <a href="#section-4.6.33">4.6.33</a>. Radio Administrative State ........................<a href="#page-82">82</a>
145 <a href="#section-4.6.34">4.6.34</a>. Radio Operational State ...........................<a href="#page-83">83</a>
146 <a href="#section-4.6.35">4.6.35</a>. Result Code .......................................<a href="#page-84">84</a>
147 <a href="#section-4.6.36">4.6.36</a>. Returned Message Element ..........................<a href="#page-85">85</a>
148 <a href="#section-4.6.37">4.6.37</a>. Session ID ........................................<a href="#page-86">86</a>
149 <a href="#section-4.6.38">4.6.38</a>. Statistics Timer ..................................<a href="#page-87">87</a>
150 <a href="#section-4.6.39">4.6.39</a>. Vendor Specific Payload ...........................<a href="#page-87">87</a>
151 <a href="#section-4.6.40">4.6.40</a>. WTP Board Data ....................................<a href="#page-88">88</a>
152 <a href="#section-4.6.41">4.6.41</a>. WTP Descriptor ....................................<a href="#page-89">89</a>
153 <a href="#section-4.6.42">4.6.42</a>. WTP Fallback ......................................<a href="#page-92">92</a>
154 <a href="#section-4.6.43">4.6.43</a>. WTP Frame Tunnel Mode .............................<a href="#page-92">92</a>
155 <a href="#section-4.6.44">4.6.44</a>. WTP MAC Type ......................................<a href="#page-93">93</a>
156 <a href="#section-4.6.45">4.6.45</a>. WTP Name ..........................................<a href="#page-94">94</a>
157 <a href="#section-4.6.46">4.6.46</a>. WTP Radio Statistics ..............................<a href="#page-94">94</a>
158 <a href="#section-4.6.47">4.6.47</a>. WTP Reboot Statistics .............................<a href="#page-96">96</a>
159 <a href="#section-4.6.48">4.6.48</a>. WTP Static IP Address Information .................<a href="#page-97">97</a>
160 <a href="#section-4.7">4.7</a>. CAPWAP Protocol Timers ....................................<a href="#page-98">98</a>
161
162
163
164 <span class="grey">Calhoun, et al. Standards Track [Page 3]</span></pre>
165 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
166 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
167
168
169 <a href="#section-4.7.1">4.7.1</a>. ChangeStatePendingTimer ............................<a href="#page-98">98</a>
170 <a href="#section-4.7.2">4.7.2</a>. DataChannelKeepAlive ...............................<a href="#page-98">98</a>
171 <a href="#section-4.7.3">4.7.3</a>. DataChannelDeadInterval ............................<a href="#page-99">99</a>
172 <a href="#section-4.7.4">4.7.4</a>. DataCheckTimer .....................................<a href="#page-99">99</a>
173 <a href="#section-4.7.5">4.7.5</a>. DiscoveryInterval ..................................<a href="#page-99">99</a>
174 <a href="#section-4.7.6">4.7.6</a>. DTLSSessionDelete ..................................<a href="#page-99">99</a>
175 <a href="#section-4.7.7">4.7.7</a>. EchoInterval .......................................<a href="#page-99">99</a>
176 <a href="#section-4.7.8">4.7.8</a>. IdleTimeout ........................................<a href="#page-99">99</a>
177 <a href="#section-4.7.9">4.7.9</a>. ImageDataStartTimer ...............................<a href="#page-100">100</a>
178 <a href="#section-4.7.10">4.7.10</a>. MaxDiscoveryInterval .............................<a href="#page-100">100</a>
179 <a href="#section-4.7.11">4.7.11</a>. ReportInterval ...................................<a href="#page-100">100</a>
180 <a href="#section-4.7.12">4.7.12</a>. RetransmitInterval ...............................<a href="#page-100">100</a>
181 <a href="#section-4.7.13">4.7.13</a>. SilentInterval ...................................<a href="#page-100">100</a>
182 <a href="#section-4.7.14">4.7.14</a>. StatisticsTimer ..................................<a href="#page-100">100</a>
183 <a href="#section-4.7.15">4.7.15</a>. WaitDTLS .........................................<a href="#page-101">101</a>
184 <a href="#section-4.7.16">4.7.16</a>. WaitJoin .........................................<a href="#page-101">101</a>
185 <a href="#section-4.8">4.8</a>. CAPWAP Protocol Variables ................................<a href="#page-101">101</a>
186 <a href="#section-4.8.1">4.8.1</a>. AdminState ........................................<a href="#page-101">101</a>
187 <a href="#section-4.8.2">4.8.2</a>. DiscoveryCount ....................................<a href="#page-101">101</a>
188 <a href="#section-4.8.3">4.8.3</a>. FailedDTLSAuthFailCount ...........................<a href="#page-101">101</a>
189 <a href="#section-4.8.4">4.8.4</a>. FailedDTLSSessionCount ............................<a href="#page-101">101</a>
190 <a href="#section-4.8.5">4.8.5</a>. MaxDiscoveries ....................................<a href="#page-102">102</a>
191 <a href="#section-4.8.6">4.8.6</a>. MaxFailedDTLSSessionRetry .........................<a href="#page-102">102</a>
192 <a href="#section-4.8.7">4.8.7</a>. MaxRetransmit .....................................<a href="#page-102">102</a>
193 <a href="#section-4.8.8">4.8.8</a>. RetransmitCount ...................................<a href="#page-102">102</a>
194 <a href="#section-4.8.9">4.8.9</a>. WTPFallBack .......................................<a href="#page-102">102</a>
195 <a href="#section-4.9">4.9</a>. WTP Saved Variables ......................................<a href="#page-102">102</a>
196 <a href="#section-4.9.1">4.9.1</a>. AdminRebootCount ..................................<a href="#page-102">102</a>
197 <a href="#section-4.9.2">4.9.2</a>. FrameEncapType ....................................<a href="#page-102">102</a>
198 <a href="#section-4.9.3">4.9.3</a>. LastRebootReason ..................................<a href="#page-103">103</a>
199 <a href="#section-4.9.4">4.9.4</a>. MacType ...........................................<a href="#page-103">103</a>
200 <a href="#section-4.9.5">4.9.5</a>. PreferredACs ......................................<a href="#page-103">103</a>
201 <a href="#section-4.9.6">4.9.6</a>. RebootCount .......................................<a href="#page-103">103</a>
202 <a href="#section-4.9.7">4.9.7</a>. Static IP Address .................................<a href="#page-103">103</a>
203 <a href="#section-4.9.8">4.9.8</a>. WTPLinkFailureCount ...............................<a href="#page-103">103</a>
204 <a href="#section-4.9.9">4.9.9</a>. WTPLocation .......................................<a href="#page-103">103</a>
205 <a href="#section-4.9.10">4.9.10</a>. WTPName ..........................................<a href="#page-103">103</a>
206 <a href="#section-5">5</a>. CAPWAP Discovery Operations ...................................<a href="#page-103">103</a>
207 <a href="#section-5.1">5.1</a>. Discovery Request Message ................................<a href="#page-103">103</a>
208 <a href="#section-5.2">5.2</a>. Discovery Response Message ...............................<a href="#page-105">105</a>
209 <a href="#section-5.3">5.3</a>. Primary Discovery Request Message ........................<a href="#page-106">106</a>
210 <a href="#section-5.4">5.4</a>. Primary Discovery Response ...............................<a href="#page-107">107</a>
211 <a href="#section-6">6</a>. CAPWAP Join Operations ........................................<a href="#page-108">108</a>
212 <a href="#section-6.1">6.1</a>. Join Request .............................................<a href="#page-108">108</a>
213 <a href="#section-6.2">6.2</a>. Join Response ............................................<a href="#page-110">110</a>
214 <a href="#section-7">7</a>. Control Channel Management ....................................<a href="#page-111">111</a>
215 <a href="#section-7.1">7.1</a>. Echo Request .............................................<a href="#page-111">111</a>
216 <a href="#section-7.2">7.2</a>. Echo Response ............................................<a href="#page-112">112</a>
217
218
219
220 <span class="grey">Calhoun, et al. Standards Track [Page 4]</span></pre>
221 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
222 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
223
224
225 <a href="#section-8">8</a>. WTP Configuration Management ..................................<a href="#page-112">112</a>
226 <a href="#section-8.1">8.1</a>. Configuration Consistency ................................<a href="#page-112">112</a>
227 <a href="#section-8.1.1">8.1.1</a>. Configuration Flexibility .........................<a href="#page-113">113</a>
228 <a href="#section-8.2">8.2</a>. Configuration Status Request .............................<a href="#page-114">114</a>
229 <a href="#section-8.3">8.3</a>. Configuration Status Response ............................<a href="#page-115">115</a>
230 <a href="#section-8.4">8.4</a>. Configuration Update Request .............................<a href="#page-116">116</a>
231 <a href="#section-8.5">8.5</a>. Configuration Update Response ............................<a href="#page-117">117</a>
232 <a href="#section-8.6">8.6</a>. Change State Event Request ...............................<a href="#page-117">117</a>
233 <a href="#section-8.7">8.7</a>. Change State Event Response ..............................<a href="#page-118">118</a>
234 <a href="#section-8.8">8.8</a>. Clear Configuration Request ..............................<a href="#page-119">119</a>
235 <a href="#section-8.9">8.9</a>. Clear Configuration Response .............................<a href="#page-119">119</a>
236 <a href="#section-9">9</a>. Device Management Operations ..................................<a href="#page-120">120</a>
237 <a href="#section-9.1">9.1</a>. Firmware Management ......................................<a href="#page-120">120</a>
238 <a href="#section-9.1.1">9.1.1</a>. Image Data Request ................................<a href="#page-124">124</a>
239 <a href="#section-9.1.2">9.1.2</a>. Image Data Response ...............................<a href="#page-125">125</a>
240 <a href="#section-9.2">9.2</a>. Reset Request ............................................<a href="#page-126">126</a>
241 <a href="#section-9.3">9.3</a>. Reset Response ...........................................<a href="#page-127">127</a>
242 <a href="#section-9.4">9.4</a>. WTP Event Request ........................................<a href="#page-127">127</a>
243 <a href="#section-9.5">9.5</a>. WTP Event Response .......................................<a href="#page-128">128</a>
244 <a href="#section-9.6">9.6</a>. Data Transfer ............................................<a href="#page-128">128</a>
245 <a href="#section-9.6.1">9.6.1</a>. Data Transfer Request .............................<a href="#page-130">130</a>
246 <a href="#section-9.6.2">9.6.2</a>. Data Transfer Response ............................<a href="#page-131">131</a>
247 <a href="#section-10">10</a>. Station Session Management ...................................<a href="#page-131">131</a>
248 <a href="#section-10.1">10.1</a>. Station Configuration Request ...........................<a href="#page-131">131</a>
249 <a href="#section-10.2">10.2</a>. Station Configuration Response ..........................<a href="#page-132">132</a>
250 <a href="#section-11">11</a>. NAT Considerations ...........................................<a href="#page-132">132</a>
251 <a href="#section-12">12</a>. Security Considerations ......................................<a href="#page-134">134</a>
252 <a href="#section-12.1">12.1</a>. CAPWAP Security .........................................<a href="#page-134">134</a>
253 <a href="#section-12.1.1">12.1.1</a>. Converting Protected Data into Unprotected Data ..135
254 12.1.2. Converting Unprotected Data into
255 Protected Data (Insertion) .......................<a href="#page-135">135</a>
256 <a href="#section-12.1.3">12.1.3</a>. Deletion of Protected Records ....................<a href="#page-135">135</a>
257 <a href="#section-12.1.4">12.1.4</a>. Insertion of Unprotected Records .................<a href="#page-135">135</a>
258 <a href="#section-12.1.5">12.1.5</a>. Use of MD5 .......................................<a href="#page-136">136</a>
259 <a href="#section-12.1.6">12.1.6</a>. CAPWAP Fragmentation .............................<a href="#page-136">136</a>
260 <a href="#section-12.2">12.2</a>. Session ID Security .....................................<a href="#page-136">136</a>
261 <a href="#section-12.3">12.3</a>. Discovery or DTLS Setup Attacks .........................<a href="#page-137">137</a>
262 <a href="#section-12.4">12.4</a>. Interference with a DTLS Session ........................<a href="#page-137">137</a>
263 <a href="#section-12.5">12.5</a>. CAPWAP Pre-Provisioning .................................<a href="#page-138">138</a>
264 <a href="#section-12.6">12.6</a>. Use of Pre-Shared Keys in CAPWAP ........................<a href="#page-139">139</a>
265 <a href="#section-12.7">12.7</a>. Use of Certificates in CAPWAP ...........................<a href="#page-140">140</a>
266 <a href="#section-12.8">12.8</a>. Use of MAC Address in CN Field ..........................<a href="#page-140">140</a>
267 <a href="#section-12.9">12.9</a>. AAA Security ............................................<a href="#page-141">141</a>
268 <a href="#section-12.10">12.10</a>. WTP Firmware ...........................................<a href="#page-141">141</a>
269 <a href="#section-13">13</a>. Operational Considerations ...................................<a href="#page-141">141</a>
270 <a href="#section-14">14</a>. Transport Considerations .....................................<a href="#page-142">142</a>
271 <a href="#section-15">15</a>. IANA Considerations ..........................................<a href="#page-143">143</a>
272 <a href="#section-15.1">15.1</a>. IPv4 Multicast Address ..................................<a href="#page-143">143</a>
273
274
275
276 <span class="grey">Calhoun, et al. Standards Track [Page 5]</span></pre>
277 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
278 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
279
280
281 <a href="#section-15.2">15.2</a>. IPv6 Multicast Address ..................................<a href="#page-144">144</a>
282 <a href="#section-15.3">15.3</a>. UDP Port ................................................<a href="#page-144">144</a>
283 <a href="#section-15.4">15.4</a>. CAPWAP Message Types ....................................<a href="#page-144">144</a>
284 <a href="#section-15.5">15.5</a>. CAPWAP Header Flags .....................................<a href="#page-144">144</a>
285 <a href="#section-15.6">15.6</a>. CAPWAP Control Message Flags ............................<a href="#page-145">145</a>
286 <a href="#section-15.7">15.7</a>. CAPWAP Message Element Type .............................<a href="#page-145">145</a>
287 <a href="#section-15.8">15.8</a>. CAPWAP Wireless Binding Identifiers .....................<a href="#page-145">145</a>
288 <a href="#section-15.9">15.9</a>. AC Security Types .......................................<a href="#page-146">146</a>
289 <a href="#section-15.10">15.10</a>. AC DTLS Policy .........................................<a href="#page-146">146</a>
290 <a href="#section-15.11">15.11</a>. AC Information Type ....................................<a href="#page-146">146</a>
291 <a href="#section-15.12">15.12</a>. CAPWAP Transport Protocol Types ........................<a href="#page-146">146</a>
292 <a href="#section-15.13">15.13</a>. Data Transfer Type .....................................<a href="#page-147">147</a>
293 <a href="#section-15.14">15.14</a>. Data Transfer Mode .....................................<a href="#page-147">147</a>
294 <a href="#section-15.15">15.15</a>. Discovery Types ........................................<a href="#page-147">147</a>
295 <a href="#section-15.16">15.16</a>. ECN Support ............................................<a href="#page-148">148</a>
296 <a href="#section-15.17">15.17</a>. Radio Admin State ......................................<a href="#page-148">148</a>
297 <a href="#section-15.18">15.18</a>. Radio Operational State ................................<a href="#page-148">148</a>
298 <a href="#section-15.19">15.19</a>. Radio Failure Causes ...................................<a href="#page-148">148</a>
299 <a href="#section-15.20">15.20</a>. Result Code ............................................<a href="#page-149">149</a>
300 <a href="#section-15.21">15.21</a>. Returned Message Element Reason ........................<a href="#page-149">149</a>
301 <a href="#section-15.22">15.22</a>. WTP Board Data Type ....................................<a href="#page-149">149</a>
302 <a href="#section-15.23">15.23</a>. WTP Descriptor Type ....................................<a href="#page-149">149</a>
303 <a href="#section-15.24">15.24</a>. WTP Fallback Mode ......................................<a href="#page-150">150</a>
304 <a href="#section-15.25">15.25</a>. WTP Frame Tunnel Mode ..................................<a href="#page-150">150</a>
305 <a href="#section-15.26">15.26</a>. WTP MAC Type ...........................................<a href="#page-150">150</a>
306 <a href="#section-15.27">15.27</a>. WTP Radio Stats Failure Type ...........................<a href="#page-151">151</a>
307 <a href="#section-15.28">15.28</a>. WTP Reboot Stats Failure Type ..........................<a href="#page-151">151</a>
308 <a href="#section-16">16</a>. Acknowledgments ..............................................<a href="#page-151">151</a>
309 <a href="#section-17">17</a>. References ...................................................<a href="#page-151">151</a>
310 <a href="#section-17.1">17.1</a>. Normative References ....................................<a href="#page-151">151</a>
311 <a href="#section-17.2">17.2</a>. Informative References ..................................<a href="#page-153">153</a>
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332 <span class="grey">Calhoun, et al. Standards Track [Page 6]</span></pre>
333 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
334 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
335
336
337 <span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
338
339 This document describes the CAPWAP protocol, a standard,
340 interoperable protocol that enables an Access Controller (AC) to
341 manage a collection of Wireless Termination Points (WTPs). The
342 CAPWAP protocol is defined to be independent of Layer 2 (L2)
343 technology, and meets the objectives in "Objectives for Control and
344 Provisioning of Wireless Access Points (CAPWAP)" [<a href="./rfc4564" title="&quot;Objectives for Control and Provisioning of Wireless Access Points (CAPWAP)&quot;">RFC4564</a>].
345
346 The emergence of centralized IEEE 802.11 Wireless Local Area Network
347 (WLAN) architectures, in which simple IEEE 802.11 WTPs are managed by
348 an Access Controller (AC), suggested that a standards-based,
349 interoperable protocol could radically simplify the deployment and
350 management of wireless networks. WTPs require a set of dynamic
351 management and control functions related to their primary task of
352 connecting the wireless and wired mediums. Traditional protocols for
353 managing WTPs are either manual static configuration via HTTP,
354 proprietary Layer 2-specific or non-existent (if the WTPs are self-
355 contained). An IEEE 802.11 binding is defined in [<a href="./rfc5416" title="&quot;Control And Provisioning of Wireless Access Points (CAPWAP) Protocol Binding for IEEE 802.11&quot;">RFC5416</a>] to
356 support use of the CAPWAP protocol with IEEE 802.11 WLAN networks.
357
358 CAPWAP assumes a network configuration consisting of multiple WTPs
359 communicating via the Internet Protocol (IP) to an AC. WTPs are
360 viewed as remote radio frequency (RF) interfaces controlled by the
361 AC. The CAPWAP protocol supports two modes of operation: Split and
362 Local MAC (medium access control). In Split MAC mode, all L2
363 wireless data and management frames are encapsulated via the CAPWAP
364 protocol and exchanged between the AC and the WTP. As shown in
365 Figure 1, the wireless frames received from a mobile device, which is
366 referred to in this specification as a Station (STA), are directly
367 encapsulated by the WTP and forwarded to the AC.
368
369 +-+ wireless frames +-+
370 | |--------------------------------| |
371 | | +-+ | |
372 | |--------------| |---------------| |
373 | |wireless PHY/ | | CAPWAP | |
374 | | MAC sublayer | | | |
375 +-+ +-+ +-+
376 STA WTP AC
377
378 Figure 1: Representative CAPWAP Architecture for Split MAC
379
380 The Local MAC mode of operation allows for the data frames to be
381 either locally bridged or tunneled as 802.3 frames. The latter
382 implies that the WTP performs the 802.11 Integration function. In
383 either case, the L2 wireless management frames are processed locally
384
385
386
387
388 <span class="grey">Calhoun, et al. Standards Track [Page 7]</span></pre>
389 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
390 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
391
392
393 by the WTP and then forwarded to the AC. Figure 2 shows the Local
394 MAC mode, in which a station transmits a wireless frame that is
395 encapsulated in an 802.3 frame and forwarded to the AC.
396
397 +-+wireless frames +-+ 802.3 frames +-+
398 | |----------------| |--------------| |
399 | | | | | |
400 | |----------------| |--------------| |
401 | |wireless PHY/ | | CAPWAP | |
402 | | MAC sublayer | | | |
403 +-+ +-+ +-+
404 STA WTP AC
405
406 Figure 2: Representative CAPWAP Architecture for Local MAC
407
408 Provisioning WTPs with security credentials and managing which WTPs
409 are authorized to provide service are traditionally handled by
410 proprietary solutions. Allowing these functions to be performed from
411 a centralized AC in an interoperable fashion increases manageability
412 and allows network operators to more tightly control their wireless
413 network infrastructure.
414
415 <span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. Goals</span>
416
417 The goals for the CAPWAP protocol are listed below:
418
419 1. To centralize the authentication and policy enforcement functions
420 for a wireless network. The AC may also provide centralized
421 bridging, forwarding, and encryption of user traffic.
422 Centralization of these functions will enable reduced cost and
423 higher efficiency by applying the capabilities of network
424 processing silicon to the wireless network, as in wired LANs.
425
426 2. To enable shifting of the higher-level protocol processing from
427 the WTP. This leaves the time-critical applications of wireless
428 control and access in the WTP, making efficient use of the
429 computing power available in WTPs, which are subject to severe
430 cost pressure.
431
432 3. To provide an extensible protocol that is not bound to a specific
433 wireless technology. Extensibility is provided via a generic
434 encapsulation and transport mechanism, enabling the CAPWAP
435 protocol to be applied to many access point types in the future,
436 via a specific wireless binding.
437
438 The CAPWAP protocol concerns itself solely with the interface between
439 the WTP and the AC. Inter-AC and station-to-AC communication are
440 strictly outside the scope of this document.
441
442
443
444 <span class="grey">Calhoun, et al. Standards Track [Page 8]</span></pre>
445 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
446 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
447
448
449 <span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</a>. Conventions Used in This Document</span>
450
451 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
452 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
453 document are to be interpreted as described in <a href="./rfc2119">RFC 2119</a> [<a href="./rfc2119" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">RFC2119</a>].
454
455 <span class="h3"><a class="selflink" id="section-1.3" href="#section-1.3">1.3</a>. Contributing Authors</span>
456
457 This section lists and acknowledges the authors of significant text
458 and concepts included in this specification.
459
460 The CAPWAP Working Group selected the Lightweight Access Point
461 Protocol (LWAPP) [<a href="#ref-LWAPP" title="&quot;Lightweight Access Point Protocol&quot;">LWAPP</a>] to be used as the basis of the CAPWAP
462 protocol specification. The following people are authors of the
463 LWAPP document:
464
465 Bob O'Hara
466 Email: [email protected]
467
468 Pat Calhoun, Cisco Systems, Inc.
469 170 West Tasman Drive, San Jose, CA 95134
470 Phone: +1 408-902-3240, Email: [email protected]
471
472 Rohit Suri, Cisco Systems, Inc.
473 170 West Tasman Drive, San Jose, CA 95134
474 Phone: +1 408-853-5548, Email: [email protected]
475
476 Nancy Cam Winget, Cisco Systems, Inc.
477 170 West Tasman Drive, San Jose, CA 95134
478 Phone: +1 408-853-0532, Email: [email protected]
479
480 Scott Kelly, Aruba Networks
481 1322 Crossman Ave, Sunnyvale, CA 94089
482 Phone: +1 408-754-8408, Email: [email protected]
483
484 Michael Glenn Williams, Nokia, Inc.
485 313 Fairchild Drive, Mountain View, CA 94043
486 Phone: +1 650-714-7758, Email: [email protected]
487
488 Sue Hares, Green Hills Software
489 825 Victors Way, Suite 100, Ann Arbor, MI 48108
490 Phone: +1 734 222 1610, Email: [email protected]
491
492 Datagram Transport Layer Security (DTLS) [<a href="./rfc4347" title="&quot;Datagram Transport Layer Security&quot;">RFC4347</a>] is used as the
493 security solution for the CAPWAP protocol. The following people are
494 authors of significant DTLS-related text included in this document:
495
496
497
498
499
500 <span class="grey">Calhoun, et al. Standards Track [Page 9]</span></pre>
501 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
502 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
503
504
505 Scott Kelly, Aruba Networks
506 1322 Crossman Ave, Sunnyvale, CA 94089
507 Phone: +1 408-754-8408
508 Email: [email protected]
509
510 Eric Rescorla, Network Resonance
511 2483 El Camino Real, #212,Palo Alto CA, 94303
512 Email: [email protected]
513
514 The concept of using DTLS to secure the CAPWAP protocol was part of
515 the Secure Light Access Point Protocol (SLAPP) proposal [<a href="#ref-SLAPP" title="&quot;SLAPP: Secure Light Access Point Protocol&quot;">SLAPP</a>]. The
516 following people are authors of the SLAPP proposal:
517
518 Partha Narasimhan, Aruba Networks
519 1322 Crossman Ave, Sunnyvale, CA 94089
520 Phone: +1 408-480-4716
521 Email: [email protected]
522
523 Dan Harkins
524 Trapeze Networks
525 5753 W. Las Positas Blvd, Pleasanton, CA 94588
526 Phone: +1-925-474-2212
527 EMail: [email protected]
528
529 Subbu Ponnuswamy, Aruba Networks
530 1322 Crossman Ave, Sunnyvale, CA 94089
531 Phone: +1 408-754-1213
532 Email: [email protected]
533
534 The following individuals contributed significant security-related
535 text to the document [<a href="./rfc5418" title="&quot;Control And Provisioning for Wireless Access Points (CAPWAP) Threat Analysis for IEEE 802.11 Deployments&quot;">RFC5418</a>]:
536
537 T. Charles Clancy, Laboratory for Telecommunications Sciences,
538 8080 Greenmead Drive, College Park, MD 20740
539 Phone: +1 240-373-5069, Email: [email protected]
540
541 Scott Kelly, Aruba Networks
542 1322 Crossman Ave, Sunnyvale, CA 94089
543 Phone: +1 408-754-8408, Email: [email protected]
544
545 <span class="h3"><a class="selflink" id="section-1.4" href="#section-1.4">1.4</a>. Terminology</span>
546
547 Access Controller (AC): The network entity that provides WTP access
548 to the network infrastructure in the data plane, control plane,
549 management plane, or a combination therein.
550
551
552
553
554
555
556 <span class="grey">Calhoun, et al. Standards Track [Page 10]</span></pre>
557 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
558 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
559
560
561 CAPWAP Control Channel: A bi-directional flow defined by the AC IP
562 Address, WTP IP Address, AC control port, WTP control port, and the
563 transport-layer protocol (UDP or UDP-Lite) over which CAPWAP Control
564 packets are sent and received.
565
566 CAPWAP Data Channel: A bi-directional flow defined by the AC IP
567 Address, WTP IP Address, AC data port, WTP data port, and the
568 transport-layer protocol (UDP or UDP-Lite) over which CAPWAP Data
569 packets are sent and received.
570
571 Station (STA): A device that contains an interface to a wireless
572 medium (WM).
573
574 Wireless Termination Point (WTP): The physical or network entity that
575 contains an RF antenna and wireless Physical Layer (PHY) to transmit
576 and receive station traffic for wireless access networks.
577
578 This document uses additional terminology defined in [<a href="./rfc3753" title="&quot;Mobility Related Terminology&quot;">RFC3753</a>].
579
580 <span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Protocol Overview</span>
581
582 The CAPWAP protocol is a generic protocol defining AC and WTP control
583 and data plane communication via a CAPWAP protocol transport
584 mechanism. CAPWAP Control messages, and optionally CAPWAP Data
585 messages, are secured using Datagram Transport Layer Security (DTLS)
586 [<a href="./rfc4347" title="&quot;Datagram Transport Layer Security&quot;">RFC4347</a>]. DTLS is a standards-track IETF protocol based upon TLS.
587 The underlying security-related protocol mechanisms of TLS have been
588 successfully deployed for many years.
589
590 The CAPWAP protocol transport layer carries two types of payload,
591 CAPWAP Data messages and CAPWAP Control messages. CAPWAP Data
592 messages encapsulate forwarded wireless frames. CAPWAP protocol
593 Control messages are management messages exchanged between a WTP and
594 an AC. The CAPWAP Data and Control packets are sent over separate
595 UDP ports. Since both data and control packets can exceed the
596 Maximum Transmission Unit (MTU) length, the payload of a CAPWAP Data
597 or Control message can be fragmented. The fragmentation behavior is
598 defined in <a href="#section-3">Section 3</a>.
599
600 The CAPWAP Protocol begins with a Discovery phase. The WTPs send a
601 Discovery Request message, causing any Access Controller (AC)
602 receiving the message to respond with a Discovery Response message.
603 From the Discovery Response messages received, a WTP selects an AC
604 with which to establish a secure DTLS session. In order to establish
605 the secure DTLS connection, the WTP will need some amount of pre-
606 provisioning, which is specified in <a href="#section-12.5">Section 12.5</a>. CAPWAP protocol
607 messages will be fragmented to the maximum length discovered to be
608 supported by the network.
609
610
611
612 <span class="grey">Calhoun, et al. Standards Track [Page 11]</span></pre>
613 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
614 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
615
616
617 Once the WTP and the AC have completed DTLS session establishment, a
618 configuration exchange occurs in which both devices agree on version
619 information. During this exchange, the WTP may receive provisioning
620 settings. The WTP is then enabled for operation.
621
622 When the WTP and AC have completed the version and provision exchange
623 and the WTP is enabled, the CAPWAP protocol is used to encapsulate
624 the wireless data frames sent between the WTP and AC. The CAPWAP
625 protocol will fragment the L2 frames if the size of the encapsulated
626 wireless user data (Data) or protocol control (Management) frames
627 causes the resulting CAPWAP protocol packet to exceed the MTU
628 supported between the WTP and AC. Fragmented CAPWAP packets are
629 reassembled to reconstitute the original encapsulated payload. MTU
630 Discovery and Fragmentation are described in <a href="#section-3">Section 3</a>.
631
632 The CAPWAP protocol provides for the delivery of commands from the AC
633 to the WTP for the management of stations that are communicating with
634 the WTP. This may include the creation of local data structures in
635 the WTP for the stations and the collection of statistical
636 information about the communication between the WTP and the stations.
637 The CAPWAP protocol provides a mechanism for the AC to obtain
638 statistical information collected by the WTP.
639
640 The CAPWAP protocol provides for a keep-alive feature that preserves
641 the communication channel between the WTP and AC. If the AC fails to
642 appear alive, the WTP will try to discover a new AC.
643
644 <span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. Wireless Binding Definition</span>
645
646 The CAPWAP protocol is independent of a specific WTP radio
647 technology, as well its associated wireless link layer protocol.
648 Elements of the CAPWAP protocol are designed to accommodate the
649 specific needs of each wireless technology in a standard way.
650 Implementation of the CAPWAP protocol for a particular wireless
651 technology MUST follow the binding requirements defined for that
652 technology.
653
654 When defining a binding for wireless technologies, the authors MUST
655 include any necessary definitions for technology-specific messages
656 and all technology-specific message elements for those messages. At
657 a minimum, a binding MUST provide:
658
659 1. The definition for a binding-specific Statistics message element,
660 carried in the WTP Event Request message.
661
662 2. A message element carried in the Station Configuration Request
663 message to configure station information on the WTP.
664
665
666
667
668 <span class="grey">Calhoun, et al. Standards Track [Page 12]</span></pre>
669 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
670 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
671
672
673 3. A WTP Radio Information message element carried in the Discovery,
674 Primary Discovery, and Join Request and Response messages,
675 indicating the binding-specific radio types supported at the WTP
676 and AC.
677
678 If technology-specific message elements are required for any of the
679 existing CAPWAP messages defined in this specification, they MUST
680 also be defined in the technology binding document.
681
682 The naming of binding-specific message elements MUST begin with the
683 name of the technology type, e.g., the binding for IEEE 802.11,
684 provided in [<a href="./rfc5416" title="&quot;Control And Provisioning of Wireless Access Points (CAPWAP) Protocol Binding for IEEE 802.11&quot;">RFC5416</a>], begins with "IEEE 802.11".
685
686 The CAPWAP binding concept MUST also be used in any future
687 specifications that add functionality to either the base CAPWAP
688 protocol specification, or any published CAPWAP binding
689 specification. A separate WTP Radio Information message element MUST
690 be created to properly advertise support for the specification. This
691 mechanism allows for future protocol extensibility, while providing
692 the necessary capabilities advertisement, through the WTP Radio
693 Information message element, to ensure WTP/AC interoperability.
694
695 <span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a>. CAPWAP Session Establishment Overview</span>
696
697 This section describes the session establishment process message
698 exchanges between a CAPWAP WTP and AC. The annotated ladder diagram
699 shows the AC on the right, the WTP on the left, and assumes the use
700 of certificates for DTLS authentication. The CAPWAP protocol state
701 machine is described in detail in <a href="#section-2.3">Section 2.3</a>. Note that DTLS allows
702 certain messages to be aggregated into a single frame, which is
703 denoted via an asterisk in Figure 3.
704
705 ============ ============
706 WTP AC
707 ============ ============
708 [----------- begin optional discovery ------------]
709
710 Discover Request
711 ------------------------------------&gt;
712 Discover Response
713 &lt;------------------------------------
714
715 [----------- end optional discovery ------------]
716
717 (-- begin DTLS handshake --)
718
719 ClientHello
720 ------------------------------------&gt;
721
722
723
724 <span class="grey">Calhoun, et al. Standards Track [Page 13]</span></pre>
725 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
726 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
727
728
729 HelloVerifyRequest (with cookie)
730 &lt;------------------------------------
731
732
733 ClientHello (with cookie)
734 ------------------------------------&gt;
735 ServerHello,
736 Certificate,
737 ServerHelloDone*
738 &lt;------------------------------------
739
740 (-- WTP callout for AC authorization --)
741
742 Certificate (optional),
743 ClientKeyExchange,
744 CertificateVerify (optional),
745 ChangeCipherSpec,
746 Finished*
747 ------------------------------------&gt;
748
749 (-- AC callout for WTP authorization --)
750
751 ChangeCipherSpec,
752 Finished*
753 &lt;------------------------------------
754
755 (-- DTLS session is established now --)
756
757 Join Request
758 ------------------------------------&gt;
759 Join Response
760 &lt;------------------------------------
761 [-- Join State Complete --]
762
763 (-- assume image is up to date --)
764
765 Configuration Status Request
766 ------------------------------------&gt;
767 Configuration Status Response
768 &lt;------------------------------------
769 [-- Configure State Complete --]
770
771 Change State Event Request
772 ------------------------------------&gt;
773 Change State Event Response
774 &lt;------------------------------------
775 [-- Data Check State Complete --]
776
777
778
779
780 <span class="grey">Calhoun, et al. Standards Track [Page 14]</span></pre>
781 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
782 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
783
784
785 (-- enter RUN state --)
786
787 :
788 :
789
790 Echo Request
791 ------------------------------------&gt;
792 Echo Response
793 &lt;------------------------------------
794
795 :
796 :
797
798 Event Request
799 ------------------------------------&gt;
800 Event Response
801 &lt;------------------------------------
802
803 :
804 :
805
806 Figure 3: CAPWAP Control Protocol Exchange
807
808 At the end of the illustrated CAPWAP message exchange, the AC and WTP
809 are securely exchanging CAPWAP Control messages. This illustration
810 is provided to clarify protocol operation, and does not include any
811 possible error conditions. <a href="#section-2.3">Section 2.3</a> provides a detailed
812 description of the corresponding state machine.
813
814 <span class="h3"><a class="selflink" id="section-2.3" href="#section-2.3">2.3</a>. CAPWAP State Machine Definition</span>
815
816 The following state diagram represents the lifecycle of a WTP-AC
817 session. Use of DTLS by the CAPWAP protocol results in the
818 juxtaposition of two nominally separate yet tightly bound state
819 machines. The DTLS and CAPWAP state machines are coupled through an
820 API consisting of commands (see <a href="#section-2.3.2.1">Section 2.3.2.1</a>) and notifications
821 (see <a href="#section-2.3.2.2">Section 2.3.2.2</a>). Certain transitions in the DTLS state machine
822 are triggered by commands from the CAPWAP state machine, while
823 certain transitions in the CAPWAP state machine are triggered by
824 notifications from the DTLS state machine.
825
826
827
828
829
830
831
832
833
834
835
836 <span class="grey">Calhoun, et al. Standards Track [Page 15]</span></pre>
837 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
838 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
839
840
841 /-------------------------------------\
842 | /-------------------------\|
843 | p| ||
844 | q+----------+ r +------------+ ||
845 | | Run |--&gt;| Reset |-\||
846 | +----------+ +------------+ |||
847 n| o ^ ^ ^ s|||
848 +------------+--------/ | | |||
849 | Data Check | /-------/ | |||
850 +------------+&lt;-------\ | | |||
851 | | | |||
852 /------------------+--------\ | |||
853 f| m| h| j v k| |||
854 +--------+ +-----------+ +--------------+|||
855 | Join |----&gt;| Configure | | Image Data ||||
856 +--------+ n +-----------+ +--------------+|||
857 ^ |g i| l| |||
858 | | \-------------------\ | |||
859 | \--------------------------------------\| | |||
860 \------------------------\ || | |||
861 /--------------&lt;----------------+---------------\ || | |||
862 | /------------&lt;----------------+-------------\ | || | |||
863 | | 4 |d t| | vv v vvv
864 | | +----------------+ +--------------+ +-----------+
865 | | | DTLS Setup | | DTLS Connect |--&gt;| DTLS TD |
866 /-|-|---+----------------+ +--------------+ e +-----------+
867 | | | |$ ^ ^ |5 ^6 ^ ^ |w
868 v v v | | | | \-------\ | | |
869 | | | | | | \---------\ | | /-----------/ |
870 | | | | | \--\ | | | | |
871 | | | | | | | | | | |
872 | | | v 3| 1 |% # v | |a |b v
873 | | \-&gt;+------+--&gt;+------+ +-----------+ +--------+
874 | | | Idle | | Disc | | Authorize | | Dead |
875 | | +------+&lt;--+------+ +-----------+ +--------+
876 | | ^ 0^ 2 |!
877 | | | | | +-------+
878 *| |u | \---------+---| Start |
879 | | |@ | +-------+
880 | \-&gt;+---------+&lt;------/
881 \---&gt;| Sulking |
882 +---------+&amp;
883
884 Figure 4: CAPWAP Integrated State Machine
885
886 The CAPWAP protocol state machine, depicted above, is used by both
887 the AC and the WTP. In cases where states are not shared (i.e., not
888 implemented in one or the other of the AC or WTP), this is explicitly
889
890
891
892 <span class="grey">Calhoun, et al. Standards Track [Page 16]</span></pre>
893 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
894 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
895
896
897 called out in the transition descriptions below. For every state
898 defined, only certain messages are permitted to be sent and received.
899 The CAPWAP Control message definitions specify the state(s) in which
900 each message is valid.
901
902 Since the WTP only communicates with a single AC, it only has a
903 single instance of the CAPWAP state machine. The state machine works
904 differently on the AC since it communicates with many WTPs. The AC
905 uses the concept of three threads. Note that the term thread used
906 here does not necessarily imply that implementers must use threads,
907 but it is one possible way of implementing the AC's state machine.
908
909 Listener Thread: The AC's Listener thread handles inbound DTLS
910 session establishment requests, through the DTLSListen command.
911 Upon creation, the Listener thread starts in the DTLS Setup state.
912 Once a DTLS session has been validated, which occurs when the
913 state machine enters the "Authorize" state, the Listener thread
914 creates a WTP session-specific Service thread and state context.
915 The state machine transitions in Figure 4 are represented by
916 numerals. It is necessary for the AC to protect itself against
917 various attacks that exist with non-authenticated frames. See
918 <a href="#section-12">Section 12</a> for more information.
919
920 Discovery Thread: The AC's Discovery thread is responsible for
921 receiving, and responding to, Discovery Request messages. The
922 state machine transitions in Figure 4 are represented by numerals.
923 Note that the Discovery thread does not maintain any per-WTP-
924 specific context information, and a single state context exists.
925 It is necessary for the AC to protect itself against various
926 attacks that exist with non-authenticated frames. See <a href="#section-12">Section 12</a>
927 for more information.
928
929 Service Thread: The AC's Service thread handles the per-WTP states,
930 and one such thread exists per-WTP connection. This thread is
931 created by the Listener thread when the Authorize state is
932 reached. When created, the Service thread inherits a copy of the
933 state machine context from the Listener thread. When
934 communication with the WTP is complete, the Service thread is
935 terminated and all associated resources are released. The state
936 machine transitions in Figure 4 are represented by alphabetic and
937 punctuation characters.
938
939 <span class="h4"><a class="selflink" id="section-2.3.1" href="#section-2.3.1">2.3.1</a>. CAPWAP Protocol State Transitions</span>
940
941 This section describes the various state transitions, and the events
942 that cause them. This section does not discuss interactions between
943 DTLS- and CAPWAP-specific states. Those interactions, and DTLS-
944 specific states and transitions, are discussed in <a href="#section-2.3.2">Section 2.3.2</a>.
945
946
947
948 <span class="grey">Calhoun, et al. Standards Track [Page 17]</span></pre>
949 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
950 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
951
952
953 Start to Idle (0): This transition occurs once device initialization
954 is complete.
955
956 WTP: This state transition is used to start the WTP's CAPWAP
957 state machine.
958
959 AC: The AC creates the Discovery and Listener threads and starts
960 the CAPWAP state machine.
961
962 Idle to Discovery (1): This transition occurs to support the CAPWAP
963 discovery process.
964
965 WTP: The WTP enters the Discovery state prior to transmitting the
966 first Discovery Request message (see <a href="#section-5.1">Section 5.1</a>). Upon
967 entering this state, the WTP sets the DiscoveryInterval
968 timer (see <a href="#section-4.7">Section 4.7</a>). The WTP resets the DiscoveryCount
969 counter to zero (0) (see <a href="#section-4.8">Section 4.8</a>). The WTP also clears
970 all information from ACs it may have received during a
971 previous Discovery phase.
972
973 AC: This state transition is executed by the AC's Discovery
974 thread, and occurs when a Discovery Request message is
975 received. The AC SHOULD respond with a Discovery Response
976 message (see <a href="#section-5.2">Section 5.2</a>).
977
978 Discovery to Discovery (#): In the Discovery state, the WTP
979 determines to which AC to connect.
980
981 WTP: This transition occurs when the DiscoveryInterval timer
982 expires. If the WTP is configured with a list of ACs, it
983 transmits a Discovery Request message to every AC from which
984 it has not received a Discovery Response message. For every
985 transition to this event, the WTP increments the
986 DiscoveryCount counter. See <a href="#section-5.1">Section 5.1</a> for more
987 information on how the WTP knows the ACs to which it should
988 transmit the Discovery Request messages. The WTP restarts
989 the DiscoveryInterval timer whenever it transmits Discovery
990 Request messages.
991
992 AC: This is an invalid state transition for the AC.
993
994 Discovery to Idle (2): This transition occurs on the AC's Discovery
995 thread when the Discovery processing is complete.
996
997 WTP: This is an invalid state transition for the WTP.
998
999
1000
1001
1002
1003
1004 <span class="grey">Calhoun, et al. Standards Track [Page 18]</span></pre>
1005 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
1006 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1007
1008
1009 AC: This state transition is executed by the AC's Discovery
1010 thread when it has transmitted the Discovery Response, in
1011 response to a Discovery Request.
1012
1013 Discovery to Sulking (!): This transition occurs on a WTP when AC
1014 Discovery fails.
1015
1016 WTP: The WTP enters this state when the DiscoveryInterval timer
1017 expires and the DiscoveryCount variable is equal to the
1018 MaxDiscoveries variable (see <a href="#section-4.8">Section 4.8</a>). Upon entering
1019 this state, the WTP MUST start the SilentInterval timer.
1020 While in the Sulking state, all received CAPWAP protocol
1021 messages MUST be ignored.
1022
1023 AC: This is an invalid state transition for the AC.
1024
1025 Sulking to Idle (@): This transition occurs on a WTP when it must
1026 restart the Discovery phase.
1027
1028 WTP: The WTP enters this state when the SilentInterval timer (see
1029 <a href="#section-4.7">Section 4.7</a>) expires. The FailedDTLSSessionCount,
1030 DiscoveryCount, and FailedDTLSAuthFailCount counters are
1031 reset to zero.
1032
1033 AC: This is an invalid state transition for the AC.
1034
1035 Sulking to Sulking (&amp;): The Sulking state provides the silent
1036 period, minimizing the possibility for Denial-of-Service (DoS)
1037 attacks.
1038
1039 WTP: All packets received from the AC while in the sulking state
1040 are ignored.
1041
1042 AC: This is an invalid state transition for the AC.
1043
1044 Idle to DTLS Setup (3): This transition occurs to establish a secure
1045 DTLS session with the peer.
1046
1047 WTP: The WTP initiates this transition by invoking the DTLSStart
1048 command (see <a href="#section-2.3.2.1">Section 2.3.2.1</a>), which starts the DTLS session
1049 establishment with the chosen AC and the WaitDTLS timer is
1050 started (see <a href="#section-4.7">Section 4.7</a>). When the Discovery phase is
1051 bypassed, it is assumed the WTP has locally configured ACs.
1052
1053
1054
1055
1056
1057
1058
1059
1060 <span class="grey">Calhoun, et al. Standards Track [Page 19]</span></pre>
1061 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
1062 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1063
1064
1065 AC: Upon entering the Idle state from the Start state, the newly
1066 created Listener thread automatically transitions to the
1067 DTLS Setup and invokes the DTLSListen command (see
1068 <a href="#section-2.3.2.1">Section 2.3.2.1</a>), and the WaitDTLS timer is started (see
1069 <a href="#section-4.7">Section 4.7</a>).
1070
1071 Discovery to DTLS Setup (%): This transition occurs to establish a
1072 secure DTLS session with the peer.
1073
1074 WTP: The WTP initiates this transition by invoking the DTLSStart
1075 command (see <a href="#section-2.3.2.1">Section 2.3.2.1</a>), which starts the DTLS session
1076 establishment with the chosen AC. The decision of to which
1077 AC to connect is the result of the Discovery phase, which is
1078 described in <a href="#section-3.3">Section 3.3</a>.
1079
1080 AC: This is an invalid state transition for the AC.
1081
1082 DTLS Setup to Idle ($): This transition occurs when the DTLS
1083 connection setup fails.
1084
1085 WTP: The WTP initiates this state transition when it receives a
1086 DTLSEstablishFail notification from DTLS (see
1087 <a href="#section-2.3.2.2">Section 2.3.2.2</a>), and the FailedDTLSSessionCount or the
1088 FailedDTLSAuthFailCount counter have not reached the value
1089 of the MaxFailedDTLSSessionRetry variable (see <a href="#section-4.8">Section 4.8</a>).
1090 This error notification aborts the secure DTLS session
1091 establishment. When this notification is received, the
1092 FailedDTLSSessionCount counter is incremented. This state
1093 transition also occurs if the WaitDTLS timer has expired.
1094
1095 AC: This is an invalid state transition for the AC.
1096
1097 DTLS Setup to Sulking (*): This transition occurs when repeated
1098 attempts to set up the DTLS connection have failed.
1099
1100 WTP: The WTP enters this state when the FailedDTLSSessionCount or
1101 the FailedDTLSAuthFailCount counter reaches the value of the
1102 MaxFailedDTLSSessionRetry variable (see <a href="#section-4.8">Section 4.8</a>). Upon
1103 entering this state, the WTP MUST start the SilentInterval
1104 timer. While in the Sulking state, all received CAPWAP and
1105 DTLS protocol messages received MUST be ignored.
1106
1107 AC: This is an invalid state transition for the AC.
1108
1109 DTLS Setup to DTLS Setup (4): This transition occurs when the DTLS
1110 Session failed to be established.
1111
1112 WTP: This is an invalid state transition for the WTP.
1113
1114
1115
1116 <span class="grey">Calhoun, et al. Standards Track [Page 20]</span></pre>
1117 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
1118 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1119
1120
1121 AC: The AC's Listener initiates this state transition when it
1122 receives a DTLSEstablishFail notification from DTLS (see
1123 <a href="#section-2.3.2.2">Section 2.3.2.2</a>). This error notification aborts the secure
1124 DTLS session establishment. When this notification is
1125 received, the FailedDTLSSessionCount counter is incremented.
1126 The Listener thread then invokes the DTLSListen command (see
1127 <a href="#section-2.3.2.1">Section 2.3.2.1</a>).
1128
1129 DTLS Setup to Authorize (5): This transition occurs when an incoming
1130 DTLS session is being established, and the DTLS stack needs
1131 authorization to proceed with the session establishment.
1132
1133 WTP: This state transition occurs when the WTP receives the
1134 DTLSPeerAuthorize notification (see <a href="#section-2.3.2.2">Section 2.3.2.2</a>). Upon
1135 entering this state, the WTP performs an authorization check
1136 against the AC credentials. See <a href="#section-2.4.4">Section 2.4.4</a> for more
1137 information on AC authorization.
1138
1139 AC: This state transition is handled by the AC's Listener thread
1140 when the DTLS module initiates the DTLSPeerAuthorize
1141 notification (see <a href="#section-2.3.2.2">Section 2.3.2.2</a>). The Listener thread
1142 forks an instance of the Service thread, along with a copy
1143 of the state context. Once created, the Service thread
1144 performs an authorization check against the WTP credentials.
1145 See <a href="#section-2.4.4">Section 2.4.4</a> for more information on WTP authorization.
1146
1147 Authorize to DTLS Setup (6): This transition is executed by the
1148 Listener thread to enable it to listen for new incoming sessions.
1149
1150 WTP: This is an invalid state transition for the WTP.
1151
1152 AC: This state transition occurs when the AC's Listener thread
1153 has created the WTP context and the Service thread. The
1154 Listener thread then invokes the DTLSListen command (see
1155 <a href="#section-2.3.2.1">Section 2.3.2.1</a>).
1156
1157 Authorize to DTLS Connect (a): This transition occurs to notify the
1158 DTLS stack that the session should be established.
1159
1160 WTP: This state transition occurs when the WTP has successfully
1161 authorized the AC's credentials (see <a href="#section-2.4.4">Section 2.4.4</a>). This
1162 is done by invoking the DTLSAccept DTLS command (see
1163 <a href="#section-2.3.2.1">Section 2.3.2.1</a>).
1164
1165 AC: This state transition occurs when the AC has successfully
1166 authorized the WTP's credentials (see <a href="#section-2.4.4">Section 2.4.4</a>). This
1167 is done by invoking the DTLSAccept DTLS command (see
1168 <a href="#section-2.3.2.1">Section 2.3.2.1</a>).
1169
1170
1171
1172 <span class="grey">Calhoun, et al. Standards Track [Page 21]</span></pre>
1173 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
1174 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1175
1176
1177 Authorize to DTLS Teardown (b): This transition occurs to notify the
1178 DTLS stack that the session should be aborted.
1179
1180 WTP: This state transition occurs when the WTP has been unable to
1181 authorize the AC, using the AC credentials. The WTP then
1182 aborts the DTLS session by invoking the DTLSAbortSession
1183 command (see <a href="#section-2.3.2.1">Section 2.3.2.1</a>). This state transition also
1184 occurs if the WaitDTLS timer has expired. The WTP starts
1185 the DTLSSessionDelete timer (see <a href="#section-4.7.6">Section 4.7.6</a>).
1186
1187 AC: This state transition occurs when the AC has been unable to
1188 authorize the WTP, using the WTP credentials. The AC then
1189 aborts the DTLS session by invoking the DTLSAbortSession
1190 command (see <a href="#section-2.3.2.1">Section 2.3.2.1</a>). This state transition also
1191 occurs if the WaitDTLS timer has expired. The AC starts the
1192 DTLSSessionDelete timer (see <a href="#section-4.7.6">Section 4.7.6</a>).
1193
1194 DTLS Connect to DTLS Teardown (c): This transition occurs when the
1195 DTLS Session failed to be established.
1196
1197 WTP: This state transition occurs when the WTP receives either a
1198 DTLSAborted or DTLSAuthenticateFail notification (see
1199 <a href="#section-2.3.2.2">Section 2.3.2.2</a>), indicating that the DTLS session was not
1200 successfully established. When this transition occurs due
1201 to the DTLSAuthenticateFail notification, the
1202 FailedDTLSAuthFailCount is incremented; otherwise, the
1203 FailedDTLSSessionCount counter is incremented. This state
1204 transition also occurs if the WaitDTLS timer has expired.
1205 The WTP starts the DTLSSessionDelete timer (see
1206 <a href="#section-4.7.6">Section 4.7.6</a>).
1207
1208 AC: This state transition occurs when the AC receives either a
1209 DTLSAborted or DTLSAuthenticateFail notification (see
1210 <a href="#section-2.3.2.2">Section 2.3.2.2</a>), indicating that the DTLS session was not
1211 successfully established, and both of the
1212 FailedDTLSAuthFailCount and FailedDTLSSessionCount counters
1213 have not reached the value of the MaxFailedDTLSSessionRetry
1214 variable (see <a href="#section-4.8">Section 4.8</a>). This state transition also
1215 occurs if the WaitDTLS timer has expired. The AC starts the
1216 DTLSSessionDelete timer (see <a href="#section-4.7.6">Section 4.7.6</a>).
1217
1218 DTLS Connect to Join (d): This transition occurs when the DTLS
1219 Session is successfully established.
1220
1221 WTP: This state transition occurs when the WTP receives the
1222 DTLSEstablished notification (see <a href="#section-2.3.2.2">Section 2.3.2.2</a>),
1223 indicating that the DTLS session was successfully
1224 established. When this notification is received, the
1225
1226
1227
1228 <span class="grey">Calhoun, et al. Standards Track [Page 22]</span></pre>
1229 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
1230 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1231
1232
1233 FailedDTLSSessionCount counter is set to zero. The WTP
1234 enters the Join state by transmitting the Join Request to
1235 the AC. The WTP stops the WaitDTLS timer.
1236
1237 AC: This state transition occurs when the AC receives the
1238 DTLSEstablished notification (see <a href="#section-2.3.2.2">Section 2.3.2.2</a>),
1239 indicating that the DTLS session was successfully
1240 established. When this notification is received, the
1241 FailedDTLSSessionCount counter is set to zero. The AC stops
1242 the WaitDTLS timer, and starts the WaitJoin timer.
1243
1244 Join to DTLS Teardown (e): This transition occurs when the join
1245 process has failed.
1246
1247 WTP: This state transition occurs when the WTP receives a Join
1248 Response message with a Result Code message element
1249 containing an error, or if the Image Identifier provided by
1250 the AC in the Join Response message differs from the WTP's
1251 currently running firmware version and the WTP has the
1252 requested image in its non-volatile memory. This causes the
1253 WTP to initiate the DTLSShutdown command (see
1254 <a href="#section-2.3.2.1">Section 2.3.2.1</a>). This transition also occurs if the WTP
1255 receives one of the following DTLS notifications:
1256 DTLSAborted, DTLSReassemblyFailure, or DTLSPeerDisconnect.
1257 The WTP starts the DTLSSessionDelete timer (see
1258 <a href="#section-4.7.6">Section 4.7.6</a>).
1259
1260 AC: This state transition occurs either if the WaitJoin timer
1261 expires or if the AC transmits a Join Response message with
1262 a Result Code message element containing an error. This
1263 causes the AC to initiate the DTLSShutdown command (see
1264 <a href="#section-2.3.2.1">Section 2.3.2.1</a>). This transition also occurs if the AC
1265 receives one of the following DTLS notifications:
1266 DTLSAborted, DTLSReassemblyFailure, or DTLSPeerDisconnect.
1267 The AC starts the DTLSSessionDelete timer (see
1268 <a href="#section-4.7.6">Section 4.7.6</a>).
1269
1270 Join to Image Data (f): This state transition is used by the WTP and
1271 the AC to download executable firmware.
1272
1273 WTP: The WTP enters the Image Data state when it receives a
1274 successful Join Response message and determines that the
1275 software version in the Image Identifier message element is
1276 not the same as its currently running image. The WTP also
1277 detects that the requested image version is not currently
1278 available in the WTP's non-volatile storage (see <a href="#section-9.1">Section 9.1</a>
1279 for a full description of the firmware download process).
1280 The WTP initializes the EchoInterval timer (see
1281
1282
1283
1284 <span class="grey">Calhoun, et al. Standards Track [Page 23]</span></pre>
1285 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
1286 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1287
1288
1289 <a href="#section-4.7">Section 4.7</a>), and transmits the Image Data Request message
1290 (see <a href="#section-9.1.1">Section 9.1.1</a>) requesting the start of the firmware
1291 download.
1292
1293 AC: This state transition occurs when the AC receives the Image
1294 Data Request message from the WTP, after having sent its
1295 Join Response to the WTP. The AC stops the WaitJoin timer.
1296 The AC MUST transmit an Image Data Response message (see
1297 <a href="#section-9.1.2">Section 9.1.2</a>) to the WTP, which includes a portion of the
1298 firmware.
1299
1300 Join to Configure (g): This state transition is used by the WTP and
1301 the AC to exchange configuration information.
1302
1303 WTP: The WTP enters the Configure state when it receives a
1304 successful Join Response message, and determines that the
1305 included Image Identifier message element is the same as its
1306 currently running image. The WTP transmits the
1307 Configuration Status Request message (see <a href="#section-8.2">Section 8.2</a>) to
1308 the AC with message elements describing its current
1309 configuration.
1310
1311 AC: This state transition occurs when it receives the
1312 Configuration Status Request message from the WTP (see
1313 <a href="#section-8.2">Section 8.2</a>), which MAY include specific message elements to
1314 override the WTP's configuration. The AC stops the WaitJoin
1315 timer. The AC transmits the Configuration Status Response
1316 message (see <a href="#section-8.3">Section 8.3</a>) and starts the
1317 ChangeStatePendingTimer timer (see <a href="#section-4.7">Section 4.7</a>).
1318
1319 Configure to Reset (h): This state transition is used to reset the
1320 connection either due to an error during the configuration phase,
1321 or when the WTP determines it needs to reset in order for the new
1322 configuration to take effect. The CAPWAP Reset command is used to
1323 indicate to the peer that it will initiate a DTLS teardown.
1324
1325 WTP: The WTP enters the Reset state when it receives a
1326 Configuration Status Response message indicating an error or
1327 when it determines that a reset of the WTP is required, due
1328 to the characteristics of a new configuration.
1329
1330 AC: The AC transitions to the Reset state when it receives a
1331 Change State Event message from the WTP that contains an
1332 error for which AC policy does not permit the WTP to provide
1333 service. This state transition also occurs when the AC
1334 ChangeStatePendingTimer timer expires.
1335
1336
1337
1338
1339
1340 <span class="grey">Calhoun, et al. Standards Track [Page 24]</span></pre>
1341 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
1342 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1343
1344
1345 Configure to DTLS Teardown (i): This transition occurs when the
1346 configuration process aborts due to a DTLS error.
1347
1348 WTP: The WTP enters this state when it receives one of the
1349 following DTLS notifications: DTLSAborted,
1350 DTLSReassemblyFailure, or DTLSPeerDisconnect (see
1351 <a href="#section-2.3.2.2">Section 2.3.2.2</a>). The WTP MAY tear down the DTLS session if
1352 it receives frequent DTLSDecapFailure notifications. The
1353 WTP starts the DTLSSessionDelete timer (see <a href="#section-4.7.6">Section 4.7.6</a>).
1354
1355 AC: The AC enters this state when it receives one of the
1356 following DTLS notifications: DTLSAborted,
1357 DTLSReassemblyFailure, or DTLSPeerDisconnect (see
1358 <a href="#section-2.3.2.2">Section 2.3.2.2</a>). The AC MAY tear down the DTLS session if
1359 it receives frequent DTLSDecapFailure notifications. The AC
1360 starts the DTLSSessionDelete timer (see <a href="#section-4.7.6">Section 4.7.6</a>).
1361
1362 Image Data to Image Data (j): The Image Data state is used by the
1363 WTP and the AC during the firmware download phase.
1364
1365 WTP: The WTP enters the Image Data state when it receives an
1366 Image Data Response message indicating that the AC has more
1367 data to send. This state transition also occurs when the
1368 WTP receives the subsequent Image Data Requests, at which
1369 time it resets the ImageDataStartTimer time to ensure it
1370 receives the next expected Image Data Request from the AC.
1371 This state transition can also occur when the WTP's
1372 EchoInterval timer (see <a href="#section-4.7.7">Section 4.7.7</a>) expires, in which
1373 case the WTP transmits an Echo Request message (see
1374 <a href="#section-7.1">Section 7.1</a>), and resets its EchoInterval timer. The state
1375 transition also occurs when the WTP receives an Echo
1376 Response from the AC (see <a href="#section-7.2">Section 7.2</a>).
1377
1378 AC: This state transition occurs when the AC receives the Image
1379 Data Response message from the WTP while already in the
1380 Image Data state. This state transition also occurs when
1381 the AC receives an Echo Request (see <a href="#section-7.1">Section 7.1</a>) from the
1382 WTP, in which case it responds with an Echo Response (see
1383 <a href="#section-7.2">Section 7.2</a>), and resets its EchoInterval timer (see
1384 <a href="#section-4.7.7">Section 4.7.7</a>).
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396 <span class="grey">Calhoun, et al. Standards Track [Page 25]</span></pre>
1397 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
1398 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1399
1400
1401 Image Data to Reset (k): This state transition is used to reset the
1402 DTLS connection prior to restarting the WTP after an image
1403 download.
1404
1405 WTP: When an image download completes, or if the
1406 ImageDataStartTimer timer expires, the WTP enters the Reset
1407 state. The WTP MAY also transition to this state upon
1408 receiving an Image Data Response message from the AC (see
1409 <a href="#section-9.1.2">Section 9.1.2</a>) indicating a failure.
1410
1411 AC: The AC enters the Reset state either when the image transfer
1412 has successfully completed or an error occurs during the
1413 image download process.
1414
1415 Image Data to DTLS Teardown (l): This transition occurs when the
1416 firmware download process aborts due to a DTLS error.
1417
1418 WTP: The WTP enters this state when it receives one of the
1419 following DTLS notifications: DTLSAborted,
1420 DTLSReassemblyFailure, or DTLSPeerDisconnect (see
1421 <a href="#section-2.3.2.2">Section 2.3.2.2</a>). The WTP MAY tear down the DTLS session if
1422 it receives frequent DTLSDecapFailure notifications. The
1423 WTP starts the DTLSSessionDelete timer (see <a href="#section-4.7.6">Section 4.7.6</a>).
1424
1425 AC: The AC enters this state when it receives one of the
1426 following DTLS notifications: DTLSAborted,
1427 DTLSReassemblyFailure, or DTLSPeerDisconnect (see
1428 <a href="#section-2.3.2.2">Section 2.3.2.2</a>). The AC MAY tear down the DTLS session if
1429 it receives frequent DTLSDecapFailure notifications. The AC
1430 starts the DTLSSessionDelete timer (see <a href="#section-4.7.6">Section 4.7.6</a>).
1431
1432 Configure to Data Check (m): This state transition occurs when the
1433 WTP and AC confirm the configuration.
1434
1435 WTP: The WTP enters this state when it receives a successful
1436 Configuration Status Response message from the AC. The WTP
1437 transmits the Change State Event Request message (see
1438 <a href="#section-8.6">Section 8.6</a>).
1439
1440 AC: This state transition occurs when the AC receives the Change
1441 State Event Request message (see <a href="#section-8.6">Section 8.6</a>) from the WTP.
1442 The AC responds with a Change State Event Response message
1443 (see <a href="#section-8.7">Section 8.7</a>). The AC MUST start the DataCheckTimer
1444 timer and stops the ChangeStatePendingTimer timer (see
1445 <a href="#section-4.7">Section 4.7</a>).
1446
1447 Data Check to DTLS Teardown (n): This transition occurs when the WTP
1448 does not complete the Data Check exchange.
1449
1450
1451
1452 <span class="grey">Calhoun, et al. Standards Track [Page 26]</span></pre>
1453 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
1454 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1455
1456
1457 WTP: This state transition occurs if the WTP does not receive the
1458 Change State Event Response message before a CAPWAP
1459 retransmission timeout occurs. The WTP also transitions to
1460 this state if the underlying reliable transport's
1461 RetransmitCount counter has reached the MaxRetransmit
1462 variable (see <a href="#section-4.7">Section 4.7</a>). The WTP starts the
1463 DTLSSessionDelete timer (see <a href="#section-4.7.6">Section 4.7.6</a>).
1464
1465 AC: The AC enters this state when the DataCheckTimer timer
1466 expires (see <a href="#section-4.7">Section 4.7</a>). The AC starts the
1467 DTLSSessionDelete timer (see <a href="#section-4.7.6">Section 4.7.6</a>).
1468
1469 Data Check to Run (o): This state transition occurs when the linkage
1470 between the control and data channels is established, causing the
1471 WTP and AC to enter their normal state of operation.
1472
1473 WTP: The WTP enters this state when it receives a successful
1474 Change State Event Response message from the AC. The WTP
1475 initiates the data channel, which MAY require the
1476 establishment of a DTLS session, starts the
1477 DataChannelKeepAlive timer (see <a href="#section-4.7.2">Section 4.7.2</a>) and transmits
1478 a Data Channel Keep-Alive packet (see <a href="#section-4.4.1">Section 4.4.1</a>). The
1479 WTP then starts the EchoInterval timer and
1480 DataChannelDeadInterval timer (see <a href="#section-4.7">Section 4.7</a>).
1481
1482 AC: This state transition occurs when the AC receives the Data
1483 Channel Keep-Alive packet (see <a href="#section-4.4.1">Section 4.4.1</a>), with a
1484 Session ID message element matching that included by the WTP
1485 in the Join Request message. The AC disables the
1486 DataCheckTimer timer. Note that if AC policy is to require
1487 the data channel to be encrypted, this process would also
1488 require the establishment of a data channel DTLS session.
1489 Upon receiving the Data Channel Keep-Alive packet, the AC
1490 transmits its own Data Channel Keep Alive packet.
1491
1492 Run to DTLS Teardown (p): This state transition occurs when an error
1493 has occurred in the DTLS stack, causing the DTLS session to be
1494 torn down.
1495
1496 WTP: The WTP enters this state when it receives one of the
1497 following DTLS notifications: DTLSAborted,
1498 DTLSReassemblyFailure, or DTLSPeerDisconnect (see
1499 <a href="#section-2.3.2.2">Section 2.3.2.2</a>). The WTP MAY tear down the DTLS session if
1500 it receives frequent DTLSDecapFailure notifications. The
1501 WTP also transitions to this state if the underlying
1502 reliable transport's RetransmitCount counter has reached the
1503 MaxRetransmit variable (see <a href="#section-4.7">Section 4.7</a>). The WTP starts
1504 the DTLSSessionDelete timer (see <a href="#section-4.7.6">Section 4.7.6</a>).
1505
1506
1507
1508 <span class="grey">Calhoun, et al. Standards Track [Page 27]</span></pre>
1509 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
1510 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1511
1512
1513 AC: The AC enters this state when it receives one of the
1514 following DTLS notifications: DTLSAborted,
1515 DTLSReassemblyFailure, or DTLSPeerDisconnect (see
1516 <a href="#section-2.3.2.2">Section 2.3.2.2</a>). The AC MAY tear down the DTLS session if
1517 it receives frequent DTLSDecapFailure notifications. The AC
1518 transitions to this state if the underlying reliable
1519 transport's RetransmitCount counter has reached the
1520 MaxRetransmit variable (see <a href="#section-4.7">Section 4.7</a>). This state
1521 transition also occurs when the AC's EchoInterval timer (see
1522 <a href="#section-4.7.7">Section 4.7.7</a>) expires. The AC starts the DTLSSessionDelete
1523 timer (see <a href="#section-4.7.6">Section 4.7.6</a>).
1524
1525 Run to Run (q): This is the normal state of operation.
1526
1527 WTP: This is the WTP's normal state of operation. The WTP resets
1528 its EchoInterval timer whenever it transmits a request to
1529 the AC. There are many events that result in this state
1530 transition:
1531
1532 Configuration Update: The WTP receives a Configuration
1533 Update Request message (see <a href="#section-8.4">Section 8.4</a>). The WTP
1534 MUST respond with a Configuration Update Response
1535 message (see <a href="#section-8.5">Section 8.5</a>).
1536
1537 Change State Event: The WTP receives a Change State Event
1538 Response message, or determines that it must initiate
1539 a Change State Event Request message, as a result of a
1540 failure or change in the state of a radio.
1541
1542 Echo Request: The WTP sends an Echo Request message
1543 (<a href="#section-7.1">Section 7.1</a>) or receives the corresponding Echo
1544 Response message, (see <a href="#section-7.2">Section 7.2</a>) from the AC. When
1545 the WTP receives the Echo Response, it resets its
1546 EchoInterval timer (see <a href="#section-4.7.7">Section 4.7.7</a>).
1547
1548 Clear Config Request: The WTP receives a Clear
1549 Configuration Request message (see <a href="#section-8.8">Section 8.8</a>) and
1550 MUST generate a corresponding Clear Configuration
1551 Response message (see <a href="#section-8.9">Section 8.9</a>). The WTP MUST
1552 reset its configuration back to manufacturer defaults.
1553
1554 WTP Event: The WTP sends a WTP Event Request message,
1555 delivering information to the AC (see <a href="#section-9.4">Section 9.4</a>).
1556 The WTP receives a WTP Event Response message from the
1557 AC (see <a href="#section-9.5">Section 9.5</a>).
1558
1559
1560
1561
1562
1563
1564 <span class="grey">Calhoun, et al. Standards Track [Page 28]</span></pre>
1565 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
1566 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1567
1568
1569 Data Transfer: The WTP sends a Data Transfer Request or
1570 Data Transfer Response message to the AC (see
1571 <a href="#section-9.6">Section 9.6</a>). The WTP receives a Data Transfer
1572 Request or Data Transfer Response message from the AC
1573 (see <a href="#section-9.6">Section 9.6</a>). Upon receipt of a Data Transfer
1574 Request, the WTP transmits a Data Transfer Response to
1575 the AC.
1576
1577 Station Configuration Request: The WTP receives a Station
1578 Configuration Request message (see <a href="#section-10.1">Section 10.1</a>), to
1579 which it MUST respond with a Station Configuration
1580 Response message (see <a href="#section-10.2">Section 10.2</a>).
1581
1582 AC: This is the AC's normal state of operation. Note that the
1583 receipt of any Request from the WTP causes the AC to reset
1584 its EchoInterval timer (see <a href="#section-4.7.7">Section 4.7.7</a>).
1585
1586 Configuration Update: The AC sends a Configuration Update
1587 Request message (see <a href="#section-8.4">Section 8.4</a>) to the WTP to update
1588 its configuration. The AC receives a Configuration
1589 Update Response message (see <a href="#section-8.5">Section 8.5</a>) from the
1590 WTP.
1591
1592 Change State Event: The AC receives a Change State Event
1593 Request message (see <a href="#section-8.6">Section 8.6</a>), to which it MUST
1594 respond with the Change State Event Response message
1595 (see <a href="#section-8.7">Section 8.7</a>).
1596
1597 Echo Request: The AC receives an Echo Request message (see
1598 <a href="#section-7.1">Section 7.1</a>), to which it MUST respond with an Echo
1599 Response message (see <a href="#section-7.2">Section 7.2</a>).
1600
1601 Clear Config Response: The AC sends a Clear Configuration
1602 Request message (see <a href="#section-8.8">Section 8.8</a>) to the WTP to clear
1603 its configuration. The AC receives a Clear
1604 Configuration Response message from the WTP (see
1605 <a href="#section-8.9">Section 8.9</a>).
1606
1607 WTP Event: The AC receives a WTP Event Request message from
1608 the WTP (see <a href="#section-9.4">Section 9.4</a>) and MUST generate a
1609 corresponding WTP Event Response message (see
1610 <a href="#section-9.5">Section 9.5</a>).
1611
1612 Data Transfer: The AC sends a Data Transfer Request or Data
1613 Transfer Response message to the WTP (see
1614 <a href="#section-9.6">Section 9.6</a>). The AC receives a Data Transfer Request
1615
1616
1617
1618
1619
1620 <span class="grey">Calhoun, et al. Standards Track [Page 29]</span></pre>
1621 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
1622 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1623
1624
1625 or Data Transfer Response message from the WTP (see
1626 <a href="#section-9.6">Section 9.6</a>). Upon receipt of a Data Transfer
1627 Request, the AC transmits a Data Transfer Response to
1628 the WTP.
1629
1630 Station Configuration Request: The AC sends a Station
1631 Configuration Request message (see <a href="#section-10.1">Section 10.1</a>) or
1632 receives the corresponding Station Configuration
1633 Response message (see <a href="#section-10.2">Section 10.2</a>) from the WTP.
1634
1635 Run to Reset (r): This state transition is used when either the AC
1636 or WTP tears down the connection. This may occur as part of
1637 normal operation, or due to error conditions.
1638
1639 WTP: The WTP enters the Reset state when it receives a Reset
1640 Request message from the AC.
1641
1642 AC: The AC enters the Reset state when it transmits a Reset
1643 Request message to the WTP.
1644
1645 Reset to DTLS Teardown (s): This transition occurs when the CAPWAP
1646 reset is complete to terminate the DTLS session.
1647
1648 WTP: This state transition occurs when the WTP transmits a Reset
1649 Response message. The WTP does not invoke the DTLSShutdown
1650 command (see <a href="#section-2.3.2.1">Section 2.3.2.1</a>). The WTP starts the
1651 DTLSSessionDelete timer (see <a href="#section-4.7.6">Section 4.7.6</a>).
1652
1653 AC: This state transition occurs when the AC receives a Reset
1654 Response message. This causes the AC to initiate the
1655 DTLSShutdown command (see <a href="#section-2.3.2.1">Section 2.3.2.1</a>). The AC starts
1656 the DTLSSessionDelete timer (see <a href="#section-4.7.6">Section 4.7.6</a>).
1657
1658 DTLS Teardown to Idle (t): This transition occurs when the DTLS
1659 session has been shut down.
1660
1661 WTP: This state transition occurs when the WTP has successfully
1662 cleaned up all resources associated with the control plane
1663 DTLS session, or if the DTLSSessionDelete timer (see
1664 <a href="#section-4.7.6">Section 4.7.6</a>) expires. The data plane DTLS session is also
1665 shut down, and all resources released, if a DTLS session was
1666 established for the data plane. Any timers set for the
1667 current instance of the state machine are also cleared.
1668
1669 AC: This is an invalid state transition for the AC.
1670
1671
1672
1673
1674
1675
1676 <span class="grey">Calhoun, et al. Standards Track [Page 30]</span></pre>
1677 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
1678 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1679
1680
1681 DTLS Teardown to Sulking (u): This transition occurs when repeated
1682 attempts to setup the DTLS connection have failed.
1683
1684 WTP: The WTP enters this state when the FailedDTLSSessionCount or
1685 the FailedDTLSAuthFailCount counter reaches the value of the
1686 MaxFailedDTLSSessionRetry variable (see <a href="#section-4.8">Section 4.8</a>). Upon
1687 entering this state, the WTP MUST start the SilentInterval
1688 timer. While in the Sulking state, all received CAPWAP and
1689 DTLS protocol messages received MUST be ignored.
1690
1691 AC: This is an invalid state transition for the AC.
1692
1693 DTLS Teardown to Dead (w): This transition occurs when the DTLS
1694 session has been shut down.
1695
1696 WTP: This is an invalid state transition for the WTP.
1697
1698 AC: This state transition occurs when the AC has successfully
1699 cleaned up all resources associated with the control plane
1700 DTLS session , or if the DTLSSessionDelete timer (see
1701 <a href="#section-4.7.6">Section 4.7.6</a>) expires. The data plane DTLS session is also
1702 shut down, and all resources released, if a DTLS session was
1703 established for the data plane. Any timers set for the
1704 current instance of the state machine are also cleared. The
1705 AC's Service thread is terminated.
1706
1707 <span class="h4"><a class="selflink" id="section-2.3.2" href="#section-2.3.2">2.3.2</a>. CAPWAP/DTLS Interface</span>
1708
1709 This section describes the DTLS Commands used by CAPWAP, and the
1710 notifications received from DTLS to the CAPWAP protocol stack.
1711
1712 <span class="h5"><a class="selflink" id="section-2.3.2.1" href="#section-2.3.2.1">2.3.2.1</a>. CAPWAP to DTLS Commands</span>
1713
1714 Six commands are defined for the CAPWAP to DTLS API. These
1715 "commands" are conceptual, and may be implemented as one or more
1716 function calls. This API definition is provided to clarify
1717 interactions between the DTLS and CAPWAP components of the integrated
1718 CAPWAP state machine.
1719
1720 Below is a list of the minimal command APIs:
1721
1722 o DTLSStart is sent to the DTLS component to cause a DTLS session to
1723 be established. Upon invoking the DTLSStart command, the WaitDTLS
1724 timer is started. The WTP initiates this DTLS command, as the AC
1725 does not initiate DTLS sessions.
1726
1727 o DTLSListen is sent to the DTLS component to allow the DTLS
1728 component to listen for incoming DTLS session requests.
1729
1730
1731
1732 <span class="grey">Calhoun, et al. Standards Track [Page 31]</span></pre>
1733 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
1734 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1735
1736
1737 o DTLSAccept is sent to the DTLS component to allow the DTLS session
1738 establishment to continue successfully.
1739
1740 o DTLSAbortSession is sent to the DTLS component to cause the
1741 session that is in the process of being established to be aborted.
1742 This command is also sent when the WaitDTLS timer expires. When
1743 this command is executed, the FailedDTLSSessionCount counter is
1744 incremented.
1745
1746 o DTLSShutdown is sent to the DTLS component to cause session
1747 teardown.
1748
1749 o DTLSMtuUpdate is sent by the CAPWAP component to modify the MTU
1750 size used by the DTLS component. See <a href="#section-3.5">Section 3.5</a> for more
1751 information on MTU Discovery. The default size is 1468 bytes.
1752
1753 <span class="h5"><a class="selflink" id="section-2.3.2.2" href="#section-2.3.2.2">2.3.2.2</a>. DTLS to CAPWAP Notifications</span>
1754
1755 DTLS notifications are defined for the DTLS to CAPWAP API. These
1756 "notifications" are conceptual and may be implemented in numerous
1757 ways (e.g., as function return values). This API definition is
1758 provided to clarify interactions between the DTLS and CAPWAP
1759 components of the integrated CAPWAP state machine. It is important
1760 to note that the notifications listed below MAY cause the CAPWAP
1761 state machine to jump from one state to another using a state
1762 transition not listed in <a href="#section-2.3.1">Section 2.3.1</a>. When a notification listed
1763 below occurs, the target CAPWAP state shown in Figure 4 becomes the
1764 current state.
1765
1766 Below is a list of the API notifications:
1767
1768 o DTLSPeerAuthorize is sent to the CAPWAP component during DTLS
1769 session establishment once the peer's identity has been received.
1770 This notification MAY be used by the CAPWAP component to authorize
1771 the session, based on the peer's identity. The authorization
1772 process will lead to the CAPWAP component initiating either the
1773 DTLSAccept or DTLSAbortSession commands.
1774
1775 o DTLSEstablished is sent to the CAPWAP component to indicate that a
1776 secure channel now exists, using the parameters provided during
1777 the DTLS initialization process. When this notification is
1778 received, the FailedDTLSSessionCount counter is reset to zero.
1779 When this notification is received, the WaitDTLS timer is stopped.
1780
1781 o DTLSEstablishFail is sent when the DTLS session establishment has
1782 failed, either due to a local error or due to the peer rejecting
1783 the session establishment. When this notification is received,
1784 the FailedDTLSSessionCount counter is incremented.
1785
1786
1787
1788 <span class="grey">Calhoun, et al. Standards Track [Page 32]</span></pre>
1789 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
1790 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1791
1792
1793 o DTLSAuthenticateFail is sent when DTLS session establishment has
1794 failed due to an authentication error. When this notification is
1795 received, the FailedDTLSAuthFailCount counter is incremented.
1796
1797 o DTLSAborted is sent to the CAPWAP component to indicate that
1798 session abort (as requested by CAPWAP) is complete; this occurs to
1799 confirm a DTLS session abort or when the WaitDTLS timer expires.
1800 When this notification is received, the WaitDTLS timer is stopped.
1801
1802 o DTLSReassemblyFailure MAY be sent to the CAPWAP component to
1803 indicate DTLS fragment reassembly failure.
1804
1805 o DTLSDecapFailure MAY be sent to the CAPWAP module to indicate a
1806 decapsulation failure. DTLSDecapFailure MAY be sent to the CAPWAP
1807 module to indicate an encryption/authentication failure. This
1808 notification is intended for informative purposes only, and is not
1809 intended to cause a change in the CAPWAP state machine (see
1810 <a href="#section-12.4">Section 12.4</a>).
1811
1812 o DTLSPeerDisconnect is sent to the CAPWAP component to indicate the
1813 DTLS session has been torn down. Note that this notification is
1814 only received if the DTLS session has been established.
1815
1816 <span class="h3"><a class="selflink" id="section-2.4" href="#section-2.4">2.4</a>. Use of DTLS in the CAPWAP Protocol</span>
1817
1818 DTLS is used as a tightly integrated, secure wrapper for the CAPWAP
1819 protocol. In this document, DTLS and CAPWAP are discussed as
1820 nominally distinct entities; however, they are very closely coupled,
1821 and may even be implemented inseparably. Since there are DTLS
1822 library implementations currently available, and since security
1823 protocols (e.g., IPsec, TLS) are often implemented in widely
1824 available acceleration hardware, it is both convenient and forward-
1825 looking to maintain a modular distinction in this document.
1826
1827 This section describes a detailed walk-through of the interactions
1828 between the DTLS module and the CAPWAP module, via 'commands' (CAPWAP
1829 to DTLS) and 'notifications' (DTLS to CAPWAP) as they would be
1830 encountered during the normal course of operation.
1831
1832 <span class="h4"><a class="selflink" id="section-2.4.1" href="#section-2.4.1">2.4.1</a>. DTLS Handshake Processing</span>
1833
1834 Details of the DTLS handshake process are specified in [<a href="./rfc4347" title="&quot;Datagram Transport Layer Security&quot;">RFC4347</a>].
1835 This section describes the interactions between the DTLS session
1836 establishment process and the CAPWAP protocol. Note that the
1837 conceptual DTLS state is shown below to help understand the point at
1838 which the DTLS states transition. In the normal case, the DTLS
1839 handshake will proceed as shown in Figure 5. (NOTE: this example
1840 uses certificates, but pre-shared keys are also supported.)
1841
1842
1843
1844 <span class="grey">Calhoun, et al. Standards Track [Page 33]</span></pre>
1845 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
1846 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1847
1848
1849 ============ ============
1850 WTP AC
1851 ============ ============
1852 ClientHello ------&gt;
1853 &lt;------ HelloVerifyRequest
1854 (with cookie)
1855
1856 ClientHello ------&gt;
1857 (with cookie)
1858 &lt;------ ServerHello
1859 &lt;------ Certificate
1860 &lt;------ ServerHelloDone
1861
1862 (WTP callout for AC authorization
1863 occurs in CAPWAP Auth state)
1864
1865 Certificate*
1866 ClientKeyExchange
1867 CertificateVerify*
1868 ChangeCipherSpec
1869 Finished ------&gt;
1870
1871 (AC callout for WTP authorization
1872 occurs in CAPWAP Auth state)
1873
1874 ChangeCipherSpec
1875 &lt;------ Finished
1876
1877 Figure 5: DTLS Handshake
1878
1879 DTLS, as specified, provides its own retransmit timers with an
1880 exponential back-off. [<a href="./rfc4347" title="&quot;Datagram Transport Layer Security&quot;">RFC4347</a>] does not specify how long
1881 retransmissions should continue. Consequently, timing out incomplete
1882 DTLS handshakes is entirely the responsibility of the CAPWAP module.
1883
1884 The DTLS implementation used by CAPWAP MUST support TLS Session
1885 Resumption. Session resumption is typically used to establish the
1886 DTLS session used for the data channel. Since the data channel uses
1887 different port numbers than the control channel, the DTLS
1888 implementation on the WTP MUST provide an interface that allows the
1889 CAPWAP module to request session resumption despite the use of the
1890 different port numbers (TLS implementations usually attempt session
1891 resumption only when connecting to the same IP address and port
1892 number). Note that session resumption is not guaranteed to occur,
1893 and a full DTLS handshake may occur instead.
1894
1895
1896
1897
1898
1899
1900 <span class="grey">Calhoun, et al. Standards Track [Page 34]</span></pre>
1901 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
1902 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1903
1904
1905 The DTLS implementation used by CAPWAP MUST use replay detection, per
1906 <a href="./rfc4347#section-3.3">Section&nbsp;3.3 of [RFC4347]</a>. Since the CAPWAP protocol handles
1907 retransmissions by re-encrypting lost frames, any duplicate DTLS
1908 frames are either unintentional or malicious and should be silently
1909 discarded.
1910
1911 <span class="h4"><a class="selflink" id="section-2.4.2" href="#section-2.4.2">2.4.2</a>. DTLS Session Establishment</span>
1912
1913 The WTP, either through the Discovery process or through pre-
1914 configuration, determines to which AC to connect. The WTP uses the
1915 DTLSStart command to request that a secure connection be established
1916 to the selected AC. Prior to initiation of the DTLS handshake, the
1917 WTP sets the WaitDTLS timer. Upon invoking the DTLSStart or
1918 DTLSListen commands, the WTP and AC, respectively, set the WaitDTLS
1919 timer. If the DTLSEstablished notification is not received prior to
1920 timer expiration, the DTLS session is aborted by issuing the
1921 DTLSAbortSession DTLS command. This notification causes the CAPWAP
1922 module to transition to the Idle state. Upon receiving a
1923 DTLSEstablished notification, the WaitDTLS timer is deactivated.
1924
1925 <span class="h4"><a class="selflink" id="section-2.4.3" href="#section-2.4.3">2.4.3</a>. DTLS Error Handling</span>
1926
1927 If the AC or WTP does not respond to any DTLS handshake messages sent
1928 by its peer, the DTLS specification calls for the message to be
1929 retransmitted. Note that during the handshake, when both the AC and
1930 the WTP are expecting additional handshake messages, they both
1931 retransmit if an expected message has not been received (note that
1932 retransmissions for CAPWAP Control messages work differently: all
1933 CAPWAP Control messages are either requests or responses, and the
1934 peer who sent the request is responsible for retransmissions).
1935
1936 If the WTP or the AC does not receive an expected DTLS handshake
1937 message despite of retransmissions, the WaitDTLS timer will
1938 eventually expire, and the session will be terminated. This can
1939 happen if communication between the peers has completely failed, or
1940 if one of the peers sent a DTLS Alert message that was lost in
1941 transit (DTLS does not retransmit Alert messages).
1942
1943 If a cookie fails to validate, this could represent a WTP error, or
1944 it could represent a DoS attack. Hence, AC resource utilization
1945 SHOULD be minimized. The AC MAY log a message indicating the
1946 failure, and SHOULD treat the message as though no cookie were
1947 present.
1948
1949 Since DTLS Handshake messages are potentially larger than the maximum
1950 record size, DTLS supports fragmenting of Handshake messages across
1951 multiple records. There are several potential causes of re-assembly
1952
1953
1954
1955
1956 <span class="grey">Calhoun, et al. Standards Track [Page 35]</span></pre>
1957 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
1958 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
1959
1960
1961 errors, including overlapping and/or lost fragments. The DTLS
1962 component MUST send a DTLSReassemblyFailure notification to the
1963 CAPWAP component. Whether precise information is given along with
1964 notification is an implementation issue, and hence is beyond the
1965 scope of this document. Upon receipt of such an error, the CAPWAP
1966 component SHOULD log an appropriate error message. Whether
1967 processing continues or the DTLS session is terminated is
1968 implementation dependent.
1969
1970 DTLS decapsulation errors consist of three types: decryption errors,
1971 authentication errors, and malformed DTLS record headers. Since DTLS
1972 authenticates the data prior to encapsulation, if decryption fails,
1973 it is difficult to detect this without first attempting to
1974 authenticate the packet. If authentication fails, a decryption error
1975 is also likely, but not guaranteed. Rather than attempt to derive
1976 (and require the implementation of) algorithms for detecting
1977 decryption failures, decryption failures are reported as
1978 authentication failures. The DTLS component MUST provide a
1979 DTLSDecapFailure notification to the CAPWAP component when such
1980 errors occur. If a malformed DTLS record header is detected, the
1981 packets SHOULD be silently discarded, and the receiver MAY log an
1982 error message.
1983
1984 There is currently only one encapsulation error defined: MTU
1985 exceeded. As part of DTLS session establishment, the CAPWAP
1986 component informs the DTLS component of the MTU size. This may be
1987 dynamically modified at any time when the CAPWAP component sends the
1988 DTLSMtuUpdate command to the DTLS component (see <a href="#section-2.3.2.1">Section 2.3.2.1</a>).
1989 The value provided to the DTLS stack is the result of the MTU
1990 Discovery process, which is described in <a href="#section-3.5">Section 3.5</a>. The DTLS
1991 component returns this notification to the CAPWAP component whenever
1992 a transmission request will result in a packet that exceeds the MTU.
1993
1994 <span class="h4"><a class="selflink" id="section-2.4.4" href="#section-2.4.4">2.4.4</a>. DTLS Endpoint Authentication and Authorization</span>
1995
1996 DTLS supports endpoint authentication with certificates or pre-shared
1997 keys. The TLS algorithm suites for each endpoint authentication
1998 method are described below.
1999
2000 <span class="h5"><a class="selflink" id="section-2.4.4.1" href="#section-2.4.4.1">2.4.4.1</a>. Authenticating with Certificates</span>
2001
2002 CAPWAP implementations only use cipher suites that are recommended
2003 for use with DTLS, see [<a href="#ref-DTLS-DESIGN" title="&quot;The Design and Implementation of Datagram TLS&quot;">DTLS-DESIGN</a>]. At present, the following
2004 algorithms MUST be supported when using certificates for CAPWAP
2005 authentication:
2006
2007 o TLS_RSA_WITH_AES_128_CBC_SHA [<a href="./rfc5246" title="&quot;The Transport Layer Security (TLS) Protocol Version 1.2&quot;">RFC5246</a>]
2008
2009
2010
2011
2012 <span class="grey">Calhoun, et al. Standards Track [Page 36]</span></pre>
2013 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
2014 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2015
2016
2017 The following algorithms SHOULD be supported when using certificates:
2018
2019 o TLS_DHE_RSA_WITH_AES_128_CBC_SHA [<a href="./rfc5246" title="&quot;The Transport Layer Security (TLS) Protocol Version 1.2&quot;">RFC5246</a>]
2020
2021 The following algorithms MAY be supported when using certificates:
2022
2023 o TLS_RSA_WITH_AES_256_CBC_SHA [<a href="./rfc5246" title="&quot;The Transport Layer Security (TLS) Protocol Version 1.2&quot;">RFC5246</a>]
2024
2025 o TLS_DHE_RSA_WITH_AES_256_CBC_SHA [<a href="./rfc5246" title="&quot;The Transport Layer Security (TLS) Protocol Version 1.2&quot;">RFC5246</a>]
2026
2027 Additional ciphers MAY be defined in subsequent CAPWAP
2028 specifications.
2029
2030 <span class="h5"><a class="selflink" id="section-2.4.4.2" href="#section-2.4.4.2">2.4.4.2</a>. Authenticating with Pre-Shared Keys</span>
2031
2032 Pre-shared keys present significant challenges from a security
2033 perspective, and for that reason, their use is strongly discouraged.
2034 Several methods for authenticating with pre-shared keys are defined
2035 [<a href="./rfc4279" title="&quot;Pre-Shared Key Ciphersuites for Transport Layer Security (TLS)&quot;">RFC4279</a>], and we focus on the following two:
2036
2037 o Pre-Shared Key (PSK) key exchange algorithm - simplest method,
2038 ciphersuites use only symmetric key algorithms.
2039
2040 o DHE_PSK key exchange algorithm - use a PSK to authenticate a
2041 Diffie-Hellman exchange. These ciphersuites give some additional
2042 protection against dictionary attacks and also provide Perfect
2043 Forward Secrecy (PFS).
2044
2045 The first approach (plain PSK) is susceptible to passive dictionary
2046 attacks; hence, while this algorithm MUST be supported, special care
2047 should be taken when choosing that method. In particular, user-
2048 readable passphrases SHOULD NOT be used, and use of short PSKs SHOULD
2049 be strongly discouraged.
2050
2051 The following cryptographic algorithms MUST be supported when using
2052 pre-shared keys:
2053
2054 o TLS_PSK_WITH_AES_128_CBC_SHA [<a href="./rfc5246" title="&quot;The Transport Layer Security (TLS) Protocol Version 1.2&quot;">RFC5246</a>]
2055
2056 o TLS_DHE_PSK_WITH_AES_128_CBC_SHA [<a href="./rfc5246" title="&quot;The Transport Layer Security (TLS) Protocol Version 1.2&quot;">RFC5246</a>]
2057
2058 The following algorithms MAY be supported when using pre-shared keys:
2059
2060 o TLS_PSK_WITH_AES_256_CBC_SHA [<a href="./rfc5246" title="&quot;The Transport Layer Security (TLS) Protocol Version 1.2&quot;">RFC5246</a>]
2061
2062 o TLS_DHE_PSK_WITH_AES_256_CBC_SHA [<a href="./rfc5246" title="&quot;The Transport Layer Security (TLS) Protocol Version 1.2&quot;">RFC5246</a>]
2063
2064 Additional ciphers MAY be defined in following CAPWAP specifications.
2065
2066
2067
2068 <span class="grey">Calhoun, et al. Standards Track [Page 37]</span></pre>
2069 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
2070 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2071
2072
2073 <span class="h5"><a class="selflink" id="section-2.4.4.3" href="#section-2.4.4.3">2.4.4.3</a>. Certificate Usage</span>
2074
2075 Certificate authorization by the AC and WTP is required so that only
2076 an AC may perform the functions of an AC and that only a WTP may
2077 perform the functions of a WTP. This restriction of functions to the
2078 AC or WTP requires that the certificates used by the AC MUST be
2079 distinguishable from the certificate used by the WTP. To accomplish
2080 this differentiation, the x.509 certificates MUST include the
2081 Extended Key Usage (EKU) certificate extension [<a href="./rfc5280" title="&quot;Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile&quot;">RFC5280</a>].
2082
2083 The EKU field indicates one or more purposes for which a certificate
2084 may be used. It is an essential part in authorization. Its syntax
2085 is described in [<a href="./rfc5280" title="&quot;Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile&quot;">RFC5280</a>] and [<a href="#ref-ISO.9834-1.1993" title="&quot;Procedures for the operation of OSI registration authorities - part 1: general procedures&quot;">ISO.9834-1.1993</a>] and is as follows:
2086
2087 ExtKeyUsageSyntax ::= SEQUENCE SIZE (1..MAX) OF KeyPurposeId
2088
2089 KeyPurposeId ::= OBJECT IDENTIFIER
2090
2091 Here we define two KeyPurposeId values, one for the WTP and one for
2092 the AC. Inclusion of one of these two values indicates a certificate
2093 is authorized for use by a WTP or AC, respectively. These values are
2094 formatted as id-kp fields.
2095
2096 id-kp OBJECT IDENTIFIER ::=
2097 { iso(1) identified-organization(3) dod(6) internet(1)
2098 security(5) mechanisms(5) pkix(7) 3 }
2099
2100 id-kp-capwapAC OBJECT IDENTIFIER ::= { id-kp 18 }
2101
2102 id-kp-capwapWTP OBJECT IDENTIFIER ::= { id-kp 19 }
2103
2104 All capwap devices MUST support the ExtendedKeyUsage certificate
2105 extension if it is present in a certificate. If the extension is
2106 present, then the certificate MUST have either the id-kp-capwapAC or
2107 the id-kp-anyExtendedKeyUsage keyPurposeID to act as an AC.
2108 Similarly, if the extension is present, a device MUST have the id-kp-
2109 capwapWTP or id-kp-anyExtendedKeyUsage keyPurposeID to act as a WTP.
2110
2111 Part of the CAPWAP certificate validation process includes ensuring
2112 that the proper EKU is included and allowing the CAPWAP session to be
2113 established only if the extension properly represents the device.
2114 For instance, an AC SHOULD NOT accept a connection request from
2115 another AC, and therefore MUST verify that the id-kp-capwapWTP EKU is
2116 present in the certificate.
2117
2118 CAPWAP implementations MUST support certificates where the common
2119 name (CN) for both the WTP and AC is the MAC address of that device.
2120
2121
2122
2123
2124 <span class="grey">Calhoun, et al. Standards Track [Page 38]</span></pre>
2125 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
2126 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2127
2128
2129 The MAC address MUST be encoded in the PrintableString format, using
2130 the well-recognized MAC address format of 01:23:45:67:89:ab. The CN
2131 field MAY contain either of the EUI-48 [<a href="#ref-EUI-48" title="&quot;Guidelines for use of a 48-bit Extended Unique Identifier&quot;">EUI-48</a>] or EUI-64 [<a href="#ref-EUI-64" title="&quot;GUIDELINES FOR 64-BIT GLOBAL IDENTIFIER (EUI-64) REGISTRATION AUTHORITY&quot;">EUI-64</a>]
2132 MAC Address formats. This seemingly unconventional use of the CN
2133 field is consistent with other standards that rely on device
2134 certificates that are provisioned during the manufacturing process,
2135 such as Packet Cable [<a href="#ref-PacketCable" title="&quot;PacketCable Security Specification PKT-SP-SEC- I12-050812&quot;">PacketCable</a>], Cable Labs [<a href="#ref-CableLabs" title="&quot;OpenCable System Security Specification OC-SP- SEC-I07-061031&quot;">CableLabs</a>], and WiMAX
2136 [<a href="#ref-WiMAX" title="&quot;WiMAX Forum X.509 Device Certificate Profile Approved Specification V1.0.1&quot;">WiMAX</a>]. See <a href="#section-12.8">Section 12.8</a> for more information on the use of the MAC
2137 address in the CN field.
2138
2139 ACs and WTPs MUST authorize (e.g., through access control lists)
2140 certificates of devices to which they are connecting, e.g., based on
2141 the issuer, MAC address, or organizational information specified in
2142 the certificate. The identities specified in the certificates bind a
2143 particular DTLS session to a specific pair of mutually authenticated
2144 and authorized MAC addresses. The particulars of authorization
2145 filter construction are implementation details which are, for the
2146 most part, not within the scope of this specification. However, at
2147 minimum, all devices MUST verify that the appropriate EKU bit is set
2148 according to the role of the peer device (AC versus WTP), and that
2149 the issuer of the certificate is appropriate for the domain in
2150 question.
2151
2152 <span class="h5"><a class="selflink" id="section-2.4.4.4" href="#section-2.4.4.4">2.4.4.4</a>. PSK Usage</span>
2153
2154 When DTLS uses PSK Ciphersuites, the ServerKeyExchange message MUST
2155 contain the "PSK identity hint" field and the ClientKeyExchange
2156 message MUST contain the "PSK identity" field. These fields are used
2157 to help the WTP select the appropriate PSK for use with the AC, and
2158 then indicate to the AC which key is being used. When PSKs are
2159 provisioned to WTPs and ACs, both the PSK Hint and PSK Identity for
2160 the key MUST be specified.
2161
2162 The PSK Hint SHOULD uniquely identify the AC and the PSK Identity
2163 SHOULD uniquely identify the WTP. It is RECOMMENDED that these hints
2164 and identities be the ASCII HEX-formatted MAC addresses of the
2165 respective devices, since each pairwise combination of WTP and AC
2166 SHOULD have a unique PSK. The PSK Hint and Identity SHOULD be
2167 sufficient to perform authorization, as simply having knowledge of a
2168 PSK does not necessarily imply authorization.
2169
2170 If a single PSK is being used for multiple devices on a CAPWAP
2171 network, which is NOT RECOMMENDED, the PSK Hint and Identity can no
2172 longer be a MAC address, so appropriate hints and identities SHOULD
2173 be selected to identify the group of devices to which the PSK is
2174 provisioned.
2175
2176
2177
2178
2179
2180 <span class="grey">Calhoun, et al. Standards Track [Page 39]</span></pre>
2181 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
2182 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2183
2184
2185 <span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. CAPWAP Transport</span>
2186
2187 Communication between a WTP and an AC is established using the
2188 standard UDP client/server model. The CAPWAP protocol supports both
2189 UDP and UDP-Lite [<a href="./rfc3828" title="&quot;The Lightweight User Datagram Protocol (UDP-Lite)&quot;">RFC3828</a>] transport protocols. When run over IPv4,
2190 UDP is used for the CAPWAP Control and Data channels.
2191
2192 When run over IPv6, the CAPWAP Control channel always uses UDP, while
2193 the CAPWAP Data channel may use either UDP or UDP-Lite. UDP-Lite is
2194 the default transport protocol for the CAPWAP Data channel. However,
2195 if a middlebox or IPv4 to IPv6 gateway has been discovered, UDP is
2196 used for the CAPWAP Data channel.
2197
2198 This section describes how the CAPWAP protocol is carried over IP and
2199 UDP/UDP-Lite transport protocols. The CAPWAP Transport Protocol
2200 message element, <a href="#section-4.6.14">Section 4.6.14</a>, describes the rules to use in
2201 determining which transport protocol is to be used.
2202
2203 In order for CAPWAP to be compatible with potential middleboxes in
2204 the network, CAPWAP implementations MUST send return traffic from the
2205 same port on which they received traffic from a given peer. Further,
2206 any unsolicited requests generated by a CAPWAP node MUST be sent on
2207 the same port.
2208
2209 <span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. UDP Transport</span>
2210
2211 One of the CAPWAP protocol requirements is to allow a WTP to reside
2212 behind a middlebox, firewall, and/or Network Address Translation
2213 (NAT) device. Since a CAPWAP session is initiated by the WTP
2214 (client) to the well-known UDP port of the AC (server), the use of
2215 UDP is a logical choice. When CAPWAP is run over IPv4, the UDP
2216 checksum field in CAPWAP packets MUST be set to zero.
2217
2218 CAPWAP protocol control packets sent from the WTP to the AC use the
2219 CAPWAP Control channel, as defined in <a href="#section-1.4">Section 1.4</a>. The CAPWAP
2220 control port at the AC is the well-known UDP port 5246. The CAPWAP
2221 control port at the WTP can be any port selected by the WTP.
2222
2223 CAPWAP protocol data packets sent from the WTP to the AC use the
2224 CAPWAP Data channel, as defined in <a href="#section-1.4">Section 1.4</a>. The CAPWAP data port
2225 at the AC is the well-known UDP port 5247. If an AC permits the
2226 administrator to change the CAPWAP control port, the CAPWAP data port
2227 MUST be the next consecutive port number. The CAPWAP data port at
2228 the WTP can be any port selected by the WTP.
2229
2230
2231
2232
2233
2234
2235
2236 <span class="grey">Calhoun, et al. Standards Track [Page 40]</span></pre>
2237 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
2238 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2239
2240
2241 <span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. UDP-Lite Transport</span>
2242
2243 When CAPWAP is run over IPv6, UDP-Lite is the default transport
2244 protocol, which reduces the checksum processing required for each
2245 packet (compared to the use of UDP over IPv6 [<a href="./rfc2460" title="&quot;Internet Protocol, Version 6 (IPv6) Specification&quot;">RFC2460</a>]). When UDP-
2246 Lite is used, the checksum field MUST have a coverage of 8 [<a href="./rfc3828" title="&quot;The Lightweight User Datagram Protocol (UDP-Lite)&quot;">RFC3828</a>].
2247
2248 UDP-Lite uses the same port assignments as UDP.
2249
2250 <span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>. AC Discovery</span>
2251
2252 The AC Discovery phase allows the WTP to determine which ACs are
2253 available and choose the best AC with which to establish a CAPWAP
2254 session. The Discovery phase occurs when the WTP enters the optional
2255 Discovery state. A WTP does not need to complete the AC Discovery
2256 phase if it uses a pre-configured AC. This section details the
2257 mechanism used by a WTP to dynamically discover candidate ACs.
2258
2259 A WTP and an AC will frequently not reside in the same IP subnet
2260 (broadcast domain). When this occurs, the WTP must be capable of
2261 discovering the AC, without requiring that multicast services are
2262 enabled in the network.
2263
2264 When the WTP attempts to establish communication with an AC, it sends
2265 the Discovery Request message and receives the Discovery Response
2266 message from the AC(s). The WTP MUST send the Discovery Request
2267 message to either the limited broadcast IP address (255.255.255.255),
2268 the well-known CAPWAP multicast address (224.0.1.140), or to the
2269 unicast IP address of the AC. For IPv6 networks, since broadcast
2270 does not exist, the use of "All ACs multicast address" (FF0X:0:0:0:0:
2271 0:0:18C) is used instead. Upon receipt of the Discovery Request
2272 message, the AC sends a Discovery Response message to the unicast IP
2273 address of the WTP, regardless of whether the Discovery Request
2274 message was sent as a broadcast, multicast, or unicast message.
2275
2276 WTP use of a limited IP broadcast, multicast, or unicast IP address
2277 is implementation dependent. ACs, on the other hand, MUST support
2278 broadcast, multicast, and unicast discovery.
2279
2280 When a WTP transmits a Discovery Request message to a unicast
2281 address, the WTP must first obtain the IP address of the AC. Any
2282 static configuration of an AC's IP address on the WTP non-volatile
2283 storage is implementation dependent. However, additional dynamic
2284 schemes are possible, for example:
2285
2286
2287
2288
2289
2290
2291
2292 <span class="grey">Calhoun, et al. Standards Track [Page 41]</span></pre>
2293 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
2294 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2295
2296
2297 DHCP: See [<a href="./rfc5417" title="&quot;Control And Provisioning of Wireless Access Points (CAPWAP) Access Controller DHCP Option&quot;">RFC5417</a>] for more information on the use of DHCP to
2298 discover AC IP addresses.
2299
2300 DNS: The WTP MAY support use of DNS Service Records (SRVs) [<a href="./rfc2782" title="&quot;A DNS RR for specifying the location of services (DNS SRV)&quot;">RFC2782</a>]
2301 to discover the AC address(es). In this case, the WTP first
2302 obtains (e.g., from local configuration) the correct domain name
2303 suffix (e.g., "example.com") and performs an SRV lookup with
2304 Service name "capwap-control" and Proto "udp". Thus, the name
2305 resolved in DNS would be, e.g., "_capwap-
2306 control._udp.example.com". Note that the SRV record MAY specify a
2307 non-default port number for the control channel; the port number
2308 for the data channel is the next port number (control channel port
2309 + 1).
2310
2311 An AC MAY also communicate alternative ACs to the WTP within the
2312 Discovery Response message through the AC IPv4 List (see
2313 <a href="#section-4.6.2">Section 4.6.2</a>) and AC IPv6 List (see <a href="#section-4.6.2">Section 4.6.2</a>). The addresses
2314 provided in these two message elements are intended to help the WTP
2315 discover additional ACs through means other than those listed above.
2316
2317 The AC Name with Priority message element (see <a href="#section-4.6.5">Section 4.6.5</a>) is used
2318 to communicate a list of preferred ACs to the WTP. The WTP SHOULD
2319 attempt to utilize the ACs listed in the order provided by the AC.
2320 The Name-to-IP Address mapping is handled via the Discovery message
2321 exchange, in which the ACs provide their identity in the AC Name (see
2322 <a href="#section-4.6.4">Section 4.6.4</a>) message element in the Discovery Response message.
2323
2324 Once the WTP has received Discovery Response messages from the
2325 candidate ACs, it MAY use other factors to determine the preferred
2326 AC. For instance, each binding defines a WTP Radio Information
2327 message element (see <a href="#section-2.1">Section 2.1</a>), which the AC includes in Discovery
2328 Response messages. The presence of one or more of these message
2329 elements is used to identify the CAPWAP bindings supported by the AC.
2330 A WTP MAY connect to an AC based on the supported bindings
2331 advertised.
2332
2333 <span class="h3"><a class="selflink" id="section-3.4" href="#section-3.4">3.4</a>. Fragmentation/Reassembly</span>
2334
2335 While fragmentation and reassembly services are provided by IP, the
2336 CAPWAP protocol also provides such services. Environments where the
2337 CAPWAP protocol is used involve firewall, NAT, and "middlebox"
2338 devices, which tend to drop IP fragments to minimize possible DoS
2339 attacks. By providing fragmentation and reassembly at the
2340 application layer, any fragmentation required due to the tunneling
2341 component of the CAPWAP protocol becomes transparent to these
2342 intermediate devices. Consequently, the CAPWAP protocol can be used
2343 in any network topology including firewall, NAT, and middlebox
2344 devices.
2345
2346
2347
2348 <span class="grey">Calhoun, et al. Standards Track [Page 42]</span></pre>
2349 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
2350 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2351
2352
2353 It is important to note that the fragmentation mechanism employed by
2354 CAPWAP has known limitations and deficiencies, which are similar to
2355 those described in [<a href="./rfc4963" title="&quot;IPv4 Reassembly Errors at High Data Rates&quot;">RFC4963</a>]. The limited size of the Fragment ID
2356 field (see <a href="#section-4.3">Section 4.3</a>) can cause wrapping of the field, and hence
2357 cause fragments from different datagrams to be incorrectly spliced
2358 together (known as "mis-associated"). For example, a 100Mpbs link
2359 with an MTU of 1500 (causing fragmentation at 1450 bytes) would cause
2360 the Fragment ID field wrap in 8 seconds. Consequently, CAPWAP
2361 implementers are warned to properly size their buffers for reassembly
2362 purposes based on the expected wireless technology throughput.
2363
2364 CAPWAP implementations SHOULD perform MTU Discovery (see
2365 <a href="#section-3.5">Section 3.5</a>), which can avoid the need for fragmentation. At the
2366 time of writing of this specification, most enterprise switching and
2367 routing infrastructure were capable of supporting "mini-jumbo" frames
2368 (1800 bytes), which eliminates the need for fragmentation (assuming
2369 the station's MTU is 1500 bytes). The need for fragmentation
2370 typically continues to exist when the WTP communicates with the AC
2371 over a Wide Area Network (WAN). Therefore, future versions of the
2372 CAPWAP protocol SHOULD consider either increasing the size of the
2373 Fragment ID field or providing alternative extensions.
2374
2375 <span class="h3"><a class="selflink" id="section-3.5" href="#section-3.5">3.5</a>. MTU Discovery</span>
2376
2377 Once a WTP has discovered the AC with which it wishes to establish a
2378 CAPWAP session, it SHOULD perform a Path MTU (PMTU) discovery. One
2379 recommendation for performing PMTU discovery is to have the WTP
2380 transmit Discovery Request (see <a href="#section-5.1">Section 5.1</a>) messages, and include
2381 the MTU Discovery Padding message element (see <a href="#section-4.6.32">Section 4.6.32</a>). The
2382 actual procedures used for PMTU discovery are described in [<a href="./rfc1191" title="&quot;Path MTU discovery&quot;">RFC1191</a>]
2383 for IPv4; for IPv6, [<a href="./rfc1981" title="&quot;Path MTU Discovery for IP version 6&quot;">RFC1981</a>] SHOULD be used. Alternatively,
2384 implementers MAY use the procedures defined in [<a href="./rfc4821" title="&quot;Packetization Layer Path MTU Discovery&quot;">RFC4821</a>]. The WTP
2385 SHOULD also periodically re-evaluate the PMTU using the guidelines
2386 provided in these two RFCs, using the Primary Discovery Request (see
2387 <a href="#section-5.3">Section 5.3</a>) along with the MTU Discovery Padding message element
2388 (see <a href="#section-4.6.32">Section 4.6.32</a>). When the MTU is initially known, or updated in
2389 the case where an existing session already exists, the discovered
2390 PMTU is used to configure the DTLS component (see <a href="#section-2.3.2.1">Section 2.3.2.1</a>),
2391 while non-DTLS frames need to be fragmented to fit the MTU, defined
2392 in <a href="#section-3.4">Section 3.4</a>.
2393
2394 <span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. CAPWAP Packet Formats</span>
2395
2396 This section contains the CAPWAP protocol packet formats. A CAPWAP
2397 protocol packet consists of one or more CAPWAP Transport Layer packet
2398 headers followed by a CAPWAP message. The CAPWAP message can be
2399 either of type Control or Data, where Control packets carry
2400
2401
2402
2403
2404 <span class="grey">Calhoun, et al. Standards Track [Page 43]</span></pre>
2405 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
2406 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2407
2408
2409 signaling, and Data packets carry user payloads. The CAPWAP frame
2410 formats for CAPWAP Data packets, and for DTLS encapsulated CAPWAP
2411 Data and Control packets are defined below.
2412
2413 The CAPWAP Control protocol includes two messages that are never
2414 protected by DTLS: the Discovery Request message and the Discovery
2415 Response message. These messages need to be in the clear to allow
2416 the CAPWAP protocol to properly identify and process them. The
2417 format of these packets are as follows:
2418
2419 CAPWAP Control Packet (Discovery Request/Response):
2420 +-------------------------------------------+
2421 | IP | UDP | CAPWAP | Control | Message |
2422 | Hdr | Hdr | Header | Header | Element(s) |
2423 +-------------------------------------------+
2424
2425 All other CAPWAP Control protocol messages MUST be protected via the
2426 DTLS protocol, which ensures that the packets are both authenticated
2427 and encrypted. These packets include the CAPWAP DTLS Header, which
2428 is described in <a href="#section-4.2">Section 4.2</a>. The format of these packets is as
2429 follows:
2430
2431 CAPWAP Control Packet (DTLS Security Required):
2432 +------------------------------------------------------------------+
2433 | IP | UDP | CAPWAP | DTLS | CAPWAP | Control| Message | DTLS |
2434 | Hdr | Hdr | DTLS Hdr | Hdr | Header | Header | Element(s)| Trlr |
2435 +------------------------------------------------------------------+
2436 \---------- authenticated -----------/
2437 \------------- encrypted ------------/
2438
2439 The CAPWAP protocol allows optional protection of data packets, using
2440 DTLS. Use of data packet protection is determined by AC policy.
2441 When DTLS is utilized, the optional CAPWAP DTLS Header is present,
2442 which is described in <a href="#section-4.2">Section 4.2</a>. The format of CAPWAP Data packets
2443 is shown below:
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460 <span class="grey">Calhoun, et al. Standards Track [Page 44]</span></pre>
2461 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
2462 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2463
2464
2465 CAPWAP Plain Text Data Packet :
2466 +-------------------------------+
2467 | IP | UDP | CAPWAP | Wireless |
2468 | Hdr | Hdr | Header | Payload |
2469 +-------------------------------+
2470
2471 DTLS Secured CAPWAP Data Packet:
2472 +--------------------------------------------------------+
2473 | IP | UDP | CAPWAP | DTLS | CAPWAP | Wireless | DTLS |
2474 | Hdr | Hdr | DTLS Hdr | Hdr | Hdr | Payload | Trlr |
2475 +--------------------------------------------------------+
2476 \------ authenticated -----/
2477 \------- encrypted --------/
2478
2479 UDP Header: All CAPWAP packets are encapsulated within either UDP,
2480 or UDP-Lite when used over IPv6. <a href="#section-3">Section 3</a> defines the specific
2481 UDP or UDP-Lite usage.
2482
2483 CAPWAP DTLS Header: All DTLS encrypted CAPWAP protocol packets are
2484 prefixed with the CAPWAP DTLS Header (see <a href="#section-4.2">Section 4.2</a>).
2485
2486 DTLS Header: The DTLS Header provides authentication and encryption
2487 services to the CAPWAP payload it encapsulates. This protocol is
2488 defined in [<a href="./rfc4347" title="&quot;Datagram Transport Layer Security&quot;">RFC4347</a>].
2489
2490 CAPWAP Header: All CAPWAP protocol packets use a common header that
2491 immediately follows the CAPWAP preamble or DTLS Header. The
2492 CAPWAP Header is defined in <a href="#section-4.3">Section 4.3</a>.
2493
2494 Wireless Payload: A CAPWAP protocol packet that contains a wireless
2495 payload is a CAPWAP Data packet. The CAPWAP protocol does not
2496 specify the format of the wireless payload, which is defined by
2497 the appropriate wireless standard. Additional information is in
2498 <a href="#section-4.4">Section 4.4</a>.
2499
2500 Control Header: The CAPWAP protocol includes a signaling component,
2501 known as the CAPWAP Control protocol. All CAPWAP Control packets
2502 include a Control Header, which is defined in <a href="#section-4.5.1">Section 4.5.1</a>.
2503 CAPWAP Data packets do not contain a Control Header field.
2504
2505 Message Elements: A CAPWAP Control packet includes one or more
2506 message elements, which are found immediately following the
2507 Control Header. These message elements are in a Type/Length/Value
2508 style header, defined in <a href="#section-4.6">Section 4.6</a>.
2509
2510 A CAPWAP implementation MUST be capable of receiving a reassembled
2511 CAPWAP message of length 4096 bytes. A CAPWAP implementation MAY
2512 indicate that it supports a higher maximum message length, by
2513
2514
2515
2516 <span class="grey">Calhoun, et al. Standards Track [Page 45]</span></pre>
2517 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
2518 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2519
2520
2521 including the Maximum Message Length message element, see
2522 <a href="#section-4.6.31">Section 4.6.31</a>, in the Join Request message or the Join Response
2523 message.
2524
2525 <span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. CAPWAP Preamble</span>
2526
2527 The CAPWAP preamble is common to all CAPWAP transport headers and is
2528 used to identify the header type that immediately follows. The
2529 reason for this preamble is to avoid needing to perform byte
2530 comparisons in order to guess whether or not the frame is DTLS
2531 encrypted. It also provides an extensibility framework that can be
2532 used to support additional transport types. The format of the
2533 preamble is as follows:
2534
2535 0
2536 0 1 2 3 4 5 6 7
2537 +-+-+-+-+-+-+-+-+
2538 |Version| Type |
2539 +-+-+-+-+-+-+-+-+
2540
2541 Version: A 4-bit field that contains the version of CAPWAP used in
2542 this packet. The value for this specification is zero (0).
2543
2544 Type: A 4-bit field that specifies the payload type that follows the
2545 UDP header. The following values are supported:
2546
2547 0 - CAPWAP Header. The CAPWAP Header (see <a href="#section-4.3">Section 4.3</a>)
2548 immediately follows the UDP header. If the packet is
2549 received on the CAPWAP Data channel, the CAPWAP stack MUST
2550 treat the packet as a clear text CAPWAP Data packet. If
2551 received on the CAPWAP Control channel, the CAPWAP stack
2552 MUST treat the packet as a clear text CAPWAP Control packet.
2553 If the control packet is not a Discovery Request or
2554 Discovery Response packet, the packet MUST be dropped.
2555
2556 1 - CAPWAP DTLS Header. The CAPWAP DTLS Header (and DTLS
2557 packet) immediately follows the UDP header (see
2558 <a href="#section-4.2">Section 4.2</a>).
2559
2560 <span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. CAPWAP DTLS Header</span>
2561
2562 The CAPWAP DTLS Header is used to identify the packet as a DTLS
2563 encrypted packet. The first eight bits include the common CAPWAP
2564 Preamble. The remaining 24 bits are padding to ensure 4-byte
2565 alignment, and MAY be used in a future version of the protocol. The
2566 DTLS packet [<a href="./rfc4347" title="&quot;Datagram Transport Layer Security&quot;">RFC4347</a>] always immediately follows this header. The
2567 format of the CAPWAP DTLS Header is as follows:
2568
2569
2570
2571
2572 <span class="grey">Calhoun, et al. Standards Track [Page 46]</span></pre>
2573 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
2574 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2575
2576
2577 0 1 2 3
2578 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
2579 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2580 |CAPWAP Preamble| Reserved |
2581 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2582
2583 CAPWAP Preamble: The CAPWAP Preamble is defined in <a href="#section-4.1">Section 4.1</a>. The
2584 CAPWAP Preamble's Payload Type field MUST be set to one (1).
2585
2586 Reserved: The 24-bit field is reserved for future use. All
2587 implementations complying with this protocol MUST set to zero any
2588 bits that are reserved in the version of the protocol supported by
2589 that implementation. Receivers MUST ignore all bits not defined
2590 for the version of the protocol they support.
2591
2592 <span class="h3"><a class="selflink" id="section-4.3" href="#section-4.3">4.3</a>. CAPWAP Header</span>
2593
2594 All CAPWAP protocol messages are encapsulated using a common header
2595 format, regardless of the CAPWAP Control or CAPWAP Data transport
2596 used to carry the messages. However, certain flags are not
2597 applicable for a given transport. Refer to the specific transport
2598 section in order to determine which flags are valid.
2599
2600 Note that the optional fields defined in this section MUST be present
2601 in the precise order shown below.
2602
2603 0 1 2 3
2604 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
2605 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2606 |CAPWAP Preamble| HLEN | RID | WBID |T|F|L|W|M|K|Flags|
2607 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2608 | Fragment ID | Frag Offset |Rsvd |
2609 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2610 | (optional) Radio MAC Address |
2611 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2612 | (optional) Wireless Specific Information |
2613 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2614 | Payload .... |
2615 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2616
2617 CAPWAP Preamble: The CAPWAP Preamble is defined in <a href="#section-4.1">Section 4.1</a>. The
2618 CAPWAP Preamble's Payload Type field MUST be set to zero (0). If
2619 the CAPWAP DTLS Header is present, the version number in both
2620 CAPWAP Preambles MUST match. The reason for this duplicate field
2621 is to avoid any possible tampering of the version field in the
2622 preamble that is not encrypted or authenticated.
2623
2624
2625
2626
2627
2628 <span class="grey">Calhoun, et al. Standards Track [Page 47]</span></pre>
2629 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
2630 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2631
2632
2633 HLEN: A 5-bit field containing the length of the CAPWAP transport
2634 header in 4-byte words (similar to IP header length). This length
2635 includes the optional headers.
2636
2637 RID: A 5-bit field that contains the Radio ID number for this
2638 packet, whose value is between one (1) and 31. Given that MAC
2639 Addresses are not necessarily unique across physical radios in a
2640 WTP, the Radio Identifier (RID) field is used to indicate with
2641 which physical radio the message is associated.
2642
2643 WBID: A 5-bit field that is the wireless binding identifier. The
2644 identifier will indicate the type of wireless packet associated
2645 with the radio. The following values are defined:
2646
2647 0 - Reserved
2648
2649 1 - IEEE 802.11
2650
2651 2 - Reserved
2652
2653 3 - EPCGlobal [<a href="#ref-EPCGlobal" title="&quot;See http://www.epcglobalinc.org/home&quot;">EPCGlobal</a>]
2654
2655 T: The Type 'T' bit indicates the format of the frame being
2656 transported in the payload. When this bit is set to one (1), the
2657 payload has the native frame format indicated by the WBID field.
2658 When this bit is zero (0), the payload is an IEEE 802.3 frame.
2659
2660 F: The Fragment 'F' bit indicates whether this packet is a fragment.
2661 When this bit is one (1), the packet is a fragment and MUST be
2662 combined with the other corresponding fragments to reassemble the
2663 complete information exchanged between the WTP and AC.
2664
2665 L: The Last 'L' bit is valid only if the 'F' bit is set and indicates
2666 whether the packet contains the last fragment of a fragmented
2667 exchange between WTP and AC. When this bit is one (1), the packet
2668 is the last fragment. When this bit is (zero) 0, the packet is
2669 not the last fragment.
2670
2671 W: The Wireless 'W' bit is used to specify whether the optional
2672 Wireless Specific Information field is present in the header. A
2673 value of one (1) is used to represent the fact that the optional
2674 header is present.
2675
2676 M: The Radio MAC 'M' bit is used to indicate that the Radio MAC
2677 Address optional header is present. This is used to communicate
2678 the MAC address of the receiving radio.
2679
2680
2681
2682
2683
2684 <span class="grey">Calhoun, et al. Standards Track [Page 48]</span></pre>
2685 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span>
2686 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2687
2688
2689 K: The Keep-Alive 'K' bit indicates the packet is a Data Channel
2690 Keep-Alive packet. This packet is used to map the data channel to
2691 the control channel for the specified Session ID and to maintain
2692 freshness of the data channel. The 'K' bit MUST NOT be set for
2693 data packets containing user data.
2694
2695 Flags: A set of reserved bits for future flags in the CAPWAP Header.
2696 All implementations complying with this protocol MUST set to zero
2697 any bits that are reserved in the version of the protocol
2698 supported by that implementation. Receivers MUST ignore all bits
2699 not defined for the version of the protocol they support.
2700
2701 Fragment ID: A 16-bit field whose value is assigned to each group of
2702 fragments making up a complete set. The Fragment ID space is
2703 managed individually for each direction for every WTP/AC pair.
2704 The value of Fragment ID is incremented with each new set of
2705 fragments. The Fragment ID wraps to zero after the maximum value
2706 has been used to identify a set of fragments.
2707
2708 Fragment Offset: A 13-bit field that indicates where in the payload
2709 this fragment belongs during re-assembly. This field is valid
2710 when the 'F' bit is set to 1. The fragment offset is measured in
2711 units of 8 octets (64 bits). The first fragment has offset zero.
2712 Note that the CAPWAP protocol does not allow for overlapping
2713 fragments.
2714
2715 Reserved: The 3-bit field is reserved for future use. All
2716 implementations complying with this protocol MUST set to zero any
2717 bits that are reserved in the version of the protocol supported by
2718 that implementation. Receivers MUST ignore all bits not defined
2719 for the version of the protocol they support.
2720
2721 Radio MAC Address: This optional field contains the MAC address of
2722 the radio receiving the packet. Because the native wireless frame
2723 format to IEEE 802.3 format causes the MAC address of the WTP's
2724 radio to be lost, this field allows the address to be communicated
2725 to the AC. This field is only present if the 'M' bit is set. The
2726 HLEN field assumes 4-byte alignment, and this field MUST be padded
2727 with zeroes (0x00) if it is not 4-byte aligned.
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740 <span class="grey">Calhoun, et al. Standards Track [Page 49]</span></pre>
2741 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span>
2742 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2743
2744
2745 The field contains the basic format:
2746
2747 0 1 2 3
2748 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
2749 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2750 | Length | MAC Address
2751 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2752
2753 Length: The length of the MAC address field. The formats and
2754 lengths specified in [<a href="#ref-EUI-48" title="&quot;Guidelines for use of a 48-bit Extended Unique Identifier&quot;">EUI-48</a>] and [<a href="#ref-EUI-64" title="&quot;GUIDELINES FOR 64-BIT GLOBAL IDENTIFIER (EUI-64) REGISTRATION AUTHORITY&quot;">EUI-64</a>] are supported.
2755
2756 MAC Address: The MAC address of the receiving radio.
2757
2758 Wireless Specific Information: This optional field contains
2759 technology-specific information that may be used to carry per-
2760 packet wireless information. This field is only present if the
2761 'W' bit is set. The WBID field in the CAPWAP Header is used to
2762 identify the format of the Wireless-Specific Information optional
2763 field. The HLEN field assumes 4-byte alignment, and this field
2764 MUST be padded with zeroes (0x00) if it is not 4-byte aligned.
2765
2766 The Wireless-Specific Information field uses the following format:
2767
2768 0 1 2 3
2769 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
2770 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2771 | Length | Data...
2772 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2773
2774 Length: The 8-bit field contains the length of the data field,
2775 with a maximum size of 255.
2776
2777 Data: Wireless-specific information, defined by the wireless-
2778 specific binding specified in the CAPWAP Header's WBID field.
2779
2780 Payload: This field contains the header for a CAPWAP Data Message or
2781 CAPWAP Control Message, followed by the data contained in the
2782 message.
2783
2784 <span class="h3"><a class="selflink" id="section-4.4" href="#section-4.4">4.4</a>. CAPWAP Data Messages</span>
2785
2786 There are two different types of CAPWAP Data packets: CAPWAP Data
2787 Channel Keep-Alive packets and Data Payload packets. The first is
2788 used by the WTP to synchronize the control and data channels and to
2789 maintain freshness of the data channel. The second is used to
2790 transmit user payloads between the AC and WTP. This section
2791 describes both types of CAPWAP Data packet formats.
2792
2793
2794
2795
2796 <span class="grey">Calhoun, et al. Standards Track [Page 50]</span></pre>
2797 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span>
2798 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2799
2800
2801 Both CAPWAP Data messages are transmitted on the CAPWAP Data channel.
2802
2803 <span class="h4"><a class="selflink" id="section-4.4.1" href="#section-4.4.1">4.4.1</a>. CAPWAP Data Channel Keep-Alive</span>
2804
2805 The CAPWAP Data Channel Keep-Alive packet is used to bind the CAPWAP
2806 control channel with the data channel, and to maintain freshness of
2807 the data channel, ensuring that the channel is still functioning.
2808 The CAPWAP Data Channel Keep-Alive packet is transmitted by the WTP
2809 when the DataChannelKeepAlive timer expires (see <a href="#section-4.7.2">Section 4.7.2</a>).
2810 When the CAPWAP Data Channel Keep-Alive packet is transmitted, the
2811 WTP sets the DataChannelDeadInterval timer.
2812
2813 In the CAPWAP Data Channel Keep-Alive packet, all of the fields in
2814 the CAPWAP Header, except the HLEN field and the 'K' bit, are set to
2815 zero upon transmission. Upon receiving a CAPWAP Data Channel Keep-
2816 Alive packet, the AC transmits a CAPWAP Data Channel Keep-Alive
2817 packet back to the WTP. The contents of the transmitted packet are
2818 identical to the contents of the received packet.
2819
2820 Upon receiving a CAPWAP Data Channel Keep-Alive packet, the WTP
2821 cancels the DataChannelDeadInterval timer and resets the
2822 DataChannelKeepAlive timer. The CAPWAP Data Channel Keep-Alive
2823 packet is retransmitted by the WTP in the same manner as the CAPWAP
2824 Control messages. If the DataChannelDeadInterval timer expires, the
2825 WTP tears down the control DTLS session, and the data DTLS session if
2826 one existed.
2827
2828 The CAPWAP Data Channel Keep-Alive packet contains the following
2829 payload immediately following the CAPWAP Header (see <a href="#section-4.3">Section 4.3</a>).
2830
2831 0 1 2 3
2832 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
2833 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2834 | Message Element Length | Message Element [0..N] ...
2835 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2836
2837 Message Element Length: The 16-bit Length field indicates the
2838 number of bytes following the CAPWAP Header, with a maximum size
2839 of 65535.
2840
2841 Message Element[0..N]: The message element(s) carry the information
2842 pertinent to each of the CAPWAP Data Channel Keep-Alive message.
2843 The following message elements MUST be present in this CAPWAP
2844 message:
2845
2846 Session ID, see <a href="#section-4.6.37">Section 4.6.37</a>.
2847
2848
2849
2850
2851
2852 <span class="grey">Calhoun, et al. Standards Track [Page 51]</span></pre>
2853 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span>
2854 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2855
2856
2857 <span class="h4"><a class="selflink" id="section-4.4.2" href="#section-4.4.2">4.4.2</a>. Data Payload</span>
2858
2859 A CAPWAP protocol Data Payload packet encapsulates a forwarded
2860 wireless frame. The CAPWAP protocol defines two different modes of
2861 encapsulation: IEEE 802.3 and native wireless. IEEE 802.3
2862 encapsulation requires that for 802.11 frames, the 802.11
2863 *Integration* function be performed in the WTP. An IEEE 802.3-
2864 encapsulated user payload frame has the following format:
2865
2866 +------------------------------------------------------+
2867 | IP Header | UDP Header | CAPWAP Header | 802.3 Frame |
2868 +------------------------------------------------------+
2869
2870 The CAPWAP protocol also defines the native wireless encapsulation
2871 mode. The format of the encapsulated CAPWAP Data frame is subject to
2872 the rules defined by the specific wireless technology binding. Each
2873 wireless technology binding MUST contain a section entitled "Payload
2874 Encapsulation", which defines the format of the wireless payload that
2875 is encapsulated within CAPWAP Data packets.
2876
2877 For 802.3 payload frames, the 802.3 frame is encapsulated (excluding
2878 the IEEE 802.3 Preamble, Start Frame Delimiter (SFD), and Frame Check
2879 Sequence (FCS) fields). If the encapsulated frame would exceed the
2880 transport layer's MTU, the sender is responsible for the
2881 fragmentation of the frame, as specified in <a href="#section-3.4">Section 3.4</a>. The CAPWAP
2882 protocol can support IEEE 802.3 frames whose length is defined in the
2883 IEEE 802.3as specification [<a href="#ref-FRAME-EXT" title="&quot;IEEE Standard 802.3as-2006&quot;">FRAME-EXT</a>].
2884
2885 <span class="h4"><a class="selflink" id="section-4.4.3" href="#section-4.4.3">4.4.3</a>. Establishment of a DTLS Data Channel</span>
2886
2887 If the AC and WTP are configured to tunnel the data channel over
2888 DTLS, the proper DTLS session must be initiated. To avoid having to
2889 reauthenticate and reauthorize an AC and WTP, the DTLS data channel
2890 SHOULD be initiated using the TLS session resumption feature
2891 [<a href="./rfc5246" title="&quot;The Transport Layer Security (TLS) Protocol Version 1.2&quot;">RFC5246</a>].
2892
2893 The AC DTLS implementation MUST NOT initiate a data channel session
2894 for a DTLS session for which there is no active control channel
2895 session.
2896
2897 <span class="h3"><a class="selflink" id="section-4.5" href="#section-4.5">4.5</a>. CAPWAP Control Messages</span>
2898
2899 The CAPWAP Control protocol provides a control channel between the
2900 WTP and the AC. Control messages are divided into the following
2901 message types:
2902
2903 Discovery: CAPWAP Discovery messages are used to identify potential
2904 ACs, their load and capabilities.
2905
2906
2907
2908 <span class="grey">Calhoun, et al. Standards Track [Page 52]</span></pre>
2909 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-53" ></span>
2910 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2911
2912
2913 Join: CAPWAP Join messages are used by a WTP to request service from
2914 an AC, and for the AC to respond to the WTP.
2915
2916 Control Channel Management: CAPWAP Control channel management
2917 messages are used to maintain the control channel.
2918
2919 WTP Configuration Management: The WTP Configuration messages are
2920 used by the AC to deliver a specific configuration to the WTP.
2921 Messages that retrieve statistics from a WTP are also included in
2922 WTP Configuration Management.
2923
2924 Station Session Management: Station Session Management messages are
2925 used by the AC to deliver specific station policies to the WTP.
2926
2927 Device Management Operations: Device management operations are used
2928 to request and deliver a firmware image to the WTP.
2929
2930 Binding-Specific CAPWAP Management Messages: Messages in this
2931 category are used by the AC and the WTP to exchange protocol-
2932 specific CAPWAP management messages. These messages may or may
2933 not be used to change the link state of a station.
2934
2935 Discovery, Join, Control Channel Management, WTP Configuration
2936 Management, and Station Session Management CAPWAP Control messages
2937 MUST be implemented. Device Management Operations messages MAY be
2938 implemented.
2939
2940 CAPWAP Control messages sent from the WTP to the AC indicate that the
2941 WTP is operational, providing an implicit keep-alive mechanism for
2942 the WTP. The Control Channel Management Echo Request and Echo
2943 Response messages provide an explicit keep-alive mechanism when other
2944 CAPWAP Control messages are not exchanged.
2945
2946 <span class="h4"><a class="selflink" id="section-4.5.1" href="#section-4.5.1">4.5.1</a>. Control Message Format</span>
2947
2948 All CAPWAP Control messages are sent encapsulated within the CAPWAP
2949 Header (see <a href="#section-4.3">Section 4.3</a>). Immediately following the CAPWAP Header is
2950 the control header, which has the following format:
2951
2952 0 1 2 3
2953 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
2954 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2955 | Message Type |
2956 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2957 | Seq Num | Msg Element Length | Flags |
2958 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2959 | Msg Element [0..N] ...
2960 +-+-+-+-+-+-+-+-+-+-+-+-+
2961
2962
2963
2964 <span class="grey">Calhoun, et al. Standards Track [Page 53]</span></pre>
2965 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-54" ></span>
2966 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
2967
2968
2969 <span class="h5"><a class="selflink" id="section-4.5.1.1" href="#section-4.5.1.1">4.5.1.1</a>. Message Type</span>
2970
2971 The Message Type field identifies the function of the CAPWAP Control
2972 message. To provide extensibility, the Message Type field is
2973 comprised of an IANA Enterprise Number [<a href="./rfc3232" title="&quot;Assigned Numbers: RFC 1700 is Replaced by an On-line Database&quot;">RFC3232</a>] and an enterprise-
2974 specific message type number. The first three octets contain the
2975 IANA Enterprise Number in network byte order, with zero used for
2976 CAPWAP base protocol (this specification) defined message types. The
2977 last octet is the enterprise-specific message type number, which has
2978 a range from 0 to 255.
2979
2980 The Message Type field is defined as:
2981
2982 Message Type =
2983 IANA Enterprise Number * 256 +
2984 Enterprise Specific Message Type Number
2985
2986 The CAPWAP protocol reliability mechanism requires that messages be
2987 defined in pairs, consisting of both a Request and a Response
2988 message. The Response message MUST acknowledge the Request message.
2989 The assignment of CAPWAP Control Message Type Values always occurs in
2990 pairs. All Request messages have odd numbered Message Type Values,
2991 and all Response messages have even numbered Message Type Values.
2992 The Request value MUST be assigned first. As an example, assigning a
2993 Message Type Value of 3 for a Request message and 4 for a Response
2994 message is valid, while assigning a Message Type Value of 4 for a
2995 Response message and 5 for the corresponding Request message is
2996 invalid.
2997
2998 When a WTP or AC receives a message with a Message Type Value field
2999 that is not recognized and is an odd number, the number in the
3000 Message Type Value Field is incremented by one, and a Response
3001 message with a Message Type Value field containing the incremented
3002 value and containing the Result Code message element with the value
3003 (Unrecognized Request) is returned to the sender of the received
3004 message. If the unknown message type is even, the message is
3005 ignored.
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020 <span class="grey">Calhoun, et al. Standards Track [Page 54]</span></pre>
3021 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-55" ></span>
3022 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3023
3024
3025 The valid values for CAPWAP Control Message Types are specified in
3026 the table below:
3027
3028 CAPWAP Control Message Message Type
3029 Value
3030 Discovery Request 1
3031 Discovery Response 2
3032 Join Request 3
3033 Join Response 4
3034 Configuration Status Request 5
3035 Configuration Status Response 6
3036 Configuration Update Request 7
3037 Configuration Update Response 8
3038 WTP Event Request 9
3039 WTP Event Response 10
3040 Change State Event Request 11
3041 Change State Event Response 12
3042 Echo Request 13
3043 Echo Response 14
3044 Image Data Request 15
3045 Image Data Response 16
3046 Reset Request 17
3047 Reset Response 18
3048 Primary Discovery Request 19
3049 Primary Discovery Response 20
3050 Data Transfer Request 21
3051 Data Transfer Response 22
3052 Clear Configuration Request 23
3053 Clear Configuration Response 24
3054 Station Configuration Request 25
3055 Station Configuration Response 26
3056
3057 <span class="h5"><a class="selflink" id="section-4.5.1.2" href="#section-4.5.1.2">4.5.1.2</a>. Sequence Number</span>
3058
3059 The Sequence Number field is an identifier value used to match
3060 Request and Response packets. When a CAPWAP packet with a Request
3061 Message Type Value is received, the value of the Sequence Number
3062 field is copied into the corresponding Response message.
3063
3064 When a CAPWAP Control message is sent, the sender's internal sequence
3065 number counter is monotonically incremented, ensuring that no two
3066 pending Request messages have the same sequence number. The Sequence
3067 Number field wraps back to zero.
3068
3069 <span class="h5"><a class="selflink" id="section-4.5.1.3" href="#section-4.5.1.3">4.5.1.3</a>. Message Element Length</span>
3070
3071 The Length field indicates the number of bytes following the Sequence
3072 Number field.
3073
3074
3075
3076 <span class="grey">Calhoun, et al. Standards Track [Page 55]</span></pre>
3077 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-56" ></span>
3078 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3079
3080
3081 <span class="h5"><a class="selflink" id="section-4.5.1.4" href="#section-4.5.1.4">4.5.1.4</a>. Flags</span>
3082
3083 The Flags field MUST be set to zero.
3084
3085 <span class="h5"><a class="selflink" id="section-4.5.1.5" href="#section-4.5.1.5">4.5.1.5</a>. Message Element [0..N]</span>
3086
3087 The message element(s) carry the information pertinent to each of the
3088 control message types. Every control message in this specification
3089 specifies which message elements are permitted.
3090
3091 When a WTP or AC receives a CAPWAP message without a message element
3092 that is specified as mandatory for the CAPWAP message, then the
3093 CAPWAP message is discarded. If the received message was a Request
3094 message for which the corresponding Response message carries message
3095 elements, then a corresponding Response message with a Result Code
3096 message element indicating "Failure - Missing Mandatory Message
3097 Element" is returned to the sender.
3098
3099 When a WTP or AC receives a CAPWAP message with a message element
3100 that the WTP or AC does not recognize, the CAPWAP message is
3101 discarded. If the received message was a Request message for which
3102 the corresponding Response message carries message elements, then a
3103 corresponding Response message with a Result Code message element
3104 indicating "Failure - Unrecognized Message Element" and one or more
3105 Returned Message Element message elements is included, containing the
3106 unrecognized message element(s).
3107
3108 <span class="h4"><a class="selflink" id="section-4.5.2" href="#section-4.5.2">4.5.2</a>. Quality of Service</span>
3109
3110 The CAPWAP base protocol does not provide any Quality of Service
3111 (QoS) recommendations for use with the CAPWAP Data messages. Any
3112 wireless-specific CAPWAP binding specification that has QoS
3113 requirements MUST define the application of QoS to the CAPWAP Data
3114 messages.
3115
3116 The IP header also includes the Explicit Congestion Notification
3117 (ECN) bits [<a href="./rfc3168" title="&quot;The Addition of Explicit Congestion Notification (ECN) to IP&quot;">RFC3168</a>]. <a href="./rfc3168#section-9.1.1">Section&nbsp;9.1.1 of [RFC3168]</a> describes two
3118 levels of ECN functionality: full functionality and limited
3119 functionality. CAPWAP ACs and WTPs SHALL implement the limited
3120 functionality and are RECOMMENDED to implement the full functionality
3121 described in [<a href="./rfc3168" title="&quot;The Addition of Explicit Congestion Notification (ECN) to IP&quot;">RFC3168</a>].
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132 <span class="grey">Calhoun, et al. Standards Track [Page 56]</span></pre>
3133 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-57" ></span>
3134 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3135
3136
3137 <span class="h5"><a class="selflink" id="section-4.5.2.1" href="#section-4.5.2.1">4.5.2.1</a>. Applying QoS to CAPWAP Control Message</span>
3138
3139 It is recommended that CAPWAP Control messages be sent by both the AC
3140 and the WTP with an appropriate Quality-of-Service precedence value,
3141 ensuring that congestion in the network minimizes occurrences of
3142 CAPWAP Control channel disconnects. Therefore, a QoS-enabled CAPWAP
3143 device SHOULD use the following values:
3144
3145 802.1Q: The priority tag of 7 SHOULD be used.
3146
3147 DSCP: The CS6 per-hop behavior Service Class SHOULD be used, which
3148 is described in [<a href="./rfc2474" title="&quot;Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers&quot;">RFC2474</a>]).
3149
3150 <span class="h4"><a class="selflink" id="section-4.5.3" href="#section-4.5.3">4.5.3</a>. Retransmissions</span>
3151
3152 The CAPWAP Control protocol operates as a reliable transport. For
3153 each Request message, a Response message is defined, which is used to
3154 acknowledge receipt of the Request message. In addition, the control
3155 header Sequence Number field is used to pair the Request and Response
3156 messages (see <a href="#section-4.5.1">Section 4.5.1</a>).
3157
3158 Response messages are not explicitly acknowledged; therefore, if a
3159 Response message is not received, the original Request message is
3160 retransmitted.
3161
3162 Implementations MUST keep track of the sequence number of the last
3163 received Request message, and MUST cache the corresponding Response
3164 message. If a retransmission with the same sequence number is
3165 received, the cached Response message MUST be retransmitted without
3166 re-processing the Request. If an older Request message is received,
3167 meaning one where the sequence number is smaller, it MUST be ignored.
3168 A newer Request message, meaning one whose sequence number is larger,
3169 is processed as usual.
3170
3171 Note: A sequence number is considered "smaller" when s1 is smaller
3172 than s2 modulo 256 if and only if (s1&lt;s2 and (s2-s1)&lt;128) or
3173 (s1&gt;s2 and (s1-s2)&gt;128).
3174
3175 Both the WTP and the AC can only have a single request outstanding at
3176 any given time. Retransmitted Request messages MUST NOT be altered
3177 by the sender.
3178
3179 After transmitting a Request message, the RetransmitInterval (see
3180 <a href="#section-4.7">Section 4.7</a>) timer and MaxRetransmit (see <a href="#section-4.8">Section 4.8</a>) variable are
3181 used to determine if the original Request message needs to be
3182 retransmitted. The RetransmitInterval timer is used the first time
3183 the Request is retransmitted. The timer is then doubled every
3184
3185
3186
3187
3188 <span class="grey">Calhoun, et al. Standards Track [Page 57]</span></pre>
3189 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-58" ></span>
3190 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3191
3192
3193 subsequent time the same Request message is retransmitted, up to
3194 MaxRetransmit but no more than half the EchoInterval timer (see
3195 <a href="#section-4.7.7">Section 4.7.7</a>). Response messages are not subject to these timers.
3196
3197 If the sender stops retransmitting a Request message before reaching
3198 MaxRetransmit retransmissions (which leads to transition to DTLS
3199 Teardown, as described in <a href="#section-2.3.1">Section 2.3.1</a>), it cannot know whether the
3200 recipient received and processed the Request or not. In most
3201 situations, the sender SHOULD NOT do this, and instead continue
3202 retransmitting until a Response message is received, or transition to
3203 DTLS Teardown occurs. However, if the sender does decide to continue
3204 the connection with a new or modified Request message, the new
3205 message MUST have a new sequence number, and be treated as a new
3206 Request message by the receiver. Note that there is a high chance
3207 that both the WTP and the AC's sequence numbers will become out of
3208 sync.
3209
3210 When a Request message is retransmitted, it MUST be re-encrypted via
3211 the DTLS stack. If the peer had received the Request message, and
3212 the corresponding Response message was lost, it is necessary to
3213 ensure that retransmitted Request messages are not identified as
3214 replays by the DTLS stack. Similarly, any cached Response messages
3215 that are retransmitted as a result of receiving a retransmitted
3216 Request message MUST be re-encrypted via DTLS.
3217
3218 Duplicate Response messages, identified by the Sequence Number field
3219 in the CAPWAP Control message header, SHOULD be discarded upon
3220 receipt.
3221
3222 <span class="h3"><a class="selflink" id="section-4.6" href="#section-4.6">4.6</a>. CAPWAP Protocol Message Elements</span>
3223
3224 This section defines the CAPWAP Protocol message elements that are
3225 included in CAPWAP protocol control messages.
3226
3227 Message elements are used to carry information needed in control
3228 messages. Every message element is identified by the Type Value
3229 field, defined below. The total length of the message elements is
3230 indicated in the message element's length field.
3231
3232 All of the message element definitions in this document use a diagram
3233 similar to the one below in order to depict its format. Note that to
3234 simplify this specification, these diagrams do not include the header
3235 fields (Type and Length). The header field values are defined in the
3236 message element descriptions.
3237
3238
3239
3240
3241
3242
3243
3244 <span class="grey">Calhoun, et al. Standards Track [Page 58]</span></pre>
3245 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-59" ></span>
3246 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3247
3248
3249 Unless otherwise specified, a control message that lists a set of
3250 supported (or expected) message elements MUST NOT expect the message
3251 elements to be in any specific order. The sender MAY include the
3252 message elements in any order. Unless otherwise noted, one message
3253 element of each type is present in a given control message.
3254
3255 Unless otherwise specified, any configuration information sent by the
3256 AC to the WTP MAY be saved to non-volatile storage (see <a href="#section-8.1">Section 8.1</a>)
3257 for more information).
3258
3259 Additional message elements may be defined in separate IETF
3260 documents.
3261
3262 The format of a message element uses the TLV format shown here:
3263
3264 0 1 2 3
3265 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
3266 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3267 | Type | Length |
3268 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3269 | Value ... |
3270 +-+-+-+-+-+-+-+-+
3271
3272 The 16-bit Type field identifies the information carried in the Value
3273 field and Length (16 bits) indicates the number of bytes in the Value
3274 field. The value of zero (0) is reserved and MUST NOT be used. The
3275 rest of the Type field values are allocated as follows:
3276
3277 Usage Type Values
3278
3279 CAPWAP Protocol Message Elements 1 - 1023
3280 IEEE 802.11 Message Elements 1024 - 2047
3281 Reserved for Future Use 2048 - 3071
3282 EPCGlobal Message Elements 3072 - 4095
3283 Reserved for Future Use 4096 - 65535
3284
3285 The table below lists the CAPWAP protocol Message Elements and their
3286 Type values.
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300 <span class="grey">Calhoun, et al. Standards Track [Page 59]</span></pre>
3301 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-60" ></span>
3302 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3303
3304
3305 CAPWAP Message Element Type Value
3306
3307 AC Descriptor 1
3308 AC IPv4 List 2
3309 AC IPv6 List 3
3310 AC Name 4
3311 AC Name with Priority 5
3312 AC Timestamp 6
3313 Add MAC ACL Entry 7
3314 Add Station 8
3315 Reserved 9
3316 CAPWAP Control IPV4 Address 10
3317 CAPWAP Control IPV6 Address 11
3318 CAPWAP Local IPV4 Address 30
3319 CAPWAP Local IPV6 Address 50
3320 CAPWAP Timers 12
3321 CAPWAP Transport Protocol 51
3322 Data Transfer Data 13
3323 Data Transfer Mode 14
3324 Decryption Error Report 15
3325 Decryption Error Report Period 16
3326 Delete MAC ACL Entry 17
3327 Delete Station 18
3328 Reserved 19
3329 Discovery Type 20
3330 Duplicate IPv4 Address 21
3331 Duplicate IPv6 Address 22
3332 ECN Support 53
3333 Idle Timeout 23
3334 Image Data 24
3335 Image Identifier 25
3336 Image Information 26
3337 Initiate Download 27
3338 Location Data 28
3339 Maximum Message Length 29
3340 MTU Discovery Padding 52
3341 Radio Administrative State 31
3342 Radio Operational State 32
3343 Result Code 33
3344 Returned Message Element 34
3345 Session ID 35
3346 Statistics Timer 36
3347 Vendor Specific Payload 37
3348 WTP Board Data 38
3349 WTP Descriptor 39
3350 WTP Fallback 40
3351 WTP Frame Tunnel Mode 41
3352 Reserved 42
3353
3354
3355
3356 <span class="grey">Calhoun, et al. Standards Track [Page 60]</span></pre>
3357 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-61" ></span>
3358 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3359
3360
3361 Reserved 43
3362 WTP MAC Type 44
3363 WTP Name 45
3364 Unused/Reserved 46
3365 WTP Radio Statistics 47
3366 WTP Reboot Statistics 48
3367 WTP Static IP Address Information 49
3368
3369 <span class="h4"><a class="selflink" id="section-4.6.1" href="#section-4.6.1">4.6.1</a>. AC Descriptor</span>
3370
3371 The AC Descriptor message element is used by the AC to communicate
3372 its current state. The value contains the following fields.
3373
3374 0 1 2 3
3375 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
3376 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3377 | Stations | Limit |
3378 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3379 | Active WTPs | Max WTPs |
3380 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3381 | Security | R-MAC Field | Reserved1 | DTLS Policy |
3382 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3383 | AC Information Sub-Element...
3384 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3385
3386 Type: 1 for AC Descriptor
3387
3388 Length: &gt;= 12
3389
3390 Stations: The number of stations currently served by the AC
3391
3392 Limit: The maximum number of stations supported by the AC
3393
3394 Active WTPs: The number of WTPs currently attached to the AC
3395
3396 Max WTPs: The maximum number of WTPs supported by the AC
3397
3398 Security: An 8-bit mask specifying the authentication credential
3399 type supported by the AC (see <a href="#section-2.4.4">Section 2.4.4</a>). The field has the
3400 following format:
3401
3402 0 1 2 3 4 5 6 7
3403 +-+-+-+-+-+-+-+-+
3404 |Reserved |S|X|R|
3405 +-+-+-+-+-+-+-+-+
3406
3407
3408
3409
3410
3411
3412 <span class="grey">Calhoun, et al. Standards Track [Page 61]</span></pre>
3413 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-62" ></span>
3414 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3415
3416
3417 Reserved: A set of reserved bits for future use. All
3418 implementations complying with this protocol MUST set to zero
3419 any bits that are reserved in the version of the protocol
3420 supported by that implementation. Receivers MUST ignore all
3421 bits not defined for the version of the protocol they support.
3422
3423 S: The AC supports the pre-shared secret authentication, as
3424 described in <a href="#section-12.6">Section 12.6</a>.
3425
3426 X: The AC supports X.509 Certificate authentication, as
3427 described in <a href="#section-12.7">Section 12.7</a>.
3428
3429 R: A reserved bit for future use. All implementations
3430 complying with this protocol MUST set to zero any bits that
3431 are reserved in the version of the protocol supported by
3432 that implementation. Receivers MUST ignore all bits not
3433 defined for the version of the protocol they support.
3434
3435 R-MAC Field: The AC supports the optional Radio MAC Address field
3436 in the CAPWAP transport header (see <a href="#section-4.3">Section 4.3</a>). The following
3437 enumerated values are supported:
3438
3439 0 - Reserved
3440
3441 1 - Supported
3442
3443 2 - Not Supported
3444
3445 Reserved: A set of reserved bits for future use. All
3446 implementations complying with this protocol MUST set to zero any
3447 bits that are reserved in the version of the protocol supported by
3448 that implementation. Receivers MUST ignore all bits not defined
3449 for the version of the protocol they support.
3450
3451 DTLS Policy: The AC communicates its policy on the use of DTLS for
3452 the CAPWAP data channel. The AC MAY communicate more than one
3453 supported option, represented by the bit field below. The WTP
3454 MUST abide by one of the options communicated by AC. The field
3455 has the following format:
3456
3457 0 1 2 3 4 5 6 7
3458 +-+-+-+-+-+-+-+-+
3459 |Reserved |D|C|R|
3460 +-+-+-+-+-+-+-+-+
3461
3462
3463
3464
3465
3466
3467
3468 <span class="grey">Calhoun, et al. Standards Track [Page 62]</span></pre>
3469 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-63" ></span>
3470 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3471
3472
3473 Reserved: A set of reserved bits for future use. All
3474 implementations complying with this protocol MUST set to zero
3475 any bits that are reserved in the version of the protocol
3476 supported by that implementation. Receivers MUST ignore all
3477 bits not defined for the version of the protocol they support.
3478
3479 D: DTLS-Enabled Data Channel Supported
3480
3481 C: Clear Text Data Channel Supported
3482
3483 R: A reserved bit for future use. All implementations
3484 complying with this protocol MUST set to zero any bits that
3485 are reserved in the version of the protocol supported by
3486 that implementation. Receivers MUST ignore all bits not
3487 defined for the version of the protocol they support.
3488
3489 AC Information Sub-Element: The AC Descriptor message element
3490 contains multiple AC Information sub-elements, and defines two
3491 sub-types, each of which MUST be present. The AC Information sub-
3492 element has the following format:
3493
3494 0 1 2 3
3495 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
3496 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3497 | AC Information Vendor Identifier |
3498 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3499 | AC Information Type | AC Information Length |
3500 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3501 | AC Information Data...
3502 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3503
3504 AC Information Vendor Identifier: A 32-bit value containing the
3505 IANA-assigned "Structure of Management Information (SMI)
3506 Network Management Private Enterprise Codes".
3507
3508 AC Information Type: Vendor-specific encoding of AC information
3509 in the UTF-8 format [<a href="./rfc3629" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC3629</a>]. The following enumerated values
3510 are supported. Both the Hardware and Software Version sub-
3511 elements MUST be included in the AC Descriptor message element.
3512 The values listed below are used in conjunction with the AC
3513 Information Vendor Identifier field, whose value MUST be set to
3514 zero (0). This field, combined with the AC Information Vendor
3515 Identifier set to a non-zero (0) value, allows vendors to use a
3516 private namespace.
3517
3518
3519
3520
3521
3522
3523
3524 <span class="grey">Calhoun, et al. Standards Track [Page 63]</span></pre>
3525 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-64" ></span>
3526 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3527
3528
3529 4 - Hardware Version: The AC's hardware version number.
3530
3531 5 - Software Version: The AC's Software (firmware) version
3532 number.
3533
3534 AC Information Length: Length of vendor-specific encoding of AC
3535 information, with a maximum size of 1024.
3536
3537 AC Information Data: Vendor-specific encoding of AC information.
3538
3539 <span class="h4"><a class="selflink" id="section-4.6.2" href="#section-4.6.2">4.6.2</a>. AC IPv4 List</span>
3540
3541 The AC IPv4 List message element is used to configure a WTP with the
3542 latest list of ACs available for the WTP to join.
3543
3544
3545 0 1 2 3
3546 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
3547 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3548 | AC IP Address[] |
3549 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3550
3551 Type: 2 for AC IPv4 List
3552
3553 Length: &gt;= 4
3554
3555 AC IP Address: An array of 32-bit integers containing AC IPv4
3556 Addresses, containing no more than 1024 addresses.
3557
3558 <span class="h4"><a class="selflink" id="section-4.6.3" href="#section-4.6.3">4.6.3</a>. AC IPv6 List</span>
3559
3560 The AC IPv6 List message element is used to configure a WTP with the
3561 latest list of ACs available for the WTP to join.
3562
3563
3564 0 1 2 3
3565 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
3566 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3567 | AC IP Address[] |
3568 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3569 | AC IP Address[] |
3570 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3571 | AC IP Address[] |
3572 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3573 | AC IP Address[] |
3574 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3575
3576
3577
3578
3579
3580 <span class="grey">Calhoun, et al. Standards Track [Page 64]</span></pre>
3581 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-65" ></span>
3582 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3583
3584
3585 Type: 3 for AC IPV6 List
3586
3587 Length: &gt;= 16
3588
3589 AC IP Address: An array of 128-bit integers containing AC IPv6
3590 Addresses, containing no more than 1024 addresses.
3591
3592 <span class="h4"><a class="selflink" id="section-4.6.4" href="#section-4.6.4">4.6.4</a>. AC Name</span>
3593
3594 The AC Name message element contains an UTF-8 [<a href="./rfc3629" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC3629</a>]
3595 representation of the AC identity. The value is a variable-length
3596 byte string. The string is NOT zero terminated.
3597
3598 0
3599 0 1 2 3 4 5 6 7
3600 +-+-+-+-+-+-+-+-+
3601 | Name ...
3602 +-+-+-+-+-+-+-+-+
3603
3604 Type: 4 for AC Name
3605
3606 Length: &gt;= 1
3607
3608 Name: A variable-length UTF-8 encoded string [<a href="./rfc3629" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC3629</a>] containing
3609 the AC's name, whose maximum size MUST NOT exceed 512 bytes.
3610
3611 <span class="h4"><a class="selflink" id="section-4.6.5" href="#section-4.6.5">4.6.5</a>. AC Name with Priority</span>
3612
3613 The AC Name with Priority message element is sent by the AC to the
3614 WTP to configure preferred ACs. The number of instances of this
3615 message element is equal to the number of ACs configured on the WTP.
3616 The WTP also uses this message element to send its configuration to
3617 the AC.
3618
3619 0 1
3620 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
3621 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3622 | Priority | AC Name...
3623 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3624
3625 Type: 5 for AC Name with Priority
3626
3627 Length: &gt;= 2
3628
3629 Priority: A value between 1 and 255 specifying the priority order
3630 of the preferred AC. For instance, the value of one (1) is used
3631 to set the primary AC, the value of two (2) is used to set the
3632 secondary, etc.
3633
3634
3635
3636 <span class="grey">Calhoun, et al. Standards Track [Page 65]</span></pre>
3637 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-66" ></span>
3638 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3639
3640
3641 AC Name: A variable-length UTF-8 encoded string [<a href="./rfc3629" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC3629</a>]
3642 containing the AC name, whose maximum size MUST NOT exceed 512
3643 bytes.
3644
3645 <span class="h4"><a class="selflink" id="section-4.6.6" href="#section-4.6.6">4.6.6</a>. AC Timestamp</span>
3646
3647 The AC Timestamp message element is sent by the AC to synchronize the
3648 WTP clock.
3649
3650 0 1 2 3
3651 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
3652 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3653 | Timestamp |
3654 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3655
3656 Type: 6 for AC Timestamp
3657
3658 Length: 4
3659
3660 Timestamp: The AC's current time, allowing all of the WTPs to be
3661 time synchronized in the format defined by Network Time Protocol
3662 (NTP) in <a href="./rfc1305">RFC 1305</a> [<a href="./rfc1305" title="&quot;Network Time Protocol (Version 3) Specification, Implementation&quot;">RFC1305</a>]. Only the most significant 32 bits of
3663 the NTP time are included in this field.
3664
3665 <span class="h4"><a class="selflink" id="section-4.6.7" href="#section-4.6.7">4.6.7</a>. Add MAC ACL Entry</span>
3666
3667 The Add MAC Access Control List (ACL) Entry message element is used
3668 by an AC to add a MAC ACL list entry on a WTP, ensuring that the WTP
3669 no longer provides service to the MAC addresses provided in the
3670 message. The MAC addresses provided in this message element are not
3671 expected to be saved in non-volatile memory on the WTP. The MAC ACL
3672 table on the WTP is cleared every time the WTP establishes a new
3673 session with an AC.
3674
3675 0 1 2 3
3676 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
3677 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3678 | Num of Entries| Length | MAC Address ...
3679 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3680
3681 Type: 7 for Add MAC ACL Entry
3682
3683 Length: &gt;= 8
3684
3685 Num of Entries: The number of instances of the Length/MAC Address
3686 fields in the array. This value MUST NOT exceed 255.
3687
3688
3689
3690
3691
3692 <span class="grey">Calhoun, et al. Standards Track [Page 66]</span></pre>
3693 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-67" ></span>
3694 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3695
3696
3697 Length: The length of the MAC Address field. The formats and
3698 lengths specified in [<a href="#ref-EUI-48" title="&quot;Guidelines for use of a 48-bit Extended Unique Identifier&quot;">EUI-48</a>] and [<a href="#ref-EUI-64" title="&quot;GUIDELINES FOR 64-BIT GLOBAL IDENTIFIER (EUI-64) REGISTRATION AUTHORITY&quot;">EUI-64</a>] are supported.
3699
3700 MAC Address: MAC addresses to add to the ACL.
3701
3702 <span class="h4"><a class="selflink" id="section-4.6.8" href="#section-4.6.8">4.6.8</a>. Add Station</span>
3703
3704 The Add Station message element is used by the AC to inform a WTP
3705 that it should forward traffic for a station. The Add Station
3706 message element is accompanied by technology-specific binding
3707 information element(s), which may include security parameters.
3708 Consequently, the security parameters MUST be applied by the WTP for
3709 the station.
3710
3711 After station policy has been delivered to the WTP through the Add
3712 Station message element, an AC MAY change any policies by sending a
3713 modified Add Station message element. When a WTP receives an Add
3714 Station message element for an existing station, it MUST override any
3715 existing state for the station.
3716
3717 0 1 2 3
3718 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
3719 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3720 | Radio ID | Length | MAC Address ...
3721 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3722 | VLAN Name...
3723 +-+-+-+-+-+-+-+-+
3724
3725 Type: 8 for Add Station
3726
3727 Length: &gt;= 8
3728
3729 Radio ID: An 8-bit value representing the radio, whose value is
3730 between one (1) and 31.
3731
3732 Length: The length of the MAC Address field. The formats and
3733 lengths specified in [<a href="#ref-EUI-48" title="&quot;Guidelines for use of a 48-bit Extended Unique Identifier&quot;">EUI-48</a>] and [<a href="#ref-EUI-64" title="&quot;GUIDELINES FOR 64-BIT GLOBAL IDENTIFIER (EUI-64) REGISTRATION AUTHORITY&quot;">EUI-64</a>] are supported.
3734
3735 MAC Address: The station's MAC address.
3736
3737 VLAN Name: An optional variable-length UTF-8 encoded string
3738 [<a href="./rfc3629" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC3629</a>], with a maximum length of 512 octets, containing the
3739 VLAN Name on which the WTP is to locally bridge user data. Note
3740 this field is only valid with WTPs configured in Local MAC mode.
3741
3742
3743
3744
3745
3746
3747
3748 <span class="grey">Calhoun, et al. Standards Track [Page 67]</span></pre>
3749 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-68" ></span>
3750 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3751
3752
3753 <span class="h4"><a class="selflink" id="section-4.6.9" href="#section-4.6.9">4.6.9</a>. CAPWAP Control IPv4 Address</span>
3754
3755 The CAPWAP Control IPv4 Address message element is sent by the AC to
3756 the WTP during the Discovery process and is used by the AC to provide
3757 the interfaces available on the AC, and the current number of WTPs
3758 connected. When multiple CAPWAP Control IPV4 Address message
3759 elements are returned, the WTP SHOULD perform load balancing across
3760 the multiple interfaces (see <a href="#section-6.1">Section 6.1</a>).
3761
3762 0 1 2 3
3763 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
3764 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3765 | IP Address |
3766 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3767 | WTP Count |
3768 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3769
3770 Type: 10 for CAPWAP Control IPv4 Address
3771
3772 Length: 6
3773
3774 IP Address: The IP address of an interface.
3775
3776 WTP Count: The number of WTPs currently connected to the interface,
3777 with a maximum value of 65535.
3778
3779 <span class="h4"><a class="selflink" id="section-4.6.10" href="#section-4.6.10">4.6.10</a>. CAPWAP Control IPv6 Address</span>
3780
3781 The CAPWAP Control IPv6 Address message element is sent by the AC to
3782 the WTP during the Discovery process and is used by the AC to provide
3783 the interfaces available on the AC, and the current number of WTPs
3784 connected. This message element is useful for the WTP to perform
3785 load balancing across multiple interfaces (see <a href="#section-6.1">Section 6.1</a>).
3786
3787 0 1 2 3
3788 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
3789 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3790 | IP Address |
3791 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3792 | IP Address |
3793 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3794 | IP Address |
3795 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3796 | IP Address |
3797 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3798 | WTP Count |
3799 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3800
3801
3802
3803
3804 <span class="grey">Calhoun, et al. Standards Track [Page 68]</span></pre>
3805 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-69" ></span>
3806 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3807
3808
3809 Type: 11 for CAPWAP Control IPv6 Address
3810
3811 Length: 18
3812
3813 IP Address: The IP address of an interface.
3814
3815 WTP Count: The number of WTPs currently connected to the interface,
3816 with a maximum value of 65535.
3817
3818 <span class="h4"><a class="selflink" id="section-4.6.11" href="#section-4.6.11">4.6.11</a>. CAPWAP Local IPv4 Address</span>
3819
3820 The CAPWAP Local IPv4 Address message element is sent by either the
3821 WTP, in the Join Request, or by the AC, in the Join Response. The
3822 CAPWAP Local IPv4 Address message element is used to communicate the
3823 IP Address of the transmitter. The receiver uses this to determine
3824 whether a middlebox exists between the two peers, by comparing the
3825 source IP address of the packet against the value of the message
3826 element.
3827
3828 0 1 2 3
3829 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
3830 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3831 | IP Address |
3832 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3833
3834 Type: 30 for CAPWAP Local IPv4 Address
3835
3836 Length: 4
3837
3838 IP Address: The IP address of the sender.
3839
3840 <span class="h4"><a class="selflink" id="section-4.6.12" href="#section-4.6.12">4.6.12</a>. CAPWAP Local IPv6 Address</span>
3841
3842 The CAPWAP Local IPv6 Address message element is sent by either the
3843 WTP, in the Join Request, or by the AC, in the Join Response. The
3844 CAPWAP Local IPv6 Address message element is used to communicate the
3845 IP Address of the transmitter. The receiver uses this to determine
3846 whether a middlebox exists between the two peers, by comparing the
3847 source IP address of the packet against the value of the message
3848 element.
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860 <span class="grey">Calhoun, et al. Standards Track [Page 69]</span></pre>
3861 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-70" ></span>
3862 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3863
3864
3865 0 1 2 3
3866 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
3867 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3868 | IP Address |
3869 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3870 | IP Address |
3871 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3872 | IP Address |
3873 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3874 | IP Address |
3875 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3876
3877 Type: 50 for CAPWAP Local IPv6 Address
3878
3879 Length: 16
3880
3881 IP Address: The IP address of the sender.
3882
3883 <span class="h4"><a class="selflink" id="section-4.6.13" href="#section-4.6.13">4.6.13</a>. CAPWAP Timers</span>
3884
3885 The CAPWAP Timers message element is used by an AC to configure
3886 CAPWAP timers on a WTP.
3887
3888 0 1
3889 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
3890 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3891 | Discovery | Echo Request |
3892 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3893
3894 Type: 12 for CAPWAP Timers
3895
3896 Length: 2
3897
3898 Discovery: The number of seconds between CAPWAP Discovery messages,
3899 when the WTP is in the Discovery phase. This value is used to
3900 configure the MaxDiscoveryInterval timer (see <a href="#section-4.7.10">Section 4.7.10</a>).
3901
3902 Echo Request: The number of seconds between WTP Echo Request CAPWAP
3903 messages. This value is used to configure the EchoInterval timer
3904 (see <a href="#section-4.7.7">Section 4.7.7</a>). The AC sets its EchoInterval timer to this
3905 value, plus the maximum retransmission time as described in
3906 <a href="#section-4.5.3">Section 4.5.3</a>.
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916 <span class="grey">Calhoun, et al. Standards Track [Page 70]</span></pre>
3917 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-71" ></span>
3918 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3919
3920
3921 <span class="h4"><a class="selflink" id="section-4.6.14" href="#section-4.6.14">4.6.14</a>. CAPWAP Transport Protocol</span>
3922
3923 When CAPWAP is run over IPv6, the UDP-Lite or UDP transports MAY be
3924 used (see <a href="#section-3">Section 3</a>). The CAPWAP IPv6 Transport Protocol message
3925 element is used by either the WTP or the AC to signal which transport
3926 protocol is to be used for the CAPWAP data channel.
3927
3928 Upon receiving the Join Request, the AC MAY set the CAPWAP Transport
3929 Protocol to UDP-Lite in the Join Response message if the CAPWAP
3930 message was received over IPv6, and the CAPWAP Local IPv6 Address
3931 message element (see <a href="#section-4.6.12">Section 4.6.12</a>) is present and no middlebox was
3932 detected (see <a href="#section-11">Section 11</a>).
3933
3934 Upon receiving the Join Response, the WTP MAY set the CAPWAP
3935 Transport Protocol to UDP-Lite in the Configuration Status Request or
3936 Image Data Request message if the AC advertised support for UDP-Lite,
3937 the message was received over IPv6, the CAPWAP Local IPv6 Address
3938 message element (see <a href="#section-4.6.12">Section 4.6.12</a>) and no middlebox was detected
3939 (see <a href="#section-11">Section 11</a>). Upon receiving either the Configuration Status
3940 Request or the Image Data Request, the AC MUST observe the preference
3941 indicated by the WTP in the CAPWAP Transport Protocol, as long as it
3942 is consistent with what the AC advertised in the Join Response.
3943
3944 For any other condition, the CAPWAP Transport Protocol MUST be set to
3945 UDP.
3946
3947 0
3948 0 1 2 3 4 5 6 7
3949 +-+-+-+-+-+-+-+-+
3950 | Transport |
3951 +-+-+-+-+-+-+-+-+
3952
3953 Type: 51 for CAPWAP Transport Protocol
3954
3955 Length: 1
3956
3957 Transport: The transport to use for the CAPWAP Data channel. The
3958 following enumerated values are supported:
3959
3960 1 - UDP-Lite: The UDP-Lite transport protocol is to be used for
3961 the CAPWAP Data channel. Note that this option MUST NOT be
3962 used if the CAPWAP Control channel is being used over IPv4.
3963
3964 2 - UDP: The UDP transport protocol is to be used for the CAPWAP
3965 Data channel.
3966
3967
3968
3969
3970
3971
3972 <span class="grey">Calhoun, et al. Standards Track [Page 71]</span></pre>
3973 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-72" ></span>
3974 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
3975
3976
3977 <span class="h4"><a class="selflink" id="section-4.6.15" href="#section-4.6.15">4.6.15</a>. Data Transfer Data</span>
3978
3979 The Data Transfer Data message element is used by the WTP to provide
3980 information to the AC for debugging purposes.
3981
3982 0 1 2 3
3983 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
3984 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3985 | Data Type | Data Mode | Data Length |
3986 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
3987 | Data ....
3988 +-+-+-+-+-+-+-+-+
3989
3990 Type: 13 for Data Transfer Data
3991
3992 Length: &gt;= 5
3993
3994 Data Type: An 8-bit value representing the transfer Data Type. The
3995 following enumerated values are supported:
3996
3997 1 - Transfer data is included.
3998
3999 2 - Last Transfer Data Block is included (End of File (EOF)).
4000
4001 5 - An error occurred. Transfer is aborted.
4002
4003 Data Mode: An 8-bit value describing the type of information being
4004 transmitted. The following enumerated values are supported:
4005
4006 0 - Reserved
4007
4008 1 - WTP Crash Data
4009
4010 2 - WTP Memory Dump
4011
4012 Data Length: Length of data field, with a maximum size of 65535.
4013
4014 Data: Data being transferred from the WTP to the AC, whose type is
4015 identified via the Data Mode field.
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028 <span class="grey">Calhoun, et al. Standards Track [Page 72]</span></pre>
4029 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-73" ></span>
4030 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4031
4032
4033 <span class="h4"><a class="selflink" id="section-4.6.16" href="#section-4.6.16">4.6.16</a>. Data Transfer Mode</span>
4034
4035 The Data Transfer Mode message element is used by the WTP to indicate
4036 the type of data transfer information it is sending to the AC for
4037 debugging purposes.
4038
4039 0
4040 0 1 2 3 4 5 6 7
4041 +-+-+-+-+-+-+-+-+
4042 | Data Mode |
4043 +-+-+-+-+-+-+-+-+
4044
4045 Type: 14 for Data Transfer Mode
4046
4047 Length: 1
4048
4049 Data Mode: An 8-bit value describing the type of information being
4050 requested. The following enumerated values are supported:
4051
4052 0 - Reserved
4053
4054 1 - WTP Crash Data
4055
4056 2 - WTP Memory Dump
4057
4058 <span class="h4"><a class="selflink" id="section-4.6.17" href="#section-4.6.17">4.6.17</a>. Decryption Error Report</span>
4059
4060 The Decryption Error Report message element value is used by the WTP
4061 to inform the AC of decryption errors that have occurred since the
4062 last report. Note that this error reporting mechanism is not used if
4063 encryption and decryption services are provided in the AC.
4064
4065 0 1 2
4066 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3
4067 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4068 | Radio ID |Num Of Entries | Length | MAC Address...
4069 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4070
4071 Type: 15 for Decryption Error Report
4072
4073 Length: &gt;= 9
4074
4075 Radio ID: The Radio Identifier refers to an interface index on the
4076 WTP, whose value is between one (1) and 31.
4077
4078 Num of Entries: The number of instances of the Length/MAC Address
4079 fields in the array. This field MUST NOT exceed the value of 255.
4080
4081
4082
4083
4084 <span class="grey">Calhoun, et al. Standards Track [Page 73]</span></pre>
4085 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-74" ></span>
4086 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4087
4088
4089 Length: The length of the MAC Address field. The formats and
4090 lengths specified in [<a href="#ref-EUI-48" title="&quot;Guidelines for use of a 48-bit Extended Unique Identifier&quot;">EUI-48</a>] and [<a href="#ref-EUI-64" title="&quot;GUIDELINES FOR 64-BIT GLOBAL IDENTIFIER (EUI-64) REGISTRATION AUTHORITY&quot;">EUI-64</a>] are supported.
4091
4092 MAC Address: MAC address of the station that has caused decryption
4093 errors.
4094
4095 <span class="h4"><a class="selflink" id="section-4.6.18" href="#section-4.6.18">4.6.18</a>. Decryption Error Report Period</span>
4096
4097 The Decryption Error Report Period message element value is used by
4098 the AC to inform the WTP how frequently it should send decryption
4099 error report messages. Note that this error reporting mechanism is
4100 not used if encryption and decryption services are provided in the
4101 AC.
4102
4103 0 1 2
4104 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3
4105 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4106 | Radio ID | Report Interval |
4107 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4108
4109 Type: 16 for Decryption Error Report Period
4110
4111 Length: 3
4112
4113 Radio ID: The Radio Identifier refers to an interface index on the
4114 WTP, whose value is between one (1) and 31.
4115
4116 Report Interval: A 16-bit unsigned integer indicating the time, in
4117 seconds. The default value for this message element can be found
4118 in <a href="#section-4.7.11">Section 4.7.11</a>.
4119
4120 <span class="h4"><a class="selflink" id="section-4.6.19" href="#section-4.6.19">4.6.19</a>. Delete MAC ACL Entry</span>
4121
4122 The Delete MAC ACL Entry message element is used by an AC to delete a
4123 MAC ACL entry on a WTP, ensuring that the WTP provides service to the
4124 MAC addresses provided in the message.
4125
4126 0 1 2 3
4127 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
4128 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4129 | Num of Entries| Length | MAC Address ...
4130 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4131
4132 Type: 17 for Delete MAC ACL Entry
4133
4134 Length: &gt;= 8
4135
4136
4137
4138
4139
4140 <span class="grey">Calhoun, et al. Standards Track [Page 74]</span></pre>
4141 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-75" ></span>
4142 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4143
4144
4145 Num of Entries: The number of instances of the Length/MAC Address
4146 fields in the array. This field MUST NOT exceed the value of 255.
4147
4148 Length: The length of the MAC Address field. The formats and
4149 lengths specified in [<a href="#ref-EUI-48" title="&quot;Guidelines for use of a 48-bit Extended Unique Identifier&quot;">EUI-48</a>] and [<a href="#ref-EUI-64" title="&quot;GUIDELINES FOR 64-BIT GLOBAL IDENTIFIER (EUI-64) REGISTRATION AUTHORITY&quot;">EUI-64</a>] are supported.
4150
4151 MAC Address: An array of MAC addresses to delete from the ACL.
4152
4153 <span class="h4"><a class="selflink" id="section-4.6.20" href="#section-4.6.20">4.6.20</a>. Delete Station</span>
4154
4155 The Delete Station message element is used by the AC to inform a WTP
4156 that it should no longer provide service to a particular station.
4157 The WTP MUST terminate service to the station immediately upon
4158 receiving this message element.
4159
4160 The transmission of a Delete Station message element could occur for
4161 various reasons, including for administrative reasons, or if the
4162 station has roamed to another WTP.
4163
4164 The Delete Station message element MAY be sent by the WTP, in the WTP
4165 Event Request message, to inform the AC that a particular station is
4166 no longer being provided service. This could occur as a result of an
4167 Idle Timeout (see <a href="#section-4.4.43">section 4.4.43</a>), due to internal resource shortages
4168 or for some other reason.
4169
4170 0 1 2 3
4171 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
4172 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4173 | Radio ID | Length | MAC Address...
4174 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4175
4176 Type: 18 for Delete Station
4177
4178 Length: &gt;= 8
4179
4180 Radio ID: An 8-bit value representing the radio, whose value is
4181 between one (1) and 31.
4182
4183 Length: The length of the MAC Address field. The formats and
4184 lengths specified in [<a href="#ref-EUI-48" title="&quot;Guidelines for use of a 48-bit Extended Unique Identifier&quot;">EUI-48</a>] and [<a href="#ref-EUI-64" title="&quot;GUIDELINES FOR 64-BIT GLOBAL IDENTIFIER (EUI-64) REGISTRATION AUTHORITY&quot;">EUI-64</a>] are supported.
4185
4186 MAC Address: The station's MAC address.
4187
4188 <span class="h4"><a class="selflink" id="section-4.6.21" href="#section-4.6.21">4.6.21</a>. Discovery Type</span>
4189
4190 The Discovery Type message element is used by the WTP to indicate how
4191 it has come to know about the existence of the AC to which it is
4192 sending the Discovery Request message.
4193
4194
4195
4196 <span class="grey">Calhoun, et al. Standards Track [Page 75]</span></pre>
4197 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-76" ></span>
4198 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4199
4200
4201 0
4202 0 1 2 3 4 5 6 7
4203 +-+-+-+-+-+-+-+-+
4204 | Discovery Type|
4205 +-+-+-+-+-+-+-+-+
4206
4207 Type: 20 for Discovery Type
4208
4209 Length: 1
4210
4211 Discovery Type: An 8-bit value indicating how the WTP discovered
4212 the AC. The following enumerated values are supported:
4213
4214 0 - Unknown
4215
4216 1 - Static Configuration
4217
4218 2 - DHCP
4219
4220 3 - DNS
4221
4222 4 - AC Referral (used when the AC was configured either through
4223 the AC IPv4 List or AC IPv6 List message element)
4224
4225 <span class="h4"><a class="selflink" id="section-4.6.22" href="#section-4.6.22">4.6.22</a>. Duplicate IPv4 Address</span>
4226
4227 The Duplicate IPv4 Address message element is used by a WTP to inform
4228 an AC that it has detected another IP device using the same IP
4229 address that the WTP is currently using.
4230
4231 The WTP MUST transmit this message element with the status set to 1
4232 after it has detected a duplicate IP address. When the WTP detects
4233 that the duplicate IP address has been cleared, it MUST send this
4234 message element with the status set to 0.
4235
4236 0 1 2 3
4237 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
4238 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4239 | IP Address |
4240 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4241 | Status | Length | MAC Address ...
4242 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4243
4244 Type: 21 for Duplicate IPv4 Address
4245
4246 Length: &gt;= 12
4247
4248 IP Address: The IP address currently used by the WTP.
4249
4250
4251
4252 <span class="grey">Calhoun, et al. Standards Track [Page 76]</span></pre>
4253 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-77" ></span>
4254 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4255
4256
4257 Status: The status of the duplicate IP address. The value MUST be
4258 set to 1 when a duplicate address is detected, and 0 when the
4259 duplicate address has been cleared.
4260
4261 Length: The length of the MAC Address field. The formats and
4262 lengths specified in [<a href="#ref-EUI-48" title="&quot;Guidelines for use of a 48-bit Extended Unique Identifier&quot;">EUI-48</a>] and [<a href="#ref-EUI-64" title="&quot;GUIDELINES FOR 64-BIT GLOBAL IDENTIFIER (EUI-64) REGISTRATION AUTHORITY&quot;">EUI-64</a>] are supported.
4263
4264 MAC Address: The MAC address of the offending device.
4265
4266 <span class="h4"><a class="selflink" id="section-4.6.23" href="#section-4.6.23">4.6.23</a>. Duplicate IPv6 Address</span>
4267
4268 The Duplicate IPv6 Address message element is used by a WTP to inform
4269 an AC that it has detected another host using the same IP address
4270 that the WTP is currently using.
4271
4272 The WTP MUST transmit this message element with the status set to 1
4273 after it has detected a duplicate IP address. When the WTP detects
4274 that the duplicate IP address has been cleared, it MUST send this
4275 message element with the status set to 0.
4276
4277 0 1 2 3
4278 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
4279 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4280 | IP Address |
4281 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4282 | IP Address |
4283 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4284 | IP Address |
4285 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4286 | IP Address |
4287 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4288 | Status | Length | MAC Address ...
4289 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4290
4291 Type: 22 for Duplicate IPv6 Address
4292
4293 Length: &gt;= 24
4294
4295 IP Address: The IP address currently used by the WTP.
4296
4297 Status: The status of the duplicate IP address. The value MUST be
4298 set to 1 when a duplicate address is detected, and 0 when the
4299 duplicate address has been cleared.
4300
4301 Length: The length of the MAC Address field. The formats and
4302 lengths specified in [<a href="#ref-EUI-48" title="&quot;Guidelines for use of a 48-bit Extended Unique Identifier&quot;">EUI-48</a>] and [<a href="#ref-EUI-64" title="&quot;GUIDELINES FOR 64-BIT GLOBAL IDENTIFIER (EUI-64) REGISTRATION AUTHORITY&quot;">EUI-64</a>] are supported.
4303
4304 MAC Address: The MAC address of the offending device.
4305
4306
4307
4308 <span class="grey">Calhoun, et al. Standards Track [Page 77]</span></pre>
4309 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-78" ></span>
4310 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4311
4312
4313 <span class="h4"><a class="selflink" id="section-4.6.24" href="#section-4.6.24">4.6.24</a>. Idle Timeout</span>
4314
4315 The Idle Timeout message element is sent by the AC to the WTP to
4316 provide the Idle Timeout value that the WTP SHOULD enforce for its
4317 active stations. The value applies to all radios on the WTP.
4318
4319 0 1 2 3
4320 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
4321 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4322 | Timeout |
4323 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4324
4325 Type: 23 for Idle Timeout
4326
4327 Length: 4
4328
4329 Timeout: The current Idle Timeout, in seconds, to be enforced by
4330 the WTP. The default value for this message element is specified
4331 in <a href="#section-4.7.8">Section 4.7.8</a>.
4332
4333 <span class="h4"><a class="selflink" id="section-4.6.25" href="#section-4.6.25">4.6.25</a>. ECN Support</span>
4334
4335 The ECN Support message element is sent by both the WTP and the AC to
4336 indicate their support for the Explicit Congestion Notification (ECN)
4337 bits, as defined in [<a href="./rfc3168" title="&quot;The Addition of Explicit Congestion Notification (ECN) to IP&quot;">RFC3168</a>].
4338
4339 0
4340 0 1 2 3 4 5 6 7
4341 +-+-+-+-+-+-+-+-+
4342 | ECN Support |
4343 +-+-+-+-+-+-+-+-+
4344
4345 Type: 53 for ECN Support
4346
4347 Length: 1
4348
4349 ECN Support: An 8-bit value representing the sender's support for
4350 ECN, as defined in [<a href="./rfc3168" title="&quot;The Addition of Explicit Congestion Notification (ECN) to IP&quot;">RFC3168</a>]. All CAPWAP Implementations MUST
4351 support the Limited ECN Support mode. Full ECN Support is used if
4352 both the WTP and AC advertise the capability for "Full and Limited
4353 ECN" Support; otherwise, Limited ECN Support is used.
4354
4355 0 - Limited ECN Support
4356
4357 1 - Full and Limited ECN Support
4358
4359
4360
4361
4362
4363
4364 <span class="grey">Calhoun, et al. Standards Track [Page 78]</span></pre>
4365 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-79" ></span>
4366 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4367
4368
4369 <span class="h4"><a class="selflink" id="section-4.6.26" href="#section-4.6.26">4.6.26</a>. Image Data</span>
4370
4371 The Image Data message element is present in the Image Data Request
4372 message sent by the AC and contains the following fields.
4373
4374 0 1 2 3
4375 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
4376 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4377 | Data Type | Data ....
4378 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4379
4380 Type: 24 for Image Data
4381
4382 Length: &gt;= 1
4383
4384 Data Type: An 8-bit value representing the image Data Type. The
4385 following enumerated values are supported:
4386
4387 1 - Image data is included.
4388
4389 2 - Last Image Data Block is included (EOF).
4390
4391 5 - An error occurred. Transfer is aborted.
4392
4393 Data: The Image Data field contains up to 1024 characters, and its
4394 length is inferred from this message element's length field. If
4395 the block being sent is the last one, the Data Type field is set
4396 to 2. The AC MAY opt to abort the data transfer by setting the
4397 Data Type field to 5. When the Data Type field is 5, the Value
4398 field has a zero length.
4399
4400 <span class="h4"><a class="selflink" id="section-4.6.27" href="#section-4.6.27">4.6.27</a>. Image Identifier</span>
4401
4402 The Image Identifier message element is sent by the AC to the WTP to
4403 indicate the expected active software version that is to be run on
4404 the WTP. The WTP sends the Image Identifier message element in order
4405 to request a specific software version from the AC. The actual
4406 download process is defined in <a href="#section-9.1">Section 9.1</a>. The value is a variable-
4407 length UTF-8 encoded string [<a href="./rfc3629" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC3629</a>], which is NOT zero terminated.
4408
4409 0 1 2 3
4410 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
4411 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4412 | Vendor Identifier |
4413 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4414 | Data...
4415 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4416
4417
4418
4419
4420 <span class="grey">Calhoun, et al. Standards Track [Page 79]</span></pre>
4421 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-80" ></span>
4422 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4423
4424
4425 Type: 25 for Image Identifier
4426
4427 Length: &gt;= 5
4428
4429 Vendor Identifier: A 32-bit value containing the IANA-assigned "SMI
4430 Network Management Private Enterprise Codes".
4431
4432 Data: A variable-length UTF-8 encoded string [<a href="./rfc3629" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC3629</a>] containing
4433 the firmware identifier to be run on the WTP, whose length MUST
4434 NOT exceed 1024 octets. The length of this field is inferred from
4435 this message element's length field.
4436
4437 <span class="h4"><a class="selflink" id="section-4.6.28" href="#section-4.6.28">4.6.28</a>. Image Information</span>
4438
4439 The Image Information message element is present in the Image Data
4440 Response message sent by the AC to the WTP and contains the following
4441 fields.
4442
4443 0 1 2 3
4444 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
4445 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4446 | File Size |
4447 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4448 | Hash |
4449 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4450 | Hash |
4451 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4452 | Hash |
4453 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4454 | Hash |
4455 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4456
4457 Type: 26 for Image Information
4458
4459 Length: 20
4460
4461 File Size: A 32-bit value containing the size of the file, in
4462 bytes, that will be transferred by the AC to the WTP.
4463
4464 Hash: A 16-octet MD5 hash of the image using the procedures defined
4465 in [<a href="./rfc1321" title="&quot;The MD5 Message-Digest Algorithm&quot;">RFC1321</a>].
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476 <span class="grey">Calhoun, et al. Standards Track [Page 80]</span></pre>
4477 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-81" ></span>
4478 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4479
4480
4481 <span class="h4"><a class="selflink" id="section-4.6.29" href="#section-4.6.29">4.6.29</a>. Initiate Download</span>
4482
4483 The Initiate Download message element is used by the WTP to inform
4484 the AC that the AC SHOULD initiate a firmware upgrade. The AC
4485 subsequently transmits an Image Data Request message, which includes
4486 the Image Data message element. This message element does not
4487 contain any data.
4488
4489 Type: 27 for Initiate Download
4490
4491 Length: 0
4492
4493 <span class="h4"><a class="selflink" id="section-4.6.30" href="#section-4.6.30">4.6.30</a>. Location Data</span>
4494
4495 The Location Data message element is a variable-length byte UTF-8
4496 encoded string [<a href="./rfc3629" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC3629</a>] containing user-defined location information
4497 (e.g., "Next to Fridge"). This information is configurable by the
4498 network administrator, and allows the WTP location to be determined.
4499 The string is not zero terminated.
4500
4501 0
4502 0 1 2 3 4 5 6 7
4503 +-+-+-+-+-+-+-+-+-
4504 | Location ...
4505 +-+-+-+-+-+-+-+-+-
4506
4507 Type: 28 for Location Data
4508
4509 Length: &gt;= 1
4510
4511 Location: A non-zero-terminated UTF-8 encoded string [<a href="./rfc3629" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC3629</a>]
4512 containing the WTP location, whose maximum size MUST NOT exceed
4513 1024.
4514
4515 <span class="h4"><a class="selflink" id="section-4.6.31" href="#section-4.6.31">4.6.31</a>. Maximum Message Length</span>
4516
4517 The Maximum Message Length message element is included in the Join
4518 Request message by the WTP to indicate the maximum CAPWAP message
4519 length that it supports to the AC. The Maximum Message Length
4520 message element is optionally included in Join Response message by
4521 the AC to indicate the maximum CAPWAP message length that it supports
4522 to the WTP.
4523
4524 0 1
4525 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
4526 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4527 | Maximum Message Length |
4528 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4529
4530
4531
4532 <span class="grey">Calhoun, et al. Standards Track [Page 81]</span></pre>
4533 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-82" ></span>
4534 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4535
4536
4537 Type: 29 for Maximum Message Length
4538
4539 Length: 2
4540
4541 Maximum Message Length A 16-bit unsigned integer indicating the
4542 maximum message length.
4543
4544 <span class="h4"><a class="selflink" id="section-4.6.32" href="#section-4.6.32">4.6.32</a>. MTU Discovery Padding</span>
4545
4546 The MTU Discovery Padding message element is used as padding to
4547 perform MTU discovery, and MUST contain octets of value 0xFF, of any
4548 length.
4549
4550 0
4551 0 1 2 3 4 5 6 7
4552 +-+-+-+-+-+-+-+-+
4553 | Padding...
4554 +-+-+-+-+-+-+-+-
4555
4556
4557 Type: 52 for MTU Discovery Padding
4558
4559 Length: Variable
4560
4561 Pad: A variable-length pad, filled with the value 0xFF.
4562
4563 <span class="h4"><a class="selflink" id="section-4.6.33" href="#section-4.6.33">4.6.33</a>. Radio Administrative State</span>
4564
4565 The Radio Administrative State message element is used to communicate
4566 the state of a particular radio. The Radio Administrative State
4567 message element is sent by the AC to change the state of the WTP.
4568 The WTP saves the value, to ensure that it remains across WTP resets.
4569 The WTP communicates this message element during the configuration
4570 phase, in the Configuration Status Request message, to ensure that
4571 the AC has the WTP radio current administrative state settings. The
4572 message element contains the following fields:
4573
4574 0 1
4575 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
4576 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4577 | Radio ID | Admin State |
4578 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4579
4580 Type: 31 for Radio Administrative State
4581
4582 Length: 2
4583
4584
4585
4586
4587
4588 <span class="grey">Calhoun, et al. Standards Track [Page 82]</span></pre>
4589 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-83" ></span>
4590 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4591
4592
4593 Radio ID: An 8-bit value representing the radio to configure, whose
4594 value is between one (1) and 31. The Radio ID field MAY also
4595 include the value of 0xff, which is used to identify the WTP. If
4596 an AC wishes to change the administrative state of a WTP, it
4597 includes 0xff in the Radio ID field.
4598
4599 Admin State: An 8-bit value representing the administrative state
4600 of the radio. The default value for the Admin State field is
4601 listed in <a href="#section-4.8.1">Section 4.8.1</a>. The following enumerated values are
4602 supported:
4603
4604 0 - Reserved
4605
4606 1 - Enabled
4607
4608 2 - Disabled
4609
4610 <span class="h4"><a class="selflink" id="section-4.6.34" href="#section-4.6.34">4.6.34</a>. Radio Operational State</span>
4611
4612 The Radio Operational State message element is sent by the WTP to the
4613 AC to communicate a radio's operational state. This message element
4614 is included in the Configuration Update Response message by the WTP
4615 if it was requested to change the state of its radio, via the Radio
4616 Administrative State message element, but was unable to comply to the
4617 request. This message element is included in the Change State Event
4618 message when a WTP radio state was changed unexpectedly. This could
4619 occur due to a hardware failure. Note that the operational state
4620 setting is not saved on the WTP, and therefore does not remain across
4621 WTP resets. The value contains three fields, as shown below.
4622
4623 0 1 2
4624 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3
4625 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4626 | Radio ID | State | Cause |
4627 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4628
4629 Type: 32 for Radio Operational State
4630
4631 Length: 3
4632
4633 Radio ID: The Radio Identifier refers to an interface index on the
4634 WTP, whose value is between one (1) and 31. A value of 0xFF is
4635 invalid, as it is not possible to change the WTP's operational
4636 state.
4637
4638 State: An 8-bit Boolean value representing the state of the radio.
4639 The following enumerated values are supported:
4640
4641
4642
4643
4644 <span class="grey">Calhoun, et al. Standards Track [Page 83]</span></pre>
4645 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-84" ></span>
4646 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4647
4648
4649 0 - Reserved
4650
4651 1 - Enabled
4652
4653 2 - Disabled
4654
4655 Cause: When a radio is inoperable, the cause field contains the
4656 reason the radio is out of service. The following enumerated
4657 values are supported:
4658
4659 0 - Normal
4660
4661 1 - Radio Failure
4662
4663 2 - Software Failure
4664
4665 3 - Administratively Set
4666
4667 <span class="h4"><a class="selflink" id="section-4.6.35" href="#section-4.6.35">4.6.35</a>. Result Code</span>
4668
4669 The Result Code message element value is a 32-bit integer value,
4670 indicating the result of the Request message corresponding to the
4671 sequence number included in the Response message.
4672
4673 0 1 2 3
4674 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
4675 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4676 | Result Code |
4677 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4678
4679 Type: 33 for Result Code
4680
4681 Length: 4
4682
4683 Result Code: The following enumerated values are defined:
4684
4685 0 Success
4686
4687 1 Failure (AC List Message Element MUST Be Present)
4688
4689 2 Success (NAT Detected)
4690
4691 3 Join Failure (Unspecified)
4692
4693 4 Join Failure (Resource Depletion)
4694
4695 5 Join Failure (Unknown Source)
4696
4697
4698
4699
4700 <span class="grey">Calhoun, et al. Standards Track [Page 84]</span></pre>
4701 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-85" ></span>
4702 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4703
4704
4705 6 Join Failure (Incorrect Data)
4706
4707 7 Join Failure (Session ID Already in Use)
4708
4709 8 Join Failure (WTP Hardware Not Supported)
4710
4711 9 Join Failure (Binding Not Supported)
4712
4713 10 Reset Failure (Unable to Reset)
4714
4715 11 Reset Failure (Firmware Write Error)
4716
4717 12 Configuration Failure (Unable to Apply Requested Configuration
4718 - Service Provided Anyhow)
4719
4720 13 Configuration Failure (Unable to Apply Requested Configuration
4721 - Service Not Provided)
4722
4723 14 Image Data Error (Invalid Checksum)
4724
4725 15 Image Data Error (Invalid Data Length)
4726
4727 16 Image Data Error (Other Error)
4728
4729 17 Image Data Error (Image Already Present)
4730
4731 18 Message Unexpected (Invalid in Current State)
4732
4733 19 Message Unexpected (Unrecognized Request)
4734
4735 20 Failure - Missing Mandatory Message Element
4736
4737 21 Failure - Unrecognized Message Element
4738
4739 22 Data Transfer Error (No Information to Transfer)
4740
4741 <span class="h4"><a class="selflink" id="section-4.6.36" href="#section-4.6.36">4.6.36</a>. Returned Message Element</span>
4742
4743 The Returned Message Element is sent by the WTP in the Change State
4744 Event Request message to communicate to the AC which message elements
4745 in the Configuration Status Response it was unable to apply locally.
4746 The Returned Message Element message element contains a result code
4747 indicating the reason that the configuration could not be applied,
4748 and encapsulates the failed message element.
4749
4750
4751
4752
4753
4754
4755
4756 <span class="grey">Calhoun, et al. Standards Track [Page 85]</span></pre>
4757 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-86" ></span>
4758 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4759
4760
4761 0 1 2 3
4762 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
4763 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4764 | Reason | Length | Message Element...
4765 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4766
4767 Type: 34 for Returned Message Element
4768
4769 Length: &gt;= 6
4770
4771 Reason: The reason the configuration in the offending message
4772 element could not be applied by the WTP. The following enumerated
4773 values are supported:
4774
4775 0 - Reserved
4776
4777 1 - Unknown Message Element
4778
4779 2 - Unsupported Message Element
4780
4781 3 - Unknown Message Element Value
4782
4783 4 - Unsupported Message Element Value
4784
4785 Length: The length of the Message Element field, which MUST NOT
4786 exceed 255 octets.
4787
4788 Message Element: The Message Element field encapsulates the message
4789 element sent by the AC in the Configuration Status Response
4790 message that caused the error.
4791
4792 <span class="h4"><a class="selflink" id="section-4.6.37" href="#section-4.6.37">4.6.37</a>. Session ID</span>
4793
4794 The Session ID message element value contains a randomly generated
4795 unsigned 128-bit integer.
4796
4797 0 1 2 3
4798 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
4799 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4800 | Session ID |
4801 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4802 | Session ID |
4803 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4804 | Session ID |
4805 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4806 | Session ID |
4807 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4808
4809
4810
4811
4812 <span class="grey">Calhoun, et al. Standards Track [Page 86]</span></pre>
4813 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-87" ></span>
4814 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4815
4816
4817 Type: 35 for Session ID
4818
4819 Length: 16
4820
4821 Session ID: A 128-bit unsigned integer used as a random session
4822 identifier
4823
4824 <span class="h4"><a class="selflink" id="section-4.6.38" href="#section-4.6.38">4.6.38</a>. Statistics Timer</span>
4825
4826 The Statistics Timer message element value is used by the AC to
4827 inform the WTP of the frequency with which it expects to receive
4828 updated statistics.
4829
4830 0 1
4831 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
4832 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4833 | Statistics Timer |
4834 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4835
4836 Type: 36 for Statistics Timer
4837
4838 Length: 2
4839
4840 Statistics Timer: A 16-bit unsigned integer indicating the time, in
4841 seconds. The default value for this timer is specified in
4842 <a href="#section-4.7.14">Section 4.7.14</a>.
4843
4844 <span class="h4"><a class="selflink" id="section-4.6.39" href="#section-4.6.39">4.6.39</a>. Vendor Specific Payload</span>
4845
4846 The Vendor Specific Payload message element is used to communicate
4847 vendor-specific information between the WTP and the AC. The Vendor
4848 Specific Payload message element MAY be present in any CAPWAP
4849 message. The exchange of vendor-specific data between the MUST NOT
4850 modify the behavior of the base CAPWAP protocol and state machine.
4851 The message element uses the following format:
4852
4853 0 1 2 3
4854 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
4855 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4856 | Vendor Identifier |
4857 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4858 | Element ID | Data...
4859 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4860
4861 Type: 37 for Vendor Specific Payload
4862
4863 Length: &gt;= 7
4864
4865
4866
4867
4868 <span class="grey">Calhoun, et al. Standards Track [Page 87]</span></pre>
4869 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-88" ></span>
4870 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4871
4872
4873 Vendor Identifier: A 32-bit value containing the IANA-assigned "SMI
4874 Network Management Private Enterprise Codes" [<a href="./rfc3232" title="&quot;Assigned Numbers: RFC 1700 is Replaced by an On-line Database&quot;">RFC3232</a>].
4875
4876 Element ID: A 16-bit Element Identifier that is managed by the
4877 vendor.
4878
4879 Data: Variable-length vendor-specific information, whose contents
4880 and format are proprietary and understood based on the Element ID
4881 field. This field MUST NOT exceed 2048 octets.
4882
4883 <span class="h4"><a class="selflink" id="section-4.6.40" href="#section-4.6.40">4.6.40</a>. WTP Board Data</span>
4884
4885 The WTP Board Data message element is sent by the WTP to the AC and
4886 contains information about the hardware present.
4887
4888 0 1 2 3
4889 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
4890 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4891 | Vendor Identifier |
4892 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4893 | Board Data Sub-Element...
4894 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4895
4896 Type: 38 for WTP Board Data
4897
4898 Length: &gt;=14
4899
4900 Vendor Identifier: A 32-bit value containing the IANA-assigned "SMI
4901 Network Management Private Enterprise Codes", identifying the WTP
4902 hardware manufacturer. The Vendor Identifier field MUST NOT be
4903 set to zero.
4904
4905 Board Data Sub-Element: The WTP Board Data message element contains
4906 multiple Board Data sub-elements, some of which are mandatory and
4907 some are optional, as described below. The Board Data Type values
4908 are not extensible by vendors, and are therefore not coupled along
4909 with the Vendor Identifier field. The Board Data sub-element has
4910 the following format:
4911
4912 0 1 2 3
4913 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
4914 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4915 | Board Data Type | Board Data Length |
4916 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4917 | Board Data Value...
4918 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4919
4920
4921
4922
4923
4924 <span class="grey">Calhoun, et al. Standards Track [Page 88]</span></pre>
4925 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-89" ></span>
4926 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4927
4928
4929 Board Data Type: The Board Data Type field identifies the data
4930 being encoded. The CAPWAP protocol defines the following
4931 values, and each of these types identify whether their presence
4932 is mandatory or optional:
4933
4934 0 - WTP Model Number: The WTP Model Number MUST be included in
4935 the WTP Board Data message element.
4936
4937 1 - WTP Serial Number: The WTP Serial Number MUST be included in
4938 the WTP Board Data message element.
4939
4940 2 - Board ID: A hardware identifier, which MAY be included in
4941 the WTP Board Data message element.
4942
4943 3 - Board Revision: A revision number of the board, which MAY be
4944 included in the WTP Board Data message element.
4945
4946 4 - Base MAC Address: The WTP's Base MAC address, which MAY be
4947 assigned to the primary Ethernet interface.
4948
4949 Board Data Length: The length of the data in the Board Data Value
4950 field, whose length MUST NOT exceed 1024 octets.
4951
4952 Board Data Value: The data associated with the Board Data Type
4953 field for this Board Data sub-element.
4954
4955 <span class="h4"><a class="selflink" id="section-4.6.41" href="#section-4.6.41">4.6.41</a>. WTP Descriptor</span>
4956
4957 The WTP Descriptor message element is used by a WTP to communicate
4958 its current hardware and software (firmware) configuration. The
4959 value contains the following fields:
4960
4961 0 1 2 3
4962 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
4963 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4964 | Max Radios | Radios in use | Num Encrypt |Encryp Sub-Elmt|
4965 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4966 | Encryption Sub-Element | Descriptor Sub-Element...
4967 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4968
4969 Type: 39 for WTP Descriptor
4970
4971 Length: &gt;= 33
4972
4973
4974
4975
4976
4977
4978
4979
4980 <span class="grey">Calhoun, et al. Standards Track [Page 89]</span></pre>
4981 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-90" ></span>
4982 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
4983
4984
4985 Max Radios: An 8-bit value representing the number of radios (where
4986 each radio is identified via the Radio ID field) supported by the
4987 WTP.
4988
4989 Radios in use: An 8-bit value representing the number of radios in
4990 use in the WTP.
4991
4992 Num Encrypt: The number of 3-byte Encryption sub-elements that
4993 follow this field. The value of the Num Encrypt field MUST be
4994 between one (1) and 255.
4995
4996 Encryption Sub-Element: The WTP Descriptor message element MUST
4997 contain at least one Encryption sub-element. One sub-element is
4998 present for each binding supported by the WTP. The Encryption
4999 sub-element has the following format:
5000
5001 0 1 2
5002 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3
5003 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5004 |Resvd| WBID | Encryption Capabilities |
5005 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5006
5007 Resvd: The 3-bit field is reserved for future use. All
5008 implementations complying with this protocol MUST set to zero
5009 any bits that are reserved in the version of the protocol
5010 supported by that implementation. Receivers MUST ignore all
5011 bits not defined for the version of the protocol they support.
5012
5013 WBID: A 5-bit field that is the wireless binding identifier.
5014 The identifier will indicate the type of wireless packet
5015 associated with the radio. The WBIDs defined in this
5016 specification can be found in <a href="#section-4.3">Section 4.3</a>.
5017
5018 Encryption Capabilities: This 16-bit field is used by the WTP to
5019 communicate its capabilities to the AC. A WTP that does not
5020 have any encryption capabilities sets this field to zero (0).
5021 Refer to the specific wireless binding for further
5022 specification of the Encryption Capabilities field.
5023
5024 Descriptor Sub-Element: The WTP Descriptor message element contains
5025 multiple Descriptor sub-elements, some of which are mandatory and
5026 some are optional, as described below. The Descriptor sub-element
5027 has the following format:
5028
5029
5030
5031
5032
5033
5034
5035
5036 <span class="grey">Calhoun, et al. Standards Track [Page 90]</span></pre>
5037 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-91" ></span>
5038 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5039
5040
5041 0 1 2 3
5042 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
5043 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5044 | Descriptor Vendor Identifier |
5045 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5046 | Descriptor Type | Descriptor Length |
5047 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5048 | Descriptor Data...
5049 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5050
5051 Descriptor Vendor Identifier: A 32-bit value containing the
5052 IANA-assigned "SMI Network Management Private Enterprise
5053 Codes".
5054
5055 Descriptor Type: The Descriptor Type field identifies the data
5056 being encoded. The format of the data is vendor-specific
5057 encoded in the UTF-8 format [<a href="./rfc3629" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC3629</a>]. The CAPWAP protocol
5058 defines the following values, and each of these types identify
5059 whether their presence is mandatory or optional. The values
5060 listed below are used in conjunction with the Descriptor Vendor
5061 Identifier field, whose value MUST be set to zero (0). This
5062 field, combined with the Descriptor Vendor Identifier set to a
5063 non-zero (0) value, allows vendors to use a private namespace.
5064
5065 0 - Hardware Version: The WTP hardware version number MUST be
5066 present.
5067
5068 1 - Active Software Version: The WTP running software version
5069 number MUST be present.
5070
5071 2 - Boot Version: The WTP boot loader version number MUST be
5072 present.
5073
5074 3 - Other Software Version: The WTP non-running software
5075 (firmware) version number MAY be present. This type is
5076 used to communicate alternate software versions that are
5077 available on the WTP's non-volatile storage.
5078
5079 Descriptor Length: Length of the vendor-specific encoding of the
5080 Descriptor Data field, whose length MUST NOT exceed 1024
5081 octets.
5082
5083 Descriptor Data: Vendor-specific data of WTP information encoded
5084 in the UTF-8 format [<a href="./rfc3629" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC3629</a>].
5085
5086
5087
5088
5089
5090
5091
5092 <span class="grey">Calhoun, et al. Standards Track [Page 91]</span></pre>
5093 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-92" ></span>
5094 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5095
5096
5097 <span class="h4"><a class="selflink" id="section-4.6.42" href="#section-4.6.42">4.6.42</a>. WTP Fallback</span>
5098
5099 The WTP Fallback message element is sent by the AC to the WTP to
5100 enable or disable automatic CAPWAP fallback in the event that a WTP
5101 detects its preferred AC to which it is not currently connected.
5102
5103 0
5104 0 1 2 3 4 5 6 7
5105 +-+-+-+-+-+-+-+-+
5106 | Mode |
5107 +-+-+-+-+-+-+-+-+
5108
5109 Type: 40 for WTP Fallback
5110
5111 Length: 1
5112
5113 Mode: The 8-bit value indicates the status of automatic CAPWAP
5114 fallback on the WTP. When enabled, if the WTP detects that its
5115 primary AC is available, and that the WTP is not connected to the
5116 primary AC, the WTP SHOULD automatically disconnect from its
5117 current AC and reconnect to its primary AC. If disabled, the WTP
5118 will only reconnect to its primary AC through manual intervention
5119 (e.g., through the Reset Request message). The default value for
5120 this field is specified in <a href="#section-4.8.9">Section 4.8.9</a>. The following
5121 enumerated values are supported:
5122
5123 0 - Reserved
5124
5125 1 - Enabled
5126
5127 2 - Disabled
5128
5129 <span class="h4"><a class="selflink" id="section-4.6.43" href="#section-4.6.43">4.6.43</a>. WTP Frame Tunnel Mode</span>
5130
5131 The WTP Frame Tunnel Mode message element allows the WTP to
5132 communicate the tunneling modes of operation that it supports to the
5133 AC. A WTP that advertises support for all types allows the AC to
5134 select which type will be used, based on its local policy.
5135
5136 0
5137 0 1 2 3 4 5 6 7
5138 +-+-+-+-+-+-+-+-+
5139 |Reservd|N|E|L|U|
5140 +-+-+-+-+-+-+-+-+
5141
5142
5143
5144
5145
5146
5147
5148 <span class="grey">Calhoun, et al. Standards Track [Page 92]</span></pre>
5149 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-93" ></span>
5150 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5151
5152
5153 Type: 41 for WTP Frame Tunnel Mode
5154
5155 Length: 1
5156
5157 Reservd: A set of reserved bits for future use. All
5158 implementations complying with this protocol MUST set to zero any
5159 bits that are reserved in the version of the protocol supported by
5160 that implementation. Receivers MUST ignore all bits not defined
5161 for the version of the protocol they support.
5162
5163 N: Native Frame Tunnel mode requires the WTP and AC to encapsulate
5164 all user payloads as native wireless frames, as defined by the
5165 wireless binding (see for example <a href="#section-4.4">Section 4.4</a>)
5166
5167 E: The 802.3 Frame Tunnel Mode requires the WTP and AC to
5168 encapsulate all user payload as native IEEE 802.3 frames (see
5169 <a href="#section-4.4">Section 4.4</a>). All user traffic is tunneled to the AC. This
5170 value MUST NOT be used when the WTP MAC Type is set to Split
5171 MAC.
5172
5173 L: When Local Bridging is used, the WTP does not tunnel user
5174 traffic to the AC; all user traffic is locally bridged. This
5175 value MUST NOT be used when the WTP MAC Type is set to Split
5176 MAC.
5177
5178 R: A reserved bit for future use. All implementations complying
5179 with this protocol MUST set to zero any bits that are reserved
5180 in the version of the protocol supported by that
5181 implementation. Receivers MUST ignore all bits not defined for
5182 the version of the protocol they support.
5183
5184 <span class="h4"><a class="selflink" id="section-4.6.44" href="#section-4.6.44">4.6.44</a>. WTP MAC Type</span>
5185
5186 The WTP MAC-Type message element allows the WTP to communicate its
5187 mode of operation to the AC. A WTP that advertises support for both
5188 modes allows the AC to select the mode to use, based on local policy.
5189
5190 0
5191 0 1 2 3 4 5 6 7
5192 +-+-+-+-+-+-+-+-+
5193 | MAC Type |
5194 +-+-+-+-+-+-+-+-+
5195
5196 Type: 44 for WTP MAC Type
5197
5198
5199
5200
5201
5202
5203
5204 <span class="grey">Calhoun, et al. Standards Track [Page 93]</span></pre>
5205 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-94" ></span>
5206 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5207
5208
5209 Length: 1
5210
5211 MAC Type: The MAC mode of operation supported by the WTP. The
5212 following enumerated values are supported:
5213
5214 0 - Local MAC: Local MAC is the default mode that MUST be
5215 supported by all WTPs. When tunneling is enabled (see
5216 <a href="#section-4.6.43">Section 4.6.43</a>), the encapsulated frames MUST be in the
5217 802.3 format (see <a href="#section-4.4.2">Section 4.4.2</a>), unless a wireless
5218 management or control frame which MAY be in its native
5219 format. Any CAPWAP binding needs to specify the format of
5220 management and control wireless frames.
5221
5222 1 - Split MAC: Split MAC support is optional, and allows the AC
5223 to receive and process native wireless frames.
5224
5225 2 - Both: WTP is capable of supporting both Local MAC and Split
5226 MAC.
5227
5228 <span class="h4"><a class="selflink" id="section-4.6.45" href="#section-4.6.45">4.6.45</a>. WTP Name</span>
5229
5230 The WTP Name message element is a variable-length byte UTF-8 encoded
5231 string [<a href="./rfc3629" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC3629</a>]. The string is not zero terminated.
5232
5233 0
5234 0 1 2 3 4 5 6 7
5235 +-+-+-+-+-+-+-+-+-
5236 | WTP Name ...
5237 +-+-+-+-+-+-+-+-+-
5238
5239 Type: 45 for WTP Name
5240
5241 Length: &gt;= 1
5242
5243 WTP Name: A non-zero-terminated UTF-8 encoded string [<a href="./rfc3629" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC3629</a>]
5244 containing the WTP name, whose maximum size MUST NOT exceed 512
5245 bytes.
5246
5247 <span class="h4"><a class="selflink" id="section-4.6.46" href="#section-4.6.46">4.6.46</a>. WTP Radio Statistics</span>
5248
5249 The WTP Radio Statistics message element is sent by the WTP to the AC
5250 to communicate statistics on radio behavior and reasons why the WTP
5251 radio has been reset. These counters are never reset on the WTP, and
5252 will therefore roll over to zero when the maximum size has been
5253 reached.
5254
5255
5256
5257
5258
5259
5260 <span class="grey">Calhoun, et al. Standards Track [Page 94]</span></pre>
5261 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-95" ></span>
5262 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5263
5264
5265 0 1 2 3
5266 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
5267 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5268 | Radio ID | Last Fail Type| Reset Count |
5269 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5270 | SW Failure Count | HW Failure Count |
5271 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5272 | Other Failure Count | Unknown Failure Count |
5273 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5274 | Config Update Count | Channel Change Count |
5275 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5276 | Band Change Count | Current Noise Floor |
5277 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5278
5279 Type: 47 for WTP Radio Statistics
5280
5281 Length: 20
5282
5283 Radio ID: The radio ID of the radio to which the statistics apply,
5284 whose value is between one (1) and 31.
5285
5286 Last Failure Type: The last WTP failure. The following enumerated
5287 values are supported:
5288
5289 0 - Statistic Not Supported
5290
5291 1 - Software Failure
5292
5293 2 - Hardware Failure
5294
5295 3 - Other Failure
5296
5297 255 - Unknown (e.g., WTP doesn't keep track of info)
5298
5299 Reset Count: The number of times that the radio has been reset.
5300
5301 SW Failure Count: The number of times that the radio has failed due
5302 to software-related reasons.
5303
5304 HW Failure Count: The number of times that the radio has failed due
5305 to hardware-related reasons.
5306
5307 Other Failure Count: The number of times that the radio has failed
5308 due to known reasons, other than software or hardware failure.
5309
5310
5311
5312
5313
5314
5315
5316 <span class="grey">Calhoun, et al. Standards Track [Page 95]</span></pre>
5317 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-96" ></span>
5318 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5319
5320
5321 Unknown Failure Count: The number of times that the radio has
5322 failed for unknown reasons.
5323
5324 Config Update Count: The number of times that the radio
5325 configuration has been updated.
5326
5327 Channel Change Count: The number of times that the radio channel
5328 has been changed.
5329
5330 Band Change Count: The number of times that the radio has changed
5331 frequency bands.
5332
5333 Current Noise Floor: A signed integer that indicates the noise
5334 floor of the radio receiver in units of dBm.
5335
5336 <span class="h4"><a class="selflink" id="section-4.6.47" href="#section-4.6.47">4.6.47</a>. WTP Reboot Statistics</span>
5337
5338 The WTP Reboot Statistics message element is sent by the WTP to the
5339 AC to communicate reasons why WTP reboots have occurred. These
5340 counters are never reset on the WTP, and will therefore roll over to
5341 zero when the maximum size has been reached.
5342
5343 0 1 2 3
5344 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
5345 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5346 | Reboot Count | AC Initiated Count |
5347 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5348 | Link Failure Count | SW Failure Count |
5349 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5350 | HW Failure Count | Other Failure Count |
5351 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5352 | Unknown Failure Count |Last Failure Type|
5353 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5354
5355 Type: 48 for WTP Reboot Statistics
5356
5357 Length: 15
5358
5359 Reboot Count: The number of reboots that have occurred due to a WTP
5360 crash. A value of 65535 implies that this information is not
5361 available on the WTP.
5362
5363 AC Initiated Count: The number of reboots that have occurred at the
5364 request of a CAPWAP protocol message, such as a change in
5365 configuration that required a reboot or an explicit CAPWAP
5366 protocol reset request. A value of 65535 implies that this
5367 information is not available on the WTP.
5368
5369
5370
5371
5372 <span class="grey">Calhoun, et al. Standards Track [Page 96]</span></pre>
5373 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-97" ></span>
5374 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5375
5376
5377 Link Failure Count: The number of times that a CAPWAP protocol
5378 connection with an AC has failed due to link failure.
5379
5380 SW Failure Count: The number of times that a CAPWAP protocol
5381 connection with an AC has failed due to software-related reasons.
5382
5383 HW Failure Count: The number of times that a CAPWAP protocol
5384 connection with an AC has failed due to hardware-related reasons.
5385
5386 Other Failure Count: The number of times that a CAPWAP protocol
5387 connection with an AC has failed due to known reasons, other than
5388 AC initiated, link, SW or HW failure.
5389
5390 Unknown Failure Count: The number of times that a CAPWAP protocol
5391 connection with an AC has failed for unknown reasons.
5392
5393 Last Failure Type: The failure type of the most recent WTP failure.
5394 The following enumerated values are supported:
5395
5396 0 - Not Supported
5397
5398 1 - AC Initiated (see <a href="#section-9.2">Section 9.2</a>)
5399
5400 2 - Link Failure
5401
5402 3 - Software Failure
5403
5404 4 - Hardware Failure
5405
5406 5 - Other Failure
5407
5408 255 - Unknown (e.g., WTP doesn't keep track of info)
5409
5410 <span class="h4"><a class="selflink" id="section-4.6.48" href="#section-4.6.48">4.6.48</a>. WTP Static IP Address Information</span>
5411
5412 The WTP Static IP Address Information message element is used by an
5413 AC to configure or clear a previously configured static IP address on
5414 a WTP. IPv6 WTPs are expected to use dynamic addresses.
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428 <span class="grey">Calhoun, et al. Standards Track [Page 97]</span></pre>
5429 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-98" ></span>
5430 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5431
5432
5433 0 1 2 3
5434 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
5435 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5436 | IP Address |
5437 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5438 | Netmask |
5439 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5440 | Gateway |
5441 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5442 | Static |
5443 +-+-+-+-+-+-+-+-+
5444
5445 Type: 49 for WTP Static IP Address Information
5446
5447 Length: 13
5448
5449 IP Address: The IP address to assign to the WTP. This field is
5450 only valid if the static field is set to one.
5451
5452 Netmask: The IP Netmask. This field is only valid if the static
5453 field is set to one.
5454
5455 Gateway: The IP address of the gateway. This field is only valid
5456 if the static field is set to one.
5457
5458 Static: An 8-bit Boolean stating whether or not the WTP should use
5459 a static IP address. A value of zero disables the static IP
5460 address, while a value of one enables it.
5461
5462 <span class="h3"><a class="selflink" id="section-4.7" href="#section-4.7">4.7</a>. CAPWAP Protocol Timers</span>
5463
5464 This section contains the definition of the CAPWAP timers.
5465
5466 <span class="h4"><a class="selflink" id="section-4.7.1" href="#section-4.7.1">4.7.1</a>. ChangeStatePendingTimer</span>
5467
5468 The maximum time, in seconds, the AC will wait for the Change State
5469 Event Request from the WTP after having transmitted a successful
5470 Configuration Status Response message.
5471
5472 Default: 25 seconds
5473
5474 <span class="h4"><a class="selflink" id="section-4.7.2" href="#section-4.7.2">4.7.2</a>. DataChannelKeepAlive</span>
5475
5476 The DataChannelKeepAlive timer is used by the WTP to determine the
5477 next opportunity when it must transmit the Data Channel Keep-Alive,
5478 in seconds.
5479
5480 Default: 30 seconds
5481
5482
5483
5484 <span class="grey">Calhoun, et al. Standards Track [Page 98]</span></pre>
5485 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-99" ></span>
5486 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5487
5488
5489 <span class="h4"><a class="selflink" id="section-4.7.3" href="#section-4.7.3">4.7.3</a>. DataChannelDeadInterval</span>
5490
5491 The minimum time, in seconds, a WTP MUST wait without having received
5492 a Data Channel Keep-Alive packet before the destination for the Data
5493 Channel Keep-Alive packets may be considered dead. The value of this
5494 timer MUST be no less than 2*DataChannelKeepAlive seconds and no
5495 greater that 240 seconds.
5496
5497 Default: 60
5498
5499 <span class="h4"><a class="selflink" id="section-4.7.4" href="#section-4.7.4">4.7.4</a>. DataCheckTimer</span>
5500
5501 The number of seconds the AC will wait for the Data Channel Keep
5502 Alive, which is required by the CAPWAP state machine's Data Check
5503 state. The AC resets the state machine if this timer expires prior
5504 to transitioning to the next state.
5505
5506 Default: 30
5507
5508 <span class="h4"><a class="selflink" id="section-4.7.5" href="#section-4.7.5">4.7.5</a>. DiscoveryInterval</span>
5509
5510 The minimum time, in seconds, that a WTP MUST wait after receiving a
5511 Discovery Response message, before initiating a DTLS handshake.
5512
5513 Default: 5
5514
5515 <span class="h4"><a class="selflink" id="section-4.7.6" href="#section-4.7.6">4.7.6</a>. DTLSSessionDelete</span>
5516
5517 The minimum time, in seconds, a WTP MUST wait for DTLS session
5518 deletion.
5519
5520 Default: 5
5521
5522 <span class="h4"><a class="selflink" id="section-4.7.7" href="#section-4.7.7">4.7.7</a>. EchoInterval</span>
5523
5524 The minimum time, in seconds, between sending Echo Request messages
5525 to the AC with which the WTP has joined.
5526
5527 Default: 30
5528
5529 <span class="h4"><a class="selflink" id="section-4.7.8" href="#section-4.7.8">4.7.8</a>. IdleTimeout</span>
5530
5531 The default Idle Timeout is 300 seconds.
5532
5533
5534
5535
5536
5537
5538
5539
5540 <span class="grey">Calhoun, et al. Standards Track [Page 99]</span></pre>
5541 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-100" ></span>
5542 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5543
5544
5545 <span class="h4"><a class="selflink" id="section-4.7.9" href="#section-4.7.9">4.7.9</a>. ImageDataStartTimer</span>
5546
5547 The number of seconds the WTP will wait for its peer to transmit the
5548 Image Data Request.
5549
5550 Default: 30
5551
5552 <span class="h4"><a class="selflink" id="section-4.7.10" href="#section-4.7.10">4.7.10</a>. MaxDiscoveryInterval</span>
5553
5554 The maximum time allowed between sending Discovery Request messages,
5555 in seconds. This value MUST be no less than 2 seconds and no greater
5556 than 180 seconds.
5557
5558 Default: 20 seconds.
5559
5560 <span class="h4"><a class="selflink" id="section-4.7.11" href="#section-4.7.11">4.7.11</a>. ReportInterval</span>
5561
5562 The ReportInterval is used by the WTP to determine the interval the
5563 WTP uses between sending the Decryption Error message elements to
5564 inform the AC of decryption errors, in seconds.
5565
5566 The default Report Interval is 120 seconds.
5567
5568 <span class="h4"><a class="selflink" id="section-4.7.12" href="#section-4.7.12">4.7.12</a>. RetransmitInterval</span>
5569
5570 The minimum time, in seconds, in which a non-acknowledged CAPWAP
5571 packet will be retransmitted.
5572
5573 Default: 3
5574
5575 <span class="h4"><a class="selflink" id="section-4.7.13" href="#section-4.7.13">4.7.13</a>. SilentInterval</span>
5576
5577 For a WTP, this is the minimum time, in seconds, a WTP MUST wait
5578 before it MAY again send Discovery Request messages or attempt to
5579 establish a DTLS session. For an AC, this is the minimum time, in
5580 seconds, during which the AC SHOULD ignore all CAPWAP and DTLS
5581 packets received from the WTP that is in the Sulking state.
5582
5583 Default: 30 seconds
5584
5585 <span class="h4"><a class="selflink" id="section-4.7.14" href="#section-4.7.14">4.7.14</a>. StatisticsTimer</span>
5586
5587 The StatisticsTimer is used by the WTP to determine the interval the
5588 WTP uses between the WTP Events Requests it transmits to the AC to
5589 communicate its statistics, in seconds.
5590
5591 Default: 120 seconds
5592
5593
5594
5595
5596 <span class="grey">Calhoun, et al. Standards Track [Page 100]</span></pre>
5597 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-101" ></span>
5598 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5599
5600
5601 <span class="h4"><a class="selflink" id="section-4.7.15" href="#section-4.7.15">4.7.15</a>. WaitDTLS</span>
5602
5603 The maximum time, in seconds, a WTP MUST wait without having received
5604 a DTLS Handshake message from an AC. This timer MUST be greater than
5605 30 seconds.
5606
5607 Default: 60
5608
5609 <span class="h4"><a class="selflink" id="section-4.7.16" href="#section-4.7.16">4.7.16</a>. WaitJoin</span>
5610
5611 The maximum time, in seconds, an AC will wait after the DTLS session
5612 has been established until it receives the Join Request from the WTP.
5613 This timer MUST be greater than 20 seconds.
5614
5615 Default: 60
5616
5617 <span class="h3"><a class="selflink" id="section-4.8" href="#section-4.8">4.8</a>. CAPWAP Protocol Variables</span>
5618
5619 This section defines the CAPWAP protocol variables, which are used
5620 for various protocol functions. Some of these variables are
5621 configurable, while others are counters or have a fixed value. For
5622 non-counter-related variables, default values are specified.
5623 However, when a WTP's variable configuration is explicitly overridden
5624 by an AC, the WTP MUST save the new value.
5625
5626 <span class="h4"><a class="selflink" id="section-4.8.1" href="#section-4.8.1">4.8.1</a>. AdminState</span>
5627
5628 The default Administrative State value is enabled (1).
5629
5630 <span class="h4"><a class="selflink" id="section-4.8.2" href="#section-4.8.2">4.8.2</a>. DiscoveryCount</span>
5631
5632 The number of Discovery Request messages transmitted by a WTP to a
5633 single AC. This is a monotonically increasing counter.
5634
5635 <span class="h4"><a class="selflink" id="section-4.8.3" href="#section-4.8.3">4.8.3</a>. FailedDTLSAuthFailCount</span>
5636
5637 The number of failed DTLS session establishment attempts due to
5638 authentication failures.
5639
5640 <span class="h4"><a class="selflink" id="section-4.8.4" href="#section-4.8.4">4.8.4</a>. FailedDTLSSessionCount</span>
5641
5642 The number of failed DTLS session establishment attempts.
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652 <span class="grey">Calhoun, et al. Standards Track [Page 101]</span></pre>
5653 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-102" ></span>
5654 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5655
5656
5657 <span class="h4"><a class="selflink" id="section-4.8.5" href="#section-4.8.5">4.8.5</a>. MaxDiscoveries</span>
5658
5659 The maximum number of Discovery Request messages that will be sent
5660 after a WTP boots.
5661
5662 Default: 10
5663
5664 <span class="h4"><a class="selflink" id="section-4.8.6" href="#section-4.8.6">4.8.6</a>. MaxFailedDTLSSessionRetry</span>
5665
5666 The maximum number of failed DTLS session establishment attempts
5667 before the CAPWAP device enters a silent period.
5668
5669 Default: 3
5670
5671 <span class="h4"><a class="selflink" id="section-4.8.7" href="#section-4.8.7">4.8.7</a>. MaxRetransmit</span>
5672
5673 The maximum number of retransmissions for a given CAPWAP packet
5674 before the link layer considers the peer dead.
5675
5676 Default: 5
5677
5678 <span class="h4"><a class="selflink" id="section-4.8.8" href="#section-4.8.8">4.8.8</a>. RetransmitCount</span>
5679
5680 The number of retransmissions for a given CAPWAP packet. This is a
5681 monotonically increasing counter.
5682
5683 <span class="h4"><a class="selflink" id="section-4.8.9" href="#section-4.8.9">4.8.9</a>. WTPFallBack</span>
5684
5685 The default WTP Fallback value is enabled (1).
5686
5687 <span class="h3"><a class="selflink" id="section-4.9" href="#section-4.9">4.9</a>. WTP Saved Variables</span>
5688
5689 In addition to the values defined in <a href="#section-4.8">Section 4.8</a>, the following
5690 values SHOULD be saved on the WTP in non-volatile memory. CAPWAP
5691 wireless bindings MAY define additional values that SHOULD be stored
5692 on the WTP.
5693
5694 <span class="h4"><a class="selflink" id="section-4.9.1" href="#section-4.9.1">4.9.1</a>. AdminRebootCount</span>
5695
5696 The number of times the WTP has rebooted administratively, defined in
5697 <a href="#section-4.6.47">Section 4.6.47</a>.
5698
5699 <span class="h4"><a class="selflink" id="section-4.9.2" href="#section-4.9.2">4.9.2</a>. FrameEncapType</span>
5700
5701 For WTPs that support multiple Frame Encapsulation Types, it is
5702 useful to save the value configured by the AC. The Frame
5703 Encapsulation Type is defined in <a href="#section-4.6.43">Section 4.6.43</a>.
5704
5705
5706
5707
5708 <span class="grey">Calhoun, et al. Standards Track [Page 102]</span></pre>
5709 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-103" ></span>
5710 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5711
5712
5713 <span class="h4"><a class="selflink" id="section-4.9.3" href="#section-4.9.3">4.9.3</a>. LastRebootReason</span>
5714
5715 The reason why the WTP last rebooted, defined in <a href="#section-4.6.47">Section 4.6.47</a>.
5716
5717 <span class="h4"><a class="selflink" id="section-4.9.4" href="#section-4.9.4">4.9.4</a>. MacType</span>
5718
5719 For WTPs that support multiple MAC-Types, it is useful to save the
5720 value configured by the AC. The MAC-Type is defined in
5721 <a href="#section-4.6.44">Section 4.6.44</a>.
5722
5723 <span class="h4"><a class="selflink" id="section-4.9.5" href="#section-4.9.5">4.9.5</a>. PreferredACs</span>
5724
5725 The preferred ACs, with the index, defined in <a href="#section-4.6.5">Section 4.6.5</a>.
5726
5727 <span class="h4"><a class="selflink" id="section-4.9.6" href="#section-4.9.6">4.9.6</a>. RebootCount</span>
5728
5729 The number of times the WTP has rebooted, defined in <a href="#section-4.6.47">Section 4.6.47</a>.
5730
5731 <span class="h4"><a class="selflink" id="section-4.9.7" href="#section-4.9.7">4.9.7</a>. Static IP Address</span>
5732
5733 The static IP address assigned to the WTP, as configured by the WTP
5734 Static IP address Information message element (see <a href="#section-4.6.48">Section 4.6.48</a>).
5735
5736 <span class="h4"><a class="selflink" id="section-4.9.8" href="#section-4.9.8">4.9.8</a>. WTPLinkFailureCount</span>
5737
5738 The number of times the link to the AC has failed, see
5739 <a href="#section-4.6.47">Section 4.6.47</a>.
5740
5741 <span class="h4"><a class="selflink" id="section-4.9.9" href="#section-4.9.9">4.9.9</a>. WTPLocation</span>
5742
5743 The WTP Location, defined in <a href="#section-4.6.30">Section 4.6.30</a>.
5744
5745 <span class="h4"><a class="selflink" id="section-4.9.10" href="#section-4.9.10">4.9.10</a>. WTPName</span>
5746
5747 The WTP Name, defined in <a href="#section-4.6.45">Section 4.6.45</a>.
5748
5749 <span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. CAPWAP Discovery Operations</span>
5750
5751 The Discovery messages are used by a WTP to determine which ACs are
5752 available to provide service, and the capabilities and load of the
5753 ACs.
5754
5755 <span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. Discovery Request Message</span>
5756
5757 The Discovery Request message is used by the WTP to automatically
5758 discover potential ACs available in the network. The Discovery
5759 Request message provides ACs with the primary capabilities of the
5760
5761
5762
5763
5764 <span class="grey">Calhoun, et al. Standards Track [Page 103]</span></pre>
5765 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-104" ></span>
5766 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5767
5768
5769 WTP. A WTP must exchange this information to ensure subsequent
5770 exchanges with the ACs are consistent with the WTP's functional
5771 characteristics.
5772
5773 Discovery Request messages MUST be sent by a WTP in the Discover
5774 state after waiting for a random delay less than
5775 MaxDiscoveryInterval, after a WTP first comes up or is
5776 (re)initialized. A WTP MUST send no more than the maximum of
5777 MaxDiscoveries Discovery Request messages, waiting for a random delay
5778 less than MaxDiscoveryInterval between each successive message.
5779
5780 This is to prevent an explosion of WTP Discovery Request messages.
5781 An example of this occurring is when many WTPs are powered on at the
5782 same time.
5783
5784 If a Discovery Response message is not received after sending the
5785 maximum number of Discovery Request messages, the WTP enters the
5786 Sulking state and MUST wait for an interval equal to SilentInterval
5787 before sending further Discovery Request messages.
5788
5789 Upon receiving a Discovery Request message, the AC will respond with
5790 a Discovery Response message sent to the address in the source
5791 address of the received Discovery Request message. Once a Discovery
5792 Response has been received, if the WTP decides to establish a session
5793 with the responding AC, it SHOULD perform an MTU discovery, using the
5794 process described in <a href="#section-3.5">Section 3.5</a>.
5795
5796 It is possible for the AC to receive a clear text Discovery Request
5797 message while a DTLS session is already active with the WTP. This is
5798 most likely the case if the WTP has rebooted, perhaps due to a
5799 software or power failure, but could also be caused by a DoS attack.
5800 In such cases, any WTP state, including the state machine instance,
5801 MUST NOT be cleared until another DTLS session has been successfully
5802 established, communicated via the DTLSSessionEstablished DTLS
5803 notification (see <a href="#section-2.3.2.2">Section 2.3.2.2</a>).
5804
5805 The binding specific WTP Radio Information message element (see
5806 <a href="#section-2.1">Section 2.1</a>) is included in the Discovery Request message to
5807 advertise WTP support for one or more CAPWAP bindings.
5808
5809 The Discovery Request message is sent by the WTP when in the
5810 Discovery state. The AC does not transmit this message.
5811
5812 The following message elements MUST be included in the Discovery
5813 Request message:
5814
5815 o Discovery Type, see <a href="#section-4.6.21">Section 4.6.21</a>
5816
5817
5818
5819
5820 <span class="grey">Calhoun, et al. Standards Track [Page 104]</span></pre>
5821 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-105" ></span>
5822 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5823
5824
5825 o WTP Board Data, see <a href="#section-4.6.40">Section 4.6.40</a>
5826
5827 o WTP Descriptor, see <a href="#section-4.6.41">Section 4.6.41</a>
5828
5829 o WTP Frame Tunnel Mode, see <a href="#section-4.6.43">Section 4.6.43</a>
5830
5831 o WTP MAC Type, see <a href="#section-4.6.44">Section 4.6.44</a>
5832
5833 o WTP Radio Information message element(s) that the WTP supports;
5834 These are defined by the individual link layer CAPWAP Binding
5835 Protocols (see <a href="#section-2.1">Section 2.1</a>).
5836
5837 The following message elements MAY be included in the Discovery
5838 Request message:
5839
5840 o MTU Discovery Padding, see <a href="#section-4.6.32">Section 4.6.32</a>
5841
5842 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
5843
5844 <span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>. Discovery Response Message</span>
5845
5846 The Discovery Response message provides a mechanism for an AC to
5847 advertise its services to requesting WTPs.
5848
5849 When a WTP receives a Discovery Response message, it MUST wait for an
5850 interval not less than DiscoveryInterval for receipt of additional
5851 Discovery Response messages. After the DiscoveryInterval elapses,
5852 the WTP enters the DTLS-Init state and selects one of the ACs that
5853 sent a Discovery Response message and send a DTLS Handshake to that
5854 AC.
5855
5856 One or more binding-specific WTP Radio Information message elements
5857 (see <a href="#section-2.1">Section 2.1</a>) are included in the Discovery Request message to
5858 advertise AC support for the CAPWAP bindings. The AC MAY include
5859 only the bindings it shares in common with the WTP, known through the
5860 WTP Radio Information message elements received in the Discovery
5861 Request message, or it MAY include all of the bindings supported.
5862 The WTP MAY use the supported bindings in its AC decision process.
5863 Note that if the WTP joins an AC that does not support a specific
5864 CAPWAP binding, service for that binding MUST NOT be provided by the
5865 WTP.
5866
5867 The Discovery Response message is sent by the AC when in the Idle
5868 state. The WTP does not transmit this message.
5869
5870 The following message elements MUST be included in the Discovery
5871 Response Message:
5872
5873
5874
5875
5876 <span class="grey">Calhoun, et al. Standards Track [Page 105]</span></pre>
5877 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-106" ></span>
5878 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5879
5880
5881 o AC Descriptor, see <a href="#section-4.6.1">Section 4.6.1</a>
5882
5883 o AC Name, see <a href="#section-4.6.4">Section 4.6.4</a>
5884
5885 o WTP Radio Information message element(s) that the AC supports;
5886 these are defined by the individual link layer CAPWAP Binding
5887 Protocols (see <a href="#section-2.1">Section 2.1</a> for more information).
5888
5889 o One of the following message elements MUST be included in the
5890 Discovery Response Message:
5891
5892 * CAPWAP Control IPv4 Address, see <a href="#section-4.6.9">Section 4.6.9</a>
5893
5894 * CAPWAP Control IPv6 Address, see <a href="#section-4.6.10">Section 4.6.10</a>
5895
5896 The following message elements MAY be included in the Discovery
5897 Response message:
5898
5899 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
5900
5901 <span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a>. Primary Discovery Request Message</span>
5902
5903 The Primary Discovery Request message is sent by the WTP to:
5904
5905 o determine whether its preferred (or primary) AC is available, or
5906
5907 o perform a Path MTU Discovery (see <a href="#section-3.5">Section 3.5</a>).
5908
5909 A Primary Discovery Request message is sent by a WTP when it has a
5910 primary AC configured, and is connected to another AC. This
5911 generally occurs as a result of a failover, and is used by the WTP as
5912 a means to discover when its primary AC becomes available. Since the
5913 WTP only has a single instance of the CAPWAP state machine, the
5914 Primary Discovery Request is sent by the WTP when in the Run state.
5915 The AC does not transmit this message.
5916
5917 The frequency of the Primary Discovery Request messages should be no
5918 more often than the sending of the Echo Request message.
5919
5920 Upon receipt of a Primary Discovery Request message, the AC responds
5921 with a Primary Discovery Response message sent to the address in the
5922 source address of the received Primary Discovery Request message.
5923
5924 The following message elements MUST be included in the Primary
5925 Discovery Request message.
5926
5927 o Discovery Type, see <a href="#section-4.6.21">Section 4.6.21</a>
5928
5929
5930
5931
5932 <span class="grey">Calhoun, et al. Standards Track [Page 106]</span></pre>
5933 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-107" ></span>
5934 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5935
5936
5937 o WTP Board Data, see <a href="#section-4.6.40">Section 4.6.40</a>
5938
5939 o WTP Descriptor, see <a href="#section-4.6.41">Section 4.6.41</a>
5940
5941 o WTP Frame Tunnel Mode, see <a href="#section-4.6.43">Section 4.6.43</a>
5942
5943 o WTP MAC Type, see <a href="#section-4.6.44">Section 4.6.44</a>
5944
5945 o WTP Radio Information message element(s) that the WTP supports;
5946 these are defined by the individual link layer CAPWAP Binding
5947 Protocols (see <a href="#section-2.1">Section 2.1</a> for more information).
5948
5949 The following message elements MAY be included in the Primary
5950 Discovery Request message:
5951
5952 o MTU Discovery Padding, see <a href="#section-4.6.32">Section 4.6.32</a>
5953
5954 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
5955
5956 <span class="h3"><a class="selflink" id="section-5.4" href="#section-5.4">5.4</a>. Primary Discovery Response</span>
5957
5958 The Primary Discovery Response message enables an AC to advertise its
5959 availability and services to requesting WTPs that are configured to
5960 have the AC as its primary AC.
5961
5962 The Primary Discovery Response message is sent by an AC after
5963 receiving a Primary Discovery Request message.
5964
5965 When a WTP receives a Primary Discovery Response message, it may
5966 establish a CAPWAP protocol connection to its primary AC, based on
5967 the configuration of the WTP Fallback Status message element on the
5968 WTP.
5969
5970 The Primary Discovery Response message is sent by the AC when in the
5971 Idle state. The WTP does not transmit this message.
5972
5973 The following message elements MUST be included in the Primary
5974 Discovery Response message.
5975
5976 o AC Descriptor, see <a href="#section-4.6.1">Section 4.6.1</a>
5977
5978 o AC Name, see <a href="#section-4.6.4">Section 4.6.4</a>
5979
5980 o WTP Radio Information message element(s) that the AC supports;
5981 These are defined by the individual link layer CAPWAP Binding
5982 Protocols (see <a href="#section-2.1">Section 2.1</a> for more information).
5983
5984
5985
5986
5987
5988 <span class="grey">Calhoun, et al. Standards Track [Page 107]</span></pre>
5989 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-108" ></span>
5990 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
5991
5992
5993 One of the following message elements MUST be included in the
5994 Discovery Response Message:
5995
5996 o CAPWAP Control IPv4 Address, see <a href="#section-4.6.9">Section 4.6.9</a>
5997
5998 o CAPWAP Control IPv6 Address, see <a href="#section-4.6.10">Section 4.6.10</a>
5999
6000 The following message elements MAY be included in the Primary
6001 Discovery Response message:
6002
6003 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
6004
6005 <span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. CAPWAP Join Operations</span>
6006
6007 The Join Request message is used by a WTP to request service from an
6008 AC after a DTLS connection is established to that AC. The Join
6009 Response message is used by the AC to indicate that it will or will
6010 not provide service.
6011
6012 <span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>. Join Request</span>
6013
6014 The Join Request message is used by a WTP to request service through
6015 the AC. If the WTP is performing the optional AC Discovery process
6016 (see <a href="#section-3.3">Section 3.3</a>), the join process occurs after the WTP has received
6017 one or more Discovery Response messages. During the Discovery
6018 process, an AC MAY return more than one CAPWAP Control IPv4 Address
6019 or CAPWAP Control IPv6 Address message elements. When more than one
6020 such message element is returned, the WTP SHOULD perform "load
6021 balancing" by choosing the interface that is servicing the least
6022 number of WTPs (known through the WTP Count field of the message
6023 element). Note, however, that other load balancing algorithms are
6024 also permitted. Once the WTP has determined its preferred AC, and
6025 its associated interface, to which to connect, it establishes the
6026 DTLS session, and transmits the Join Request over the secured control
6027 channel. When an AC receives a Join Request message it responds with
6028 a Join Response message.
6029
6030 Upon completion of the DTLS handshake and receipt of the
6031 DTLSEstablished notification, the WTP sends the Join Request message
6032 to the AC. When the AC is notified of the DTLS session
6033 establishment, it does not clear the WaitDTLS timer until it has
6034 received the Join Request message, at which time it sends a Join
6035 Response message to the WTP, indicating success or failure.
6036
6037 One or more WTP Radio Information message elements (see <a href="#section-2.1">Section 2.1</a>)
6038 are included in the Join Request to request service for the CAPWAP
6039 bindings by the AC. Including a binding that is unsupported by the
6040 AC will result in a failed Join Response.
6041
6042
6043
6044 <span class="grey">Calhoun, et al. Standards Track [Page 108]</span></pre>
6045 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-109" ></span>
6046 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6047
6048
6049 If the AC rejects the Join Request, it sends a Join Response message
6050 with a failure indication and initiates an abort of the DTLS session
6051 via the DTLSAbort command.
6052
6053 If an invalid (i.e., malformed) Join Request message is received, the
6054 message MUST be silently discarded by the AC. No response is sent to
6055 the WTP. The AC SHOULD log this event.
6056
6057 The Join Request is sent by the WTP when in the Join State. The AC
6058 does not transmit this message.
6059
6060 The following message elements MUST be included in the Join Request
6061 message.
6062
6063 o Location Data, see <a href="#section-4.6.30">Section 4.6.30</a>
6064
6065 o WTP Board Data, see <a href="#section-4.6.40">Section 4.6.40</a>
6066
6067 o WTP Descriptor, see <a href="#section-4.6.41">Section 4.6.41</a>
6068
6069 o WTP Name, see <a href="#section-4.6.45">Section 4.6.45</a>
6070
6071 o Session ID, see <a href="#section-4.6.37">Section 4.6.37</a>
6072
6073 o WTP Frame Tunnel Mode, see <a href="#section-4.6.43">Section 4.6.43</a>
6074
6075 o WTP MAC Type, see <a href="#section-4.6.44">Section 4.6.44</a>
6076
6077 o WTP Radio Information message element(s) that the WTP supports;
6078 these are defined by the individual link layer CAPWAP Binding
6079 Protocols (see <a href="#section-2.1">Section 2.1</a> for more information).
6080
6081 o ECN Support, see <a href="#section-4.6.25">Section 4.6.25</a>
6082
6083 At least one of the following message element MUST be included in the
6084 Join Request message.
6085
6086 o CAPWAP Local IPv4 Address, see <a href="#section-4.6.11">Section 4.6.11</a>
6087
6088 o CAPWAP Local IPv6 Address, see <a href="#section-4.6.12">Section 4.6.12</a>
6089
6090 The following message element MAY be included in the Join Request
6091 message.
6092
6093 o CAPWAP Transport Protocol, see <a href="#section-4.6.14">Section 4.6.14</a>
6094
6095 o Maximum Message Length, see <a href="#section-4.6.31">Section 4.6.31</a>
6096
6097
6098
6099
6100 <span class="grey">Calhoun, et al. Standards Track [Page 109]</span></pre>
6101 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-110" ></span>
6102 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6103
6104
6105 o WTP Reboot Statistics, see <a href="#section-4.6.47">Section 4.6.47</a>
6106
6107 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
6108
6109 <span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>. Join Response</span>
6110
6111 The Join Response message is sent by the AC to indicate to a WTP that
6112 it is capable and willing to provide service to the WTP.
6113
6114 The WTP, receiving a Join Response message, checks for success or
6115 failure. If the message indicates success, the WTP clears the
6116 WaitDTLS timer for the session and proceeds to the Configure state.
6117
6118 If the WaitDTLS Timer expires prior to reception of the Join Response
6119 message, the WTP MUST terminate the handshake, deallocate session
6120 state and initiate the DTLSAbort command.
6121
6122 If an invalid (malformed) Join Response message is received, the WTP
6123 SHOULD log an informative message detailing the error. This error
6124 MUST be treated in the same manner as AC non-responsiveness. The
6125 WaitDTLS timer will eventually expire, and the WTP MAY (if it is so
6126 configured) attempt to join a new AC.
6127
6128 If one of the WTP Radio Information message elements (see
6129 <a href="#section-2.1">Section 2.1</a>) in the Join Request message requested support for a
6130 CAPWAP binding that the AC does not support, the AC sets the Result
6131 Code message element to "Binding Not Supported".
6132
6133 The AC includes the Image Identifier message element to indicate the
6134 software version it expects the WTP to run. This information is used
6135 to determine whether the WTP MUST change its currently running
6136 firmware image or download a new version (see <a href="#section-9.1.1">Section 9.1.1</a>).
6137
6138 The Join Response message is sent by the AC when in the Join State.
6139 The WTP does not transmit this message.
6140
6141 The following message elements MUST be included in the Join Response
6142 message.
6143
6144 o Result Code, see <a href="#section-4.6.35">Section 4.6.35</a>
6145
6146 o AC Descriptor, see <a href="#section-4.6.1">Section 4.6.1</a>
6147
6148 o AC Name, see <a href="#section-4.6.4">Section 4.6.4</a>
6149
6150 o WTP Radio Information message element(s) that the AC supports;
6151 these are defined by the individual link layer CAPWAP Binding
6152 Protocols (see <a href="#section-2.1">Section 2.1</a>).
6153
6154
6155
6156 <span class="grey">Calhoun, et al. Standards Track [Page 110]</span></pre>
6157 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-111" ></span>
6158 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6159
6160
6161 o ECN Support, see <a href="#section-4.6.25">Section 4.6.25</a>
6162
6163 One of the following message elements MUST be included in the Join
6164 Response Message:
6165
6166 o CAPWAP Control IPv4 Address, see <a href="#section-4.6.9">Section 4.6.9</a>
6167
6168 o CAPWAP Control IPv6 Address, see <a href="#section-4.6.10">Section 4.6.10</a>
6169
6170 One of the following message elements MUST be included in the Join
6171 Response Message:
6172
6173 o CAPWAP Local IPv4 Address, see <a href="#section-4.6.11">Section 4.6.11</a>
6174
6175 o CAPWAP Local IPv6 Address, see <a href="#section-4.6.12">Section 4.6.12</a>
6176
6177 The following message elements MAY be included in the Join Response
6178 message.
6179
6180 o AC IPv4 List, see <a href="#section-4.6.2">Section 4.6.2</a>
6181
6182 o AC IPv6 List, see <a href="#section-4.6.3">Section 4.6.3</a>
6183
6184 o CAPWAP Transport Protocol, see <a href="#section-4.6.14">Section 4.6.14</a>
6185
6186 o Image Identifier, see <a href="#section-4.6.27">Section 4.6.27</a>
6187
6188 o Maximum Message Length, see <a href="#section-4.6.31">Section 4.6.31</a>
6189
6190 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
6191
6192 <span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Control Channel Management</span>
6193
6194 The Control Channel Management messages are used by the WTP and AC to
6195 maintain a control communication channel. CAPWAP Control messages,
6196 such as the WTP Event Request message sent from the WTP to the AC
6197 indicate to the AC that the WTP is operational. When such control
6198 messages are not being sent, the Echo Request and Echo Response
6199 messages are used to maintain the control communication channel.
6200
6201 <span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>. Echo Request</span>
6202
6203 The Echo Request message is a keep-alive mechanism for CAPWAP control
6204 messages.
6205
6206
6207
6208
6209
6210
6211
6212 <span class="grey">Calhoun, et al. Standards Track [Page 111]</span></pre>
6213 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-112" ></span>
6214 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6215
6216
6217 Echo Request messages are sent periodically by a WTP in the Image
6218 Data or Run state (see <a href="#section-2.3">Section 2.3</a>) to determine the state of the
6219 control connection between the WTP and the AC. The Echo Request
6220 message is sent by the WTP when the EchoInterval timer expires.
6221
6222 The Echo Request message is sent by the WTP when in the Run state.
6223 The AC does not transmit this message.
6224
6225 The following message elements MAY be included in the Echo Request
6226 message:
6227
6228 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
6229
6230 When an AC receives an Echo Request message it responds with an Echo
6231 Response message.
6232
6233 <span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>. Echo Response</span>
6234
6235 The Echo Response message acknowledges the Echo Request message.
6236
6237 An Echo Response message is sent by an AC after receiving an Echo
6238 Request message. After transmitting the Echo Response message, the
6239 AC SHOULD reset its EchoInterval timer (see <a href="#section-4.7.7">Section 4.7.7</a>). If
6240 another Echo Request message or other control message is not received
6241 by the AC when the timer expires, the AC SHOULD consider the WTP to
6242 be no longer reachable.
6243
6244 The Echo Response message is sent by the AC when in the Run state.
6245 The WTP does not transmit this message.
6246
6247 The following message elements MAY be included in the Echo Response
6248 message:
6249
6250 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
6251
6252 When a WTP receives an Echo Response message it initializes the
6253 EchoInterval to the configured value.
6254
6255 <span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. WTP Configuration Management</span>
6256
6257 WTP Configuration messages are used to exchange configuration
6258 information between the AC and the WTP.
6259
6260 <span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>. Configuration Consistency</span>
6261
6262 The CAPWAP protocol provides flexibility in how WTP configuration is
6263 managed. A WTP can behave in one of two ways, which is
6264 implementation specific:
6265
6266
6267
6268 <span class="grey">Calhoun, et al. Standards Track [Page 112]</span></pre>
6269 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-113" ></span>
6270 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6271
6272
6273 1. The WTP retains no configuration and accepts the configuration
6274 provided by the AC.
6275
6276 2. The WTP saves the configuration of parameters provided by the AC
6277 that are non-default values into local non-volatile memory, and
6278 are enforced during the WTP's power up initialization phase.
6279
6280 If the WTP opts to save configuration locally, the CAPWAP protocol
6281 state machine defines the Configure state, which allows for
6282 configuration exchange. In the Configure state, the WTP sends its
6283 current configuration overrides to the AC via the Configuration
6284 Status Request message. A configuration override is a non-default
6285 parameter. As an example, in the CAPWAP protocol, the default
6286 antenna configuration is internal omni antenna. A WTP that either
6287 has no internal antennas, or has been explicitly configured by the AC
6288 to use external antennas, sends its antenna configuration during the
6289 configure phase, allowing the AC to become aware of the WTP's current
6290 configuration.
6291
6292 Once the WTP has provided its configuration to the AC, the AC sends
6293 its configuration to the WTP. This allows the WTP to receive
6294 configuration and policies from the AC.
6295
6296 The AC maintains a copy of each active WTP configuration. There is
6297 no need for versioning or other means to identify configuration
6298 changes. If a WTP becomes inactive, the AC MAY delete the inactive
6299 WTP configuration. If a WTP fails, and connects to a new AC, the WTP
6300 provides its overridden configuration parameters, allowing the new AC
6301 to be aware of the WTP configuration.
6302
6303 This model allows for resiliency in case of an AC failure, ensuring
6304 another AC can provide service to the WTP. A new AC would be
6305 automatically updated with WTP configuration changes, eliminating the
6306 need for inter-AC communication and the need for all ACs to be aware
6307 of the configuration of all WTPs in the network.
6308
6309 Once the CAPWAP protocol enters the Run state, the WTPs begin to
6310 provide service. It is common for administrators to require that
6311 configuration changes be made while the network is operational.
6312 Therefore, the Configuration Update Request is sent by the AC to the
6313 WTP to make these changes at run-time.
6314
6315 <span class="h4"><a class="selflink" id="section-8.1.1" href="#section-8.1.1">8.1.1</a>. Configuration Flexibility</span>
6316
6317 The CAPWAP protocol provides the flexibility to configure and manage
6318 WTPs of varying design and functional characteristics. When a WTP
6319 first discovers an AC, it provides primary functional information
6320
6321
6322
6323
6324 <span class="grey">Calhoun, et al. Standards Track [Page 113]</span></pre>
6325 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-114" ></span>
6326 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6327
6328
6329 relating to its type of MAC and to the nature of frames to be
6330 exchanged. The AC configures the WTP appropriately. The AC also
6331 establishes corresponding internal state for the WTP.
6332
6333 <span class="h3"><a class="selflink" id="section-8.2" href="#section-8.2">8.2</a>. Configuration Status Request</span>
6334
6335 The Configuration Status Request message is sent by a WTP to deliver
6336 its current configuration to the AC.
6337
6338 The Configuration Status Request message carries binding-specific
6339 message elements. Refer to the appropriate binding for the
6340 definition of this structure.
6341
6342 When an AC receives a Configuration Status Request message, it acts
6343 upon the content of the message and responds to the WTP with a
6344 Configuration Status Response message.
6345
6346 The Configuration Status Request message includes multiple Radio
6347 Administrative State message elements, one for the WTP, and one for
6348 each radio in the WTP.
6349
6350 The Configuration Status Request message is sent by the WTP when in
6351 the Configure State. The AC does not transmit this message.
6352
6353 The following message elements MUST be included in the Configuration
6354 Status Request message.
6355
6356 o AC Name, see <a href="#section-4.6.4">Section 4.6.4</a>
6357
6358 o Radio Administrative State, see <a href="#section-4.6.33">Section 4.6.33</a>
6359
6360 o Statistics Timer, see <a href="#section-4.6.38">Section 4.6.38</a>
6361
6362 o WTP Reboot Statistics, see <a href="#section-4.6.47">Section 4.6.47</a>
6363
6364 The following message elements MAY be included in the Configuration
6365 Status Request message.
6366
6367 o AC Name with Priority, see <a href="#section-4.6.5">Section 4.6.5</a>
6368
6369 o CAPWAP Transport Protocol, see <a href="#section-4.6.14">Section 4.6.14</a>
6370
6371 o WTP Static IP Address Information, see <a href="#section-4.6.48">Section 4.6.48</a>
6372
6373 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
6374
6375
6376
6377
6378
6379
6380 <span class="grey">Calhoun, et al. Standards Track [Page 114]</span></pre>
6381 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-115" ></span>
6382 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6383
6384
6385 <span class="h3"><a class="selflink" id="section-8.3" href="#section-8.3">8.3</a>. Configuration Status Response</span>
6386
6387 The Configuration Status Response message is sent by an AC and
6388 provides a mechanism for the AC to override a WTP's requested
6389 configuration.
6390
6391 A Configuration Status Response message is sent by an AC after
6392 receiving a Configuration Status Request message.
6393
6394 The Configuration Status Response message carries binding-specific
6395 message elements. Refer to the appropriate binding for the
6396 definition of this structure.
6397
6398 When a WTP receives a Configuration Status Response message, it acts
6399 upon the content of the message, as appropriate. If the
6400 Configuration Status Response message includes a Radio Operational
6401 State message element that causes a change in the operational state
6402 of one of the radios, the WTP transmits a Change State Event to the
6403 AC, as an acknowledgement of the change in state.
6404
6405 The Configuration Status Response message is sent by the AC when in
6406 the Configure state. The WTP does not transmit this message.
6407
6408 The following message elements MUST be included in the Configuration
6409 Status Response message.
6410
6411 o CAPWAP Timers, see <a href="#section-4.6.13">Section 4.6.13</a>
6412
6413 o Decryption Error Report Period, see <a href="#section-4.6.18">Section 4.6.18</a>
6414
6415 o Idle Timeout, see <a href="#section-4.6.24">Section 4.6.24</a>
6416
6417 o WTP Fallback, see <a href="#section-4.6.42">Section 4.6.42</a>
6418
6419 One or both of the following message elements MUST be included in the
6420 Configuration Status Response message:
6421
6422 o AC IPv4 List, see <a href="#section-4.6.2">Section 4.6.2</a>
6423
6424 o AC IPv6 List, see <a href="#section-4.6.3">Section 4.6.3</a>
6425
6426 The following message element MAY be included in the Configuration
6427 Status Response message.
6428
6429 o WTP Static IP Address Information, see <a href="#section-4.6.48">Section 4.6.48</a>
6430
6431 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
6432
6433
6434
6435
6436 <span class="grey">Calhoun, et al. Standards Track [Page 115]</span></pre>
6437 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-116" ></span>
6438 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6439
6440
6441 <span class="h3"><a class="selflink" id="section-8.4" href="#section-8.4">8.4</a>. Configuration Update Request</span>
6442
6443 Configuration Update Request messages are sent by the AC to provision
6444 the WTP while in the Run state. This is used to modify the
6445 configuration of the WTP while it is operational.
6446
6447 When a WTP receives a Configuration Update Request message, it
6448 responds with a Configuration Update Response message, with a Result
6449 Code message element indicating the result of the configuration
6450 request.
6451
6452 The AC includes the Image Identifier message element (see
6453 <a href="#section-4.6.27">Section 4.6.27</a>) to force the WTP to update its firmware while in the
6454 Run state. The WTP MAY proceed to download the requested firmware if
6455 it determines the version specified in the Image Identifier message
6456 element is not in its non-volatile storage by transmitting an Image
6457 Data Request (see <a href="#section-9.1.1">Section 9.1.1</a>) that includes the Initiate Download
6458 message element (see <a href="#section-4.6.29">Section 4.6.29</a>).
6459
6460 The Configuration Update Request is sent by the AC when in the Run
6461 state. The WTP does not transmit this message.
6462
6463 One or more of the following message elements MAY be included in the
6464 Configuration Update message:
6465
6466 o AC Name with Priority, see <a href="#section-4.6.5">Section 4.6.5</a>
6467
6468 o AC Timestamp, see <a href="#section-4.6.6">Section 4.6.6</a>
6469
6470 o Add MAC ACL Entry, see <a href="#section-4.6.7">Section 4.6.7</a>
6471
6472 o CAPWAP Timers, see <a href="#section-4.6.13">Section 4.6.13</a>
6473
6474 o Decryption Error Report Period, see <a href="#section-4.6.18">Section 4.6.18</a>
6475
6476 o Delete MAC ACL Entry, see <a href="#section-4.6.19">Section 4.6.19</a>
6477
6478 o Idle Timeout, see <a href="#section-4.6.24">Section 4.6.24</a>
6479
6480 o Location Data, see <a href="#section-4.6.30">Section 4.6.30</a>
6481
6482 o Radio Administrative State, see <a href="#section-4.6.33">Section 4.6.33</a>
6483
6484 o Statistics Timer, see <a href="#section-4.6.38">Section 4.6.38</a>
6485
6486 o WTP Fallback, see <a href="#section-4.6.42">Section 4.6.42</a>
6487
6488 o WTP Name, see <a href="#section-4.6.45">Section 4.6.45</a>
6489
6490
6491
6492 <span class="grey">Calhoun, et al. Standards Track [Page 116]</span></pre>
6493 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-117" ></span>
6494 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6495
6496
6497 o WTP Static IP Address Information, see <a href="#section-4.6.48">Section 4.6.48</a>
6498
6499 o Image Identifier, see <a href="#section-4.6.27">Section 4.6.27</a>
6500
6501 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
6502
6503 <span class="h3"><a class="selflink" id="section-8.5" href="#section-8.5">8.5</a>. Configuration Update Response</span>
6504
6505 The Configuration Update Response message is the acknowledgement
6506 message for the Configuration Update Request message.
6507
6508 The Configuration Update Response message is sent by a WTP after
6509 receiving a Configuration Update Request message.
6510
6511 When an AC receives a Configuration Update Response message, the
6512 result code indicates if the WTP successfully accepted the
6513 configuration.
6514
6515 The Configuration Update Response message is sent by the WTP when in
6516 the Run state. The AC does not transmit this message.
6517
6518 The following message element MUST be present in the Configuration
6519 Update message.
6520
6521 Result Code, see <a href="#section-4.6.35">Section 4.6.35</a>
6522
6523 The following message elements MAY be present in the Configuration
6524 Update Response message.
6525
6526 o Radio Operational State, see <a href="#section-4.6.34">Section 4.6.34</a>
6527
6528 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
6529
6530 <span class="h3"><a class="selflink" id="section-8.6" href="#section-8.6">8.6</a>. Change State Event Request</span>
6531
6532 The Change State Event Request message is used by the WTP for two
6533 main purposes:
6534
6535 o When sent by the WTP following the reception of a Configuration
6536 Status Response message from the AC, the WTP uses the Change State
6537 Event Request message to provide an update on the WTP radio's
6538 operational state and to confirm that the configuration provided
6539 by the AC was successfully applied.
6540
6541 o When sent during the Run state, the WTP uses the Change State
6542 Event Request message to notify the AC of an unexpected change in
6543 the WTP's radio operational state.
6544
6545
6546
6547
6548 <span class="grey">Calhoun, et al. Standards Track [Page 117]</span></pre>
6549 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-118" ></span>
6550 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6551
6552
6553 When an AC receives a Change State Event Request message it responds
6554 with a Change State Event Response message and modifies its data
6555 structures for the WTP as needed. The AC MAY decide not to provide
6556 service to the WTP if it receives an error, based on local policy,
6557 and to transition to the Reset state.
6558
6559 The Change State Event Request message is sent by a WTP to
6560 acknowledge or report an error condition to the AC for a requested
6561 configuration in the Configuration Status Response message. The
6562 Change State Event Request message includes the Result Code message
6563 element, which indicates whether the configuration was successfully
6564 applied. If the WTP is unable to apply a specific configuration
6565 request, it indicates the failure by including one or more Returned
6566 Message Element message elements (see <a href="#section-4.6.36">Section 4.6.36</a>).
6567
6568 The Change State Event Request message is sent by the WTP in the
6569 Configure or Run state. The AC does not transmit this message.
6570
6571 The WTP MAY save its configuration to persistent storage prior to
6572 transmitting the response. However, this is implementation specific
6573 and is not required.
6574
6575 The following message elements MUST be present in the Change State
6576 Event Request message.
6577
6578 o Radio Operational State, see <a href="#section-4.6.34">Section 4.6.34</a>
6579
6580 o Result Code, see <a href="#section-4.6.35">Section 4.6.35</a>
6581
6582 One or more of the following message elements MAY be present in the
6583 Change State Event Request message:
6584
6585 o Returned Message Element(s), see <a href="#section-4.6.36">Section 4.6.36</a>
6586
6587 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
6588
6589 <span class="h3"><a class="selflink" id="section-8.7" href="#section-8.7">8.7</a>. Change State Event Response</span>
6590
6591 The Change State Event Response message acknowledges the Change State
6592 Event Request message.
6593
6594 A Change State Event Response message is sent by an AC in response to
6595 a Change State Event Request message.
6596
6597 The Change State Event Response message is sent by the AC when in the
6598 Configure or Run state. The WTP does not transmit this message.
6599
6600
6601
6602
6603
6604 <span class="grey">Calhoun, et al. Standards Track [Page 118]</span></pre>
6605 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-119" ></span>
6606 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6607
6608
6609 The following message element MAY be included in the Change State
6610 Event Response message:
6611
6612 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
6613
6614 The WTP does not take any action upon receipt of the Change State
6615 Event Response message.
6616
6617 <span class="h3"><a class="selflink" id="section-8.8" href="#section-8.8">8.8</a>. Clear Configuration Request</span>
6618
6619 The Clear Configuration Request message is used to reset the WTP
6620 configuration.
6621
6622 The Clear Configuration Request message is sent by an AC to request
6623 that a WTP reset its configuration to the manufacturing default
6624 configuration. The Clear Config Request message is sent while in the
6625 Run state.
6626
6627 The Clear Configuration Request is sent by the AC when in the Run
6628 state. The WTP does not transmit this message.
6629
6630 The following message element MAY be included in the Clear
6631 Configuration Request message:
6632
6633 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
6634
6635 When a WTP receives a Clear Configuration Request message, it resets
6636 its configuration to the manufacturing default configuration.
6637
6638 <span class="h3"><a class="selflink" id="section-8.9" href="#section-8.9">8.9</a>. Clear Configuration Response</span>
6639
6640 The Clear Configuration Response message is sent by the WTP after
6641 receiving a Clear Configuration Request message and resetting its
6642 configuration parameters to the manufacturing default values.
6643
6644 The Clear Configuration Response is sent by the WTP when in the Run
6645 state. The AC does not transmit this message.
6646
6647 The Clear Configuration Response message MUST include the following
6648 message element:
6649
6650 o Result Code, see <a href="#section-4.6.35">Section 4.6.35</a>
6651
6652 The following message element MAY be included in the Clear
6653 Configuration Request message:
6654
6655 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
6656
6657
6658
6659
6660 <span class="grey">Calhoun, et al. Standards Track [Page 119]</span></pre>
6661 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-120" ></span>
6662 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6663
6664
6665 <span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Device Management Operations</span>
6666
6667 This section defines CAPWAP operations responsible for debugging,
6668 gathering statistics, logging, and firmware management. The
6669 management operations defined in this section are used by the AC to
6670 either push/pull information to/from the WTP, or request that the WTP
6671 reboot. This section does not deal with the management of the AC per
6672 se, and assumes that the AC is operational and configured.
6673
6674 <span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.1</a>. Firmware Management</span>
6675
6676 This section describes the firmware download procedures used by the
6677 CAPWAP protocol. Firmware download can occur during the Image Data
6678 or Run state. The former allows the download to occur at boot time,
6679 while the latter is used to trigger the download while an active
6680 CAPWAP session exists. It is important to note that the CAPWAP
6681 protocol does not provide the ability for the AC to identify whether
6682 the firmware information provided by the WTP is correct or whether
6683 the WTP is properly storing the firmware (see <a href="#section-12.10">Section 12.10</a> for more
6684 information).
6685
6686 Figure 6 provides an example of a WTP that performs a firmware
6687 upgrade while in the Image Data state. In this example, the WTP does
6688 not already have the requested firmware (Image Identifier = x), and
6689 downloads the image from the AC.
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716 <span class="grey">Calhoun, et al. Standards Track [Page 120]</span></pre>
6717 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-121" ></span>
6718 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6719
6720
6721 WTP AC
6722
6723 Join Request
6724 --------------------------------------------------------&gt;
6725
6726 Join Response (Image Identifier = x)
6727 &lt;------------------------------------------------------
6728
6729 Image Data Request (Image Identifier = x,
6730 Initiate Download)
6731 --------------------------------------------------------&gt;
6732
6733 Image Data Response (Result Code = Success,
6734 Image Information = {size,hash})
6735 &lt;------------------------------------------------------
6736
6737 Image Data Request (Image Data = Data)
6738 &lt;------------------------------------------------------
6739
6740 Image Data Response (Result Code = Success)
6741 --------------------------------------------------------&gt;
6742
6743 .....
6744
6745 Image Data Request (Image Data = EOF)
6746 &lt;------------------------------------------------------
6747
6748 Image Data Response (Result Code = Success)
6749 --------------------------------------------------------&gt;
6750
6751 (WTP enters the Reset State)
6752
6753 Figure 6: WTP Firmware Download Case 1
6754
6755 Figure 7 provides an example in which the WTP has the image specified
6756 by the AC in its non-volatile storage, but is not its current running
6757 image. In this case, the WTP opts to NOT download the firmware and
6758 immediately reset to the requested image.
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772 <span class="grey">Calhoun, et al. Standards Track [Page 121]</span></pre>
6773 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-122" ></span>
6774 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6775
6776
6777 WTP AC
6778
6779 Join Request
6780 --------------------------------------------------------&gt;
6781
6782 Join Response (Image Identifier = x)
6783 &lt;------------------------------------------------------
6784
6785 (WTP enters the Reset State)
6786
6787 Figure 7: WTP Firmware Download Case 2
6788
6789 Figure 8 provides an example of a WTP that performs a firmware
6790 upgrade while in the Run state. This mode of firmware upgrade allows
6791 the WTP to download its image while continuing to provide service.
6792 The WTP will not automatically reset until it is notified by the AC,
6793 with a Reset Request message.
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828 <span class="grey">Calhoun, et al. Standards Track [Page 122]</span></pre>
6829 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-123" ></span>
6830 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6831
6832
6833 WTP AC
6834
6835 Configuration Update Request (Image Identifier = x)
6836 &lt;------------------------------------------------------
6837
6838 Configuration Update Response (Result Code = Success)
6839 --------------------------------------------------------&gt;
6840
6841
6842 Image Data Request (Image Identifier = x,
6843 Initiate Download)
6844 --------------------------------------------------------&gt;
6845
6846 Image Data Response (Result Code = Success,
6847 Image Information = {size,hash})
6848 &lt;------------------------------------------------------
6849
6850 Image Data Request (Image Data = Data)
6851 &lt;------------------------------------------------------
6852
6853 Image Data Response (Result Code = Success)
6854 --------------------------------------------------------&gt;
6855
6856 .....
6857
6858 Image Data Request (Image Data = EOF)
6859 &lt;------------------------------------------------------
6860
6861 Image Data Response (Result Code = Success)
6862 --------------------------------------------------------&gt;
6863
6864 .....
6865
6866 (administratively requested reboot request)
6867 Reset Request (Image Identifier = x)
6868 &lt;------------------------------------------------------
6869
6870 Reset Response (Result Code = Success)
6871 --------------------------------------------------------&gt;
6872
6873 Figure 8: WTP Firmware Download Case 3
6874
6875 Figure 9 provides another example of the firmware download while in
6876 the Run state. In this example, the WTP already has the image
6877 specified by the AC in its non-volatile storage. The WTP opts to NOT
6878 download the firmware. The WTP resets upon receipt of a Reset
6879 Request message from the AC.
6880
6881
6882
6883
6884 <span class="grey">Calhoun, et al. Standards Track [Page 123]</span></pre>
6885 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-124" ></span>
6886 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6887
6888
6889 WTP AC
6890
6891 Configuration Update Request (Image Identifier = x)
6892 &lt;------------------------------------------------------
6893
6894 Configuration Update Response (Result Code = Already Have Image)
6895 --------------------------------------------------------&gt;
6896
6897 .....
6898
6899 (administratively requested reboot request)
6900 Reset Request (Image Identifier = x)
6901 &lt;------------------------------------------------------
6902
6903 Reset Response (Result Code = Success)
6904 --------------------------------------------------------&gt;
6905
6906 Figure 9: WTP Firmware Download Case 4
6907
6908 <span class="h4"><a class="selflink" id="section-9.1.1" href="#section-9.1.1">9.1.1</a>. Image Data Request</span>
6909
6910 The Image Data Request message is used to update firmware on the WTP.
6911 This message and its companion Response message are used by the AC to
6912 ensure that the image being run on each WTP is appropriate.
6913
6914 Image Data Request messages are exchanged between the WTP and the AC
6915 to download a new firmware image to the WTP. When a WTP or AC
6916 receives an Image Data Request message, it responds with an Image
6917 Data Response message. The message elements contained within the
6918 Image Data Request message are required to determine the intent of
6919 the request.
6920
6921 The decision that new firmware is to be downloaded to the WTP can
6922 occur in one of two ways:
6923
6924 When the WTP joins the AC, the Join Response message includes the
6925 Image Identifier message element, which informs the WTP of the
6926 firmware it is expected to run. If the WTP does not currently
6927 have the requested firmware version, it transmits an Image Data
6928 Request message, with the appropriate Image Identifier message
6929 element. If the WTP already has the requested firmware in its
6930 non-volatile flash, but is not its currently running image, it
6931 simply resets to run the proper firmware.
6932
6933 Once the WTP is in the Run state, it is possible for the AC to
6934 cause the WTP to initiate a firmware download by sending a
6935 Configuration Update Request message with the Image Identifier
6936 message elements. This will cause the WTP to transmit an Image
6937
6938
6939
6940 <span class="grey">Calhoun, et al. Standards Track [Page 124]</span></pre>
6941 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-125" ></span>
6942 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6943
6944
6945 Data Request with the Image Identifier and the Initiate Download
6946 message elements. Note that when the firmware is downloaded in
6947 this way, the WTP does not automatically reset after the download
6948 is complete. The WTP will only reset when it receives a Reset
6949 Request message from the AC. If the WTP already had the requested
6950 firmware version in its non-volatile storage, the WTP does not
6951 transmit the Image Data Request message and responds with a
6952 Configuration Update Response message with the Result Code set to
6953 Image Already Present.
6954
6955 Regardless of how the download was initiated, once the AC receives an
6956 Image Data Request message with the Image Identifier message element,
6957 it begins the transfer process by transmitting an Image Data Request
6958 message that includes the Image Data message element. This continues
6959 until the firmware image has been transferred.
6960
6961 The Image Data Request message is sent by the WTP or the AC when in
6962 the Image Data or Run state.
6963
6964 The following message elements MAY be included in the Image Data
6965 Request message:
6966
6967 o CAPWAP Transport Protocol, see <a href="#section-4.6.14">Section 4.6.14</a>
6968
6969 o Image Data, see <a href="#section-4.6.26">Section 4.6.26</a>
6970
6971 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
6972
6973 The following message elements MAY be included in the Image Data
6974 Request message when sent by the WTP:
6975
6976 o Image Identifier, see <a href="#section-4.6.27">Section 4.6.27</a>
6977
6978 o Initiate Download, see <a href="#section-4.6.29">Section 4.6.29</a>
6979
6980 <span class="h4"><a class="selflink" id="section-9.1.2" href="#section-9.1.2">9.1.2</a>. Image Data Response</span>
6981
6982 The Image Data Response message acknowledges the Image Data Request
6983 message.
6984
6985 An Image Data Response message is sent in response to a received
6986 Image Data Request message. Its purpose is to acknowledge the
6987 receipt of the Image Data Request message. The Result Code is
6988 included to indicate whether a previously sent Image Data Request
6989 message was invalid.
6990
6991 The Image Data Response message is sent by the WTP or the AC when in
6992 the Image Data or Run state.
6993
6994
6995
6996 <span class="grey">Calhoun, et al. Standards Track [Page 125]</span></pre>
6997 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-126" ></span>
6998 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
6999
7000
7001 The following message element MUST be included in the Image Data
7002 Response message:
7003
7004 o Result Code, see <a href="#section-4.6.35">Section 4.6.35</a>
7005
7006 The following message element MAY be included in the Image Data
7007 Response message:
7008
7009 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
7010
7011 The following message element MAY be included in the Image Data
7012 Response message when sent by the AC:
7013
7014 o Image Information, see <a href="#section-4.6.28">Section 4.6.28</a>
7015
7016 Upon receiving an Image Data Response message indicating an error,
7017 the WTP MAY retransmit a previous Image Data Request message, or
7018 abandon the firmware download to the WTP by transitioning to the
7019 Reset state.
7020
7021 <span class="h3"><a class="selflink" id="section-9.2" href="#section-9.2">9.2</a>. Reset Request</span>
7022
7023 The Reset Request message is used to cause a WTP to reboot.
7024
7025 A Reset Request message is sent by an AC to cause a WTP to
7026 reinitialize its operation. If the AC includes the Image Identifier
7027 message element (see <a href="#section-4.6.27">Section 4.6.27</a>), it indicates to the WTP that it
7028 SHOULD use that version of software upon reboot.
7029
7030 The Reset Request is sent by the AC when in the Run state. The WTP
7031 does not transmit this message.
7032
7033 The following message element MUST be included in the Reset Request
7034 message:
7035
7036 o Image Identifier, see <a href="#section-4.6.27">Section 4.6.27</a>
7037
7038 The following message element MAY be included in the Reset Request
7039 message:
7040
7041 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
7042
7043 When a WTP receives a Reset Request message, it responds with a Reset
7044 Response message indicating success and then reinitializes itself.
7045 If the WTP is unable to write to its non-volatile storage, to ensure
7046 that it runs the requested software version indicated in the Image
7047 Identifier message element, it MAY send the appropriate Result Code
7048 message element, but MUST reboot. If the WTP is unable to reset,
7049
7050
7051
7052 <span class="grey">Calhoun, et al. Standards Track [Page 126]</span></pre>
7053 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-127" ></span>
7054 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7055
7056
7057 including a hardware reset, it sends a Reset Response message to the
7058 AC with a Result Code message element indicating failure. The AC no
7059 longer provides service to the WTP.
7060
7061 <span class="h3"><a class="selflink" id="section-9.3" href="#section-9.3">9.3</a>. Reset Response</span>
7062
7063 The Reset Response message acknowledges the Reset Request message.
7064
7065 A Reset Response message is sent by the WTP after receiving a Reset
7066 Request message.
7067
7068 The Reset Response is sent by the WTP when in the Run state. The AC
7069 does not transmit this message.
7070
7071 The following message elements MAY be included in the Reset Response
7072 message.
7073
7074 o Result Code, see <a href="#section-4.6.35">Section 4.6.35</a>
7075
7076 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
7077
7078 When an AC receives a successful Reset Response message, it is
7079 notified that the WTP will reinitialize its operation. An AC that
7080 receives a Reset Response message indicating failure may opt to no
7081 longer provide service to the WTP.
7082
7083 <span class="h3"><a class="selflink" id="section-9.4" href="#section-9.4">9.4</a>. WTP Event Request</span>
7084
7085 The WTP Event Request message is used by a WTP to send information to
7086 its AC. The WTP Event Request message MAY be sent periodically, or
7087 sent in response to an asynchronous event on the WTP. For example, a
7088 WTP MAY collect statistics and use the WTP Event Request message to
7089 transmit the statistics to the AC.
7090
7091 When an AC receives a WTP Event Request message it will respond with
7092 a WTP Event Response message.
7093
7094 The presence of the Delete Station message element is used by the WTP
7095 to inform the AC that it is no longer providing service to the
7096 station. This could be the result of an Idle Timeout (see
7097 <a href="#section-4.6.24">Section 4.6.24</a>), due to resource shortages, or some other reason.
7098
7099 The WTP Event Request message is sent by the WTP when in the Run
7100 state. The AC does not transmit this message.
7101
7102
7103
7104
7105
7106
7107
7108 <span class="grey">Calhoun, et al. Standards Track [Page 127]</span></pre>
7109 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-128" ></span>
7110 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7111
7112
7113 The WTP Event Request message MUST contain one of the message
7114 elements listed below, or a message element that is defined for a
7115 specific wireless technology. More than one of each message element
7116 listed MAY be included in the WTP Event Request message.
7117
7118 o Decryption Error Report, see <a href="#section-4.6.17">Section 4.6.17</a>
7119
7120 o Duplicate IPv4 Address, see <a href="#section-4.6.22">Section 4.6.22</a>
7121
7122 o Duplicate IPv6 Address, see <a href="#section-4.6.23">Section 4.6.23</a>
7123
7124 o WTP Radio Statistics, see <a href="#section-4.6.46">Section 4.6.46</a>
7125
7126 o WTP Reboot Statistics, see <a href="#section-4.6.47">Section 4.6.47</a>
7127
7128 o Delete Station, see <a href="#section-4.6.20">Section 4.6.20</a>
7129
7130 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
7131
7132 <span class="h3"><a class="selflink" id="section-9.5" href="#section-9.5">9.5</a>. WTP Event Response</span>
7133
7134 The WTP Event Response message acknowledges receipt of the WTP Event
7135 Request message.
7136
7137 A WTP Event Response message is sent by an AC after receiving a WTP
7138 Event Request message.
7139
7140 The WTP Event Response message is sent by the AC when in the Run
7141 state. The WTP does not transmit this message.
7142
7143 The following message element MAY be included in the WTP Event
7144 Response message:
7145
7146 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
7147
7148 <span class="h3"><a class="selflink" id="section-9.6" href="#section-9.6">9.6</a>. Data Transfer</span>
7149
7150 This section describes the data transfer procedures used by the
7151 CAPWAP protocol. The data transfer mechanism is used to upload
7152 information available at the WTP to the AC, such as crash or debug
7153 information. The data transfer messages can only be exchanged while
7154 in the Run state.
7155
7156 Figure 10 provides an example of an AC that requests that the WTP
7157 transfer its latest crash file. Once the WTP acknowledges that it
7158 has information to send, via the Data Transfer Response, it transmits
7159 its own Data Transfer Request. Upon receipt, the AC responds with a
7160
7161
7162
7163
7164 <span class="grey">Calhoun, et al. Standards Track [Page 128]</span></pre>
7165 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-129" ></span>
7166 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7167
7168
7169 Data Transfer Response, and the exchange continues until the WTP
7170 transmits a Data Transfer Data message element that indicates an End
7171 of File (EOF).
7172
7173 WTP AC
7174
7175 Data Transfer Request (Data Transfer Mode = Crash Data)
7176 &lt;------------------------------------------------------
7177
7178 Data Transfer Response (Result Code = Success)
7179 --------------------------------------------------------&gt;
7180
7181 Data Transfer Request (Data Transfer Data = Data)
7182 --------------------------------------------------------&gt;
7183
7184 Data Transfer Response (Result Code = Success)
7185 &lt;------------------------------------------------------
7186
7187 .....
7188
7189 Data Transfer Request (Data Transfer Data = EOF)
7190 --------------------------------------------------------&gt;
7191
7192 Data Transfer Response (Result Code = Success)
7193 &lt;------------------------------------------------------
7194
7195
7196 Figure 10: WTP Data Transfer Case 1
7197
7198 Figure 11 provides an example of an AC that requests that the WTP
7199 transfer its latest crash file. However, in this example, the WTP
7200 does not have any crash information to send, and therefore sends a
7201 Data Transfer Response with a Result Code indicating the error.
7202
7203 WTP AC
7204
7205 Data Transfer Request (Data Transfer Mode = Crash Data)
7206 &lt;------------------------------------------------------
7207
7208 Data Transfer Response (Result Code = Data Transfer
7209 Error (No Information to Transfer))
7210 --------------------------------------------------------&gt;
7211
7212
7213 Figure 11: WTP Data Transfer Case 2
7214
7215
7216
7217
7218
7219
7220 <span class="grey">Calhoun, et al. Standards Track [Page 129]</span></pre>
7221 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-130" ></span>
7222 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7223
7224
7225 <span class="h4"><a class="selflink" id="section-9.6.1" href="#section-9.6.1">9.6.1</a>. Data Transfer Request</span>
7226
7227 The Data Transfer Request message is used to deliver debug
7228 information from the WTP to the AC.
7229
7230 The Data Transfer Request messages can be sent either by the AC or
7231 the WTP. When sent by the AC, it is used to request that data be
7232 transmitted from the WTP to the AC, and includes the Data Transfer
7233 Mode message element, which specifies the information desired by the
7234 AC. The Data Transfer Request is sent by the WTP in order to
7235 transfer actual data to the AC, through the Data Transfer Data
7236 message element.
7237
7238 Given that the CAPWAP protocol minimizes the need for WTPs to be
7239 directly managed, the Data Transfer Request is an important
7240 troubleshooting tool used by the AC to retrieve information that may
7241 be available on the WTP. For instance, some WTP implementations may
7242 store crash information to help manufacturers identify software
7243 faults. The Data Transfer Request message can be used to send such
7244 information from the WTP to the AC. Another possible use would be to
7245 allow a remote debugger function in the WTP to use the Data Transfer
7246 Request message to send console output to the AC for debugging
7247 purposes.
7248
7249 When the WTP or AC receives a Data Transfer Request message, it
7250 responds to the WTP with a Data Transfer Response message. The AC
7251 MAY log the information received through the Data Transfer Data
7252 message element.
7253
7254 The Data Transfer Request message is sent by the WTP or AC when in
7255 the Run state.
7256
7257 When sent by the AC, the Data Transfer Request message MUST contain
7258 the following message element:
7259
7260 o Data Transfer Mode, see <a href="#section-4.6.16">Section 4.6.16</a>
7261
7262 When sent by the WTP, the Data Transfer Request message MUST contain
7263 the following message element:
7264
7265 o Data Transfer Data, see <a href="#section-4.6.15">Section 4.6.15</a>
7266
7267 Regardless of whether the Data Transfer Request is sent by the AC or
7268 WTP, the following message element MAY be included in the Data
7269 Transfer Request message:
7270
7271 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
7272
7273
7274
7275
7276 <span class="grey">Calhoun, et al. Standards Track [Page 130]</span></pre>
7277 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-131" ></span>
7278 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7279
7280
7281 <span class="h4"><a class="selflink" id="section-9.6.2" href="#section-9.6.2">9.6.2</a>. Data Transfer Response</span>
7282
7283 The Data Transfer Response message acknowledges the Data Transfer
7284 Request message.
7285
7286 A Data Transfer Response message is sent in response to a received
7287 Data Transfer Request message. Its purpose is to acknowledge receipt
7288 of the Data Transfer Request message. When sent by the WTP, the
7289 Result Code message element is used to indicate whether the data
7290 transfer requested by the AC can be completed. When sent by the AC,
7291 the Result Code message element is used to indicate receipt of the
7292 data transferred in the Data Transfer Request message.
7293
7294 The Data Transfer Response message is sent by the WTP or AC when in
7295 the Run state.
7296
7297 The following message element MUST be included in the Data Transfer
7298 Response message:
7299
7300 o Result Code, see <a href="#section-4.6.35">Section 4.6.35</a>
7301
7302 The following message element MAY be included in the Data Transfer
7303 Response message:
7304
7305 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
7306
7307 Upon receipt of a Data Transfer Response message, the WTP transmits
7308 more information, if more information is available.
7309
7310 <span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. Station Session Management</span>
7311
7312 Messages in this section are used by the AC to create, modify, or
7313 delete station session state on the WTPs.
7314
7315 <span class="h3"><a class="selflink" id="section-10.1" href="#section-10.1">10.1</a>. Station Configuration Request</span>
7316
7317 The Station Configuration Request message is used to create, modify,
7318 or delete station session state on a WTP. The message is sent by the
7319 AC to the WTP, and MAY contain one or more message elements. The
7320 message elements for this CAPWAP Control message include information
7321 that is generally highly technology specific. Refer to the
7322 appropriate binding document for definitions of the messages elements
7323 that are included in this control message.
7324
7325 The Station Configuration Request message is sent by the AC when in
7326 the Run state. The WTP does not transmit this message.
7327
7328
7329
7330
7331
7332 <span class="grey">Calhoun, et al. Standards Track [Page 131]</span></pre>
7333 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-132" ></span>
7334 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7335
7336
7337 The following CAPWAP Control message elements MAY be included in the
7338 Station Configuration Request message. More than one of each message
7339 element listed MAY be included in the Station Configuration Request
7340 message:
7341
7342 o Add Station, see <a href="#section-4.6.8">Section 4.6.8</a>
7343
7344 o Delete Station, see <a href="#section-4.6.20">Section 4.6.20</a>
7345
7346 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
7347
7348 <span class="h3"><a class="selflink" id="section-10.2" href="#section-10.2">10.2</a>. Station Configuration Response</span>
7349
7350 The Station Configuration Response message is used to acknowledge a
7351 previously received Station Configuration Request message.
7352
7353 The Station Configuration Response message is sent by the WTP when in
7354 the Run state. The AC does not transmit this message.
7355
7356 The following message element MUST be present in the Station
7357 Configuration Response message:
7358
7359 o Result Code, see <a href="#section-4.6.35">Section 4.6.35</a>
7360
7361 The following message element MAY be included in the Station
7362 Configuration Response message:
7363
7364 o Vendor Specific Payload, see <a href="#section-4.6.39">Section 4.6.39</a>
7365
7366 The Result Code message element indicates that the requested
7367 configuration was successfully applied, or that an error related to
7368 processing of the Station Configuration Request message occurred on
7369 the WTP.
7370
7371 <span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. NAT Considerations</span>
7372
7373 There are three specific situations in which a NAT deployment may be
7374 used in conjunction with a CAPWAP-enabled deployment. The first
7375 consists of a configuration in which a single WTP is behind a NAT
7376 system. Since all communication is initiated by the WTP, and all
7377 communication is performed over IP using two UDP ports, the protocol
7378 easily traverses NAT systems in this configuration.
7379
7380 In the second case, two or more WTPs are deployed behind the same NAT
7381 system. Here, the AC would receive multiple connection requests from
7382 the same IP address, and therefore cannot use the WTP's IP address
7383 alone to bind the CAPWAP Control and Data channel. The CAPWAP Data
7384 Check state, which establishes the data plane connection and
7385
7386
7387
7388 <span class="grey">Calhoun, et al. Standards Track [Page 132]</span></pre>
7389 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-133" ></span>
7390 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7391
7392
7393 communicates the CAPWAP Data Channel Keep-Alive, includes the Session
7394 Identifier message element, which is used to bind the control and
7395 data plane. Use of the Session Identifier message element enables
7396 the AC to match the control and data plane flows from multiple WTPs
7397 behind the same NAT system (multiple WTPs sharing the same IP
7398 address). CAPWAP implementations MUST also use DTLS session
7399 information on any encrypted CAPWAP channel to validate the source of
7400 both the control and data plane, as described in <a href="#section-12.2">Section 12.2</a>.
7401
7402 In the third configuration, the AC is deployed behind a NAT. In this
7403 case, the AC is not reachable by the WTP unless a specific rule has
7404 been configured on the NAT to translate the address and redirect
7405 CAPWAP messages to the AC. This deployment presents two issues.
7406 First, an AC communicates its interfaces and corresponding WTP load
7407 using the CAPWAP Control IPv4 Address and CAPWAP Control IPv6 Address
7408 message elements. This message element is mandatory, but contains IP
7409 addresses that are only valid in the private address space used by
7410 the AC, which is not reachable by the WTP. The WTP MUST NOT utilize
7411 the information in these message elements if it detects a NAT (as
7412 described in the CAPWAP Transport Protocol message element in
7413 <a href="#section-4.6.14">Section 4.6.14</a>). Second, since the addresses cannot be used by the
7414 WTP, this effectively disables the load-balancing capabilities (see
7415 <a href="#section-6.1">Section 6.1</a>) of the CAPWAP protocol. Alternatively, the AC could
7416 have a configured NAT'ed address, which it would include in either of
7417 the two control address message elements, and the NAT would need to
7418 be configured accordingly.
7419
7420 In order for a CAPWAP WTP or AC to detect whether a middlebox is
7421 present, both the Join Request (see <a href="#section-6.1">Section 6.1</a>) and the Join
7422 Response (see <a href="#section-6.2">Section 6.2</a>) include either the CAPWAP Local IPv4
7423 Address (see <a href="#section-4.6.11">Section 4.6.11</a>) or the CAPWAP Local IPv6 Address (see
7424 <a href="#section-4.6.12">Section 4.6.12</a>) message element. Upon receiving one of these
7425 messages, if the packet's source IP address differs from the address
7426 found in either one of these message elements, it indicates that a
7427 middlebox is present.
7428
7429 In order for CAPWAP to be compatible with potential middleboxes in
7430 the network, CAPWAP implementations MUST send return traffic from the
7431 same port on which it received traffic from a given peer. Further,
7432 any unsolicited requests generated by a CAPWAP node MUST be sent on
7433 the same port.
7434
7435 Note that this middlebox detection technique is not foolproof. If
7436 the public IP address assigned to the NAT is identical to the private
7437 IP address used by the AC, detection by the WTP would fail. This
7438 failure can lead to various protocol errors, so it is therefore
7439 necessary for deployments to ensure that the NAT's IP address is not
7440 the same as the ACs.
7441
7442
7443
7444 <span class="grey">Calhoun, et al. Standards Track [Page 133]</span></pre>
7445 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-134" ></span>
7446 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7447
7448
7449 The CAPWAP protocol allows for all of the AC identities supporting a
7450 group of WTPs to be communicated through the AC List message element.
7451 This feature MUST be ignored by the WTP when it detects the AC is
7452 behind a middlebox.
7453
7454 The CAPWAP protocol allows an AC to configure a static IP address on
7455 a WTP using the WTP Static IP Address Information message element.
7456 This message element SHOULD NOT be used in NAT'ed environments,
7457 unless the administrator is familiar with the internal IP addressing
7458 scheme within the WTP's private network, and does not rely on the
7459 public address seen by the AC.
7460
7461 When a WTP detects the duplicate address condition, it generates a
7462 message to the AC, which includes the Duplicate IP Address message
7463 element. The IP address embedded within this message element is
7464 different from the public IP address seen by the AC.
7465
7466 <span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>. Security Considerations</span>
7467
7468 This section describes security considerations for the CAPWAP
7469 protocol. It also provides security recommendations for protocols
7470 used in conjunction with CAPWAP.
7471
7472 <span class="h3"><a class="selflink" id="section-12.1" href="#section-12.1">12.1</a>. CAPWAP Security</span>
7473
7474 As it is currently specified, the CAPWAP protocol sits between the
7475 security mechanisms specified by the wireless link layer protocol
7476 (e.g., IEEE 802.11i) and Authentication, Authorization, and
7477 Accounting (AAA). One goal of CAPWAP is to bootstrap trust between
7478 the STA and WTP using a series of preestablished trust relationships:
7479
7480 STA WTP AC AAA
7481 ==============================================
7482
7483 DTLS Cred AAA Cred
7484 &lt;------------&gt;&lt;-------------&gt;
7485
7486 EAP Credential
7487 &lt;------------------------------------------&gt;
7488
7489 wireless link layer
7490 (e.g., 802.11 PTK)
7491 &lt;--------------&gt; or
7492 &lt;---------------------------&gt;
7493 (derived)
7494
7495 Figure 12: STA Session Setup
7496
7497
7498
7499
7500 <span class="grey">Calhoun, et al. Standards Track [Page 134]</span></pre>
7501 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-135" ></span>
7502 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7503
7504
7505 Within CAPWAP, DTLS is used to secure the link between the WTP and
7506 AC. In addition to securing control messages, it's also a link in
7507 this chain of trust for establishing link layer keys. Consequently,
7508 much rests on the security of DTLS.
7509
7510 In some CAPWAP deployment scenarios, there are two channels between
7511 the WTP and AC: the control channel, carrying CAPWAP Control
7512 messages, and the data channel, over which client data packets are
7513 tunneled between the AC and WTP. Typically, the control channel is
7514 secured by DTLS, while the data channel is not.
7515
7516 The use of parallel protected and unprotected channels deserves
7517 special consideration, but does not create a threat. There are two
7518 potential concerns: attempting to convert protected data into
7519 unprotected data and attempting to convert un-protected data into
7520 protected data. These concerns are addressed below.
7521
7522 <span class="h4"><a class="selflink" id="section-12.1.1" href="#section-12.1.1">12.1.1</a>. Converting Protected Data into Unprotected Data</span>
7523
7524 Since CAPWAP does not support authentication-only ciphers (i.e., all
7525 supported ciphersuites include encryption and authentication), it is
7526 not possible to convert protected data into unprotected data. Since
7527 encrypted data is (ideally) indistinguishable from random data, the
7528 probability of an encrypted packet passing for a well-formed packet
7529 is effectively zero.
7530
7531 <span class="h4"><a class="selflink" id="section-12.1.2" href="#section-12.1.2">12.1.2</a>. Converting Unprotected Data into Protected Data (Insertion)</span>
7532
7533 The use of message authentication makes it impossible for the
7534 attacker to forge protected records. This makes conversion of
7535 unprotected records to protected records impossible.
7536
7537 <span class="h4"><a class="selflink" id="section-12.1.3" href="#section-12.1.3">12.1.3</a>. Deletion of Protected Records</span>
7538
7539 An attacker could remove protected records from the stream, though
7540 not undetectably so, due the built-in reliability of the underlying
7541 CAPWAP protocol. In the worst case, the attacker would remove the
7542 same record repeatedly, resulting in a CAPWAP session timeout and
7543 restart. This is effectively a DoS attack, and could be accomplished
7544 by a man in the middle regardless of the CAPWAP protocol security
7545 mechanisms chosen.
7546
7547 <span class="h4"><a class="selflink" id="section-12.1.4" href="#section-12.1.4">12.1.4</a>. Insertion of Unprotected Records</span>
7548
7549 An attacker could inject packets into the unprotected channel, but
7550 this may become evident if sequence number desynchronization occurs
7551 as a result. Only if the attacker is a man in the middle (MITM) can
7552
7553
7554
7555
7556 <span class="grey">Calhoun, et al. Standards Track [Page 135]</span></pre>
7557 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-136" ></span>
7558 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7559
7560
7561 packets be inserted undetectably. This is a consequence of that
7562 channel's lack of protection, and not a new threat resulting from the
7563 CAPWAP security mechanism.
7564
7565 <span class="h4"><a class="selflink" id="section-12.1.5" href="#section-12.1.5">12.1.5</a>. Use of MD5</span>
7566
7567 The Image Information message element (<a href="#section-4.6.28">Section 4.6.28</a>) makes use of
7568 MD5 to compute the hash field. The authenticity and integrity of the
7569 image file is protected by DTLS, and in this context, MD5 is not used
7570 as a cryptographically secure hash, but just as a basic checksum.
7571 Therefore, the use of MD5 is not considered a security vulnerability,
7572 and no mechanisms for algorithm agility are provided.
7573
7574 <span class="h4"><a class="selflink" id="section-12.1.6" href="#section-12.1.6">12.1.6</a>. CAPWAP Fragmentation</span>
7575
7576 <a href="./rfc4963">RFC 4963</a> [<a href="./rfc4963" title="&quot;IPv4 Reassembly Errors at High Data Rates&quot;">RFC4963</a>] describes a possible security vulnerability where
7577 a malicious entity can "corrupt" a flow by injecting fragments. By
7578 sending "high" fragments (those with offset greater than zero) with a
7579 forged source address, the attacker can deliberately cause
7580 corruption. The use of DTLS on the CAPWAP Data channel can be used
7581 to avoid this possible vulnerability.
7582
7583 <span class="h3"><a class="selflink" id="section-12.2" href="#section-12.2">12.2</a>. Session ID Security</span>
7584
7585 Since DTLS does not export a unique session identifier, there can be
7586 no explicit protocol binding between the DTLS layer and CAPWAP layer.
7587 As a result, implementations MUST provide a mechanism for performing
7588 this binding. For example, an AC MUST NOT associate decrypted DTLS
7589 control packets with a particular WTP session based solely on the
7590 Session ID in the packet header. Instead, identification should be
7591 done based on which DTLS session decrypted the packet. Otherwise,
7592 one authenticated WTP could spoof another authenticated WTP by
7593 altering the Session ID in the encrypted CAPWAP Header.
7594
7595 It should be noted that when the CAPWAP Data channel is unencrypted,
7596 the WTP Session ID is exposed and possibly known to adversaries and
7597 other WTPs. This would allow the forgery of the source of data-
7598 channel traffic. This, however, should not be a surprise for
7599 unencrypted data channels. When the data channel is encrypted, the
7600 Session ID is not exposed, and therefore can safely be used to
7601 associate a data and control channel. The 128-bit length of the
7602 Session ID mitigates online guessing attacks where an adversarial,
7603 authenticated WTP tries to correlate his own data channel with
7604 another WTP's control channel. Note that for encrypted data
7605 channels, the Session ID should only be used for correlation for the
7606 first packet immediately after the initial DTLS handshake. Future
7607 correlation should instead be done via identification of a packet's
7608 DTLS session.
7609
7610
7611
7612 <span class="grey">Calhoun, et al. Standards Track [Page 136]</span></pre>
7613 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-137" ></span>
7614 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7615
7616
7617 <span class="h3"><a class="selflink" id="section-12.3" href="#section-12.3">12.3</a>. Discovery or DTLS Setup Attacks</span>
7618
7619 Since the Discovery Request messages are sent in the clear, it is
7620 important that AC implementations NOT assume that receiving a
7621 Discovery Request message from a WTP implies that the WTP has
7622 rebooted, and consequently tear down any active DTLS sessions.
7623 Discovery Request messages can easily be spoofed by malicious
7624 devices, so it is important that the AC maintain two separate sets of
7625 states for the WTP until the DTLSSessionEstablished notification is
7626 received, indicating that the WTP was authenticated. Once a new DTLS
7627 session is successfully established, any state referring to the old
7628 session can be cleared.
7629
7630 Similarly, when the AC is entering the DTLS Setup phase, it SHOULD
7631 NOT assume that the WTP has reset, and therefore should not discard
7632 active state until the DTLS session has been successfully
7633 established. While the HelloVerifyRequest provides some protection
7634 against denial-of-service (DoS) attacks on the AC, an adversary
7635 capable of receiving packets at a valid address (or a malfunctioning
7636 or misconfigured WTP) may repeatedly attempt DTLS handshakes with the
7637 AC, potentially creating a resource shortage. If either the
7638 FailedDTLSSessionCount or the FailedDTLSAuthFailCount counter reaches
7639 the value of MaxFailedDTLSSessionRetry variable (see <a href="#section-4.8">Section 4.8</a>),
7640 implementations MAY choose to rate-limit new DTLS handshakes for some
7641 period of time. It is RECOMMENDED that implementations choosing to
7642 implement rate-limiting use a random discard technique, rather than
7643 mimicking the WTP's sulking behavior. This will ensure that messages
7644 from valid WTPs will have some probability of eliciting a response,
7645 even in the face of a significant DoS attack.
7646
7647 Some CAPWAP implementations may wish to restrict the DTLS setup
7648 process to only those peers that have been configured in the access
7649 control list, authorizing only those clients to initiate a DTLS
7650 handshake. Note that the impact of this on mitigating denial-of-
7651 service attacks against the DTLS layer is minimal, because DTLS
7652 already uses client-side cookies to minimize processor consumption
7653 attacks.
7654
7655 <span class="h3"><a class="selflink" id="section-12.4" href="#section-12.4">12.4</a>. Interference with a DTLS Session</span>
7656
7657 If a WTP or AC repeatedly receives packets that fail DTLS
7658 authentication or decryption, this could indicate a DTLS
7659 desynchronization between the AC and WTP, a link prone to
7660 undetectable bit errors, or an attacker trying to disrupt a DTLS
7661 session.
7662
7663
7664
7665
7666
7667
7668 <span class="grey">Calhoun, et al. Standards Track [Page 137]</span></pre>
7669 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-138" ></span>
7670 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7671
7672
7673 In the state machine (<a href="#section-2.3">section 2.3</a>), transitions to the DTLS Tear Down
7674 (TD) state can be triggered by frequently receiving DTLS packets with
7675 authentication or decryption errors. The threshold or technique for
7676 deciding when to move to the tear down state should be chosen
7677 carefully. Being able to easily transition to DTLS TD allows easy
7678 detection of malfunctioning devices, but allows for denial-of-service
7679 attacks. Making it difficult to transition to DTLS TD prevents
7680 denial-of-service attacks, but makes it more difficult to detect and
7681 reset a malfunctioning session. Implementers should set this policy
7682 with care.
7683
7684 <span class="h3"><a class="selflink" id="section-12.5" href="#section-12.5">12.5</a>. CAPWAP Pre-Provisioning</span>
7685
7686 In order for CAPWAP to establish a secure communication with a peer,
7687 some level of pre-provisioning on both the WTP and AC is necessary.
7688 This section will detail the minimal number of configuration
7689 parameters.
7690
7691 When using pre-shared keys, it is necessary to configure the pre-
7692 shared key for each possible peer with which a DTLS session may be
7693 established. To support this mode of operation, one or more entries
7694 of the following table may be configured on either the AC or WTP:
7695
7696 o Identity: The identity of the peering AC or WTP. This format MAY
7697 be in the form of either an IP address or host name (the latter of
7698 which needs to be resolved to an IP address using DNS).
7699
7700 o Key: The pre-shared key for use with the peer when establishing
7701 the DTLS session (see <a href="#section-12.6">Section 12.6</a> for more information).
7702
7703 o PSK Identity: Identity hint associated with the provisioned key
7704 (see <a href="#section-2.4.4.4">Section 2.4.4.4</a> for more information).
7705
7706 When using certificates, the following items need to be pre-
7707 provisioned:
7708
7709 o Device Certificate: The local device's certificate (see
7710 <a href="#section-12.7">Section 12.7</a> for more information).
7711
7712 o Trust Anchor: Trusted root certificate chain used to validate any
7713 certificate received from CAPWAP peers. Note that one or more
7714 root certificates MAY be configured on a given device.
7715
7716 Regardless of the authentication method, the following item needs to
7717 be pre-provisioned:
7718
7719
7720
7721
7722
7723
7724 <span class="grey">Calhoun, et al. Standards Track [Page 138]</span></pre>
7725 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-139" ></span>
7726 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7727
7728
7729 o Access Control List: The access control list table contains the
7730 identities of one or more CAPWAP peers, along with a rule. The
7731 rule is used to determine whether communication with the peer is
7732 permitted (see <a href="#section-2.4.4.3">Section 2.4.4.3</a> for more information).
7733
7734 <span class="h3"><a class="selflink" id="section-12.6" href="#section-12.6">12.6</a>. Use of Pre-Shared Keys in CAPWAP</span>
7735
7736 While use of pre-shared keys may provide deployment and provisioning
7737 advantages not found in public-key-based deployments, it also
7738 introduces a number of operational and security concerns. In
7739 particular, because the keys must typically be entered manually, it
7740 is common for people to base them on memorable words or phrases.
7741 These are referred to as "low entropy passwords/passphrases".
7742
7743 Use of low-entropy pre-shared keys, coupled with the fact that the
7744 keys are often not frequently updated, tends to significantly
7745 increase exposure. For these reasons, the following recommendations
7746 are made:
7747
7748 o When DTLS is used with a pre-shared key (PSK) ciphersuite, each
7749 WTP SHOULD have a unique PSK. Since WTPs will likely be widely
7750 deployed, their physical security is not guaranteed. If PSKs are
7751 not unique for each WTP, key reuse would allow the compromise of
7752 one WTP to result in the compromise of others.
7753
7754 o Generating PSKs from low entropy passwords is NOT RECOMMENDED.
7755
7756 o It is RECOMMENDED that implementations that allow the
7757 administrator to manually configure the PSK also provide a
7758 capability for generation of new random PSKs, taking <a href="./rfc4086">RFC 4086</a>
7759 [<a href="./rfc4086" title="&quot;Randomness Requirements for Security&quot;">RFC4086</a>] into account.
7760
7761 o Pre-shared keys SHOULD be periodically updated. Implementations
7762 MAY facilitate this by providing an administrative interface for
7763 automatic key generation and periodic update, or it MAY be
7764 accomplished manually instead.
7765
7766 Every pairwise combination of WTP and AC on the network SHOULD have a
7767 unique PSK. This prevents the domino effect (see "Guidance for
7768 Authentication, Authorization, and Accounting (AAA) Key Management"
7769 [<a href="./rfc4962" title="&quot;Guidance for Authentication, Authorization, and Accounting (AAA) Key Management&quot;">RFC4962</a>]). If PSKs are tied to specific WTPs, then knowledge of the
7770 PSK implies a binding to a specified identity that can be authorized.
7771
7772 If PSKs are shared, this binding between device and identity is no
7773 longer possible. Compromise of one WTP can yield compromise of
7774 another WTP, violating the CAPWAP security hierarchy. Consequently,
7775 sharing keys between WTPs is NOT RECOMMENDED.
7776
7777
7778
7779
7780 <span class="grey">Calhoun, et al. Standards Track [Page 139]</span></pre>
7781 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-140" ></span>
7782 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7783
7784
7785 <span class="h3"><a class="selflink" id="section-12.7" href="#section-12.7">12.7</a>. Use of Certificates in CAPWAP</span>
7786
7787 For public-key-based DTLS deployments, each device SHOULD have unique
7788 credentials, with an extended key usage authorizing the device to act
7789 as either a WTP or AC. If devices do not have unique credentials, it
7790 is possible that by compromising one device, any other device using
7791 the same credential may also be considered to be compromised.
7792
7793 Certificate validation involves checking a large variety of things.
7794 Since the necessary things to validate are often environment-
7795 specific, many are beyond the scope of this document. In this
7796 section, we provide some basic guidance on certificate validation.
7797
7798 Each device is responsible for authenticating and authorizing devices
7799 with which they communicate. Authentication entails validation of
7800 the chain of trust leading to the peer certificate, followed by the
7801 peer certificate itself. Implementations SHOULD also provide a
7802 secure method for verifying that the credential in question has not
7803 been revoked.
7804
7805 Note that if the WTP relies on the AC for network connectivity (e.g.,
7806 the AC is a Layer 2 switch to which the WTP is directly connected),
7807 the WTP may not be able to contact an Online Certificate Status
7808 Protocol (OCSP) server or otherwise obtain an up-to-date Certificate
7809 Revocation List (CRL) if a compromised AC doesn't explicitly permit
7810 this. This cannot be avoided, except through effective physical
7811 security and monitoring measures at the AC.
7812
7813 Proper validation of certificates typically requires checking to
7814 ensure the certificate has not yet expired. If devices have a real-
7815 time clock, they SHOULD verify the certificate validity dates. If no
7816 real-time clock is available, the device SHOULD make a best-effort
7817 attempt to validate the certificate validity dates through other
7818 means. Failure to check a certificate's temporal validity can make a
7819 device vulnerable to man-in-the-middle attacks launched using
7820 compromised, expired certificates, and therefore devices should make
7821 every effort to perform this validation.
7822
7823 <span class="h3"><a class="selflink" id="section-12.8" href="#section-12.8">12.8</a>. Use of MAC Address in CN Field</span>
7824
7825 The CAPWAP protocol is an evolution of an existing protocol [<a href="#ref-LWAPP" title="&quot;Lightweight Access Point Protocol&quot;">LWAPP</a>],
7826 which is implemented on a large number of already deployed ACs and
7827 WTPs. Every one of these devices has an existing X.509 certificate,
7828 which is provisioned at the time of manufacturing. These X.509
7829 certificates use the device's MAC address in the Common Name (CN)
7830 field. It is well understood that encoding the MAC address in the CN
7831 field is less than optimal, and using the SubjectAltName field would
7832 be preferable. However, at the time of publication, there is no URN
7833
7834
7835
7836 <span class="grey">Calhoun, et al. Standards Track [Page 140]</span></pre>
7837 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-141" ></span>
7838 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7839
7840
7841 specification that allows for the MAC address to be used in the
7842 SubjectAltName field. As such a specification is published by the
7843 IETF, future versions of the CAPWAP protocol MAY require support for
7844 the new URN scheme.
7845
7846 <span class="h3"><a class="selflink" id="section-12.9" href="#section-12.9">12.9</a>. AAA Security</span>
7847
7848 The AAA protocol is used to distribute Extensible Authentication
7849 Protocol (EAP) keys to the ACs, and consequently its security is
7850 important to the overall system security. When used with Transport
7851 Layer Security (TLS) or IPsec, security guidelines specified in <a href="./rfc3539">RFC</a>
7852 <a href="./rfc3539">3539</a> [<a href="./rfc3539" title="&quot;Authentication, Authorization and Accounting (AAA) Transport Profile&quot;">RFC3539</a>] SHOULD be followed.
7853
7854 In general, the link between the AC and AAA server SHOULD be secured
7855 using a strong ciphersuite keyed with mutually authenticated session
7856 keys. Implementations SHOULD NOT rely solely on Basic RADIUS shared
7857 secret authentication as it is often vulnerable to dictionary
7858 attacks, but rather SHOULD use stronger underlying security
7859 mechanisms.
7860
7861 <span class="h3"><a class="selflink" id="section-12.10" href="#section-12.10">12.10</a>. WTP Firmware</span>
7862
7863 The CAPWAP protocol defines a mechanism by which the AC downloads new
7864 firmware to the WTP. During the session establishment process, the
7865 WTP provides information about its current firmware to the AC. The
7866 AC then decides whether the WTP's firmware needs to be updated. It
7867 is important to note that the CAPWAP specification makes the explicit
7868 assumption that the WTP is providing the correct firmware version to
7869 the AC, and is therefore not lying. Further, during the firmware
7870 download process, the CAPWAP protocol does not provide any mechanisms
7871 to recognize whether the WTP is actually storing the firmware for
7872 future use.
7873
7874 <span class="h2"><a class="selflink" id="section-13" href="#section-13">13</a>. Operational Considerations</span>
7875
7876 The CAPWAP protocol assumes that it is the only configuration
7877 interface to the WTP to configure parameters that are specified in
7878 the CAPWAP specifications. While the use of a separate management
7879 protocol MAY be used for the purposes of monitoring the WTP directly,
7880 configuring the WTP through a separate management interface is not
7881 recommended. Configuring the WTP through a separate protocol, such
7882 as via a command line interface (CLI) or Simple Network Management
7883 Protocol (SNMP), could lead to the AC state being out of sync with
7884 the WTP.
7885
7886
7887
7888
7889
7890
7891
7892 <span class="grey">Calhoun, et al. Standards Track [Page 141]</span></pre>
7893 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-142" ></span>
7894 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7895
7896
7897 The CAPWAP protocol does not deal with the management of the ACs.
7898 The AC is assumed to be configured through some separate management
7899 interface, which could be via a proprietary CLI, SNMP, Network
7900 Configuration Protocol (NETCONF), or some other management protocol.
7901
7902 The CAPWAP protocol's control channel is fairly lightweight from a
7903 traffic perspective. Once the WTP has been configured, the WTP sends
7904 periodic statistics. Further, the specification calls for a keep-
7905 alive packet to be sent on the protocol's data channel to make sure
7906 that any possible middleboxes (e.g., NAT) maintain their UDP state.
7907 The overhead associated with the control and data channel is not
7908 expected to impact network traffic. That said, the CAPWAP protocol
7909 does allow for the frequency of these packets to be modified through
7910 the DataChannelKeepAlive and StatisticsTimer (see <a href="#section-4.7.2">Section 4.7.2</a> and
7911 <a href="#section-4.7.14">Section 4.7.14</a>, respectively).
7912
7913 <span class="h2"><a class="selflink" id="section-14" href="#section-14">14</a>. Transport Considerations</span>
7914
7915 The CAPWAP WG carefully considered the congestion control
7916 requirements of the CAPWAP protocol, both for the CAPWAP Control and
7917 Data channels.
7918
7919 CAPWAP specifies a single-threaded command/response protocol to be
7920 used on the control channel, and we have specified that an
7921 exponential back-off algorithm should be used when commands are
7922 retransmitted. When CAPWAP runs in its default mode (Local MAC), the
7923 control channel is the only CAPWAP channel.
7924
7925 However, CAPWAP can also be run in Split MAC mode, in which case
7926 there will be a DTLS-encrypted data channel between each WTP and the
7927 AC. The WG discussed various options for providing congestion
7928 control on this channel. However, due to performance problems with
7929 TCP when it is run over another congestion control mechanism and the
7930 fact that the vast majority of traffic run over the CAPWAP Data
7931 channel is likely to be congestion-controlled IP traffic, the CAPWAP
7932 WG felt that specifying a congestion control mechanism for the CAPWAP
7933 Data channel would be more likely to cause problems than to resolve
7934 any.
7935
7936 Because there is no congestion control mechanism specified for the
7937 CAPWAP Data channel, it is RECOMMENDED that non-congestion-controlled
7938 traffic not be tunneled over CAPWAP. When a significant amount of
7939 non-congestion-controlled traffic is expected to be present on a
7940 WLAN, the CAPWAP connection between the AC and the WTP for that LAN
7941 should be configured to remain in Local MAC mode with Distribution
7942 function at the WTP.
7943
7944
7945
7946
7947
7948 <span class="grey">Calhoun, et al. Standards Track [Page 142]</span></pre>
7949 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-143" ></span>
7950 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
7951
7952
7953 The lock step nature of the CAPWAP protocol's control channel can
7954 cause the firmware download process to take some time, depending upon
7955 the round-trip time (RTT). This is not expected to be a problem
7956 since the CAPWAP protocol allows firmware to be downloaded while the
7957 WTP provides service to wireless clients/devices.
7958
7959 It is necessary for the WTP and AC to configure their MTU based on
7960 the capabilities of the path. See <a href="#section-3.5">Section 3.5</a> for more information.
7961
7962 The CAPWAP protocol mandates support of the Explicit Congestion
7963 Notification (ECN) through a mode of operation named "limited
7964 functionality option", detailed in <a href="./rfc3168#section-9.1.1">section&nbsp;9.1.1 of [RFC3168]</a>.
7965 Future versions of the CAPWAP protocol should consider mandating
7966 support for the "full functionality option".
7967
7968 <span class="h2"><a class="selflink" id="section-15" href="#section-15">15</a>. IANA Considerations</span>
7969
7970 This section details the actions that IANA has taken in preparation
7971 for publication of the specification. Numerous registries have been
7972 created, and the contents, document action (see [<a href="./rfc5226" title="">RFC5226</a>], and
7973 registry format are all included below. Note that in cases where bit
7974 fields are referred to, the bit numbering is left to right, where the
7975 leftmost bit is labeled as bit zero (0).
7976
7977 For future registration requests where an Expert Review is required,
7978 a Designated Expert should be consulted, which is appointed by the
7979 responsible IESG Area Director. The intention is that any allocation
7980 will be accompanied by a published RFC, but given that other SDOs may
7981 want to create standards built on top of CAPWAP, a document the
7982 Designated Expert can review is also acceptable. IANA should allow
7983 for allocation of values prior to documents being approved for
7984 publication, so the Designated Expert can approve allocations once it
7985 seems clear that publication will occur. The Designated Expert will
7986 post a request to the CAPWAP WG mailing list (or a successor
7987 designated by the Area Director) for comment and review. Before a
7988 period of 30 days has passed, the Designated Expert will either
7989 approve or deny the registration request and publish a notice of the
7990 decision to the CAPWAP WG mailing list or its successor, as well as
7991 informing IANA. A denial notice must be justified by an explanation,
7992 and in the cases where it is possible, concrete suggestions on how
7993 the request can be modified so as to become acceptable should be
7994 provided.
7995
7996 <span class="h3"><a class="selflink" id="section-15.1" href="#section-15.1">15.1</a>. IPv4 Multicast Address</span>
7997
7998 IANA has registered a new IPv4 multicast address called "capwap-ac"
7999 from the Internetwork Control Block IPv4 multicast address registry;
8000 see <a href="#section-3.3">Section 3.3</a>.
8001
8002
8003
8004 <span class="grey">Calhoun, et al. Standards Track [Page 143]</span></pre>
8005 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-144" ></span>
8006 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
8007
8008
8009 <span class="h3"><a class="selflink" id="section-15.2" href="#section-15.2">15.2</a>. IPv6 Multicast Address</span>
8010
8011 IANA has registered a new organization local multicast address called
8012 the "All ACs multicast address" in the Variable Scope IPv6 multicast
8013 address registry; see <a href="#section-3.3">Section 3.3</a>.
8014
8015 <span class="h3"><a class="selflink" id="section-15.3" href="#section-15.3">15.3</a>. UDP Port</span>
8016
8017 IANA registered two new UDP Ports, which are organization-local
8018 multicast addresses, in the registered port numbers registry; see
8019 <a href="#section-3.1">Section 3.1</a>. The following values have been registered:
8020
8021 Keyword Decimal Description References
8022 ------- ------- ----------- ----------
8023 capwap-control 5246/udp CAPWAP Control Protocol This Document
8024 capwap-data 5247/udp CAPWAP Data Protocol This Document
8025
8026
8027 <span class="h3"><a class="selflink" id="section-15.4" href="#section-15.4">15.4</a>. CAPWAP Message Types</span>
8028
8029 The Message Type field in the CAPWAP Header (see <a href="#section-4.5.1.1">Section 4.5.1.1</a>) is
8030 used to identify the operation performed by the message. There are
8031 multiple namespaces, which are identified via the first three octets
8032 of the field containing the IANA Enterprise Number [<a href="./rfc5226" title="">RFC5226</a>].
8033
8034 IANA maintains the CAPWAP Message Types registry for all message
8035 types whose Enterprise Number is set to zero (0). The namespace is 8
8036 bits (0-255), where the value of zero (0) is reserved and must not be
8037 assigned. The values one (1) through 26 are allocated in this
8038 specification, and can be found in <a href="#section-4.5.1.1">Section 4.5.1.1</a>. Any new
8039 assignments of a CAPWAP Message Type whose Enterprise Number is set
8040 to zero (0) requires an Expert Review. The registry maintained by
8041 IANA has the following format:
8042
8043 CAPWAP Control Message Message Type Reference
8044 Value
8045
8046 <span class="h3"><a class="selflink" id="section-15.5" href="#section-15.5">15.5</a>. CAPWAP Header Flags</span>
8047
8048 The Flags field in the CAPWAP Header (see <a href="#section-4.3">Section 4.3</a>) is 9 bits in
8049 length and is used to identify any special treatment related to the
8050 message. This specification defines bits zero (0) through five (5),
8051 while bits six (6) through eight (8) are reserved. There are
8052 currently three unused, reserved bits that are managed by IANA and
8053 whose assignment require an Expert Review. IANA created the CAPWAP
8054 Header Flags registry, whose format is:
8055
8056 Flag Field Name Bit Position Reference
8057
8058
8059
8060 <span class="grey">Calhoun, et al. Standards Track [Page 144]</span></pre>
8061 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-145" ></span>
8062 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
8063
8064
8065 <span class="h3"><a class="selflink" id="section-15.6" href="#section-15.6">15.6</a>. CAPWAP Control Message Flags</span>
8066
8067 The Flags field in the CAPWAP Control Message header (see
8068 <a href="#section-4.5.1.4">Section 4.5.1.4</a>) is used to identify any special treatment related to
8069 the control message. There are currently eight (8) unused, reserved
8070 bits. The assignment of these bits is managed by IANA and requires
8071 an Expert Review. IANA created the CAPWAP Control Message Flags
8072 registry, whose format is:
8073
8074 Flag Field Name Bit Position Reference
8075
8076 <span class="h3"><a class="selflink" id="section-15.7" href="#section-15.7">15.7</a>. CAPWAP Message Element Type</span>
8077
8078 The Type field in the CAPWAP Message Element header (see <a href="#section-4.6">Section 4.6</a>)
8079 is used to identify the data being transported. The namespace is 16
8080 bits (0-65535), where the value of zero (0) is reserved and must not
8081 be assigned. The values one (1) through 53 are allocated in this
8082 specification, and can be found in <a href="#section-4.5.1.1">Section 4.5.1.1</a>.
8083
8084 The 16-bit namespace is further divided into blocks of addresses that
8085 are reserved for specific CAPWAP wireless bindings. The following
8086 blocks are reserved:
8087
8088 CAPWAP Protocol Message Elements 1 - 1023
8089 IEEE 802.11 Message Elements 1024 - 2047
8090 EPCGlobal Message Elements 3072 - 4095
8091
8092 This namespace is managed by IANA and assignments require an Expert
8093 Review. IANA created the CAPWAP Message Element Type registry, whose
8094 format is:
8095
8096 CAPWAP Message Element Type Value Reference
8097
8098 <span class="h3"><a class="selflink" id="section-15.8" href="#section-15.8">15.8</a>. CAPWAP Wireless Binding Identifiers</span>
8099
8100 The Wireless Binding Identifier (WBID) field in the CAPWAP Header
8101 (see <a href="#section-4.3">Section 4.3</a>) is used to identify the wireless technology
8102 associated with the packet. This specification allocates the values
8103 one (1) and three (3). Due to the limited address space available, a
8104 new WBID request requires Expert Review. IANA created the CAPWAP
8105 Wireless Binding Identifier registry, whose format is:
8106
8107 CAPWAP Wireless Binding Identifier Type Value Reference
8108
8109
8110
8111
8112
8113
8114
8115
8116 <span class="grey">Calhoun, et al. Standards Track [Page 145]</span></pre>
8117 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-146" ></span>
8118 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
8119
8120
8121 <span class="h3"><a class="selflink" id="section-15.9" href="#section-15.9">15.9</a>. AC Security Types</span>
8122
8123 The Security field in the AC Descriptor message element (see
8124 <a href="#section-4.6.1">Section 4.6.1</a>) is 8 bits in length and is used to identify the
8125 authentication methods available on the AC. This specification
8126 defines bits five (5) and six (6), while bits zero (0) through four
8127 (4) as well as bit seven (7) are reserved and unused. These reserved
8128 bits are managed by IANA and assignment requires Standards Action.
8129 IANA created the AC Security Types registry, whose format is:
8130
8131 AC Security Type Bit Position Reference
8132
8133 <span class="h3"><a class="selflink" id="section-15.10" href="#section-15.10">15.10</a>. AC DTLS Policy</span>
8134
8135 The DTLS Policy field in the AC Descriptor message element (see
8136 <a href="#section-4.6.1">Section 4.6.1</a>) is 8 bits in length and is used to identify whether
8137 the CAPWAP Data Channel is to be secured. This specification defines
8138 bits five (5) and six (6), while bits zero (0) through four (4) as
8139 well as bit seven (7) are reserved and unused. These reserved bits
8140 are managed by IANA and assignment requires Standards Action. IANA
8141 created the AC DTLS Policy registry, whose format is:
8142
8143 AC DTLS Policy Bit Position Reference
8144
8145 <span class="h3"><a class="selflink" id="section-15.11" href="#section-15.11">15.11</a>. AC Information Type</span>
8146
8147 The Information Type field in the AC Descriptor message element (see
8148 <a href="#section-4.6.1">Section 4.6.1</a>) is used to represent information about the AC. The
8149 namespace is 16 bits (0-65535), where the value of zero (0) is
8150 reserved and must not be assigned. This field, combined with the AC
8151 Information Vendor ID, allows vendors to use a private namespace.
8152 This specification defines the AC Information Type namespace when the
8153 AC Information Vendor ID is set to zero (0), for which the values
8154 four (4) and five (5) are allocated in this specification, and can be
8155 found in <a href="#section-4.6.1">Section 4.6.1</a>. This namespace is managed by IANA and
8156 assignments require an Expert Review. IANA created the AC
8157 Information Type registry, whose format is:
8158
8159 AC Information Type Type Value Reference
8160
8161 <span class="h3"><a class="selflink" id="section-15.12" href="#section-15.12">15.12</a>. CAPWAP Transport Protocol Types</span>
8162
8163 The Transport field in the CAPWAP Transport Protocol message element
8164 (see <a href="#section-4.6.14">Section 4.6.14</a>) is used to identify the transport to use for the
8165 CAPWAP Data Channel. The namespace is 8 bits (0-255), where the
8166 value of zero (0) is reserved and must not be assigned. The values
8167 one (1) and two (2) are allocated in this specification, and can be
8168
8169
8170
8171
8172 <span class="grey">Calhoun, et al. Standards Track [Page 146]</span></pre>
8173 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-147" ></span>
8174 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
8175
8176
8177 found in <a href="#section-4.6.14">Section 4.6.14</a>. This namespace is managed by IANA and
8178 assignments require an Expert Review. IANA created the CAPWAP
8179 Transport Protocol Types registry, whose format is:
8180
8181 CAPWAP Transport Protocol Type Type Value Reference
8182
8183 <span class="h3"><a class="selflink" id="section-15.13" href="#section-15.13">15.13</a>. Data Transfer Type</span>
8184
8185 The Data Type field in the Data Transfer Data message element (see
8186 <a href="#section-4.6.15">Section 4.6.15</a>) and Image Data message element (see <a href="#section-4.6.26">Section 4.6.26</a>)
8187 is used to provide information about the data being carried. The
8188 namespace is 8 bits (0-255), where the value of zero (0) is reserved
8189 and must not be assigned. The values one (1), two (2), and five (5)
8190 are allocated in this specification, and can be found in
8191 <a href="#section-4.6.15">Section 4.6.15</a>. This namespace is managed by IANA and assignments
8192 require an Expert Review. IANA created the Data Transfer Type
8193 registry, whose format is:
8194
8195 Data Transfer Type Type Value Reference
8196
8197 <span class="h3"><a class="selflink" id="section-15.14" href="#section-15.14">15.14</a>. Data Transfer Mode</span>
8198
8199 The Data Mode field in the Data Transfer Data message element (see
8200 <a href="#section-4.6.15">Section 4.6.15</a>) and Data Transfer Mode message element (see
8201 <a href="#section-15.14">Section 15.14</a>) is used to provide information about the data being
8202 carried. The namespace is 8 bits (0-255), where the value of zero
8203 (0) is reserved and must not be assigned. The values one (1) and two
8204 (2) are allocated in this specification, and can be found in
8205 <a href="#section-15.14">Section 15.14</a>. This namespace is managed by IANA and assignments
8206 require an Expert Review. IANA created the Data Transfer Mode
8207 registry, whose format is:
8208
8209 Data Transfer Mode Type Value Reference
8210
8211 <span class="h3"><a class="selflink" id="section-15.15" href="#section-15.15">15.15</a>. Discovery Types</span>
8212
8213 The Discovery Type field in the Discovery Type message element (see
8214 <a href="#section-4.6.21">Section 4.6.21</a>) is used by the WTP to indicate to the AC how it was
8215 discovered. The namespace is 8 bits (0-255). The values zero (0)
8216 through four (4) are allocated in this specification and can be found
8217 in <a href="#section-4.6.21">Section 4.6.21</a>. This namespace is managed by IANA and assignments
8218 require an Expert Review. IANA created the Discovery Types registry,
8219 whose format is:
8220
8221 Discovery Types Type Value Reference
8222
8223
8224
8225
8226
8227
8228 <span class="grey">Calhoun, et al. Standards Track [Page 147]</span></pre>
8229 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-148" ></span>
8230 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
8231
8232
8233 <span class="h3"><a class="selflink" id="section-15.16" href="#section-15.16">15.16</a>. ECN Support</span>
8234
8235 The ECN Support field in the ECN Support message element (see
8236 <a href="#section-4.6.25">Section 4.6.25</a>) is used by the WTP to represent its ECN Support. The
8237 namespace is 8 bits (0-255). The values zero (0) and one (1) are
8238 allocated in this specification, and can be found in <a href="#section-4.6.25">Section 4.6.25</a>.
8239 This namespace is managed by IANA and assignments require an Expert
8240 Review. IANA created the ECN Support registry, whose format is:
8241
8242 ECN Support Type Value Reference
8243
8244 <span class="h3"><a class="selflink" id="section-15.17" href="#section-15.17">15.17</a>. Radio Admin State</span>
8245
8246 The Radio Admin field in the Radio Administrative State message
8247 element (see <a href="#section-4.6.33">Section 4.6.33</a>) is used by the WTP to represent the
8248 state of its radios. The namespace is 8 bits (0-255), where the
8249 value of zero (0) is reserved and must not be assigned. The values
8250 one (1) and two (2) are allocated in this specification, and can be
8251 found in <a href="#section-4.6.33">Section 4.6.33</a>. This namespace is managed by IANA and
8252 assignments require an Expert Review. IANA created the Radio Admin
8253 State registry, whose format is:
8254
8255 Radio Admin State Type Value Reference
8256
8257 <span class="h3"><a class="selflink" id="section-15.18" href="#section-15.18">15.18</a>. Radio Operational State</span>
8258
8259 The State field in the Radio Operational State message element (see
8260 <a href="#section-4.6.34">Section 4.6.34</a>) is used by the WTP to represent the operational state
8261 of its radios. The namespace is 8 bits (0-255), where the value of
8262 zero (0) is reserved and must not be assigned. The values one (1)
8263 and two (2) are allocated in this specification, and can be found in
8264 <a href="#section-4.6.34">Section 4.6.34</a>. This namespace is managed by IANA and assignments
8265 require an Expert Review. IANA created the Radio Operational State
8266 registry, whose format is:
8267
8268 Radio Operational State Type Value Reference
8269
8270 <span class="h3"><a class="selflink" id="section-15.19" href="#section-15.19">15.19</a>. Radio Failure Causes</span>
8271
8272 The Cause field in the Radio Operational State message element (see
8273 <a href="#section-4.6.34">Section 4.6.34</a>) is used by the WTP to represent the reason a radio
8274 may have failed. The namespace is 8 bits (0-255), where the value of
8275 zero (0) through three (3) are allocated in this specification, and
8276 can be found in <a href="#section-4.6.34">Section 4.6.34</a>. This namespace is managed by IANA
8277 and assignments require an Expert Review. IANA created the Radio
8278 Failure Causes registry, whose format is:
8279
8280 Radio Failure Causes Type Value Reference
8281
8282
8283
8284 <span class="grey">Calhoun, et al. Standards Track [Page 148]</span></pre>
8285 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-149" ></span>
8286 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
8287
8288
8289 <span class="h3"><a class="selflink" id="section-15.20" href="#section-15.20">15.20</a>. Result Code</span>
8290
8291 The Result Code field in the Result Code message element (see
8292 <a href="#section-4.6.35">Section 4.6.35</a>) is used to indicate the success or failure of a
8293 CAPWAP Control message. The namespace is 32 bits (0-4294967295),
8294 where the value of zero (0) through 22 are allocated in this
8295 specification, and can be found in <a href="#section-4.6.35">Section 4.6.35</a>. This namespace is
8296 managed by IANA and assignments require an Expert Review. IANA
8297 created the Result Code registry, whose format is:
8298
8299 Result Code Type Value Reference
8300
8301 <span class="h3"><a class="selflink" id="section-15.21" href="#section-15.21">15.21</a>. Returned Message Element Reason</span>
8302
8303 The Reason field in the Returned Message Element message element (see
8304 <a href="#section-4.6.36">Section 4.6.36</a>) is used to indicate the reason why a message element
8305 was not processed successfully. The namespace is 8 bits (0-255),
8306 where the value of zero (0) is reserved and must not be assigned.
8307 The values one (1) through four (4) are allocated in this
8308 specification, and can be found in <a href="#section-4.6.36">Section 4.6.36</a>. This namespace is
8309 managed by IANA and assignments require an Expert Review. IANA
8310 created the Returned Message Element Reason registry, whose format
8311 is:
8312
8313 Returned Message Element Reason Type Value Reference
8314
8315 <span class="h3"><a class="selflink" id="section-15.22" href="#section-15.22">15.22</a>. WTP Board Data Type</span>
8316
8317 The Board Data Type field in the WTP Board Data message element (see
8318 <a href="#section-4.6.40">Section 4.6.40</a>) is used to represent information about the WTP
8319 hardware. The namespace is 16 bits (0-65535). The WTP Board Data
8320 Type values zero (0) through four (4) are allocated in this
8321 specification, and can be found in <a href="#section-4.6.40">Section 4.6.40</a>. This namespace is
8322 managed by IANA and assignments require an Expert Review. IANA
8323 created the WTP Board Data Type registry, whose format is:
8324
8325 WTP Board Data Type Type Value Reference
8326
8327 <span class="h3"><a class="selflink" id="section-15.23" href="#section-15.23">15.23</a>. WTP Descriptor Type</span>
8328
8329 The Descriptor Type field in the WTP Descriptor message element (see
8330 <a href="#section-4.6.41">Section 4.6.41</a>) is used to represent information about the WTP
8331 software. The namespace is 16 bits (0-65535). This field, combined
8332 with the Descriptor Vendor ID, allows vendors to use a private
8333 namespace. This specification defines the WTP Descriptor Type
8334 namespace when the Descriptor Vendor ID is set to zero (0), for which
8335 the values zero (0) through three (3) are allocated in this
8336
8337
8338
8339
8340 <span class="grey">Calhoun, et al. Standards Track [Page 149]</span></pre>
8341 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-150" ></span>
8342 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
8343
8344
8345 specification, and can be found in <a href="#section-4.6.41">Section 4.6.41</a>. This namespace is
8346 managed by IANA and assignments require an Expert Review. IANA
8347 created the WTP Board Data Type registry, whose format is:
8348
8349 WTP Descriptor Type Type Value Reference
8350
8351 <span class="h3"><a class="selflink" id="section-15.24" href="#section-15.24">15.24</a>. WTP Fallback Mode</span>
8352
8353 The Mode field in the WTP Fallback message element (see
8354 <a href="#section-4.6.42">Section 4.6.42</a>) is used to indicate the type of AC fallback mechanism
8355 the WTP should employ. The namespace is 8 bits (0-255), where the
8356 value of zero (0) is reserved and must not be assigned. The values
8357 one (1) and two (2) are allocated in this specification, and can be
8358 found in <a href="#section-4.6.42">Section 4.6.42</a>. This namespace is managed by IANA and
8359 assignments require an Expert Review. IANA created the WTP Fallback
8360 Mode registry, whose format is:
8361
8362 WTP Fallback Mode Type Value Reference
8363
8364 <span class="h3"><a class="selflink" id="section-15.25" href="#section-15.25">15.25</a>. WTP Frame Tunnel Mode</span>
8365
8366 The Tunnel Type field in the WTP Frame Tunnel Mode message element
8367 (see <a href="#section-4.6.43">Section 4.6.43</a>) is 8 bits and is used to indicate the type of
8368 tunneling to use between the WTP and the AC. This specification
8369 defines bits four (4) through six (6), while bits zero (0) through
8370 three (3) as well as bit seven (7) are reserved and unused. These
8371 reserved bits are managed by IANA and assignment requires an Expert
8372 Review. IANA created the WTP Frame Tunnel Mode registry, whose
8373 format is:
8374
8375 WTP Frame Tunnel Mode Bit Position Reference
8376
8377 <span class="h3"><a class="selflink" id="section-15.26" href="#section-15.26">15.26</a>. WTP MAC Type</span>
8378
8379 The MAC Type field in the WTP MAC Type message element (see
8380 <a href="#section-4.6.44">Section 4.6.44</a>) is used to indicate the type of MAC to use in
8381 tunneled frames between the WTP and the AC. The namespace is 8 bits
8382 (0-255), where the value of zero (0) through two (2) are allocated in
8383 this specification, and can be found in <a href="#section-4.6.44">Section 4.6.44</a>. This
8384 namespace is managed by IANA and assignments require an Expert
8385 Review. IANA created the WTP MAC Type registry, whose format is:
8386
8387 WTP MAC Type Type Value Reference
8388
8389
8390
8391
8392
8393
8394
8395
8396 <span class="grey">Calhoun, et al. Standards Track [Page 150]</span></pre>
8397 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-151" ></span>
8398 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
8399
8400
8401 <span class="h3"><a class="selflink" id="section-15.27" href="#section-15.27">15.27</a>. WTP Radio Stats Failure Type</span>
8402
8403 The Last Failure Type field in the WTP Radio Statistics message
8404 element (see <a href="#section-4.6.46">Section 4.6.46</a>) is used to indicate the last WTP
8405 failure. The namespace is 8 bits (0-255), where the value of zero
8406 (0) through three (3) as well as the value 255 are allocated in this
8407 specification, and can be found in <a href="#section-4.6.46">Section 4.6.46</a>. This namespace is
8408 managed by IANA and assignments require an Expert Review. IANA
8409 created the WTP Radio Stats Failure Type registry, whose format is:
8410
8411 WTP Radio Stats Failure Type Type Value Reference
8412
8413 <span class="h3"><a class="selflink" id="section-15.28" href="#section-15.28">15.28</a>. WTP Reboot Stats Failure Type</span>
8414
8415 The Last Failure Type field in the WTP Reboot Statistics message
8416 element (see <a href="#section-4.6.47">Section 4.6.47</a>) is used to indicate the last reboot
8417 reason. The namespace is 8 bits (0-255), where the value of zero (0)
8418 through five (5) as well as the value 255 are allocated in this
8419 specification, and can be found in <a href="#section-4.6.47">Section 4.6.47</a>. This namespace is
8420 managed by IANA and assignments require an Expert Review. IANA
8421 created the WTP Reboot Stats Failure Type registry, whose format is:
8422
8423 WTP Reboot Stats Failure Type Type Value Reference
8424
8425 <span class="h2"><a class="selflink" id="section-16" href="#section-16">16</a>. Acknowledgments</span>
8426
8427 The following individuals are acknowledged for their contributions to
8428 this protocol specification: Puneet Agarwal, Abhijit Choudhury, Pasi
8429 Eronen, Saravanan Govindan, Peter Nilsson, David Perkins, and Yong
8430 Zhang.
8431
8432 Michael Vakulenko contributed text to describe how CAPWAP can be used
8433 over Layer 3 (IP/UDP) networks.
8434
8435 <span class="h2"><a class="selflink" id="section-17" href="#section-17">17</a>. References</span>
8436
8437 <span class="h3"><a class="selflink" id="section-17.1" href="#section-17.1">17.1</a>. Normative References</span>
8438
8439 [<a id="ref-RFC1191">RFC1191</a>] Mogul, J. and S. Deering, "Path MTU discovery",
8440 <a href="./rfc1191">RFC 1191</a>, November 1990.
8441
8442 [<a id="ref-RFC1321">RFC1321</a>] Rivest, R., "The MD5 Message-Digest Algorithm",
8443 <a href="./rfc1321">RFC 1321</a>, April 1992.
8444
8445 [<a id="ref-RFC1305">RFC1305</a>] Mills, D., "Network Time Protocol (Version 3)
8446 Specification, Implementation", <a href="./rfc1305">RFC 1305</a>,
8447 March 1992.
8448
8449
8450
8451
8452 <span class="grey">Calhoun, et al. Standards Track [Page 151]</span></pre>
8453 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-152" ></span>
8454 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
8455
8456
8457 [<a id="ref-RFC1981">RFC1981</a>] McCann, J., Deering, S., and J. Mogul, "Path MTU
8458 Discovery for IP version 6", <a href="./rfc1981">RFC 1981</a>,
8459 August 1996.
8460
8461 [<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to
8462 Indicate Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>,
8463 March 1997.
8464
8465 [<a id="ref-RFC2460">RFC2460</a>] Deering, S. and R. Hinden, "Internet Protocol,
8466 Version 6 (IPv6) Specification", <a href="./rfc2460">RFC 2460</a>,
8467 December 1998.
8468
8469 [<a id="ref-RFC2474">RFC2474</a>] Nichols, K., Blake, S., Baker, F., and D. Black,
8470 "Definition of the Differentiated Services Field
8471 (DS Field) in the IPv4 and IPv6 Headers",
8472 <a href="./rfc2474">RFC 2474</a>, December 1998.
8473
8474 [<a id="ref-RFC2782">RFC2782</a>] Gulbrandsen, A., Vixie, P., and L. Esibov, "A DNS
8475 RR for specifying the location of services (DNS
8476 SRV)", <a href="./rfc2782">RFC 2782</a>, February 2000.
8477
8478 [<a id="ref-RFC3168">RFC3168</a>] Ramakrishnan, K., Floyd, S., and D. Black, "The
8479 Addition of Explicit Congestion Notification (ECN)
8480 to IP", <a href="./rfc3168">RFC 3168</a>, September 2001.
8481
8482 [<a id="ref-RFC3539">RFC3539</a>] Aboba, B. and J. Wood, "Authentication,
8483 Authorization and Accounting (AAA) Transport
8484 Profile", <a href="./rfc3539">RFC 3539</a>, June 2003.
8485
8486 [<a id="ref-RFC3629">RFC3629</a>] Yergeau, F., "UTF-8, a transformation format of
8487 ISO 10646", STD 63, <a href="./rfc3629">RFC 3629</a>, November 2003.
8488
8489 [<a id="ref-RFC3828">RFC3828</a>] Larzon, L-A., Degermark, M., Pink, S., Jonsson,
8490 L-E., and G. Fairhurst, "The Lightweight User
8491 Datagram Protocol (UDP-Lite)", <a href="./rfc3828">RFC 3828</a>,
8492 July 2004.
8493
8494 [<a id="ref-RFC4086">RFC4086</a>] Eastlake, D., Schiller, J., and S. Crocker,
8495 "Randomness Requirements for Security", <a href="https://www.rfc-editor.org/bcp/bcp106">BCP 106</a>,
8496 <a href="./rfc4086">RFC 4086</a>, June 2005.
8497
8498 [<a id="ref-RFC4279">RFC4279</a>] Eronen, P. and H. Tschofenig, "Pre-Shared Key
8499 Ciphersuites for Transport Layer Security (TLS)",
8500 <a href="./rfc4279">RFC 4279</a>, December 2005.
8501
8502 [<a id="ref-RFC5246">RFC5246</a>] Dierks, T. and E. Rescorla, "The Transport Layer
8503 Security (TLS) Protocol Version 1.2", <a href="./rfc5246">RFC 5246</a>,
8504 August 2008.
8505
8506
8507
8508 <span class="grey">Calhoun, et al. Standards Track [Page 152]</span></pre>
8509 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-153" ></span>
8510 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
8511
8512
8513 [<a id="ref-RFC4347">RFC4347</a>] Rescorla, E. and N. Modadugu, "Datagram Transport
8514 Layer Security", <a href="./rfc4347">RFC 4347</a>, April 2006.
8515
8516 [<a id="ref-RFC4821">RFC4821</a>] Mathis, M. and J. Heffner, "Packetization Layer
8517 Path MTU Discovery", <a href="./rfc4821">RFC 4821</a>, March 2007.
8518
8519 [<a id="ref-RFC4963">RFC4963</a>] Heffner, J., Mathis, M., and B. Chandler, "IPv4
8520 Reassembly Errors at High Data Rates", <a href="./rfc4963">RFC 4963</a>,
8521 July 2007.
8522
8523 [<a id="ref-RFC5226">RFC5226</a>] Narten, T. and H. Alvestrand, "Guidelines for
8524 Writing an IANA Considerations Section in RFCs",
8525 <a href="https://www.rfc-editor.org/bcp/bcp26">BCP 26</a>, <a href="./rfc5226">RFC 5226</a>, May 2008.
8526
8527 [<a id="ref-RFC5280">RFC5280</a>] Cooper, D., Santesson, S., Farrell, S., Boeyen,
8528 S., Housley, R., and W. Polk, "Internet X.509
8529 Public Key Infrastructure Certificate and
8530 Certificate Revocation List (CRL) Profile",
8531 <a href="./rfc5280">RFC 5280</a>, May 2008.
8532
8533 [<a id="ref-ISO.9834-1.1993">ISO.9834-1.1993</a>] International Organization for Standardization,
8534 "Procedures for the operation of OSI registration
8535 authorities - part 1: general procedures",
8536 ISO Standard 9834-1, 1993.
8537
8538 [<a id="ref-RFC5416">RFC5416</a>] Calhoun, P., Ed., Montemurro, M., Ed., and D.
8539 Stanley, Ed., "Control And Provisioning of
8540 Wireless Access Points (CAPWAP) Protocol Binding
8541 for IEEE 802.11", <a href="./rfc5416">RFC 5416</a>, March 2009.
8542
8543 [<a id="ref-RFC5417">RFC5417</a>] Calhoun, P., "Control And Provisioning of Wireless
8544 Access Points (CAPWAP) Access Controller DHCP
8545 Option", <a href="./rfc5417">RFC 5417</a>, March 2009.
8546
8547 [<a id="ref-FRAME-EXT">FRAME-EXT</a>] IEEE, "IEEE Standard 802.3as-2006", 2005.
8548
8549 <span class="h3"><a class="selflink" id="section-17.2" href="#section-17.2">17.2</a>. Informative References</span>
8550
8551 [<a id="ref-RFC3232">RFC3232</a>] Reynolds, J., "Assigned Numbers: <a href="./rfc1700">RFC 1700</a> is
8552 Replaced by an On-line Database", <a href="./rfc3232">RFC 3232</a>,
8553 January 2002.
8554
8555 [<a id="ref-RFC3753">RFC3753</a>] Manner, J. and M. Kojo, "Mobility Related
8556 Terminology", <a href="./rfc3753">RFC 3753</a>, June 2004.
8557
8558
8559
8560
8561
8562
8563
8564 <span class="grey">Calhoun, et al. Standards Track [Page 153]</span></pre>
8565 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-154" ></span>
8566 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
8567
8568
8569 [<a id="ref-RFC4564">RFC4564</a>] Govindan, S., Cheng, H., Yao, ZH., Zhou, WH., and
8570 L. Yang, "Objectives for Control and Provisioning
8571 of Wireless Access Points (CAPWAP)", <a href="./rfc4564">RFC 4564</a>,
8572 July 2006.
8573
8574 [<a id="ref-RFC4962">RFC4962</a>] Housley, R. and B. Aboba, "Guidance for
8575 Authentication, Authorization, and Accounting
8576 (AAA) Key Management", <a href="https://www.rfc-editor.org/bcp/bcp132">BCP 132</a>, <a href="./rfc4962">RFC 4962</a>,
8577 July 2007.
8578
8579 [<a id="ref-LWAPP">LWAPP</a>] Calhoun, P., O'Hara, B., Suri, R., Cam Winget, N.,
8580 Kelly, S., Williams, M., and S. Hares,
8581 "Lightweight Access Point Protocol", Work in
8582 Progress, March 2007.
8583
8584 [<a id="ref-SLAPP">SLAPP</a>] Narasimhan, P., Harkins, D., and S. Ponnuswamy,
8585 "SLAPP: Secure Light Access Point Protocol", Work
8586 in Progress, May 2005.
8587
8588 [<a id="ref-DTLS-DESIGN">DTLS-DESIGN</a>] Modadugu, et al., N., "The Design and
8589 Implementation of Datagram TLS", Feb 2004.
8590
8591 [<a id="ref-EUI-48">EUI-48</a>] IEEE, "Guidelines for use of a 48-bit Extended
8592 Unique Identifier", Dec 2005.
8593
8594 [<a id="ref-EUI-64">EUI-64</a>] IEEE, "GUIDELINES FOR 64-BIT GLOBAL IDENTIFIER
8595 (EUI-64) REGISTRATION AUTHORITY".
8596
8597 [<a id="ref-EPCGlobal">EPCGlobal</a>] "See <a href="http://www.epcglobalinc.org/home">http://www.epcglobalinc.org/home</a>".
8598
8599 [<a id="ref-PacketCable">PacketCable</a>] "PacketCable Security Specification PKT-SP-SEC-
8600 I12-050812", August 2005, &lt;PacketCable&gt;.
8601
8602 [<a id="ref-CableLabs">CableLabs</a>] "OpenCable System Security Specification OC-SP-
8603 SEC-I07-061031", October 2006, &lt;CableLabs&gt;.
8604
8605 [<a id="ref-WiMAX">WiMAX</a>] "WiMAX Forum X.509 Device Certificate Profile
8606 Approved Specification V1.0.1", April 2008,
8607 &lt;WiMAX&gt;.
8608
8609 [<a id="ref-RFC5418">RFC5418</a>] Kelly, S. and C. Clancy, "Control And Provisioning
8610 for Wireless Access Points (CAPWAP) Threat
8611 Analysis for IEEE 802.11 Deployments", <a href="./rfc5418">RFC 5418</a>,
8612 March 2009.
8613
8614
8615
8616
8617
8618
8619
8620 <span class="grey">Calhoun, et al. Standards Track [Page 154]</span></pre>
8621 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-155" ></span>
8622 <span class="grey"><a href="./rfc5415">RFC 5415</a> CAPWAP Protocol Specification March 2009</span>
8623
8624
8625 Editors' Addresses
8626
8627 Pat R. Calhoun (editor)
8628 Cisco Systems, Inc.
8629 170 West Tasman Drive
8630 San Jose, CA 95134
8631
8632 Phone: +1 408-902-3240
8633 EMail: [email protected]
8634
8635 Michael P. Montemurro (editor)
8636 Research In Motion
8637 5090 Commerce Blvd
8638 Mississauga, ON L4W 5M4
8639 Canada
8640
8641 Phone: +1 905-629-4746 x4999
8642 EMail: [email protected]
8643
8644
8645 Dorothy Stanley (editor)
8646 Aruba Networks
8647 1322 Crossman Ave
8648 Sunnyvale, CA 94089
8649
8650 Phone: +1 630-363-1389
8651 EMail: [email protected]
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676 Calhoun, et al. Standards Track [Page 155]
8677 </pre>