gglsbl

Python client library for Google Safe Browsing Update API v4.

The code was developed according to official Developers Guide, however this is not a reference implementation.

Quick start

Get Google API key

Instructions to procure API key can be found here. Please note that v3/v4 key is different from v2.2 API. API v3 key may work with current API v4.

Install the library

    python setup.py install

To sync local hash prefix cache

    from gglsbl import SafeBrowsingList
    sbl = SafeBrowsingList('API KEY GOES HERE')
    sbl.update_hash_prefix_cache()

URL lookup

    from gglsbl import SafeBrowsingList
    sbl = SafeBrowsingList('API KEY GOES HERE')
    threat_list = sbl.lookup_url('http://github.com/')
    if threat_list == None:
      print("no threat')
    else: 
      print('threats: ' + str(threat_list))

CLI Tool

bin/gglsbl_client.py can be used for a quick check or as a code example.

To immediately sync local cache with Safe Browsing API.

    gglsbl_client.py --api-key 'API KEY GOES HERE' --onetime

Please mind Request Frequency policy if you are going to use this command for more than a one-time test.

To look up URL

    gglsbl_client.py --api-key 'API KEY GOES HERE' --check-url http://github.com/

Fore more options please see

    gglsbl_client.py --help

Running in Distributed Environment

For cases when multiple apps and/or servers would benifit from sharing same GSB cache please see gglsbl-rest project maintained by Alexandre Sieira.

Running on Python3

Current version of library is fully compatible with both python2.7 and python3.

If you prefer to use older v3 version of Safe Browsing API there is a python3 port of the legacy version made by Stefan.

afilipovich / gglsbl

readme