-
Notifications
You must be signed in to change notification settings - Fork 101
/
ssh-find-agent.sh
executable file
·260 lines (228 loc) · 7.16 KB
/
ssh-find-agent.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
#!/bin/bash
# Copyright (C) 2011 by Wayne Walker <[email protected]>
#
# Released under one of the versions of the MIT License.
#
# Copyright (C) 2011 by Wayne Walker <[email protected]>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
sfa_init() {
_ssh_agent_sockets=()
_live_agent_list=()
_live_agent_sock_list=()
_sorted_live_agent_list=()
_sfa_timeout=1.0
# Set $sfa_path array to the dirs to search for ssh-agent sockets
sfa_set_path
if ! command -v 'timeout' &>/dev/null; then
printf "ssh-find-agent.sh: 'timeout' command could not be found.\n"
printf " Please install 'coreutils' via your system's package manager.\n"
fi
}
# Allow users to override the default path to search for ssh-agent sockets
# The first of the variable found is used to set the path:
# SSH_FIND_AGENT_PATH (colon separated dir list)
# _TMPDIR_OVERRIDE for legacy compatibility
# TMPDIR (if set) (plus /tmp due to ssh bug)
sfa_set_path() {
sfa_path=()
if [[ -n "$SSH_FIND_AGENT_PATH" ]]; then
IFS=':' read -r -a sfa_path <<<"$SSH_FIND_AGENT_PATH"
else
# Maintain backwards compatibility with the old _TMPDIR_OVERRIDE variable
if [[ -n "$_TMPDIR_OVERRIDE" ]]; then
sfa_path=("$_TMPDIR_OVERRIDE")
else
if [[ -n "$TMPDIR" ]]; then
sfa_path=("/tmp" "$TMPDIR")
else
sfa_path=("/tmp")
fi
fi
fi
}
sfa_err() {
# shellcheck disable=SC2059
printf "$@" 1>&2
}
sfa_debug() {
if ((_DEBUG > 0)); then
sfa_err "$@" 1>&2
fi
}
sfa_find_all_agent_sockets() {
_ssh_agent_sockets=($(
find "${sfa_path[@]}" -maxdepth 2 -type s -name agent.\* \
-o -name S.gpg-agent.ssh -o -name ssh -o -regex '.*/ssh-.*/agent..*$' \
2>/dev/null | grep -E \
'/ssh-.*/agent.*|/gpg- .*/S.gpg-agent.ssh|/keyring-.*/ssh$|.*/ssh-.*/agent..*$'
))
sfa_debug "${_ssh_agent_sockets[@]}"
}
sfa_test_agent_socket() {
local socket=$1
local output
output=$(SSH_AUTH_SOCK=$socket timeout "$_sfa_timeout" ssh-add -l 2>&1)
result=$?
[[ "$output" == "error fetching identities: communication with agent failed" ]] && result=2
sfa_debug $result
case $result in
0 | 1 | 141)
# contactible and has keys loaded
{
OIFS="$IFS"
IFS=$'\n'
# shellcheck disable=SC2207
_keys=($(SSH_AUTH_SOCK=$socket ssh-add -l 2>/dev/null))
IFS="$OIFS"
}
_live_agent_list+=("${#_keys[@]}:$socket")
return 0
;;
2 | 124)
# socket is dead, delete it
sfa_err 'socket (%s) is dead, removing it.\n' "$socket"
sfa_debug "rm -rf ${socket%/*}"
rm -rf "${socket%/*}"
;;
125 | 126 | 127)
sfa_err 'timeout returned <%s>\n' "$result" 1>&2
;;
*)
sfa_err 'Unknown failure timeout returned <%s>\n' "$result" 1>&2
;;
esac
case $result in
0 | 1)
_live_agent_list+=("$_key_count:$socket")
return 0
;;
esac
return 1
}
sfa_verify_sockets() {
for i in "${_ssh_agent_sockets[@]}"; do
sfa_test_agent_socket "$i"
done
}
sfa_fingerprints() {
local file="$1"
while read -r l; do
[[ -n "$l" && ${l##\#} = "$l" ]] && ssh-keygen -l -f /dev/stdin <<<"$l"
done <"$file"
}
sfa_print_choose_menu() {
# find all the apparent socket files
# the sockets go into $_ssh_agent_sockets[]
sfa_find_all_agent_sockets
# verify each socket, discarding if dead
# the live sockets go into $_live_agent_list[]
sfa_verify_sockets
sfa_debug '<%s>\n' "${_live_agent_list[@]}"
# shellcheck disable=SC2207
IFS=$'\n' _sorted_live_agent_list=($(sort -u <<<"${_live_agent_list[*]}"))
unset IFS
sfa_debug "SORTED:\n"
sfa_debug ' <%s>\n' "${_sorted_live_agent_list[@]}"
local i=0
local sock
for agent in "${_sorted_live_agent_list[@]}"; do
i=$((i + 1))
sock=${agent/*:/}
if [[ "$1" = "-i" ]]; then
_live_agent_sock_list[i]=$sock
printf '#%i)\n' "$i"
printf ' export SSH_AUTH_SOCK=%s\n' "$sock"
# Get all the forwarded keys for this agent, parse them and print them
SSH_AUTH_SOCK=$sock ssh-add -l 2>&1 |
grep -v 'error fetching identities for protocol 1: agent refused operation' |
while IFS= read -r key; do
parts=("$key")
key_size="${parts[0]}"
fingerprint="${parts[1]}"
remote_name="${parts[2]}"
key_type="${parts[3]}"
printf ' %s %s\t%s\t%s\n' "$key_size" "$key_type" "$remote_name" "$fingerprint"
done
else
printf '%s\n' "$sock"
fi
done
}
sfa_set_ssh_agent_socket() {
case $1 in
-c | --choose)
sfa_print_choose_menu -i
((0 == ${#_live_agent_list[@]})) && {
sfa_err 'No agents found.\n'
return 1
}
read -p "Choose (1-${#_live_agent_sock_list[@]})? " -r choice
if [ "$choice" -eq "$choice" ]; then
[[ -z "${_live_agent_sock_list[$choice]}" ]] && {
sfa_err 'Invalid choice.\n'
return 1
}
printf 'Setting export SSH_AUTH_SOCK=%s\n' "${_live_agent_sock_list[$choice]}"
export SSH_AUTH_SOCK=${_live_agent_sock_list[$choice]}
fi
;;
-a | --auto)
# Choose the last one, as they are sorted numerically by how many keys they have
sock=$(sfa_print_choose_menu | tail -n -1)
[[ -z "$sock" ]] && return 1
sfa_debug 'export SSH_AUTH_SOCK=%s\n' "$sock"
export SSH_AUTH_SOCK=$sock
;;
*)
sfa_usage
;;
esac
# set agent pid - this is unreliable as the pid may be of the child rather than the agent
if [ -n "$SSH_AUTH_SOCK" ]; then
export SSH_AGENT_PID=$(($(basename "$SSH_AUTH_SOCK" | cut -d. -f2) + 1))
fi
return 0
}
sfa_usage() {
sfa_err 'ssh-find-agent <[-c|--choose|-a|--auto|-h|--help]>\n'
return 1
}
# Renamed for https://github.com/wwalker/ssh-find-agent/issues/12
ssh_find_agent() {
sfa_init
case $1 in
-c | --choose | -a | --auto)
sfa_set_ssh_agent_socket "$1"
return $?
;;
-l | --list)
sfa_print_choose_menu -i
;;
*)
sfa_usage
;;
esac
}
# Original function name is still supported.
# https://github.com/wwalker/ssh-find-agent/issues/12 points out that I
# should use ssh_find_agent() for best compatibility.
ssh-find-agent() {
ssh_find_agent "$@"
}