idnits 2.17.1 draft-ietf-dime-rfc4005bis-12.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? Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (January 2, 2013) is 4126 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' -- Obsolete informational reference (is this intentional?): RFC 3588 (ref. 'BASE') (Obsoleted by RFC 6733) -- 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 (~~), 2 warnings (==), 6 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group G. Zorn, Ed. 3 Internet-Draft Network Zen 4 Obsoletes: 4005 (if approved) January 2, 2013 5 Intended status: Standards Track 6 Expires: July 6, 2013 8 Diameter Network Access Server Application 9 draft-ietf-dime-rfc4005bis-12 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; it obsoletes RFC 4005. When 16 combined with the Diameter Base protocol, Transport Profile, and 17 Extensible 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 July 6, 2013. 37 Copyright Notice 39 Copyright (c) 2013 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. Changes from RFC 4005 . . . . . . . . . . . . . . . . . . 5 56 1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 6 57 1.3. Requirements Language . . . . . . . . . . . . . . . . . . 7 58 1.4. Advertising Application Support . . . . . . . . . . . . . 7 59 1.5. Application Identification . . . . . . . . . . . . . . . . 7 60 1.6. Accounting Model . . . . . . . . . . . . . . . . . . . . . 8 61 2. NAS Calls, Ports, and Sessions . . . . . . . . . . . . . . . . 8 62 2.1. Diameter Session Establishment . . . . . . . . . . . . . . 8 63 2.2. Diameter Session Reauthentication or Reauthorization . . . 9 64 2.3. Diameter Session Termination . . . . . . . . . . . . . . . 10 65 3. Diameter NAS Application Messages . . . . . . . . . . . . . . 10 66 3.1. AA-Request (AAR) Command . . . . . . . . . . . . . . . . . 10 67 3.2. AA-Answer (AAA) Command . . . . . . . . . . . . . . . . . 12 68 3.3. Re-Auth-Request (RAR) Command . . . . . . . . . . . . . . 14 69 3.4. Re-Auth-Answer (RAA) Command . . . . . . . . . . . . . . . 15 70 3.5. Session-Termination-Request (STR) Command . . . . . . . . 16 71 3.6. Session-Termination-Answer (STA) Command . . . . . . . . . 17 72 3.7. Abort-Session-Request (ASR) Command . . . . . . . . . . . 18 73 3.8. Abort-Session-Answer (ASA) Command . . . . . . . . . . . . 19 74 3.9. Accounting-Request (ACR) Command . . . . . . . . . . . . . 20 75 3.10. Accounting-Answer (ACA) Command . . . . . . . . . . . . . 22 76 4. Diameter NAS Application AVPs . . . . . . . . . . . . . . . . 23 77 4.1. Derived AVP Data Formats . . . . . . . . . . . . . . . . . 23 78 4.1.1. QoSFilterRule . . . . . . . . . . . . . . . . . . . . 23 79 4.2. NAS Session AVPs . . . . . . . . . . . . . . . . . . . . . 24 80 4.2.1. Call and Session Information . . . . . . . . . . . . . 24 81 4.2.2. NAS-Port AVP . . . . . . . . . . . . . . . . . . . . . 25 82 4.2.3. NAS-Port-Id AVP . . . . . . . . . . . . . . . . . . . 25 83 4.2.4. NAS-Port-Type AVP . . . . . . . . . . . . . . . . . . 26 84 4.2.5. Called-Station-Id AVP . . . . . . . . . . . . . . . . 26 85 4.2.6. Calling-Station-Id AVP . . . . . . . . . . . . . . . . 26 86 4.2.7. Connect-Info AVP . . . . . . . . . . . . . . . . . . . 27 87 4.2.8. Originating-Line-Info AVP . . . . . . . . . . . . . . 27 88 4.2.9. Reply-Message AVP . . . . . . . . . . . . . . . . . . 28 89 4.3. NAS Authentication AVPs . . . . . . . . . . . . . . . . . 28 90 4.3.1. User-Password AVP . . . . . . . . . . . . . . . . . . 29 91 4.3.2. Password-Retry AVP . . . . . . . . . . . . . . . . . . 29 92 4.3.3. Prompt AVP . . . . . . . . . . . . . . . . . . . . . . 29 93 4.3.4. CHAP-Auth AVP . . . . . . . . . . . . . . . . . . . . 29 94 4.3.5. CHAP-Algorithm AVP . . . . . . . . . . . . . . . . . . 30 95 4.3.6. CHAP-Ident AVP . . . . . . . . . . . . . . . . . . . . 30 96 4.3.7. CHAP-Response AVP . . . . . . . . . . . . . . . . . . 30 97 4.3.8. CHAP-Challenge AVP . . . . . . . . . . . . . . . . . . 30 98 4.3.9. ARAP-Password AVP . . . . . . . . . . . . . . . . . . 30 99 4.3.10. ARAP-Challenge-Response AVP . . . . . . . . . . . . . 30 100 4.3.11. ARAP-Security AVP . . . . . . . . . . . . . . . . . . 31 101 4.3.12. ARAP-Security-Data AVP . . . . . . . . . . . . . . . . 31 102 4.4. NAS Authorization AVPs . . . . . . . . . . . . . . . . . . 31 103 4.4.1. Service-Type AVP . . . . . . . . . . . . . . . . . . . 33 104 4.4.2. Callback-Number AVP . . . . . . . . . . . . . . . . . 33 105 4.4.3. Callback-Id AVP . . . . . . . . . . . . . . . . . . . 34 106 4.4.4. Idle-Timeout AVP . . . . . . . . . . . . . . . . . . . 34 107 4.4.5. Port-Limit AVP . . . . . . . . . . . . . . . . . . . . 34 108 4.4.6. NAS-Filter-Rule AVP . . . . . . . . . . . . . . . . . 34 109 4.4.7. Filter-Id AVP . . . . . . . . . . . . . . . . . . . . 34 110 4.4.8. Configuration-Token AVP . . . . . . . . . . . . . . . 35 111 4.4.9. QoS-Filter-Rule AVP . . . . . . . . . . . . . . . . . 35 112 4.4.10. Framed Access Authorization AVPs . . . . . . . . . . . 36 113 4.4.10.1. Framed-Protocol AVP . . . . . . . . . . . . . . . 36 114 4.4.10.2. Framed-Routing AVP . . . . . . . . . . . . . . . 36 115 4.4.10.3. Framed-MTU AVP . . . . . . . . . . . . . . . . . 36 116 4.4.10.4. Framed-Compression AVP . . . . . . . . . . . . . 36 117 4.4.10.5. IP Access Authorization AVPs . . . . . . . . . . 37 118 4.4.10.5.1. Framed-IP-Address AVP . . . . . . . . . . . . 37 119 4.4.10.5.2. Framed-IP-Netmask AVP . . . . . . . . . . . . 37 120 4.4.10.5.3. Framed-Route AVP . . . . . . . . . . . . . . 37 121 4.4.10.5.4. Framed-Pool AVP . . . . . . . . . . . . . . . 38 122 4.4.10.5.5. Framed-Interface-Id AVP . . . . . . . . . . . 38 123 4.4.10.5.6. Framed-IPv6-Prefix AVP . . . . . . . . . . . 38 124 4.4.10.5.7. Framed-IPv6-Route AVP . . . . . . . . . . . . 38 125 4.4.10.5.8. Framed-IPv6-Pool AVP . . . . . . . . . . . . 39 126 4.4.10.6. IPX Access AVPs . . . . . . . . . . . . . . . . . 39 127 4.4.10.6.1. Framed-IPX-Network AVP . . . . . . . . . . . 39 128 4.4.10.7. AppleTalk Network Access AVPs . . . . . . . . . . 39 129 4.4.10.7.1. Framed-AppleTalk-Link AVP . . . . . . . . . . 39 130 4.4.10.7.2. Framed-AppleTalk-Network AVP . . . . . . . . 40 131 4.4.10.7.3. Framed-AppleTalk-Zone AVP . . . . . . . . . . 40 132 4.4.10.8. AppleTalk Remote Access AVPs . . . . . . . . . . 40 133 4.4.10.8.1. ARAP-Features AVP . . . . . . . . . . . . . . 40 134 4.4.10.8.2. ARAP-Zone-Access AVP . . . . . . . . . . . . 41 135 4.4.11. Non-Framed Access Authorization AVPs . . . . . . . . . 41 136 4.4.11.1. Login-IP-Host AVP . . . . . . . . . . . . . . . . 41 137 4.4.11.2. Login-IPv6-Host AVP . . . . . . . . . . . . . . . 41 138 4.4.11.3. Login-Service AVP . . . . . . . . . . . . . . . . 42 139 4.4.11.4. TCP Services . . . . . . . . . . . . . . . . . . 42 140 4.4.11.4.1. Login-TCP-Port AVP . . . . . . . . . . . . . 42 141 4.4.11.5. LAT Services . . . . . . . . . . . . . . . . . . 42 142 4.4.11.5.1. Login-LAT-Service AVP . . . . . . . . . . . . 42 143 4.4.11.5.2. Login-LAT-Node AVP . . . . . . . . . . . . . 43 144 4.4.11.5.3. Login-LAT-Group AVP . . . . . . . . . . . . . 43 145 4.4.11.5.4. Login-LAT-Port AVP . . . . . . . . . . . . . 44 146 4.5. NAS Tunneling AVPs . . . . . . . . . . . . . . . . . . . . 44 147 4.5.1. Tunneling AVP . . . . . . . . . . . . . . . . . . . . 45 148 4.5.2. Tunnel-Type AVP . . . . . . . . . . . . . . . . . . . 45 149 4.5.3. Tunnel-Medium-Type AVP . . . . . . . . . . . . . . . . 46 150 4.5.4. Tunnel-Client-Endpoint AVP . . . . . . . . . . . . . . 46 151 4.5.5. Tunnel-Server-Endpoint AVP . . . . . . . . . . . . . . 47 152 4.5.6. Tunnel-Password AVP . . . . . . . . . . . . . . . . . 47 153 4.5.7. Tunnel-Private-Group-Id AVP . . . . . . . . . . . . . 48 154 4.5.8. Tunnel-Assignment-Id AVP . . . . . . . . . . . . . . . 48 155 4.5.9. Tunnel-Preference AVP . . . . . . . . . . . . . . . . 49 156 4.5.10. Tunnel-Client-Auth-Id AVP . . . . . . . . . . . . . . 50 157 4.5.11. Tunnel-Server-Auth-Id AVP . . . . . . . . . . . . . . 50 158 4.6. NAS Accounting AVPs . . . . . . . . . . . . . . . . . . . 50 159 4.6.1. Accounting-Input-Octets AVP . . . . . . . . . . . . . 51 160 4.6.2. Accounting-Output-Octets AVP . . . . . . . . . . . . . 51 161 4.6.3. Accounting-Input-Packets AVP . . . . . . . . . . . . . 52 162 4.6.4. Accounting-Output-Packets AVP . . . . . . . . . . . . 52 163 4.6.5. Acct-Session-Time AVP . . . . . . . . . . . . . . . . 52 164 4.6.6. Acct-Authentic AVP . . . . . . . . . . . . . . . . . . 52 165 4.6.7. Accounting-Auth-Method AVP . . . . . . . . . . . . . . 52 166 4.6.8. Acct-Delay-Time AVP . . . . . . . . . . . . . . . . . 52 167 4.6.9. Acct-Link-Count AVP . . . . . . . . . . . . . . . . . 53 168 4.6.10. Acct-Tunnel-Connection AVP . . . . . . . . . . . . . . 54 169 4.6.11. Acct-Tunnel-Packets-Lost AVP . . . . . . . . . . . . . 54 170 5. AVP Occurrence Tables . . . . . . . . . . . . . . . . . . . . 54 171 5.1. AA-Request/Answer AVP Table . . . . . . . . . . . . . . . 54 172 5.2. Accounting AVP Tables . . . . . . . . . . . . . . . . . . 57 173 5.2.1. Framed Access Accounting AVP Table . . . . . . . . . . 58 174 5.2.2. Non-Framed Access Accounting AVP Table . . . . . . . . 60 175 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 61 176 7. Security Considerations . . . . . . . . . . . . . . . . . . . 62 177 7.1. Authentication Considerations . . . . . . . . . . . . . . 62 178 7.2. AVP Considerations . . . . . . . . . . . . . . . . . . . . 62 179 8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 63 180 8.1. Normative References . . . . . . . . . . . . . . . . . . . 63 181 8.2. Informative References . . . . . . . . . . . . . . . . . . 63 182 Appendix A. Acknowledgements . . . . . . . . . . . . . . . . . . 66 183 A.1. This Document . . . . . . . . . . . . . . . . . . . . . . 66 184 A.2. RFC 4005 . . . . . . . . . . . . . . . . . . . . . . . . . 66 186 1. Introduction 188 This document describes the Diameter protocol application used for 189 AAA in the Network Access Server (NAS) environment. When combined 190 with the Diameter Base protocol [RFC6733], Transport Profile 191 [RFC3539], and EAP [RFC4072] specifications, this specification 192 satisfies the NAS-related requirements defined in Aboba, et 193 al. [RFC2989] and Beadles & Mitton [RFC3169]. 195 First, this document describes the operation of a Diameter NAS 196 application. Then it defines the Diameter message Command-Codes. 197 The following sections list the AVPs used in these messages, grouped 198 by common usage. These are session identification, authentication, 199 authorization, tunneling, and accounting. The authorization AVPs are 200 further broken down by service type. 202 1.1. Changes from RFC 4005 204 This document obsoletes RFC 4005 and is not backward compatible with 205 that document. An overview of some of the major changes is given 206 below. 208 o All of the material regarding RADIUS/Diameter protocol 209 interactions has been removed. 211 o The Command Code Format (CCF) [RFC6733] for the Accounting-Request 212 and Accounting-Answer messages has been changed to explicitly 213 require the inclusion of the Acct-Application-Id AVP and exclude 214 the Vendor-Specific-Application-Id AVP. Normally, this type of 215 change would also require the allocation of a new command code and 216 consequently, a new application-id (See Section 1.3.3 of 217 [RFC6733]). However, the presence of an instance of the Acct- 218 Application-Id AVP was required in RFC 4005, as well: 220 The ACR message [BASE] is sent by the NAS to report its session 221 information to a target server downstream. 223 Either of Acct-Application-Id or Vendor-Specific-Application-Id 224 AVPs MUST be present. If the Vendor-Specific-Application-Id 225 grouped AVP is present, it must have an Acct-Application-Id 226 inside. 228 Thus, though the syntax of the commands has changed, the semantics 229 have not (with the caveat that the Acct-Application-Id AVP can no 230 longer be contained in the Vendor-Specific-Application-Id AVP). 232 o The lists of RADIUS attribute values have been deleted in favor of 233 references to the appropriate IANA registries. 235 o The accounting model to be used is now specified (see 236 Section 1.6). 238 There are many other miscellaneous fixes that have been introduced in 239 this document that may not be considered significant but they are 240 useful nonetheless. Examples are fixes to example IP addresses, 241 addition of clarifying references, etc. All of the errata previously 242 filed against RFC 4005 have been fixed. A comprehensive list of 243 changes is not shown here for practical reasons. 245 1.2. Terminology 247 Section 1.2 of the Diameter base protocol specification [RFC6733] 248 defines most of the terminology used in this document. Additionally, 249 the following terms and acronyms are used in this application: 251 NAS (Network Access Server) 252 A device that provides an access service for a user to a network. 253 The service may be a network connection or a value-added service 254 such as terminal emulation [RFC2881]. 256 PPP (Point-to-Point Protocol) 257 A multiprotocol serial datalink. PPP is the primary IP datalink 258 used for dial-in NAS connection service [RFC1661]. 260 CHAP (Challenge Handshake Authentication Protocol) 261 An authentication process used in PPP [RFC1994]. 263 PAP (Password Authentication Protocol) 264 A deprecated PPP authentication process, but often used for 265 backward compatibility [RFC1334]. 267 SLIP (Serial Line Interface Protocol) 268 A serial datalink that only supports IP. A design prior to PPP. 270 ARAP (Appletalk Remote Access Protocol) 271 A serial datalink for accessing Appletalk networks [ARAP]. 273 IPX (Internet Packet Exchange) 274 The network protocol used by NetWare networks [IPX]. 276 L2TP (Layer Two Tunneling Protocol) 278 L2TP [RFC3931] provides a dynamic mechanism for tunneling Layer 2 279 "circuits" across a packet-oriented data network. 281 LAC (L2TP Access Concentrator) 283 An L2TP Control Connection Endpoint being used to cross-connect an 284 L2TP session directly to a data link [RFC3931]. 286 LAT (Local Area Transport) 287 A Digital Equipment Corp. LAN protocol for terminal services 288 [LAT]. 290 LCP (Link Control Protocol) 292 One of the three major components of PPP [RFC1661]. LCP is used 293 to automatically agree upon encapsulation format options, handle 294 varying limits on sizes of packets, detect a looped-back link and 295 other common misconfiguration errors, and terminate the link. 296 Other optional facilities provided are authentication of the 297 identity of its peer on the link, and determination when a link is 298 functioning properly and when it is failing. 300 PPTP (Point-to-Point Tunneling Protocol) 302 A protocol which allows PPP to be tunneled through an IP network 303 [RFC2637]. 305 VPN (Virtual Private Network) 306 In this document, this term is used to describe access services 307 that use tunneling methods. 309 1.3. Requirements Language 311 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 312 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 313 "OPTIONAL" in this document are to be interpreted as described in RFC 314 2119 [RFC2119]. 316 1.4. Advertising Application Support 318 Diameter nodes conforming to this specification MUST advertise 319 support by including the value of one (1) in the Auth-Application-Id 320 of the Capabilities-Exchange-Request (CER) message [RFC6733]. 322 1.5. Application Identification 324 When used in this application, the Auth-Application-Id AVP MUST be 325 set to the value one (1) in the following messages 327 o AA-Request (Section 3.1) 328 o Re-Auth-Request(Section 3.3) 330 o Session-Termination-Request (Section 3.5) 332 o Abort-Session-Request (Section 3.7) 334 1.6. Accounting Model 336 It is RECOMMENDED that the coupled accounting model (Section 9.3 of 337 [RFC6733]) be used with this application; therefore, the value of the 338 Acct-Application-Id AVP in the Accounting-Request (Section 3.10) and 339 Accounting-Answer (Section 3.9) messages SHOULD be set to one (1). 341 2. NAS Calls, Ports, and Sessions 343 The arrival of a new call or service connection at a port of a 344 Network Access Server (NAS) starts a Diameter NAS Application message 345 exchange. Information about the call, the identity of the user, and 346 the user's authentication information are packaged into a Diameter 347 AA-Request (AAR) message and sent to a server. 349 The server processes the information and responds with a Diameter AA- 350 Answer (AAA) message that contains authorization information for the 351 NAS, or a failure code (Result-Code AVP). A value of 352 DIAMETER_MULTI_ROUND_AUTH indicates an additional authentication 353 exchange, and several AAR and AAA messages may be exchanged until the 354 transaction completes. 356 Depending on the value of the Auth-Request-Type AVP, the Diameter 357 protocol allows authorization-only requests that contain no 358 authentication information from the client. This capability goes 359 beyond the Call Check capabilities provided by RADIUS (Section 5.6 of 360 [RFC2865]) in that no access decision is requested. As a result, a 361 new session cannot be started as a result of a response to an 362 authorization-only request without introducing a significant security 363 vulnerability. 365 2.1. Diameter Session Establishment 367 When the authentication or authorization exchange completes 368 successfully, the NAS application SHOULD start a session context. If 369 the Result-Code of DIAMETER_MULTI_ROUND_AUTH is returned, the 370 exchange continues until a success or error is returned. 372 If accounting is active, the application MUST also send an Accounting 373 message [RFC6733]. An Accounting-Record-Type of START_RECORD is sent 374 for a new session. If a session fails to start, the EVENT_RECORD 375 message is sent with the reason for the failure described. 377 Note that the return of an unsupportable Accounting-Realtime-Required 378 value [RFC6733] would result in a failure to establish the session. 380 2.2. Diameter Session Reauthentication or Reauthorization 382 The Diameter Base protocol allows users to be periodically 383 reauthenticated and/or reauthorized. In such instances, the 384 Session-Id AVP in the AAR message MUST be the same as the one present 385 in the original authentication/authorization message. 387 A Diameter server informs the NAS of the maximum time allowed before 388 reauthentication or reauthorization via the Authorization-Lifetime 389 AVP [RFC6733]. A NAS MAY reauthenticate and/or reauthorize before 390 the end, but A NAS MUST reauthenticate and/or reauthorize at the end 391 of the period provided by the Authorization-Lifetime AVP. The 392 failure of a reauthentication exchange will terminate the service. 394 Furthermore, it is possible for Diameter servers to issue an 395 unsolicited reauthentication and/or reauthorization request (e.g., 396 Re-Auth-Request (RAR) message [RFC6733]) to the NAS. Upon receipt of 397 such a message, the NAS MUST respond to the request with a Re-Auth- 398 Answer (RAA) message [RFC6733]. 400 If the RAR properly identifies an active session, the NAS will 401 initiate a new local reauthentication or authorization sequence as 402 indicated by the Re-Auth-Request-Type value. This will cause the NAS 403 to send a new AAR message using the existing Session-Id. The server 404 will respond with an AAA message to specify the new service 405 parameters. 407 If accounting is active, every change of authentication or 408 authorization SHOULD generate an accounting message. If the NAS 409 service is a continuation of the prior user context, then an 410 Accounting-Record-Type of INTERIM_RECORD indicating the new session 411 attributes and cumulative status would be appropriate. If a new user 412 or a significant change in authorization is detected by the NAS, then 413 the service may send two messages of the types STOP_RECORD and 414 START_RECORD. Accounting may change the subsession identifiers 415 (Acct-Session-ID, or Acct-Sub-Session-Id) to indicate such sub- 416 sessions. A service may also use a different Session-Id value for 417 accounting (see Section 9.6 of [RFC6733]). 419 However, the Diameter Session-ID AVP value used for the initial 420 authorization exchange MUST be used to generate an STR message when 421 the session context is terminated. 423 2.3. Diameter Session Termination 425 When a NAS receives an indication that a user's session is being 426 disconnected by the client (e.g., an LCP Terminate-Request message 427 [RFC1661] is received) or an administrative command, the NAS MUST 428 issue a Session-Termination-Request (STR) [RFC6733] to its Diameter 429 Server. This will ensure that any resources maintained on the 430 servers are freed appropriately. 432 Furthermore, a NAS that receives an Abort-Session-Request (ASR) 433 [RFC6733] MUST issue an Abort-Session-Answer (ASA) if the session 434 identified is active and disconnect the PPP (or tunneling) session. 436 If accounting is active, an Accounting STOP_RECORD message [RFC6733] 437 MUST be sent upon termination of the session context. 439 More information on Diameter Session Termination can be found in 440 Sections 8.4 and 8.5 of [RFC6733]. 442 3. Diameter NAS Application Messages 444 This section defines the Diameter message Command-Code [RFC6733] 445 values that MUST be supported by all Diameter implementations 446 conforming to this specification. The Command Codes are as follows: 448 +-----------------------------------+---------+------+--------------+ 449 | Command Name | Abbrev. | Code | Reference | 450 +-----------------------------------+---------+------+--------------+ 451 | AA-Request | AAR | 265 | Section 3.1 | 452 | AA-Answer | AAA | 265 | Section 3.2 | 453 | Re-Auth-Request | RAR | 258 | Section 3.3 | 454 | Re-Auth-Answer | RAA | 258 | Section 3.4 | 455 | Session-Termination-Request | STR | 275 | Section 3.5 | 456 | Session-Termination-Answer | STA | 275 | Section 3.6 | 457 | Abort-Session-Request | ASR | 274 | Section 3.7 | 458 | Abort-Session-Answer | ASA | 274 | Section 3.8 | 459 | Accounting-Request | ACR | 271 | Section 3.9 | 460 | Accounting-Answer | ACA | 271 | Section 3.10 | 461 +-----------------------------------+---------+------+--------------+ 463 Note that the message formats in the following sub-sections use the 464 standard Diameter Command Code Format ([RFC6733], Section 3.2). 466 3.1. AA-Request (AAR) Command 468 The AA-Request (AAR), which is indicated by setting the Command-Code 469 field to 265 and the 'R' bit in the Command Flags field, is used to 470 request authentication and/or authorization for a given NAS user. 472 The type of request is identified through the Auth-Request-Type AVP 473 [RFC6733]. The recommended value for most situations is 474 AUTHORIZE_AUTHENTICATE. 476 If Authentication is requested, the User-Name attribute SHOULD be 477 present, as well as any additional authentication AVPs that would 478 carry the password information. A request for authorization SHOULD 479 only include the information from which the authorization will be 480 performed, such as the User-Name, Called-Station-Id, or Calling- 481 Station-Id AVPs. All requests SHOULD contain AVPs uniquely 482 identifying the source of the call, such as Origin-Host and NAS-Port. 483 Certain networks MAY use different AVPs for authorization purposes. 484 A request for authorization will include some AVPs defined in 485 Section 4.4. 487 It is possible for a single session to be authorized first and then 488 for an authentication request to follow. 490 This AA-Request message MAY be the result of a multi-round 491 authentication exchange, which occurs when the AA-Answer message is 492 received with the Result-Code AVP set to DIAMETER_MULTI_ROUND_AUTH. 493 A subsequent AAR message SHOULD be sent, with the User-Password AVP 494 that includes the user's response to the prompt, and MUST include any 495 State AVPs that were present in the AAA message. 497 Message Format 499 ::= < Diameter Header: 265, REQ, PXY > 500 < Session-Id > 501 { Auth-Application-Id } 502 { Origin-Host } 503 { Origin-Realm } 504 { Destination-Realm } 505 { Auth-Request-Type } 506 [ Destination-Host ] 507 [ NAS-Identifier ] 508 [ NAS-IP-Address ] 509 [ NAS-IPv6-Address ] 510 [ NAS-Port ] 511 [ NAS-Port-Id ] 512 [ NAS-Port-Type ] 513 [ Origin-AAA-Protocol ] 514 [ Origin-State-Id ] 515 [ Port-Limit ] 516 [ User-Name ] 517 [ User-Password ] 518 [ Service-Type ] 519 [ State ] 521 [ Authorization-Lifetime ] 522 [ Auth-Grace-Period ] 523 [ Auth-Session-State ] 524 [ Callback-Number ] 525 [ Called-Station-Id ] 526 [ Calling-Station-Id ] 527 [ Originating-Line-Info ] 528 [ Connect-Info ] 529 [ CHAP-Auth ] 530 [ CHAP-Challenge ] 531 * [ Framed-Compression ] 532 [ Framed-Interface-Id ] 533 [ Framed-IP-Address ] 534 * [ Framed-IPv6-Prefix ] 535 [ Framed-IP-Netmask ] 536 [ Framed-MTU ] 537 [ Framed-Protocol ] 538 [ ARAP-Password ] 539 [ ARAP-Security ] 540 * [ ARAP-Security-Data ] 541 * [ Login-IP-Host ] 542 * [ Login-IPv6-Host ] 543 [ Login-LAT-Group ] 544 [ Login-LAT-Node ] 545 [ Login-LAT-Port ] 546 [ Login-LAT-Service ] 547 * [ Tunneling ] 548 * [ Proxy-Info ] 549 * [ Route-Record ] 550 * [ AVP ] 552 3.2. AA-Answer (AAA) Command 554 The AA-Answer (AAA) message is indicated by setting the Command-Code 555 field to 265 and clearing the 'R' bit in the Command Flags field. It 556 is sent in response to the AA-Request (AAR) message. If 557 authorization was requested, a successful response will include the 558 authorization AVPs appropriate for the service being provided, as 559 defined in Section 4.4. 561 For authentication exchanges requiring more than a single round trip, 562 the server MUST set the Result-Code AVP to DIAMETER_MULTI_ROUND_AUTH. 563 An AAA message with this result code MAY include one Reply-Message or 564 more and MAY include zero or one State AVPs. 566 If the Reply-Message AVP was present, the network access server 567 SHOULD send the text to the user's client to display to the user, 568 instructing the client to prompt the user for a response. For 569 example, this can be achieved in PPP via PAP. If it is impossible to 570 deliver the text prompt to the user, the Diameter NAS Application 571 client MUST treat the AA-Answer (AAA) with the Reply-Message AVP as 572 an error and deny access. 574 Message Format 576 ::= < Diameter Header: 265, PXY > 577 < Session-Id > 578 { Auth-Application-Id } 579 { Auth-Request-Type } 580 { Result-Code } 581 { Origin-Host } 582 { Origin-Realm } 583 [ User-Name ] 584 [ Service-Type ] 585 * [ Class ] 586 * [ Configuration-Token ] 587 [ Acct-Interim-Interval ] 588 [ Error-Message ] 589 [ Error-Reporting-Host ] 590 * [ Failed-AVP ] 591 [ Idle-Timeout ] 592 [ Authorization-Lifetime ] 593 [ Auth-Grace-Period ] 594 [ Auth-Session-State ] 595 [ Re-Auth-Request-Type ] 596 [ Multi-Round-Time-Out ] 597 [ Session-Timeout ] 598 [ State ] 599 * [ Reply-Message ] 600 [ Origin-AAA-Protocol ] 601 [ Origin-State-Id ] 602 * [ Filter-Id ] 603 [ Password-Retry ] 604 [ Port-Limit ] 605 [ Prompt ] 606 [ ARAP-Challenge-Response ] 607 [ ARAP-Features ] 608 [ ARAP-Security ] 609 * [ ARAP-Security-Data ] 610 [ ARAP-Zone-Access ] 611 [ Callback-Id ] 612 [ Callback-Number ] 613 [ Framed-Appletalk-Link ] 614 * [ Framed-Appletalk-Network ] 615 [ Framed-Appletalk-Zone ] 616 * [ Framed-Compression ] 618 [ Framed-Interface-Id ] 619 [ Framed-IP-Address ] 620 * [ Framed-IPv6-Prefix ] 621 [ Framed-IPv6-Pool ] 622 * [ Framed-IPv6-Route ] 623 [ Framed-IP-Netmask ] 624 * [ Framed-Route ] 625 [ Framed-Pool ] 626 [ Framed-IPX-Network ] 627 [ Framed-MTU ] 628 [ Framed-Protocol ] 629 [ Framed-Routing ] 630 * [ Login-IP-Host ] 631 * [ Login-IPv6-Host ] 632 [ Login-LAT-Group ] 633 [ Login-LAT-Node ] 634 [ Login-LAT-Port ] 635 [ Login-LAT-Service ] 636 [ Login-Service ] 637 [ Login-TCP-Port ] 638 * [ NAS-Filter-Rule ] 639 * [ QoS-Filter-Rule ] 640 * [ Tunneling ] 641 * [ Redirect-Host ] 642 [ Redirect-Host-Usage ] 643 [ Redirect-Max-Cache-Time ] 644 * [ Proxy-Info ] 645 * [ AVP ] 647 3.3. Re-Auth-Request (RAR) Command 649 A Diameter server can initiate re-authentication and/or re- 650 authorization for a particular session by issuing a Re-Auth-Request 651 (RAR) message [RFC6733]. 653 For example, for pre-paid services, the Diameter server that 654 originally authorized a session may need some confirmation that the 655 user is still using the services. 657 If a NAS receives an RAR message with Session-Id equal to a currently 658 active session and a Re-Auth-Type that includes authentication, it 659 MUST initiate a re-authentication toward the user, if the service 660 supports this particular feature. 662 Message Format 664 ::= < Diameter Header: 258, REQ, PXY > 665 < Session-Id > 666 { Origin-Host } 667 { Origin-Realm } 668 { Destination-Realm } 669 { Destination-Host } 670 { Auth-Application-Id } 671 { Re-Auth-Request-Type } 672 [ User-Name ] 673 [ Origin-AAA-Protocol ] 674 [ Origin-State-Id ] 675 [ NAS-Identifier ] 676 [ NAS-IP-Address ] 677 [ NAS-IPv6-Address ] 678 [ NAS-Port ] 679 [ NAS-Port-Id ] 680 [ NAS-Port-Type ] 681 [ Service-Type ] 682 [ Framed-IP-Address ] 683 [ Framed-IPv6-Prefix ] 684 [ Framed-Interface-Id ] 685 [ Called-Station-Id ] 686 [ Calling-Station-Id ] 687 [ Originating-Line-Info ] 688 [ Acct-Session-Id ] 689 [ Acct-Multi-Session-Id ] 690 [ State ] 691 * [ Class ] 692 [ Reply-Message ] 693 * [ Proxy-Info ] 694 * [ Route-Record ] 695 * [ AVP ] 697 3.4. Re-Auth-Answer (RAA) Command 699 The Re-Auth-Answer (RAA) message [RFC6733] is sent in response to the 700 RAR. The Result-Code AVP MUST be present and indicates the 701 disposition of the request. 703 A successful RAA transaction MUST be followed by an AAR message. 705 Message Format 707 ::= < Diameter Header: 258, PXY > 708 < Session-Id > 709 { Result-Code } 710 { Origin-Host } 711 { Origin-Realm } 712 [ User-Name ] 713 [ Origin-AAA-Protocol ] 714 [ Origin-State-Id ] 715 [ Error-Message ] 716 [ Error-Reporting-Host ] 717 * [ Failed-AVP ] 718 * [ Redirected-Host ] 719 [ Redirected-Host-Usage ] 720 [ Redirected-Host-Cache-Time ] 721 [ Service-Type ] 722 * [ Configuration-Token ] 723 [ Idle-Timeout ] 724 [ Authorization-Lifetime ] 725 [ Auth-Grace-Period ] 726 [ Re-Auth-Request-Type ] 727 [ State ] 728 * [ Class ] 729 * [ Reply-Message ] 730 [ Prompt ] 731 * [ Proxy-Info ] 732 * [ AVP ] 734 3.5. Session-Termination-Request (STR) Command 736 The Session-Termination-Request (STR) message [RFC6733] is sent by 737 the NAS to inform the Diameter Server that an authenticated and/or 738 authorized session is being terminated. 740 Message Format 742 ::= < Diameter Header: 275, REQ, PXY > 743 < Session-Id > 744 { Origin-Host } 745 { Origin-Realm } 746 { Destination-Realm } 747 { Auth-Application-Id } 748 { Termination-Cause } 749 [ User-Name ] 750 [ Destination-Host ] 751 * [ Class ] 752 [ Origin-AAA-Protocol ] 753 [ Origin-State-Id ] 754 * [ Proxy-Info ] 755 * [ Route-Record ] 756 * [ AVP ] 758 3.6. Session-Termination-Answer (STA) Command 760 The Session-Termination-Answer (STA) message [RFC6733] is sent by the 761 Diameter Server to acknowledge the notification that the session has 762 been terminated. The Result-Code AVP MUST be present and MAY contain 763 an indication that an error occurred while the STR was being 764 serviced. 766 Upon sending the STA, the Diameter Server MUST release all resources 767 for the session indicated by the Session-Id AVP. Any intermediate 768 server in the Proxy-Chain MAY also release any resources, if 769 necessary. 771 Message Format 773 ::= < Diameter Header: 275, PXY > 774 < Session-Id > 775 { Result-Code } 776 { Origin-Host } 777 { Origin-Realm } 778 [ User-Name ] 779 * [ Class ] 780 [ Error-Message ] 781 [ Error-Reporting-Host ] 782 * [ Failed-AVP ] 783 [ Origin-AAA-Protocol ] 784 [ Origin-State-Id ] 785 * [ Redirect-Host ] 786 [ Redirect-Host-Usase ] 787 [ Redirect-Max-Cache-Time ] 788 * [ Proxy-Info ] 789 * [ AVP ] 791 3.7. Abort-Session-Request (ASR) Command 793 The Abort-Session-Request (ASR) message [RFC6733] can be sent by any 794 Diameter server to the NAS providing session service to request that 795 the session identified by the Session-Id be stopped. 797 Message Format 799 ::= < Diameter Header: 274, REQ, PXY > 800 < Session-Id > 801 { Origin-Host } 802 { Origin-Realm } 803 { Destination-Realm } 804 { Destination-Host } 805 { Auth-Application-Id } 806 [ User-Name ] 807 [ Origin-AAA-Protocol ] 808 [ Origin-State-Id ] 809 [ NAS-Identifier ] 810 [ NAS-IP-Address ] 811 [ NAS-IPv6-Address ] 812 [ NAS-Port ] 813 [ NAS-Port-Id ] 814 [ NAS-Port-Type ] 815 [ Service-Type ] 816 [ Framed-IP-Address ] 817 [ Framed-IPv6-Prefix ] 818 [ Framed-Interface-Id ] 819 [ Called-Station-Id ] 820 [ Calling-Station-Id ] 821 [ Originating-Line-Info ] 822 [ Acct-Session-Id ] 823 [ Acct-Multi-Session-Id ] 824 [ State ] 825 * [ Class ] 826 * [ Reply-Message ] 827 * [ Proxy-Info ] 828 * [ Route-Record ] 829 * [ AVP ] 831 3.8. Abort-Session-Answer (ASA) Command 833 The ASA message [RFC6733] is sent in response to the ASR. The 834 Result-Code AVP MUST be present and indicates the disposition of the 835 request. 837 If the session identified by Session-Id in the ASR was successfully 838 terminated, Result-Code is set to DIAMETER_SUCCESS. If the session 839 is not currently active, the Result-Code AVP is set to 840 DIAMETER_UNKNOWN_SESSION_ID. If the access device does not stop the 841 session for any other reason, the Result-Code AVP is set to 842 DIAMETER_UNABLE_TO_COMPLY. 844 Message Format 846 ::= < Diameter Header: 274, PXY > 847 < Session-Id > 848 { Result-Code } 849 { Origin-Host } 850 { Origin-Realm } 851 [ User-Name ] 852 [ Origin-AAA-Protocol ] 853 [ Origin-State-Id ] 854 [ State] 855 [ Error-Message ] 856 [ Error-Reporting-Host ] 857 * [ Failed-AVP ] 858 * [ Redirected-Host ] 859 [ Redirected-Host-Usage ] 860 [ Redirected-Max-Cache-Time ] 861 * [ Proxy-Info ] 862 * [ AVP ] 864 3.9. Accounting-Request (ACR) Command 866 The ACR message [RFC6733] is sent by the NAS to report its session 867 information to a target server downstream. 869 The Acct-Application-Id AVP MUST be present. 871 The AVPs listed in the Base protocol specification [RFC6733] MUST be 872 assumed to be present, as appropriate. NAS service-specific 873 accounting AVPs SHOULD be present as described in Section 4.6 and the 874 rest of this specification. 876 Message Format 878 ::= < Diameter Header: 271, REQ, PXY > 879 < Session-Id > 880 { Origin-Host } 881 { Origin-Realm } 882 { Destination-Realm } 883 { Accounting-Record-Type } 884 { Accounting-Record-Number } 885 { Acct-Application-Id } 886 [ User-Name ] 887 [ Accounting-Sub-Session-Id ] 888 [ Acct-Session-Id ] 889 [ Acct-Multi-Session-Id ] 890 [ Origin-AAA-Protocol ] 891 [ Origin-State-Id ] 893 [ Destination-Host ] 894 [ Event-Timestamp ] 895 [ Acct-Delay-Time ] 896 [ NAS-Identifier ] 897 [ NAS-IP-Address ] 898 [ NAS-IPv6-Address ] 899 [ NAS-Port ] 900 [ NAS-Port-Id ] 901 [ NAS-Port-Type ] 902 * [ Class ] 903 [ Service-Type ] 904 [ Termination-Cause ] 905 [ Accounting-Input-Octets ] 906 [ Accounting-Input-Packets ] 907 [ Accounting-Output-Octets ] 908 [ Accounting-Output-Packets ] 909 [ Acct-Authentic ] 910 [ Accounting-Auth-Method ] 911 [ Acct-Link-Count ] 912 [ Acct-Session-Time ] 913 [ Acct-Tunnel-Connection ] 914 [ Acct-Tunnel-Packets-Lost ] 915 [ Callback-Id ] 916 [ Callback-Number ] 917 [ Called-Station-Id ] 918 [ Calling-Station-Id ] 919 * [ Connection-Info ] 920 [ Originating-Line-Info ] 921 [ Authorization-Lifetime ] 922 [ Session-Timeout ] 923 [ Idle-Timeout ] 924 [ Port-Limit ] 925 [ Accounting-Realtime-Required ] 926 [ Acct-Interim-Interval ] 927 * [ Filter-Id ] 928 * [ NAS-Filter-Rule ] 929 * [ Qos-Filter-Rule ] 930 [ Framed-AppleTalk-Link ] 931 [ Framed-AppleTalk-Network ] 932 [ Framed-AppleTalk-Zone ] 933 [ Framed-Compression ] 934 [ Framed-Interface-Id ] 935 [ Framed-IP-Address ] 936 [ Framed-IP-Netmask ] 937 * [ Framed-IPv6-Prefix ] 938 [ Framed-IPv6-Pool ] 939 * [ Framed-IPv6-Route ] 940 [ Framed-IPX-Network ] 942 [ Framed-MTU ] 943 [ Framed-Pool ] 944 [ Framed-Protocol ] 945 * [ Framed-Route ] 946 [ Framed-Routing ] 947 * [ Login-IP-Host ] 948 * [ Login-IPv6-Host ] 949 [ Login-LAT-Group ] 950 [ Login-LAT-Node ] 951 [ Login-LAT-Port ] 952 [ Login-LAT-Service ] 953 [ Login-Service ] 954 [ Login-TCP-Port ] 955 * [ Tunneling ] 956 * [ Proxy-Info ] 957 * [ Route-Record ] 958 * [ AVP ] 960 3.10. Accounting-Answer (ACA) Command 962 The ACA message [RFC6733] is used to acknowledge an Accounting- 963 Request command. The Accounting-Answer command contains the same 964 Session-Id as the Request. 966 Only the target Diameter Server or home Diameter Server SHOULD 967 respond with the Accounting-Answer command. 969 The Acct-Application-Id AVP MUST be present. 971 The AVPs listed in the Base protocol specification [RFC6733] MUST be 972 assumed to be present, as appropriate. NAS service-specific 973 accounting AVPs SHOULD be present as described in Section 4.6 and the 974 rest of this specification. 976 Message Format 978 ::= < Diameter Header: 271, PXY > 979 < Session-Id > 980 { Result-Code } 981 { Origin-Host } 982 { Origin-Realm } 983 { Accounting-Record-Type } 984 { Accounting-Record-Number } 985 { Acct-Application-Id } 986 [ User-Name ] 987 [ Accounting-Sub-Session-Id ] 988 [ Acct-Session-Id ] 989 [ Acct-Multi-Session-Id ] 990 [ Event-Timestamp ] 991 [ Error-Message ] 992 [ Error-Reporting-Host ] 993 * [ Failed-AVP ] 994 [ Origin-AAA-Protocol ] 995 [ Origin-State-Id ] 996 [ NAS-Identifier ] 997 [ NAS-IP-Address ] 998 [ NAS-IPv6-Address ] 999 [ NAS-Port ] 1000 [ NAS-Port-Id ] 1001 [ NAS-Port-Type ] 1002 [ Service-Type ] 1003 [ Termination-Cause ] 1004 [ Accounting-Realtime-Required ] 1005 [ Acct-Interim-Interval ] 1006 * [ Class ] 1007 * [ Proxy-Info ] 1008 * [ AVP ] 1010 4. Diameter NAS Application AVPs 1012 The following sections define a new derived AVP data format, a set of 1013 application-specific AVPs and describe the use of AVPs defined in 1014 other documents by the Diameter NAS Application. 1016 4.1. Derived AVP Data Formats 1018 4.1.1. QoSFilterRule 1020 The QosFilterRule format is derived from the OctetString AVP Base 1021 Format. It uses the ASCII charset. Packets may be marked or metered 1022 based on the following information: 1024 o Direction (in or out) 1026 o Source and destination IP address (possibly masked) 1028 o Protocol 1030 o Source and destination port (lists or ranges) 1032 o DSCP values (no mask or range) 1034 Rules for the appropriate direction are evaluated in order; the first 1035 matched rule terminates the evaluation. Each packet is evaluated 1036 once. If no rule matches, the packet is treated as best effort. An 1037 access device unable to interpret or apply a QoS rule SHOULD NOT 1038 terminate the session. 1040 QoSFilterRule filters MUST follow the following format: 1042 action dir proto from src to dst [options] 1043 where 1045 action 1046 tag Mark packet with a specific DSCP [RFC2474] 1047 meter Meter traffic 1049 dir The format is as described under IPFilterRule 1050 [RFC6733] 1052 proto The format is as described under IPFilterRule 1053 [RFC6733] 1055 src and dst The format is as described under IPFilterRule 1056 [RFC6733] 1058 The options are described in Section 4.4.9. 1060 The rule syntax is a modified subset of ipfw(8) from FreeBSD, and the 1061 ipfw.c code may provide a useful base for implementations. 1063 4.2. NAS Session AVPs 1065 Diameter reserves the AVP Codes 0 - 255 for RADIUS Attributes that 1066 are implemented in Diameter. 1068 4.2.1. Call and Session Information 1070 This section describes the AVPs specific to Diameter applications 1071 that are needed to identify the call and session context and status 1072 information. On a request, this information allows the server to 1073 qualify the session. 1075 These AVPs are used in addition to the following AVPs from the base 1076 protocol specification [RFC6733]: 1078 Session-Id 1079 Auth-Application-Id 1080 Origin-Host 1081 Origin-Realm 1082 Auth-Request-Type 1083 Termination-Cause 1085 The following table gives the possible flag values for the session 1086 level AVPs. 1088 +----------+ 1089 | AVP Flag | 1090 | rules | 1091 |----+-----+ 1092 |MUST| MUST| 1093 Attribute Name Section Defined | | NOT| 1094 -----------------------------------------|----+-----| 1095 NAS-Port 4.2.2 | M | V | 1096 NAS-Port-Id 4.2.3 | M | V | 1097 NAS-Port-Type 4.2.4 | M | V | 1098 Called-Station-Id 4.2.5 | M | V | 1099 Calling-Station-Id 4.2.6 | M | V | 1100 Connect-Info 4.2.7 | M | V | 1101 Originating-Line-Info 4.2.8 | M | V | 1102 Reply-Message 4.2.9 | M | V | 1103 -----------------------------------------|----+-----| 1105 4.2.2. NAS-Port AVP 1107 The NAS-Port AVP (AVP Code 5) is of type Unsigned32 and contains the 1108 physical or virtual port number of the NAS which is authenticating 1109 the user. Note that "port" is meant in its sense as a service 1110 connection on the NAS, not as an IP protocol identifier. 1112 Either the NAS-Port AVP or the NAS-Port-Id AVP (Section 4.2.3) SHOULD 1113 be present in the AA-Request (AAR, Section 3.1) command if the NAS 1114 differentiates among its ports. 1116 4.2.3. NAS-Port-Id AVP 1118 The NAS-Port-Id AVP (AVP Code 87) is of type UTF8String and consists 1119 of 7-bit ASCII text identifying the port of the NAS authenticating 1120 the user. Note that "port" is meant in its sense as a service 1121 connection on the NAS, not as an IP protocol identifier. 1123 Either the NAS-Port-Id AVP or the NAS-Port AVP (Section 4.2.2) SHOULD 1124 be present in the AA-Request (AAR, Section 3.1) command if the NAS 1125 differentiates among its ports. NAS-Port-Id is intended for use by 1126 NASes that cannot conveniently number their ports. 1128 4.2.4. NAS-Port-Type AVP 1130 The NAS-Port-Type AVP (AVP Code 61) is of type Enumerated and 1131 contains the type of the port on which the NAS is authenticating the 1132 user. This AVP SHOULD be present if the NAS uses the same NAS-Port 1133 number ranges for different service types concurrently. 1135 The currently supported values of the NAS-Port-Type AVP are listed in 1136 [RADIUSAttrVals]. 1138 4.2.5. Called-Station-Id AVP 1140 The Called-Station-Id AVP (AVP Code 30) is of type UTF8String and 1141 allows the NAS to send a 7-bit ASCII string describing the Layer 2 1142 address the user contacted in the request. For dialup access, this 1143 can be a phone number obtained by using the Dialed Number 1144 Identification Service (DNIS) or a similar technology. Note that 1145 this may be different from the phone number the call comes in on. 1146 For use with IEEE 802 access, the Called-Station-Id MAY contain a MAC 1147 address formatted as described in Congdon, et al. [RFC3580]. 1149 If the Called-Station-Id AVP is present in an AAR message, Auth- 1150 Request-Type AVP is set to AUTHORIZE_ONLY and the User-Name AVP is 1151 absent, the Diameter Server MAY perform authorization based on this 1152 AVP. This can be used by a NAS to request whether a call should be 1153 answered based on the DNIS result. 1155 Further codification of this field's allowed content and usage is 1156 outside the scope of this specification. 1158 4.2.6. Calling-Station-Id AVP 1160 The Calling-Station-Id AVP (AVP Code 31) is of type UTF8String and 1161 allows the NAS to send a 7-bit ASCII string describing the Layer 2 1162 address from which the user connected in the request. For dialup 1163 access, this is the phone number the call came from, using Automatic 1164 Number Identification (ANI) or a similar technology. For use with 1165 IEEE 802 access, the Calling-Station-Id AVP MAY contain a MAC 1166 address, formated as described in RFC 3580. 1168 If the Calling-Station-Id AVP is present in an AAR message, the Auth- 1169 Request-Type AVP is set to AUTHORIZE_ONLY and the User-Name AVP is 1170 absent, the Diameter Server MAY perform authorization based on the 1171 value of this AVP. This can be used by a NAS to request whether a 1172 call should be answered based on the Layer 2 address (ANI, MAC 1173 Address, etc.) 1175 Further codification of this field's allowed content and usage is 1176 outside the scope of this specification. 1178 4.2.7. Connect-Info AVP 1180 The Connect-Info AVP (AVP Code 77) is of type UTF8String and is sent 1181 in the AA-Request message or an ACR message with the value of the 1182 Accounting-Record-Type AVP set to STOP. When sent in the AA-Request, 1183 it indicates the nature of the user's connection. The connection 1184 speed SHOULD be included at the beginning of the first Connect-Info 1185 AVP in the message. If the transmit and receive connection speeds 1186 differ, both may be included in the first AVP with the transmit speed 1187 listed first (the speed at which the NAS modem transmits), then a 1188 slash (/), then the receive speed, and then other optional 1189 information. 1191 For example: "28800 V42BIS/LAPM" or "52000/31200 V90" 1193 If sent in an ACR message with the value of the Accounting-Record- 1194 Type AVP set to STOP, this attribute may summarize statistics 1195 relating to session quality. For example, in IEEE 802.11, the 1196 Connect-Info AVP may contain information on the number of link layer 1197 retransmissions. The exact format of this attribute is 1198 implementation specific. 1200 4.2.8. Originating-Line-Info AVP 1202 The Originating-Line-Info AVP (AVP Code 94) is of type OctetString 1203 and is sent by the NAS system to convey information about the origin 1204 of the call from an SS7 system. 1206 The Originating Line Information (OLI) element indicates the nature 1207 and/or characteristics of the line from which a call originated 1208 (e.g., pay phone, hotel, cellular). Telephone companies are starting 1209 to offer OLI to their customers as an option over Primary Rate 1210 Interface (PRI). Internet Service Providers (ISPs) can use OLI in 1211 addition to Called-Station-Id and Calling-Station-Id attributes to 1212 differentiate customer calls and to define different services. 1214 The Value field contains two octets (00 - 99). ANSI T1.113 and 1215 BELLCORE 394 can be used for additional information about these 1216 values and their use. For information on the currently assigned 1217 values, see [ANITypes]. 1219 4.2.9. Reply-Message AVP 1221 The Reply-Message AVP (AVP Code 18) is of type UTF8String and 1222 contains text that MAY be displayed to the user. When used in an AA- 1223 Answer message with a successful Result-Code AVP, it indicates 1224 success. When found in an AAA message with a Result-Code other than 1225 DIAMETER_SUCCESS, the AVP contains a failure message. 1227 The Reply-Message AVP MAY contain text to prompt the user before 1228 another AA-Request attempt. When used in an AA-Answer message 1229 containing a Result-Code AVP with the value DIAMETER_MULTI_ROUND_AUTH 1230 or in an Re-Auth-Request message, it MAY contain text to prompt the 1231 user for a response. 1233 4.3. NAS Authentication AVPs 1235 This section defines the AVPs necessary to carry the authentication 1236 information in the Diameter protocol. The functionality defined here 1237 provides a RADIUS-like AAA service [RFC2865] over a more reliable and 1238 secure transport, as defined in the base protocol [RFC6733]. 1240 The following table gives the possible flag values for the session 1241 level AVPs. 1243 +----------+ 1244 | AVP Flag | 1245 | rules | 1246 |----+-----| 1247 |MUST| MUST| 1248 Attribute Name Section Defined | | NOT| 1249 -----------------------------------------|----+-----| 1250 User-Password 4.3.1 | M | V | 1251 Password-Retry 4.3.2 | M | V | 1252 Prompt 4.3.3 | M | V | 1253 CHAP-Auth 4.3.4 | M | V | 1254 CHAP-Algorithm 4.3.5 | M | V | 1255 CHAP-Ident 4.3.6 | M | V | 1256 CHAP-Response 4.3.7 | M | V | 1257 CHAP-Challenge 4.3.8 | M | V | 1258 ARAP-Password 4.3.9 | M | V | 1259 ARAP-Challenge-Response 4.3.10 | M | V | 1260 ARAP-Security 4.3.11 | M | V | 1261 ARAP-Security-Data 4.3.12 | M | V | 1262 -----------------------------------------|----+-----| 1264 4.3.1. User-Password AVP 1266 The User-Password AVP (AVP Code 2) is of type OctetString and 1267 contains the password of the user to be authenticated, or the user's 1268 input in a multi-round authentication exchange. 1270 The User-Password AVP contains a user password or one-time password 1271 and therefore represents sensitive information. As required by 1272 Fajardo, et al. [RFC6733], Diameter messages are encrypted by using 1273 IPsec [RFC4301] or TLS [RFC5246]. Unless this AVP is used for one- 1274 time passwords, the User-Password AVP SHOULD NOT be used in untrusted 1275 proxy environments without encrypting it by using end-to-end security 1276 techniques. 1278 The clear-text password (prior to encryption) MUST NOT be longer than 1279 128 bytes in length. 1281 4.3.2. Password-Retry AVP 1283 The Password-Retry AVP (AVP Code 75) is of type Unsigned32 and MAY be 1284 included in the AA-Answer if the Result-Code indicates an 1285 authentication failure. The value of this AVP indicates how many 1286 authentication attempts a user is permitted before being 1287 disconnected. This AVP is primarily intended for use when the 1288 Framed-Protocol AVP (Section 4.4.10.1) is set to ARAP. 1290 4.3.3. Prompt AVP 1292 The Prompt AVP (AVP Code 76) is of type Enumerated and MAY be present 1293 in the AA-Answer message. When present, it is used by the NAS to 1294 determine whether the user's response, when entered, should be 1295 echoed. 1297 The supported values are listed in [RADIUSAttrVals] 1299 4.3.4. CHAP-Auth AVP 1301 The CHAP-Auth AVP (AVP Code 402) is of type Grouped and contains the 1302 information necessary to authenticate a user using the PPP Challenge- 1303 Handshake Authentication Protocol (CHAP) [RFC1994]. If the CHAP-Auth 1304 AVP is found in a message, the CHAP-Challenge AVP (Section 4.3.8) 1305 MUST be present as well. The optional AVPs containing the CHAP 1306 response depend upon the value of the CHAP-Algorithm AVP 1307 (Section 4.3.8). The grouped AVP has the following ABNF grammar: 1309 CHAP-Auth ::= < AVP Header: 402 > 1310 { CHAP-Algorithm } 1311 { CHAP-Ident } 1312 [ CHAP-Response ] 1313 * [ AVP ] 1315 4.3.5. CHAP-Algorithm AVP 1317 The CHAP-Algorithm AVP (AVP Code 403) is of type Enumerated and 1318 contains the algorithm identifier used in the computation of the CHAP 1319 response [RFC1994]. The following values are currently supported: 1321 CHAP with MD5 5 The CHAP response is computed by using the procedure 1322 described in [RFC1994] This algorithm requires that the CHAP- 1323 Response AVP (Section 4.3.7) MUST be present in the CHAP-Auth AVP 1324 (Section 4.3.4). 1326 4.3.6. CHAP-Ident AVP 1328 The CHAP-Ident AVP (AVP Code 404) is of type OctetString and contains 1329 the 1 octet CHAP Identifier used in the computation of the CHAP 1330 response [RFC1994] 1332 4.3.7. CHAP-Response AVP 1334 The CHAP-Response AVP (AVP Code 405) is of type OctetString and 1335 contains the 16 octet authentication data provided by the user in 1336 response to the CHAP challenge [RFC1994]. 1338 4.3.8. CHAP-Challenge AVP 1340 The CHAP-Challenge AVP (AVP Code 60) is of type OctetString and 1341 contains the CHAP Challenge sent by the NAS to the CHAP peer 1342 [RFC1994]. 1344 4.3.9. ARAP-Password AVP 1346 The ARAP-Password AVP (AVP Code 70) is of type OctetString and is 1347 only present when the Framed-Protocol AVP (Section 4.4.10.1) is 1348 included in the message and is set to ARAP. This AVP MUST NOT be 1349 present if either the User-Password or the CHAP-Auth AVP is present. 1350 See Rigney, et al. [RFC2869] for more information on the contents of 1351 this AVP. 1353 4.3.10. ARAP-Challenge-Response AVP 1355 The ARAP-Challenge-Response AVP (AVP Code 84) is of type OctetString 1356 and is only present when the Framed-Protocol AVP (Section 4.4.10.1) 1357 is included in the message and is set to ARAP. This AVP contains an 1358 8 octet response to the dial-in client's challenge. The Diameter 1359 server calculates this value by taking the dial-in client's challenge 1360 from the high-order 8 octets of the ARAP-Password AVP and performing 1361 DES encryption on this value with the authenticating user's password 1362 as the key. If the user's password is fewer than 8 octets in length, 1363 the password is padded at the end with NULL octets to a length of 8 1364 before it is used as a key. 1366 4.3.11. ARAP-Security AVP 1368 The ARAP-Security AVP (AVP Code 73) is of type Unsigned32 and MAY be 1369 present in the AA-Answer message if the Framed-Protocol AVP 1370 (Section 4.4.10.1) is set to the value of ARAP, and the Result-Code 1371 AVP ([RFC6733], Section 7.1) is set to DIAMETER_MULTI_ROUND_AUTH. 1372 See RFC 2869 for more information on the contents of this AVP. 1374 4.3.12. ARAP-Security-Data AVP 1376 The ARAP-Security-Data AVP (AVP Code 74) is of type OctetString and 1377 MAY be present in the AA-Request or AA-Answer message if the Framed- 1378 Protocol AVP (Section 4.4.10.1) is set to the value of ARAP and the 1379 Result-Code AVP ([RFC6733], Section 7.1) is set to 1380 DIAMETER_MULTI_ROUND_AUTH. This AVP contains the security module 1381 challenge or response associated with the ARAP Security Module 1382 specified in the ARAP-Security AVP (Section 4.3.11). 1384 4.4. NAS Authorization AVPs 1386 This section contains the authorization AVPs supported in the NAS 1387 Application. The Service-Type AVP SHOULD be present in all messages 1388 and, based on its value, additional AVPs defined in this section and 1389 Section 4.5 MAY be present. 1391 The following table gives the possible flag values for the session- 1392 level AVPs. 1394 +----------+ 1395 | AVP Flag | 1396 | rules | 1397 |----+-----| 1398 |MUST| MUST| 1399 Attribute Name Section Defined | | NOT| 1400 -----------------------------------------|----+-----| 1401 Service-Type 4.4.1 | M | V | 1402 Callback-Number 4.4.2 | M | V | 1403 Callback-Id 4.4.3 | M | V | 1404 Idle-Timeout 4.4.4 | M | V | 1405 Port-Limit 4.4.5 | M | V | 1406 NAS-Filter-Rule 4.4.6 | M | V | 1407 Filter-Id 4.4.7 | M | V | 1408 Configuration-Token 4.4.8 | M | V | 1409 QoS-Filter-Rule 4.4.9 | | | 1410 Framed-Protocol 4.4.10.1 | M | V | 1411 Framed-Routing 4.4.10.2 | M | V | 1412 Framed-MTU 4.4.10.3 | M | V | 1413 Framed-Compression 4.4.10.4 | M | V | 1414 Framed-IP-Address 4.4.10.5.1 | M | V | 1415 Framed-IP-Netmask 4.4.10.5.2 | M | V | 1416 Framed-Route 4.4.10.5.3 | M | V | 1417 Framed-Pool 4.4.10.5.4 | M | V | 1418 Framed-Interface-Id 4.4.10.5.5 | M | V | 1419 Framed-IPv6-Prefix 4.4.10.5.6 | M | V | 1420 Framed-IPv6-Route 4.4.10.5.7 | M | V | 1421 Framed-IPv6-Pool 4.4.10.5.8 | M | V | 1422 Framed-IPX-Network 4.4.10.6.1 | M | V | 1423 Framed-Appletalk-Link 4.4.10.7.1 | M | V | 1424 Framed-Appletalk-Network 4.4.10.7.2 | M | V | 1425 Framed-Appletalk-Zone 4.4.10.7.3 | M | V | 1426 ARAP-Features 4.4.10.8.1 | M | V | 1427 ARAP-Zone-Access 4.4.10.8.2 | M | V | 1428 Login-IP-Host 4.4.11.1 | M | V | 1429 Login-IPv6-Host 4.4.11.2 | M | V | 1430 Login-Service 4.4.11.3 | M | V | 1431 Login-TCP-Port 4.4.11.4.1 | M | V | 1432 Login-LAT-Service 4.4.11.5.1 | M | V | 1433 Login-LAT-Node 4.4.11.5.2 | M | V | 1434 Login-LAT-Group 4.4.11.5.3 | M | V | 1435 Login-LAT-Port 4.4.11.5.4 | M | V | 1436 -----------------------------------------|----+-----| 1438 4.4.1. Service-Type AVP 1440 The Service-Type AVP (AVP Code 6) is of type Enumerated and contains 1441 the type of service the user has requested or the type of service to 1442 be provided. One such AVP MAY be present in an authentication and/or 1443 authorization request or response. A NAS is not required to 1444 implement all of these service types. It MUST treat unknown or 1445 unsupported Service-Types received in a response as a failure and end 1446 the session with a DIAMETER_INVALID_AVP_VALUE Result-Code. 1448 When used in a request, the Service-Type AVP SHOULD be considered a 1449 hint to the server that the NAS believes the user would prefer the 1450 kind of service indicated. The server is not required to honor the 1451 hint. Furthermore, if the service specified by the server is 1452 supported, but not compatible with the current mode of access, the 1453 NAS MUST fail to start the session. The NAS MUST also generate the 1454 appropriate error message(s). 1456 The complete list of defined values that the Service-Type AVP can 1457 take can be found in [RFC2865] and [RADIUSAttrVals], but the 1458 following values require further qualification here: 1460 Login (1) 1461 The user should be connected to a host. The message MAY 1462 include additional AVPs as defined in Section 4.4.11.4 or 1463 Section 4.4.11.5. 1465 Framed (2) 1466 A Framed Protocol, such as PPP or SLIP, should be started for 1467 the User. The message MAY include additional AVPs defined in 1468 Section 4.4.10, or Section 4.5 for tunneling services. 1470 Callback Login (3) 1471 The user should be disconnected and called back, then connected 1472 to a host. The message MAY include additional AVPs defined in 1473 this Section. 1475 Callback Framed (4) 1476 The user should be disconnected and called back, and then a 1477 Framed Protocol, such as PPP or SLIP, should be started for the 1478 User. The message MAY include additional AVPs defined in 1479 Section 4.4.10, or Section 4.5 for tunneling services. 1481 4.4.2. Callback-Number AVP 1483 The Callback-Number AVP (AVP Code 19) is of type UTF8String and 1484 contains a dialing string to be used for callback. It MAY be used in 1485 an authentication and/or authorization request as a hint to the 1486 server that a Callback service is desired, but the server is not 1487 required to honor the hint in the corresponding response. 1489 The codification of this field's allowed usage range is outside the 1490 scope of this specification. 1492 4.4.3. Callback-Id AVP 1494 The Callback-Id AVP (AVP Code 20) is of type UTF8String and contains 1495 the name of a place to be called, to be interpreted by the NAS. This 1496 AVP MAY be present in an authentication and/or authorization 1497 response. 1499 This AVP is not roaming-friendly as it assumes that the Callback-Id 1500 is configured on the NAS. Using the Callback-Number AVP 1501 (Section 4.4.2) is therefore preferable. 1503 4.4.4. Idle-Timeout AVP 1505 The Idle-Timeout AVP (AVP Code 28) is of type Unsigned32 and sets the 1506 maximum number of consecutive seconds of idle connection allowable to 1507 the user before termination of the session or before a prompt is 1508 issued. The default is none, or system specific. 1510 4.4.5. Port-Limit AVP 1512 The Port-Limit AVP (AVP Code 62) is of type Unsigned32 and sets the 1513 maximum number of ports the NAS provides to the user. It MAY be used 1514 in an authentication and/or authorization request as a hint to the 1515 server that multilink PPP [RFC1990] service is desired, but the 1516 server is not required to honor the hint in the corresponding 1517 response. 1519 4.4.6. NAS-Filter-Rule AVP 1521 The NAS-Filter-Rule AVP (AVP Code 400) is of type IPFilterRule and 1522 provides filter rules that need to be configured on the NAS for the 1523 user. One or more of these AVPs MAY be present in an authorization 1524 response. 1526 4.4.7. Filter-Id AVP 1528 The Filter-Id AVP (AVP Code 11) is of type UTF8String and contains 1529 the name of the filter list for this user. It is intended to be 1530 human-readable. Zero or more Filter-Id AVPs MAY be sent in an 1531 authorization answer message. 1533 Identifying a filter list by name allows the filter to be used on 1534 different NASes without regard to filter-list implementation details. 1535 However, this AVP is not roaming-friendly, as filter naming differs 1536 from one service provider to another. 1538 In environments where backward compatibility with RADIUS is not 1539 required, it is RECOMMENDED that the NAS-Filter-Rule AVP 1540 (Section 4.4.6) be used instead. 1542 4.4.8. Configuration-Token AVP 1544 The Configuration-Token AVP (AVP Code 78) is of type OctetString and 1545 is sent by a Diameter Server to a Diameter Proxy Agent in an AA- 1546 Answer command to indicate a type of user profile to be used. It 1547 should not be sent to a Diameter Client (NAS). 1549 The format of the Data field of this AVP is site specific. 1551 4.4.9. QoS-Filter-Rule AVP 1553 The QoS-Filter-Rule AVP (AVP Code 407) is of type QoSFilterRule 1554 (Section 4.1.1) and provides QoS filter rules that need to be 1555 configured on the NAS for the user. One or more such AVPs MAY be 1556 present in an authorization response. 1558 The use of this AVP is NOT RECOMMENDED; the AVPs defined by Korhonen, 1559 et al. [RFC5777] SHOULD be used instead. 1561 The following options are defined for the QoSFilterRule filters: 1563 DSCP If action is set to tag (Section 4.1.1) this option 1564 MUST be included in the rule. 1566 Color values are defined in Nichols, et al. [RFC2474]. Exact 1567 matching of DSCP values is required (no masks or ranges). 1569 metering The metering option 1570 provides Assured Forwarding, as defined in Heinanen, et al. 1571 [RFC2597]. and MUST be present if the action is set to meter 1572 (Section 4.1.1) The rate option is the throughput, in bits per 1573 second, used by the access device to mark packets. Traffic 1574 over the rate is marked with the color_over codepoint, and 1575 traffic under the rate is marked with the color_under 1576 codepoint. The color_under and color_over options contain the 1577 drop preferences and MUST conform to the recommended codepoint 1578 keywords described in RFC 2597 (e.g., AF13). 1580 The metering option also supports the strict limit on traffic 1581 required by Expedited Forwarding, as defined in Davie, et 1582 al. [RFC3246]. The color_over option may contain the keyword 1583 "drop" to prevent forwarding of traffic that exceeds the rate 1584 parameter. 1586 4.4.10. Framed Access Authorization AVPs 1588 This section lists the authorization AVPs necessary to support framed 1589 access, such as PPP and SLIP. AVPs defined in this section MAY be 1590 present in a message if the Service-Type AVP was set to "Framed" or 1591 "Callback Framed". 1593 4.4.10.1. Framed-Protocol AVP 1595 The Framed-Protocol AVP (AVP Code 7) is of type Enumerated and 1596 contains the framing to be used for framed access. This AVP MAY be 1597 present in both requests and responses. The supported values are 1598 listed in [RADIUSAttrVals]. 1600 4.4.10.2. Framed-Routing AVP 1602 The Framed-Routing AVP (AVP Code 10) is of type Enumerated and 1603 contains the routing method for the user when the user is a router to 1604 a network. This AVP SHOULD only be present in authorization 1605 responses. The supported values are listed in [RADIUSAttrVals]. 1607 4.4.10.3. Framed-MTU AVP 1609 The Framed-MTU AVP (AVP Code 12) is of type Unsigned32 and contains 1610 the Maximum Transmission Unit (MTU) to be configured for the user, 1611 when it is not negotiated by some other means (such as PPP). This 1612 AVP SHOULD only be present in authorization responses. The MTU value 1613 MUST be in the range from 64 to 65535. 1615 4.4.10.4. Framed-Compression AVP 1617 The Framed-Compression AVP (AVP Code 13) is of type Enumerated and 1618 contains the compression protocol to be used for the link. It MAY be 1619 used in an authorization request as a hint to the server that a 1620 specific compression type is desired, but the server is not required 1621 to honor the hint in the corresponding response. 1623 More than one compression protocol AVP MAY be sent. The NAS is 1624 responsible for applying the proper compression protocol to the 1625 appropriate link traffic. 1627 The supported values are listed in [RADIUSAttrVals]. 1629 4.4.10.5. IP Access Authorization AVPs 1631 The AVPs defined in this section are used when the user requests, or 1632 is being granted, access service to IP. 1634 4.4.10.5.1. Framed-IP-Address AVP 1636 The Framed-IP-Address AVP (AVP Code 8) [RFC2865] is of type 1637 OctetString and contains an IPv4 address of the type specified in the 1638 attribute value to be configured for the user. It MAY be used in an 1639 authorization request as a hint to the server that a specific address 1640 is desired, but the server is not required to honor the hint in the 1641 corresponding response. 1643 Two values have special significance: 0xFFFFFFFF and 0xFFFFFFFE. The 1644 value 0xFFFFFFFF indicates that the NAS should allow the user to 1645 select an address (i.e., negotiated). The value 0xFFFFFFFE indicates 1646 that the NAS should select an address for the user (e.g., assigned 1647 from a pool of addresses kept by the NAS). 1649 4.4.10.5.2. Framed-IP-Netmask AVP 1651 The Framed-IP-Netmask AVP (AVP Code 9) is of type OctetString and 1652 contains the four octets of the IPv4 netmask to be configured for the 1653 user when the user is a router to a network. It MAY be used in an 1654 authorization request as a hint to the server that a specific netmask 1655 is desired, but the server is not required to honor the hint in the 1656 corresponding response. This AVP MUST be present in a response if 1657 the request included this AVP with a value of 0xFFFFFFFF. 1659 4.4.10.5.3. Framed-Route AVP 1661 The Framed-Route AVP (AVP Code 22) is of type UTF8String and contains 1662 the 7-bit ASCII routing information to be configured for the user on 1663 the NAS. Zero or more of these AVPs MAY be present in an 1664 authorization response. 1666 The string MUST contain a destination prefix in dotted quad form 1667 optionally followed by a slash and a decimal length specifier stating 1668 how many high-order bits of the prefix should be used. This is 1669 followed by a space, a gateway address in dotted quad form, a space, 1670 and one or more metrics separated by spaces; for example, 1672 "192.0.2.0/24 192.0.2.1 1" 1674 The length specifier may be omitted, in which case it should default 1675 to 8 bits for class A prefixes, to 16 bits for class B prefixes, and 1676 to 24 bits for class C prefixes; for example, 1677 "192.0.2.0 192.0.2.1 1" 1679 Whenever the gateway address is specified as "0.0.0.0" the IP address 1680 of the user SHOULD be used as the gateway address. 1682 4.4.10.5.4. Framed-Pool AVP 1684 The Framed-Pool AVP (AVP Code 88) is of type OctetString and contains 1685 the name of an assigned address pool that SHOULD be used to assign an 1686 address for the user. If a NAS does not support multiple address 1687 pools, the NAS SHOULD ignore this AVP. Address pools are usually 1688 used for IP addresses but can be used for other protocols if the NAS 1689 supports pools for those protocols. 1691 Although specified as type OctetString for compatibility with RADIUS 1692 [RFC2865], the encoding of the Data field SHOULD also conform to the 1693 rules for the UTF8String Data Format. 1695 4.4.10.5.5. Framed-Interface-Id AVP 1697 The Framed-Interface-Id AVP (AVP Code 96) is of type Unsigned64 and 1698 contains the IPv6 interface identifier to be configured for the user. 1699 It MAY be used in authorization requests as a hint to the server that 1700 a specific interface id is desired, but the server is not required to 1701 honor the hint in the corresponding response. 1703 4.4.10.5.6. Framed-IPv6-Prefix AVP 1705 The Framed-IPv6-Prefix AVP (AVP Code 97) is of type OctetString and 1706 contains the IPv6 prefix to be configured for the user. One or more 1707 AVPs MAY be used in authorization requests as a hint to the server 1708 that specific IPv6 prefixes are desired, but the server is not 1709 required to honor the hint in the corresponding response. 1711 4.4.10.5.7. Framed-IPv6-Route AVP 1713 The Framed-IPv6-Route AVP (AVP Code 99) is of type UTF8String and 1714 contains the ASCII routing information to be configured for the user 1715 on the NAS. Zero or more of these AVPs MAY be present in an 1716 authorization response. 1718 The string MUST contain an IPv6 address prefix followed by a slash 1719 and a decimal length specifier stating how many high order bits of 1720 the prefix should be used. This is followed by a space, a gateway 1721 address in hexadecimal notation, a space, and one or more metrics 1722 separated by spaces; for example, 1723 "2001:db8::/32 2001:db8:106:a00:20ff:fe99:a998 1" 1725 Whenever the gateway address is the IPv6 unspecified address, the IP 1726 address of the user SHOULD be used as the gateway address, such as 1727 in: 1729 "2001:db8::/32 :: 1" 1731 4.4.10.5.8. Framed-IPv6-Pool AVP 1733 The Framed-IPv6-Pool AVP (AVP Code 100) is of type OctetString and 1734 contains the name of an assigned pool that SHOULD be used to assign 1735 an IPv6 prefix for the user. If the access device does not support 1736 multiple prefix pools, it MUST ignore this AVP. 1738 Although specified as type OctetString for compatibility with RADIUS 1739 [RFC3162], the encoding of the Data field SHOULD also conform to the 1740 rules for the UTF8String Data Format. 1742 4.4.10.6. IPX Access AVPs 1744 The AVPs defined in this section are used when the user requests, or 1745 is being granted, access to an IPX network service [IPX]. 1747 4.4.10.6.1. Framed-IPX-Network AVP 1749 The Framed-IPX-Network AVP (AVP Code 23) is of type Unsigned32 and 1750 contains the IPX Network number to be configured for the user. It 1751 MAY be used in an authorization request as a hint to the server that 1752 a specific address is desired, but the server is not required to 1753 honor the hint in the corresponding response. 1755 Two addresses have special significance: 0xFFFFFFFF and 0xFFFFFFFE. 1756 The value 0xFFFFFFFF indicates that the NAS should allow the user to 1757 select an address (i.e., Negotiated). The value 0xFFFFFFFE indicates 1758 that the NAS should select an address for the user (e.g., assign it 1759 from a pool of one or more IPX networks kept by the NAS). 1761 4.4.10.7. AppleTalk Network Access AVPs 1763 The AVPs defined in this section are used when the user requests, or 1764 is being granted, access to an AppleTalk network [AppleTalk]. 1766 4.4.10.7.1. Framed-AppleTalk-Link AVP 1768 The Framed-AppleTalk-Link AVP (AVP Code 37) is of type Unsigned32 and 1769 contains the AppleTalk network number that should be used for the 1770 serial link to the user, which is another AppleTalk router. This AVP 1771 MUST only be present in an authorization response and is never used 1772 when the user is not another router. 1774 Despite the size of the field, values range from 0 to 65,535. The 1775 special value of 0 indicates an unnumbered serial link. A value of 1 1776 to 65,535 means that the serial line between the NAS and the user 1777 should be assigned that value as an AppleTalk network number. 1779 4.4.10.7.2. Framed-AppleTalk-Network AVP 1781 The Framed-AppleTalk-Network AVP (AVP Code 38) is of type Unsigned32 1782 and contains the AppleTalk Network number that the NAS should probe 1783 to allocate an AppleTalk node for the user. This AVP MUST only be 1784 present in an authorization response and is never used when the user 1785 is not another router. Multiple instances of this AVP indicate that 1786 the NAS may probe, using any of the network numbers specified. 1788 Despite the size of the field, values range from 0 to 65,535. The 1789 special value 0 indicates that the NAS should assign a network for 1790 the user, using its default cable range. A value between 1 and 1791 65,535 (inclusive) indicates to the AppleTalk Network that the NAS 1792 should probe to find an address for the user. 1794 4.4.10.7.3. Framed-AppleTalk-Zone AVP 1796 The Framed-AppleTalk-Zone AVP (AVP Code 39) is of type OctetString 1797 and contains the AppleTalk Default Zone to be used for this user. 1798 This AVP MUST only be present in an authorization response. Multiple 1799 instances of this AVP in the same message are not allowed. 1801 The codification of this field's allowed range is outside the scope 1802 of this specification. 1804 4.4.10.8. AppleTalk Remote Access AVPs 1806 The AVPs defined in this section are used when the user requests, or 1807 is being granted, access to the AppleTalk network via the AppleTalk 1808 Remote Access Protocol [ARAP]. They are only present if the Framed- 1809 Protocol AVP (Section 4.4.10.1) is set to ARAP. Section 2.2 of RFC 1810 2869 describes the operational use of these attributes. 1812 4.4.10.8.1. ARAP-Features AVP 1814 The ARAP-Features AVP (AVP Code 71) is of type OctetString and MAY be 1815 present in the AA-Accept message if the Framed-Protocol AVP is set to 1816 the value of ARAP. See RFC 2869 for more information about the 1817 format of this AVP. 1819 4.4.10.8.2. ARAP-Zone-Access AVP 1821 The ARAP-Zone-Access AVP (AVP Code 72) is of type Enumerated and MAY 1822 be present in the AA-Accept message if the Framed-Protocol AVP is set 1823 to the value of ARAP. 1825 The supported values are listed in [RADIUSAttrVals] and defined in 1826 RFC 2869. 1828 4.4.11. Non-Framed Access Authorization AVPs 1830 This section contains the authorization AVPs that are needed to 1831 support terminal server functionality. AVPs defined in this section 1832 MAY be present in a message if the Service-Type AVP was set to 1833 "Login" or "Callback Login". 1835 4.4.11.1. Login-IP-Host AVP 1837 The Login-IP-Host AVP (AVP Code 14) [RFC2865] is of type OctetString 1838 and contains the IPv4 address of a host with which to connect the 1839 user when the Login-Service AVP is included. It MAY be used in an 1840 AA-Request command as a hint to the Diameter Server that a specific 1841 host is desired, but the Diameter Server is not required to honor the 1842 hint in the AA-Answer. 1844 Two addresses have special significance: all ones and 0. The value 1845 of all ones indicates that the NAS SHOULD allow the user to select an 1846 address. The value 0 indicates that the NAS SHOULD select a host to 1847 connect the user to. 1849 4.4.11.2. Login-IPv6-Host AVP 1851 The Login-IPv6-Host AVP (AVP Code 98) [RFC3162] is of type 1852 OctetString and contains the IPv6 address of a host with which to 1853 connect the user when the Login-Service AVP is included. It MAY be 1854 used in an AA-Request command as a hint to the Diameter Server that a 1855 specific host is desired, but the Diameter Server is not required to 1856 honor the hint in the AA-Answer. 1858 Two addresses have special significance, 1859 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF and 0. The value 1860 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF indicates that the NAS SHOULD 1861 allow the user to select an address. The value 0 indicates that the 1862 NAS SHOULD select a host to connect the user to. 1864 4.4.11.3. Login-Service AVP 1866 The Login-Service AVP (AVP Code 15) is of type Enumerated and 1867 contains the service that should be used to connect the user to the 1868 login host. This AVP SHOULD only be present in authorization 1869 responses. The supported values are listed in RFC 2869. 1871 4.4.11.4. TCP Services 1873 The AVP described in the following section MAY be present if the 1874 Login-Service AVP is set to Telnet, Rlogin, TCP Clear, or TCP Clear 1875 Quiet. 1877 4.4.11.4.1. Login-TCP-Port AVP 1879 The Login-TCP-Port AVP (AVP Code 16) is of type Unsigned32 and 1880 contains the TCP port with which the user is to be connected when the 1881 Login-Service AVP is also present. This AVP SHOULD only be present 1882 in authorization responses. The value MUST NOT be greater than 1883 65,535. 1885 4.4.11.5. LAT Services 1887 The AVPs described in this section MAY be present if the Login- 1888 Service AVP is set to LAT [LAT]. 1890 4.4.11.5.1. Login-LAT-Service AVP 1892 The Login-LAT-Service AVP (AVP Code 34) is of type OctetString and 1893 contains the system with which the user is to be connected by LAT. 1894 It MAY be used in an authorization request as a hint to the server 1895 that a specific service is desired, but the server is not required to 1896 honor the hint in the corresponding response. This AVP MUST only be 1897 present in the response if the Login-Service AVP states that LAT is 1898 desired. 1900 Administrators use this service attribute when dealing with clustered 1901 systems. In these environments, several different time-sharing hosts 1902 share the same resources (disks, printers, etc.), and administrators 1903 often configure each host to offer access (service) to each of the 1904 shared resources. In this case, each host in the cluster advertises 1905 its services through LAT broadcasts. 1907 Sophisticated users often know which service providers (machines) are 1908 faster and tend to use a node name when initiating a LAT connection. 1909 Some administrators want particular users to use certain machines as 1910 a primitive form of load balancing (although LAT knows how to do load 1911 balancing itself). 1913 The String field contains the identity of the LAT service to use. 1914 The LAT Architecture allows this string to contain $ (dollar), - 1915 (hyphen), . (period), _ (underscore), numerics, upper- and lowercase 1916 alphabetics, and the ISO Latin-1 character set extension 1917 [ISO.8859-1.1987]. All LAT string comparisons are case insensitive. 1919 4.4.11.5.2. Login-LAT-Node AVP 1921 The Login-LAT-Node AVP (AVP Code 35) is of type OctetString and 1922 contains the Node with which the user is to be automatically 1923 connected by LAT. It MAY be used in an authorization request as a 1924 hint to the server that a specific LAT node is desired, but the 1925 server is not required to honor the hint in the corresponding 1926 response. This AVP MUST only be present in a response if the Login- 1927 Service-Type AVP is set to LAT. 1929 The String field contains the identity of the LAT service to use. 1930 The LAT Architecture allows this string to contain $ (dollar), - 1931 (hyphen), . (period), _ (underscore), numerics, upper- and lowercase 1932 alphabetics, and the ISO Latin-1 character set extension 1933 [ISO.8859-1.1987]. All LAT string comparisons are case insensitive. 1935 4.4.11.5.3. Login-LAT-Group AVP 1937 The Login-LAT-Group AVP (AVP Code 36) is of type OctetString and 1938 contains a string identifying the LAT group codes this user is 1939 authorized to use. It MAY be used in an authorization request as a 1940 hint to the server that a specific group is desired, but the server 1941 is not required to honor the hint in the corresponding response. 1942 This AVP MUST only be present in a response if the Login-Service-Type 1943 AVP is set to LAT. 1945 LAT supports 256 different group codes, which LAT uses as a form of 1946 access rights. LAT encodes the group codes as a 256-bit bitmap. 1948 Administrators can assign one or more of the group code bits at the 1949 LAT service provider; it will only accept LAT connections that have 1950 these group codes set in the bitmap. The administrators assign a 1951 bitmap of authorized group codes to each user. LAT gets these from 1952 the operating system and uses them in its requests to the service 1953 providers. 1955 The codification of the range of allowed usage of this field is 1956 outside the scope of this specification. 1958 4.4.11.5.4. Login-LAT-Port AVP 1960 The Login-LAT-Port AVP (AVP Code 63) is of type OctetString and 1961 contains the Port with which the user is to be connected by LAT. It 1962 MAY be used in an authorization request as a hint to the server that 1963 a specific port is desired, but the server is not required to honor 1964 the hint in the corresponding response. This AVP MUST only be 1965 present in a response if the Login-Service-Type AVP is set to LAT. 1967 The String field contains the identity of the LAT service to use. 1968 The LAT Architecture allows this string to contain $ (dollar), - 1969 (hyphen), . (period), _ (underscore), numerics, upper- and lower-case 1970 alphabetics, and the ISO Latin-1 character set extension 1971 [ISO.8859-1.1987]. 1973 All LAT string comparisons are case insensitive. 1975 4.5. NAS Tunneling AVPs 1977 Some NASes support compulsory tunnel services in which the incoming 1978 connection data is conveyed by an encapsulation method to a gateway 1979 elsewhere in the network. This is typically transparent to the 1980 service user, and the tunnel characteristics may be described by the 1981 remote AAA server, based on the user's authorization information. 1982 Several tunnel characteristics may be returned, and the NAS 1983 implementation may choose one. See Zorn, et al. [RFC2868] and Zorn, 1984 Aboba & Mitton [RFC2867] for further information. 1986 The following table gives the possible flag values for the session 1987 level AVPs and specifies whether the AVP MAY be encrypted. 1989 +----------+ 1990 | AVP Flag | 1991 | rules | 1992 |----+-----| 1993 |MUST| MUST| 1994 Attribute Name Section Defined | | NOT | 1995 -----------------------------------------|----+-----| 1996 Tunneling 4.5.1 | M | V | 1997 Tunnel-Type 4.5.2 | M | V | 1998 Tunnel-Medium-Type 4.5.3 | M | V | 1999 Tunnel-Client-Endpoint 4.5.4 | M | V | 2000 Tunnel-Server-Endpoint 4.5.5 | M | V | 2001 Tunnel-Password 4.5.6 | M | V | 2002 Tunnel-Private-Group-Id 4.5.7 | M | V | 2003 Tunnel-Assignment-Id 4.5.8 | M | V | 2004 Tunnel-Preference 4.5.9 | M | V | 2005 Tunnel-Client-Auth-Id 4.5.10 | M | V | 2006 Tunnel-Server-Auth-Id 4.5.11 | M | V | 2007 -----------------------------------------|----+-----| 2009 4.5.1. Tunneling AVP 2011 The Tunneling AVP (AVP Code 401) is of type Grouped and contains the 2012 following AVPs, used to describe a compulsory tunnel service 2013 ([RFC2868], [RFC2867]). Its data field has the following ABNF 2014 grammar: 2016 Tunneling ::= < AVP Header: 401 > 2017 { Tunnel-Type } 2018 { Tunnel-Medium-Type } 2019 { Tunnel-Client-Endpoint } 2020 { Tunnel-Server-Endpoint } 2021 [ Tunnel-Preference ] 2022 [ Tunnel-Client-Auth-Id ] 2023 [ Tunnel-Server-Auth-Id ] 2024 [ Tunnel-Assignment-Id ] 2025 [ Tunnel-Password ] 2026 [ Tunnel-Private-Group-Id ] 2028 4.5.2. Tunnel-Type AVP 2030 The Tunnel-Type AVP (AVP Code 64) is of type Enumerated and contains 2031 the tunneling protocol(s) to be used (in the case of a tunnel 2032 initiator) or in use (in the case of a tunnel terminator). It MAY be 2033 used in an authorization request as a hint to the server that a 2034 specific tunnel type is desired, but the server is not required to 2035 honor the hint in the corresponding response. 2037 The Tunnel-Type AVP SHOULD also be included in ACR messages. 2039 A tunnel initiator is not required to implement any of these tunnel 2040 types. If a tunnel initiator receives a response that contains only 2041 unknown or unsupported Tunnel-Types, the tunnel initiator MUST behave 2042 as though a response were received with the Result-Code indicating a 2043 failure. 2045 The supported values are listed in [RADIUSAttrVals]. 2047 4.5.3. Tunnel-Medium-Type AVP 2049 The Tunnel-Medium-Type AVP (AVP Code 65) is of type Enumerated and 2050 contains the transport medium to use when creating a tunnel for 2051 protocols (such as L2TP [RFC3931]) that can operate over multiple 2052 transports. It MAY be used in an authorization request as a hint to 2053 the server that a specific medium is desired, but the server is not 2054 required to honor the hint in the corresponding response. 2056 The supported values are listed in [RADIUSAttrVals]. 2058 4.5.4. Tunnel-Client-Endpoint AVP 2060 The Tunnel-Client-Endpoint AVP (AVP Code 66) is of type UTF8String 2061 and contains the address of the initiator end of the tunnel. It MAY 2062 be used in an authorization request as a hint to the server that a 2063 specific endpoint is desired, but the server is not required to honor 2064 the hint in the corresponding response. This AVP SHOULD be included 2065 in the corresponding ACR messages, in which case it indicates the 2066 address from which the tunnel was initiated. This AVP, along with 2067 the Tunnel-Server-Endpoint (Section 4.5.5) and Session-Id AVPs 2068 ([RFC6733], Section 8.8), can be used to provide a globally unique 2069 means to identify a tunnel for accounting and auditingpurposes. 2071 If the value of the Tunnel-Medium-Type AVP (Section 4.5.3) is IPv4 2072 (1), then this string is either the fully qualified domain name 2073 (FQDN) of the tunnel client machine, or a "dotted-decimal" IP 2074 address. Implementations MUST support the dotted-decimal format and 2075 SHOULD support the FQDN format for IP addresses. 2077 If Tunnel-Medium-Type is IPv6 (2), then this string is either the 2078 FQDN of the tunnel client machine, or a text representation of the 2079 address in either the preferred or alternate form [RFC3516]. 2080 Conforming implementations MUST support the preferred form and SHOULD 2081 support both the alternate text form and the FQDN format for IPv6 2082 addresses. 2084 If Tunnel-Medium-Type is neither IPv4 nor IPv6, then this string is a 2085 tag referring to configuration data local to the Diameter client that 2086 describes the interface or medium-specific client address to use. 2088 Note that this application handles internationalized domain names in 2089 the same way as the Diameter base protocol (see Appendix D of RFC 2090 6733 for details). 2092 4.5.5. Tunnel-Server-Endpoint AVP 2094 The Tunnel-Server-Endpoint AVP (AVP Code 67) is of type UTF8String 2095 and contains the address of the server end of the tunnel. It MAY be 2096 used in an authorization request as a hint to the server that a 2097 specific endpoint is desired, but the server is not required to honor 2098 the hint in the corresponding response. 2100 This AVP SHOULD be included in the corresponding ACR messages, in 2101 which case it indicates the address from which the tunnel was 2102 initiated. This AVP, along with the Tunnel-Client-Endpoint 2103 (Section 4.5.4) and Session-Id AVP ([RFC6733], Section 8.8), can be 2104 used to provide a globally unique means to identify a tunnel for 2105 accounting and auditing purposes. 2107 If Tunnel-Medium-Type is IPv4 (1), then this string is either the 2108 fully qualified domain name (FQDN) of the tunnel server machine, or a 2109 "dotted-decimal" IP address. Implementations MUST support the 2110 dotted-decimal format and SHOULD support the FQDN format for IP 2111 addresses. 2113 If Tunnel-Medium-Type is IPv6 (2), then this string is either the 2114 FQDN of the tunnel server machine, or a text representation of the 2115 address in either the preferred or alternate form [RFC3516]. 2116 Implementations MUST support the preferred form and SHOULD support 2117 both the alternate text form and the FQDN format for IPv6 addresses. 2119 If Tunnel-Medium-Type is not IPv4 or IPv6, this string is a tag 2120 referring to configuration data local to the Diameter client that 2121 describes the interface or medium-specific server address to use. 2123 Note that this application handles internationalized domain names in 2124 the same way as the Diameter base protocol (see Appendix D of RFC 2125 6733 for details). 2127 4.5.6. Tunnel-Password AVP 2129 The Tunnel-Password AVP (AVP Code 69) is of type OctetString and may 2130 contain a password to be used to authenticate to a remote server. 2132 The Tunnel-Password AVP SHOULD NOT be used in untrusted proxy 2133 environments without encrypting it by using end-to-end security 2134 techniques. 2136 4.5.7. Tunnel-Private-Group-Id AVP 2138 The Tunnel-Private-Group-Id AVP (AVP Code 81) is of type OctetString 2139 and contains the group Id for a particular tunneled session. The 2140 Tunnel-Private-Group-Id AVP MAY be included in an authorization 2141 request if the tunnel initiator can predetermine the group resulting 2142 from a particular connection. It SHOULD be included in the 2143 authorization response if this tunnel session is to be treated as 2144 belonging to a particular private group. Private groups may be used 2145 to associate a tunneled session with a particular group of users. 2146 For example, it MAY be used to facilitate routing of unregistered IP 2147 addresses through a particular interface. This AVP SHOULD be 2148 included in the ACR messages that pertain to the tunneled session. 2150 4.5.8. Tunnel-Assignment-Id AVP 2152 The Tunnel-Assignment-Id AVP (AVP Code 82) is of type OctetString and 2153 is used to indicate to the tunnel initiator the particular tunnel to 2154 which a session is to be assigned. Some tunneling protocols, such as 2155 PPTP [RFC2637] and L2TP [RFC3931], allow for sessions between the 2156 same two tunnel endpoints to be multiplexed over the same tunnel and 2157 also for a given session to use its own dedicated tunnel. This 2158 attribute provides a mechanism for Diameter to inform the tunnel 2159 initiator (for example, a LAC) whether to assign the session to a 2160 multiplexed tunnel or to a separate tunnel. Furthermore, it allows 2161 for sessions sharing multiplexed tunnels to be assigned to different 2162 multiplexed tunnels. 2164 A particular tunneling implementation may assign differing 2165 characteristics to particular tunnels. For example, different 2166 tunnels may be assigned different QoS parameters. Such tunnels may 2167 be used to carry either individual or multiple sessions. The Tunnel- 2168 Assignment-Id attribute thus allows the Diameter server to indicate 2169 that a particular session is to be assigned to a tunnel providing an 2170 appropriate level of service. It is expected that any QoS-related 2171 Diameter tunneling attributes defined in the future accompanying this 2172 one will be associated by the tunnel initiator with the Id given by 2173 this attribute. In the meantime, any semantic given to a particular 2174 Id string is a matter left to local configuration in the tunnel 2175 initiator. 2177 The Tunnel-Assignment-Id AVP is of significance only to Diameter and 2178 the tunnel initiator. The Id it specifies is only intended to be of 2179 local use to Diameter and the tunnel initiator. The Id assigned by 2180 the tunnel initiator is not conveyed to the tunnel peer. 2182 This attribute MAY be included in authorization responses. The 2183 tunnel initiator receiving this attribute MAY choose to ignore it and 2184 to assign the session to an arbitrary multiplexed or non-multiplexed 2185 tunnel between the desired endpoints. This AVP SHOULD also be 2186 included in the Accounting-Request messages pertaining to the 2187 tunneled session. 2189 If a tunnel initiator supports the Tunnel-Assignment-Id AVP, then it 2190 should assign a session to a tunnel in the following manner: 2192 o If this AVP is present and a tunnel exists between the specified 2193 endpoints with the specified Id, then the session should be 2194 assigned to that tunnel. 2196 o If this AVP is present and no tunnel exists between the specified 2197 endpoints with the specified Id, then a new tunnel should be 2198 established for the session and the specified Id should be 2199 associated with the new tunnel. 2201 o If this AVP is not present, then the session is assigned to an 2202 unnamed tunnel. If an unnamed tunnel does not yet exist between 2203 the specified endpoints, then it is established and used for this 2204 session and for subsequent ones established without the Tunnel- 2205 Assignment-Id attribute. A tunnel initiator MUST NOT assign a 2206 session for which a Tunnel-Assignment-Id AVP was not specified to 2207 a named tunnel (i.e., one that was initiated by a session 2208 specifying this AVP). 2210 Note that the same Id may be used to name different tunnels if these 2211 tunnels are between different endpoints. 2213 4.5.9. Tunnel-Preference AVP 2215 The Tunnel-Preference AVP (AVP Code 83) is of type Unsigned32 and is 2216 used to identify the relative preference assigned to each tunnel when 2217 more than one set of tunneling AVPs is returned within separate 2218 Grouped-AVP AVPs. It MAY be used in an authorization request as a 2219 hint to the server that a specific preference is desired, but the 2220 server is not required to honor the hint in the corresponding 2221 response. 2223 For example, suppose that AVPs describing two tunnels are returned by 2224 the server, one with a Tunnel-Type of PPTP and the other with a 2225 Tunnel-Type of L2TP. If the tunnel initiator supports only one of 2226 the Tunnel-Types returned, it will initiate a tunnel of that type. 2227 If, however, it supports both tunnel protocols, it SHOULD use the 2228 value of the Tunnel-Preference AVP to decide which tunnel should be 2229 started. The tunnel with the lowest numerical value in the Value 2230 field of this AVP SHOULD be given the highest preference. The values 2231 assigned to two or more instances of the Tunnel-Preference AVP within 2232 a given authorization response MAY be identical. In this case, the 2233 tunnel initiator SHOULD use locally configured metrics to decide 2234 which set of AVPs to use. 2236 4.5.10. Tunnel-Client-Auth-Id AVP 2238 The Tunnel-Client-Auth-Id AVP (AVP Code 90) is of type UTF8String and 2239 specifies the name used by the tunnel initiator during the 2240 authentication phase of tunnel establishment. It MAY be used in an 2241 authorization request as a hint to the server that a specific 2242 preference is desired, but the server is not required to honor the 2243 hint in the corresponding response. This AVP MUST be present in the 2244 authorization response if an authentication name other than the 2245 default is desired. This AVP SHOULD be included in the ACR messages 2246 pertaining to the tunneled session. 2248 4.5.11. Tunnel-Server-Auth-Id AVP 2250 The Tunnel-Server-Auth-Id AVP (AVP Code 91) is of type UTF8String and 2251 specifies the name used by the tunnel terminator during the 2252 authentication phase of tunnel establishment. It MAY be used in an 2253 authorization request as a hint to the server that a specific 2254 preference is desired, but the server is not required to honor the 2255 hint in the corresponding response. This AVP MUST be present in the 2256 authorization response if an authentication name other than the 2257 default is desired. This AVP SHOULD be included in the ACR messages 2258 pertaining to the tunneled session. 2260 4.6. NAS Accounting AVPs 2262 Applications implementing this specification use Diameter Accounting 2263 (as defined in [RFC6733]) and the AVPs in the following section. 2264 Service-specific AVP usage is defined in the tables in Section 5. 2266 If accounting is active, Accounting Request (ACR) messages SHOULD be 2267 sent after the completion of any Authentication or Authorization 2268 transaction and at the end of a Session. The value of the 2269 Accounting-Record-Type AVP [RFC6733] indicates the type of event. 2270 All other AVPs identify the session and provide additional 2271 information relevant to the event. 2273 The successful completion of the first Authentication or 2274 Authorization transaction SHOULD cause a START_RECORD to be sent. If 2275 additional Authentications or Authorizations occur in later 2276 transactions, the first exchange should generate a START_RECORD, and 2277 the later an INTERIM_RECORD. For a given session, there MUST only be 2278 one set of matching START and STOP records, with any number of 2279 INTERIM_RECORDS in between, or one EVENT_RECORD indicating the reason 2280 a session wasn't started. 2282 The following table gives the possible flag values for the session 2283 level AVPs and specifies whether the AVP MAY be encrypted. 2285 +----------+ 2286 | AVP Flag | 2287 | rules | 2288 |----+-----| 2289 Section |MUST| MUST| 2290 Attribute Name Defined | | NOT| 2291 -----------------------------------------|----+-----| 2292 Accounting-Input-Octets 4.6.1 | M | V | 2293 Accounting-Output-Octets 4.6.2 | M | V | 2294 Accounting-Input-Packets 4.6.3 | M | V | 2295 Accounting-Output-Packets 4.6.4 | M | V | 2296 Acct-Session-Time 4.6.5 | M | V | 2297 Acct-Authentic 4.6.6 | M | V | 2298 Accounting-Auth-Method 4.6.7 | M | V | 2299 Acct-Delay-Time 4.6.8 | M | V | 2300 Acct-Link-Count 4.6.9 | M | V | 2301 Acct-Tunnel-Connection 4.6.10 | M | V | 2302 Acct-Tunnel-Packets-Lost 4.6.11 | M | V | 2303 -----------------------------------------|----+-----| 2305 4.6.1. Accounting-Input-Octets AVP 2307 The Accounting-Input-Octets AVP (AVP Code 363) is of type Unsigned64 2308 and contains the number of octets received from the user. 2310 For NAS usage, this AVP indicates how many octets have been received 2311 from the port in the course of this session. It can only be present 2312 in ACR messages with an Accounting-Record-Type [RFC6733] of 2313 INTERIM_RECORD or STOP_RECORD. 2315 4.6.2. Accounting-Output-Octets AVP 2317 The Accounting-Output-Octets AVP (AVP Code 364) is of type Unsigned64 2318 and contains the number of octets sent to the user. 2320 For NAS usage, this AVP indicates how many octets have been sent to 2321 the port in the course of this session. It can only be present in 2322 ACR messages with an Accounting-Record-Type of INTERIM_RECORD or 2323 STOP_RECORD. 2325 4.6.3. Accounting-Input-Packets AVP 2327 The Accounting-Input-Packets (AVP Code 365) is of type Unsigned64 and 2328 contains the number of packets received from the user. 2330 For NAS usage, this AVP indicates how many packets have been received 2331 from the port over the course of a session being provided to a Framed 2332 User. It can only be present in ACR messages with an Accounting- 2333 Record-Type of INTERIM_RECORD or STOP_RECORD. 2335 4.6.4. Accounting-Output-Packets AVP 2337 The Accounting-Output-Packets (AVP Code 366) is of type Unsigned64 2338 and contains the number of IP packets sent to the user. 2340 For NAS usage, this AVP indicates how many packets have been sent to 2341 the port over the course of a session being provided to a Framed 2342 User. It can only be present in ACR messages with an Accounting- 2343 Record-Type of INTERIM_RECORD or STOP_RECORD. 2345 4.6.5. Acct-Session-Time AVP 2347 The Acct-Session-Time AVP (AVP Code 46) is of type Unsigned32 and 2348 indicates the length of the current session in seconds. It can only 2349 be present in ACR messages with an Accounting-Record-Type of 2350 INTERIM_RECORD or STOP_RECORD. 2352 4.6.6. Acct-Authentic AVP 2354 The Acct-Authentic AVP (AVP Code 45) is of type Enumerated and 2355 specifies how the user was authenticated. The supported values are 2356 listed in [RADIUSAttrVals]. 2358 4.6.7. Accounting-Auth-Method AVP 2360 The Accounting-Auth-Method AVP (AVP Code 406) is of type Enumerated. 2361 A NAS MAY include this AVP in an Accounting-Request message to 2362 indicate the method used to authenticate the user. (Note that this 2363 AVP is semantically equivalent, and the supported values are 2364 identical, to the Microsoft MS-Acct-Auth-Type vendor-specific RADIUS 2365 attribute [RFC2548]). 2367 4.6.8. Acct-Delay-Time AVP 2369 The Acct-Delay-Time AVP (AVP Code 41) is of type Unsigned32 and 2370 indicates the number of seconds the Diameter client has been trying 2371 to send the Accounting-Request (ACR). The accounting server may 2372 subtract this value from the time when the ACR arrives at the server 2373 to calculate the approximate time of the event that caused the ACR to 2374 be generated. 2376 This AVP is not used for retransmissions at the transport level (TCP 2377 or SCTP). Rather, it may be used when an ACR command cannot be 2378 transmitted because there is no appropriate peer to transmit it to or 2379 was rejected because it could not be delivered. In these cases, the 2380 command MAY be buffered and transmitted later, when an appropriate 2381 peer-connection is available or after sufficient time has passed that 2382 the destination-host may be reachable and operational. If the ACR is 2383 re-sent in this way, the Acct-Delay-Time AVP SHOULD be included. The 2384 value of this AVP indicates the number of seconds that elapsed 2385 between the time of the first attempt at transmission and the current 2386 attempt. 2388 4.6.9. Acct-Link-Count AVP 2390 The Acct-Link-Count AVP (AVP Code 51) is of type Unsigned32 and 2391 indicates the total number of links that have been active (current or 2392 closed) in a given multilink session at the time the accounting 2393 record is generated. This AVP MAY be included in Accounting-Requests 2394 for any session that may be part of a multilink service. 2396 The Acct-Link-Count AVP may be used to make it easier for an 2397 accounting server to know when it has all the records for a given 2398 multilink service. When the number of Accounting-Requests received 2399 with Accounting-Record-Type = STOP_RECORD and with the same Acct- 2400 Multi-Session-Id and unique Session-Ids equals the largest value of 2401 Acct-Link-Count seen in those Accounting-Requests, all STOP_RECORD 2402 Accounting-Requests for that multilink service have been received. 2404 The following example, showing eight Accounting-Requests, illustrates 2405 how the Acct-Link-Count AVP is used. In the table below, only the 2406 relevant AVPs are shown, although additional AVPs containing 2407 accounting information will be present in the Accounting-Requests. 2409 Acct-Multi- Accounting- Acct- 2410 Session-Id Session-Id Record-Type Link-Count 2411 -------------------------------------------------------- 2412 "...10" "...10" START_RECORD 1 2413 "...10" "...11" START_RECORD 2 2414 "...10" "...11" STOP_RECORD 2 2415 "...10" "...12" START_RECORD 3 2416 "...10" "...13" START_RECORD 4 2417 "...10" "...12" STOP_RECORD 4 2418 "...10" "...13" STOP_RECORD 4 2419 "...10" "...10" STOP_RECORD 4 2421 4.6.10. Acct-Tunnel-Connection AVP 2423 The Acct-Tunnel-Connection AVP (AVP Code 68) is of type OctetString 2424 and contains the identifier assigned to the tunnel session. This 2425 AVP, along with the Tunnel-Client-Endpoint (Section 4.5.4) and 2426 Tunnel-Server-Endpoint (Section 4.5.5) AVPs, may be used to provide a 2427 means to uniquely identify a tunnel session for auditing purposes. 2429 The format of the identifier in this AVP depends upon the value of 2430 the Tunnel-Type AVP (Section 4.5.2). For example, to identify an 2431 L2TP tunnel connection fully, the L2TP Tunnel Id and Call Id might be 2432 encoded in this field. The exact encoding of this field is 2433 implementation dependent. 2435 4.6.11. Acct-Tunnel-Packets-Lost AVP 2437 The Acct-Tunnel-Packets-Lost AVP (AVP Code 86) is of type Unsigned32 2438 and contains the number of packets lost on a given tunnel. 2440 5. AVP Occurrence Tables 2442 The following tables present the AVPs used by NAS applications in NAS 2443 messages and specify in which Diameter messages they may or may not 2444 be present. Messages and AVPs defined in the base Diameter protocol 2445 [RFC6733] are not described in this document. Note that AVPs that 2446 can only be present within a Grouped AVP are not represented in this 2447 table. 2449 The tables use the following symbols: 2451 0 The AVP MUST NOT be present in the message. 2452 0+ Zero or more instances of the AVP MAY be present in the 2453 message. 2454 0-1 Zero or one instance of the AVP MAY be present in the 2455 message. 2456 1 Exactly one instance of the AVP MUST be present in the 2457 message. 2459 5.1. AA-Request/Answer AVP Table 2461 The table in this section is limited to the Command Codes defined in 2462 this specification. 2464 +-----------+ 2465 | Command | 2466 |-----+-----+ 2467 AVP Name | AAR | AAA | 2468 ------------------------------|-----+-----+ 2469 Acct-Interim-Interval | 0 | 0-1 | 2470 ARAP-Challenge-Response | 0 | 0-1 | 2471 ARAP-Features | 0 | 0-1 | 2472 ARAP-Password | 0-1 | 0 | 2473 ARAP-Security | 0-1 | 0-1 | 2474 ARAP-Security-Data | 0+ | 0+ | 2475 ARAP-Zone-Access | 0 | 0-1 | 2476 Auth-Application-Id | 1 | 1 | 2477 Auth-Grace-Period | 0-1 | 0-1 | 2478 Auth-Request-Type | 1 | 1 | 2479 Auth-Session-State | 0-1 | 0-1 | 2480 Authorization-Lifetime | 0-1 | 0-1 | 2481 ------------------------------|-----+-----+ 2482 +-----------+ 2483 | Command | 2484 |-----+-----+ 2485 Attribute Name | AAR | AAA | 2486 ------------------------------|-----+-----+ 2487 Callback-Id | 0 | 0-1 | 2488 Callback-Number | 0-1 | 0-1 | 2489 Called-Station-Id | 0-1 | 0 | 2490 Calling-Station-Id | 0-1 | 0 | 2491 CHAP-Auth | 0-1 | 0 | 2492 CHAP-Challenge | 0-1 | 0 | 2493 Class | 0 | 0+ | 2494 Configuration-Token | 0 | 0+ | 2495 Connect-Info | 0+ | 0 | 2496 Destination-Host | 0-1 | 0 | 2497 Destination-Realm | 1 | 0 | 2498 Error-Message | 0 | 0-1 | 2499 Error-Reporting-Host | 0 | 0-1 | 2500 Failed-AVP | 0+ | 0+ | 2501 Filter-Id | 0 | 0+ | 2502 Framed-Appletalk-Link | 0 | 0-1 | 2503 Framed-Appletalk-Network | 0 | 0+ | 2504 Framed-Appletalk-Zone | 0 | 0-1 | 2505 Framed-Compression | 0+ | 0+ | 2506 Framed-Interface-Id | 0-1 | 0-1 | 2507 Framed-IP-Address | 0-1 | 0-1 | 2508 Framed-IP-Netmask | 0-1 | 0-1 | 2509 Framed-IPv6-Prefix | 0+ | 0+ | 2510 Framed-IPv6-Pool | 0 | 0-1 | 2511 Framed-IPv6-Route | 0 | 0+ | 2512 Framed-IPX-Network | 0 | 0-1 | 2513 Framed-MTU | 0-1 | 0-1 | 2514 Framed-Pool | 0 | 0-1 | 2515 Framed-Protocol | 0-1 | 0-1 | 2516 Framed-Route | 0 | 0+ | 2517 Framed-Routing | 0 | 0-1 | 2518 Idle-Timeout | 0 | 0-1 | 2519 Login-IP-Host | 0+ | 0+ | 2520 Login-IPv6-Host | 0+ | 0+ | 2521 Login-LAT-Group | 0-1 | 0-1 | 2522 Login-LAT-Node | 0-1 | 0-1 | 2523 Login-LAT-Port | 0-1 | 0-1 | 2524 Login-LAT-Service | 0-1 | 0-1 | 2525 Login-Service | 0 | 0-1 | 2526 Login-TCP-Port | 0 | 0-1 | 2527 Multi-Round-Time-Out | 0 | 0-1 | 2528 ------------------------------|-----+-----+ 2529 +-----------+ 2530 | Command | 2531 |-----+-----+ 2532 Attribute Name | AAR | AAA | 2533 ------------------------------|-----+-----+ 2534 NAS-Filter-Rule | 0 | 0+ | 2535 NAS-Identifier | 0-1 | 0 | 2536 NAS-IP-Address | 0-1 | 0 | 2537 NAS-IPv6-Address | 0-1 | 0 | 2538 NAS-Port | 0-1 | 0 | 2539 NAS-Port-Id | 0-1 | 0 | 2540 NAS-Port-Type | 0-1 | 0 | 2541 Origin-AAA-Protocol | 0-1 | 0-1 | 2542 Origin-Host | 1 | 1 | 2543 Origin-Realm | 1 | 1 | 2544 Origin-State-Id | 0-1 | 0-1 | 2545 Originating-Line-Info | 0-1 | 0 | 2546 Password-Retry | 0 | 0-1 | 2547 Port-Limit | 0-1 | 0-1 | 2548 Prompt | 0 | 0-1 | 2549 Proxy-Info | 0+ | 0+ | 2550 QoS-Filter-Rule | 0 | 0+ | 2551 Re-Auth-Request-Type | 0 | 0-1 | 2552 Redirect-Host | 0 | 0+ | 2553 Redirect-Host-Usage | 0 | 0-1 | 2554 Redirect-Max-Cache-Time | 0 | 0-1 | 2555 Reply-Message | 0 | 0+ | 2556 Result-Code | 0 | 1 | 2557 Route-Record | 0+ | 0 | 2558 Service-Type | 0-1 | 0-1 | 2559 Session-Id | 1 | 1 | 2560 Session-Timeout | 0 | 0-1 | 2561 State | 0-1 | 0-1 | 2562 Tunneling | 0+ | 0+ | 2563 User-Name | 0-1 | 0-1 | 2564 User-Password | 0-1 | 0 | 2565 ------------------------------|-----+-----+ 2567 5.2. Accounting AVP Tables 2569 The tables in this section are used to show which AVPs defined in 2570 this document are to be present and used in NAS application 2571 Accounting messages. These AVPs are defined in this document, as 2572 well as in [RFC6733] and [RFC2866]. 2574 5.2.1. Framed Access Accounting AVP Table 2576 The table in this section is used when the Service-Type AVP 2577 (Section 4.4.1) specifies Framed Access. 2579 +-----------+ 2580 | Command | 2581 |-----+-----+ 2582 Attribute Name | ACR | ACA | 2583 ---------------------------------------|-----+-----+ 2584 Accounting-Auth-Method | 0-1 | 0 | 2585 Accounting-Input-Octets | 1 | 0 | 2586 Accounting-Input-Packets | 1 | 0 | 2587 Accounting-Output-Octets | 1 | 0 | 2588 Accounting-Output-Packets | 1 | 0 | 2589 Accounting-Record-Number | 0-1 | 0-1 | 2590 Accounting-Record-Type | 1 | 1 | 2591 Accounting-Realtime-Required | 0-1 | 0-1 | 2592 Accounting-Sub-Session-Id | 0-1 | 0-1 | 2593 Acct-Application-Id | 0-1 | 0-1 | 2594 Acct-Session-Id | 1 | 0-1 | 2595 Acct-Multi-Session-Id | 0-1 | 0-1 | 2596 Acct-Authentic | 1 | 0 | 2597 Acct-Delay-Time | 0-1 | 0 | 2598 Acct-Interim-Interval | 0-1 | 0-1 | 2599 Acct-Link-Count | 0-1 | 0 | 2600 Acct-Session-Time | 1 | 0 | 2601 Acct-Tunnel-Connection | 0-1 | 0 | 2602 Acct-Tunnel-Packets-Lost | 0-1 | 0 | 2603 Authorization-Lifetime | 0-1 | 0 | 2604 Callback-Id | 0-1 | 0 | 2605 Callback-Number | 0-1 | 0 | 2606 Called-Station-Id | 0-1 | 0 | 2607 Calling-Station-Id | 0-1 | 0 | 2608 Class | 0+ | 0+ | 2609 Connection-Info | 0+ | 0 | 2610 Destination-Host | 0-1 | 0 | 2611 Destination-Realm | 1 | 0 | 2612 Event-Timestamp | 0-1 | 0-1 | 2613 Error-Message | 0 | 0-1 | 2614 Error-Reporting-Host | 0 | 0-1 | 2615 Failed-AVP | 0 | 0+ | 2616 ---------------------------------------|-----+-----+ 2617 +-----------+ 2618 | Command | 2619 |-----+-----+ 2620 Attribute Name | ACR | ACA | 2621 ---------------------------------------|-----+-----+ 2622 Framed-AppleTalk-Link | 0-1 | 0 | 2623 Framed-AppleTalk-Network | 0-1 | 0 | 2624 Framed-AppleTalk-Zone | 0-1 | 0 | 2625 Framed-Compression | 0-1 | 0 | 2626 Framed-IP-Address | 0-1 | 0 | 2627 Framed-IP-Netmask | 0-1 | 0 | 2628 Framed-IPv6-Prefix | 0+ | 0 | 2629 Framed-IPv6-Pool | 0-1 | 0 | 2630 Framed-IPX-Network | 0-1 | 0 | 2631 Framed-MTU | 0-1 | 0 | 2632 Framed-Pool | 0-1 | 0 | 2633 Framed-Protocol | 0-1 | 0 | 2634 Framed-Route | 0-1 | 0 | 2635 Framed-Routing | 0-1 | 0 | 2636 NAS-Filter-Rule | 0+ | 0 | 2637 NAS-Identifier | 0-1 | 0-1 | 2638 NAS-IP-Address | 0-1 | 0-1 | 2639 NAS-IPv6-Address | 0-1 | 0-1 | 2640 NAS-Port | 0-1 | 0-1 | 2641 NAS-Port-Id | 0-1 | 0-1 | 2642 NAS-Port-Type | 0-1 | 0-1 | 2643 Origin-AAA-Protocol | 0-1 | 0-1 | 2644 Origin-Host | 1 | 1 | 2645 Origin-Realm | 1 | 1 | 2646 Origin-State-Id | 0-1 | 0-1 | 2647 Originating-Line-Info | 0-1 | 0 | 2648 Proxy-Info | 0+ | 0+ | 2649 QoS-Filter-Rule | 0+ | 0 | 2650 Route-Record | 0+ | 0 | 2651 Result-Code | 0 | 1 | 2652 Service-Type | 0-1 | 0-1 | 2653 Session-Id | 1 | 1 | 2654 Termination-Cause | 0-1 | 0-1 | 2655 Tunnel-Assignment-Id | 0-1 | 0 | 2656 Tunnel-Client-Endpoint | 0-1 | 0 | 2657 Tunnel-Medium-Type | 0-1 | 0 | 2658 Tunnel-Private-Group-Id | 0-1 | 0 | 2659 Tunnel-Server-Endpoint | 0-1 | 0 | 2660 Tunnel-Type | 0-1 | 0 | 2661 User-Name | 0-1 | 0-1 | 2662 ---------------------------------------|-----+-----+ 2664 5.2.2. Non-Framed Access Accounting AVP Table 2666 The table in this section is used when the Service-Type AVP 2667 (Section 4.4.1) specifies Non-Framed Access. 2669 +-----------+ 2670 | Command | 2671 |-----+-----+ 2672 Attribute Name | ACR | ACA | 2673 ---------------------------------------|-----+-----+ 2674 Accounting-Auth-Method | 0-1 | 0 | 2675 Accounting-Input-Octets | 1 | 0 | 2676 Accounting-Output-Octets | 1 | 0 | 2677 Accounting-Record-Type | 1 | 1 | 2678 Accounting-Record-Number | 0-1 | 0-1 | 2679 Accounting-Realtime-Required | 0-1 | 0-1 | 2680 Accounting-Sub-Session-Id | 0-1 | 0-1 | 2681 Acct-Application-Id | 0-1 | 0-1 | 2682 Acct-Session-Id | 1 | 0-1 | 2683 Acct-Multi-Session-Id | 0-1 | 0-1 | 2684 Acct-Authentic | 1 | 0 | 2685 Acct-Delay-Time | 0-1 | 0 | 2686 Acct-Interim-Interval | 0-1 | 0-1 | 2687 Acct-Link-Count | 0-1 | 0 | 2688 Acct-Session-Time | 1 | 0 | 2689 Authorization-Lifetime | 0-1 | 0 | 2690 Callback-Id | 0-1 | 0 | 2691 Callback-Number | 0-1 | 0 | 2692 Called-Station-Id | 0-1 | 0 | 2693 Calling-Station-Id | 0-1 | 0 | 2694 Class | 0+ | 0+ | 2695 Connection-Info | 0+ | 0 | 2696 Destination-Host | 0-1 | 0 | 2697 Destination-Realm | 1 | 0 | 2698 Event-Timestamp | 0-1 | 0-1 | 2699 Error-Message | 0 | 0-1 | 2700 Error-Reporting-Host | 0 | 0-1 | 2701 Failed-AVP | 0 | 0+ | 2702 Login-IP-Host | 0+ | 0 | 2703 Login-IPv6-Host | 0+ | 0 | 2704 Login-LAT-Service | 0-1 | 0 | 2705 Login-LAT-Node | 0-1 | 0 | 2706 Login-LAT-Group | 0-1 | 0 | 2707 Login-LAT-Port | 0-1 | 0 | 2708 Login-Service | 0-1 | 0 | 2709 Login-TCP-Port | 0-1 | 0 | 2710 ---------------------------------------|-----+-----+ 2711 +-----------+ 2712 | Command | 2713 |-----+-----+ 2714 Attribute Name | ACR | ACA | 2715 ---------------------------------------|-----+-----+ 2716 NAS-Identifier | 0-1 | 0-1 | 2717 NAS-IP-Address | 0-1 | 0-1 | 2718 NAS-IPv6-Address | 0-1 | 0-1 | 2719 NAS-Port | 0-1 | 0-1 | 2720 NAS-Port-Id | 0-1 | 0-1 | 2721 NAS-Port-Type | 0-1 | 0-1 | 2722 Origin-AAA-Protocol | 0-1 | 0-1 | 2723 Origin-Host | 1 | 1 | 2724 Origin-Realm | 1 | 1 | 2725 Origin-State-Id | 0-1 | 0-1 | 2726 Originating-Line-Info | 0-1 | 0 | 2727 Proxy-Info | 0+ | 0+ | 2728 QoS-Filter-Rule | 0+ | 0 | 2729 Route-Record | 0+ | 0 | 2730 Result-Code | 0 | 1 | 2731 Session-Id | 1 | 1 | 2732 Service-Type | 0-1 | 0-1 | 2733 Termination-Cause | 0-1 | 0-1 | 2734 User-Name | 0-1 | 0-1 | 2735 ---------------------------------------|-----+-----+ 2737 6. IANA Considerations 2739 Several of the namespaces used in this document are managed by the 2740 Internet Assigned Numbers Authority [IANA], including the AVP Codes 2741 [AVP-Codes], AVP Specific Values [AVP-Vals], Application IDs 2742 [App-Ids], Command Codes [Command-Codes] and RADIUS Attribute Values 2743 [RADIUSAttrVals]. 2745 For the current values allocated, and the policies governing 2746 allocation in those namespaces, please see the above-referenced 2747 registries. 2749 IANA Note: Please change all the references in the registries listed 2750 above that are currently pointing to RFC 4005 to point to this 2751 document instead; please change the reference for for the value '1' 2752 in the "Application IDs" sub-registry of the "Authentication, 2753 Authorization, and Accounting (AAA) Parameters" registry to point to 2754 this document, as well. 2756 RFC Editor: Please remove both this note and the IANA note above 2757 before publication. 2759 7. Security Considerations 2761 This document describes the extension of Diameter for the NAS 2762 application. Security considerations regarding the Diameter protocol 2763 itself are discussed in [RFC6733]. Use of this application of 2764 Diameter MUST take into consideration the security issues and 2765 requirements of the Base protocol. 2767 7.1. Authentication Considerations 2769 This document does not contain a security protocol but does discuss 2770 how PPP authentication protocols can be carried within the Diameter 2771 protocol. The PPP authentication protocols described are PAP and 2772 CHAP. 2774 The use of PAP SHOULD be discouraged, as it exposes users' passwords 2775 to possibly non-trusted entities. However, PAP is also frequently 2776 used for use with One-Time Passwords, which do not expose a security 2777 risk. 2779 This document also describes how CHAP can be carried within the 2780 Diameter protocol, which is required for RADIUS backward 2781 compatibility. The CHAP protocol, as used in a RADIUS environment, 2782 facilitates authentication replay attacks. 2784 The use of the EAP authentication protocols [RFC4072] can offer 2785 better security, given a method suitable for the circumstances. 2787 7.2. AVP Considerations 2789 Diameter AVPs often contain security-sensitive data; for example, 2790 user passwords and location data, network addresses and cryptographic 2791 keys. With the exception of the Configuration-Token (Section 4.4.8), 2792 QoS-Filter-Rule (Section 4.4.9) and Tunneling (Section 4.5.1) AVPs, 2793 all of the AVPs defined in this document are considered to be 2794 security-sensitive. 2796 Diameter messages containing any AVPs considered to be security- 2797 sensitive MUST only be sent protected via mutually authenticated TLS 2798 or IPsec. In addition, those messages MUST NOT be sent via 2799 intermediate nodes unless there is end-to-end security between the 2800 originator and recipient or the originator has locally trusted 2801 configuration that indicates that end-to-end security is not needed. 2802 For example, end-to-end security may not be required in the case 2803 where an intermediary node is known to be operated as part of the 2804 same administrative domain as the endpoints so that an ability to 2805 successfully compromise the intermediary would imply a high 2806 probability of being able to compromise the endpoints as well. Note 2807 that no end-to-end security mechanism is specified in this document. 2809 8. References 2811 8.1. Normative References 2813 [ANITypes] NANPA Number Resource Info, "ANI Assignments", . 2817 [RFC1994] Simpson, W., "PPP Challenge Handshake 2818 Authentication Protocol (CHAP)", RFC 1994, 2819 August 1996. 2821 [RFC2119] Bradner, S., "Key words for use in RFCs to 2822 Indicate Requirement Levels", BCP 14, RFC 2119, 2823 March 1997. 2825 [RFC2865] Rigney, C., Willens, S., Rubens, A., and W. 2826 Simpson, "Remote Authentication Dial In User 2827 Service (RADIUS)", RFC 2865, June 2000. 2829 [RFC3162] Aboba, B., Zorn, G., and D. Mitton, "RADIUS and 2830 IPv6", RFC 3162, August 2001. 2832 [RFC3516] Nerenberg, L., "IMAP4 Binary Content Extension", 2833 RFC 3516, April 2003. 2835 [RFC3539] Aboba, B. and J. Wood, "Authentication, 2836 Authorization and Accounting (AAA) Transport 2837 Profile", RFC 3539, June 2003. 2839 [RFC5777] Korhonen, J., Tschofenig, H., Arumaithurai, M., 2840 Jones, M., and A. Lior, "Traffic Classification 2841 and Quality of Service (QoS) Attributes for 2842 Diameter", RFC 5777, February 2010. 2844 [RFC6733] Fajardo, V., Arkko, J., Loughney, J., and G. Zorn, 2845 "Diameter Base Protocol", RFC 6733, October 2012. 2847 8.2. Informative References 2849 [ARAP] Apple Computer, "Apple Remote Access Protocol 2850 (ARAP) Version 2.0 External Reference 2851 Specification", R0612LL/B , September 1994. 2853 [AVP-Codes] "IANA AAA AVP Codes Registry", . 2857 [AVP-Vals] "IANA AAA AVP Specific Values", . 2861 [App-Ids] "IANA AAA Application IDs Registry", . 2865 [AppleTalk] Sidhu, G., Andrews, R., and A. Oppenheimer, 2866 "Inside AppleTalk", Second Edition Apple Computer, 2867 1990. 2869 [BASE] Calhoun, P., Loughney, J., Guttman, E., Zorn, G., 2870 and J. Arkko, "Diameter Base Protocol", RFC 3588, 2871 September 2003. 2873 [Command-Codes] "IANA AAA Command Codes Registry", . 2877 [IANA] "Internet Assigned Numbers Authority", 2878 . 2880 [IPX] Novell, Inc., "NetWare System Technical Interface 2881 Overview", #883-000780-001, June 1989. 2883 [ISO.8859-1.1987] International Organization for Standardization, 2884 "Information technology - 8-bit single byte coded 2885 graphic - character sets - Part 1: Latin alphabet 2886 No. 1, JTC1/SC2", ISO Standard 8859-1, 1987. 2888 [LAT] Digital Equipment Corp., "Local Area Transport 2889 (LAT) Specification V5.0", AA-NL26A-TE, 2890 June 1989. 2892 [RADIUSAttrVals] IANA, "IANA Radius Attribute Values Registry", . 2896 [RFC1334] Lloyd, B. and W. Simpson, "PPP Authentication 2897 Protocols", RFC 1334, October 1992. 2899 [RFC1661] Simpson, W., "The Point-to-Point Protocol (PPP)", 2900 STD 51, RFC 1661, July 1994. 2902 [RFC1990] Sklower, K., Lloyd, B., McGregor, G., Carr, D., 2903 and T. Coradetti, "The PPP Multilink Protocol 2904 (MP)", RFC 1990, August 1996. 2906 [RFC2474] Nichols, K., Blake, S., Baker, F., and D. Black, 2907 "Definition of the Differentiated Services Field 2908 (DS Field) in the IPv4 and IPv6 Headers", 2909 RFC 2474, December 1998. 2911 [RFC2548] Zorn, G., "Microsoft Vendor-specific RADIUS 2912 Attributes", RFC 2548, March 1999. 2914 [RFC2597] Heinanen, J., Baker, F., Weiss, W., and J. 2915 Wroclawski, "Assured Forwarding PHB Group", 2916 RFC 2597, June 1999. 2918 [RFC2637] Hamzeh, K., Pall, G., Verthein, W., Taarud, J., 2919 Little, W., and G. Zorn, "Point-to-Point Tunneling 2920 Protocol", RFC 2637, July 1999. 2922 [RFC2866] Rigney, C., "RADIUS Accounting", RFC 2866, 2923 June 2000. 2925 [RFC2867] Zorn, G., Aboba, B., and D. Mitton, "RADIUS 2926 Accounting Modifications for Tunnel Protocol 2927 Support", RFC 2867, June 2000. 2929 [RFC2868] Zorn, G., Leifer, D., Rubens, A., Shriver, J., 2930 Holdrege, M., and I. Goyret, "RADIUS Attributes 2931 for Tunnel Protocol Support", RFC 2868, June 2000. 2933 [RFC2869] Rigney, C., Willats, W., and P. Calhoun, "RADIUS 2934 Extensions", RFC 2869, June 2000. 2936 [RFC2881] Mitton, D. and M. Beadles, "Network Access Server 2937 Requirements Next Generation (NASREQNG) NAS 2938 Model", RFC 2881, July 2000. 2940 [RFC2989] Aboba, B., Calhoun, P., Glass, S., Hiller, T., 2941 McCann, P., Shiino, H., Walsh, P., Zorn, G., 2942 Dommety, G., Perkins, C., Patil, B., Mitton, D., 2943 Manning, S., Beadles, M., Chen, X., Sivalingham, 2944 S., Hameed, A., Munson, M., Jacobs, S., Lim, B., 2945 Hirschman, B., Hsu, R., Koo, H., Lipford, M., 2946 Campbell, E., Xu, Y., Baba, S., and E. Jaques, 2947 "Criteria for Evaluating AAA Protocols for Network 2948 Access", RFC 2989, November 2000. 2950 [RFC3169] Beadles, M. and D. Mitton, "Criteria for 2951 Evaluating Network Access Server Protocols", 2952 RFC 3169, September 2001. 2954 [RFC3246] Davie, B., Charny, A., Bennet, J., Benson, K., Le 2955 Boudec, J., Courtney, W., Davari, S., Firoiu, V., 2956 and D. Stiliadis, "An Expedited Forwarding PHB 2957 (Per-Hop Behavior)", RFC 3246, March 2002. 2959 [RFC3580] Congdon, P., Aboba, B., Smith, A., Zorn, G., and 2960 J. Roese, "IEEE 802.1X Remote Authentication Dial 2961 In User Service (RADIUS) Usage Guidelines", 2962 RFC 3580, September 2003. 2964 [RFC3931] Lau, J., Townsley, M., and I. Goyret, "Layer Two 2965 Tunneling Protocol - Version 3 (L2TPv3)", 2966 RFC 3931, March 2005. 2968 [RFC4072] Eronen, P., Hiller, T., and G. Zorn, "Diameter 2969 Extensible Authentication Protocol (EAP) 2970 Application", RFC 4072, August 2005. 2972 [RFC4301] Kent, S. and K. Seo, "Security Architecture for 2973 the Internet Protocol", RFC 4301, December 2005. 2975 [RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer 2976 Security (TLS) Protocol Version 1.2", RFC 5246, 2977 August 2008. 2979 Appendix A. Acknowledgements 2981 A.1. This Document 2983 The vast majority of the text in this document was taken directly 2984 from RFC 4005; the editor owes a debt of gratitude to the authors 2985 thereof (especially Dave Mitton, who somehow managed to make nroff 2986 paginate the AVP Occurance Tables correctly!). 2988 Thanks (in no particular order) to Jai-Jin Lim, Liu Hans, Sebastien 2989 Decugis, Jouni Korhonen, Mark Jones, Hannes Tschofenig, Dave Crocker, 2990 David Black, Barry Leiba, Peter Saint-Andre and Stefan Winter for 2991 their useful reviews and helpful comments. 2993 A.2. RFC 4005 2995 The authors would like to thank Carl Rigney, Allan C. Rubens, William 2996 Allen Simpson, and Steve Willens for their work on the original 2997 RADIUS protocol, from which many of the concepts in this 2998 specification were derived. Thanks, also, to Carl Rigney for 3000 [RFC2866] and [RFC2869]; Ward Willats for [RFC2869]; Glen Zorn, 3001 Bernard Aboba, and Dave Mitton for [RFC2867] and [RFC3162]; and Dory 3002 Leifer, John Shriver, Matt Holdrege, Allan Rubens, Glen Zorn and 3003 Ignacio Goyret for their work on [RFC2868]. This document stole text 3004 and concepts from both [RFC2868] and [RFC2869]. Thanks go to Carl 3005 Williams for providing IPv6-specific text. 3007 The authors would also like to acknowledge the following people for 3008 their contributions in the development of the Diameter protocol: 3009 Bernard Aboba, Jari Arkko, William Bulley, Kuntal Chowdhury, Daniel 3010 C. Fox, Lol Grant, Nancy Greene, Jeff Hagg, Peter Heitman, Paul 3011 Krumviede, Fergal Ladley, Ryan Moats, Victor Muslin, Kenneth Peirce, 3012 Sumit Vakil, John R. Vollbrecht, and Jeff Weisberg. 3014 Finally, Pat Calhoun would like to thank Sun Microsystems, as most of 3015 the effort put into this document was done while he was in their 3016 employ. 3018 Author's Address 3020 Glen Zorn (editor) 3021 Network Zen 3022 227/358 Thanon Sanphawut 3023 Bang Na, Bangkok 10260 3024 Thailand 3026 Phone: +66 (0) 909-201060 3027 EMail: glenzorn@gmail.com