写了一个 ssh 客户端,欢迎体验

2023-12-15 00:24:33 +08:00
 vimiix

需求来源

对于一个后端程序员来说,在工作中免不了要和繁杂的服务器打交道,ssh 是不可或缺的开发工具。但每次登录都需要输入密码的行为,对于认为一切皆可自动化的程序员来说,肯定是有点繁琐的(如果您是使用图形化界面的用户可忽略)。

所以我在前段时间考虑,我应该自己实现一个 ssh 客户端,它不需要拥有许多复杂的功能,只需要满足我以下这几个需求即可满足日常使用:

于是乎,近期我在业余时间就设计并编写了 ssx 这个轻量级的具有记忆的 ssh 客户端。它完美的实现了上面我所需要的功能,也已经被我愉快的应用到了日常的开发中。

项目源码地址:https://github.com/vimiix/ssx

使用方式

下面就简单介绍一下 ssx 的使用方式。

ssx 是通过 golang 开发的一个独立的二进制文件,安装方式就是从 release 页面下载对应平台的软件包,解压后把 ssx 二进制放到系统的任意目录下,这里我习惯放到 /usr/local/bin 目录下,如果你选择其他目录下,需要确保存放的目录添加到 $PATH 环境变量中,这样后续使用我们就不用再添加路径前缀,直接通过 ssx 命令就可以运行了。

登录服务器

使用 ssx 登录服务器的时候,基本和 ssh 使用习惯一致,下面是基本命令模式:

ssx [-s] [USER@]HOST[:PORT] [-k IDENTITY_FILE]

在这个命令中,USER 是可以省略的,如果省略则是系统当前用户名;PORT 是可以省略的,默认是 22 ,-k IDENTITY_FILE 代表如果是使用私钥登录,则通过 -k 来指定私钥的路径,也是可以省略的,默认是 ~/.ssh/id_rsa,当然了,前提是这个文件存在。所以最精简的登录命令就是:ssx <ip>

当首次登录,不存在可用私钥时,会通过交互方式来让用户输入密码,一旦登录成功,这个密码就会被 ssx 保存到本地的数据文件中 (默认为 ~/.ssx/db, 可通过环境变量 SSX_DB_PATH 进行自定义),下次登录时,仍然执行 ssx <ip> 即可自动登录。

注意,登录过的服务器,再次登录时,我嫌输入全部 IP 比较麻烦,所以 ssx 支持输入 IP 中的部分字符,自动搜索匹配进行登录。

为服务器打标签

当我们成功登录过一次服务器后,就可以通过 ssx list 命令来查看目前 ssx 存储的所有服务器列表。下面是一个列表示例:

# output example
# Entries (stored in ssx)
#  ID |       Address        |          Tags
#-----+----------------------+--------------------------
#  1  | root@172.23.1.84:22  | centos

ssx 会给每个服务器分配一个唯一的 ID ,我们在打标签时就需要通过 ID 来指定服务器条目。

当然,既然服务器有唯一 ID ,ssx 也支持通过 ID 来进行登录:ssx -i <ID>

打标签需要通过 ssx 的子命令 tag 来完成,下面是 tag 命令的模式:

ssx tag -i <ENTRY_ID> [-t TAG1 [-t TAG2 ...]] [-d TAG3 [-d TAG4 ...]]

当我们完成对服务器的打标签后,比如上面示例中的服务器,我增加了一个 centos 的标签,那么我此时就可以通过标签来进行登录了:

// -t 可省略
ssx [-t] centos

删除服务器记录

ssx 也支持删除服务器记录,命令如下:

ssx delete -i <ID>

一旦删除,ssx 不会保留该服务器的任何信息,所以下次登录时会等同于新的服务器来对待,ID 也会重新生成。

目前支持的环境变量

除了上面提到的 SSX_DB_PATH 可以指定存储数据的文件外,ssx 还支持:

这里我解释一下 SSX_IMPORT_SSH_CONFIG 的作用,这个环境变量不设置时,ssx 默认是不会读取用户的 ~/.ssh/config 文件的,ssx 只使用自己存储文件进行检索。如果将这个环境变量设置为非空(任意字符串),ssx 就会在初始化的时候加载用户 ssh 配置文件中存在的服务器条目,但 ssx 仅读取用于检索和登录,并不会将这些条目持久化到 ssx 的存储文件中,所以,如果 ssx IP 登录时,这个 IP 是 ~/.ssh/config 文件中已经配置过登录验证方式的服务器,ssx 匹配到就直接登录了。但 ssx list 查看时,该服务器会被显示到 found in ssh config 的表格中,这个表格中的条目是不具有 ID 属性的,以下是一个示例:

