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