GitHub 접속 용 SSH 키 만드는 방법

SSH 공개키와 개인키 만들기

$ cd ~/.ssh
$ ls
...

 

$ ssh-keygen -t ed25519 -C "your_email@example.com"

-C 옵션의 your_email@example.com은 자신의 이메일로 변경해주세요. ed25519 방식으로 동작하지 않는 경우에는 아래와 같이 RSA로 옵션을 변경해 SSH 키를 생성합니다.

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

명령어를 실행해서 실제로 키를 만들어보겠습니다.

$ ssh-keygen -t ed25519 -C "lainyzine.com@gmail.com"
Generating public/private ed25519 key pair.
Enter file in which to save the key (/Users/lainyzine/.ssh/id_ed25519):

첫 번째로 저장하고자하는 위치를 물어봅니다. 다른 위치를 지정하는 것도 가능하지만 여기서는 기본값을 사용합니다.

Enter passphrase (empty for no passphrase):
Enter same passphrase again:

다음으로 SSH 키에 대한 비밀번호를 추가로 지정할지 물어봅니다. 패스워드를 설정해도 되고, 추가 패스워드 없이 사용하려면 엔터를 두 번 입력해줍니다. (추가 패스워드는 나중에 지정하는 것도 가능하지만, GitHub에서는 공식적으로 패스워드 설정을 권장하고 있습니다).

Your identification has been saved in /Users/lainyzine/.ssh/id_ed25519.
Your public key has been saved in /Users/lainyzine/.ssh/id_ed25519.pub.
The key fingerprint is:
SHA256:MRR2EWPjezAxwlrxCgfqjq43CJjtZVl8Heo5YU/912I lainyzine.com@gmail.com
The key's randomart image is:
+--[ED25519 256]--+
|      ..*oXo     |
|     . +o*.=     |
|    ...o+o=o     |
|   .  +o=+o+.    |
|.o  .o +S=. ..  .|
|+ .o+   + ..  E o|
|.o.o.    .   . o |
|..+              |
|.o..             |
+----[SHA256]-----+

그럼 SSH 키가 생성되었습니다. 설명을 잘 읽어보면 개인키는 /Users/lainyzine/.ssh/id_ed25519에, 공개키는 /Users/lainyzine/.ssh/id_ed25519.pub에 저장되었습니다. RSA 방식으로 키를 생성하는 경우 기본 파일 이름은 id_rsa, id_rsa.pub가 됩니다.

실제로 키가 잘 생성되었는지 개인키를 출력해봅니다.

$ cat id_ed25519
-----BEGIN OPENSSH PRIVATE KEY-----
b3BlbnNzaC1rZXktdjEAAAAABG5vbmU333AAEb55uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW
QyNTUxOQAAACDoOnBaZyx9IjcgU6666n28Qz6LwTPYHZRW0/H9IGT+QAAAKAHVs1tB1bN
bQAAAAtzc2gtZWQyNTUxOQAAACDoOnBaZyxeajc17UAPTn28Qz6LwTPYHZRW0/H9IGT+Q
AAAEBbytj4mVV9QBnssl9TRW4N2p3frl95UFpQtnRn5sDkKeg6cFpnLH0iNyBQDGc9Ofbx
DPovBM9gdlFbT8f0gZP5AAAAFnlvdXJfZW1haWxAZXhhbXBsZS5jb20BAgMEBQYH
-----END OPENSSH PRIVATE KEY-----

다시 한 번 강조하지만, 개인키는 절대 공개되어서는 안 됩니다.

이번에는 공개키를 출력해봅니다. 바로 이 내용을 GitHub에 등록해주어야합니다.

$ cat id_ed25519.pub
ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOg6cFpnLH0iNyBQDGc9OfbxDPovBM9gdlFbT8f0gZP5 your_email@example.com

이 내용을 전체를 직접 복사하거나, macOS에서는 pbcopy, 윈도에서는 clip 명령어를 사용해 클립보드에 복사합니다. cat으로 실행한 내용을 직접 복사하기보다는 텍스트가 깨지지 않도록 명령어를 통해 복사하는 걸 추천합니다.

# macOS
$ pbcopy < ~/.ssh/id_ed25519.pub

# Windows
$ clip < ~/.ssh/id_ed25519.pub

공개키를 GitHub 계정에 등록하기

SSH 키를 등록합니다

