Customization/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-11 00:10:08 +00:00
Code Releases Activity

feat(ssh-agent): allow using external helper to ask for passwords (#7631)

Browse source
This commit is contained in:
Simone Gaiarin 2021-08-26 11:42:17 +02:00 committed by GitHub
parent c47ac2d86d
commit 5a9d9553cd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 83 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
plugins/ssh-agent/README.md
View file

@ -55,6 +55,15 @@ ssh-add -K -c -a /run/user/1000/ssh-auth <identities>
For valid `ssh-add` arguments run `ssh-add --help` or `man ssh-add`. For valid `ssh-add` arguments run `ssh-add --help` or `man ssh-add`.
----
To set an **external helper** to ask for the passwords and possibly store
them in the system keychain use the `helper` style. For example:
```zsh
zstyle :omz:plugins:ssh-agent helper ksshaskpass
```
## Credits ## Credits
Based on code from Joseph M. Reagle: https://www.cygwin.com/ml/cygwin/2001-06/msg00537.html Based on code from Joseph M. Reagle: https://www.cygwin.com/ml/cygwin/2001-06/msg00537.html

128
plugins/ssh-agent/ssh-agent.plugin.zsh
View file

@ -1,56 +1,76 @@
typeset _agent_forwarding _ssh_env_cache typeset _agent_forwarding _ssh_env_cache
function _start_agent() { function _start_agent() {
local lifetime local lifetime
zstyle -s :omz:plugins:ssh-agent lifetime lifetime zstyle -s :omz:plugins:ssh-agent lifetime lifetime
# start ssh-agent and setup environment # start ssh-agent and setup environment
echo Starting ssh-agent... echo Starting ssh-agent...
ssh-agent -s ${lifetime:+-t} ${lifetime} | sed 's/^echo/#echo/' >! $_ssh_env_cache ssh-agent -s ${lifetime:+-t} ${lifetime} | sed 's/^echo/#echo/' >! $_ssh_env_cache
chmod 600 $_ssh_env_cache chmod 600 $_ssh_env_cache
. $_ssh_env_cache > /dev/null . $_ssh_env_cache > /dev/null
} }
function _add_identities() { function _add_identities() {
local id line sig lines local id line sig lines
local -a identities loaded_sigs loaded_ids not_loaded local -a identities loaded_sigs loaded_ids not_loaded
zstyle -a :omz:plugins:ssh-agent identities identities zstyle -a :omz:plugins:ssh-agent identities identities
# check for .ssh folder presence # check for .ssh folder presence
if [[ ! -d $HOME/.ssh ]]; then if [[ ! -d $HOME/.ssh ]]; then
return return
fi fi
# add default keys if no identities were set up via zstyle # add default keys if no identities were set up via zstyle
# this is to mimic the call to ssh-add with no identities # this is to mimic the call to ssh-add with no identities
if [[ ${#identities} -eq 0 ]]; then if [[ ${#identities} -eq 0 ]]; then
# key list found on `ssh-add` man page's DESCRIPTION section # key list found on `ssh-add` man page's DESCRIPTION section
for id in id_rsa id_dsa id_ecdsa id_ed25519 identity; do for id in id_rsa id_dsa id_ecdsa id_ed25519 identity; do
# check if file exists # check if file exists
[[ -f "$HOME/.ssh/$id" ]] && identities+=$id [[ -f "$HOME/.ssh/$id" ]] && identities+=($id)
done done
fi fi
# get list of loaded identities' signatures and filenames # get list of loaded identities' signatures and filenames
if lines=$(ssh-add -l); then if lines=$(ssh-add -l); then
for line in ${(f)lines}; do for line in ${(f)lines}; do
loaded_sigs+=${${(z)line}[2]} loaded_sigs+=${${(z)line}[2]}
loaded_ids+=${${(z)line}[3]} loaded_ids+=${${(z)line}[3]}
done done
fi fi
# add identities if not already loaded # add identities if not already loaded
for id in $identities; do for id in $identities; do
# check for filename match, otherwise try for signature match # check for filename match, otherwise try for signature match
if [[ ${loaded_ids[(I)$HOME/.ssh/$id]} -le 0 ]]; then if [[ ${loaded_ids[(I)$HOME/.ssh/$id]} -le 0 ]]; then
sig="$(ssh-keygen -lf "$HOME/.ssh/$id" | awk '{print $2}')" sig="$(ssh-keygen -lf "$HOME/.ssh/$id" | awk '{print $2}')"
[[ ${loaded_sigs[(I)$sig]} -le 0 ]] && not_loaded+="$HOME/.ssh/$id" [[ ${loaded_sigs[(I)$sig]} -le 0 ]] && not_loaded+=("$HOME/.ssh/$id")
fi fi
done done
local args # abort if no identities need to be loaded
zstyle -a :omz:plugins:ssh-agent ssh-add-args args if [[ ${#not_loaded} -eq 0 ]]; then
[[ -n "$not_loaded" ]] && ssh-add "${args[@]}" ${^not_loaded} return
fi
# pass extra arguments to ssh-add
local args
zstyle -a :omz:plugins:ssh-agent ssh-add-args args
# use user specified helper to ask for password (ksshaskpass, etc)
local helper
zstyle -s :omz:plugins:ssh-agent helper helper
if [[ -n "$helper" ]]; then
if [[ -z "${commands[$helper]}" ]]; then
echo "ssh-agent: the helper '$helper' has not been found."
else
SSH_ASKPASS="$helper" ssh-add "${args[@]}" ${^not_loaded} < /dev/null
return $?
fi
fi
ssh-add "${args[@]}" ${^not_loaded}
} }
# Get the filename to store/lookup the environment from # Get the filename to store/lookup the environment from
@ -60,21 +80,21 @@ _ssh_env_cache="$HOME/.ssh/environment-$SHORT_HOST"
zstyle -b :omz:plugins:ssh-agent agent-forwarding _agent_forwarding zstyle -b :omz:plugins:ssh-agent agent-forwarding _agent_forwarding
if [[ $_agent_forwarding == "yes" && -n "$SSH_AUTH_SOCK" ]]; then if [[ $_agent_forwarding == "yes" && -n "$SSH_AUTH_SOCK" ]]; then
# Add a nifty symlink for screen/tmux if agent forwarding # Add a nifty symlink for screen/tmux if agent forwarding
[[ -L $SSH_AUTH_SOCK ]] || ln -sf "$SSH_AUTH_SOCK" /tmp/ssh-agent-$USERNAME-screen [[ -L $SSH_AUTH_SOCK ]] || ln -sf "$SSH_AUTH_SOCK" /tmp/ssh-agent-$USERNAME-screen
elif [[ -f "$_ssh_env_cache" ]]; then elif [[ -f "$_ssh_env_cache" ]]; then
# Source SSH settings, if applicable # Source SSH settings, if applicable
. $_ssh_env_cache > /dev/null . $_ssh_env_cache > /dev/null
if [[ $USERNAME == "root" ]]; then if [[ $USERNAME == "root" ]]; then
FILTER="ax" FILTER="ax"
else else
FILTER="x" FILTER="x"
fi fi
ps $FILTER | grep ssh-agent | grep -q $SSH_AGENT_PID || { ps $FILTER | grep ssh-agent | grep -q $SSH_AGENT_PID || {
_start_agent _start_agent
} }
else else
_start_agent _start_agent
fi fi
_add_identities _add_identities