├── .github └── FUNDING.yml ├── img └── snoopdroid.png ├── MANIFEST.in ├── Makefile ├── snoopdroid ├── constants.py ├── utils.py ├── ui.py ├── koodous.py ├── __init__.py ├── virustotal.py ├── data │ └── knowngood.txt └── acquisition.py ├── bin └── snoopdroid ├── dev └── snoopdroid ├── .gitignore ├── setup.py ├── README.md └── LICENSE /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: botherder 2 | patreon: botherder 3 | ko_fi: botherder 4 | -------------------------------------------------------------------------------- /img/snoopdroid.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/botherder/snoopdroid/HEAD/img/snoopdroid.png -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include LICENSE 2 | include README.md 3 | global-exclude __pycache__ 4 | global-exclude *.py[co] 5 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | PWD = $(shell pwd) 2 | 3 | clean: 4 | rm -rf $(PWD)/build $(PWD)/dist $(PWD)/snoopdroid.egg-info 5 | 6 | dist: 7 | python3 setup.py sdist bdist_wheel 8 | 9 | upload: 10 | python3 -m twine upload dist/* 11 | -------------------------------------------------------------------------------- /snoopdroid/constants.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Snoopdroid 5 | # 6 | # Copyright (C) 2019 Claudio Guarnieri 7 | # 8 | # This program is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU Affero General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # This program is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU Affero General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU Affero General Public License 19 | # along with this program. If not, see . 20 | 21 | __version__ = "2.3" 22 | -------------------------------------------------------------------------------- /bin/snoopdroid: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Snoopdroid 5 | # 6 | # Copyright (C) 2019 Claudio Guarnieri 7 | # 8 | # This program is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU Affero General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # This program is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU Affero General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU Affero General Public License 19 | # along with this program. If not, see . 20 | 21 | import snoopdroid 22 | snoopdroid.main() 23 | -------------------------------------------------------------------------------- /dev/snoopdroid: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Snoopdroid 5 | # 6 | # Copyright (C) 2019 Claudio Guarnieri 7 | # 8 | # This program is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU Affero General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # This program is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU Affero General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU Affero General Public License 19 | # along with this program. If not, see . 20 | 21 | import os 22 | import sys 23 | 24 | sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) 25 | 26 | import snoopdroid 27 | snoopdroid.main() 28 | -------------------------------------------------------------------------------- /snoopdroid/utils.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Snoopdroid 4 | # 5 | # Copyright (C) 2019 Claudio Guarnieri 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU Affero General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU Affero General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU Affero General Public License 18 | # along with this program. If not, see . 19 | 20 | import hashlib 21 | 22 | def get_sha256(file_path): 23 | sha256_hash = hashlib.sha256() 24 | with open(file_path,"rb") as handle: 25 | for byte_block in iter(lambda: handle.read(4096), b""): 26 | sha256_hash.update(byte_block) 27 | 28 | return sha256_hash.hexdigest() 29 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | MANIFEST 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | .pytest_cache/ 49 | 50 | # Translations 51 | *.mo 52 | *.pot 53 | 54 | # Django stuff: 55 | *.log 56 | local_settings.py 57 | db.sqlite3 58 | 59 | # Flask stuff: 60 | instance/ 61 | .webassets-cache 62 | 63 | # Scrapy stuff: 64 | .scrapy 65 | 66 | # Sphinx documentation 67 | docs/_build/ 68 | 69 | # PyBuilder 70 | target/ 71 | 72 | # Jupyter Notebook 73 | .ipynb_checkpoints 74 | 75 | # pyenv 76 | .python-version 77 | 78 | # celery beat schedule file 79 | celerybeat-schedule 80 | 81 | # SageMath parsed files 82 | *.sage.py 83 | 84 | # Environments 85 | .env 86 | .venv 87 | env/ 88 | venv/ 89 | ENV/ 90 | env.bak/ 91 | venv.bak/ 92 | 93 | # Spyder project settings 94 | .spyderproject 95 | .spyproject 96 | 97 | # Rope project settings 98 | .ropeproject 99 | 100 | # mkdocs documentation 101 | /site 102 | 103 | # mypy 104 | .mypy_cache/ 105 | -------------------------------------------------------------------------------- /snoopdroid/ui.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Snoopdroid 4 | # 5 | # Copyright (C) 2019 Claudio Guarnieri 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU Affero General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU Affero General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU Affero General Public License 18 | # along with this program. If not, see . 19 | 20 | from tqdm import tqdm 21 | from colorama import init 22 | from termcolor import colored 23 | 24 | from .constants import __version__ 25 | 26 | def logo(): 27 | print(" _ _ _ ") 28 | print(" | | (_) | | ") 29 | print(" ___ _ __ ___ ___ _ __ __| |_ __ ___ _ __| | ") 30 | print(" / __| '_ \\ / _ \\ / _ \\| '_ \\ / _` | '__/ _ \\| |/ _` |") 31 | print(" \\__ \\ | | | (_) | (_) | |_) | (_| | | | (_) | | (_| | ") 32 | print(" |___/_| |_|\\___/ \\___/| .__/ \\__,_|_| \\___/|_|\\__,_|") 33 | print(" | | ") 34 | print(" |_| v{} ".format(__version__)) 35 | print(" ") 36 | 37 | 38 | class PullProgress(tqdm): 39 | def update_to(self, file_name, current, total): 40 | if total is not None: 41 | self.total = total 42 | self.update(current - self.n) 43 | 44 | init(autoreset=True) 45 | 46 | def info(text): 47 | return colored("***", "cyan", attrs=["bold",]) + " " + text 48 | 49 | def error(text): 50 | return colored("!!!", "red", attrs=["bold",]) + " Error: " + text 51 | 52 | def highlight(text): 53 | return colored(text, "cyan", attrs=["bold",]) 54 | 55 | def green(text): 56 | return colored(text, "green", attrs=["bold",]) 57 | 58 | def red(text): 59 | return colored(text, "red", attrs=["bold",]) 60 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # Snoopdroid 3 | # Copyright (C) 2019 Claudio Guarnieri 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU Affero General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU Affero General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU Affero General Public License 16 | # along with this program. If not, see . 17 | 18 | import os 19 | from setuptools import setup 20 | 21 | from snoopdroid.constants import __version__ 22 | 23 | description = "Extract all apks from an Android device and check for malicious apps" 24 | 25 | this_directory = os.path.abspath(os.path.dirname(__file__)) 26 | with open(os.path.join(this_directory, "README.md"), encoding="utf-8") as handle: 27 | long_description = handle.read() 28 | 29 | requires = ( 30 | "rsa", 31 | "tqdm", 32 | "halo", 33 | "requests", 34 | "terminaltables", 35 | "adb", 36 | ) 37 | 38 | def get_package_data(package): 39 | walk = [(dirpath.replace(package + os.sep, '', 1), filenames) 40 | for dirpath, dirnames, filenames in os.walk(package) 41 | if not os.path.exists(os.path.join(dirpath, '__init__.py'))] 42 | 43 | filepaths = [] 44 | for base, filenames in walk: 45 | filepaths.extend([os.path.join(base, filename) 46 | for filename in filenames]) 47 | return {package: filepaths} 48 | 49 | setup( 50 | name="snoopdroid", 51 | version=__version__, 52 | author="Claudio Guarnieri", 53 | author_email="nex@nex.sx", 54 | description=description, 55 | long_description=long_description, 56 | 57 | scripts=["bin/snoopdroid",], 58 | install_requires=requires, 59 | packages=["snoopdroid",], 60 | package_data=get_package_data('snoopdroid'), 61 | include_package_data=True, 62 | 63 | keywords="security android", 64 | license="GPLv3", 65 | classifiers=[ 66 | "Programming Language :: Python :: 3", 67 | "Topic :: Security", 68 | "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", 69 | "Operating System :: Android", 70 | "Operating System :: POSIX :: Linux", 71 | "Operating System :: MacOS", 72 | "Environment :: Console", 73 | ], 74 | ) 75 | -------------------------------------------------------------------------------- /snoopdroid/koodous.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Snoopdroid 4 | # 5 | # Copyright (C) 2019 Claudio Guarnieri 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU Affero General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU Affero General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU Affero General Public License 18 | # along with this program. If not, see . 19 | 20 | import requests 21 | 22 | from halo import Halo 23 | from terminaltables import AsciiTable 24 | 25 | from .ui import info, highlight, green, red 26 | 27 | def get_koodous_report(sha256): 28 | url = "https://api.koodous.com/apks/{}".format(sha256) 29 | res = requests.get(url) 30 | return res.json() 31 | 32 | def koodous_lookup(packages): 33 | print(info("Looking up all extracted files on " + highlight("Koodous") + " (www.koodous.com).")) 34 | print(info("This might take a while...")) 35 | print("") 36 | 37 | table_data = [] 38 | table_data.append(["Package name", "File path", "Trusted", "Detected", "Rating"]) 39 | 40 | with Halo(text="", spinner="bouncingBar") as spinner: 41 | total_packages = len(packages) 42 | counter = 0 43 | for package in packages: 44 | counter += 1 45 | 46 | spinner.text = "Looking up {} [{}/{}]".format(package.name, counter, total_packages) 47 | 48 | for file in package.files: 49 | report = get_koodous_report(file["sha256"]) 50 | 51 | if "package_name" in report: 52 | trusted = "no" 53 | if report["trusted"]: 54 | trusted = green("yes") 55 | 56 | detected = "no" 57 | if report["detected"]: 58 | detected = red("yes") 59 | 60 | rating = "0" 61 | if int(report["rating"]) < 0: 62 | rating = red(str(report["rating"])) 63 | 64 | row = [package.name, file["stored_path"], trusted, detected, rating] 65 | else: 66 | row = [package.name, file["stored_path"], "", "", ""] 67 | 68 | table_data.append(row) 69 | 70 | spinner.succeed("Completed!") 71 | 72 | print("") 73 | 74 | table = AsciiTable(table_data) 75 | print(table.table) 76 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Snoopdroid 2 | ========== 3 | 4 | **PLEASE NOTE: This project has been abandoned in favor of [Snoopdroid 2](https://github.com/botherder/snoopdroid2), which is a complete rewrite in Go to simplify portability. Check it out.** 5 | 6 | Snoopdroid is a simple utility to automate the process of extracting installed apps from an Android phone using the [Android Debug Bridge](https://developer.android.com/studio/command-line/adb). Optionally, Snoopdroid is able to lookup the extracted packages on various online services in order to attempt to immediately recognize any known malicious apps. 7 | 8 |

9 | 10 | Installation on Debian GNU/Linux 11 | -------------------------------- 12 | 13 | In order to run Snoopdroid on Debian you will need to install the following dependencies: 14 | 15 | ``` 16 | apt install python3 python3-pip python3-dev build-essential libssl-dev libffi-dev swig android-sdk-platform-tools 17 | ``` 18 | 19 | Make sure to generate your adb keys with: 20 | 21 | ``` 22 | adb keygen ~/.android/adbkey 23 | ``` 24 | 25 | You can then install Snoopdroid with pip3: 26 | 27 | ``` 28 | pip3 install rsa 29 | pip3 install snoopdroid 30 | ``` 31 | 32 | Installation on Mac 33 | ------------------- 34 | 35 | Running Snoopdroid on Mac requires Xcode and [homebrew](https://brew.sh) to be installed. 36 | 37 | In order to install adb and other dependencies use: 38 | 39 | ``` 40 | brew install openssl swig libusb python3 41 | brew install homebrew/cask/android-platform-tools 42 | ``` 43 | 44 | Make sure to generate your adb keys: 45 | 46 | ``` 47 | mkdir $HOME/.android 48 | adb keygen $HOME/.android/adbkey 49 | adb pubkey $HOME/.android/adbkey > $HOME/.android/adbkey.pub 50 | ``` 51 | 52 | You can now install Snoopdroid with pip3: 53 | 54 | ``` 55 | pip3 install rsa 56 | pip3 install snoopdroid 57 | ``` 58 | 59 | How to use 60 | ---------- 61 | 62 | In order to use Snoopdroid you need to connect your Android device to your computer. You will then need to [enable USB debugging](https://developer.android.com/studio/debug/dev-options#enable) on the Android device. 63 | 64 | If this is the first time you connect to this device, you will need to approve the authentication keys through a prompt that will appear on your Android device. 65 | 66 | You can now launch Snoopdroid simply with `snoopdroid`. At each run, Snoopdroid will generate a new acquisition folder containing all the extracted APKs in the current working directory. You can change the base folder using: 67 | 68 | ``` 69 | snoopdroid --storage /path/to/folder 70 | ``` 71 | 72 | Optionally, you can decide to enable lookups of the SHA256 hash of all the extracted APKs on [VirusTotal](https://www.virustotal.com) and/or [Koodous](https://www.koodous.com). While these lookups do not provide any conclusive assessment on all of the extracted APKs, they might highlight any known malicious ones. 73 | 74 | ``` 75 | snoopdroid --virustotal 76 | snoopdroid --koodous 77 | ``` 78 | 79 | Or, to launch all available lookups: 80 | 81 | ``` 82 | snoopdroid --all 83 | ``` 84 | -------------------------------------------------------------------------------- /snoopdroid/__init__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Snoopdroid 5 | # 6 | # Copyright (C) 2019 Claudio Guarnieri 7 | # 8 | # This program is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU Affero General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # This program is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU Affero General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU Affero General Public License 19 | # along with this program. If not, see . 20 | 21 | import os 22 | import sys 23 | import argparse 24 | import datetime 25 | 26 | from .ui import info, logo 27 | from .acquisition import Acquisition 28 | from .virustotal import virustotal_lookup 29 | from .koodous import koodous_lookup 30 | 31 | def main(): 32 | parser = argparse.ArgumentParser(description="Extract information from Android device") 33 | parser.add_argument("--storage", default=os.getcwd(), help="Specify a different base folder to store the acquisition") 34 | parser.add_argument("--limit", default=None, help="Set a limit to the number of packages to extract (mainly for debug purposes)") 35 | parser.add_argument("--all-apks", action="store_true", help="Extract all packages installed on the phone, even those marked as safe") 36 | parser.add_argument("--virustotal", action="store_true", help="Check packages on VirusTotal") 37 | parser.add_argument("--koodous", action="store_true", help="Check packages on Koodous") 38 | parser.add_argument("--all-checks", action="store_true", help="Run all available checks") 39 | parser.add_argument("--from-file", default=None, help="Instead of acquiring from phone, load an existing packages.json file for lookups (mainly for debug purposes)") 40 | args = parser.parse_args() 41 | 42 | logo() 43 | 44 | try: 45 | if args.from_file: 46 | acq = Acquisition.fromJSON(args.from_file) 47 | else: 48 | # TODO: Need to come up with a better folder name. 49 | acq_folder = datetime.datetime.now().isoformat().split(".")[0].replace(":", "") 50 | storage_folder = os.path.join(args.storage, acq_folder) 51 | 52 | acq = Acquisition(storage_folder=storage_folder, 53 | all_apks=args.all_apks, limit=args.limit) 54 | acq.run() 55 | 56 | packages = acq.packages 57 | 58 | if len(packages) == 0: 59 | return 60 | 61 | if args.virustotal or args.all_checks: 62 | virustotal_lookup(packages) 63 | 64 | print("") 65 | 66 | if args.koodous or args.all_checks: 67 | koodous_lookup(packages) 68 | except KeyboardInterrupt: 69 | print("") 70 | sys.exit(-1) 71 | 72 | if __name__ == "__main__": 73 | main() 74 | -------------------------------------------------------------------------------- /snoopdroid/virustotal.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Snoopdroid 4 | # 5 | # Copyright (C) 2019 Claudio Guarnieri 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU Affero General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU Affero General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU Affero General Public License 18 | # along with this program. If not, see . 19 | 20 | import time 21 | import requests 22 | 23 | from halo import Halo 24 | from terminaltables import AsciiTable 25 | 26 | from .ui import info, highlight, red 27 | 28 | def get_virustotal_report(hashes): 29 | apikey = "233f22e200ca5822bd91103043ccac138b910db79f29af5616a9afe8b6f215ad" 30 | url = "https://www.virustotal.com/partners/sysinternals/file-reports?apikey={}".format(apikey) 31 | 32 | items = [] 33 | for sha256 in hashes: 34 | items.append({ 35 | "hash": sha256, 36 | "image_path": "unknown", 37 | "creation_datetime": "unknown", 38 | }) 39 | headers = {"User-Agent": "VirusTotal", "Content-Type": "application/json"} 40 | res = requests.post(url, headers=headers, json=items) 41 | 42 | if res.status_code == 200: 43 | report = res.json() 44 | return report["data"] 45 | 46 | return None 47 | 48 | def virustotal_lookup(packages): 49 | print(info("Looking up all extracted files on " + highlight("VirusTotal") + " (www.virustotal.com).")) 50 | print("") 51 | 52 | detections = {} 53 | 54 | def virustotal_query(batch): 55 | report = get_virustotal_report(batch) 56 | if report: 57 | for entry in report: 58 | if entry["hash"] not in detections and entry["found"] == True: 59 | detections[entry["hash"]] = entry["detection_ratio"] 60 | 61 | with Halo(text="", spinner="bouncingBar") as spinner: 62 | batch = [] 63 | for package in packages: 64 | for file in package.files: 65 | batch.append(file["sha256"]) 66 | if len(batch) == 25: 67 | spinner.text = "Looking up first 25 apps..." 68 | 69 | virustotal_query(batch) 70 | batch = [] 71 | 72 | if batch: 73 | spinner.text = "Looking up remaining files..." 74 | virustotal_query(batch) 75 | 76 | spinner.succeed("Completed!") 77 | 78 | table_data = [] 79 | table_data.append(["Package name", "File path", "Detections"]) 80 | 81 | for package in packages: 82 | for file in package.files: 83 | row = [package.name, file["stored_path"],] 84 | 85 | if file["sha256"] in detections: 86 | detection = detections[file["sha256"]] 87 | positives = detection.split("/")[0] 88 | if int(positives) > 0: 89 | row.append(red(detection)) 90 | else: 91 | row.append(detection) 92 | else: 93 | row.append("not found") 94 | 95 | table_data.append(row) 96 | 97 | print("") 98 | 99 | table = AsciiTable(table_data) 100 | print(table.table) 101 | -------------------------------------------------------------------------------- /snoopdroid/data/knowngood.txt: -------------------------------------------------------------------------------- 1 | android 2 | android.auto_generated_rro__ 3 | android.autoinstalls.config.google.nexus 4 | com.android.backupconfirm 5 | com.android.bips 6 | com.android.bluetooth 7 | com.android.bluetoothmidiservice 8 | com.android.bookmarkprovider 9 | com.android.calllogbackup 10 | com.android.captiveportallogin 11 | com.android.carrierdefaultapp 12 | com.android.cellbroadcastreceiver 13 | com.android.certinstaller 14 | com.android.chrome 15 | com.android.companiondevicemanager 16 | com.android.connectivity.metrics 17 | com.android.cts.ctsshim 18 | com.android.cts.priv.ctsshim 19 | com.android.defcontainer 20 | com.android.documentsui 21 | com.android.dreams.basic 22 | com.android.egg 23 | com.android.emergency 24 | com.android.externalstorage 25 | com.android.facelock 26 | com.android.hotwordenrollment.okgoogle 27 | com.android.hotwordenrollment.tgoogle 28 | com.android.hotwordenrollment.xgoogle 29 | com.android.htmlviewer 30 | com.android.inputdevices 31 | com.android.keychain 32 | com.android.location.fused 33 | com.android.managedprovisioning 34 | com.android.mms.service 35 | com.android.mtp 36 | com.android.musicfx 37 | com.android.nfc 38 | com.android.omadm.service 39 | com.android.pacprocessor 40 | com.android.phone 41 | com.android.printspooler 42 | com.android.providers.blockednumber 43 | com.android.providers.calendar 44 | com.android.providers.contacts 45 | com.android.providers.downloads 46 | com.android.providers.downloads.ui 47 | com.android.providers.media 48 | com.android.providers.partnerbookmarks 49 | com.android.providers.settings 50 | com.android.providers.telephony 51 | com.android.providers.userdictionary 52 | com.android.proxyhandler 53 | com.android.sdm.plugins.connmo 54 | com.android.sdm.plugins.dcmo 55 | com.android.sdm.plugins.diagmon 56 | com.android.sdm.plugins.sprintdm 57 | com.android.server.telecom 58 | com.android.service.ims 59 | com.android.service.ims.presence 60 | com.android.settings 61 | com.android.sharedstoragebackup 62 | com.android.shell 63 | com.android.statementservice 64 | com.android.stk 65 | com.android.systemui 66 | com.android.systemui.theme.dark 67 | com.android.vending 68 | com.android.vpndialogs 69 | com.android.vzwomatrigger 70 | com.android.wallpaperbackup 71 | com.android.wallpaper.livepicker 72 | com.breel.wallpapers 73 | com.customermobile.preload.vzw 74 | com.google.android.apps.cloudprint 75 | com.google.android.apps.docs 76 | com.google.android.apps.enterprise.dmagent 77 | com.google.android.apps.gcs 78 | com.google.android.apps.helprtc 79 | com.google.android.apps.maps 80 | com.google.android.apps.messaging 81 | com.google.android.apps.nexuslauncher 82 | com.google.android.apps.photos 83 | com.google.android.apps.pixelmigrate 84 | com.google.android.apps.turbo 85 | com.google.android.apps.tycho 86 | com.google.android.apps.wallpaper 87 | com.google.android.apps.wallpaper.nexus 88 | com.google.android.apps.work.oobconfig 89 | com.google.android.asdiv 90 | com.google.android.backuptransport 91 | com.google.android.calculator 92 | com.google.android.calendar 93 | com.google.android.carrier 94 | com.google.android.carrier.authdialog 95 | com.google.android.carriersetup 96 | com.google.android.configupdater 97 | com.google.android.contacts 98 | com.google.android.deskclock 99 | com.google.android.dialer 100 | com.google.android.euicc 101 | com.google.android.ext.services 102 | com.google.android.ext.shared 103 | com.google.android.feedback 104 | com.google.android.gm 105 | com.google.android.gms 106 | com.google.android.gms.policy_sidecar_o 107 | com.google.android.gms.setup 108 | com.google.android.GoogleCamera 109 | com.google.android.googlequicksearchbox 110 | com.google.android.gsf 111 | com.google.android.hardwareinfo 112 | com.google.android.hiddenmenu 113 | com.google.android.ims 114 | com.google.android.inputmethod.japanese 115 | com.google.android.inputmethod.korean 116 | com.google.android.inputmethod.latin 117 | com.google.android.inputmethod.pinyin 118 | com.google.android.marvin.talkback 119 | com.google.android.music 120 | com.google.android.onetimeinitializer 121 | com.google.android.packageinstaller 122 | com.google.android.partnersetup 123 | com.google.android.printservice.recommendation 124 | com.google.android.setupwizard 125 | com.google.android.soundpicker 126 | com.google.android.storagemanager 127 | com.google.android.syncadapters.contacts 128 | com.google.android.tag 129 | com.google.android.tetheringentitlement 130 | com.google.android.theme.pixel 131 | com.google.android.tts 132 | com.google.android.videos 133 | com.google.android.webview 134 | com.google.android.wfcactivation 135 | com.google.android.youtube 136 | com.google.ar.core 137 | com.google.intelligence.sense 138 | com.google.modemservice 139 | com.google.pixel.wahoo.gfxdrv 140 | com.google.SSRestartDetector 141 | com.google.tango 142 | com.google.vr.apps.ornament 143 | com.google.vr.vrcore 144 | com.htc.omadm.trigger 145 | com.qti.qualcomm.datastatusnotification 146 | com.qualcomm.embms 147 | com.qualcomm.ltebc_vzw 148 | com.qualcomm.qcrilmsgtunnel 149 | com.qualcomm.qti.telephonyservice 150 | com.qualcomm.qti.uceShimService 151 | com.qualcomm.timeservice 152 | com.quicinc.cne.CNEService 153 | com.verizon.llkagent 154 | com.verizon.mips.services 155 | com.verizon.obdm 156 | com.verizon.obdm_permissions 157 | com.verizon.services 158 | com.vzw.apnlib 159 | org.codeaurora.ims 160 | qualcomm.com.vzw_msdc_api 161 | -------------------------------------------------------------------------------- /snoopdroid/acquisition.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Snoopdroid 4 | # 5 | # Copyright (C) 2019 Claudio Guarnieri 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU Affero General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU Affero General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU Affero General Public License 18 | # along with this program. If not, see . 19 | 20 | import os 21 | import sys 22 | import json 23 | import time 24 | import shutil 25 | import pkg_resources 26 | from usb1 import USBErrorBusy, USBErrorAccess 27 | 28 | from adb import adb_commands 29 | from adb import sign_pythonrsa 30 | from adb.usb_exceptions import DeviceAuthError 31 | 32 | from .ui import PullProgress, info, highlight, error 33 | from .utils import get_sha256 34 | 35 | class Package(object): 36 | def __init__(self, name, files=None): 37 | self.name = name 38 | self.files = files or [] 39 | 40 | class Acquisition(object): 41 | def __init__(self, storage_folder=None, all_apks=False, limit=None, packages=None): 42 | self.device = None 43 | self.packages = packages or [] 44 | self.storage_folder = storage_folder 45 | self.all_apks = all_apks 46 | self.limit = limit 47 | 48 | self.__known_good = [] 49 | 50 | @classmethod 51 | def fromJSON(cls, json_path): 52 | with open(json_path, "r") as handle: 53 | data = json.load(handle) 54 | 55 | packages = [] 56 | for entry in data: 57 | package = Package(entry["name"], entry["files"]) 58 | packages.append(package) 59 | 60 | return cls(packages=packages) 61 | 62 | def __load_knowngood(self): 63 | knowngood_path = os.path.join("data", "knowngood.txt") 64 | knowngood_string = pkg_resources.resource_string(__name__, knowngood_path) 65 | knowngood_list = knowngood_string.decode("utf-8").split("\n") 66 | self.__known_good.extend(knowngood_list) 67 | 68 | def __clean_output(self, output): 69 | return output.strip().replace("package:", "") 70 | 71 | def connect(self): 72 | # Maybe one day they will merge: 73 | # https://github.com/google/python-adb/pull/142 74 | priv_key_path = os.path.expanduser("~/.android/adbkey") 75 | with open(priv_key_path, "rb") as handle: 76 | priv_key = handle.read() 77 | pub_key_path = priv_key_path + ".pub" 78 | with open(pub_key_path, "rb") as handle: 79 | pub_key = handle.read() 80 | 81 | signer = sign_pythonrsa.PythonRSASigner(pub_key, priv_key) 82 | self.device = adb_commands.AdbCommands() 83 | 84 | while True: 85 | try: 86 | self.device.ConnectDevice(rsa_keys=[signer]) 87 | except (USBErrorBusy, USBErrorAccess): 88 | print(error("Device is busy, maybe run `adb kill-server` and try again.")) 89 | sys.exit(-1) 90 | except DeviceAuthError: 91 | print(error("You need to authorize this computer on the Android device. Retrying in 5 seconds...")) 92 | time.sleep(5) 93 | except Exception as e: 94 | print(error(repr(e))) 95 | sys.exit(-1) 96 | else: 97 | break 98 | 99 | def disconnect(self): 100 | self.device.Close() 101 | 102 | def reconnect(self): 103 | print(info("Reconnecting ...")) 104 | self.disconnect() 105 | self.connect() 106 | 107 | def get_packages(self): 108 | print(info("Retrieving package names ...")) 109 | 110 | if not self.all_apks: 111 | self.__load_knowngood() 112 | 113 | output = self.device.Shell("pm list packages") 114 | total = 0 115 | for line in output.split("\n"): 116 | package_name = self.__clean_output(line) 117 | if package_name == "": 118 | continue 119 | 120 | total += 1 121 | 122 | if not self.all_apks and package_name in self.__known_good: 123 | continue 124 | 125 | if package_name not in self.packages: 126 | self.packages.append(Package(package_name)) 127 | 128 | print(info("There are {} packages installed on the device. I selected {} for inspection.".format( 129 | total, len(self.packages)))) 130 | print("") 131 | 132 | def pull_packages(self): 133 | print(info("Starting acquisition at folder {}\n".format(self.storage_folder))) 134 | 135 | if not os.path.exists(self.storage_folder): 136 | os.mkdir(self.storage_folder) 137 | 138 | print(info("Downloading packages from device. This might take some time ...")) 139 | print("") 140 | 141 | storage_folder_apk = os.path.join(self.storage_folder, "apks") 142 | if not os.path.exists(storage_folder_apk): 143 | os.mkdir(storage_folder_apk) 144 | 145 | total_packages = len(self.packages) 146 | counter = 0 147 | for package in self.packages: 148 | # This is for debug purposes mainly. 149 | if self.limit and counter == int(self.limit): 150 | break 151 | 152 | counter += 1 153 | 154 | print("[{}/{}] Package: {}".format(counter, total_packages, highlight(package.name))) 155 | 156 | try: 157 | output = self.device.Shell("pm path {}".format(package.name)) 158 | output = self.__clean_output(output) 159 | if not output: 160 | continue 161 | except Exception as e: 162 | print("ERROR: Failed to get path of package {}: {}".format(package.name, e)) 163 | self.reconnect() 164 | continue 165 | 166 | # Sometimes the package path contains multiple lines for multiple apks. 167 | # We loop through each line and download each file. 168 | for path in output.split("\n"): 169 | path = path.strip() 170 | print("Downloading {} ...".format(path)) 171 | 172 | try: 173 | with PullProgress(unit='B', unit_divisor=1024, unit_scale=True, miniters=1) as pp: 174 | data = self.device.Pull(path, progress_callback=pp.update_to) 175 | except Exception as e: 176 | print("ERROR: Failed to pull package file from {}: {}".format(path, e)) 177 | self.reconnect() 178 | continue 179 | 180 | # We try to extract the apk name for this package. 181 | file_name = "" 182 | if "==/" in path: 183 | file_name = "_" + path.split("==/")[1].replace(".apk", "") 184 | 185 | # We store the apk to disk. 186 | file_path = os.path.join(storage_folder_apk, "{}{}.apk".format(package.name, file_name)) 187 | name_counter = 0 188 | while True: 189 | if not os.path.exists(file_path): 190 | break 191 | 192 | name_counter += 1 193 | file_path = os.path.join(storage_folder_apk, "{}{}_{}.apk".format( 194 | package.name, file_name, name_counter)) 195 | 196 | with open(file_path, "wb") as handle: 197 | handle.write(data) 198 | 199 | # We add the apk metadata to the package object. 200 | package.files.append({ 201 | "path": path, 202 | "stored_path": file_path, 203 | "sha256": get_sha256(file_path), 204 | }) 205 | 206 | print("") 207 | 208 | def save_json(self): 209 | json_path = os.path.join(self.storage_folder, "packages.json") 210 | packages = [] 211 | for package in self.packages: 212 | packages.append(package.__dict__) 213 | 214 | with open(json_path, "w") as handle: 215 | json.dump(packages, handle, indent=4) 216 | 217 | def run(self): 218 | self.connect() 219 | self.get_packages() 220 | self.pull_packages() 221 | self.disconnect() 222 | self.save_json() 223 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------