bugfix for ssh key generation (were all typed rsa1)
[bootmanager.git] / source / steps / StartDebug.py
index 6220704..fc403e6 100644 (file)
@@ -1,19 +1,20 @@
-#!/usr/bin/python2
-
+#!/usr/bin/python
+#
 # Copyright (c) 2003 Intel Corporation
 # All rights reserved.
 #
 # Copyright (c) 2004-2006 The Trustees of Princeton University
 # All rights reserved.
 
+from __future__ import print_function
+
 import os
 
 from Exceptions import *
 import utils
-import compatibility
 
 
-message= \
+warning_message = \
 """
 ---------------------------------------------------------
 This machine has entered a temporary debug state, so
@@ -27,8 +28,13 @@ Thank you.
 ---------------------------------------------------------
 """
 
+# this can be invoked 
+# either at the end of the bm logic, because something failed (last_resort = True)
+# and/or it can be invoked as a fallback very early in the bootmanager logic,
+# so we can reach the node regardless of what happens (e.g. bm sometimes hangs)
+
+def Run(vars, log, last_resort = True):
 
-def Run( vars, log ):
     """
     Bring up sshd inside the boot cd environment for debug purposes.
 
@@ -37,96 +43,89 @@ def Run( vars, log ):
 
     Expect the following variables in vars to be set:
     BM_SOURCE_DIR     The source dir for the boot manager sources that
-                      we are currently running from
-    BOOT_CD_VERSION          A tuple of the current bootcd version
+                        we are currently running from
     """
 
-    log.write( "\n\nStep: Starting debug mode.\n" )
+    if last_resort:
+        message = "Starting debug mode"
+    else:
+        message = "Starting fallback sshd"
+
+
+    log.write("\n\nStep: %s.\n"%message)
     
     # make sure we have the variables we need
     try:
-        BM_SOURCE_DIR= vars["BM_SOURCE_DIR"]
+        BM_SOURCE_DIR = vars["BM_SOURCE_DIR"]
         if BM_SOURCE_DIR == "":
             raise ValueError, "BM_SOURCE_DIR"
 
-        BOOT_CD_VERSION= vars["BOOT_CD_VERSION"]
-        if BOOT_CD_VERSION == "":
-            raise ValueError, "BOOT_CD_VERSION"
-
     except KeyError, var:
         raise BootManagerException, "Missing variable in vars: %s\n" % var
     except ValueError, var:
         raise BootManagerException, "Variable in vars, shouldn't be: %s\n" % var
 
-
-    log.write( "Starting debug environment\n" )
-
-    ssh_source_files= "%s/debug_files/" % BM_SOURCE_DIR    
-    ssh_dir= "/etc/ssh/"
-    ssh_home= "/root/.ssh"
-    cancel_boot_flag= "/tmp/CANCEL_BOOT"
-    sshd_started_flag= "/tmp/SSHD_RUNNING"
+    # constants
+    ssh_source_files = "%s/debug_files/" % BM_SOURCE_DIR    
+    ssh_dir = "/etc/ssh/"
+    key_gen_prog = "ssh-keygen"
+    ssh_home = "/root/.ssh"
+    cancel_boot_flag = "/tmp/CANCEL_BOOT"
+    sshd_started_flag = "/tmp/SSHD_RUNNING"
+
+    # pre-sshd
+    pre_sshd_script = os.path.join(ssh_source_files, "pre-sshd")
+    if os.path.exists(pre_sshd_script):
+        utils.sysexec_noerr(pre_sshd_script, log)
     
