clarify ambiguities in destination, slightly better error messages

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

diff --git a/gp-saml-gui.py b/gp-saml-gui.py
index eaa9680930614dcf04df0af647b275e6afa90148..0f2f96179308423d64b20f606668910f77c2c5f6 100755 (executable)
--- a/gp-saml-gui.py
+++ b/gp-saml-gui.py
@@ -13,6 +13,7 @@ from os import path
 from shlex import quote
 from sys import stderr
 from binascii import a2b_base64, b2a_base64
 from shlex import quote
 from sys import stderr
 from binascii import a2b_base64, b2a_base64

+from urllib.parse import urlparse

 
 gi.require_version('Gtk', '3.0')
 gi.require_version('WebKit2', '4.0')
 
 gi.require_version('Gtk', '3.0')
 gi.require_version('WebKit2', '4.0')


@@ -88,10 +89,11 @@ class SAMLLoginView:
             return
 
         mr = webview.get_main_resource()
             return
 
         mr = webview.get_main_resource()

+        uri = mr.get_uri()

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

-            print('[PAGE   ] Finished loading page %s' % mr.get_uri(), file=stderr)
+            print('[PAGE   ] Finished loading page %s' % uri, file=stderr)

         if not h:
             return
 
         if not h:
             return
 


@@ -99,7 +101,7 @@ class SAMLLoginView:
         d = {}
         h.foreach(lambda k, v: setitem(d, k, v))
         # filter to interesting headers
         d = {}
         h.foreach(lambda k, v: setitem(d, k, v))
         # filter to interesting headers

-        fd = {name:v for name, v in d.items() if name.startswith('saml-') or name in ('location', 'prelogin-cookie', 'portal-userauthcookie')}
+        fd = {name:v for name, v in d.items() if name.startswith('saml-') or name in ('prelogin-cookie', 'portal-userauthcookie')}

         if fd and self.verbose:
             print("[SAML   ] Got SAML result headers: %r" % fd, file=stderr)
             if self.verbose > 1:
         if fd and self.verbose:
             print("[SAML   ] Got SAML result headers: %r" % fd, file=stderr)
             if self.verbose > 1:


@@ -108,7 +110,7 @@ class SAMLLoginView:
                 mr.get_data(None, self.log_resource_text, ct[0], ct.params.get('charset'), d)
 
         # check if we're done
                 mr.get_data(None, self.log_resource_text, ct[0], ct.params.get('charset'), d)
 
         # check if we're done

-        self.saml_result.update(fd)
+        self.saml_result.update(fd, server=urlparse(uri).netloc)

         GLib.timeout_add(1000, self.check_done)
 
     def check_done(self):
         GLib.timeout_add(1000, self.check_done)
 
     def check_done(self):


@@ -129,8 +131,10 @@ def parse_args(args = None):
     x.add_argument('-K', '--no-cookies', dest='cookies', action='store_const', const=None,
                    help="Don't use or store cookies at all")
     x = p.add_mutually_exclusive_group()
     x.add_argument('-K', '--no-cookies', dest='cookies', action='store_const', const=None,
                    help="Don't use or store cookies at all")
     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)')
+    x.add_argument('-p','--portal', dest='interface', action='store_const', const='portal', default='gateway',
+                   help='SAML auth to portal')
+    x.add_argument('-g','--gateway', dest='interface', action='store_const', const='gateway',
+                   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('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)')


@@ -164,11 +168,14 @@ if __name__ == "__main__":
     s.headers['User-Agent'] = 'PAN GlobalProtect'
     s.cert = args.cert
 
     s.headers['User-Agent'] = 'PAN GlobalProtect'
     s.cert = args.cert
 

+    if2prelogin = {'portal':'global-protect/prelogin.esp','gateway':'ssl-vpn/prelogin.esp'}
+    if2auth = {'portal':'global-protect/getconfig.esp','gateway':'ssl-vpn/login.esp'}
+

     # query prelogin.esp and parse SAML bits
     if args.uri:
         sam, uri, html = 'URI', args.server, None
     else:
     # query prelogin.esp and parse SAML bits
     if args.uri:
         sam, uri, html = 'URI', args.server, None
     else:

-        endpoint = 'https://{}/{}/prelogin.esp'.format(args.server, ('global-protect' if args.portal else 'ssl-vpn'))
+        endpoint = 'https://{}/{}'.format(args.server, if2prelogin[args.interface])

         if args.verbose:
             print("Looking for SAML auth tags in response to %s..." % endpoint, file=stderr)
         try:
         if args.verbose:
             print("Looking for SAML auth tags in response to %s..." % endpoint, file=stderr)
         try:


@@ -188,10 +195,13 @@ if __name__ == "__main__":
             else:
                 raise
         xml = ET.fromstring(res.content)
             else:
                 raise
         xml = ET.fromstring(res.content)

+        if xml.tag != 'prelogin-response':
+            p.error("This does not appear to be a GlobalProtect prelogin response\nCheck in browser: {}".format(endpoint))

         sam = xml.find('saml-auth-method')
         sr = xml.find('saml-request')
         if sam is None or sr is None:
         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)")
