root / lib / ssh.py @ 196ec587
History | View | Annotate | Download (7.9 kB)
1 | 2f31098c | Iustin Pop | #
|
---|---|---|---|
2 | a8083063 | Iustin Pop | #
|
3 | a8083063 | Iustin Pop | |
4 | a8083063 | Iustin Pop | # Copyright (C) 2006, 2007 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 | a8083063 | Iustin Pop | |
30 | a8083063 | Iustin Pop | from ganeti import utils |
31 | a8083063 | Iustin Pop | from ganeti import errors |
32 | 82122173 | Iustin Pop | from ganeti import constants |
33 | 82122173 | Iustin Pop | |
34 | 82122173 | Iustin Pop | |
35 | 70d9e3d8 | Iustin Pop | def GetUserFiles(user, mkdir=False): |
36 | 70d9e3d8 | Iustin Pop | """Return the paths of a user's ssh files.
|
37 | 70d9e3d8 | Iustin Pop |
|
38 | 70d9e3d8 | Iustin Pop | The function will return a triplet (priv_key_path, pub_key_path,
|
39 | 70d9e3d8 | Iustin Pop | auth_key_path) that are used for ssh authentication. Currently, the
|
40 | 70d9e3d8 | Iustin Pop | keys used are DSA keys, so this function will return:
|
41 | 70d9e3d8 | Iustin Pop | (~user/.ssh/id_dsa, ~user/.ssh/id_dsa.pub,
|
42 | 70d9e3d8 | Iustin Pop | ~user/.ssh/authorized_keys).
|
43 | 70d9e3d8 | Iustin Pop |
|
44 | 70d9e3d8 | Iustin Pop | If the optional parameter mkdir is True, the ssh directory will be
|
45 | 70d9e3d8 | Iustin Pop | created if it doesn't exist.
|
46 | 70d9e3d8 | Iustin Pop |
|
47 | 70d9e3d8 | Iustin Pop | Regardless of the mkdir parameters, the script will raise an error
|
48 | 70d9e3d8 | Iustin Pop | if ~user/.ssh is not a directory.
|
49 | 70d9e3d8 | Iustin Pop |
|
50 | 70d9e3d8 | Iustin Pop | """
|
51 | 70d9e3d8 | Iustin Pop | user_dir = utils.GetHomeDir(user) |
52 | 70d9e3d8 | Iustin Pop | if not user_dir: |
53 | 70d9e3d8 | Iustin Pop | raise errors.OpExecError("Cannot resolve home of user %s" % user) |
54 | 70d9e3d8 | Iustin Pop | |
55 | c4feafe8 | Iustin Pop | ssh_dir = utils.PathJoin(user_dir, ".ssh")
|
56 | 5bae14d9 | Guido Trotter | if mkdir:
|
57 | 5bae14d9 | Guido Trotter | utils.EnsureDirs([(ssh_dir, constants.SECURE_DIR_MODE)]) |
58 | 70d9e3d8 | Iustin Pop | elif not os.path.isdir(ssh_dir): |
59 | 70d9e3d8 | Iustin Pop | raise errors.OpExecError("path ~%s/.ssh is not a directory" % user) |
60 | 70d9e3d8 | Iustin Pop | |
61 | c4feafe8 | Iustin Pop | return [utils.PathJoin(ssh_dir, base)
|
62 | 70d9e3d8 | Iustin Pop | for base in ["id_dsa", "id_dsa.pub", "authorized_keys"]] |
63 | 70d9e3d8 | Iustin Pop | |
64 | 70d9e3d8 | Iustin Pop | |
65 | c92b310a | Michael Hanselmann | class SshRunner: |
66 | c92b310a | Michael Hanselmann | """Wrapper for SSH commands.
|
67 | a8083063 | Iustin Pop |
|
68 | a8083063 | Iustin Pop | """
|
69 | 56bece1f | Iustin Pop | def __init__(self, cluster_name): |
70 | 56bece1f | Iustin Pop | self.cluster_name = cluster_name
|
71 | 1ff08570 | Michael Hanselmann | |
72 | 652d6694 | Michael Hanselmann | def _BuildSshOptions(self, batch, ask_key, use_cluster_key, |
73 | 2892a4c9 | Iustin Pop | strict_host_check, private_key=None, quiet=True): |
74 | bf75f132 | Iustin Pop | """Builds a list with needed SSH options.
|
75 | bf75f132 | Iustin Pop |
|
76 | bf75f132 | Iustin Pop | @param batch: same as ssh's batch option
|
77 | bf75f132 | Iustin Pop | @param ask_key: allows ssh to ask for key confirmation; this
|
78 | bf75f132 | Iustin Pop | parameter conflicts with the batch one
|
79 | bf75f132 | Iustin Pop | @param use_cluster_key: if True, use the cluster name as the
|
80 | bf75f132 | Iustin Pop | HostKeyAlias name
|
81 | bf75f132 | Iustin Pop | @param strict_host_check: this makes the host key checking strict
|
82 | 4403ff8d | René Nussbaumer | @param private_key: use this private key instead of the default
|
83 | 2892a4c9 | Iustin Pop | @param quiet: whether to enable -q to ssh
|
84 | bf75f132 | Iustin Pop |
|
85 | bf75f132 | Iustin Pop | @rtype: list
|
86 | bf75f132 | Iustin Pop | @return: the list of options ready to use in L{utils.RunCmd}
|
87 | bf75f132 | Iustin Pop |
|
88 | bf75f132 | Iustin Pop | """
|
89 | f6d9f4c3 | Michael Hanselmann | options = [ |
90 | f6d9f4c3 | Michael Hanselmann | "-oEscapeChar=none",
|
91 | f6d9f4c3 | Michael Hanselmann | "-oHashKnownHosts=no",
|
92 | f6d9f4c3 | Michael Hanselmann | "-oGlobalKnownHostsFile=%s" % constants.SSH_KNOWN_HOSTS_FILE,
|
93 | f6d9f4c3 | Michael Hanselmann | "-oUserKnownHostsFile=/dev/null",
|
94 | b427788e | Iustin Pop | "-oCheckHostIp=no",
|
95 | f6d9f4c3 | Michael Hanselmann | ] |
96 | f6d9f4c3 | Michael Hanselmann | |
97 | f6d9f4c3 | Michael Hanselmann | if use_cluster_key:
|
98 | 56bece1f | Iustin Pop | options.append("-oHostKeyAlias=%s" % self.cluster_name) |
99 | f6d9f4c3 | Michael Hanselmann | |
100 | 2892a4c9 | Iustin Pop | if quiet:
|
101 | 2892a4c9 | Iustin Pop | options.append("-q")
|
102 | 2892a4c9 | Iustin Pop | |
103 | 4403ff8d | René Nussbaumer | if private_key:
|
104 | 4403ff8d | René Nussbaumer | options.append("-i%s" % private_key)
|
105 | 4403ff8d | René Nussbaumer | |
106 | 652d6694 | Michael Hanselmann | # TODO: Too many boolean options, maybe convert them to more descriptive
|
107 | 652d6694 | Michael Hanselmann | # constants.
|
108 | 652d6694 | Michael Hanselmann | |
109 | f6d9f4c3 | Michael Hanselmann | # Note: ask_key conflicts with batch mode
|
110 | f6d9f4c3 | Michael Hanselmann | if batch:
|
111 | f6d9f4c3 | Michael Hanselmann | if ask_key:
|
112 | f6d9f4c3 | Michael Hanselmann | raise errors.ProgrammerError("SSH call requested conflicting options") |
113 | f6d9f4c3 | Michael Hanselmann | |
114 | 652d6694 | Michael Hanselmann | options.append("-oBatchMode=yes")
|
115 | 652d6694 | Michael Hanselmann | |
116 | 652d6694 | Michael Hanselmann | if strict_host_check:
|
117 | 652d6694 | Michael Hanselmann | options.append("-oStrictHostKeyChecking=yes")
|
118 | 652d6694 | Michael Hanselmann | else:
|
119 | 652d6694 | Michael Hanselmann | options.append("-oStrictHostKeyChecking=no")
|
120 | f6d9f4c3 | Michael Hanselmann | |
121 | e66d9f1a | Iustin Pop | else:
|
122 | e66d9f1a | Iustin Pop | # non-batch mode
|
123 | e66d9f1a | Iustin Pop | |
124 | e66d9f1a | Iustin Pop | if ask_key:
|
125 | e66d9f1a | Iustin Pop | options.append("-oStrictHostKeyChecking=ask")
|
126 | e66d9f1a | Iustin Pop | elif strict_host_check:
|
127 | e66d9f1a | Iustin Pop | options.append("-oStrictHostKeyChecking=yes")
|
128 | e66d9f1a | Iustin Pop | else:
|
129 | e66d9f1a | Iustin Pop | options.append("-oStrictHostKeyChecking=no")
|
130 | f6d9f4c3 | Michael Hanselmann | |
131 | f6d9f4c3 | Michael Hanselmann | return options
|
132 | 1ff08570 | Michael Hanselmann | |
133 | 8f07f831 | Michael Hanselmann | def BuildCmd(self, hostname, user, command, batch=True, ask_key=False, |
134 | 4403ff8d | René Nussbaumer | tty=False, use_cluster_key=True, strict_host_check=True, |
135 | 2892a4c9 | Iustin Pop | private_key=None, quiet=True): |
136 | c92b310a | Michael Hanselmann | """Build an ssh command to execute a command on a remote node.
|
137 | c92b310a | Michael Hanselmann |
|
138 | c41eea6e | Iustin Pop | @param hostname: the target host, string
|
139 | c41eea6e | Iustin Pop | @param user: user to auth as
|
140 | c41eea6e | Iustin Pop | @param command: the command
|
141 | c41eea6e | Iustin Pop | @param batch: if true, ssh will run in batch mode with no prompting
|
142 | c41eea6e | Iustin Pop | @param ask_key: if true, ssh will run with
|
143 | c41eea6e | Iustin Pop | StrictHostKeyChecking=ask, so that we can connect to an
|
144 | c41eea6e | Iustin Pop | unknown host (not valid in batch mode)
|
145 | c41eea6e | Iustin Pop | @param use_cluster_key: whether to expect and use the
|
146 | c41eea6e | Iustin Pop | cluster-global SSH key
|
147 | c41eea6e | Iustin Pop | @param strict_host_check: whether to check the host's SSH key at all
|
148 | 4403ff8d | René Nussbaumer | @param private_key: use this private key instead of the default
|
149 | 2892a4c9 | Iustin Pop | @param quiet: whether to enable -q to ssh
|
150 | c41eea6e | Iustin Pop |
|
151 | c41eea6e | Iustin Pop | @return: the ssh call to run 'command' on the remote host.
|
152 | c92b310a | Michael Hanselmann |
|
153 | c92b310a | Michael Hanselmann | """
|
154 | 2892a4c9 | Iustin Pop | argv = [constants.SSH] |
155 | 652d6694 | Michael Hanselmann | argv.extend(self._BuildSshOptions(batch, ask_key, use_cluster_key,
|
156 | 2892a4c9 | Iustin Pop | strict_host_check, private_key, |
157 | 2892a4c9 | Iustin Pop | quiet=quiet)) |
158 | 8f07f831 | Michael Hanselmann | if tty:
|
159 | f724a702 | Balazs Lecz | argv.extend(["-t", "-t"]) |
160 | c92b310a | Michael Hanselmann | argv.extend(["%s@%s" % (user, hostname), command])
|
161 | c92b310a | Michael Hanselmann | return argv
|
162 | c92b310a | Michael Hanselmann | |
163 | 54ab6aec | Michael Hanselmann | def Run(self, *args, **kwargs): |
164 | c92b310a | Michael Hanselmann | """Runs a command on a remote node.
|
165 | c92b310a | Michael Hanselmann |
|
166 | c92b310a | Michael Hanselmann | This method has the same return value as `utils.RunCmd()`, which it
|
167 | c92b310a | Michael Hanselmann | uses to launch ssh.
|
168 | c92b310a | Michael Hanselmann |
|
169 | c41eea6e | Iustin Pop | Args: see SshRunner.BuildCmd.
|
170 | c92b310a | Michael Hanselmann |
|
171 | c41eea6e | Iustin Pop | @rtype: L{utils.RunResult}
|
172 | c41eea6e | Iustin Pop | @return: the result as from L{utils.RunCmd()}
|
173 | c92b310a | Michael Hanselmann |
|
174 | c92b310a | Michael Hanselmann | """
|
175 | 54ab6aec | Michael Hanselmann | return utils.RunCmd(self.BuildCmd(*args, **kwargs)) |
176 | c92b310a | Michael Hanselmann | |
177 | c92b310a | Michael Hanselmann | def CopyFileToNode(self, node, filename): |
178 | c92b310a | Michael Hanselmann | """Copy a file to another node with scp.
|
179 | c92b310a | Michael Hanselmann |
|
180 | c41eea6e | Iustin Pop | @param node: node in the cluster
|
181 | c41eea6e | Iustin Pop | @param filename: absolute pathname of a local file
|
182 | c92b310a | Michael Hanselmann |
|
183 | c41eea6e | Iustin Pop | @rtype: boolean
|
184 | c41eea6e | Iustin Pop | @return: the success of the operation
|
185 | a8083063 | Iustin Pop |
|
186 | c92b310a | Michael Hanselmann | """
|
187 | c92b310a | Michael Hanselmann | if not os.path.isabs(filename): |
188 | 23828f1c | Iustin Pop | logging.error("File %s must be an absolute path", filename)
|
189 | c92b310a | Michael Hanselmann | return False |
190 | a8083063 | Iustin Pop | |
191 | 1d544ba3 | Michael Hanselmann | if not os.path.isfile(filename): |
192 | 23828f1c | Iustin Pop | logging.error("File %s does not exist", filename)
|
193 | 1d544ba3 | Michael Hanselmann | return False |
194 | 1d544ba3 | Michael Hanselmann | |
195 | 2892a4c9 | Iustin Pop | command = [constants.SCP, "-p"]
|
196 | 652d6694 | Michael Hanselmann | command.extend(self._BuildSshOptions(True, False, True, True)) |
197 | c92b310a | Michael Hanselmann | command.append(filename) |
198 | c92b310a | Michael Hanselmann | command.append("%s:%s" % (node, filename))
|
199 | a8083063 | Iustin Pop | |
200 | c92b310a | Michael Hanselmann | result = utils.RunCmd(command) |
201 | a8083063 | Iustin Pop | |
202 | c92b310a | Michael Hanselmann | if result.failed:
|
203 | 23828f1c | Iustin Pop | logging.error("Copy to node %s failed (%s) error %s,"
|
204 | 23828f1c | Iustin Pop | " command was %s",
|
205 | 23828f1c | Iustin Pop | node, result.fail_reason, result.output, result.cmd) |
206 | a8083063 | Iustin Pop | |
207 | c92b310a | Michael Hanselmann | return not result.failed |
208 | a8083063 | Iustin Pop | |
209 | c92b310a | Michael Hanselmann | def VerifyNodeHostname(self, node): |
210 | c92b310a | Michael Hanselmann | """Verify hostname consistency via SSH.
|
211 | a8083063 | Iustin Pop |
|
212 | c92b310a | Michael Hanselmann | This functions connects via ssh to a node and compares the hostname
|
213 | c92b310a | Michael Hanselmann | reported by the node to the name with have (the one that we
|
214 | c92b310a | Michael Hanselmann | connected to).
|
215 | a8083063 | Iustin Pop |
|
216 | c92b310a | Michael Hanselmann | This is used to detect problems in ssh known_hosts files
|
217 | 5bbd3f7f | Michael Hanselmann | (conflicting known hosts) and inconsistencies between dns/hosts
|
218 | c92b310a | Michael Hanselmann | entries and local machine names
|
219 | a8083063 | Iustin Pop |
|
220 | c41eea6e | Iustin Pop | @param node: nodename of a host to check; can be short or
|
221 | c41eea6e | Iustin Pop | full qualified hostname
|
222 | a8083063 | Iustin Pop |
|
223 | c41eea6e | Iustin Pop | @return: (success, detail), where:
|
224 | c41eea6e | Iustin Pop | - success: True/False
|
225 | c41eea6e | Iustin Pop | - detail: string with details
|
226 | a8083063 | Iustin Pop |
|
227 | c92b310a | Michael Hanselmann | """
|
228 | 8b2df5f6 | Iustin Pop | retval = self.Run(node, 'root', 'hostname --fqdn') |
229 | a8083063 | Iustin Pop | |
230 | c92b310a | Michael Hanselmann | if retval.failed:
|
231 | c92b310a | Michael Hanselmann | msg = "ssh problem"
|
232 | c92b310a | Michael Hanselmann | output = retval.output |
233 | c92b310a | Michael Hanselmann | if output:
|
234 | c92b310a | Michael Hanselmann | msg += ": %s" % output
|
235 | a162cf5b | Iustin Pop | else:
|
236 | a162cf5b | Iustin Pop | msg += ": %s (no output)" % retval.fail_reason
|
237 | 099c52ad | Iustin Pop | logging.error("Command %s failed: %s", retval.cmd, msg)
|
238 | c92b310a | Michael Hanselmann | return False, msg |
239 | a8083063 | Iustin Pop | |
240 | c92b310a | Michael Hanselmann | remotehostname = retval.stdout.strip() |
241 | a8083063 | Iustin Pop | |
242 | c92b310a | Michael Hanselmann | if not remotehostname or remotehostname != node: |
243 | 31821208 | Iustin Pop | if node.startswith(remotehostname + "."): |
244 | 31821208 | Iustin Pop | msg = "hostname not FQDN"
|
245 | 31821208 | Iustin Pop | else:
|
246 | 31821208 | Iustin Pop | msg = "hostname mistmatch"
|
247 | 31821208 | Iustin Pop | return False, ("%s: expected %s but got %s" % |
248 | 31821208 | Iustin Pop | (msg, node, remotehostname)) |
249 | a8083063 | Iustin Pop | |
250 | c92b310a | Michael Hanselmann | return True, "host matches" |
251 | 75a5f456 | Michael Hanselmann | |
252 | 75a5f456 | Michael Hanselmann | |
253 | 7688d0d3 | Michael Hanselmann | def WriteKnownHostsFile(cfg, file_name): |
254 | 75a5f456 | Michael Hanselmann | """Writes the cluster-wide equally known_hosts file.
|
255 | 75a5f456 | Michael Hanselmann |
|
256 | 75a5f456 | Michael Hanselmann | """
|
257 | a3f9f296 | Guido Trotter | utils.WriteFile(file_name, mode=0600,
|
258 | 7688d0d3 | Michael Hanselmann | data="%s ssh-rsa %s\n" % (cfg.GetClusterName(),
|
259 | 75a5f456 | Michael Hanselmann | cfg.GetHostKey())) |