RAS_AUTH_ATTRIBUTE_TYPE

[This is preliminary documentation and subject to change.]

The RAS_AUTH_ATTRIBUTE_TYPE enumerated type specifies attribute values used for session authentication. Further details for values in this enumerated type may be obtained by referring to one of the three following references: http://ds.internic.net/rfc/rfc2138.txt, http://ds.internic.net/rfc/rfc2139.txt, or http://ds.internic.net/internet-drafts/draft-ietf-radius-ext-00.txt.

typedef enum _RAS_AUTH_ATTRIBUTE_TYPE_ {
    raatMinimum = 0,           // Undefined
    raatUserName,              // Value field is a Pointer 
    raatUserPassword,          // Value field is a Pointer 
    raatMD5CHAPPassword,       // Value field is a Pointer 
    raatNASIPAddress,          // Value field is a 32 bit integral value
    raatNASPort,               // Value field is a 32 bit integral value
    raatServiceType,           // Value field is a 32 bit integral value
    raatFramedProtocol,        // Value field is a 32 bit integral value
    raatFramedIPAddress,       // Value field is a 32 bit integral value
    raatFramedIPNetmask,       // Value field is a 32 bit integral value
    raatFramedRouting,         // Value field is a 32 bit integral value
    raatFilterId,              // Value field is a Pointer 
    raatFramedMTU,             // Value field is a 32 bit integral value
    raatFramedCompression,     // Value field is a 32 bit integral value
    raatLoginIPHost,           // Value field is a 32 bit integral value
    raatLoginService,          // Value field is a 32 bit integral value
    raatLoginTCPPort,          // Value field is a 32 bit integral value
    raatUnassigned1,           // Undefined
    raatReplyMessage,          // Value field is a Pointer 
    raatCallbackNumber,        // Value field is a Pointer 
    raatCallbackId,            // Value field is a Pointer 
    raatUnassigned2,           // Undefined
    raatFramedRoute,           // Value field is a Pointer 
    raatFramedIPXNetwork,      // Value field is a 32 bit integral value
    raatState,                 // Value field is a Pointer 
    raatClass,                 // Value field is a Pointer 
    raatVendorSpecific,        // Value field is a Pointer 
    raatSessionTimeout,        // Value field is a 32 bit integral value
    raatIdleTimeout,           // Value field is a 32 bit integral value
    raatTerminationAction,     // Value field is a 32 bit integral value
    raatCalledStationId,       // Value field is a Pointer 
    raatCallingStationId,      // Value field is a Pointer 
    raatNASIdentifier,         // Value field is a Pointer 
    raatProxyState,            // Value field is a Pointer 
    raatLoginLATService,       // Value field is a Pointer 
    raatLoginLATNode,          // Value field is a Pointer 
    raatLoginLATGroup,         // Value field is a Pointer 
    raatFramedAppleTalkLink,   // Value field is a 32 bit integral value
    raatFramedAppleTalkNetwork,// Value field is a 32 bit integral value
    raatFramedAppleTalkZone,   // Value field is a Pointer 
    raatAcctStatusType,        // Value field is a 32 bit integral value
    raatAcctDelayType,         // Value field is a 32 bit integral value
    raatAcctInputOctets,       // Value field is a 32 bit integral value
    raatAcctOutputOctets,      // Value field is a 32 bit integral value
    raatAcctSessionId,         // Value field is a Pointer 
    raatAcctAuthentic,         // Value field is a 32 bit integral value
    raatAcctSessionTime,       // Value field is a 32 bit integral value
    raatAcctInputPackets,      // Value field is a 32 bit integral value
    raatAcctOutputPackets,     // Value field is a 32 bit integral value
    raatAcctTerminateCause,    // Value field is a 32 bit integral value
    raatAcctMultiSessionId,    // Value field is a Pointer 
    raatAcctLinkCount,         // Value field is a 32 bit integral value
    raatMD5CHAPChallenge = 60, // Value field is a Pointer 
    raatNASPortType,           // Value field is a 32 bit integral value
    raatPortLimit,             // Value field is a 32 bit integral value
    raatLoginLATPort,          // Value field is a Pointer 
    raatPrompt,                // Value field is a 32 bit integral value
    raatConnectInfo,           // Value field is a Pointer 
    raatSignature,             // Value field is a Pointer 
    raatEAPMessage,            // Value field is a Pointer 
    raatConfigurationToken,    // Value field is a Pointer 
    raatPasswordRetry,         // Value field is a 32 bit integral value
    raatARAPPassword,          // Value field is a Pointer 
    raatARAPFeatures,          // Value field is a Pointer 
    raatARAPZoneAccess,        // Value field is a 32 bit integral value
    raatARAPSecurity,          // Value field is a 32 bit integral value
    raatARAPSecurityData,      // Value field is a Pointer 
    raatPasswordRetry,         // Value field is a 32 bit integral value
    raatPrompt,                // Value field is a 32 bit integral value
    raatConnectInfo,           // Value field is a Pointer 
    raatConfigurationToken,    // Value field is a Pointer 
    raatEAPMessage,            // Value field is a Pointer 
    raatSignature,             // Value field is a Pointer 
    raatEAPProtocol =(0xFFFFFFFF-90),// Value field is a 32 bit integral 
                                     // value
    raatEncryptionType,        // Value field is a 32 bit integral value
    raatEncryptionPolicy,      // Value field is a 32 bit integral value
    raatAuthenticationProtocol,// Value field is a 32 bit integral value
    raatTimeOfDay,             // Value field is a Pointer 
    raatBAPRequired,           // Value field is a 32 bit integral value
    raatBAPLineDownTime,       // Value field is a 32 bit integral value
    raatBAPLineDownLimit,      // Value field is a 32 bit integral value
    raatAllowedPortType,       // Value field is a 32 bit integral value
    raatReserved = 0xFFFFFFFF  // Undefined
} RAS_AUTH_ATTRIBUTE_TYPE;

Values

raatMinimum

This value is equal to zero, and used as the NULL terminator in any array of RAS_AUTH_ATTRIBUTE structures.

raatUserName

Specifies the name of the user to be authenticated. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatUserPassword

Specifies the password of the user to be authenticated. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatMD5CHAPPassword

Specifies the password provided by the user in response to an MD5 Challenge Handshake Authentication Protocol (CHAP) challenge.. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatNASIPAddress

Specifies the Network Access Server (NAS) IP address. An Access-Request should specify either an NAS IP address or an NAS identifier. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatNASPort

Identifies the physical or virtual private network (VPN) through which the user is connecting to the NAS. Note that this value is not a port number in the sense of TCP or UDP. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatServiceType

Specifies the type of service the user has requested or the type of service to be provided. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatFramedProtocol

Specifies the type of framed protocol to use for framed access, for example SLIP, PPP, or ARAP (AppleTalk Remote Access Protocol). The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatFramedIPAddress

Specifies the IP address that will be configured for the user requesting authentication. This attribute is typically returned by the authentication provider. However, the NAS may use it in an authentication request to specify a preferred IP address. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatFramedIPNetmask

Specifies the IP network mask for a user that is a router to a network. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatFramedRouting

Specifies the routing method for a user that is a router to a nework. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatFilterId

Identifies the filter list for the user requesting authentication. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatFramedMTU

Specifies the Maximum Transmission Unit (MTU) for the user. This attribute is used in cases where the MTU is not negotiated through some other means, e.g. PPP. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatFramedCompression

Specifies a compression protocol to use for the connection. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. http://ds.internic.net/rfc/rfc2138.txt.

raatLoginIPHost

Specifies the system with which to connect the user. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatLoginService

Specifies the service to use to connect the user to the host specified by raatLoginIPHost. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatLoginTCPPort

Specifies the port to which to connect the user. This attribute is present only if the raatLoginService attribute is present. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatUnassigned1

This value is currently unassigned.

raatReplyMessage

Specifies a message to display to the user. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatCallbackNumber

Specifies a callback number. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatCallbackId

Identifies a location to callback. The value of this attribute will be interpreted by the NAS. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatUnassigned2

