share/dictionary.wimax

   1 # -*- text -*-
   2 # Copyright (C) 2011 The FreeRADIUS Server project and contributors
   3 ##############################################################################
   4 #
   5 #       WiMAX Forum
   6 #
   7 #       Updated from NWG_R1_V1.2.1-Stage-3.pdf
   8 #
   9 #       NWG_R1_V1.2-Stage-3.pdf
  10 #       RADIUS discussion is on pp. 432-498
  11 #       WiMAX VSA's are on p. 450 and following.
  12 #
  13 #       DHCP && MIP keys are on p.48 and following.
  14 #
  15 #       WiMAX VSA's have a non-standard format:
  16 #
  17 #               type            1 octet
  18 #               length          1 octet
  19 #               continuation    1 octet      0bcrrrrrrr
  20 #               value           1+ octets
  21 #
  22 #       If the high bit of the "continuation" field is set, then
  23 #       the next attribute of the same WiMAX type should have it's
  24 #       value concatenated to this one.
  25 #
  26 #       The C bit MUST be zero for all small types.  e.g.  integer,
  27 #       ipaddr, ipv6addr, etc.  It MAY be set for "string" and "octet"
  28 #       types.  The maximum attribute length for "string" and "octet"
  29 #       types is still 253 bytes, even with continuations.  The WiMAX
  30 #       specifications do not specify a maximum length, so we have chosen
  31 #       to keep the traditional RADIUS maximum length here.
  32 #
  33 #       The C bit MAY be 1 for TLV types.  There is no restriction on
  34 #       TLV length other than maximum packet size (a bit less than 4K).
  35 #
  36 #       The rest of the bits in the "continuation" octet are reserved,
  37 #       and MUST be zero.
  38 #
  39 #       Each WiMAX VSA is packed into one Vendor-Specific attribute
  40 #       with Vendor-Id of WiMAX.  Multiple WiMAX sub-TLV's ARE packed
  41 #       into one VSA with an encapsulating TLV.
  42 #
  43 #       The WiMAX forum adds the following (non-standard) data types:
  44 #
  45 #       byte     - one-octet unsigned integer
  46 #       short    - two-octet unsigned integer in network byte order
  47 #       signed   - 4-octet signed integer in network byte order.
  48 #       combo-ip - if length 4, is the same as the "ipaddr" type.
  49 #                  if length 16, is the same as "ipv6addr" type.
  50 #       tlv      - encapsulated sub-attributes
  51 #                  i.e. Vendor-Specific -> WiMAX TLV -> WiMAX sub-tlv.
  52 #
  53 ##############################################################################
  54 #
  55 #       $Id$
  56 #
  57 ##############################################################################
  58
  59 VENDOR          WiMAX                           24757   format=1,1,c
  60
  61 BEGIN-VENDOR    WiMAX
  62
  63 ATTRIBUTE       WiMAX-Capability                        1       tlv
  64
  65 BEGIN-TLV       WiMAX-Capability
  66 ATTRIBUTE       WiMAX-Release                           1       string
  67 ATTRIBUTE       WiMAX-Accounting-Capabilities           2       byte
  68 ATTRIBUTE       WiMAX-Hotlining-Capabilities            3       byte
  69 ATTRIBUTE       WiMAX-Idle-Mode-Notification-Cap        4       byte
  70
  71 # This is really a bitmap
  72 VALUE   WiMAX-Accounting-Capabilities   No-Accounting           0
  73 VALUE   WiMAX-Accounting-Capabilities   IP-Session-Based        1
  74 VALUE   WiMAX-Accounting-Capabilities   Flow-Based              2
  75
  76 # This is really a bitmap
  77 VALUE   WiMAX-Hotlining-Capabilities    Not-Supported           0
  78 VALUE   WiMAX-Hotlining-Capabilities    Hotline-Profile-Id      1
  79 VALUE   WiMAX-Hotlining-Capabilities    NAS-Filter-Rule         2
  80 VALUE   WiMAX-Hotlining-Capabilities    HTTP-Redirection        4
  81 VALUE   WiMAX-Hotlining-Capabilities    IP-Redirection          8
  82
  83 VALUE   WiMAX-Idle-Mode-Notification-Cap Not-Supported          0
  84 VALUE   WiMAX-Idle-Mode-Notification-Cap Supported              1
  85
  86 END-TLV         WiMAX-Capability
  87
  88 ATTRIBUTE       WiMAX-Device-Authentication-Indicator   2       byte
  89 ATTRIBUTE       WiMAX-GMT-Timezone-offset               3       signed
  90 ATTRIBUTE       WiMAX-AAA-Session-Id                    4       octets
  91
  92 # 32 octets in length
  93 ATTRIBUTE       WiMAX-MSK                               5       octets encrypt=2
  94 ATTRIBUTE       WiMAX-hHA-IP-MIP4                       6       ipaddr
  95 ATTRIBUTE       WiMAX-hHA-IP-MIP6                       7       ipv6addr
  96 ATTRIBUTE       WiMAX-DHCPv4-Server                     8       combo-ip
  97 ATTRIBUTE       WiMAX-DHCPv6-Server                     9       combo-ip
  98
  99 # MN-HA-CMIP4 = H(MIP-RK, "CMIP4 MN HA" | HA-IPv4 | MN-NAI), or
 100 # MN-HA-PMIP4 = H(MIP-RK, "PMIP4 MN HA" | HA-IPv4 | MN-NAI)
 101 ATTRIBUTE       WiMAX-MN-hHA-MIP4-Key                   10      octets encrypt=2
 102
 103 # MN-HA-CMIP4-SPI == MIP-SPI, or
 104 # MN-HA-PIMP4-SPI == MIP-SPI + 1
 105 ATTRIBUTE       WiMAX-MN-hHA-MIP4-SPI                   11      integer
 106
 107 # MN-HA-CMIP6 = H(MIP-RK, "CMIP6 MN HA" | HA-IPv6 | MN-NAI)
 108 ATTRIBUTE       WiMAX-MN-hHA-MIP6-Key                   12      octets encrypt=2
 109
 110 # MN-HA-CMIP6-SPI == MIP-SPI + 2
 111 ATTRIBUTE       WiMAX-MN-hHA-MIP6-SPI                   13      integer
 112
 113 # FA-RK = H(MIP-RK, "FA-RK")
 114 ATTRIBUTE       WiMAX-FA-RK-Key                         14      octets encrypt=2
 115
 116 # 160 bit random number
 117 ATTRIBUTE       WiMAX-HA-RK-Key                         15      octets encrypt=2
 118 # SPI-CMIP4
 119 ATTRIBUTE       WiMAX-HA-RK-SPI                         16      integer
 120
 121 ATTRIBUTE       WiMAX-HA-RK-Lifetime                    17      integer
 122
 123 #  The same as MN-HA-CMIP4, etc.  But in different packets.
 124 ATTRIBUTE       WiMAX-RRQ-HA-IP                         18      combo-ip
 125 ATTRIBUTE       WiMAX-RRQ-MN-HA-Key                     19      octets encrypt=2
 126 ATTRIBUTE       WiMAX-RRQ-MN-HA-SPI                     20      integer
 127
 128 ATTRIBUTE       WiMAX-Session-Continue                  21      integer
 129 ATTRIBUTE       WiMAX-Beginning-Of-Session              22      integer
 130 ATTRIBUTE       WiMAX-IP-Technology                     23      integer
 131
 132 VALUE   WiMAX-IP-Technology             Reserved-0              0
 133 VALUE   WiMAX-IP-Technology             Reserved-1              1
 134 VALUE   WiMAX-IP-Technology             PMIP4                   2
 135 VALUE   WiMAX-IP-Technology             CMIP4                   3
 136 VALUE   WiMAX-IP-Technology             CMIP6                   4
 137 VALUE   WiMAX-IP-Technology             Ethernet-CS             5
 138
 139 ATTRIBUTE       WiMAX-Hotline-Indicator                 24      string
 140 ATTRIBUTE       WiMAX-Prepaid-Indicator                 25      byte
 141 ATTRIBUTE       WiMAX-PDFID                             26      short
 142 ATTRIBUTE       WiMAX-SDFID                             27      short
 143 ATTRIBUTE       WiMAX-Packet-Flow-Descriptor            28      tlv
 144
 145 BEGIN-TLV WiMAX-Packet-Flow-Descriptor
 146 ATTRIBUTE       WiMAX-Packet-Data-Flow-Id               1       short
 147 ATTRIBUTE       WiMAX-Service-Data-Flow-Id              2       short
 148 ATTRIBUTE       WiMAX-Service-Profile-Id                3       integer
 149 ATTRIBUTE       WiMAX-Direction                         4       byte
 150
 151 VALUE   WiMAX-Direction                 Reserved-0              0
 152 VALUE   WiMAX-Direction                 Uplink                  1
 153 VALUE   WiMAX-Direction                 Downlink                2
 154 VALUE   WiMAX-Direction                 Bi-Directional          3
 155
 156 ATTRIBUTE       WiMAX-Activation-Trigger                5       byte    # bitmap
 157 ATTRIBUTE       WiMAX-Transport-Type                    6       byte
 158
 159 VALUE   WiMAX-Transport-Type            Reserved-0              0
 160 VALUE   WiMAX-Transport-Type            IPv4-CS                 1
 161 VALUE   WiMAX-Transport-Type            IPv6-CS                 2
 162 VALUE   WiMAX-Transport-Type            Ethernet                3
 163
 164 ATTRIBUTE       WiMAX-Uplink-QOS-Id                     7       byte
 165 ATTRIBUTE       WiMAX-Downlink-QOS-Id                   8       byte
 166 ATTRIBUTE       WiMAX-Uplink-Classifier                 9       string
 167 ATTRIBUTE       WiMAX-Downlink-Classifier               10      string
 168 END-TLV WiMAX-Packet-Flow-Descriptor
 169
 170 ATTRIBUTE       WiMAX-QoS-Descriptor                    29      tlv
 171
 172 BEGIN-TLV WiMAX-QoS-Descriptor
 173 ATTRIBUTE       WiMAX-QoS-Id                            1       byte
 174 ATTRIBUTE       WiMAX-Global-Service-Class-Name         2       string # 6 octets
 175 ATTRIBUTE       WiMAX-Service-Class-Name                3       string
 176 ATTRIBUTE       WiMAX-Schedule-Type                     4       byte
 177 ATTRIBUTE       WiMAX-Traffic-Priority                  5       byte
 178 ATTRIBUTE       WiMAX-Maximum-Sustained-Traffic-Rate    6       integer
 179 ATTRIBUTE       WiMAX-Minimum-Reserved-Traffic-Rate     7       integer
 180 ATTRIBUTE       WiMAX-Maximum-Traffic-Burst             8       integer
 181 ATTRIBUTE       WiMAX-Tolerated-Jitter                  9       integer
 182 ATTRIBUTE       WiMAX-Maximum-Latency                   10      integer
 183 ATTRIBUTE       WiMAX-Reduced-Resources-Code            11      byte
 184 ATTRIBUTE       WiMAX-Media-Flow-Type                   12      byte
 185 ATTRIBUTE       WiMAX-Unsolicited-Grant-Interval        13      short
 186 ATTRIBUTE       WiMAX-SDU-Size                          14      short
 187 ATTRIBUTE       WiMAX-Unsolicited-Polling-Interval      15      short
 188 ATTRIBUTE       WiMAX-Media-Flow-Description-SDP        16      string
 189
 190 VALUE   WiMAX-Schedule-Type             Best-Effort             2
 191 VALUE   WiMAX-Schedule-Type             nrtPS                   3
 192 VALUE   WiMAX-Schedule-Type             rtPS                    4
 193 VALUE   WiMAX-Schedule-Type             Extended-rtPS           5
 194 VALUE   WiMAX-Schedule-Type             UGS                     6
 195
 196 VALUE   WiMAX-Media-Flow-Type           VoIP                    1
 197 VALUE   WiMAX-Media-Flow-Type           Robust-Browser          2
 198 VALUE   WiMAX-Media-Flow-Type           Secure-Browser-VPN      3
 199 VALUE   WiMAX-Media-Flow-Type           Streaming-Video         4
 200 VALUE   WiMAX-Media-Flow-Type           Streaming-Live-TV       5
 201 VALUE   WiMAX-Media-Flow-Type           Music-Photo-Download    6
 202 VALUE   WiMAX-Media-Flow-Type           Multi-Player-Gaming     7
 203 VALUE   WiMAX-Media-Flow-Type           Location-Based-Services 8
 204 VALUE   WiMAX-Media-Flow-Type           Text-Audio-Books        9
 205 VALUE   WiMAX-Media-Flow-Type           Video-Conversation      10
 206 VALUE   WiMAX-Media-Flow-Type           Message                 11
 207 VALUE   WiMAX-Media-Flow-Type           Control                 12
 208 VALUE   WiMAX-Media-Flow-Type           Data                    13
 209
 210 END-TLV WiMAX-QoS-Descriptor
 211
 212 ATTRIBUTE       WiMAX-Uplink-Granted-QoS                30      string
 213 ATTRIBUTE       WiMAX-Control-Packets-In                31      integer
 214 ATTRIBUTE       WiMAX-Control-Octets-In                 32      integer
 215 ATTRIBUTE       WiMAX-Control-Packets-Out               33      integer
 216 ATTRIBUTE       WiMAX-Control-Octets-Out                34      integer
 217 ATTRIBUTE       WiMAX-PPAC                              35      tlv
 218
 219 BEGIN-TLV WiMAX-PPAC
 220 ATTRIBUTE       WiMAX-Available-In-Client               1       integer
 221
 222 # Really a bitmap
 223 VALUE   WiMAX-Available-In-Client       Volume-Metering         1
 224 VALUE   WiMAX-Available-In-Client       Duration-Metering       2
 225 VALUE   WiMAX-Available-In-Client       Resource-Metering       4
 226 VALUE   WiMAX-Available-In-Client       Pools                   8
 227 VALUE   WiMAX-Available-In-Client       Rating-Groups           0x10
 228 VALUE   WiMAX-Available-In-Client       Multi-Services          0x20
 229 VALUE   WiMAX-Available-In-Client       Tariff-Switch           0x40
 230 END-TLV WiMAX-PPAC
 231
 232 ATTRIBUTE       WiMAX-Session-Termination-Capability    36      integer
 233
 234 # Really a bitmap
 235 VALUE   WiMAX-Session-Termination-Capability Dynamic-Authorization 1
 236
 237 ATTRIBUTE       WiMAX-PPAQ                              37      tlv
 238
 239 BEGIN-TLV       WiMAX-PPAQ
 240 ATTRIBUTE       WiMAX-PPAQ-Quota-Identifier             1       octets
 241 ATTRIBUTE       WiMAX-Volume-Quota                      2       integer #kb
 242 ATTRIBUTE       WiMAX-Volume-Threshold                  3       integer #kb
 243 ATTRIBUTE       WiMAX-Duration-Quota                    4       integer #s
 244 ATTRIBUTE       WiMAX-Duration-Threshold                5       integer #s
 245 ATTRIBUTE       WiMAX-Resource-Quota                    6       integer
 246 ATTRIBUTE       WiMAX-Resource-Threshold                7       integer
 247 ATTRIBUTE       WiMAX-Update-Reason                     8       integer
 248 ATTRIBUTE       WiMAX-Prepaid-Server                    9       combo-ip
 249 ATTRIBUTE       WiMAX-Service-Id                        10      string
 250 ATTRIBUTE       WiMAX-Rating-Group-Id                   11      integer
 251 ATTRIBUTE       WiMAX-Termination-Action                12      byte
 252 ATTRIBUTE       WiMAX-Pool-Id                           13      integer
 253 ATTRIBUTE       WiMAX-Pool-Multiplier                   14      integer
 254 ATTRIBUTE       WiMAX-Requested-Action                  15      byte
 255 ATTRIBUTE       WiMAX-Check-Balance-Result              16      byte
 256
 257 #
 258 #  4 octets - integer representing 1/10's of lowest currency (e.g. cents)
 259 #  4 octets - currency code as in ISO-4217
 260 #  1+       - UTF8 string containing text like "cost is $1 per minute"
 261 #
 262 ATTRIBUTE       WiMAX-Cost-Information-AVP              17      octets
 263
 264 VALUE   WiMAX-Update-Reason             Pre-Initialization      1
 265 VALUE   WiMAX-Update-Reason             Initial-Request         2
 266 VALUE   WiMAX-Update-Reason             Threshold-Reached       3
 267 VALUE   WiMAX-Update-Reason             Quota-Reached           4
 268 VALUE   WiMAX-Update-Reason             TITSU-Approaching       5
 269 VALUE   WiMAX-Update-Reason             Remote-Forced-Disconnect 6
 270 VALUE   WiMAX-Update-Reason             Client-Service-Termination 7
 271 VALUE   WiMAX-Update-Reason             Access-Service-Terminated 8
 272 VALUE   WiMAX-Update-Reason             Service-Not-Established 9
 273 VALUE   WiMAX-Update-Reason             One-Time-Charging       10
 274
 275 VALUE   WiMAX-Termination-Action        Terminate               1
 276 VALUE   WiMAX-Termination-Action        Request-More-Quota      2
 277 VALUE   WiMAX-Termination-Action        Redirect-Or-Filter      3
 278
 279 VALUE   WiMAX-Requested-Action          Balance-Check           1
 280 VALUE   WiMAX-Requested-Action          Price-Enquiry           2
 281
 282 END-TLV         WiMAX-PPAQ
 283
 284 ATTRIBUTE       WiMAX-Prepaid-Tariff-Switching          38      tlv
 285
 286 BEGIN-TLV       WiMAX-Prepaid-Tariff-Switching
 287 ATTRIBUTE       WiMAX-Prepaid-Quota-Identifier          1       string
 288 ATTRIBUTE       WiMAX-Volume-Used-After                 2       integer #1k
 289 ATTRIBUTE       WiMAX-Tariff-Switch-Interval            3       integer #s
 290 ATTRIBUTE       WiMAX-Time-Interval-After               4       integer #s
 291 END-TLV         WiMAX-Prepaid-Tariff-Switching
 292
 293 ATTRIBUTE       WiMAX-Active-Time-Duration              39      integer
 294 ATTRIBUTE       WiMAX-DHCP-RK                           40      octets encrypt=2
 295 ATTRIBUTE       WiMAX-DHCP-RK-Key-Id                    41      integer
 296 ATTRIBUTE       WiMAX-DHCP-RK-Lifetime                  42      integer
 297 ATTRIBUTE       WiMAX-DHCP-Msg-Server-IP                43      ipaddr
 298 ATTRIBUTE       WiMAX-Idle-Mode-Transition              44      byte
 299 ATTRIBUTE       WiMAX-NAP-Id                            45      octets
 300
 301 # 3 octets of NAP Id
 302 # 3 octets of base-station Id
 303 ATTRIBUTE       WiMAX-BS-Id                             46      octets
 304 ATTRIBUTE       WiMAX-Location                          47      octets
 305
 306 # Number of times Acct-Input-Packets rolled over 2^32.
 307 ATTRIBUTE       WiMAX-Acct-Input-Packets-Gigaword       48      integer
 308 ATTRIBUTE       WiMAX-Acct-Output-Packets-Gigaword      49      integer
 309
 310 # Formatted as per IP Filter rule specification.
 311 ATTRIBUTE       WiMAX-Uplink-Flow-Description           50      string
 312
 313 ATTRIBUTE       WiMAX-Blu-Coa-IPv6                      51      ipv6addr
 314 ATTRIBUTE       WiMAX-DNS-Server                        52      combo-ip
 315 ATTRIBUTE       WiMAX-Hotline-Profile-Id                53      string
 316
 317 # Formatted as per IP Filter rule specification.
 318 ATTRIBUTE       WiMAX-HTTP-Redirection-Rule             54      string
 319
 320 # Formatted as per IP Filter rule specification.
 321 ATTRIBUTE       WiMAX-IP-Redirection-Rule               55      string
 322 ATTRIBUTE       WiMAX-Hotline-Session-Timer             56      integer
 323
 324 # 3 octets
 325 ATTRIBUTE       WiMAX-NSP-Id                            57      octets
 326 ATTRIBUTE       WiMAX-HA-RK-Key-Requested               58      integer
 327
 328 VALUE   WiMAX-HA-RK-Key-Requested       No                      0
 329 VALUE   WiMAX-HA-RK-Key-Requested       Yes                     1
 330
 331 ATTRIBUTE       WiMAX-Count-Type                        59      byte
 332 ATTRIBUTE       WiMAX-DM-Action-Code                    60      integer
 333
 334 VALUE   WiMAX-DM-Action-Code            Deregister-MS           0
 335 VALUE   WiMAX-DM-Action-Code            Suspend-MS-Traffic      1
 336 VALUE   WiMAX-DM-Action-Code            Suspend-User-Traffic    2
 337 VALUE   WiMAX-DM-Action-Code            Resume-Traffic          3
 338 VALUE   WiMAX-DM-Action-Code            MS-Terminate            4
 339 VALUE   WiMAX-DM-Action-Code            MS-Idle                 5
 340 VALUE   WiMAX-DM-Action-Code            MS-Completed-IPv6-Handover 6
 341 VALUE   WiMAX-DM-Action-Code            BS-Sends-RES-Cmd        0xffff
 342
 343 # FA-RK-SPI = SPI-CMIP4 = MIP-SPI
 344 ATTRIBUTE       WiMAX-FA-RK-SPI                         61      integer
 345
 346 # Formatted as per IP Filter rule specification.
 347 ATTRIBUTE       WiMAX-Downlink-Flow-Description         62      string
 348
 349 # Same as QoS-Descriptor... dang.
 350 ATTRIBUTE       WiMAX-Downlink-Granted-QoS              63      tlv
 351
 352 # More MIP keys, calculated as above... but in different packets.
 353 # Why, oh why?
 354 ATTRIBUTE       WiMAX-vHA-IP-MIP4                       64      ipaddr
 355 ATTRIBUTE       WiMAX-vHA-IP-MIP6                       65      ipv6addr
 356 ATTRIBUTE       WiMAX-vHA-MIP4-Key                      66      octets encrypt=2
 357 ATTRIBUTE       WiMAX-vHA-RK-Key                        67      octets encrypt=2
 358 ATTRIBUTE       WiMAX-vHA-RK-SPI                        68      integer
 359 ATTRIBUTE       WiMAX-vHA-RK-Lifetime                   69      integer
 360
 361 ATTRIBUTE       WiMAX-MN-vHA-MIP6-Key                   70      octets encrypt=2
 362 ATTRIBUTE       WiMAX-MN-vHA-MIP4-SPI                   71      integer
 363 ATTRIBUTE       WiMAX-MN-vHA-MIP6-SPI                   72      integer
 364 ATTRIBUTE       WiMAX-vDHCPv4-Server                    73      ipaddr
 365 ATTRIBUTE       WiMAX-vDHCPv6-Server                    74      ipv6addr
 366 ATTRIBUTE       WiMAX-vDHCP-RK                          75      octets encrypt=2
 367 ATTRIBUTE       WiMAX-vDHCP-RK-Key-ID                   76      integer
 368 ATTRIBUTE       WiMAX-vDHCP-RK-Lifetime                 77      integer
 369
 370 END-VENDOR      WiMAX