FreeRADIUS InkBridge

RADIUS Attribute Definitions

This page contains a list of RADIUS attribute definitions, with links to the relevant standards.

It is critical that all vendors and administrators follow the RFC definitions of attributes. Standardization enables devices from different manufacturers to communicate using shared protocols and frameworks. RFC-compliant systems have consistent behaviour, which prevents interoperability issues that can cause problems in production networks.

In addition to interoperability issues, FreeRADIUS depends on the data types which are defined in RFC 8044. Many modules in the server use specific RFC attributes, and rely on using their defined data types. Changing the definitions of those attributes in the dictionaries will cause problems. Since the server needs a specific definition for these attributes, it will detect edits to the dictionaries, and refuse to start if the dictionary definitions for standard attributes have been modified.

RADIUS also has a finite range (1-255) available for standard attributes. Defining a custom attribute with a number already used by an RFC can cause a collision. Vendors who need custom attributes must use Vendor-Specific attributes.

For local site policy, administrators can define local attributes in the local dictionary. These attributes should use the DEFINE keyword, which avoids all issues with assigning attribute numbers. Policies in unlang can also use local variables. All of these local attributes are never sent over the network.

Attribute RFCs and Definitions

The following tables list the RADIUS attributes which are defined in the RFCs. Each attribute includes a brief explanation and a direct link to its definition in the RFCs.

A

ARAP-Challenge-Response

Contains the response to the dial-in client’s challenge.

ARAP-Features

Holds password information that the NAS sent to the user (via feature flags).

ARAP-Password

Contains the dial-in user’s response to the NAS challenge.

ARAP-Security

Identifies the ARAP Security Module to be used in an Access-Challenge packet.

ARAP-Security-Data

Contains the security module challenge or response in Access type packets.

ARAP-Zone-Access

Indicates how the ARAP zone list for the user is to be used.

AUTH-Key

RADIUS attributes providing support for 802.16 Privacy Key Management (v1).

Access-Accept

Access-Accept packets that contain specific configuration information to start delivery of service to the user.

Access-Challenge

Access-Challenge packets sent by RADIUS in response to a user’s Access-Request message.

Access-Reject

Access-Reject packets are sent when an attribute verification fails.

Access-Request

Access-Request packets that contain select information to determine the user’s level of access and services.

Accounting-Request

Accounting-Request packets contain information used by accounting operations for a service or resource granted to a user.

Accounting-Response

Accounting-Response packets are acknowledgments indication that the Accounting-Request has been processed.

Acct-Authentic

Indicates how the user was authenticated.

Acct-Delay-Time

The delay between two accounting events and shows client’s time taken to send a specific record.

Acct-Input-Gigawords

Indicates how many times the Acct-Input-Octets counter has wrapped during service provided.

Acct-Input-Octets

The number of octets that have been received from the port after the service started.

Acct-Input-Packets

The number of packets received on the ingress port.

Acct-Interim-Interval

The time (in seconds) between each interim update for the specific session and only appears in the Access-Accept message.

Acct-Link-Count

Gives the count of links used in a select multilink session when the accounting record is generated.

Acct-Multi-Session-Id

A unique Accounting ID to make it easy to link together multiple related sessions in a log file.

Acct-Output-Gigawords

Indicates how many times the Acct-Output-Octets counter has wrapped while delivering this service.

Acct-Output-Octets

The number of octets sent to the port while delivering this service.

Acct-Output-Packets

The number of packets sent on the egress port.

Acct-Session-Id

An ID assigned to a session and tracked by this ID via log files. Exmple stop and start events are mapped to this ID.

Acct-Session-Time

Indicates how long the user has been granted access.

Acct-Status-Type

Indicates the state of the user service, for example: start or stop events.

Acct-Terminate-Cause

Gives the reasons why a connection ended.

Acct-Tunnel-Connection

Gives details of the the tunnel connection such as port, ip address etc.

Acct-Tunnel-Packets-Lost

Tracks the number of accounting packets lost during a session.

C

CHAP-Challenge

Contains the CHAP Challenge sent by the NAS to a PPP Challenge-Handshake Authentication Protocol (CHAP) user.

CHAP-Password

Contains the response value provided by a PPP Challenge-Handshake Authentication Protocol (CHAP) user in response to the challenge.

Callback-Id

Indicates the name of a place to be called, to be interpreted by the NAS.

Callback-Number

Indicates a dialing string to be used for callback.

Called-Station-Id

The phone number that the user called, using Dialed Number Identification (DNIS).

Calling-Station-Id

The phone number that the call came from, using Automatic Number Identification (ANI).

Change-of-Authorization

Contains information for dynamically changing session authorizations.

Chargeable-User-Identity

CUI, is a unique handle used correlate and process authentication/accounting operations for a specific user.

Class

This Attribute is available to be sent by the server to the client in an Access-Accept packet.

Configuration-Token

Indicates the type of user profile to be applied during authentication requests.

Connect-Info

Indicates the nature of the user’s connection.

D

DNS-Server-IPv6-Address

Contains the IPv6 address of a DNS server.

DS-Lite

Provides IPv4 and IPv6 connectivity to users that are addressed only with an IPv6 prefix.

DS-Lite-Tunnel-Name

Specifies the Fully Qualified Domain Name (FQDN) of the Address Family Transition Router (AFTR) that the client connects to.

Delegated-IPv6-Prefix

Contains the IPv6 prefix that’s assigned to the user for network operations.

Delegated-IPv6-Prefix-Pool

Contains the name of an assigned pool used for prefix delegation.

Digest-AKA-Auts

Contains the auts parameter that’s used in theDigest AKA calculation.

Digest-Algorithm

Holds the algorithm parameter that defines the HTTP Digest calculation.

Digest-Auth-Param

Used for future extensions and also maps to the auth-param parameter [RFC2617].

Digest-CNonce

Contains the client nonce parameter that’s used in HTTP Digest calculations.

Digest-Domain

Contains a URI that helps define the protection space for HTTP type protocols.

Digest-Entity-Body-Hash

Contains a HASH value of an HTTP type message body that used in digest calculation.

Digest-HA1

Enables the generation of an Authentication-Info header.

Digest-Method

Contains the opaque parameter that is passed to the HTTP-style client.

Digest-Nextnonce

Holds a nonce to be used in the HTTP Digest calculation.

Digest-Nonce

holds a nonce to be used in the HTTP Digest calculation.

Digest-Nonce-Count

Contains the nonce count parameter that is used to detect replay attacks.

Digest-Opaque

Contains the opaque parameter that is passed to the HTTP-style client.

Digest-Qop

Contins the Quality of Protection parameter that impacts the HTTP Digest calculation.

Digest-Realm

Defines a protection space of the RADIUS server.

Digest-Response

If present in an Access-Request message, a RADIUS server will process theAccess-Request as a request for Digest Authentication.

Digest-Response-Auth

Enables the RADIUS server to prove possession of the password.

Digest-Stale

An attribute value (T/F) that’s sent by a RADIUS server to notify client whether it has accepted a nonce.

Digest-URI.

Contains the contents of the digest-uri directive or the URI of the HTTP-style request.

Digest-Username

Holds the user name used in the HTTP Digestcalculation.

E

EAP-Message

This attribute encapsulates EAP packets allowing the NAS to authenticate dial-in users via EAP.

Error-Cause

Holds information about why the Authorization Server cannot process Disconnect-Request or CoA-Request packets.

Event-Timestamp

This attribute is used Accounting-Request packets to record the time of an event.

Extended-Type-1

Encapsulates "Extended Type" attributes format, in the RADIUS Attribute Type space of 241.{1-255}.

Extended-Type-2

Encapsulates "Extended Type" attributes format, in the RADIUS Attribute Type space of 242.{1-255}.

Extended-Type-3

Encapsulates "Extended Type" attributes format, in the RADIUS Attribute Type space of 243.{1-255}.

Extended-Type-4

Encapsulates "Extended Type" attributes format, in the RADIUS Attribute Type space of 244.{1-255}.

Extended-Vendor-Specific-1

Defines a RADIUS Type Code of 241.26 ("evs" data type).

Extended-Vendor-Specific-2

Defines a RADIUS Type Code of 242.26 ("evs" data type).

Extended-Vendor-Specific-3

Defines a RADIUS Type Code of 243.26 ("evs" data type).

Extended-Vendor-Specific-4

Defines a RADIUS Type Code of 244.26 ("evs" data type).

Extended-Vendor-Specific-5

Defines a RADIUS Type Code of 245.26 ("evs" data type).

Extended-Vendor-Specific-6

Defines a RADIUS Type Code of 246.26 ("evs" data type).

F

Filter-ID

Indicates the name of the filter list to be applied to the Supplicant’s session.

Filter-Id

Indicates the name of the filter list for the specific user.

Framed-AppleTalk-Link

The AppleTalk Network number to be used for the serial link to the user.

Framed-AppleTalk-Network

The AppleTalk Network number which the NAS should probe to allocate an AppleTalk node for the user.

Framed-AppleTalk-Zone

Defines the AppleTalk Default Zone to be used for this user.

Framed-Compression

Indicates a compression protocol to be used for the link.

Framed-IP-Address

Indicates the address to be configured for the user.

Framed-IP-Netmask

Indicates the IP netmask to be configured for the user when the user is a router to a network.

Framed-IPX-Network

Indicates the IPX Network number to be configured for the user.

Framed-IPv6-Address

Indicates an IPv6 address that’s assigned to the NAS-facing interface of the RG/host.

Framed-IPv6-Pool

Contains the name of an assigned pool that’s used to assign an IPv6 prefix for the user.

Framed-IPv6-Prefix

Indicates an IPv6 prefix (and corresponding route) to be configured for the user.

Framed-IPv6-Route

Provides routing information to be configured for the user on the NAS.

Framed-Interface-Id

Indicates the IPv6 interface identifier to be configured for the user.

Framed-MTU

Indicates the Maximum Transmission Unit to be configured for the user.

Framed-Pool

Contains the name of an assigned address pool used to assign an address for the user.

Framed-Protocol

Indicates the framing to be used for framed access.

Framed-Route

Provides routing information to be configured for the user on the NAS.

Framed-Routing

Indicates the routing method for the user, when theuser is a router to a network.

I

Idle-Timeout

Sets the maximum number of consecutive seconds of idle connection allowed to the user before termination of the session.

K

Keep-Alives

The process of sending test RADIUS requests to see if a server is alive.

L

Login-IP-Host

Indicates the system with which to connect the user, when the Login-Service Attribute is included

Login-IPv6-Host

Indicates the system with which to connect the user, when the Login-Service Attribute is included.

Login-LAT-Group

Contains a string identifying the LAT group codes which this user is authorized to use.

Login-LAT-Node

Indicates the Node with which the user is to be automatically connected by LAT.

Login-LAT-Port

Indicates the Port with which the user is to be connected by LAT.

Login-LAT-Service

Indicates the system with which the user is to be connected by LAT.

Login-Service

Indicates the service to use to connect the user to the login host.

Login-TCP-Port

indicates the TCP port with which the user is to be connected.

Long-Extended-Type-1

Encapsulates attributes of the "Long Extended Type" format, in the RADIUS Attribute Type space of 245.{1-255}.

Long-Extended-Type-2

Encapsulates attributes of the "Long Extended Type"format, in the RADIUS Attribute Type space of 246.{1-255}.

M

MS-ARAP-Challenge

