gp-saml-gui.py

   1 #!/usr/bin/env python3
   2
   3 import gi
   4 import argparse
   5 import pprint
   6 import urllib
   7 import requests
   8 import xml.etree.ElementTree as ET
   9 import ssl
  10
  11 from operator import setitem
  12 from os import path
  13 from shlex import quote
  14 from sys import stderr, platform
  15 from binascii import a2b_base64, b2a_base64
  16 from urllib.parse import urlparse, urlencode
  17
  18 gi.require_version('Gtk', '3.0')
  19 gi.require_version('WebKit2', '4.0')
  20 from gi.repository import Gtk, WebKit2, GLib
  21
  22 class SAMLLoginView:
  23     def __init__(self, uri, html=None, verbose=False, cookies=None, verify=True):
  24         window = Gtk.Window()
  25
  26         # API reference: https://lazka.github.io/pgi-docs/#WebKit2-4.0
  27
  28         self.closed = False
  29         self.success = False
  30         self.saml_result = {}
  31         self.verbose = verbose
  32
  33         self.ctx = WebKit2.WebContext.get_default()
  34         if not args.verify:
  35             self.ctx.set_tls_errors_policy(WebKit2.TLSErrorsPolicy.IGNORE)
  36         self.cookies = self.ctx.get_cookie_manager()
  37         if args.cookies:
  38             self.cookies.set_accept_policy(WebKit2.CookieAcceptPolicy.ALWAYS)
  39             self.cookies.set_persistent_storage(args.cookies, WebKit2.CookiePersistentStorage.TEXT)
  40         self.wview = WebKit2.WebView()
  41
  42         window.resize(500, 500)
  43         window.add(self.wview)
  44         window.show_all()
  45         window.set_title("SAML Login")
  46         window.connect('delete-event', self.close)
  47         self.wview.connect('load-changed', self.get_saml_headers)
  48         self.wview.connect('resource-load-started', self.log_resources)
  49
  50         if html:
  51             self.wview.load_html(html, uri)
  52         else:
  53             self.wview.load_uri(uri)
  54
  55     def close(self, window, event):
  56         self.closed = True
  57         Gtk.main_quit()
  58
  59     def log_resources(self, webview, resource, request):
  60         if self.verbose > 1:
  61             print('[REQUEST] %s for resource %s' % (request.get_http_method() or 'Request', resource.get_uri()), file=stderr)
  62         if self.verbose > 2:
  63             resource.connect('finished', self.log_resource_details, request)
  64
  65     def log_resource_details(self, resource, request):
  66         m = request.get_http_method() or 'Request'
  67         uri = resource.get_uri()
  68         rs = resource.get_response()
  69         h = rs.get_http_headers() if rs else None
  70         if h:
  71             ct, cl = h.get_content_type(), h.get_content_length()
  72             content_type, charset = ct[0], ct.params.get('charset')
  73             content_details = '%d bytes of %s%s for ' % (cl, content_type, ('; charset='+charset) if charset else '')
  74         print('[RECEIVE] %sresource %s %s' % (content_details if h else '', m, uri), file=stderr)
  75
  76     def log_resource_text(self, resource, result, content_type, charset=None, show_headers=None):
  77         data = resource.get_data_finish(result)
  78         content_details = '%d bytes of %s%s for ' % (len(data), content_type, ('; charset='+charset) if charset else '')
  79         print('[DATA   ] %sresource %s' % (content_details, resource.get_uri()), file=stderr)
  80         if show_headers:
  81             for h,v in show_headers.items():
  82                 print('%s: %s' % (h, v), file=stderr)
  83             print(file=stderr)
  84         if charset or content_type.startswith('text/'):
  85             print(data.decode(charset or 'utf-8'), file=stderr)
  86
  87     def get_saml_headers(self, webview, event):
  88         if event != WebKit2.LoadEvent.FINISHED:
  89             return
  90
  91         mr = webview.get_main_resource()
  92         uri = mr.get_uri()
  93         rs = mr.get_response()
  94         h = rs.get_http_headers()
  95         if self.verbose:
  96             print('[PAGE   ] Finished loading page %s' % uri, file=stderr)
  97         if not h:
  98             return
  99
 100         # convert to normal dict
 101         d = {}
 102         h.foreach(lambda k, v: setitem(d, k, v))
 103         # filter to interesting headers
 104         fd = {name:v for name, v in d.items() if name.startswith('saml-') or name in ('prelogin-cookie', 'portal-userauthcookie')}
 105         if fd and self.verbose:
 106             print("[SAML   ] Got SAML result headers: %r" % fd, file=stderr)
 107             if self.verbose > 1:
 108                 # display everything we found
 109                 ct = h.get_content_type()
 110                 mr.get_data(None, self.log_resource_text, ct[0], ct.params.get('charset'), d)
 111
 112         # check if we're done
 113         self.saml_result.update(fd, server=urlparse(uri).netloc)
 114         GLib.timeout_add(1000, self.check_done)
 115
 116     def check_done(self):
 117         d = self.saml_result
 118         if 'saml-username' in d and ('prelogin-cookie' in d or 'portal-userauthcookie' in d):
 119             if args.verbose:
 120                 print("[SAML   ] Got all required SAML headers, done.", file=stderr)
 121             self.success = True
 122             Gtk.main_quit()
 123
 124 def parse_args(args = None):
 125     pf2clientos = dict(linux='Linux', darwin='Mac', win32='Windows', cygwin='Windows')
 126     clientos2ocos = dict(Linux='linux-64', Mac='mac-intel', Windows='win')
 127     default_clientos = pf2clientos.get(platform, 'Windows')
 128
 129     p = argparse.ArgumentParser()
 130     p.add_argument('server', help='GlobalProtect server (portal or gateway)')
 131     p.add_argument('--no-verify', dest='verify', action='store_false', default=True, help='Ignore invalid server certificate')
 132     x = p.add_mutually_exclusive_group()
 133     x.add_argument('-C', '--cookies', default='~/.gp-saml-gui-cookies',
 134                    help='Use and store cookies in this file (instead of default %(default)s)')
 135     x.add_argument('-K', '--no-cookies', dest='cookies', action='store_const', const=None,
 136                    help="Don't use or store cookies at all")
 137     x = p.add_mutually_exclusive_group()
 138     x.add_argument('-p','--portal', dest='interface', action='store_const', const='portal', default='gateway',
 139                    help='SAML auth to portal')
 140     x.add_argument('-g','--gateway', dest='interface', action='store_const', const='gateway',
 141                    help='SAML auth to gateway (default)')
 142     g = p.add_argument_group('Client certificate')
 143     g.add_argument('-c','--cert', help='PEM file containing client certificate (and optionally private key)')
 144     g.add_argument('--key', help='PEM file containing client private key (if not included in same file as certificate)')
 145     g = p.add_argument_group('Debugging and advanced options')
 146     x = p.add_mutually_exclusive_group()
 147     x.add_argument('-v','--verbose', default=1, action='count', help='Increase verbosity of explanatory output to stderr')
 148     x.add_argument('-q','--quiet', dest='verbose', action='store_const', const=0, help='Reduce verbosity to a minimum')
 149     g.add_argument('-x','--external', action='store_true', help='Launch external browser (for debugging)')
 150     g.add_argument('-u','--uri', action='store_true', help='Treat server as the complete URI of the SAML entry point, rather than GlobalProtect server')
 151     g.add_argument('--clientos', choices=set(pf2clientos.values()), default=default_clientos, help="clientos value to send (default is %(default)s)")
 152     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")')
 153     args = p.parse_args(args = None)
 154
 155     args.ocos = clientos2ocos[args.clientos]
 156     args.extra = dict(x.split('=', 1) for x in args.extra)
 157
 158     if args.cookies:
 159         args.cookies = path.expanduser(args.cookies)
 160
 161     if args.cert and args.key:
 162         args.cert, args.key = (args.cert, args.key), None
 163     elif args.cert:
 164         args.cert = (args.cert, None)
 165     elif args.key:
 166         p.error('--key specified without --cert')
 167     else:
 168         args.cert = None
 169
 170     return p, args
 171
 172 if __name__ == "__main__":
 173     p, args = parse_args()
 174
 175     s = requests.Session()
 176     s.headers['User-Agent'] = 'PAN GlobalProtect'
 177     s.cert = args.cert
 178
 179     if2prelogin = {'portal':'global-protect/prelogin.esp','gateway':'ssl-vpn/prelogin.esp'}
 180     if2auth = {'portal':'global-protect/getconfig.esp','gateway':'ssl-vpn/login.esp'}
 181
 182     # query prelogin.esp and parse SAML bits
 183     if args.uri:
 184         sam, uri, html = 'URI', args.server, None
 185     else:
 186         endpoint = 'https://{}/{}'.format(args.server, if2prelogin[args.interface])
 187         data = {'tmp':'tmp', 'kerberos-support':'yes', 'ipv6-support':'yes', 'clientVer':4100, 'clientos':args.clientos, **args.extra}
 188         if args.verbose:
 189             print("Looking for SAML auth tags in response to %s..." % endpoint, file=stderr)
 190         try:
 191             res = s.post(endpoint, verify=args.verify, data=data)
 192         except Exception as ex:
 193             rootex = ex
 194             while True:
 195                 if isinstance(rootex, ssl.SSLError):
 196                     break
 197                 elif not rootex.__cause__ and not rootex.__context__:
 198                     break
 199                 rootex = rootex.__cause__ or rootex.__context__
 200             if isinstance(rootex, ssl.CertificateError):
 201                 p.error("SSL certificate error (try --no-verify to ignore): %s" % rootex)
 202             elif isinstance(rootex, ssl.SSLError):
 203                 p.error("SSL error: %s" % rootex)
 204             else:
 205                 raise
 206         xml = ET.fromstring(res.content)
 207         if xml.tag != 'prelogin-response':
 208             p.error("This does not appear to be a GlobalProtect prelogin response\nCheck in browser: {}?{}".format(endpoint, urlencode(data)))
 209         sam = xml.find('saml-auth-method')
 210         sr = xml.find('saml-request')
 211         if sam is None or sr is None:
 212             p.error("{} prelogin response does not contain SAML tags (<saml-auth-method> or <saml-request> missing)\n\n"
 213                     "Things to try:\n"
 214                     "1) Spoof an officially supported OS (e.g. --clientos=Windows or --clientos=Mac)\n"
 215                     "2) Check in browser: {}?{}".format(args.interface.title(), endpoint, urlencode(data)))
 216         sam = sam.text
 217         sr = a2b_base64(sr.text).decode()
 218         if sam == 'POST':
 219             html, uri = sr, None
 220         elif sam == 'REDIRECT':
 221             uri, html = sr, None
 222         else:
 223             p.error("Unknown SAML method (%s)" % sam)
 224
 225     # launch external browser for debugging
 226     if args.external:
 227         print("Got SAML %s, opening external browser for debugging..." % sam, file=stderr)
 228         import webbrowser
 229         if html:
 230             uri = 'data:text/html;base64,' + b2a_base64(html.encode()).decode()
 231         webbrowser.open(uri)
 232         raise SystemExit
 233
 234     # spawn WebKit view to do SAML interactive login
 235     if args.verbose:
 236         print("Got SAML %s, opening browser..." % sam, file=stderr)
 237     slv = SAMLLoginView(uri, html, verbose=args.verbose, cookies=args.cookies, verify=args.verify)
 238     Gtk.main()
 239     if slv.closed:
 240         print("Login window closed by user.", file=stderr)
 241         p.exit(1)
 242     if not slv.success:
 243         p.error('''Login window closed without producing SAML cookies.''')
 244
 245     # extract response and convert to OpenConnect command-line
 246     un = slv.saml_result.get('saml-username')
 247     server = slv.saml_result.get('server', args.server)
 248
 249     for cn, ifh in (('prelogin-cookie','gateway'), ('portal-userauthcookie','portal')):
 250         cv = slv.saml_result.get(cn)
 251         if cv:
 252             break
 253     else:
 254         cn = ifh = None
 255         p.error("Didn't get an expected cookie. Something went wrong.")
 256
 257     if args.verbose:
 258         # Warn about ambiguities
 259         if server != args.server and not args.uri:
 260             print('''IMPORTANT: During the SAML auth, you were redirected from {} to {1}. This probably '''
 261                   '''means you should specify {1} as the server for final connection, but we're not 100% '''
 262                   '''sure about this. You should probably try both.\n'''.format(args.server, server), file=stderr)
 263         if ifh != args.interface and not args.uri:
 264             print('''IMPORTANT: We started with SAML auth to the {} interface, but received a cookie '''
 265                   '''that's often associated with the {} interface. You should probably try both.\n'''.format(args.interface, ifh),
 266                   file=stderr)
 267         print('''\nSAML response converted to OpenConnect command line invocation:\n''', file=stderr)
 268         print('''    echo {} |\n        openconnect --protocol=gp --user={} --os={} --usergroup={}:{} --passwd-on-stdin {}'''.format(
 269             quote(cv), quote(un), quote(args.ocos), quote(args.interface), quote(cn), quote(server)), file=stderr)
 270
 271         print('''\nSAML response converted to test-globalprotect-login.py invocation:\n''', file=stderr)
 272         print('''    test-globalprotect-login.py --user={} --clientos={} -p '' \\\n         https://{}/{} {}={}\n'''.format(
 273             quote(un), quote(args.clientos), quote(server), quote(if2auth[args.interface]), quote(cn), quote(cv)), file=stderr)
 274     varvals = {
 275         'HOST': quote('https://%s/%s:%s' % (server, if2auth[args.interface], cn)),
 276         'USER': quote(un), 'COOKIE': quote(cv), 'OS': quote(args.ocos),
 277     }
 278     print('\n'.join('%s=%s' % pair for pair in varvals.items()))