Add SSH key를 눌러 키를 등록합니다.

SSH 키가 정상 등록된 것을 확인할 수 있습니다

SSH 키를 생성하고 GitHub에 등록하는 과정까지 마쳤습니다. 공개키는 정말로 공개키입니다. GitHub에 키를 등록하면 github.com/[USERNAME].keys으로 접속하면 해당 사용자의 공개키를 확인할 수 있습니다. 아례 스크린샷은 비탈릭 부테린(Vitalik Buterin)의 공개키입니다.

비탈릭 부테린의 공개키 페이지

공개키를 알아서 할 수 있는 건, 대응하는 개인키를 가진 사용자에게 인증 권한을 부여하는 일입니다. 따라서 공개키가 공개된다고 보안 상 위험은 없다고 봐도 무방합니다.

그럼 이제 등록한 키가 잘 동작하는지 확인해볼 차례입니다.

SSH 접속 설정

테스트에 앞서 명시적으로 SSH 접속 설정을 해두겠습니다. ~/.ssh/config 파일에 아래 내용을 추가하거나, 파일이 없다면 생성한 후 아래 내용을 추가해주세요.

Host github.com
  IdentityFile ~/.ssh/id_ed25519
  User git

이제 접속 테스트를 해볼 차례입니다. 아래 명령어로 GitHub에 접속 테스트를 해볼 수 있습니다.

$ ssh -T git@github.com
Enter passphrase for key '/Users/lainyzine/.ssh/id_ed25519':
Hi lainyzine! You've successfully authenticated, but GitHub does not provide shell access.

SSH 키에 패스워드를 지정한 경우 패스워드 입력을 받습니다. 인증에 성공하면 GitHub ID 출력까지 확인할 수 있습니다. 이를 통해 등록한 SSH 키로 접속에 성공한 것을 확인할 수 있습니다. (여기서 에러가 발생한다면 트러블슈팅 섹션을 참고해주세요)

하나의 GitHub 계정을 사용할 때는 큰 문제가 없습니다만, 멀티 어카운트를 사용하는 경우에는 설정이 좀 더 복잡해집니다. 이에 대한 내용은 아래 글에서 다룹니다.

• 관련 글: GitHub 멀티 어카운트를 사용할 때 유용한 Git 설정

GitHub에 SSH 키로 접속 테스트

이 SSH 키를 통해서 SSH 프로토콜로 Git 작업을 수행할 수 있습니다. 테스트를 위해 private 권한으로 example-private 저장소를 생성해보았습니다.

먼저 이 저장소를 클론하려면 저장소에 대한 권한이 있어야합니다. SSH 형식으로 주소를 변경하고, 이 주소를 변경해서 저장소를 로컬에 클론해보겠습니다.

• 관련 글: git clone 사용법: 원격 Git 저장소 복제

$ git clone git@github.com:lainyzine/example-private.git
Cloning into 'example-private'...
Enter passphrase for key '/Users/lainyzine/.ssh/id_ed25519':
warning: You appear to have cloned an empty repository.
$ ls
example-private

SSH 키에 패스워드가 설정되어있으면, 계속해서 비밀번호를 물어봅니다. 정상적으로 클론이 되고, 빈 저장소라는 경고가 나타납니다.

이번에는 저장소에 푸시를 해보겠습니다. 저장소 디렉터리로 이동해서 README.md 파일을 입시로 생성하고 이 내용을 커밋하고, 푸시해봅니다.

$ cd example-private

# Git 설정에 사용자 정보 등록
$ git config --global user.name lainyzine
$ git config --global user.email lainyzine.com@gmail.com

# README.md 파일 커밋하고 푸시하기
$ echo 'Hi, GitHub' > README.md
$ git add .
$ git commit -m'Add README.md'
[master (root-commit) 5f7b9a8] Add README.md
 1 file changed, 1 insertion(+)
 create mode 100644 README.md
$ git push origin master
Enter passphrase for key '/Users/lainyzine/.ssh/id_ed25519':
Enumerating objects: 3, done.
Counting objects: 100% (3/3), done.
Writing objects: 100% (3/3), 238 bytes | 238.00 KiB/s, done.
Total 3 (delta 0), reused 0 (delta 0)
To github.com:lainyzine/example-private.git
 * [new branch]      master -> master

GitHub에 푸시가 정상적으로 되는 것을 확인할 수 있습니다.

