Ultimate FTP in Microsoft Windows PowerShell

ATP Inc would like to illustrate how to use Ultimate FTP in PowerShell in this topic. PowerShell is the new command line and scripting language developed by Microsoft to helps IT professionals complete their tasks more efficiently with greater control and productivity on Microsoft Windows Platforms. The PowerShell contains more than 130 command line tools especially designed for administrators.

Windows PowerShell is built on top of the .NET Framework, so it gives administrators a wide-range of methods and extensions. With Ultimate FTP, now you can upload and download files to FTP server easily with a few lines of code. Since PowerShell accepts and returns .NET objects, FTP classes are accessible to the PowerShell, in which you can use the component to build a complex application like a C# or VB.NET application. This component can be downloaded from our website.

To get start, we begin with uploading several files with a single line of code:

Unlike many other FTP components, Ultimate FTP enables you to upload and download multiple files with different extensions with a single line of code. We take advantages of this feature with the following PowerShell sample:

# Load DLL
 Add-Type -Path C:\InstalledDir\UltimateFtp.dll
 # Set source path and files to upload
 $sourcePath = "C:\Temp\*.ps1;*.dat;*.zip"
 # Set destination path
 $destinationPath = "/my dir"
 # Create a new instance of the Ftp class
 $ftp = New-Object Atp.Net.Ftp
 $ftp.Connect("myserver")
 $ftp.Authenticate("user", "pass")
 # Upload files
 $ftp.UploadFiles($sourcePath, $destinationPath)
 
 $ftp.Close()
 $ftp.Dispose()

Now we will download files from the FTP server to the local disk:

We gives you the ease-of-use of the FTP component not only in the upload methods, but also in the download methods. The following PowerShell code example demonstrates how to load the UltimateFtp.DLL assembly and download files from the FTP server:

# Load DLL
Add-Type -Path C:\InstalledDir\UltimateFtp.dll
# Set source path and files to upload
$sourcePath = "/my dir/*.ps1;*.dat;*.zip"
# Set destination path
$destinationPath = "C:\Temp2"
# Create a new instance of the Ftp class
$ftp = New-Object Atp.Net.Ftp
 $ftp.Connect("myserver")
 $ftp.Authenticate("user", "pass")
 # Download files
$ftp.DownloadFiles($sourcePath, $destinationPath)

$ftp.Close()
$ftp.Dispose()

Now you see with Ultimate FTP Component and a little knowledge of PowerShell language, you can build a comprehensive file transfer application running on the Windows PowerShell.

Click here to download the Ultimate FTP Component for .NET, or here to download the .NET CF version.

Security Overview and How to Connect to FTP/SSL Servers

This topic gives you an overview of Certificate and Security Modes for FTP/SSL. It also illustrates how to connect to FTP/SSL servers using Ultimate FTP.

What is a digital certificate?

Authentication is important for secure communications. Users must be able to prove their identity to the entities they are communicating with. In addition, they must be able to verify the identity of the entity communicating with them. This is accomplished by presenting or verifying some form of trusted credentials.

A digital certificate is a common credential that provides authentication. A trusted organization, called a Certificate Authority (CA), assigns a certificate to a user or entity and the user or entity then uses the certificate to prove itself to the other side. You may configure your system to accept any number of Certificate Authorities but ATP does not recommend this configuration. Completing the following steps to access the Certificates dialog box:

  1. In the Control Panel, double-click Internet Options.
  2. Select the Content tab, and then click Certificates.

Where do I get a certificate?

Certificates must come from a trusted CA. A user submits a certificate request to a CA and the CA returns a certificate for the user to use. Certificate used on our FTP server is generated by FileZila and CuteFTP. Listed below are some Certificate Authorities:

  • Microsoft Certificate Server - used for internal corporate Certificate delegation
  • VeriSign - (www.verisign.com) provides certificates for Internet users and servers

You always need a digital certificate installed to operate as a server. You only need a digital certificate installed on a client if the server requests authentication.

How does the authentication process work?

  1. The client normally initiates the TCP connection. The Connect method makes this TCP connection, sends a "client hello" message, and automatically responds to authentication requests received from the server.
  2. The server accepts the connection initiated by the client, constructs its digital credentials from the digital certificate referred to by the Server.Certificate Property, and sends its credentials to the client.
  3. Optionally, the server may also send an authentication request to the client.
  4. The client receives the server's credentials, verifies it against the CAs it is configured to trust, and responds with its own credentials if an authentication request is received.
  5. If the client and server cannot negotiate a mutually acceptable security protocol, an error is generated and the connection is closed.
  6. If the client cannot validate the server's credentials, an error is generated and the client closes the connection.
  7. If the server cannot validate the client's credentials (if requested), an error is generated and the server closes the connection.
  8. Once protocol negotiation and authentication is successful, secure encryption/decryption is performed on all data passing over the connection.
  9. The session is terminated when one side closes the connection.

What is a certificate store?

A certificate store is a location on the system (memory, disk, registry, etc.) where certificates are stored for use. There are three major system stores and other minor stores. The three major stores are:

  • MY - personal certificates go here. (e.g. ATP code signing)
  • ROOT - certificates for Trusted Root Certificate Authorities.
  • CA - all other certificates.

What are the system store and the machine store?

The system store is the certificate store located in the HKEY_CURRENT_USER registry key. The machine store is the certificate store located in the HKEY_LOCAL_MACHINE registry key. Applications installed as a service should store their certificates in the machine store since there is no current user when running as a service.

What is the X500 naming convention?

This is a format for creating a distinguished name. The different parts of the name are described below:

  • C - country you are in (ex. US).
  • S - state you are in (ex. California).
  • L - locality value or city (ex. Walnut).
  • O - your organization (ex. ATP, Inc.).
  • OU - organizational unit (ex. Software Development).
  • CN - common name; typically the name of the system or user (Ex. www.mydomain.com).

Here are some examples of X500 names:

  • C=US, S=New York, L=Syracuse, O=ATP, Inc., OU=ATP, CN=My Machine
  • C=US, S=Georgia, L=Atlanta, O=MyOrg, OU=Toy Department, CN=John Doe

Explicit connection

When the client connects to the server using SSL, an SSL negotiation is initialized, the connection is secured and all following communication is being protected. 

The code snippet below shows how to connect to an FTP server securely using Explicit security mode.

C#  
// Create a new instance.
Ftp client = new Ftp();
// Connect to the FTP server.
client.Connect("myserver", 21, SecurityMode.Explicit);
// Authenticate.
client.Authenticate("userName", "password");
// Do something here...
client.DownloadFile("/my remote file.dat", "my local file");
// Disconnect.
client.Disconnect();

 

VB.NET

 
' Create a new instance.
Dim client As New Ftp()
' Connect to the FTP server.
client.Connect("myserver", 21, SecurityMode.Explicit)
' Authenticate.
client.Authenticate("userName", "password")
' Do something here...
client.DownloadFile("/my remote file.dat", "my local file")
' Disconnect.
client.Disconnect()

 

Implicit Connection with FTP

Originally, a separate port was assigned to the SSL version of the FTP. The port number 990 is usually assigned for FTP/SSL. Upon connection to this port, an SSL negotiation starts immediately and the control connection is secured. All data connections are also secured implicitly in the same way. This is similar to the approach used by HTTPS.

The code snippet below shows how to connect to an FTP server securely using Implicit security mode in Ultimate FTP.

C#  
// Create a new instance.
Ftp client = new Ftp();
// Connect to the FTP server.
client.Connect("myserver", 990, SecurityMode.Implicit);
// Authenticate.
client.Authenticate("userName", "password");
// Do something here...
client.DownloadFile("/my remote file.dat", "my local file");
// Disconnect.
client.Disconnect();

VB.NET  
' Create a new instance.
Dim client As New Ftp()
' Connect to the FTP server.
client.Connect("myserver", 990, SecurityMode.Implicit)
' Authenticate.
client.Authenticate("userName", "password")
' Do something here...
client.DownloadFile("/my remote file.dat", "my local file")
' Disconnect.
client.Disconnect()

Click here to download the Ultimate FTP Component for .NET, or here to download the .NET CF version.

 

Downloading multiple files and directories

Download multiple files and directories with ATP UltimateFtp is really simple. You only need to call the DownloadFiles method with few parameters. The component will do the rest of hard work for you. It will loop through the specified directory, find files that match the specified search criteria, create threads, and start downloading. The steps belows show you how to use Ultimate FTP to download files with three threads.

Downloading files using multiple threads

Add using directives to your code to create aliases for existing namespaces and avoid having to type the fully qualified type names. The code looks similar to the following:

C# Copy Code
using Atp.Net;
using Atp.IO;
VB.NET Copy Code
Imports Atp.Net
Imports Atp.IO

Create a new instance of the Ftp class.
C# Copy Code
// Create a new instance.
Ftp client = new Ftp();
VB.NET Copy Code
' Create a new instance.
Dim client As New Ftp()
Register event handlers to the ThreadCompleted and ThreadsCompleted events to get informed when a thread has completed and all threads have completed. The code looks similar to the following:
C# Copy Code
client.ThreadCompleted += client_ThreadCompleted;
client.ThreadsCompleted += client_ThreadsCompleted;
VB.NET Copy Code
AddHandler client.ThreadCompleted, AddressOf client_ThreadCompleted
AddHandler client.ThreadsCompleted, AddressOf client_ThreadsCompleted

Now pass all needed parameters to the DownloadFiles method. The code looks similar to the following:
C# Copy Code
// Download files and subdirectories from "/my folder" to "c:\\my folder" using 3 threads. This waits untils these threads complete.
client.DownloadFiles("/my folder", "c:\\my folder", 3, true);
VB.NET Copy Code
' Download files and subdirectories from "/my folder" to "c:\\my folder" using 3 threads. This waits untils these threads complete.
client.DownloadFiles("/my folder""c:\my folder", 3, True)

Final example code