export SSX_IMPORT_SSH_CONFIG=true
ssx list
# output example
# Entries (stored in ssx)
#  ID |       Address        |          Tags
#-----+----------------------+--------------------------
#  1  | root@172.23.1.84:22  | centos
#
# Entries (found in ssh config)
#               Address              |           Tags
# -----------------------------------+----------------------------
#   git@ssh.github.com:22            | github.com

操作演示

最后通过一个演示动画来感受一下这个小可爱的功能吧。

4755 次点击
所在节点    Go 编程语言
37 条回复
adoal
2023-12-15 13:29:11 +08:00
不是否定 OP 针对自己个性化需求的开发。只是想说,openssh 演化了这么多年,其实功能非常强大,在最基本的日常用法之外有很多花样。当然,纯程序员可能更喜欢通过写代码来实现自己需求,而我主要是运维的身份,更喜欢尽量发掘现有成熟工具的潜力,没有谁高谁低的臧否。
vimiix
2023-12-15 13:38:41 +08:00
@ljlljl0 asciinema + svg-term
vimiix
2023-12-15 13:47:11 +08:00
@adoal 嗯嗯,赞同您的说法,ssh 肯定是成熟的工具,其肯定更适用于运维和生产环境。我写这个小工具主要目的是一个是解决我日常开发的一些显而易见的问题(也可能可以通过各种 ssh 的配置方式解决,但我比较懒,不想手动去配置,希望用朴素的方式连接后工具就可以自动帮我记下来,这个从安全的角度来说,不是个好的实践方案),另一方面也是想业余时间写点产品化的东西,这样有助于我建立产品思维。在生产上,我肯定是优先考虑用成熟的产品,但在个人工作流自动化方面,更愿意折腾自己写点东西的。:)
trzzzz
2023-12-15 13:58:01 +08:00
https://github.com/T-TRz879/scpw 。这是我之前写过一个 scp 的客户端,个人工作需要经常传包,每次 server 和包都比较固定,懒得敲那么多。OP 的 ssx 很不错
lstz
2023-12-15 13:59:32 +08:00
不敢苟同以上部分同学的观点,难道有了 A 工具就不能再写个 B 工具吗?
我认为百家争鸣是最好也是最健康的状态,楼主加油,支持一个
LonnyWong
2023-12-15 15:01:33 +08:00
@lstz #25 有人反对楼主自己写吗?
lstz
2023-12-15 19:04:37 +08:00
@LonnyWong 无需问我
lstz
2023-12-15 19:17:47 +08:00
看来是误会,我收回前面的话
YaD2x
2023-12-15 19:42:00 +08:00
貌似在 windows 终端登录后,不支持上下翻动历史命令,终端的高亮颜色显示也有变化。
vimiix
2023-12-17 22:15:42 +08:00
@trzzzz 过奖,后面有规划在 ssx 里加上 scp 的能力,在设计中
vimiix
2023-12-17 22:16:08 +08:00
@lstz #25 感谢支持
vimiix
2023-12-17 22:24:41 +08:00
@YaD2x #29 我这边测试了下,windows 上颜色正常,上下左右键确实失效了。我下周排查下看能否解决,感谢提醒
vimiix
2023-12-17 23:05:10 +08:00
@YaD2x #29 windows 中方向键失效的问题已在 v0.0.4 版本修复
Songine
2024-01-06 14:12:51 +08:00
不错诶,安卓 APP 上也可以直接跑,但是搞不懂怎样才可以附加命令给连接的主机呢?
类似 ssh user@ip cmd 好像不行..
vimiix
2024-01-09 18:35:48 +08:00
@Songine #34 直接执行一条命令然后就返回,这个意思吗?如果是的话,这个后面版本会增加
Songine
2024-01-12 13:08:29 +08:00
@vimiix 对的,就是执行单条命令返回,后续会有这个功能的话那就太好了(◦˙▽˙◦)
vimiix
2024-01-26 14:39:54 +08:00
@Songine 执行单条命令的功能已经在 v0.0.6 版本中支持
https://github.com/vimiix/ssx/releases/tag/v0.0.6

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://yangjunhui.monster/t/1000524

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX