HttpListener.AuthenticationSchemes Property

Definition

Namespace:

System.Net

Assemblies:

netstandard.dll, System.Net.HttpListener.dll

Source:

HttpListener.cs

Gets or sets the scheme used to authenticate clients.

C#

public System.Net.AuthenticationSchemes AuthenticationSchemes { get; set; }

Property Value

AuthenticationSchemes

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

Exceptions

ObjectDisposedException

This object has been closed.

Examples

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

C#

public static void SimpleListenerWithUnsafeAuthentication(string[] prefixes)
{
    // URI prefixes are required,
    // for example "http://contoso.com:8080/index/".
    if (prefixes == null || prefixes.Length == 0)
      throw new ArgumentException("prefixes");
    // Set up a listener.
    HttpListener listener = new HttpListener();
    foreach (string s in prefixes)
    {
        listener.Prefixes.Add(s);
    }
    listener.Start();
    // 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;
    Console.WriteLine("Listening...");
    // ... process requests here.

    listener.Close();
}

Remarks

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.

Note

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

Applies to