This documentation is archived and is not being maintained.

HttpListener.AuthenticationSchemes Property

Gets or sets the scheme used to authenticate clients.

Namespace:  System.Net
Assembly:  System (in System.dll)

Public Property AuthenticationSchemes As AuthenticationSchemes

Property Value

Type: System.Net.AuthenticationSchemes
A bitwise combination of AuthenticationSchemes enumeration values that indicates how clients are to be authenticated. The default value is Anonymous.


This object has been closed.

The HttpListener uses the specified scheme to authenticate all incoming requests. The GetContext and EndGetContext methods return an incoming client request only if the HttpListener successfully authenticates the request.

You can interrogate the identity of a successfully authenticated client by using the HttpListenerContext.User property.

If you want an HttpListener object to use different authentication mechanisms based on characteristics of the requests it receives (for example, the request's Url or UserHostName property), you must implement a method that chooses the authentication scheme. For instructions about how to do this, see the AuthenticationSchemeSelectorDelegate property documentation.


To set this property to enable Digest, NTLM, or Negotiate requires the SecurityPermission, ControlPrincipal.

The following code example demonstrates using the AuthenticationSchemes property to specify an authentication scheme.

Public Shared Sub SimpleListenerWithUnsafeAuthentication(ByVal prefixes() As String)
    ' URI prefixes are required,
    ' for example "".
    If prefixes Is Nothing OrElse prefixes.Length = 0 Then
        Throw New ArgumentException("prefixes")
    End If
    ' Set up a listener.
    Dim listener As New HttpListener()
    For Each s As String In prefixes
    Next s
    ' Specify Negotiate as the authentication scheme.
    listener.AuthenticationSchemes = AuthenticationSchemes.Negotiate
    ' If NTLM is used, we will allow multiple requests on the same
    ' connection to use the authentication information of first request.
    ' This improves performance but does reduce the security of your 
    ' application. 
    listener.UnsafeConnectionNtlmAuthentication = True
    ' This listener does not want to receive exceptions 
    ' that occur when sending the response to the client.
    listener.IgnoreWriteExceptions = True
    ' ... process requests here.

End Sub

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.