This attribute is only present in an Access-Request packet containing a Framed-Protocol Attribute with the value 3 (ARAP).

MS-ARAP-Password-Change-Reason

Indicates the reason for a server-initiated password change.

MS-Acct-Auth-Type

Represents the method used to authenticate the dial-up user.

MS-Acct-EAP-Type

Represents the Extensible Authentication Protocol (EAP) [15] type used to authenticate the dial-up user.

MS-BAP-Usage

Determines if the use of BAP is allowed, disallowed or required on new multilink calls.

MS-CHAP-CPW-1

Allows the user to change their password if it has expired.

MS-CHAP-CPW-2

Allows the user to change their password if it has expired.

MS-CHAP-Challenge

Contains the challenge sent by a NAS to a MS-CHAP user.

MS-CHAP-Domain

Indicates the Windows NT domain in which the user was authenticated.

MS-CHAP-Error

Contains error data related to the preceding MS-CHAP exchange.

MS-CHAP-LM-Enc-PW

Contains the new Windows NT password encrypted with the old LAN Manager password hash.

MS-CHAP-MPPE-Keys

Present in an Access-Request packet containing a Framed-Protocol Attribute with the value 3 (ARAP).

MS-CHAP-NT-Enc-PW

Contains the new Windows NT password encrypted with the old Windows NT password hash.

MS-CHAP-Response

Contains the response value provided by a PPP MS-CHAP user in response to the challenge.

MS-CHAP2-CPW

Allows the user to change their password if it has expired.

MS-CHAP2-Response

Contains the response value provided by an MS-CHAP-V2 peer in response to the challenge.

MS-CHAP2-Success

Contains the response value provided by an MS-CHAP-V2 peer in response to the challenge.

MS-Filter

MS-Link-Drop-Time-Limit

Indicates the length of time (in seconds) that a link must be underutilized before it is dropped.

MS-Link-Utilization-Threshold

Represents the percentage of available bandwidth utilization below which the link must fall before the link is eligible for termination.

MS-MPPE-Encryption-Policy

Used to indicate if encryption is on or off.

MS-MPPE-Encryption-Types

Defines what type of encryptions are available.

MS-MPPE-Recv-Key

Contains a session key to use for encrypting packets received by the NAS from the remote host.

MS-MPPE-Send-Key

Contains a session key to use for encrypting packets sent by the NAS to the remote host.

MS-New-ARAP-Password

Contains the new ARAP password during a password change operation.

MS-Old-ARAP-Password

Contains the old ARAP password during a password change operation.

MS-Primary-DNS-Server

The primary Domain Name Server’s (DNS) IP address.

MS-Primary-NBNS-Server

The primary Net Bios Name Server’s (NBNS) IP address.

MS-RAS-Vendor

The manufacturer name of the RAIDIUS client machine.

MS-RAS-Version

The software version of the RADIUS client machine.

MS-Secondary-DNS-Server

The IP address of the secondary DNS server to be used by the PPP peer. This attribute can be included in Access-Accept or Accounting-Request packets.

MS-Secondary-NBNS-Server

The IP address of the secondary Net Bios Name Server(NBNS) server to be used by the PPP peer.

Management-Policy-Id

The name of the management access policy for the specific user.

Management-Privilege-Level

The assigned privilege level for management access for the authenticated user.

Management-Transport-Protection

The minimum level of protection required for transport within an access session.

Message-Authenticator

Used to sign Access-Requests to prevent spoofing Access-Requests using CHAP, ARAP or EAP authentication.

Mobile-Node-Identifier

Contains the mobile node identifier (MN-Identifier) to identify the device on the network.

N

NAS-Filter-Rule

The filter rules to be applied for the select user.

NAS-IP-Address

The NAS’s IP Address that is requesting authentication of the user.

NAS-IPv6-Address

The NAS’s IPv6 Address that is requesting authentication of the user.

NAS-Identifier

A string used to identify the NAS originating the Access-Request packet.

NAS-Port

The NAS’s physical port number that is authenticating the user.

NAS-Port-Id

The name (text string) used to reference the NAS’s port that is authenticating the user.

NAS-Port-Type

The type of the physical port of the NAS that is authenticating the user.

P

PKM-AUTH-Key

Contains a PKM authorisation key.

PKM-CA-Cert

A string value containing the X.509 certificate used to sign the SS certificate.

PKM-Config-Settings

Contains string values that map to relevant TLVs used in the PKM configuration.

PKM-Cryptosuite-List

Contains a list of cryptosuite attributes that may be used to create security attributes.

PKM-SA-Descriptor

Specifies the characteristics of a PKM security association.

PKM-SAID

Contains a PKM Security Association Identifier.

PKM-SS-Cert

Contains a an X.509 certificate (public key).

Password-Retry

The number of authentication attempts a user may be allowed before being disconnected.

Port-Limit

Sets the maximum number of ports to be provided to the user by the NAS.

Proxy-State

This state attribute is sent by a proxy server to another server when forwarding an Access-Request.

R

Reply-Message

A text message that may be shown to the user.

Route-IPv6-Information

Defines the prefix and route for the user on the NAS.

S

SIP-AOR

This attribute, identifies the URI, and is used for the authorisation of SIP messages.

Service-Selection

The name of the service or the external network with which the mobility service for the particular MN.

Service-Type

The the type of service the user has requested, or the type of service to be provided.

Session-Timeout

The maximum number of seconds of service provided to the user before a session terminates.

State

An attribute that’s sent by the server to the client in an Access-Challenge or by client to the server in the new Access-Request.

Stateful-IPv6-Address-Pool

The assigned pool used to select an IPv6 address for the user on the NAS.

T

Termination-Action

This Attribute indicates what action the NAS should take when the specified service is completed.

Tunnel-Assignment-ID

This Attribute is used to indicate to the tunnel initiator the particular tunnel to which a session is to be assigned.

Tunnel-Client-Auth-ID

This Attribute specifies the name used by the tunnel initiator during the authentication phase of tunnel establishment.

Tunnel-Client-Endpoint

This Attribute contains the address of the initiator end of the tunnel.

Tunnel-Link-Reject

This value marks the rejection of the establishment of a new link in an existing tunnel.

Tunnel-Link-Start

This value marks the creation of a tunnel link.

Tunnel-Link-Stop

This value marks the destruction of a tunnel link.

Tunnel-Medium-Type

Attribute indicates which transport medium to use when creating a tunnel for those protocols (such as L2TP) that can operate over multiple transports.

Tunnel-Password

Contains a password to be used to authenticate to a remote server.

Tunnel-Preference

An attribute to indicate the relative preference assigned to each tunnel.

Tunnel-Private-Group-ID

This Attribute indicates the group ID for a particular tunneled session.

Tunnel-Reject

This attribute, identifies the URI, and is used for the authorisation of SIP messages.

Tunnel-Server-Auth-ID

This Attribute specifies the name used by the tunnel terminator during the authentication phase of tunnel establishment.

Tunnel-Server-Endpoint

This Attribute indicates the address of the server end of the tunnel.

Tunnel-Start

This value MAY be used to mark the establishment of a tunnel with another node.

Tunnel-Stop

This value MAY be used to mark the destruction of a tunnel to or from another node.

Tunnel-Type

This Attribute indicates the tunneling protocol(s) to be used a tunnel (either as a tunnel initiator or terminator).

U

User-Name

This Attribute indicates the name of the user to be authenticated.

User-Password

This Attribute indicates the password of the user to be authenticated, or the user’s input following an Access-Challenge.

V

Vendor-Id

This attribute assigns the identify to the vendor.

Vendor-Specific

This attribute extends defines the characteristics of the specific vendor.