WPX_FILTER_AUTHENT_EX structure

  • Article

Applies to: desktop apps only

The Forefront TMG Web proxy includes a pointer to the WPX_FILTER_AUTHENT_EX structure when it is authenticating a user. If your filter should be notified for this event, it must register to receive SF_NOTIFY_AUTHENTICATION notifications. For more information about the types of event notifications that are sent to Web filters, see Event Notifications.

Syntax

typedef struct _WPX_FILTER_AUTHENT_EX {
  CHAR          *pszUser;
  DWORD         cbUserBuff;
  CHAR          *pszPassword;
  DWORD         cbPasswordBuff;
  BOOL          fAuthIsRequired;
  BOOL (WINAPI) *SetAuthenticatedUser;
  BOOL (WINAPI) *SetADAuthenticatedUser;
} WPX_FILTER_AUTHENT_EX, *PWPX_FILTER_AUTHENT_EX;

Members

  • pszUser
    Null-terminated string that specifies the user name for this request. An empty string indicates an anonymous user.

  • cbUserBuff
    The size of the buffer pointed to by pszUser. This is guaranteed to be at least SF_MAX_USERNAME.

  • pszPassword
    Null-terminated string that specifies the password for this request.

  • cbPasswordBuff
    The size of the buffer pointed to by pszPassword. This is guaranteed to be at least SF_MAX_PASSWORD.

  • fAuthIsRequired
    Indicates whether authentication is required for this request.

  • SetAuthenticatedUser
    Points to the SetAuthenticatedUser function, which is used by Web filters to set an authenticated non-Windows user.

  • SetADAuthenticatedUser
    Points to the SetADAuthenticatedUser function, which is used by Web filters to set an authenticated Windows user.

Remarks

This notification can be used to implement a Web filter that adds an authentication scheme to Forefront TMG.

When the server is about to authenticate the client, this structure is pointed to by the pvNotification parameter in the HttpFilterProc function when the notificationType parameter is SF_NOTIFY_AUTHENTICATION. The pszUser and pszPassword members contain the information sent by the client.

In the case of basic or RADIUS authentication, after exiting this notification, these values should represent a valid Windows user account and password. If another authentication method is used, the password value will not be available.

Requirements

Minimum supported client

 None supported

Minimum supported server

 Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)

Version

 Forefront Threat Management Gateway (TMG) 2010

Header

 Wpxhttpfilt.h

See also

Notification Structures

 

 

Build date: 7/12/2010