PHP Classes


Recommend this page to a friend!
  Classes of Merijn van den Kroonenberg   PHP Google Safe Browsing API   Download  
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP Google Safe Browsing API
Lookup safety of sites using the safe browsing API
Author: By
Last change:
Date: 5 years ago
Size: 4,496 bytes


Class file image Download

Web2All safebrowsingv4

This is a google safebrowsing client (update API V4) written in PHP. For information see the google documentation

In short the update API keeps track of a local database of hashcodes which is updated using the update API v4 protocol. Any urls will be checked against the local database. When possible matches are found, more hashes will be retrieved from the google service.

URLs which are checked are NEVER sent to google, only a hash will be submitted to google. This is the big advantage compared to the Lookup API v4. An additional advantage is less network traffic as initial checks are done against a local database of hash prefixes and the bulk of the checks does not require a roundtrip to the google service.

Disadvantage of the Update service compared to the Lookup service is that a local cache/data storage is required and the client must update it periodically. So the client must run as a daemon (or scheduled) to keep the local database up-to-date.

The web2all/safebrowsingv4 is no longer actively maintained.

What is in this package

This package contains the google safebrowsing Update API V4 protocol implementation. But it only includes a reference implementation for the local storage (for storing the hash prefix database).

This reference implementation is file-based and just an example, it is not suited for production use.

For an example of a mysql storage backend implementation of this safebrowsing client, see the web2all/safebrowsingv4-sqlstorage package.


Install using composer (eg. composer create-project web2all/safebrowsingv4).

Go to google and request a new API key, see

For tests run: vendor/bin/phpunit tests

To test the safebrowsing client using the example file storage backend create a sample php script:

ini_set ( "memory_limit", "712M");

$storage = new GoogleSafeBrowsing_Example_FileStorage('/writeable/dir/storage/');
$updater = new GoogleSafeBrowsing_Updater('YOUR-GOOGLE-KEY', $storage);



foreach(explode(',',$ensure_lists) as $list){
    echo "add list $list\n";


the above script will create a local hash prefix database in '/writeable/dir/storage/' and will keep it uptodate. You would want to run such a script in the background. The initial run will need to download all prefixes. It is also pretty memory hungry, an initial run, or when all lists are reset could require 600Mb.

Once above script runs, you can do lookups like this:

$storage = new GoogleSafeBrowsing_Example_FileStorage('/writeable/dir/storage/');
$api=new GoogleSafeBrowsing_API('YOUR-GOOGLE-KEY');

$lookup=new GoogleSafeBrowsing_Lookup($api, $storage);

  die('no url given');

echo "Looking up: $url\n";
  echo "NOT LISTED\n";
  echo implode(',',$lists)."\n";


Do not use the included FileStorage example storage backend in production! It is not efficeient, its just an implementation example. If you must, use web2all/safebrowsingv4-sqlstorage which can be used with mysql. Or implement you own storage backend by implementing the GoogleSafeBrowsing_Lookup_IStorage and GoogleSafeBrowsing_Updater_IStorage interfaces.

See also


Web2All safebrowsingv4 is open-sourced software licensed under the MIT license (