├── metafinder ├── utils │ ├── __init__.py │ ├── file │ │ ├── __init__.py │ │ ├── parser.py │ │ ├── download.py │ │ └── metadata.py │ ├── finder │ │ ├── __init__.py │ │ ├── bing.py │ │ ├── google.py │ │ └── baidu.py │ ├── var_data.py │ ├── color_print.py │ ├── exception.py │ ├── agent.py │ ├── banner.py │ ├── result.py │ └── library.py ├── __init__.py ├── extractor.py ├── cli.py └── core.py ├── requirements.txt ├── .gitignore ├── CONTRIBUTING.md ├── .github └── pull_request_template.md ├── README.md ├── setup.py └── LICENSE /metafinder/utils/__init__.py: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /metafinder/utils/file/__init__.py: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /metafinder/__init__.py: -------------------------------------------------------------------------------- 1 | __version__ = "1.2" -------------------------------------------------------------------------------- /metafinder/utils/finder/__init__.py: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests 2 | pikepdf 3 | beautifulsoup4 4 | openpyxl 5 | python-docx 6 | python-pptx 7 | prompt-toolkit 8 | urllib3 9 | -------------------------------------------------------------------------------- /metafinder/utils/var_data.py: -------------------------------------------------------------------------------- 1 | # Define constants 2 | CONST_SEARCH_ENGINES = "search_engines" 3 | CONST_URL = "url" 4 | CONST_NAME = "name" 5 | CONST_METADATA = "metadata" 6 | CONST_STATUS_CODE = "status_code" 7 | -------------------------------------------------------------------------------- /metafinder/extractor.py: -------------------------------------------------------------------------------- 1 | from metafinder.utils.library import extract_metadata_from_google_search, extract_metadata_from_bing_search, extract_metadata_from_baidu_search 2 | from metafinder.utils.library import extract_metadata_from_document 3 | from metafinder.utils.exception import GoogleCaptcha, BaiduDetection, GoogleCookiePolicies -------------------------------------------------------------------------------- /metafinder/utils/color_print.py: -------------------------------------------------------------------------------- 1 | from prompt_toolkit import print_formatted_text, HTML 2 | 3 | 4 | 5 | def print_error(msg, start="", end=""): 6 | print_formatted_text(HTML(f"{start}[!] {msg}{end}")) 7 | 8 | def print_ok(msg, start="", end=""): 9 | print_formatted_text(HTML(f"{start}[+] {msg}{end}")) -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Byte-compiled / optimized / DLL files 3 | __pycache__/ 4 | *.py[cod] 5 | *$py.class 6 | *egg* 7 | 8 | # Results folder 9 | results/ 10 | *.tmp 11 | 12 | dist/ 13 | build/ 14 | 15 | # Pyre type checker 16 | .pyre/ 17 | \.vscode/ 18 | 19 | # Pycache 20 | __pycache__/ 21 | __pycache__ 22 | 23 | # Generated files 24 | /files 25 | \.DS_Store 26 | 27 | # Virtualenv 28 | venv/ -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to Metafinder 2 | 3 | ## Contribution Steps 4 | 5 | 1. Send a Pull Request following our pull requests guidelines. 6 | 2. New PRs go to the master branch when merging. 7 | 3. In the PR, describe all the changes, issues and fixes. 8 | 9 | ## Building Metafinder 10 | 11 | ### Pre-requisites 12 | 13 | - Python 3.8 14 | - Pip 15 | 16 | ``` 17 | git clone https://github.com/Josue87/MetaFinder 18 | cd metafinder 19 | ``` 20 | 21 | Create a new venv and install the dependencies: 22 | 23 | ``` 24 | python3 -m venv venv 25 | source venv/bin/activate 26 | pip3 install -r requirements.txt 27 | ``` 28 | 29 | To start locally run 30 | 31 | ``` 32 | python -m metafinder.cli [arguments] 33 | ``` 34 | 35 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | ### :pushpin: References 2 | 3 | - **Issue:** [BUG|TASK#](https://github.com/Josue87/MetaFinder/issues) 4 | 5 | ### :tophat: What is the goal? 6 | 7 | _Describe the changes in detail and why you opted for this solution_ 8 | 9 | ### :memo: Notes 10 | 11 | _Additional notes for reviewers, point them to the sections you want them to review more carefully, questions you may have, provide a description of the implementation_ 12 | 13 | ### :art: A picture is worth a thousand words 14 | 15 | _Screenshots, images and videos showcasing the new feature_ 16 | 17 | ### :white_check_mark: Checklist 18 | 19 | - [ ] I have made corresponding changes to the documentation 20 | - [ ] I have added tests that prove my fix is effective or that my feature works 21 | - [ ] I have checked this works with manual QA 22 | -------------------------------------------------------------------------------- /metafinder/utils/exception.py: -------------------------------------------------------------------------------- 1 | class GoogleCaptcha(Exception): 2 | def __init__(self, *args): 3 | self.data = "Google Captcha detected" 4 | if args: 5 | self.data = args[0] 6 | def __str__(self): 7 | return "GoogleCaptcha, {0}".format(self.data) 8 | 9 | class GoogleCookiePolicies(Exception): 10 | def __init__(self, *args): 11 | self.data = "Google Cookie Policy detected" 12 | if args: 13 | self.data = args[0] 14 | def __str__(self): 15 | return "GoogleCookiePolicies, {0}".format(self.data) 16 | 17 | class BaiduDetection(Exception): 18 | def __init__(self, *args): 19 | self.data = "Baidu Robot detected" 20 | if args: 21 | self.data = args[0] 22 | def __str__(self): 23 | return "BaiduDetection, {0}".format(self.data) -------------------------------------------------------------------------------- /metafinder/utils/agent.py: -------------------------------------------------------------------------------- 1 | user_agent = { 2 | 0: {'User-agent': 'Mozilla/5.0 (Linux; Android 10; SM-A205U) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.86 Mobile Safari/537.36'}, 3 | 1: {'User-agent': 'Mozilla/5.0 (Windows NT 10.0; WOW64; Trident/7.0; rv:11.0) like Gecko'}, 4 | 2: {'User-agent': 'Opera/9.80 (Linux armv7l) Presto/2.12.407 Version/12.51 , D50u-D1-UHD/V1.5.16-UHD (Vizio, D50u-D1, Wireless)'}, 5 | 3: {'User-agent': 'BrightSign/7.1.95 (XT1143) Mozilla/5.0 (Unknown; Linux arm) AppleWebKit/537.36 (KHTML, like Gecko) QtWebEngine/5.6.0 Chrome/45.0.2454.101 Safari/537.36'}, 6 | 4: {'User-agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.24 Safari/537.36'}, 7 | 5: {'User-agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36'}, 8 | 6: {'User-agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.157 Safari/537.36'} 9 | } -------------------------------------------------------------------------------- /metafinder/utils/banner.py: -------------------------------------------------------------------------------- 1 | from metafinder import __version__ 2 | 3 | 4 | banner = """ 5 | _____ __ ___________ .__ .___ 6 | / \ ____ _/ |_ _____ \_ _____/ |__| ____ __| _/ ____ _______ 7 | / \ / \ _/ __ \ \ __\ \__ \ | __) | | / \ / __ | _/ __ \ \_ __ \ 8 | / Y \ \ ___/ | | / __ \_ | \ | | | | \ / /_/ | \ ___/ | | \/ 9 | \____|__ / \___ > |__| (____ / \___ / |__| |___| / \____ | \___ > |__| 10 | \/ \/ \/ \/ \/ \/ \/ 11 | """ 12 | 13 | author = "@JosueEncinar" 14 | description = "Search for documents in a domain through Search Engines. The objective is to extract metadata" 15 | usage_example = "metafinder -d domain.com -l 50 -o /tmp -go -bi" 16 | 17 | 18 | def show_banner(): 19 | print(banner) 20 | print(f"|_ Author: {author}") 21 | print(f"|_ Description: {description}") 22 | print(f"|_ Version: {__version__}") 23 | print(f"|_ Usage: {usage_example}") 24 | print("") 25 | -------------------------------------------------------------------------------- /metafinder/utils/result.py: -------------------------------------------------------------------------------- 1 | class Result: 2 | """Result class 3 | 4 | Functions: 5 | get_metadata: Return all metadata collected. 6 | get_authors: Returns all authors found in a list. 7 | get_software: Returns all software found in a list. 8 | """ 9 | def __init__(self, metadata): 10 | self._metadata = metadata 11 | self._authors, self._software = self._configure_data(metadata) 12 | 13 | def get_metadata(self): 14 | return self._metadata 15 | 16 | def get_authors(self): 17 | return self._authors 18 | 19 | def get_software(self): 20 | return self._software 21 | 22 | def _configure_data(self, metadata): 23 | authors = [] 24 | software = [] 25 | for key, value in metadata.items(): 26 | for v in value["metadata"]: 27 | if v and v == "Author" and value["metadata"][v] not in authors: 28 | authors.append(value["metadata"][v]) 29 | elif v and (v == "Producer" or v == "Creator") and value["metadata"][v] not in software: 30 | software.append(value["metadata"][v]) 31 | return authors, software 32 | 33 | 34 | -------------------------------------------------------------------------------- /metafinder/utils/file/parser.py: -------------------------------------------------------------------------------- 1 | from os import sep 2 | from metafinder.utils.var_data import * 3 | 4 | 5 | def file_parser_list(directory, name, data): 6 | file_name = directory + sep + name 7 | with open(file_name, "w") as output: 8 | for d in data: 9 | output.write(f'{d}\n') 10 | 11 | def file_parser(directory, name, metadata): 12 | file_name = directory + sep + name 13 | with open(file_name, "w") as output: 14 | for key, value in metadata.items(): 15 | output.write("\n") 16 | output.write(key + "\n") 17 | output.write("-"* len(key) + "\n") 18 | output.write(f"URL: {value[CONST_URL]}\n") 19 | output.write(f"Status code: {value[CONST_STATUS_CODE]}\n") 20 | engines = "" 21 | for se in value[CONST_SEARCH_ENGINES]: 22 | engines = se + ", " 23 | output.write(f"Search engines: {engines[0:-2]}\n") 24 | if value[CONST_METADATA]: 25 | for v in value[CONST_METADATA]: 26 | if value[CONST_METADATA][v] is not None: 27 | output.write(f'|_ {v}: {value[CONST_METADATA][v]}\n') 28 | else: 29 | output.write(f'|_ No metadata found\n') 30 | 31 | -------------------------------------------------------------------------------- /metafinder/utils/finder/bing.py: -------------------------------------------------------------------------------- 1 | from urllib.parse import urlencode, urlunparse 2 | from urllib.request import urlopen, Request 3 | from bs4 import BeautifulSoup 4 | from random import randint 5 | from metafinder.utils.agent import user_agent 6 | 7 | def search(target, total): 8 | bing_count = 25 9 | documents = [] 10 | url = f"https://www.bing.com/search?q=site:{target}+(filetype:pdf+OR+filetype:doc+OR%20filetype:docx+OR+filetype:xls+OR+filetype:xlsx+OR+filetype:ppt+OR+filetype:pptx)&count={bing_count}" 11 | try: 12 | count = 0 13 | iter_count = int(total/bing_count) 14 | if (total%bing_count) != 0: 15 | iter_count +=1 16 | while (count < iter_count) and (len(documents) < total): 17 | this_count = count*bing_count + 1 18 | new_url = url + f"&first={this_count}&FORM=PERE" 19 | req = Request(new_url, headers={"User-Agent": user_agent.get(randint(0, len(user_agent)-1))["User-agent"]}) 20 | page = urlopen(req) 21 | soup = BeautifulSoup(page.read(), "html.parser") 22 | all_links = soup.find_all("a") 23 | for link in all_links: 24 | href = link.get("href", None) 25 | if href and target in href and \ 26 | (href.endswith("pdf") or href.endswith("doc") or href.endswith("docx") or href.endswith("ppt") or href.endswith("pptx") or href.endswith("xls") or href.endswith("xlsx")) \ 27 | and href not in documents: 28 | documents.append(href) 29 | if len(documents) >= total: 30 | break 31 | count += 1 32 | except Exception as e: 33 | pass 34 | return documents 35 | -------------------------------------------------------------------------------- /metafinder/utils/finder/google.py: -------------------------------------------------------------------------------- 1 | import requests 2 | from bs4 import BeautifulSoup 3 | from random import randint 4 | from metafinder.utils.exception import GoogleCaptcha, GoogleCookiePolicies 5 | from metafinder.utils.agent import user_agent 6 | import urllib3 7 | urllib3.disable_warnings() 8 | 9 | 10 | def search(target, total): 11 | documents = [] 12 | start = 0 13 | num = 50 if total > 50 else total 14 | iterations = int(total/50) 15 | if (total%50) != 0: 16 | iterations += 1 17 | ## Check https://github.com/n4xh4ck5/RastLeak - thanks Nacho 18 | url_base = f"https://www.google.com/search?q=(ext:pdf OR ext:doc OR ext:docx OR ext:xls OR ext:xlsx OR ext:ppt OR ext:pptx)+(site:*.{target} OR site:{target})&num={num}" 19 | cookies = {"CONSENT": "YES+srp.gws"} 20 | while (start < iterations) and (len(documents) < total): 21 | try: 22 | url = url_base + f"&start={start}" 23 | response = requests.get(url, 24 | headers={'User-agent': 'APIs-Google (+https://developers.google.com/webmasters/APIs-Google.html)'}, 25 | timeout=5, 26 | verify=False, 27 | allow_redirects=False, 28 | cookies=cookies) 29 | text = response.text 30 | if response.status_code == 302 and ("htps://www.google.com/webhp" in text or "https://consent.google.com" in text): 31 | raise GoogleCookiePolicies() 32 | if "detected unusual traffic" in text: 33 | raise GoogleCaptcha() 34 | soup = BeautifulSoup(text, "html.parser") 35 | all_links = soup.find_all("a") 36 | follow = False 37 | for link in all_links: 38 | href = link.get("href", None) 39 | if href and target in href and "google" not in href: 40 | try: 41 | href = "http" + href.split("=http")[1] 42 | href = href.split("&sa=U&")[0] 43 | follow = True 44 | if href not in documents: 45 | documents.append(href) 46 | if len(documents) >= total: 47 | break 48 | except: 49 | continue 50 | if not follow: 51 | break 52 | except Exception as ex: 53 | raise ex #It's left over... but it stays there 54 | start += 1 55 | return documents -------------------------------------------------------------------------------- /metafinder/utils/file/download.py: -------------------------------------------------------------------------------- 1 | from os import sep, listdir, remove 2 | import os.path 3 | from concurrent.futures import ThreadPoolExecutor, as_completed 4 | from metafinder.utils.file.metadata import extract_metadata 5 | import time 6 | from os import sep 7 | import requests 8 | from random import randint 9 | from metafinder.utils.agent import user_agent 10 | from metafinder.utils.var_data import * 11 | 12 | # Disable warning by SSL certificate 13 | import urllib3 14 | urllib3.disable_warnings() 15 | from metafinder.utils.color_print import print_error, print_ok 16 | 17 | 18 | def download_document(element, directory, display): 19 | metadata = {} 20 | url = element[CONST_URL] 21 | search_engines = element[CONST_SEARCH_ENGINES] 22 | try: 23 | response = requests.get(url, headers=user_agent.get(randint(0, len(user_agent)-1)), timeout=10, verify=False) 24 | url = response.url 25 | name = url.split(sep)[-1].split('?')[0] 26 | file_name = directory + sep + name 27 | s_code = response.status_code 28 | data = {} 29 | if s_code == 200: 30 | with open(file_name, "wb") as f: 31 | f.write(response.content) 32 | data = extract_metadata(file_name) 33 | if display: 34 | print_ok(f"Downloaded file {url}") 35 | elif display: 36 | print_error(f"(Status code: {s_code}) File {url}") 37 | metadata = { 38 | CONST_NAME: name, 39 | CONST_URL: url, 40 | CONST_METADATA: data, 41 | CONST_STATUS_CODE: s_code, 42 | CONST_SEARCH_ENGINES: search_engines} 43 | except Exception as ex: 44 | if display: 45 | print_error(f"Error donwloading {url} >> {ex}") 46 | return metadata 47 | 48 | 49 | def download_file(urls_metadata, directory, threads, display=True): 50 | metadata_files = {} 51 | with ThreadPoolExecutor(max_workers=threads) as executor: 52 | future_download = {executor.submit(download_document, url, directory, display): url for url in urls_metadata} 53 | for future in as_completed(future_download): 54 | try: 55 | data = future.result() 56 | if data: 57 | name = data[CONST_NAME] 58 | del data[CONST_NAME] 59 | metadata_files[name] = data 60 | except Exception as ex: 61 | if display: 62 | print_error(f"Error: {ex}") 63 | try: 64 | for f in listdir(directory): 65 | remove(os.path.join(directory, f)) 66 | except: 67 | pass 68 | return metadata_files 69 | 70 | -------------------------------------------------------------------------------- /metafinder/utils/finder/baidu.py: -------------------------------------------------------------------------------- 1 | import requests 2 | from bs4 import BeautifulSoup 3 | from time import sleep 4 | from random import randint 5 | from metafinder.utils.exception import BaiduDetection 6 | from metafinder.utils.agent import user_agent 7 | from concurrent.futures import ThreadPoolExecutor, as_completed 8 | import urllib3 9 | urllib3.disable_warnings() 10 | 11 | def _get_link(baidu_link): 12 | location = None 13 | try: 14 | resp = requests.get(baidu_link, timeout=5, allow_redirects=False) 15 | location = resp.headers.get("Location", None) # Get redirection (Real link) 16 | except: 17 | pass 18 | return location 19 | 20 | def search(target, total): 21 | num_results = 50 if total >= 50 else total 22 | documents = [] 23 | base_url = "https://www.baidu.com/s?ie=utf-8" 24 | total_loop = int(total/num_results) 25 | if (total%num_results) != 0: 26 | total_loop += 1 27 | count = 1 28 | old_useragent = -1 29 | total_timeout = 0 30 | while (count <= total_loop) and (len(documents) < total): 31 | while True: 32 | next_useragent = randint(0, len(user_agent)-1) 33 | if next_useragent != old_useragent: 34 | break 35 | old_useragent = next_useragent 36 | new_url = base_url + f"&pn={count*num_results}&wd=(site:{target}+|+site:*.{target})+filetype:pdf&rn={num_results}" 37 | try: 38 | new_agent = user_agent.get(count, next_useragent) 39 | response = requests.get(new_url, headers=new_agent, timeout=5, verify=False) 40 | text = response.text 41 | if "timeout-button" in text: 42 | total_timeout += 1 43 | if total_timeout == 5: 44 | raise BaiduDetection 45 | sleep(2) 46 | continue 47 | soup = BeautifulSoup(text, "html.parser") 48 | all_h3 = soup.findAll("h3", {"class": "t"}) 49 | for h3 in all_h3: 50 | href = h3.a.get("href", None) 51 | if href and href not in documents: 52 | documents.append(href) 53 | if len(documents) >= total: 54 | break 55 | except Exception as ex: 56 | raise ex #It's left over... but it stays there 57 | count += 1 58 | return_documents = [] 59 | with ThreadPoolExecutor(max_workers=6) as executor: 60 | future_download = {executor.submit(_get_link, url): url for url in documents} 61 | for future in as_completed(future_download): 62 | try: 63 | data = future.result() 64 | if data and data not in return_documents: 65 | return_documents.append(data) 66 | except: 67 | pass 68 | return return_documents 69 | -------------------------------------------------------------------------------- /metafinder/utils/file/metadata.py: -------------------------------------------------------------------------------- 1 | from docx import Document 2 | import pikepdf 3 | from openpyxl import load_workbook 4 | from pptx import Presentation 5 | from datetime import datetime 6 | 7 | 8 | def _get_properties(prop): 9 | metadata = {} 10 | metadata["Author"] = prop.author 11 | metadata["Comments"] = prop.comments 12 | metadata["Created"] = str(prop.created) 13 | metadata["Identifier"] = prop.identifier 14 | metadata["Keywords"] = prop.keywords 15 | metadata["Modified"] = str(prop.modified) 16 | metadata["Subject"] = prop.subject 17 | metadata["Title"] = prop.title 18 | 19 | def extract_doc(document): 20 | doc = Document(document) 21 | prop = doc.core_properties 22 | return _get_properties(prop) 23 | 24 | def extract_pdf(document): 25 | metadata = {} 26 | with pikepdf.open(document) as pdf: 27 | info = pdf.docinfo 28 | for meta in info: 29 | data = str(info.get(meta, "")) 30 | if data and data.startswith("D:"): 31 | try: 32 | d = data.split("D:")[1].split("+")[0] 33 | data = str(datetime.strptime(d,"%Y%m%d%H%M%S")) 34 | except: 35 | pass 36 | metadata[meta[1:]] = data # [1:] avoid first element '/' 37 | return metadata 38 | 39 | 40 | def extract_xls(document): 41 | wb = load_workbook(document) 42 | prop = wb.properties 43 | return _get_properties(prop) 44 | 45 | def extract_ppt(document): 46 | pptx_presentation = Presentation(document) 47 | prop = pptx_presentation.core_properties 48 | return _get_properties(prop) 49 | 50 | 51 | def remove_indirect_object(metadata): 52 | new_metadata = {} 53 | for m in metadata: 54 | value = metadata[m] 55 | if "IndirectObject(" not in str(value) and str(value) != "": 56 | new_metadata[m] = value 57 | return new_metadata 58 | 59 | 60 | def extract_metadata(document): 61 | try: 62 | if document.endswith("pdf"): 63 | metadata = extract_pdf(document) 64 | elif document.endswith("doc") or document.endswith("docx"): 65 | metadata = extract_doc(document) 66 | elif document.endswith("xls") or document.endswith("xlsx"): 67 | metadata = extract_xls(document) 68 | elif document.endswith("ppt") or document.endswith("pptx"): 69 | metadata = extract_ppt(document) 70 | else: 71 | metadata = {} 72 | except: 73 | metadata = {} 74 | 75 | return remove_indirect_object(metadata) 76 | 77 | 78 | 79 | 80 | -------------------------------------------------------------------------------- /metafinder/cli.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | from os import sep, listdir, remove 3 | import os.path 4 | import sys 5 | from pathlib import Path 6 | from metafinder.utils.banner import show_banner 7 | from metafinder.core import processing 8 | from metafinder import __version__ 9 | 10 | 11 | def main(argv=None): 12 | """The entry point for the script 13 | 14 | Args: 15 | argv (list): The list of parameters passed. 16 | """ 17 | parser = argparse.ArgumentParser() 18 | parser.add_argument('-d','--domain', help="Domain to search",required=True) 19 | parser.add_argument('-o','--output', help="Folder where the results will be stored",required=True, default="results") 20 | parser.add_argument('-l','--limit', help="Limit of documents to search in the searchs engines (max 250)", type=int, required=True) 21 | parser.add_argument('-t','--threads', help="Number of threads for downloading documents", type=int, default=4) 22 | parser.add_argument('-go','--google', help="Search in Google", action='store_true', default=False) 23 | parser.add_argument('-bi','--bing', help="Search in Bing", action='store_true', default=False) 24 | parser.add_argument('-ba','--baidu', help="Search in Baidu", action='store_true', default=False) 25 | parser.add_argument('-v','--version', help="Show Metafinder version", action='version', version=__version__) 26 | 27 | args = parser.parse_args() 28 | show_banner() 29 | directory = Path(args.output) / args.domain 30 | directory.mkdir(parents=True, exist_ok=True) 31 | search_engines = { 32 | "google": args.google, 33 | "bing": args.bing, 34 | "baidu": args.baidu 35 | } 36 | some_election = False 37 | for k,v in search_engines.items(): 38 | if v: 39 | some_election = True 40 | break 41 | 42 | if not some_election: 43 | search_engines["google"] = True 44 | 45 | limit = 250 if args.limit > 250 else args.limit # max 250 46 | 47 | try: 48 | processing(args.domain, limit, str(directory), args.threads, search_engines) 49 | except KeyboardInterrupt: 50 | print("[-] MetaFinder has been interrupted. Deleting files.") 51 | try: 52 | for f in listdir(directory): 53 | remove(os.path.join(directory, f)) 54 | except: 55 | pass 56 | try: 57 | for f in listdir("."): 58 | if f.endswith(".tmp"): 59 | remove(os.path.join(directory, f)) 60 | except: 61 | pass 62 | print("Bye.") 63 | 64 | 65 | if __name__ == '__main__': 66 | main(sys.argv[1:]) 67 | 68 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | MetaFinder 3 |
4 |

