#! /usr/bin/env python3 """ Sherlock: Find Usernames Across Social Networks Module This module contains the main logic to search for usernames at social networks. """ import csv import json import os import platform import re import sys from argparse import ArgumentParser, RawDescriptionHelpFormatter from concurrent.futures import ThreadPoolExecutor from time import time import requests from colorama import Fore, Style, init from requests_futures.sessions import FuturesSession from torrequest import TorRequest module_name = "Sherlock: Find Usernames Across Social Networks" __version__ = "0.4.1" amount = 0 BANNER = r''' ."""-. / \ ____ _ _ _ | _..--'-. / ___|| |__ ___ _ __| | ___ ___| |__ >.`__.-""\;"` \___ \| '_ \ / _ \ '__| |/ _ \ / __| |/ / / /( ^\ ___) | | | | __/ | | | (_) | (__| < '-`) =|-. |____/|_| |_|\___|_| |_|\___/ \___|_|\_\ /`--.'--' \ .-. .'`-._ `.\ | J / / `--.| \__/'''[1:] # TODO: fix tumblr class ElapsedFuturesSession(FuturesSession): """ Extends FutureSession to add a response time metric to each request. This is taken (almost) directly from here: https://github.com/ross/requests-futures#working-in-the-background """ def request(self, method, url, hooks={}, *args, **kwargs): start = time() def timing(r, *args, **kwargs): elapsed_sec = time() - start r.elapsed = round(elapsed_sec * 1000) try: if isinstance(hooks['response'], (list, tuple)): # needs to be first so we don't time other hooks execution hooks['response'].insert(0, timing) else: hooks['response'] = [timing, hooks['response']] except KeyError: hooks['response'] = timing return super(ElapsedFuturesSession, self).request(method, url, hooks=hooks, *args, **kwargs) def print_error(err, errstr, var, verbose=False): print(Style.BRIGHT + Fore.WHITE + "[" + Fore.RED + "-" + Fore.WHITE + "]" + Fore.RED + f" {errstr}" + Fore.YELLOW + f" {err if verbose else var}") def format_response_time(response_time, verbose): return " [{} ms]".format(response_time) if verbose else "" def print_found(social_network, url, response_time, verbose=False): print((Style.BRIGHT + Fore.WHITE + "[" + Fore.GREEN + "+" + Fore.WHITE + "]" + format_response_time(response_time, verbose) + Fore.GREEN + " {}:").format(social_network), url) def print_not_found(social_network, response_time, verbose=False): print((Style.BRIGHT + Fore.WHITE + "[" + Fore.RED + "-" + Fore.WHITE + "]" + format_response_time(response_time, verbose) + Fore.GREEN + " {}:" + Fore.YELLOW + " Not Found!").format(social_network)) def get_response(request_future, error_type, social_network, verbose=False): try: rsp = request_future.result() if rsp.status_code: return rsp, error_type, rsp.elapsed except requests.exceptions.HTTPError as errh: print_error(errh, "HTTP Error:", social_network, verbose) except requests.exceptions.ConnectionError as errc: print_error(errc, "Error Connecting:", social_network, verbose) except requests.exceptions.Timeout as errt: print_error(errt, "Timeout Error:", social_network, verbose) except requests.exceptions.RequestException as err: print_error(err, "Unknown error:", social_network, verbose) return None, "", -1 def sherlock(username, site_data, verbose=False, tor=False, unique_tor=False, proxy=None): """Run Sherlock Analysis. Checks for existence of username on various social media sites. Keyword Arguments: username -- String indicating username that report should be created against. site_data -- Dictionary containing all of the site data. verbose -- Boolean indicating whether to give verbose output. tor -- Boolean indicating whether to use a tor circuit for the requests. unique_tor -- Boolean indicating whether to use a new tor circuit for each request. proxy -- String indicating the proxy URL Return Value: Dictionary containing results from report. Key of dictionary is the name of the social network site, and the value is another dictionary with the following keys: url_main: URL of main site. url_user: URL of user on site (if account exists). exists: String indicating results of test for account existence. http_status: HTTP status code of query which checked for existence on site. response_text: Text that came back from request. May be None if there was an HTTP error when checking for existence. """ global amount print((Style.BRIGHT + Fore.GREEN + "[" + Fore.YELLOW + "*" + Fore.GREEN + "] Checking username" + Fore.WHITE + " {}" + Fore.GREEN + " on:").format(username)) # A user agent is needed because some sites don't # return the correct information since they think that # we are bots headers = { 'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.12; rv:55.0) Gecko/20100101 Firefox/55.0' } # Allow 1 thread for each external service, so `len(site_data)` threads total executor = ThreadPoolExecutor(max_workers=len(site_data)) # Create session based on request methodology underlying_session = requests.session() underlying_request = requests.Request() if tor or unique_tor: underlying_request = TorRequest() underlying_session = underlying_request.session # Create multi-threaded session for all requests. Use our custom FuturesSession that exposes response time session = ElapsedFuturesSession( executor=executor, session=underlying_session) # Results from analysis of all sites results_total = {} # First create futures for all requests. This allows for the requests to run in parallel for social_network, net_info in site_data.items(): # Results from analysis of this specific site results_site = {} # Record URL of main site results_site['url_main'] = net_info.get("urlMain") # Don't make request if username is invalid for the site regex_check = net_info.get("regexCheck") if regex_check and re.search(regex_check, username) is None: # No need to do the check at the site: this user name is not allowed. print((Style.BRIGHT + Fore.WHITE + "[" + Fore.RED + "-" + Fore.WHITE + "]" + Fore.GREEN + " {}:" + Fore.YELLOW + " Illegal Username Format For This Site!").format(social_network)) results_site["exists"] = "illegal" else: # URL of user on site (if it exists) url = net_info["url"].format(username) results_site["url_user"] = url request_method = session.get if social_network != "GitHub": # If only the status_code is needed don't download the body if net_info["errorType"] == 'status_code': request_method = session.head if net_info["errorType"] == "response_url": # Site forwards request to a different URL if username not # found. Disallow the redirect so we can capture the # http status from the original URL request. allow_redirects = False else: # Allow whatever redirect that the site wants to do. # The final result of the request will be what is available. allow_redirects = True # This future starts running the request in a new thread, doesn't block the main thread if proxy != None: proxies = {"http": proxy, "https": proxy} future = request_method(url=url, headers=headers, proxies=proxies, allow_redirects=allow_redirects ) else: future = request_method(url=url, headers=headers, allow_redirects=allow_redirects ) # Store future in data for access later net_info["request_future"] = future # Reset identify for tor (if needed) if unique_tor: underlying_request.reset_identity() # Add this site's results into final dictionary with all of the other results. results_total[social_network] = results_site # Open the file containing account links # Core logic: If tor requests, make them here. If multi-threaded requests, wait for responses for social_network, net_info in site_data.items(): # Retrieve results again results_site = results_total.get(social_network) # Retrieve other site information again url = results_site.get("url_user") exists = results_site.get("exists") if exists is not None: # We have already determined the user doesn't exist here continue # Get the expected error type error_type = net_info["errorType"] # Default data in case there are any failures in doing a request. http_status = "?" response_text = "" # Retrieve future and ensure it has finished future = net_info["request_future"] r, error_type, response_time = get_response(request_future=future, error_type=error_type, social_network=social_network, verbose=verbose) # Attempt to get request information try: http_status = r.status_code except: pass try: response_text = r.text.encode(r.encoding) except: pass if error_type == "message": error = net_info.get("errorMsg") # Checks if the error message is in the HTML if not error in r.text: print_found(social_network, url, response_time, verbose) exists = "yes" amount = amount+1 else: print_not_found(social_network, response_time, verbose) exists = "no" elif error_type == "status_code": # Checks if the status code of the response is 2XX if not r.status_code >= 300 or r.status_code < 200: print_found(social_network, url, response_time, verbose) exists = "yes" amount = amount+1 else: print_not_found(social_network, response_time, verbose) exists = "no" elif error_type == "response_url": # For this detection method, we have turned off the redirect. # So, there is no need to check the response URL: it will always # match the request. Instead, we will ensure that the response # code indicates that the request was successful (i.e. no 404, or # forward to some odd redirect). if (r.status_code >= 200) and (r.status_code < 300): # print_found(social_network, url, response_time, verbose) exists = "yes" amount = amount+1 else: print_not_found(social_network, response_time, verbose) exists = "no" elif error_type == "": print((Style.BRIGHT + Fore.WHITE + "[" + Fore.RED + "-" + Fore.WHITE + "]" + Fore.GREEN + " {}:" + Fore.YELLOW + " Error!").format(social_network)) exists = "error" # Save exists flag results_site['exists'] = exists # Save results from request results_site['http_status'] = http_status results_site['response_text'] = response_text results_site['response_time_ms'] = response_time # Add this site's results into final dictionary with all of the other results. results_total[social_network] = results_site return results_total def main(): # Colorama module's initialization. init(autoreset=True) version_string = f"%(prog)s {__version__}\n" + \ f"{requests.__description__}: {requests.__version__}\n" + \ f"Python: {platform.python_version()}" parser = ArgumentParser(formatter_class=RawDescriptionHelpFormatter, description=f"{module_name} (Version {__version__})" ) parser.add_argument("--version", action="version", version=version_string, help="Display version information and dependencies." ) parser.add_argument("--verbose", "-v", "-d", "--debug", action="store_true", dest="verbose", default=False, help="Display extra debugging information and metrics." ) parser.add_argument("--folderoutput", "-fo", dest="folderoutput", help="If using multiple usernames, the output of the results will be saved at this folder." ) parser.add_argument("--output", "-o", dest="output", help="If using single username, the output of the result will be saved at this file." ) parser.add_argument("--tor", "-t", action="store_true", dest="tor", default=False, help="Make requests over TOR; increases runtime; requires TOR to be installed and in system path.") parser.add_argument("--unique-tor", "-u", action="store_true", dest="unique_tor", default=False, help="Make requests over TOR with new TOR circuit after each request; increases runtime; requires TOR to be installed and in system path.") parser.add_argument("--csv", action="store_true", dest="csv", default=False, help="Create Comma-Separated Values (CSV) File." ) parser.add_argument("--site", action="append", metavar='SITE_NAME', dest="site_list", default=None, help="Limit analysis to just the listed sites. Add multiple options to specify more than one site." ) parser.add_argument("--proxy", "-p", metavar='PROXY_URL', action="store", dest="proxy", default=None, help="Make requests over a proxy. e.g. socks5://127.0.0.1:1080" ) parser.add_argument("--json", "-j", metavar="JSON_FILE", dest="json_file", default="data.json", help="Load data from a JSON file or an online, valid, JSON file.") parser.add_argument("username", nargs='+', metavar='USERNAMES', action="store", help="One or more usernames to check with social networks." ) args = parser.parse_args() print(Fore.WHITE + Style.BRIGHT + BANNER) # Argument check # TODO regex check on args.proxy if args.tor and args.proxy != None: raise Exception("TOR and Proxy cannot be set in the meantime.") # Make prompts if args.proxy != None: print("Using the proxy: " + args.proxy) if args.tor or args.unique_tor: print("Using TOR to make requests") print("Warning: some websites might refuse connecting over TOR, so note that using this option might increase connection errors.") # Check if both output methods are entered as input. if args.output is not None and args.folderoutput is not None: print("You can only use one of the output methods.") sys.exit(1) # Check validity for single username output. if args.output is not None and len(args.username) != 1: print("You can only use --output with a single username") sys.exit(1) response_json_online = None site_data_all = None # Try to load json from website. try: response_json_online = requests.get(url=args.json_file) except requests.exceptions.MissingSchema: # In case the schema is wrong it's because it may not be a website pass # Check if the response is appropriate. if response_json_online is not None and response_json_online.status_code == 200: # Since we got data from a website, try to load json and exit if parsing fails. try: site_data_all = response_json_online.json() except ValueError: print("Invalid JSON from website!") sys.exit(1) pass data_file_path = os.path.join(os.path.dirname( os.path.realpath(__file__)), args.json_file) # This will be none if the request had a missing schema if site_data_all is None: # Check if the file exists otherwise exit. if not os.path.exists(data_file_path): print("JSON file at doesn't exist.") print( "If this is not a file but a website, make sure you have appended http:// or https://.") sys.exit(1) else: raw = open(data_file_path, "r", encoding="utf-8") try: site_data_all = json.load(raw) except: print("Invalid JSON loaded from file.") if args.site_list is None: # Not desired to look at a sub-set of sites site_data = site_data_all else: # User desires to selectively run queries on a sub-set of the site list. # Make sure that the sites are supported & build up pruned site database. site_data = {} site_missing = [] for site in args.site_list: for existing_site in site_data_all: if site.lower() == existing_site.lower(): site_data[existing_site] = site_data_all[existing_site] if not site_data: # Build up list of sites not supported for future error message. site_missing.append(f"'{site}'") if site_missing: print( f"Error: Desired sites not found: {', '.join(site_missing)}.") sys.exit(1) # Run report on all specified users. for username in args.username: print() if args.output: file = open(args.output, "w", encoding="utf-8") elif args.folderoutput: # In case we handle multiple usernames at a targetted folder. # If the folder doesnt exist, create it first if not os.path.isdir(args.folderoutput): os.mkdir(args.folderoutput) file = open(os.path.join(args.folderoutput, username + ".txt"), "w", encoding="utf-8") else: file = open(username + ".txt", "w", encoding="utf-8") results = {} results = sherlock(username, site_data, verbose=args.verbose, tor=args.tor, unique_tor=args.unique_tor, proxy=args.proxy) exists_counter = 0 for website_name in results: dictionary = results[website_name] if dictionary.get("exists") == "yes": exists_counter += 1 file.write(dictionary["url_user"] + "\n") file.write("Total Websites : {}".format(exists_counter)) file.close() if args.csv == True: with open(username + ".csv", "w", newline='', encoding="utf-8") as csv_report: writer = csv.writer(csv_report) writer.writerow(['username', 'name', 'url_main', 'url_user', 'exists', 'http_status', 'response_time_ms' ] ) for site in results: writer.writerow([username, site, results[site]['url_main'], results[site]['url_user'], results[site]['exists'], results[site]['http_status'], results[site]['response_time_ms'] ] ) if __name__ == "__main__": main()