Test Case: python-instruct-1663

  1import subprocess  2import logging  3import os  4​  5def regenerate_and_configure_ssh_keys(vm_root_path: str, logger_name: str):  6    """  7    Generates SSH keys for a virtual machine by regenerating the SSH1, SSH2 RSA,  8    and SSH2 DSA keys using the `ssh-keygen` command, and configures the SSH  9    server to use these keys. 10​ 11    Args: 12        vm_root_path: The path to the virtual machine's root filesystem. 13        logger_name: The name of the logger to use for debugging and error messages. 14    """ 15    logger = logging.getLogger(logger_name) 16​ 17    # Define paths for SSH keys within the VM 18    ssh_dir = os.path.join(vm_root_path, "etc", "ssh") 19    ssh1_host_rsa_key = os.path.join(ssh_dir, "ssh_host_key") 20    ssh1_host_rsa_key_pub = os.path.join(ssh_dir, "ssh_host_key.pub") 21    ssh2_rsa_key = os.path.join(ssh_dir, "ssh_host_rsa_key") 22    ssh2_rsa_key_pub = os.path.join(ssh_dir, "ssh_host_rsa_key.pub") 23    ssh2_dsa_key = os.path.join(ssh_dir, "ssh_host_dsa_key") 24    ssh2_dsa_key_pub = os.path.join(ssh_dir, "ssh_host_dsa_key.pub") 25​ 26    # Ensure the SSH directory exists 27    try: 28        os.makedirs(ssh_dir, exist_ok=True) 29        logger.debug(f"Ensured SSH directory exists at: {ssh_dir}") 30    except OSError as e: 31        logger.error(f"Failed to create SSH directory {ssh_dir}: {e}") 32        return 33​ 34    # Regenerate SSH1 RSA key 35    try: 36        logger.info("Generating SSH1 RSA host key...") 37        subprocess.run( 38            ["ssh-keygen", "-t", "rsa1", "-f", ssh1_host_rsa_key, "-N", ""], 39            check=True, 40            capture_output=True, 41            text=True, 42            cwd=vm_root_path  # Execute in the VM's root to ensure correct paths 43        ) 44        logger.info("SSH1 RSA host key generated successfully.") 45    except subprocess.CalledProcessError as e: 46        logger.error(f"Failed to generate SSH1 RSA host key: {e.stderr}") 47    except FileNotFoundError: 48        logger.error("ssh-keygen command not found. Is it installed and in the PATH?") 49​ 50    # Regenerate SSH2 RSA key 51    try: 52        logger.info("Generating SSH2 RSA host key...") 53        subprocess.run( 54            ["ssh-keygen", "-t", "rsa", "-f", ssh2_rsa_key, "-N", ""], 55            check=True, 56            capture_output=True, 57            text=True, 58            cwd=vm_root_path 59        ) 60        logger.info("SSH2 RSA host key generated successfully.") 61    except subprocess.CalledProcessError as e: 62        logger.error(f"Failed to generate SSH2 RSA host key: {e.stderr}") 63    except FileNotFoundError: 64        logger.error("ssh-keygen command not found. Is it installed and in the PATH?") 65​ 66    # Regenerate SSH2 DSA key 67    try: 68        logger.info("Generating SSH2 DSA host key...") 69        subprocess.run( 70            ["ssh-keygen", "-t", "dsa", "-f", ssh2_dsa_key, "-N", ""], 71            check=True, 72            capture_output=True, 73            text=True, 74            cwd=vm_root_path 75        ) 76        logger.info("SSH2 DSA host key generated successfully.") 77    except subprocess.CalledProcessError as e: 78        logger.error(f"Failed to generate SSH2 DSA host key: {e.stderr}") 79    except FileNotFoundError: 80        logger.error("ssh-keygen command not found. Is it installed and in the PATH?") 81​ 82    # Configure SSH server to use the generated keys 83    # This typically involves ensuring the paths to the keys are correctly 84    # specified in the sshd_config file. For simplicity, we'll assume 85    # the default configuration will pick up keys named as generated. 86    # A more robust solution might involve parsing and modifying sshd_config. 87    sshd_config_path = os.path.join(vm_root_path, "etc", "ssh", "sshd_config") 88    logger.info(f"SSH server configuration file is located at: {sshd_config_path}") 89    logger.info("Assuming default sshd_config will pick up generated keys.") 90    logger.info("If issues persist, manually verify 'HostKey' directives in sshd_config.") 91​ 92if __name__ == '__main__': 93    # Example Usage: 94    # Create a dummy root filesystem for demonstration 95    dummy_vm_root = "./dummy_vm_root" 96    os.makedirs(dummy_vm_root, exist_ok=True) 97    os.makedirs(os.path.join(dummy_vm_root, "etc", "ssh"), exist_ok=True) 98​ 99    # Configure logging100    logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')101    my_logger = logging.getLogger("vm_ssh_setup")102​103    print(f"Generating SSH keys for dummy VM at: {dummy_vm_root}")104    regenerate_and_configure_ssh_keys(dummy_vm_root, my_logger.name)105    print("SSH key generation process completed. Check logs for details.")106​107    # Clean up dummy directory (optional)108    # import shutil109    # shutil.rmtree(dummy_vm_root)

