[Webstorm] SSH Key Passphrase 인증 (헤매인 스토리)

WebStorm - JetBrains

 

 

접근 (요약)

개발을 위해 사용하던 (IDE) IntelliJ Ultimate version 말고도 Webstorm이 무상제공됨(비영리)을 확인했습니다.

따라서 JavaScript & TypeSript 전용 웹 개발 프로젝트를 위해 사용을 해보려다가, 설정에서 헤매인(?) 스토리를 담습니다.

 

둘 다 JetBrains사에서 다루는 IDE이다 보니 한 쪽의 프로그램에서의 settings 값들을 다른 한 쪽의 프로그램으로 모두 import 를 해올 수 있었고, 그렇게 전 무심코 settings 값들을 import 를 해오면서 모든 문제의 시작이 있었던 것 같습니다.

 

WebStorm 내 VCS에 Github 계정이 token으로 로그인이 되어있음에도 불구하고,

프로젝트 clone을 위해 rsa(SSH key)를 명확히 입력해도 clone이 fail되는 상황

 

우회하여, terminal 명령어 입력으로 clone을 받고자 SSH 형식의 url을 copy해 clone은 성공해도

프로젝트 내 변경이력을 push 하려해도 push failed 되는 상황

 

무언가 한 가득 방해받고, 막혀있는 듯한 느낌을 줬습니다. 

무엇이 문제인지 알 것 같으면서도 모르겠는 이 상황을 풀어나간 스토리를 적어 내려갑니다.

도움이 되는 부분에서 해결을 보시길 응원합니다!

  

 

 

 

  1. 고맙지만 미웠던, import 

 

  2. 에러 발생의 시작 ()

      (2.1). Permission denied

      (2.2). Auto Fetch Fail

      (2.3). Push Failed

 

  3. 이건 왜 안돼? (원격 저장소로의 push)

      (3.1). git push --set-upstream origin 브랜치명

      (3.2). IDE VCS

 

  4.  IDE setting 수정

      (4.1)  Preferences (또는 Settings) > Tools > SSH Configurations

      (4.2)  Preferences (또는 Settings) > Appearance & Behavior > System Settings > Passwords로 이동

      

  5. 해소

      (5.1). 프로그램 실행 후 SSH key를 재차 확인

---

방법

   1. 고맙지만 미웠던, import 

제품 내 import settings 을 도와주는 JetBrains

 

IntelliJ Ultimate IDEA에서 사용했던 settings 값을 그대로 "import settings" 해주겠다는 WebStorm 과의 첫만남.

이것이 '유료 IDEA Tool을 사용하는 또다른 이유 중 하나겠구나' 생각하며 아무런 의심없이 진행.

 

---

  2. 에러 발생의 시작 

      (2.1). Permission denied

      (2.2). Auto Fetch Fail

      (2.3). Push Failed

문제의 에러..

 

✅ github 프로젝트의 권한을 maintain => admin 으로 수정 (maintain  role도 괜찮았던 것..!)

✅ 다양한 명령어 확인 과정 

 

eval $(ssh-agent -s)

>> Agent pid 85005

 

ssh -T git@github.com

>> Hi OOOO, 

---

  3. 이건 왜 안돼? (원격 저장소로의 push)

      (3.1). git push --set-upstream origin 브랜치명

      (3.2). IDE VCS

 

다양한 테스트 중, 원격 저장소로의 Push 를 위해서 2가지 방법 이용

 

1. 명령어 입력 => Push 진행 됨

git push --set-upstream origin 브랜치명

 

 

2. VCS 사용 => Push Failed

- 명확한 rsa passphrase를 입력해도 push failed가 났던 것

단축키 : command + k

 

1) 웹스톰에서 VCS 를 통해 command+k 키를 눌러 commit and push를 진행하면 아래 에러가 나오는데 Push failed git@github.com: Permission denied (publickey). Could not read from remote repository. Please make sure you have the correct access rights and the repository exists. 2) 또, commit 한 후에, git push --set-upstream origin feature/BTMS_RF0017 이 명령어로 push를 하면 rsa의 passphrase를 요구하면서 올바르게 입력 후 원격저장소에 push가 돼. 난 정확한 passphrase를 입력하는데 왜 1) 방식에서는 에러가 날까?

 

==> 주로 SSH 에이전트와 WebStorm의 인증 설정 차이 때문입니다.

