teafoot · September 11, 2022 17:28 · Apr 25, 2019 · Apr 25, 2019 · Apr 25, 2019 · Apr 4, 2019
diff --git a/github_bitbucket_multiple_ssh_keys.md b/github_bitbucket_multiple_ssh_keys.md
@@ -186,7 +186,7 @@ statement for each of the .gitconfig files referencing the directory they are in
 	
 ```
 
-<b>Do not forget the trailing slash in the `[includeif "gitdir:...` statement.</b>
+<b>Do not forget the trailing slash in the `[includeif "gitdir:...` statement.</b> (thanks loizoskounios)
 
 ## 6. Cloning the repositories
 

diff --git a/github_bitbucket_multiple_ssh_keys.md b/github_bitbucket_multiple_ssh_keys.md
@@ -173,6 +173,7 @@ https://confluence.atlassian.com/bitbucketserver/using-gpg-keys-913477014.html
 
 To activate the .gitconfig files in ~/src/*, edit the .gitconfig file in your home directory and add an `includeif`
 statement for each of the .gitconfig files referencing the directory they are in
+
 ```
 ~/.gitconfig
 ...
@@ -185,6 +186,8 @@ statement for each of the .gitconfig files referencing the directory they are in
 	
 ```
 
+<b>Do not forget the trailing slash in the `[includeif "gitdir:...` statement.</b>
+
 ## 6. Cloning the repositories
 
 You then clone the code using the SSH clone address (i.e. [email protected]... or [email protected]..., not https://bitbucket.org... nor https://github.com...)

diff --git a/github_bitbucket_multiple_ssh_keys.md b/github_bitbucket_multiple_ssh_keys.md
@@ -66,6 +66,7 @@ chmod 600 ~/.ssh/config
 We now need to add SSH configuration that specifies the github and bitbucket hostnames but with a suffix appended to qualify
 which key to use.  We set the `HostName` to the correct github.com or bitbucket.org address.
 
+Note: Linux users should either omit `UseKeychain yes` or add `IgnoreUnknown UseKeychain` (thanks soulofmischief)
 ```
 ~/.ssh/config
 ...

diff --git a/github_bitbucket_multiple_ssh_keys.md b/github_bitbucket_multiple_ssh_keys.md
@@ -55,7 +55,6 @@ $ ssh-add ~/.ssh/key2_rsa
 ```
 
 ## 2. Setup ~/.ssh/config
-Based on work from https://gist.github.com/jexchan/2351996
 
 Create a file in ~/.ssh/config (if it does not already exist).  You must make sure it is readable only by the owner
 and the group and public bits are set off.
@@ -119,8 +118,6 @@ https://help.github.com/en/articles/adding-a-new-ssh-key-to-your-github-account
 
 ## 4. Create key specific .gitconfig
 
-Based on work from http://blog.bennycornelissen.nl.s3-website-eu-west-1.amazonaws.com/post/juggling-multiple-git-identities/
-
 You will need a single directory where all code that corresponds to a given key will be checked out to.
 
 I prefer to keep all those directories in one directory in my home `~/src` and I name them according to the account
@@ -204,3 +201,11 @@ the SSH config file but because of the SSH configuration it will use the origina
 ensuring you use the right key.
 
 All commits/pulls/pushes to/from those repositories will use the corresponding config/key/account.
+
+
+### Credits
+
+This work was adapted from the following
+* https://medium.com/@trionkidnapper/ssh-keys-with-multiple-github-accounts-c67db56f191e
+* https://gist.github.com/jexchan/2351996
+* http://blog.bennycornelissen.nl.s3-website-eu-west-1.amazonaws.com/post/juggling-multiple-git-identities/
diff --git a/github_bitbucket_multiple_ssh_keys.md b/github_bitbucket_multiple_ssh_keys.md
@@ -55,6 +55,7 @@ $ ssh-add ~/.ssh/key2_rsa
 ```
 
 ## 2. Setup ~/.ssh/config
+Based on work from https://gist.github.com/jexchan/2351996
 
 Create a file in ~/.ssh/config (if it does not already exist).  You must make sure it is readable only by the owner
 and the group and public bits are set off.

diff --git a/github_bitbucket_multiple_ssh_keys.md b/github_bitbucket_multiple_ssh_keys.md
@@ -186,7 +186,7 @@ statement for each of the .gitconfig files referencing the directory they are in
 	
 ```
 
-## 6. Checkout
+## 6. Cloning the repositories
 
 You then clone the code using the SSH clone address (i.e. [email protected]... or [email protected]..., not https://bitbucket.org... nor https://github.com...)
 into the directory that corresponds to the key you want to use for that clone.

diff --git a/github_bitbucket_multiple_ssh_keys.md b/github_bitbucket_multiple_ssh_keys.md
@@ -2,38 +2,204 @@
 
 There are numerous reasons you may need to use multiple SSH keys for accessing GitHub and BitBucket
 
-When acting as a consultant, it is common to have multiple Github and/or BitBucket accounts depending on which client you may be working for.
-
 You may use the same computer for work and personal development and need to separate your work.
 
+When acting as a consultant, it is common to have multiple GitHub and/or BitBucket accounts depending on which client you may be working for.
+
 You may have different projects you're working on where you would like to segregate your access. 
 
-Either way, handling this in a standard Mac/linux PC setup is difficult.
+Whatever your reason may be, handling this in a standard Mac/linux PC setup is difficult.
+
+Use the following guide to ensure you code is easy to manage, all changes correspond to the correct identity,
+ and checking out new repositories is not a hassle.
+
+This guide will work on Mac OS, most Linux distributions and on Windows when using Cygwin, GitBash, or Windows Subsystem for Linux
+with OpenSSH installed.
 
-Use the following guide to ensure you code is easy to manage and checking out new repositories is not a hassle.
+<b>You must have Git 2.13 or above and OpenSSH installed to use the following guide.</b>
 
-## 1. Decide on how many keys you need and create them
+## 1. Create keys 
+
+You will need one key for each different account you will use on either GitHub or BitBucket.  
 
-You will need one key for each different identity you will use on either GitHub or BitBucket.  
 Whichever site you have more identities with determines how many keys you will need.
+
 A single key can act both as a GitHub and BitBucket key but cannot be associated with more than one BitBucket or GitHub account.
 
-Then create the keys (make sure to enter a secure password and do not just leave it blank)
-```
->  ssh-keygen -t rsa -b 4096 -f ~/.ssh/key1_rsa -C "[email protected]" 
+If you already have created a key in ~/.ssh/id_rsa (the default location), you may use that in place of the ~/.ssh/msmith key
+in my examples or you can leave that key and add additional keys for the other identities.
+
+Create the keys and ssh-add them (make sure to enter a secure password and do not just leave it blank)
+```bash
+$  ssh-keygen -t rsa -b 4096 -f ~/.ssh/key1_rsa -C "[email protected]" 
 Generating public/private rsa key pair.
-Enter passphrase (empty for no passphrase): 
+Enter passphrase (empty for no passphrase): ************
 Enter same passphrase again: 
 Your identification has been saved in /Users/me/.ssh/key1_rsa.
 Your public key has been saved in /Users/me/.ssh/key1_rsa.pub.
 The key fingerprint is:
 ...
+$  ssh-add ~/.ssh/key1_rsa
 
->  ssh-keygen -t rsa -b 4096 -f ~/.ssh/key2_rsa -C "[email protected]" 
+
+$  ssh-keygen -t rsa -b 4096 -f ~/.ssh/key2_rsa -C "[email protected]" 
 Generating public/private rsa key pair.
-Enter passphrase (empty for no passphrase): 
+Enter passphrase (empty for no passphrase): ************
 Enter same passphrase again: 
 Your identification has been saved in /Users/me/.ssh/key2_rsa.
 Your public key has been saved in /Users/me/.ssh/key2_rsa.pub.
 The key fingerprint is:
+...
+
+$ ssh-add ~/.ssh/key2_rsa
+```
+
+## 2. Setup ~/.ssh/config
+
+Create a file in ~/.ssh/config (if it does not already exist).  You must make sure it is readable only by the owner
+and the group and public bits are set off.
+```bash
+touch ~/.ssh/config
+chmod 600 ~/.ssh/config
+```
+
+We now need to add SSH configuration that specifies the github and bitbucket hostnames but with a suffix appended to qualify
+which key to use.  We set the `HostName` to the correct github.com or bitbucket.org address.
+
+```
+~/.ssh/config
+...
+
+Host github.com-msmith
+HostName github.com
+UseKeychain yes
+AddKeysToAgent yes
+User git
+IdentityFile ~/.ssh/msmith_rsa
+IdentitiesOnly
+
+Host bitbucket.org-msmith
+HostName bitbucket.org
+UseKeychain yes
+AddKeysToAgent yes
+User git
+IdentityFile ~/.ssh/msmith_rsa
+IdentitiesOnly
+
+Host github.com-jblige
+HostName github.com
+UseKeychain yes
+AddKeysToAgent yes
+User git
+IdentityFile ~/.ssh/jblige_rsa
+IdentitiesOnly
+
+Host bitbucket.org-jblige
+HostName bitbucket.org
+UseKeychain yes
+AddKeysToAgent yes
+User git
+IdentityFile ~/.ssh/jblige_rsa
+IdentitiesOnly
+
+...
+```
+## 3. Add public keys to GitHub and BitBucket
+
+Log into GitHub for each user and add the keys from ~/.ssh/xxxxx.pub to the respective users authorized SSH keys.
+
+For more information on this see:
+https://confluence.atlassian.com/bitbucket/set-up-an-ssh-key-728138079.html
+
+or
+
+
+https://help.github.com/en/articles/adding-a-new-ssh-key-to-your-github-account
+
+## 4. Create key specific .gitconfig
+
+Based on work from http://blog.bennycornelissen.nl.s3-website-eu-west-1.amazonaws.com/post/juggling-multiple-git-identities/
+
+You will need a single directory where all code that corresponds to a given key will be checked out to.
+
+I prefer to keep all those directories in one directory in my home `~/src` and I name them according to the account
+name associated with the key
+
+```bash
+mkdir -p ~/src/msmith
+mkdir -p ~/src/jblige
+```
+
+In each directory put a `.gitconfig` file.
+```
+~/src/msmith/.gitconfig
+...
+[user]
+  email = [email protected]
+    
+[url "[email protected]"]
+  insteadOf = [email protected]
+  
+[url "[email protected]"]
+  insteadOf = [email protected]
+```
+```
+~/src/jblige/.gitconfig
+...
+[user]
+  email = [email protected]
+  signingkey = ABCD1234
+  
+[url "[email protected]"]
+  insteadOf = [email protected]
+  
+[url "[email protected]"]
+  insteadOf = [email protected]
+  
+[commit]
+  gpgsign = true
+```
+This way, I use the correct email address for both keys and have even set up automatic commit signing for jblige.
+I also rewrite all the hostnames for the original SSH connections to the correctly suffixed hostnames I created
+in the SSH config file.
+
+For more information about GPG signing see:
+https://help.github.com/en/articles/signing-commits
+
+or
+
+https://confluence.atlassian.com/bitbucketserver/using-gpg-keys-913477014.html
+
+## 5. Setup Git config `includeif`
+
+To activate the .gitconfig files in ~/src/*, edit the .gitconfig file in your home directory and add an `includeif`
+statement for each of the .gitconfig files referencing the directory they are in
 ```
+~/.gitconfig
+...
+
+[includeif "gitdir:~/src/msmith/"]
+	path = ~/src/msmith/.gitconfig
+	
+[includeif "gitdir:~/src/jblige/"]
+	path = ~/src/jblige/.gitconfig
+	
+```
+
+## 6. Checkout
+
+You then clone the code using the SSH clone address (i.e. [email protected]... or [email protected]..., not https://bitbucket.org... nor https://github.com...)
+into the directory that corresponds to the key you want to use for that clone.
+
+```bash
+$  cd ~/src/msmith
+$  git clone [email protected]:someuser/somerepo.git
+...
+
+```
+
+Because of the rewriting, git will actually attempt to clone using the suffixed address corresponding to the configuration in
+the SSH config file but because of the SSH configuration it will use the original hostname when actually connecting to the host
+ensuring you use the right key.
+
+All commits/pulls/pushes to/from those repositories will use the corresponding config/key/account.
diff --git a/github_bitbucket_multiple_ssh_keys.md b/github_bitbucket_multiple_ssh_keys.md
@@ -0,0 +1,39 @@
+# Why Multiple SSH keys?
+
+There are numerous reasons you may need to use multiple SSH keys for accessing GitHub and BitBucket
+
+When acting as a consultant, it is common to have multiple Github and/or BitBucket accounts depending on which client you may be working for.
+
+You may use the same computer for work and personal development and need to separate your work.
+
+You may have different projects you're working on where you would like to segregate your access. 
+
+Either way, handling this in a standard Mac/linux PC setup is difficult.
+
+Use the following guide to ensure you code is easy to manage and checking out new repositories is not a hassle.
+
+## 1. Decide on how many keys you need and create them
+
+You will need one key for each different identity you will use on either GitHub or BitBucket.  
+Whichever site you have more identities with determines how many keys you will need.
+A single key can act both as a GitHub and BitBucket key but cannot be associated with more than one BitBucket or GitHub account.
+
+Then create the keys (make sure to enter a secure password and do not just leave it blank)
+```
+>  ssh-keygen -t rsa -b 4096 -f ~/.ssh/key1_rsa -C "[email protected]" 
+Generating public/private rsa key pair.
+Enter passphrase (empty for no passphrase): 
+Enter same passphrase again: 
+Your identification has been saved in /Users/me/.ssh/key1_rsa.
+Your public key has been saved in /Users/me/.ssh/key1_rsa.pub.
+The key fingerprint is:
+...
+
+>  ssh-keygen -t rsa -b 4096 -f ~/.ssh/key2_rsa -C "[email protected]" 
+Generating public/private rsa key pair.
+Enter passphrase (empty for no passphrase): 
+Enter same passphrase again: 
+Your identification has been saved in /Users/me/.ssh/key2_rsa.
+Your public key has been saved in /Users/me/.ssh/key2_rsa.pub.
+The key fingerprint is:
+```
No results found