-    sshd_started= 0
-    try:
-        os.stat(sshd_started_flag)
-        sshd_started= 1
-    except OSError, e:
-        pass
-
-    if not sshd_started:
-        log.write( "Creating ssh host keys\n" )
-        
-        utils.makedirs( ssh_dir )
-        utils.sysexec( "ssh-keygen -t rsa1 -b 1024 -f %s/ssh_host_key -N ''" %
-                       ssh_dir, log )
-        utils.sysexec( "ssh-keygen -t rsa -f %s/ssh_host_rsa_key -N ''" %
-                       ssh_dir, log )
-        utils.sysexec( "ssh-keygen -d -f %s/ssh_host_dsa_key -N ''" %
-                       ssh_dir, log )
-
-        if BOOT_CD_VERSION[0] == 3:
-            utils.sysexec( "cp -f %s/sshd_config_v3 %s/sshd_config" %
-                           (ssh_source_files,ssh_dir), log )
-        else:
-            utils.sysexec( "cp -f %s/sshd_config_v2 %s/sshd_config" %
-                           (ssh_source_files,ssh_dir), log )
-    else:
-        log.write( "ssh host keys already created\n" )
-
-
-    # always update the key, may have change in this instance of the bootmanager
-    log.write( "Installing debug ssh key for root user\n" )
+    # create host keys if needed
+    if not os.path.isdir (ssh_dir):
+        utils.makedirs (ssh_dir)
+
+    # original code used to specify -b 1024 for the rsa1 key
+    key_specs = [
+        ("/etc/ssh/ssh_host_key",     'rsa1', "SSH1 RSA"),
+        ("/etc/ssh/ssh_host_rsa_key", 'rsa',  "SSH2 RSA"),
+        ("/etc/ssh/ssh_host_dsa_key", 'dsa',  "SSH2 DSA"),
+    ]
+
+    for key_file, key_type, label in key_specs:
+        if not os.path.exists(key_file):
+            log.write("Creating {} host key {}\n".format(label, key_file))
+            utils.sysexec("{} -q -t {} -f {} -C '' -N ''"\
+                                 .format(key_gen_prog, key_type, key_file), log)
+            utils.sysexec("chmod 600 {}".format(key_file), log)
+            utils.sysexec("chmod 644 {}.pub".format(key_file), log)
+
+    # (over)write sshd config
+    utils.sysexec("cp -f {}/sshd_config {}/sshd_config".format(ssh_source_files, ssh_dir), log)
     
-    utils.makedirs( ssh_home )
-    utils.sysexec( "cp -f %s/debug_root_ssh_key %s/authorized_keys" %
-                   (ssh_source_files,ssh_home), log )
-    utils.sysexec( "chmod 700 %s" % ssh_home, log )
-    utils.sysexec( "chmod 600 %s/authorized_keys" % ssh_home, log )
-
-    if not sshd_started:
-        log.write( "Starting sshd\n" )
-        
-        if BOOT_CD_VERSION[0] == 2:
-            utils.sysexec( "/usr/sbin/sshd", log )
-        else:
-            utils.sysexec( "service sshd start", log )
-        
+    ### xxx ### xxx ### xxx ### xxx ### xxx 
+
+    # always update the key, may have changed in this instance of the bootmanager
+    log.write("Installing debug ssh key for root user\n")
+    if not os.path.isdir (ssh_home):
+        utils.makedirs(ssh_home)
+    utils.sysexec("cp -f {}/debug_root_ssh_key {}/authorized_keys".format(ssh_source_files, ssh_home), log)
+    utils.sysexec("chmod 700 {}".format(ssh_home), log)
+    utils.sysexec("chmod 600 {}/authorized_keys".format(ssh_home), log)
+
+    # start sshd
+    if not os.path.isfile(sshd_started_flag):
+        log.write("Starting sshd\n")
+        utils.sysexec("service sshd start", log)
         # flag that ssh is running
-        utils.sysexec( "touch %s" % sshd_started_flag, log )
+        utils.sysexec("touch {}".format(sshd_started_flag), log)
     else:
-        log.write( "sshd already running\n" )
+        # it is expected that sshd is already running when last_resort==True
+        if not last_resort:
+            log.write("sshd is already running\n")
 
+    if last_resort:
+        # this will make the initial script stop requesting scripts from PLC
+        utils.sysexec("touch {}".format(cancel_boot_flag), log)
 
-    # for ease of use, setup lvm on 2.x cds
-    if BOOT_CD_VERSION[0] == 2:
-        compatibility.setup_lvm_2x_cd(vars,log)
-
-    
-    # this will make the initial script stop requesting scripts from PLC
-    utils.sysexec( "touch %s" % cancel_boot_flag, log )
-
-    print message
+    if last_resort:
+        print(warning_message)
     
     return
-