RAS_AUTH_ATTRIBUTE_TYPE
A version of this page is also available for
4/8/2010
This enumeration specifies attribute values used for session authentication.
Syntax
typedef enum _RAS_AUTH_ATTRIBUTE_TYPE_ {
raatMinimum = 0,
raatUserName,
raatUserPassword,
raatMD5CHAPPassword,
raatNASIPAddress,
raatNASPort,
raatServiceType,
raatFramedProtocol,
raatFramedIPAddress,
raatFramedIPNetmask,
raatFramedRouting = 10,
raatFilterId,
raatFramedMTU,
raatFramedCompression,
raatLoginIPHost,
raatLoginService,
raatLoginTCPPort,
raatUnassigned17,
raatReplyMessage,
raatCallbackNumber = 20,
raatCallbackId,
raatUnassigned21,
raatFramedRoute,
raatFramedIPXNetwork,
raatState,
raatClass,
raatVendorSpecific,
raatSessionTimeout,
raatIdleTimeout,
raatTerminationAction,
raatCalledStationId = 30,
raatCallingStationId,
raatNASIdentifier,
raatProxyState,
raatLoginLATService,
raatLoginLATNode,
raatLoginLATGroup,
raatFramedAppleTalkLink,
raatFramedAppleTalkNetwork,
raatFramedAppleTalkZone,
raatAcctStatusType = 40,
raatAcctDelayTime,
raatAcctInputOctets,
raatAcctOutputOctets,
raatAcctSessionId,
raatAcctAuthentic,
raatAcctSessionTime,
raatAcctInputPackets,
raatAcctOutputPackets,
raatAcctTerminateCause,
raatAcctMultiSessionId = 50,
raatAcctLinkCount,
raatAcctEventTimeStamp = 55,
raatMD5CHAPChallenge = 60,
raatNASPortType,
raatPortLimit,
raatLoginLATPort,
raatTunnelType,
raatTunnelMediumType,
raatTunnelClientEndpoint,
raatTunnelServerEndpoint,
raatARAPPassword = 70,
raatARAPFeatures,
raatARAPZoneAccess,
raatARAPSecurity,
raatARAPSecurityData,
raatPasswordRetry,
raatPrompt,
raatConnectInfo,
raatConfigurationToken,
raatEAPMessage,
raatSignature = 80,
raatARAPChallengeResponse = 84,
raatAcctInterimInterval = 85,
raatARAPGuestLogon = 8096,
raatReserved = 0xFFFFFFFF
} RAS_AUTH_ATTRIBUTE_TYPE;
Elements
- raatMinimum
Specifies a value 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.
- raatUserPassword
Specifies the password of the user to be authenticated. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- 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.
- 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.
- raatNASPort
Specifies 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.
- 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.
- 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.
- raatFramedIPAddress
Specifies the IP address that is configured for the user who is requesting authentication. The authentication provider typically returns this attribute. 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.
- 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.
- raatFramedRouting
Specifies the routing method 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.
- raatFilterId
Specifies the filter list for the user who is requesting authentication. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- 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, such as PPP. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32-bit integral value.
- 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.
- 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.
- 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.
- 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.
- raatUnassigned17
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.
- raatCallbackNumber
Specifies a callback number. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- raatCallbackId
Specifies a location to call back. The value of this attribute is interpreted by the NAS. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- raatUnassigned21
This value is currently unassigned. The value field in RAS_AUTH_ATTRIBUTE for this type is also undefined.
- raatFramedRoute
Specifies routing information to configure on the NAS for the user. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- 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.
- raatState
Specifies state information provided to the client by the server. 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 accounting provider. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- raatVendorSpecific
Specifies a field for vendor-supplied extended attributes. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- raatSessionTimeout
Specifies the maximum number of seconds for which to provide service to the user. After this time, the session is terminated. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32-bit integral value.
- raatIdleTimeout
Specifies the maximum number of consecutive seconds the session can be idle. If the idle time exceeds this value, the session is terminated. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32-bit integral value.
- raatTerminationAction
Specifies an action the server performs when time the connection terminates. Refer to the preceding referenced files for detailed information about this value. The value field in RAS_AUTH_ATTRIBUTE for this type is 32-bit integral value.
- 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.
- raatCallingStationId
Specifies the number from which the user is calling. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- raatNASIdentifier
Specifies the 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.
- raatProxyState
Specifies a value that a proxy server includes when forwarding an authentication request. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- raatLoginLATService
Specifies an attribute that is not currently used for authentication on Windows Embedded CE.
- raatLoginLATNode
Specifies an attribute that is not currently used for authentication on Windows Embedded CE.
- raatLoginLATGroup
Specifies an attribute that is not currently used for authentication on Windows Embedded CE.
- 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.
- 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.
- raatFramedAppleTalkZone
Specifies the AppleTalk default zone for the user. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- 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.
- raatAcctDelayTime
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.
- 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.
- 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.
- 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.
- raatAcctAuthentic
Specifies, to the accounting provider, how the user was authenticated. The value field in RAS_AUTH_ATTRIBUTEfor this type is a 32-bit integral value.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- raatAcctEventTimeStamp
Specifies an attribute that is included in an accounting request packet. It specifies the time that the event took place. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32-bit integral value.
- raatMD5CHAPChallenge
Specifies the Challenge Handshake Authentication Protocol (CHAP) challenge sent by the NAS to a CHAP user. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- raatNASPortType
Specifies the type of the port through which the user is connecting, for example, asynchronous, ISDN, virtual. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32-bit integral value.
- 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.
- raatLoginLATPort
Specifies an attribute that is not currently used for authentication on Windows Embedded CE.
raatTunnelType
Specifies the tunneling protocol used. The following table shows valid tunnel types for Windows Embedded CE.Value Description 1
Point-to-Point Tunneling Protocol (PPTP)
10
Generic Route Encapsulation (GRE)
raatTunnelMediumType
Specifies which transport medium to use when creating a tunnel for those protocols that can operate over multiple transports. The following table shows valid medium types.Value Description 1
IPv4 (IP version 4)
2
IPv6 (IP version 6)
3
Network service access point (NSAP)
4
High-level data link control (HDLC) (8-bit multidrop)
5
Backbone network (BBN) 1822
6
802 (includes all 802 media plus Ethernet canonical format)
7
E.163 (POTS)
8
E.164 (SMDS, Frame Relay, ATM)
9
F.69 (Telex)
10
X.121 (X.25, Frame Relay)
11
Internetwork Packet Exchange (IPX)
12
AppleTalk
13
DECnet Phase IV
14
Banyan Virtual Networking System (VINES)
15
E.164 with NSAP format subaddress
- raatTunnelClientEndpoint
Points to the address of the initiator end of the tunnel.
- raatTunnelServerEndpoint
Points to the address of the server end of the tunnel.
- 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.
- raatARAPFeatures
Specifies information that an NAS should send back to the user in an ARAP "feature flags" packet. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- 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.
- 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 value.
- raatARAPSecurityData
Specifies the data to use with an ARAP security module. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- raatPasswordRetry
Specifies the number of password retry attempts to permit the user access. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32-bit integral value.
- raatPrompt
Specifies whether the NAS should echo the user response to a challenge. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32-bit integral value.
- raatConnectInfo
Specifies information about the type of connection the user is using. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- raatConfigurationToken
Specifies 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.
- raatEAPMessage
Specifies that EAP information be sent directly between the user and the authentication provider. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- 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.
- raatARAPChallengeResponse
Specifies the response to an Apple Remote Access Protocol (ARAP) challenge. In ARAP, either the server or the client may respond to challenges. The value field in RAS_AUTH_ATTRIBUTE for this type is a pointer.
- raatAcctInterimInterval
Specifies the time, in seconds, between accounting updates. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32-bit integral value.
- raatARAPGuestLogon
Specifies an Apple Remote Access Protocol (ARAP) guest logon. The value field in RAS_AUTH_ATTRIBUTE for this type is a 32-bit integral value.
- raatReserved
The value field in RAS_AUTH_ATTRIBUTE for this type is undefined.
Requirements
| Header | raseapif.h |
| Windows Embedded CE | Windows CE .NET 4.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |