code.grnet.gr Git - ganeti-local/blob - lib/ssh.py

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