FtpWebRequest.EnableSsl Property

Gets or sets a Boolean that specifies that an SSL connection should be used.

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

public bool EnableSsl { get; set; }

Property Value

Type: System.Boolean
true if control and data transmissions are encrypted; otherwise, false. The default value is false.

ExceptionCondition
InvalidOperationException

The connection to the FTP server has already been established.

Caution noteCaution

Unless the EnableSsl property is true, all data and commands, including your user name and password information, are sent to the server in clear text. Anyone monitoring network traffic can view your credentials and use them to connect to the server. If you are connecting to an FTP server that requires credentials and supports SSL, you should set EnableSsl to true.

The "AUTH TLS" command is sent to the server to request an encrypted session. If the server does not recognize this command, you receive a WebException exception.

The following code example uses an encrypted connection to download the directory listing from an FTP server.

       public static bool ListFilesOnServerSsl(Uri serverUri)
       {
           // The serverUri should start with the ftp:// scheme. 
           if (serverUri.Scheme != Uri.UriSchemeFtp)
           {
               return false;
           }
           // Get the object used to communicate with the server.
           FtpWebRequest request = (FtpWebRequest)WebRequest.Create(serverUri);
           request.Method = WebRequestMethods.Ftp.ListDirectory;
           request.EnableSsl = true;

           // Get the ServicePoint object used for this request, and limit it to one connection. 
           // In a real-world application you might use the default number of connections (2), 
           // or select a value that works best for your application.

           ServicePoint sp = request.ServicePoint;
           Console.WriteLine("ServicePoint connections = {0}.", sp.ConnectionLimit);
           sp.ConnectionLimit = 1;

           FtpWebResponse response = (FtpWebResponse) request.GetResponse();
            Console.WriteLine("The content length is {0}", response.ContentLength);
           // The following streams are used to read the data returned from the server.
           Stream responseStream = null;
           StreamReader readStream = null;
           try
           {
               responseStream = response.GetResponseStream(); 
               readStream = new StreamReader(responseStream, System.Text.Encoding.UTF8);

               if (readStream != null)
               {
                   // Display the data received from the server.
                   Console.WriteLine(readStream.ReadToEnd());
               } 
               Console.WriteLine("List status: {0}",response.StatusDescription);            
           }
           finally
           {
               if (readStream != null)
               {
                   readStream.Close();
               }
               if (response != null)
               {
                   response.Close();
               }
           }


           Console.WriteLine("Banner message: {0}", 
               response.BannerMessage);

           Console.WriteLine("Welcome message: {0}", 
               response.WelcomeMessage);

           Console.WriteLine("Exit message: {0}", 
               response.ExitMessage);
           return true;
       }

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft