简介这是一份基于 C# 开发的 SSH 连接功能半成品工程原本作为另一个主项目的子功能模块现独立打包分享。工程采用 WinForms 界面包含源码、解决方案、安装部署工程、NuGet 依赖包及说明文档适合正在做远程连接、网络管理或需要为项目集成 SSH 能力的 C# 开发者参考也可用于课程设计、毕业设计、实训与大创等初期项目立项。压缩包共 70 个文件约 7.39MB主要由 cs 源文件、dll 依赖库、xml 配置文件与文档、exe 可执行程序、pdb 调试符号及 resources 资源文件组成目录保留了 Visual Studio 工程结构和 Setup 打包配置能直接打开复现并继续扩展。当前已有 48 人浏览学习。虽标注为半成品但完整度已能帮助读者梳理 SSH 客户端的界面交互、连接调用与异常处理思路也适合基于现有模块改造补充业务逻辑后快速接入实际项目。1. 这个C# SSH半成品缺了什么先搞清楚再下手做C#上位机或者内部运维工具的人大概率都遇到过这种局面主项目做到一半需要远程去连一台Linux设备读个状态、跑个脚本、传个文件于是顺手用C#写了个SSH连接的子功能塞进项目某个角落。这个子功能往往停在“能连上、能跑一两条命令”的状态超时、重连、批量、密钥这些边界全没补最终压缩成一个半成品zip等真正要用时才发现补起来比重写还费劲。这篇笔记就是把这种半成品拆开告诉你它缺在哪、怎么补齐、踩坑在哪适合正在做上位机集成、设备巡检、服务器批量操作的人照着改。2. C#做SSH连接的技术选型为什么绕不开SSH.NET2.1 SSH.NET、SharpSSH、还是干脆调ssh.exeC#里做SSH连接常见的路就那么几条我挨个说下它们的真实处境。第一是Renci.SshNet一般搜“SSH.NET”就能找到NuGet上直接装。它是目前C# SSH事实标准密码认证、私钥认证、SFTP、端口转发都有实现上走的是纯托管代码不用额外装OpenSSH客户端部署到工控机上不依赖系统环境。绝大多数“C#上位机去连远端设备”的项目最后都绕回它。第二是SharpSSH这个库比较老接口风格还停留在.NET 2.0时代维护基本停滞。如果你只是想快速验证一下能不能连拿它写个demo还行真要拿到生产环境遇到新版本OpenSSH服务端的密钥交换算法很容易握不上手。第三是直接调ssh.exe比如Process.Start(ssh, userhost ...)再解析标准输出。这个做法在Windows 10以后可行因为系统自带OpenSSH客户端但有几个硬伤密码没法直接传得靠交互输入或者配密钥批量执行时进程频繁创建销毁开销大ssh.exe输出的本地化信息在不同Windows版本上不一样解析容易翻车。我一般只拿它做临时手工排查不会写进正式流程。第四是自己写一个SSH协议栈这是最不建议的路。SSH不是简单的“发命令收输出”它涉及密钥交换、主机认证、加密算法协商、压缩、通道复用随便哪一步没做对对端服务端日志里就是一堆算法不匹配的报错。SSH.NET把这些都封装好了没必要重新造轮子。所以我的结论很直接C#做SSH连接新项目直接用SSH.NET别犹豫。下面所有代码都基于它。2.2 最小可用先跑通第一条命令拿到半成品zIp后我做的第一件事不是去补功能而是先确认依赖的库是什么版本、能不能编译过、连不连得上。SSH.NET在Visual Studio的NuGet管理器里直接搜索“SSH.NET”安装命令行用dotnet的话执行dotnet add package SSH.NET装完引用先写一个最小连接跑通一条命令再谈其他using Renci.SshNet; // 第一步组装连接信息 var connectionInfo new ConnectionInfo( 192.168.1.100, // 目标主机IP或域名 22, // SSH端口默认就是22 root, // 登录用户名 new PasswordAuthenticationMethod( root, // 用户名和上面的保持一致 your-password) // 密码 ); // 第二步创建客户端并连接 using var client new SshClient(connectionInfo); client.Connect(); // 第三步执行一条命令拿完整输出 var cmd client.RunCommand(cat /etc/os-release); Console.WriteLine(cmd.Result); client.Disconnect();这段代码的逻辑先构造ConnectionInfo把主机、端口、用户名、认证方式打包然后创建SshClient并调用Connect()建立会话RunCommand执行一条命令并返回SshCommand对象它的Result属性就是命令的标准输出。最后Disconnect释放会话using确保客户端被释放掉。参数有几个要注意的地方。端口必须是int类型默认22但如果对端改过端口号这里要跟着改。用户名要和认证方式里的用户名一致不一致时会直接收到认证失败。密码里如果包含特殊字符比如$、#直接写字符串没问题但要注意别在代码里硬编码后面会讲怎么用配置文件或者环境变量管理。跑通这一条半成品的第一步就算站住了。但如果你的服务端禁用了密码认证、只允许密钥登录这段代码就会卡在认证阶段这就引出后面的密钥认证内容。所以下一步不是急着加批量而是把连接健壮性补上。2.3 依赖包里面到底有什么ConnectionInfo是核心入口很多半成品代码的问题是把SshClient直接new出来用new SshClient(host, port, username, password)这种构造方式也能跑但会把参数写死在代码里换台设备就得改代码重新编译这不是子功能该有的形态。SSH.NET的核心入口是ConnectionInfo它不仅仅是“连接参数集合”它还管三件事认证方法的优先级、编码、超时控制。我用表格列一下它常用的属性方便你对着改属性作用常见取值Host目标主机IP或域名PortSSH端口22或自定义端口Username用户名root、ubuntu等AuthenticationMethods认证方法数组密码、私钥等按顺序尝试Timeout通道操作超时默认30秒调大防大文件传输误判ConnectTimeout连接握手超时新版本支持单位毫秒Encoding命令输出编码默认UTF-8设备输出非UTF-8时改这里AuthenticationMethods是个数组这是SSH.NET的一个好设计你可以同时传密码和私钥它会自动按顺序尝试省去手动写“先试密码、失败再试私钥”的分支逻辑。我通常在工控场景里同时传两种认证方式这样设备改过密码或者临时换密钥都能连上。3. 把半成品补成一个能用的SSH子功能命令、超时与批量3.1 命令执行与输出捕获别再用RunCommand就完事半成品最常见的样子就是会调RunCommand但RunCommand有一个隐患它内部是同步等待命令通道关闭后才返回一旦命令产生大量输出比如cat /var/log/syslog或者find / -name *.conf输出流缓冲会被塞满命令还没执行完客户端这边就卡住了。我一般用CreateCommand替换RunCommand它能更精细地控制执行过程using Renci.SshNet; using var client new SshClient(connectionInfo); client.Connect(); // 创建命令对象 var command client.CreateCommand(cat /var/log/syslog | tail -n 50); // 执行并等待结果CommandTimeout是执行超时 command.CommandTimeout TimeSpan.FromSeconds(30); var output command.Execute(); // ExitStatus是命令的退出码0代表成功 Console.WriteLine($退出码: {command.ExitStatus}); Console.WriteLine(output); client.Disconnect();这段代码和RunCommand的区别在于CreateCommand返回一个SshCommand对象你可以单独设置CommandTimeout执行完还能拿ExitStatus判断命令是否真的成功——这比单纯拿输出文本去猜“是不是有报错”可靠得多。关于CommandTimeout它管的是单条命令整体执行的超时单位是TimeSpan。批量巡检时我一般设30秒长任务比如日志分析会放到60秒。如果命令超时Execute()会抛异常需要在外面包一层try/catch否则整个程序会崩。另外要注意ExitStatus在命令被CommandTimeout中断时可能是空值判断逻辑要写清楚“超时就是失败”。如果你需要实时看到命令输出比如执行一个进度条任务或长编译那就得用shell流。SSH.NET里叫CreateShellStream它模拟一个终端会话边出结果边读到适合交互式命令。但shell流的坑在于它没有“结束”的概念需要自己判断命令提示符或者等一段时间逻辑多不少。我的建议是能用非交互式命令解决的就别上shell流。3.2 超时控制、退出码与批量登录上位机场景的真实需求真正到了上位机场景你会发现需求不是“连上去跑一条命令”而是“对一批设备做同一组操作”。比如产线上有几十块Linux板卡你要批量改配置、批量查CPU温度、批量重启服务。这时候半成品最大的缺项就是批量执行和超时处理。批量执行的核心不是循环那么简单而是并发控制。几十台设备同时连如果全用同步循环一台卡住后面的全等如果全开线程去连SSH握手本身就吃资源可能把上位机拖垮。我习惯用信号量控制并发数using System.Collections.Concurrent; using Renci.SshNet; var devices new Liststring { 192.168.1.101, 192.168.1.102, 192.168.1.103 }; var results new ConcurrentDictionarystring, string(); var semaphore new SemaphoreSlim(5); // 最多5个并发连接 var tasks devices.Select(async ip { await semaphore.WaitAsync(); try { var info new ConnectionInfo(ip, 22, root, new PasswordAuthenticationMethod(root, password)); using var client new SshClient(info); client.Connect(); var result client.CreateCommand(uptime).Execute(); results[ip] ${result.Trim()} [退出码: {client.CreateCommand(echo $?).Execute()}]; client.Disconnect(); } catch (Exception ex) { results[ip] $连接失败: {ex.Message}; } finally { semaphore.Release(); } }); await Task.WhenAll(tasks); foreach (var r in results) { Console.WriteLine(${r.Key}: {r.Value}); }这段代码做的事情把所有设备IP放进列表用ConcurrentDictionary存放结果解决多线程写集合的冲突。SemaphoreSlim(5)把并发连接数限制在5个避免几十个SSH同时握手把上位机网络堵死。每个设备独立连接、独立执行、独立断开一台失败不影响其他设备。这里有个小细节我在循环里执行了两次CreateCommand第一次是uptime第二次是echo $?。第二次不是必须的Execute()返回后ExitStatus其实已经拿到了。但在某些老版本SSH.NET里连续执行命令时ExitStatus可能拿的是上一条命令的值所以我习惯单独查一下算是个血泪经验。超时设置在这段代码里也要单独提ConnectionInfo.ConnectTimeout控制的是TCP握手和SSH协议协商阶段默认情况下可能比较保守工控网络慢的话容易报“连接超时”。我通常设成5000毫秒超过5秒连不上就直接跳过这台设备记录失败原因继续下一台。3.3 从SSH到SFTP文件传输是子功能的另一半很多情况下SSH子功能不只是为了执行命令还要传文件比如更新设备上的程序包、拉取日志文件。SSH.NET把SFTP客户端直接做进了库同一个连接信息就能用。using Renci.SshNet; using var client new SftpClient(connectionInfo); client.Connect(); // 上传文件本地流写入远端路径 using var fileStream File.OpenRead(C:\app\update.zip); client.UploadFile(fileStream, /opt/app/update.zip); // 下载文件远端文件写入本地流 using var downloadStream File.Create(C:\backup\remote.tar.gz); client.DownloadFile(/var/log/messages.tar.gz, downloadStream); client.Disconnect();sftp的操作逻辑和FTP很像UploadFile接受一个本地流和一个远端路径DownloadFile接受远端路径和一个本地流。关键点是远端路径必须是绝对路径用相对路径很容易“文件不存在”的报错File.OpenRead和File.Create都会占用本地文件句柄记得用using释放。实际项目中我会把文件传输和命令执行放同一个SshClient上因为SSH协议支持多通道复用一个连接里既能开命令会话又能开SFTP会话没有必要为传文件单独建第二个连接。半成品代码里如果有“传文件又要重新连一次”的逻辑可以合并到一个连接里省去握手开销。4. 认证与参数细节密钥、主机指纹与连接复用4.1 密码、私钥和主机指纹三种认证方式怎么选半成品一般在认证这块最偷懒密码直接写死。密码认证简单但有一个现实问题——设备密码一旦定期轮换上位机代码就得跟着改改完还要重新编译发布。私钥认证能绕开这个维护成本但它的坑不比密码少。SSH.NET支持三种认证方式我按使用频率给你梳理认证方式使用场景注意点PasswordAuthenticationMethod密码认证密码轮换后需要更新配置PrivateKeyAuthenticationMethod密钥认证私钥格式、passphrase、权限三座大山KeyboardInteractiveAuthenticationMethod设备要求交互式应答常见于首次登录改密、二次验证私钥认证在SSH.NET里的写法using Renci.SshNet; // 加载私钥文件 var privateKey new PrivateKeyFile(C:\keys\id_rsa, passphrase if any); // 组装连接信息认证方式用私钥 var connectionInfo new ConnectionInfo( 192.168.1.100, 22, root, new PrivateKeyAuthenticationMethod(root, privateKey) ); using var client new SshClient(connectionInfo); client.Connect();这里PrivateKeyFile既支持OpenSSH格式也支持PEM格式构造函数第二个参数是私钥的passphrase没有就传null。Windows上生成的密钥默认可能带有passphrase如果批量部署想免交互生成密钥时别设passphrase或者把passphrase放到上位机的配置中心管理。主机指纹校验是很多半成品忽略的安全点。SSH协议为了防止中间人攻击会校验服务端的主机公钥。SSH.NET里默认行为是接受任意主机公钥这在工控内网问题不大但如果你的设备暴露在不可信网络最好把指纹校验加上也就是校验一把“指纹白名单”。4.2 私钥在Windows上的格式坑私钥认证最容易翻车的地方就是格式。很多人在Windows上用ssh-keygen生成的密钥是OpenSSH格式头部长这样-----BEGIN OPENSSH PRIVATE KEY-----而SSH.NET对OpenSSH格式的支持有个演进过程旧版本只认RSA私钥的PEM格式-----BEGIN RSA PRIVATE KEY-----如果密钥文件头是OPENSSH PRIVATE KEY但你用的SSH.NET版本比较旧加载时会直接报“invalid private key”。解决办法有两个一是更新SSH.NET到最新版本新版已经支持OpenSSH格式二是把密钥转成PEM格式。转换命令在Windows的OpenSSH客户端里直接执行ssh-keygen -p -m PEM -f C:\keys\id_rsa这条命令会重新处理私钥格式并转成PEM。-p表示修改passphrase-m PEM指定输出格式-f指向私钥文件。执行过程会先问旧passphrase再问新passphrase如果密钥本来没有passphrase直接回车两次就行。转换后记得重新生成对应的公钥因为格式变了公钥内容可能跟着变服务端authorized_keys里要同步更新。另外一个容易忽略的点Windows的私钥文件如果是从别处拷贝来的权限可能放大到“Everyone可读”SSH.NET不像Linux sshd那样做权限校验但安全起见还是右击文件属性把无关用户的读取权限去掉。4.3 连接复用还是每次新建性能与安全的取舍半成品代码里另一个高频问题是每次操作都new SshClient、Connect、Disconnect。短连接的好处是逻辑简单坏处是握手开销大。一次SSH握手要经历TCP连接、协议版本交换、密钥交换、认证往返次数不少。上位机如果每5秒轮询一次设备状态频繁建连断开会让设备端的sshd日志被刷屏还可能触发某些设备的安全策略导致IP被封。但SSH.NET的SshClient不是线程安全的一个实例同一时间只能处理一条命令。所以“连接复用”的正确姿势是要么串行使用一个连接执行多条命令要么给每个工作线程单独维护一个连接对象。我写上位机轮询时会在初始化阶段提前建立连接之后循环里复用同一个SshClient执行命令程序退出时再统一断开。如果批量任务并发度很高就做连接池每个线程从池里拿一个独立连接。连接池的实现不复杂核心是队列加锁但要注意连接池不能无限膨胀要设置最大连接数超过就先等。这个边界设计和线程池很像没有想象中神秘。5. 从半成品到可用最容易翻车的5个坑现象、原因、解决5.1 连接卡死、超时无效与端口不通现象调用client.Connect()后程序卡住不动看起来像死锁或者你设置了Timeout但超时之后还是卡着。原因SSH.NET旧版本的ConnectionInfo.Timeout管的是通道操作管不到连接握手。连接握手阶段的超时在旧版本里是写死的如果目标IP不可达TCP连接会等到系统级超时那是很长一段时间比如几十分钟。解决升级到新版SSH.NET在ConnectionInfo上显式设置ConnectTimeout单位是毫秒。另外调用Connect()之前先用一个简单的TCP探测确认端口通不通using System.Net.Sockets; using var tcp new TcpClient(); var task tcp.ConnectAsync(192.168.1.100, 22); if (await Task.WhenAny(task, Task.Delay(2000)) ! task) { Console.WriteLine(端口不通跳过); return; }TCP能连上再去走SSH握手排错路径一下子就短了。这条经验帮我在现场省了好多时间端口不通再怎么调SSH参数也白搭。5.2 命令输出为空、中文乱码与交互命令现象命令明明执行成功了但Result是空的或者输出一堆乱码。原因两种可能。第一种是命令输出全在标准错误流里Result只包含标准输出需要再查看Error属性第二种是设备系统编码不是UTF-8比如某些欧版老设备用ISO-8859-1Windows老设备用GBKSSH.NET默认按UTF-8解码就乱码了。解决执行命令后同时检查Result和Errorvar cmd client.CreateCommand(your-command); cmd.Execute(); var output cmd.Result; var errorOutput cmd.Error; if (!string.IsNullOrEmpty(errorOutput)) { Console.WriteLine($stderr: {errorOutput}); }如果是编码问题在连接信息里改编码var connectionInfo new ConnectionInfo(...); connectionInfo.Encoding System.Text.Encoding.UTF8;还有一种情况命令本身是交互式的比如直接执行top、vim它会等待用户输入Execute()拿不到任何输出一直挂着。这类命令要么改成非交互的变体比如top -b -n 1按批处理模式跑一次要么给命令加上 /dev/null强制它不读终端输入。5.3 私钥报格式错误、权限问题和认证方式顺序现象使用私钥认证时加载密钥就报错或者连上之后服务端直接拒绝日志里出现Permission denied (publickey)。原因前面提到过的OpenSSH格式和PEM格式的差异只是其一其二是服务端对公钥有权限要求~/.ssh/authorized_keys和~/.ssh目录的权限如果太大sshd会拒绝读取你的公钥其三是SSH.NET配置的认证方式顺序优先级如果先试密码失败再试私钥某些服务端在多次失败后会直接断开。解决先确认私钥格式头部是OPENSSH PRIVATE KEY就按前面转换一次。确认服务端authorized_keys里存的公钥和本地私钥配对不一致会导致认证失败。最后调整ConnectionInfo中AuthenticationMethods的排列顺序把最可能成功的认证方式放最前面。var authMethods new AuthenticationMethod[] { new PrivateKeyAuthenticationMethod(root, privateKey), new PasswordAuthenticationMethod(root, password) }; var connectionInfo new ConnectionInfo(host, 22, root, authMethods);另外服务端日志是排查密钥认证失败的最好帮手。如果你能登录设备直接看/var/log/auth.logDebian系或/var/log/secureCentOS系会明确告诉你公钥为什么被拒绝比我瞎猜快得多。6. 把它封装成上位机里的一个模块异步化、心跳保活与日志6.1 异步命令与取消机制半成品最后要变成正式子功能我一般会加一层异步封装。SSH.NET的新版本已经提供了ConnectAsync和ExecuteAsync配合CancellationTokenSource能做到“用户点取消就立刻中断”。异步写法的好处是上位机界面不会卡死跑批量任务时还能同时操作其他控件。6.2 心跳保活与自动重连设备端的sshd默认有空闲超时比如ClientAliveInterval配置为300秒意味着5分钟没有数据往来就断开。上位机长时间停在那不操作连接就会被服务端回收。我的做法是写一个心跳循环每隔一段空闲时间发一个轻量命令using Timer System.Threading.Timer; var heartbeatTimer new Timer(_ { try { client.CreateCommand(echo keepalive).Execute(); } catch { // 心跳失败标记需要重连 } }, null, TimeSpan.FromMinutes(2), TimeSpan.FromMinutes(2));心跳不只是保活还能顺带检测设备是否在线。如果心跳失败就触发重连逻辑先断开旧连接等待几秒重新Connect。这在设备会重启的现场尤其重要设备重启后端口从监听到消失再到恢复重连时要加退避策略不能疯狂重试。6.3 验证与收尾封装完成后我会用一个真实设备做一轮验证正常命令、长输出命令、批量并发、私钥登录、断网重连、文件传输这六项。每项都记录用时和结果确认后再交出去。一个人踩过太多SSH的坑等到真正上线才发现连不上就已经晚了。所以这类半成品项目我最深的感触是把边界补全比把主路径跑通更费功夫。现在我再看到“能连上但别的都没有”的SSH子功能第一件事就是检查超时、编码、复用逻辑而不是急着加功能。希望帮到你。本文还有配套的精品资源点击获取
