配置SSH密钥

什么是SSH密钥

SSH密钥是一种安全的连接方式，用于在本地计算机与用户账号下的Repo之间建立安全连接，用户可参考配置步骤配置SSH密钥。

用户可以参考配置步骤配置SSH密钥，也可以根据配置SSH操作视频进行配置。

约束与限制

在多电脑的环境下，需要为每一台电脑配置SSH密钥，从而该电脑下的所有账号均可通过此SSH密钥进行连接。

配置步骤

用户可根据配置SSH操作视频配置SSH密钥，也可以根据如下操作步骤配置。

1. 运行Git Bash，先检查本地是否已生成过SSH密钥。请在Git Bash中执行如下命令：

   cat ~/.ssh/id_rsa.pub

   • 如果提示“No such file or directory”，说明用户这台计算机没生成过SSH密钥，请继续执行2。
   • 如果返回以“ssh-rsa”开头的字符串，说明用户这台计算机已经生成过SSH密钥，如果使用已经生成的密钥请直接跳到3，如果想重新生成密钥，请从2向下执行。

2. 生成SSH密钥。在Git Bash中生成密钥的命令如下：

   ssh-keygen -t rsa -b 4096 -C your_email@example.com

   • “-t rsa”表示生成的是RSA类型密钥。
   • “-b 4096”是密钥长度（该长度的RSA密钥更具安全性）。
   • “-C your_email@example.com”表示在生成的公钥文件中添加注释，方便识别此密钥对的用途。

   输入生成密钥的命令后，直接回车，密钥会默认存储到“~/.ssh/id_rsa”路径下，对应的公钥文件为“~/.ssh/id_rsa.pub”。

3. 复制SSH公钥到剪切板。请根据用户的操作系统，选择相应的执行命令，将SSH公钥复制到用户的剪切板。
   • Windows：

     clip < ~/.ssh/id_rsa.pub

   • Mac：

     pbcopy < ~/.ssh/id_rsa.pub

   • Linux (xclip required):

     xclip -sel clip < ~/.ssh/id_rsa.pub

4. 登录并进入Repo的代码仓库列表页，单击右上角昵称，选择“个人设置” > “代码托管” > “SSH密钥”，进入配置SSH密钥页面。

   也可以在Repo的代码仓库列表页，单击右上角“设置我的SSH密钥”，进入配置SSH密钥页面。

5. 在“标题”中为用户的新密钥起一个名称，将用户在3中复制的SSH公钥粘贴进“密钥”中，单击确定后，弹出页面“密钥已设置成功，单击 立即返回，无操作3S后自动跳转”，表示密钥设置成功。

相关文档

• 如果返回“密钥添加失败，请检查密钥是否有效”，表示输入的密钥格式有误，如果用户是通过手动在本地复制的密钥，可能复制了多余的空格或者复制的密钥不完整，可以参考3，根据用户的系统执行指令，重新配置密钥。
• 在配置SSH密钥时，提示：“此密钥已存在，请重新生成密钥”，表示该密钥在该账号或者其它账户下被添加过。解决办法：可参考如上操作步骤，在本地重新生成一次SSH密钥，再把生成的密钥配置到CodeArts Repo。
• Repo提供接口获取SSH密钥列表，请参考API文档获取SSH密钥列表。
• Repo提供接口获取SSH密钥列表，请参考API文档添加SSH密钥。
• Repo提供接口获取SSH密钥列表，请参考API文档添加SSH密钥。

介绍视频