Merge ~jslarraz/ubuntu-qa-tools:create-ssh-key into ubuntu-qa-tools:master

[Jorge Sancho Larraz]

uvt: automatically create ssh key if it does not exist

Currently uvt instruct the user to create an ssh key if it can not find one. This MR will create the key for the user.

[Marc Deslauriers (mdeslaur)]

I'd be pretty surprised if a tool created an ssh key for me without asking, could you please ask the user first for confirmation and specify where and what type of key will be created?

Make sure you create the .ssh directory with 700 permissions.

review: Needs Fixing

0903b96... by Jorge Sancho Larraz on 2024-02-16

uvt: ask the user for confirmation before creating the ssh key

[Jorge Sancho Larraz (jslarraz)]

Thanks Marc!

Commentaries addressed in https://git.launchpad.net/~jslarraz/ubuntu-qa-tools/commit/?id=0903b967ec3ae05cafd380347d845ef37d2f6ecb

9d7ed47... by Jorge Sancho Larraz on 2024-02-16

uvt: add extra print to improve readability

[Marc Deslauriers (mdeslaur)]

Prompt looks good!

I would switch makedirs() to mkdir(), we shouldn't be creating the user home directory, something clearly went wrong if we need to do that.

Please set permissions to 0o700 not 0o755, and use the mode parameter of mkdir() instead of doing a separate chmod.

Thanks!

review: Needs Fixing

01c8b4d... by Jorge Sancho Larraz on 2024-02-16

uvt: fix ~/.ssh creation

8623627... by Jorge Sancho Larraz on 2024-02-16

uvt: fix ~/.ssh creation

a50eeb7... by Jorge Sancho Larraz on 2024-02-16

uvt: fix ~/.ssh creation

[Jorge Sancho Larraz (jslarraz)]

You are absolutely right! Fixed in https://git.launchpad.net/~jslarraz/ubuntu-qa-tools/commit/?id=01c8b4d94004440e27eb3e8de67861235daf67a9

Also fixed a couple of issues it seems I overlooked in https://git.launchpad.net/~jslarraz/ubuntu-qa-tools/commit/?id=8623627603437d10bec357b86adfce70691e8de4 and https://git.launchpad.net/~jslarraz/ubuntu-qa-tools/commit/?id=a50eeb7bd61db154b2285689e97bb4f39ded18ec

[Marc Deslauriers (mdeslaur)]

looks good, thanks!

review: Approve

[Jorge Sancho Larraz (jslarraz)]

Merged in https://git.launchpad.net/ubuntu-qa-tools/commit/?id=e30482567362af27c0fcb0033d20db98cd952022

diff --git a/vm-tools/uvt b/vm-tools/uvt
index 7d655b1..fb7f5f2 100755
--- a/vm-tools/uvt
+++ b/vm-tools/uvt
@@ -3367,10 +3367,38 @@ def check_required_tools():
 def check_ssh_key():
     '''Checks if the user has an ssh key'''
 
+    # Ensure .ssh directory is initialized anyway
+    if not os.path.exists(os.path.expanduser("~/.ssh")):
+        os.mkdir(os.path.expanduser("~/.ssh"), mode=0o700)
+
     if not os.path.exists(uvt_conf['vm_ssh_key']):
-        print("\nYour user must have an ssh key.\n" +
-              "Please create one now with 'ssh-keygen -t rsa' and try again.\n", file=sys.stderr)
-        sys.exit(1)
+
+        # Infer key type from name, defaults to rsa
+        for key_type in ["ed25519-sk", "ed25519", "ecdsa-sk", "ecdsa", "dsa", "rsa"]:
+            if key_type in os.path.basename(uvt_conf['vm_ssh_key']):
+                break
+
+        conf_file = os.path.join(os.path.expanduser("~"), config_file)
+        if not os.path.exists(conf_file):
+            print("ssh key '~/.ssh/id_rsa.pub' defined in the default configuration does "
+                  "not exists. If you wish to use a different ssh key, you can launch "
+                  "'uvt config', which will create a default config file in ~/%s "
+                  "that you can customize." % config_file)
+
+        else:
+            print("ssh key '%s' defined in the configuration file '~/%s' does " 
+                  "not exists." % (uvt_conf['vm_ssh_key'], config_file))
+
+        print("")
+        if not confirm("Would you like to create a '%s' ssh key in '%s'" % (key_type, uvt_conf['vm_ssh_key'])):
+            print("Aborting.")
+            sys.exit(1)
+
+        os.makedirs(os.path.dirname(os.path.expanduser(uvt_conf['vm_ssh_key'])), exist_ok=True)
+        rc, out = runcmd(["ssh-keygen", "-t", key_type, "-f", uvt_conf['vm_ssh_key'].split(".pub")[0], "-q", "-N", ""])
+        if rc != 0:
+            print("Error while creating ssh key, please create it manually with 'ssh-keygen -t rsa'.")
+            sys.exit(1)
 
 def parse_config_file(conf_file):
     '''Parses a config file'''