854203608

Build # 854203608

Build Type

github-actions

Committed by GitHub

Commit Message

<a href="https://github.com/dmuhs/mythx-cli/commit/<a class=hub.com/dmuhs/mythx-cli/commit/2ca96ba26f30123e4d569ecd45af144a8215e6ee">2ca96ba26<a href="https://github.com/dmuhs/mythx-cli/commit/2ca96ba26f30123e4d569ecd45af144a8215e6ee">">Merge </a><a class="double-link" href="https://github.com/dmuhs/mythx-cli/commit/<a class="double-link" href="https://github.com/dmuhs/mythx-cli/commit/dbb2959904fe6889409f7fec87d6ae4a68b028b8">dbb295990</a>">dbb295990</a><a href="https://github.com/dmuhs/mythx-cli/commit/2ca96ba26f30123e4d569ecd45af144a8215e6ee"> into d4a9f4284">d4a9f4284</a>

Pull Request Pull Request #249: Feat/fuzz

Run Details

665 of 665 new or added lines in 27 files covered. (100.0%)

1448 of 1685 relevant lines covered (85.93%)

3.44 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

63.04

/mythx_cli/fuzz/faas.py

import logging
import random
import string

import requests

from mythx_cli.analyze.scribble import ScribbleMixin

from .exceptions import (
    BadStatusCode,
    CreateFaaSCampaignError,
    PayloadError,
    RequestError,
    ScribbleMetaError,
)

LOGGER = logging.getLogger("mythx-cli")

headers = {"Content-Type": "application/json"}


class FaasClient:
    """ A client to interact with the FaaS API.

    This object receives solidity compilation artifacts and a Harvey Seed state, generates a payload that the faas
    API can consume and submits it, also triggering the start of a Campaign.
    """

    def __init__(self, faas_url, campaign_name_prefix, project_type):
        self.faas_url = faas_url
        self.campaign_name_prefix = campaign_name_prefix
        self.project_type = project_type

    def generate_campaign_name(self):
        """Return a random name with the provided prefix self.campaign_name_prefix."""
        letters = string.ascii_lowercase
        random_string = "".join(random.choice(letters) for i in range(5))
        return str(self.campaign_name_prefix + "_" + random_string)

    def start_faas_campaign(self, payload):
        """Make HTTP request to the faas"""
        try:
            req_url = f"{self.faas_url}/api/campaigns?start_immediately=true"
            response = requests.post(req_url, json=payload, headers=headers)
            response_data = response.json()
            if response.status_code != requests.codes.ok:
                raise BadStatusCode(
                    f"Got http status code {response.status_code} for request {req_url}",
                    detail=response_data["detail"],
                )
            return response_data["id"]
        except Exception as e:
            if isinstance(e, BadStatusCode):
                raise e
            raise RequestError(f"Error starting FaaS campaign.")

    def create_faas_campaign(self, campaign_data, seed_state):
        """Submit a campaign to the FaaS and start that campaign.

        This function takes a FaaS payload and makes an HTTP request to the Faas backend, which
        then creates and starts a campaign. The campaign is started because of the `start_immediately=true` query
        parameter.

        This will send the following data to the FaaS for analysis:

        * :code:`name`
        * :code:`parameters` A dict of Harvey configuration options
        * :code:`sources` A dict containing source files code and AST
        * :code:`contracts` Solidity artifacts of the target smart contracts
        * :code:`corpus` Seed state of the target contract. Usually the list of transactions that took place on the
        local ganache (or equivalent) instance.

        :return: Campaign ID
        """
        try:
            try:
                api_payload_params = {
                    "discovery-probability-threshold": seed_state[
                        "discovery-probability-threshold"
                    ],
                    "num-cores": seed_state["num-cores"],
                    "assertion-checking-mode": seed_state["assertion-checking-mode"],
                }

                api_payload = {
                    "parameters": api_payload_params,
                    "name": self.generate_campaign_name(),
                    "corpus": seed_state["analysis-setup"],
                    "sources": campaign_data.payload["sources"],
                    "contracts": campaign_data.payload["contracts"],
                }
            except Exception:
                raise PayloadError(f"Error extracting data from payload")

            try:
                instr_meta = ScribbleMixin.get_arming_instr_meta()

                if instr_meta is not None:
                    api_payload["instrumentationMetadata"] = instr_meta
            except Exception as e:
                raise ScribbleMetaError(
                    f"Error getting Scribble arming metadata."
                ) from e

            campaign_id = self.start_faas_campaign(api_payload)

            return campaign_id
        except (PayloadError, ScribbleMetaError) as e:
            raise CreateFaaSCampaignError(f"Error creating the FaaS campaign:")

1	import logging	4✔
2	import random	4✔
3	import string	4✔
4
5	import requests	4✔
6
7	from mythx_cli.analyze.scribble import ScribbleMixin	4✔
8
9	from .exceptions import (	4✔
10	BadStatusCode,
11	CreateFaaSCampaignError,
12	PayloadError,
13	RequestError,
14	ScribbleMetaError,
15	)
16
17	LOGGER = logging.getLogger("mythx-cli")	4✔
18
19	headers = {"Content-Type": "application/json"}	4✔
20
21
22	class FaasClient:	4✔
23	""" A client to interact with the FaaS API.
24
25	This object receives solidity compilation artifacts and a Harvey Seed state, generates a payload that the faas
26	API can consume and submits it, also triggering the start of a Campaign.
27	"""
28
29	def __init__(self, faas_url, campaign_name_prefix, project_type):	4✔
30	self.faas_url = faas_url	4✔
31	self.campaign_name_prefix = campaign_name_prefix	4✔
32	self.project_type = project_type	4✔
33
34	def generate_campaign_name(self):	4✔
35	"""Return a random name with the provided prefix self.campaign_name_prefix."""
36	letters = string.ascii_lowercase	4✔
37	random_string = "".join(random.choice(letters) for i in range(5))	4✔
38	return str(self.campaign_name_prefix + "_" + random_string)	4✔
39
40	def start_faas_campaign(self, payload):	4✔
41	"""Make HTTP request to the faas"""
42	try:	×
43	req_url = f"{self.faas_url}/api/campaigns?start_immediately=true"	×
44	response = requests.post(req_url, json=payload, headers=headers)	×
45	response_data = response.json()	×
46	if response.status_code != requests.codes.ok:	×
47	raise BadStatusCode(	×
48	f"Got http status code {response.status_code} for request {req_url}",
49	detail=response_data["detail"],
50	)
51	return response_data["id"]	×
52	except Exception as e:	×
53	if isinstance(e, BadStatusCode):	×
54	raise e	×
55	raise RequestError(f"Error starting FaaS campaign.")	×
56
57	def create_faas_campaign(self, campaign_data, seed_state):	4✔
58	"""Submit a campaign to the FaaS and start that campaign.
59
60	This function takes a FaaS payload and makes an HTTP request to the Faas backend, which
61	then creates and starts a campaign. The campaign is started because of the `start_immediately=true` query
62	parameter.
63
64	This will send the following data to the FaaS for analysis:
65
66	* :code:`name`
67	* :code:`parameters` A dict of Harvey configuration options
68	* :code:`sources` A dict containing source files code and AST
69	* :code:`contracts` Solidity artifacts of the target smart contracts
70	* :code:`corpus` Seed state of the target contract. Usually the list of transactions that took place on the
71	local ganache (or equivalent) instance.
72
73	:return: Campaign ID
74	"""
75	try:	4✔
76	try:	4✔
77	api_payload_params = {	4✔
78	"discovery-probability-threshold": seed_state[
79	"discovery-probability-threshold"
80	],
81	"num-cores": seed_state["num-cores"],
82	"assertion-checking-mode": seed_state["assertion-checking-mode"],
83	}
84
85	api_payload = {	4✔
86	"parameters": api_payload_params,
87	"name": self.generate_campaign_name(),
88	"corpus": seed_state["analysis-setup"],
89	"sources": campaign_data.payload["sources"],
90	"contracts": campaign_data.payload["contracts"],
91	}
92	except Exception:	×
93	raise PayloadError(f"Error extracting data from payload")	×
94
95	try:	4✔
96	instr_meta = ScribbleMixin.get_arming_instr_meta()	4✔
97
98	if instr_meta is not None:	4✔
99	api_payload["instrumentationMetadata"] = instr_meta	×
100	except Exception as e:	×
101	raise ScribbleMetaError(	×
102	f"Error getting Scribble arming metadata."
103	) from e
104
105	campaign_id = self.start_faas_campaign(api_payload)	4✔
106
107	return campaign_id	4✔
108	except (PayloadError, ScribbleMetaError) as e:	4✔
109	raise CreateFaaSCampaignError(f"Error creating the FaaS campaign:")	×

dmuhs / mythx-cli / 854203608

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous