idnits 2.17.1 draft-ietf-dime-rfc4005bis-05.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- == There are 7 instances of lines with non-RFC6890-compliant IPv4 addresses in the document. If these are example addresses, they should be changed. -- The document has examples using IPv4 documentation addresses according to RFC6890, but does not use any IPv6 documentation addresses. Maybe there should be IPv6 examples, too? -- The draft header indicates that this document obsoletes RFC4005, but the abstract doesn't seem to mention this, which it should. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (July 11, 2011) is 4670 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Possible downref: Non-RFC (?) normative reference: ref. 'ANITypes' == Outdated reference: A later version (-34) exists of draft-ietf-dime-rfc3588bis-26 -- Possible downref: Non-RFC (?) normative reference: ref. 'RADIUSTypes' -- Obsolete informational reference (is this intentional?): RFC 1334 (Obsoleted by RFC 1994) -- Obsolete informational reference (is this intentional?): RFC 5246 (Obsoleted by RFC 8446) Summary: 0 errors (**), 0 flaws (~~), 3 warnings (==), 7 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group G. Zorn 3 Internet-Draft Network Zen 4 Obsoletes: 4005 (if approved) July 11, 2011 5 Intended status: Standards Track 6 Expires: January 12, 2012 8 Diameter Network Access Server Application 9 draft-ietf-dime-rfc4005bis-05 11 Abstract 13 This document describes the Diameter protocol application used for 14 Authentication, Authorization, and Accounting (AAA) services in the 15 Network Access Server (NAS) environment. When combined with the 16 Diameter Base protocol, Transport Profile, and Extensible 17 Authentication Protocol specifications, this application 18 specification satisfies typical network access services requirements. 20 Status of This Memo 22 This Internet-Draft is submitted in full conformance with the 23 provisions of BCP 78 and BCP 79. 25 Internet-Drafts are working documents of the Internet Engineering 26 Task Force (IETF). Note that other groups may also distribute 27 working documents as Internet-Drafts. The list of current Internet- 28 Drafts is at http://datatracker.ietf.org/drafts/current/. 30 Internet-Drafts are draft documents valid for a maximum of six months 31 and may be updated, replaced, or obsoleted by other documents at any 32 time. It is inappropriate to use Internet-Drafts as reference 33 material or to cite them other than as "work in progress." 35 This Internet-Draft will expire on January 12, 2012. 37 Copyright Notice 39 Copyright (c) 2011 IETF Trust and the persons identified as the 40 document authors. All rights reserved. 42 This document is subject to BCP 78 and the IETF Trust's Legal 43 Provisions Relating to IETF Documents 44 (http://trustee.ietf.org/license-info) in effect on the date of 45 publication of this document. Please review these documents 46 carefully, as they describe your rights and restrictions with respect 47 to this document. Code Components extracted from this document must 48 include Simplified BSD License text as described in Section 4.e of 49 the Trust Legal Provisions and are provided without warranty as 50 described in the Simplified BSD License. 52 Table of Contents 54 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 5 55 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 5 56 1.2. Requirements Language . . . . . . . . . . . . . . . . . . 6 57 1.3. Advertising Application Support . . . . . . . . . . . . . 7 58 2. NAS Calls, Ports, and Sessions . . . . . . . . . . . . . . . . 7 59 2.1. Diameter Session Establishment . . . . . . . . . . . . . . 7 60 2.2. Diameter Session Reauthentication or Reauthorization . . . 8 61 2.3. Diameter Session Termination . . . . . . . . . . . . . . . 8 62 3. Diameter NAS Application Messages . . . . . . . . . . . . . . 9 63 3.1. AA-Request (AAR) Command . . . . . . . . . . . . . . . . . 9 64 3.2. AA-Answer (AAA) Command . . . . . . . . . . . . . . . . . 11 65 3.3. Re-Auth-Request (RAR) Command . . . . . . . . . . . . . . 13 66 3.4. Re-Auth-Answer (RAA) Command . . . . . . . . . . . . . . . 14 67 3.5. Session-Termination-Request (STR) Command . . . . . . . . 15 68 3.6. Session-Termination-Answer (STA) Command . . . . . . . . . 16 69 3.7. Abort-Session-Request (ASR) Command . . . . . . . . . . . 17 70 3.8. Abort-Session-Answer (ASA) Command . . . . . . . . . . . . 18 71 3.9. Accounting-Request (ACR) Command . . . . . . . . . . . . . 19 72 3.10. Accounting-Answer (ACA) Command . . . . . . . . . . . . . 21 73 4. Diameter NAS Application AVPs . . . . . . . . . . . . . . . . 22 74 4.1. Derived AVP Data Formats . . . . . . . . . . . . . . . . . 22 75 4.1.1. QoSFilterRule . . . . . . . . . . . . . . . . . . . . 22 76 4.2. NAS Session AVPs . . . . . . . . . . . . . . . . . . . . . 23 77 4.2.1. Call and Session Information . . . . . . . . . . . . . 23 78 4.2.2. NAS-Port AVP . . . . . . . . . . . . . . . . . . . . . 24 79 4.2.3. NAS-Port-Id AVP . . . . . . . . . . . . . . . . . . . 24 80 4.2.4. NAS-Port-Type AVP . . . . . . . . . . . . . . . . . . 25 81 4.2.5. Called-Station-Id AVP . . . . . . . . . . . . . . . . 25 82 4.2.6. Calling-Station-Id AVP . . . . . . . . . . . . . . . . 25 83 4.2.7. Connect-Info AVP . . . . . . . . . . . . . . . . . . . 26 84 4.2.8. Originating-Line-Info AVP . . . . . . . . . . . . . . 26 85 4.2.9. Reply-Message AVP . . . . . . . . . . . . . . . . . . 27 86 4.3. NAS Authentication AVPs . . . . . . . . . . . . . . . . . 27 87 4.3.1. User-Password AVP . . . . . . . . . . . . . . . . . . 28 88 4.3.2. Password-Retry AVP . . . . . . . . . . . . . . . . . . 28 89 4.3.3. Prompt AVP . . . . . . . . . . . . . . . . . . . . . . 29 90 4.3.4. CHAP-Auth AVP . . . . . . . . . . . . . . . . . . . . 29 91 4.3.5. CHAP-Algorithm AVP . . . . . . . . . . . . . . . . . . 29 92 4.3.6. CHAP-Ident AVP . . . . . . . . . . . . . . . . . . . . 29 93 4.3.7. CHAP-Response AVP . . . . . . . . . . . . . . . . . . 29 94 4.3.8. CHAP-Challenge AVP . . . . . . . . . . . . . . . . . . 30 95 4.3.9. ARAP-Password AVP . . . . . . . . . . . . . . . . . . 30 96 4.3.10. ARAP-Challenge-Response AVP . . . . . . . . . . . . . 30 97 4.3.11. ARAP-Security AVP . . . . . . . . . . . . . . . . . . 30 98 4.3.12. ARAP-Security-Data AVP . . . . . . . . . . . . . . . . 30 99 4.4. NAS Authorization AVPs . . . . . . . . . . . . . . . . . . 31 100 4.4.1. Service-Type AVP . . . . . . . . . . . . . . . . . . . 33 101 4.4.2. Callback-Number AVP . . . . . . . . . . . . . . . . . 33 102 4.4.3. Callback-Id AVP . . . . . . . . . . . . . . . . . . . 34 103 4.4.4. Idle-Timeout AVP . . . . . . . . . . . . . . . . . . . 34 104 4.4.5. Port-Limit AVP . . . . . . . . . . . . . . . . . . . . 34 105 4.4.6. NAS-Filter-Rule AVP . . . . . . . . . . . . . . . . . 34 106 4.4.7. Filter-Id AVP . . . . . . . . . . . . . . . . . . . . 34 107 4.4.8. Configuration-Token AVP . . . . . . . . . . . . . . . 35 108 4.4.9. QoS-Filter-Rule AVP . . . . . . . . . . . . . . . . . 35 109 4.4.10. Framed Access Authorization AVPs . . . . . . . . . . . 36 110 4.4.10.1. Framed-Protocol AVP . . . . . . . . . . . . . . . 36 111 4.4.10.2. Framed-Routing AVP . . . . . . . . . . . . . . . 36 112 4.4.10.3. Framed-MTU AVP . . . . . . . . . . . . . . . . . 36 113 4.4.10.4. Framed-Compression AVP . . . . . . . . . . . . . 36 114 4.4.10.5. IP Access Authorization AVPs . . . . . . . . . . 36 115 4.4.10.5.1. Framed-IP-Address AVP . . . . . . . . . . . . 37 116 4.4.10.5.2. Framed-IP-Netmask AVP . . . . . . . . . . . . 37 117 4.4.10.5.3. Framed-Route AVP . . . . . . . . . . . . . . 37 118 4.4.10.5.4. Framed-Pool AVP . . . . . . . . . . . . . . . 38 119 4.4.10.5.5. Framed-Interface-Id AVP . . . . . . . . . . . 38 120 4.4.10.5.6. Framed-IPv6-Prefix AVP . . . . . . . . . . . 38 121 4.4.10.5.7. Framed-IPv6-Route AVP . . . . . . . . . . . . 38 122 4.4.10.5.8. Framed-IPv6-Pool AVP . . . . . . . . . . . . 39 123 4.4.10.6. IPX Access AVPs . . . . . . . . . . . . . . . . . 39 124 4.4.10.6.1. Framed-IPX-Network AVP . . . . . . . . . . . 39 125 4.4.10.7. AppleTalk Network Access AVPs . . . . . . . . . . 39 126 4.4.10.7.1. Framed-AppleTalk-Link AVP . . . . . . . . . . 39 127 4.4.10.7.2. Framed-AppleTalk-Network AVP . . . . . . . . 40 128 4.4.10.7.3. Framed-AppleTalk-Zone AVP . . . . . . . . . . 40 129 4.4.10.8. AppleTalk Remote Access AVPs . . . . . . . . . . 40 130 4.4.10.8.1. ARAP-Features AVP . . . . . . . . . . . . . . 40 131 4.4.10.8.2. ARAP-Zone-Access AVP . . . . . . . . . . . . 40 132 4.4.11. Non-Framed Access Authorization AVPs . . . . . . . . . 41 133 4.4.11.1. Login-IP-Host AVP . . . . . . . . . . . . . . . . 41 134 4.4.11.2. Login-IPv6-Host AVP . . . . . . . . . . . . . . . 41 135 4.4.11.3. Login-Service AVP . . . . . . . . . . . . . . . . 41 136 4.4.11.4. TCP Services . . . . . . . . . . . . . . . . . . 42 137 4.4.11.4.1. Login-TCP-Port AVP . . . . . . . . . . . . . 42 138 4.4.11.5. LAT Services . . . . . . . . . . . . . . . . . . 42 139 4.4.11.5.1. Login-LAT-Service AVP . . . . . . . . . . . . 42 140 4.4.11.5.2. Login-LAT-Node AVP . . . . . . . . . . . . . 43 141 4.4.11.5.3. Login-LAT-Group AVP . . . . . . . . . . . . . 43 142 4.4.11.5.4. Login-LAT-Port AVP . . . . . . . . . . . . . 43 143 4.5. NAS Tunneling AVPs . . . . . . . . . . . . . . . . . . . . 44 144 4.5.1. Tunneling AVP . . . . . . . . . . . . . . . . . . . . 44 145 4.5.2. Tunnel-Type AVP . . . . . . . . . . . . . . . . . . . 45 146 4.5.3. Tunnel-Medium-Type AVP . . . . . . . . . . . . . . . . 45 147 4.5.4. Tunnel-Client-Endpoint AVP . . . . . . . . . . . . . . 45 148 4.5.5. Tunnel-Server-Endpoint AVP . . . . . . . . . . . . . . 46 149 4.5.6. Tunnel-Password AVP . . . . . . . . . . . . . . . . . 47 150 4.5.7. Tunnel-Private-Group-Id AVP . . . . . . . . . . . . . 47 151 4.5.8. Tunnel-Assignment-Id AVP . . . . . . . . . . . . . . . 47 152 4.5.9. Tunnel-Preference AVP . . . . . . . . . . . . . . . . 49 153 4.5.10. Tunnel-Client-Auth-Id AVP . . . . . . . . . . . . . . 49 154 4.5.11. Tunnel-Server-Auth-Id AVP . . . . . . . . . . . . . . 49 155 4.6. NAS Accounting AVPs . . . . . . . . . . . . . . . . . . . 50 156 4.6.1. Accounting-Input-Octets AVP . . . . . . . . . . . . . 51 157 4.6.2. Accounting-Output-Octets AVP . . . . . . . . . . . . . 51 158 4.6.3. Accounting-Input-Packets AVP . . . . . . . . . . . . . 51 159 4.6.4. Accounting-Output-Packets AVP . . . . . . . . . . . . 51 160 4.6.5. Acct-Session-Time AVP . . . . . . . . . . . . . . . . 51 161 4.6.6. Acct-Authentic AVP . . . . . . . . . . . . . . . . . . 52 162 4.6.7. Accounting-Auth-Method AVP . . . . . . . . . . . . . . 52 163 4.6.8. Acct-Delay-Time AVP . . . . . . . . . . . . . . . . . 52 164 4.6.9. Acct-Link-Count AVP . . . . . . . . . . . . . . . . . 52 165 4.6.10. Acct-Tunnel-Connection AVP . . . . . . . . . . . . . . 53 166 4.6.11. Acct-Tunnel-Packets-Lost AVP . . . . . . . . . . . . . 53 167 5. AVP Occurrence Tables . . . . . . . . . . . . . . . . . . . . 53 168 5.1. AA-Request/Answer AVP Table . . . . . . . . . . . . . . . 54 169 5.2. Accounting AVP Tables . . . . . . . . . . . . . . . . . . 56 170 5.2.1. Framed Access Accounting AVP Table . . . . . . . . . . 57 171 5.2.2. Non-Framed Access Accounting AVP Table . . . . . . . . 59 172 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 60 173 7. Security Considerations . . . . . . . . . . . . . . . . . . . 60 174 8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 61 175 8.1. Normative References . . . . . . . . . . . . . . . . . . . 61 176 8.2. Informative References . . . . . . . . . . . . . . . . . . 62 177 Appendix A. Acknowledgements . . . . . . . . . . . . . . . . . . 64 178 A.1. RFC 4005 . . . . . . . . . . . . . . . . . . . . . . . . . 64 179 A.2. RFC 4005bis . . . . . . . . . . . . . . . . . . . . . . . 65 181 1. Introduction 183 This document describes the Diameter protocol application used for 184 AAA in the Network Access Server (NAS) environment. When combined 185 with the Diameter Base protocol [I-D.ietf-dime-rfc3588bis], Transport 186 Profile [RFC3539], and EAP [RFC4072] specifications, this 187 specification satisfies the NAS-related requirements defined in 188 [RFC2989] and [RFC3169]. 190 First, this document describes the operation of a Diameter NAS 191 application. Then it defines the Diameter message Command-Codes. 192 The following sections list the AVPs used in these messages, grouped 193 by common usage. These are session identification, authentication, 194 authorization, tunneling, and accounting. The authorization AVPs are 195 further broken down by service type. 197 1.1. Terminology 199 Section 1.2 of the base Diameter specification 200 [I-D.ietf-dime-rfc3588bis] defines most of the terminology used in 201 this document. Additionally, the following terms and acronyms are 202 used in this application: 204 NAS (Network Access Server) 205 A device that provides an access service for a user to a network. 206 The service may be a network connection or a value-added service 207 such as terminal emulation [RFC2881]. 209 PPP (Point-to-Point Protocol) 210 A multiprotocol serial datalink. PPP is the primary IP datalink 211 used for dial-in NAS connection service [RFC1661]. 213 CHAP (Challenge Handshake Authentication Protocol) 214 An authentication process used in PPP [RFC1994]. 216 PAP (Password Authentication Protocol) 217 A deprecated PPP authentication process, but often used for 218 backward compatibility [RFC1334]. 220 SLIP (Serial Line Interface Protocol) 221 A serial datalink that only supports IP. A design prior to PPP. 223 ARAP (Appletalk Remote Access Protocol) 224 A serial datalink for accessing Appletalk networks [ARAP]. 226 IPX (Internet Packet Exchange) 227 The network protocol used by NetWare networks [IPX]. 229 L2TP (Layer Two Tunneling Protocol) 231 L2TP [RFC3931] provides a dynamic mechanism for tunneling Layer 2 232 "circuits" across a packet-oriented data network. 234 LAC (L2TP Access Concentrator) 236 An L2TP Control Connection Endpoint being used tocross-connect an 237 L2TP session directly to a data link [RFC3931]. 239 LAT (Local Area Transport) 240 A Digital Equipment Corp. LAN protocol for terminal services 241 [LAT]. 243 LCP (Link Control Protocol) 245 One of the three major components of PPP [RFC1661]. LCP is used 246 to automatically agree upon encapsulation format options, handle 247 varying limits on sizes of packets, detect a looped-back link and 248 other common misconfiguration errors, and terminate the link. 249 Other optional facilities provided are authentication of the 250 identity of its peer on the link, and determination when a link is 251 functioning properly and when it is failing. 253 PAC (PPTP Access Concentrator) 255 A device attached to one or more Public Switched Telephone Network 256 (PSTN) or Integrated Services Digtal Network (ISDN) lines capable 257 of PPP operation and of handling PPTP [RFC2637]. 259 PPTP (Point-to-Point Tunneling Protocol) 261 A protocol which allows PPP to be tunneled through an IP network 262 [RFC2637]. 264 VPN (Virtual Private Network) 265 In this document, this term is used to describe access services 266 that use tunneling methods. 268 1.2. Requirements Language 270 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 271 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 272 document are to be interpreted as described in RFC 2119 [RFC2119]. 274 1.3. Advertising Application Support 276 Diameter applications conforming to this specification MUST advertise 277 support by including the value of one (1) in the Auth-Application-Id 278 of the Capabilities-Exchange-Request (CER), AA-Request (AAR), and AA- 279 Answer (AAA) messages. All other messages use the Base application 280 id value [I-D.ietf-dime-rfc3588bis]. 282 2. NAS Calls, Ports, and Sessions 284 The arrival of a new call or service connection at a port of a 285 Network Access Server (NAS) starts a Diameter NAS message exchange. 286 Information about the call, the identity of the user, and the user's 287 authentication information are packaged into a Diameter AA-Request 288 (AAR) message and sent to a server. 290 The server processes the information and responds with a Diameter AA- 291 Answer (AAA) message that contains authorization information for the 292 NAS, or a failure code (Result-Code AVP). A value of 293 DIAMETER_MULTI_ROUND_AUTH indicates an additional authentication 294 exchange, and several AAR and AAA messages may be exchanged until the 295 transaction completes. 297 Depending on the value of the Auth-Request-Type AVP, the Diameter 298 protocol allows authorization-only requests that contain no 299 authentication information from the client. This capability goes 300 beyond the Call Check capabilities provided by RADIUS (Section 5.6 of 301 [RFC2865]) in that no access decision is requested. As a result, 302 service cannot be started as a result of a response to an 303 authorization-only request without introducing a significant security 304 vulnerability. 306 2.1. Diameter Session Establishment 308 When the authentication or authorization exchange completes 309 successfully, the NAS application SHOULD start a session context. If 310 the Result-Code of DIAMETER_MULTI_ROUND_AUTH is returned, the 311 exchange continues until a success or error is returned. 313 If accounting is active, the application MUST also send an Accounting 314 message [I-D.ietf-dime-rfc3588bis]. An Accounting-Record-Type of 315 START_RECORD is sent for a new session. If a session fails to start, 316 the EVENT_RECORD message is sent with the reason for the failure 317 described. 319 Note that the return of an unsupportable Accounting-Realtime-Required 320 value [I-D.ietf-dime-rfc3588bis] would result in a failure to 321 establish the session. 323 2.2. Diameter Session Reauthentication or Reauthorization 325 The Diameter Base protocol allows users to be periodically 326 reauthenticated and/or reauthorized. In such instances, the 327 Session-Id AVP in the AAR message MUST be the same as the one present 328 in the original authentication/authorization message. 330 A Diameter server informs the NAS of the maximum time allowed before 331 reauthentication or reauthorization via the Authorization-Lifetime 332 AVP [I-D.ietf-dime-rfc3588bis]. A NAS MAY reauthenticate and/or 333 reauthorize before the end, but A NAS MUST reauthenticate and/or 334 reauthorize at the end of the period provided by the Authorization- 335 Lifetime AVP. The failure of a reauthentication exchange will 336 terminate the service. 338 Furthermore, it is possible for Diameter servers to issue an 339 unsolicited reauthentication and/or reauthorization request (e.g., 340 Re-Auth-Request (RAR) message [I-D.ietf-dime-rfc3588bis]) to the NAS. 341 Upon receipt of such a message, the NAS MUST respond to the request 342 with a Re-Auth-Answer (RAA) message [I-D.ietf-dime-rfc3588bis]. 344 If the RAR properly identifies an active session, the NAS will 345 initiate a new local reauthentication or authorization sequence as 346 indicated by the Re-Auth-Request-Type value. This will cause the NAS 347 to send a new AAR message using the existing Session-Id. The server 348 will respond with an AAA message to specify the new service 349 parameters. 351 If accounting is active, every change of authentication or 352 authorization SHOULD generate an accounting message. If the NAS 353 service is a continuation of the prior user context, then an 354 Accounting-Record-Type of INTERIM_RECORD indicating the new session 355 attributes and cumulative status would be appropriate. If a new user 356 or a significant change in authorization is detected by the NAS, then 357 the service may send two messages of the types STOP_RECORD and 358 START_RECORD. Accounting may change the subsession identifiers 359 (Acct-Session-ID, or Acct-Sub-Session-Id) to indicate such sub- 360 sessions. A service may also use a different Session-Id value for 361 accounting (see Section 9.6 of [I-D.ietf-dime-rfc3588bis]). 363 However, the Diameter Session-ID AVP value used for the initial 364 authorization exchange MUST be used to generate an STR message when 365 the session context is terminated. 367 2.3. Diameter Session Termination 369 When a NAS receives an indication that a user's session is being 370 disconnected by the client (e.g., an LCP Terminate-Request message 372 [RFC1661] is received) or an administrative command, the NAS MUST 373 issue a Session-Termination-Request (STR) [I-D.ietf-dime-rfc3588bis] 374 to its Diameter Server. This will ensure that any resources 375 maintained on the servers are freed appropriately. 377 Furthermore, a NAS that receives an Abort-Session-Request (ASR) 378 [I-D.ietf-dime-rfc3588bis] MUST issue an ASA if the session 379 identified is active and disconnect the PPP (or tunneling) session. 381 If accounting is active, an Accounting STOP_RECORD message 382 [I-D.ietf-dime-rfc3588bis] MUST be sent upon termination of the 383 session context. 385 More information on Diameter Session Termination can be found in 386 Sections 8.4 and 8.5 of [I-D.ietf-dime-rfc3588bis]. 388 3. Diameter NAS Application Messages 390 This section defines the Diameter message Command-Code 391 [I-D.ietf-dime-rfc3588bis] values that MUST be supported by all 392 Diameter implementations conforming to this specification. The 393 Command Codes are as follows: 395 +-----------------------------------+---------+------+--------------+ 396 | Command Name | Abbrev. | Code | Reference | 397 +-----------------------------------+---------+------+--------------+ 398 | AA-Request | AAR | 265 | Section 3.1 | 399 | AA-Answer | AAA | 265 | Section 3.2 | 400 | Re-Auth-Request | RAR | 258 | Section 3.3 | 401 | Re-Auth-Answer | RAA | 258 | Section 3.4 | 402 | Session-Termination-Request | STR | 275 | Section 3.5 | 403 | Session-Termination-Answer | STA | 275 | Section 3.6 | 404 | Abort-Session-Request | ASR | 274 | Section 3.7 | 405 | Abort-Session-Answer | ASA | 274 | Section 3.8 | 406 | Accounting-Request | ACR | 271 | Section 3.9 | 407 | Accounting-Answer | ACA | 271 | Section 3.10 | 408 +-----------------------------------+---------+------+--------------+ 410 3.1. AA-Request (AAR) Command 412 The AA-Request (AAR), which is indicated by setting the Command-Code 413 field to 265 and the 'R' bit in the Command Flags field, is used to 414 request authentication and/or authorization for a given NAS user. 415 The type of request is identified through the Auth-Request-Type AVP 416 [I-D.ietf-dime-rfc3588bis] The recommended value for most situations 417 is AUTHORIZE_AUTHENTICATE. 419 If Authentication is requested, the User-Name attribute SHOULD be 420 present, as well as any additional authentication AVPs that would 421 carry the password information. A request for authorization SHOULD 422 only include the information from which the authorization will be 423 performed, such as the User-Name, Called-Station-Id, or Calling- 424 Station-Id AVPs. All requests SHOULD contain AVPs uniquely 425 identifying the source of the call, such as Origin-Host and NAS-Port. 426 Certain networks MAY use different AVPs for authorization purposes. 427 A request for authorization will include some AVPs defined in 428 Section 4.4. 430 It is possible for a single session to be authorized first and then 431 for an authentication request to follow. 433 This AA-Request message MAY be the result of a multi-round 434 authentication exchange, which occurs when the AA-Answer message is 435 received with the Result-Code AVP set to DIAMETER_MULTI_ROUND_AUTH. 436 A subsequent AAR message SHOULD be sent, with the User-Password AVP 437 that includes the user's response to the prompt, and MUST include any 438 State AVPs that were present in the AAA message. 440 Message Format 442 ::= < Diameter Header: 265, REQ, PXY > 443 < Session-Id > 444 { Auth-Application-Id } 445 { Origin-Host } 446 { Origin-Realm } 447 { Destination-Realm } 448 { Auth-Request-Type } 449 [ Destination-Host ] 450 [ NAS-Identifier ] 451 [ NAS-IP-Address ] 452 [ NAS-IPv6-Address ] 453 [ NAS-Port ] 454 [ NAS-Port-Id ] 455 [ NAS-Port-Type ] 456 [ Origin-AAA-Protocol ] 457 [ Origin-State-Id ] 458 [ Port-Limit ] 459 [ User-Name ] 460 [ User-Password ] 461 [ Service-Type ] 462 [ State ] 463 [ Authorization-Lifetime ] 464 [ Auth-Grace-Period ] 465 [ Auth-Session-State ] 466 [ Callback-Number ] 467 [ Called-Station-Id ] 469 [ Calling-Station-Id ] 470 [ Originating-Line-Info ] 471 [ Connect-Info ] 472 [ CHAP-Auth ] 473 [ CHAP-Challenge ] 474 * [ Framed-Compression ] 475 [ Framed-Interface-Id ] 476 [ Framed-IP-Address ] 477 * [ Framed-IPv6-Prefix ] 478 [ Framed-IP-Netmask ] 479 [ Framed-MTU ] 480 [ Framed-Protocol ] 481 [ ARAP-Password ] 482 [ ARAP-Security ] 483 * [ ARAP-Security-Data ] 484 * [ Login-IP-Host ] 485 * [ Login-IPv6-Host ] 486 [ Login-LAT-Group ] 487 [ Login-LAT-Node ] 488 [ Login-LAT-Port ] 489 [ Login-LAT-Service ] 490 * [ Tunneling ] 491 * [ Proxy-Info ] 492 * [ Route-Record ] 493 * [ AVP ] 495 3.2. AA-Answer (AAA) Command 497 The AA-Answer (AAA) message is indicated by setting the Command-Code 498 field to 265 and clearing the 'R' bit in the Command Flags field. It 499 is sent in response to the AA-Request (AAR) message. If 500 authorization was requested, a successful response will include the 501 authorization AVPs appropriate for the service being provided, as 502 defined in Section 4.4. 504 For authentication exchanges requiring more than a single round trip, 505 the server MUST set the Result-Code AVP to DIAMETER_MULTI_ROUND_AUTH. 506 An AAA message with this result code MAY include one Reply-Message or 507 more and MAY include zero or one State AVPs. 509 If the Reply-Message AVP was present, the network access server 510 SHOULD send the text to the user's client to display to the user, 511 instructing the client to prompt the user for a response. For 512 example, this capability can be achieved in PPP via PAP. If the 513 access client is unable to prompt the user for a new response, it 514 MUST treat the AA-Answer (AAA) with the Reply-Message AVP as an error 515 and deny access. 517 Message Format 519 ::= < Diameter Header: 265, PXY > 520 < Session-Id > 521 { Auth-Application-Id } 522 { Auth-Request-Type } 523 { Result-Code } 524 { Origin-Host } 525 { Origin-Realm } 526 [ User-Name ] 527 [ Service-Type ] 528 * [ Class ] 529 * [ Configuration-Token ] 530 [ Acct-Interim-Interval ] 531 [ Error-Message ] 532 [ Error-Reporting-Host ] 533 * [ Failed-AVP ] 534 [ Idle-Timeout ] 535 [ Authorization-Lifetime ] 536 [ Auth-Grace-Period ] 537 [ Auth-Session-State ] 538 [ Re-Auth-Request-Type ] 539 [ Multi-Round-Time-Out ] 540 [ Session-Timeout ] 541 [ State ] 542 * [ Reply-Message ] 543 [ Origin-AAA-Protocol ] 544 [ Origin-State-Id ] 545 * [ Filter-Id ] 546 [ Password-Retry ] 547 [ Port-Limit ] 548 [ Prompt ] 549 [ ARAP-Challenge-Response ] 550 [ ARAP-Features ] 551 [ ARAP-Security ] 552 * [ ARAP-Security-Data ] 553 [ ARAP-Zone-Access ] 554 [ Callback-Id ] 555 [ Callback-Number ] 556 [ Framed-Appletalk-Link ] 557 * [ Framed-Appletalk-Network ] 558 [ Framed-Appletalk-Zone ] 559 * [ Framed-Compression ] 560 [ Framed-Interface-Id ] 561 [ Framed-IP-Address ] 562 * [ Framed-IPv6-Prefix ] 563 [ Framed-IPv6-Pool ] 564 * [ Framed-IPv6-Route ] 566 [ Framed-IP-Netmask ] 567 * [ Framed-Route ] 568 [ Framed-Pool ] 569 [ Framed-IPX-Network ] 570 [ Framed-MTU ] 571 [ Framed-Protocol ] 572 [ Framed-Routing ] 573 * [ Login-IP-Host ] 574 * [ Login-IPv6-Host ] 575 [ Login-LAT-Group ] 576 [ Login-LAT-Node ] 577 [ Login-LAT-Port ] 578 [ Login-LAT-Service ] 579 [ Login-Service ] 580 [ Login-TCP-Port ] 581 * [ NAS-Filter-Rule ] 582 * [ QoS-Filter-Rule ] 583 * [ Tunneling ] 584 * [ Redirect-Host ] 585 [ Redirect-Host-Usage ] 586 [ Redirect-Max-Cache-Time ] 587 * [ Proxy-Info ] 588 * [ AVP ] 590 3.3. Re-Auth-Request (RAR) Command 592 A Diameter server may initiate a re-authentication and/or re- 593 authorization service for a particular session by issuing a Re-Auth- 594 Request (RAR) message [I-D.ietf-dime-rfc3588bis]. 596 For example, for pre-paid services, the Diameter server that 597 originally authorized a session may need some confirmation that the 598 user is still using the services. 600 If a NAS receives an RAR message with Session-Id equal to a currently 601 active session and a Re-Auth-Type that includes authentication, it 602 MUST initiate a re-authentication toward the user, if the service 603 supports this particular feature. 605 Message Format 607 ::= < Diameter Header: 258, REQ, PXY > 608 < Session-Id > 609 { Origin-Host } 610 { Origin-Realm } 611 { Destination-Realm } 612 { Destination-Host } 613 { Auth-Application-Id } 614 { Re-Auth-Request-Type } 615 [ User-Name ] 616 [ Origin-AAA-Protocol ] 617 [ Origin-State-Id ] 618 [ NAS-Identifier ] 619 [ NAS-IP-Address ] 620 [ NAS-IPv6-Address ] 621 [ NAS-Port ] 622 [ NAS-Port-Id ] 623 [ NAS-Port-Type ] 624 [ Service-Type ] 625 [ Framed-IP-Address ] 626 [ Framed-IPv6-Prefix ] 627 [ Framed-Interface-Id ] 628 [ Called-Station-Id ] 629 [ Calling-Station-Id ] 630 [ Originating-Line-Info ] 631 [ Acct-Session-Id ] 632 [ Acct-Multi-Session-Id ] 633 [ State ] 634 * [ Class ] 635 [ Reply-Message ] 636 * [ Proxy-Info ] 637 * [ Route-Record ] 638 * [ AVP ] 640 3.4. Re-Auth-Answer (RAA) Command 642 The Re-Auth-Answer (RAA) message [I-D.ietf-dime-rfc3588bis] is sent 643 in response to the RAR. The Result-Code AVP MUST be present and 644 indicates the disposition of the request. 646 A successful RAA transaction MUST be followed by an AAR message. 648 Message Format 650 ::= < Diameter Header: 258, PXY > 651 < Session-Id > 652 { Result-Code } 653 { Origin-Host } 654 { Origin-Realm } 655 [ User-Name ] 656 [ Origin-AAA-Protocol ] 657 [ Origin-State-Id ] 658 [ Error-Message ] 659 [ Error-Reporting-Host ] 660 * [ Failed-AVP ] 661 * [ Redirected-Host ] 662 [ Redirected-Host-Usage ] 663 [ Redirected-Host-Cache-Time ] 664 [ Service-Type ] 665 * [ Configuration-Token ] 666 [ Idle-Timeout ] 667 [ Authorization-Lifetime ] 668 [ Auth-Grace-Period ] 669 [ Re-Auth-Request-Type ] 670 [ State ] 671 * [ Class ] 672 * [ Reply-Message ] 673 [ Prompt ] 674 * [ Proxy-Info ] 675 * [ AVP ] 677 3.5. Session-Termination-Request (STR) Command 679 The Session-Termination-Request (STR) message 680 [I-D.ietf-dime-rfc3588bis] is sent by the NAS to inform the Diameter 681 Server that an authenticated and/or authorized session is being 682 terminated. 684 Message Format 686 ::= < Diameter Header: 275, REQ, PXY > 687 < Session-Id > 688 { Origin-Host } 689 { Origin-Realm } 690 { Destination-Realm } 691 { Auth-Application-Id } 692 { Termination-Cause } 693 [ User-Name ] 694 [ Destination-Host ] 695 * [ Class ] 696 [ Origin-AAA-Protocol ] 697 [ Origin-State-Id ] 698 * [ Proxy-Info ] 699 * [ Route-Record ] 700 * [ AVP ] 702 3.6. Session-Termination-Answer (STA) Command 704 The Session-Termination-Answer (STA) message 705 [I-D.ietf-dime-rfc3588bis] is sent by the Diameter Server to 706 acknowledge the notification that the session has been terminated. 707 The Result-Code AVP MUST be present and MAY contain an indication 708 that an error occurred while the STR was being serviced. 710 Upon sending or receiving the STA, the Diameter Server MUST release 711 all resources for the session indicated by the Session-Id AVP. Any 712 intermediate server in the Proxy-Chain MAY also release any 713 resources, if necessary. 715 Message Format 717 ::= < Diameter Header: 275, PXY > 718 < Session-Id > 719 { Result-Code } 720 { Origin-Host } 721 { Origin-Realm } 722 [ User-Name ] 723 * [ Class ] 724 [ Error-Message ] 725 [ Error-Reporting-Host ] 726 * [ Failed-AVP ] 727 [ Origin-AAA-Protocol ] 728 [ Origin-State-Id ] 729 * [ Redirect-Host ] 730 [ Redirect-Host-Usase ] 731 [ Redirect-Max-Cache-Time ] 732 * [ Proxy-Info ] 733 * [ AVP ] 735 3.7. Abort-Session-Request (ASR) Command 737 The Abort-Session-Request (ASR) message [I-D.ietf-dime-rfc3588bis] 738 may be sent by any server to the NAS providing session service, to 739 request that the session identified by the Session-Id be stopped. 741 Message Format 743 ::= < Diameter Header: 274, REQ, PXY > 744 < Session-Id > 745 { Origin-Host } 746 { Origin-Realm } 747 { Destination-Realm } 748 { Destination-Host } 749 { Auth-Application-Id } 750 [ User-Name ] 751 [ Origin-AAA-Protocol ] 752 [ Origin-State-Id ] 753 [ NAS-Identifier ] 754 [ NAS-IP-Address ] 755 [ NAS-IPv6-Address ] 756 [ NAS-Port ] 757 [ NAS-Port-Id ] 758 [ NAS-Port-Type ] 759 [ Service-Type ] 760 [ Framed-IP-Address ] 761 [ Framed-IPv6-Prefix ] 762 [ Framed-Interface-Id ] 763 [ Called-Station-Id ] 764 [ Calling-Station-Id ] 765 [ Originating-Line-Info ] 766 [ Acct-Session-Id ] 767 [ Acct-Multi-Session-Id ] 768 [ State ] 769 * [ Class ] 770 * [ Reply-Message ] 771 * [ Proxy-Info ] 772 * [ Route-Record ] 773 * [ AVP ] 775 3.8. Abort-Session-Answer (ASA) Command 777 The ASA message [I-D.ietf-dime-rfc3588bis] is sent in response to the 778 ASR. The Result-Code AVP MUST be present and indicates the 779 disposition of the request. 781 If the session identified by Session-Id in the ASR was successfully 782 terminated, Result-Code is set to DIAMETER_SUCCESS. If the session 783 is not currently active, the Result-Code AVP is set to 784 DIAMETER_UNKNOWN_SESSION_ID. If the access device does not stop the 785 session for any other reason, the Result-Code AVP is set to 786 DIAMETER_UNABLE_TO_COMPLY. 788 Message Format 790 ::= < Diameter Header: 274, PXY > 791 < Session-Id > 792 { Result-Code } 793 { Origin-Host } 794 { Origin-Realm } 795 [ User-Name ] 796 [ Origin-AAA-Protocol ] 797 [ Origin-State-Id ] 798 [ State] 799 [ Error-Message ] 800 [ Error-Reporting-Host ] 801 * [ Failed-AVP ] 802 * [ Redirected-Host ] 803 [ Redirected-Host-Usage ] 804 [ Redirected-Max-Cache-Time ] 805 * [ Proxy-Info ] 806 * [ AVP ] 808 3.9. Accounting-Request (ACR) Command 810 The ACR message [I-D.ietf-dime-rfc3588bis] is sent by the NAS to 811 report its session information to a target server downstream. 813 Either the Acct-Application-Id AVP or the Vendor-Specific- 814 Application-Id AVP MUST be present. If the Vendor-Specific- 815 Application-Id grouped AVP is present, it must have an Acct- 816 Application-Id inside. 818 The AVPs listed in the Base protocol specification 819 [I-D.ietf-dime-rfc3588bis] MUST be assumed to be present, as 820 appropriate. NAS service-specific accounting AVPs SHOULD be present 821 as described in Section 4.6 and the rest of this specification. 823 Message Format 825 ::= < Diameter Header: 271, REQ, PXY > 826 < Session-Id > 827 { Origin-Host } 828 { Origin-Realm } 829 { Destination-Realm } 830 { Accounting-Record-Type } 831 { Accounting-Record-Number } 832 [ Acct-Application-Id ] 833 [ Vendor-Specific-Application-Id ] 834 [ User-Name ] 835 [ Accounting-Sub-Session-Id ] 837 [ Acct-Session-Id ] 838 [ Acct-Multi-Session-Id ] 839 [ Origin-AAA-Protocol ] 840 [ Origin-State-Id ] 841 [ Destination-Host ] 842 [ Event-Timestamp ] 843 [ Acct-Delay-Time ] 844 [ NAS-Identifier ] 845 [ NAS-IP-Address ] 846 [ NAS-IPv6-Address ] 847 [ NAS-Port ] 848 [ NAS-Port-Id ] 849 [ NAS-Port-Type ] 850 * [ Class ] 851 [ Service-Type ] 852 [ Termination-Cause ] 853 [ Accounting-Input-Octets ] 854 [ Accounting-Input-Packets ] 855 [ Accounting-Output-Octets ] 856 [ Accounting-Output-Packets ] 857 [ Acct-Authentic ] 858 [ Accounting-Auth-Method ] 859 [ Acct-Link-Count ] 860 [ Acct-Session-Time ] 861 [ Acct-Tunnel-Connection ] 862 [ Acct-Tunnel-Packets-Lost ] 863 [ Callback-Id ] 864 [ Callback-Number ] 865 [ Called-Station-Id ] 866 [ Calling-Station-Id ] 867 * [ Connection-Info ] 868 [ Originating-Line-Info ] 869 [ Authorization-Lifetime ] 870 [ Session-Timeout ] 871 [ Idle-Timeout ] 872 [ Port-Limit ] 873 [ Accounting-Realtime-Required ] 874 [ Acct-Interim-Interval ] 875 * [ Filter-Id ] 876 * [ NAS-Filter-Rule ] 877 * [ Qos-Filter-Rule ] 878 [ Framed-AppleTalk-Link ] 879 [ Framed-AppleTalk-Network ] 880 [ Framed-AppleTalk-Zone ] 881 [ Framed-Compression ] 882 [ Framed-Interface-Id ] 883 [ Framed-IP-Address ] 884 [ Framed-IP-Netmask ] 886 * [ Framed-IPv6-Prefix ] 887 [ Framed-IPv6-Pool ] 888 * [ Framed-IPv6-Route ] 889 [ Framed-IPX-Network ] 890 [ Framed-MTU ] 891 [ Framed-Pool ] 892 [ Framed-Protocol ] 893 * [ Framed-Route ] 894 [ Framed-Routing ] 895 * [ Login-IP-Host ] 896 * [ Login-IPv6-Host ] 897 [ Login-LAT-Group ] 898 [ Login-LAT-Node ] 899 [ Login-LAT-Port ] 900 [ Login-LAT-Service ] 901 [ Login-Service ] 902 [ Login-TCP-Port ] 903 * [ Tunneling ] 904 * [ Proxy-Info ] 905 * [ Route-Record ] 906 * [ AVP ] 908 3.10. Accounting-Answer (ACA) Command 910 The ACA message [I-D.ietf-dime-rfc3588bis] is used to acknowledge an 911 Accounting-Request command. The Accounting-Answer command contains 912 the same Session-Id as the Request. If the Accounting-Request was 913 protected by end-to-end security, then the corresponding ACA message 914 MUST be protected as well. 916 Only the target Diameter Server or home Diameter Server SHOULD 917 respond with the Accounting-Answer command. 919 Either the Acct-Application-Id AVP or the Vendor-Specific- 920 Application-Id AVP MUST be present, as it was in the request. 922 The AVPs listed in the Base protocol specification 923 [I-D.ietf-dime-rfc3588bis] MUST be assumed to be present, as 924 appropriate. NAS service-specific accounting AVPs SHOULD be present 925 as described in Section 4.6 and the rest of this specification. 927 Message Format 929 ::= < Diameter Header: 271, PXY > 930 < Session-Id > 931 { Result-Code } 932 { Origin-Host } 933 { Origin-Realm } 934 { Accounting-Record-Type } 935 { Accounting-Record-Number } 936 [ Acct-Application-Id ] 937 [ Vendor-Specific-Application-Id ] 938 [ User-Name ] 939 [ Accounting-Sub-Session-Id ] 940 [ Acct-Session-Id ] 941 [ Acct-Multi-Session-Id ] 942 [ Event-Timestamp ] 943 [ Error-Message ] 944 [ Error-Reporting-Host ] 945 * [ Failed-AVP ] 946 [ Origin-AAA-Protocol ] 947 [ Origin-State-Id ] 948 [ NAS-Identifier ] 949 [ NAS-IP-Address ] 950 [ NAS-IPv6-Address ] 951 [ NAS-Port ] 952 [ NAS-Port-Id ] 953 [ NAS-Port-Type ] 954 [ Service-Type ] 955 [ Termination-Cause ] 956 [ Accounting-Realtime-Required ] 957 [ Acct-Interim-Interval ] 958 * [ Class ] 959 * [ Proxy-Info ] 960 * [ AVP ] 962 4. Diameter NAS Application AVPs 964 The following sections define a new derived AVP data format, a set of 965 application-specific AVPs and describe the use of AVPs defined in 966 other documents by the Diameter NAS Application. 968 4.1. Derived AVP Data Formats 970 4.1.1. QoSFilterRule 972 The QosFilterRule format is derived from the OctetString AVP Base 973 Format. It uses the ASCII charset. Packets may be marked or metered 974 based on the following information: 976 o Direction (in or out) 978 o Source and destination IP address (possibly masked) 980 o Protocol 982 o Source and destination port (lists or ranges) 984 o DSCP values (no mask or range) 986 Rules for the appropriate direction are evaluated in order; the first 987 matched rule terminates the evaluation. Each packet is evaluated 988 once. If no rule matches, the packet is treated as best effort. An 989 access device unable to interpret or apply a QoS rule SHOULD NOT 990 terminate the session. 992 QoSFilterRule filters MUST follow the following format: 994 action dir proto from src to dst [options] 995 where 997 action 998 tag Mark packet with a specific DSCP [RFC2474] 999 meter Meter traffic 1001 dir The format is as described under IPFilterRule 1002 [I-D.ietf-dime-rfc3588bis] 1004 proto The format is as described under IPFilterRule 1005 [I-D.ietf-dime-rfc3588bis] 1007 src and dst The format is as described under IPFilterRule 1008 [I-D.ietf-dime-rfc3588bis] 1010 The options are described in Section 4.4.9. 1012 The rule syntax is a modified subset of ipfw(8) from FreeBSD, and the 1013 ipfw.c code may provide a useful base for implementations. 1015 4.2. NAS Session AVPs 1017 Diameter reserves the AVP Codes 0 - 255 for RADIUS Attributes that 1018 are implemented in Diameter. 1020 4.2.1. Call and Session Information 1022 This section describes the AVPs specific to Diameter applications 1023 that are needed to identify the call and session context and status 1024 information. On a request, this information allows the server to 1025 qualify the session. 1027 These AVPs are used in addition to the following AVPs from the base 1028 protocol specification [I-D.ietf-dime-rfc3588bis]: 1030 Session-Id 1031 Auth-Application-Id 1032 Origin-Host 1033 Origin-Realm 1034 Auth-Request-Type 1035 Termination-Cause 1037 The following table gives the possible flag values for the session 1038 level AVPs and specifies whether the AVP MAY be encrypted. 1040 +----------+ 1041 | AVP Flag | 1042 | rules | 1043 |----+-----+ 1044 |MUST| MUST| 1045 Attribute Name Section Defined | | NOT| 1046 -----------------------------------------|----+-----| 1047 NAS-Port 4.2.2 | M | V | 1048 NAS-Port-Id 4.2.3 | M | V | 1049 NAS-Port-Type 4.2.4 | M | V | 1050 Called-Station-Id 4.2.5 | M | V | 1051 Calling-Station-Id 4.2.6 | M | V | 1052 Connect-Info 4.2.7 | M | V | 1053 Originating-Line-Info 4.2.8 | | V | 1054 Reply-Message 4.2.9 | M | V | 1055 -----------------------------------------|----+-----| 1057 4.2.2. NAS-Port AVP 1059 The NAS-Port AVP (AVP Code 5) is of type Unsigned32 and contains the 1060 physical or virtual port number of the NAS which is authenticating 1061 the user. Note that "port" is meant in its sense as a service 1062 connection on the NAS, not as an IP protocol identifier. 1064 Either the NAS-Port AVP or the NAS-Port-Id AVP (Section 4.2.3) SHOULD 1065 be present in the AA-Request (AAR, Section 3.1) command if the NAS 1066 differentiates among its ports. 1068 4.2.3. NAS-Port-Id AVP 1070 The NAS-Port-Id AVP (AVP Code 87) is of type UTF8String and consists 1071 of ASCII text identifying the port of the NAS authenticating the 1072 user. Note that "port" is meant in its sense as a service connection 1073 on the NAS, not as an IP protocol identifier. 1075 Either the NAS-Port-Id or the NAS-Port (Section 4.2.2) SHOULD be 1076 present in the AA-Request (AAR, Section 3.1) command if the NAS 1077 differentiates among its ports. NAS-Port-Id is intended for use by 1078 NASes that cannot conveniently number their ports. 1080 4.2.4. NAS-Port-Type AVP 1082 The NAS-Port-Type AVP (AVP Code 61) is of type Enumerated and 1083 contains the type of the port on which the NAS is authenticating the 1084 user. This AVP SHOULD be present if the NAS uses the same NAS-Port 1085 number ranges for different service types concurrently. 1087 The currently supported values of the NAS-Port-Type AVP are listed in 1088 [RADIUSTypes]. 1090 4.2.5. Called-Station-Id AVP 1092 The Called-Station-Id AVP (AVP Code 30) is of type UTF8String and 1093 allows the NAS to send the ASCII string describing the Layer 2 1094 address the user contacted in the request. For dialup access, this 1095 can be a phone number obtained by using the Dialed Number 1096 Identification Service (DNIS) or a similar technology. Note that 1097 this may be different from the phone number the call comes in on. 1098 For use with IEEE 802 access, the Called-Station-Id MAY contain a MAC 1099 address formatted as described in [RFC3580]. It SHOULD only be 1100 present in authentication and/or authorization requests. 1102 If the Called-Station-Id AVP is present in an AAR message, Auth- 1103 Request-Type AVP is set to AUTHORIZE_ONLY and the User-Name AVP is 1104 absent, the Diameter Server MAY perform authorization based on this 1105 AVP. This can be used by a NAS to request whether a call should be 1106 answered based on the DNIS result. 1108 The codification of this field's allowed usage range is outside the 1109 scope of this specification. 1111 4.2.6. Calling-Station-Id AVP 1113 The Calling-Station-Id AVP (AVP Code 31) is of type UTF8String and 1114 allows the NAS to send the ASCII string describing the Layer 2 1115 address from which the user connected in the request. For dialup 1116 access, this is the phone number the call came from, using Automatic 1117 Number Identification (ANI) or a similar technology. For use with 1118 IEEE 802 access, the Calling-Station-Id AVP MAY contain a MAC 1119 address, formated as described in [RFC3580]. It SHOULD only be 1120 present in authentication and/or authorization requests. 1122 If the Calling-Station-Id AVP is present in an AAR message, the Auth- 1123 Request-Type AVP is set to AUTHORIZE_ONLY and the User-Name AVP is 1124 absent, the Diameter Server MAY perform authorization based on the 1125 value of this AVP. This can be used by a NAS to request whether a 1126 call should be answered based on the Layer 2 address (ANI, MAC 1127 Address, etc.) 1129 The codification of this field's allowed usage range is outside the 1130 scope of this specification. 1132 4.2.7. Connect-Info AVP 1134 The Connect-Info AVP (AVP Code 77) is of type UTF8String and is sent 1135 in the AA-Request message or an ACR message with the value of the 1136 Accounting-Record-Type AVP set to STOP. When sent in the AA-Request, 1137 it indicates the nature of the user's connection. The connection 1138 speed SHOULD be included at the beginning of the first Connect-Info 1139 AVP in the message. If the transmit and receive connection speeds 1140 differ, both may be included in the first AVP with the transmit speed 1141 listed first (the speed at which the NAS modem transmits), then a 1142 slash (/), then the receive speed, and then other optional 1143 information. 1145 For example: "28800 V42BIS/LAPM" or "52000/31200 V90" 1147 If sent in an ACR message with the value of the Accounting-Record- 1148 Type AVP set to STOP, this attribute may summarize statistics 1149 relating to session quality. For example, in IEEE 802.11, the 1150 Connect-Info AVP may contain information on the number of link layer 1151 retransmissions. The exact format of this attribute is 1152 implementation specific. 1154 4.2.8. Originating-Line-Info AVP 1156 The Originating-Line-Info AVP (AVP Code 94) is of type OctetString 1157 and is sent by the NAS system to convey information about the origin 1158 of the call from an SS7 system. 1160 The Originating Line Information (OLI) element indicates the nature 1161 and/or characteristics of the line from which a call originated 1162 (e.g., pay phone, hotel, cellular). Telephone companies are starting 1163 to offer OLI to their customers as an option over Primary Rate 1164 Interface (PRI). Internet Service Providers (ISPs) can use OLI in 1165 addition to Called-Station-Id and Calling-Station-Id attributes to 1166 differentiate customer calls and to define different services. 1168 The Value field contains two octets (00 - 99). ANSI T1.113 and 1169 BELLCORE 394 can be used for additional information about these 1170 values and their use. For information on the currently assigned 1171 values, see [ANITypes]. 1173 4.2.9. Reply-Message AVP 1175 The Reply-Message AVP (AVP Code 18) is of type UTF8String and 1176 contains text that MAY be displayed to the user. When used in an AA- 1177 Answer message with a successful Result-Code AVP, it indicates 1178 success. When found in an AAA message with a Result-Code other than 1179 DIAMETER_SUCCESS, the AVP contains a failure message. 1181 The Reply-Message AVP MAY contain text to prompt the user before 1182 another AA-Request attempt. When used in an AA-Answer message 1183 containing a Result-Code AVP with the value DIAMETER_MULTI_ROUND_AUTH 1184 or in an Re-Auth-Request message, it MAY contain text to prompt the 1185 user for a response. 1187 4.3. NAS Authentication AVPs 1189 This section defines the AVPs necessary to carry the authentication 1190 information in the Diameter protocol. The functionality defined here 1191 provides a RADIUS-like AAA service [RFC2865] over a more reliable and 1192 secure transport, as defined in the base protocol 1193 [I-D.ietf-dime-rfc3588bis]. 1195 The following table gives the possible flag values for the session 1196 level AVPs and specifies whether the AVP MAY be encrypted. 1198 +----------+ 1199 | AVP Flag | 1200 | rules | 1201 |----+-----| 1202 |MUST| MUST| 1203 Attribute Name Section Defined | | NOT| 1204 -----------------------------------------|----+-----| 1205 User-Password 4.3.1 | M | V | 1206 Password-Retry 4.3.2 | M | V | 1207 Prompt 4.3.3 | M | V | 1208 CHAP-Auth 4.3.4 | M | V | 1209 CHAP-Algorithm 4.3.5 | M | V | 1210 CHAP-Ident 4.3.6 | M | V | 1211 CHAP-Response 4.3.7 | M | V | 1212 CHAP-Challenge 4.3.8 | M | V | 1213 ARAP-Password 4.3.9 | M | V | 1214 ARAP-Challenge-Response 4.3.10 | M | V | 1215 ARAP-Security 4.3.11 | M | V | 1216 ARAP-Security-Data 4.3.12 | M | V | 1217 -----------------------------------------|----+-----| 1219 4.3.1. User-Password AVP 1221 The User-Password AVP (AVP Code 2) is of type OctetString and 1222 contains the password of the user to be authenticated, or the user's 1223 input in a multi-round authentication exchange. 1225 The User-Password AVP contains a user password or one-time password 1226 and therefore represents sensitive information. As required in 1227 [I-D.ietf-dime-rfc3588bis], Diameter messages are encrypted by using 1228 IPsec [RFC4301] or TLS [RFC5246]. Unless this AVP is used for one- 1229 time passwords, the User-Password AVP SHOULD NOT be used in untrusted 1230 proxy environments without encrypting it by using end-to-end security 1231 techniques. 1233 The clear-text password (prior to encryption) MUST NOT be longer than 1234 128 bytes in length. 1236 4.3.2. Password-Retry AVP 1238 The Password-Retry AVP (AVP Code 75) is of type Unsigned32 and MAY be 1239 included in the AA-Answer if the Result-Code indicates an 1240 authentication failure. The value of this AVP indicates how many 1241 authentication attempts a user is permitted before being 1242 disconnected. This AVP is primarily intended for use when the 1243 Framed-Protocol AVP (Section 4.4.10.1) is set to ARAP. 1245 4.3.3. Prompt AVP 1247 The Prompt AVP (AVP Code 76) is of type Enumerated and MAY be present 1248 in the AA-Answer message. When present, it is used by the NAS to 1249 determine whether the user's response, when entered, should be 1250 echoed. 1252 The supported values are listed in [RADIUSTypes] 1254 4.3.4. CHAP-Auth AVP 1256 The CHAP-Auth AVP (AVP Code 402) is of type Grouped and contains the 1257 information necessary to authenticate a user using the PPP Challenge- 1258 Handshake Authentication Protocol (CHAP) [RFC1994]. If the CHAP-Auth 1259 AVP is found in a message, the CHAP-Challenge AVP Section 4.3.8 MUST 1260 be present as well. The optional AVPs containing the CHAP response 1261 depend upon the value of the CHAP-Algorithm AVP Section 4.3.8. The 1262 grouped AVP has the following ABNF grammar: 1264 CHAP-Auth ::= < AVP Header: 402 > 1265 { CHAP-Algorithm } 1266 { CHAP-Ident } 1267 [ CHAP-Response ] 1268 * [ AVP ] 1270 4.3.5. CHAP-Algorithm AVP 1272 The CHAP-Algorithm AVP (AVP Code 403) is of type Enumerated and 1273 contains the algorithm identifier used in the computation of the CHAP 1274 response [RFC1994]. The following values are currently supported: 1276 CHAP with MD5 5 The CHAP response is computed by using the procedure 1277 described in [RFC1994] This algorithm requires that the CHAP- 1278 Response AVP Section 4.3.7 MUST be present in the CHAP-Auth AVP 1279 Section 4.3.4. 1281 4.3.6. CHAP-Ident AVP 1283 The CHAP-Ident AVP (AVP Code 404) is of type OctetString and contains 1284 the 1 octet CHAP Identifier used in the computation of the CHAP 1285 response [RFC1994] 1287 4.3.7. CHAP-Response AVP 1289 The CHAP-Response AVP (AVP Code 405) is of type OctetString and 1290 contains the 16 octet authentication data provided by the user in 1291 response to the CHAP challenge [RFC1994]. 1293 4.3.8. CHAP-Challenge AVP 1295 The CHAP-Challenge AVP (AVP Code 60) is of type OctetString and 1296 contains the CHAP Challenge sent by the NAS to the CHAP peer 1297 [RFC1994]. 1299 4.3.9. ARAP-Password AVP 1301 The ARAP-Password AVP (AVP Code 70) is of type OctetString and is 1302 only present when the Framed-Protocol AVP (Section 4.4.10.1) is 1303 included in the message and is set to ARAP. This AVP MUST NOT be 1304 present if either the User-Password or the CHAP-Auth AVP is present. 1305 See [RFC2869] for more information on the contents of this AVP. 1307 4.3.10. ARAP-Challenge-Response AVP 1309 The ARAP-Challenge-Response AVP (AVP Code 84) is of type OctetString 1310 and is only present when the Framed-Protocol AVP (Section 4.4.10.1) 1311 is included in the message and is set to ARAP. This AVP contains an 1312 8 octet response to the dial-in client's challenge. The Diameter 1313 server calculates this value by taking the dial-in client's challenge 1314 from the high-order 8 octets of the ARAP-Password AVP and performing 1315 DES encryption on this value with the authenticating user's password 1316 as the key. If the user's password is fewer than 8 octets in length, 1317 the password is padded at the end with NULL octets to a length of 8 1318 before it is used as a key. 1320 4.3.11. ARAP-Security AVP 1322 The ARAP-Security AVP (AVP Code 73) is of type Unsigned32 and MAY be 1323 present in the AA-Answer message if the Framed-Protocol AVP 1324 (Section 4.4.10.1) is set to the value of ARAP, and the Result-Code 1325 AVP ([I-D.ietf-dime-rfc3588bis], Section 7.1) is set to 1326 DIAMETER_MULTI_ROUND_AUTH. See [RFC2869] for more information on the 1327 contents of this AVP. 1329 4.3.12. ARAP-Security-Data AVP 1331 The ARAP-Security-Data AVP (AVP Code 74) is of type OctetString and 1332 MAY be present in the AA-Request or AA-Answer message if the Framed- 1333 Protocol AVP (Section 4.4.10.1) is set to the value of ARAP and the 1334 Result-Code AVP ([I-D.ietf-dime-rfc3588bis], Section 7.1) is set to 1335 DIAMETER_MULTI_ROUND_AUTH. This AVP contains the security module 1336 challenge or response associated with the ARAP Security Module 1337 specified in the ARAP-Security AVP (Section 4.3.11). 1339 4.4. NAS Authorization AVPs 1341 This section contains the authorization AVPs supported in the NAS 1342 Application. The Service-Type AVP SHOULD be present in all messages 1343 and, based on its value, additional AVPs defined in this section and 1344 Section 4.5 MAY be present. 1346 The following table gives the possible flag values for the session 1347 level AVPs and specifies whether the AVP MAY be encrypted. 1349 +----------+ 1350 | AVP Flag | 1351 | rules | 1352 |----+-----| 1353 |MUST| MUST| 1354 Attribute Name Section Defined | | NOT| 1355 -----------------------------------------|----+-----| 1356 Service-Type 4.4.1 | M | V | 1357 Callback-Number 4.4.2 | M | V | 1358 Callback-Id 4.4.3 | M | V | 1359 Idle-Timeout 4.4.4 | M | V | 1360 Port-Limit 4.4.5 | M | V | 1361 NAS-Filter-Rule 4.4.6 | M | V | 1362 Filter-Id 4.4.7 | M | V | 1363 Configuration-Token 4.4.8 | M | P,V | 1364 QoS-Filter-Rule 4.4.9 | | | 1365 Framed-Protocol 4.4.10.1 | M | V | 1366 Framed-Routing 4.4.10.2 | M | V | 1367 Framed-MTU 4.4.10.3 | M | V | 1368 Framed-Compression 4.4.10.4 | M | V | 1369 Framed-IP-Address 4.4.10.5.1 | M | V | 1370 Framed-IP-Netmask 4.4.10.5.2 | M | V | 1371 Framed-Route 4.4.10.5.3 | M | V | 1372 Framed-Pool 4.4.10.5.4 | M | V | 1373 Framed-Interface-Id 4.4.10.5.5 | M | V | 1374 Framed-IPv6-Prefix 4.4.10.5.6 | M | V | 1375 Framed-IPv6-Route 4.4.10.5.7 | M | V | 1376 Framed-IPv6-Pool 4.4.10.5.8 | M | V | 1377 Framed-IPX-Network 4.4.10.6.1 | M | V | 1378 Framed-Appletalk-Link 4.4.10.7.1 | M | V | 1379 Framed-Appletalk-Network 4.4.10.7.2 | M | V | 1380 Framed-Appletalk-Zone 4.4.10.7.3 | M | V | 1381 ARAP-Features 4.4.10.8.1 | M | V | 1382 ARAP-Zone-Access 4.4.10.8.2 | M | V | 1383 Login-IP-Host 4.4.11.1 | M | V | 1384 Login-IPv6-Host 4.4.11.2 | M | V | 1385 Login-Service 4.4.11.3 | M | V | 1386 Login-TCP-Port 4.4.11.4.1 | M | V | 1387 Login-LAT-Service 4.4.11.5.1 | M | V | 1388 Login-LAT-Node 4.4.11.5.2 | M | V | 1389 Login-LAT-Group 4.4.11.5.3 | M | V | 1390 Login-LAT-Port 4.4.11.5.4 | M | V | 1391 -----------------------------------------|----+-----| 1393 4.4.1. Service-Type AVP 1395 The Service-Type AVP (AVP Code 6) is of type Enumerated and contains 1396 the type of service the user has requested or the type of service to 1397 be provided. One such AVP MAY be present in an authentication and/or 1398 authorization request or response. A NAS is not required to 1399 implement all of these service types. It MUST treat unknown or 1400 unsupported Service-Types received in a response as a failure and end 1401 the session with a DIAMETER_INVALID_AVP_VALUE Result-Code. 1403 When used in a request, the Service-Type AVP SHOULD be considered a 1404 hint to the server that the NAS believes the user would prefer the 1405 kind of service indicated. The server is not required to honor the 1406 hint. Furthermore, if the service specified by the server is 1407 supported, but not compatible with the current mode of access, the 1408 NAS MUST fail to start the session. The NAS MUST also generate the 1409 appropriate error message(s). 1411 The complete list of defined values that the Service-Type AVP can 1412 take can be found in [RFC2865] and [RADIUSTypes], but the following 1413 values require further qualification here: 1415 Login (1) 1416 The user should be connected to a host. The message MAY 1417 include additional AVPs as defined in Section 4.4.11.4 or 1418 Section 4.4.11.5. 1420 Framed (2) 1421 A Framed Protocol, such as PPP or SLIP, should be started for 1422 the User. The message MAY include additional AVPs defined in 1423 Section 4.4.10, or Section 4.5 for tunneling services. 1425 Callback Login (3) 1426 The user should be disconnected and called back, then connected 1427 to a host. The message MAY include additional AVPs defined in 1428 this Section. 1430 Callback Framed (4) 1431 The user should be disconnected and called back, and then a 1432 Framed Protocol, such as PPP or SLIP, should be started for the 1433 User. The message MAY include additional AVPs defined in 1434 Section 4.4.10, or Section 4.5 for tunneling services. 1436 4.4.2. Callback-Number AVP 1438 The Callback-Number AVP (AVP Code 19) is of type UTF8String and 1439 contains a dialing string to be used for callback. It MAY be used in 1440 an authentication and/or authorization request as a hint to the 1441 server that a Callback service is desired, but the server is not 1442 required to honor the hint in the corresponding response. 1444 The codification of this field's allowed usage range is outside the 1445 scope of this specification. 1447 4.4.3. Callback-Id AVP 1449 The Callback-Id AVP (AVP Code 20) is of type UTF8String and contains 1450 the name of a place to be called, to be interpreted by the NAS. This 1451 AVP MAY be present in an authentication and/or authorization 1452 response. 1454 This AVP is not roaming-friendly as it assumes that the Callback-Id 1455 is configured on the NAS. Using the Callback-Number AVP 1456 Section 4.4.2 is therefore preferable. 1458 4.4.4. Idle-Timeout AVP 1460 The Idle-Timeout AVP (AVP Code 28) is of type Unsigned32 and sets the 1461 maximum number of consecutive seconds of idle connection allowable to 1462 the user before termination of the session or before a prompt is 1463 issued. The default is none, or system specific. 1465 4.4.5. Port-Limit AVP 1467 The Port-Limit AVP (AVP Code 62) is of type Unsigned32 and sets the 1468 maximum number of ports the NAS provides to the user. It MAY be used 1469 in an authentication and/or authorization request as a hint to the 1470 server that multilink PPP [RFC1990] service is desired, but the 1471 server is not required to honor the hint in the corresponding 1472 response. 1474 4.4.6. NAS-Filter-Rule AVP 1476 The NAS-Filter-Rule AVP (AVP Code 400) is of type IPFilterRule and 1477 provides filter rules that need to be configured on the NAS for the 1478 user. One or more of these AVPs MAY be present in an authorization 1479 response. 1481 4.4.7. Filter-Id AVP 1483 The Filter-Id AVP (AVP Code 11) is of type UTF8String and contains 1484 the name of the filter list for this user. Zero or more Filter-Id 1485 AVPs MAY be sent in an authorization answer. 1487 Identifying a filter list by name allows the filter to be used on 1488 different NASes without regard to filter-list implementation details. 1489 However, this AVP is not roaming-friendly, as filter naming differs 1490 from one service provider to another. 1492 In environments where backward compatibility with RADIUS is not 1493 required, it is RECOMMENDED that the NAS-Filter-Rule AVP 1494 Section 4.4.6 be used instead. 1496 4.4.8. Configuration-Token AVP 1498 The Configuration-Token AVP (AVP Code 78) is of type OctetString and 1499 is sent by a Diameter Server to a Diameter Proxy Agent in an AA- 1500 Answer command to indicate a type of user profile to be used. It 1501 should not be sent to a Diameter Client (NAS). 1503 The format of the Data field of this AVP is site specific. 1505 4.4.9. QoS-Filter-Rule AVP 1507 The QoS-Filter-Rule AVP (AVP Code 407) is of type QoSFilterRule 1508 Section 4.1.1 and provides QoS filter rules that need to be 1509 configured on the NAS for the user. One or more such AVPs MAY be 1510 present in an authorization response. 1512 DSCP If action is set to tag Section 4.1.1 this option MUST 1513 be included in the rule. 1515 Color values are defined in [RFC2474]. Exact matching of DSCP 1516 values is required (no masks or ranges). 1518 metering The metering option 1519 provides Assured Forwarding, as defined in [RFC2597]. and MUST 1520 be present if the action is set to meter Section 4.1.1 The rate 1521 option is the throughput, in bits per second, used by the 1522 access device to mark packets. Traffic over the rate is marked 1523 with the color_over codepoint, and traffic under the rate is 1524 marked with the color_under codepoint. The color_under and 1525 color_over options contain the drop preferences and MUST 1526 conform to the recommended codepoint keywords described in 1527 [RFC2597] (e.g., AF13). 1529 The metering option also supports the strict limit on traffic 1530 required by Expedited Forwarding, as defined in [RFC3246]. The 1531 color_over option may contain the keyword "drop" to prevent 1532 forwarding of traffic that exceeds the rate parameter. 1534 4.4.10. Framed Access Authorization AVPs 1536 This section lists the authorization AVPs necessary to support framed 1537 access, such as PPP and SLIP. AVPs defined in this section MAY be 1538 present in a message if the Service-Type AVP was set to "Framed" or 1539 "Callback Framed". 1541 4.4.10.1. Framed-Protocol AVP 1543 The Framed-Protocol AVP (AVP Code 7) is of type Enumerated and 1544 contains the framing to be used for framed access. This AVP MAY be 1545 present in both requests and responses. The supported values are 1546 listed in [RADIUSTypes]. 1548 4.4.10.2. Framed-Routing AVP 1550 The Framed-Routing AVP (AVP Code 10) is of type Enumerated and 1551 contains the routing method for the user when the user is a router to 1552 a network. This AVP SHOULD only be present in authorization 1553 responses. The supported values are listed in [RADIUSTypes]. 1555 4.4.10.3. Framed-MTU AVP 1557 The Framed-MTU AVP (AVP Code 12) is of type Unsigned32 and contains 1558 the Maximum Transmission Unit (MTU) to be configured for the user, 1559 when it is not negotiated by some other means (such as PPP). This 1560 AVP SHOULD only be present in authorization responses. The MTU value 1561 MUST be in the range from 64 to 65535. 1563 4.4.10.4. Framed-Compression AVP 1565 The Framed-Compression AVP (AVP Code 13) is of type Enumerated and 1566 contains the compression protocol to be used for the link. It MAY be 1567 used in an authorization request as a hint to the server that a 1568 specific compression type is desired, but the server is not required 1569 to honor the hint in the corresponding response. 1571 More than one compression protocol AVP MAY be sent. The NAS is 1572 responsible for applying the proper compression protocol to the 1573 appropriate link traffic. 1575 The supported values are listed in [RADIUSTypes]. 1577 4.4.10.5. IP Access Authorization AVPs 1579 The AVPs defined in this section are used when the user requests, or 1580 is being granted, access service to IP. 1582 4.4.10.5.1. Framed-IP-Address AVP 1584 The Framed-IP-Address AVP (AVP Code 8) [RFC2865] is of type 1585 OctetString and contains an IPv4 address of the type specified in the 1586 attribute value to be configured for the user. It MAY be used in an 1587 authorization request as a hint to the server that a specific address 1588 is desired, but the server is not required to honor the hint in the 1589 corresponding response. 1591 Two values have special significance: 0xFFFFFFFF and 0xFFFFFFFE. The 1592 value 0xFFFFFFFF indicates that the NAS should allow the user to 1593 select an address (i.e., negotiated). The value 0xFFFFFFFE indicates 1594 that the NAS should select an address for the user (e.g., assigned 1595 from a pool of addresses kept by the NAS). 1597 4.4.10.5.2. Framed-IP-Netmask AVP 1599 The Framed-IP-Netmask AVP (AVP Code 9) is of type OctetString and 1600 contains the four octets of the IPv4 netmask to be configured for the 1601 user when the user is a router to a network. It MAY be used in an 1602 authorization request as a hint to the server that a specific netmask 1603 is desired, but the server is not required to honor the hint in the 1604 corresponding response. This AVP MUST be present in a response if 1605 the request included this AVP with a value of 0xFFFFFFFF. 1607 4.4.10.5.3. Framed-Route AVP 1609 The Framed-Route AVP (AVP Code 22) is of type UTF8String and contains 1610 the ASCII routing information to be configured for the user on the 1611 NAS. Zero or more of these AVPs MAY be present in an authorization 1612 response. 1614 The string MUST contain a destination prefix in dotted quad form 1615 optionally followed by a slash and a decimal length specifier stating 1616 how many high-order bits of the prefix should be used. This is 1617 followed by a space, a gateway address in dotted quad form, a space, 1618 and one or more metrics separated by spaces; for example, 1620 "192.0.2.0/24 192.0.2.1 1" 1622 The length specifier may be omitted, in which case it should default 1623 to 8 bits for class A prefixes, to 16 bits for class B prefixes, and 1624 to 24 bits for class C prefixes; for example, 1626 "192.0.2.0 192.0.2.1 1" 1628 Whenever the gateway address is specified as "0.0.0.0" the IP address 1629 of the user SHOULD be used as the gateway address. 1631 4.4.10.5.4. Framed-Pool AVP 1633 The Framed-Pool AVP (AVP Code 88) is of type OctetString and contains 1634 the name of an assigned address pool that SHOULD be used to assign an 1635 address for the user. If a NAS does not support multiple address 1636 pools, the NAS SHOULD ignore this AVP. Address pools are usually 1637 used for IP addresses but can be used for other protocols if the NAS 1638 supports pools for those protocols. 1640 Although specified as type OctetString for compatibility with RADIUS 1641 [RFC2865], the encoding of the Data field SHOULD also conform to the 1642 rules for the UTF8String Data Format. 1644 4.4.10.5.5. Framed-Interface-Id AVP 1646 The Framed-Interface-Id AVP (AVP Code 96) is of type Unsigned64 and 1647 contains the IPv6 interface identifier to be configured for the user. 1648 It MAY be used in authorization requests as a hint to the server that 1649 a specific interface id is desired, but the server is not required to 1650 honor the hint in the corresponding response. 1652 4.4.10.5.6. Framed-IPv6-Prefix AVP 1654 The Framed-IPv6-Prefix AVP (AVP Code 97) is of type OctetString and 1655 contains the IPv6 prefix to be configured for the user. One or more 1656 AVPs MAY be used in authorization requests as a hint to the server 1657 that specific IPv6 prefixes are desired, but the server is not 1658 required to honor the hint in the corresponding response. 1660 4.4.10.5.7. Framed-IPv6-Route AVP 1662 The Framed-IPv6-Route AVP (AVP Code 99) is of type UTF8String and 1663 contains the ASCII routing information to be configured for the user 1664 on the NAS. Zero or more of these AVPs MAY be present in an 1665 authorization response. 1667 The string MUST contain an IPv6 address prefix followed by a slash 1668 and a decimal length specifier stating how many high order bits of 1669 the prefix should be used. This is followed by a space, a gateway 1670 address in hexadecimal notation, a space, and one or more metrics 1671 separated by spaces; for example, 1673 "2001:db8::/32 2001:db8:106:a00:20ff:fe99:a998 1" 1675 Whenever the gateway address is the IPv6 unspecified address, the IP 1676 address of the user SHOULD be used as the gateway address, such as 1677 in: 1679 "2001:db8::/32 :: 1" 1681 4.4.10.5.8. Framed-IPv6-Pool AVP 1683 The Framed-IPv6-Pool AVP (AVP Code 100) is of type OctetString and 1684 contains the name of an assigned pool that SHOULD be used to assign 1685 an IPv6 prefix for the user. If the access device does not support 1686 multiple prefix pools, it MUST ignore this AVP. 1688 Although specified as type OctetString for compatibility with RADIUS 1689 [RFC3162], the encoding of the Data field SHOULD also conform to the 1690 rules for the UTF8String Data Format. 1692 4.4.10.6. IPX Access AVPs 1694 The AVPs defined in this section are used when the user requests, or 1695 is being granted, access to an IPX network service [IPX]. 1697 4.4.10.6.1. Framed-IPX-Network AVP 1699 The Framed-IPX-Network AVP (AVP Code 23) is of type Unsigned32 and 1700 contains the IPX Network number to be configured for the user. It 1701 MAY be used in an authorization request as a hint to the server that 1702 a specific address is desired, but the server is not required to 1703 honor the hint in the corresponding response. 1705 Two addresses have special significance: 0xFFFFFFFF and 0xFFFFFFFE. 1706 The value 0xFFFFFFFF indicates that the NAS should allow the user to 1707 select an address (i.e., Negotiated). The value 0xFFFFFFFE indicates 1708 that the NAS should select an address for the user (e.g., assign it 1709 from a pool of one or more IPX networks kept by the NAS). 1711 4.4.10.7. AppleTalk Network Access AVPs 1713 The AVPs defined in this section are used when the user requests, or 1714 is being granted, access to an AppleTalk network [AppleTalk]. 1716 4.4.10.7.1. Framed-AppleTalk-Link AVP 1718 The Framed-AppleTalk-Link AVP (AVP Code 37) is of type Unsigned32 and 1719 contains the AppleTalk network number that should be used for the 1720 serial link to the user, which is another AppleTalk router. This AVP 1721 MUST only be present in an authorization response and is never used 1722 when the user is not another router. 1724 Despite the size of the field, values range from 0 to 65,535. The 1725 special value of 0 indicates an unnumbered serial link. A value of 1 1726 to 65,535 means that the serial line between the NAS and the user 1727 should be assigned that value as an AppleTalk network number. 1729 4.4.10.7.2. Framed-AppleTalk-Network AVP 1731 The Framed-AppleTalk-Network AVP (AVP Code 38) is of type Unsigned32 1732 and contains the AppleTalk Network number that the NAS should probe 1733 to allocate an AppleTalk node for the user. This AVP MUST only be 1734 present in an authorization response and is never used when the user 1735 is not another router. Multiple instances of this AVP indicate that 1736 the NAS may probe, using any of the network numbers specified. 1738 Despite the size of the field, values range from 0 to 65,535. The 1739 special value 0 indicates that the NAS should assign a network for 1740 the user, using its default cable range. A value between 1 and 1741 65,535 (inclusive) indicates to the AppleTalk Network that the NAS 1742 should probe to find an address for the user. 1744 4.4.10.7.3. Framed-AppleTalk-Zone AVP 1746 The Framed-AppleTalk-Zone AVP (AVP Code 39) is of type OctetString 1747 and contains the AppleTalk Default Zone to be used for this user. 1748 This AVP MUST only be present in an authorization response. Multiple 1749 instances of this AVP in the same message are not allowed. 1751 The codification of this field's allowed range is outside the scope 1752 of this specification. 1754 4.4.10.8. AppleTalk Remote Access AVPs 1756 The AVPs defined in this section are used when the user requests, or 1757 is being granted, access to the AppleTalk network via the AppleTalk 1758 Remote Access Protocol [ARAP]. They are only present if the Framed- 1759 Protocol AVP Section 4.4.10.1 is set to ARAP. Section 2.2 of RFC 1760 2869 [RFC2869] describes the operational use of these attributes. 1762 4.4.10.8.1. ARAP-Features AVP 1764 The ARAP-Features AVP (AVP Code 71) is of type OctetString and MAY be 1765 present in the AA-Accept message if the Framed-Protocol AVP is set to 1766 the value of ARAP. See [RFC2869] for more information about the 1767 format of this AVP. 1769 4.4.10.8.2. ARAP-Zone-Access AVP 1771 The ARAP-Zone-Access AVP (AVP Code 72) is of type Enumerated and MAY 1772 be present in the AA-Accept message if the Framed-Protocol AVP is set 1773 to the value of ARAP. 1775 The supported values are listed in [RADIUSTypes] and defined in 1776 [RFC2869]. 1778 4.4.11. Non-Framed Access Authorization AVPs 1780 This section contains the authorization AVPs that are needed to 1781 support terminal server functionality. AVPs defined in this section 1782 MAY be present in a message if the Service-Type AVP was set to 1783 "Login" or "Callback Login". 1785 4.4.11.1. Login-IP-Host AVP 1787 The Login-IP-Host AVP (AVP Code 14) [RFC2865] is of type OctetString 1788 and contains the IPv4 address of a host with which to connect the 1789 user when the Login-Service AVP is included. It MAY be used in an 1790 AA-Request command as a hint to the Diameter Server that a specific 1791 host is desired, but the Diameter Server is not required to honor the 1792 hint in the AA-Answer. 1794 Two addresses have special significance: all ones and 0. The value 1795 of all ones indicates that the NAS SHOULD allow the user to select an 1796 address. The value 0 indicates that the NAS SHOULD select a host to 1797 connect the user to. 1799 4.4.11.2. Login-IPv6-Host AVP 1801 The Login-IPv6-Host AVP (AVP Code 98) [RFC3162] is of type 1802 OctetString and contains the IPv6 address of a host with which to 1803 connect the user when the Login-Service AVP is included. It MAY be 1804 used in an AA-Request command as a hint to the Diameter Server that a 1805 specific host is desired, but the Diameter Server is not required to 1806 honor the hint in the AA-Answer. 1808 Two addresses have special significance, 1809 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF and 0. The value 1810 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF indicates that the NAS SHOULD 1811 allow the user to select an address. The value 0 indicates that the 1812 NAS SHOULD select a host to connect the user to. 1814 4.4.11.3. Login-Service AVP 1816 The Login-Service AVP (AVP Code 15) is of type Enumerated and 1817 contains the service that should be used to connect the user to the 1818 login host. This AVP SHOULD only be present in authorization 1819 responses. The supported values are listed in [RFC2869]. 1821 4.4.11.4. TCP Services 1823 The AVP described in the following section MAY be present if the 1824 Login-Service AVP is set to Telnet, Rlogin, TCP Clear, or TCP Clear 1825 Quiet. 1827 4.4.11.4.1. Login-TCP-Port AVP 1829 The Login-TCP-Port AVP (AVP Code 16) is of type Unsigned32 and 1830 contains the TCP port with which the user is to be connected when the 1831 Login-Service AVP is also present. This AVP SHOULD only be present 1832 in authorization responses. The value MUST NOT be greater than 1833 65,535. 1835 4.4.11.5. LAT Services 1837 The AVPs described in this section MAY be present if the Login- 1838 Service AVP is set to LAT [LAT]. 1840 4.4.11.5.1. Login-LAT-Service AVP 1842 The Login-LAT-Service AVP (AVP Code 34) is of type OctetString and 1843 contains the system with which the user is to be connected by LAT. 1844 It MAY be used in an authorization request as a hint to the server 1845 that a specific service is desired, but the server is not required to 1846 honor the hint in the corresponding response. This AVP MUST only be 1847 present in the response if the Login-Service AVP states that LAT is 1848 desired. 1850 Administrators use this service attribute when dealing with clustered 1851 systems. In these environments, several different time-sharing hosts 1852 share the same resources (disks, printers, etc.), and administrators 1853 often configure each host to offer access (service) to each of the 1854 shared resources. In this case, each host in the cluster advertises 1855 its services through LAT broadcasts. 1857 Sophisticated users often know which service providers (machines) are 1858 faster and tend to use a node name when initiating a LAT connection. 1859 Some administrators want particular users to use certain machines as 1860 a primitive form of load balancing (although LAT knows how to do load 1861 balancing itself). 1863 The String field contains the identity of the LAT service to use. 1864 The LAT Architecture allows this string to contain $ (dollar), - 1865 (hyphen), . (period), _ (underscore), numerics, upper- and lowercase 1866 alphabetics, and the ISO Latin-1 character set extension 1867 [ISO.8859-1.1987]. All LAT string comparisons are case insensitive. 1869 4.4.11.5.2. Login-LAT-Node AVP 1871 The Login-LAT-Node AVP (AVP Code 35) is of type OctetString and 1872 contains the Node with which the user is to be automatically 1873 connected by LAT. It MAY be used in an authorization request as a 1874 hint to the server that a specific LAT node is desired, but the 1875 server is not required to honor the hint in the corresponding 1876 response. This AVP MUST only be present in a response if the Login- 1877 Service-Type AVP is set to LAT. 1879 The String field contains the identity of the LAT service to use. 1880 The LAT Architecture allows this string to contain $ (dollar), - 1881 (hyphen), . (period), _ (underscore), numerics, upper- and lowercase 1882 alphabetics, and the ISO Latin-1 character set extension 1883 [ISO.8859-1.1987]. All LAT string comparisons are case insensitive. 1885 4.4.11.5.3. Login-LAT-Group AVP 1887 The Login-LAT-Group AVP (AVP Code 36) is of type OctetString and 1888 contains a string identifying the LAT group codes this user is 1889 authorized to use. It MAY be used in an authorization request as a 1890 hint to the server that a specific group is desired, but the server 1891 is not required to honor the hint in the corresponding response. 1892 This AVP MUST only be present in a response if the Login-Service-Type 1893 AVP is set to LAT. 1895 LAT supports 256 different group codes, which LAT uses as a form of 1896 access rights. LAT encodes the group codes as a 256-bit bitmap. 1898 Administrators can assign one or more of the group code bits at the 1899 LAT service provider; it will only accept LAT connections that have 1900 these group codes set in the bitmap. The administrators assign a 1901 bitmap of authorized group codes to each user. LAT gets these from 1902 the operating system and uses them in its requests to the service 1903 providers. 1905 The codification of the range of allowed usage of this field is 1906 outside the scope of this specification. 1908 4.4.11.5.4. Login-LAT-Port AVP 1910 The Login-LAT-Port AVP (AVP Code 63) is of type OctetString and 1911 contains the Port with which the user is to be connected by LAT. It 1912 MAY be used in an authorization request as a hint to the server that 1913 a specific port is desired, but the server is not required to honor 1914 the hint in the corresponding response. This AVP MUST only be 1915 present in a response if the Login-Service-Type AVP is set to LAT. 1917 The String field contains the identity of the LAT service to use. 1918 The LAT Architecture allows this string to contain $ (dollar), - 1919 (hyphen), . (period), _ (underscore), numerics, upper- and lower-case 1920 alphabetics, and the ISO Latin-1 character set extension 1921 [ISO.8859-1.1987]. 1923 All LAT string comparisons are case insensitive. 1925 4.5. NAS Tunneling AVPs 1927 Some NASes support compulsory tunnel services in which the incoming 1928 connection data is conveyed by an encapsulation method to a gateway 1929 elsewhere in the network. This is typically transparent to the 1930 service user, and the tunnel characteristics may be described by the 1931 remote AAA server, based on the user's authorization information. 1932 Several tunnel characteristics may be returned, and the NAS 1933 implementation may choose one. See [RFC2868] and [RFC2867] for 1934 further information. 1936 The following table gives the possible flag values for the session 1937 level AVPs and specifies whether the AVP MAY be encrypted. 1939 +----------+ 1940 | AVP Flag | 1941 | rules | 1942 |----+-----| 1943 |MUST| MUST| 1944 Attribute Name Section Defined | | NOT | 1945 -----------------------------------------|----+-----| 1946 Tunneling 4.5.1 | M | V | 1947 Tunnel-Type 4.5.2 | M | V | 1948 Tunnel-Medium-Type 4.5.3 | M | V | 1949 Tunnel-Client-Endpoint 4.5.4 | M | V | 1950 Tunnel-Server-Endpoint 4.5.5 | M | V | 1951 Tunnel-Password 4.5.6 | M | V | 1952 Tunnel-Private-Group-Id 4.5.7 | M | V | 1953 Tunnel-Assignment-Id 4.5.8 | M | V | 1954 Tunnel-Preference 4.5.9 | M | V | 1955 Tunnel-Client-Auth-Id 4.5.10 | M | V | 1956 Tunnel-Server-Auth-Id 4.5.11 | M | V | 1957 -----------------------------------------|----+-----| 1959 4.5.1. Tunneling AVP 1961 The Tunneling AVP (AVP Code 401) is of type Grouped and contains the 1962 following AVPs, used to describe a compulsory tunnel service 1963 ([RFC2868], [RFC2867]). Its data field has the following ABNF 1964 grammar: 1966 Tunneling ::= < AVP Header: 401 > 1967 { Tunnel-Type } 1968 { Tunnel-Medium-Type } 1969 { Tunnel-Client-Endpoint } 1970 { Tunnel-Server-Endpoint } 1971 [ Tunnel-Preference ] 1972 [ Tunnel-Client-Auth-Id ] 1973 [ Tunnel-Server-Auth-Id ] 1974 [ Tunnel-Assignment-Id ] 1975 [ Tunnel-Password ] 1976 [ Tunnel-Private-Group-Id ] 1978 4.5.2. Tunnel-Type AVP 1980 The Tunnel-Type AVP (AVP Code 64) is of type Enumerated and contains 1981 the tunneling protocol(s) to be used (in the case of a tunnel 1982 initiator) or in use (in the case of a tunnel terminator). It MAY be 1983 used in an authorization request as a hint to the server that a 1984 specific tunnel type is desired, but the server is not required to 1985 honor the hint in the corresponding response. 1987 The Tunnel-Type AVP SHOULD also be included in ACR messages. 1989 A tunnel initiator is not required to implement any of these tunnel 1990 types. If a tunnel initiator receives a response that contains only 1991 unknown or unsupported Tunnel-Types, the tunnel initiator MUST behave 1992 as though a response were received with the Result-Code indicating a 1993 failure. 1995 The supported values are listed in [RADIUSTypes]. 1997 4.5.3. Tunnel-Medium-Type AVP 1999 The Tunnel-Medium-Type AVP (AVP Code 65) is of type Enumerated and 2000 contains the transport medium to use when creating a tunnel for 2001 protocols (such as L2TP [RFC3931]) that can operate over multiple 2002 transports. It MAY be used in an authorization request as a hint to 2003 the server that a specific medium is desired, but the server is not 2004 required to honor the hint in the corresponding response. 2006 The supported values are listed in [RADIUSTypes]. 2008 4.5.4. Tunnel-Client-Endpoint AVP 2010 The Tunnel-Client-Endpoint AVP (AVP Code 66) is of type UTF8String 2011 and contains the address of the initiator end of the tunnel. It MAY 2012 be used in an authorization request as a hint to the server that a 2013 specific endpoint is desired, but the server is not required to honor 2014 the hint in the corresponding response. This AVP SHOULD be included 2015 in the corresponding ACR messages, in which case it indicates the 2016 address from which the tunnel was initiated. This AVP, along with 2017 the Tunnel-Server-Endpoint (Section 4.5.5) and Session-Id AVPs 2018 ([I-D.ietf-dime-rfc3588bis], Section 8.8), can be used to provide a 2019 globally unique means to identify a tunnel for accounting and 2020 auditingpurposes. 2022 If the value of the Tunnel-Medium-Type AVP (Section 4.5.3) is IPv4 2023 (1), then this string is either the fully qualified domain name 2024 (FQDN) of the tunnel client machine, or a "dotted-decimal" IP 2025 address. Implementations MUST support the dotted-decimal format and 2026 SHOULD support the FQDN format for IP addresses. 2028 If Tunnel-Medium-Type is IPv6 (2), then this string is either the 2029 FQDN of the tunnel client machine, or a text representation of the 2030 address in either the preferred or alternate form [RFC3516]. 2031 Conforming implementations MUST support the preferred form and SHOULD 2032 support both the alternate text form and the FQDN format for IPv6 2033 addresses. 2035 If Tunnel-Medium-Type is neither IPv4 nor IPv6, then this string is a 2036 tag referring to configuration data local to the Diameter client that 2037 describes the interface or medium-specific client address to use. 2039 4.5.5. Tunnel-Server-Endpoint AVP 2041 The Tunnel-Server-Endpoint AVP (AVP Code 67) is of type UTF8String 2042 and contains the address of the server end of the tunnel. It MAY be 2043 used in an authorization request as a hint to the server that a 2044 specific endpoint is desired, but the server is not required to honor 2045 the hint in the corresponding response. 2047 This AVP SHOULD be included in the corresponding ACR messages, in 2048 which case it indicates the address from which the tunnel was 2049 initiated. This AVP, along with the Tunnel-Client-Endpoint 2050 (Section 4.5.4) and Session-Id AVP ([I-D.ietf-dime-rfc3588bis], 2051 Section 8.8), can be used to provide a globally unique means to 2052 identify a tunnel for accounting and auditing purposes. 2054 If Tunnel-Medium-Type is IPv4 (1), then this string is either the 2055 fully qualified domain name (FQDN) of the tunnel server machine, or a 2056 "dotted-decimal" IP address. Implementations MUST support the 2057 dotted-decimal format and SHOULD support the FQDN format for IP 2058 addresses. 2060 If Tunnel-Medium-Type is IPv6 (2), then this string is either the 2061 FQDN of the tunnel server machine, or a text representation of the 2062 address in either the preferred or alternate form [RFC3516]. 2063 Implementations MUST support the preferred form and SHOULD support 2064 both the alternate text form and the FQDN format for IPv6 addresses. 2066 If Tunnel-Medium-Type is not IPv4 or IPv6, this string is a tag 2067 referring to configuration data local to the Diameter client that 2068 describes the interface or medium-specific server address to use. 2070 4.5.6. Tunnel-Password AVP 2072 The Tunnel-Password AVP (AVP Code 69) is of type OctetString and may 2073 contain a password to be used to authenticate to a remote server. 2075 The Tunnel-Password AVP SHOULD NOT be used in untrusted proxy 2076 environments without encrypting it by using end-to-end security 2077 techniques. 2079 4.5.7. Tunnel-Private-Group-Id AVP 2081 The Tunnel-Private-Group-Id AVP (AVP Code 81) is of type OctetString 2082 and contains the group Id for a particular tunneled session. The 2083 Tunnel-Private-Group-Id AVP MAY be included in an authorization 2084 request if the tunnel initiator can predetermine the group resulting 2085 from a particular connection. It SHOULD be included in the 2086 authorization response if this tunnel session is to be treated as 2087 belonging to a particular private group. Private groups may be used 2088 to associate a tunneled session with a particular group of users. 2089 For example, it MAY be used to facilitate routing of unregistered IP 2090 addresses through a particular interface. This AVP SHOULD be 2091 included in the ACR messages that pertain to the tunneled session. 2093 4.5.8. Tunnel-Assignment-Id AVP 2095 The Tunnel-Assignment-Id AVP (AVP Code 82) is of type OctetString and 2096 is used to indicate to the tunnel initiator the particular tunnel to 2097 which a session is to be assigned. Some tunneling protocols, such as 2098 PPTP [RFC2637] and L2TP [RFC3931], allow for sessions between the 2099 same two tunnel endpoints to be multiplexed over the same tunnel and 2100 also for a given session to use its own dedicated tunnel. This 2101 attribute provides a mechanism for Diameter to inform the tunnel 2102 initiator (e.g., PAC, LAC) whether to assign the session to a 2103 multiplexed tunnel or to a separate tunnel. Furthermore, it allows 2104 for sessions sharing multiplexed tunnels to be assigned to different 2105 multiplexed tunnels. 2107 A particular tunneling implementation may assign differing 2108 characteristics to particular tunnels. For example, different 2109 tunnels may be assigned different QoS parameters. Such tunnels may 2110 be used to carry either individual or multiple sessions. The Tunnel- 2111 Assignment-Id attribute thus allows the Diameter server to indicate 2112 that a particular session is to be assigned to a tunnel providing an 2113 appropriate level of service. It is expected that any QoS-related 2114 Diameter tunneling attributes defined in the future accompanying this 2115 one will be associated by the tunnel initiator with the Id given by 2116 this attribute. In the meantime, any semantic given to a particular 2117 Id string is a matter left to local configuration in the tunnel 2118 initiator. 2120 The Tunnel-Assignment-Id AVP is of significance only to Diameter and 2121 the tunnel initiator. The Id it specifies is only intended to be of 2122 local use to Diameter and the tunnel initiator. The Id assigned by 2123 the tunnel initiator is not conveyed to the tunnel peer. 2125 This attribute MAY be included in authorization responses. The 2126 tunnel initiator receiving this attribute MAY choose to ignore it and 2127 to assign the session to an arbitrary multiplexed or non-multiplexed 2128 tunnel between the desired endpoints. This AVP SHOULD also be 2129 included in the Accounting-Request messages pertaining to the 2130 tunneled session. 2132 If a tunnel initiator supports the Tunnel-Assignment-Id AVP, then it 2133 should assign a session to a tunnel in the following manner: 2135 o If this AVP is present and a tunnel exists between the specified 2136 endpoints with the specified Id, then the session should be 2137 assigned to that tunnel. 2139 o If this AVP is present and no tunnel exists between the specified 2140 endpoints with the specified Id, then a new tunnel should be 2141 established for the session and the specified Id should be 2142 associated with the new tunnel. 2144 o If this AVP is not present, then the session is assigned to an 2145 unnamed tunnel. If an unnamed tunnel does not yet exist between 2146 the specified endpoints, then it is established and used for this 2147 session and for subsequent ones established without the Tunnel- 2148 Assignment-Id attribute. A tunnel initiator MUST NOT assign a 2149 session for which a Tunnel-Assignment-Id AVP was not specified to 2150 a named tunnel (i.e., one that was initiated by a session 2151 specifying this AVP). 2153 Note that the same Id may be used to name different tunnels if these 2154 tunnels are between different endpoints. 2156 4.5.9. Tunnel-Preference AVP 2158 The Tunnel-Preference AVP (AVP Code 83) is of type Unsigned32 and is 2159 used to identify the relative preference assigned to each tunnel when 2160 more than one set of tunneling AVPs is returned within separate 2161 Grouped-AVP AVPs. It MAY be used in an authorization request as a 2162 hint to the server that a specific preference is desired, but the 2163 server is not required to honor the hint in the corresponding 2164 response. 2166 For example, suppose that AVPs describing two tunnels are returned by 2167 the server, one with a Tunnel-Type of PPTP and the other with a 2168 Tunnel-Type of L2TP. If the tunnel initiator supports only one of 2169 the Tunnel-Types returned, it will initiate a tunnel of that type. 2170 If, however, it supports both tunnel protocols, it SHOULD use the 2171 value of the Tunnel-Preference AVP to decide which tunnel should be 2172 started. The tunnel with the lowest numerical value in the Value 2173 field of this AVP SHOULD be given the highest preference. The values 2174 assigned to two or more instances of the Tunnel-Preference AVP within 2175 a given authorization response MAY be identical. In this case, the 2176 tunnel initiator SHOULD use locally configured metrics to decide 2177 which set of AVPs to use. 2179 4.5.10. Tunnel-Client-Auth-Id AVP 2181 The Tunnel-Client-Auth-Id AVP (AVP Code 90) is of type UTF8String and 2182 specifies the name used by the tunnel initiator during the 2183 authentication phase of tunnel establishment. It MAY be used in an 2184 authorization request as a hint to the server that a specific 2185 preference is desired, but the server is not required to honor the 2186 hint in the corresponding response. This AVP MUST be present in the 2187 authorization response if an authentication name other than the 2188 default is desired. This AVP SHOULD be included in the ACR messages 2189 pertaining to the tunneled session. 2191 4.5.11. Tunnel-Server-Auth-Id AVP 2193 The Tunnel-Server-Auth-Id AVP (AVP Code 91) is of type UTF8String and 2194 specifies the name used by the tunnel terminator during the 2195 authentication phase of tunnel establishment. It MAY be used in an 2196 authorization request as a hint to the server that a specific 2197 preference is desired, but the server is not required to honor the 2198 hint in the corresponding response. This AVP MUST be present in the 2199 authorization response if an authentication name other than the 2200 default is desired. This AVP SHOULD be included in the ACR messages 2201 pertaining to the tunneled session. 2203 4.6. NAS Accounting AVPs 2205 Applications implementing this specification use Diameter Accounting 2206 (as defined in [I-D.ietf-dime-rfc3588bis]) and the AVPs in the 2207 following section. Service-specific AVP usage is defined in the 2208 tables in Section 5. 2210 If accounting is active, Accounting Request (ACR) messages SHOULD be 2211 sent after the completion of any Authentication or Authorization 2212 transaction and at the end of a Session. The value of the 2213 Accounting-Record-Type AVP [I-D.ietf-dime-rfc3588bis] indicates the 2214 type of event. All other AVPs identify the session and provide 2215 additional information relevant to the event. 2217 The successful completion of the first Authentication or 2218 Authorization transaction SHOULD cause a START_RECORD to be sent. If 2219 additional Authentications or Authorizations occur in later 2220 transactions, the first exchange should generate a START_RECORD, and 2221 the later an INTERIM_RECORD. For a given session, there MUST only be 2222 one set of matching START and STOP records, with any number of 2223 INTERIM_RECORDS in between, or one EVENT_RECORD indicating the reason 2224 a session wasn't started. 2226 The following table gives the possible flag values for the session 2227 level AVPs and specifies whether the AVP MAY be encrypted. 2229 +----------+ 2230 | AVP Flag | 2231 | rules | 2232 |----+-----| 2233 Section |MUST| MUST| 2234 Attribute Name Defined | | NOT| 2235 -----------------------------------------|----+-----| 2236 Accounting-Input-Octets 4.6.1 | M | V | 2237 Accounting-Output-Octets 4.6.2 | M | V | 2238 Accounting-Input-Packets 4.6.3 | M | V | 2239 Accounting-Output-Packets 4.6.4 | M | V | 2240 Acct-Session-Time 4.6.5 | M | V | 2241 Acct-Authentic 4.6.6 | M | V | 2242 Accounting-Auth-Method 4.6.7 | M | V | 2243 Acct-Delay-Time 4.6.8 | M | V | 2244 Acct-Link-Count 4.6.9 | M | V | 2245 Acct-Tunnel-Connection 4.6.10 | M | V | 2246 Acct-Tunnel-Packets-Lost 4.6.11 | M | V | 2247 -----------------------------------------|----+-----| 2249 4.6.1. Accounting-Input-Octets AVP 2251 The Accounting-Input-Octets AVP (AVP Code 363) is of type Unsigned64 2252 and contains the number of octets received from the user. 2254 For NAS usage, this AVP indicates how many octets have been received 2255 from the port in the course of this session. It can only be present 2256 in ACR messages with an Accounting-Record-Type 2257 [I-D.ietf-dime-rfc3588bis] of INTERIM_RECORD or STOP_RECORD. 2259 4.6.2. Accounting-Output-Octets AVP 2261 The Accounting-Output-Octets AVP (AVP Code 364) is of type Unsigned64 2262 and contains the number of octets sent to the user. 2264 For NAS usage, this AVP indicates how many octets have been sent to 2265 the port in the course of this session. It can only be present in 2266 ACR messages with an Accounting-Record-Type of INTERIM_RECORD or 2267 STOP_RECORD. 2269 4.6.3. Accounting-Input-Packets AVP 2271 The Accounting-Input-Packets (AVP Code 365) is of type Unsigned64 and 2272 contains the number of packets received from the user. 2274 For NAS usage, this AVP indicates how many packets have been received 2275 from the port over the course of a session being provided to a Framed 2276 User. It can only be present in ACR messages with an Accounting- 2277 Record-Type of INTERIM_RECORD or STOP_RECORD. 2279 4.6.4. Accounting-Output-Packets AVP 2281 The Accounting-Output-Packets (AVP Code 366) is of type Unsigned64 2282 and contains the number of IP packets sent to the user. 2284 For NAS usage, this AVP indicates how many packets have been sent to 2285 the port over the course of a session being provided to a Framed 2286 User. It can only be present in ACR messages with an Accounting- 2287 Record-Type of INTERIM_RECORD or STOP_RECORD. 2289 4.6.5. Acct-Session-Time AVP 2291 The Acct-Session-Time AVP (AVP Code 46) is of type Unsigned32 and 2292 indicates the length of the current session in seconds. It can only 2293 be present in ACR messages with an Accounting-Record-Type of 2294 INTERIM_RECORD or STOP_RECORD. 2296 4.6.6. Acct-Authentic AVP 2298 The Acct-Authentic AVP (AVP Code 45) is of type Enumerated and 2299 specifies how the user was authenticated. The supported values are 2300 listed in [RADIUSTypes]. 2302 4.6.7. Accounting-Auth-Method AVP 2304 The Accounting-Auth-Method AVP (AVP Code 406) is of type Enumerated. 2305 A NAS MAY include this AVP in an Accounting-Request message to 2306 indicate the method used to authenticate the user. (Note that this 2307 AVP is semantically equivalent, and the supported values are 2308 identical, to the Microsoft MS-Acct-Auth-Type vendor-specific RADIUS 2309 attribute [RFC2548]). 2311 4.6.8. Acct-Delay-Time AVP 2313 The Acct-Delay-Time AVP (AVP Code 41) is of type Unsigned32 and 2314 indicates the number of seconds the Diameter client has been trying 2315 to send the Accounting-Request (ACR). The accounting server may 2316 subtract this value from the time when the ACR arrives at the server 2317 to calculate the approximate time of the event that caused the ACR to 2318 be generated. 2320 This AVP is not used for retransmissions at the transport level (TCP 2321 or SCTP). Rather, it may be used when an ACR command cannot be 2322 transmitted because there is no appropriate peer to transmit it to or 2323 was rejected because it could not be delivered. In these cases, the 2324 command MAY be buffered and transmitted later, when an appropriate 2325 peer-connection is available or after sufficient time has passed that 2326 the destination-host may be reachable and operational. If the ACR is 2327 re-sent in this way, the Acct-Delay-Time AVP SHOULD be included. The 2328 value of this AVP indicates the number of seconds that elapsed 2329 between the time of the first attempt at transmission and the current 2330 attempt. 2332 4.6.9. Acct-Link-Count AVP 2334 The Acct-Link-Count AVP (AVP Code 51) is of type Unsigned32 and 2335 indicates the total number of links that have been active (current or 2336 closed) in a given multilink session at the time the accounting 2337 record is generated. This AVP MAY be included in Accounting-Requests 2338 for any session that may be part of a multilink service. 2340 The Acct-Link-Count AVP may be used to make it easier for an 2341 accounting server to know when it has all the records for a given 2342 multilink service. When the number of Accounting-Requests received 2343 with Accounting-Record-Type = STOP_RECORD and with the same Acct- 2344 Multi-Session-Id and unique Session-Ids equals the largest value of 2345 Acct-Link-Count seen in those Accounting-Requests, all STOP_RECORD 2346 Accounting-Requests for that multilink service have been received. 2348 The following example, showing eight Accounting-Requests, illustrates 2349 how the Acct-Link-Count AVP is used. In the table below, only the 2350 relevant AVPs are shown, although additional AVPs containing 2351 accounting information will be present in the Accounting-Requests. 2353 Acct-Multi- Accounting- Acct- 2354 Session-Id Session-Id Record-Type Link-Count 2355 -------------------------------------------------------- 2356 "...10" "...10" START_RECORD 1 2357 "...10" "...11" START_RECORD 2 2358 "...10" "...11" STOP_RECORD 2 2359 "...10" "...12" START_RECORD 3 2360 "...10" "...13" START_RECORD 4 2361 "...10" "...12" STOP_RECORD 4 2362 "...10" "...13" STOP_RECORD 4 2363 "...10" "...10" STOP_RECORD 4 2365 4.6.10. Acct-Tunnel-Connection AVP 2367 The Acct-Tunnel-Connection AVP (AVP Code 68) is of type OctetString 2368 and contains the identifier assigned to the tunnel session. This 2369 AVP, along with the Tunnel-Client-Endpoint (Section 4.5.4) and 2370 Tunnel-Server-Endpoint (Section 4.5.5) AVPs, may be used to provide a 2371 means to uniquely identify a tunnel session for auditing purposes. 2373 The format of the identifier in this AVP depends upon the value of 2374 the Tunnel-Type AVP (Section 4.5.2). For example, to identify an 2375 L2TP tunnel connection fully, the L2TP Tunnel Id and Call Id might be 2376 encoded in this field. The exact encoding of this field is 2377 implementation dependent. 2379 4.6.11. Acct-Tunnel-Packets-Lost AVP 2381 The Acct-Tunnel-Packets-Lost AVP (AVP Code 86) is of type Unsigned32 2382 and contains the number of packets lost on a given tunnel. 2384 5. AVP Occurrence Tables 2386 The following tables present the AVPs used by NAS applications in NAS 2387 messages and specify in which Diameter messages they may or may not 2388 be present. Messages and AVPs defined in the base Diameter protocol 2389 [I-D.ietf-dime-rfc3588bis] are not described in this document. Note 2390 that AVPs that can only be present within a Grouped AVP are not 2391 represented in this table. 2393 The tables use the following symbols: 2395 0 The AVP MUST NOT be present in the message. 2396 0+ Zero or more instances of the AVP MAY be present in the 2397 message. 2398 0-1 Zero or one instance of the AVP MAY be present in the 2399 message. 2400 1 Exactly one instance of the AVP MUST be present in the 2401 message. 2403 5.1. AA-Request/Answer AVP Table 2405 The table in this section is limited to the Command Codes defined in 2406 this specification. 2408 +-----------+ 2409 | Command | 2410 |-----+-----+ 2411 AVP Name | AAR | AAA | 2412 ------------------------------|-----+-----+ 2413 Acct-Interim-Interval | 0 | 0-1 | 2414 ARAP-Challenge-Response | 0 | 0-1 | 2415 ARAP-Features | 0 | 0-1 | 2416 ARAP-Password | 0-1 | 0 | 2417 ARAP-Security | 0-1 | 0-1 | 2418 ARAP-Security-Data | 0+ | 0+ | 2419 ARAP-Zone-Access | 0 | 0-1 | 2420 Auth-Application-Id | 1 | 1 | 2421 Auth-Grace-Period | 0-1 | 0-1 | 2422 Auth-Request-Type | 1 | 1 | 2423 Auth-Session-State | 0-1 | 0-1 | 2424 Authorization-Lifetime | 0-1 | 0-1 | 2425 ------------------------------|-----+-----+ 2426 +-----------+ 2427 | Command | 2428 |-----+-----+ 2429 Attribute Name | AAR | AAA | 2430 ------------------------------|-----+-----+ 2431 Callback-Id | 0 | 0-1 | 2432 Callback-Number | 0-1 | 0-1 | 2433 Called-Station-Id | 0-1 | 0 | 2434 Calling-Station-Id | 0-1 | 0 | 2435 CHAP-Auth | 0-1 | 0 | 2436 CHAP-Challenge | 0-1 | 0 | 2437 Class | 0 | 0+ | 2438 Configuration-Token | 0 | 0+ | 2439 Connect-Info | 0+ | 0 | 2440 Destination-Host | 0-1 | 0 | 2441 Destination-Realm | 1 | 0 | 2442 Error-Message | 0 | 0-1 | 2443 Error-Reporting-Host | 0 | 0-1 | 2444 Failed-AVP | 0+ | 0+ | 2445 Filter-Id | 0 | 0+ | 2446 Framed-Appletalk-Link | 0 | 0-1 | 2447 Framed-Appletalk-Network | 0 | 0+ | 2448 Framed-Appletalk-Zone | 0 | 0-1 | 2449 Framed-Compression | 0+ | 0+ | 2450 Framed-Interface-Id | 0-1 | 0-1 | 2451 Framed-IP-Address | 0-1 | 0-1 | 2452 Framed-IP-Netmask | 0-1 | 0-1 | 2453 Framed-IPv6-Prefix | 0+ | 0+ | 2454 Framed-IPv6-Pool | 0 | 0-1 | 2455 Framed-IPv6-Route | 0 | 0+ | 2456 Framed-IPX-Network | 0 | 0-1 | 2457 Framed-MTU | 0-1 | 0-1 | 2458 Framed-Pool | 0 | 0-1 | 2459 Framed-Protocol | 0-1 | 0-1 | 2460 Framed-Route | 0 | 0+ | 2461 Framed-Routing | 0 | 0-1 | 2462 Idle-Timeout | 0 | 0-1 | 2463 Login-IP-Host | 0+ | 0+ | 2464 Login-IPv6-Host | 0+ | 0+ | 2465 Login-LAT-Group | 0-1 | 0-1 | 2466 Login-LAT-Node | 0-1 | 0-1 | 2467 Login-LAT-Port | 0-1 | 0-1 | 2468 Login-LAT-Service | 0-1 | 0-1 | 2469 Login-Service | 0 | 0-1 | 2470 Login-TCP-Port | 0 | 0-1 | 2471 Multi-Round-Time-Out | 0 | 0-1 | 2472 ------------------------------|-----+-----+ 2473 +-----------+ 2474 | Command | 2475 |-----+-----+ 2476 Attribute Name | AAR | AAA | 2477 ------------------------------|-----+-----+ 2478 NAS-Filter-Rule | 0 | 0+ | 2479 NAS-Identifier | 0-1 | 0 | 2480 NAS-IP-Address | 0-1 | 0 | 2481 NAS-IPv6-Address | 0-1 | 0 | 2482 NAS-Port | 0-1 | 0 | 2483 NAS-Port-Id | 0-1 | 0 | 2484 NAS-Port-Type | 0-1 | 0 | 2485 Origin-AAA-Protocol | 0-1 | 0-1 | 2486 Origin-Host | 1 | 1 | 2487 Origin-Realm | 1 | 1 | 2488 Origin-State-Id | 0-1 | 0-1 | 2489 Originating-Line-Info | 0-1 | 0 | 2490 Password-Retry | 0 | 0-1 | 2491 Port-Limit | 0-1 | 0-1 | 2492 Prompt | 0 | 0-1 | 2493 Proxy-Info | 0+ | 0+ | 2494 QoS-Filter-Rule | 0 | 0+ | 2495 Re-Auth-Request-Type | 0 | 0-1 | 2496 Redirect-Host | 0 | 0+ | 2497 Redirect-Host-Usage | 0 | 0-1 | 2498 Redirect-Max-Cache-Time | 0 | 0-1 | 2499 Reply-Message | 0 | 0+ | 2500 Result-Code | 0 | 1 | 2501 Route-Record | 0+ | 0 | 2502 Service-Type | 0-1 | 0-1 | 2503 Session-Id | 1 | 1 | 2504 Session-Timeout | 0 | 0-1 | 2505 State | 0-1 | 0-1 | 2506 Tunneling | 0+ | 0+ | 2507 User-Name | 0-1 | 0-1 | 2508 User-Password | 0-1 | 0 | 2509 ------------------------------|-----+-----+ 2511 5.2. Accounting AVP Tables 2513 The tables in this section are used to show which AVPs defined in 2514 this document are to be present and used in NAS application 2515 Accounting messages. These AVPs are defined in this document, as 2516 well as in [I-D.ietf-dime-rfc3588bis] and [RFC2866]. 2518 5.2.1. Framed Access Accounting AVP Table 2520 The table in this section is used when the Service-Type AVP 2521 (Section 4.4.1) specifies Framed Access. 2523 +-----------+ 2524 | Command | 2525 |-----+-----+ 2526 Attribute Name | ACR | ACA | 2527 ---------------------------------------|-----+-----+ 2528 Accounting-Auth-Method | 0-1 | 0 | 2529 Accounting-Input-Octets | 1 | 0 | 2530 Accounting-Input-Packets | 1 | 0 | 2531 Accounting-Output-Octets | 1 | 0 | 2532 Accounting-Output-Packets | 1 | 0 | 2533 Accounting-Record-Number | 0-1 | 0-1 | 2534 Accounting-Record-Type | 1 | 1 | 2535 Accounting-Realtime-Required | 0-1 | 0-1 | 2536 Accounting-Sub-Session-Id | 0-1 | 0-1 | 2537 Acct-Application-Id | 0-1 | 0-1 | 2538 Acct-Session-Id | 1 | 0-1 | 2539 Acct-Multi-Session-Id | 0-1 | 0-1 | 2540 Acct-Authentic | 1 | 0 | 2541 Acct-Delay-Time | 0-1 | 0 | 2542 Acct-Interim-Interval | 0-1 | 0-1 | 2543 Acct-Link-Count | 0-1 | 0 | 2544 Acct-Session-Time | 1 | 0 | 2545 Acct-Tunnel-Connection | 0-1 | 0 | 2546 Acct-Tunnel-Packets-Lost | 0-1 | 0 | 2547 Authorization-Lifetime | 0-1 | 0 | 2548 Callback-Id | 0-1 | 0 | 2549 Callback-Number | 0-1 | 0 | 2550 Called-Station-Id | 0-1 | 0 | 2551 Calling-Station-Id | 0-1 | 0 | 2552 Class | 0+ | 0+ | 2553 Connection-Info | 0+ | 0 | 2554 Destination-Host | 0-1 | 0 | 2555 Destination-Realm | 1 | 0 | 2556 Event-Timestamp | 0-1 | 0-1 | 2557 Error-Message | 0 | 0-1 | 2558 Error-Reporting-Host | 0 | 0-1 | 2559 Failed-AVP | 0 | 0+ | 2560 ---------------------------------------|-----+-----+ 2561 +-----------+ 2562 | Command | 2563 |-----+-----+ 2564 Attribute Name | ACR | ACA | 2565 ---------------------------------------|-----+-----+ 2566 Framed-AppleTalk-Link | 0-1 | 0 | 2567 Framed-AppleTalk-Network | 0-1 | 0 | 2568 Framed-AppleTalk-Zone | 0-1 | 0 | 2569 Framed-Compression | 0-1 | 0 | 2570 Framed-IP-Address | 0-1 | 0 | 2571 Framed-IP-Netmask | 0-1 | 0 | 2572 Framed-IPv6-Prefix | 0+ | 0 | 2573 Framed-IPv6-Pool | 0-1 | 0 | 2574 Framed-IPX-Network | 0-1 | 0 | 2575 Framed-MTU | 0-1 | 0 | 2576 Framed-Pool | 0-1 | 0 | 2577 Framed-Protocol | 0-1 | 0 | 2578 Framed-Route | 0-1 | 0 | 2579 Framed-Routing | 0-1 | 0 | 2580 NAS-Filter-Rule | 0+ | 0 | 2581 NAS-Identifier | 0-1 | 0-1 | 2582 NAS-IP-Address | 0-1 | 0-1 | 2583 NAS-IPv6-Address | 0-1 | 0-1 | 2584 NAS-Port | 0-1 | 0-1 | 2585 NAS-Port-Id | 0-1 | 0-1 | 2586 NAS-Port-Type | 0-1 | 0-1 | 2587 Origin-AAA-Protocol | 0-1 | 0-1 | 2588 Origin-Host | 1 | 1 | 2589 Origin-Realm | 1 | 1 | 2590 Origin-State-Id | 0-1 | 0-1 | 2591 Originating-Line-Info | 0-1 | 0 | 2592 Proxy-Info | 0+ | 0+ | 2593 QoS-Filter-Rule | 0+ | 0 | 2594 Route-Record | 0+ | 0 | 2595 Result-Code | 0 | 1 | 2596 Service-Type | 0-1 | 0-1 | 2597 Session-Id | 1 | 1 | 2598 Termination-Cause | 0-1 | 0-1 | 2599 Tunnel-Assignment-Id | 0-1 | 0 | 2600 Tunnel-Client-Endpoint | 0-1 | 0 | 2601 Tunnel-Medium-Type | 0-1 | 0 | 2602 Tunnel-Private-Group-Id | 0-1 | 0 | 2603 Tunnel-Server-Endpoint | 0-1 | 0 | 2604 Tunnel-Type | 0-1 | 0 | 2605 User-Name | 0-1 | 0-1 | 2606 Vendor-Specific-Application-Id | 0-1 | 0-1 | 2607 ---------------------------------------|-----+-----+ 2609 5.2.2. Non-Framed Access Accounting AVP Table 2611 The table in this section is used when the Service-Type AVP 2612 (Section 4.4.1) specifies Non-Framed Access. 2614 +-----------+ 2615 | Command | 2616 |-----+-----+ 2617 Attribute Name | ACR | ACA | 2618 ---------------------------------------|-----+-----+ 2619 Accounting-Auth-Method | 0-1 | 0 | 2620 Accounting-Input-Octets | 1 | 0 | 2621 Accounting-Output-Octets | 1 | 0 | 2622 Accounting-Record-Type | 1 | 1 | 2623 Accounting-Record-Number | 0-1 | 0-1 | 2624 Accounting-Realtime-Required | 0-1 | 0-1 | 2625 Accounting-Sub-Session-Id | 0-1 | 0-1 | 2626 Acct-Application-Id | 0-1 | 0-1 | 2627 Acct-Session-Id | 1 | 0-1 | 2628 Acct-Multi-Session-Id | 0-1 | 0-1 | 2629 Acct-Authentic | 1 | 0 | 2630 Acct-Delay-Time | 0-1 | 0 | 2631 Acct-Interim-Interval | 0-1 | 0-1 | 2632 Acct-Link-Count | 0-1 | 0 | 2633 Acct-Session-Time | 1 | 0 | 2634 Authorization-Lifetime | 0-1 | 0 | 2635 Callback-Id | 0-1 | 0 | 2636 Callback-Number | 0-1 | 0 | 2637 Called-Station-Id | 0-1 | 0 | 2638 Calling-Station-Id | 0-1 | 0 | 2639 Class | 0+ | 0+ | 2640 Connection-Info | 0+ | 0 | 2641 Destination-Host | 0-1 | 0 | 2642 Destination-Realm | 1 | 0 | 2643 Event-Timestamp | 0-1 | 0-1 | 2644 Error-Message | 0 | 0-1 | 2645 Error-Reporting-Host | 0 | 0-1 | 2646 Failed-AVP | 0 | 0+ | 2647 Login-IP-Host | 0+ | 0 | 2648 Login-IPv6-Host | 0+ | 0 | 2649 Login-LAT-Service | 0-1 | 0 | 2650 Login-LAT-Node | 0-1 | 0 | 2651 Login-LAT-Group | 0-1 | 0 | 2652 Login-LAT-Port | 0-1 | 0 | 2653 Login-Service | 0-1 | 0 | 2654 Login-TCP-Port | 0-1 | 0 | 2655 ---------------------------------------|-----+-----+ 2656 +-----------+ 2657 | Command | 2658 |-----+-----+ 2659 Attribute Name | ACR | ACA | 2660 ---------------------------------------|-----+-----+ 2661 NAS-Identifier | 0-1 | 0-1 | 2662 NAS-IP-Address | 0-1 | 0-1 | 2663 NAS-IPv6-Address | 0-1 | 0-1 | 2664 NAS-Port | 0-1 | 0-1 | 2665 NAS-Port-Id | 0-1 | 0-1 | 2666 NAS-Port-Type | 0-1 | 0-1 | 2667 Origin-AAA-Protocol | 0-1 | 0-1 | 2668 Origin-Host | 1 | 1 | 2669 Origin-Realm | 1 | 1 | 2670 Origin-State-Id | 0-1 | 0-1 | 2671 Originating-Line-Info | 0-1 | 0 | 2672 Proxy-Info | 0+ | 0+ | 2673 QoS-Filter-Rule | 0+ | 0 | 2674 Route-Record | 0+ | 0 | 2675 Result-Code | 0 | 1 | 2676 Session-Id | 1 | 1 | 2677 Service-Type | 0-1 | 0-1 | 2678 Termination-Cause | 0-1 | 0-1 | 2679 User-Name | 0-1 | 0-1 | 2680 Vendor-Specific-Application-Id | 0-1 | 0-1 | 2681 ---------------------------------------|-----+-----+ 2683 6. IANA Considerations 2685 This document does not request any action by IANA. 2687 7. Security Considerations 2689 This document describes the extension of Diameter for the NAS 2690 application. The security considerations of the Diameter protocol 2691 itself have been discussed in [I-D.ietf-dime-rfc3588bis]. Use of 2692 this application of Diameter MUST take into consideration the 2693 security issues and requirements of the Base protocol. 2695 This document does not contain a security protocol but does discuss 2696 how PPP authentication protocols can be carried within the Diameter 2697 protocol. The PPP authentication protocols described are PAP and 2698 CHAP. 2700 The use of PAP SHOULD be discouraged, as it exposes users' passwords 2701 to possibly non-trusted entities. However, PAP is also frequently 2702 used for use with One-Time Passwords, which do not expose a security 2703 risk. 2705 This document also describes how CHAP can be carried within the 2706 Diameter protocol, which is required for RADIUS backward 2707 compatibility. The CHAP protocol, as used in a RADIUS environment, 2708 facilitates authentication replay attacks. 2710 The use of the EAP authentication protocols [RFC4072] can offer 2711 better security, given a method suitable for the circumstances. 2713 8. References 2715 8.1. Normative References 2717 [ANITypes] NANPA Number Resource Info, "ANI 2718 Assignments", . 2722 [I-D.ietf-dime-rfc3588bis] Fajardo, V., Arkko, J., Loughney, J., and 2723 G. Zorn, "Diameter Base Protocol", 2724 draft-ietf-dime-rfc3588bis-26 (work in 2725 progress), January 2011. 2727 [RADIUSTypes] IANA, "RADIUS Types", . 2730 [RFC1994] Simpson, W., "PPP Challenge Handshake 2731 Authentication Protocol (CHAP)", 2732 RFC 1994, August 1996. 2734 [RFC2119] Bradner, S., "Key words for use in RFCs 2735 to Indicate Requirement Levels", BCP 14, 2736 RFC 2119, March 1997. 2738 [RFC2865] Rigney, C., Willens, S., Rubens, A., and 2739 W. Simpson, "Remote Authentication Dial 2740 In User Service (RADIUS)", RFC 2865, 2741 June 2000. 2743 [RFC3162] Aboba, B., Zorn, G., and D. Mitton, 2744 "RADIUS and IPv6", RFC 3162, August 2001. 2746 [RFC3516] Nerenberg, L., "IMAP4 Binary Content 2747 Extension", RFC 3516, April 2003. 2749 [RFC3539] Aboba, B. and J. Wood, "Authentication, 2750 Authorization and Accounting (AAA) 2751 Transport Profile", RFC 3539, June 2003. 2753 8.2. Informative References 2755 [ARAP] Apple Computer, "Apple Remote Access 2756 Protocol (ARAP) Version 2.0 External 2757 Reference Specification", R0612LL/B , 2758 September 1994. 2760 [AppleTalk] Sidhu, G., Andrews, R., and A. 2761 Oppenheimer, "Inside AppleTalk", Second 2762 Edition Apple Computer, 1990. 2764 [IPX] Novell, Inc., "NetWare System Technical 2765 Interface Overview", #883-000780-001, 2766 June 1989. 2768 [ISO.8859-1.1987] International Organization for 2769 Standardization, "Information technology 2770 - 8-bit single byte coded graphic - 2771 character sets - Part 1: Latin alphabet 2772 No. 1, JTC1/SC2", ISO Standard 8859-1, 2773 1987. 2775 [LAT] Digital Equipment Corp., "Local Area 2776 Transport (LAT) Specification V5.0", AA- 2777 NL26A-TE, June 1989. 2779 [RFC1334] Lloyd, B. and W. Simpson, "PPP 2780 Authentication Protocols", RFC 1334, 2781 October 1992. 2783 [RFC1661] Simpson, W., "The Point-to-Point Protocol 2784 (PPP)", STD 51, RFC 1661, July 1994. 2786 [RFC1990] Sklower, K., Lloyd, B., McGregor, G., 2787 Carr, D., and T. Coradetti, "The PPP 2788 Multilink Protocol (MP)", RFC 1990, 2789 August 1996. 2791 [RFC2474] Nichols, K., Blake, S., Baker, F., and D. 2792 Black, "Definition of the Differentiated 2793 Services Field (DS Field) in the IPv4 and 2794 IPv6 Headers", RFC 2474, December 1998. 2796 [RFC2548] Zorn, G., "Microsoft Vendor-specific 2797 RADIUS Attributes", RFC 2548, March 1999. 2799 [RFC2597] Heinanen, J., Baker, F., Weiss, W., and 2800 J. Wroclawski, "Assured Forwarding PHB 2801 Group", RFC 2597, June 1999. 2803 [RFC2637] Hamzeh, K., Pall, G., Verthein, W., 2804 Taarud, J., Little, W., and G. Zorn, 2805 "Point-to-Point Tunneling Protocol", 2806 RFC 2637, July 1999. 2808 [RFC2866] Rigney, C., "RADIUS Accounting", 2809 RFC 2866, June 2000. 2811 [RFC2867] Zorn, G., Aboba, B., and D. Mitton, 2812 "RADIUS Accounting Modifications for 2813 Tunnel Protocol Support", RFC 2867, 2814 June 2000. 2816 [RFC2868] Zorn, G., Leifer, D., Rubens, A., 2817 Shriver, J., Holdrege, M., and I. Goyret, 2818 "RADIUS Attributes for Tunnel Protocol 2819 Support", RFC 2868, June 2000. 2821 [RFC2869] Rigney, C., Willats, W., and P. Calhoun, 2822 "RADIUS Extensions", RFC 2869, June 2000. 2824 [RFC2881] Mitton, D. and M. Beadles, "Network 2825 Access Server Requirements Next 2826 Generation (NASREQNG) NAS Model", 2827 RFC 2881, July 2000. 2829 [RFC2989] Aboba, B., Calhoun, P., Glass, S., 2830 Hiller, T., McCann, P., Shiino, H., 2831 Walsh, P., Zorn, G., Dommety, G., 2832 Perkins, C., Patil, B., Mitton, D., 2833 Manning, S., Beadles, M., Chen, X., 2834 Sivalingham, S., Hameed, A., Munson, M., 2835 Jacobs, S., Lim, B., Hirschman, B., Hsu, 2836 R., Koo, H., Lipford, M., Campbell, E., 2837 Xu, Y., Baba, S., and E. Jaques, 2838 "Criteria for Evaluating AAA Protocols 2839 for Network Access", RFC 2989, 2840 November 2000. 2842 [RFC3169] Beadles, M. and D. Mitton, "Criteria for 2843 Evaluating Network Access Server 2844 Protocols", RFC 3169, September 2001. 2846 [RFC3246] Davie, B., Charny, A., Bennet, J., 2847 Benson, K., Le Boudec, J., Courtney, W., 2848 Davari, S., Firoiu, V., and D. Stiliadis, 2849 "An Expedited Forwarding PHB (Per-Hop 2850 Behavior)", RFC 3246, March 2002. 2852 [RFC3580] Congdon, P., Aboba, B., Smith, A., Zorn, 2853 G., and J. Roese, "IEEE 802.1X Remote 2854 Authentication Dial In User Service 2855 (RADIUS) Usage Guidelines", RFC 3580, 2856 September 2003. 2858 [RFC3931] Lau, J., Townsley, M., and I. Goyret, 2859 "Layer Two Tunneling Protocol - Version 3 2860 (L2TPv3)", RFC 3931, March 2005. 2862 [RFC4072] Eronen, P., Hiller, T., and G. Zorn, 2863 "Diameter Extensible Authentication 2864 Protocol (EAP) Application", RFC 4072, 2865 August 2005. 2867 [RFC4301] Kent, S. and K. Seo, "Security 2868 Architecture for the Internet Protocol", 2869 RFC 4301, December 2005. 2871 [RFC5246] Dierks, T. and E. Rescorla, "The 2872 Transport Layer Security (TLS) Protocol 2873 Version 1.2", RFC 5246, August 2008. 2875 Appendix A. Acknowledgements 2877 A.1. RFC 4005 2879 The authors would like to thank Carl Rigney, Allan C. Rubens, William 2880 Allen Simpson, and Steve Willens for their work on the original 2881 RADIUS protocol, from which many of the concepts in this 2882 specification were derived. Thanks, also, to Carl Rigney for 2883 [RFC2866] and [RFC2869]; Ward Willats for [RFC2869]; Glen Zorn, 2884 Bernard Aboba, and Dave Mitton for [RFC2867] and [RFC3162]; and Dory 2885 Leifer, John Shriver, Matt Holdrege, Allan Rubens, Glen Zorn and 2886 Ignacio Goyret for their work on [RFC2868]. This document stole text 2887 and concepts from both [RFC2868] and [RFC2869]. Thanks go to Carl 2888 Williams for providing IPv6-specific text. 2890 The authors would also like to acknowledge the following people for 2891 their contributions in the development of the Diameter protocol: 2892 Bernard Aboba, Jari Arkko, William Bulley, Kuntal Chowdhury, Daniel 2893 C. Fox, Lol Grant, Nancy Greene, Jeff Hagg, Peter Heitman, Paul 2894 Krumviede, Fergal Ladley, Ryan Moats, Victor Muslin, Kenneth Peirce, 2895 Sumit Vakil, John R. Vollbrecht, and Jeff Weisberg. 2897 Finally, Pat Calhoun would like to thank Sun Microsystems, as most of 2898 the effort put into this document was done while he was in their 2899 employ. 2901 A.2. RFC 4005bis 2903 The vast majority of the text in this document was lifted directly 2904 from RFC 4005; the editor owes a debt of gratitude to the authors 2905 thereof (especially Dave Mitton, who somehow managed to make nroff 2906 paginate the AVP Occurance Tables correctly!). 2908 Thanks (in no particular order) to Jai-Jin Lim, Liu Hans, Sebastien 2909 Decugis, Jouni Korhonen and Stefan Winter for their useful reviews 2910 and helpful comments. 2912 Author's Address 2914 Glen Zorn 2915 Network Zen 2916 227/358 Thanon Sanphawut 2917 Bang Na, Bangkok 10260 2918 Thailand 2920 Phone: +66 (0) 87-040-4617 2921 EMail: gwz@net-zen.net