Export (0) Print
Expand All

HttpListener.AuthenticationSchemes Property

Gets or sets the scheme used to authenticate clients.

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

public AuthenticationSchemes AuthenticationSchemes { get; set; }
/** @property */
public AuthenticationSchemes get_AuthenticationSchemes ()

/** @property */
public void set_AuthenticationSchemes (AuthenticationSchemes value)

public function get AuthenticationSchemes () : AuthenticationSchemes

public function set AuthenticationSchemes (value : AuthenticationSchemes)

Not applicable.

Property Value

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

Exception typeCondition

ObjectDisposedException

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.

NoteNote:

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 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();
}

public static void SimpleListenerWithUnsafeAuthentication(String prefixes[])
{
    // URI prefixes are required,
    // for example "http://contoso.com:8080/index/".
    if (prefixes == null || prefixes.get_Length() == 0) {
        throw new ArgumentException("prefixes");
    }
    // Set up a listener.
    HttpListener listener = new HttpListener();
    for (int iCtr = 0; iCtr < prefixes.get_Length(); iCtr++) {
        String s = prefixes[iCtr];
        listener.get_Prefixes().Add(s);
    }
    listener.Start();
    // Specify Negotiate as the authentication scheme.
    listener.set_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.set_UnsafeConnectionNtlmAuthentication(true);
    // This listener does not want to recieve exceptions 
    // that occur when sending the response to the client.
    listener.set_IgnoreWriteExceptions(true);
    Console.WriteLine("Listening...");
    // ... process requests here.
    listener.Close();
} //SimpleListenerWithUnsafeAuthentication

Windows 98, Windows Server 2003, Windows XP Media Center Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft