C#访问基于公开键认证的SFTP服务器

来源：互联网发布：软件项目开发总结编辑：程序博客网时间：2024/06/06 19:31

什么是SFTP，公开键认证，

SFTP可不是FTP协议的扩展，他是基于SSH的文件传输协议。而当SFTP服务器登录有客户端的公开键时，客户端就可以用自己的私有键去跟服务器握手（handshake）已实现登录而不需要输入密码。而这种方式被称为公开键认证。

1 建SFTP服务器

首先当然是先建一个local SFTP server ,我使用的是SilverSHielD. 它是非商用的话，免费，当然只能同时又三个连接，下载，安装。

2 配置服务器

打开"SilverSHielD Management Console",然后connect

Log Path设一下，然后切换到user,追加

username等等，填好.

关键的在manage User’s　Public Keys, 打开， Add

正规的流程应该是客户用winscp等工具生成自己的Key-pair，然后把public 可以贴到 actual Public Key, 俺们自己测试用，所以直接Generate，

然后会提示你保存私有键，这是一定要选 OpenSSH Private Key Files ，这个生成的文件就是客户端认证用私有键。

依次confirm下去，配置完成。

3 下载访问SFTP的library

我用的是 SSH.NET Library

4，访问代码

A,说不定另一个客户用的是FTP，做一个通用的接口先：

public interface IFtpClient     {         /// <summary>         /// 连接服务器         /// </summary>         /// <returns>true：成功；false：失败</returns>         bool Connect();         /// <summary>         /// 断开连接         /// </summary>         void DisConnect();          /// <summary>         /// 取得文件列表         /// </summary>         /// <param name="path">路径</param>         /// <returns></returns>         List<string> ListFiles(string path);          /// <summary>         /// 下载文件          /// </summary>         /// <param name="remoteFileName">包含全路径的服务器端文件名</param>         /// <param name="localFileName">本地保存的文件名</param>         /// <returns></returns>         bool Download(string remoteFileName, string localFileName);          /// <summary>         /// 上传文件         /// </summary>         /// <param name="localFileName">待上传的文件</param>         /// <param name="remoteFileName">服务器端文件名</param>         /// <returns></returns>         bool Upload(string localFileName, string remoteFileName);          /// <summary>         /// 文件改名         /// </summary>         /// <param name="localFileName">包含全路径的源文件名</param>         /// <param name="remoteFileName">包含全路径的新文件名</param>         /// <returns></returns>         bool Rename(string orgFileName, string newFileName);          /// <summary>         /// 删除文件         /// </summary>         /// <param name="orgFileName"></param>         /// <param name="newFileName"></param>         /// <returns></returns>         bool Delete(string fileName);     }

B 定义实现：

public class SFtpClient : IFtpClient     {         SftpClient sftp = null;          /// <summary>         /// 构造函数         /// </summary>         /// <param name="host">sftp服务器名或IP</param>         /// <param name="port">端口，默认22</param>         /// <param name="user"></param>         /// <param name="privateKey"></param>         /// <param name="passPhrase"></param>         public SFtpClient(string host, int? port, string user, string privateKey, string passPhrase)         {             PrivateKeyFile keyFile = null;              if (string.IsNullOrEmpty(passPhrase))             {                 keyFile = new PrivateKeyFile(privateKey);             }             else             {                 keyFile = new PrivateKeyFile(privateKey, passPhrase);             }              if (port.HasValue)             {                 sftp = new SftpClient(host, port.Value, user, keyFile);             }             else             {                 sftp = new SftpClient(host, user, keyFile);             }               if (sftp != null)             {                 sftp.ConnectionInfo.RetryAttempts = 5;                 sftp.ConnectionInfo.Timeout = new TimeSpan(0, 3, 0);             }         }          public bool Connect()         {             if (sftp == null)             {                 return false;             }              if (sftp.IsConnected)             {                 return true;             }              try             {                 sftp.Connect();                 return true;             }             catch (Exception ex)             {                 string server = string.Format("{0}:{1}", sftp.ConnectionInfo.Username, sftp.ConnectionInfo.Host);                 // 我用的是nLog来记录错误日志。                 // logger.Error("[{0}] SFTP连接发生错误。", server, ex);                 return false;             }         }          public void DisConnect()         {             if (sftp == null)             {                 return;             }             if (!sftp.IsConnected)             {                 return;             }              try             {                 sftp.Disconnect();                 sftp.Dispose();                 sftp = null;             }             catch (Exception ex)             {                 //logger.Error("SFTP断开连接发生错误。", ex);             }         }          /// <summary>         /// 取得文件列表         /// </summary>         /// <param name="path">路径</param>         /// <returns></returns>         public List<string> ListFiles(string path)         {              if (!Connect())             {                 return null;             }              List<string> files = new List<string>();             try             {                 sftp.ChangeDirectory("/");                 sftp.ListDirectory(path).ToList().ForEach(f =>                     {                          files.Add(f.FullName);                     });                  return files;             }             catch (Exception ex)             {                 // logger.Error("[{0}]　取得文件列表发生错误。", Path, ex);                 return null;             }         }          /// <summary>         /// 下载文件          /// </summary>         /// <param name="remoteFileName">包含全路径的服务器端文件名</param>         /// <param name="localFileName">本地保存的文件名</param>         /// <returns></returns>         public bool Download(string remoteFileName, string localFileName)         {             if (!Connect())             {                 return false;             }              try             {                 sftp.ChangeDirectory("/");                 FileStream fs = File.OpenWrite(localFileName);                 sftp.DownloadFile(remoteFileName, fs);                 fs.Close();                 return true;             }             catch (Exception ex)             {                 //logger.Error("[{0}]　文件下载发生错误。", remoteFileName, ex);                 return false;             }         }          /// <summary>         /// 上传文件         /// </summary>         /// <param name="localFileName">待上传的文件</param>         /// <param name="remoteFileName">服务器端文件名</param>         /// <returns></returns>         public bool Upload(string localFileName, string remoteFileName)         {             if (!Connect())             {                 return false;             }              try             {                 sftp.ChangeDirectory("/");                  FileStream fs = File.OpenRead(localFileName);                 sftp.UploadFile(fs, remoteFileName, true);                 fs.Close();                 Thread.Sleep(1000);                 return true;             }             catch (Exception ex)             {                 //logger.Error("[{0}]　文件上传发生错误。", localFileName, ex);                 return false;             }         }          /// <summary>         /// 文件改名         /// </summary>         /// <param name="localFileName">包含全路径的源文件名</param>         /// <param name="remoteFileName">包含全路径的新文件名</param>         /// <returns></returns>         public bool Rename(string orgFileName, string newFileName)         {             if (!Connect())             {                 return false;             }              try             {                 sftp.ChangeDirectory("/");                  sftp.RenameFile(orgFileName, newFileName);                 return true;             }             catch (Exception ex)             {                 //logger.Error("[{0}]　文件改名发生错误。", localFileName, ex);                 return false;             }         }           /// <summary>         /// 删除文件         /// </summary>         /// <param name="orgFileName"></param>         /// <param name="newFileName"></param>         /// <returns></returns>         public bool Delete(string fileName)         {             if (!Connect())             {                 return false;             }              try             {                 sftp.ChangeDirectory("/");                  sftp.DeleteFile(fileName);                 return true;             }             catch (Exception ex)             {                 //logger.Error("[{0}]　文件删除发生错误。", localFileName, ex);                 return false;             }         }     }

事例下载