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

Reviewed-on: #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,37 +63,38 @@ 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:
-      if vm["state"] == "running":
-        ip_display = "..booting.."
-      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 = {}
+    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[af] = "..booting.."
+          ip_display_class[af] = "waiting-pulse"
+        else:
+          ip_display[af] = "unknown"
+          ip_display_class[af] = "yellow"
 
     mappedVms.append(dict(
-      id=vm['id'], 
-      size=vm['size'], 
+      id=vm['id'],
+      size=vm['size'],
       state=vm['state'],
-      ipv4=ip_display, 
-      ipv4_status=ip_display_class, 
-      os=vm['os'], 
+      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
@@ -189,7 +195,7 @@ def detail(id):
       duration=duration
     )
 
-def _create(vm_sizes, operating_systems, public_keys_for_account, affordable_vm_sizes, server_data):
+def _create(email, vm_sizes, operating_systems, public_keys_for_account, affordable_vm_sizes, server_data):
   errors = list()
 
   size = server_data.get("size")
@@ -241,14 +247,14 @@ def _create(vm_sizes, operating_systems, public_keys_for_account, affordable_vm_
   if len(errors) == 0:
     id = make_capsul_id()
     current_app.config["HUB_MODEL"].create(
-      email = session["account"],
+      email = email,
       id=id,
       os=os,
       size=size,
       template_image_file_name=operating_systems[os]['template_image_file_name'],
       vcpus=vm_sizes[size]['vcpus'],
       memory_mb=vm_sizes[size]['memory_mb'],
-      ssh_authorized_keys=posted_keys
+      ssh_authorized_keys=list(map(lambda x: dict(name=x['name'], content=x['content']), posted_keys))
     )
     return id, errors
 
@@ -276,6 +282,7 @@ def create():
     if "csrf-token" not in request.form or request.form['csrf-token'] != session['csrf-token']:
       return abort(418, f"u want tea")
     id, errors = _create(
+      session['account'],
       vm_sizes, 
       operating_systems,
       public_keys_for_account,

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/hub_api.py

@@ -178,4 +178,4 @@ def on_create_claimed(payload, host_id):
     network_name=payload['network_name'],
     public_ipv4=payload['public_ipv4'],
     ssh_authorized_keys=list(map(lambda x: x["name"], payload['ssh_authorized_keys'])),
-  )
+  )

capsulflask/hub_model.py

@@ -198,6 +198,10 @@ class CapsulFlaskHub(VirtualizationInterface):
     validate_capsul_id(id)
     online_hosts = get_model().get_online_hosts()
     #current_app.logger.debug(f"hub_model.create(): ${len(online_hosts)} hosts")
+
+    current_app.logger.error(f'{email}, {id} {os} {size} {template_image_file_name} {vcpus} {memory_mb}')
+    current_app.logger.error(f'{ssh_authorized_keys}')
+    
     payload = json.dumps(dict(
       type="create", 
       email=email, 
@@ -228,12 +232,13 @@ class CapsulFlaskHub(VirtualizationInterface):
       except:
         # no need to do anything here since if it cant be parsed then generic_operation will handle it.
         pass
+
+    if error_message != "":
+      raise ValueError(f"create capsul operation {operation_id} on {assigned_hosts} failed with {error_message}")
       
     if number_of_assigned != 1:
       assigned_hosts_string = ", ".join(assigned_hosts)
       raise ValueError(f"expected create capsul operation {operation_id} to be assigned to one host, it was assigned to {number_of_assigned} ({assigned_hosts_string})")
-    if error_message != "":
-      raise ValueError(f"create capsul operation {operation_id} on {assigned_hosts_string} failed with {error_message}")
       
 
   def destroy(self, email: str, id: str):

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/publicapi.py

@@ -15,7 +15,7 @@ bp = Blueprint("publicapi", __name__, url_prefix="/api")
 @bp.route("/capsul/create", methods=["POST"])
 @account_required
 def capsul_create():
-    email = session["account"]
+    email = session["account"][0]
     
     from .console import _create, get_account_balance, get_payments, get_vms
 
@@ -36,6 +36,7 @@ def capsul_create():
     request.json['ssh_authorized_key_count'] = 1
 
     id, errors = _create(
+      email,
       vm_sizes, 
       operating_systems,
       public_keys_for_account,

capsulflask/shell_scripts/capacity-avaliable.sh

@@ -3,7 +3,7 @@
 # check available RAM and IPv4s
 
 ram_bytes_to_allocate="$1"
-ram_bytes_available=$(grep -E "^(size|memory_available_bytes)" /proc/spl/kstat/zfs/arcstats | awk '{sum+=$3} END {printf "%.0f", sum}')
+ram_bytes_available="$(($(grep Available /proc/meminfo | grep -o '[0-9]*') * 1024))"
 ram_bytes_remainder="$((ram_bytes_available - ram_bytes_to_allocate))"
 
 if echo "$ram_bytes_to_allocate" | grep -vqE "^[0-9]+$"; then
@@ -11,8 +11,8 @@ if echo "$ram_bytes_to_allocate" | grep -vqE "^[0-9]+$"; then
   exit 1
 fi
 
-# 20GB
-if [ "$ram_bytes_remainder" -le $((20 * 1024 * 1024 * 1024)) ]; then
+# 0.25GB
+if [ "$ram_bytes_remainder" -le $((1 * 1024 * 1024 * 1024 / 4)) ]; then
   echo "VM is requesting more RAM than $(hostname -f) has available."
   echo "Bytes requested: $ram_bytes_to_allocate"
   echo "Bytes available: $ram_bytes_available"

capsulflask/shell_scripts/create.sh

@@ -6,6 +6,7 @@
 
 vmname="$1"
 template_file="/tank/img/$2"
+qemu_tank_dir="/tank"
 vcpus="$3"
 memory="$4"
 pubkeys="$5"
@@ -50,40 +51,40 @@ if echo "$public_ipv4" | grep -vqE "^[0-9.]+$"; then
   exit 1
 fi
 
-disk="/tank/vm/$vmname.qcow2"
-cdrom="/tank/vm/$vmname.iso"
-xml="/tank/vm/$vmname.xml"
+disk="$vmname.qcow2"
+cdrom="$vmname.iso"
+xml="$vmname.xml"
 
 if [ -f /tank/vm/$vmname.qcow2 ]; then
     echo "Randomly generated name matched an existing VM! Odds are like one in a billion. Buy a lotto ticket."
     exit 1
 fi
 
-cp "$template_file" "$disk"
+cp "$template_file" "/tank/vm/$disk"
 cp /tank/config/cyberia-cloudinit.yml /tmp/cloudinit.yml
 echo "$pubkeys" | while IFS= read -r line; do
   echo "      - $line" >> /tmp/cloudinit.yml
 done
 
-cloud-localds "$cdrom" /tmp/cloudinit.yml
+cloud-localds "/tank/vm/$cdrom" /tmp/cloudinit.yml
 
-qemu-img resize "$disk" "$root_volume_size"
+qemu-img resize "/tank/vm/$disk" "$root_volume_size"
 virt-install \
     --memory "$memory" \
     --vcpus "$vcpus" \
     --name "$vmname" \
-    --disk "$disk",bus=virtio \
-    --disk "$cdrom",device=cdrom \
+    --disk "$qemu_tank_dir/vm/$disk",bus=virtio \
+    --disk "$qemu_tank_dir/vm/$cdrom",device=cdrom \
     --os-type Linux \
     --os-variant generic \
     --virt-type kvm \
     --graphics vnc,listen=127.0.0.1 \
-    --network network=$network_name,filterref=clean-traffic,model=virtio \
+    --network network=$network_name,model=virtio \
     --import \
-    --print-xml > "$xml"
+    --print-xml > "/tank/vm/$xml"
 
-chmod 0600 "$xml" "$disk" "$cdrom"
-virsh define "$xml"
+chmod 0600 "/tank/vm/$xml" "/tank/vm/$disk" "/tank/vm/$cdrom"
+virsh define "/tank/vm/$xml"
 virsh start "$vmname"
 
 echo "success"

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/static/style.css

@@ -1,8 +1,8 @@
 html {
-  color: #bdc7b8;
+  color: #241e1e;
   font: calc(0.40rem + 1vmin) monospace;
   overflow-y: scroll;
-  background-color: #241e1e;
+  background-color: #bdc7b8;
 }
 
 body {
@@ -19,8 +19,8 @@ body {
 }
 
 a {
-  color:#6CF;
-  text-shadow: 1px 1px 0px #000c;
+  color:#00517a;
+  text-shadow: 1px 1px 0px #eee;
 }
 
 a.no-shadow {
@@ -28,7 +28,7 @@ a.no-shadow {
 }
 
 a:hover, a:active, a:visited {
-  color: #b5bd68;
+  color: #323417;
 } 
 
 .nav-links  a {
@@ -59,11 +59,11 @@ h1, h2, h3, h4, h5 {
   margin: initial;
   padding: initial;
   text-transform: uppercase;
-  text-shadow: 2px 2px 0px #0007;
+  text-shadow: 2px 2px 0px #eee;
 }
 
 main {
-  border: 1px dashed #bdc7b8;
+  border: 1px dashed #241e1e;
   padding: 1rem;
   margin-bottom: 2em;
 
@@ -143,7 +143,7 @@ input, textarea, select, label {
 input, select, textarea {
   outline: 0;
   padding: 0.25em 0.5em;
-  color: #bdc7b8;
+  color: #241e1e;
   background-color: #bdc7b805;
 }
 

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 -

capsulflask/theme/yolocolo/base.html

@@ -2,7 +2,7 @@
 <head>
   <!-- Namecoin Address: N2aVL6pHtBp7EtNGb3jpsL2L2NyjBNbiB1 -->
   <link href="{{ url_for('static', filename='favicon.yolocolo.ico') }}" rel="icon">
-  <title>{% block title %}{% endblock %}{% if self.title() %} - {% endif %}Capsul</title>
+  <title>{% block title %}{% endblock %}{% if self.title() %} - {% endif %}Serverscoop</title>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width,initial-scale=1.0">
   <meta name="Description" content="Cyberia Capsul">
@@ -14,7 +14,7 @@
 <nav>
   <div class="row justify-space-between half-margin">
     <div>
-      🦉 <a href="/"><b>YOLOCOLO</b></a>
+      🍞 <a href="/"><b>serverscoop</b></a>
     </div>
     <div>
       &nbsp;
@@ -31,7 +31,7 @@
 
     {% if session["account"] %} 
       <a href="/console">Capsuls</a>
-      <a href="/console/ssh">SSH Public Keys</a>
+      <a href="/console/keys">SSH &amp; API Keys</a>
       <a href="/console/account-balance">Account Balance</a>
     {% endif %}
 
@@ -49,9 +49,7 @@
 <footer>
   This server runs <a
     href="https://giit.cyberia.club/~forest/capsul-flask">capsul-flask</a> by
-  Cyberia Computer Club, available under the <a
-    href="https://creativecommons.org/licenses/by-sa/4.0/">Attribution-ShareAlike
-    4.0 International</a> licence.<br/><br/>
+  Cyberia Computer Club, available under the GNU AFFERO GENERAL PUBLIC LICENSE.<br/><br/>
   <a href="https://git.autonomic.zone/3wordchant/capsul-flask/src/branch/yolocolo/capsulflask{% block pagesource %}{% endblock %}">View page source</a>
 </footer>
 </body>

capsulflask/theme/yolocolo/index.html

@@ -3,13 +3,11 @@
 {% block content %}
   <h1>
   <pre>
-             _                 _
- _   _  ___ | | ___   ___ ___ | | ___
-| | | |/ _ \| |/ _ \ / __/ _ \| |/ _ \
-| |_| | (_) | | (_) | (_| (_) | | (_) |
- \__, |\___/|_|\___/ \___\___/|_|\___/
- |___/
-
+ ___  ___ _ ____   _____ _ __ ___  ___ ___   ___  _ __  
+/ __|/ _ \ '__\ \ / / _ \ '__/ __|/ __/ _ \ / _ \| '_ \ 
+\__ \  __/ |   \ V /  __/ |  \__ \ (_| (_) | (_) | |_) |
+|___/\___|_|    \_/ \___|_|  |___/\___\___/ \___/| .__/ 
+                                                 |_|    
   </pre>
   <span>Co-operative hosting using <a href="https://cyberia.club">Cyberia</a>'s Capsul</span>
 {% endblock %}