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