RFC 4005
Diameter Network Access Server Application
4. NAS Session AVPs
Diameter reserves the AVP Codes 0 - 255 for RADIUS functions that are implemented in Diameter. AVPs new to Diameter have code values of 256 and greater. A Diameter message that includes one of these AVPs may represent functions not present in the RADIUS environment and may cause interoperability
issues, should the request traverse an AAA system that only supports the RADIUS protocol. Some RADIUS attributes are not allowed or supported directly in Diameter. See section 9 for more information.4.1. Call and Session Information
This section contains the AVPs specific to NAS Diameter applications that are needed to identify the call and session context and status information. On a request, this information allows the server to qualify the session. These AVPs are used in addition to the Base AVPs of: Session-Id Auth-Application-Id Origin-Host Origin-Realm Auth-Request-Type Termination-Cause The following table describes the session level AVPs; their AVP Code values, types, and possible flag values; and whether the AVP MAY be encrypted. +---------------------+ | AVP Flag rules | |----+-----+----+-----|----+ AVP Section | | |SHLD| MUST| | Attribute Name Code Defined Value Type |MUST| MAY | NOT| NOT|Encr| -----------------------------------------|----+-----+----+-----|----| NAS-Port 5 4.2 Unsigned32 | M | P | | V | Y | NAS-Port-Id 87 4.3 UTF8String | M | P | | V | Y | NAS-Port-Type 61 4.4 Enumerated | M | P | | V | Y | Called-Station-Id 30 4.5 UTF8String | M | P | | V | Y | Calling-Station- 31 4.6 UTF8String | M | P | | V | Y | Id | | | | | | Connect-Info 77 4.7 UTF8String | M | P | | V | Y | Originating-Line- 94 4.8 OctetString| | M,P | | V | Y | Info | | | | | | Reply-Message 18 4.9 UTF8String | M | P | | V | Y | -----------------------------------------|----+-----+----+-----|----|
4.2. NAS-Port AVP
The NAS-Port AVP (AVP Code 5) is of type Unsigned32 and contains the physical or virtual port number of the NAS which is authenticating the user. Note that "port" is meant in its sense as a service connection on the NAS, not as an IP protocol identifier. Either NAS-Port or NAS-Port-Id (AVP Code 87) SHOULD be present in AA-Request (AAR) commands if the NAS differentiates among its ports.4.3. NAS-Port-Id AVP
The NAS-Port-Id AVP (AVP Code 87) is of type UTF8String and consists of ASCII text identifying the port of the NAS authenticating the user. Note that "port" is meant in its sense as a service connection on the NAS, not as an IP protocol identifier. Either NAS-Port or NAS-Port-Id SHOULD be present in AA-Request (AAR) commands if the NAS differentiates among its ports. NAS-Port-Id is intended for use by NASes that cannot conveniently number their ports.4.4. NAS-Port-Type AVP
The NAS-Port-Type AVP (AVP Code 61) is of type Enumerated and contains the type of the port on which the NAS is authenticating the user. This AVP SHOULD be present if the NAS uses the same NAS-Port number ranges for different service types concurrently. The supported values are defined in [RADIUSTypes]. The following list is informational and subject to change by the IANA. 0 Async 1 Sync 2 ISDN Sync 3 ISDN Async V.120 4 ISDN Async V.110 5 Virtual 6 PIAFS 7 HDLC Clear Channel 8 X.25 9 X.75 10 G.3 Fax 11 SDSL - Symmetric DSL 12 ADSL-CAP - Asymmetric DSL, Carrierless Amplitude Phase Modulation 13 ADSL-DMT - Asymmetric DSL, Discrete Multi-Tone 14 IDSL - ISDN Digital Subscriber Line
15 Ethernet
16 xDSL - Digital Subscriber Line of unknown type
17 Cable
18 Wireless - Other
19 Wireless - IEEE 802.11
20 Token-Ring [RAD802.1X]
21 FDDI [RAD802.1X]
22 Wireless - CDMA2000
23 Wireless - UMTS
24 Wireless - 1X-EV
25 IAPP [IEEE 802.11f]
4.5. Called-Station-Id AVP
The Called-Station-Id AVP (AVP Code 30) is of type UTF8String and
allows the NAS to send the ASCII string describing the layer 2
address the user contacted in the request. For dialup access, this
can be a phone number obtained by using Dialed Number Identification
(DNIS) or a similar technology. Note that this may be different from
the phone number the call comes in on. For use with IEEE 802 access,
the Called-Station-Id MAY contain a MAC address formatted as
described in [RAD802.1X]. It SHOULD only be present in
authentication and/or authorization requests.
If the Auth-Request-Type AVP is set to authorization-only and the
User-Name AVP is absent, the Diameter Server MAY perform
authorization based on this field. This can be used by a NAS to
request whether a call should be answered based on the DNIS.
The codification of this field's allowed usage range is outside the
scope of this specification.
4.6. Calling-Station-Id AVP
The Calling-Station-Id AVP (AVP Code 31) is of type UTF8String and
allows the NAS to send the ASCII string describing the layer 2
address from which the user connected in the request. For dialup
access, this is the phone number the call came from, using Automatic
Number Identification (ANI) or a similar technology. For use with
IEEE 802 access, the Calling-Station-Id AVP MAY contain a MAC
address, formated as described in [RAD802.1X]. It SHOULD only be
present in authentication and/or authorization requests.
If the Auth-Request-Type AVP is set to authorization-only and the
User-Name AVP is absent, the Diameter Server MAY perform
authorization based on this field. This can be used by a NAS to
request whether a call should be answered based on the layer 2
address (ANI, MAC Address, etc.)
The codification of this field's allowed usage range is outside the scope of this specification.4.7. Connect-Info AVP
The Connect-Info AVP (AVP Code 77) is of type UTF8String and is sent in the AA-Request message or ACR STOP message. When sent in the Access-Request, it indicates the nature of the user's connection. The connection speed SHOULD be included at the beginning of the first Connect-Info AVP in the message. If the transmit and receive connection speeds differ, both may be included in the first AVP with the transmit speed listed first (the speed the NAS modem transmits at), then a slash (/), then the receive speed, and then other optional information. For example: "28800 V42BIS/LAPM" or "52000/31200 V90" More than one Connect-Info attribute may be present in an Accounting-Request packet to accommodate expected efforts by the ITU to have modems report more connection information in a standard format that might exceed 252 octets. If sent in the ACR STOP, this attribute may summarize statistics relating to session quality. For example, in IEEE 802.11, the Connect-Info attribute may contain information on the number of link layer retransmissions. The exact format of this attribute is implementation specific.4.8. Originating-Line-Info AVP
The Originating-Line-Info AVP (AVP Code 94) is of type OctetString and is sent by the NAS system to convey information about the origin of the call from an SS7 system. The originating line information (OLI) element indicates the nature and/or characteristics of the line from which a call originated (e.g., pay phone, hotel, cellular). Telephone companies are starting to offer OLI to their customers as an option over Primary Rate Interface (PRI). Internet Service Providers (ISPs) can use OLI in addition to Called-Station-Id and Calling-Station-Id attributes to differentiate customer calls and to define different services. The Value field contains two octets (00 - 99). ANSI T1.113 and BELLCORE 394 can be used for additional information about these values and their use. For more information on current assignment values, see [ANITypes].
Value Description
------------------------------------------------------------
00 Plain Old Telephone Service (POTS)
01 Multiparty Line (more than 2)
02 ANI Failure
03 ANI Observed
04 ONI Observed
05 ANI Failure Observed
06 Station Level Rating
07 Special Operator Handling Required
08 InterLATA Restricted
10 Test Call
20 Automatic Identified Outward Dialing (AIOD)
23 Coin or Non-Coin
24 Toll Free Service (Non-Pay Origination)
25 Toll Free Service (Pay Origination)
27 Toll Free Service (Coin Control Origination)
29 Prison/Inmate Service
30-32 Intercept
30 Intercept (Blank)
31 Intercept (Trouble)
32 Intercept (Regular)
34 Telco Operator Handled Call
40-49 Unrestricted Use
52 Outward Wide Area Telecommunications Service (OUTWATS)
60 Telecommunications Relay Service (TRS)(Unrestricted)
61 Cellular/Wireless PCS (Type 1)
62 Cellular/Wireless PCS (Type 2)
63 Cellular/Wireless PCS (Roaming)
66 TRS (Hotel)
67 TRS (Restricted)
70 Pay Station, No Coin Control
93 Access for Private Virtual Network Service
4.9. Reply-Message AVP
The Reply-Message AVP (AVP Code 18) is of type UTF8String and
contains text that MAY be displayed to the user. When used in an
AA-Answer message with a successful Result-Code AVP, it indicates
success. When found in an AAA message with a Result-Code other than
DIAMETER_SUCCESS, the AVP contains a failure message.
The Reply-Message AVP MAY indicate dialog text to prompt the user
before another AA-Request attempt. When used in an AA-Answer with a
Result-Code of DIAMETER_MULTI_ROUND_AUTH or in an Re-Auth-Request
message, it MAY contain a dialog text to prompt the user for a
response.
Multiple Reply-Messages MAY be included, and if any are displayed, they MUST be displayed in the same order as they appear in the Diameter message.5. NAS Authentication AVPs
This section defines the AVPs necessary to carry the authentication information in the Diameter protocol. The functionality defined here provides a RADIUS-like AAA service over a more reliable and secure transport, as defined in the base protocol [BASE]. The following table describes the AVPs; their AVP Code values, types, and possible flag values, and whether the AVP MAY be encrypted. +---------------------+ | AVP Flag rules | |----+-----+----+-----|----+ AVP Section | | |SHLD| MUST| | Attribute Name Code Defined Value Type |MUST| MAY | NOT| NOT|Encr| -----------------------------------------|----+-----+----+-----|----| User-Password 2 5.1 OctetString| M | P | | V | Y | Password-Retry 75 5.2 Unsigned32 | M | P | | V | Y | Prompt 76 5.3 Enumerated | M | P | | V | Y | CHAP-Auth 402 5.4 Grouped | M | P | | V | Y | CHAP-Algorithm 403 5.5 Enumerated | M | P | | V | Y | CHAP-Ident 404 5.6 OctetString| M | P | | V | Y | CHAP-Response 405 5.7 OctetString| M | P | | V | Y | CHAP-Challenge 60 5.8 OctetString| M | P | | V | Y | ARAP-Password 70 5.9 OctetString| M | P | | V | Y | ARAP-Challenge- 84 5.10 OctetString| M | P | | V | Y | Response | | | | | | ARAP-Security 73 5.11 Unsigned32 | M | P | | V | Y | ARAP-Security- 74 5.12 OctetString| M | P | | V | Y | Data | | | | | | -----------------------------------------|----+-----+----+-----|----|5.1. User-Password AVP
The User-Password AVP (AVP Code 2) is of type OctetString and contains the password of the user to be authenticated, or the user's input in a multi-round authentication exchange. The User-Password AVP contains a user password or one-time password and therefore represents sensitive information. As required in [BASE], Diameter messages are encrypted by using IPsec or TLS. Unless this AVP is used for one-time passwords, the User-Password AVP
SHOULD NOT be used in untrusted proxy environments without encrypting it by using end-to-end security techniques, such as the proposed CMS Security [DiamCMS]. The clear-text password (prior to encryption) MUST NOT be longer than 128 bytes in length.5.2. Password-Retry AVP
The Password-Retry AVP (AVP Code 75) is of type Unsigned32 and MAY be included in the AA-Answer if the Result-Code indicates an authentication failure. The value of this AVP indicates how many authentication attempts a user is permitted before being disconnected. This AVP is primarily intended for use when the Framed-Protocol AVP (see section 6.10.1) is set to ARAP.5.3. Prompt AVP
The Prompt AVP (AVP Code 76) is of type Enumerated and MAY be present in the AA-Answer message. When present, it is used by the NAS to determine whether the user's response, when entered, should be echoed. The supported values are listed in [RADIUSTypes]. The following list is informational: 0 No Echo 1 Echo5.4. CHAP-Auth AVP
The CHAP-Auth AVP (AVP Code 402) is of type Grouped and contains the information necessary to authenticate a user using the PPP Challenge-Handshake Authentication Protocol (CHAP) [PPPCHAP]. If the CHAP-Auth AVP is found in a message, the CHAP-Challenge AVP MUST be present as well. The optional AVPs containing the CHAP response depend upon the value of the CHAP-Algorithm AVP. The grouped AVP has the following ABNF grammar: CHAP-Auth ::= < AVP Header: 402 > { CHAP-Algorithm } { CHAP-Ident } [ CHAP-Response ] * [ AVP ]
5.5. CHAP-Algorithm AVP
The CHAP-Algorithm AVP (AVP Code 403) is of type Enumerated and contains the algorithm identifier used in the computation of the CHAP response [PPPCHAP]. The following values are currently supported: CHAP with MD5 5 The CHAP response is computed by using the procedure described in [PPPCHAP]. This algorithm requires that the CHAP-Response AVP MUST be present in the CHAP-Auth AVP.5.6. CHAP-Ident AVP
The CHAP-Ident AVP (AVP Code 404) is of type OctetString and contains the 1 octet CHAP Identifier used in the computation of the CHAP response [PPPCHAP].5.7. CHAP-Response AVP
The CHAP-Response AVP (AVP Code 405) is of type OctetString and contains the 16 octet authentication data provided by the user in response to the CHAP challenge [PPPCHAP].5.8. CHAP-Challenge AVP
The CHAP-Challenge AVP (AVP Code 60) is of type OctetString and contains the CHAP Challenge sent by the NAS to the CHAP peer [PPPCHAP].5.9. ARAP-Password AVP
The ARAP-Password AVP (AVP Code 70) is of type OctetString and is only present when the Framed-Protocol AVP (see section 6.10.1) is included in the message and is set to ARAP. This AVP MUST NOT be present if either the User-Password or the CHAP-Auth AVP is present. See [RADIUSExt] for more information on the contents of this AVP.5.10. ARAP-Challenge-Response AVP
The ARAP-Challenge-Response AVP (AVP Code 84) is of type OctetString and is only present when the Framed-Protocol AVP (see section 6.10.1) is included in the message and is set to ARAP. This AVP contains an 8 octet response to the dial-in client's challenge. The RADIUS server calculates this value by taking the dial-in client's challenge from the high-order 8 octets of the ARAP-Password AVP and performing DES encryption on this value with the authenticating user's password
as the key. If the user's password is fewer than 8 octets in length, the password is padded at the end with NULL octets to a length of 8 before it is used as a key.5.11. ARAP-Security AVP
The ARAP-Security AVP (AVP Code 73) is of type Unsigned32 and MAY be present in the AA-Answer message if the Framed-Protocol AVP (see section 6.10.1) is set to the value of ARAP, and the Result-Code AVP is set to DIAMETER_MULTI_ROUND_AUTH. See [RADIUSExt] for more information on the format of this AVP.5.12. ARAP-Security-Data AVP
The ARAP-Security AVP (AVP Code 74) is of type OctetString and MAY be present in the AA-Request or AA-Answer message if the Framed-Protocol AVP is set to the value of ARAP, and the Result-Code AVP is set to DIAMETER_MULTI_ROUND_AUTH. This AVP contains the security module challenge or response associated with the ARAP Security Module specified in ARAP-Security.6. NAS Authorization AVPs
This section contains the authorization AVPs supported in the NAS Application. The Service-Type AVP SHOULD be present in all messages, and, based on its value, additional AVPs defined in this section and in section 7 MAY be present. Due to space constraints, the short-form IPFltrRule is used to represent IPFilterRule, and QoSFltrRule is used for QoSFilterRule. +---------------------+ | AVP Flag rules | |----+-----+----+-----|----+ AVP Section | | |SHLD| MUST| | Attribute Name Code Defined Value Type |MUST| MAY | NOT| NOT|Encr| -----------------------------------------|----+-----+----+-----|----| Service-Type 6 6.1 Enumerated | M | P | | V | Y | Callback-Number 19 6.2 UTF8String | M | P | | V | Y | Callback-Id 20 6.3 UTF8String | M | P | | V | Y | Idle-Timeout 28 6.4 Unsigned32 | M | P | | V | Y | Port-Limit 62 6.5 Unsigned32 | M | P | | V | Y | NAS-Filter-Rule 400 6.6 IPFltrRule | M | P | | V | Y | Filter-Id 11 6.7 UTF8String | M | P | | V | Y | Configuration- 78 6.8 OctetString| M | | | P,V | | Token | | | | | | QoS-Filter-Rule 407 6.9 QoSFltrRule| | | | | | Framed-Protocol 7 6.10.1 Enumerated | M | P | | V | Y |
Framed-Routing 10 6.10.2 Enumerated | M | P | | V | Y | Framed-MTU 12 6.10.3 Unsigned32 | M | P | | V | Y | Framed- 13 6.10.4 Enumerated | M | P | | V | Y | Compression | | | | | | Framed-IP-Address 8 6.11.1 OctetString| M | P | | V | Y | Framed-IP-Netmask 9 6.11.2 OctetString| M | P | | V | Y | Framed-Route 22 6.11.3 UTF8String | M | P | | V | Y | Framed-Pool 88 6.11.4 OctetString| M | P | | V | Y | Framed- 96 6.11.5 Unsigned64 | M | P | | V | Y | Interface-Id | | | | | | Framed-IPv6- 97 6.11.6 OctetString| M | P | | V | Y | Prefix | | | | | | Framed-IPv6- 99 6.11.7 UTF8String | M | P | | V | Y | Route | | | | | | Framed-IPv6-Pool 100 6.11.8 OctetString| M | P | | V | Y | Framed-IPX- 23 6.12.1 UTF8String | M | P | | V | Y | Network | | | | | | Framed-Appletalk- 37 6.13.1 Unsigned32 | M | P | | V | Y | Link | | | | | | Framed-Appletalk- 38 6.13.2 Unsigned32 | M | P | | V | Y | Network | | | | | | Framed-Appletalk- 39 6.13.3 OctetString| M | P | | V | Y | Zone | | | | | | ARAP-Features 71 6.14.1 OctetString| M | P | | V | Y | ARAP-Zone-Access 72 6.14.2 Enumerated | M | P | | V | Y | Login-IP-Host 14 6.15.1 OctetString| M | P | | V | Y | Login-IPv6-Host 98 6.15.2 OctetString| M | P | | V | Y | Login-Service 15 6.15.3 Enumerated | M | P | | V | Y | Login-TCP-Port 16 6.16.1 Unsigned32 | M | P | | V | Y | Login-LAT-Service 34 6.17.1 OctetString| M | P | | V | Y | Login-LAT-Node 35 6.17.2 OctetString| M | P | | V | Y | Login-LAT-Group 36 6.17.3 OctetString| M | P | | V | Y | Login-LAT-Port 63 6.17.4 OctetString| M | P | | V | Y | -----------------------------------------|----+-----+----+-----|----|6.1. Service-Type AVP
The Service-Type AVP (AVP Code 6) is of type Enumerated and contains the type of service the user has requested or the type of service to be provided. One such AVP MAY be present in an authentication and/or authorization request or response. A NAS is not required to implement all of these service types. It MUST treat unknown or unsupported Service-Types received in a response as a failure and end the session with a DIAMETER_INVALID_AVP_VALUE Result-Code. When used in a request, the Service-Type AVP SHOULD be considered a hint to the server that the NAS believes the user would prefer the kind of service indicated. The server is not required to honor the
hint. Furthermore, if the service specified by the server is supported, but not compatible with the current mode of access, the NAS MUST fail to start the session. The NAS MUST also generate the appropriate error message(s). The following values have been defined for the Service-Type AVP. The complete list of defined values can be found in [RADIUS] and [RADIUSTypes]. The following list is informational: 1 Login 2 Framed 3 Callback Login 4 Callback Framed 5 Outbound 6 Administrative 7 NAS Prompt 8 Authenticate Only 9 Callback NAS Prompt 10 Call Check 11 Callback Administrative 12 Voice 13 Fax 14 Modem Relay 15 IAPP-Register [IEEE 802.11f] 16 IAPP-AP-Check [IEEE 802.11f] 17 Authorize Only [RADDynAuth] The following values are further qualified: Login 1 The user should be connected to a host. The message MAY include additional AVPs defined in sections 6.16 or 6.17. Framed 2 A Framed Protocol, such as PPP or SLIP, should be started for the User. The message MAY include additional AVPs defined in section 6.10, or section 7 for tunneling services. Callback Login 3 The user should be disconnected and called back, then connected to a host. The message MAY include additional AVPs defined in this section. Callback Framed 4 The user should be disconnected and called back, and then a Framed Protocol, such as PPP or SLIP, should be started for the User. The message MAY include additional AVPs defined in section 6.10, or in section 7 for tunneling services.
6.2. Callback-Number AVP
The Callback-Number AVP (AVP Code 19) is of type UTF8String and contains a dialing string to be used for callback. It MAY be used in an authentication and/or authorization request as a hint to the server that a Callback service is desired, but the server is not required to honor the hint in the corresponding response. The codification of this field's allowed usage range is outside the scope of this specification.6.3. Callback-Id AVP
The Callback-Id AVP (AVP Code 20) is of type UTF8String and contains the name of a place to be called, to be interpreted by the NAS. This AVP MAY be present in an authentication and/or authorization response. This AVP is not roaming-friendly as it assumes that the Callback-Id is configured on the NAS. Using the Callback-Number AVP therefore preferable.6.4. Idle-Timeout AVP
The Idle-Timeout AVP (AVP Code 28) is of type Unsigned32 and sets the maximum number of consecutive seconds of idle connection allowable to the user before termination of the session or before a prompt is issued. The default is none, or system specific.6.5. Port-Limit AVP
The Port-Limit AVP (AVP Code 62) is of type Unsigned32 and sets the maximum number of ports the NAS provides to the user. It MAY be used in an authentication and/or authorization request as a hint to the server that multilink PPP [PPPMP] service is desired, but the server is not required to honor the hint in the corresponding response.6.6. NAS-Filter-Rule AVP
The NAS-Filter-Rule AVP (AVP Code 400) is of type IPFilterRule and provides filter rules that need to be configured on the NAS for the user. One or more of these AVPs MAY be present in an authorization response.
6.7. Filter-Id AVP
The Filter-Id AVP (AVP Code 11) is of type UTF8String and contains the name of the filter list for this user. Zero or more Filter-Id AVPs MAY be sent in an authorization answer. Identifying a filter list by name allows the filter to be used on different NASes without regard to filter-list implementation details. However, this AVP is not roaming friendly, as filter naming differs from one service provider to another. In non-RADIUS environments, it is RECOMMENDED that the NAS-Filter- Rule AVP be used instead.6.8. Configuration-Token AVP
The Configuration-Token AVP (AVP Code 78) is of type OctetString and is sent by a Diameter Server to a Diameter Proxy Agent or Translation Agent in an AA-Answer command to indicate a type of user profile to be used. It should not be sent to a Diameter Client (NAS). The format of the Data field of this AVP is site specific.6.9. QoS-Filter-Rule AVP
The QoS-Filter-Rule AVP (AVP Code 407) is of type QoSFilterRule and provides QoS filter rules that need to be configured on the NAS for the user. One or more such AVPs MAY be present in an authorization response. Note: Due to an editorial mistake in [BASE], only the AVP format is discussed. The complete QoSFilterRule definition was not included. It is reprinted here for clarification. QoSFilterRule The QosFilterRule format is derived from the OctetString AVP Base Format. It uses the ASCII charset. Packets may be marked or metered based on the following information: Direction (in or out) Source and destination IP address (possibly masked) Protocol Source and destination port (lists or ranges) DSCP values (no mask or range) Rules for the appropriate direction are evaluated in order; the first matched rule terminates the evaluation. Each packet is
evaluated once. If no rule matches, the packet is treated as best
effort. An access device unable to interpret or apply a QoS rule
SHOULD NOT terminate the session.
QoSFilterRule filters MUST follow the following format:
action dir proto from src to dst [options]
tag - Mark packet with a specific DSCP
[DIFFSERV]. The DSCP option MUST be
included.
meter - Meter traffic. The metering options
MUST be included.
dir The format is as described under IPFilterRule.
proto The format is as described under IPFilterRule.
src and dst The format is as described under IPFilterRule.
options:
DSCP <color>
Color values as defined in [DIFFSERV]. Exact
matching of DSCP values is required (no masks or
ranges).
metering <rate> <color_under> <color_over>
The metering option provides Assured Forwarding,
as defined in [DIFFSERVAF], and MUST be present
if the action is set to meter. The rate option is
the throughput, in bits per second, used
by the access device to mark packets. Traffic
over the rate is marked with the color_over
codepoint, and traffic under the rate is marked
with the color_under codepoint. The color_under
and color_over options contain the drop
preferences and MUST conform to the recommended
codepoint keywords described in [DIFFSERVAF]
(e.g., AF13).
The metering option also supports the strict
limit on traffic required by Expedited
Forwarding, as defined in [DIFFSERVEF]. The
color_over option may contain the keyword "drop"
to prevent forwarding of traffic that exceeds the
rate parameter.
The rule syntax is a modified subset of ipfw(8) from FreeBSD,
and the ipfw.c code may provide a useful base for
implementations.
6.10. Framed Access Authorization AVPs
This section lists the authorization AVPs necessary to
support framed access, such as PPP and SLIP. AVPs defined in this
section MAY be present in a message if the Service-Type AVP was set
to "Framed" or "Callback Framed".
6.10.1. Framed-Protocol AVP
The Framed-Protocol AVP (AVP Code 7) is of type Enumerated and
contains the framing to be used for framed access. This AVP MAY be
present in both requests and responses. The supported values are
listed in [RADIUSTypes]. The following list is informational:
1 PPP
2 SLIP
3 AppleTalk Remote Access Protocol (ARAP)
4 Gandalf proprietary SingleLink/MultiLink protocol
5 Xylogics proprietary IPX/SLIP
6 X.75 Synchronous
6.10.2. Framed-Routing AVP
The Framed-Routing AVP (AVP Code 10) is of type Enumerated and
contains the routing method for the user when the user is a router to
a network. This AVP SHOULD only be present in authorization
responses. The supported values are listed in [RADIUSTypes]. The
following list is informational:
0 None
1 Send routing packets
2 Listen for routing packets
3 Send and Listen
6.10.3. Framed-MTU AVP
The Framed-MTU AVP (AVP Code 12) is of type Unsigned32 and contains
the Maximum Transmission Unit to be configured for the user, when it
is not negotiated by some other means (such as PPP). This AVP SHOULD
only be present in authorization responses. The MTU value MUST be in
the range from 64 to 65535.
6.10.4. Framed-Compression AVP
The Framed-Compression AVP (AVP Code 13) is of type Enumerated and contains the compression protocol to be used for the link. It MAY be used in an authorization request as a hint to the server that a specific compression type is desired, but the server is not required to honor the hint in the corresponding response. More than one compression protocol AVP MAY be sent. The NAS is responsible for applying the proper compression protocol to the appropriate link traffic. The supported values are listed in [RADIUSTypes]. The following list is informational: 0 None 1 VJ TCP/IP header compression 2 IPX header compression 3 Stac-LZS compression6.11. IP Access Authorization AVPs
The AVPs defined in this section are used when the user requests, or is being granted, access service to IP.6.11.1. Framed-IP-Address AVP
The Framed-IP-Address AVP (AVP Code 8) [RADIUS] is of type OctetString and contains an IPv4 address of the type specified in the attribute value to be configured for the user. It MAY be used in an authorization request as a hint to the server that a specific address is desired, but the server is not required to honor the hint in the corresponding response. Two values have special significance: 0xFFFFFFFF and 0xFFFFFFFE. The value 0xFFFFFFFF indicates that the NAS should allow the user to select an address (i.e., negotiated). The value 0xFFFFFFFE indicates that the NAS should select an address for the user (e.g., assigned from a pool of addresses kept by the NAS).6.11.2. Framed-IP-Netmask AVP
The Framed-IP-Netmask AVP (AVP Code 9) is of type OctetString and contains the four octets of the IPv4 netmask to be configured for the user when the user is a router to a network. It MAY be used in an authorization request as a hint to the server that a specific netmask
is desired, but the server is not required to honor the hint in the corresponding response. This AVP MUST be present in a response if the request included this AVP with a value of 0xFFFFFFFF.6.11.3. Framed-Route AVP
The Framed-Route AVP (AVP Code 22) is of type UTF8String and contains the ASCII routing information to be configured for the user on the NAS. Zero or more of these AVPs MAY be present in an authorization response. The string MUST contain a destination prefix in dotted quad form optionally followed by a slash and a decimal length specifier stating how many high-order bits of the prefix should be used. This is followed by a space, a gateway address in dotted quad form, a space, and one or more metrics separated by spaces; for example, "192.168.1.0/24 192.168.1.1 1". The length specifier may be omitted, in which case it should default to 8 bits for class A prefixes, to 16 bits for class B prefixes, and to 24 bits for class C prefixes; for example, "192.168.1.0 192.168.1.1 1". Whenever the gateway address is specified as "0.0.0.0" the IP address of the user SHOULD be used as the gateway address.6.11.4. Framed-Pool AVP
The Framed-Pool AVP (AVP Code 88) is of type OctetString and contains the name of an assigned address pool that SHOULD be used to assign an address for the user. If a NAS does not support multiple address pools, the NAS SHOULD ignore this AVP. Address pools are usually used for IP addresses but can be used for other protocols if the NAS supports pools for those protocols. Although specified as type OctetString for compatibility with RADIUS [RADIUSExt], the encoding of the Data field SHOULD also conform to the rules for the UTF8String Data Format.6.11.5. Framed-Interface-Id AVP
The Framed-Interface-Id AVP (AVP Code 96) is of type Unsigned64 and contains the IPv6 interface identifier to be configured for the user. It MAY be used in authorization requests as a hint to the server that a specific interface id is desired, but the server is not required to honor the hint in the corresponding response.
6.11.6. Framed-IPv6-Prefix AVP
The Framed-IPv6-Prefix AVP (AVP Code 97) is of type OctetString and contains the IPv6 prefix to be configured for the user. One or more AVPs MAY be used in authorization requests as a hint to the server that specific IPv6 prefixes are desired, but the server is not required to honor the hint in the corresponding response.6.11.7. Framed-IPv6-Route AVP
The Framed-IPv6-Route AVP (AVP Code 99) is of type UTF8String and contains the ASCII routing information to be configured for the user on the NAS. Zero or more of these AVPs MAY be present in an authorization response. The string MUST contain an IPv6 address prefix followed by a slash and a decimal length specifier stating how many high order bits of the prefix should be used. This is followed by a space, a gateway address in hexadecimal notation, a space, and one or more metrics separated by spaces; for example, "2000:0:0:106::/64 2000::106:a00:20ff:fe99:a998 1". Whenever the gateway address is the IPv6 unspecified address, the IP address of the user SHOULD be used as the gateway address, such as in: "2000:0:0:106::/64 :: 1".6.11.8. Framed-IPv6-Pool AVP
The Framed-IPv6-Pool AVP (AVP Code 100) is of type OctetString and contains the name of an assigned pool that SHOULD be used to assign an IPv6 prefix for the user. If the access device does not support multiple prefix pools, it MUST ignore this AVP. Although specified as type OctetString for compatibility with RADIUS [RADIUSIPv6], the encoding of the Data field SHOULD also conform to the rules for the UTF8String Data Format.6.12. IPX Access
The AVPs defined in this section are used when the user requests, or is being granted, access to an IPX network service.
6.12.1. Framed-IPX-Network AVP
The Framed-IPX-Network AVP (AVP Code 23) is of type Unsigned32 and contains the IPX Network number to be configured for the user. It MAY be used in an authorization request as a hint to the server that a specific address is desired, but the server is not required to honor the hint in the corresponding response. Two addresses have special significance: 0xFFFFFFFF and 0xFFFFFFFE. The value 0xFFFFFFFF indicates that the NAS should allow the user to select an address (i.e., Negotiated). The value 0xFFFFFFFE indicates that the NAS should select an address for the user (e.g., assign it from a pool of one or more IPX networks kept by the NAS).6.13. AppleTalk Network Access
The AVPs defined in this section are used when the user requests, or is being granted, access to an AppleTalk network [AppleTalk].6.13.1. Framed-AppleTalk-Link AVP
The Framed-AppleTalk-Link AVP (AVP Code 37) is of type Unsigned32 and contains the AppleTalk network number that should be used for the serial link to the user, which is another AppleTalk router. This AVP MUST only be present in an authorization response and is never used when the user is not another router. Despite the size of the field, values range from 0 to 65,535. The special value of 0 indicates an unnumbered serial link. A value of 1 to 65,535 means that the serial line between the NAS and the user should be assigned that value as an AppleTalk network number.6.13.2. Framed-AppleTalk-Network AVP
The Framed-AppleTalk-Network AVP (AVP Code 38) is of type Unsigned32 and contains the AppleTalk Network number that the NAS should probe to allocate an AppleTalk node for the user. This AVP MUST only be present in an authorization response and is never used when the user is not another router. Multiple instances of this AVP indicate that the NAS may probe, using any of the network numbers specified. Despite the size of the field, values range from 0 to 65,535. The special value 0 indicates that the NAS should assign a network for the user, using its default cable range. A value between 1 and 65,535 (inclusive) indicates to the AppleTalk Network that the NAS should probe to find an address for the user.
6.13.3. Framed-AppleTalk-Zone AVP
The Framed-AppleTalk-Zone AVP (AVP Code 39) is of type OctetString and contains the AppleTalk Default Zone to be used for this user. This AVP MUST only be present in an authorization response. Multiple instances of this AVP in the same message are not allowed. The codification of this field's allowed range is outside the scope of this specification.6.14. AppleTalk Remote Access
The AVPs defined in this section are used when the user requests, or is being granted, access to the AppleTalk network via the AppleTalk Remote Access Protocol [ARAP]. They are only present if the Framed- Protocol AVP (see section 6.10.1) is set to ARAP. Section 2.2 of RFC 2869 [RADIUSExt] describes the operational use of these attributes.6.14.1. ARAP-Features AVP
The ARAP-Features AVP (AVP Code 71) is of type OctetString and MAY be present in the AA-Accept message if the Framed-Protocol AVP is set to the value of ARAP. See [RADIUSExt] for more information about the format of this AVP.6.14.2. ARAP-Zone-Access AVP
The ARAP-Zone-Access AVP (AVP Code 72) is of type Enumerated and MAY be present in the AA-Accept message if the Framed-Protocol AVP is set to the value of ARAP. The supported values are listed in [RADIUSTypes] and defined in [RADIUSExt].6.15. Non-Framed Access Authorization AVPs
This section contains the authorization AVPs that are needed to support terminal server functionality. AVPs defined in this section MAY be present in a message if the Service-Type AVP was set to "Login" or "Callback Login".6.15.1. Login-IP-Host AVP
The Login-IP-Host AVP (AVP Code 14) [RADIUS] is of type OctetString and contains the IPv4 address of a host with which to connect the user when the Login-Service AVP is included. It MAY be used in an AA-Request command as a hint to the Diameter Server that a specific
host is desired, but the Diameter Server is not required to honor the hint in the AA-Answer. Two addresses have special significance: all ones and 0. The value of all ones indicates that the NAS SHOULD allow the user to select an address. The value 0 indicates that the NAS SHOULD select a host to connect the user to.6.15.2. Login-IPv6-Host AVP
The Login-IPv6-Host AVP (AVP Code 98) [RADIUSIPv6] is of type OctetString and contains the IPv6 address of a host with which to connect the user when the Login-Service AVP is included. It MAY be used in an AA-Request command as a hint to the Diameter Server that a specific host is desired, but the Diameter Server is not required to honor the hint in the AA-Answer. Two addresses have special significance: 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF and 0. The value 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF indicates that the NAS SHOULD allow the user to select an address. The value 0 indicates that the NAS SHOULD select a host to connect the user to.6.15.3. Login-Service AVP
The Login-Service AVP (AVP Code 15) is of type Enumerated and contains the service that should be used to connect the user to the login host. This AVP SHOULD only be present in authorization responses. The supported values are listed in [RADIUSTypes]. The following list is informational: 0 Telnet 1 Rlogin 2 TCP Clear 3 PortMaster (proprietary) 4 LAT 5 X25-PAD 6 X25-T3POS 8 TCP Clear Quiet (suppresses any NAS-generated connect string)
6.16. TCP Services
The AVPs described in this section MAY be present if the Login- Service AVP is set to Telnet, Rlogin, TCP Clear, or TCP Clear Quiet.6.16.1. Login-TCP-Port AVP
The Login-TCP-Port AVP (AVP Code 16) is of type Unsigned32 and contains the TCP port with which the user is to be connected when the Login-Service AVP is also present. This AVP SHOULD only be present in authorization responses. The value MUST NOT be greater than 65,535.6.17. LAT Services
The AVPs described in this section MAY be present if the Login- Service AVP is set to LAT [LAT].6.17.1. Login-LAT-Service AVP
The Login-LAT-Service AVP (AVP Code 34) is of type OctetString and contains the system with which the user is to be connected by LAT. It MAY be used in an authorization request as a hint to the server that a specific service is desired, but the server is not required to honor the hint in the corresponding response. This AVP MUST only be present in the response if the Login-Service AVP states that LAT is desired. Administrators use this service attribute when dealing with clustered systems, such as a VAX or Alpha cluster. In these environments, several different time-sharing hosts share the same resources (disks, printers, etc.), and administrators often configure each host to offer access (service) to each of the shared resources. In this case, each host in the cluster advertises its services through LAT broadcasts. Sophisticated users often know which service providers (machines) are faster and tend to use a node name when initiating a LAT connection. Some administrators want particular users to use certain machines as a primitive form of load balancing (although LAT knows how to do load balancing itself). The String field contains the identity of the LAT service to use. The LAT Architecture allows this string to contain $ (dollar), - (hyphen), . (period), _ (underscore), numerics, upper- and lowercase alphabetics, and the ISO Latin-1 character set extension [ISOLatin]. All LAT string comparisons are case insensitive.
6.17.2. Login-LAT-Node AVP
The Login-LAT-Node AVP (AVP Code 35) is of type OctetString and contains the Node with which the user is to be automatically connected by LAT. It MAY be used in an authorization request as a hint to the server that a specific LAT node is desired, but the server is not required to honor the hint in the corresponding response. This AVP MUST only be present in a response if the Login- Service-Type AVP is set to LAT. The String field contains the identity of the LAT service to use. The LAT Architecture allows this string to contain $ (dollar), - (hyphen), . (period), _ (underscore), numerics, upper- and lowercase alphabetics, and the ISO Latin-1 character set extension [ISOLatin]. All LAT string comparisons are case insensitive.6.17.3. Login-LAT-Group AVP
The Login-LAT-Group AVP (AVP Code 36) is of type OctetString and contains a string identifying the LAT group codes this user is authorized to use. It MAY be used in an authorization request as a hint to the server that a specific group is desired, but the server is not required to honor the hint in the corresponding response. This AVP MUST only be present in a response if the Login-Service-Type AVP is set to LAT. LAT supports 256 different group codes, which LAT uses as a form of access rights. LAT encodes the group codes as a 256-bit bitmap. Administrators can assign one or more of the group code bits at the LAT service provider; it will only accept LAT connections that have these group codes set in the bitmap. The administrators assign a bitmap of authorized group codes to each user. LAT gets these from the operating system and uses them in its requests to the service providers. The codification of the range of allowed usage of this field is outside the scope of this specification.6.17.4. Login-LAT-Port AVP
The Login-LAT-Port AVP (AVP Code 63) is of type OctetString and contains the Port with which the user is to be connected by LAT. It MAY be used in an authorization request as a hint to the server that a specific port is desired, but the server is not required to honor the hint in the corresponding response. This AVP MUST only be present in a response if the Login-Service-Type AVP is set to LAT.
The String field contains the identity of the LAT service to use. The LAT Architecture allows this string to contain $ (dollar), - (hyphen), . (period), _ (underscore), numerics, upper- and lower-case alphabetics, and the ISO Latin-1 character set extension [ISOLatin]. All LAT string comparisons are case insensitive.
(page 44 continued on part 3)
