使用跳板机在vscode/Pycharm上配置内网服务器

​
最近遇到一个问题：实验室服务器仅限内网访问，无法在家（外网）访问实验室的内部服务器，但同时实验室又提供了一个外网可以访问的跳板机，虽然可以先 ssh到跳板机再从跳板机 ssh到内网服务器，但这种方式不方便传输文件，也没法用 vscode或者 pycharm进行自动同步代码或者远程调试。本篇文章给出了一个该类问题的解决方案，即通过 ssh隧道的方式，用 vscode或者 Pycharm通过跳板机连接内网服务器。

0 vscode配置

vscode 跳板使用内网服务器只需按如下方式配置config文件：

Host <自定义的内网服务器名>
	HoseName <内网服务器ip>
	Port <内网服务器端口>
	User <内网服务器用户名>
	ProxyJump <跳板机用户名>@<跳板机ip>:<跳板机端口>

对应为终端命令：ssh -J <跳板机用户名>@<跳板机ip>:<内网服务器端口> <服务器用户名>@<内网服务器ip>:<跳板机端口>

建议把自定义服务器或者跳板机名直接写成对应的ip值，这样传输免密登录的公钥时（ssh-copy-id -i ~/.ssh/id_rsa.pub user@host）不论是内网服务器还是跳板机都能生效。

可以进一步把<跳板机用户名>@<跳板机ip>:<跳板机端口>另写成另一个Host，所以就是：

Host <自定义的跳板机名>
	HostName <跳板机ip>
	Port <跳板机端口>
	User <跳板机用户名>
	
Host <自定义内网服务器名>
	HostName <内网服务器ip>
	Port <内网服务器端口>
	User <内网服务器用户名>
	ProxyJump <自定义的跳板机名>

也可以把ProxyJump换成ProxyCommand，所以就是：

Host <自定义的跳板机名>
	HostName <跳板机ip>
	Port <跳板机端口>
	User <跳板机用户名>

Host <自定义内网服务器名>
	HostName <内网服务器ip>
	Port <内网服务器端口>
	User <内网服务器用户名>
	ProxyCommand ssh -W %h:%p <自定义的跳板机名>

如果不懂它的原理，那就继续往下了解怎么配置Pycharm的。

1 配置跳板机和服务器的免密登录

① 本地配置config文件

​ 打开本地配置文件：vim ~/.ssh/config（安装好git软件（博客装新机必备中的1.4有教怎么安装及配置）后可以使用vim命令）

​ （会影响VS Code的结果）在config配置文件中输入以下内容（可能会出现文末的错误1）：

Host *
    ControlPersist yes
    ControlMaster auto
    ControlPath ~/.ssh/%n:%p

② 登录跳板机（可能出现文末的错误2），在跳板机上配置config文件

​ 登录跳板机：ssh -p <跳板机端口号> <跳板机用户名>@<跳板机ip>

​ 打开跳板机配置文件：vim ~/.ssh/config

​ 在config配置文件中输入以下内容：

Host *
    ControlPersist yes
    ControlMaster auto
    ControlPath ~/.ssh/%n:%p

③ 登录一次内网服务器

ssh -p <服务器端口号> <服务器用户名>@<服务器ip>

2 设置ssh隧道

① 本地命令行输入（可能出现文末的错误3）：

ssh -N -f -L 6000:<内网服务器ip>:22 -p <跳板机端口> <跳板机用户名>@<跳板机ip> -o TCPKeepAlive=yes

② 验证本地登入内网服务器：

ssh -p 6000 <服务器用户名>@localhost

③ [可选步骤] 简化跳板机、服务器登录[[2][2]]：

​ 将本地.ssh文件夹的公钥（id_rsa.pub）传递给跳板机：（如果本地没有公钥，使用ssh-keygen -t rsa生成公钥）

cd ~/.ssh/
ssh-copy-id -i id_rsa.pub -p <跳板机端口> <跳板机用户名>@<跳板机ip>

​ 配置本地配置文件（vim ~/.ssh/config）：

Host tbj
    HostName <跳板机ip>
    User <跳板机用户名>
    Port <跳板机端口>

Host fwq
    HostName 127.0.0.1
    User <服务器用户名>
    Port 6000

​ 测试简单登录方式（无需输入ssh -p <端口> <用户名>@<ip>）：

ssh tgb
ssh fwq

3 配置pycharm

常规服务器配置pycharm方法，只是ip为127.0.0.1，端口为6000，账号、密码依然为内网服务器的账号秘密，具体可参考[[3][3]]。

4 本地系统使用

4.1 本地为 Windows

ssh 隧道可能因为网络不稳定而断开，每次断开之后都需要手动再次建立ssh隧道。因此在Windows端每次断网后要设置一下隧道：

① 本地命令行输入：

ssh -N -f -L 6000:<内网服务器ip>:22 -p <跳板机端口> <跳板机用户名>@<跳板机ip> -o TCPKeepAlive=yes

② 在ssh端使用

ssh tgb
ssh fwq

或如步骤三所述在pycharm上使用。

4.2 本地为Linux

使用corn维护ssh隧道

ssh 隧道可能因为网络不稳定而断开，每次断开之后都需要手动再次建立ssh隧道。下面介绍一种Linux端的解决方案：通过cron定期执行脚本来维护SSH隧道畅通：

① 编写脚本，通过判断socket文件是否存在来判断隧道连接是否已经断开
在本地任意位置创建脚本auto_connect.sh并写入如下内容（注意更换<>中内容）

#/usr/bin/env sh
if [[ ! -a "~/.ssh/<跳板机ip>:<跳板机端口>" ]]; then
    echo "connecting <跳板机ip>:<跳板机端口> .."
    ssh -N -f -L 6000:<内网服务器ip>:22 -p <跳板机端口> username@<跳板机ip> -o TCPKeepAlive=yes
    if [[ $? -ne 0 ]]; then
        echo "failed to connect <跳板机ip>:<跳板机端口>" >&1
        exit 2
    fi
fi

② 使用cron服务定时执行脚本建立ssh 隧道。在命令行中执行如下语句：(注意修改脚本位置, 路径不可用缩写)

echo "0-59   *   *   *   *   sh /path/to/auto_connect.sh" > ~/.crontab
crontab ~/.crontab

5 可能出现的错误

5.1 错误1: Connection reset by peer

mux_client_request_session: read from master failed: Connection reset by peer
Failed to connect to new control master

方案：在 .ssh/config 里删掉 ControlPath 的配置: ControlPath ~/.ssh/persist/%n:%p.

windows git: mux_client_request_session: read from master failed: Connection reset by peer

5.2 错误2: Host key verification failed

WARNING: REMOTE HOST IDENTIFICSTION HAS CHANGED: xxx

Host key verification failed.

方案：在正在操作的机器上执行vim ~/.ssh/known_hosts删除159.226.xxx的相关 rsa 的信息.

ssh连接的时候出现Host key verification failed

5.3 错误3: SSH port forwarding: bind: Address already in use

bind [127.0.0.1]:6000: Address already in use

channel_setup_fwd_listener_tcpip: cannot listen to port: 6000
Could not request local forwarding.

方案：改-L为-R: ssh -N -f -R 6000:<内网服务器ip>:22 -p <跳板机端口> username@<跳板机ip> -o TCPKeepAlive=yes

SSH port forwarding: bind: Address already in use

参考资料：

使用Pycharm和跳板机 连接内网服务器
免密登录服务器(支持跳板机)
PyCharm 配置远程python解释器和在本地修改服务器代码
SSH隧道技术----端口转发，socket代理
vscode通过跳板机连接内网服务器(ProxyJump、ProxyCommand)