github 에 SSH key 등록하기

github, bitbucket 같은 클라우드 사이트에 Client 프로그램으로 SSH 접속을 위해서는 SSH 키 쌍 생성하고 클라우드 사이트에 등록해야 한다.

보통 github, bitbucket 등 같은 SSH 접근을 지원하는 사이트는 ssh-agent forwarding 방식을 사용한다.

1. 클라이언트에서 ssh 키 쌍을 생성
2. 클라이언트에 개인키를 ssh-agent 에 등록
3. 클라우드 서비스에 공개키를 등록
4. 클라이언트 프로그램에서 ssh 사용시 ssh-agent 등록한 개인키로 암호화

여기서는 github 에 ssh key 등록 과정을 요약하고 있다.

• Connect with SSH
• github을 예로 들었지만 bitbucket 도 유사한 과정을 거친다.
• bitbucket 에 SSH key 등록하기

SSH 구성과 SSH 인증

먼저 ssh host key 를 생성하고 github 과 사용할 개인 key 를 만든다. 개인키를 ssh-agent 방식으로 등록하고 공개키를 github 에 등록하면 된다.

ssh-agent 키 관리

로컬 머신에서 사용하는 SSH Key 쌍에 대한 접근을 ssh-agent 를 통해서 진행한다. managing deploy keys 에 설명되어 있다.

• 에이전트 전달은 로컬 개발 컴퓨터에서 사용하는 것과 동일한 SSH 키를 사용합니다.
• 단 사용자 클라이언트에 SSH에 있어야 합니다

SSH Client Keys

저장소에 접근하는 url은 HTTPS or SSH 에 따라 달라진다.

1. HTTPS

https://<repo_owner>@github.com/<accountname>/<reponame>.git

2. SSH

git@github.com:<repo_owner>/<reponame>.git

or

ssh://git@github.com/<repo_owner>/<reponame>.git

github은 암호 알고리즘으로 keys: Ed25519, ECDSA, RSA, and DSA 를 지원한다.

예를 들어 아래 같이 생성한 공개키를 사용할 수 있다.

#Ed25519 (ed25519) / 256
$ ssh-keygen -t ed25519 -b 256

# ECDSA (ecdsa) / 256
$ ssh-keygen -t ecdsa -b 256

# RSA (rsa) / 2048
$ ssh-keygen -t rsa -b 4096

개별키 생성

ssh 를 사용해서 github 에 접근하려면 사용하는 클라이언트에서 SSH 로 개인키와 공개키를 생성해야 한다. SSH 키를 생성하려면 아래 과정이 필요하다.

1. Open SSH 설치
2. SSH 서비스
3. SSH 키 생성

여기서 Linux/macOS 그리고 Windows 11 에서 키 쌍을 생성해서 github에 SSH Key를 등록하는 과정을 살펴보겠다.

Windows 11에서 키 생성

Windows 11 에서 Git 이 설치되어 있다고 가정.

> get-command git

Application     git.exe                                            2.38.1.1   C:\Program Files\Git\cmd\git.exe

Openssh 확인

> ssh -V
OpenSSH_for_Windows_8.6p1, LibreSSL 3.4.3

ssh 명령 위치 확인

> Get-Command ssh

결과 ssh 명령을 git config 로 ssh 명령을 지정

git config --global core.sshCommand C:/Windows/System32/OpenSSH/ssh.exe

SSH agent 시작

git 이 ssh 키를 사용하려면 SSH agent 가 시작되어야 한다. 보통 Git for windows 와 Windows 11 이후 Windows OpenSSH 를 사용하므로

Windows OpenSSH 사용자는 다음 같이 agent를 확인하고 시작한다.

> Get-Service ssh-agent

Status   Name               DisplayName
------   ----               -----------
Stopped  ssh-agent          OpenSSH Authentication Agent

ssh-agent 서비스를 시작 하려면 Windows service에서 OpenSSH Authenticate Agent 서비스를 시작해 두어야 한다.

속성에서 시작으로 한다.

서비스가 정상적으로 시작되면 아래 명령으로 시작/종료 그리고 재시작을 할 수 있다. - 시작 안되어 있으면 알수없는 에러가 난다.

> Start-Service ssh-agent

Git for windows 를 사용하면 Git for windows의 bash 터미널 에서 다음 같이 확인하고 시작한다.

$ ps -a | grep ssh-agent

ssh-agent 를 시작한다.

$ eval $(ssh-agent)

에이젼트가 시작되면 git client 에서 ssh 정보를 얻을 수 있다.

github에서 사용할 SSH key pair를 생성

ssh-keygen.exe로 키 쌍, 비밀키/공개키를 생성한다. 키를 생성시 bitbucket 계정의 e-mail 을 포함해 생성한다. 생성시 사용자 홈 디렉토리 .ssh 디렉토리에서 작업한다.

> ssh-keygen.exe -t ed25519  -b 4096 -C "EMAIL" -f "KEY_FILE"