5 |

6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 |

15 | 16 |

17 | Search for documents in a domain through Search Engines. The objective is to extract metadata. 18 |

19 |
20 | 21 | ## Installation: 22 | 23 | ``` 24 | > pip3 install metafinder 25 | ``` 26 | 27 | Upgrades are also available using: 28 | 29 | ``` 30 | > pip3 install metafinder --upgrade 31 | ``` 32 | 33 | ## Usage 34 | 35 | MetaFinder can be used in 2 ways: 36 | 37 | ### CLI 38 | ``` 39 | metafinder -d domain.com -l 20 -o folder [-t 10] -go -bi -ba 40 | ``` 41 | 42 | Parameters: 43 | * d: Specifies the target domain. 44 | * l: Specify the maximum number of results to be searched in the searchs engines. 45 | * o: Specify the path to save the report. 46 | * t: Optional. Used to configure the threads (4 by default). 47 | * v: Show Metafinder version. 48 | * Search Engines to select (Google by default): 49 | * go: Optional. Search in Google. 50 | * bi: Optional. Search in Bing. 51 | * ba: Optional. Search in Baidu. (Experimental) 52 | 53 | ### In Code 54 | ``` 55 | import metafinder.extractor as metadata_extractor 56 | 57 | documents_limit = 5 58 | domain = "target_domain" 59 | result = metadata_extractor.extract_metadata_from_google_search(domain, documents_limit) 60 | # result = metadata_extractor.extract_metadata_from_bing_search(domain, documents_limit) 61 | # result = metadata_extractor.extract_metadata_from_baidu_search(domain, documents_limit) 62 | authors = result.get_authors() 63 | software = result.get_software() 64 | for k,v in result.get_metadata().items(): 65 | print(f"{k}:") 66 | print(f"|_ URL: {v['url']}") 67 | for metadata,value in v['metadata'].items(): 68 | print(f"|__ {metadata}: {value}") 69 | 70 | document_name = "test.pdf" 71 | try: 72 | metadata_file = metadata_extractor.extract_metadata_from_document(document_name) 73 | for k,v in metadata_file.items(): 74 | print(f"{k}: {v}") 75 | except FileNotFoundError: 76 | print("File not found") 77 | ``` 78 | 79 | ## Example 80 | 81 | ![image](https://user-images.githubusercontent.com/16885065/118243158-69ee7600-b49e-11eb-9562-2dc1fab59d67.png) 82 | 83 | # Author 84 | 85 | This project has been developed by: 86 | 87 | * **Josué Encinar García** -- [@JosueEncinar](https://twitter.com/JosueEncinar) 88 | 89 | 90 | # Contributors 91 | 92 | 93 | * **Félix Brezo Fernández** -- [@febrezo](https://twitter.com/febrezo) 94 | 95 | 96 | # Disclaimer! 97 | 98 | The software is designed to leave no trace in the documents we upload to a domain. The author is not responsible for any illegitimate use. 99 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | 2 | from setuptools import setup, find_packages 3 | from os import path 4 | import metafinder 5 | 6 | 7 | long_description = """ 8 | **MetaFinder - Metadata search through Search Engines** 9 | ======================================================= 10 | 11 | Installation: 12 | ------------- 13 | 14 | > pip3 install metafinder 15 | 16 | Upgrades are also available using: 17 | 18 | > pip3 install metafinder --upgrade 19 | 20 | Usage 21 | ----- 22 | 23 | MetaFinder can be used in 2 ways: 24 | 25 | CLI 26 | --- 27 | 28 | metafinder -d domain.com -l 20 -o folder [-t 10] -go -bi -ba 29 | 30 | Parameters: 31 | 32 | - d: Specifies the target domain. 33 | - l: Specify the maximum number of results to be searched. 34 | - o: Specify the path to save the report. 35 | - t: Optional. Used to configure the threads (4 by default). 36 | - v: Show Metafinder version. 37 | - go: Optional. Search in Google. (Default) 38 | - bi: Optional. Search in Bing. 39 | - ba: Optional. Search in Baidu. (Experimental) 40 | 41 | In Code 42 | ------- 43 | 44 | import metafinder.extractor as metadata_extractor 45 | 46 | documents_limit = 5 47 | domain = "target_domain" 48 | result = metadata_extractor.extract_metadata_from_google_search(domain, documents_limit) 49 | # result = metadata_extractor.extract_metadata_from_bing_search(domain, documents_limit) 50 | # result = metadata_extractor.extract_metadata_from_baidu_search(domain, documents_limit) 51 | authors = result.get_authors() 52 | software = result.get_software() 53 | for k,v in result.get_metadata().items(): 54 | print(f"{k}:") 55 | print(f"|_ URL: {v['url']}") 56 | for metadata,value in v['metadata'].items(): 57 | print(f"|__ {metadata}: {value}") 58 | 59 | document_name = "test.pdf" 60 | try: 61 | metadata_file = metadata_extractor.extract_metadata_from_document(document_name) 62 | for k,v in metadata_file.items(): 63 | print(f"{k}: {v}") 64 | except FileNotFoundError: 65 | print("File not found") 66 | 67 | Author 68 | ====== 69 | 70 | This project has been developed by: 71 | 72 | - **Josué Encinar García** -- https://twitter.com/JosueEncinar 73 | 74 | Contributors 75 | ============ 76 | 77 | - **Félix Brezo Fernández** -- https://twitter.com/febrezo 78 | 79 | Disclaimer! 80 | =========== 81 | 82 | The software is designed to leave no trace in the documents we upload to a domain. The author is not responsible for any 83 | illegitimate use. 84 | 85 | 86 | """ 87 | 88 | setup( 89 | name='metafinder', 90 | version=metafinder.__version__, 91 | author='Josue Encinar (@JosueEncinar)', 92 | description='MetaFinder - Metadata search through Search Engines', 93 | include_package_data=True, 94 | license='GNU GPLv3+', 95 | packages=find_packages(), 96 | long_description=long_description, 97 | long_description_content_type='text/markdown', 98 | url="https://github.com/Josue87/MetaFinder", 99 | entry_points={ 100 | 'console_scripts': [ 101 | 'metafinder=metafinder.cli:main', 102 | ], 103 | }, 104 | install_requires=[ 105 | "requests>=2.25.1", 106 | "pikepdf>=2.5.2", 107 | "beautifulsoup4>=4.9.3", 108 | "openpyxl>=3.0.5", 109 | "python-docx>=0.8.6", 110 | "python-pptx>=0.6.18", 111 | "prompt-toolkit>=3.0.5", 112 | "urllib3>=1.26.4" 113 | ] 114 | ) 115 | -------------------------------------------------------------------------------- /metafinder/utils/library.py: -------------------------------------------------------------------------------- 1 | from pathlib import Path 2 | import tempfile 3 | from os.path import isfile 4 | from metafinder.utils.finder import google 5 | from metafinder.utils.finder import bing 6 | from metafinder.utils.finder import baidu 7 | from metafinder.utils.file.download import download_file 8 | from metafinder.utils.file.metadata import extract_metadata 9 | from metafinder.utils.result import Result 10 | from metafinder.utils.var_data import * 11 | 12 | 13 | def _generate_list(links, search_engine): 14 | result = [] 15 | for link in links: 16 | result.append({ 17 | CONST_URL: link, 18 | CONST_SEARCH_ENGINES: [search_engine] 19 | }) 20 | return result 21 | 22 | def extract_metadata_from_google_search(domain, limit=50, threads=4): 23 | """Search metadata in files through Google 24 | 25 | Args: 26 | domain: Target domain. 27 | limit: Maximum number of files to search. 28 | threads: Threads for downloading documents. 29 | 30 | Raises: 31 | GoogleCaptcha: If Google displays the captcha. 32 | Exception: If there is an error 33 | 34 | Returns: 35 | dict: Result object 36 | """ 37 | links = google.search(domain, limit) 38 | directory = tempfile.TemporaryDirectory() 39 | metadata_files = None 40 | if links and len(links) > 0: 41 | metadata_files = download_file(_generate_list(links, "Google"), directory.name, threads, False) 42 | directory.cleanup() 43 | return Result(metadata_files) if metadata_files else None 44 | 45 | def extract_metadata_from_bing_search(domain, limit=50, threads=4): 46 | """Search metadata in files through Bing 47 | 48 | Args: 49 | domain: Target domain. 50 | limit: Maximum number of files to search. 51 | threads: Threads for downloading documents. 52 | 53 | Raises: 54 | Exception: If there is an error 55 | 56 | Returns: 57 | dict: Result object 58 | """ 59 | links = bing.search(domain, limit) 60 | directory = tempfile.TemporaryDirectory() 61 | metadata_files = None 62 | if len(links) > 0: 63 | metadata_files = download_file(_generate_list(links, "Bing"), directory.name, threads, False) 64 | directory.cleanup() 65 | return Result(metadata_files) if metadata_files else None 66 | 67 | def extract_metadata_from_baidu_search(domain, limit=50, threads=2): 68 | """Search metadata in PDF files through Baidu (slow method) 69 | 70 | Args: 71 | domain: Target domain. 72 | limit: Maximum number of files to search. 73 | threads: Threads for downloading documents. 74 | 75 | Raises: 76 | BaiduDetection: If Google displays the captcha. 77 | Exception: If there is an error 78 | 79 | Returns: 80 | dict: Result object 81 | """ 82 | links = baidu.search(domain, limit) 83 | directory = tempfile.TemporaryDirectory() 84 | metadata_files = None 85 | if len(links) > 0: 86 | metadata_files = download_file(_generate_list(links, "Baidu"), directory.name, threads, False) 87 | directory.cleanup() 88 | return Result(metadata_files) if metadata_files else None 89 | 90 | def extract_metadata_from_document(document): 91 | """Search metadata in a document 92 | 93 | Args: 94 | document: Document to be analyze. 95 | 96 | Raises: 97 | FileNotFoundError: If file doesn't exist. 98 | 99 | Returns: 100 | dict: A json with metadata 101 | """ 102 | if isfile(document): 103 | return extract_metadata(document) 104 | raise FileNotFoundError() 105 | -------------------------------------------------------------------------------- /metafinder/core.py: -------------------------------------------------------------------------------- 1 | from metafinder.utils.finder import google 2 | from metafinder.utils.finder import bing 3 | from metafinder.utils.finder import baidu 4 | from metafinder.utils.file.download import download_file 5 | from metafinder.utils.file.parser import file_parser_list, file_parser 6 | from metafinder.utils.color_print import print_error, print_ok 7 | from metafinder.utils.result import Result 8 | from metafinder.utils.var_data import * 9 | 10 | 11 | def _get_links(target, limit, directory, threads, search_engines): 12 | links = [] 13 | search_engines_methods = { 14 | "google": google.search, 15 | "bing": bing.search, 16 | "baidu": baidu.search 17 | } 18 | for engine in search_engines_methods.keys(): 19 | aux_links = [] 20 | if search_engines.get(engine, False): 21 | print(f"Searching in {engine}") 22 | try: 23 | aux_links = search_engines_methods[engine](target, limit) 24 | for link_to_check in aux_links: 25 | exist = False 26 | i = 0 27 | for exist_link in links: 28 | if link_to_check == exist_link[CONST_URL]: 29 | exist = True 30 | links[i][CONST_SEARCH_ENGINES].append(engine) 31 | break 32 | i += 1 33 | 34 | if not exist: 35 | links.append({ 36 | CONST_SEARCH_ENGINES: [engine], 37 | CONST_URL: link_to_check}) 38 | print_ok("Done", end="\n") 39 | except KeyboardInterrupt: 40 | print(f"{engine} interrupted\n") 41 | except Exception as ex: 42 | print_error(f"{engine} error {ex}", end="\n") 43 | return links 44 | 45 | 46 | def processing(target, limit, directory, threads, search_engines): 47 | links = _get_links(target, limit, directory, threads, search_engines) 48 | total_links = len(links) 49 | links_msg = f"Total files to be analyzed: {total_links}" 50 | print(links_msg) 51 | print("-" * len(links_msg)) 52 | if total_links > 0: 53 | try: 54 | metadata_result = Result(download_file(links, directory, threads)) 55 | authors = metadata_result.get_authors() 56 | software = metadata_result.get_software() 57 | metadata_files = metadata_result.get_metadata() 58 | print("\nAnalyzing metadata...") 59 | if metadata_files: 60 | software_msg = f"Software data found: {len(software)}" 61 | authors_msg = f"Authors found: {len(authors)}" 62 | print(f"\n{authors_msg}") 63 | print("-" * len(authors_msg)) 64 | for a in authors: 65 | print(a) 66 | print(f"\n{software_msg}") 67 | print("-" * len(software_msg)) 68 | for s in software: 69 | print(s) 70 | metadata_filename = "metadata_result.txt" 71 | authors_filename = "authors.txt" 72 | software_filename = "software.txt" 73 | file_parser_list(directory, authors_filename, authors) 74 | file_parser_list(directory, software_filename, software) 75 | print("") 76 | print_ok(f"Authors data have been saved in file {directory}/{authors_filename}") 77 | print_ok(f"Software data have been saved in file {directory}/{software_filename}") 78 | file_parser(directory, metadata_filename, metadata_files) 79 | print_ok(f"All metadata results have been saved in file {directory}/{metadata_filename}") 80 | else: 81 | print_error("No metadata found...") 82 | except KeyboardInterrupt: 83 | print("CTRL^C") 84 | except: 85 | pass 86 | else: 87 | print("There is nothing to analyze. Closing...") 88 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------