Export (0) Print
Expand All

HttpListenerRequest.ClientCertificateError Property

Gets an error code that identifies a problem with the X509Certificate provided by the client.

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

'Declaration
Public ReadOnly Property ClientCertificateError As Integer

Property Value

Type: System.Int32
An Int32 value that contains a Windows error code.

ExceptionCondition
InvalidOperationException

The client certificate has not been initialized yet by a call to the BeginGetClientCertificate or GetClientCertificate methods

-or -

The operation is still in progress.

This property contains a Windows error code returned by the Secure Channel (Schannel) Security Support Provider Interface (SSPI), which is used to validate the certificate. For more information about SSPI support for Schannel, see "Creating a Secure Connection Using Schannel" in the Security documentation at http://msdn.microsoft.com/library.

The following code example checks this property to determine whether the request includes a valid client certificate.

Console.WriteLine("Listening for {0} prefixes...", listener.Prefixes.Count)
Dim context As HttpListenerContext = listener.GetContext()
Dim request As HttpListenerRequest = context.Request
Console.WriteLine("Received a request.")
' This server requires a valid client certificate 
' for requests that are not sent from the local computer. 

' Did the client omit the certificate or send an invalid certificate? 
If request.IsAuthenticated AndAlso request.GetClientCertificate() Is Nothing OrElse request.ClientCertificateError <> 0 Then 
    ' Send a 403 response. 
    Dim badCertificateResponse As HttpListenerResponse = context.Response
    SendBadCertificateResponse(badCertificateResponse)
    Console.WriteLine("Client has invalid certificate.")
    Continue Do 
End If

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft