Add VirusTotal tools

Gradio_UI.py

@@ -141,7 +141,7 @@ def stream_to_gradio(
 
     for step_log in agent.run(task, stream=True, reset=reset_agent_memory, additional_args=additional_args):
         # Track tokens if model provides them
-        if hasattr(agent.model, "last_input_token_count"):
+        if hasattr(agent.model, "last_input_token_count") and agent.model.last_input_token_count is not None:
             total_input_tokens += agent.model.last_input_token_count
             total_output_tokens += agent.model.last_output_token_count
             if isinstance(step_log, ActionStep):

app.py

@@ -1,22 +1,17 @@
-from smolagents import CodeAgent,DuckDuckGoSearchTool, HfApiModel,load_tool,tool
 import datetime
-import requests
+import os
+
 import pytz
+import requests
 import yaml
-from tools.final_answer import FinalAnswerTool
+from smolagents import CodeAgent, DuckDuckGoSearchTool, HfApiModel, tool
 
 from Gradio_UI import GradioUI
+from classes.get_url_report import GetURLReportResponse, Data, Attributes, Stats
+from classes.ip_address_report import IPAddressReport, TotalVotes, AnalysisStats
+from classes.scan_url import DataAnalysis, Links, ScanResponse
+from tools.final_answer import FinalAnswerTool
 
-# Below is an example of a tool that does nothing. Amaze us with your creativity !
-@tool
-def my_cutom_tool(arg1:str, arg2:int)-> str: #it's import to specify the return type
-    #Keep this format for the description / args / args description but feel free to modify the tool
-    """A tool that does nothing yet 
-    Args:
-        arg1: the first argument
-        arg2: the second argument
-    """
-    return "What magic will you build ?"
 
 @tool
 def get_current_time_in_timezone(timezone: str) -> str:
@@ -33,25 +28,198 @@ def get_current_time_in_timezone(timezone: str) -> str:
     except Exception as e:
         return f"Error fetching time for timezone '{timezone}': {str(e)}"
 
+@tool
+def get_my_ip_address() -> str:
+    """
+    Retrieves the public IP address of the machine running this code.
+
+    Returns:
+        str: The public IP address.
+
+    Raises:
+        Exception: If the request to the external service fails.
+    """
+    url = "https://api.ipify.org?format=json"
+    response = requests.get(url)
+
+    if response.status_code == 200:
+        data = response.json()
+        return data["ip"]
+    else:
+        raise Exception(f"Failed to retrieve IP address: {response.status_code} - {response.text}")
+
+@tool
+def get_ip_address_report(ip_address: str) -> IPAddressReport:
+    """
+    Fetches the IP address report from the VirusTotal API and returns it as an IPAddressReport object.
+
+    Args:
+        ip_address: The IP address to fetch the report for.
+
+    Returns:
+        IPAddressReport: An object containing the IP address report.
+
+    Raises:
+        Exception: If the request to the VirusTotal API fails.
+    """
+    url = f"https://www.virustotal.com/api/v3/ip_addresses/{ip_address}"
+    headers = {
+        "accept": "application/json",
+        "x-apikey": os.getenv('VT_API_KEY')
+    }
+
+    response = requests.get(url, headers=headers)
+
+    if response.status_code == 200:
+        data = response.json()
+        report = IPAddressReport(
+            id=data["data"]["id"],
+            type=data["data"]["type"],
+            reputation=data["data"]["attributes"]["reputation"],
+            continent=data["data"]["attributes"]["continent"],
+            as_owner=data["data"]["attributes"]["as_owner"],
+            country=data["data"]["attributes"]["country"],
+            tags=data["data"]["attributes"]["tags"],
+            total_votes=TotalVotes(
+                harmless=data["data"]["attributes"]["total_votes"]["harmless"],
+                malicious=data["data"]["attributes"]["total_votes"]["malicious"]
+            ),
+            network=data["data"]["attributes"]["network"],
+            last_analysis_stats=AnalysisStats(
+                malicious=data["data"]["attributes"]["last_analysis_stats"]["malicious"],
+                suspicious=data["data"]["attributes"]["last_analysis_stats"]["suspicious"],
+                undetected=data["data"]["attributes"]["last_analysis_stats"]["undetected"],
+                harmless=data["data"]["attributes"]["last_analysis_stats"]["harmless"],
+                timeout=data["data"]["attributes"]["last_analysis_stats"]["timeout"]
+            )
+        )
+        return report
+    else:
+        raise Exception(f"Failed to retrieve data: {response.status_code} - {response.text}")
+
+@tool
+def scan_url(url: str) -> ScanResponse:
+    """
+    Request a scan of a given URL using the VirusTotal API.
+
+    Args:
+         url: The URL to scan.
+
+    Returns:
+        ScanResponse: The response from the VirusTotal API.
+
+    Raises:
+        Exception: If the request to the external service fails.
+    """
+
+    endpoint = "https://www.virustotal.com/api/v3/urls"
+
+    payload = { "url" : url }
+    headers = {
+        "accept": "application/json",
+        "x-apikey": os.getenv('VT_API_KEY') ,
+        "content-type": "application/x-www-form-urlencoded"
+    }
+
+    # Send a POST request to the VirusTotal API
+    response = requests.post(endpoint, headers=headers, data=payload)
+
+    print(response.text)
+
+    try:
+        # Raise an exception if the request was unsuccessful
+        response.raise_for_status()
+
+        response_json = response.json()
+
+        return ScanResponse(
+            data=DataAnalysis(
+                type=response_json["data"]["type"],
+                id=response_json["data"]["id"],
+                links=Links(self_url=response_json["data"]["links"]["self"])
+            )
+        )
+
+    except requests.exceptions.RequestException as e:
+        # Handle any errors that occur during the request
+        raise Exception(f"Failed to retrieve data: {response.status_code} - {response.text}")
+
+@tool
+def get_scan_report(scan: ScanResponse) -> GetURLReportResponse:
+    """
+    Fetch a report of a scan of a given URL using the VirusTotal API.
+
+    Args:
+        scan: The ScanResponse object returned by calling scan_url tool.
+
+    Returns:
+        GetURLReportResponse: The response from the VirusTotal API.
+
+    Raises:
+        Exception: If the request to the external service fails.
+    """
+
+    headers = {
+        "accept": "application/json",
+        "x-apikey": os.getenv('VT_API_KEY')
+    }
+
+    # Send a GET request to the VirusTotal API
+    response = requests.get(scan.data.links.self_url, headers=headers)
+
+    print(response.text)
+
+    try:
+        # Raise an exception if the request was unsuccessful
+        response.raise_for_status()
+
+        response_json = response.json()
+
+        # Creating an instance of the data class from the JSON response
+        response = GetURLReportResponse(
+            data=Data(
+                id=response_json["data"]["id"],
+                type=response_json["data"]["type"],
+                attributes=Attributes(
+                    date=response_json["data"]["attributes"]["date"],
+                    status=response_json["data"]["attributes"]["status"],
+                    stats=Stats(
+                        malicious=response_json["data"]["attributes"]["stats"]["malicious"],
+                        suspicious=response_json["data"]["attributes"]["stats"]["suspicious"],
+                        undetected=response_json["data"]["attributes"]["stats"]["undetected"],
+                        harmless=response_json["data"]["attributes"]["stats"]["harmless"],
+                        timeout=response_json["data"]["attributes"]["stats"]["timeout"]
+                    )
+                )
+            )
+        )
+
+        return response
+
+    except requests.exceptions.RequestException as e:
+        # Handle any errors that occur during the request
+        raise Exception(f"Failed to retrieve data: {response.status_code} - {response.text}")
 
 final_answer = FinalAnswerTool()
 model = HfApiModel(
-max_tokens=2096,
-temperature=0.5,
-model_id='https://wxknx1kg971u7k1n.us-east-1.aws.endpoints.huggingface.cloud',# it is possible that this model may be overloaded
-custom_role_conversions=None,
+    token=os.getenv('HF_TOKEN'),
+    max_tokens=2096,
+    temperature=0.5,
+    model_id=os.getenv('MODEL'),
+    custom_role_conversions=None,
 )
 
-
 # Import tool from Hub
-image_generation_tool = load_tool("agents-course/text-to-image", trust_remote_code=True)
+# image_generation_tool = load_tool("agents-course/text-to-image", trust_remote_code=True)
+
+web_search_tool = DuckDuckGoSearchTool()
 
 with open("prompts.yaml", 'r') as stream:
     prompt_templates = yaml.safe_load(stream)
     
 agent = CodeAgent(
     model=model,
-    tools=[final_answer], ## add your tools here (don't remove final answer)
+    tools=[final_answer, get_my_ip_address, get_ip_address_report, scan_url, get_scan_report], ## add your tools here (don't remove final answer)
     max_steps=6,
     verbosity_level=1,
     grammar=None,
@@ -61,5 +229,4 @@ agent = CodeAgent(
     prompt_templates=prompt_templates
 )
 
-
 GradioUI(agent).launch()

classes/get_url_report.py

@@ -0,0 +1,68 @@
+from dataclasses import dataclass
+from datetime import datetime
+
+@dataclass
+class Stats:
+    """
+    Represents the statistics of the analysis results.
+
+    Attributes:
+        malicious (int): Number of engines that detected the URL as malicious.
+        suspicious (int): Number of engines that detected the URL as suspicious.
+        undetected (int): Number of engines that did not detect the URL.
+        harmless (int): Number of engines that detected the URL as harmless.
+        timeout (int): Number of engines that timed out during the analysis.
+    """
+    malicious: int
+    suspicious: int
+    undetected: int
+    harmless: int
+    timeout: int
+
+@dataclass
+class Attributes:
+    """
+    Represents the attributes of the analysis. If status is queued, retry later.
+
+    Attributes:
+        date (int): The timestamp of the analysis in Unix epoch format.
+        status (str): The status of the analysis (e.g., "queued").
+        stats (Stats): An instance of the Stats class containing analysis statistics.
+    """
+    date: int
+    status: str
+    stats: Stats
+
+    def get_date_as_datetime(self) -> datetime:
+        """
+        Convert the Unix epoch timestamp to a datetime object.
+
+        Returns:
+            datetime: The datetime representation of the analysis date.
+        """
+        return datetime.fromtimestamp(self.date)
+
+@dataclass
+class Data:
+    """
+    Represents the data section of the VirusTotal analysis response.
+
+    Attributes:
+        id (str): The unique identifier for the analysis.
+        type (str): The type of the data, which is "analysis" in this context.
+        attributes (Attributes): An instance of the Attributes class containing analysis details.
+    """
+    id: str
+    type: str
+    attributes: Attributes
+
+@dataclass
+class GetURLReportResponse:
+    """
+    Represents the overall response from the VirusTotal API for a URL scan analysis.
+
+    Attributes:
+        data (Data): An instance of the Data class containing analysis details.
+    """
+    data: Data
+

classes/ip_address_report.py

@@ -0,0 +1,59 @@
+from dataclasses import dataclass
+
+@dataclass
+class TotalVotes:
+    """
+        Represents the total votes for an IP address.
+
+        Attributes:
+            harmless (int): The number of votes indicating the IP address is harmless.
+            malicious (int): The number of votes indicating the IP address is malicious.
+        """
+    harmless: int
+    malicious: int
+
+@dataclass
+class AnalysisStats:
+    """
+       Represents the statistics from the last analysis of an IP address.
+
+       Attributes:
+           malicious (int): The number of engines that detected the IP address as malicious.
+           suspicious (int): The number of engines that detected the IP address as suspicious.
+           undetected (int): The number of engines that did not detect any issues with the IP address.
+           harmless (int): The number of engines that detected the IP address as harmless.
+           timeout (int): The number of engines that timed out during the analysis.
+       """
+    malicious: int
+    suspicious: int
+    undetected: int
+    harmless: int
+    timeout: int
+
+@dataclass
+class IPAddressReport:
+    """
+    Represents a report for an IP address.
+
+    Attributes:
+        id (str): The ID of the IP address.
+        type (str): The type of the report (e.g., "ip_address").
+        reputation (int): The reputation score of the IP address.
+        continent (str): The continent where the IP address is located.
+        as_owner (str): The owner of the autonomous system (AS) associated with the IP address.
+        country (str): The country where the IP address is located.
+        tags (List[str]): A list of tags associated with the IP address.
+        total_votes (TotalVotes): The total votes for the IP address.
+        network (str): The network associated with the IP address.
+        last_analysis_stats (AnalysisStats): The statistics from the last analysis of the IP address.
+    """
+    id: str
+    type: str
+    reputation: int
+    continent: str
+    as_owner: str
+    country: str
+    tags: list
+    total_votes: TotalVotes
+    network: str
+    last_analysis_stats: AnalysisStats

classes/scan_url.py

@@ -0,0 +1,36 @@
+from dataclasses import dataclass
+from typing import Optional
+
+@dataclass
+class Links:
+    """
+    Represents the links associated with an analysis.
+
+    Attributes:
+        self_url (str): The URL to access the analysis resource itself.
+    """
+    self_url: str
+
+@dataclass
+class DataAnalysis:
+    """
+    Represents the data section of the VirusTotal analysis response.
+
+    Attributes:
+        type (str): The type of the data, which is "analysis" in this context.
+        id (str): The unique identifier for the analysis.
+        links (Links): An instance of the Links class containing related URLs.
+    """
+    type: str
+    id: str
+    links: Links
+
+@dataclass
+class ScanResponse:
+    """
+    Represents the overall response from the VirusTotal API for a URL scan analysis.
+
+    Attributes:
+        data (DataAnalysis): An instance of the DataAnalysis class containing analysis details.
+    """
+    data: DataAnalysis