Merge pull request 'Make the displayed SSH username configurable' (#13) from mirsal/capsul-flask:ssh-username into yolocolo

Reviewed-on: 3wordchant/capsul-flask#12

capsulflask/__init__.py

@@ -58,6 +58,7 @@ app.config.from_mapping(
   LOG_LEVEL=os.environ.get("LOG_LEVEL", default="INFO"),
   SPOKE_HOST_ID=os.environ.get("SPOKE_HOST_ID", default="baikal"),
   SPOKE_HOST_TOKEN=os.environ.get("SPOKE_HOST_TOKEN", default="changeme"),
+  SSH_USERNAME=os.environ.get("SSH_USERNAME", default="cyberian"),
   HUB_TOKEN=os.environ.get("HUB_TOKEN", default="changeme"),
 
   # https://www.postgresql.org/docs/9.1/libpq-ssl.html#LIBPQ-SSL-SSLMODE-STATEMENTS

capsulflask/console.py

@@ -29,12 +29,14 @@ def make_capsul_id():
   letters_n_nummers = generate(alphabet="1234567890qwertyuiopasdfghjklzxcvbnm", size=10)
   return f"capsul-{letters_n_nummers}"
 
-def double_check_capsul_address(id, ipv4, get_ssh_host_keys):
+def double_check_capsul_address(id, ipv4, ipv6, get_ssh_host_keys):
   try:
     result = current_app.config["HUB_MODEL"].get(id, get_ssh_host_keys)
     if result != None and result.ipv4 != None and result.ipv4 != ipv4:
-      ipv4 = result.ipv4
-      get_model().update_vm_ip(email=session["account"], id=id, ipv4=result.ipv4)
+      get_model().update_vm_ipv4(email=session["account"], id=id, ipv4=result.ipv4)
+
+    if result != None and result.ipv6 != None and result.ipv6 != ipv6:
+      get_model().update_vm_ipv6(email=session["account"], id=id, ipv6=result.ipv6)
 
     if result != None and result.ssh_host_keys != None and get_ssh_host_keys:
       get_model().update_vm_ssh_host_keys(email=session["account"], id=id, ssh_host_keys=result.ssh_host_keys)
@@ -61,36 +63,37 @@ def index():
   # for now we are going to check the IP according to the virt model
   # on every request. this could be done by a background job and cached later on...
   for vm in vms:
-    result = double_check_capsul_address(vm["id"], vm["ipv4"], False)
+    result = double_check_capsul_address(vm["id"], vm["ipv4"], vm["ipv6"], False)
     if result is not None:
       vm["ipv4"] = result.ipv4
+      vm["ipv6"] = result.ipv6
       vm["state"] = result.state
     else:
       vm["state"] = "unknown"
 
-
   mappedVms = []
   for vm in vms:
-    ip_display = vm['ipv4']
-    if not ip_display:
+    ip_display = {}
+    ip_display_class = {}
+    for af in ['ipv4', 'ipv6']:
+      ip_display[af] = vm[af]
+      ip_display_class[af] = "ok"
+      if not ip_display[af]:
         if vm["state"] == "running":
-        ip_display = "..booting.."
+          ip_display[af] = "..booting.."
+          ip_display_class[af] = "waiting-pulse"
         else:
-        ip_display = "unknown"
-
-    ip_display_class = "ok"
-    if not vm['ipv4']:
-      if vm["state"] == "running":
-        ip_display_class = "waiting-pulse"
-      else:
-        ip_display_class = "yellow"
+          ip_display[af] = "unknown"
+          ip_display_class[af] = "yellow"
 
     mappedVms.append(dict(
       id=vm['id'],
       size=vm['size'],
       state=vm['state'],
-      ipv4=ip_display, 
-      ipv4_status=ip_display_class, 
+      ipv4=ip_display['ipv4'],
+      ipv4_status=ip_display_class['ipv4'],
+      ipv6=ip_display['ipv6'],
+      ipv6_status=ip_display_class['ipv6'],
       os=vm['os'],
       created=vm['created'].strftime("%b %d %Y")
     ))
@@ -109,6 +112,8 @@ def detail(id):
   if vm is None:
     return abort(404, f"{id} doesn't exist.")
 
+  vm['ssh_username'] = current_app.config['SSH_USERNAME']
+
   if vm['deleted']:
     return render_template("capsul-detail.html", vm=vm, delete=True, deleted=True)
 
@@ -168,10 +173,11 @@ def detail(id):
   else:
     needs_ssh_host_keys = "ssh_host_keys" not in vm or len(vm["ssh_host_keys"]) == 0
 
-    vm_from_virt_model = double_check_capsul_address(vm["id"], vm["ipv4"], needs_ssh_host_keys)
+    vm_from_virt_model = double_check_capsul_address(vm["id"], vm["ipv4"], vm['ipv6'], needs_ssh_host_keys)
     
     if vm_from_virt_model is not None:
       vm["ipv4"] = vm_from_virt_model.ipv4
+      vm["ipv6"] = vm_from_virt_model.ipv6
       vm["state"] = vm_from_virt_model.state
       if needs_ssh_host_keys:
         vm["ssh_host_keys"] = vm_from_virt_model.ssh_host_keys

capsulflask/db_model.py

@@ -179,10 +179,14 @@ class DBModel:
       self.cursor.fetchall()
     ))
 
-  def update_vm_ip(self, email, id, ipv4):
+  def update_vm_ipv4(self, email, id, ipv4):
     self.cursor.execute("UPDATE vms SET public_ipv4 = %s WHERE email = %s AND id = %s", (ipv4, email, id))
     self.connection.commit()
 
+  def update_vm_ipv6(self, email, id, ipv6):
+    self.cursor.execute("UPDATE vms SET public_ipv6 = %s WHERE email = %s AND id = %s", (ipv6, email, id))
+    self.connection.commit()
+
   def update_vm_ssh_host_keys(self, email, id, ssh_host_keys):
     for key in ssh_host_keys:
       self.cursor.execute(""" 

capsulflask/landing.py

@@ -22,7 +22,7 @@ def pricing():
 
 @bp.route("/faq")
 def faq():
-  return render_template("faq.html")
+  return render_template("faq.html", ssh_username=current_app.config['SSH_USERNAME'])
 
 @bp.route("/about-ssh")
 def about_ssh():

capsulflask/shell_scripts/get.sh

@@ -29,7 +29,8 @@ if virsh domuuid "$vmname" | grep -vqE '^[\t\s\n]*$'; then
   esac
 fi
 
-# this gets the ipv4
-ipv4="$(virsh domifaddr "$vmname" | awk '/vnet/ {print $4}' | cut -d'/' -f1)"
+# this gets the vm ip addresses
+ipv4="$(virsh domifaddr "$vmname" | awk '/ipv4/ {print $4}' | cut -d'/' -f1)"
+ipv6="$(virsh domifaddr "$vmname" | awk '/ipv6/ {print $4}' | cut -d'/' -f1)"
 
-echo "$exists $state $ipv4"
+echo "$exists $state $ipv4 $ipv6"

capsulflask/spoke_model.py

@@ -114,24 +114,30 @@ class ShellScriptSpoke(VirtualizationInterface):
     if len(fields) < 3:
       return VirtualMachine(id, current_app.config["SPOKE_HOST_ID"], state=state)
 
-    ipaddr = fields[2]
+    ip4addr = fields[2]
 
-    if not re.match(r"^([0-9]{1,3}\.){3}[0-9]{1,3}$", ipaddr):
+    if not re.match(r"^([0-9]{1,3}\.){3}[0-9]{1,3}$", ip4addr):
       return VirtualMachine(id, current_app.config["SPOKE_HOST_ID"], state=state)
 
     if get_ssh_host_keys:
       try:
-        completedProcess2 = run([join(current_app.root_path, 'shell_scripts/ssh-keyscan.sh'), ipaddr], capture_output=True)
+        completedProcess2 = run([join(current_app.root_path, 'shell_scripts/ssh-keyscan.sh'), ip4addr], capture_output=True)
         self.validate_completed_process(completedProcess2)
         ssh_host_keys = json.loads(completedProcess2.stdout.decode("utf-8"))
-        return VirtualMachine(id, current_app.config["SPOKE_HOST_ID"], state=state, ipv4=ipaddr, ssh_host_keys=ssh_host_keys)
+        return VirtualMachine(id, current_app.config["SPOKE_HOST_ID"], state=state, ipv4=ip4addr, ssh_host_keys=ssh_host_keys)
       except:
         current_app.logger.warning(f"""
-          failed to ssh-keyscan {id} at {ipaddr}:
+          failed to ssh-keyscan {id} at {ip4addr}:
           {my_exec_info_message(sys.exc_info())}"""
         )
 
-    return VirtualMachine(id, current_app.config["SPOKE_HOST_ID"], state=state, ipv4=ipaddr)
+    if len(fields) < 4:
+        return VirtualMachine(id, current_app.config["SPOKE_HOST_ID"], state=state, ipv4=ip4addr)
+
+    ip6addr = fields[3]
+
+    return VirtualMachine(id, current_app.config["SPOKE_HOST_ID"], state=state, ipv4=ip4addr, ipv6=ip6addr)
+
 
   def list_ids(self) -> list:
     completedProcess = run([join(current_app.root_path, 'shell_scripts/list-ids.sh')], capture_output=True)

capsulflask/templates/capsul-detail.html

@@ -79,6 +79,10 @@
         <label class="align" for="ipv4">IPv4 Address</label>
         <span id="ipv4">{{ vm['ipv4'] }}</span>
       </div>
+      <div class="row justify-start">
+        <label class="align" for="ipv6">IPv6 Address</label>
+        <span id="ipv6">{{ vm['ipv6'] }}</span>
+      </div>
       <div class="row justify-start">
         <label class="align" for="os_description">Operating System</label>
         <span id="os_description">{{ vm['os_description'] }}</span>
@@ -97,7 +101,7 @@
       </div>
       <div class="row justify-start">
         <label class="align" for="ssh_username">SSH Username</label>
-        <span id="ssh_username">cyberian</span>
+        <span id="ssh_username">{{ vm['ssh_username'] }}</span>
       </div>
       <div class="row justify-start">
         <label class="align" for="ssh_authorized_keys">SSH Authorized Keys</label>

capsulflask/templates/faq.html

@@ -21,13 +21,13 @@
    </li>
    <li>
      How do I log in?
-     <p>ssh to the ip provided to you using the cyberian user.</p>
-     <pre class='code'>$ ssh cyberian@1.2.3.4</pre>
+     <p>ssh to the ip provided to you using the "{{ ssh_username }}" user.</p>
+     <pre class='code'>$ ssh {{ ssh_username }}@1.2.3.4</pre>
      <p>For more information, see <a href="/about-ssh">Understanding the Secure Shell Protocol (SSH)</a>.</p>
    </li>
    <li>
      How do I change to the root user?
-     <p>The cyberian user has passwordless sudo access by default. This should work:</p>
+     <p>The "{{ ssh_username }}" user has passwordless sudo access by default. This should work:</p>
      <pre class='code'>
 # Linux
 $ sudo su -