Commit 34e4f76b authored by ale's avatar ale

Update GSB plugin with newer gglsbl library

parent 47a05ac1
Apache License
Version 2.0, January 2004
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
implied, including, without limitation, any warranties or conditions
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.
#!/usr/bin/env python2.5
# Copyright 2008 Google Inc.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# See the License for the specific language governing permissions and
# limitations under the License.
"""Google Safe Browsing protocol version 2.2 client."""
import datetime
import logging
import os
import sys
import tempfile
import threading
import datastore
import expression
import hashprefix_trie
import server
import util
class Error(Exception):
def FullHashIsCurrent(list_entry, sbl, now):
Returns true if full hash should be considered valid.
updated = list_entry.GetHashTimestamp()
# All hashes are considered valid if we have made downloads request in
# UPDATED_MAX time. If not, then it is still considered valid if we have
# made a hashserver request that verified the hash is still valid in
return (((sbl.UpdateTime() is not None) and
(now - sbl.UpdateTime() < Client.UPDATED_MAX)) or
((updated is not None) and
(now - updated < Client.UPDATED_MAX)))
def ExternalCheckUrl(url, sbls, server, debug_info=False):
Return a list of 2-tuples [(blacklist, matching expression), ...] for
all matches.
url needs to be ASCII. Encode url with Punycode if necessary.
gen = expression.ExpressionGenerator(url)
# A trie that maps hash prefixes to expression objects.
# This tracks prefixes for which we need to do a gethash request.
prefix_matches = hashprefix_trie.HashprefixTrie()
# Return value.
matches = []
# Keep a list of all lists which we want to check as we should only need
# to look for one match per list. Once we've found a matching hash we can
# ignore the rest.
# TODO(gcasto): Is this really worth it? The increase in code complexity
# is non trivial and in most cases it probably doesn't save any work.
# Also, this is ineffecient as we are copying around the entire list contents.
check_sbls = set(sbls.itervalues())
now =
for expr in gen.Expressions():
if len(check_sbls) == 0:
logging.debug('Checking expression: "%s"', expr.Value())
# Cast check_sbls to list so that we can modify elements.
for sbl in list(check_sbls):
for list_entry in sbl.GetPrefixMatches(expr.HashValue()):
fullhash = list_entry.FullHash()
if fullhash is None or not FullHashIsCurrent(list_entry, sbl, now):
# Multiple prefix matches per list are rare, but they do happen.
# Make sure to keep track of all matches.
prefix_matches.Insert(list_entry.Prefix(), expr)
elif fullhash == expr.HashValue():
if debug_info:
matches.append((sbl.Name(), expr.Value(),
matches.append((sbl.Name(), expr.Value()))
break # Found a match. Continue to the next list.
# TODO(gcasto): This is not technically correct as you could be trying to look
# up a prefix from one list and have check_sbls populated by a different
# list and you would proceed with the lookup even though it doesn't matter.
if len(check_sbls) == 0 or prefix_matches.Size() == 0:
return matches
# Get full length hashes for cases where we only had a matching prefix or
# had a full length hash that was too old.
ghresp = server.GetAllFullHashes(prefix_matches.PrefixIterator())
logging.debug('get all thashes response: %s', ghresp)
# Check these full length hashes for a match.
for listname, addchunknum_map in ghresp.listmap.iteritems():
sbl = sbls.get(listname, None)
if sbl is None:"No Listname")
# listname showed up on the gethash server before the downloads server.
for addchunknum, hashes_set in addchunknum_map.iteritems():
for fullhash in hashes_set:
for expr in prefix_matches.GetPrefixMatches(fullhash):
if (sbl.AddFullHash(fullhash, addchunknum, ghresp.timestamp)
and sbl in check_sbls and expr.HashValue() == fullhash):
if debug_info:
matches.append((sbl.Name(), expr.Value(), addchunknum))
matches.append((sbl.Name(), expr.Value()))
return matches
class Client(object):
An automatically self-updating container for safebrowsing lists. Uses a
background thread to update the local list cache.
ds: DataStore instance
apikey: SafeBrowsing API key.
hp: 2-tuple with host and port for HTTP connections
ssl_hp: 2-tuple with host and port for HTTPS(SSL) connections
base_path: Base of HTTP path on host:port.
use_mac: True to enable verification with MACs.
size_limit: Preferred maximum download size in bytes. Intended for slow
force_delay: Use this value as the server polling delay until the client is
fully in sync.
pre_update_hook: A function that is called immediately before an update
finishes. This function must accept this Client object as an argument. The
function is called from the Client's updater thread.
post_update_hook: A function that is called immediately after an update
finishes. This function must accept this Client object as an argument. The
function is called from the Client's updater thread.
gethash_server: 2-tuple of host and port for gethash requests. If unspecified,
hp will be used.
update_lists: If true, constantly get lists to download from the safebrowsing
servers, otherwise just use the lists that are already present in the
datastore. If the datastore has no information, we ask the server for the
lists to download regardless.
sb_server: If not None the client uses this server instance instead of
creating its own server instance.
sb_lists: If not None, will use these lists instead of asking server what
lists are available.
UPDATED_MAX = datetime.timedelta(minutes=45)
def __init__(self, ds, apikey, hp=('', 80),
ssl_hp=('', 443), base_path='/safebrowsing',
use_mac=True, size_limit=None, force_delay=None,
pre_update_hook=lambda cl: None,
post_update_hook=lambda cl: None, gethash_server=None,
update_lists=False, sb_server=None, sb_lists=None):
self._force_delay = force_delay
self._post_update_hook = post_update_hook
self._pre_update_hook = pre_update_hook
self._datastore = ds
self._update_lists = update_lists
self._size_limit = size_limit
# A dict of listnames and sblist.Lists.
if sb_lists:
self._sbls = dict([(x.Name(), x) for x in sb_lists])
self._sbls = self._datastore.GetLists()
clientkey = self._datastore.GetClientKey()
wrkey = self._datastore.GetWrKey()
if not sb_server:
self._server = server.Server(hp, ssl_hp, base_path,
clientkey=clientkey, wrkey=wrkey,
apikey=apikey, gethash_server=gethash_server)
self._server = sb_server
if use_mac and (clientkey is None or wrkey is None):
if not self._sbls:
self._sbls = dict(
[(x.Name(), x) for x in self._server.GetLists()])
# This lock prevents concurrent access from the background updater thread
# and user threads.
self._lock = threading.RLock()
self._in_sync = False
self._first_sync_updates = 0
self._exit_cond = threading.Condition()
self._exit_updater = False
self._thr = threading.Thread(target=self._PollForData,
def _MakeLockedMethod(unbound):
def LockedMethod(self, *args, **kwargs):
return unbound(self, *args, **kwargs)
return LockedMethod
def InSync(self):
return self._in_sync
def FirstSyncUpdates(self):
return self._first_sync_updates
def CheckUrl(self, url, debug_info=False):
return ExternalCheckUrl(url, self._sbls, self._server, debug_info)
### Block updates from the background thread while checking a URL.
CheckUrl = _MakeLockedMethod(CheckUrl)
def Lists(self):
Return a map of listnames -> sblist.List objects.
return self._sbls
Lists = _MakeLockedMethod(Lists)
def ExitUpdater(self):
Call this to get a proper shutdown with a sync to the datastore.
self._exit_updater = True
def Server(self):
return self._server
def _PollForData(self, requested_delay):
Continuously poll the safe browsing server for updates.
num_updates = 0
while True:
num_updates += 1
requested_delay, updates_done = self._Update()'Finished update number %d, next delay: %d',
num_updates, requested_delay)
# Save current list info to disk.
logging.exception("Datastore sync failed")
if updates_done:'Fully in sync')
self._force_delay = None
self._in_sync = True
if self._first_sync_updates == 0:
self._first_sync_updates = num_updates
self._in_sync = False
logging.exception('exception in client update thread')
logging.debug('requested_delay: %d, force_delay: %s', requested_delay,
if self._force_delay is None:
delay = requested_delay
delay = self._force_delay
if not self._exit_updater:'Waiting %d seconds' % delay)
if self._exit_updater:'Exiting')
def _Update(self):
Update the client state (blacklists, keys). Return 2-tuple (poll_delay,
updates_done). poll_delay is the minimum delay requested by the server.
updates_done is True if no changes were received from the server.
# Possibly check for new or deleted lists.
if self._update_lists:
# Get new data.
logging.debug('lists: "%s"', ','.join(self._sbls.iterkeys()))
download = self._server.Download(self._sbls.values(),
logging.debug('Minimum delay: %d', download.min_delay_sec)
if download.rekey:
return (download.min_delay_sec, False)
if download.reset:
return (download.min_delay_sec, False)
updates_done = True
for name, ops in download.listops.iteritems():
for op in ops:
# Make sure that we actually received data before claiming that
# we aren't up to date.
updates_done = False
logging.debug('Applying operation to list %s: %s', name, op)
# Update the List's timestamp after successfully updating it.
return (download.min_delay_sec, updates_done)
_Update = _MakeLockedMethod(_Update)
# This should only be called from locked methods.
def _Rekey(self):
clientkey, wrkey = self._server.Rekey()
def _UpdateLists(self):
sbls = self._server.GetLists()
deleted = set(self._sbls.iterkeys())
for server_l in sbls:
logging.debug('server returned list: "%s"', server_l.Name())
if server_l.Name() in deleted:
if not self._sbls.has_key(server_l.Name()):
logging.debug('added list: "%s"', server_l.Name())
self._sbls[server_l.Name()] = server_l
for name in deleted:
logging.debug('Deleting list: %s', name)
del self._sbls[name]
class UrlChecker(object):
def __init__(self, urls):
self._urls = urls
self._event = threading.Event()
def Updated(self, cl):
This runs in the client's updater thread.
logging.debug('List states:')
for sbl in cl.Lists().itervalues():
logging.debug('%s: %d prefixes, %s', sbl.Name(), sbl.NumPrefixes(),
if not cl.InSync():'Waiting to complete updates...')
for url in self._urls:
matches = cl.CheckUrl(url)'CheckUrl %s: %s', url, matches)
print '%s:' % (url,)
if len(matches) == 0:
print '\t(no matches)'
for listname, matching in matches:
print '\t%s: %s' % (listname, matching)
def WaitForFinish(self):
def PrintUsage(argv):
print >>sys.stderr, ('Usage: %s <APIKey> [check <URL> <URL> ...]\n'
'Visit "'
'key_signup.html" to obtain an APIKey'
% (argv[0],))
def CheckForUrl(apikey, urls):
checking_datastore_loc = os.path.join(tempfile.mkdtemp(), 'datastore_checker')
ds = datastore.DataStore(checking_datastore_loc)
checker = UrlChecker(urls)
cl = Client(ds,
def main(argv):
A command line google safe browsing client. Usage: