Change the JobQueueError parent class
[ganeti-local] / lib / ssh.py
index d4fc217..71d30ed 100644 (file)
@@ -32,25 +32,6 @@ from ganeti import errors
 from ganeti import constants
 
 
-KNOWN_HOSTS_OPTS = [
-  "-oGlobalKnownHostsFile=%s" % constants.SSH_KNOWN_HOSTS_FILE,
-  "-oUserKnownHostsFile=/dev/null",
-  ]
-
-# Note: BATCH_MODE conflicts with ASK_KEY
-BATCH_MODE_OPTS = [
-  "-oBatchMode=yes",
-  "-oEscapeChar=none",
-  "-oStrictHostKeyChecking=yes",
-  ]
-
-ASK_KEY_OPTS = [
-  "-oEscapeChar=none",
-  "-oHashKnownHosts=no",
-  "-oStrictHostKeyChecking=ask",
-  ]
-
-
 def GetUserFiles(user, mkdir=False):
   """Return the paths of a user's ssh files.
 
@@ -90,8 +71,45 @@ class SshRunner:
   """Wrapper for SSH commands.
 
   """
+  def __init__(self, cluster_name):
+    self.cluster_name = cluster_name
+
+  def _BuildSshOptions(self, batch, ask_key, use_cluster_key,
+                       strict_host_check):
+    options = [
+      "-oEscapeChar=none",
+      "-oHashKnownHosts=no",
+      "-oGlobalKnownHostsFile=%s" % constants.SSH_KNOWN_HOSTS_FILE,
+      "-oUserKnownHostsFile=/dev/null",
+      ]
+
+    if use_cluster_key:
+      options.append("-oHostKeyAlias=%s" % self.cluster_name)
+
+    # TODO: Too many boolean options, maybe convert them to more descriptive
+    # constants.
+
+    # Note: ask_key conflicts with batch mode
+    if batch:
+      if ask_key:
+        raise errors.ProgrammerError("SSH call requested conflicting options")
+
+      options.append("-oBatchMode=yes")
+
+      if strict_host_check:
+        options.append("-oStrictHostKeyChecking=yes")
+      else:
+        options.append("-oStrictHostKeyChecking=no")
+
+    elif ask_key:
+      options.extend([
+        "-oStrictHostKeyChecking=ask",
+        ])
+
+    return options
+
   def BuildCmd(self, hostname, user, command, batch=True, ask_key=False,
-               tty=False):
+               tty=False, use_cluster_key=True, strict_host_check=True):
     """Build an ssh command to execute a command on a remote node.
 
     Args:
@@ -101,45 +119,35 @@ class SshRunner:
       batch: if true, ssh will run in batch mode with no prompting
       ask_key: if true, ssh will run with StrictHostKeyChecking=ask, so that
                we can connect to an unknown host (not valid in batch mode)
+      use_cluster_key: Whether to expect and use the cluster-global SSH key
+      strict_host_check: Whether to check the host's SSH key at all
 
     Returns:
       The ssh call to run 'command' on the remote host.
 
     """
-    argv = ["ssh", "-q"]
-    argv.extend(KNOWN_HOSTS_OPTS)
-    if batch:
-      # if we are in batch mode, we can't ask the key
-      if ask_key:
-        raise errors.ProgrammerError("SSH call requested conflicting options")
-      argv.extend(BATCH_MODE_OPTS)
-    elif ask_key:
-      argv.extend(ASK_KEY_OPTS)
+    argv = [constants.SSH, "-q"]
+    argv.extend(self._BuildSshOptions(batch, ask_key, use_cluster_key,
+                                      strict_host_check))
     if tty:
       argv.append("-t")
     argv.extend(["%s@%s" % (user, hostname), command])
     return argv
 
-  def Run(self, hostname, user, command, batch=True, ask_key=False):
+  def Run(self, *args, **kwargs):
     """Runs a command on a remote node.
 
     This method has the same return value as `utils.RunCmd()`, which it
     uses to launch ssh.
 
     Args:
-      hostname: the target host, string
-      user: user to auth as
-      command: the command
-      batch: if true, ssh will run in batch mode with no prompting
-      ask_key: if true, ssh will run with StrictHostKeyChecking=ask, so that
-               we can connect to an unknown host (not valid in batch mode)
+      See SshRunner.BuildCmd.
 
     Returns:
       `utils.RunResult` like `utils.RunCmd()`
 
     """
-    return utils.RunCmd(self.BuildCmd(hostname, user, command, batch=batch,
-                                      ask_key=ask_key))
+    return utils.RunCmd(self.BuildCmd(*args, **kwargs))
 
   def CopyFileToNode(self, node, filename):
     """Copy a file to another node with scp.
@@ -152,17 +160,16 @@ class SshRunner:
       success: True/False
 
     """
-    if not os.path.isfile(filename):
-      logger.Error("file %s does not exist" % (filename))
-      return False
-
     if not os.path.isabs(filename):
       logger.Error("file %s must be an absolute path" % (filename))
       return False
 
-    command = ["scp", "-q", "-p"]
-    command.extend(KNOWN_HOSTS_OPTS)
-    command.extend(BATCH_MODE_OPTS)
+    if not os.path.isfile(filename):
+      logger.Error("file %s does not exist" % (filename))
+      return False
+
+    command = [constants.SCP, "-q", "-p"]
+    command.extend(self._BuildSshOptions(True, False, True, True))
     command.append(filename)
     command.append("%s:%s" % (node, filename))
 
@@ -213,10 +220,10 @@ class SshRunner:
     return True, "host matches"
 
 
-def WriteKnownHostsFile(cfg, sstore, file_name):
+def WriteKnownHostsFile(cfg, file_name):
   """Writes the cluster-wide equally known_hosts file.
 
   """
   utils.WriteFile(file_name, mode=0700,
-                  data="%s ssh-rsa %s\n" % (sstore.GetClusterName(),
+                  data="%s ssh-rsa %s\n" % (cfg.GetClusterName(),
                                             cfg.GetHostKey()))