BasicAuthentication Property of the IFPCWebListenerProperties Interface

Article
08/13/2010

The BasicAuthentication property gets or sets a Boolean value that indicates whether Basic authentication is used.

C++

HRESULT put_BasicAuthentication(
    VARIANT_BOOL fBasicAuthentication
);
HRESULT get_BasicAuthentication(
    VARIANT_BOOL* pfBasicAuthentication
);

Parameters

fBasicAuthentication
Boolean value that indicates whether Basic authentication is used.
pfBasicAuthentication
Pointer to a Boolean variable that is set on return to VARIANT_TRUE if Basic authentication is used, or to VARIANT_FALSE if Basic authentication is not used.

Return Value

These property methods return S_OK if the call is successful; otherwise, they return an error code.

Visual Basic

Property BasicAuthentication As Boolean

Property Value

Boolean value that indicates whether Basic authentication is used.

Remarks

This property is read/write. Its default value is False (VARIANT_FALSE in C++).

The standard Hypertext Transfer Protocol (HTTP) method of authentication is Basic authentication. Basic authentication sends and receives user information as text characters that can be easily read. Although passwords and user names are encoded, no encryption is used with Basic authentication. The following describes the authentication procedure for Basic authentication:

The client prompts the user for credentials, which consist of a user name and password.
The credentials are then encoded by the client and sent to the server.
The user name is verified as being an account on the Forefront TMG computer or in a trusted domain of the Forefront TMG computer.

Basic authentication can be enabled for a Web listener together with Digest authentication, Integrated authentication, and SSL certificate authentication.

Requirements

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.
DLL	Requires Msfpccom.dll.