팁과 트러블 슈팅

GitHub에 SSH 키를 등록할 때 유용한 팁과 문제가 발생했을 때 대처하는 방법에 대해서 알아봅니다.

팁: SSH키 패스워드 입력을 생략하는 방법

매번 SSH 키 패스워드 입력을 하려면 번거롭습니다. ssh-agent에 키를 등록해두면 좀 더 편리하게 사용할 수 있습니다. ssh-agnet는 백그라운드에서 SSH 인증 정보를 관리합니다. ssh-agent가 실행되어있는지부터 확인해봅니다.

$ ssh-add -l
Error connecting to agent: Connection refused

위와 같이 에러가 나오면 ssh-agent가 실행되어있지 않은 상태입니다. SSH 키 목록이나 The agent has no identities.와 같은 메시지가 나오면 이미 ssh-agent가 실행된 상태입니다. 실행되어있지 않다면, 먼저 ssh-agent를 실행합니다.

$ eval "$(ssh-agent -s)"

다음으로 ssh-add 명령어로 키를 등록합니다. 등록할 대 패스워드를 확인합니다.

$ ssh-add ~/.ssh/id_ed25519
Enter passphrase for /Users/lainyzine/.ssh/id_ed25519:
Identity added: /Users/lainyzine/.ssh/id_ed25519 (lainyzine.com@gmail.com)

ssh-add -l 명령어로 ssh-agent에 등록된 SSH 키들을 확인할 수 있습니다.

$ ssh-add -l
256 SHA256:JfXX05Pj352343pnuQiQ125Z6V88Q/F49cBViSumqVFeSp3LIQs lainyzine.com@gmail.com (ED25519)

이 상태에서 git clone을 하면 더 이상 패스워드를 물어보지 않습니다.

$ git clone git@github.com:lainyzine/example-private.git example-private-2
Cloning into 'example-private-2'...
remote: Enumerating objects: 6, done.
remote: Counting objects: 100% (6/6), done.
remote: Compressing objects: 100% (2/2), done.
remote: Total 6 (delta 0), reused 6 (delta 0), pack-reused 0
Receiving objects: 100% (6/6), done.

팁: macOS에서 키체인 사용하기

macOS에서는 ssh-add 명령어를 사용할 때 -K 옵션을 붙여주면 패스워드를 키체인에 저장해서 사용할 수 있습니다.

$ ssh-add -K ~/.ssh/id_ed25519
Enter passphrase for /Users/lainyzine/.ssh/id_ed25519:
Identity added: /Users/lainyzine/.ssh/id_ed25519 (lainyzine.com@gmail.com)

처음 패스워드를 입력하면 키체인에 패스워드를 등록하고 패스워드를 다시 물어보지 않습니다.

~/.ssh/config 파일에 AddKeysToAgent와 UseKeychain 옵션을 추가해두면 위의 과정들을 자동적으로 처리해줘서 편리합니다.

Host github.com
  IdentityFile ~/.ssh/id_ed25519
  User git
  AddKeysToAgent yes
  UseKeychain yes

트러블 슈팅: Permission denied

ssh -T git@github.com로 SSH 접속 테스트를 할 때 에러가 발생할 수 있습니다. Permission denied 가 발생하는 경우 에러메시지를 잘 확인해보면 도움이 됩니다. 예를 들어 다음과 같이 출력되는 경우에는,

$ ssh -T git@github.com
no such identity: /Users/lainyzine/.ssh/id_ed25519: No such file or directory
git@github.com: Permission denied (publickey).

No such file or directory 메시지에서 힌트를 얻을 수 있습니다. 지정된 키 파일이 존재하지 않는 경우입니다. 키가 제대로 생성되었는지, 키 경로에 오타는 없는지 확인해봅니다. -i 옵션을 사용해 SSH 키 경로를 명시적으로 지정해보는 것도 좋습니다.

$ ssh -i /Users/lainyzine/.ssh/id_ed25519 -T git@github.com

접속 과정을 좀 더 자세히 확인하고 싶다면 -v 옵션을 붙여봅니다. 상세한 로그가 나와서 문제를 찾는데 도움이 됩니다.

$ ssh -v -T git@github.com

추천 문서

• Generating a new SSH key and adding it to the ssh-agent - GitHub Docs

 

출처 : https://www.lainyzine.com/ko/article/creating-ssh-key-for-github/