+            p.error("This does not appear to be a SAML prelogin response (<saml-auth-method> or <saml-request> tags missing)\n"
+                    "Check in browser: {}".format(endpoint))

         sam = sam.text
         sr = a2b_base64(sr.text).decode()
         if sam == 'POST':
         sam = sam.text
         sr = a2b_base64(sr.text).decode()
         if sam == 'POST':


@@ -223,26 +233,37 @@ if __name__ == "__main__":
 
     # extract response and convert to OpenConnect command-line
     un = slv.saml_result.get('saml-username')
 
     # extract response and convert to OpenConnect command-line
     un = slv.saml_result.get('saml-username')

-    for cn in ('prelogin-cookie', 'portal-userauthcookie'):
+    server = slv.saml_result.get('server', args.server)
+
+    for cn, ifh in (('prelogin-cookie','gateway'), ('portal-userauthcookie','portal')):

         cv = slv.saml_result.get(cn)
         if cv:
             break
     else:
         cv = slv.saml_result.get(cn)
         if cv:
             break
     else:

-        cn = None
+        cn = ifh = None
+        p.error("Didn't get an expected cookie. Something went wrong.")

 
 

-    fullpath = ('/global-protect/getconfig.esp' if args.portal else '/ssl-vpn/login.esp')
-    shortpath = ('portal' if args.portal else 'gateway')

     if args.verbose:
     if args.verbose:

+        # Warn about ambiguities
+        if server != args.server and not args.uri:
+            print('''IMPORTANT: During the SAML auth, you were redirected from {} to {}. This probably'''
+                  '''means you should specify {} as the server for final connection, but we're not 100%'''
+                  '''sure about this. You should probably try both.\n'''.format(args.server, server), file=stderr)
+        if ifh != args.interface and not args.uri:
+            print('''IMPORTANT: We started with SAML auth to the {} interface, but received a cookie'''
+                  '''that's associated with the {} interface. You should probably try both.\n'''.format(args.interface, ifh),
+                  file=stderr)
+

         print('''\nSAML response converted to OpenConnect command line invocation:\n''', file=stderr)
         print('''    echo {} |\n        openconnect --protocol=gp --user={} --usergroup={}:{} --passwd-on-stdin {}'''.format(
         print('''\nSAML response converted to OpenConnect command line invocation:\n''', file=stderr)
         print('''    echo {} |\n        openconnect --protocol=gp --user={} --usergroup={}:{} --passwd-on-stdin {}'''.format(

-            quote(cv), quote(un), quote(shortpath), quote(cn), quote(args.server)), file=stderr)
+            quote(cv), quote(un), quote(ifh), quote(cn), quote(server)), file=stderr)

 
         print('''\nSAML response converted to test-globalprotect-login.py invocation:\n''', file=stderr)
         print('''    test-globalprotect-login.py --user={} -p '' \\\n         https://{}{} {}={}\n'''.format(
 
         print('''\nSAML response converted to test-globalprotect-login.py invocation:\n''', file=stderr)
         print('''    test-globalprotect-login.py --user={} -p '' \\\n         https://{}{} {}={}\n'''.format(

-            quote(un), quote(args.server), quote(fullpath), quote(cn), quote(cv)), file=stderr)
+            quote(un), quote(server), quote(if2auth[ifh]), quote(cn), quote(cv)), file=stderr)

 
     varvals = {
 
     varvals = {

-        'HOST': quote('https://%s/%s:%s' % (args.server, shortpath, cn)),
+        'HOST': quote('https://%s/%s:%s' % (server, if2auth[ifh], cn)),

         'USER': quote(un), 'COOKIE': quote(cv),
     }
     print('\n'.join('%s=%s' % pair for pair in varvals.items()))
         'USER': quote(un), 'COOKIE': quote(cv),
     }
     print('\n'.join('%s=%s' % pair for pair in varvals.items()))