This value is currently unassigned. The value field in RAS_AUTH_ATTRIBUTE for this type is also undefined.

raatFramedRoute

Provides routing information to configure on the NAS for the user. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatFramedIPXNetwork

Specifies the IPX network number to configure for the user. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatState

Please refer to http://ds.internic.net/rfc/rfc2138.txt for detailed information about this value. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.

raatClass

Specifies a value that is provided to the NAS by the authentication provider. The NAS should use this value when communicating with the the accounting provider. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatVendorSpecific

Allows vendors to provide their own extended attributes. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatSessionTimeout

Specifies the maximum number of seconds for which to provide service to the user. After this time, the session will be terminated. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatIdleTimeout

Specifies the maximum number of consecutive seconds the session can be idle. If the idle time exceeds this value, the session will be terminated. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatTerminationAction

Please refer to the above referenced files at ds.internic.net for detailed information about this value. The value field in RAS_AUTH_ATTRIBUTE for this type is 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatCalledStationId

Specifies the number that the user dialed to connect to the NAS. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatCallingStationId

Specifies the number from which the user is calling. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatNASIdentifier

Specifies the Network Access Server (NAS) identifier. An Access-Request should specify either an NAS identifier or an NAS IP address. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatProxyState

Specifies a value that a proxy server will include when forwarding an authentication request. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatLoginLATService

This attribute is not currently used for authentication on Windows NT. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatLoginLATNode

This attribute is not currently used for authentication on Windows NT. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatLoginLATGroup

This attribute is not currently used for authentication on Windows NT. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatFramedAppleTalkLink

Specifies the AppleTalk network number for the user when the user is another router. The value field in RAS_AUTH_ATTRIBUTE for this type is 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatFramedAppleTalkNetwork

Specifies the AppleTalk network number that the NAS should use to allocate an AppleTalk node for the user. This attribute is used only when the user is not another router. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatFramedAppleTalkZone

Specifies the AppleTalk default zone for the user. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatAcctStatusType

Specifies whether the accounting provider should start or stop accounting for the user. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2139.txt for more information.

raatAcctDelayType

Specifies the length of time that the client has been attempting to send the current request. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2139.txt for more information.

raatAcctInputOctets

Specifies the number of octets that have been received during the current accounting session. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2139.txt for more information.

raatAcctOutputOctets

Specifies the number of octets that were sent during the current accounting session. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2139.txt for more information.

raatAcctSessionId

Specifies a value to enable the identification of matching start and stop records within a log file. The start and stop records are sent in the raatAcctStatusType attribute. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2139.txt for more information.

raatAcctAuthentic

Specifies to the accounting provider how the user was authenticated, for example by Windows NT Directory Services, RADIUS, or some other authentication provider. The value field in RAS_AUTH_ATTRIBUTEfor this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2139.txt for more information.

raatAcctSessionTime

Specifies the number of seconds that have elapsed in the current accounting session. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2139.txt for more information.

raatAcctInputPackets

Specifies the number of packets that have been received during the current accounting session. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2139.txt for more information.

raatAcctOutputPackets

Specifies the number of packets that have been sent during the current accounting session. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2139.txt for more information.

raatAcctTerminateCause

Specifies how the current accounting session was terminated. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2139.txt for more information.

raatAcctMultiSessionId

Specifies a value to enable the identification of related accounting sessions within a log file. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2139.txt for more information.

raatAcctLinkCount

Specifies the number of links if the current accounting session is using a multilink connection. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2139.txt for more information.

raatMD5CHAPChallenge

Specifies the CHAP challenge sent by the NAS to a CHAP user. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatNASPortType

Specifies the type of the port through which the user is connecting, for example, asynchronous, ISDN, vitual. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information.

raatPortLimit

Specifies the number of ports the NAS should make available to the user for multilink sessions. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/rfc/rfc2138.txt for more information

raatLoginLATPort

This attribute is not currently used for authentication on Windows NT. Please refer to the above referenced files at ds.internic.net for detailed information about this value.

raatARAPPassword

Specifies a password to use for AppleTalk Remote Access Protocol (ARAP) authentication. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/internet-drafts/draft-ietf-radius-ext-00.txt for more information.

raatARAPFeatures

Specifies information that an NAS should send back to the use in an ARAP "feature flags" packet. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/internet-drafts/draft-ietf-radius-ext-00.txt for more information.

raatARAPZoneAccess

Specifies how to use the ARAP zone list for the user. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/internet-drafts/draft-ietf-radius-ext-00.txt for more information.

raatARAPSecurity

Specifies an ARAP security module to use during a secondary authentication phase between the NAS and the user. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral. See http://ds.internic.net/internet-drafts/draft-ietf-radius-ext-00.txt for more information.

raatARAPSecurityData

Specifies the data to use with an ARAP security module. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer. See http://ds.internic.net/internet-drafts/draft-ietf-radius-ext-00.txt for more information.

raatPasswordRetry

Specifies the number of password retry attempts to permit the user. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. rfcext.

raatPrompt

Specifies whether the NAS should echo the users response to a challenge. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. See http://ds.internic.net/internet-drafts/draft-ietf-radius-ext-00.txt for more information.

raatConnectInfo

Provides information about the type of connection the user is using. The value field in RAS_AUTH_ATTRIBUTE for this type is a Pointer. See http://ds.internic.net/internet-drafts/draft-ietf-radius-ext-00.txt for more information.

raatConfigurationToken

Identifies user-profile information in communications between RADIUS Proxy Servers and RADIUS Proxy Clients. The value field in RAS_AUTH_ATTRIBUTE for this type is a Pointer. See http://ds.internic.net/internet-drafts/draft-ietf-radius-ext-00.txt for more information.

raatEAPMessage

Specifies Extensible Authentication Protocol (EAP) information to be sent directly between the user and the authentication provider. The value field in RAS_AUTH_ATTRIBUTE for this type is a Pointer. See http://ds.internic.net/internet-drafts/draft-ietf-radius-ext-00.txt for more information.

raatSignature

Specifies a signature to include with CHAP, EAP, or ARAP packets. The value field in RAS_AUTH_ATTRIBUTE for this type is a Pointer. See http://ds.internic.net/internet-drafts/draft-ietf-radius-ext-00.txt for more information.

raatEAPProtocol

Specifies a particular authentication protocol. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value

raatEncryptionType

Specifies an encryption key length (either 40 bit or 128 bit), and whether this length is allowed, disallowed, or required. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value

raatEncryptionPolicy

The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value

raatAuthenticationProtocol

Specifies a particular authentication protocol. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value.

raatTimeOfDay

Specifies the time (or times) of day during which the user may dial in. If this attribute is absent, the user may dial in at any time. The value field in RAS_AUTH_ATTRIBUTE for this type is a Pointer. The format of the string pointed to is

SUN|MON|TUE|WED|THU|FRI|SAT<SPACE>hh:mm-hh:mm{<SPACE>hh:mm-hh:mm}

The unit of time is 1 hour

An array of RAS_AUTH_ATTRIBUTE structures may contains multiple instances of raatTimeOfDay. If so, the user may dial in during any of the time listed in any of the structures.

raatBAPRequired

If this attribute is present, BAP is required for incoming multilink calls. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value

raatBAPLineDownTime

Specifies a time period in seconds. If a multilink connecton's capacity falls below that specified by raatBAPLineDownLimit for a length of time longer than the value of this attribute, one of the links in the multilink connection will be dropped. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value

raatBAPLineDownLimit

Specifies the percent capacity, below which, one of the links in a multilink connection may be dropped. See the raatBAPLineDownTime attribute for more information. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value

raatAllowedPortType

If this attribute is present, it encodes the port types that a user can use for dialing in. If this attribute is absent, the user can dial in on any type of port. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32 bit integral value. The value is a bitstring that represents the port types allowed.

raatReserved

The value field in RAS_AUTH_ATTRIBUTE for this type is undefined.

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in rasauth.h.

RAS_AUTH_ATTRIBUTE_TYPE

Values

QuickInfo

See Also