radius/dictionary.wimax

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