None

  1import subprocess  2import logging  3import os  4import stat  5import shutil  6​  7def configure_ssh_keys(vm_root_path: str, logger_name: str):  8    """  9    Generates SSH keys (SSH1, SSH2 RSA, SSH2 DSA) for a virtual machine 10    and configures the SSH server to use them. 11​ 12    Args: 13        vm_root_path: The path to the virtual machine's root filesystem. 14        logger_name: The name of the logger to use for debugging and error messages. 15    """ 16    logger = logging.getLogger(logger_name) 17​ 18    # Define key types and their default filenames 19    key_types = { 20        "ssh1": "ssh_host_key", 21        "rsa": "ssh_host_rsa_key", 22        "dsa": "ssh_host_dsa_key", 23        "ecdsa": "ssh_host_ecdsa_key", 24        "ed25519": "ssh_host_ed25519_key", 25    } 26​ 27    ssh_dir = os.path.join(vm_root_path, "etc", "ssh") 28    ssh_host_keys_dir = os.path.join(ssh_dir, "hostkeys") 29​ 30    # Ensure SSH directories exist 31    try: 32        os.makedirs(ssh_dir, exist_ok=True) 33        os.makedirs(ssh_host_keys_dir, exist_ok=True) 34        logger.debug(f"Ensured existence of SSH directories: {ssh_dir}, {ssh_host_keys_dir}") 35    except OSError as e: 36        logger.error(f"Failed to create SSH directories: {e}") 37        return 38​ 39    # Set appropriate permissions for the SSH directory 40    try: 41        os.chmod(ssh_dir, stat.S_IRWXU | stat.S_IRGRP | stat.S_IXGRP | stat.S_IROTH | stat.S_IXOTH) 42        os.chmod(ssh_host_keys_dir, stat.S_IRWXU | stat.S_IRGRP | stat.S_IXGRP | stat.S_IROTH | stat.S_IXOTH) 43        logger.debug(f"Set permissions for SSH directories: {ssh_dir}, {ssh_host_keys_dir}") 44    except OSError as e: 45        logger.error(f"Failed to set permissions for SSH directories: {e}") 46        return 47​ 48    # Generate keys 49    for key_type, filename in key_types.items(): 50        key_path = os.path.join(ssh_host_keys_dir, filename) 51        # Use ssh-keygen with specific options for host keys 52        # -t: key type 53        # -f: output file 54        # -N "": empty passphrase 55        # -q: quiet mode 56        # -b: bits (for RSA/DSA, not applicable for ECDSA/Ed25519) 57        command = ["ssh-keygen", "-t", key_type, "-f", key_path, "-N", "", "-q"] 58        if key_type in ["rsa", "dsa"]: 59            # Default bit lengths are usually sufficient, but can be specified if needed 60            # For RSA, 2048 or 4096 are common. For DSA, 1024 is common. 61            if key_type == "rsa": 62                command.extend(["-b", "4096"]) 63            elif key_type == "dsa": 64                command.extend(["-b", "1024"]) 65​ 66        try: 67            logger.info(f"Generating {key_type} SSH host key at {key_path}...") 68            # Use subprocess.run for better control and error handling 69            # check=True will raise CalledProcessError if the command returns a non-zero exit code 70            # capture_output=True to get stdout/stderr 71            # text=True to decode stdout/stderr as text 72            result = subprocess.run( 73                command, 74                check=True, 75                capture_output=True, 76                text=True, 77                timeout=60  # Add a timeout to prevent hanging 78            ) 79            logger.debug(f"ssh-keygen stdout for {key_type}: {result.stdout}") 80            logger.debug(f"ssh-keygen stderr for {key_type}: {result.stderr}") 81​ 82            # Set restrictive permissions for private keys 83            private_key_path = key_path 84            public_key_path = f"{key_path}.pub" 85​ 86            os.chmod(private_key_path, stat.S_IRUSR | stat.S_IWUSR)  # Read/write for owner only 87            os.chmod(public_key_path, stat.S_IRUSR | stat.S_IRGRP | stat.S_IROTH) # Read for all 88​ 89            logger.debug(f"Set permissions for private key {private_key_path} and public key {public_key_path}") 90​ 91        except FileNotFoundError: 92            logger.error("ssh-keygen command not found. Please ensure OpenSSH client tools are installed.") 93            return 94        except subprocess.CalledProcessError as e: 95            logger.error(f"Failed to generate {key_type} SSH host key: {e}") 96            logger.error(f"Command: {' '.join(e.cmd)}") 97            logger.error(f"Return code: {e.returncode}") 98            logger.error(f"Stderr: {e.stderr}") 99            logger.error(f"Stdout: {e.stdout}")100        except subprocess.TimeoutExpired:101            logger.error(f"Timeout generating {key_type} SSH host key.")102        except OSError as e:103            logger.error(f"Failed to set permissions for generated keys: {e}")104        except Exception as e:105            logger.error(f"An unexpected error occurred during {key_type} key generation: {e}")106​107    # Configure sshd_config to use the generated keys108    sshd_config_path = os.path.join(ssh_dir, "sshd_config")109    try:110        with open(sshd_config_path, "r") as f:111            lines = f.readlines()112​113        # Remove existing HostKey directives to ensure only new keys are used114        new_lines = [115            line for line in lines116            if not line.strip().startswith("HostKey")117        ]118​119        # Add new HostKey directives pointing to the generated keys120        # Order matters for some SSH versions, typically RSA first.121        # SSH1 is generally discouraged and often disabled by default.122        # We'll add RSA, ECDSA, Ed25519 as they are modern and secure.123        # DSA is deprecated. SSH1 is legacy.124        host_keys_to_add = [125            os.path.join(ssh_host_keys_dir, key_types["rsa"]),126            os.path.join(ssh_host_keys_dir, key_types["ecdsa"]),127            os.path.join(ssh_host_keys_dir, key_types["ed25519"]),128        ]129        # Add SSH1 and DSA only if they were successfully generated130        if os.path.exists(os.path.join(ssh_host_keys_dir, key_types["ssh1"])):131            host_keys_to_add.insert(0, os.path.join(ssh_host_keys_dir, key_types["ssh1"]))132        if os.path.exists(os.path.join(ssh_host_keys_dir, key_types["dsa"])):133            host_keys_to_add.insert(1, os.path.join(ssh_host_keys_dir, key_types["dsa"]))134​135​136        for key_file in host_keys_to_add:137            new_lines.append(f"HostKey {key_file}\n")138​139        with open(sshd_config_path, "w") as f:140            f.writelines(new_lines)141​142        logger.info(f"Updated {sshd_config_path} to use generated SSH host keys.")143​144    except FileNotFoundError:145        logger.error(f"sshd_config file not found at {sshd_config_path}. Cannot configure SSH server.")146    except IOError as e:147        logger.error(f"Failed to read or write {sshd_config_path}: {e}")148    except Exception as e:149        logger.error(f"An unexpected error occurred while configuring sshd_config: {e}")

None