C# Copy Code
public void DoMultiThreadsDownloadFiles()
{
   
// Create a new instance of the Atp.Net.Ftp class.
   
Ftp client = new Ftp();
   
// Connect to the server.
   
client.Connect("server");
   
// Authenticate.
   
client.Authenticate("user", "pass");
   client.CommandResponse += client_ResponseRead;
   client.ThreadCompleted += client_ThreadCompleted;
   client.ThreadsCompleted += client_ThreadsCompleted;
   
// ...
   
// Download files and subdirectories from "/my folder" to "c:\\my folder" using 3 threads. This waits untils these threads complete.
   
client.DownloadFiles("/my folder", "c:\\my folder", 3, true);
   
// ...
   
client.Disconnect();
}
void client_ThreadsCompleted(object sender, ThreadsCompletedEventArgs e)
{
   Console.WriteLine(
"Multi-threads file transfer completed");
}
void client_ThreadCompleted(object sender, ThreadCompletedEventArgs e)
{
   Console.WriteLine(
string.Format("Thread ID {0} completed", e.FileSystem.ThreadId));
}
void client_ResponseRead(object sender, CommandResponseEventArgs e)
{
   Ftp client = (Ftp)sender;
   
if (client.ThreadId >= 0)
       
if (e.Command != null)
           Console.WriteLine(
"Thread: {0} - CMD>       {1}", client.ThreadId,
               e.Command);
       
else
           
Console.WriteLine("Thread: {0} - RESPONSE>  {1}", client.ThreadId,
               e.Response);
}
VB.NET Copy Code
Public Sub DoMultiThreadsDownloadFiles()
    ' Create a new instance.
    Dim client As New Ftp()
    ' Connect to the server.
    client.Connect("server")
    ' Authenticate.
    client.Authenticate("user""pass")
    AddHandler client.CommandResponse, AddressOf client_ResponseRead
    AddHandler client.ThreadCompleted, AddressOf client_ThreadCompleted
    AddHandler client.ThreadsCompleted, AddressOf client_ThreadsCompleted
    ' ...
    ' Download files and subdirectories from "/my folder" to "c:\\my folder" using 3 threads. This waits untils these threads complete.
    client.DownloadFiles("/my folder""c:\my folder", 3, True)
    ' ...
    client.Disconnect()
End Sub
Private Sub client_ThreadsCompleted(ByVal sender As ObjectByVal e AsThreadsCompletedEventArgs)
    Console.WriteLine("Multi-threads file transfer completed")
End Sub
Private Sub client_ThreadCompleted(ByVal sender As ObjectByVal e AsThreadCompletedEventArgs)
    Console.WriteLine(String.Format("Thread ID {0} completed", e.FileSystem.ThreadId))
End Sub
Private Sub client_ResponseRead(ByVal sender As ObjectByVal e AsCommandResponseEventArgs)
    Dim client As Ftp = CType(sender, Ftp)
    If client.ThreadId >= 0 Then
        If e.Command IsNot Nothing Then
            Console.WriteLine("Thread: {0} - CMD> {1}", client.ThreadId, e.Command)
        Else
            Console.WriteLine("Thread: {0} - RESPONSE> {1}", client.ThreadId, e.Response)
        End If
    End If
End Sub

You may want to see other topics:

Uploading selected files and directories

 

Click here to download the Ultimate FTP Component for .NET, or here to download the .NET CF version.

How to upload selected files and directories

Use the UploadFiles method to easily upload selected files and directories from the local disk to the FTP server. You just need to provide local path, remote path, files and directories to upload and transfer options, ATP Ultimate FTP component will do the rest of hard work for you.

The following steps show you how to use the UploadFiles method to upload multiple files to the remote server. To download multiple files, see this http://www.ftpcomponent.net/downloading-multiple-files-and-directories

C#



// Create a new instance.
 Ftp client = new Ftp();
 // Connect to the FTP server.
 client.Connect("localhost");
 // Authenticate.
 client.Authenticate("test", "test");
 // ...
 // List of files and directories to upload.
 string[] files = new string[] { "myfile", "my dir", @"c:\my folder\my dir2" };
 // Upload selected files and subdirectories in local folder 'c:\my folder' to the remote dir '/temp'.
 client.UploadFiles(@"c:\my folder", files, "/temp", new TransferOptions());
 // ...
 // Disconnect.
 client.Disconnect();


VB.NET

' Create a new instance.
 Dim client As New Ftp()
 ' Connect to the FTP server.
 client.Connect("localhost")
 ' Authenticate.
 client.Authenticate("test", "test")
 ' ...
 ' List of files and directories to upload.
 Dim files() As String = {"myfile", "my dir", "c:\my folder\my dir2"}
 ' Upload selected files and subdirectories in local folder 'c:\my folder' to the remote dir '/temp'.
 client.UploadFiles("c:\my folder", files, "/temp", New TransferOptions())
 ' ...
 ' Disconnect.
 client.Disconnect()

Click here to download the Ultimate FTP Component for .NET, or here to download the .NET CF version.