API Token Login

Add full support for passwordless token-only login.

build_vdiclient.bat

@@ -1,5 +1,5 @@
 @echo off
-pyinstaller --noconsole --noconfirm --hidden-import proxmoxer.backends --hidden-import proxmoxer.backends.https --hidden-import proxmoxer.backends.https.AuthenticationError --hidden-import proxmoxer.core --hidden-import proxmoxer.core.ResourceException --hidden-import subprocess.TimeoutExpired --hidden-import subprocess.CalledProcessError --hidden-import requests.exceptions --hidden-import requests.exceptions.ConnectTimeout --hidden-import requests.exceptions.ConnectionError -i vdiicon.ico vdiclient.py
+pyinstaller --noconsole --noconfirm --hidden-import proxmoxer.backends --hidden-import proxmoxer.backends.https --hidden-import proxmoxer.backends.https.AuthenticationError --hidden-import proxmoxer.core --hidden-import proxmoxer.core.ResourceException --hidden-import subprocess.TimeoutExpired --hidden-import subprocess.CalledProcessError --hidden-import requests.exceptions --hidden-import requests.exceptions.ReadTimeout --hidden-import requests.exceptions.ConnectTimeout --hidden-import requests.exceptions.ConnectionError -i vdiicon.ico vdiclient.py
 copy vdiclient.png dist\vdiclient
 copy vdiicon.ico dist\vdiclient
 del dist\vdiclient\opengl32sw.dll

dist/vdiclient.json

