id int32 0 252k | repo stringlengths 7 55 | path stringlengths 4 127 | func_name stringlengths 1 88 | original_string stringlengths 75 19.8k | language stringclasses 1 value | code stringlengths 51 19.8k | code_tokens list | docstring stringlengths 3 17.3k | docstring_tokens list | sha stringlengths 40 40 | url stringlengths 87 242 |
|---|---|---|---|---|---|---|---|---|---|---|---|
244,600 | ansible/ansible-container | container/utils/_text.py | to_bytes | def to_bytes(obj, encoding='utf-8', errors=None, nonstring='simplerepr'):
"""Make sure that a string is a byte string
:arg obj: An object to make sure is a byte string. In most cases this
will be either a text string or a byte string. However, with
``nonstring='simplerepr'``, this can be used as a traceback-free
version of ``str(obj)``.
:kwarg encoding: The encoding to use to transform from a text string to
a byte string. Defaults to using 'utf-8'.
:kwarg errors: The error handler to use if the text string is not
encodable using the specified encoding. Any valid `codecs error
handler <https://docs.python.org/2/library/codecs.html#codec-base-classes>`_
may be specified. There are three additional error strategies
specifically aimed at helping people to port code. The first two are:
:surrogate_or_strict: Will use ``surrogateescape`` if it is a valid
handler, otherwise it will use ``strict``
:surrogate_or_replace: Will use ``surrogateescape`` if it is a valid
handler, otherwise it will use ``replace``.
Because ``surrogateescape`` was added in Python3 this usually means that
Python3 will use ``surrogateescape`` and Python2 will use the fallback
error handler. Note that the code checks for ``surrogateescape`` when the
module is imported. If you have a backport of ``surrogateescape`` for
Python2, be sure to register the error handler prior to importing this
module.
The last error handler is:
:surrogate_then_replace: Will use ``surrogateescape`` if it is a valid
handler. If encoding with ``surrogateescape`` would traceback,
surrogates are first replaced with a replacement characters
and then the string is encoded using ``replace`` (which replaces
the rest of the nonencodable bytes). If ``surrogateescape`` is
not present it will simply use ``replace``. (Added in Ansible 2.3)
This strategy is designed to never traceback when it attempts
to encode a string.
The default until Ansible-2.2 was ``surrogate_or_replace``
From Ansible-2.3 onwards, the default is ``surrogate_then_replace``.
:kwarg nonstring: The strategy to use if a nonstring is specified in
``obj``. Default is 'simplerepr'. Valid values are:
:simplerepr: The default. This takes the ``str`` of the object and
then returns the bytes version of that string.
:empty: Return an empty byte string
:passthru: Return the object passed in
:strict: Raise a :exc:`TypeError`
:returns: Typically this returns a byte string. If a nonstring object is
passed in this may be a different type depending on the strategy
specified by nonstring. This will never return a text string.
.. note:: If passed a byte string, this function does not check that the
string is valid in the specified encoding. If it's important that the
byte string is in the specified encoding do::
encoded_string = to_bytes(to_text(input_string, 'latin-1'), 'utf-8')
.. version_changed:: 2.3
Added the ``surrogate_then_replace`` error handler and made it the default error handler.
"""
if isinstance(obj, binary_type):
return obj
# We're given a text string
# If it has surrogates, we know because it will decode
original_errors = errors
if errors in _COMPOSED_ERROR_HANDLERS:
if HAS_SURROGATEESCAPE:
errors = 'surrogateescape'
elif errors == 'surrogate_or_strict':
errors = 'strict'
else:
errors = 'replace'
if isinstance(obj, text_type):
try:
# Try this first as it's the fastest
return obj.encode(encoding, errors)
except UnicodeEncodeError:
if original_errors in (None, 'surrogate_then_replace'):
# Slow but works
return_string = obj.encode('utf-8', 'surrogateescape')
return_string = return_string.decode('utf-8', 'replace')
return return_string.encode(encoding, 'replace')
raise
# Note: We do these last even though we have to call to_bytes again on the
# value because we're optimizing the common case
if nonstring == 'simplerepr':
try:
value = str(obj)
except UnicodeError:
try:
value = repr(obj)
except UnicodeError:
# Giving up
return to_bytes('')
elif nonstring == 'passthru':
return obj
elif nonstring == 'empty':
# python2.4 doesn't have b''
return to_bytes('')
elif nonstring == 'strict':
raise TypeError('obj must be a string type')
else:
raise TypeError('Invalid value %s for to_bytes\' nonstring parameter' % nonstring)
return to_bytes(value, encoding, errors) | python | def to_bytes(obj, encoding='utf-8', errors=None, nonstring='simplerepr'):
if isinstance(obj, binary_type):
return obj
# We're given a text string
# If it has surrogates, we know because it will decode
original_errors = errors
if errors in _COMPOSED_ERROR_HANDLERS:
if HAS_SURROGATEESCAPE:
errors = 'surrogateescape'
elif errors == 'surrogate_or_strict':
errors = 'strict'
else:
errors = 'replace'
if isinstance(obj, text_type):
try:
# Try this first as it's the fastest
return obj.encode(encoding, errors)
except UnicodeEncodeError:
if original_errors in (None, 'surrogate_then_replace'):
# Slow but works
return_string = obj.encode('utf-8', 'surrogateescape')
return_string = return_string.decode('utf-8', 'replace')
return return_string.encode(encoding, 'replace')
raise
# Note: We do these last even though we have to call to_bytes again on the
# value because we're optimizing the common case
if nonstring == 'simplerepr':
try:
value = str(obj)
except UnicodeError:
try:
value = repr(obj)
except UnicodeError:
# Giving up
return to_bytes('')
elif nonstring == 'passthru':
return obj
elif nonstring == 'empty':
# python2.4 doesn't have b''
return to_bytes('')
elif nonstring == 'strict':
raise TypeError('obj must be a string type')
else:
raise TypeError('Invalid value %s for to_bytes\' nonstring parameter' % nonstring)
return to_bytes(value, encoding, errors) | [
"def",
"to_bytes",
"(",
"obj",
",",
"encoding",
"=",
"'utf-8'",
",",
"errors",
"=",
"None",
",",
"nonstring",
"=",
"'simplerepr'",
")",
":",
"if",
"isinstance",
"(",
"obj",
",",
"binary_type",
")",
":",
"return",
"obj",
"# We're given a text string",
"# If i... | Make sure that a string is a byte string
:arg obj: An object to make sure is a byte string. In most cases this
will be either a text string or a byte string. However, with
``nonstring='simplerepr'``, this can be used as a traceback-free
version of ``str(obj)``.
:kwarg encoding: The encoding to use to transform from a text string to
a byte string. Defaults to using 'utf-8'.
:kwarg errors: The error handler to use if the text string is not
encodable using the specified encoding. Any valid `codecs error
handler <https://docs.python.org/2/library/codecs.html#codec-base-classes>`_
may be specified. There are three additional error strategies
specifically aimed at helping people to port code. The first two are:
:surrogate_or_strict: Will use ``surrogateescape`` if it is a valid
handler, otherwise it will use ``strict``
:surrogate_or_replace: Will use ``surrogateescape`` if it is a valid
handler, otherwise it will use ``replace``.
Because ``surrogateescape`` was added in Python3 this usually means that
Python3 will use ``surrogateescape`` and Python2 will use the fallback
error handler. Note that the code checks for ``surrogateescape`` when the
module is imported. If you have a backport of ``surrogateescape`` for
Python2, be sure to register the error handler prior to importing this
module.
The last error handler is:
:surrogate_then_replace: Will use ``surrogateescape`` if it is a valid
handler. If encoding with ``surrogateescape`` would traceback,
surrogates are first replaced with a replacement characters
and then the string is encoded using ``replace`` (which replaces
the rest of the nonencodable bytes). If ``surrogateescape`` is
not present it will simply use ``replace``. (Added in Ansible 2.3)
This strategy is designed to never traceback when it attempts
to encode a string.
The default until Ansible-2.2 was ``surrogate_or_replace``
From Ansible-2.3 onwards, the default is ``surrogate_then_replace``.
:kwarg nonstring: The strategy to use if a nonstring is specified in
``obj``. Default is 'simplerepr'. Valid values are:
:simplerepr: The default. This takes the ``str`` of the object and
then returns the bytes version of that string.
:empty: Return an empty byte string
:passthru: Return the object passed in
:strict: Raise a :exc:`TypeError`
:returns: Typically this returns a byte string. If a nonstring object is
passed in this may be a different type depending on the strategy
specified by nonstring. This will never return a text string.
.. note:: If passed a byte string, this function does not check that the
string is valid in the specified encoding. If it's important that the
byte string is in the specified encoding do::
encoded_string = to_bytes(to_text(input_string, 'latin-1'), 'utf-8')
.. version_changed:: 2.3
Added the ``surrogate_then_replace`` error handler and made it the default error handler. | [
"Make",
"sure",
"that",
"a",
"string",
"is",
"a",
"byte",
"string"
] | d031c1a6133d5482a5d054fcbdbecafb923f8b4b | https://github.com/ansible/ansible-container/blob/d031c1a6133d5482a5d054fcbdbecafb923f8b4b/container/utils/_text.py#L52-L163 |
244,601 | ansible/ansible-container | container/utils/_text.py | to_text | def to_text(obj, encoding='utf-8', errors=None, nonstring='simplerepr'):
"""Make sure that a string is a text string
:arg obj: An object to make sure is a text string. In most cases this
will be either a text string or a byte string. However, with
``nonstring='simplerepr'``, this can be used as a traceback-free
version of ``str(obj)``.
:kwarg encoding: The encoding to use to transform from a byte string to
a text string. Defaults to using 'utf-8'.
:kwarg errors: The error handler to use if the byte string is not
decodable using the specified encoding. Any valid `codecs error
handler <https://docs.python.org/2/library/codecs.html#codec-base-classes>`_
may be specified. We support three additional error strategies
specifically aimed at helping people to port code:
:surrogate_or_strict: Will use surrogateescape if it is a valid
handler, otherwise it will use strict
:surrogate_or_replace: Will use surrogateescape if it is a valid
handler, otherwise it will use replace.
:surrogate_then_replace: Does the same as surrogate_or_replace but
`was added for symmetry with the error handlers in
:func:`ansible.module_utils._text.to_bytes` (Added in Ansible 2.3)
Because surrogateescape was added in Python3 this usually means that
Python3 will use `surrogateescape` and Python2 will use the fallback
error handler. Note that the code checks for surrogateescape when the
module is imported. If you have a backport of `surrogateescape` for
python2, be sure to register the error handler prior to importing this
module.
The default until Ansible-2.2 was `surrogate_or_replace`
In Ansible-2.3 this defaults to `surrogate_then_replace` for symmetry
with :func:`ansible.module_utils._text.to_bytes` .
:kwarg nonstring: The strategy to use if a nonstring is specified in
``obj``. Default is 'simplerepr'. Valid values are:
:simplerepr: The default. This takes the ``str`` of the object and
then returns the text version of that string.
:empty: Return an empty text string
:passthru: Return the object passed in
:strict: Raise a :exc:`TypeError`
:returns: Typically this returns a text string. If a nonstring object is
passed in this may be a different type depending on the strategy
specified by nonstring. This will never return a byte string.
From Ansible-2.3 onwards, the default is `surrogate_then_replace`.
.. version_changed:: 2.3
Added the surrogate_then_replace error handler and made it the default error handler.
"""
if isinstance(obj, text_type):
return obj
if errors in _COMPOSED_ERROR_HANDLERS:
if HAS_SURROGATEESCAPE:
errors = 'surrogateescape'
elif errors == 'surrogate_or_strict':
errors = 'strict'
else:
errors = 'replace'
if isinstance(obj, binary_type):
# Note: We don't need special handling for surrogate_then_replace
# because all bytes will either be made into surrogates or are valid
# to decode.
return obj.decode(encoding, errors)
# Note: We do these last even though we have to call to_text again on the
# value because we're optimizing the common case
if nonstring == 'simplerepr':
try:
value = str(obj)
except UnicodeError:
try:
value = repr(obj)
except UnicodeError:
# Giving up
return u''
elif nonstring == 'passthru':
return obj
elif nonstring == 'empty':
return u''
elif nonstring == 'strict':
raise TypeError('obj must be a string type')
else:
raise TypeError('Invalid value %s for to_text\'s nonstring parameter' % nonstring)
return to_text(value, encoding, errors) | python | def to_text(obj, encoding='utf-8', errors=None, nonstring='simplerepr'):
if isinstance(obj, text_type):
return obj
if errors in _COMPOSED_ERROR_HANDLERS:
if HAS_SURROGATEESCAPE:
errors = 'surrogateescape'
elif errors == 'surrogate_or_strict':
errors = 'strict'
else:
errors = 'replace'
if isinstance(obj, binary_type):
# Note: We don't need special handling for surrogate_then_replace
# because all bytes will either be made into surrogates or are valid
# to decode.
return obj.decode(encoding, errors)
# Note: We do these last even though we have to call to_text again on the
# value because we're optimizing the common case
if nonstring == 'simplerepr':
try:
value = str(obj)
except UnicodeError:
try:
value = repr(obj)
except UnicodeError:
# Giving up
return u''
elif nonstring == 'passthru':
return obj
elif nonstring == 'empty':
return u''
elif nonstring == 'strict':
raise TypeError('obj must be a string type')
else:
raise TypeError('Invalid value %s for to_text\'s nonstring parameter' % nonstring)
return to_text(value, encoding, errors) | [
"def",
"to_text",
"(",
"obj",
",",
"encoding",
"=",
"'utf-8'",
",",
"errors",
"=",
"None",
",",
"nonstring",
"=",
"'simplerepr'",
")",
":",
"if",
"isinstance",
"(",
"obj",
",",
"text_type",
")",
":",
"return",
"obj",
"if",
"errors",
"in",
"_COMPOSED_ERRO... | Make sure that a string is a text string
:arg obj: An object to make sure is a text string. In most cases this
will be either a text string or a byte string. However, with
``nonstring='simplerepr'``, this can be used as a traceback-free
version of ``str(obj)``.
:kwarg encoding: The encoding to use to transform from a byte string to
a text string. Defaults to using 'utf-8'.
:kwarg errors: The error handler to use if the byte string is not
decodable using the specified encoding. Any valid `codecs error
handler <https://docs.python.org/2/library/codecs.html#codec-base-classes>`_
may be specified. We support three additional error strategies
specifically aimed at helping people to port code:
:surrogate_or_strict: Will use surrogateescape if it is a valid
handler, otherwise it will use strict
:surrogate_or_replace: Will use surrogateescape if it is a valid
handler, otherwise it will use replace.
:surrogate_then_replace: Does the same as surrogate_or_replace but
`was added for symmetry with the error handlers in
:func:`ansible.module_utils._text.to_bytes` (Added in Ansible 2.3)
Because surrogateescape was added in Python3 this usually means that
Python3 will use `surrogateescape` and Python2 will use the fallback
error handler. Note that the code checks for surrogateescape when the
module is imported. If you have a backport of `surrogateescape` for
python2, be sure to register the error handler prior to importing this
module.
The default until Ansible-2.2 was `surrogate_or_replace`
In Ansible-2.3 this defaults to `surrogate_then_replace` for symmetry
with :func:`ansible.module_utils._text.to_bytes` .
:kwarg nonstring: The strategy to use if a nonstring is specified in
``obj``. Default is 'simplerepr'. Valid values are:
:simplerepr: The default. This takes the ``str`` of the object and
then returns the text version of that string.
:empty: Return an empty text string
:passthru: Return the object passed in
:strict: Raise a :exc:`TypeError`
:returns: Typically this returns a text string. If a nonstring object is
passed in this may be a different type depending on the strategy
specified by nonstring. This will never return a byte string.
From Ansible-2.3 onwards, the default is `surrogate_then_replace`.
.. version_changed:: 2.3
Added the surrogate_then_replace error handler and made it the default error handler. | [
"Make",
"sure",
"that",
"a",
"string",
"is",
"a",
"text",
"string"
] | d031c1a6133d5482a5d054fcbdbecafb923f8b4b | https://github.com/ansible/ansible-container/blob/d031c1a6133d5482a5d054fcbdbecafb923f8b4b/container/utils/_text.py#L166-L254 |
244,602 | ansible/ansible-container | container/core.py | push_images | def push_images(base_path, image_namespace, engine_obj, config, **kwargs):
""" Pushes images to a Docker registry. Returns dict containing attributes used to push images. """
config_path = kwargs.get('config_path', engine_obj.auth_config_path)
username = kwargs.get('username')
password = kwargs.get('password')
push_to = kwargs.get('push_to')
url = engine_obj.default_registry_url
registry_name = engine_obj.default_registry_name
namespace = image_namespace
save_conductor = config.save_conductor
repository_prefix = None
pull_from_url = None
if push_to:
if config.get('registries', dict()).get(push_to):
url = config['registries'][push_to].get('url')
namespace = config['registries'][push_to].get('namespace', namespace)
repository_prefix = config['registries'][push_to].get('repository_prefix')
pull_from_url = config['registries'][push_to].get('pull_from_url')
if not url:
raise AnsibleContainerRegistryAttributeException(
u"Registry {} missing required attribute 'url'".format(push_to)
)
else:
url, namespace = resolve_push_to(push_to, engine_obj.default_registry_url, namespace)
if username and not password:
# If a username was supplied without a password, prompt for it
if url != engine_obj.default_registry_url:
registry_name = url
while not password:
password = getpass.getpass(u"Enter password for {0} at {1}: ".format(username, registry_name))
if config_path:
# Make sure the config_path exists
# - gives us a chance to create the file with correct permissions, if it does not exists
# - makes sure we mount a path to the conductor for a specific file
config_path = os.path.normpath(os.path.expanduser(config_path))
if os.path.exists(config_path) and os.path.isdir(config_path):
raise AnsibleContainerException(
u"Expecting --config-path to be a path to a file, not a directory"
)
elif not os.path.exists(config_path):
# Make sure the directory path exists
if not os.path.exists(os.path.dirname(config_path)):
try:
os.makedirs(os.path.dirname(config_path), 0o750)
except OSError:
raise AnsibleContainerException(
u"Failed to create the requested the path {}".format(os.path.dirname(config_path))
)
# Touch the file
open(config_path, 'w').close()
# If you ran build with --save-build-container, then you're broken without first removing
# the old build container.
remove_existing_container(engine_obj, 'conductor', remove_volumes=True)
push_params = {}
push_params.update(kwargs)
push_params['config_path'] = config_path
push_params['password'] = password
push_params['url'] = url
push_params['namespace'] = namespace
push_params['repository_prefix'] = repository_prefix
push_params['pull_from_url'] = pull_from_url
# Push
engine_obj.await_conductor_command('push', dict(config), base_path, push_params, save_container=save_conductor)
return {'url': url,
'namespace': namespace,
'repository_prefix': repository_prefix,
'pull_from_url': pull_from_url } | python | def push_images(base_path, image_namespace, engine_obj, config, **kwargs):
config_path = kwargs.get('config_path', engine_obj.auth_config_path)
username = kwargs.get('username')
password = kwargs.get('password')
push_to = kwargs.get('push_to')
url = engine_obj.default_registry_url
registry_name = engine_obj.default_registry_name
namespace = image_namespace
save_conductor = config.save_conductor
repository_prefix = None
pull_from_url = None
if push_to:
if config.get('registries', dict()).get(push_to):
url = config['registries'][push_to].get('url')
namespace = config['registries'][push_to].get('namespace', namespace)
repository_prefix = config['registries'][push_to].get('repository_prefix')
pull_from_url = config['registries'][push_to].get('pull_from_url')
if not url:
raise AnsibleContainerRegistryAttributeException(
u"Registry {} missing required attribute 'url'".format(push_to)
)
else:
url, namespace = resolve_push_to(push_to, engine_obj.default_registry_url, namespace)
if username and not password:
# If a username was supplied without a password, prompt for it
if url != engine_obj.default_registry_url:
registry_name = url
while not password:
password = getpass.getpass(u"Enter password for {0} at {1}: ".format(username, registry_name))
if config_path:
# Make sure the config_path exists
# - gives us a chance to create the file with correct permissions, if it does not exists
# - makes sure we mount a path to the conductor for a specific file
config_path = os.path.normpath(os.path.expanduser(config_path))
if os.path.exists(config_path) and os.path.isdir(config_path):
raise AnsibleContainerException(
u"Expecting --config-path to be a path to a file, not a directory"
)
elif not os.path.exists(config_path):
# Make sure the directory path exists
if not os.path.exists(os.path.dirname(config_path)):
try:
os.makedirs(os.path.dirname(config_path), 0o750)
except OSError:
raise AnsibleContainerException(
u"Failed to create the requested the path {}".format(os.path.dirname(config_path))
)
# Touch the file
open(config_path, 'w').close()
# If you ran build with --save-build-container, then you're broken without first removing
# the old build container.
remove_existing_container(engine_obj, 'conductor', remove_volumes=True)
push_params = {}
push_params.update(kwargs)
push_params['config_path'] = config_path
push_params['password'] = password
push_params['url'] = url
push_params['namespace'] = namespace
push_params['repository_prefix'] = repository_prefix
push_params['pull_from_url'] = pull_from_url
# Push
engine_obj.await_conductor_command('push', dict(config), base_path, push_params, save_container=save_conductor)
return {'url': url,
'namespace': namespace,
'repository_prefix': repository_prefix,
'pull_from_url': pull_from_url } | [
"def",
"push_images",
"(",
"base_path",
",",
"image_namespace",
",",
"engine_obj",
",",
"config",
",",
"*",
"*",
"kwargs",
")",
":",
"config_path",
"=",
"kwargs",
".",
"get",
"(",
"'config_path'",
",",
"engine_obj",
".",
"auth_config_path",
")",
"username",
... | Pushes images to a Docker registry. Returns dict containing attributes used to push images. | [
"Pushes",
"images",
"to",
"a",
"Docker",
"registry",
".",
"Returns",
"dict",
"containing",
"attributes",
"used",
"to",
"push",
"images",
"."
] | d031c1a6133d5482a5d054fcbdbecafb923f8b4b | https://github.com/ansible/ansible-container/blob/d031c1a6133d5482a5d054fcbdbecafb923f8b4b/container/core.py#L394-L467 |
244,603 | ansible/ansible-container | container/core.py | remove_existing_container | def remove_existing_container(engine_obj, service_name, remove_volumes=False):
"""
Remove a container for an existing service. Handy for removing an existing conductor.
"""
conductor_container_id = engine_obj.get_container_id_for_service(service_name)
if engine_obj.service_is_running(service_name):
engine_obj.stop_container(conductor_container_id, forcefully=True)
if conductor_container_id:
engine_obj.delete_container(conductor_container_id, remove_volumes=remove_volumes) | python | def remove_existing_container(engine_obj, service_name, remove_volumes=False):
conductor_container_id = engine_obj.get_container_id_for_service(service_name)
if engine_obj.service_is_running(service_name):
engine_obj.stop_container(conductor_container_id, forcefully=True)
if conductor_container_id:
engine_obj.delete_container(conductor_container_id, remove_volumes=remove_volumes) | [
"def",
"remove_existing_container",
"(",
"engine_obj",
",",
"service_name",
",",
"remove_volumes",
"=",
"False",
")",
":",
"conductor_container_id",
"=",
"engine_obj",
".",
"get_container_id_for_service",
"(",
"service_name",
")",
"if",
"engine_obj",
".",
"service_is_ru... | Remove a container for an existing service. Handy for removing an existing conductor. | [
"Remove",
"a",
"container",
"for",
"an",
"existing",
"service",
".",
"Handy",
"for",
"removing",
"an",
"existing",
"conductor",
"."
] | d031c1a6133d5482a5d054fcbdbecafb923f8b4b | https://github.com/ansible/ansible-container/blob/d031c1a6133d5482a5d054fcbdbecafb923f8b4b/container/core.py#L510-L518 |
244,604 | ansible/ansible-container | container/core.py | resolve_push_to | def resolve_push_to(push_to, default_url, default_namespace):
'''
Given a push-to value, return the registry and namespace.
:param push_to: string: User supplied --push-to value.
:param default_url: string: Container engine's default_index value (e.g. docker.io).
:return: tuple: registry_url, namespace
'''
protocol = 'http://' if push_to.startswith('http://') else 'https://'
url = push_to = REMOVE_HTTP.sub('', push_to)
namespace = default_namespace
parts = url.split('/', 1)
special_set = {'.', ':'}
char_set = set([c for c in parts[0]])
if len(parts) == 1:
if not special_set.intersection(char_set) and parts[0] != 'localhost':
registry_url = default_url
namespace = push_to
else:
registry_url = protocol + parts[0]
else:
registry_url = protocol + parts[0]
namespace = parts[1]
return registry_url, namespace | python | def resolve_push_to(push_to, default_url, default_namespace):
'''
Given a push-to value, return the registry and namespace.
:param push_to: string: User supplied --push-to value.
:param default_url: string: Container engine's default_index value (e.g. docker.io).
:return: tuple: registry_url, namespace
'''
protocol = 'http://' if push_to.startswith('http://') else 'https://'
url = push_to = REMOVE_HTTP.sub('', push_to)
namespace = default_namespace
parts = url.split('/', 1)
special_set = {'.', ':'}
char_set = set([c for c in parts[0]])
if len(parts) == 1:
if not special_set.intersection(char_set) and parts[0] != 'localhost':
registry_url = default_url
namespace = push_to
else:
registry_url = protocol + parts[0]
else:
registry_url = protocol + parts[0]
namespace = parts[1]
return registry_url, namespace | [
"def",
"resolve_push_to",
"(",
"push_to",
",",
"default_url",
",",
"default_namespace",
")",
":",
"protocol",
"=",
"'http://'",
"if",
"push_to",
".",
"startswith",
"(",
"'http://'",
")",
"else",
"'https://'",
"url",
"=",
"push_to",
"=",
"REMOVE_HTTP",
".",
"su... | Given a push-to value, return the registry and namespace.
:param push_to: string: User supplied --push-to value.
:param default_url: string: Container engine's default_index value (e.g. docker.io).
:return: tuple: registry_url, namespace | [
"Given",
"a",
"push",
"-",
"to",
"value",
"return",
"the",
"registry",
"and",
"namespace",
"."
] | d031c1a6133d5482a5d054fcbdbecafb923f8b4b | https://github.com/ansible/ansible-container/blob/d031c1a6133d5482a5d054fcbdbecafb923f8b4b/container/core.py#L522-L546 |
244,605 | ansible/ansible-container | container/core.py | conductorcmd_push | def conductorcmd_push(engine_name, project_name, services, **kwargs):
""" Push images to a registry """
username = kwargs.pop('username')
password = kwargs.pop('password')
email = kwargs.pop('email')
url = kwargs.pop('url')
namespace = kwargs.pop('namespace')
tag = kwargs.pop('tag')
config_path = kwargs.pop('config_path')
repository_prefix =kwargs.pop('repository_prefix')
engine = load_engine(['PUSH', 'LOGIN'], engine_name, project_name, services)
logger.info(u'Engine integration loaded. Preparing push.',
engine=engine.display_name)
# Verify that we can authenticate with the registry
username, password = engine.login(username, password, email, url, config_path)
# Push each image that has been built using Ansible roles
for name, service in iteritems(services):
if service.get('containers'):
for c in service['containers']:
if 'roles' in c:
cname = '%s-%s' % (name, c['container_name'])
image_id = engine.get_latest_image_id_for_service(cname)
engine.push(image_id, cname, url=url, tag=tag, namespace=namespace, username=username,
password=password, repository_prefix=repository_prefix)
elif 'roles' in service:
# if the service has roles, it's an image we should push
image_id = engine.get_latest_image_id_for_service(name)
engine.push(image_id, name, url=url, tag=tag, namespace=namespace, username=username,
password=password, repository_prefix=repository_prefix) | python | def conductorcmd_push(engine_name, project_name, services, **kwargs):
username = kwargs.pop('username')
password = kwargs.pop('password')
email = kwargs.pop('email')
url = kwargs.pop('url')
namespace = kwargs.pop('namespace')
tag = kwargs.pop('tag')
config_path = kwargs.pop('config_path')
repository_prefix =kwargs.pop('repository_prefix')
engine = load_engine(['PUSH', 'LOGIN'], engine_name, project_name, services)
logger.info(u'Engine integration loaded. Preparing push.',
engine=engine.display_name)
# Verify that we can authenticate with the registry
username, password = engine.login(username, password, email, url, config_path)
# Push each image that has been built using Ansible roles
for name, service in iteritems(services):
if service.get('containers'):
for c in service['containers']:
if 'roles' in c:
cname = '%s-%s' % (name, c['container_name'])
image_id = engine.get_latest_image_id_for_service(cname)
engine.push(image_id, cname, url=url, tag=tag, namespace=namespace, username=username,
password=password, repository_prefix=repository_prefix)
elif 'roles' in service:
# if the service has roles, it's an image we should push
image_id = engine.get_latest_image_id_for_service(name)
engine.push(image_id, name, url=url, tag=tag, namespace=namespace, username=username,
password=password, repository_prefix=repository_prefix) | [
"def",
"conductorcmd_push",
"(",
"engine_name",
",",
"project_name",
",",
"services",
",",
"*",
"*",
"kwargs",
")",
":",
"username",
"=",
"kwargs",
".",
"pop",
"(",
"'username'",
")",
"password",
"=",
"kwargs",
".",
"pop",
"(",
"'password'",
")",
"email",
... | Push images to a registry | [
"Push",
"images",
"to",
"a",
"registry"
] | d031c1a6133d5482a5d054fcbdbecafb923f8b4b | https://github.com/ansible/ansible-container/blob/d031c1a6133d5482a5d054fcbdbecafb923f8b4b/container/core.py#L1038-L1069 |
244,606 | ansible/ansible-container | container/openshift/deploy.py | Deploy.get_route_templates | def get_route_templates(self):
"""
Generate Openshift route templates or playbook tasks. Each port on a service definition found in container.yml
represents an externally exposed port.
"""
def _get_published_ports(service_config):
result = []
for port in service_config.get('ports', []):
protocol = 'TCP'
if isinstance(port, string_types) and '/' in port:
port, protocol = port.split('/')
if isinstance(port, string_types) and ':' in port:
host, container = port.split(':')
else:
host = port
result.append({'port': host, 'protocol': protocol.lower()})
return result
templates = []
for name, service_config in self._services.items():
state = service_config.get(self.CONFIG_KEY, {}).get('state', 'present')
force = service_config.get(self.CONFIG_KEY, {}).get('force', False)
published_ports = _get_published_ports(service_config)
if state != 'present':
continue
for port in published_ports:
route_name = "%s-%s" % (name, port['port'])
labels = dict(
app=self._namespace_name,
service=name
)
template = CommentedMap()
template['apiVersion'] = self.DEFAULT_API_VERSION
template['kind'] = 'Route'
template['force'] = force
template['metadata'] = CommentedMap([
('name', route_name),
('namespace', self._namespace_name),
('labels', labels.copy())
])
template['spec'] = CommentedMap([
('to', CommentedMap([
('kind', 'Service'),
('name', name)
])),
('port', CommentedMap([
('targetPort', 'port-{}-{}'.format(port['port'], port['protocol']))
]))
])
if service_config.get(self.CONFIG_KEY, {}).get('routes'):
for route in service_config[self.CONFIG_KEY]['routes']:
if str(route.get('port')) == str(port['port']):
for key, value in route.items():
if key not in ('force', 'port'):
self.copy_attribute(template['spec'], key, value)
templates.append(template)
return templates | python | def get_route_templates(self):
def _get_published_ports(service_config):
result = []
for port in service_config.get('ports', []):
protocol = 'TCP'
if isinstance(port, string_types) and '/' in port:
port, protocol = port.split('/')
if isinstance(port, string_types) and ':' in port:
host, container = port.split(':')
else:
host = port
result.append({'port': host, 'protocol': protocol.lower()})
return result
templates = []
for name, service_config in self._services.items():
state = service_config.get(self.CONFIG_KEY, {}).get('state', 'present')
force = service_config.get(self.CONFIG_KEY, {}).get('force', False)
published_ports = _get_published_ports(service_config)
if state != 'present':
continue
for port in published_ports:
route_name = "%s-%s" % (name, port['port'])
labels = dict(
app=self._namespace_name,
service=name
)
template = CommentedMap()
template['apiVersion'] = self.DEFAULT_API_VERSION
template['kind'] = 'Route'
template['force'] = force
template['metadata'] = CommentedMap([
('name', route_name),
('namespace', self._namespace_name),
('labels', labels.copy())
])
template['spec'] = CommentedMap([
('to', CommentedMap([
('kind', 'Service'),
('name', name)
])),
('port', CommentedMap([
('targetPort', 'port-{}-{}'.format(port['port'], port['protocol']))
]))
])
if service_config.get(self.CONFIG_KEY, {}).get('routes'):
for route in service_config[self.CONFIG_KEY]['routes']:
if str(route.get('port')) == str(port['port']):
for key, value in route.items():
if key not in ('force', 'port'):
self.copy_attribute(template['spec'], key, value)
templates.append(template)
return templates | [
"def",
"get_route_templates",
"(",
"self",
")",
":",
"def",
"_get_published_ports",
"(",
"service_config",
")",
":",
"result",
"=",
"[",
"]",
"for",
"port",
"in",
"service_config",
".",
"get",
"(",
"'ports'",
",",
"[",
"]",
")",
":",
"protocol",
"=",
"'T... | Generate Openshift route templates or playbook tasks. Each port on a service definition found in container.yml
represents an externally exposed port. | [
"Generate",
"Openshift",
"route",
"templates",
"or",
"playbook",
"tasks",
".",
"Each",
"port",
"on",
"a",
"service",
"definition",
"found",
"in",
"container",
".",
"yml",
"represents",
"an",
"externally",
"exposed",
"port",
"."
] | d031c1a6133d5482a5d054fcbdbecafb923f8b4b | https://github.com/ansible/ansible-container/blob/d031c1a6133d5482a5d054fcbdbecafb923f8b4b/container/openshift/deploy.py#L56-L117 |
244,607 | ansible/ansible-container | container/docker/importer.py | DockerfileParser.preparse_iter | def preparse_iter(self):
"""
Comments can be anywhere. So break apart the Dockerfile into significant
lines and any comments that precede them. And if a line is a carryover
from the previous via an escaped-newline, bring the directive with it.
"""
to_yield = {}
last_directive = None
lines_processed = 0
for line in self.lines_iter():
if not line:
continue
if line.startswith(u'#'):
comment = line.lstrip('#').strip()
# Directives have to precede any instructions
if lines_processed == 1:
if comment.startswith(u'escape='):
self.escape_char = comment.split(u'=', 1)[1]
continue
to_yield.setdefault('comments', []).append(comment)
else:
# last_directive being set means the previous line ended with a
# newline escape
if last_directive:
directive, payload = last_directive, line
else:
directive, payload = line.split(u' ', 1)
if line.endswith(self.escape_char):
payload = payload.rstrip(self.escape_char)
last_directive = directive
else:
last_directive = None
to_yield['directive'] = directive
to_yield['payload'] = payload.strip()
yield to_yield
to_yield = {} | python | def preparse_iter(self):
to_yield = {}
last_directive = None
lines_processed = 0
for line in self.lines_iter():
if not line:
continue
if line.startswith(u'#'):
comment = line.lstrip('#').strip()
# Directives have to precede any instructions
if lines_processed == 1:
if comment.startswith(u'escape='):
self.escape_char = comment.split(u'=', 1)[1]
continue
to_yield.setdefault('comments', []).append(comment)
else:
# last_directive being set means the previous line ended with a
# newline escape
if last_directive:
directive, payload = last_directive, line
else:
directive, payload = line.split(u' ', 1)
if line.endswith(self.escape_char):
payload = payload.rstrip(self.escape_char)
last_directive = directive
else:
last_directive = None
to_yield['directive'] = directive
to_yield['payload'] = payload.strip()
yield to_yield
to_yield = {} | [
"def",
"preparse_iter",
"(",
"self",
")",
":",
"to_yield",
"=",
"{",
"}",
"last_directive",
"=",
"None",
"lines_processed",
"=",
"0",
"for",
"line",
"in",
"self",
".",
"lines_iter",
"(",
")",
":",
"if",
"not",
"line",
":",
"continue",
"if",
"line",
"."... | Comments can be anywhere. So break apart the Dockerfile into significant
lines and any comments that precede them. And if a line is a carryover
from the previous via an escaped-newline, bring the directive with it. | [
"Comments",
"can",
"be",
"anywhere",
".",
"So",
"break",
"apart",
"the",
"Dockerfile",
"into",
"significant",
"lines",
"and",
"any",
"comments",
"that",
"precede",
"them",
".",
"And",
"if",
"a",
"line",
"is",
"a",
"carryover",
"from",
"the",
"previous",
"v... | d031c1a6133d5482a5d054fcbdbecafb923f8b4b | https://github.com/ansible/ansible-container/blob/d031c1a6133d5482a5d054fcbdbecafb923f8b4b/container/docker/importer.py#L120-L155 |
244,608 | ansible/ansible-container | container/docker/engine.py | Engine.run_container | def run_container(self, image_id, service_name, **kwargs):
"""Run a particular container. The kwargs argument contains individual
parameter overrides from the service definition."""
run_kwargs = self.run_kwargs_for_service(service_name)
run_kwargs.update(kwargs, relax=True)
logger.debug('Running container in docker', image=image_id, params=run_kwargs)
container_obj = self.client.containers.run(
image=image_id,
detach=True,
**run_kwargs
)
log_iter = container_obj.logs(stdout=True, stderr=True, stream=True)
mux = logmux.LogMultiplexer()
mux.add_iterator(log_iter, plainLogger)
return container_obj.id | python | def run_container(self, image_id, service_name, **kwargs):
run_kwargs = self.run_kwargs_for_service(service_name)
run_kwargs.update(kwargs, relax=True)
logger.debug('Running container in docker', image=image_id, params=run_kwargs)
container_obj = self.client.containers.run(
image=image_id,
detach=True,
**run_kwargs
)
log_iter = container_obj.logs(stdout=True, stderr=True, stream=True)
mux = logmux.LogMultiplexer()
mux.add_iterator(log_iter, plainLogger)
return container_obj.id | [
"def",
"run_container",
"(",
"self",
",",
"image_id",
",",
"service_name",
",",
"*",
"*",
"kwargs",
")",
":",
"run_kwargs",
"=",
"self",
".",
"run_kwargs_for_service",
"(",
"service_name",
")",
"run_kwargs",
".",
"update",
"(",
"kwargs",
",",
"relax",
"=",
... | Run a particular container. The kwargs argument contains individual
parameter overrides from the service definition. | [
"Run",
"a",
"particular",
"container",
".",
"The",
"kwargs",
"argument",
"contains",
"individual",
"parameter",
"overrides",
"from",
"the",
"service",
"definition",
"."
] | d031c1a6133d5482a5d054fcbdbecafb923f8b4b | https://github.com/ansible/ansible-container/blob/d031c1a6133d5482a5d054fcbdbecafb923f8b4b/container/docker/engine.py#L265-L281 |
244,609 | ansible/ansible-container | container/docker/engine.py | Engine.push | def push(self, image_id, service_name, tag=None, namespace=None, url=None, username=None, password=None,
repository_prefix=None, **kwargs):
"""
Push an image to a remote registry.
"""
auth_config = {
'username': username,
'password': password
}
build_stamp = self.get_build_stamp_for_image(image_id)
tag = tag or build_stamp
if repository_prefix:
image_name = "{}-{}".format(repository_prefix, service_name)
elif repository_prefix is None:
image_name = "{}-{}".format(self.project_name, service_name)
elif repository_prefix == '':
image_name = service_name
repository = "{}/{}".format(namespace, image_name)
if url != self.default_registry_url:
url = REMOVE_HTTP.sub('', url)
repository = "%s/%s" % (url.rstrip('/'), repository)
logger.info('Tagging %s' % repository)
self.client.api.tag(image_id, repository, tag=tag)
logger.info('Pushing %s:%s...' % (repository, tag))
stream = self.client.api.push(repository, tag=tag, stream=True, auth_config=auth_config)
last_status = None
for data in stream:
data = data.splitlines()
for line in data:
line = json.loads(line)
if type(line) is dict and 'error' in line:
plainLogger.error(line['error'])
raise exceptions.AnsibleContainerException(
"Failed to push image. {}".format(line['error'])
)
elif type(line) is dict and 'status' in line:
if line['status'] != last_status:
plainLogger.info(line['status'])
last_status = line['status']
else:
plainLogger.debug(line) | python | def push(self, image_id, service_name, tag=None, namespace=None, url=None, username=None, password=None,
repository_prefix=None, **kwargs):
auth_config = {
'username': username,
'password': password
}
build_stamp = self.get_build_stamp_for_image(image_id)
tag = tag or build_stamp
if repository_prefix:
image_name = "{}-{}".format(repository_prefix, service_name)
elif repository_prefix is None:
image_name = "{}-{}".format(self.project_name, service_name)
elif repository_prefix == '':
image_name = service_name
repository = "{}/{}".format(namespace, image_name)
if url != self.default_registry_url:
url = REMOVE_HTTP.sub('', url)
repository = "%s/%s" % (url.rstrip('/'), repository)
logger.info('Tagging %s' % repository)
self.client.api.tag(image_id, repository, tag=tag)
logger.info('Pushing %s:%s...' % (repository, tag))
stream = self.client.api.push(repository, tag=tag, stream=True, auth_config=auth_config)
last_status = None
for data in stream:
data = data.splitlines()
for line in data:
line = json.loads(line)
if type(line) is dict and 'error' in line:
plainLogger.error(line['error'])
raise exceptions.AnsibleContainerException(
"Failed to push image. {}".format(line['error'])
)
elif type(line) is dict and 'status' in line:
if line['status'] != last_status:
plainLogger.info(line['status'])
last_status = line['status']
else:
plainLogger.debug(line) | [
"def",
"push",
"(",
"self",
",",
"image_id",
",",
"service_name",
",",
"tag",
"=",
"None",
",",
"namespace",
"=",
"None",
",",
"url",
"=",
"None",
",",
"username",
"=",
"None",
",",
"password",
"=",
"None",
",",
"repository_prefix",
"=",
"None",
",",
... | Push an image to a remote registry. | [
"Push",
"an",
"image",
"to",
"a",
"remote",
"registry",
"."
] | d031c1a6133d5482a5d054fcbdbecafb923f8b4b | https://github.com/ansible/ansible-container/blob/d031c1a6133d5482a5d054fcbdbecafb923f8b4b/container/docker/engine.py#L895-L941 |
244,610 | ansible/ansible-container | container/docker/engine.py | Engine.login | def login(self, username, password, email, url, config_path):
"""
If username and password are provided, authenticate with the registry.
Otherwise, check the config file for existing authentication data.
"""
if username and password:
try:
self.client.login(username=username, password=password, email=email,
registry=url, reauth=True)
except docker_errors.APIError as exc:
raise exceptions.AnsibleContainerConductorException(
u"Error logging into registry: {}".format(exc)
)
except Exception:
raise
self._update_config_file(username, password, email, url, config_path)
username, password = self._get_registry_auth(url, config_path)
if not username:
raise exceptions.AnsibleContainerConductorException(
u'Please provide login credentials for registry {}.'.format(url))
return username, password | python | def login(self, username, password, email, url, config_path):
if username and password:
try:
self.client.login(username=username, password=password, email=email,
registry=url, reauth=True)
except docker_errors.APIError as exc:
raise exceptions.AnsibleContainerConductorException(
u"Error logging into registry: {}".format(exc)
)
except Exception:
raise
self._update_config_file(username, password, email, url, config_path)
username, password = self._get_registry_auth(url, config_path)
if not username:
raise exceptions.AnsibleContainerConductorException(
u'Please provide login credentials for registry {}.'.format(url))
return username, password | [
"def",
"login",
"(",
"self",
",",
"username",
",",
"password",
",",
"email",
",",
"url",
",",
"config_path",
")",
":",
"if",
"username",
"and",
"password",
":",
"try",
":",
"self",
".",
"client",
".",
"login",
"(",
"username",
"=",
"username",
",",
"... | If username and password are provided, authenticate with the registry.
Otherwise, check the config file for existing authentication data. | [
"If",
"username",
"and",
"password",
"are",
"provided",
"authenticate",
"with",
"the",
"registry",
".",
"Otherwise",
"check",
"the",
"config",
"file",
"for",
"existing",
"authentication",
"data",
"."
] | d031c1a6133d5482a5d054fcbdbecafb923f8b4b | https://github.com/ansible/ansible-container/blob/d031c1a6133d5482a5d054fcbdbecafb923f8b4b/container/docker/engine.py#L1186-L1208 |
244,611 | ansible/ansible-container | container/docker/engine.py | Engine._update_config_file | def _update_config_file(username, password, email, url, config_path):
"""Update the config file with the authorization."""
try:
# read the existing config
config = json.load(open(config_path, "r"))
except ValueError:
config = dict()
if not config.get('auths'):
config['auths'] = dict()
if not config['auths'].get(url):
config['auths'][url] = dict()
encoded_credentials = dict(
auth=base64.b64encode(username + b':' + password),
email=email
)
config['auths'][url] = encoded_credentials
try:
json.dump(config, open(config_path, "w"), indent=5, sort_keys=True)
except Exception as exc:
raise exceptions.AnsibleContainerConductorException(
u"Failed to write registry config to {0} - {1}".format(config_path, exc)
) | python | def _update_config_file(username, password, email, url, config_path):
try:
# read the existing config
config = json.load(open(config_path, "r"))
except ValueError:
config = dict()
if not config.get('auths'):
config['auths'] = dict()
if not config['auths'].get(url):
config['auths'][url] = dict()
encoded_credentials = dict(
auth=base64.b64encode(username + b':' + password),
email=email
)
config['auths'][url] = encoded_credentials
try:
json.dump(config, open(config_path, "w"), indent=5, sort_keys=True)
except Exception as exc:
raise exceptions.AnsibleContainerConductorException(
u"Failed to write registry config to {0} - {1}".format(config_path, exc)
) | [
"def",
"_update_config_file",
"(",
"username",
",",
"password",
",",
"email",
",",
"url",
",",
"config_path",
")",
":",
"try",
":",
"# read the existing config",
"config",
"=",
"json",
".",
"load",
"(",
"open",
"(",
"config_path",
",",
"\"r\"",
")",
")",
"... | Update the config file with the authorization. | [
"Update",
"the",
"config",
"file",
"with",
"the",
"authorization",
"."
] | d031c1a6133d5482a5d054fcbdbecafb923f8b4b | https://github.com/ansible/ansible-container/blob/d031c1a6133d5482a5d054fcbdbecafb923f8b4b/container/docker/engine.py#L1212-L1235 |
244,612 | ansible/ansible-container | container/docker/engine.py | Engine._get_registry_auth | def _get_registry_auth(registry_url, config_path):
"""
Retrieve from the config file the current authentication for a given URL, and
return the username, password
"""
username = None
password = None
try:
docker_config = json.load(open(config_path))
except ValueError:
# The configuration file is empty
return username, password
if docker_config.get('auths'):
docker_config = docker_config['auths']
auth_key = docker_config.get(registry_url, {}).get('auth', None)
if auth_key:
username, password = base64.b64decode(auth_key).split(':', 1)
return username, password | python | def _get_registry_auth(registry_url, config_path):
username = None
password = None
try:
docker_config = json.load(open(config_path))
except ValueError:
# The configuration file is empty
return username, password
if docker_config.get('auths'):
docker_config = docker_config['auths']
auth_key = docker_config.get(registry_url, {}).get('auth', None)
if auth_key:
username, password = base64.b64decode(auth_key).split(':', 1)
return username, password | [
"def",
"_get_registry_auth",
"(",
"registry_url",
",",
"config_path",
")",
":",
"username",
"=",
"None",
"password",
"=",
"None",
"try",
":",
"docker_config",
"=",
"json",
".",
"load",
"(",
"open",
"(",
"config_path",
")",
")",
"except",
"ValueError",
":",
... | Retrieve from the config file the current authentication for a given URL, and
return the username, password | [
"Retrieve",
"from",
"the",
"config",
"file",
"the",
"current",
"authentication",
"for",
"a",
"given",
"URL",
"and",
"return",
"the",
"username",
"password"
] | d031c1a6133d5482a5d054fcbdbecafb923f8b4b | https://github.com/ansible/ansible-container/blob/d031c1a6133d5482a5d054fcbdbecafb923f8b4b/container/docker/engine.py#L1239-L1256 |
244,613 | ansible/ansible-container | container/utils/__init__.py | resolve_role_to_path | def resolve_role_to_path(role):
"""
Given a role definition from a service's list of roles, returns the file path to the role
"""
loader = DataLoader()
try:
variable_manager = VariableManager(loader=loader)
except TypeError:
# If Ansible prior to ansible/ansible@8f97aef1a365
variable_manager = VariableManager()
role_obj = RoleInclude.load(data=role, play=None,
variable_manager=variable_manager,
loader=loader)
return role_obj._role_path | python | def resolve_role_to_path(role):
loader = DataLoader()
try:
variable_manager = VariableManager(loader=loader)
except TypeError:
# If Ansible prior to ansible/ansible@8f97aef1a365
variable_manager = VariableManager()
role_obj = RoleInclude.load(data=role, play=None,
variable_manager=variable_manager,
loader=loader)
return role_obj._role_path | [
"def",
"resolve_role_to_path",
"(",
"role",
")",
":",
"loader",
"=",
"DataLoader",
"(",
")",
"try",
":",
"variable_manager",
"=",
"VariableManager",
"(",
"loader",
"=",
"loader",
")",
"except",
"TypeError",
":",
"# If Ansible prior to ansible/ansible@8f97aef1a365",
... | Given a role definition from a service's list of roles, returns the file path to the role | [
"Given",
"a",
"role",
"definition",
"from",
"a",
"service",
"s",
"list",
"of",
"roles",
"returns",
"the",
"file",
"path",
"to",
"the",
"role"
] | d031c1a6133d5482a5d054fcbdbecafb923f8b4b | https://github.com/ansible/ansible-container/blob/d031c1a6133d5482a5d054fcbdbecafb923f8b4b/container/utils/__init__.py#L225-L238 |
244,614 | ansible/ansible-container | container/utils/__init__.py | get_role_fingerprint | def get_role_fingerprint(role, service_name, config_vars):
"""
Given a role definition from a service's list of roles, returns a hexdigest based on the role definition,
the role contents, and the hexdigest of each dependency
"""
def hash_file(hash_obj, file_path):
blocksize = 64 * 1024
with open(file_path, 'rb') as ifs:
while True:
data = ifs.read(blocksize)
if not data:
break
hash_obj.update(data)
hash_obj.update('::')
def hash_dir(hash_obj, dir_path):
for root, dirs, files in os.walk(dir_path, topdown=True):
for file_path in files:
abs_file_path = os.path.join(root, file_path)
hash_obj.update(abs_file_path.encode('utf-8'))
hash_obj.update('::')
hash_file(hash_obj, abs_file_path)
def hash_role(hash_obj, role_path):
# Role content is easy to hash - the hash of the role content with the
# hash of any role dependencies it has
hash_dir(hash_obj, role_path)
for dependency in get_dependencies_for_role(role_path):
if dependency:
dependency_path = resolve_role_to_path(dependency)
hash_role(hash_obj, dependency_path)
# However tasks within that role might reference files outside of the
# role, like source code
loader = DataLoader()
var_man = VariableManager(loader=loader)
play = Play.load(generate_playbook_for_role(service_name, config_vars, role)[0],
variable_manager=var_man, loader=loader)
play_context = PlayContext(play=play)
inv_man = InventoryManager(loader, sources=['%s,' % service_name])
host = Host(service_name)
iterator = PlayIterator(inv_man, play, play_context, var_man, config_vars)
while True:
_, task = iterator.get_next_task_for_host(host)
if task is None: break
if task.action in FILE_COPY_MODULES:
src = task.args.get('src')
if src is not None:
if not os.path.exists(src) or not src.startswith(('/', '..')): continue
src = os.path.realpath(src)
if os.path.isfile(src):
hash_file(hash_obj, src)
else:
hash_dir(hash_obj, src)
def get_dependencies_for_role(role_path):
meta_main_path = os.path.join(role_path, 'meta', 'main.yml')
if os.path.exists(meta_main_path):
meta_main = yaml.safe_load(open(meta_main_path))
if meta_main:
for dependency in meta_main.get('dependencies', []):
yield dependency.get('role', None)
hash_obj = hashlib.sha256()
# Account for variables passed to the role by including the invocation string
hash_obj.update((json.dumps(role) if not isinstance(role, string_types) else role) + '::')
# Add each of the role's files and directories
hash_role(hash_obj, resolve_role_to_path(role))
return hash_obj.hexdigest() | python | def get_role_fingerprint(role, service_name, config_vars):
def hash_file(hash_obj, file_path):
blocksize = 64 * 1024
with open(file_path, 'rb') as ifs:
while True:
data = ifs.read(blocksize)
if not data:
break
hash_obj.update(data)
hash_obj.update('::')
def hash_dir(hash_obj, dir_path):
for root, dirs, files in os.walk(dir_path, topdown=True):
for file_path in files:
abs_file_path = os.path.join(root, file_path)
hash_obj.update(abs_file_path.encode('utf-8'))
hash_obj.update('::')
hash_file(hash_obj, abs_file_path)
def hash_role(hash_obj, role_path):
# Role content is easy to hash - the hash of the role content with the
# hash of any role dependencies it has
hash_dir(hash_obj, role_path)
for dependency in get_dependencies_for_role(role_path):
if dependency:
dependency_path = resolve_role_to_path(dependency)
hash_role(hash_obj, dependency_path)
# However tasks within that role might reference files outside of the
# role, like source code
loader = DataLoader()
var_man = VariableManager(loader=loader)
play = Play.load(generate_playbook_for_role(service_name, config_vars, role)[0],
variable_manager=var_man, loader=loader)
play_context = PlayContext(play=play)
inv_man = InventoryManager(loader, sources=['%s,' % service_name])
host = Host(service_name)
iterator = PlayIterator(inv_man, play, play_context, var_man, config_vars)
while True:
_, task = iterator.get_next_task_for_host(host)
if task is None: break
if task.action in FILE_COPY_MODULES:
src = task.args.get('src')
if src is not None:
if not os.path.exists(src) or not src.startswith(('/', '..')): continue
src = os.path.realpath(src)
if os.path.isfile(src):
hash_file(hash_obj, src)
else:
hash_dir(hash_obj, src)
def get_dependencies_for_role(role_path):
meta_main_path = os.path.join(role_path, 'meta', 'main.yml')
if os.path.exists(meta_main_path):
meta_main = yaml.safe_load(open(meta_main_path))
if meta_main:
for dependency in meta_main.get('dependencies', []):
yield dependency.get('role', None)
hash_obj = hashlib.sha256()
# Account for variables passed to the role by including the invocation string
hash_obj.update((json.dumps(role) if not isinstance(role, string_types) else role) + '::')
# Add each of the role's files and directories
hash_role(hash_obj, resolve_role_to_path(role))
return hash_obj.hexdigest() | [
"def",
"get_role_fingerprint",
"(",
"role",
",",
"service_name",
",",
"config_vars",
")",
":",
"def",
"hash_file",
"(",
"hash_obj",
",",
"file_path",
")",
":",
"blocksize",
"=",
"64",
"*",
"1024",
"with",
"open",
"(",
"file_path",
",",
"'rb'",
")",
"as",
... | Given a role definition from a service's list of roles, returns a hexdigest based on the role definition,
the role contents, and the hexdigest of each dependency | [
"Given",
"a",
"role",
"definition",
"from",
"a",
"service",
"s",
"list",
"of",
"roles",
"returns",
"a",
"hexdigest",
"based",
"on",
"the",
"role",
"definition",
"the",
"role",
"contents",
"and",
"the",
"hexdigest",
"of",
"each",
"dependency"
] | d031c1a6133d5482a5d054fcbdbecafb923f8b4b | https://github.com/ansible/ansible-container/blob/d031c1a6133d5482a5d054fcbdbecafb923f8b4b/container/utils/__init__.py#L256-L323 |
244,615 | litl/backoff | backoff/_decorator.py | on_predicate | def on_predicate(wait_gen,
predicate=operator.not_,
max_tries=None,
max_time=None,
jitter=full_jitter,
on_success=None,
on_backoff=None,
on_giveup=None,
logger='backoff',
**wait_gen_kwargs):
"""Returns decorator for backoff and retry triggered by predicate.
Args:
wait_gen: A generator yielding successive wait times in
seconds.
predicate: A function which when called on the return value of
the target function will trigger backoff when considered
truthily. If not specified, the default behavior is to
backoff on falsey return values.
max_tries: The maximum number of attempts to make before giving
up. In the case of failure, the result of the last attempt
will be returned. The default value of None means there
is no limit to the number of tries. If a callable is passed,
it will be evaluated at runtime and its return value used.
max_time: The maximum total amount of time to try for before
giving up. If this time expires, the result of the last
attempt will be returned. If a callable is passed, it will
be evaluated at runtime and its return value used.
jitter: A function of the value yielded by wait_gen returning
the actual time to wait. This distributes wait times
stochastically in order to avoid timing collisions across
concurrent clients. Wait times are jittered by default
using the full_jitter function. Jittering may be disabled
altogether by passing jitter=None.
on_success: Callable (or iterable of callables) with a unary
signature to be called in the event of success. The
parameter is a dict containing details about the invocation.
on_backoff: Callable (or iterable of callables) with a unary
signature to be called in the event of a backoff. The
parameter is a dict containing details about the invocation.
on_giveup: Callable (or iterable of callables) with a unary
signature to be called in the event that max_tries
is exceeded. The parameter is a dict containing details
about the invocation.
logger: Name of logger or Logger object to log to. Defaults to
'backoff'.
**wait_gen_kwargs: Any additional keyword args specified will be
passed to wait_gen when it is initialized. Any callable
args will first be evaluated and their return values passed.
This is useful for runtime configuration.
"""
def decorate(target):
# change names because python 2.x doesn't have nonlocal
logger_ = logger
if isinstance(logger_, basestring):
logger_ = logging.getLogger(logger_)
on_success_ = _config_handlers(on_success)
on_backoff_ = _config_handlers(on_backoff, _log_backoff, logger_)
on_giveup_ = _config_handlers(on_giveup, _log_giveup, logger_)
retry = None
if sys.version_info >= (3, 5): # pragma: python=3.5
import asyncio
if asyncio.iscoroutinefunction(target):
import backoff._async
retry = backoff._async.retry_predicate
elif _is_event_loop() and _is_current_task():
# Verify that sync version is not being run from coroutine
# (that would lead to event loop hiccups).
raise TypeError(
"backoff.on_predicate applied to a regular function "
"inside coroutine, this will lead to event loop "
"hiccups. Use backoff.on_predicate on coroutines in "
"asynchronous code.")
if retry is None:
retry = _sync.retry_predicate
return retry(target, wait_gen, predicate,
max_tries, max_time, jitter,
on_success_, on_backoff_, on_giveup_,
wait_gen_kwargs)
# Return a function which decorates a target with a retry loop.
return decorate | python | def on_predicate(wait_gen,
predicate=operator.not_,
max_tries=None,
max_time=None,
jitter=full_jitter,
on_success=None,
on_backoff=None,
on_giveup=None,
logger='backoff',
**wait_gen_kwargs):
def decorate(target):
# change names because python 2.x doesn't have nonlocal
logger_ = logger
if isinstance(logger_, basestring):
logger_ = logging.getLogger(logger_)
on_success_ = _config_handlers(on_success)
on_backoff_ = _config_handlers(on_backoff, _log_backoff, logger_)
on_giveup_ = _config_handlers(on_giveup, _log_giveup, logger_)
retry = None
if sys.version_info >= (3, 5): # pragma: python=3.5
import asyncio
if asyncio.iscoroutinefunction(target):
import backoff._async
retry = backoff._async.retry_predicate
elif _is_event_loop() and _is_current_task():
# Verify that sync version is not being run from coroutine
# (that would lead to event loop hiccups).
raise TypeError(
"backoff.on_predicate applied to a regular function "
"inside coroutine, this will lead to event loop "
"hiccups. Use backoff.on_predicate on coroutines in "
"asynchronous code.")
if retry is None:
retry = _sync.retry_predicate
return retry(target, wait_gen, predicate,
max_tries, max_time, jitter,
on_success_, on_backoff_, on_giveup_,
wait_gen_kwargs)
# Return a function which decorates a target with a retry loop.
return decorate | [
"def",
"on_predicate",
"(",
"wait_gen",
",",
"predicate",
"=",
"operator",
".",
"not_",
",",
"max_tries",
"=",
"None",
",",
"max_time",
"=",
"None",
",",
"jitter",
"=",
"full_jitter",
",",
"on_success",
"=",
"None",
",",
"on_backoff",
"=",
"None",
",",
"... | Returns decorator for backoff and retry triggered by predicate.
Args:
wait_gen: A generator yielding successive wait times in
seconds.
predicate: A function which when called on the return value of
the target function will trigger backoff when considered
truthily. If not specified, the default behavior is to
backoff on falsey return values.
max_tries: The maximum number of attempts to make before giving
up. In the case of failure, the result of the last attempt
will be returned. The default value of None means there
is no limit to the number of tries. If a callable is passed,
it will be evaluated at runtime and its return value used.
max_time: The maximum total amount of time to try for before
giving up. If this time expires, the result of the last
attempt will be returned. If a callable is passed, it will
be evaluated at runtime and its return value used.
jitter: A function of the value yielded by wait_gen returning
the actual time to wait. This distributes wait times
stochastically in order to avoid timing collisions across
concurrent clients. Wait times are jittered by default
using the full_jitter function. Jittering may be disabled
altogether by passing jitter=None.
on_success: Callable (or iterable of callables) with a unary
signature to be called in the event of success. The
parameter is a dict containing details about the invocation.
on_backoff: Callable (or iterable of callables) with a unary
signature to be called in the event of a backoff. The
parameter is a dict containing details about the invocation.
on_giveup: Callable (or iterable of callables) with a unary
signature to be called in the event that max_tries
is exceeded. The parameter is a dict containing details
about the invocation.
logger: Name of logger or Logger object to log to. Defaults to
'backoff'.
**wait_gen_kwargs: Any additional keyword args specified will be
passed to wait_gen when it is initialized. Any callable
args will first be evaluated and their return values passed.
This is useful for runtime configuration. | [
"Returns",
"decorator",
"for",
"backoff",
"and",
"retry",
"triggered",
"by",
"predicate",
"."
] | 229d30adce4128f093550a1761c49594c78df4b4 | https://github.com/litl/backoff/blob/229d30adce4128f093550a1761c49594c78df4b4/backoff/_decorator.py#L20-L106 |
244,616 | litl/backoff | backoff/_wait_gen.py | expo | def expo(base=2, factor=1, max_value=None):
"""Generator for exponential decay.
Args:
base: The mathematical base of the exponentiation operation
factor: Factor to multiply the exponentation by.
max_value: The maximum value to yield. Once the value in the
true exponential sequence exceeds this, the value
of max_value will forever after be yielded.
"""
n = 0
while True:
a = factor * base ** n
if max_value is None or a < max_value:
yield a
n += 1
else:
yield max_value | python | def expo(base=2, factor=1, max_value=None):
n = 0
while True:
a = factor * base ** n
if max_value is None or a < max_value:
yield a
n += 1
else:
yield max_value | [
"def",
"expo",
"(",
"base",
"=",
"2",
",",
"factor",
"=",
"1",
",",
"max_value",
"=",
"None",
")",
":",
"n",
"=",
"0",
"while",
"True",
":",
"a",
"=",
"factor",
"*",
"base",
"**",
"n",
"if",
"max_value",
"is",
"None",
"or",
"a",
"<",
"max_value... | Generator for exponential decay.
Args:
base: The mathematical base of the exponentiation operation
factor: Factor to multiply the exponentation by.
max_value: The maximum value to yield. Once the value in the
true exponential sequence exceeds this, the value
of max_value will forever after be yielded. | [
"Generator",
"for",
"exponential",
"decay",
"."
] | 229d30adce4128f093550a1761c49594c78df4b4 | https://github.com/litl/backoff/blob/229d30adce4128f093550a1761c49594c78df4b4/backoff/_wait_gen.py#L6-L23 |
244,617 | litl/backoff | backoff/_wait_gen.py | fibo | def fibo(max_value=None):
"""Generator for fibonaccial decay.
Args:
max_value: The maximum value to yield. Once the value in the
true fibonacci sequence exceeds this, the value
of max_value will forever after be yielded.
"""
a = 1
b = 1
while True:
if max_value is None or a < max_value:
yield a
a, b = b, a + b
else:
yield max_value | python | def fibo(max_value=None):
a = 1
b = 1
while True:
if max_value is None or a < max_value:
yield a
a, b = b, a + b
else:
yield max_value | [
"def",
"fibo",
"(",
"max_value",
"=",
"None",
")",
":",
"a",
"=",
"1",
"b",
"=",
"1",
"while",
"True",
":",
"if",
"max_value",
"is",
"None",
"or",
"a",
"<",
"max_value",
":",
"yield",
"a",
"a",
",",
"b",
"=",
"b",
",",
"a",
"+",
"b",
"else",
... | Generator for fibonaccial decay.
Args:
max_value: The maximum value to yield. Once the value in the
true fibonacci sequence exceeds this, the value
of max_value will forever after be yielded. | [
"Generator",
"for",
"fibonaccial",
"decay",
"."
] | 229d30adce4128f093550a1761c49594c78df4b4 | https://github.com/litl/backoff/blob/229d30adce4128f093550a1761c49594c78df4b4/backoff/_wait_gen.py#L26-L41 |
244,618 | litl/backoff | backoff/_wait_gen.py | constant | def constant(interval=1):
"""Generator for constant intervals.
Args:
interval: A constant value to yield or an iterable of such values.
"""
try:
itr = iter(interval)
except TypeError:
itr = itertools.repeat(interval)
for val in itr:
yield val | python | def constant(interval=1):
try:
itr = iter(interval)
except TypeError:
itr = itertools.repeat(interval)
for val in itr:
yield val | [
"def",
"constant",
"(",
"interval",
"=",
"1",
")",
":",
"try",
":",
"itr",
"=",
"iter",
"(",
"interval",
")",
"except",
"TypeError",
":",
"itr",
"=",
"itertools",
".",
"repeat",
"(",
"interval",
")",
"for",
"val",
"in",
"itr",
":",
"yield",
"val"
] | Generator for constant intervals.
Args:
interval: A constant value to yield or an iterable of such values. | [
"Generator",
"for",
"constant",
"intervals",
"."
] | 229d30adce4128f093550a1761c49594c78df4b4 | https://github.com/litl/backoff/blob/229d30adce4128f093550a1761c49594c78df4b4/backoff/_wait_gen.py#L44-L56 |
244,619 | crytic/slither | slither/detectors/erc20/incorrect_interface.py | IncorrectERC20InterfaceDetection.detect_incorrect_erc20_interface | def detect_incorrect_erc20_interface(contract):
""" Detect incorrect ERC20 interface
Returns:
list(str) : list of incorrect function signatures
"""
functions = [f for f in contract.functions if f.contract == contract and \
IncorrectERC20InterfaceDetection.incorrect_erc20_interface(f.signature)]
return functions | python | def detect_incorrect_erc20_interface(contract):
functions = [f for f in contract.functions if f.contract == contract and \
IncorrectERC20InterfaceDetection.incorrect_erc20_interface(f.signature)]
return functions | [
"def",
"detect_incorrect_erc20_interface",
"(",
"contract",
")",
":",
"functions",
"=",
"[",
"f",
"for",
"f",
"in",
"contract",
".",
"functions",
"if",
"f",
".",
"contract",
"==",
"contract",
"and",
"IncorrectERC20InterfaceDetection",
".",
"incorrect_erc20_interface... | Detect incorrect ERC20 interface
Returns:
list(str) : list of incorrect function signatures | [
"Detect",
"incorrect",
"ERC20",
"interface"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/erc20/incorrect_interface.py#L49-L57 |
244,620 | crytic/slither | slither/detectors/erc20/incorrect_interface.py | IncorrectERC20InterfaceDetection._detect | def _detect(self):
""" Detect incorrect erc20 interface
Returns:
dict: [contrat name] = set(str) events
"""
results = []
for c in self.contracts:
functions = IncorrectERC20InterfaceDetection.detect_incorrect_erc20_interface(c)
if functions:
info = "{} ({}) has incorrect ERC20 function interface(s):\n"
info = info.format(c.name,
c.source_mapping_str)
for function in functions:
info += "\t-{} ({})\n".format(function.name, function.source_mapping_str)
json = self.generate_json_result(info)
self.add_functions_to_json(functions, json)
results.append(json)
return results | python | def _detect(self):
results = []
for c in self.contracts:
functions = IncorrectERC20InterfaceDetection.detect_incorrect_erc20_interface(c)
if functions:
info = "{} ({}) has incorrect ERC20 function interface(s):\n"
info = info.format(c.name,
c.source_mapping_str)
for function in functions:
info += "\t-{} ({})\n".format(function.name, function.source_mapping_str)
json = self.generate_json_result(info)
self.add_functions_to_json(functions, json)
results.append(json)
return results | [
"def",
"_detect",
"(",
"self",
")",
":",
"results",
"=",
"[",
"]",
"for",
"c",
"in",
"self",
".",
"contracts",
":",
"functions",
"=",
"IncorrectERC20InterfaceDetection",
".",
"detect_incorrect_erc20_interface",
"(",
"c",
")",
"if",
"functions",
":",
"info",
... | Detect incorrect erc20 interface
Returns:
dict: [contrat name] = set(str) events | [
"Detect",
"incorrect",
"erc20",
"interface"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/erc20/incorrect_interface.py#L59-L78 |
244,621 | crytic/slither | slither/detectors/shadowing/local.py | LocalShadowing.detect_shadowing_definitions | def detect_shadowing_definitions(self, contract):
""" Detects if functions, access modifiers, events, state variables, and local variables are named after
reserved keywords. Any such definitions are returned in a list.
Returns:
list of tuple: (type, contract name, definition)"""
result = []
# Loop through all functions + modifiers in this contract.
for function in contract.functions + contract.modifiers:
# We should only look for functions declared directly in this contract (not in a base contract).
if function.contract != contract:
continue
# This function was declared in this contract, we check what its local variables might shadow.
for variable in function.variables:
overshadowed = []
for scope_contract in [contract] + contract.inheritance:
# Check functions
for scope_function in scope_contract.functions:
if variable.name == scope_function.name and scope_function.contract == scope_contract:
overshadowed.append((self.OVERSHADOWED_FUNCTION, scope_contract.name, scope_function))
# Check modifiers
for scope_modifier in scope_contract.modifiers:
if variable.name == scope_modifier.name and scope_modifier.contract == scope_contract:
overshadowed.append((self.OVERSHADOWED_MODIFIER, scope_contract.name, scope_modifier))
# Check events
for scope_event in scope_contract.events:
if variable.name == scope_event.name and scope_event.contract == scope_contract:
overshadowed.append((self.OVERSHADOWED_EVENT, scope_contract.name, scope_event))
# Check state variables
for scope_state_variable in scope_contract.variables:
if variable.name == scope_state_variable.name and scope_state_variable.contract == scope_contract:
overshadowed.append((self.OVERSHADOWED_STATE_VARIABLE, scope_contract.name, scope_state_variable))
# If we have found any overshadowed objects, we'll want to add it to our result list.
if overshadowed:
result.append((contract.name, function.name, variable, overshadowed))
return result | python | def detect_shadowing_definitions(self, contract):
result = []
# Loop through all functions + modifiers in this contract.
for function in contract.functions + contract.modifiers:
# We should only look for functions declared directly in this contract (not in a base contract).
if function.contract != contract:
continue
# This function was declared in this contract, we check what its local variables might shadow.
for variable in function.variables:
overshadowed = []
for scope_contract in [contract] + contract.inheritance:
# Check functions
for scope_function in scope_contract.functions:
if variable.name == scope_function.name and scope_function.contract == scope_contract:
overshadowed.append((self.OVERSHADOWED_FUNCTION, scope_contract.name, scope_function))
# Check modifiers
for scope_modifier in scope_contract.modifiers:
if variable.name == scope_modifier.name and scope_modifier.contract == scope_contract:
overshadowed.append((self.OVERSHADOWED_MODIFIER, scope_contract.name, scope_modifier))
# Check events
for scope_event in scope_contract.events:
if variable.name == scope_event.name and scope_event.contract == scope_contract:
overshadowed.append((self.OVERSHADOWED_EVENT, scope_contract.name, scope_event))
# Check state variables
for scope_state_variable in scope_contract.variables:
if variable.name == scope_state_variable.name and scope_state_variable.contract == scope_contract:
overshadowed.append((self.OVERSHADOWED_STATE_VARIABLE, scope_contract.name, scope_state_variable))
# If we have found any overshadowed objects, we'll want to add it to our result list.
if overshadowed:
result.append((contract.name, function.name, variable, overshadowed))
return result | [
"def",
"detect_shadowing_definitions",
"(",
"self",
",",
"contract",
")",
":",
"result",
"=",
"[",
"]",
"# Loop through all functions + modifiers in this contract.",
"for",
"function",
"in",
"contract",
".",
"functions",
"+",
"contract",
".",
"modifiers",
":",
"# We s... | Detects if functions, access modifiers, events, state variables, and local variables are named after
reserved keywords. Any such definitions are returned in a list.
Returns:
list of tuple: (type, contract name, definition) | [
"Detects",
"if",
"functions",
"access",
"modifiers",
"events",
"state",
"variables",
"and",
"local",
"variables",
"are",
"named",
"after",
"reserved",
"keywords",
".",
"Any",
"such",
"definitions",
"are",
"returned",
"in",
"a",
"list",
"."
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/shadowing/local.py#L51-L90 |
244,622 | crytic/slither | slither/detectors/shadowing/local.py | LocalShadowing._detect | def _detect(self):
""" Detect shadowing local variables
Recursively visit the calls
Returns:
list: {'vuln', 'filename,'contract','func', 'shadow'}
"""
results = []
for contract in self.contracts:
shadows = self.detect_shadowing_definitions(contract)
if shadows:
for shadow in shadows:
local_parent_name = shadow[1]
local_variable = shadow[2]
overshadowed = shadow[3]
info = '{}.{}.{} (local variable @ {}) shadows:\n'.format(contract.name,
local_parent_name,
local_variable.name,
local_variable.source_mapping_str)
for overshadowed_entry in overshadowed:
info += "\t- {}.{} ({} @ {})\n".format(overshadowed_entry[1],
overshadowed_entry[2],
overshadowed_entry[0],
overshadowed_entry[2].source_mapping_str)
# Generate relevant JSON data for this shadowing definition.
json = self.generate_json_result(info)
self.add_variable_to_json(local_variable, json)
for overshadowed_entry in overshadowed:
if overshadowed_entry[0] in [self.OVERSHADOWED_FUNCTION, self.OVERSHADOWED_MODIFIER,
self.OVERSHADOWED_EVENT]:
self.add_function_to_json(overshadowed_entry[2], json)
elif overshadowed_entry[0] == self.OVERSHADOWED_STATE_VARIABLE:
self.add_variable_to_json(overshadowed_entry[2], json)
results.append(json)
return results | python | def _detect(self):
results = []
for contract in self.contracts:
shadows = self.detect_shadowing_definitions(contract)
if shadows:
for shadow in shadows:
local_parent_name = shadow[1]
local_variable = shadow[2]
overshadowed = shadow[3]
info = '{}.{}.{} (local variable @ {}) shadows:\n'.format(contract.name,
local_parent_name,
local_variable.name,
local_variable.source_mapping_str)
for overshadowed_entry in overshadowed:
info += "\t- {}.{} ({} @ {})\n".format(overshadowed_entry[1],
overshadowed_entry[2],
overshadowed_entry[0],
overshadowed_entry[2].source_mapping_str)
# Generate relevant JSON data for this shadowing definition.
json = self.generate_json_result(info)
self.add_variable_to_json(local_variable, json)
for overshadowed_entry in overshadowed:
if overshadowed_entry[0] in [self.OVERSHADOWED_FUNCTION, self.OVERSHADOWED_MODIFIER,
self.OVERSHADOWED_EVENT]:
self.add_function_to_json(overshadowed_entry[2], json)
elif overshadowed_entry[0] == self.OVERSHADOWED_STATE_VARIABLE:
self.add_variable_to_json(overshadowed_entry[2], json)
results.append(json)
return results | [
"def",
"_detect",
"(",
"self",
")",
":",
"results",
"=",
"[",
"]",
"for",
"contract",
"in",
"self",
".",
"contracts",
":",
"shadows",
"=",
"self",
".",
"detect_shadowing_definitions",
"(",
"contract",
")",
"if",
"shadows",
":",
"for",
"shadow",
"in",
"sh... | Detect shadowing local variables
Recursively visit the calls
Returns:
list: {'vuln', 'filename,'contract','func', 'shadow'} | [
"Detect",
"shadowing",
"local",
"variables"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/shadowing/local.py#L92-L131 |
244,623 | crytic/slither | slither/detectors/variables/possible_const_state_variables.py | ConstCandidateStateVars._detect | def _detect(self):
""" Detect state variables that could be const
"""
results = []
all_info = ''
all_variables = [c.state_variables for c in self.slither.contracts]
all_variables = set([item for sublist in all_variables for item in sublist])
all_non_constant_elementary_variables = set([v for v in all_variables
if self._valid_candidate(v)])
all_functions = [c.all_functions_called for c in self.slither.contracts]
all_functions = list(set([item for sublist in all_functions for item in sublist]))
all_variables_written = [f.state_variables_written for f in all_functions]
all_variables_written = set([item for sublist in all_variables_written for item in sublist])
constable_variables = [v for v in all_non_constant_elementary_variables
if (not v in all_variables_written) and self._constant_initial_expression(v)]
# Order for deterministic results
constable_variables = sorted(constable_variables, key=lambda x: x.canonical_name)
for v in constable_variables:
info = "{}.{} should be constant ({})\n".format(v.contract.name,
v.name,
v.source_mapping_str)
all_info += info
if all_info != '':
json = self.generate_json_result(all_info)
self.add_variables_to_json(constable_variables, json)
results.append(json)
return results | python | def _detect(self):
results = []
all_info = ''
all_variables = [c.state_variables for c in self.slither.contracts]
all_variables = set([item for sublist in all_variables for item in sublist])
all_non_constant_elementary_variables = set([v for v in all_variables
if self._valid_candidate(v)])
all_functions = [c.all_functions_called for c in self.slither.contracts]
all_functions = list(set([item for sublist in all_functions for item in sublist]))
all_variables_written = [f.state_variables_written for f in all_functions]
all_variables_written = set([item for sublist in all_variables_written for item in sublist])
constable_variables = [v for v in all_non_constant_elementary_variables
if (not v in all_variables_written) and self._constant_initial_expression(v)]
# Order for deterministic results
constable_variables = sorted(constable_variables, key=lambda x: x.canonical_name)
for v in constable_variables:
info = "{}.{} should be constant ({})\n".format(v.contract.name,
v.name,
v.source_mapping_str)
all_info += info
if all_info != '':
json = self.generate_json_result(all_info)
self.add_variables_to_json(constable_variables, json)
results.append(json)
return results | [
"def",
"_detect",
"(",
"self",
")",
":",
"results",
"=",
"[",
"]",
"all_info",
"=",
"''",
"all_variables",
"=",
"[",
"c",
".",
"state_variables",
"for",
"c",
"in",
"self",
".",
"slither",
".",
"contracts",
"]",
"all_variables",
"=",
"set",
"(",
"[",
... | Detect state variables that could be const | [
"Detect",
"state",
"variables",
"that",
"could",
"be",
"const"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/variables/possible_const_state_variables.py#L66-L96 |
244,624 | crytic/slither | slither/detectors/functions/suicidal.py | Suicidal.detect_suicidal_func | def detect_suicidal_func(func):
""" Detect if the function is suicidal
Detect the public functions calling suicide/selfdestruct without protection
Returns:
(bool): True if the function is suicidal
"""
if func.is_constructor:
return False
if func.visibility != 'public':
return False
calls = [c.name for c in func.internal_calls]
if not ('suicide(address)' in calls or 'selfdestruct(address)' in calls):
return False
if func.is_protected():
return False
return True | python | def detect_suicidal_func(func):
if func.is_constructor:
return False
if func.visibility != 'public':
return False
calls = [c.name for c in func.internal_calls]
if not ('suicide(address)' in calls or 'selfdestruct(address)' in calls):
return False
if func.is_protected():
return False
return True | [
"def",
"detect_suicidal_func",
"(",
"func",
")",
":",
"if",
"func",
".",
"is_constructor",
":",
"return",
"False",
"if",
"func",
".",
"visibility",
"!=",
"'public'",
":",
"return",
"False",
"calls",
"=",
"[",
"c",
".",
"name",
"for",
"c",
"in",
"func",
... | Detect if the function is suicidal
Detect the public functions calling suicide/selfdestruct without protection
Returns:
(bool): True if the function is suicidal | [
"Detect",
"if",
"the",
"function",
"is",
"suicidal"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/functions/suicidal.py#L37-L58 |
244,625 | crytic/slither | slither/detectors/functions/suicidal.py | Suicidal._detect | def _detect(self):
""" Detect the suicidal functions
"""
results = []
for c in self.contracts:
functions = self.detect_suicidal(c)
for func in functions:
txt = "{}.{} ({}) allows anyone to destruct the contract\n"
info = txt.format(func.contract.name,
func.name,
func.source_mapping_str)
json = self.generate_json_result(info)
self.add_function_to_json(func, json)
results.append(json)
return results | python | def _detect(self):
results = []
for c in self.contracts:
functions = self.detect_suicidal(c)
for func in functions:
txt = "{}.{} ({}) allows anyone to destruct the contract\n"
info = txt.format(func.contract.name,
func.name,
func.source_mapping_str)
json = self.generate_json_result(info)
self.add_function_to_json(func, json)
results.append(json)
return results | [
"def",
"_detect",
"(",
"self",
")",
":",
"results",
"=",
"[",
"]",
"for",
"c",
"in",
"self",
".",
"contracts",
":",
"functions",
"=",
"self",
".",
"detect_suicidal",
"(",
"c",
")",
"for",
"func",
"in",
"functions",
":",
"txt",
"=",
"\"{}.{} ({}) allows... | Detect the suicidal functions | [
"Detect",
"the",
"suicidal",
"functions"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/functions/suicidal.py#L67-L84 |
244,626 | crytic/slither | slither/detectors/operations/unused_return_values.py | UnusedReturnValues._detect | def _detect(self):
""" Detect high level calls which return a value that are never used
"""
results = []
for c in self.slither.contracts:
for f in c.functions + c.modifiers:
if f.contract != c:
continue
unused_return = self.detect_unused_return_values(f)
if unused_return:
info = "{}.{} ({}) does not use the value returned by external calls:\n"
info = info.format(f.contract.name,
f.name,
f.source_mapping_str)
for node in unused_return:
info += "\t-{} ({})\n".format(node.expression, node.source_mapping_str)
json = self.generate_json_result(info)
self.add_function_to_json(f, json)
self.add_nodes_to_json(unused_return, json)
results.append(json)
return results | python | def _detect(self):
results = []
for c in self.slither.contracts:
for f in c.functions + c.modifiers:
if f.contract != c:
continue
unused_return = self.detect_unused_return_values(f)
if unused_return:
info = "{}.{} ({}) does not use the value returned by external calls:\n"
info = info.format(f.contract.name,
f.name,
f.source_mapping_str)
for node in unused_return:
info += "\t-{} ({})\n".format(node.expression, node.source_mapping_str)
json = self.generate_json_result(info)
self.add_function_to_json(f, json)
self.add_nodes_to_json(unused_return, json)
results.append(json)
return results | [
"def",
"_detect",
"(",
"self",
")",
":",
"results",
"=",
"[",
"]",
"for",
"c",
"in",
"self",
".",
"slither",
".",
"contracts",
":",
"for",
"f",
"in",
"c",
".",
"functions",
"+",
"c",
".",
"modifiers",
":",
"if",
"f",
".",
"contract",
"!=",
"c",
... | Detect high level calls which return a value that are never used | [
"Detect",
"high",
"level",
"calls",
"which",
"return",
"a",
"value",
"that",
"are",
"never",
"used"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/operations/unused_return_values.py#L61-L83 |
244,627 | crytic/slither | slither/printers/inheritance/inheritance_graph.py | PrinterInheritanceGraph._summary | def _summary(self, contract):
"""
Build summary using HTML
"""
ret = ''
# Add arrows (number them if there is more than one path so we know order of declaration for inheritance).
if len(contract.immediate_inheritance) == 1:
ret += '%s -> %s;\n' % (contract.name, contract.immediate_inheritance[0])
else:
for i in range(0, len(contract.immediate_inheritance)):
ret += '%s -> %s [ label="%s" ];\n' % (contract.name, contract.immediate_inheritance[i], i + 1)
# Functions
visibilities = ['public', 'external']
public_functions = [self._get_pattern_func(f, contract) for f in contract.functions if
not f.is_constructor and f.contract == contract and f.visibility in visibilities]
public_functions = ''.join(public_functions)
private_functions = [self._get_pattern_func(f, contract) for f in contract.functions if
not f.is_constructor and f.contract == contract and f.visibility not in visibilities]
private_functions = ''.join(private_functions)
# Modifiers
modifiers = [self._get_pattern_func(m, contract) for m in contract.modifiers if m.contract == contract]
modifiers = ''.join(modifiers)
# Public variables
public_variables = [self._get_pattern_var(v, contract) for v in contract.variables if
v.contract == contract and v.visibility in visibilities]
public_variables = ''.join(public_variables)
private_variables = [self._get_pattern_var(v, contract) for v in contract.variables if
v.contract == contract and v.visibility not in visibilities]
private_variables = ''.join(private_variables)
# Obtain any indirect shadowing information for this node.
indirect_shadowing_information = self._get_indirect_shadowing_information(contract)
# Build the node label
ret += '%s[shape="box"' % contract.name
ret += 'label=< <TABLE border="0">'
ret += '<TR><TD align="center"><B>%s</B></TD></TR>' % contract.name
if public_functions:
ret += '<TR><TD align="left"><I>Public Functions:</I></TD></TR>'
ret += '%s' % public_functions
if private_functions:
ret += '<TR><TD align="left"><I>Private Functions:</I></TD></TR>'
ret += '%s' % private_functions
if modifiers:
ret += '<TR><TD align="left"><I>Modifiers:</I></TD></TR>'
ret += '%s' % modifiers
if public_variables:
ret += '<TR><TD align="left"><I>Public Variables:</I></TD></TR>'
ret += '%s' % public_variables
if private_variables:
ret += '<TR><TD align="left"><I>Private Variables:</I></TD></TR>'
ret += '%s' % private_variables
if indirect_shadowing_information:
ret += '<TR><TD><BR/></TD></TR><TR><TD align="left" border="1"><font color="#777777" point-size="10">%s</font></TD></TR>' % indirect_shadowing_information.replace('\n', '<BR/>')
ret += '</TABLE> >];\n'
return ret | python | def _summary(self, contract):
ret = ''
# Add arrows (number them if there is more than one path so we know order of declaration for inheritance).
if len(contract.immediate_inheritance) == 1:
ret += '%s -> %s;\n' % (contract.name, contract.immediate_inheritance[0])
else:
for i in range(0, len(contract.immediate_inheritance)):
ret += '%s -> %s [ label="%s" ];\n' % (contract.name, contract.immediate_inheritance[i], i + 1)
# Functions
visibilities = ['public', 'external']
public_functions = [self._get_pattern_func(f, contract) for f in contract.functions if
not f.is_constructor and f.contract == contract and f.visibility in visibilities]
public_functions = ''.join(public_functions)
private_functions = [self._get_pattern_func(f, contract) for f in contract.functions if
not f.is_constructor and f.contract == contract and f.visibility not in visibilities]
private_functions = ''.join(private_functions)
# Modifiers
modifiers = [self._get_pattern_func(m, contract) for m in contract.modifiers if m.contract == contract]
modifiers = ''.join(modifiers)
# Public variables
public_variables = [self._get_pattern_var(v, contract) for v in contract.variables if
v.contract == contract and v.visibility in visibilities]
public_variables = ''.join(public_variables)
private_variables = [self._get_pattern_var(v, contract) for v in contract.variables if
v.contract == contract and v.visibility not in visibilities]
private_variables = ''.join(private_variables)
# Obtain any indirect shadowing information for this node.
indirect_shadowing_information = self._get_indirect_shadowing_information(contract)
# Build the node label
ret += '%s[shape="box"' % contract.name
ret += 'label=< <TABLE border="0">'
ret += '<TR><TD align="center"><B>%s</B></TD></TR>' % contract.name
if public_functions:
ret += '<TR><TD align="left"><I>Public Functions:</I></TD></TR>'
ret += '%s' % public_functions
if private_functions:
ret += '<TR><TD align="left"><I>Private Functions:</I></TD></TR>'
ret += '%s' % private_functions
if modifiers:
ret += '<TR><TD align="left"><I>Modifiers:</I></TD></TR>'
ret += '%s' % modifiers
if public_variables:
ret += '<TR><TD align="left"><I>Public Variables:</I></TD></TR>'
ret += '%s' % public_variables
if private_variables:
ret += '<TR><TD align="left"><I>Private Variables:</I></TD></TR>'
ret += '%s' % private_variables
if indirect_shadowing_information:
ret += '<TR><TD><BR/></TD></TR><TR><TD align="left" border="1"><font color="#777777" point-size="10">%s</font></TD></TR>' % indirect_shadowing_information.replace('\n', '<BR/>')
ret += '</TABLE> >];\n'
return ret | [
"def",
"_summary",
"(",
"self",
",",
"contract",
")",
":",
"ret",
"=",
"''",
"# Add arrows (number them if there is more than one path so we know order of declaration for inheritance).",
"if",
"len",
"(",
"contract",
".",
"immediate_inheritance",
")",
"==",
"1",
":",
"ret... | Build summary using HTML | [
"Build",
"summary",
"using",
"HTML"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/printers/inheritance/inheritance_graph.py#L103-L165 |
244,628 | crytic/slither | slither/detectors/shadowing/builtin_symbols.py | BuiltinSymbolShadowing.detect_builtin_shadowing_definitions | def detect_builtin_shadowing_definitions(self, contract):
""" Detects if functions, access modifiers, events, state variables, or local variables are named after built-in
symbols. Any such definitions are returned in a list.
Returns:
list of tuple: (type, definition, [local variable parent])"""
result = []
# Loop through all functions, modifiers, variables (state and local) to detect any built-in symbol keywords.
for function in contract.functions:
if function.contract == contract:
if self.is_builtin_symbol(function.name):
result.append((self.SHADOWING_FUNCTION, function, None))
result += self.detect_builtin_shadowing_locals(function)
for modifier in contract.modifiers:
if modifier.contract == contract:
if self.is_builtin_symbol(modifier.name):
result.append((self.SHADOWING_MODIFIER, modifier, None))
result += self.detect_builtin_shadowing_locals(modifier)
for variable in contract.variables:
if variable.contract == contract:
if self.is_builtin_symbol(variable.name):
result.append((self.SHADOWING_STATE_VARIABLE, variable, None))
for event in contract.events:
if event.contract == contract:
if self.is_builtin_symbol(event.name):
result.append((self.SHADOWING_EVENT, event, None))
return result | python | def detect_builtin_shadowing_definitions(self, contract):
result = []
# Loop through all functions, modifiers, variables (state and local) to detect any built-in symbol keywords.
for function in contract.functions:
if function.contract == contract:
if self.is_builtin_symbol(function.name):
result.append((self.SHADOWING_FUNCTION, function, None))
result += self.detect_builtin_shadowing_locals(function)
for modifier in contract.modifiers:
if modifier.contract == contract:
if self.is_builtin_symbol(modifier.name):
result.append((self.SHADOWING_MODIFIER, modifier, None))
result += self.detect_builtin_shadowing_locals(modifier)
for variable in contract.variables:
if variable.contract == contract:
if self.is_builtin_symbol(variable.name):
result.append((self.SHADOWING_STATE_VARIABLE, variable, None))
for event in contract.events:
if event.contract == contract:
if self.is_builtin_symbol(event.name):
result.append((self.SHADOWING_EVENT, event, None))
return result | [
"def",
"detect_builtin_shadowing_definitions",
"(",
"self",
",",
"contract",
")",
":",
"result",
"=",
"[",
"]",
"# Loop through all functions, modifiers, variables (state and local) to detect any built-in symbol keywords.",
"for",
"function",
"in",
"contract",
".",
"functions",
... | Detects if functions, access modifiers, events, state variables, or local variables are named after built-in
symbols. Any such definitions are returned in a list.
Returns:
list of tuple: (type, definition, [local variable parent]) | [
"Detects",
"if",
"functions",
"access",
"modifiers",
"events",
"state",
"variables",
"or",
"local",
"variables",
"are",
"named",
"after",
"built",
"-",
"in",
"symbols",
".",
"Any",
"such",
"definitions",
"are",
"returned",
"in",
"a",
"list",
"."
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/shadowing/builtin_symbols.py#L83-L112 |
244,629 | crytic/slither | slither/detectors/shadowing/builtin_symbols.py | BuiltinSymbolShadowing._detect | def _detect(self):
""" Detect shadowing of built-in symbols
Recursively visit the calls
Returns:
list: {'vuln', 'filename,'contract','func', 'shadow'}
"""
results = []
for contract in self.contracts:
shadows = self.detect_builtin_shadowing_definitions(contract)
if shadows:
for shadow in shadows:
# Obtain components
shadow_type = shadow[0]
shadow_object = shadow[1]
local_variable_parent = shadow[2]
# Build the path for our info string
local_variable_path = contract.name + "."
if local_variable_parent is not None:
local_variable_path += local_variable_parent.name + "."
local_variable_path += shadow_object.name
info = '{} ({} @ {}) shadows built-in symbol \"{}"\n'.format(local_variable_path,
shadow_type,
shadow_object.source_mapping_str,
shadow_object.name)
# Generate relevant JSON data for this shadowing definition.
json = self.generate_json_result(info)
if shadow_type in [self.SHADOWING_FUNCTION, self.SHADOWING_MODIFIER, self.SHADOWING_EVENT]:
self.add_function_to_json(shadow_object, json)
elif shadow_type in [self.SHADOWING_STATE_VARIABLE, self.SHADOWING_LOCAL_VARIABLE]:
self.add_variable_to_json(shadow_object, json)
results.append(json)
return results | python | def _detect(self):
results = []
for contract in self.contracts:
shadows = self.detect_builtin_shadowing_definitions(contract)
if shadows:
for shadow in shadows:
# Obtain components
shadow_type = shadow[0]
shadow_object = shadow[1]
local_variable_parent = shadow[2]
# Build the path for our info string
local_variable_path = contract.name + "."
if local_variable_parent is not None:
local_variable_path += local_variable_parent.name + "."
local_variable_path += shadow_object.name
info = '{} ({} @ {}) shadows built-in symbol \"{}"\n'.format(local_variable_path,
shadow_type,
shadow_object.source_mapping_str,
shadow_object.name)
# Generate relevant JSON data for this shadowing definition.
json = self.generate_json_result(info)
if shadow_type in [self.SHADOWING_FUNCTION, self.SHADOWING_MODIFIER, self.SHADOWING_EVENT]:
self.add_function_to_json(shadow_object, json)
elif shadow_type in [self.SHADOWING_STATE_VARIABLE, self.SHADOWING_LOCAL_VARIABLE]:
self.add_variable_to_json(shadow_object, json)
results.append(json)
return results | [
"def",
"_detect",
"(",
"self",
")",
":",
"results",
"=",
"[",
"]",
"for",
"contract",
"in",
"self",
".",
"contracts",
":",
"shadows",
"=",
"self",
".",
"detect_builtin_shadowing_definitions",
"(",
"contract",
")",
"if",
"shadows",
":",
"for",
"shadow",
"in... | Detect shadowing of built-in symbols
Recursively visit the calls
Returns:
list: {'vuln', 'filename,'contract','func', 'shadow'} | [
"Detect",
"shadowing",
"of",
"built",
"-",
"in",
"symbols"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/shadowing/builtin_symbols.py#L114-L152 |
244,630 | crytic/slither | slither/utils/inheritance_analysis.py | detect_c3_function_shadowing | def detect_c3_function_shadowing(contract):
"""
Detects and obtains functions which are indirectly shadowed via multiple inheritance by C3 linearization
properties, despite not directly inheriting from each other.
:param contract: The contract to check for potential C3 linearization shadowing within.
:return: A list of list of tuples: (contract, function), where each inner list describes colliding functions.
The later elements in the inner list overshadow the earlier ones. The contract-function pair's function does not
need to be defined in its paired contract, it may have been inherited within it.
"""
# Loop through all contracts, and all underlying functions.
results = {}
for i in range(0, len(contract.immediate_inheritance) - 1):
inherited_contract1 = contract.immediate_inheritance[i]
for function1 in inherited_contract1.functions_and_modifiers:
# If this function has already be handled or is unimplemented, we skip it
if function1.full_name in results or function1.is_constructor or not function1.is_implemented:
continue
# Define our list of function instances which overshadow each other.
functions_matching = [(inherited_contract1, function1)]
already_processed = set([function1])
# Loop again through other contracts and functions to compare to.
for x in range(i + 1, len(contract.immediate_inheritance)):
inherited_contract2 = contract.immediate_inheritance[x]
# Loop for each function in this contract
for function2 in inherited_contract2.functions_and_modifiers:
# Skip this function if it is the last function that was shadowed.
if function2 in already_processed or function2.is_constructor or not function2.is_implemented:
continue
# If this function does have the same full name, it is shadowing through C3 linearization.
if function1.full_name == function2.full_name:
functions_matching.append((inherited_contract2, function2))
already_processed.add(function2)
# If we have more than one definition matching the same signature, we add it to the results.
if len(functions_matching) > 1:
results[function1.full_name] = functions_matching
return list(results.values()) | python | def detect_c3_function_shadowing(contract):
# Loop through all contracts, and all underlying functions.
results = {}
for i in range(0, len(contract.immediate_inheritance) - 1):
inherited_contract1 = contract.immediate_inheritance[i]
for function1 in inherited_contract1.functions_and_modifiers:
# If this function has already be handled or is unimplemented, we skip it
if function1.full_name in results or function1.is_constructor or not function1.is_implemented:
continue
# Define our list of function instances which overshadow each other.
functions_matching = [(inherited_contract1, function1)]
already_processed = set([function1])
# Loop again through other contracts and functions to compare to.
for x in range(i + 1, len(contract.immediate_inheritance)):
inherited_contract2 = contract.immediate_inheritance[x]
# Loop for each function in this contract
for function2 in inherited_contract2.functions_and_modifiers:
# Skip this function if it is the last function that was shadowed.
if function2 in already_processed or function2.is_constructor or not function2.is_implemented:
continue
# If this function does have the same full name, it is shadowing through C3 linearization.
if function1.full_name == function2.full_name:
functions_matching.append((inherited_contract2, function2))
already_processed.add(function2)
# If we have more than one definition matching the same signature, we add it to the results.
if len(functions_matching) > 1:
results[function1.full_name] = functions_matching
return list(results.values()) | [
"def",
"detect_c3_function_shadowing",
"(",
"contract",
")",
":",
"# Loop through all contracts, and all underlying functions.",
"results",
"=",
"{",
"}",
"for",
"i",
"in",
"range",
"(",
"0",
",",
"len",
"(",
"contract",
".",
"immediate_inheritance",
")",
"-",
"1",
... | Detects and obtains functions which are indirectly shadowed via multiple inheritance by C3 linearization
properties, despite not directly inheriting from each other.
:param contract: The contract to check for potential C3 linearization shadowing within.
:return: A list of list of tuples: (contract, function), where each inner list describes colliding functions.
The later elements in the inner list overshadow the earlier ones. The contract-function pair's function does not
need to be defined in its paired contract, it may have been inherited within it. | [
"Detects",
"and",
"obtains",
"functions",
"which",
"are",
"indirectly",
"shadowed",
"via",
"multiple",
"inheritance",
"by",
"C3",
"linearization",
"properties",
"despite",
"not",
"directly",
"inheriting",
"from",
"each",
"other",
"."
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/utils/inheritance_analysis.py#L6-L50 |
244,631 | crytic/slither | slither/detectors/variables/uninitialized_state_variables.py | UninitializedStateVarsDetection._detect | def _detect(self):
""" Detect uninitialized state variables
Recursively visit the calls
Returns:
dict: [contract name] = set(state variable uninitialized)
"""
results = []
for c in self.slither.contracts_derived:
ret = self.detect_uninitialized(c)
for variable, functions in ret:
info = "{}.{} ({}) is never initialized. It is used in:\n"
info = info.format(variable.contract.name,
variable.name,
variable.source_mapping_str)
for f in functions:
info += "\t- {} ({})\n".format(f.name, f.source_mapping_str)
source = [variable.source_mapping]
source += [f.source_mapping for f in functions]
json = self.generate_json_result(info)
self.add_variable_to_json(variable, json)
self.add_functions_to_json(functions, json)
results.append(json)
return results | python | def _detect(self):
results = []
for c in self.slither.contracts_derived:
ret = self.detect_uninitialized(c)
for variable, functions in ret:
info = "{}.{} ({}) is never initialized. It is used in:\n"
info = info.format(variable.contract.name,
variable.name,
variable.source_mapping_str)
for f in functions:
info += "\t- {} ({})\n".format(f.name, f.source_mapping_str)
source = [variable.source_mapping]
source += [f.source_mapping for f in functions]
json = self.generate_json_result(info)
self.add_variable_to_json(variable, json)
self.add_functions_to_json(functions, json)
results.append(json)
return results | [
"def",
"_detect",
"(",
"self",
")",
":",
"results",
"=",
"[",
"]",
"for",
"c",
"in",
"self",
".",
"slither",
".",
"contracts_derived",
":",
"ret",
"=",
"self",
".",
"detect_uninitialized",
"(",
"c",
")",
"for",
"variable",
",",
"functions",
"in",
"ret"... | Detect uninitialized state variables
Recursively visit the calls
Returns:
dict: [contract name] = set(state variable uninitialized) | [
"Detect",
"uninitialized",
"state",
"variables"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/variables/uninitialized_state_variables.py#L84-L110 |
244,632 | crytic/slither | slither/detectors/functions/external_function.py | ExternalFunction.detect_functions_called | def detect_functions_called(contract):
""" Returns a list of InternallCall, SolidityCall
calls made in a function
Returns:
(list): List of all InternallCall, SolidityCall
"""
result = []
# Obtain all functions reachable by this contract.
for func in contract.all_functions_called:
# Loop through all nodes in the function, add all calls to a list.
for node in func.nodes:
for ir in node.irs:
if isinstance(ir, (InternalCall, SolidityCall)):
result.append(ir.function)
return result | python | def detect_functions_called(contract):
result = []
# Obtain all functions reachable by this contract.
for func in contract.all_functions_called:
# Loop through all nodes in the function, add all calls to a list.
for node in func.nodes:
for ir in node.irs:
if isinstance(ir, (InternalCall, SolidityCall)):
result.append(ir.function)
return result | [
"def",
"detect_functions_called",
"(",
"contract",
")",
":",
"result",
"=",
"[",
"]",
"# Obtain all functions reachable by this contract.",
"for",
"func",
"in",
"contract",
".",
"all_functions_called",
":",
"# Loop through all nodes in the function, add all calls to a list.",
"... | Returns a list of InternallCall, SolidityCall
calls made in a function
Returns:
(list): List of all InternallCall, SolidityCall | [
"Returns",
"a",
"list",
"of",
"InternallCall",
"SolidityCall",
"calls",
"made",
"in",
"a",
"function"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/functions/external_function.py#L27-L43 |
244,633 | crytic/slither | slither/detectors/functions/external_function.py | ExternalFunction._contains_internal_dynamic_call | def _contains_internal_dynamic_call(contract):
"""
Checks if a contract contains a dynamic call either in a direct definition, or through inheritance.
Returns:
(boolean): True if this contract contains a dynamic call (including through inheritance).
"""
for func in contract.all_functions_called:
for node in func.nodes:
for ir in node.irs:
if isinstance(ir, (InternalDynamicCall)):
return True
return False | python | def _contains_internal_dynamic_call(contract):
for func in contract.all_functions_called:
for node in func.nodes:
for ir in node.irs:
if isinstance(ir, (InternalDynamicCall)):
return True
return False | [
"def",
"_contains_internal_dynamic_call",
"(",
"contract",
")",
":",
"for",
"func",
"in",
"contract",
".",
"all_functions_called",
":",
"for",
"node",
"in",
"func",
".",
"nodes",
":",
"for",
"ir",
"in",
"node",
".",
"irs",
":",
"if",
"isinstance",
"(",
"ir... | Checks if a contract contains a dynamic call either in a direct definition, or through inheritance.
Returns:
(boolean): True if this contract contains a dynamic call (including through inheritance). | [
"Checks",
"if",
"a",
"contract",
"contains",
"a",
"dynamic",
"call",
"either",
"in",
"a",
"direct",
"definition",
"or",
"through",
"inheritance",
"."
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/functions/external_function.py#L46-L58 |
244,634 | crytic/slither | slither/detectors/functions/external_function.py | ExternalFunction.get_base_most_function | def get_base_most_function(function):
"""
Obtains the base function definition for the provided function. This could be used to obtain the original
definition of a function, if the provided function is an override.
Returns:
(function): Returns the base-most function of a provided function. (The original definition).
"""
# Loop through the list of inherited contracts and this contract, to find the first function instance which
# matches this function's signature. Note here that `inheritance` is in order from most basic to most extended.
for contract in function.contract.inheritance + [function.contract]:
# Loop through the functions not inherited (explicitly defined in this contract).
for f in contract.functions_not_inherited:
# If it matches names, this is the base most function.
if f.full_name == function.full_name:
return f
# Somehow we couldn't resolve it, which shouldn't happen, as the provided function should be found if we could
# not find some any more basic.
raise Exception("Could not resolve the base-most function for the provided function.") | python | def get_base_most_function(function):
# Loop through the list of inherited contracts and this contract, to find the first function instance which
# matches this function's signature. Note here that `inheritance` is in order from most basic to most extended.
for contract in function.contract.inheritance + [function.contract]:
# Loop through the functions not inherited (explicitly defined in this contract).
for f in contract.functions_not_inherited:
# If it matches names, this is the base most function.
if f.full_name == function.full_name:
return f
# Somehow we couldn't resolve it, which shouldn't happen, as the provided function should be found if we could
# not find some any more basic.
raise Exception("Could not resolve the base-most function for the provided function.") | [
"def",
"get_base_most_function",
"(",
"function",
")",
":",
"# Loop through the list of inherited contracts and this contract, to find the first function instance which",
"# matches this function's signature. Note here that `inheritance` is in order from most basic to most extended.",
"for",
"cont... | Obtains the base function definition for the provided function. This could be used to obtain the original
definition of a function, if the provided function is an override.
Returns:
(function): Returns the base-most function of a provided function. (The original definition). | [
"Obtains",
"the",
"base",
"function",
"definition",
"for",
"the",
"provided",
"function",
".",
"This",
"could",
"be",
"used",
"to",
"obtain",
"the",
"original",
"definition",
"of",
"a",
"function",
"if",
"the",
"provided",
"function",
"is",
"an",
"override",
... | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/functions/external_function.py#L61-L82 |
244,635 | crytic/slither | slither/detectors/functions/external_function.py | ExternalFunction.get_all_function_definitions | def get_all_function_definitions(base_most_function):
"""
Obtains all function definitions given a base-most function. This includes the provided function, plus any
overrides of that function.
Returns:
(list): Returns any the provided function and any overriding functions defined for it.
"""
# We assume the provided function is the base-most function, so we check all derived contracts
# for a redefinition
return [base_most_function] + [function for derived_contract in base_most_function.contract.derived_contracts
for function in derived_contract.functions
if function.full_name == base_most_function.full_name] | python | def get_all_function_definitions(base_most_function):
# We assume the provided function is the base-most function, so we check all derived contracts
# for a redefinition
return [base_most_function] + [function for derived_contract in base_most_function.contract.derived_contracts
for function in derived_contract.functions
if function.full_name == base_most_function.full_name] | [
"def",
"get_all_function_definitions",
"(",
"base_most_function",
")",
":",
"# We assume the provided function is the base-most function, so we check all derived contracts",
"# for a redefinition",
"return",
"[",
"base_most_function",
"]",
"+",
"[",
"function",
"for",
"derived_contra... | Obtains all function definitions given a base-most function. This includes the provided function, plus any
overrides of that function.
Returns:
(list): Returns any the provided function and any overriding functions defined for it. | [
"Obtains",
"all",
"function",
"definitions",
"given",
"a",
"base",
"-",
"most",
"function",
".",
"This",
"includes",
"the",
"provided",
"function",
"plus",
"any",
"overrides",
"of",
"that",
"function",
"."
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/functions/external_function.py#L85-L97 |
244,636 | crytic/slither | slither/detectors/functions/complex_function.py | ComplexFunction.detect_complex_func | def detect_complex_func(func):
"""Detect the cyclomatic complexity of the contract functions
shouldn't be greater than 7
"""
result = []
code_complexity = compute_cyclomatic_complexity(func)
if code_complexity > ComplexFunction.MAX_CYCLOMATIC_COMPLEXITY:
result.append({
"func": func,
"cause": ComplexFunction.CAUSE_CYCLOMATIC
})
"""Detect the number of external calls in the func
shouldn't be greater than 5
"""
count = 0
for node in func.nodes:
for ir in node.irs:
if isinstance(ir, (HighLevelCall, LowLevelCall, LibraryCall)):
count += 1
if count > ComplexFunction.MAX_EXTERNAL_CALLS:
result.append({
"func": func,
"cause": ComplexFunction.CAUSE_EXTERNAL_CALL
})
"""Checks the number of the state variables written
shouldn't be greater than 10
"""
if len(func.state_variables_written) > ComplexFunction.MAX_STATE_VARIABLES:
result.append({
"func": func,
"cause": ComplexFunction.CAUSE_STATE_VARS
})
return result | python | def detect_complex_func(func):
result = []
code_complexity = compute_cyclomatic_complexity(func)
if code_complexity > ComplexFunction.MAX_CYCLOMATIC_COMPLEXITY:
result.append({
"func": func,
"cause": ComplexFunction.CAUSE_CYCLOMATIC
})
"""Detect the number of external calls in the func
shouldn't be greater than 5
"""
count = 0
for node in func.nodes:
for ir in node.irs:
if isinstance(ir, (HighLevelCall, LowLevelCall, LibraryCall)):
count += 1
if count > ComplexFunction.MAX_EXTERNAL_CALLS:
result.append({
"func": func,
"cause": ComplexFunction.CAUSE_EXTERNAL_CALL
})
"""Checks the number of the state variables written
shouldn't be greater than 10
"""
if len(func.state_variables_written) > ComplexFunction.MAX_STATE_VARIABLES:
result.append({
"func": func,
"cause": ComplexFunction.CAUSE_STATE_VARS
})
return result | [
"def",
"detect_complex_func",
"(",
"func",
")",
":",
"result",
"=",
"[",
"]",
"code_complexity",
"=",
"compute_cyclomatic_complexity",
"(",
"func",
")",
"if",
"code_complexity",
">",
"ComplexFunction",
".",
"MAX_CYCLOMATIC_COMPLEXITY",
":",
"result",
".",
"append",
... | Detect the cyclomatic complexity of the contract functions
shouldn't be greater than 7 | [
"Detect",
"the",
"cyclomatic",
"complexity",
"of",
"the",
"contract",
"functions",
"shouldn",
"t",
"be",
"greater",
"than",
"7"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/functions/complex_function.py#L36-L73 |
244,637 | crytic/slither | slither/detectors/variables/unused_state_variables.py | UnusedStateVars._detect | def _detect(self):
""" Detect unused state variables
"""
results = []
for c in self.slither.contracts_derived:
unusedVars = self.detect_unused(c)
if unusedVars:
info = ''
for var in unusedVars:
info += "{}.{} ({}) is never used in {}\n".format(var.contract.name,
var.name,
var.source_mapping_str,
c.name)
json = self.generate_json_result(info)
self.add_variables_to_json(unusedVars, json)
results.append(json)
return results | python | def _detect(self):
results = []
for c in self.slither.contracts_derived:
unusedVars = self.detect_unused(c)
if unusedVars:
info = ''
for var in unusedVars:
info += "{}.{} ({}) is never used in {}\n".format(var.contract.name,
var.name,
var.source_mapping_str,
c.name)
json = self.generate_json_result(info)
self.add_variables_to_json(unusedVars, json)
results.append(json)
return results | [
"def",
"_detect",
"(",
"self",
")",
":",
"results",
"=",
"[",
"]",
"for",
"c",
"in",
"self",
".",
"slither",
".",
"contracts_derived",
":",
"unusedVars",
"=",
"self",
".",
"detect_unused",
"(",
"c",
")",
"if",
"unusedVars",
":",
"info",
"=",
"''",
"f... | Detect unused state variables | [
"Detect",
"unused",
"state",
"variables"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/variables/unused_state_variables.py#L51-L70 |
244,638 | crytic/slither | slither/detectors/variables/uninitialized_local_variables.py | UninitializedLocalVars._detect | def _detect(self):
""" Detect uninitialized local variables
Recursively visit the calls
Returns:
dict: [contract name] = set(local variable uninitialized)
"""
results = []
self.results = []
self.visited_all_paths = {}
for contract in self.slither.contracts:
for function in contract.functions:
if function.is_implemented and function.contract == contract:
if function.contains_assembly:
continue
# dont consider storage variable, as they are detected by another detector
uninitialized_local_variables = [v for v in function.local_variables if not v.is_storage and v.uninitialized]
function.entry_point.context[self.key] = uninitialized_local_variables
self._detect_uninitialized(function, function.entry_point, [])
all_results = list(set(self.results))
for(function, uninitialized_local_variable) in all_results:
var_name = uninitialized_local_variable.name
info = "{} in {}.{} ({}) is a local variable never initialiazed\n"
info = info.format(var_name,
function.contract.name,
function.name,
uninitialized_local_variable.source_mapping_str)
json = self.generate_json_result(info)
self.add_variable_to_json(uninitialized_local_variable, json)
self.add_function_to_json(function, json)
results.append(json)
return results | python | def _detect(self):
results = []
self.results = []
self.visited_all_paths = {}
for contract in self.slither.contracts:
for function in contract.functions:
if function.is_implemented and function.contract == contract:
if function.contains_assembly:
continue
# dont consider storage variable, as they are detected by another detector
uninitialized_local_variables = [v for v in function.local_variables if not v.is_storage and v.uninitialized]
function.entry_point.context[self.key] = uninitialized_local_variables
self._detect_uninitialized(function, function.entry_point, [])
all_results = list(set(self.results))
for(function, uninitialized_local_variable) in all_results:
var_name = uninitialized_local_variable.name
info = "{} in {}.{} ({}) is a local variable never initialiazed\n"
info = info.format(var_name,
function.contract.name,
function.name,
uninitialized_local_variable.source_mapping_str)
json = self.generate_json_result(info)
self.add_variable_to_json(uninitialized_local_variable, json)
self.add_function_to_json(function, json)
results.append(json)
return results | [
"def",
"_detect",
"(",
"self",
")",
":",
"results",
"=",
"[",
"]",
"self",
".",
"results",
"=",
"[",
"]",
"self",
".",
"visited_all_paths",
"=",
"{",
"}",
"for",
"contract",
"in",
"self",
".",
"slither",
".",
"contracts",
":",
"for",
"function",
"in"... | Detect uninitialized local variables
Recursively visit the calls
Returns:
dict: [contract name] = set(local variable uninitialized) | [
"Detect",
"uninitialized",
"local",
"variables"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/variables/uninitialized_local_variables.py#L79-L116 |
244,639 | crytic/slither | slither/detectors/erc20/unindexed_event_parameters.py | UnindexedERC20EventParameters._detect | def _detect(self):
"""
Detect un-indexed ERC20 event parameters in all contracts.
"""
results = []
for c in self.contracts:
unindexed_params = self.detect_erc20_unindexed_event_params(c)
if unindexed_params:
info = "{} ({}) does not mark important ERC20 parameters as 'indexed':\n"
info = info.format(c.name, c.source_mapping_str)
for (event, parameter) in unindexed_params:
info += "\t-{} ({}) does not index parameter '{}'\n".format(event.name, event.source_mapping_str, parameter.name)
# Add the events to the JSON (note: we do not add the params/vars as they have no source mapping).
json = self.generate_json_result(info)
self.add_functions_to_json([event for event, _ in unindexed_params], json)
results.append(json)
return results | python | def _detect(self):
results = []
for c in self.contracts:
unindexed_params = self.detect_erc20_unindexed_event_params(c)
if unindexed_params:
info = "{} ({}) does not mark important ERC20 parameters as 'indexed':\n"
info = info.format(c.name, c.source_mapping_str)
for (event, parameter) in unindexed_params:
info += "\t-{} ({}) does not index parameter '{}'\n".format(event.name, event.source_mapping_str, parameter.name)
# Add the events to the JSON (note: we do not add the params/vars as they have no source mapping).
json = self.generate_json_result(info)
self.add_functions_to_json([event for event, _ in unindexed_params], json)
results.append(json)
return results | [
"def",
"_detect",
"(",
"self",
")",
":",
"results",
"=",
"[",
"]",
"for",
"c",
"in",
"self",
".",
"contracts",
":",
"unindexed_params",
"=",
"self",
".",
"detect_erc20_unindexed_event_params",
"(",
"c",
")",
"if",
"unindexed_params",
":",
"info",
"=",
"\"{... | Detect un-indexed ERC20 event parameters in all contracts. | [
"Detect",
"un",
"-",
"indexed",
"ERC20",
"event",
"parameters",
"in",
"all",
"contracts",
"."
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/erc20/unindexed_event_parameters.py#L67-L85 |
244,640 | crytic/slither | slither/core/slither_core.py | Slither.print_functions | def print_functions(self, d):
"""
Export all the functions to dot files
"""
for c in self.contracts:
for f in c.functions:
f.cfg_to_dot(os.path.join(d, '{}.{}.dot'.format(c.name, f.name))) | python | def print_functions(self, d):
for c in self.contracts:
for f in c.functions:
f.cfg_to_dot(os.path.join(d, '{}.{}.dot'.format(c.name, f.name))) | [
"def",
"print_functions",
"(",
"self",
",",
"d",
")",
":",
"for",
"c",
"in",
"self",
".",
"contracts",
":",
"for",
"f",
"in",
"c",
".",
"functions",
":",
"f",
".",
"cfg_to_dot",
"(",
"os",
".",
"path",
".",
"join",
"(",
"d",
",",
"'{}.{}.dot'",
"... | Export all the functions to dot files | [
"Export",
"all",
"the",
"functions",
"to",
"dot",
"files"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/slither_core.py#L155-L161 |
244,641 | crytic/slither | slither/printers/inheritance/inheritance.py | PrinterInheritance.output | def output(self, filename):
"""
Output the inheritance relation
_filename is not used
Args:
_filename(string)
"""
info = 'Inheritance\n'
if not self.contracts:
return
info += blue('Child_Contract -> ') + green('Immediate_Base_Contracts')
info += green(' [Not_Immediate_Base_Contracts]')
for child in self.contracts:
info += blue(f'\n+ {child.name}')
if child.inheritance:
immediate = child.immediate_inheritance
not_immediate = [i for i in child.inheritance if i not in immediate]
info += ' -> ' + green(", ".join(map(str, immediate)))
if not_immediate:
info += ", ["+ green(", ".join(map(str, not_immediate))) + "]"
info += green('\n\nBase_Contract -> ') + blue('Immediate_Child_Contracts')
info += blue(' [Not_Immediate_Child_Contracts]')
for base in self.contracts:
info += green(f'\n+ {base.name}')
children = list(self._get_child_contracts(base))
if children:
immediate = [child for child in children if base in child.immediate_inheritance]
not_immediate = [child for child in children if not child in immediate]
info += ' -> ' + blue(", ".join(map(str, immediate)))
if not_immediate:
info += ', [' + blue(", ".join(map(str, not_immediate))) + ']'
self.info(info) | python | def output(self, filename):
info = 'Inheritance\n'
if not self.contracts:
return
info += blue('Child_Contract -> ') + green('Immediate_Base_Contracts')
info += green(' [Not_Immediate_Base_Contracts]')
for child in self.contracts:
info += blue(f'\n+ {child.name}')
if child.inheritance:
immediate = child.immediate_inheritance
not_immediate = [i for i in child.inheritance if i not in immediate]
info += ' -> ' + green(", ".join(map(str, immediate)))
if not_immediate:
info += ", ["+ green(", ".join(map(str, not_immediate))) + "]"
info += green('\n\nBase_Contract -> ') + blue('Immediate_Child_Contracts')
info += blue(' [Not_Immediate_Child_Contracts]')
for base in self.contracts:
info += green(f'\n+ {base.name}')
children = list(self._get_child_contracts(base))
if children:
immediate = [child for child in children if base in child.immediate_inheritance]
not_immediate = [child for child in children if not child in immediate]
info += ' -> ' + blue(", ".join(map(str, immediate)))
if not_immediate:
info += ', [' + blue(", ".join(map(str, not_immediate))) + ']'
self.info(info) | [
"def",
"output",
"(",
"self",
",",
"filename",
")",
":",
"info",
"=",
"'Inheritance\\n'",
"if",
"not",
"self",
".",
"contracts",
":",
"return",
"info",
"+=",
"blue",
"(",
"'Child_Contract -> '",
")",
"+",
"green",
"(",
"'Immediate_Base_Contracts'",
")",
"inf... | Output the inheritance relation
_filename is not used
Args:
_filename(string) | [
"Output",
"the",
"inheritance",
"relation"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/printers/inheritance/inheritance.py#L23-L58 |
244,642 | crytic/slither | slither/detectors/variables/uninitialized_storage_variables.py | UninitializedStorageVars._detect | def _detect(self):
""" Detect uninitialized storage variables
Recursively visit the calls
Returns:
dict: [contract name] = set(storage variable uninitialized)
"""
results = []
self.results = []
self.visited_all_paths = {}
for contract in self.slither.contracts:
for function in contract.functions:
if function.is_implemented:
uninitialized_storage_variables = [v for v in function.local_variables if v.is_storage and v.uninitialized]
function.entry_point.context[self.key] = uninitialized_storage_variables
self._detect_uninitialized(function, function.entry_point, [])
for(function, uninitialized_storage_variable) in self.results:
var_name = uninitialized_storage_variable.name
info = "{} in {}.{} ({}) is a storage variable never initialiazed\n"
info = info.format(var_name, function.contract.name, function.name, uninitialized_storage_variable.source_mapping_str)
json = self.generate_json_result(info)
self.add_variable_to_json(uninitialized_storage_variable, json)
self.add_function_to_json(function, json)
results.append(json)
return results | python | def _detect(self):
results = []
self.results = []
self.visited_all_paths = {}
for contract in self.slither.contracts:
for function in contract.functions:
if function.is_implemented:
uninitialized_storage_variables = [v for v in function.local_variables if v.is_storage and v.uninitialized]
function.entry_point.context[self.key] = uninitialized_storage_variables
self._detect_uninitialized(function, function.entry_point, [])
for(function, uninitialized_storage_variable) in self.results:
var_name = uninitialized_storage_variable.name
info = "{} in {}.{} ({}) is a storage variable never initialiazed\n"
info = info.format(var_name, function.contract.name, function.name, uninitialized_storage_variable.source_mapping_str)
json = self.generate_json_result(info)
self.add_variable_to_json(uninitialized_storage_variable, json)
self.add_function_to_json(function, json)
results.append(json)
return results | [
"def",
"_detect",
"(",
"self",
")",
":",
"results",
"=",
"[",
"]",
"self",
".",
"results",
"=",
"[",
"]",
"self",
".",
"visited_all_paths",
"=",
"{",
"}",
"for",
"contract",
"in",
"self",
".",
"slither",
".",
"contracts",
":",
"for",
"function",
"in"... | Detect uninitialized storage variables
Recursively visit the calls
Returns:
dict: [contract name] = set(storage variable uninitialized) | [
"Detect",
"uninitialized",
"storage",
"variables"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/variables/uninitialized_storage_variables.py#L86-L117 |
244,643 | crytic/slither | slither/detectors/reentrancy/reentrancy.py | Reentrancy._can_callback | def _can_callback(self, irs):
"""
Detect if the node contains a call that can
be used to re-entrance
Consider as valid target:
- low level call
- high level call
Do not consider Send/Transfer as there is not enough gas
"""
for ir in irs:
if isinstance(ir, LowLevelCall):
return True
if isinstance(ir, HighLevelCall) and not isinstance(ir, LibraryCall):
# If solidity >0.5, STATICCALL is used
if self.slither.solc_version and self.slither.solc_version.startswith('0.5.'):
if isinstance(ir.function, Function) and (ir.function.view or ir.function.pure):
continue
if isinstance(ir.function, Variable):
continue
# If there is a call to itself
# We can check that the function called is
# reentrancy-safe
if ir.destination == SolidityVariable('this'):
if isinstance(ir.function, Variable):
continue
if not ir.function.all_high_level_calls():
if not ir.function.all_low_level_calls():
continue
return True
return False | python | def _can_callback(self, irs):
for ir in irs:
if isinstance(ir, LowLevelCall):
return True
if isinstance(ir, HighLevelCall) and not isinstance(ir, LibraryCall):
# If solidity >0.5, STATICCALL is used
if self.slither.solc_version and self.slither.solc_version.startswith('0.5.'):
if isinstance(ir.function, Function) and (ir.function.view or ir.function.pure):
continue
if isinstance(ir.function, Variable):
continue
# If there is a call to itself
# We can check that the function called is
# reentrancy-safe
if ir.destination == SolidityVariable('this'):
if isinstance(ir.function, Variable):
continue
if not ir.function.all_high_level_calls():
if not ir.function.all_low_level_calls():
continue
return True
return False | [
"def",
"_can_callback",
"(",
"self",
",",
"irs",
")",
":",
"for",
"ir",
"in",
"irs",
":",
"if",
"isinstance",
"(",
"ir",
",",
"LowLevelCall",
")",
":",
"return",
"True",
"if",
"isinstance",
"(",
"ir",
",",
"HighLevelCall",
")",
"and",
"not",
"isinstanc... | Detect if the node contains a call that can
be used to re-entrance
Consider as valid target:
- low level call
- high level call
Do not consider Send/Transfer as there is not enough gas | [
"Detect",
"if",
"the",
"node",
"contains",
"a",
"call",
"that",
"can",
"be",
"used",
"to",
"re",
"-",
"entrance"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/reentrancy/reentrancy.py#L37-L68 |
244,644 | crytic/slither | slither/detectors/reentrancy/reentrancy.py | Reentrancy._can_send_eth | def _can_send_eth(irs):
"""
Detect if the node can send eth
"""
for ir in irs:
if isinstance(ir, (HighLevelCall, LowLevelCall, Transfer, Send)):
if ir.call_value:
return True
return False | python | def _can_send_eth(irs):
for ir in irs:
if isinstance(ir, (HighLevelCall, LowLevelCall, Transfer, Send)):
if ir.call_value:
return True
return False | [
"def",
"_can_send_eth",
"(",
"irs",
")",
":",
"for",
"ir",
"in",
"irs",
":",
"if",
"isinstance",
"(",
"ir",
",",
"(",
"HighLevelCall",
",",
"LowLevelCall",
",",
"Transfer",
",",
"Send",
")",
")",
":",
"if",
"ir",
".",
"call_value",
":",
"return",
"Tr... | Detect if the node can send eth | [
"Detect",
"if",
"the",
"node",
"can",
"send",
"eth"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/reentrancy/reentrancy.py#L71-L79 |
244,645 | crytic/slither | slither/core/cfg/node.py | Node.remove_father | def remove_father(self, father):
""" Remove the father node. Do nothing if the node is not a father
Args:
fathers: list of fathers to add
"""
self._fathers = [x for x in self._fathers if x.node_id != father.node_id] | python | def remove_father(self, father):
self._fathers = [x for x in self._fathers if x.node_id != father.node_id] | [
"def",
"remove_father",
"(",
"self",
",",
"father",
")",
":",
"self",
".",
"_fathers",
"=",
"[",
"x",
"for",
"x",
"in",
"self",
".",
"_fathers",
"if",
"x",
".",
"node_id",
"!=",
"father",
".",
"node_id",
"]"
] | Remove the father node. Do nothing if the node is not a father
Args:
fathers: list of fathers to add | [
"Remove",
"the",
"father",
"node",
".",
"Do",
"nothing",
"if",
"the",
"node",
"is",
"not",
"a",
"father"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/cfg/node.py#L485-L491 |
244,646 | crytic/slither | slither/core/cfg/node.py | Node.remove_son | def remove_son(self, son):
""" Remove the son node. Do nothing if the node is not a son
Args:
fathers: list of fathers to add
"""
self._sons = [x for x in self._sons if x.node_id != son.node_id] | python | def remove_son(self, son):
self._sons = [x for x in self._sons if x.node_id != son.node_id] | [
"def",
"remove_son",
"(",
"self",
",",
"son",
")",
":",
"self",
".",
"_sons",
"=",
"[",
"x",
"for",
"x",
"in",
"self",
".",
"_sons",
"if",
"x",
".",
"node_id",
"!=",
"son",
".",
"node_id",
"]"
] | Remove the son node. Do nothing if the node is not a son
Args:
fathers: list of fathers to add | [
"Remove",
"the",
"son",
"node",
".",
"Do",
"nothing",
"if",
"the",
"node",
"is",
"not",
"a",
"son"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/cfg/node.py#L493-L499 |
244,647 | crytic/slither | slither/detectors/statements/deprecated_calls.py | DeprecatedStandards.detect_deprecated_references_in_node | def detect_deprecated_references_in_node(self, node):
""" Detects if a node makes use of any deprecated standards.
Returns:
list of tuple: (detecting_signature, original_text, recommended_text)"""
# Define our results list
results = []
# If this node has an expression, we check the underlying expression.
if node.expression:
results += self.detect_deprecation_in_expression(node.expression)
# Check if there is usage of any deprecated solidity variables or functions
for dep_node in self.DEPRECATED_NODE_TYPES:
if node.type == dep_node[0]:
results.append(dep_node)
return results | python | def detect_deprecated_references_in_node(self, node):
# Define our results list
results = []
# If this node has an expression, we check the underlying expression.
if node.expression:
results += self.detect_deprecation_in_expression(node.expression)
# Check if there is usage of any deprecated solidity variables or functions
for dep_node in self.DEPRECATED_NODE_TYPES:
if node.type == dep_node[0]:
results.append(dep_node)
return results | [
"def",
"detect_deprecated_references_in_node",
"(",
"self",
",",
"node",
")",
":",
"# Define our results list",
"results",
"=",
"[",
"]",
"# If this node has an expression, we check the underlying expression.",
"if",
"node",
".",
"expression",
":",
"results",
"+=",
"self",
... | Detects if a node makes use of any deprecated standards.
Returns:
list of tuple: (detecting_signature, original_text, recommended_text) | [
"Detects",
"if",
"a",
"node",
"makes",
"use",
"of",
"any",
"deprecated",
"standards",
"."
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/statements/deprecated_calls.py#L88-L105 |
244,648 | crytic/slither | slither/detectors/statements/deprecated_calls.py | DeprecatedStandards.detect_deprecated_references_in_contract | def detect_deprecated_references_in_contract(self, contract):
""" Detects the usage of any deprecated built-in symbols.
Returns:
list of tuple: (state_variable | node, (detecting_signature, original_text, recommended_text))"""
results = []
for state_variable in contract.variables:
if state_variable.contract != contract:
continue
if state_variable.expression:
deprecated_results = self.detect_deprecation_in_expression(state_variable.expression)
if deprecated_results:
results.append((state_variable, deprecated_results))
# Loop through all functions + modifiers in this contract.
for function in contract.functions + contract.modifiers:
# We should only look for functions declared directly in this contract (not in a base contract).
if function.contract != contract:
continue
# Loop through each node in this function.
for node in function.nodes:
# Detect deprecated references in the node.
deprecated_results = self.detect_deprecated_references_in_node(node)
# Detect additional deprecated low-level-calls.
for ir in node.irs:
if isinstance(ir, LowLevelCall):
for dep_llc in self.DEPRECATED_LOW_LEVEL_CALLS:
if ir.function_name == dep_llc[0]:
deprecated_results.append(dep_llc)
# If we have any results from this iteration, add them to our results list.
if deprecated_results:
results.append((node, deprecated_results))
return results | python | def detect_deprecated_references_in_contract(self, contract):
results = []
for state_variable in contract.variables:
if state_variable.contract != contract:
continue
if state_variable.expression:
deprecated_results = self.detect_deprecation_in_expression(state_variable.expression)
if deprecated_results:
results.append((state_variable, deprecated_results))
# Loop through all functions + modifiers in this contract.
for function in contract.functions + contract.modifiers:
# We should only look for functions declared directly in this contract (not in a base contract).
if function.contract != contract:
continue
# Loop through each node in this function.
for node in function.nodes:
# Detect deprecated references in the node.
deprecated_results = self.detect_deprecated_references_in_node(node)
# Detect additional deprecated low-level-calls.
for ir in node.irs:
if isinstance(ir, LowLevelCall):
for dep_llc in self.DEPRECATED_LOW_LEVEL_CALLS:
if ir.function_name == dep_llc[0]:
deprecated_results.append(dep_llc)
# If we have any results from this iteration, add them to our results list.
if deprecated_results:
results.append((node, deprecated_results))
return results | [
"def",
"detect_deprecated_references_in_contract",
"(",
"self",
",",
"contract",
")",
":",
"results",
"=",
"[",
"]",
"for",
"state_variable",
"in",
"contract",
".",
"variables",
":",
"if",
"state_variable",
".",
"contract",
"!=",
"contract",
":",
"continue",
"if... | Detects the usage of any deprecated built-in symbols.
Returns:
list of tuple: (state_variable | node, (detecting_signature, original_text, recommended_text)) | [
"Detects",
"the",
"usage",
"of",
"any",
"deprecated",
"built",
"-",
"in",
"symbols",
"."
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/statements/deprecated_calls.py#L107-L144 |
244,649 | crytic/slither | slither/__main__.py | process | def process(filename, args, detector_classes, printer_classes):
"""
The core high-level code for running Slither static analysis.
Returns:
list(result), int: Result list and number of contracts analyzed
"""
ast = '--ast-compact-json'
if args.legacy_ast:
ast = '--ast-json'
args.filter_paths = parse_filter_paths(args)
slither = Slither(filename,
ast_format=ast,
**vars(args))
return _process(slither, detector_classes, printer_classes) | python | def process(filename, args, detector_classes, printer_classes):
ast = '--ast-compact-json'
if args.legacy_ast:
ast = '--ast-json'
args.filter_paths = parse_filter_paths(args)
slither = Slither(filename,
ast_format=ast,
**vars(args))
return _process(slither, detector_classes, printer_classes) | [
"def",
"process",
"(",
"filename",
",",
"args",
",",
"detector_classes",
",",
"printer_classes",
")",
":",
"ast",
"=",
"'--ast-compact-json'",
"if",
"args",
".",
"legacy_ast",
":",
"ast",
"=",
"'--ast-json'",
"args",
".",
"filter_paths",
"=",
"parse_filter_paths... | The core high-level code for running Slither static analysis.
Returns:
list(result), int: Result list and number of contracts analyzed | [
"The",
"core",
"high",
"-",
"level",
"code",
"for",
"running",
"Slither",
"static",
"analysis",
"."
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/__main__.py#L38-L53 |
244,650 | crytic/slither | slither/detectors/attributes/const_functions.py | ConstantFunctions._detect | def _detect(self):
""" Detect the constant function changing the state
Recursively visit the calls
Returns:
list: {'vuln', 'filename,'contract','func','#varsWritten'}
"""
results = []
for c in self.contracts:
for f in c.functions:
if f.contract != c:
continue
if f.view or f.pure:
if f.contains_assembly:
attr = 'view' if f.view else 'pure'
info = '{}.{} ({}) is declared {} but contains assembly code\n'
info = info.format(f.contract.name, f.name, f.source_mapping_str, attr)
json = self.generate_json_result(info)
self.add_function_to_json(f, json)
json['elements'].append({'type': 'info',
'contains_assembly' : True})
results.append(json)
variables_written = f.all_state_variables_written()
if variables_written:
attr = 'view' if f.view else 'pure'
info = '{}.{} ({}) is declared {} but changes state variables:\n'
info = info.format(f.contract.name, f.name, f.source_mapping_str, attr)
for variable_written in variables_written:
info += '\t- {}.{}\n'.format(variable_written.contract.name,
variable_written.name)
json = self.generate_json_result(info)
self.add_function_to_json(f, json)
self.add_variables_to_json(variables_written, json)
json['elements'].append({'type': 'info',
'contains_assembly' : False})
results.append(json)
return results | python | def _detect(self):
results = []
for c in self.contracts:
for f in c.functions:
if f.contract != c:
continue
if f.view or f.pure:
if f.contains_assembly:
attr = 'view' if f.view else 'pure'
info = '{}.{} ({}) is declared {} but contains assembly code\n'
info = info.format(f.contract.name, f.name, f.source_mapping_str, attr)
json = self.generate_json_result(info)
self.add_function_to_json(f, json)
json['elements'].append({'type': 'info',
'contains_assembly' : True})
results.append(json)
variables_written = f.all_state_variables_written()
if variables_written:
attr = 'view' if f.view else 'pure'
info = '{}.{} ({}) is declared {} but changes state variables:\n'
info = info.format(f.contract.name, f.name, f.source_mapping_str, attr)
for variable_written in variables_written:
info += '\t- {}.{}\n'.format(variable_written.contract.name,
variable_written.name)
json = self.generate_json_result(info)
self.add_function_to_json(f, json)
self.add_variables_to_json(variables_written, json)
json['elements'].append({'type': 'info',
'contains_assembly' : False})
results.append(json)
return results | [
"def",
"_detect",
"(",
"self",
")",
":",
"results",
"=",
"[",
"]",
"for",
"c",
"in",
"self",
".",
"contracts",
":",
"for",
"f",
"in",
"c",
".",
"functions",
":",
"if",
"f",
".",
"contract",
"!=",
"c",
":",
"continue",
"if",
"f",
".",
"view",
"o... | Detect the constant function changing the state
Recursively visit the calls
Returns:
list: {'vuln', 'filename,'contract','func','#varsWritten'} | [
"Detect",
"the",
"constant",
"function",
"changing",
"the",
"state"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/detectors/attributes/const_functions.py#L44-L84 |
244,651 | crytic/slither | slither/core/declarations/contract.py | Contract.constructor | def constructor(self):
'''
Return the contract's immediate constructor.
If there is no immediate constructor, returns the first constructor
executed, following the c3 linearization
Return None if there is no constructor.
'''
cst = self.constructor_not_inherited
if cst:
return cst
for inherited_contract in self.inheritance:
cst = inherited_contract.constructor_not_inherited
if cst:
return cst
return None | python | def constructor(self):
'''
Return the contract's immediate constructor.
If there is no immediate constructor, returns the first constructor
executed, following the c3 linearization
Return None if there is no constructor.
'''
cst = self.constructor_not_inherited
if cst:
return cst
for inherited_contract in self.inheritance:
cst = inherited_contract.constructor_not_inherited
if cst:
return cst
return None | [
"def",
"constructor",
"(",
"self",
")",
":",
"cst",
"=",
"self",
".",
"constructor_not_inherited",
"if",
"cst",
":",
"return",
"cst",
"for",
"inherited_contract",
"in",
"self",
".",
"inheritance",
":",
"cst",
"=",
"inherited_contract",
".",
"constructor_not_inhe... | Return the contract's immediate constructor.
If there is no immediate constructor, returns the first constructor
executed, following the c3 linearization
Return None if there is no constructor. | [
"Return",
"the",
"contract",
"s",
"immediate",
"constructor",
".",
"If",
"there",
"is",
"no",
"immediate",
"constructor",
"returns",
"the",
"first",
"constructor",
"executed",
"following",
"the",
"c3",
"linearization",
"Return",
"None",
"if",
"there",
"is",
"no"... | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/contract.py#L168-L182 |
244,652 | crytic/slither | slither/core/declarations/contract.py | Contract.get_functions_reading_from_variable | def get_functions_reading_from_variable(self, variable):
'''
Return the functions reading the variable
'''
return [f for f in self.functions if f.is_reading(variable)] | python | def get_functions_reading_from_variable(self, variable):
'''
Return the functions reading the variable
'''
return [f for f in self.functions if f.is_reading(variable)] | [
"def",
"get_functions_reading_from_variable",
"(",
"self",
",",
"variable",
")",
":",
"return",
"[",
"f",
"for",
"f",
"in",
"self",
".",
"functions",
"if",
"f",
".",
"is_reading",
"(",
"variable",
")",
"]"
] | Return the functions reading the variable | [
"Return",
"the",
"functions",
"reading",
"the",
"variable"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/contract.py#L339-L343 |
244,653 | crytic/slither | slither/core/declarations/contract.py | Contract.get_functions_writing_to_variable | def get_functions_writing_to_variable(self, variable):
'''
Return the functions writting the variable
'''
return [f for f in self.functions if f.is_writing(variable)] | python | def get_functions_writing_to_variable(self, variable):
'''
Return the functions writting the variable
'''
return [f for f in self.functions if f.is_writing(variable)] | [
"def",
"get_functions_writing_to_variable",
"(",
"self",
",",
"variable",
")",
":",
"return",
"[",
"f",
"for",
"f",
"in",
"self",
".",
"functions",
"if",
"f",
".",
"is_writing",
"(",
"variable",
")",
"]"
] | Return the functions writting the variable | [
"Return",
"the",
"functions",
"writting",
"the",
"variable"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/contract.py#L345-L349 |
244,654 | crytic/slither | slither/core/declarations/contract.py | Contract.get_source_var_declaration | def get_source_var_declaration(self, var):
""" Return the source mapping where the variable is declared
Args:
var (str): variable name
Returns:
(dict): sourceMapping
"""
return next((x.source_mapping for x in self.variables if x.name == var)) | python | def get_source_var_declaration(self, var):
return next((x.source_mapping for x in self.variables if x.name == var)) | [
"def",
"get_source_var_declaration",
"(",
"self",
",",
"var",
")",
":",
"return",
"next",
"(",
"(",
"x",
".",
"source_mapping",
"for",
"x",
"in",
"self",
".",
"variables",
"if",
"x",
".",
"name",
"==",
"var",
")",
")"
] | Return the source mapping where the variable is declared
Args:
var (str): variable name
Returns:
(dict): sourceMapping | [
"Return",
"the",
"source",
"mapping",
"where",
"the",
"variable",
"is",
"declared"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/contract.py#L351-L359 |
244,655 | crytic/slither | slither/core/declarations/contract.py | Contract.get_source_event_declaration | def get_source_event_declaration(self, event):
""" Return the source mapping where the event is declared
Args:
event (str): event name
Returns:
(dict): sourceMapping
"""
return next((x.source_mapping for x in self.events if x.name == event)) | python | def get_source_event_declaration(self, event):
return next((x.source_mapping for x in self.events if x.name == event)) | [
"def",
"get_source_event_declaration",
"(",
"self",
",",
"event",
")",
":",
"return",
"next",
"(",
"(",
"x",
".",
"source_mapping",
"for",
"x",
"in",
"self",
".",
"events",
"if",
"x",
".",
"name",
"==",
"event",
")",
")"
] | Return the source mapping where the event is declared
Args:
event (str): event name
Returns:
(dict): sourceMapping | [
"Return",
"the",
"source",
"mapping",
"where",
"the",
"event",
"is",
"declared"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/contract.py#L361-L369 |
244,656 | crytic/slither | slither/core/declarations/contract.py | Contract.get_summary | def get_summary(self):
""" Return the function summary
Returns:
(str, list, list, list, list): (name, inheritance, variables, fuction summaries, modifier summaries)
"""
func_summaries = [f.get_summary() for f in self.functions]
modif_summaries = [f.get_summary() for f in self.modifiers]
return (self.name, [str(x) for x in self.inheritance], [str(x) for x in self.variables], func_summaries, modif_summaries) | python | def get_summary(self):
func_summaries = [f.get_summary() for f in self.functions]
modif_summaries = [f.get_summary() for f in self.modifiers]
return (self.name, [str(x) for x in self.inheritance], [str(x) for x in self.variables], func_summaries, modif_summaries) | [
"def",
"get_summary",
"(",
"self",
")",
":",
"func_summaries",
"=",
"[",
"f",
".",
"get_summary",
"(",
")",
"for",
"f",
"in",
"self",
".",
"functions",
"]",
"modif_summaries",
"=",
"[",
"f",
".",
"get_summary",
"(",
")",
"for",
"f",
"in",
"self",
"."... | Return the function summary
Returns:
(str, list, list, list, list): (name, inheritance, variables, fuction summaries, modifier summaries) | [
"Return",
"the",
"function",
"summary"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/contract.py#L512-L520 |
244,657 | crytic/slither | slither/core/declarations/contract.py | Contract.is_erc20 | def is_erc20(self):
"""
Check if the contract is an erc20 token
Note: it does not check for correct return values
Returns:
bool
"""
full_names = [f.full_name for f in self.functions]
return 'transfer(address,uint256)' in full_names and\
'transferFrom(address,address,uint256)' in full_names and\
'approve(address,uint256)' in full_names | python | def is_erc20(self):
full_names = [f.full_name for f in self.functions]
return 'transfer(address,uint256)' in full_names and\
'transferFrom(address,address,uint256)' in full_names and\
'approve(address,uint256)' in full_names | [
"def",
"is_erc20",
"(",
"self",
")",
":",
"full_names",
"=",
"[",
"f",
".",
"full_name",
"for",
"f",
"in",
"self",
".",
"functions",
"]",
"return",
"'transfer(address,uint256)'",
"in",
"full_names",
"and",
"'transferFrom(address,address,uint256)'",
"in",
"full_nam... | Check if the contract is an erc20 token
Note: it does not check for correct return values
Returns:
bool | [
"Check",
"if",
"the",
"contract",
"is",
"an",
"erc20",
"token"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/contract.py#L530-L541 |
244,658 | crytic/slither | slither/slithir/convert.py | integrate_value_gas | def integrate_value_gas(result):
'''
Integrate value and gas temporary arguments to call instruction
'''
was_changed = True
calls = []
while was_changed:
# We loop until we do not find any call to value or gas
was_changed = False
# Find all the assignments
assigments = {}
for i in result:
if isinstance(i, OperationWithLValue):
assigments[i.lvalue.name] = i
if isinstance(i, TmpCall):
if isinstance(i.called, Variable) and i.called.name in assigments:
ins_ori = assigments[i.called.name]
i.set_ori(ins_ori)
to_remove = []
variable_to_replace = {}
# Replace call to value, gas to an argument of the real call
for idx in range(len(result)):
ins = result[idx]
# value can be shadowed, so we check that the prev ins
# is an Argument
if is_value(ins) and isinstance(result[idx-1], Argument):
was_changed = True
result[idx-1].set_type(ArgumentType.VALUE)
result[idx-1].call_id = ins.ori.variable_left.name
calls.append(ins.ori.variable_left)
to_remove.append(ins)
variable_to_replace[ins.lvalue.name] = ins.ori.variable_left
elif is_gas(ins) and isinstance(result[idx-1], Argument):
was_changed = True
result[idx-1].set_type(ArgumentType.GAS)
result[idx-1].call_id = ins.ori.variable_left.name
calls.append(ins.ori.variable_left)
to_remove.append(ins)
variable_to_replace[ins.lvalue.name] = ins.ori.variable_left
# Remove the call to value/gas instruction
result = [i for i in result if not i in to_remove]
# update the real call
for ins in result:
if isinstance(ins, TmpCall):
# use of while if there redirections
while ins.called.name in variable_to_replace:
was_changed = True
ins.call_id = variable_to_replace[ins.called.name].name
calls.append(ins.called)
ins.called = variable_to_replace[ins.called.name]
if isinstance(ins, Argument):
while ins.call_id in variable_to_replace:
was_changed = True
ins.call_id = variable_to_replace[ins.call_id].name
calls = list(set([str(c) for c in calls]))
idx = 0
calls_d = {}
for call in calls:
calls_d[str(call)] = idx
idx = idx+1
return result | python | def integrate_value_gas(result):
'''
Integrate value and gas temporary arguments to call instruction
'''
was_changed = True
calls = []
while was_changed:
# We loop until we do not find any call to value or gas
was_changed = False
# Find all the assignments
assigments = {}
for i in result:
if isinstance(i, OperationWithLValue):
assigments[i.lvalue.name] = i
if isinstance(i, TmpCall):
if isinstance(i.called, Variable) and i.called.name in assigments:
ins_ori = assigments[i.called.name]
i.set_ori(ins_ori)
to_remove = []
variable_to_replace = {}
# Replace call to value, gas to an argument of the real call
for idx in range(len(result)):
ins = result[idx]
# value can be shadowed, so we check that the prev ins
# is an Argument
if is_value(ins) and isinstance(result[idx-1], Argument):
was_changed = True
result[idx-1].set_type(ArgumentType.VALUE)
result[idx-1].call_id = ins.ori.variable_left.name
calls.append(ins.ori.variable_left)
to_remove.append(ins)
variable_to_replace[ins.lvalue.name] = ins.ori.variable_left
elif is_gas(ins) and isinstance(result[idx-1], Argument):
was_changed = True
result[idx-1].set_type(ArgumentType.GAS)
result[idx-1].call_id = ins.ori.variable_left.name
calls.append(ins.ori.variable_left)
to_remove.append(ins)
variable_to_replace[ins.lvalue.name] = ins.ori.variable_left
# Remove the call to value/gas instruction
result = [i for i in result if not i in to_remove]
# update the real call
for ins in result:
if isinstance(ins, TmpCall):
# use of while if there redirections
while ins.called.name in variable_to_replace:
was_changed = True
ins.call_id = variable_to_replace[ins.called.name].name
calls.append(ins.called)
ins.called = variable_to_replace[ins.called.name]
if isinstance(ins, Argument):
while ins.call_id in variable_to_replace:
was_changed = True
ins.call_id = variable_to_replace[ins.call_id].name
calls = list(set([str(c) for c in calls]))
idx = 0
calls_d = {}
for call in calls:
calls_d[str(call)] = idx
idx = idx+1
return result | [
"def",
"integrate_value_gas",
"(",
"result",
")",
":",
"was_changed",
"=",
"True",
"calls",
"=",
"[",
"]",
"while",
"was_changed",
":",
"# We loop until we do not find any call to value or gas",
"was_changed",
"=",
"False",
"# Find all the assignments",
"assigments",
"=",... | Integrate value and gas temporary arguments to call instruction | [
"Integrate",
"value",
"and",
"gas",
"temporary",
"arguments",
"to",
"call",
"instruction"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/slithir/convert.py#L144-L213 |
244,659 | crytic/slither | slither/slithir/convert.py | propagate_type_and_convert_call | def propagate_type_and_convert_call(result, node):
'''
Propagate the types variables and convert tmp call to real call operation
'''
calls_value = {}
calls_gas = {}
call_data = []
idx = 0
# use of while len() as result can be modified during the iteration
while idx < len(result):
ins = result[idx]
if isinstance(ins, TmpCall):
new_ins = extract_tmp_call(ins, node.function.contract)
if new_ins:
new_ins.set_node(ins.node)
ins = new_ins
result[idx] = ins
if isinstance(ins, Argument):
if ins.get_type() in [ArgumentType.GAS]:
assert not ins.call_id in calls_gas
calls_gas[ins.call_id] = ins.argument
elif ins.get_type() in [ArgumentType.VALUE]:
assert not ins.call_id in calls_value
calls_value[ins.call_id] = ins.argument
else:
assert ins.get_type() == ArgumentType.CALL
call_data.append(ins.argument)
if isinstance(ins, (HighLevelCall, NewContract, InternalDynamicCall)):
if ins.call_id in calls_value:
ins.call_value = calls_value[ins.call_id]
if ins.call_id in calls_gas:
ins.call_gas = calls_gas[ins.call_id]
if isinstance(ins, (Call, NewContract, NewStructure)):
ins.arguments = call_data
call_data = []
if is_temporary(ins):
del result[idx]
continue
new_ins = propagate_types(ins, node)
if new_ins:
if isinstance(new_ins, (list,)):
if len(new_ins) == 2:
new_ins[0].set_node(ins.node)
new_ins[1].set_node(ins.node)
del result[idx]
result.insert(idx, new_ins[0])
result.insert(idx+1, new_ins[1])
idx = idx + 1
else:
assert len(new_ins) == 3
new_ins[0].set_node(ins.node)
new_ins[1].set_node(ins.node)
new_ins[2].set_node(ins.node)
del result[idx]
result.insert(idx, new_ins[0])
result.insert(idx+1, new_ins[1])
result.insert(idx+2, new_ins[2])
idx = idx + 2
else:
new_ins.set_node(ins.node)
result[idx] = new_ins
idx = idx +1
return result | python | def propagate_type_and_convert_call(result, node):
'''
Propagate the types variables and convert tmp call to real call operation
'''
calls_value = {}
calls_gas = {}
call_data = []
idx = 0
# use of while len() as result can be modified during the iteration
while idx < len(result):
ins = result[idx]
if isinstance(ins, TmpCall):
new_ins = extract_tmp_call(ins, node.function.contract)
if new_ins:
new_ins.set_node(ins.node)
ins = new_ins
result[idx] = ins
if isinstance(ins, Argument):
if ins.get_type() in [ArgumentType.GAS]:
assert not ins.call_id in calls_gas
calls_gas[ins.call_id] = ins.argument
elif ins.get_type() in [ArgumentType.VALUE]:
assert not ins.call_id in calls_value
calls_value[ins.call_id] = ins.argument
else:
assert ins.get_type() == ArgumentType.CALL
call_data.append(ins.argument)
if isinstance(ins, (HighLevelCall, NewContract, InternalDynamicCall)):
if ins.call_id in calls_value:
ins.call_value = calls_value[ins.call_id]
if ins.call_id in calls_gas:
ins.call_gas = calls_gas[ins.call_id]
if isinstance(ins, (Call, NewContract, NewStructure)):
ins.arguments = call_data
call_data = []
if is_temporary(ins):
del result[idx]
continue
new_ins = propagate_types(ins, node)
if new_ins:
if isinstance(new_ins, (list,)):
if len(new_ins) == 2:
new_ins[0].set_node(ins.node)
new_ins[1].set_node(ins.node)
del result[idx]
result.insert(idx, new_ins[0])
result.insert(idx+1, new_ins[1])
idx = idx + 1
else:
assert len(new_ins) == 3
new_ins[0].set_node(ins.node)
new_ins[1].set_node(ins.node)
new_ins[2].set_node(ins.node)
del result[idx]
result.insert(idx, new_ins[0])
result.insert(idx+1, new_ins[1])
result.insert(idx+2, new_ins[2])
idx = idx + 2
else:
new_ins.set_node(ins.node)
result[idx] = new_ins
idx = idx +1
return result | [
"def",
"propagate_type_and_convert_call",
"(",
"result",
",",
"node",
")",
":",
"calls_value",
"=",
"{",
"}",
"calls_gas",
"=",
"{",
"}",
"call_data",
"=",
"[",
"]",
"idx",
"=",
"0",
"# use of while len() as result can be modified during the iteration",
"while",
"id... | Propagate the types variables and convert tmp call to real call operation | [
"Propagate",
"the",
"types",
"variables",
"and",
"convert",
"tmp",
"call",
"to",
"real",
"call",
"operation"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/slithir/convert.py#L222-L292 |
244,660 | crytic/slither | slither/slithir/convert.py | convert_to_push | def convert_to_push(ir, node):
"""
Convert a call to a PUSH operaiton
The funciton assume to receive a correct IR
The checks must be done by the caller
May necessitate to create an intermediate operation (InitArray)
Necessitate to return the lenght (see push documentation)
As a result, the function return may return a list
"""
lvalue = ir.lvalue
if isinstance(ir.arguments[0], list):
ret = []
val = TemporaryVariable(node)
operation = InitArray(ir.arguments[0], val)
ret.append(operation)
ir = Push(ir.destination, val)
length = Literal(len(operation.init_values))
t = operation.init_values[0].type
ir.lvalue.set_type(ArrayType(t, length))
ret.append(ir)
if lvalue:
length = Length(ir.array, lvalue)
length.lvalue.points_to = ir.lvalue
ret.append(length)
return ret
ir = Push(ir.destination, ir.arguments[0])
if lvalue:
ret = []
ret.append(ir)
length = Length(ir.array, lvalue)
length.lvalue.points_to = ir.lvalue
ret.append(length)
return ret
return ir | python | def convert_to_push(ir, node):
lvalue = ir.lvalue
if isinstance(ir.arguments[0], list):
ret = []
val = TemporaryVariable(node)
operation = InitArray(ir.arguments[0], val)
ret.append(operation)
ir = Push(ir.destination, val)
length = Literal(len(operation.init_values))
t = operation.init_values[0].type
ir.lvalue.set_type(ArrayType(t, length))
ret.append(ir)
if lvalue:
length = Length(ir.array, lvalue)
length.lvalue.points_to = ir.lvalue
ret.append(length)
return ret
ir = Push(ir.destination, ir.arguments[0])
if lvalue:
ret = []
ret.append(ir)
length = Length(ir.array, lvalue)
length.lvalue.points_to = ir.lvalue
ret.append(length)
return ret
return ir | [
"def",
"convert_to_push",
"(",
"ir",
",",
"node",
")",
":",
"lvalue",
"=",
"ir",
".",
"lvalue",
"if",
"isinstance",
"(",
"ir",
".",
"arguments",
"[",
"0",
"]",
",",
"list",
")",
":",
"ret",
"=",
"[",
"]",
"val",
"=",
"TemporaryVariable",
"(",
"node... | Convert a call to a PUSH operaiton
The funciton assume to receive a correct IR
The checks must be done by the caller
May necessitate to create an intermediate operation (InitArray)
Necessitate to return the lenght (see push documentation)
As a result, the function return may return a list | [
"Convert",
"a",
"call",
"to",
"a",
"PUSH",
"operaiton"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/slithir/convert.py#L579-L626 |
244,661 | crytic/slither | slither/slithir/convert.py | get_type | def get_type(t):
"""
Convert a type to a str
If the instance is a Contract, return 'address' instead
"""
if isinstance(t, UserDefinedType):
if isinstance(t.type, Contract):
return 'address'
return str(t) | python | def get_type(t):
if isinstance(t, UserDefinedType):
if isinstance(t.type, Contract):
return 'address'
return str(t) | [
"def",
"get_type",
"(",
"t",
")",
":",
"if",
"isinstance",
"(",
"t",
",",
"UserDefinedType",
")",
":",
"if",
"isinstance",
"(",
"t",
".",
"type",
",",
"Contract",
")",
":",
"return",
"'address'",
"return",
"str",
"(",
"t",
")"
] | Convert a type to a str
If the instance is a Contract, return 'address' instead | [
"Convert",
"a",
"type",
"to",
"a",
"str",
"If",
"the",
"instance",
"is",
"a",
"Contract",
"return",
"address",
"instead"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/slithir/convert.py#L661-L669 |
244,662 | crytic/slither | slither/slithir/convert.py | find_references_origin | def find_references_origin(irs):
"""
Make lvalue of each Index, Member operation
points to the left variable
"""
for ir in irs:
if isinstance(ir, (Index, Member)):
ir.lvalue.points_to = ir.variable_left | python | def find_references_origin(irs):
for ir in irs:
if isinstance(ir, (Index, Member)):
ir.lvalue.points_to = ir.variable_left | [
"def",
"find_references_origin",
"(",
"irs",
")",
":",
"for",
"ir",
"in",
"irs",
":",
"if",
"isinstance",
"(",
"ir",
",",
"(",
"Index",
",",
"Member",
")",
")",
":",
"ir",
".",
"lvalue",
".",
"points_to",
"=",
"ir",
".",
"variable_left"
] | Make lvalue of each Index, Member operation
points to the left variable | [
"Make",
"lvalue",
"of",
"each",
"Index",
"Member",
"operation",
"points",
"to",
"the",
"left",
"variable"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/slithir/convert.py#L768-L775 |
244,663 | crytic/slither | slither/slithir/convert.py | apply_ir_heuristics | def apply_ir_heuristics(irs, node):
"""
Apply a set of heuristic to improve slithIR
"""
irs = integrate_value_gas(irs)
irs = propagate_type_and_convert_call(irs, node)
irs = remove_unused(irs)
find_references_origin(irs)
return irs | python | def apply_ir_heuristics(irs, node):
irs = integrate_value_gas(irs)
irs = propagate_type_and_convert_call(irs, node)
irs = remove_unused(irs)
find_references_origin(irs)
return irs | [
"def",
"apply_ir_heuristics",
"(",
"irs",
",",
"node",
")",
":",
"irs",
"=",
"integrate_value_gas",
"(",
"irs",
")",
"irs",
"=",
"propagate_type_and_convert_call",
"(",
"irs",
",",
"node",
")",
"irs",
"=",
"remove_unused",
"(",
"irs",
")",
"find_references_ori... | Apply a set of heuristic to improve slithIR | [
"Apply",
"a",
"set",
"of",
"heuristic",
"to",
"improve",
"slithIR"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/slithir/convert.py#L832-L844 |
244,664 | crytic/slither | slither/core/declarations/function.py | Function.return_type | def return_type(self):
"""
Return the list of return type
If no return, return None
"""
returns = self.returns
if returns:
return [r.type for r in returns]
return None | python | def return_type(self):
returns = self.returns
if returns:
return [r.type for r in returns]
return None | [
"def",
"return_type",
"(",
"self",
")",
":",
"returns",
"=",
"self",
".",
"returns",
"if",
"returns",
":",
"return",
"[",
"r",
".",
"type",
"for",
"r",
"in",
"returns",
"]",
"return",
"None"
] | Return the list of return type
If no return, return None | [
"Return",
"the",
"list",
"of",
"return",
"type",
"If",
"no",
"return",
"return",
"None"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/function.py#L249-L257 |
244,665 | crytic/slither | slither/core/declarations/function.py | Function.all_solidity_variables_read | def all_solidity_variables_read(self):
""" recursive version of solidity_read
"""
if self._all_solidity_variables_read is None:
self._all_solidity_variables_read = self._explore_functions(
lambda x: x.solidity_variables_read)
return self._all_solidity_variables_read | python | def all_solidity_variables_read(self):
if self._all_solidity_variables_read is None:
self._all_solidity_variables_read = self._explore_functions(
lambda x: x.solidity_variables_read)
return self._all_solidity_variables_read | [
"def",
"all_solidity_variables_read",
"(",
"self",
")",
":",
"if",
"self",
".",
"_all_solidity_variables_read",
"is",
"None",
":",
"self",
".",
"_all_solidity_variables_read",
"=",
"self",
".",
"_explore_functions",
"(",
"lambda",
"x",
":",
"x",
".",
"solidity_var... | recursive version of solidity_read | [
"recursive",
"version",
"of",
"solidity_read"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/function.py#L629-L635 |
244,666 | crytic/slither | slither/core/declarations/function.py | Function.all_state_variables_written | def all_state_variables_written(self):
""" recursive version of variables_written
"""
if self._all_state_variables_written is None:
self._all_state_variables_written = self._explore_functions(
lambda x: x.state_variables_written)
return self._all_state_variables_written | python | def all_state_variables_written(self):
if self._all_state_variables_written is None:
self._all_state_variables_written = self._explore_functions(
lambda x: x.state_variables_written)
return self._all_state_variables_written | [
"def",
"all_state_variables_written",
"(",
"self",
")",
":",
"if",
"self",
".",
"_all_state_variables_written",
"is",
"None",
":",
"self",
".",
"_all_state_variables_written",
"=",
"self",
".",
"_explore_functions",
"(",
"lambda",
"x",
":",
"x",
".",
"state_variab... | recursive version of variables_written | [
"recursive",
"version",
"of",
"variables_written"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/function.py#L651-L657 |
244,667 | crytic/slither | slither/core/declarations/function.py | Function.all_internal_calls | def all_internal_calls(self):
""" recursive version of internal_calls
"""
if self._all_internals_calls is None:
self._all_internals_calls = self._explore_functions(lambda x: x.internal_calls)
return self._all_internals_calls | python | def all_internal_calls(self):
if self._all_internals_calls is None:
self._all_internals_calls = self._explore_functions(lambda x: x.internal_calls)
return self._all_internals_calls | [
"def",
"all_internal_calls",
"(",
"self",
")",
":",
"if",
"self",
".",
"_all_internals_calls",
"is",
"None",
":",
"self",
".",
"_all_internals_calls",
"=",
"self",
".",
"_explore_functions",
"(",
"lambda",
"x",
":",
"x",
".",
"internal_calls",
")",
"return",
... | recursive version of internal_calls | [
"recursive",
"version",
"of",
"internal_calls"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/function.py#L659-L664 |
244,668 | crytic/slither | slither/core/declarations/function.py | Function.all_low_level_calls | def all_low_level_calls(self):
""" recursive version of low_level calls
"""
if self._all_low_level_calls is None:
self._all_low_level_calls = self._explore_functions(lambda x: x.low_level_calls)
return self._all_low_level_calls | python | def all_low_level_calls(self):
if self._all_low_level_calls is None:
self._all_low_level_calls = self._explore_functions(lambda x: x.low_level_calls)
return self._all_low_level_calls | [
"def",
"all_low_level_calls",
"(",
"self",
")",
":",
"if",
"self",
".",
"_all_low_level_calls",
"is",
"None",
":",
"self",
".",
"_all_low_level_calls",
"=",
"self",
".",
"_explore_functions",
"(",
"lambda",
"x",
":",
"x",
".",
"low_level_calls",
")",
"return",... | recursive version of low_level calls | [
"recursive",
"version",
"of",
"low_level",
"calls"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/function.py#L666-L671 |
244,669 | crytic/slither | slither/core/declarations/function.py | Function.all_high_level_calls | def all_high_level_calls(self):
""" recursive version of high_level calls
"""
if self._all_high_level_calls is None:
self._all_high_level_calls = self._explore_functions(lambda x: x.high_level_calls)
return self._all_high_level_calls | python | def all_high_level_calls(self):
if self._all_high_level_calls is None:
self._all_high_level_calls = self._explore_functions(lambda x: x.high_level_calls)
return self._all_high_level_calls | [
"def",
"all_high_level_calls",
"(",
"self",
")",
":",
"if",
"self",
".",
"_all_high_level_calls",
"is",
"None",
":",
"self",
".",
"_all_high_level_calls",
"=",
"self",
".",
"_explore_functions",
"(",
"lambda",
"x",
":",
"x",
".",
"high_level_calls",
")",
"retu... | recursive version of high_level calls | [
"recursive",
"version",
"of",
"high_level",
"calls"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/function.py#L673-L678 |
244,670 | crytic/slither | slither/core/declarations/function.py | Function.all_library_calls | def all_library_calls(self):
""" recursive version of library calls
"""
if self._all_library_calls is None:
self._all_library_calls = self._explore_functions(lambda x: x.library_calls)
return self._all_library_calls | python | def all_library_calls(self):
if self._all_library_calls is None:
self._all_library_calls = self._explore_functions(lambda x: x.library_calls)
return self._all_library_calls | [
"def",
"all_library_calls",
"(",
"self",
")",
":",
"if",
"self",
".",
"_all_library_calls",
"is",
"None",
":",
"self",
".",
"_all_library_calls",
"=",
"self",
".",
"_explore_functions",
"(",
"lambda",
"x",
":",
"x",
".",
"library_calls",
")",
"return",
"self... | recursive version of library calls | [
"recursive",
"version",
"of",
"library",
"calls"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/function.py#L680-L685 |
244,671 | crytic/slither | slither/core/declarations/function.py | Function.all_conditional_state_variables_read | def all_conditional_state_variables_read(self, include_loop=True):
"""
Return the state variable used in a condition
Over approximate and also return index access
It won't work if the variable is assigned to a temp variable
"""
if include_loop:
if self._all_conditional_state_variables_read_with_loop is None:
self._all_conditional_state_variables_read_with_loop = self._explore_functions(
lambda x: self._explore_func_cond_read(x,
include_loop))
return self._all_conditional_state_variables_read_with_loop
else:
if self._all_conditional_state_variables_read is None:
self._all_conditional_state_variables_read = self._explore_functions(
lambda x: self._explore_func_cond_read(x,
include_loop))
return self._all_conditional_state_variables_read | python | def all_conditional_state_variables_read(self, include_loop=True):
if include_loop:
if self._all_conditional_state_variables_read_with_loop is None:
self._all_conditional_state_variables_read_with_loop = self._explore_functions(
lambda x: self._explore_func_cond_read(x,
include_loop))
return self._all_conditional_state_variables_read_with_loop
else:
if self._all_conditional_state_variables_read is None:
self._all_conditional_state_variables_read = self._explore_functions(
lambda x: self._explore_func_cond_read(x,
include_loop))
return self._all_conditional_state_variables_read | [
"def",
"all_conditional_state_variables_read",
"(",
"self",
",",
"include_loop",
"=",
"True",
")",
":",
"if",
"include_loop",
":",
"if",
"self",
".",
"_all_conditional_state_variables_read_with_loop",
"is",
"None",
":",
"self",
".",
"_all_conditional_state_variables_read_... | Return the state variable used in a condition
Over approximate and also return index access
It won't work if the variable is assigned to a temp variable | [
"Return",
"the",
"state",
"variable",
"used",
"in",
"a",
"condition"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/function.py#L692-L710 |
244,672 | crytic/slither | slither/core/declarations/function.py | Function.all_conditional_solidity_variables_read | def all_conditional_solidity_variables_read(self, include_loop=True):
"""
Return the Soldiity variables directly used in a condtion
Use of the IR to filter index access
Assumption: the solidity vars are used directly in the conditional node
It won't work if the variable is assigned to a temp variable
"""
if include_loop:
if self._all_conditional_solidity_variables_read_with_loop is None:
self._all_conditional_solidity_variables_read_with_loop = self._explore_functions(
lambda x: self._explore_func_conditional(x,
self._solidity_variable_in_binary,
include_loop))
return self._all_conditional_solidity_variables_read_with_loop
else:
if self._all_conditional_solidity_variables_read is None:
self._all_conditional_solidity_variables_read = self._explore_functions(
lambda x: self._explore_func_conditional(x,
self._solidity_variable_in_binary,
include_loop))
return self._all_conditional_solidity_variables_read | python | def all_conditional_solidity_variables_read(self, include_loop=True):
if include_loop:
if self._all_conditional_solidity_variables_read_with_loop is None:
self._all_conditional_solidity_variables_read_with_loop = self._explore_functions(
lambda x: self._explore_func_conditional(x,
self._solidity_variable_in_binary,
include_loop))
return self._all_conditional_solidity_variables_read_with_loop
else:
if self._all_conditional_solidity_variables_read is None:
self._all_conditional_solidity_variables_read = self._explore_functions(
lambda x: self._explore_func_conditional(x,
self._solidity_variable_in_binary,
include_loop))
return self._all_conditional_solidity_variables_read | [
"def",
"all_conditional_solidity_variables_read",
"(",
"self",
",",
"include_loop",
"=",
"True",
")",
":",
"if",
"include_loop",
":",
"if",
"self",
".",
"_all_conditional_solidity_variables_read_with_loop",
"is",
"None",
":",
"self",
".",
"_all_conditional_solidity_variab... | Return the Soldiity variables directly used in a condtion
Use of the IR to filter index access
Assumption: the solidity vars are used directly in the conditional node
It won't work if the variable is assigned to a temp variable | [
"Return",
"the",
"Soldiity",
"variables",
"directly",
"used",
"in",
"a",
"condtion"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/function.py#L726-L747 |
244,673 | crytic/slither | slither/core/declarations/function.py | Function.all_solidity_variables_used_as_args | def all_solidity_variables_used_as_args(self):
"""
Return the Soldiity variables directly used in a call
Use of the IR to filter index access
Used to catch check(msg.sender)
"""
if self._all_solidity_variables_used_as_args is None:
self._all_solidity_variables_used_as_args = self._explore_functions(
lambda x: self._explore_func_nodes(x, self._solidity_variable_in_internal_calls))
return self._all_solidity_variables_used_as_args | python | def all_solidity_variables_used_as_args(self):
if self._all_solidity_variables_used_as_args is None:
self._all_solidity_variables_used_as_args = self._explore_functions(
lambda x: self._explore_func_nodes(x, self._solidity_variable_in_internal_calls))
return self._all_solidity_variables_used_as_args | [
"def",
"all_solidity_variables_used_as_args",
"(",
"self",
")",
":",
"if",
"self",
".",
"_all_solidity_variables_used_as_args",
"is",
"None",
":",
"self",
".",
"_all_solidity_variables_used_as_args",
"=",
"self",
".",
"_explore_functions",
"(",
"lambda",
"x",
":",
"se... | Return the Soldiity variables directly used in a call
Use of the IR to filter index access
Used to catch check(msg.sender) | [
"Return",
"the",
"Soldiity",
"variables",
"directly",
"used",
"in",
"a",
"call"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/function.py#L763-L773 |
244,674 | crytic/slither | slither/core/declarations/function.py | Function.is_protected | def is_protected(self):
"""
Determine if the function is protected using a check on msg.sender
Only detects if msg.sender is directly used in a condition
For example, it wont work for:
address a = msg.sender
require(a == owner)
Returns
(bool)
"""
if self.is_constructor:
return True
conditional_vars = self.all_conditional_solidity_variables_read(include_loop=False)
args_vars = self.all_solidity_variables_used_as_args()
return SolidityVariableComposed('msg.sender') in conditional_vars + args_vars | python | def is_protected(self):
if self.is_constructor:
return True
conditional_vars = self.all_conditional_solidity_variables_read(include_loop=False)
args_vars = self.all_solidity_variables_used_as_args()
return SolidityVariableComposed('msg.sender') in conditional_vars + args_vars | [
"def",
"is_protected",
"(",
"self",
")",
":",
"if",
"self",
".",
"is_constructor",
":",
"return",
"True",
"conditional_vars",
"=",
"self",
".",
"all_conditional_solidity_variables_read",
"(",
"include_loop",
"=",
"False",
")",
"args_vars",
"=",
"self",
".",
"all... | Determine if the function is protected using a check on msg.sender
Only detects if msg.sender is directly used in a condition
For example, it wont work for:
address a = msg.sender
require(a == owner)
Returns
(bool) | [
"Determine",
"if",
"the",
"function",
"is",
"protected",
"using",
"a",
"check",
"on",
"msg",
".",
"sender"
] | 04c147f7e50223c6af458ca430befae747ccd259 | https://github.com/crytic/slither/blob/04c147f7e50223c6af458ca430befae747ccd259/slither/core/declarations/function.py#L940-L956 |
244,675 | TheHive-Project/Cortex-Analyzers | analyzers/SoltraEdge/soltra.py | SoltraEdge.auth_string | def auth_string(self):
'''
Authenticate based on username and token which is base64-encoded
'''
username_token = '{username}:{token}'.format(username=self.username, token=self.token)
b64encoded_string = b64encode(username_token)
auth_string = 'Token {b64}'.format(b64=b64encoded_string)
return auth_string | python | def auth_string(self):
'''
Authenticate based on username and token which is base64-encoded
'''
username_token = '{username}:{token}'.format(username=self.username, token=self.token)
b64encoded_string = b64encode(username_token)
auth_string = 'Token {b64}'.format(b64=b64encoded_string)
return auth_string | [
"def",
"auth_string",
"(",
"self",
")",
":",
"username_token",
"=",
"'{username}:{token}'",
".",
"format",
"(",
"username",
"=",
"self",
".",
"username",
",",
"token",
"=",
"self",
".",
"token",
")",
"b64encoded_string",
"=",
"b64encode",
"(",
"username_token"... | Authenticate based on username and token which is base64-encoded | [
"Authenticate",
"based",
"on",
"username",
"and",
"token",
"which",
"is",
"base64",
"-",
"encoded"
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/SoltraEdge/soltra.py#L27-L36 |
244,676 | TheHive-Project/Cortex-Analyzers | analyzers/SoltraEdge/soltra.py | SoltraEdge.api_related | def api_related(self, query):
'''
Find related objects through SoltraEdge API
'''
url = "{0}/{1}/related/?format=json".format(self.base_url, query)
response = requests.get(url, headers=self.headers, verify=self.verify_ssl)
if response.status_code == 200:
return response.json()
else:
self.error('Received status code: {0} from Soltra Server. Content:\n{1}'.format(
response.status_code, response.text)
) | python | def api_related(self, query):
'''
Find related objects through SoltraEdge API
'''
url = "{0}/{1}/related/?format=json".format(self.base_url, query)
response = requests.get(url, headers=self.headers, verify=self.verify_ssl)
if response.status_code == 200:
return response.json()
else:
self.error('Received status code: {0} from Soltra Server. Content:\n{1}'.format(
response.status_code, response.text)
) | [
"def",
"api_related",
"(",
"self",
",",
"query",
")",
":",
"url",
"=",
"\"{0}/{1}/related/?format=json\"",
".",
"format",
"(",
"self",
".",
"base_url",
",",
"query",
")",
"response",
"=",
"requests",
".",
"get",
"(",
"url",
",",
"headers",
"=",
"self",
"... | Find related objects through SoltraEdge API | [
"Find",
"related",
"objects",
"through",
"SoltraEdge",
"API"
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/SoltraEdge/soltra.py#L55-L68 |
244,677 | TheHive-Project/Cortex-Analyzers | analyzers/SoltraEdge/soltra.py | SoltraEdge.tlp_classifiers | def tlp_classifiers(self, name_tlp, val_tlp):
'''
Classifier between Cortex and Soltra.
Soltra uses name-TLP, and Cortex "value-TLP"
'''
classifier = {
"WHITE": 0,
"GREEN": 1,
"AMBER": 2,
"RED": 3
}
valid = True
if classifier[name_tlp] > val_tlp:
valid = False
return valid | python | def tlp_classifiers(self, name_tlp, val_tlp):
'''
Classifier between Cortex and Soltra.
Soltra uses name-TLP, and Cortex "value-TLP"
'''
classifier = {
"WHITE": 0,
"GREEN": 1,
"AMBER": 2,
"RED": 3
}
valid = True
if classifier[name_tlp] > val_tlp:
valid = False
return valid | [
"def",
"tlp_classifiers",
"(",
"self",
",",
"name_tlp",
",",
"val_tlp",
")",
":",
"classifier",
"=",
"{",
"\"WHITE\"",
":",
"0",
",",
"\"GREEN\"",
":",
"1",
",",
"\"AMBER\"",
":",
"2",
",",
"\"RED\"",
":",
"3",
"}",
"valid",
"=",
"True",
"if",
"class... | Classifier between Cortex and Soltra.
Soltra uses name-TLP, and Cortex "value-TLP" | [
"Classifier",
"between",
"Cortex",
"and",
"Soltra",
".",
"Soltra",
"uses",
"name",
"-",
"TLP",
"and",
"Cortex",
"value",
"-",
"TLP"
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/SoltraEdge/soltra.py#L71-L89 |
244,678 | TheHive-Project/Cortex-Analyzers | analyzers/SoltraEdge/soltra.py | SoltraEdge.pop_object | def pop_object(self, element):
'''
Pop the object element if the object contains an higher TLP then allowed.
'''
redacted_text = "Redacted. Object contained TLP value higher than allowed."
element['id'] = ''
element['url'] = ''
element['type'] = ''
element['tags'] = []
element['etlp'] = None
element['title'] = redacted_text
element['tlpColor'] = element['tlpColor']
element['uploaded_on'] = ''
element['uploaded_by'] = ''
element['description'] = redacted_text
element['children_types'] = []
element['summary']['type'] = ''
element['summary']['value'] = ''
element['summary']['title'] = redacted_text
element['summary']['description'] = redacted_text
return element | python | def pop_object(self, element):
'''
Pop the object element if the object contains an higher TLP then allowed.
'''
redacted_text = "Redacted. Object contained TLP value higher than allowed."
element['id'] = ''
element['url'] = ''
element['type'] = ''
element['tags'] = []
element['etlp'] = None
element['title'] = redacted_text
element['tlpColor'] = element['tlpColor']
element['uploaded_on'] = ''
element['uploaded_by'] = ''
element['description'] = redacted_text
element['children_types'] = []
element['summary']['type'] = ''
element['summary']['value'] = ''
element['summary']['title'] = redacted_text
element['summary']['description'] = redacted_text
return element | [
"def",
"pop_object",
"(",
"self",
",",
"element",
")",
":",
"redacted_text",
"=",
"\"Redacted. Object contained TLP value higher than allowed.\"",
"element",
"[",
"'id'",
"]",
"=",
"''",
"element",
"[",
"'url'",
"]",
"=",
"''",
"element",
"[",
"'type'",
"]",
"="... | Pop the object element if the object contains an higher TLP then allowed. | [
"Pop",
"the",
"object",
"element",
"if",
"the",
"object",
"contains",
"an",
"higher",
"TLP",
"then",
"allowed",
"."
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/SoltraEdge/soltra.py#L92-L116 |
244,679 | TheHive-Project/Cortex-Analyzers | analyzers/CERTatPassiveDNS/whois_wrapper.py | __query | def __query(domain, limit=100):
"""Using the shell script to query pdns.cert.at is a hack, but python raises an error every time using subprocess
functions to call whois. So this hack is avoiding calling whois directly. Ugly, but works.
:param domain: The domain pdns is queried with.
:type domain: str
:param limit: Maximum number of results
:type limit: int
:returns: str -- Console output from whois call.
:rtype: str
"""
s = check_output(['{}'.format(os.path.join(os.path.dirname(__file__), 'whois.sh')), '--limit {} {}'.format(limit, domain)], universal_newlines=True)
return s | python | def __query(domain, limit=100):
s = check_output(['{}'.format(os.path.join(os.path.dirname(__file__), 'whois.sh')), '--limit {} {}'.format(limit, domain)], universal_newlines=True)
return s | [
"def",
"__query",
"(",
"domain",
",",
"limit",
"=",
"100",
")",
":",
"s",
"=",
"check_output",
"(",
"[",
"'{}'",
".",
"format",
"(",
"os",
".",
"path",
".",
"join",
"(",
"os",
".",
"path",
".",
"dirname",
"(",
"__file__",
")",
",",
"'whois.sh'",
... | Using the shell script to query pdns.cert.at is a hack, but python raises an error every time using subprocess
functions to call whois. So this hack is avoiding calling whois directly. Ugly, but works.
:param domain: The domain pdns is queried with.
:type domain: str
:param limit: Maximum number of results
:type limit: int
:returns: str -- Console output from whois call.
:rtype: str | [
"Using",
"the",
"shell",
"script",
"to",
"query",
"pdns",
".",
"cert",
".",
"at",
"is",
"a",
"hack",
"but",
"python",
"raises",
"an",
"error",
"every",
"time",
"using",
"subprocess",
"functions",
"to",
"call",
"whois",
".",
"So",
"this",
"hack",
"is",
... | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/CERTatPassiveDNS/whois_wrapper.py#L6-L18 |
244,680 | TheHive-Project/Cortex-Analyzers | analyzers/FileInfo/submodules/submodule_oletools.py | OLEToolsSubmodule.analyze_vba | def analyze_vba(self, path):
"""Analyze a given sample for malicious vba."""
try:
vba_parser = VBA_Parser_CLI(path, relaxed=True)
vbaparser_result = vba_parser.process_file_json(show_decoded_strings=True,
display_code=True,
hide_attributes=False,
vba_code_only=False,
show_deobfuscated_code=True,
deobfuscate=True)
self.add_result_subsection('Olevba', vbaparser_result)
except TypeError:
self.add_result_subsection('Oletools VBA Analysis failed', 'Analysis failed due to an filetype error.'
'The file does not seem to be a valid MS-Office '
'file.') | python | def analyze_vba(self, path):
try:
vba_parser = VBA_Parser_CLI(path, relaxed=True)
vbaparser_result = vba_parser.process_file_json(show_decoded_strings=True,
display_code=True,
hide_attributes=False,
vba_code_only=False,
show_deobfuscated_code=True,
deobfuscate=True)
self.add_result_subsection('Olevba', vbaparser_result)
except TypeError:
self.add_result_subsection('Oletools VBA Analysis failed', 'Analysis failed due to an filetype error.'
'The file does not seem to be a valid MS-Office '
'file.') | [
"def",
"analyze_vba",
"(",
"self",
",",
"path",
")",
":",
"try",
":",
"vba_parser",
"=",
"VBA_Parser_CLI",
"(",
"path",
",",
"relaxed",
"=",
"True",
")",
"vbaparser_result",
"=",
"vba_parser",
".",
"process_file_json",
"(",
"show_decoded_strings",
"=",
"True",... | Analyze a given sample for malicious vba. | [
"Analyze",
"a",
"given",
"sample",
"for",
"malicious",
"vba",
"."
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/FileInfo/submodules/submodule_oletools.py#L98-L115 |
244,681 | TheHive-Project/Cortex-Analyzers | analyzers/MaxMind/maxminddb/reader.py | Reader.get | def get(self, ip_address):
"""Return the record for the ip_address in the MaxMind DB
Arguments:
ip_address -- an IP address in the standard string notation
"""
address = ipaddress.ip_address(ip_address)
if address.version == 6 and self._metadata.ip_version == 4:
raise ValueError('Error looking up {0}. You attempted to look up '
'an IPv6 address in an IPv4-only database.'.format(
ip_address))
pointer = self._find_address_in_tree(address)
return self._resolve_data_pointer(pointer) if pointer else None | python | def get(self, ip_address):
address = ipaddress.ip_address(ip_address)
if address.version == 6 and self._metadata.ip_version == 4:
raise ValueError('Error looking up {0}. You attempted to look up '
'an IPv6 address in an IPv4-only database.'.format(
ip_address))
pointer = self._find_address_in_tree(address)
return self._resolve_data_pointer(pointer) if pointer else None | [
"def",
"get",
"(",
"self",
",",
"ip_address",
")",
":",
"address",
"=",
"ipaddress",
".",
"ip_address",
"(",
"ip_address",
")",
"if",
"address",
".",
"version",
"==",
"6",
"and",
"self",
".",
"_metadata",
".",
"ip_version",
"==",
"4",
":",
"raise",
"Va... | Return the record for the ip_address in the MaxMind DB
Arguments:
ip_address -- an IP address in the standard string notation | [
"Return",
"the",
"record",
"for",
"the",
"ip_address",
"in",
"the",
"MaxMind",
"DB"
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/MaxMind/maxminddb/reader.py#L61-L76 |
244,682 | TheHive-Project/Cortex-Analyzers | analyzers/Crtsh/crtshquery.py | CrtshAnalyzer.search | def search(self, domain, wildcard=True):
"""
Search crt.sh for the given domain.
domain -- Domain to search for
wildcard -- Whether or not to prepend a wildcard to the domain
(default: True)
Return a list of a certificate dict:
{
"issuer_ca_id": 16418,
"issuer_name": "C=US, O=Let's Encrypt, CN=Let's Encrypt Authority X3",
"name_value": "hatch.uber.com",
"min_cert_id": 325717795,
"min_entry_timestamp": "2018-02-08T16:47:39.089",
"not_before": "2018-02-08T15:47:39"
}
XML notation would also include the base64 cert:
https://crt.sh/atom?q={}
"""
base_url = "https://crt.sh/?q={}&output=json"
if wildcard:
domain = "%25.{}".format(domain)
url = base_url.format(domain)
ua = 'Mozilla/5.0 (Windows NT 6.1; WOW64; rv:40.0) Gecko/20100101 Firefox/40.1'
req = requests.get(url, headers={'User-Agent': ua})
if req.ok:
try:
content = req.content.decode('utf-8')
data = json.loads(content.replace('}{', '},{'))
return data
except Exception:
self.error("Error retrieving information.")
return None | python | def search(self, domain, wildcard=True):
base_url = "https://crt.sh/?q={}&output=json"
if wildcard:
domain = "%25.{}".format(domain)
url = base_url.format(domain)
ua = 'Mozilla/5.0 (Windows NT 6.1; WOW64; rv:40.0) Gecko/20100101 Firefox/40.1'
req = requests.get(url, headers={'User-Agent': ua})
if req.ok:
try:
content = req.content.decode('utf-8')
data = json.loads(content.replace('}{', '},{'))
return data
except Exception:
self.error("Error retrieving information.")
return None | [
"def",
"search",
"(",
"self",
",",
"domain",
",",
"wildcard",
"=",
"True",
")",
":",
"base_url",
"=",
"\"https://crt.sh/?q={}&output=json\"",
"if",
"wildcard",
":",
"domain",
"=",
"\"%25.{}\"",
".",
"format",
"(",
"domain",
")",
"url",
"=",
"base_url",
".",
... | Search crt.sh for the given domain.
domain -- Domain to search for
wildcard -- Whether or not to prepend a wildcard to the domain
(default: True)
Return a list of a certificate dict:
{
"issuer_ca_id": 16418,
"issuer_name": "C=US, O=Let's Encrypt, CN=Let's Encrypt Authority X3",
"name_value": "hatch.uber.com",
"min_cert_id": 325717795,
"min_entry_timestamp": "2018-02-08T16:47:39.089",
"not_before": "2018-02-08T15:47:39"
}
XML notation would also include the base64 cert:
https://crt.sh/atom?q={} | [
"Search",
"crt",
".",
"sh",
"for",
"the",
"given",
"domain",
"."
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/Crtsh/crtshquery.py#L10-L47 |
244,683 | TheHive-Project/Cortex-Analyzers | analyzers/MISP/mispclient.py | MISPClient.__search | def __search(self, value, type_attribute):
"""Search method call wrapper.
:param value: value to search for.
:type value: str
:param type_attribute: attribute types to search for.
:type type_attribute: [list, none]
"""
results = []
if not value:
raise EmptySearchtermError
for idx, connection in enumerate(self.misp_connections):
misp_response = connection.search(type_attribute=type_attribute, values=value)
# Fixes #94
if isinstance(self.misp_name, list):
name = self.misp_name[idx]
else:
name = self.misp_name
results.append({'url': connection.root_url,
'name': name,
'result': self.__clean(misp_response)})
return results | python | def __search(self, value, type_attribute):
results = []
if not value:
raise EmptySearchtermError
for idx, connection in enumerate(self.misp_connections):
misp_response = connection.search(type_attribute=type_attribute, values=value)
# Fixes #94
if isinstance(self.misp_name, list):
name = self.misp_name[idx]
else:
name = self.misp_name
results.append({'url': connection.root_url,
'name': name,
'result': self.__clean(misp_response)})
return results | [
"def",
"__search",
"(",
"self",
",",
"value",
",",
"type_attribute",
")",
":",
"results",
"=",
"[",
"]",
"if",
"not",
"value",
":",
"raise",
"EmptySearchtermError",
"for",
"idx",
",",
"connection",
"in",
"enumerate",
"(",
"self",
".",
"misp_connections",
"... | Search method call wrapper.
:param value: value to search for.
:type value: str
:param type_attribute: attribute types to search for.
:type type_attribute: [list, none] | [
"Search",
"method",
"call",
"wrapper",
"."
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/MISP/mispclient.py#L213-L236 |
244,684 | TheHive-Project/Cortex-Analyzers | analyzers/TorBlutmagie/tor_blutmagie.py | TorBlutmagieClient.search_tor_node | def search_tor_node(self, data_type, data):
"""Lookup an artifact to check if it is a known tor exit node.
:param data_type: The artifact type. Must be one of 'ip', 'fqdn'
or 'domain'
:param data: The artifact to lookup
:type data_type: str
:type data: str
:return: Data relative to the tor node. If the looked-up artifact is
related to a tor exit node it will contain a `nodes` array.
That array will contains a list of nodes containing the
following keys:
- name: name given to the router
- ip: their IP address
- hostname: Hostname of the router
- country_code: ISO2 code of the country hosting the router
- as_name: ASName registering the router
- as_number: ASNumber registering the router
Otherwise, `nodes` will be empty.
:rtype: list
"""
results = []
if data_type == 'ip':
results = self._get_node_from_ip(data)
elif data_type == 'fqdn':
results = self._get_node_from_fqdn(data)
elif data_type == 'domain':
results = self._get_node_from_domain(data)
else:
pass
return {"nodes": results} | python | def search_tor_node(self, data_type, data):
results = []
if data_type == 'ip':
results = self._get_node_from_ip(data)
elif data_type == 'fqdn':
results = self._get_node_from_fqdn(data)
elif data_type == 'domain':
results = self._get_node_from_domain(data)
else:
pass
return {"nodes": results} | [
"def",
"search_tor_node",
"(",
"self",
",",
"data_type",
",",
"data",
")",
":",
"results",
"=",
"[",
"]",
"if",
"data_type",
"==",
"'ip'",
":",
"results",
"=",
"self",
".",
"_get_node_from_ip",
"(",
"data",
")",
"elif",
"data_type",
"==",
"'fqdn'",
":",
... | Lookup an artifact to check if it is a known tor exit node.
:param data_type: The artifact type. Must be one of 'ip', 'fqdn'
or 'domain'
:param data: The artifact to lookup
:type data_type: str
:type data: str
:return: Data relative to the tor node. If the looked-up artifact is
related to a tor exit node it will contain a `nodes` array.
That array will contains a list of nodes containing the
following keys:
- name: name given to the router
- ip: their IP address
- hostname: Hostname of the router
- country_code: ISO2 code of the country hosting the router
- as_name: ASName registering the router
- as_number: ASNumber registering the router
Otherwise, `nodes` will be empty.
:rtype: list | [
"Lookup",
"an",
"artifact",
"to",
"check",
"if",
"it",
"is",
"a",
"known",
"tor",
"exit",
"node",
"."
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/TorBlutmagie/tor_blutmagie.py#L80-L110 |
244,685 | TheHive-Project/Cortex-Analyzers | analyzers/Yara/yara_analyzer.py | YaraAnalyzer.check | def check(self, file):
"""
Checks a given file against all available yara rules
:param file: Path to file
:type file:str
:returns: Python dictionary containing the results
:rtype: list
"""
result = []
for rule in self.ruleset:
matches = rule.match(file)
for match in matches:
result.append(str(match))
return result | python | def check(self, file):
result = []
for rule in self.ruleset:
matches = rule.match(file)
for match in matches:
result.append(str(match))
return result | [
"def",
"check",
"(",
"self",
",",
"file",
")",
":",
"result",
"=",
"[",
"]",
"for",
"rule",
"in",
"self",
".",
"ruleset",
":",
"matches",
"=",
"rule",
".",
"match",
"(",
"file",
")",
"for",
"match",
"in",
"matches",
":",
"result",
".",
"append",
... | Checks a given file against all available yara rules
:param file: Path to file
:type file:str
:returns: Python dictionary containing the results
:rtype: list | [
"Checks",
"a",
"given",
"file",
"against",
"all",
"available",
"yara",
"rules"
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/Yara/yara_analyzer.py#L32-L47 |
244,686 | TheHive-Project/Cortex-Analyzers | analyzers/CIRCLPassiveDNS/circl_passivedns.py | CIRCLPassiveDNSAnalyzer.query | def query(self, domain):
"""The actual query happens here. Time from queries is replaced with isoformat.
:param domain: The domain which should gets queried.
:type domain: str
:returns: List of dicts containing the search results.
:rtype: [list, dict]
"""
result = {}
try:
result = self.pdns.query(domain)
except:
self.error('Exception while querying passiveDNS. Check the domain format.')
# Clean the datetime problems in order to correct the json serializability
clean_result = []
for ind, resultset in enumerate(result):
if resultset.get('time_first', None):
resultset['time_first'] = resultset.get('time_first').isoformat(' ')
if resultset.get('time_last', None):
resultset['time_last'] = resultset.get('time_last').isoformat(' ')
clean_result.append(resultset)
return clean_result | python | def query(self, domain):
result = {}
try:
result = self.pdns.query(domain)
except:
self.error('Exception while querying passiveDNS. Check the domain format.')
# Clean the datetime problems in order to correct the json serializability
clean_result = []
for ind, resultset in enumerate(result):
if resultset.get('time_first', None):
resultset['time_first'] = resultset.get('time_first').isoformat(' ')
if resultset.get('time_last', None):
resultset['time_last'] = resultset.get('time_last').isoformat(' ')
clean_result.append(resultset)
return clean_result | [
"def",
"query",
"(",
"self",
",",
"domain",
")",
":",
"result",
"=",
"{",
"}",
"try",
":",
"result",
"=",
"self",
".",
"pdns",
".",
"query",
"(",
"domain",
")",
"except",
":",
"self",
".",
"error",
"(",
"'Exception while querying passiveDNS. Check the doma... | The actual query happens here. Time from queries is replaced with isoformat.
:param domain: The domain which should gets queried.
:type domain: str
:returns: List of dicts containing the search results.
:rtype: [list, dict] | [
"The",
"actual",
"query",
"happens",
"here",
".",
"Time",
"from",
"queries",
"is",
"replaced",
"with",
"isoformat",
"."
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/CIRCLPassiveDNS/circl_passivedns.py#L13-L37 |
244,687 | TheHive-Project/Cortex-Analyzers | analyzers/CIRCLPassiveSSL/circl_passivessl.py | CIRCLPassiveSSLAnalyzer.query_ip | def query_ip(self, ip):
"""
Queries Circl.lu Passive SSL for an ip using PyPSSL class. Returns error if nothing is found.
:param ip: IP to query for
:type ip: str
:returns: python dict of results
:rtype: dict
"""
try:
result = self.pssl.query(ip)
except:
self.error('Exception during processing with passiveSSL. '
'Please check the format of ip.')
# Check for empty result
# result is always assigned, self.error exits the function.
if not result.get(ip, None):
certificates = []
else:
certificates = list(result.get(ip).get('certificates'))
newresult = {'ip': ip,
'certificates': []}
for cert in certificates:
newresult['certificates'].append({'fingerprint': cert,
'subject': result.get(ip).get('subjects').get(cert).get('values')[0]})
return newresult | python | def query_ip(self, ip):
try:
result = self.pssl.query(ip)
except:
self.error('Exception during processing with passiveSSL. '
'Please check the format of ip.')
# Check for empty result
# result is always assigned, self.error exits the function.
if not result.get(ip, None):
certificates = []
else:
certificates = list(result.get(ip).get('certificates'))
newresult = {'ip': ip,
'certificates': []}
for cert in certificates:
newresult['certificates'].append({'fingerprint': cert,
'subject': result.get(ip).get('subjects').get(cert).get('values')[0]})
return newresult | [
"def",
"query_ip",
"(",
"self",
",",
"ip",
")",
":",
"try",
":",
"result",
"=",
"self",
".",
"pssl",
".",
"query",
"(",
"ip",
")",
"except",
":",
"self",
".",
"error",
"(",
"'Exception during processing with passiveSSL. '",
"'Please check the format of ip.'",
... | Queries Circl.lu Passive SSL for an ip using PyPSSL class. Returns error if nothing is found.
:param ip: IP to query for
:type ip: str
:returns: python dict of results
:rtype: dict | [
"Queries",
"Circl",
".",
"lu",
"Passive",
"SSL",
"for",
"an",
"ip",
"using",
"PyPSSL",
"class",
".",
"Returns",
"error",
"if",
"nothing",
"is",
"found",
"."
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/CIRCLPassiveSSL/circl_passivessl.py#L16-L43 |
244,688 | TheHive-Project/Cortex-Analyzers | analyzers/CIRCLPassiveSSL/circl_passivessl.py | CIRCLPassiveSSLAnalyzer.query_certificate | def query_certificate(self, cert_hash):
"""
Queries Circl.lu Passive SSL for a certificate hash using PyPSSL class. Returns error if nothing is found.
:param cert_hash: hash to query for
:type cert_hash: str
:return: python dict of results
:rtype: dict
"""
try:
cquery = self.pssl.query_cert(cert_hash)
except Exception:
self.error('Exception during processing with passiveSSL. '
'This happens if the given hash is not sha1 or contains dashes/colons etc. '
'Please make sure to submit a clean formatted sha1 hash.')
# fetch_cert raises an error if no certificate was found.
try:
cfetch = self.pssl.fetch_cert(cert_hash, make_datetime=False)
except Exception:
cfetch = {}
return {'query': cquery,
'cert': cfetch} | python | def query_certificate(self, cert_hash):
try:
cquery = self.pssl.query_cert(cert_hash)
except Exception:
self.error('Exception during processing with passiveSSL. '
'This happens if the given hash is not sha1 or contains dashes/colons etc. '
'Please make sure to submit a clean formatted sha1 hash.')
# fetch_cert raises an error if no certificate was found.
try:
cfetch = self.pssl.fetch_cert(cert_hash, make_datetime=False)
except Exception:
cfetch = {}
return {'query': cquery,
'cert': cfetch} | [
"def",
"query_certificate",
"(",
"self",
",",
"cert_hash",
")",
":",
"try",
":",
"cquery",
"=",
"self",
".",
"pssl",
".",
"query_cert",
"(",
"cert_hash",
")",
"except",
"Exception",
":",
"self",
".",
"error",
"(",
"'Exception during processing with passiveSSL. '... | Queries Circl.lu Passive SSL for a certificate hash using PyPSSL class. Returns error if nothing is found.
:param cert_hash: hash to query for
:type cert_hash: str
:return: python dict of results
:rtype: dict | [
"Queries",
"Circl",
".",
"lu",
"Passive",
"SSL",
"for",
"a",
"certificate",
"hash",
"using",
"PyPSSL",
"class",
".",
"Returns",
"error",
"if",
"nothing",
"is",
"found",
"."
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/CIRCLPassiveSSL/circl_passivessl.py#L45-L68 |
244,689 | TheHive-Project/Cortex-Analyzers | analyzers/GreyNoise/greynoise.py | GreyNoiseAnalyzer._get_level | def _get_level(current_level, new_intention):
"""
Map GreyNoise intentions to Cortex maliciousness levels.
Accept a Cortex level and a GreyNoise intention, the return the more malicious of the two.
:param current_level: A Cortex maliciousness level
https://github.com/TheHive-Project/CortexDocs/blob/master/api/how-to-create-an-analyzer.md#output
:param new_intention: An intention field value from a GreyNoise record
https://github.com/GreyNoise-Intelligence/api.greynoise.io#v1queryip
:return: The more malicious of the 2 submitted values as a Cortex maliciousness level
"""
intention_level_map = OrderedDict([
('info', 'info'),
('benign', 'safe'),
('suspicious', 'suspicious'),
('malicious', 'malicious')
])
levels = intention_level_map.values()
new_level = intention_level_map.get(new_intention, 'info')
new_index = levels.index(new_level)
try:
current_index = levels.index(current_level)
except ValueError: # There is no existing level
current_index = -1
return new_level if new_index > current_index else current_level | python | def _get_level(current_level, new_intention):
intention_level_map = OrderedDict([
('info', 'info'),
('benign', 'safe'),
('suspicious', 'suspicious'),
('malicious', 'malicious')
])
levels = intention_level_map.values()
new_level = intention_level_map.get(new_intention, 'info')
new_index = levels.index(new_level)
try:
current_index = levels.index(current_level)
except ValueError: # There is no existing level
current_index = -1
return new_level if new_index > current_index else current_level | [
"def",
"_get_level",
"(",
"current_level",
",",
"new_intention",
")",
":",
"intention_level_map",
"=",
"OrderedDict",
"(",
"[",
"(",
"'info'",
",",
"'info'",
")",
",",
"(",
"'benign'",
",",
"'safe'",
")",
",",
"(",
"'suspicious'",
",",
"'suspicious'",
")",
... | Map GreyNoise intentions to Cortex maliciousness levels.
Accept a Cortex level and a GreyNoise intention, the return the more malicious of the two.
:param current_level: A Cortex maliciousness level
https://github.com/TheHive-Project/CortexDocs/blob/master/api/how-to-create-an-analyzer.md#output
:param new_intention: An intention field value from a GreyNoise record
https://github.com/GreyNoise-Intelligence/api.greynoise.io#v1queryip
:return: The more malicious of the 2 submitted values as a Cortex maliciousness level | [
"Map",
"GreyNoise",
"intentions",
"to",
"Cortex",
"maliciousness",
"levels",
".",
"Accept",
"a",
"Cortex",
"level",
"and",
"a",
"GreyNoise",
"intention",
"the",
"return",
"the",
"more",
"malicious",
"of",
"the",
"two",
"."
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/GreyNoise/greynoise.py#L16-L44 |
244,690 | TheHive-Project/Cortex-Analyzers | analyzers/GreyNoise/greynoise.py | GreyNoiseAnalyzer.summary | def summary(self, raw):
"""
Return one taxonomy summarizing the reported tags
If there is only one tag, use it as the predicate
If there are multiple tags, use "entries" as the predicate
Use the total count as the value
Use the most malicious level found
Examples:
Input
{
"name": SCANNER1,
"intention": ""
}
Output
GreyNoise:SCANNER1 = 1 (info)
Input
{
"name": SCANNER1,
"intention": "malicious"
},
{
"name": SCANNER1,
"intention": "benign"
}
Output
GreyNoise:SCANNER1 = 2 (malicious)
Input
{
"name": SCANNER1,
"intention": ""
},
{
"name": SCANNER1,
"intention": "safe"
},
{
"name": SCANNER2,
"intention": ""
}
Output
GreyNoise:entries = 3 (safe)
"""
try:
taxonomies = []
if raw.get('records'):
final_level = None
taxonomy_data = defaultdict(int)
for record in raw.get('records', []):
name = record.get('name', 'unknown')
intention = record.get('intention', 'unknown')
taxonomy_data[name] += 1
final_level = self._get_level(final_level, intention)
if len(taxonomy_data) > 1: # Multiple tags have been found
taxonomies.append(self.build_taxonomy(final_level, 'GreyNoise', 'entries', len(taxonomy_data)))
else: # There is only one tag found, possibly multiple times
for name, count in taxonomy_data.iteritems():
taxonomies.append(self.build_taxonomy(final_level, 'GreyNoise', name, count))
else:
taxonomies.append(self.build_taxonomy('info', 'GreyNoise', 'Records', 'None'))
return {"taxonomies": taxonomies}
except Exception as e:
self.error('Summary failed\n{}'.format(e.message)) | python | def summary(self, raw):
try:
taxonomies = []
if raw.get('records'):
final_level = None
taxonomy_data = defaultdict(int)
for record in raw.get('records', []):
name = record.get('name', 'unknown')
intention = record.get('intention', 'unknown')
taxonomy_data[name] += 1
final_level = self._get_level(final_level, intention)
if len(taxonomy_data) > 1: # Multiple tags have been found
taxonomies.append(self.build_taxonomy(final_level, 'GreyNoise', 'entries', len(taxonomy_data)))
else: # There is only one tag found, possibly multiple times
for name, count in taxonomy_data.iteritems():
taxonomies.append(self.build_taxonomy(final_level, 'GreyNoise', name, count))
else:
taxonomies.append(self.build_taxonomy('info', 'GreyNoise', 'Records', 'None'))
return {"taxonomies": taxonomies}
except Exception as e:
self.error('Summary failed\n{}'.format(e.message)) | [
"def",
"summary",
"(",
"self",
",",
"raw",
")",
":",
"try",
":",
"taxonomies",
"=",
"[",
"]",
"if",
"raw",
".",
"get",
"(",
"'records'",
")",
":",
"final_level",
"=",
"None",
"taxonomy_data",
"=",
"defaultdict",
"(",
"int",
")",
"for",
"record",
"in"... | Return one taxonomy summarizing the reported tags
If there is only one tag, use it as the predicate
If there are multiple tags, use "entries" as the predicate
Use the total count as the value
Use the most malicious level found
Examples:
Input
{
"name": SCANNER1,
"intention": ""
}
Output
GreyNoise:SCANNER1 = 1 (info)
Input
{
"name": SCANNER1,
"intention": "malicious"
},
{
"name": SCANNER1,
"intention": "benign"
}
Output
GreyNoise:SCANNER1 = 2 (malicious)
Input
{
"name": SCANNER1,
"intention": ""
},
{
"name": SCANNER1,
"intention": "safe"
},
{
"name": SCANNER2,
"intention": ""
}
Output
GreyNoise:entries = 3 (safe) | [
"Return",
"one",
"taxonomy",
"summarizing",
"the",
"reported",
"tags",
"If",
"there",
"is",
"only",
"one",
"tag",
"use",
"it",
"as",
"the",
"predicate",
"If",
"there",
"are",
"multiple",
"tags",
"use",
"entries",
"as",
"the",
"predicate",
"Use",
"the",
"to... | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/GreyNoise/greynoise.py#L62-L136 |
244,691 | TheHive-Project/Cortex-Analyzers | analyzers/VirusTotal/virustotal_api.py | PublicApi.scan_file | def scan_file(self, this_file):
""" Submit a file to be scanned by VirusTotal
:param this_file: File to be scanned (32MB file size limit)
:return: JSON response that contains scan_id and permalink.
"""
params = {'apikey': self.api_key}
try:
if type(this_file) == str and os.path.isfile(this_file):
files = {'file': (this_file, open(this_file, 'rb'))}
elif isinstance(this_file, StringIO.StringIO):
files = {'file': this_file.read()}
else:
files = {'file': this_file}
except TypeError as e:
return dict(error=e.message)
try:
response = requests.post(self.base + 'file/scan', files=files, params=params, proxies=self.proxies)
except requests.RequestException as e:
return dict(error=e.message)
return _return_response_and_status_code(response) | python | def scan_file(self, this_file):
params = {'apikey': self.api_key}
try:
if type(this_file) == str and os.path.isfile(this_file):
files = {'file': (this_file, open(this_file, 'rb'))}
elif isinstance(this_file, StringIO.StringIO):
files = {'file': this_file.read()}
else:
files = {'file': this_file}
except TypeError as e:
return dict(error=e.message)
try:
response = requests.post(self.base + 'file/scan', files=files, params=params, proxies=self.proxies)
except requests.RequestException as e:
return dict(error=e.message)
return _return_response_and_status_code(response) | [
"def",
"scan_file",
"(",
"self",
",",
"this_file",
")",
":",
"params",
"=",
"{",
"'apikey'",
":",
"self",
".",
"api_key",
"}",
"try",
":",
"if",
"type",
"(",
"this_file",
")",
"==",
"str",
"and",
"os",
".",
"path",
".",
"isfile",
"(",
"this_file",
... | Submit a file to be scanned by VirusTotal
:param this_file: File to be scanned (32MB file size limit)
:return: JSON response that contains scan_id and permalink. | [
"Submit",
"a",
"file",
"to",
"be",
"scanned",
"by",
"VirusTotal"
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/VirusTotal/virustotal_api.py#L62-L84 |
244,692 | TheHive-Project/Cortex-Analyzers | analyzers/VirusTotal/virustotal_api.py | PublicApi.scan_url | def scan_url(self, this_url):
""" Submit a URL to be scanned by VirusTotal.
:param this_url: The URL that should be scanned. This parameter accepts a list of URLs (up to 4 with the
standard request rate) so as to perform a batch scanning request with one single call. The
URLs must be separated by a new line character.
:return: JSON response that contains scan_id and permalink.
"""
params = {'apikey': self.api_key, 'url': this_url}
try:
response = requests.post(self.base + 'url/scan', params=params, proxies=self.proxies)
except requests.RequestException as e:
return dict(error=e.message)
return _return_response_and_status_code(response) | python | def scan_url(self, this_url):
params = {'apikey': self.api_key, 'url': this_url}
try:
response = requests.post(self.base + 'url/scan', params=params, proxies=self.proxies)
except requests.RequestException as e:
return dict(error=e.message)
return _return_response_and_status_code(response) | [
"def",
"scan_url",
"(",
"self",
",",
"this_url",
")",
":",
"params",
"=",
"{",
"'apikey'",
":",
"self",
".",
"api_key",
",",
"'url'",
":",
"this_url",
"}",
"try",
":",
"response",
"=",
"requests",
".",
"post",
"(",
"self",
".",
"base",
"+",
"'url/sca... | Submit a URL to be scanned by VirusTotal.
:param this_url: The URL that should be scanned. This parameter accepts a list of URLs (up to 4 with the
standard request rate) so as to perform a batch scanning request with one single call. The
URLs must be separated by a new line character.
:return: JSON response that contains scan_id and permalink. | [
"Submit",
"a",
"URL",
"to",
"be",
"scanned",
"by",
"VirusTotal",
"."
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/VirusTotal/virustotal_api.py#L124-L139 |
244,693 | TheHive-Project/Cortex-Analyzers | analyzers/VirusTotal/virustotal_api.py | PrivateApi.get_file | def get_file(self, this_hash):
""" Download a file by its hash.
Downloads a file from VirusTotal's store given one of its hashes. This call can be used in conjuction with
the file searching call in order to download samples that match a given set of criteria.
:param this_hash: The md5/sha1/sha256 hash of the file you want to download.
:return: Downloaded file in response.content
"""
params = {'apikey': self.api_key, 'hash': this_hash}
try:
response = requests.get(self.base + 'file/download', params=params, proxies=self.proxies)
except requests.RequestException as e:
return dict(error=e.message)
if response.status_code == requests.codes.ok:
return response.content
elif response.status_code == 403:
return dict(error='You tried to perform calls to functions for which you require a Private API key.',
response_code=response.status_code)
elif response.status_code == 404:
return dict(error='File not found.', response_code=response.status_code)
else:
return dict(response_code=response.status_code) | python | def get_file(self, this_hash):
params = {'apikey': self.api_key, 'hash': this_hash}
try:
response = requests.get(self.base + 'file/download', params=params, proxies=self.proxies)
except requests.RequestException as e:
return dict(error=e.message)
if response.status_code == requests.codes.ok:
return response.content
elif response.status_code == 403:
return dict(error='You tried to perform calls to functions for which you require a Private API key.',
response_code=response.status_code)
elif response.status_code == 404:
return dict(error='File not found.', response_code=response.status_code)
else:
return dict(response_code=response.status_code) | [
"def",
"get_file",
"(",
"self",
",",
"this_hash",
")",
":",
"params",
"=",
"{",
"'apikey'",
":",
"self",
".",
"api_key",
",",
"'hash'",
":",
"this_hash",
"}",
"try",
":",
"response",
"=",
"requests",
".",
"get",
"(",
"self",
".",
"base",
"+",
"'file/... | Download a file by its hash.
Downloads a file from VirusTotal's store given one of its hashes. This call can be used in conjuction with
the file searching call in order to download samples that match a given set of criteria.
:param this_hash: The md5/sha1/sha256 hash of the file you want to download.
:return: Downloaded file in response.content | [
"Download",
"a",
"file",
"by",
"its",
"hash",
"."
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/VirusTotal/virustotal_api.py#L501-L525 |
244,694 | TheHive-Project/Cortex-Analyzers | analyzers/VirusTotal/virustotal_api.py | PrivateApi.get_url_report | def get_url_report(self, this_url, scan='0', allinfo=1):
""" Get the scan results for a URL.
:param this_url: A URL for which you want to retrieve the most recent report. You may also specify a scan_id
(sha256-timestamp as returned by the URL submission API) to access a specific report. At the same time, you
can specify a CSV list made up of a combination of urls and scan_ids (up to 25 items) so as to perform a batch
request with one single call. The CSV list must be separated by new line characters.
:param scan: (optional) This is an optional parameter that when set to "1" will automatically submit the URL
for analysis if no report is found for it in VirusTotal's database. In this case the result will contain a
scan_id field that can be used to query the analysis report later on.
:param allinfo: (optional) If this parameter is specified and set to "1" additional info regarding the URL
(other than the URL scanning engine results) will also be returned. This additional info includes VirusTotal
related metadata (first seen date, last seen date, files downloaded from the given URL, etc.) and the output
of other tools and datasets when fed with the URL.
:return: JSON response
"""
params = {'apikey': self.api_key, 'resource': this_url, 'scan': scan, 'allinfo': allinfo}
try:
response = requests.get(self.base + 'url/report', params=params, proxies=self.proxies)
except requests.RequestException as e:
return dict(error=e.message)
return _return_response_and_status_code(response) | python | def get_url_report(self, this_url, scan='0', allinfo=1):
params = {'apikey': self.api_key, 'resource': this_url, 'scan': scan, 'allinfo': allinfo}
try:
response = requests.get(self.base + 'url/report', params=params, proxies=self.proxies)
except requests.RequestException as e:
return dict(error=e.message)
return _return_response_and_status_code(response) | [
"def",
"get_url_report",
"(",
"self",
",",
"this_url",
",",
"scan",
"=",
"'0'",
",",
"allinfo",
"=",
"1",
")",
":",
"params",
"=",
"{",
"'apikey'",
":",
"self",
".",
"api_key",
",",
"'resource'",
":",
"this_url",
",",
"'scan'",
":",
"scan",
",",
"'al... | Get the scan results for a URL.
:param this_url: A URL for which you want to retrieve the most recent report. You may also specify a scan_id
(sha256-timestamp as returned by the URL submission API) to access a specific report. At the same time, you
can specify a CSV list made up of a combination of urls and scan_ids (up to 25 items) so as to perform a batch
request with one single call. The CSV list must be separated by new line characters.
:param scan: (optional) This is an optional parameter that when set to "1" will automatically submit the URL
for analysis if no report is found for it in VirusTotal's database. In this case the result will contain a
scan_id field that can be used to query the analysis report later on.
:param allinfo: (optional) If this parameter is specified and set to "1" additional info regarding the URL
(other than the URL scanning engine results) will also be returned. This additional info includes VirusTotal
related metadata (first seen date, last seen date, files downloaded from the given URL, etc.) and the output
of other tools and datasets when fed with the URL.
:return: JSON response | [
"Get",
"the",
"scan",
"results",
"for",
"a",
"URL",
"."
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/VirusTotal/virustotal_api.py#L548-L572 |
244,695 | TheHive-Project/Cortex-Analyzers | analyzers/VirusTotal/virustotal_api.py | PrivateApi.get_comments | def get_comments(self, resource, before=None):
""" Get comments for a file or URL.
Retrieve a list of VirusTotal Community comments for a given file or URL. VirusTotal Community comments are
user submitted reviews on a given item, these comments may contain anything from the in-the-wild locations of
files up to fully-featured reverse engineering reports on a given sample.
:param resource: Either an md5/sha1/sha256 hash of the file or the URL itself you want to retrieve.
:param before: (optional) A datetime token that allows you to iterate over all comments on a specific item
whenever it has been commented on more than 25 times.
:return: JSON response - The application answers with the comments sorted in descending order according to
their date.
"""
params = dict(apikey=self.api_key, resource=resource, before=before)
try:
response = requests.get(self.base + 'comments/get', params=params, proxies=self.proxies)
except requests.RequestException as e:
return dict(error=e.message)
return _return_response_and_status_code(response) | python | def get_comments(self, resource, before=None):
params = dict(apikey=self.api_key, resource=resource, before=before)
try:
response = requests.get(self.base + 'comments/get', params=params, proxies=self.proxies)
except requests.RequestException as e:
return dict(error=e.message)
return _return_response_and_status_code(response) | [
"def",
"get_comments",
"(",
"self",
",",
"resource",
",",
"before",
"=",
"None",
")",
":",
"params",
"=",
"dict",
"(",
"apikey",
"=",
"self",
".",
"api_key",
",",
"resource",
"=",
"resource",
",",
"before",
"=",
"before",
")",
"try",
":",
"response",
... | Get comments for a file or URL.
Retrieve a list of VirusTotal Community comments for a given file or URL. VirusTotal Community comments are
user submitted reviews on a given item, these comments may contain anything from the in-the-wild locations of
files up to fully-featured reverse engineering reports on a given sample.
:param resource: Either an md5/sha1/sha256 hash of the file or the URL itself you want to retrieve.
:param before: (optional) A datetime token that allows you to iterate over all comments on a specific item
whenever it has been commented on more than 25 times.
:return: JSON response - The application answers with the comments sorted in descending order according to
their date. | [
"Get",
"comments",
"for",
"a",
"file",
"or",
"URL",
"."
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/VirusTotal/virustotal_api.py#L659-L679 |
244,696 | TheHive-Project/Cortex-Analyzers | analyzers/VirusTotal/virustotal_api.py | IntelApi.save_downloaded_file | def save_downloaded_file(filename, save_file_at, file_stream):
""" Save Downloaded File to Disk Helper Function
:param save_file_at: Path of where to save the file.
:param file_stream: File stream
:param filename: Name to save the file.
"""
filename = os.path.join(save_file_at, filename)
with open(filename, 'wb') as f:
f.write(file_stream)
f.flush() | python | def save_downloaded_file(filename, save_file_at, file_stream):
filename = os.path.join(save_file_at, filename)
with open(filename, 'wb') as f:
f.write(file_stream)
f.flush() | [
"def",
"save_downloaded_file",
"(",
"filename",
",",
"save_file_at",
",",
"file_stream",
")",
":",
"filename",
"=",
"os",
".",
"path",
".",
"join",
"(",
"save_file_at",
",",
"filename",
")",
"with",
"open",
"(",
"filename",
",",
"'wb'",
")",
"as",
"f",
"... | Save Downloaded File to Disk Helper Function
:param save_file_at: Path of where to save the file.
:param file_stream: File stream
:param filename: Name to save the file. | [
"Save",
"Downloaded",
"File",
"to",
"Disk",
"Helper",
"Function"
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/VirusTotal/virustotal_api.py#L758-L768 |
244,697 | TheHive-Project/Cortex-Analyzers | analyzers/MaxMind/geoip2/records.py | PlaceRecord.name | def name(self):
"""Dict with locale codes as keys and localized name as value"""
# pylint:disable=E1101
return next((self.names.get(x) for x in self._locales if x in
self.names), None) | python | def name(self):
# pylint:disable=E1101
return next((self.names.get(x) for x in self._locales if x in
self.names), None) | [
"def",
"name",
"(",
"self",
")",
":",
"# pylint:disable=E1101",
"return",
"next",
"(",
"(",
"self",
".",
"names",
".",
"get",
"(",
"x",
")",
"for",
"x",
"in",
"self",
".",
"_locales",
"if",
"x",
"in",
"self",
".",
"names",
")",
",",
"None",
")"
] | Dict with locale codes as keys and localized name as value | [
"Dict",
"with",
"locale",
"codes",
"as",
"keys",
"and",
"localized",
"name",
"as",
"value"
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/MaxMind/geoip2/records.py#L40-L44 |
244,698 | TheHive-Project/Cortex-Analyzers | analyzers/Patrowl/patrowl.py | PatrowlAnalyzer.summary | def summary(self, raw):
"""Parse, format and return scan summary."""
taxonomies = []
level = "info"
namespace = "Patrowl"
# getreport service
if self.service == 'getreport':
if 'risk_level' in raw and raw['risk_level']:
risk_level = raw['risk_level']
# Grade
if risk_level['grade'] in ["A", "B"]:
level = "safe"
else:
level = "suspicious"
taxonomies.append(self.build_taxonomy(level, namespace, "Grade", risk_level['grade']))
# Findings
if risk_level['high'] > 0:
level = "malicious"
elif risk_level['medium'] > 0 or risk_level['low'] > 0:
level = "suspicious"
else:
level = "info"
taxonomies.append(self.build_taxonomy(
level, namespace, "Findings", "{}/{}/{}/{}".format(
risk_level['high'],
risk_level['medium'],
risk_level['low'],
risk_level['info']
)))
#todo: add_asset service
return {"taxonomies": taxonomies} | python | def summary(self, raw):
taxonomies = []
level = "info"
namespace = "Patrowl"
# getreport service
if self.service == 'getreport':
if 'risk_level' in raw and raw['risk_level']:
risk_level = raw['risk_level']
# Grade
if risk_level['grade'] in ["A", "B"]:
level = "safe"
else:
level = "suspicious"
taxonomies.append(self.build_taxonomy(level, namespace, "Grade", risk_level['grade']))
# Findings
if risk_level['high'] > 0:
level = "malicious"
elif risk_level['medium'] > 0 or risk_level['low'] > 0:
level = "suspicious"
else:
level = "info"
taxonomies.append(self.build_taxonomy(
level, namespace, "Findings", "{}/{}/{}/{}".format(
risk_level['high'],
risk_level['medium'],
risk_level['low'],
risk_level['info']
)))
#todo: add_asset service
return {"taxonomies": taxonomies} | [
"def",
"summary",
"(",
"self",
",",
"raw",
")",
":",
"taxonomies",
"=",
"[",
"]",
"level",
"=",
"\"info\"",
"namespace",
"=",
"\"Patrowl\"",
"# getreport service",
"if",
"self",
".",
"service",
"==",
"'getreport'",
":",
"if",
"'risk_level'",
"in",
"raw",
"... | Parse, format and return scan summary. | [
"Parse",
"format",
"and",
"return",
"scan",
"summary",
"."
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/Patrowl/patrowl.py#L17-L53 |
244,699 | TheHive-Project/Cortex-Analyzers | analyzers/Patrowl/patrowl.py | PatrowlAnalyzer.run | def run(self):
"""Run the analyzer."""
try:
if self.service == 'getreport':
service_url = '{}/assets/api/v1/details/{}'.format(
self.url, self.get_data())
headers = {
'Authorization': 'token {}'.format(self.api_key)
}
response = requests.get(service_url, headers=headers)
self.report(response.json())
else:
self.error('Unknown Patrowl service')
except Exception as e:
self.unexpectedError(e) | python | def run(self):
try:
if self.service == 'getreport':
service_url = '{}/assets/api/v1/details/{}'.format(
self.url, self.get_data())
headers = {
'Authorization': 'token {}'.format(self.api_key)
}
response = requests.get(service_url, headers=headers)
self.report(response.json())
else:
self.error('Unknown Patrowl service')
except Exception as e:
self.unexpectedError(e) | [
"def",
"run",
"(",
"self",
")",
":",
"try",
":",
"if",
"self",
".",
"service",
"==",
"'getreport'",
":",
"service_url",
"=",
"'{}/assets/api/v1/details/{}'",
".",
"format",
"(",
"self",
".",
"url",
",",
"self",
".",
"get_data",
"(",
")",
")",
"headers",
... | Run the analyzer. | [
"Run",
"the",
"analyzer",
"."
] | 8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf | https://github.com/TheHive-Project/Cortex-Analyzers/blob/8dae6a8c4cf9af5554ae8c844985c4b44d4bd4bf/analyzers/Patrowl/patrowl.py#L55-L73 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.