Commit 91d29b9b authored by Damien Octeau's avatar Damien Octeau

Initial commit.

parents
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
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,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
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.
# Copyright (C) 2015 The Pennsylvania State University and the University of Wisconsin
# Systems and Internet Infrastructure Security Laboratory
#
# Author: Damien Octeau
#
# 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#exclude linking/*.pyx
include *.txt
include plot_links.py
include setup.py
include linking/*.c
include linking/*.pxd
include linking/*.pxi
include linking/*.py
To build:
python setup.py build
The script can be run directly from the top-level directory afterwards.
It can also be installed with python setup.py install
For further instructions, please see http://siis.cse.psu.edu/primo/
# Copyright (C) 2015 The Pennsylvania State University and the University of Wisconsin
# Systems and Internet Infrastructure Security Laboratory
#
# Author: Damien Octeau
#
# 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
cdef class Application(object):
cdef readonly list components
cdef readonly unicode name
cdef readonly tuple used_permissions
cdef readonly long version
cdef readonly unicode sample
cdef readonly list intents
cdef readonly tuple descriptor
cdef readonly tuple component_maps
cdef readonly tuple exported_component_maps
cdef long _hash
cdef int CountMatchingComponentsOfKind(self, int kind, unicode name)
cdef bint HasMatchingExportedComponentsOfKind(self, int kind, unicode name)
# Copyright (C) 2015 The Pennsylvania State University and the University of Wisconsin
# Systems and Internet Infrastructure Security Laboratory
#
# Author: Damien Octeau
#
# 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Application class and factory."""
from linking.components cimport Component
from linking.components cimport MakeComponent
from linking.intents cimport ComponentIntent
from linking.attribute_matching cimport AttributeMap
from linking import ic3_data_pb2
cdef set SAMPLES = set()
def MakeApplication(application_pb):
"""Generates an Application object from a protobuf.
Args:
application_pb: An Application protobuf object.
Returns: A linking.Application object.
"""
cdef unicode name = application_pb.name
# In protobufs, fields of type RepeatedScalarFieldContainer (such as
# used_permissions) contain a weak reference to
# google.protobuf.internal.python_message._Listener. To avoid pickling
# issues, we copy the contents.
cdef tuple used_permissions = (tuple(sorted(application_pb.used_permissions))
if application_pb.used_permissions else None)
cdef long version = application_pb.version
cdef unicode sample = (application_pb.sample
if application_pb.HasField('sample') else None)
SAMPLES.add(sample)
cdef Application application = Application(name, used_permissions, version,
sample)
cdef list components = []
for pb_component in application_pb.components:
components.append(MakeComponent(pb_component, application))
application.components = components
cdef tuple component_maps
cdef tuple exported_component_maps
# This is relying on the fact that:
# ic3_data_pb2.Application.Component.ACTIVITY = 0
# ic3_data_pb2.Application.Component.SERVICE = 1
# ic3_data_pb2.Application.Component.RECEIVER = 2
# TODO Check C arrays.
component_maps = (AttributeMap(), AttributeMap(), AttributeMap())
exported_component_maps = (AttributeMap(), AttributeMap(), AttributeMap())
cdef unicode component_name
cdef int kind
cdef AttributeMap current_attribute_map
cdef Component component
cdef list intents = []
cdef list component_intents
for component in components:
kind = component.kind
if kind == ic3_data_pb2.Application.Component.PROVIDER:
continue
elif kind == ic3_data_pb2.Application.Component.DYNAMIC_RECEIVER:
kind = ic3_data_pb2.Application.Component.RECEIVER
component_name = component.name
current_attribute_map = component_maps[kind]
current_attribute_map.AddAttribute(component_name, component)
if component.exported:
current_attribute_map = exported_component_maps[kind]
current_attribute_map.AddAttribute(component_name, component)
component_intents = component.intents
if component_intents:
intents += component_intents
application.component_maps = component_maps
application.exported_component_maps = exported_component_maps
application.intents = intents
return application
cdef class Application(object):
"""A class that represents an application."""
def __cinit__(self, unicode name, tuple used_permissions, long version,
unicode sample):
self.name = name
self.used_permissions = used_permissions
self.version = version
self.sample = sample
self.descriptor = (self.name, self.version)
self._hash = hash(self.descriptor)
cdef int CountMatchingComponentsOfKind(self, int kind, unicode value):
"""Counts the number of components in this application matching a given
field value.
Args:
kind: A field name.
value: A field value.
Returns: The number of components matching the field value.
"""
cdef AttributeMap attribute_map = self.component_maps[kind]
return len(attribute_map.GetEndPointsForAttribute(value))
cdef bint HasMatchingExportedComponentsOfKind(self, int kind, unicode value):
"""Determines if any component in this application matches a given field
value.
Args:
kind: A field name.
value: A field value.
Returns: True if a component in this application matches the field value.
"""
return self.CountMatchingComponentsOfKind(kind, value) > 0
def HasOpenComponent(self):
"""Determines if this application has any component that is publicly
accessible.
Returns: True if this application has a component that is publicly
accessible.
"""
cdef Component component
for component in self.components:
if component.IsOpenComponent():
return True
return False
def SendsExternalIntent(self):
"""Determines if this application sends an Intent to another application.
Note that this does not take into account potentially imprecise Intents.
Returns: True if this application sends an Intent to another application.
"""
cdef ComponentIntent intent
if self.intents:
for intent in self.intents:
if not intent.HasInternalDestination():
return True
return False
property exit_point_count:
def __get__(self):
cdef int count = 0
cdef Component component
for component in self.components:
count += component.exit_point_count
return count
property intent_count:
def __get__(self):
return len(self.intents)
property intent_filter_count:
def __get__(self):
cdef int count = 0
cdef Component component
for component in self.components:
count += component.intent_filter_count
return count
def __hash__(self):
return self._hash
def __richcmp__(self, object other, int op):
if op == 2:
return (isinstance(other, Application)
and self.descriptor == other.descriptor)
raise NotImplementedError
# Copyright (C) 2015 The Pennsylvania State University and the University of Wisconsin
# Systems and Internet Infrastructure Security Laboratory
#
# Author: Damien Octeau
#
# 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
cdef class AttributeMap(object):
cdef dict _regexes
cdef dict _constants
cdef set _all_end_points
cdef set _end_points_with_regexes
cdef dict _cache
cdef void AddAttribute(self, unicode attribute, object end_point)
cdef set GetEndPointsForAttributeSet(
self, object attribute_set, set search_space=?, bint match_all=?)
cdef set GetEndPointsForAttribute(self, unicode attribute, set search_space=?)
cdef set GetEndPointsWithoutEmptySet(self, set search_space)
cdef set GetEndPointsForEmptySet(self, set search_space)
cdef bint NonEmptyIntersection(unicode regex1, unicode regex2)
# Copyright (C) 2015 The Pennsylvania State University and the University of Wisconsin
# Systems and Internet Infrastructure Security Laboratory
#
# Author: Damien Octeau
#
# 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Utilities for matching attributes with end points."""
import re
cdef class AttributeMap(object):
"""Class that maps attributes to end points that contain them."""
def __cinit__(self):
self._regexes = {}
self._constants = {}
self._all_end_points = set()
self._end_points_with_regexes = set()
self._cache = {}
def __repr__(self):
return str(self._regexes) + ' - ' + str(self._constants)
cdef void AddAttribute(self, unicode attribute, object end_point):
"""Adds an attribute and the end point that contains it.
Args:
attribute: A field value.
end_point: The end point that contains the field value.
"""
if hasattr(attribute, '__iter__') and len(attribute) == 0:
# We want the empty set to use the None key.
attribute = None
cdef dict attribute_map = None
if (attribute is not None and '(.*)' in attribute):
attribute_map = self._regexes
self._end_points_with_regexes.add(end_point)
else:
attribute_map = self._constants
cdef set end_points = attribute_map.get(attribute)
if not end_points:
end_points = set()
attribute_map[attribute] = end_points
end_points.add(end_point)
self._all_end_points.add(end_point)
cdef set GetEndPointsForAttributeSet(
self, object attribute_set, set search_space=None, bint match_all=True):
"""Returns all end points matching attributes from a set.
Args:
attribute_set: An iterable of attributes.
search_space: The search space.
match_all: If set to True, then only end points matching all attributes
are returned. Otherwise, returned end points will match any attribute.
Returns: All matching end points.
"""
if not attribute_set:
return search_space
cdef list end_point_sets = [self.GetEndPointsForAttribute(attribute, None)
for attribute in attribute_set]
cdef set result = None
for end_points in end_point_sets:
if result is not None:
if match_all:
result = result & end_points
else:
result = result | end_points
else:
result = end_points
if search_space is not None:
result = result & search_space
return result
cdef set GetEndPointsForAttribute(self, unicode attribute,
set search_space=None):
"""Returns the end points that have a certain attribute among a set of end
points.
Args:
attribute: A field value.
search_space: The search space.
Returns: All matching end points.
"""
if attribute == u'(.*)':
return (self._all_end_points & search_space if search_space is not None
else self._all_end_points)
cdef set end_points
try:
end_points = self._cache[attribute]
except KeyError:
end_points = self._constants.get(attribute, set())
# Bypass regular expression matching if no end point in the search space
# is associated with a regex.
if attribute is not None and '(.*)' in attribute:
for candidate, end_points_for_attribute in self._constants.iteritems():
if candidate is not None and NonEmptyIntersection(candidate, attribute):
end_points = end_points | end_points_for_attribute
if self._end_points_with_regexes:
for candidate, end_points_for_attribute in self._regexes.iteritems():
if attribute is not None and NonEmptyIntersection(candidate, attribute):
end_points = end_points | end_points_for_attribute
self._cache[attribute] = end_points
# Only retain the ones that are in the search space.
if search_space is not None: end_points = end_points & search_space
return end_points
cdef set GetEndPointsWithoutEmptySet(self, set search_space):
"""Selects the end points that have a non-empty set of attributes.
Args:
search_space: The search space.
Returns: All end points that have a non-empty set of attributes.
"""
cdef set empty_set = self._constants.get(None, set())
return (search_space - empty_set)
cdef set GetEndPointsForEmptySet(self, set search_space):
"""Selects the end points with an empty set of attributes.
Args:
search_space: The search space.
Returns: All end points that have a non-empty set of attributes.
"""
return self.GetEndPointsForAttribute(None, search_space)
def __str__(self):
parts = ['%s: %s' % (key, value)
for (key, value) in self._constants.iteritems()]
parts += ['%s: %s' % (key, value)
for (key, value) in self._regexes.iteritems()]
return '\n'.join(parts)
cdef bint NonEmptyIntersection(unicode regex1, unicode regex2):
"""Determines if the languages described by two regular expressions have a
non empty intersection.
Args:
regex1: A regular expression.
regex2: Another regular expression.
Returns: True if the two regular expressions describe languages with non-empty
intersection.
"""
#comment this out if you want (.*) and (.*) to not match
#return regex1==regex2
if regex1 == u'(.*)':
# This matches everything.
return True
elif regex2 == u'(.*)':
# This matches everything.
return True
elif '(.*)' in regex1:
# At least one string is a regex.
if re.match(EscapeRegex(regex1), regex2):
return True
if '(.*)' in regex2:
# We need to consider this case as an attempt to find the intersection of
# two regular expressions.
# For example, if regex1 = 'ab.*d' and regex2 = 'a.*d', then this will return
# True.
return re.match(EscapeRegex(regex2), regex1)
return False
elif '(.*)' in regex2:
# If we come here, then only regex2 is a regex.
return re.match(EscapeRegex(regex2), regex1)
else:
# Neither is a regex.
return regex1 == regex2
cdef unicode EscapeRegex(unicode astr):
"""Turns a string into a proper regular expression.
This involves escaping characters such as . and also not escaping parts of
strings that are unknown, as indicated by (.*).
Args:
astr: A string.
Returns: The cleansed regular expression.
"""
return re.escape(astr.replace('(.*)', 'ddddddd')).replace('ddddddd', '.*')
# Copyright (C) 2015 The Pennsylvania State University and the University of Wisconsin
# Systems and Internet Infrastructure Security Laboratory
#
# Author: Damien Octeau
#
# 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from linking.applications cimport Application
cdef int GetSkippedFilterCount()
cdef Component MakeComponent(object component_pb, Application application)
cdef class Component(object):
cdef readonly unicode name
cdef readonly int kind
cdef readonly unicode permission
cdef readonly tuple extras
cdef readonly bint exported
cdef readonly int exit_point_count
cdef readonly Application application
cdef public unicode _filters_attributes_string
cdef public unicode _intents_attributes_string
cdef readonly list intents
cdef readonly tuple descriptor
cdef readonly list filters
cdef long _hash
cdef readonly int id