SSHELPER - Automagically creates and configures your SSH tokens for GitHub!

README.md

SSHelper.sh

This is a (at present, Mac-exclusive) command-line utility that will automatically perform all relevant steps required to get SSH up and running on your Mac with GitHub. It is a genuine, well-designed, superfine, one-time, one-line, benign, online, commandline goldmine to streamline your storyline and leave you on cloud-nine!

Oh, and it performs the following activities:

1. Create an SSH key on your local machine
2. Activate the SSH Agent
3. Create/amend your SSH config file to contain the newly-created key
4. Amend your system keychain to contain the new key
5. Add the public portion of said key to your GitHub account

Installation

Download this file to your home ($HOME/~) directory, then, from your bash terminal of choice:

source $HOME/SSHelper.sh

That's it! Follow the on-screen prompts and your hand will be held to completion of the task! No Googling, no arcane commands, no surprise, no buillshit!

After it has completed, you may feel free to delete the file (rm $HOME/SSHelper.sh), or leave it there for the next time the nuisance arises!

Bugs/Concerns/Requests

Feel free to report any wrongs, worries, or wishes right here, and I'll tackle 'em as they come in! Thanks!

Open Source License

License type: Offensive Limerick

---

Made with <code> by @JJ / Nerdy Deeds, LLC in 2022

SSHelper.sh

#!/bin/bash

export GH_EMAIL
export KEY_NAME

function testGithub {
    if [[ "$(ssh -qp 443 [email protected]  2>&1 | grep .)" == "" || "$1" != "" ]]; then
        clear
        printf "UH-OH! It appears you've not yet set up an SSH token for GitHub! \n\n   - Shall we address that now? [ (Y)es / (N)o ] > " 
        read -r BEGIN 
        if [[ "$(echo $BEGIN | sed -E "s/^[yY].*/Y/" | sed -E "s/[nN].*/N/" | sed -E "s/^[^YN].*/X/")" != "Y" ]]; then
            clear
            echo -e "\nOkay, you can always set it up later by re-running this script with the command:\n\n     $ source '$HOME/sshelper.sh'\n"
            return 0 
        else
            echo -e "\nCan do! Starting SSH creation/registration subroutine!"
            echo -e "\n\nLet's gather your system password now, so you don't need to babysit."
            sudo echo "Got it!"
            printf "\n\nTesting for GitHub command line utilities..."
            if [[ "$(gh --version)" != "" ]]; then 
                printf "done."
            else
                printf "not found! Installing..."
                brew install gh --quiet
            fi
            gatherData;
        fi
    else
        echo -e "\n\nSSH connections to GitHub detected and appears functional." 
        return 0
    fi
}

function primeRelevantPaths {
    [ ! -e "$HOME/.ssh" ]  && mkdir "$HOME/.ssh"
    [ ! -f ~/.ssh/config ] && touch "$HOME/.ssh/config"
}

function gatherData {
    echo -e "\nGotta collect some basic details to start, here:"
    printf "\n - What is the [EMAIL ADDRESS] you use to access GitHub?\n   Enter an email or hit <ENTER> to use '%s'.\n\n      [EMAIL ADDRESS] > " "$(git config user.email)" && tput sc  && read -r GH_EMAIL
    [[ "$GH_EMAIL" == "" ]] && GH_EMAIL="$(git config user.email)" && tput rc && printf "%s" "$GH_EMAIL"
    
    printf "\n\n\n - What would you like to [NAME YOUR KEYFILE]?\n   Enter a filename or hit <Enter> to use '%s'.\n\n     [KEYFILE NAME] > " "$(echo "$GH_EMAIL" | sed -E 's/@.*//g' | sed -E 's/[\.!@#$%^&*()-]/_/g')" && tput sc && read -r KEY_NAME
    [[ "$KEY_NAME" == "" ]] && KEY_NAME="$(echo "$GH_EMAIL" | sed -E 's/@.*//g' | sed -E 's/[\.\!\@\#\$\%\^\&\*\(\)\-]/_/g')" && tput rc && printf "%s" "$KEY_NAME"
    createKey
}

function createKey {
    printf "\n\nCreating paths..." && primeRelevantPaths && printf "done."
    echo -e "\n\nGenerating key..." && ssh-keygen -t ed25519 -C "$GH_EMAIL" -f "$HOME/.ssh/$KEY_NAME" -N '' && printf "\ndone."
    echo -e "\n\nActivating agent..." && eval "$(ssh-agent -s)" && printf "done."
    echo -e "\n\nAmending keychain..."
    cat <<- EOD >> $HOME/.ssh/config
Host *.github.com
  AddKeysToAgent yes
  UseKeychain yes
  IdentityFile ~/.ssh/$KEY_NAME
EOD
    printf "done.\n\n\nFinally, we need to add the newly-created token to your GitHub account.\n\n   - How would you like to do so? [ (A)utomatically / (M)anually / (C)ancel ]> "
    read -r KEY_INSTALL_METHOD
    case "$(echo "$KEY_INSTALL_METHOD" | head -c 1)" in
        ('A'|'a')   printf "You got it! Follow the next couple prompts, copy the on-screen code when prompted to do so, then a browser window will open. Paste in your code, approve the request, and you're all set!\n\nHit <Enter> to continue."
                    read -r 2>&1
                    gh auth login -p ssh -h github.com -w 
                    printf "Done and done! Looks like you're done with, as well, then!"
                    return 0;;
        ('M'|'m')   printf "\nAs you like! Would you like me to open a browser to the correct page in GitHub, and copy your newly-generated public key to your pasteboard for you? \n\n   - Copy the key and open a browser?  [ (Y)es / (N)o ] > "
                    read -r HALFAUTO
                    case "$(echo "$HALFAUTO" | head -c 1)" in
                        ('Y'|'y') printf "Done and done! Looks like you're done with me, then!"
                                  pbcopy < "$HOME/.ssh/$KEY_NAME.pub"
                                  open "https://github.com/settings/keys"
                                  exit 0 ;;
                        (*)       printf "Fair enough! Looks like you're done with me, then!" && return 0 ;;
                    esac 
                    printf "Done and done! Looks like you're done with, as well, then!"
                    return 0;;
        (*)         printf "Fair enough! Looks like you're done with me, then!" && return 0 ;;
    esac
}

testGithub "$*"