@@ -1,6 +1,6 @@
 {
 	"upgrade_guid" : "46cbad92-353e-4b28-9bee-83950991dad8",
-	"version" : "1.0.1",
+	"version" : "1.0.8",
 	"product_name" : "VDI Client",
 	"manufacturer" : "Josh Patten",
 	"name" : "VDI Client",

requirements.bat

@@ -2,4 +2,5 @@
 pip install pyinstaller
 pip install proxmoxer
 pip install PySimpleGUIQt
-pip install requests
+pip install requests
+pip install pywin32

requirements.sh

@@ -1,3 +1,6 @@
 #!/bin/bash
 pip3 install proxmoxer
-pip3 install PySimpleGUIQt
+pip3 install PySimpleGUIQt
+# If PySimpleGUIQt fails, VDIClient will fall back to PySimpleGUI
+pip3 install PySimpleGUI
+pip3 install requests

vdiclient.ini.example

@@ -9,9 +9,12 @@ icon = vdiicon.ico
 logo = vdiclient.png
 # Enable Kiosk mode, which does not allow the user to close anything
 kiosk = False
+# Enable/Disable Fullscreen mode (not applicable in Kiosk mode)
+fullscreen = True
 # Enable displaying SPICE ini file before opening virt-viewer
 inidebug = False
 
+
 [Authentication]
 # This is the authentication backend that will be used to authenticate
 auth_backend = pve
@@ -19,7 +22,7 @@ auth_backend = pve
 auth_totp = false
 # If disabled, TLS certificate will not be checked
 tls_verify = false
-# User name
+# User name (if using token)
 #user = user
 # API Token Name
 #token_name = dvi
@@ -32,6 +35,17 @@ tls_verify = false
 pve1.example.com = 8006
 
 [SpiceProxyRedirect]
-# The Spice Proxy provided by the Proxmox API may need to have it's host/port rewritten
+# The Spice Proxy provided by the Proxmox API may need to have its host/port rewritten
 # These rewrite rules are written `IP:port = IP:port`
-pve1.example.com:3128 = 123.123.123.123:6000
+# 1. Use the inidebug and read the current proxy=pve1.example.com:3128
+# 2. Add your proxmox ip to the right side e.g. 123.123.123.123:6000
+pve1.example.com:3128 = 123.123.123.123:6000
+
+#[AdditionalParameters]
+# If you wish to define additional parameters to pass to virt-viewer you may define them here
+# More parameter definitions here: https://www.mankier.com/1/remote-viewer
+# Some Examples:
+# Enable USB passthrough
+#enable-usbredir = true
+# Enable auto USB device sharing
+#enable-usb-autoshare = true

vdiclient.py

@@ -1,6 +1,11 @@
 #!/usr/bin/python3
 import proxmoxer # pip install proxmoxer
-import PySimpleGUIQt as sg # pip install PySimpleGUIQt
+try:
+	import PySimpleGUIQt as sg # pip install PySimpleGUIQt
+	gui = 'QT'
+except ImportError:
+	import PySimpleGUI as sg # pip install PySimpleGUI
+	gui = 'TK'
 import requests
 from configparser import ConfigParser
 import random
@@ -11,11 +16,13 @@ from time import sleep
 from io import StringIO
 
 
+
 class G:
 	hostpool = []
 	spiceproxy_conv = {}
 	proxmox = None
 	vvcmd = None
+	scaling = 1
 	#########
 	title = 'VDI Login'
 	backend = 'pve'
@@ -25,12 +32,30 @@ class G:
 	totp = False
 	imagefile = None
 	kiosk = False
+	fullscreen = True
 	verify_ssl = True
 	icon = None
 	inidebug = False
+	addl_params = None
 	theme = 'LightBlue'
 
-sg.theme(G.theme)
+def get_dpi():
+	import ctypes
+	import win32api # pip install pywin32
+	shcore = ctypes.windll.shcore
+	monitors = win32api.EnumDisplayMonitors()
+	hresult = shcore.SetProcessDpiAwareness(2)
+	assert hresult == 0
+	dpiX = ctypes.c_uint()
+	dpiY = ctypes.c_uint()
+	for i, monitor in enumerate(monitors):
+		shcore.GetDpiForMonitor(
+			monitor[0].handle,
+			0,
+			ctypes.byref(dpiX),
+			ctypes.byref(dpiY)
+		)
+		return dpiX.value/96
 
 def loadconfig(config_location = None):
 	if config_location:
@@ -45,11 +70,16 @@ def loadconfig(config_location = None):
 			config_location = f'{os.getenv("APPDATA")}\\VDIClient\\vdiclient.ini'
 			if not os.path.exists(config_location):
 				config_location = f'{os.getenv("PROGRAMFILES")}\\VDIClient\\vdiclient.ini'
+			if not os.path.exists(config_location):
+				config_location = f'{os.getenv("PROGRAMFILES(x86)")}\\VDIClient\\vdiclient.ini'
+			if not os.path.exists(config_location):
+				# Last ditch effort
+				config_location = 'C:\\Program Files\\VDIClient\\vdiclient.ini'
 			if not os.path.exists(config_location):
 				win_popup_button(f'Unable to read supplied configuration from any location!', 'OK')
 				return False
 		elif os.name == 'posix': #Linux
-			config_location = '~/.config/VDIClient/vdiclient.ini'
+			config_location = os.path.expanduser('~/.config/VDIClient/vdiclient.ini')
 			if not os.path.exists(config_location):
 				config_location = '/etc/vdiclient/vdiclient.ini'
 			if not os.path.exists(config_location):
@@ -79,6 +109,8 @@ def loadconfig(config_location = None):
 				G.imagefile = config['General']['logo']
 		if 'kiosk' in config['General']:
 			G.kiosk = config['General'].getboolean('kiosk')
+		if 'fullscreen' in config['General']:
+			G.fullscreen = config['General'].getboolean('fullscreen')
 		if 'inidebug' in config['General']:
 			G.inidebug = config['General'].getboolean('inidebug')
 	if not 'Authentication' in config:
@@ -109,11 +141,16 @@ def loadconfig(config_location = None):
 	if 'SpiceProxyRedirect' in config:
 		for key in config['SpiceProxyRedirect']:
 			G.spiceproxy_conv[key] = config['SpiceProxyRedirect'][key]
+	if 'AdditionalParameters' in config:
+		G.addl_params = {}
+		for key in config['AdditionalParameters']:
+			G.addl_params[key] = config['AdditionalParameters'][key]
 	return True
 
 def win_popup(message):
 	layout = [[sg.Text(message)]]
 	window = sg.Window('Message', layout, no_titlebar=True, keep_on_top=True, finalize=True)
+	window.bring_to_front()
 	return window
 	
 def win_popup_button(message, button):
@@ -132,14 +169,14 @@ def win_popup_button(message, button):
 def setmainlayout():
 	layout = []
 	if G.imagefile:
-		layout.append([sg.Image(G.imagefile), sg.Text(G.title, size =(18, 1), justification='c', font=["Helvetica", 18])])
+		layout.append([sg.Image(G.imagefile), sg.Text(G.title, size =(18*G.scaling, 1*G.scaling), justification='c', font=["Helvetica", 18])])
 	else:
-		layout.append([sg.Text(G.title, size =(30, 1), justification='c', font=["Helvetica", 18])])
+		layout.append([sg.Text(G.title, size =(30*G.scaling, 1*G.scaling), justification='c', font=["Helvetica", 18])])
-	layout.append([sg.Text("Username", size =(12, 1), font=["Helvetica", 12]), sg.InputText(default_text=G.user,key='-username-', font=["Helvetica", 12])])
+	layout.append([sg.Text("Username", size =(12*G.scaling, 1*G.scaling), font=["Helvetica", 12]), sg.InputText(default_text=G.user,key='-username-', font=["Helvetica", 12])])
-	layout.append([sg.Text("Password", size =(12, 1),font=["Helvetica", 12]), sg.InputText(key='-password-', password_char='*', font=["Helvetica", 12])])
+	layout.append([sg.Text("Password", size =(12*G.scaling, 1*G.scaling),font=["Helvetica", 12]), sg.InputText(key='-password-', password_char='*', font=["Helvetica", 12])])
 	
 	if G.totp:
-		layout.append([sg.Text("OTP Key", size =(12, 1), font=["Helvetica", 12]), sg.InputText(key='-totp-', font=["Helvetica", 12])])
+		layout.append([sg.Text("OTP Key", size =(12*G.scaling, 1), font=["Helvetica", 12]), sg.InputText(key='-totp-', font=["Helvetica", 12])])
 	if G.kiosk:
 		layout.append([sg.Button("Log In", font=["Helvetica", 14])])
 	else:
@@ -148,17 +185,21 @@ def setmainlayout():
 
 def getvms():
 	vms = []
-	for vm in G.proxmox.cluster.resources.get(type='vm'):
+	try:
-		vms.append(vm)
+		for vm in G.proxmox.cluster.resources.get(type='vm'):
-	return vms
+			vms.append(vm)
+		return vms
+	except proxmoxer.core.ResourceException as e:
+		win_popup_button(f"Unable to display list of VMs:\n {e!r}", 'OK')
+		return False
 
 def setvmlayout(vms):
 	layout = []
 	if G.imagefile:
-		layout.append([sg.Image(G.imagefile), sg.Text(G.title, size =(18, 1), justification='c', font=["Helvetica", 18])])
+		layout.append([sg.Image(G.imagefile), sg.Text(G.title, size =(18*G.scaling, 1*G.scaling), justification='c', font=["Helvetica", 18])])
 	else:
-		layout.append([sg.Text(G.title, size =(30, 1), justification='c', font=["Helvetica", 18])])
+		layout.append([sg.Text(G.title, size =(30*G.scaling, 1*G.scaling), justification='c', font=["Helvetica", 18])])
-	layout.append([sg.Text('Please select a desktop instance to connect to', size =(40, 1), justification='c', font=["Helvetica", 10])])
+	layout.append([sg.Text('Please select a desktop instance to connect to', size =(40*G.scaling, 1*G.scaling), justification='c', font=["Helvetica", 10])])
 	layoutcolumn = []
 	for vm in vms:
 		if not vm["status"] == "unknown":
@@ -166,7 +207,7 @@ def setvmlayout(vms):
 			layoutcolumn.append([sg.Text(vm['name'], font=["Helvetica", 14]), sg.Button('Connect', font=["Helvetica", 14], key=connkeyname)])
 			layoutcolumn.append([sg.HorizontalSeparator()])
 	if len(vms) > 5: # We need a scrollbar
-		layout.append([sg.Column(layoutcolumn, scrollable = True, size = [450, None] )])
+		layout.append([sg.Column(layoutcolumn, scrollable = True, size = [450*G.scaling, None] )])
 	else:
 		for row in layoutcolumn:
 			layout.append(row)
@@ -175,7 +216,7 @@ def setvmlayout(vms):
 
 def iniwin(inistring):
 	inilayout = [
-			[sg.Multiline(default_text=inistring, size=(800, 600))]
+			[sg.Multiline(default_text=inistring, size=(800*G.scaling, 600*G.scaling))]
 	]
 	iniwindow = sg.Window('INI debug', inilayout)
 	while True:
@@ -205,7 +246,11 @@ def vmaction(vmnode, vmid, vmtype):
 		running = False
 		i = 0
 		while running == False and i < 30:
-			jobstatus = G.proxmox.nodes(vmnode).tasks(jobid).status.get()
+			try:
+				jobstatus = G.proxmox.nodes(vmnode).tasks(jobid).status.get()
+			except Exception:
+				# We ran into a query issue here, going to skip this round and try again
+				jobstatus = {}
 			if 'exitstatus' in jobstatus:
 				startpop.close()
 				startpop = None
@@ -227,15 +272,18 @@ def vmaction(vmnode, vmid, vmtype):
 		spiceconfig = G.proxmox.nodes(vmnode).lxc(str(vmid)).spiceproxy.post()
 	confignode = ConfigParser()
 	confignode['virt-viewer'] = {}
-	for key,value in spiceconfig.items():
+	for key, value in spiceconfig.items():
 		if key == 'proxy':
-			val = value[7:]
+			val = value[7:].lower()
 			if val in G.spiceproxy_conv:
 				confignode['virt-viewer'][key] = f'http://{G.spiceproxy_conv[val]}'
 			else:
 				confignode['virt-viewer'][key] = f'{value}'
 		else:
 			confignode['virt-viewer'][key] = f'{value}'
+	if G.addl_params:
+		for key, value in G.addl_params.items():
+			confignode['virt-viewer'][key] = f'{value}'
 	inifile = StringIO('')
 	confignode.write(inifile)
 	inifile.seek(0)
@@ -248,7 +296,7 @@ def vmaction(vmnode, vmid, vmtype):
 		pcmd.append('--kiosk')
 		pcmd.append('--kiosk-quit')
 		pcmd.append('on-disconnect')
-	else:
+	elif G.fullscreen:
 		pcmd.append('--full-screen')
 	pcmd.append('-') #We need it to listen on stdin
 	process = subprocess.Popen(pcmd, stdin=subprocess.PIPE, stdout=subprocess.PIPE)
@@ -284,7 +332,7 @@ def setcmd():
 			win_popup_button('Installation of virt-viewer missing, please install using `apt install virt-viewer`', 'OK')
 		sys.exit()
 
-def pveauth(username, passwd, totp):
+def pveauth(username, passwd=None, totp=None):
 	random.shuffle(G.hostpool)
 	err = None
 	for hostinfo in G.hostpool:
@@ -310,44 +358,59 @@ def pveauth(username, passwd, totp):
 				err = e
 				connected = True
 				return connected, authenticated, err
-			except (requests.exceptions.ConnectTimeout, requests.exceptions.ConnectionError) as e:
+			except (requests.exceptions.ReadTimeout, requests.exceptions.ConnectTimeout, requests.exceptions.ConnectionError) as e:
 				err = e
 				connected = False
 	return connected, authenticated, err
 
 def loginwindow():
 	layout = setmainlayout()
-	if G.icon:
+	if G.user and G.token_name and G.token_value: # We need to skip the login
-		window = sg.Window(G.title, layout, return_keyboard_events=True, resizable=False, no_titlebar=G.kiosk, icon=G.icon)
+		popwin = win_popup("Please wait, authenticating...")
-	else:
+		connected, authenticated, error = pveauth(G.user)
-		window = sg.Window(G.title, layout, return_keyboard_events=True, resizable=False, no_titlebar=G.kiosk)
+		popwin.close()
-	while True:
+		if not connected:
-		event, values = window.read()
+			win_popup_button(f'Unable to connect to any VDI server, are you connected to the Internet?\nError Info: {error}', 'OK')
-		if event == 'Cancel' or event == sg.WIN_CLOSED:
-			window.close()
 			return False
+		elif connected and not authenticated:
+			win_popup_button('Invalid username and/or password, please try again!', 'OK')
+			return False
+		elif connected and authenticated:
+			return True
+	else:
+		if G.icon:
+			window = sg.Window(G.title, layout, return_keyboard_events=True, resizable=False, no_titlebar=G.kiosk, icon=G.icon)
 		else:
-			if event in ('Log In', '\r', 'special 16777220', 'special 16777221'):
+			window = sg.Window(G.title, layout, return_keyboard_events=True, resizable=False, no_titlebar=G.kiosk)
-				popwin = win_popup("Please wait, authenticating...")
+		while True:
-				user = values['-username-']
+			event, values = window.read()
-				passwd = values['-password-']
+			if event == 'Cancel' or event == sg.WIN_CLOSED:
-				totp = None
+				window.close()
-				if '-totp-' in values:
+				return False
-					if values['-totp-'] not in (None, ''):
+			else:
-						totp = values['-totp-']
+				if event in ('Log In', '\r', 'special 16777220', 'special 16777221'):
-				connected, authenticated, error = pveauth(user, passwd, totp)
+					popwin = win_popup("Please wait, authenticating...")
-				popwin.close()
+					user = values['-username-']
-				if not connected:
+					passwd = values['-password-']
-					win_popup_button(f'Unable to connect to any VDI server, are you connected to the Internet?\nError Info: {error}', 'OK')
+					totp = None
-				elif connected and not authenticated:
+					if '-totp-' in values:
-					win_popup_button('Invalid username and/or password, please try again!', 'OK')
+						if values['-totp-'] not in (None, ''):
-				elif connected and authenticated:
+							totp = values['-totp-']
-					window.close()
+					connected, authenticated, error = pveauth(user, passwd=passwd, totp=totp)
-					return True
+					popwin.close()
-				#break
+					if not connected:
+						win_popup_button(f'Unable to connect to any VDI server, are you connected to the Internet?\nError Info: {error}', 'OK')
+					elif connected and not authenticated:
+						win_popup_button('Invalid username and/or password, please try again!', 'OK')
+					elif connected and authenticated:
+						window.close()
+						return True
+					#break
 
 def showvms():
 	vms = getvms()
+	if vms == False:
+		return False
 	if len(vms) < 1:
 		win_popup_button('No desktop instances found, please consult with your system administrator', 'OK')
 		return False
@@ -374,6 +437,13 @@ def showvms():
 	return True
 
 def main():
+	if os.name == 'nt' and gui == 'QT':
+		G.scaling = get_dpi()
+	else:
+		if gui == 'QT':
+			G.scaling = 1.0 #TODO FIXME: Figure out scaling on Linux
+		else:
+			G.scaling = 1 # TKinter requires integers
 	config_location = None
 	if len(sys.argv) > 1:
 		if sys.argv[1] == '--list_themes':
@@ -388,17 +458,22 @@ def main():
 	setcmd()
 	if not loadconfig(config_location):
 		return False
+	sg.theme(G.theme)
 	loggedin = False
 	while True:
 		if not loggedin:
 			loggedin = loginwindow()
 			if not loggedin:
+				if G.user and G.token_name and G.token_value: # This means if we don't exit we'll be in an infinite loop
+					return 1
 				break
 			else:
 				vmstat = showvms()
 				if not vmstat:
 					G.proxmox = None
 					loggedin = False
+					if G.user and G.token_name and G.token_value: # This means if we don't exit we'll be in an infinite loop
+						return 0
 				else:
 					return
 sys.exit(main())