Skip to content

SpiderFoot automates OSINT for threat intelligence and mapping your attack surface.

4.6 KB
Raw Blame
# -*- coding: utf-8 -*-
# -------------------------------------------------------------------------------
# Name:         sfp_textmagic
# Purpose:      Spiderfoot module to retrieve phone number type
#               using TextMagic API
#
# Author:      Krishnasis Mandal <[email protected]>
#
# Created:     2020-10-05
# Copyright:   (c) Steve Micallef
# Licence:     MIT
# -------------------------------------------------------------------------------
import json

from spiderfoot import SpiderFootEvent, SpiderFootPlugin


class sfp_textmagic(SpiderFootPlugin):

    meta = {
        "name": "TextMagic",
        "summary": "Obtain phone number type from TextMagic API",
        'flags': ["apikey"],
        "useCases": ["Passive"],
        "categories": ["Search Engines"],
        "dataSource": {
            "website": "https://www.textmagic.com/",
            "model": "FREE_AUTH_LIMITED",
            "references": [
                "https://docs.textmagic.com/"
            ],
            "apiKeyInstructions": [
                "Visit https://textmagic.com",
                "Register a free trial account",
                "Visit https://my.textmagic.com/online/api/rest-api/keys",
                "Click on 'Add new API Key'",
                "Your API key will be listed beside 'The new API Key is'"
            ],
            "favIcon": "https://www.textmagic.com/wp-content/themes/textmagic-genesis/assets/app/images/favicon.png",
            "logo": "https://www.textmagic.com/wp-content/uploads/2015/04/logo.png",
            "description": "TextMagic is a business text-messaging service for sending "
            "notifications, alerts, reminders, confirmations and SMS marketing campaigns.",
        },
    }

    opts = {
        "api_key_username": "",
        "api_key": "",
    }

    optdescs = {
        "api_key_username": "TextMagic API Username",
        "api_key": "TextMagic API Key",
    }

    errorState = False

    def setup(self, sfc, userOpts=None):
        if userOpts is None:
            userOpts = {}
        self.sf = sfc
        self.results = self.tempStorage()
        self.opts.update(userOpts)

    def watchedEvents(self):
        return [
            "PHONE_NUMBER"
        ]

    def producedEvents(self):
        return [
            "PHONE_NUMBER_TYPE",
            "RAW_RIR_DATA"
        ]

    def handle_error_response(self, qry, res):
        try:
            error_info = json.loads(res["content"])
        except Exception:
            error_info = None
        if error_info:
            error_message = error_info.get("message")
        else:
            error_message = None
        if error_message:
            error_str = f", message {error_message}"
        else:
            error_str = ""
        self.error(f"Failed to get results for {qry}, code {res['code']}{error_str}")

    def queryPhoneNumber(self, qry):
        headers = {
            'X-TM-Username': self.opts['api_key_username'],
            'X-TM-Key': self.opts['api_key']
        }

        res = self.sf.fetchUrl(
            f"https://rest.textmagic.com/api/v2/lookups/{qry}",
            headers=headers,
            timeout=self.opts["_fetchtimeout"],
            useragent="SpiderFoot",
        )

        if res["code"] != "200":
            self.handle_error_response(qry, res)
            return None

        if res['content'] is None:
            self.info(f"No TextMagic info found for {qry}")
            return None

        try:
            return json.loads(res['content'])
        except Exception as e:
            self.error(f"Error processing JSON response from TextMagic: {e}")

        return None

    def handleEvent(self, event):
        eventName = event.eventType
        srcModuleName = event.module
        eventData = event.data

        if self.errorState:
            return

        self.debug(f"Received event, {eventName}, from {srcModuleName}")

        if self.opts["api_key"] == "" or self.opts["api_key_username"] == "":
            self.error(
                f"You enabled {self.__class__.__name__} but did not set an API Username/Key!"
            )
            self.errorState = True
            return

        self.results[eventData] = True

        data = self.queryPhoneNumber(event.data)

        if data is None:
            return

        phoneNumberType = data.get("type")
        if phoneNumberType is not None:
            evt = SpiderFootEvent("RAW_RIR_DATA", str(data), self.__name__, event)
            self.notifyListeners(evt)

            evt = SpiderFootEvent("PHONE_NUMBER_TYPE", phoneNumberType, self.__name__, event)
            self.notifyListeners(evt)

# End of sfp_textmagic class