VSCode 远程开发：WLS 2 + ZeroTier 内网穿透

前置条件

1. 两台 Win 10 主机，其中一台（记为本地机）远程访问另一台主机（记为远程机）的 WSL；
2. 本地机安装好 VSCode；
3. 两台主机不在一个局域网内，且均无公网 IP（后续需要在两台主机上配置内网穿透，如果两台主机可相互 ping 通，可省去该步骤）；
4. 本地机可通过向日葵、Todesk、Teamviewer 等工具访问远程机（后续需要给远程机安装软件）。

两台设备均开启 OpenSSH 服务

1. Win 10 自带 OpenSSH 客户端和服务器，可直接在设置中安装（默认已安装客户端）。本地机和远程机均需要安装 OpenSSH 客户端和服务器。
   
   
2. OpenSSH 服务器安装后，其服务默认为手动启动且为未启动状态，需要设置成自启动，并启动服务。
   
3. 重启电脑，可通过 cmd 输入 ssh 命令验证，出现如下输出，说明已安装成功。
   

设置远程机上的 WSL 2

设置仅当 Win 10 被远程访问时，默认的 CMD 自动变为 PowerShell，以便直接进入 WSL 2。

在 PowerShell 中输入以下命令（将命令中的 PowerShell 地址换成自己机子上的地址）。

New-ItemProperty -Path "HKLM:\SOFTWARE\OpenSSH" -Name DefaultShell -Value "C:\WINDOWS\system32\WindowsPowerShell\v1.0\powershell.exe" -PropertyType String -Force

两台设备均配置 ZeroTier（内网穿透）

免费渠道考虑过花生壳，但无奈对个人用户性价比不高，最后选择 ZeroTier。ZeroTier 可以创建一个虚拟局域网，实现多台机器的互访，缺点是任何需要远程访问的机器都需要安装他的客户端。

1. 创建免费账号，然后点击 Create A Network 创建虚拟网络，获得网络 ID；
   
2. 在本地机和远程机安装 ZeroTier 客户端；
3. 分别在两台设备上启动 ZeroTier 客户端，在任务栏的小图标中找到 ZeroTier，右键选择 Join New Network，在小窗口中输入上面获取的网络 ID 后，点击右下角的 Join；
   
4. 回到 ZeroTier 创建网络的页面，点击网络 ID，进入设置页面，找到 Member 卡片，此时列表中会出现已加入该网络的所有设备（如未出现预期设备，可尝试刷新页面），勾选所有设备的 Auth? 列，授予它们访问局域网的权限；
   

在本地机测试访问远程机

1. 本地机 VSCode 安装 Remote -SSH 扩展；
   

2. 安装后点击 VSCode 左下角图标 ><，在弹出的命令面板中选择 Open SSH Configuration File...；
   

3. 选择 User 目录下的 config 文件；
   

4. 在文件中输入以下内容

   Host remote_wsl                     # 名称（可自定）
       HostName  ********              # ZeroTier 分配的**远程机**的 IP 地址
       User ***                        # Windows 系统的用户名
       Port 22                         # WSL 2 填写 22 端口
   

5. 保存配置后，再次点击 VSCode 左下角图标 ><，在弹出的命令面板中选择 Connect to Host...，选择刚刚配置好的 remote_wsl。如果 VS Code 未能判断远程服务器类型，则会要求我们自己手动选择类型（这里选择 Windows），输入密码登录成功后（首次登陆可能会提示是否加入 known_hosts，yes 即可），就可以愉快的编辑代码了。
   

免密登录（可选）

1. 在本地机生成公钥，在 cmd 或 powershell 中输入 ssh-keygen -t rsa 命令：
   

2. 进入 C:\Users\用户名\.ssh （以自己配置的为准）找到公钥文件 id_rsa.pub，并复制全部文本内容。

3. 进入远程机的 C:\Users\用户名\.ssh 文件夹，创建文件 authorized_keys（注意：文件无后缀名），将复制的公钥粘贴进去并保存（如果已有该文件，直接在文件内追加该内容）。

4. 打开远程机 C:\ProgramData\ssh\ 文件夹下的 sshd_config 文件，修改以下内容（重点），如果保存时提示没有权限，可以用管理员身份打开cmd，用 notepad C:\ProgramData\ssh\sshd_config 命令打开文件编辑即可。

   • 确保以下 3 条没有被注释

     PubkeyAuthentication yes
     AuthorizedKeysFile	.ssh/authorized_keys
     PasswordAuthentication yes
     

     PasswordAuthentication：改成 yes 或者 no 都无所谓。如果证书通过了，就不会触发 password 验证。如果证书没过，就提示 password 登录。

   • 确保以下 2 条有注释掉

     #Match Group administrators
     #       AuthorizedKeysFile __PROGRAMDATA__/ssh/administrators_authorized_keys
     

5. 重启远程机 sshd 服务：在服务中找到 OpenSSH SSH Server，重启即可。

6. 在本地机 ssh 配置 C:\Users\用户名\.ssh\config 文件中补充私钥地址 IdentityFile：

   Host remote_wsl                                     # 名称（可自定）
       HostName  ********                              # ZeroTier 分配的**远程机**的 IP 地址
       User ***                                        # Windows 系统的用户名
       Port 22                                         # WSL 2 填写 22 端口
       IdentityFile C:\Users\UserName\.ssh\id_rsa      # 私钥地址
   

7. 再次尝试用 VSCode 连接或者在本地机用 ssh 远程机登录用户名@远程机IP 命令（如 ssh [email protected]）测试连接，此时不再提示输入密码。

遇到的问题

ssh: connect to host 远程机 IP port 22: Connection timed out

ZeroTier 连接不稳定，可以尝试其他内网穿透方案，或者购买稳定方案。

VSCode SSH 连接提示：过程试图写入的管道不存在

内网穿透不稳定也会引发此问题，如果排除是网络问题，可尝试将本地机的 C:\Users\用户名\.ssh\known_hosts 文件中关于远程机的所有信息删除，然后保存重新尝试。

参考

VS Code+内网穿透 | 远程 WSL 开发解决方案

VSCode 远程开发 - Windows

多台WIN10之间的SSH免密登录