PPP_EAP_OUTPUT

[This is preliminary documentation and subject to change.]

The authentication protocol uses the PPP_EAP_OUTPUT structure to communicate requests and status information to the RAS Connection Manager.

typedef struct _PPP_EAP_OUTPUT {
    PPP_EAP_ACTION       Action;                // action that RAS 
                                                // should take 
    DWORD                dwIdExpected;          // ID of expected 
                                                // response packet 
    DWORD                dwAuthResultCode;      // result of 
                                                // authentication 
    CHAR                 szIdentity[UNLEN+1];   // identifies the 
                                                // authenticated user 
    RAS_AUTH_ATTRIBUTE * pAuthenticatedUserAttributes;
                                                // array of attributes 
                                                // structure 
    BOOL                 fInvokeInteractiveUI;  // causes RAS 
                                                // to invoke 
                                                // interactive UI 
    PBYTE                pUIContextData;        // data to send to 
                                                // interactive UI 
    DWORD                dwSizeOfUIContextData; // size of data 
    BOOL                 fSaveConfigInfo;       // RAS should save 
                                                // the config info
    PBYTE             pConnectionData;     // pointer to the per-
                                           // connection config info
    DWORD             dwSizeofConnectionData;  // size of the per-
                                           // connection config info
    PBYTE             pUserData;           // pointer to the per-
                                           // user config info
    DWORD             dwSizeofUserData;    // size of the per-
                                           // user config info
} PPP_EAP_OUTPUT, *PPPP_EAP_OUTPUT; 
 

Members

Action

Specifies a PPP_EAP_ACTION value. The RAS Connection Manager will carry out this action on behalf of the authentication protocol.

dwIdExpected

Specifies the identifier (ID) for an incoming response packet. Use of this member tells RAS to drop packets that have identifiers that do not match this value. Set this member only if the Action member is EAPACTION_SendWithTimeout or EAPACTION_SendWithTimeoutInteractive.

dwAuthResultCode

Indicates whether authentication was successful. Any non-zero value for dwAuthResultCode indicates failure. The failure code must come from winerror.h, raserror.h or mprerror.h. This member is valid only if the Action member has a value of EAPACTION_Done or EAPACTION_SendAndDone.

szIdentity

Specifies an identifier for the authenticated user on the the server. The authentication protocol running on the server (that is, the authenticator) should set the szIdentity member when Action is EAPACTION_Done or EAPACTION_SendAndDone.

pAuthenticatedUserAttributes

Pointer to an optional array of RAS_AUTH_ATTRIBUTE structures. The array is terminated by a structure with an raaType member that has a value of raatMinimum (see RAS_AUTH_ATTRIBUTE_TYPE).

These structures are allocated by the authentication protocol only if the protocol is not using an existing authentication provider. It is up to the authentication protocol to free this memory in its RasEapEnd function. This member should be set on the authenticator side when Action is EAPACTION_Done or EAPACTION_SendAndDone, and dwAuthResultCode is zero.

fInvokeInteractiveUI

Specifies whether RAS should invoke the authentication protocol's interactive UI. If the authentication protocol sets this member to TRUE, RAS will invoke the interactive UI, by calling the RasEapInvokeInteractiveUI function provided by the authentication protocol.

pUIContextData

Pointer to context data that RAS should pass in the call to RasEapInvokeInteractiveUI. The authentication protocol should free this memory in its implementation of RasEapEnd.

dwSizeOfUIContextData

Specifies the size of the context data that RAS should pass in the call to RasEapInvokeInteractiveUI.

fSaveConfigInfo

Specifies whether RAS should save the config data pointed to by the pConnectionData and pUser data parameters. If this parameter is TRUE, RAS will save the config data in the phonebook entry for the connection.

pConnectionInfo

Pointer to connection-specific configuration data that RAS should save in the phonebook entry for the connection. The authentication protocol should free this memory during the call to RasEapEnd.

dwSizeofConnectionInfo

Specifies the size in bytes of the data pointed to by pConnectionData.

pUserData

Pointer to user-specific data that RAS should save for this connection. RAS will save this data in the registry under HKEY_CURRENT_USER. The authentication protocol should free this memory during the call to RasEapEnd.

dwSizeofUserData

Specifies the size in bytes of the data pointed to by pUserData.

Remarks

Use the RasEapMakeMessage function to pass the PPP_EAP_OUTPUT structure between the authentication protocol and the RAS Connection Manager

QuickInfo

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

See Also

RAS_AUTH_ATTRIBUTE, PPP_EAP_ACTION, RasEapInvokeInteractiveUI, RasEapMakeMessage