• 터미널에서 git push를 실행할 때는 SSH 에이전트가 활성화되어 있어, SSH 키와 passphrase가 정상적으로 동작합니다.
• WebStorm에서 VCS 사용 시에는 SSH 에이전트가 제대로 설정되지 않았거나, WebStorm이 제대로된 SSH 키를 사용하지 않아서 Permission denied (publickey) 오류가 발생합니다. 이때 SSH 키 인증에 실패하고, git@github.com: Permission denied 에러가 발생하는 것입니다.

1. WebStorm에서 SSH 에이전트 설정 확인

WebStorm이 SSH 에이전트를 제대로 사용하고 있는지 확인해야 합니다. 만약 WebStorm이 SSH 키를 찾지 못하면, 인증을 위해 passphrase를 요청할 수 없습니다.

WebStorm에서 SSH 설정을 확인하는 방법:

• Preferences > Version Control > Git으로 가세요.
• Path to Git executable에서 git이 올바르게 설정되어 있는지 확인합니다.
• Use credential helper가 체크되어 있는지 확인해 보세요. 이 설정이 GitHub과의 인증 문제를 해결하는 데 도움이 될 수 있습니다.

2. WebStorm에서 SSH 키를 올바르게 사용하는지 확인

WebStorm은 때때로 로컬 환경의 SSH 에이전트를 제대로 인식하지 못할 수 있습니다. 이를 해결하기 위한 방법은 WebStorm에서 직접 SSH 키를 사용하도록 설정하는 것입니다.

1. WebStorm에서 Preferences (또는 Settings) > Tools > SSH Configurations로 가세요.
2. GitHub에 연결된 SSH 키가 제대로 설정되어 있는지 확인합니다. 이 설정을 통해 WebStorm이 사용하는 SSH 키를 확인하고, 올바르게 설정할 수 있습니다.

3. SSH 에이전트 문제 해결

WebStorm이 SSH 에이전트와 제대로 연동되지 않아서 발생할 수 있는 문제입니다. 이를 해결하기 위해서는, SSH 에이전트가 실행 중인지 확인하고, WebStorm에 SSH 키를 명시적으로 연결해줘야 합니다.

• 터미널에서 SSH 에이전트가 활성화 되어 있는지 확인하려면 아래 명령어를 입력해보세요:이 명령어는 SSH 에이전트를 시작하고, 해당 키를 SSH 에이전트에 추가하는 명령입니다.
• bash
  코드 복사
  eval "$(ssh-agent -s)" ssh-add ~/.ssh/id_rsa
• WebStorm을 다시 시작한 후, VCS -> Git -> Commit and Push를 다시 시도해 보세요.

4. WebStorm의 Git 인증 설정 재설정

WebStorm에서 GitHub 인증 정보를 재설정하는 것도 방법이 될 수 있습니다. WebStorm에서 인증 정보를 삭제하고, 다시 인증 절차를 진행해 보세요.

1. Preferences (또는 Settings) > Appearance & Behavior > System Settings > Passwords로 이동합니다.
2. In KeePass나 Native Keychain을 선택하고, 저장된 GitHub 인증 정보를 삭제합니다.
3. 다시 WebStorm을 재시작하고, GitHub에 대한 인증 정보를 새로 입력해 보세요.

5. GitHub에서 SSH 키 확인

WebStorm에서 사용하는 SSH 키가 GitHub에 제대로 등록되었는지 다시 한번 확인하는 것도 좋은 방법입니다. 만약 SSH 키가 GitHub 계정에 등록되지 않았다면 Permission denied (publickey) 에러가 발생할 수 있습니다.

• GitHub SSH Key 등록을 확인하려면:
  • GitHub에 로그인한 후, Settings > SSH and GPG keys에서 등록된 SSH 키 목록을 확인하세요.
  • WebStorm에서 사용하는 키와 일치하는지 확인하고, 키가 등록되어 있지 않다면 새로 추가해 주세요

---

 

  4. IDE setting 수정

      (4.1)  Preferences (또는 Settings) > Tools > SSH Configurations

      (4.2)  Preferences (또는 Settings) > Appearance & Behavior > System Settings > Passwords로 이동

 

(4-1) 기존에 추가 되어있던 것 제거 (import로 함께 넘어온 설정 값이 있었다)

 

(4-2) 기존의 체크 된 keyChain이 아니라, "Do not save, Forget passwords after restart" 체크!

 

  5. 해소

      (5.1). 프로그램 실행 후 SSH key를 재차 확인

 

 

해소된 이후, 재실행시킨 WebStorm이 반겨주며 내놓은 것!

(rsa SSH key를 재입력하도록 하는 것!)