test-globalprotect-login.py

   1 #!/usr/bin/python3
   2
   3 from sys import stderr, platform
   4 from urllib.parse import urlparse, urlencode
   5 import requests
   6 import argparse
   7 import getpass
   8 import os
   9 import xml.etree.ElementTree as ET
  10 import posixpath
  11 from binascii import a2b_base64
  12 from tempfile import NamedTemporaryFile
  13 from shlex import quote
  14 from itertools import chain
  15
  16 clientos_map = dict(linux='Linux', darwin='Mac', win32='Windows', cygwin='Windows')
  17 default_clientos = clientos_map.get(platform, 'Windows')
  18
  19 p = argparse.ArgumentParser()
  20 p.add_argument('-v','--verbose', default=0, action='count')
  21 p.add_argument('endpoint', help='GlobalProtect server; can append /ssl-vpn/login.esp (default) or /global-protect/getconfig.esp or /{ssl-vpn,global-protect}/prelogin.esp')
  22 p.add_argument('extra', nargs='*', help='Extra field to pass to include in the login query string (e.g. "portal-userauthcookie=deadbeef01234567")')
  23 g = p.add_argument_group('Login credentials')
  24 g.add_argument('-u','--user', help='Username (will prompt if unspecified)')
  25 g.add_argument('-p','--password', help='Password (will prompt if unspecified)')
  26 g.add_argument('-c','--cert', help='PEM file containing client certificate (and optionally private key)')
  27 g.add_argument('--computer', default=os.uname()[1], help="Computer name (default is `hostname`)")
  28 g.add_argument('--clientos', choices=set(clientos_map.values()), default=default_clientos, help="clientos value to send (default is %(default)s)")
  29 g.add_argument('-k','--key', help='PEM file containing client private key (if not included in same file as certificate)')
  30 p.add_argument('-b','--browse', action='store_true', help='Automatically spawn browser for SAML')
  31 p.add_argument('--no-verify', dest='verify', action='store_false', default=True, help='Ignore invalid server certificate')
  32 args = p.parse_args()
  33
  34 extra = dict(x.split('=', 1) for x in args.extra)
  35 endpoint = urlparse(('https://' if '//' not in args.endpoint else '') + args.endpoint, 'https:')
  36 if not endpoint.path:
  37     print("Endpoint path unspecified: defaulting to /ssl-vpn/login.esp", file=stderr)
  38     endpoint = endpoint._replace(path = '/ssl-vpn/login.esp')
  39 prelogin = (posixpath.split(endpoint.path)[-1] == 'prelogin.esp')
  40
  41 if args.cert and args.key:
  42     cert = (args.cert, args.key)
  43 elif args.cert:
  44     cert = (args.cert, None)
  45 elif args.key:
  46     p.error('--key specified without --cert')
  47 else:
  48     cert = None
  49
  50 s = requests.Session()
  51 s.headers['User-Agent'] = 'PAN GlobalProtect'
  52 s.cert = cert
  53
  54 if prelogin:
  55     data={
  56         # sent by many clients but not known to have any effect
  57         'tmp': 'tmp', 'clientVer': 4100, 'kerberos-support': 'yes', 'ipv6-support': 'yes',
  58         # affects some clients' behavior (https://github.com/dlenski/gp-saml-gui/issues/6#issuecomment-599743060)
  59         'clientos': args.clientos,
  60         **extra
  61     }
  62 else:
  63     # same request params work for /global-protect/getconfig.esp as for /ssl-vpn/login.esp
  64     if args.user == None:
  65         args.user = input('Username: ')
  66     if args.password == None:
  67         args.password = getpass.getpass('Password: ')
  68     data=dict(user=args.user, passwd=args.password,
  69               # required
  70               jnlpReady='jnlpReady', ok='Login', direct='yes',
  71               # optional but might affect behavior
  72               clientVer=4100, server=endpoint.netloc, prot='https:',
  73               computer=args.computer,
  74               **extra)
  75 res = s.post(endpoint.geturl(), verify=args.verify, data=data)
  76
  77 if args.verbose:
  78     print("Request body:\n", res.request.body, file=stderr)
  79
  80 res.raise_for_status()
  81
  82 # build openconnect "cookie" if the result is a <jnlp>
  83
  84 try:
  85     xml = ET.fromstring(res.text)
  86 except Exception:
  87     xml = None
  88
  89 if cert:
  90     cert_and_key = '\\\n        ' + ' '.join('%s "%s"' % (opt, quote(fn)) for opt, fn in zip(('-c','-k'), cert) if fn) + ' \\\n'
  91 else:
  92     cert_and_key = ''
  93
  94 if xml is not None and xml.tag == 'jnlp':
  95     arguments = [(t.text or '') for t in xml.iter('argument')]
  96     arguments += [''] * (16-len(arguments))
  97     cookie = urlencode({'authcookie': arguments[1], 'portal': arguments[3], 'user': arguments[4], 'domain': arguments[7],
  98                         'computer': args.computer, 'preferred-ip': arguments[15]})
  99
 100     print('''
 101
 102 Extracted connection cookie from <jnlp>. Use this to connect:
 103
 104     openconnect --protocol=gp --usergroup=gateway %s \\
 105         --cookie %s%s
 106 ''' % (quote(endpoint.netloc), quote(cookie), cert_and_key), file=stderr)
 107
 108 # do SAML request if the result is <prelogin-response><saml...>
 109
 110 elif xml is not None and xml.tag == 'prelogin-response' and None not in (xml.find('saml-auth-method'), xml.find('saml-request')):
 111     import webbrowser
 112     sam = xml.find('saml-auth-method').text
 113     sr = a2b_base64(xml.find('saml-request').text)
 114     if sam == 'POST':
 115         with NamedTemporaryFile(delete=False, suffix='.html') as tf:
 116             tf.write(sr)
 117         if args.browse:
 118             print("Got SAML POST, browsing to %s" % tf.name)
 119             webbrowser.open('file://' + tf.name)
 120         else:
 121             print("Got SAML POST, saved to:\n\t%s" % tf.name)
 122     elif sam == 'REDIRECT':
 123         sr = a2b_base64(sr)
 124         if args.browse:
 125             print("Got SAML REDIRECT, browsing to %s" % sr)
 126             webbrowser.open(sr)
 127         else:
 128             print("Got SAML REDIRECT to:\n\t%s" % sr)
 129
 130 # if it's a portal config response, pass along to gateway
 131
 132 elif xml is not None and xml.tag == 'policy':
 133
 134     uemail = xml.find('user-email')
 135     if uemail: uemail = uemail.text
 136     cookies = [(cn, xml.find(cn).text) for cn in ('portal-prelogonuserauthcookie', 'portal-userauthcookie')]
 137     gateways = [(e.find('description').text, e.get('name')) for e in set(chain(xml.findall('gateways/external/list/entry'), xml.findall('gateways6/external/list/entry')))]
 138
 139     print('''\nPortal config response response converted to new test-globalprotect-login.py invocation for gateway login:\n'''
 140           '''    test-globalprotect-login.py --user={} --clientos={} -p {} {}\\\n'''
 141           '''        https://{}/ssl-vpn/login.esp \\\n'''
 142           '''        {}\n'''.format(
 143               quote(args.user), quote(args.clientos), quote(args.password), cert_and_key, quote(gateways[0][1]),
 144               ' '.join(cn+'='+quote(cv) for cn, cv in cookies),
 145               file=stderr))
 146
 147     if uemail and uemail != args.user:
 148         print('''IMPORTANT: Portal config contained different username. You might need to try\n'''
 149               '''{} instead.\n'''.format(uemail))
 150     if len(gateways)>1:
 151         print('''Received multiple gateways. Options include:\n    {}\n'''.format('\n    '.join('%s => %s' % (desc, host) for desc, host in gateways)))
 152
 153 # Just print the result
 154
 155 else:
 156     if args.verbose:
 157         print(res.headers, file=stderr)
 158     print(res.text)