Refactor credential prompt in common.py

Signed-off-by: David Seaward <david.seaward@puri.sm>

scripts/liberty.py

@@ -4,17 +4,26 @@ from scripts.nautilus_files_setup import nautilus_files_setup
 
 
 @click.group()
-def cli():
+@click.pass_context
+def cli(ctx):
+    """Liberty CLI is a command line tool for interacting with Librem
+    One and other Liberty Domain Hosts (LDHs)."""
     pass
 
 
-@cli.command()
+@cli.group()
+def setup():
+    """Configure or reconfigure services on an XDG desktop."""
+    pass
+
+
+@setup.command(name="tunnel")
 def tunnel_setup():
-    """Add tunnel config to NetworkManager"""
+    """Download tunnel config and add to NetworkManager."""
     nm_tunnel_setup()
 
 
-@cli.command()
+@setup.command(name="files")
 def files_setup():
     """Create mountpoint for files."""
     nautilus_files_setup()

scripts/nautilus_files_setup.py

@@ -3,7 +3,9 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
 import sh
+from scripts.common import *
 
 
 def nautilus_files_setup():
-    print(sh.echo("Work in progress"))
+    credentials = prompt_for_credentials()
+    print(sh.echo("Hello world!"))

scripts/nm_tunnel_setup.py

@@ -11,63 +11,57 @@ import sys
 import os
 import requests
 import gi
-import re
 from tempfile import mkstemp
-from getpass import getpass
 from json.decoder import JSONDecodeError
-gi.require_version('NM', '1.0')
-from gi.repository import NM, GLib
 
+gi.require_version("NM", "1.0")
+from gi.repository import NM, GLib
+from scripts.common import *
 
-PROTO = 'https://'
-PATH = '/api/v1/user/tunnel_account'
-CERT_PATH = '/public/certificate.ovpn'
-QQN = 'US1'
+PROTO = "https://"
+PATH = "/api/v1/user/tunnel_account"
+CERT_PATH = "/public/certificate.ovpn"
+QQN = "US1"
 
 
 def nm_tunnel_setup():
     """This script will:
-    1. Ask for Librem One credentilas.
-    2. Retrieve tunnel account credentials from librem.one.
-    3. Download .ovpn config file from librem.one.
+    1. Prompt for LDH credentials.
+    2. Retrieve tunnel credentials from host.
+    3. Download .ovpn config file from host.
     4. Setup new VPN connection in your NetworkManager.
     """
+
     # Get tunnel credentials
-    address = input('Enter your Librem One address: ')
-    regex = r'^[A-Za-z][A-Za-z0-9]*@[A-Za-z0-9]+(\.[A-Za-z0-9]+)+$'
-    if not re.match(regex, address):
-        print(address, 'is not a valid email address.')
-        sys.exit(1)
-    (user, host) = address.split('@')
-    passwd = getpass('Enter your password: ')
+    credentials = prompt_for_credentials()
 
-    url = PROTO + host + PATH
+    url = PROTO + credentials.host + PATH
     try:
-        r = requests.get(url, auth=(user, passwd))
+        r = requests.get(url, auth=(credentials.user, credentials.passphrase))
     except requests.exceptions.ConnectionError as e:
         print(repr(e))
         sys.exit(1)
     if r.status_code == 200:
-        tunnel_user = r.json().get('tunnel_user')
-        tunnel_password = r.json().get('tunnel_password')
-        if tunnel_password is None or tunnel_password is None:
-            print('Your tunnel service is not active')
+        tunnel_user = r.json().get("tunnel_user")
+        tunnel_password = r.json().get("tunnel_password")
+        if tunnel_user is None or tunnel_password is None:
+            print("Your tunnel service is not active")
             sys.exit(1)
     else:
-        print('\nSomething went wrong when connecting to', url)
+        print("\nSomething went wrong when connecting to", url)
         try:
-            detail = r.json().get('detail', 'No detail available')
+            detail = r.json().get("detail", "No detail available")
         except JSONDecodeError as e:
             detail = r.reason
-        print('Problem details:', detail)
+        print("Problem details:", detail)
         sys.exit(1)
 
     # Download certificate
-    cert_url = PROTO + host + CERT_PATH
-    (fd, fname) = mkstemp(suffix='.ovpn')
+    cert_url = PROTO + credentials.host + CERT_PATH
+    (fd, fname) = mkstemp(suffix=".ovpn")
     try:
         with requests.get(cert_url, stream=True) as r:
-            with open(fd, 'wb') as f:
+            with open(fd, "wb") as f:
                 for chunk in r.iter_content(chunk_size=1024):
                     if chunk:
                         f.write(chunk)
@@ -78,10 +72,10 @@ def nm_tunnel_setup():
 
     # Configure NetworkManager
     client = NM.Client.new(None)
-    plugin = NM.VpnEditorPlugin.load('/usr/lib/x86_64-linux-gnu/'
-                                     'NetworkManager/'
-                                     'libnm-vpn-plugin-openvpn.so',
-                                     'org.freedesktop.NetworkManager.openvpn')
+    plugin = NM.VpnEditorPlugin.load(
+        "/usr/lib/x86_64-linux-gnu/NetworkManager/libnm-vpn-plugin-openvpn.so",
+        "org.freedesktop.NetworkManager.openvpn",
+    )
     try:
         new_con = plugin.import_(fname)
     except Exception as e:
@@ -91,24 +85,25 @@ def nm_tunnel_setup():
     new_con.normalize()
 
     # Create the new secret
-    new_secrets = GLib.Variant('a{sa{sv}}',
-                               {'vpn':
-                                {'secrets':
-                                 GLib.Variant('a{ss}',
-                                              {'password': tunnel_password})},
-                                'ipv6': {}})
+    new_secrets = GLib.Variant(
+        "a{sa{sv}}",
+        {
+            "vpn": {"secrets": GLib.Variant("a{ss}", {"password": tunnel_password})},
+            "ipv6": {},
+        },
+    )
 
     # Update the connection with the secret
     new_con.update_secrets(NM.SETTING_VPN_SETTING_NAME, new_secrets)
 
     # Add the username to the VPN settings
     vpn_settings = new_con.get_setting_vpn()
-    vpn_settings.add_data_item('username', tunnel_user)
+    vpn_settings.add_data_item("username", tunnel_user)
 
     # Set Connection Name
-    con_name = '{user}@{domain} {country_code}'.format(user=user,
-                                                       domain=host,
-                                                       country_code=QQN)
+    con_name = "{address} {country_code}".format(
+        address=credentials.address, country_code=QQN
+    )
     new_con_settings = new_con.get_setting_connection()
     new_con_settings.set_property(NM.SETTING_CONNECTION_ID, con_name)
 
@@ -132,5 +127,5 @@ def nm_tunnel_setup():
     main_loop.run()
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     nm_tunnel_setup()