This documentation is archived and is not being maintained.

NegotiateStream.RemoteIdentity Property

Gets information about the identity of the remote party sharing this authenticated stream.

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

'Declaration
Public Overridable ReadOnly Property RemoteIdentity As IIdentity
	Get

Property Value

Type: System.Security.Principal.IIdentity
An IIdentity object that describes the identity of the remote endpoint.

ExceptionCondition
InvalidOperationException

Authentication failed or has not occurred.

When accessed by the client, this property returns a GenericIdentity containing the Service Principal Name (SPN) of the server and the authentication protocol used. When accessed by the server, this property returns a WindowsIdentity that describes the client. If the WindowsIdentity is not available, client information is returned to the server in a GenericIdentity.

The following code example demonstrates displaying the value of this property.


Public Shared Sub EndAuthenticateCallback(ByVal ar As IAsyncResult)
    ' Get the saved data.
    Dim cState As ClientState = CType(ar.AsyncState, ClientState)
    Dim clientRequest As TcpClient = cState.Client
    Dim authStream As NegotiateStream = CType(cState.AuthenticatedStream, NegotiateStream)
    Console.WriteLine("Ending authentication.")
    ' Any exceptions that occurred during authentication are
    ' thrown by the EndAuthenticateAsServer method.
    Try
        ' This call blocks until the authentication is complete.
        authStream.EndAuthenticateAsServer(ar)
    Catch e As AuthenticationException
        Console.WriteLine(e)
        Console.WriteLine("Authentication failed - closing connection.")
        cState.Waiter.Set()
        Return
    Catch e As Exception
        Console.WriteLine(e)
        Console.WriteLine("Closing connection.")
        cState.Waiter.Set()
        Return
    End Try
    ' Display properties of the authenticated client.
    Dim id As IIdentity = authStream.RemoteIdentity
    Console.WriteLine("{0} was authenticated using {1}.", id.Name, id.AuthenticationType)
    cState.Waiter.Set()

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.
Show: