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