AuthenticatedStream Class

AuthenticatedStream Class

 

Provides methods for passing credentials across a stream and requesting or performing authentication for client-server applications.

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

System.Object
  System.MarshalByRefObject
    System.IO.Stream
      System.Net.Security.AuthenticatedStream
        System.Net.Security.NegotiateStream
        System.Net.Security.SslStream

public abstract class AuthenticatedStream : Stream

NameDescription
System_CAPS_protmethodAuthenticatedStream(Stream, Boolean)

Initializes a new instance of the AuthenticatedStream class.

NameDescription
System_CAPS_pubpropertyCanRead

When overridden in a derived class, gets a value indicating whether the current stream supports reading.(Inherited from Stream.)

System_CAPS_pubpropertyCanSeek

When overridden in a derived class, gets a value indicating whether the current stream supports seeking.(Inherited from Stream.)

System_CAPS_pubpropertyCanTimeout

Gets a value that determines whether the current stream can time out.(Inherited from Stream.)

System_CAPS_pubpropertyCanWrite

When overridden in a derived class, gets a value indicating whether the current stream supports writing.(Inherited from Stream.)

System_CAPS_protpropertyInnerStream

Gets the stream used by this AuthenticatedStream for sending and receiving data.

System_CAPS_pubpropertyIsAuthenticated

Gets a Boolean value that indicates whether authentication was successful.

System_CAPS_pubpropertyIsEncrypted

Gets a Boolean value that indicates whether data sent using this AuthenticatedStream is encrypted.

System_CAPS_pubpropertyIsMutuallyAuthenticated

Gets a Boolean value that indicates whether both server and client have been authenticated.

System_CAPS_pubpropertyIsServer

Gets a Boolean value that indicates whether the local side of the connection was authenticated as the server.

System_CAPS_pubpropertyIsSigned

Gets a Boolean value that indicates whether the data sent using this stream is signed.

System_CAPS_pubpropertyLeaveInnerStreamOpen

Gets whether the stream used by this AuthenticatedStream for sending and receiving data has been left open.

System_CAPS_pubpropertyLength

When overridden in a derived class, gets the length in bytes of the stream.(Inherited from Stream.)

System_CAPS_pubpropertyPosition

When overridden in a derived class, gets or sets the position within the current stream.(Inherited from Stream.)

System_CAPS_pubpropertyReadTimeout

Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.)

System_CAPS_pubpropertyWriteTimeout

Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.)

NameDescription
System_CAPS_pubmethodBeginRead(Byte[], Int32, Int32, AsyncCallback, Object)

Begins an asynchronous read operation. (Consider using ReadAsync instead; see the Remarks section.)(Inherited from Stream.)

System_CAPS_pubmethodBeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)

Begins an asynchronous write operation. (Consider using WriteAsync instead; see the Remarks section.)(Inherited from Stream.)

System_CAPS_pubmethodClose()

Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed.(Inherited from Stream.)

System_CAPS_pubmethodCopyTo(Stream)

Reads the bytes from the current stream and writes them to another stream.(Inherited from Stream.)

System_CAPS_pubmethodCopyTo(Stream, Int32)

Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream)

Asynchronously reads the bytes from the current stream and writes them to another stream.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream, Int32)

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream, Int32, CancellationToken)

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.(Inherited from Stream.)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodCreateWaitHandle()

Obsolete.Allocates a WaitHandle object.(Inherited from Stream.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Stream.(Inherited from Stream.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the AuthenticatedStream and optionally releases the managed resources. (Overrides Stream.Dispose(Boolean).)

System_CAPS_pubmethodEndRead(IAsyncResult)

Waits for the pending asynchronous read to complete. (Consider using ReadAsync instead; see the Remarks section.)(Inherited from Stream.)

System_CAPS_pubmethodEndWrite(IAsyncResult)

Ends an asynchronous write operation. (Consider using WriteAsync instead; see the Remarks section.)(Inherited from Stream.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFlush()

When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.(Inherited from Stream.)

System_CAPS_pubmethodFlushAsync()

Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.(Inherited from Stream.)

System_CAPS_pubmethodFlushAsync(CancellationToken)

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.(Inherited from Stream.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodObjectInvariant()

Obsolete. This API supports the product infrastructure and is not intended to be used directly from your code. Provides support for a Contract.(Inherited from Stream.)

System_CAPS_pubmethodRead(Byte[], Int32, Int32)

When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.(Inherited from Stream.)

System_CAPS_pubmethodReadAsync(Byte[], Int32, Int32)

Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.(Inherited from Stream.)

System_CAPS_pubmethodReadAsync(Byte[], Int32, Int32, CancellationToken)

Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.(Inherited from Stream.)

System_CAPS_pubmethodReadByte()

Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.(Inherited from Stream.)

System_CAPS_pubmethodSeek(Int64, SeekOrigin)

When overridden in a derived class, sets the position within the current stream.(Inherited from Stream.)

System_CAPS_pubmethodSetLength(Int64)

When overridden in a derived class, sets the length of the current stream.(Inherited from Stream.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWrite(Byte[], Int32, Int32)

When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.(Inherited from Stream.)

System_CAPS_pubmethodWriteAsync(Byte[], Int32, Int32)

Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.(Inherited from Stream.)

System_CAPS_pubmethodWriteAsync(Byte[], Int32, Int32, CancellationToken)

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.(Inherited from Stream.)

System_CAPS_pubmethodWriteByte(Byte)

Writes a byte to the current position in the stream and advances the position within the stream by one byte.(Inherited from Stream.)

This abstract class provides methods and properties that are common to authenticated streams.

Authenticated streams can provide authentication, data signing, and encryption services that can help maintain the integrity and confidentiality of data transmitted using the InnerStream.

The security protocol implemented by a class that derives from AuthenticatedStream together with the security protocols supported on the client and server will determine the security features that are available to an application. The NegotiateStream and SslStream classes inherit from AuthenticatedStream and implement the Negotiate and Secure Sockets Layer security protocols, respectively.

Notes to Inheritors:

The following members must be overridden in a derived class: IsAuthenticated, IsEncrypted, IsMutuallyAuthenticated, IsServer, and IsSigned.

The following code example demonstrates displaying the properties of an authenticated stream.


    // The following class displays the properties of an authenticatedStream.
    public class AuthenticatedStreamReporter
{
    public static void DisplayProperties(AuthenticatedStream stream)
   {
        Console.WriteLine("IsAuthenticated: {0}", stream.IsAuthenticated);
        Console.WriteLine("IsMutuallyAuthenticated: {0}", stream.IsMutuallyAuthenticated);
        Console.WriteLine("IsEncrypted: {0}", stream.IsEncrypted);
        Console.WriteLine("IsSigned: {0}", stream.IsSigned);
        Console.WriteLine("IsServer: {0}", stream.IsServer);
    }
}

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft