diff options
Diffstat (limited to 'plugins/ssh-agent')
| -rw-r--r-- | plugins/ssh-agent/README.md | 34 | ||||
| -rw-r--r-- | plugins/ssh-agent/ssh-agent.plugin.zsh | 82 |
2 files changed, 98 insertions, 18 deletions
diff --git a/plugins/ssh-agent/README.md b/plugins/ssh-agent/README.md index 0b96d9bb5..aa96f9cc9 100644 --- a/plugins/ssh-agent/README.md +++ b/plugins/ssh-agent/README.md @@ -9,7 +9,7 @@ To enable it, add `ssh-agent` to your plugins: plugins=(... ssh-agent) ``` -## Instructions +## Settings **IMPORTANT: put these settings _before_ the line that sources oh-my-zsh** @@ -19,12 +19,24 @@ To enable **agent forwarding support** add the following to your zshrc file: zstyle :omz:plugins:ssh-agent agent-forwarding on ``` -To **load multiple identities** use the `identities` style, For example: +To **NOT load any identities on start** use the `lazy` style. +This is particularly usefull when combined with the AddKeysToAgent +(available from OpenSSH 7.2), since it allows to enter the password only +on first use. + +```zsh +zstyle :omz:plugins:ssh-agent lazy yes +``` + +To **load multiple identities** use the `identities` style. This have no +effect if `lazy` is enabled. ```zsh zstyle :omz:plugins:ssh-agent identities id_rsa id_rsa2 id_github ``` +---- + To **set the maximum lifetime of the identities**, use the `lifetime` style. The lifetime may be specified in seconds or as described in sshd_config(5) (see _TIME FORMATS_). If left unspecified, the default lifetime is forever. @@ -33,6 +45,24 @@ The lifetime may be specified in seconds or as described in sshd_config(5) zstyle :omz:plugins:ssh-agent lifetime 4h ``` +---- + +To **pass arguments to the `ssh-add` command** that adds the identities on startup, +use the `ssh-add-args` setting. You can pass multiple arguments separated by spaces: + +```zsh +zstyle :omz:plugins:ssh-agent ssh-add-args -K -c -a /run/user/1000/ssh-auth +``` + +These will then be passed the the `ssh-add` call as if written directly. The example +above will turn into: + +```zsh +ssh-add -K -c -a /run/user/1000/ssh-auth <identities> +``` + +For valid `ssh-add` arguments run `ssh-add --help` or `man ssh-add`. + ## Credits Based on code from Joseph M. Reagle: https://www.cygwin.com/ml/cygwin/2001-06/msg00537.html diff --git a/plugins/ssh-agent/ssh-agent.plugin.zsh b/plugins/ssh-agent/ssh-agent.plugin.zsh index fe4946c6d..494cf1393 100644 --- a/plugins/ssh-agent/ssh-agent.plugin.zsh +++ b/plugins/ssh-agent/ssh-agent.plugin.zsh @@ -1,36 +1,80 @@ -typeset _agent_forwarding _ssh_env_cache +lockdir=/tmp/oh-my-zsh-ssh-agent.lock + +while true; do + if mkdir "$lockdir" 2>/dev/null + then # directory did not exist, but was created successfully + trap 'rm -rf "$lockdir"' 0 # remove directory when script finishes + break # continue with script + else + sleep 0.1 # sleep for 0.2 and try again + fi +done + +typeset _ssh_env_cache function _start_agent() { local lifetime - local -a identities - - # start ssh-agent and setup environment zstyle -s :omz:plugins:ssh-agent lifetime lifetime + # start ssh-agent and setup environment + echo Starting ssh-agent... ssh-agent -s ${lifetime:+-t} ${lifetime} | sed 's/^echo/#echo/' >! $_ssh_env_cache chmod 600 $_ssh_env_cache . $_ssh_env_cache > /dev/null +} - # load identies +function _add_identities() { + local id line sig lines + local -a identities loaded_sigs loaded_ids not_loaded zstyle -a :omz:plugins:ssh-agent identities identities - echo starting ssh-agent... - ssh-add $HOME/.ssh/${^identities} + # check for .ssh folder presence + if [[ ! -d $HOME/.ssh ]]; then + return + fi + + # add default keys if no identities were set up via zstyle + # this is to mimic the call to ssh-add with no identities + if [[ ${#identities} -eq 0 ]]; then + # key list found on `ssh-add` man page's DESCRIPTION section + for id in id_rsa id_dsa id_ecdsa id_ed25519 identity; do + # check if file exists + [[ -f "$HOME/.ssh/$id" ]] && identities+=$id + done + fi + + # get list of loaded identities' signatures and filenames + if lines=$(ssh-add -l); then + for line in ${(f)lines}; do + loaded_sigs+=${${(z)line}[2]} + loaded_ids+=${${(z)line}[3]} + done + fi + + # add identities if not already loaded + for id in $identities; do + # check for filename match, otherwise try for signature match + if [[ ${loaded_ids[(I)$HOME/.ssh/$id]} -le 0 ]]; then + sig="$(ssh-keygen -lf "$HOME/.ssh/$id" | awk '{print $2}')" + [[ ${loaded_sigs[(I)$sig]} -le 0 ]] && not_loaded+="$HOME/.ssh/$id" + fi + done + + local args + zstyle -a :omz:plugins:ssh-agent ssh-add-args args + [[ -n "$not_loaded" ]] && ssh-add "${args[@]}" ${^not_loaded} } # Get the filename to store/lookup the environment from _ssh_env_cache="$HOME/.ssh/environment-$SHORT_HOST" -# test if agent-forwarding is enabled -zstyle -b :omz:plugins:ssh-agent agent-forwarding _agent_forwarding - -if [[ $_agent_forwarding == "yes" && -n "$SSH_AUTH_SOCK" ]]; then +if zstyle -t :omz:plugins:ssh-agent agent-forwarding && [[ -n "$SSH_AUTH_SOCK" ]]; then # Add a nifty symlink for screen/tmux if agent forwarding - [[ -L $SSH_AUTH_SOCK ]] || ln -sf "$SSH_AUTH_SOCK" /tmp/ssh-agent-$USER-screen + [[ -L $SSH_AUTH_SOCK ]] || ln -sf "$SSH_AUTH_SOCK" /tmp/ssh-agent-$USERNAME-screen elif [[ -f "$_ssh_env_cache" ]]; then # Source SSH settings, if applicable . $_ssh_env_cache > /dev/null - if [[ $USER == "root" ]]; then + if [[ $USERNAME == "root" ]]; then FILTER="ax" else FILTER="x" @@ -38,10 +82,16 @@ elif [[ -f "$_ssh_env_cache" ]]; then ps $FILTER | grep ssh-agent | grep -q $SSH_AGENT_PID || { _start_agent } -else +elif [[ -d $HOME/.ssh ]]; then _start_agent fi +if ! zstyle -t :omz:plugins:ssh-agent lazy; then + _add_identities +fi + # tidy up after ourselves -unset _agent_forwarding _ssh_env_cache -unfunction _start_agent +unset _ssh_env_cache +unfunction _start_agent _add_identities + +rm -rf "$lockdir" |