add --external and --uri for convenient debugging/futzing purposes

[nu-vpn-proxy.git] / gp-saml-gui.py

diff --git a/gp-saml-gui.py b/gp-saml-gui.py
index 6bc121e6dccff8b72d7b6ebe4d821aa9e1a7b6d6..1f2b1b58663cf53aaea1f254eebe290ff9b5cd71 100755 (executable)
--- a/gp-saml-gui.py
+++ b/gp-saml-gui.py
@@ -6,9 +6,10 @@ import pprint
 import urllib
 import requests
 import xml.etree.ElementTree as ET
 import urllib
 import requests
 import xml.etree.ElementTree as ET

+import os

 
 from sys import stderr
 
 from sys import stderr

-from binascii import a2b_base64
+from binascii import a2b_base64, b2a_base64

 
 gi.require_version('Gtk', '3.0')
 from gi.repository import Gtk
 
 gi.require_version('Gtk', '3.0')
 from gi.repository import Gtk


@@ -17,31 +18,45 @@ gi.require_version('WebKit2', '4.0')
 from gi.repository import WebKit2
 
 class SAMLLoginView:
 from gi.repository import WebKit2
 
 class SAMLLoginView:

-    def __init__(self, uri, html=None, verbose=False):
+    def __init__(self, uri, html=None, verbose=False, cookies=None):

         window = Gtk.Window()
 
         # API reference: https://lazka.github.io/pgi-docs/#WebKit2-4.0
         window = Gtk.Window()
 
         # API reference: https://lazka.github.io/pgi-docs/#WebKit2-4.0

-        # TODO: cookies, see https://stackoverflow.com/questions/48368219/webkit2-webview-how-to-store-cookies-and-reuse-it-again

 
         self.success = False
 
         self.success = False

+        self.verbose = verbose
+
+        self.ctx = WebKit2.WebContext.get_default()
+        self.cookies = self.ctx.get_cookie_manager()
+        if args.cookies:
+            self.cookies.set_accept_policy(WebKit2.CookieAcceptPolicy.ALWAYS)
+            self.cookies.set_persistent_storage(args.cookies, WebKit2.CookiePersistentStorage.TEXT)

         self.wview = WebKit2.WebView()
         self.wview = WebKit2.WebView()

-        if html:
-            self.wview.load_html(html, uri)
-        else:
-            self.wview.load_uri(uri)
+

         window.resize(500, 500)
         window.add(self.wview)
         window.show_all()
         window.set_title("SAML Login")
         window.connect('delete-event', Gtk.main_quit)
         self.wview.connect('load-changed', self.get_saml_headers)
         window.resize(500, 500)
         window.add(self.wview)
         window.show_all()
         window.set_title("SAML Login")
         window.connect('delete-event', Gtk.main_quit)
         self.wview.connect('load-changed', self.get_saml_headers)

+        self.wview.connect('resource-load-started', self.log_resources)
+
+        if html:
+            self.wview.load_html(html, uri)
+        else:
+            self.wview.load_uri(uri)
+
+    def log_resources(self, webview, resource, request):
+        if self.verbose > 1:
+            print('%s for resource %s' % (request.get_http_method() or 'Request', resource.get_uri()), file=stderr)

 
     def get_saml_headers(self, webview, event):
         if event != WebKit2.LoadEvent.FINISHED:
             return
 
         mr = webview.get_main_resource()
 
     def get_saml_headers(self, webview, event):
         if event != WebKit2.LoadEvent.FINISHED:
             return
 
         mr = webview.get_main_resource()

-        print("Finished loading %s..." % mr.get_uri(), file=stderr)
+        if self.verbose:
+            print("Finished loading %s" % mr.get_uri(), file=stderr)

         rs = mr.get_response()
         h = rs.get_http_headers()
         if h:
         rs = mr.get_response()
         h = rs.get_http_headers()
         if h:


@@ -52,26 +67,35 @@ class SAMLLoginView:
             h.foreach(listify)
             self.saml_result = d = dict(l)
             if d:
             h.foreach(listify)
             self.saml_result = d = dict(l)
             if d:

-                print("Got SAML relevant headers, done: %r" % d, file=stderr)
+                if self.verbose:
+                    print("Got SAML relevant headers, done: %r" % d, file=stderr)

                 self.success = True
                 Gtk.main_quit()
 
 def parse_args(args = None):
     p = argparse.ArgumentParser()
                 self.success = True
                 Gtk.main_quit()
 
 def parse_args(args = None):
     p = argparse.ArgumentParser()

-    p.add_argument('-v','--verbose', default=0, action='count')

     p.add_argument('server', help='GlobalProtect server (portal or gateway)')
     p.add_argument('--no-verify', dest='verify', action='store_false', default=True, help='Ignore invalid server certificate')
     p.add_argument('server', help='GlobalProtect server (portal or gateway)')
     p.add_argument('--no-verify', dest='verify', action='store_false', default=True, help='Ignore invalid server certificate')

+    p.add_argument('-C', '--no-cookies', dest='cookies', action='store_const', const=None,
+                   default='~/.gp-saml-gui-cookies', help="Don't use cookies (stored in %(default)s)")

     x = p.add_mutually_exclusive_group()
     x.add_argument('-p','--portal', dest='portal', action='store_true', help='SAML auth to portal')
     x.add_argument('-g','--gateway', dest='portal', action='store_false', help='SAML auth to gateway (default)')
     g = p.add_argument_group('Client certificate')
     g.add_argument('-c','--cert', help='PEM file containing client certificate (and optionally private key)')
     g.add_argument('--key', help='PEM file containing client private key (if not included in same file as certificate)')
     x = p.add_mutually_exclusive_group()
     x.add_argument('-p','--portal', dest='portal', action='store_true', help='SAML auth to portal')
     x.add_argument('-g','--gateway', dest='portal', action='store_false', help='SAML auth to gateway (default)')
     g = p.add_argument_group('Client certificate')
     g.add_argument('-c','--cert', help='PEM file containing client certificate (and optionally private key)')
     g.add_argument('--key', help='PEM file containing client private key (if not included in same file as certificate)')

+    g = p.add_argument_group('Debugging and advanced options')
+    g.add_argument('-v','--verbose', default=0, action='count')
+    g.add_argument('-x','--external', action='store_true', help='Launch external browser (for debugging)')
+    g.add_argument('-u','--uri', action='store_true', help='Treat server as the complete URI of the SAML entry point, rather than GlobalProtect server')

     p.add_argument('extra', nargs='*', help='Extra form field(s) to pass to include in the login query string (e.g. "magic-cookie-value=deadbeef01234567")')
     args = p.parse_args(args = None)
 
     args.extra = dict(x.split('=', 1) for x in args.extra)
 
     p.add_argument('extra', nargs='*', help='Extra form field(s) to pass to include in the login query string (e.g. "magic-cookie-value=deadbeef01234567")')
     args = p.parse_args(args = None)
 
     args.extra = dict(x.split('=', 1) for x in args.extra)
 

+    if args.cookies:
+        args.cookies = os.path.expanduser(args.cookies)
+

     if args.cert and args.key:
         args.cert, args.key = (args.cert, args.key), None
     elif args.cert:
     if args.cert and args.key:
         args.cert, args.key = (args.cert, args.key), None
     elif args.cert:


@@ -91,24 +115,38 @@ if __name__ == "__main__":
     s.cert = args.cert
 
     # query prelogin.esp and parse SAML bits
     s.cert = args.cert
 
     # query prelogin.esp and parse SAML bits

-    endpoint = 'https://{}/{}/prelogin.esp'.format(args.server, ('global-protect' if args.portal else 'ssl-vpn'))
-    res = s.post(endpoint, verify=args.verify, data=args.extra)
-    xml = ET.fromstring(res.content)
-    sam = xml.find('saml-auth-method')
-    sr = xml.find('saml-request')
-    if sam is None or sr is None:
-        p.error("This does not appear to be a SAML prelogin response (<saml-auth-method> or <saml-request> tags missing)")
-    elif sam.text == 'POST':
-        print("Got SAML POST content, opening browser...", file=stderr)
-        html, uri = a2b_base64(sr.text).decode(), None
-    elif sam.text == 'REDIRECT':
-        print("Got SAML REDIRECT to %s, opening browser..." % sr.text, file=stderr)
-        uri, html = sr.text, None
+    if args.uri:
+        sam, uri, html = 'URI', args.server, None

     else:
     else:

-        p.error("Unknown SAML method (%s)" % sam.text)
+        endpoint = 'https://{}/{}/prelogin.esp'.format(args.server, ('global-protect' if args.portal else 'ssl-vpn'))
+        res = s.post(endpoint, verify=args.verify, data=args.extra)
+        xml = ET.fromstring(res.content)
+        sam = xml.find('saml-auth-method')
+        sr = xml.find('saml-request')
+        if sam is None or sr is None:
+            p.error("This does not appear to be a SAML prelogin response (<saml-auth-method> or <saml-request> tags missing)")
+        sam = sam.text
+        sr = a2b_base64(sr.text).decode()
+        if sam == 'POST':
+            html, uri = sr, None
+        elif sam == 'REDIRECT':
+            uri, html = sr, None
+        else:
+            p.error("Unknown SAML method (%s)" % sam)
+
+    # launch external browser for debugging
+    if args.external:
+        print("Got SAML %s, opening external browser for debugging..." % sam, file=stderr)
+        import webbrowser
+        if html:
+            uri = 'data:text/html;base64,' + b2a_base64(html.encode()).decode()
+        webbrowser.open(uri)
+        raise SystemExit

 
     # spawn WebKit view to do SAML interactive login
 
     # spawn WebKit view to do SAML interactive login

-    slv = SAMLLoginView(uri, html, verbose=args.verbose)
+    if args.verbose:
+        print("Got SAML %s, opening browser..." % sam, file=stderr)
+    slv = SAMLLoginView(uri, html, verbose=args.verbose, cookies=args.cookies)

     Gtk.main()
     if not slv.success:
         p.error('''Login window closed without producing SAML cookie''')
     Gtk.main()
     if not slv.success:
         p.error('''Login window closed without producing SAML cookie''')