root / lib / ssh.py @ 0376655e
History | View | Annotate | Download (8.6 kB)
1 | 2f31098c | Iustin Pop | #
|
---|---|---|---|
2 | a8083063 | Iustin Pop | #
|
3 | a8083063 | Iustin Pop | |
4 | ebcd61bb | Iustin Pop | # Copyright (C) 2006, 2007, 2010, 2011 Google Inc.
|
5 | a8083063 | Iustin Pop | #
|
6 | a8083063 | Iustin Pop | # This program is free software; you can redistribute it and/or modify
|
7 | a8083063 | Iustin Pop | # it under the terms of the GNU General Public License as published by
|
8 | a8083063 | Iustin Pop | # the Free Software Foundation; either version 2 of the License, or
|
9 | a8083063 | Iustin Pop | # (at your option) any later version.
|
10 | a8083063 | Iustin Pop | #
|
11 | a8083063 | Iustin Pop | # This program is distributed in the hope that it will be useful, but
|
12 | a8083063 | Iustin Pop | # WITHOUT ANY WARRANTY; without even the implied warranty of
|
13 | a8083063 | Iustin Pop | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
14 | a8083063 | Iustin Pop | # General Public License for more details.
|
15 | a8083063 | Iustin Pop | #
|
16 | a8083063 | Iustin Pop | # You should have received a copy of the GNU General Public License
|
17 | a8083063 | Iustin Pop | # along with this program; if not, write to the Free Software
|
18 | a8083063 | Iustin Pop | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
19 | a8083063 | Iustin Pop | # 02110-1301, USA.
|
20 | a8083063 | Iustin Pop | |
21 | a8083063 | Iustin Pop | |
22 | a8083063 | Iustin Pop | """Module encapsulating ssh functionality.
|
23 | a8083063 | Iustin Pop |
|
24 | a8083063 | Iustin Pop | """
|
25 | a8083063 | Iustin Pop | |
26 | a8083063 | Iustin Pop | |
27 | a8083063 | Iustin Pop | import os |
28 | 9c034cbe | Iustin Pop | import logging |
29 | 33993ab8 | René Nussbaumer | import re |
30 | a8083063 | Iustin Pop | |
31 | a8083063 | Iustin Pop | from ganeti import utils |
32 | a8083063 | Iustin Pop | from ganeti import errors |
33 | 82122173 | Iustin Pop | from ganeti import constants |
34 | 8062638d | Manuel Franceschini | from ganeti import netutils |
35 | 82122173 | Iustin Pop | |
36 | 82122173 | Iustin Pop | |
37 | 33993ab8 | René Nussbaumer | def FormatParamikoFingerprint(fingerprint): |
38 | 697a3d61 | Manuel Franceschini | """Format paramiko PKey fingerprint.
|
39 | 33993ab8 | René Nussbaumer |
|
40 | 33993ab8 | René Nussbaumer | @type fingerprint: str
|
41 | 33993ab8 | René Nussbaumer | @param fingerprint: PKey fingerprint
|
42 | 697a3d61 | Manuel Franceschini | @return: The string hex representation of the fingerprint
|
43 | 33993ab8 | René Nussbaumer |
|
44 | 33993ab8 | René Nussbaumer | """
|
45 | 33993ab8 | René Nussbaumer | assert len(fingerprint) % 2 == 0 |
46 | 33993ab8 | René Nussbaumer | return ":".join(re.findall(r"..", fingerprint.lower())) |
47 | 33993ab8 | René Nussbaumer | |
48 | 33993ab8 | René Nussbaumer | |
49 | 70d9e3d8 | Iustin Pop | def GetUserFiles(user, mkdir=False): |
50 | 70d9e3d8 | Iustin Pop | """Return the paths of a user's ssh files.
|
51 | 70d9e3d8 | Iustin Pop |
|
52 | 70d9e3d8 | Iustin Pop | The function will return a triplet (priv_key_path, pub_key_path,
|
53 | 70d9e3d8 | Iustin Pop | auth_key_path) that are used for ssh authentication. Currently, the
|
54 | 70d9e3d8 | Iustin Pop | keys used are DSA keys, so this function will return:
|
55 | 70d9e3d8 | Iustin Pop | (~user/.ssh/id_dsa, ~user/.ssh/id_dsa.pub,
|
56 | 70d9e3d8 | Iustin Pop | ~user/.ssh/authorized_keys).
|
57 | 70d9e3d8 | Iustin Pop |
|
58 | 70d9e3d8 | Iustin Pop | If the optional parameter mkdir is True, the ssh directory will be
|
59 | 70d9e3d8 | Iustin Pop | created if it doesn't exist.
|
60 | 70d9e3d8 | Iustin Pop |
|
61 | 70d9e3d8 | Iustin Pop | Regardless of the mkdir parameters, the script will raise an error
|
62 | 70d9e3d8 | Iustin Pop | if ~user/.ssh is not a directory.
|
63 | 70d9e3d8 | Iustin Pop |
|
64 | 70d9e3d8 | Iustin Pop | """
|
65 | 70d9e3d8 | Iustin Pop | user_dir = utils.GetHomeDir(user) |
66 | 70d9e3d8 | Iustin Pop | if not user_dir: |
67 | 70d9e3d8 | Iustin Pop | raise errors.OpExecError("Cannot resolve home of user %s" % user) |
68 | 70d9e3d8 | Iustin Pop | |
69 | c4feafe8 | Iustin Pop | ssh_dir = utils.PathJoin(user_dir, ".ssh")
|
70 | 5bae14d9 | Guido Trotter | if mkdir:
|
71 | 5bae14d9 | Guido Trotter | utils.EnsureDirs([(ssh_dir, constants.SECURE_DIR_MODE)]) |
72 | 70d9e3d8 | Iustin Pop | elif not os.path.isdir(ssh_dir): |
73 | 898a6d45 | Michael Hanselmann | raise errors.OpExecError("Path %s is not a directory" % ssh_dir) |
74 | 70d9e3d8 | Iustin Pop | |
75 | c4feafe8 | Iustin Pop | return [utils.PathJoin(ssh_dir, base)
|
76 | 70d9e3d8 | Iustin Pop | for base in ["id_dsa", "id_dsa.pub", "authorized_keys"]] |
77 | 70d9e3d8 | Iustin Pop | |
78 | 70d9e3d8 | Iustin Pop | |
79 | c92b310a | Michael Hanselmann | class SshRunner: |
80 | c92b310a | Michael Hanselmann | """Wrapper for SSH commands.
|
81 | a8083063 | Iustin Pop |
|
82 | a8083063 | Iustin Pop | """
|
83 | b43dcc5a | Manuel Franceschini | def __init__(self, cluster_name, ipv6=False): |
84 | b43dcc5a | Manuel Franceschini | """Initializes this class.
|
85 | b43dcc5a | Manuel Franceschini |
|
86 | b43dcc5a | Manuel Franceschini | @type cluster_name: str
|
87 | b43dcc5a | Manuel Franceschini | @param cluster_name: name of the cluster
|
88 | b43dcc5a | Manuel Franceschini | @type ipv6: bool
|
89 | b43dcc5a | Manuel Franceschini | @param ipv6: If true, force ssh to use IPv6 addresses only
|
90 | b43dcc5a | Manuel Franceschini |
|
91 | b43dcc5a | Manuel Franceschini | """
|
92 | 56bece1f | Iustin Pop | self.cluster_name = cluster_name
|
93 | b43dcc5a | Manuel Franceschini | self.ipv6 = ipv6
|
94 | 1ff08570 | Michael Hanselmann | |
95 | 652d6694 | Michael Hanselmann | def _BuildSshOptions(self, batch, ask_key, use_cluster_key, |
96 | 2892a4c9 | Iustin Pop | strict_host_check, private_key=None, quiet=True): |
97 | bf75f132 | Iustin Pop | """Builds a list with needed SSH options.
|
98 | bf75f132 | Iustin Pop |
|
99 | bf75f132 | Iustin Pop | @param batch: same as ssh's batch option
|
100 | bf75f132 | Iustin Pop | @param ask_key: allows ssh to ask for key confirmation; this
|
101 | bf75f132 | Iustin Pop | parameter conflicts with the batch one
|
102 | bf75f132 | Iustin Pop | @param use_cluster_key: if True, use the cluster name as the
|
103 | bf75f132 | Iustin Pop | HostKeyAlias name
|
104 | bf75f132 | Iustin Pop | @param strict_host_check: this makes the host key checking strict
|
105 | 4403ff8d | René Nussbaumer | @param private_key: use this private key instead of the default
|
106 | 2892a4c9 | Iustin Pop | @param quiet: whether to enable -q to ssh
|
107 | bf75f132 | Iustin Pop |
|
108 | bf75f132 | Iustin Pop | @rtype: list
|
109 | a4ccecf6 | Michael Hanselmann | @return: the list of options ready to use in L{utils.process.RunCmd}
|
110 | bf75f132 | Iustin Pop |
|
111 | bf75f132 | Iustin Pop | """
|
112 | f6d9f4c3 | Michael Hanselmann | options = [ |
113 | f6d9f4c3 | Michael Hanselmann | "-oEscapeChar=none",
|
114 | f6d9f4c3 | Michael Hanselmann | "-oHashKnownHosts=no",
|
115 | f6d9f4c3 | Michael Hanselmann | "-oGlobalKnownHostsFile=%s" % constants.SSH_KNOWN_HOSTS_FILE,
|
116 | f6d9f4c3 | Michael Hanselmann | "-oUserKnownHostsFile=/dev/null",
|
117 | b427788e | Iustin Pop | "-oCheckHostIp=no",
|
118 | f6d9f4c3 | Michael Hanselmann | ] |
119 | f6d9f4c3 | Michael Hanselmann | |
120 | f6d9f4c3 | Michael Hanselmann | if use_cluster_key:
|
121 | 56bece1f | Iustin Pop | options.append("-oHostKeyAlias=%s" % self.cluster_name) |
122 | f6d9f4c3 | Michael Hanselmann | |
123 | 2892a4c9 | Iustin Pop | if quiet:
|
124 | 2892a4c9 | Iustin Pop | options.append("-q")
|
125 | 2892a4c9 | Iustin Pop | |
126 | 4403ff8d | René Nussbaumer | if private_key:
|
127 | 4403ff8d | René Nussbaumer | options.append("-i%s" % private_key)
|
128 | 4403ff8d | René Nussbaumer | |
129 | 652d6694 | Michael Hanselmann | # TODO: Too many boolean options, maybe convert them to more descriptive
|
130 | 652d6694 | Michael Hanselmann | # constants.
|
131 | 652d6694 | Michael Hanselmann | |
132 | f6d9f4c3 | Michael Hanselmann | # Note: ask_key conflicts with batch mode
|
133 | f6d9f4c3 | Michael Hanselmann | if batch:
|
134 | f6d9f4c3 | Michael Hanselmann | if ask_key:
|
135 | f6d9f4c3 | Michael Hanselmann | raise errors.ProgrammerError("SSH call requested conflicting options") |
136 | f6d9f4c3 | Michael Hanselmann | |
137 | 652d6694 | Michael Hanselmann | options.append("-oBatchMode=yes")
|
138 | 652d6694 | Michael Hanselmann | |
139 | 652d6694 | Michael Hanselmann | if strict_host_check:
|
140 | 652d6694 | Michael Hanselmann | options.append("-oStrictHostKeyChecking=yes")
|
141 | 652d6694 | Michael Hanselmann | else:
|
142 | 652d6694 | Michael Hanselmann | options.append("-oStrictHostKeyChecking=no")
|
143 | f6d9f4c3 | Michael Hanselmann | |
144 | e66d9f1a | Iustin Pop | else:
|
145 | e66d9f1a | Iustin Pop | # non-batch mode
|
146 | e66d9f1a | Iustin Pop | |
147 | e66d9f1a | Iustin Pop | if ask_key:
|
148 | e66d9f1a | Iustin Pop | options.append("-oStrictHostKeyChecking=ask")
|
149 | e66d9f1a | Iustin Pop | elif strict_host_check:
|
150 | e66d9f1a | Iustin Pop | options.append("-oStrictHostKeyChecking=yes")
|
151 | e66d9f1a | Iustin Pop | else:
|
152 | e66d9f1a | Iustin Pop | options.append("-oStrictHostKeyChecking=no")
|
153 | f6d9f4c3 | Michael Hanselmann | |
154 | b43dcc5a | Manuel Franceschini | if self.ipv6: |
155 | b43dcc5a | Manuel Franceschini | options.append("-6")
|
156 | b43dcc5a | Manuel Franceschini | |
157 | f6d9f4c3 | Michael Hanselmann | return options
|
158 | 1ff08570 | Michael Hanselmann | |
159 | 8f07f831 | Michael Hanselmann | def BuildCmd(self, hostname, user, command, batch=True, ask_key=False, |
160 | 4403ff8d | René Nussbaumer | tty=False, use_cluster_key=True, strict_host_check=True, |
161 | 2892a4c9 | Iustin Pop | private_key=None, quiet=True): |
162 | c92b310a | Michael Hanselmann | """Build an ssh command to execute a command on a remote node.
|
163 | c92b310a | Michael Hanselmann |
|
164 | c41eea6e | Iustin Pop | @param hostname: the target host, string
|
165 | c41eea6e | Iustin Pop | @param user: user to auth as
|
166 | c41eea6e | Iustin Pop | @param command: the command
|
167 | c41eea6e | Iustin Pop | @param batch: if true, ssh will run in batch mode with no prompting
|
168 | c41eea6e | Iustin Pop | @param ask_key: if true, ssh will run with
|
169 | c41eea6e | Iustin Pop | StrictHostKeyChecking=ask, so that we can connect to an
|
170 | c41eea6e | Iustin Pop | unknown host (not valid in batch mode)
|
171 | c41eea6e | Iustin Pop | @param use_cluster_key: whether to expect and use the
|
172 | c41eea6e | Iustin Pop | cluster-global SSH key
|
173 | c41eea6e | Iustin Pop | @param strict_host_check: whether to check the host's SSH key at all
|
174 | 4403ff8d | René Nussbaumer | @param private_key: use this private key instead of the default
|
175 | 2892a4c9 | Iustin Pop | @param quiet: whether to enable -q to ssh
|
176 | c41eea6e | Iustin Pop |
|
177 | c41eea6e | Iustin Pop | @return: the ssh call to run 'command' on the remote host.
|
178 | c92b310a | Michael Hanselmann |
|
179 | c92b310a | Michael Hanselmann | """
|
180 | 2892a4c9 | Iustin Pop | argv = [constants.SSH] |
181 | 652d6694 | Michael Hanselmann | argv.extend(self._BuildSshOptions(batch, ask_key, use_cluster_key,
|
182 | 2892a4c9 | Iustin Pop | strict_host_check, private_key, |
183 | 2892a4c9 | Iustin Pop | quiet=quiet)) |
184 | 8f07f831 | Michael Hanselmann | if tty:
|
185 | f724a702 | Balazs Lecz | argv.extend(["-t", "-t"]) |
186 | c92b310a | Michael Hanselmann | argv.extend(["%s@%s" % (user, hostname), command])
|
187 | c92b310a | Michael Hanselmann | return argv
|
188 | c92b310a | Michael Hanselmann | |
189 | 54ab6aec | Michael Hanselmann | def Run(self, *args, **kwargs): |
190 | c92b310a | Michael Hanselmann | """Runs a command on a remote node.
|
191 | c92b310a | Michael Hanselmann |
|
192 | c92b310a | Michael Hanselmann | This method has the same return value as `utils.RunCmd()`, which it
|
193 | c92b310a | Michael Hanselmann | uses to launch ssh.
|
194 | c92b310a | Michael Hanselmann |
|
195 | c41eea6e | Iustin Pop | Args: see SshRunner.BuildCmd.
|
196 | c92b310a | Michael Hanselmann |
|
197 | a4ccecf6 | Michael Hanselmann | @rtype: L{utils.process.RunResult}
|
198 | a4ccecf6 | Michael Hanselmann | @return: the result as from L{utils.process.RunCmd()}
|
199 | c92b310a | Michael Hanselmann |
|
200 | c92b310a | Michael Hanselmann | """
|
201 | 54ab6aec | Michael Hanselmann | return utils.RunCmd(self.BuildCmd(*args, **kwargs)) |
202 | c92b310a | Michael Hanselmann | |
203 | c92b310a | Michael Hanselmann | def CopyFileToNode(self, node, filename): |
204 | c92b310a | Michael Hanselmann | """Copy a file to another node with scp.
|
205 | c92b310a | Michael Hanselmann |
|
206 | c41eea6e | Iustin Pop | @param node: node in the cluster
|
207 | c41eea6e | Iustin Pop | @param filename: absolute pathname of a local file
|
208 | c92b310a | Michael Hanselmann |
|
209 | c41eea6e | Iustin Pop | @rtype: boolean
|
210 | c41eea6e | Iustin Pop | @return: the success of the operation
|
211 | a8083063 | Iustin Pop |
|
212 | c92b310a | Michael Hanselmann | """
|
213 | c92b310a | Michael Hanselmann | if not os.path.isabs(filename): |
214 | 23828f1c | Iustin Pop | logging.error("File %s must be an absolute path", filename)
|
215 | c92b310a | Michael Hanselmann | return False |
216 | a8083063 | Iustin Pop | |
217 | 1d544ba3 | Michael Hanselmann | if not os.path.isfile(filename): |
218 | 23828f1c | Iustin Pop | logging.error("File %s does not exist", filename)
|
219 | 1d544ba3 | Michael Hanselmann | return False |
220 | 1d544ba3 | Michael Hanselmann | |
221 | 2892a4c9 | Iustin Pop | command = [constants.SCP, "-p"]
|
222 | 652d6694 | Michael Hanselmann | command.extend(self._BuildSshOptions(True, False, True, True)) |
223 | c92b310a | Michael Hanselmann | command.append(filename) |
224 | 8062638d | Manuel Franceschini | if netutils.IP6Address.IsValid(node):
|
225 | 8062638d | Manuel Franceschini | node = netutils.FormatAddress((node, None))
|
226 | 8062638d | Manuel Franceschini | |
227 | c92b310a | Michael Hanselmann | command.append("%s:%s" % (node, filename))
|
228 | a8083063 | Iustin Pop | |
229 | c92b310a | Michael Hanselmann | result = utils.RunCmd(command) |
230 | a8083063 | Iustin Pop | |
231 | c92b310a | Michael Hanselmann | if result.failed:
|
232 | 23828f1c | Iustin Pop | logging.error("Copy to node %s failed (%s) error %s,"
|
233 | 23828f1c | Iustin Pop | " command was %s",
|
234 | 23828f1c | Iustin Pop | node, result.fail_reason, result.output, result.cmd) |
235 | a8083063 | Iustin Pop | |
236 | c92b310a | Michael Hanselmann | return not result.failed |
237 | a8083063 | Iustin Pop | |
238 | c92b310a | Michael Hanselmann | def VerifyNodeHostname(self, node): |
239 | c92b310a | Michael Hanselmann | """Verify hostname consistency via SSH.
|
240 | a8083063 | Iustin Pop |
|
241 | c92b310a | Michael Hanselmann | This functions connects via ssh to a node and compares the hostname
|
242 | c92b310a | Michael Hanselmann | reported by the node to the name with have (the one that we
|
243 | c92b310a | Michael Hanselmann | connected to).
|
244 | a8083063 | Iustin Pop |
|
245 | c92b310a | Michael Hanselmann | This is used to detect problems in ssh known_hosts files
|
246 | 5bbd3f7f | Michael Hanselmann | (conflicting known hosts) and inconsistencies between dns/hosts
|
247 | c92b310a | Michael Hanselmann | entries and local machine names
|
248 | a8083063 | Iustin Pop |
|
249 | c41eea6e | Iustin Pop | @param node: nodename of a host to check; can be short or
|
250 | c41eea6e | Iustin Pop | full qualified hostname
|
251 | a8083063 | Iustin Pop |
|
252 | c41eea6e | Iustin Pop | @return: (success, detail), where:
|
253 | c41eea6e | Iustin Pop | - success: True/False
|
254 | c41eea6e | Iustin Pop | - detail: string with details
|
255 | a8083063 | Iustin Pop |
|
256 | c92b310a | Michael Hanselmann | """
|
257 | ebcd61bb | Iustin Pop | retval = self.Run(node, "root", "hostname --fqdn", quiet=False) |
258 | a8083063 | Iustin Pop | |
259 | c92b310a | Michael Hanselmann | if retval.failed:
|
260 | c92b310a | Michael Hanselmann | msg = "ssh problem"
|
261 | c92b310a | Michael Hanselmann | output = retval.output |
262 | c92b310a | Michael Hanselmann | if output:
|
263 | c92b310a | Michael Hanselmann | msg += ": %s" % output
|
264 | a162cf5b | Iustin Pop | else:
|
265 | a162cf5b | Iustin Pop | msg += ": %s (no output)" % retval.fail_reason
|
266 | 099c52ad | Iustin Pop | logging.error("Command %s failed: %s", retval.cmd, msg)
|
267 | c92b310a | Michael Hanselmann | return False, msg |
268 | a8083063 | Iustin Pop | |
269 | c92b310a | Michael Hanselmann | remotehostname = retval.stdout.strip() |
270 | a8083063 | Iustin Pop | |
271 | c92b310a | Michael Hanselmann | if not remotehostname or remotehostname != node: |
272 | 31821208 | Iustin Pop | if node.startswith(remotehostname + "."): |
273 | 31821208 | Iustin Pop | msg = "hostname not FQDN"
|
274 | 31821208 | Iustin Pop | else:
|
275 | 2175e25d | Manuel Franceschini | msg = "hostname mismatch"
|
276 | 31821208 | Iustin Pop | return False, ("%s: expected %s but got %s" % |
277 | 31821208 | Iustin Pop | (msg, node, remotehostname)) |
278 | a8083063 | Iustin Pop | |
279 | c92b310a | Michael Hanselmann | return True, "host matches" |
280 | 75a5f456 | Michael Hanselmann | |
281 | 75a5f456 | Michael Hanselmann | |
282 | 7688d0d3 | Michael Hanselmann | def WriteKnownHostsFile(cfg, file_name): |
283 | 75a5f456 | Michael Hanselmann | """Writes the cluster-wide equally known_hosts file.
|
284 | 75a5f456 | Michael Hanselmann |
|
285 | 75a5f456 | Michael Hanselmann | """
|
286 | a3f9f296 | Guido Trotter | utils.WriteFile(file_name, mode=0600,
|
287 | 7688d0d3 | Michael Hanselmann | data="%s ssh-rsa %s\n" % (cfg.GetClusterName(),
|
288 | 75a5f456 | Michael Hanselmann | cfg.GetHostKey())) |