• EMAIL: github 계정 이메일
• KEY_FILE: 파일 이름. 보통 bitbucket_work

참고: Ed25519 알고리즘을 지원하지 않는 레거시 시스템을 사용하는 경우 다음을 사용합니다.

>$ ssh-keygen -t rsa -b 4096 -C "EMAIL" -f "KEY_FILE"

.ssh 디렉토리에 키 쌍 KEY_FILE 과 KEY_FILE.pub 이 생성된다.

> dir .ssh

    Directory: C:\Users\daddy\.ssh

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---        2023-06-25  오후 6:11           3381 bitbucket_work
-a---        2023-06-25  오후 6:11            744 bitbucket_work.pub
-a---        2020-11-08 오전 12:12           1675 id_rsa
-a---        2020-11-08 오전 12:12            404 id_rsa.pub

이제 키를 SSH Agent 에 등록하자.

SSH Agent 에 키 등록

키 파일을 SSH Agent 에 등록한다. KEY_FILE 은 비밀키 파일을 지정하면 된다.

> ssh-add ~/.ssh/KEY_FILE

그리고 명확하게 github 에 해당 키를 사용하도록 ~/.ssh/config 에 아래 같이 등록한다.

Host github.com
  AddKeysToAgent yes
  IdentityFile ~/.ssh/KEY_FILE

macOS / Linux

Openssh 확인

$ ssh -V
OpenSSH_8.2p1 macOS, OpenSSL 1.1.1f  31 Mar 2020

ssh 명령이 없으면 macOS는 brew 로 설치한다.

$ brew install openssh

Linux 는 apt, dnf, pacman 을 사용해 설치한다.

$ sudo apt update && sudo apt install openssh-client

SSH agent 시작

git 에서 ssh 키를 사용하려면 SSH agent 가 시작한다. bash 터미널 에서 다음 같이 확인하고 시작한다.

$ ps -a | grep ssh-agent

ssh-agent 를 시작한다.

$ eval $(ssh-agent)

이 명령을 ~/.bashrc, ~/.zshrc, ~/.profile, 등에 등록해 둔다. 에이젼트가 시작되면 git client 에서 ssh 정보를 얻을 수 있다.

github에 사용할 SSH key pair를 생성

ssh-keygen.exe로 키 쌍, 비밀키/공개키를 생성한다.

• 키를 생성시 bitbucket 계정의 e-mail 을 포함해 생성한다.
• 사용자 홈 디렉토리 .ssh 디렉토리에서 작업한다.

$ ssh-keygen -t rsa -b 4096 -C "EMAIL" -f "KEY_FILE"

• EMAIL: bitbucket 계정 이메일
• KEY_FILE: 파일 이름. 보통 bitbucket_work

참고: Ed25519 알고리즘을 지원하지 않는 레거시 시스템을 사용하는 경우 다음을 사용합니다.

>$ ssh-keygen -t rsa -b 4096 -C "EMAIL" -f "KEY_FILE"

.ssh 디렉토리에 키 쌍 KEY_FILE 과 KEY_FILE.pub 이 생성된다.

$ ls -l .ssh

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---        2023-06-25  오후 6:11           3381 bitbucket_work
-a---        2023-06-25  오후 6:11            744 bitbucket_work.pub
-a---        2020-11-08 오전 12:12           1675 id_rsa
-a---        2020-11-08 오전 12:12            404 id_rsa.pub

이제 키 쌍를 SSH Agent 에 등록하자.

SSH Agent 에 키 등록

키 파일을 SSH Agent 에 등록한다. KEY_FILE 은 비밀키 파일을 지정하면 된다.

$ ssh-add ~/.ssh/KEY_FILE

그리고 명확하게 bitbucket 에 해당 키를 사용하도록 ~/.ssh/config 에 아래 같이 등록한다.

Host github.com
  AddKeysToAgent yes
  IdentityFile ~/.ssh/KEY_FILE

github 에 public key 등록하기

github 계정의 SSH and GPG keys에서 등록해 주어야 한다. 키 쌍 중 공개키 KEY_FILE.pub 내용을 등록해 준다.

1. Settings -> Personal Settings

' >

cat 명령 등으로 내용을 복사한다. 사이트의 Add key 창에 붙여 넣는다.

클라이언트에서 github SSH 접속이 가능한지 테스트한다. 단, 모든 SSH 연결은 최초 접속시 호스트 접속시 접속 여부를 묻는 다이얼로그가 나온다.

• https://docs.github.com/ko/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection

결과적으로 아래 같이 결과가 출력되면 성공한 상태다.

$ $ ssh -T git@github.com

Hi USER! You've successfully authenticated, but GitHub does not provide shell access.

이제 git 클라이언트에서 HTTPS, SSH 를 통해서 github 과 ssh 연결이 가능하다. git 클라이언트로 push, pull 등을 수행할 수 있다.

---

참고

1. Connect with SSH, github
2. SSH 연결 테스트, github
3. bitbucket 에 SSH key 등록하기