2 # Copyright (C) 2011 The FreeRADIUS Server project and contributors
3 ##############################################################################
5 # This is a WiMAX dictionary for the WiChorus line of products.
6 # It is NOT compatible with the normal WiMAX dictionary.
7 # It CANNOT be used at the same time as the normal WiMAX dictionary.
9 ##############################################################################
13 ##############################################################################
15 VENDOR WiMAX 24757 format=1,1,c
19 ATTRIBUTE WiMAX-Capability 1 tlv
21 BEGIN-TLV WiMAX-Capability
22 ATTRIBUTE WiMAX-Release 1 string
23 ATTRIBUTE WiMAX-Accounting-Capabilities 2 byte
24 ATTRIBUTE WiMAX-Hotlining-Capabilities 3 byte
25 ATTRIBUTE WiMAX-Idle-Mode-Notification-Cap 4 byte
26 ATTRIBUTE WiMAX-Packet-Flow-Descriptor-Capabilities 5 byte
27 # Role of 6/7 swapped vs definition in WMF R015v01
28 ATTRIBUTE WiMAX-ASN-Network-Service-Capabilities 6 integer
29 ATTRIBUTE WiMAX-Authorized-IP-Services 7 integer
31 # This is really a bitmap
32 VALUE WiMAX-Accounting-Capabilities No-Accounting 0
33 VALUE WiMAX-Accounting-Capabilities IP-Session-Based 1
34 VALUE WiMAX-Accounting-Capabilities Flow-Based 2
36 # This is really a bitmap
37 VALUE WiMAX-Hotlining-Capabilities Not-Supported 0
38 VALUE WiMAX-Hotlining-Capabilities Hotline-Profile-Id 1
39 VALUE WiMAX-Hotlining-Capabilities NAS-Filter-Rule 2
40 VALUE WiMAX-Hotlining-Capabilities HTTP-Redirection 4
41 VALUE WiMAX-Hotlining-Capabilities IP-Redirection 8
43 VALUE WiMAX-Idle-Mode-Notification-Cap Not-Supported 0
44 VALUE WiMAX-Idle-Mode-Notification-Cap Supported 1
46 # v2 also implies support for v1
47 VALUE WiMAX-Packet-Flow-Descriptor-Capabilities v1 1
48 VALUE WiMAX-Packet-Flow-Descriptor-Capabilities v2 2
50 # This is really a bitmap.
51 # For Wichorus gateway this is used to
52 # indicate functionality supported by the ASN-GW. In WMF R015V01
53 # this is sub-tlv 7 with the same functionality. Sub-tlv 6 is a
54 # similar and used to indicate services the ASN is authorized to
55 # support for the subscriber (see sub-tlv 7 for Wichorus' version)
56 # Wichorus' implementation is also shifted left one bit...
57 VALUE WiMAX-ASN-Network-Service-Capabilities DHCPv4-Relay 2
58 VALUE WiMAX-ASN-Network-Service-Capabilities DHCPv6-Relay 4
59 VALUE WiMAX-ASN-Network-Service-Capabilities DHCPv4-Proxy 8
60 VALUE WiMAX-ASN-Network-Service-Capabilities DHCPv6-Proxy 16
61 VALUE WiMAX-ASN-Network-Service-Capabilities FA 32
62 VALUE WiMAX-ASN-Network-Service-Capabilities PMIP-Client 64
63 # ... plus additional, but these are the only relevant ones for now
65 # This is really a bitmap
66 # Proprietary definition of supported services. Used by the AAA to
67 # indicate which services the ASN is allowed to support for the MS
68 VALUE WiMAX-Authorized-IP-Services CMIPv4 1
69 VALUE WiMAX-Authorized-IP-Services PMIPv4 2
70 VALUE WiMAX-Authorized-IP-Services SimpleIPv4 4
72 END-TLV WiMAX-Capability
74 ATTRIBUTE WiMAX-Device-Authentication-Indicator 2 byte
75 ATTRIBUTE WiMAX-GMT-Timezone-offset 3 signed
76 ATTRIBUTE WiMAX-AAA-Session-Id 4 octets
79 ATTRIBUTE WiMAX-MSK 5 octets encrypt=2
80 ATTRIBUTE WiMAX-hHA-IP-MIP4 6 ipaddr
81 ATTRIBUTE WiMAX-hHA-IP-MIP6 7 ipv6addr
82 ATTRIBUTE WiMAX-DHCPv4-Server 8 combo-ip
83 ATTRIBUTE WiMAX-DHCPv6-Server 9 combo-ip
85 # MN-HA-CMIP4 = H(MIP-RK, "CMIP4 MN HA" | HA-IPv4 | MN-NAI), or
86 # MN-HA-PMIP4 = H(MIP-RK, "PMIP4 MN HA" | HA-IPv4 | MN-NAI)
87 ATTRIBUTE WiMAX-MN-hHA-MIP4-Key 10 octets encrypt=2
89 # MN-HA-CMIP4-SPI == MIP-SPI, or
90 # MN-HA-PIMP4-SPI == MIP-SPI + 1
91 ATTRIBUTE WiMAX-MN-hHA-MIP4-SPI 11 integer
93 # MN-HA-CMIP6 = H(MIP-RK, "CMIP6 MN HA" | HA-IPv6 | MN-NAI)
94 ATTRIBUTE WiMAX-MN-hHA-MIP6-Key 12 octets encrypt=2
96 # MN-HA-CMIP6-SPI == MIP-SPI + 2
97 ATTRIBUTE WiMAX-MN-hHA-MIP6-SPI 13 integer
99 # FA-RK = H(MIP-RK, "FA-RK")
100 ATTRIBUTE WiMAX-FA-RK-Key 14 octets encrypt=2
102 # 160 bit random number
103 ATTRIBUTE WiMAX-HA-RK-Key 15 octets encrypt=2
105 ATTRIBUTE WiMAX-HA-RK-SPI 16 integer
107 ATTRIBUTE WiMAX-HA-RK-Lifetime 17 integer
109 # Calculation is the same as MN-HA-CMIP4, etc.
110 # With CMIP the MN may not know the appropriate HA IP address when calculating
111 # the MIP RRQ AE (IPv4) or during a BU (IPv6). In this case it must either use an
112 # old known HA IP address or can indicate whether dynamic HA assignment from the
113 # hCSN is preferred to the vCSN, or if there is no preference by providing
114 # ALL-ZERO-ONE-ADDR (255.255.255.255/0.0.0.0 respectively) in the MIP RRQ sent
115 # to the FA. The RRQ-MN-HA key is calculated using this RRQ-HA-IP address and is
116 # required by the HA to validate the MIP RRQ received from the MS as it does
117 # not contain the actual HA IP address.
118 ATTRIBUTE WiMAX-RRQ-HA-IP 18 combo-ip
119 ATTRIBUTE WiMAX-RRQ-MN-HA-Key 19 octets encrypt=2
121 ATTRIBUTE WiMAX-Time-Of-Day-Time 20 tlv
123 BEGIN-TLV WiMAX-Time-Of-Day-Time
124 ATTRIBUTE WiMAX-Hour 1 byte
125 ATTRIBUTE WiMAX-Minute 2 byte
126 ATTRIBUTE WiMAX-UTC-Offset 3 integer
127 END-TLV WiMAX-Time-Of-Day-Time
129 ATTRIBUTE WiMAX-Session-Continue 21 integer
131 VALUE WiMAX-Session-Continue False 0
132 VALUE WiMAX-Session-Continue True 1
134 ATTRIBUTE WiMAX-Beginning-Of-Session 22 integer
136 VALUE WiMAX-Beginning-Of-Session False 0
137 VALUE WiMAX-Beginning-Of-Session True 1
139 # This is pulled from WMF R015v01 - because our ASN-GW supports Simple IP and a
140 # simple way to denote this was needed without building in a lot of private
141 # logic that would one day simply be replaced by this logic anyway.
142 # Note: Attribute renamed in Release 1.5 to Network-Technology. Maintain the
143 # old name here to allow for better backwards compatibility.
144 ATTRIBUTE WiMAX-IP-Technology 23 integer
146 VALUE WiMAX-IP-Technology Simple-IPv4 0
147 VALUE WiMAX-IP-Technology Simple-IPv6 1
148 VALUE WiMAX-IP-Technology PMIP4 2
149 VALUE WiMAX-IP-Technology CMIP4 3
150 VALUE WiMAX-IP-Technology CMIP6 4
151 VALUE WiMAX-IP-Technology Ethernet-CS 5
152 VALUE WiMAX-IP-Technology Simple-ETH 6
153 VALUE WiMAX-IP-Technology MIP-Based-ETH 7
154 VALUE WiMAX-IP-Technology PMIP6 8
156 ATTRIBUTE WiMAX-Hotline-Indicator 24 string
157 ATTRIBUTE WiMAX-Prepaid-Indicator 25 byte
158 ATTRIBUTE WiMAX-PDFID 26 short
159 ATTRIBUTE WiMAX-SDFID 27 short
160 ATTRIBUTE WiMAX-Packet-Flow-Descriptor 28 tlv
162 BEGIN-TLV WiMAX-Packet-Flow-Descriptor
163 ATTRIBUTE WiMAX-Packet-Data-Flow-Id 1 short
164 ATTRIBUTE WiMAX-Service-Data-Flow-Id 2 short
165 ATTRIBUTE WiMAX-Service-Profile-Id 3 integer
166 ATTRIBUTE WiMAX-Direction 4 byte
168 VALUE WiMAX-Direction Reserved-0 0
169 VALUE WiMAX-Direction Uplink 1
170 VALUE WiMAX-Direction Downlink 2
171 VALUE WiMAX-Direction Bi-Directional 3
173 ATTRIBUTE WiMAX-Activation-Trigger 5 byte
175 # This is really a bitmap
176 VALUE WiMAX-Activation-Trigger Reserved-0 0
177 VALUE WiMAX-Activation-Trigger Provisioned 1
178 VALUE WiMAX-Activation-Trigger Admit 2
179 VALUE WiMAX-Activation-Trigger Activate 4
180 VALUE WiMAX-Activation-Trigger Dynamically-Changeable 8
182 ATTRIBUTE WiMAX-Transport-Type 6 byte
184 VALUE WiMAX-Transport-Type Reserved-0 0
185 VALUE WiMAX-Transport-Type IPv4-CS 1
186 VALUE WiMAX-Transport-Type IPv6-CS 2
187 VALUE WiMAX-Transport-Type Ethernet 3
189 ATTRIBUTE WiMAX-Uplink-QOS-Id 7 byte
190 ATTRIBUTE WiMAX-Downlink-QOS-Id 8 byte
191 ATTRIBUTE WiMAX-Uplink-Classifier 9 string
192 ATTRIBUTE WiMAX-Downlink-Classifier 10 string
193 #ATTRIBUTE WiMAX-Paging-Preference 11 byte # Single bit, value => refer to 802.16e section 11.13.30
194 END-TLV WiMAX-Packet-Flow-Descriptor
196 ATTRIBUTE WiMAX-QoS-Descriptor 29 tlv
198 BEGIN-TLV WiMAX-QoS-Descriptor
199 ATTRIBUTE WiMAX-QoS-Id 1 byte
200 ATTRIBUTE WiMAX-Global-Service-Class-Name 2 string # 6 octets
201 ATTRIBUTE WiMAX-Service-Class-Name 3 string
202 ATTRIBUTE WiMAX-Schedule-Type 4 byte
203 ATTRIBUTE WiMAX-Traffic-Priority 5 byte
204 ATTRIBUTE WiMAX-Maximum-Sustained-Traffic-Rate 6 integer
205 ATTRIBUTE WiMAX-Minimum-Reserved-Traffic-Rate 7 integer
206 ATTRIBUTE WiMAX-Maximum-Traffic-Burst 8 integer
207 ATTRIBUTE WiMAX-Tolerated-Jitter 9 integer
208 ATTRIBUTE WiMAX-Maximum-Latency 10 integer
209 ATTRIBUTE WiMAX-Reduced-Resources-Code 11 byte
210 ATTRIBUTE WiMAX-Media-Flow-Type 12 byte
211 ATTRIBUTE WiMAX-Unsolicited-Grant-Interval 13 short
212 ATTRIBUTE WiMAX-SDU-Size 14 short
213 ATTRIBUTE WiMAX-Unsolicited-Polling-Interval 15 short
214 ATTRIBUTE WiMAX-Media-Flow-Description-SDP 16 string
216 VALUE WiMAX-Schedule-Type Best-Effort 2
217 VALUE WiMAX-Schedule-Type nrtPS 3
218 VALUE WiMAX-Schedule-Type rtPS 4
219 VALUE WiMAX-Schedule-Type Extended-rtPS 5
220 VALUE WiMAX-Schedule-Type UGS 6
222 VALUE WiMAX-Media-Flow-Type VoIP 1
223 VALUE WiMAX-Media-Flow-Type Robust-Browser 2
224 VALUE WiMAX-Media-Flow-Type Secure-Browser-VPN 3
225 VALUE WiMAX-Media-Flow-Type Streaming-Video 4
226 VALUE WiMAX-Media-Flow-Type Streaming-Live-TV 5
227 VALUE WiMAX-Media-Flow-Type Music-Photo-Download 6
228 VALUE WiMAX-Media-Flow-Type Multi-Player-Gaming 7
229 VALUE WiMAX-Media-Flow-Type Location-Based-Services 8
230 VALUE WiMAX-Media-Flow-Type Text-Audio-Books 9
231 VALUE WiMAX-Media-Flow-Type Video-Conversation 10
232 VALUE WiMAX-Media-Flow-Type Message 11
233 VALUE WiMAX-Media-Flow-Type Control 12
234 VALUE WiMAX-Media-Flow-Type Data 13
236 END-TLV WiMAX-QoS-Descriptor
238 # Same as QoS-Descriptor... used only in interim and stop records for
239 # flow based accounting.
240 ATTRIBUTE WiMAX-Uplink-Granted-QoS 30 tlv # UPDATED - WAS STRING...
241 ATTRIBUTE WiMAX-Control-Packets-In 31 integer
242 ATTRIBUTE WiMAX-Control-Octets-In 32 integer
243 ATTRIBUTE WiMAX-Control-Packets-Out 33 integer
244 ATTRIBUTE WiMAX-Control-Octets-Out 34 integer
245 ATTRIBUTE WiMAX-PPAC 35 tlv
248 ATTRIBUTE WiMAX-Available-In-Client 1 integer
251 VALUE WiMAX-Available-In-Client Volume-Metering 1
252 VALUE WiMAX-Available-In-Client Duration-Metering 2
253 VALUE WiMAX-Available-In-Client Resource-Metering 4
254 VALUE WiMAX-Available-In-Client Pools 8
255 VALUE WiMAX-Available-In-Client Rating-Groups 0x10
256 VALUE WiMAX-Available-In-Client Multi-Services 0x20
257 VALUE WiMAX-Available-In-Client Tariff-Switch 0x40
260 ATTRIBUTE WiMAX-Session-Termination-Capability 36 integer
263 VALUE WiMAX-Session-Termination-Capability Dynamic-Authorization 1
265 ATTRIBUTE WiMAX-PPAQ 37 tlv
268 ATTRIBUTE WiMAX-PPAQ-Quota-Identifier 1 octets
269 ATTRIBUTE WiMAX-Volume-Quota 2 integer #kb
270 ATTRIBUTE WiMAX-Volume-Threshold 3 integer #kb
271 ATTRIBUTE WiMAX-Duration-Quota 4 integer #s
272 ATTRIBUTE WiMAX-Duration-Threshold 5 integer #s
273 ATTRIBUTE WiMAX-Resource-Quota 6 integer
274 ATTRIBUTE WiMAX-Resource-Threshold 7 integer
275 ATTRIBUTE WiMAX-Update-Reason 8 integer
276 ATTRIBUTE WiMAX-Prepaid-Server 9 combo-ip
277 ATTRIBUTE WiMAX-Service-Id 10 string
278 ATTRIBUTE WiMAX-Rating-Group-Id 11 integer
279 ATTRIBUTE WiMAX-Termination-Action 12 byte
280 ATTRIBUTE WiMAX-Pool-Id 13 integer
281 ATTRIBUTE WiMAX-Pool-Multiplier 14 integer
282 ATTRIBUTE WiMAX-Requested-Action 15 byte
283 ATTRIBUTE WiMAX-Check-Balance-Result 16 byte
286 # 4 octets - integer representing 1/10's of lowest currency (e.g. cents)
287 # 4 octets - currency code as in ISO-4217
288 # 1+ - UTF8 string containing text like "cost is $1 per minute"
290 ATTRIBUTE WiMAX-Cost-Information-AVP 17 octets
292 VALUE WiMAX-Update-Reason Pre-Initialization 1
293 VALUE WiMAX-Update-Reason Initial-Request 2
294 VALUE WiMAX-Update-Reason Threshold-Reached 3
295 VALUE WiMAX-Update-Reason Quota-Reached 4
296 VALUE WiMAX-Update-Reason TITSU-Approaching 5
297 VALUE WiMAX-Update-Reason Remote-Forced-Disconnect 6
298 VALUE WiMAX-Update-Reason Client-Service-Termination 7
299 VALUE WiMAX-Update-Reason Access-Service-Terminated 8
300 VALUE WiMAX-Update-Reason Service-Not-Established 9
301 VALUE WiMAX-Update-Reason One-Time-Charging 10
303 VALUE WiMAX-Termination-Action Terminate 1
304 VALUE WiMAX-Termination-Action Request-More-Quota 2
305 VALUE WiMAX-Termination-Action Redirect-Or-Filter 3
307 VALUE WiMAX-Requested-Action Balance-Check 1
308 VALUE WiMAX-Requested-Action Price-Enquiry 2
312 ATTRIBUTE WiMAX-Prepaid-Tariff-Switching 38 tlv
314 BEGIN-TLV WiMAX-Prepaid-Tariff-Switching
315 ATTRIBUTE WiMAX-Prepaid-Quota-Identifier 1 string
316 ATTRIBUTE WiMAX-Volume-Used-After 2 integer #1k
317 ATTRIBUTE WiMAX-Tariff-Switch-Interval 3 integer #s
318 ATTRIBUTE WiMAX-Time-Interval-After 4 integer #s
319 END-TLV WiMAX-Prepaid-Tariff-Switching
321 ATTRIBUTE WiMAX-Active-Time-Duration 39 integer
322 ATTRIBUTE WiMAX-DHCP-RK 40 octets encrypt=2
323 ATTRIBUTE WiMAX-DHCP-RK-Key-Id 41 integer
324 ATTRIBUTE WiMAX-DHCP-RK-Lifetime 42 integer
325 ATTRIBUTE WiMAX-DHCP-Msg-Server-IP 43 ipaddr
326 ATTRIBUTE WiMAX-Idle-Mode-Transition 44 byte
327 ATTRIBUTE WiMAX-NAP-Id 45 octets
330 # 3 octets of base-station Id
331 ATTRIBUTE WiMAX-BS-Id 46 octets
332 ATTRIBUTE WiMAX-Location 47 octets
334 # Number of times Acct-Input-Packets rolled over 2^32.
335 ATTRIBUTE WiMAX-Acct-Input-Packets-Gigaword 48 integer
336 ATTRIBUTE WiMAX-Acct-Output-Packets-Gigaword 49 integer
338 # Formatted as per IP Filter rule specification.
339 ATTRIBUTE WiMAX-Uplink-Flow-Description 50 string
341 ATTRIBUTE WiMAX-BU-CoA-IPv6 51 ipv6addr # Updated
342 ATTRIBUTE WiMAX-DNS-Server 52 combo-ip
343 ATTRIBUTE WiMAX-Hotline-Profile-Id 53 string
345 # Formatted as per IP Filter rule specification.
346 ATTRIBUTE WiMAX-HTTP-Redirection-Rule 54 string
348 # Formatted as per IP Filter rule specification.
349 ATTRIBUTE WiMAX-IP-Redirection-Rule 55 string
350 ATTRIBUTE WiMAX-Hotline-Session-Timer 56 integer
353 ATTRIBUTE WiMAX-NSP-Id 57 octets
355 # WiMAX-HA-RK-Requested has been removed from WMF Release 1.3 and later.
356 # However the attribute has not been replaced so this is left to preserve
357 # backward compatibility. This attribute is deprecated and will be removed.
358 ATTRIBUTE WiMAX-HA-RK-Key-Requested 58 integer
360 VALUE WiMAX-HA-RK-Key-Requested No 0
361 VALUE WiMAX-HA-RK-Key-Requested Yes 1
363 ATTRIBUTE WiMAX-Count-Type 59 byte
364 ATTRIBUTE WiMAX-DM-Action-Code 60 integer
366 VALUE WiMAX-DM-Action-Code Deregister-MS 0
367 VALUE WiMAX-DM-Action-Code Suspend-MS-Traffic 1
368 VALUE WiMAX-DM-Action-Code Suspend-User-Traffic 2
369 VALUE WiMAX-DM-Action-Code Resume-Traffic 3
370 VALUE WiMAX-DM-Action-Code MS-Terminate 4
371 VALUE WiMAX-DM-Action-Code MS-Idle 5
372 VALUE WiMAX-DM-Action-Code MS-Completed-IPv6-Handover 6
373 VALUE WiMAX-DM-Action-Code BS-Sends-RES-Cmd 0xffff
375 # FA-RK-SPI = SPI-CMIP4 = MIP-SPI
376 ATTRIBUTE WiMAX-FA-RK-SPI 61 integer
378 # Formatted as per IP Filter rule specification.
379 ATTRIBUTE WiMAX-Downlink-Flow-Description 62 string
381 # Same as QoS-Descriptor... used only in flow based accounting.
382 ATTRIBUTE WiMAX-Downlink-Granted-QoS 63 tlv
384 # More MIP keys, calculated as above... but in different packets.
385 # In a roaming scenario both the vAAA and the hAAA can provide a HA
386 # and related key context, as well as DHCP server information to the ASN-GW.
387 # These attributes are used by the vCSN.
388 ATTRIBUTE WiMAX-vHA-IP-MIP4 64 ipaddr
389 ATTRIBUTE WiMAX-vHA-IP-MIP6 65 ipv6addr
390 ATTRIBUTE WiMAX-vHA-MIP4-Key 66 octets encrypt=2
391 ATTRIBUTE WiMAX-vHA-RK-Key 67 octets encrypt=2
392 ATTRIBUTE WiMAX-vHA-RK-SPI 68 integer
393 ATTRIBUTE WiMAX-vHA-RK-Lifetime 69 integer
395 ATTRIBUTE WiMAX-MN-vHA-MIP6-Key 70 octets encrypt=2
396 ATTRIBUTE WiMAX-MN-vHA-MIP4-SPI 71 integer
397 ATTRIBUTE WiMAX-MN-vHA-MIP6-SPI 72 integer
399 ATTRIBUTE WiMAX-vDHCPv4-Server 73 ipaddr
400 ATTRIBUTE WiMAX-vDHCPv6-Server 74 ipv6addr
401 ATTRIBUTE WiMAX-vDHCP-RK 75 octets encrypt=2
402 ATTRIBUTE WiMAX-vDHCP-RK-Key-ID 76 integer
403 ATTRIBUTE WiMAX-vDHCP-RK-Lifetime 77 integer
407 # About 10 more attributes in 1.3