├── requirements.txt ├── MANIFEST.in ├── docs ├── rtspscanner-help.png ├── rtspscanner-network.png ├── rtspscanner-nocreds.png ├── rtspscanner-singlehost.png └── rtspscanner-addsinglehost.png ├── CHANGELOG.md ├── setup.py ├── .gitignore ├── README.md ├── rtspscanner.py └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | Pillow~=9.2.0 2 | beard-portscan~=0.15 -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md 2 | include LICENSE 3 | include CHANGELOG.md -------------------------------------------------------------------------------- /docs/rtspscanner-help.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BeardedTek-com/RTSPScanner/HEAD/docs/rtspscanner-help.png -------------------------------------------------------------------------------- /docs/rtspscanner-network.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BeardedTek-com/RTSPScanner/HEAD/docs/rtspscanner-network.png -------------------------------------------------------------------------------- /docs/rtspscanner-nocreds.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BeardedTek-com/RTSPScanner/HEAD/docs/rtspscanner-nocreds.png -------------------------------------------------------------------------------- /docs/rtspscanner-singlehost.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BeardedTek-com/RTSPScanner/HEAD/docs/rtspscanner-singlehost.png -------------------------------------------------------------------------------- /docs/rtspscanner-addsinglehost.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BeardedTek-com/RTSPScanner/HEAD/docs/rtspscanner-addsinglehost.png -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # 0.1.3 > 0.1.4: 2 | - Add `-pp` `--paths` command line option 3 | - Adds easier way to add custom paths for rtsp streams 4 | - Add RTSP_WHITESPACE environment variable 5 | - Move `cla()` within `if __name__ == "__main":` 6 | - refactor `splitEnvCSV` to `splitCSV` to better reflect its function 7 | - Add error handling on requests.ConnectionError while trying to contact API 8 | - Thank you @tammeryousef1006 for pointing out this behavior 9 | - Outputs tips on how to rectify problems and stops further connection attemps 10 | - Typical output: 11 | ``` 12 | Cannot reach rtsp-simple-server at http://192.168.2.243:9997. 13 | Possible Causes: API not enabled 14 | transport (http/https) not correct: http 15 | ip/fqdn not correct: 192.168.2.243 16 | port number not correct: 9997 17 | 18 | 4 Potential RTSP Sources: 19 | 192.168.2.190:8554 20 | 192.168.2.189:8554 21 | 22 | 2 Cameras Found: 23 | 192.168.2.190: rtsp://*****:*****@192.168.2.190:8554/Streaming/Channels/101 24 | 192.168.2.189: rtsp://*****:*****@192.168.2.189:8554/Streaming/Channels/101 25 | 26 | Credentials Used: 27 | *****:***** 28 | 29 | Paths Used: 30 | /Streaming/Channels/101 31 | /live 32 | /live2 33 | ``` 34 | # 0.1.2 > 0.1.3: 35 | - Bugfix 36 | 37 | # 0.1.1 > 0.1.2: 38 | - Update License to properly reflect AGPLv3 -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from pathlib import Path 2 | from setuptools import find_packages, setup 3 | dependencies = ['beard-portscan','Pillow'] 4 | # read the contents of README file 5 | this_directory = Path(__file__).parent 6 | long_description = (this_directory / "README.md").read_text() 7 | setup( 8 | name='rtspscanner', 9 | packages=find_packages(), 10 | version='0.1.4', 11 | description="RTSP Camera Scanner", 12 | author="The Bearded Tek", 13 | author_email="kenny@beardedtek.com", 14 | url="https://github.com/beardedtek-com/RTSPScanner", 15 | long_description=long_description, 16 | long_description_content_type='text/markdown', 17 | license='AGPLv3', 18 | project_urls={ 19 | "Bug Tracker": "https://github.com/beardedtek-com/RTSPScanner/issues", 20 | }, 21 | keywords=[ 22 | "port", 23 | "scanner", 24 | "multithreading", 25 | "queue", 26 | "terminal", 27 | "utility", 28 | "rtsp", 29 | "camera", 30 | "frigate", 31 | "fevr", 32 | "beardedtek", 33 | "python3", 34 | "cctv", 35 | "security" 36 | ], 37 | classifiers=[ 38 | "Environment :: Console", 39 | "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)", 40 | "Natural Language :: English", 41 | "Operating System :: MacOS :: MacOS X", 42 | "Operating System :: POSIX", 43 | "Operating System :: POSIX :: Linux", 44 | "Programming Language :: Python :: 3", 45 | "Topic :: Utilities", 46 | "Topic :: Home Automation", 47 | "Topic :: Software Development :: Libraries :: Python Modules", 48 | "Topic :: System :: Networking", 49 | "Topic :: Multimedia :: Video", 50 | "Topic :: Multimedia :: Video :: Capture", 51 | ], 52 | install_requires=dependencies, 53 | py_modules=['rtspscanner'], 54 | entry_points={ 55 | 'console_scripts': [ 56 | "rtspscanner=rtspscanner:main" 57 | ], 58 | }, 59 | ) 60 | -------------------------------------------------------------------------------- /.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 | .pypirc 11 | .Python 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | wheels/ 24 | pip-wheel-metadata/ 25 | share/python-wheels/ 26 | *.egg-info/ 27 | .installed.cfg 28 | *.egg 29 | MANIFEST 30 | 31 | # PyInstaller 32 | # Usually these files are written by a python script from a template 33 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 34 | *.manifest 35 | *.spec 36 | 37 | # Installer logs 38 | pip-log.txt 39 | pip-delete-this-directory.txt 40 | 41 | # Unit test / coverage reports 42 | htmlcov/ 43 | .tox/ 44 | .nox/ 45 | .coverage 46 | .coverage.* 47 | .cache 48 | nosetests.xml 49 | coverage.xml 50 | *.cover 51 | *.py,cover 52 | .hypothesis/ 53 | .pytest_cache/ 54 | 55 | # Translations 56 | *.mo 57 | *.pot 58 | 59 | # Django stuff: 60 | *.log 61 | local_settings.py 62 | db.sqlite3 63 | db.sqlite3-journal 64 | 65 | # Flask stuff: 66 | instance/ 67 | .webassets-cache 68 | 69 | # Scrapy stuff: 70 | .scrapy 71 | 72 | # Sphinx documentation 73 | docs/_build/ 74 | 75 | # PyBuilder 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | .python-version 87 | 88 | # pipenv 89 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 90 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 91 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 92 | # install all needed dependencies. 93 | #Pipfile.lock 94 | 95 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 96 | __pypackages__/ 97 | 98 | # Celery stuff 99 | celerybeat-schedule 100 | celerybeat.pid 101 | 102 | # SageMath parsed files 103 | *.sage.py 104 | 105 | # Environments 106 | .env 107 | .venv 108 | env/ 109 | venv/ 110 | ENV/ 111 | env.bak/ 112 | venv.bak/ 113 | 114 | # Spyder project settings 115 | .spyderproject 116 | .spyproject 117 | 118 | # Rope project settings 119 | .ropeproject 120 | 121 | # mkdocs documentation 122 | /site 123 | 124 | # mypy 125 | .mypy_cache/ 126 | .dmypy.json 127 | dmypy.json 128 | 129 | # Pyre type checker 130 | .pyre/ 131 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # RTSPScanner 2 | 3 | [![PyPI](https://img.shields.io/pypi/v/rtspscanner)](https://pypi.org/project/rtspscanner/)   [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rtspscanner)](https://pypi.org/project/rtspscanner/)   [![PyPI - License](https://img.shields.io/pypi/l/rtspscanner)](https://pypi.org/project/rtspscanner/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/portscanner)](https://pypi.org/project/rtspscanner/) 4 | 5 | ## Python 3 Utility to scan for RTSP Sources on a network. 6 | This can be used as a command line utility or as a class 7 | 8 | This uses a modified version of PortScan forked from [Aperocky/PortScan](https://github.com/Aperocky/PortScan). 9 | A [Pull Request](https://github.com/Aperocky/PortScan/pull/1) has been submitted, but there has not been a commit since 2019. 10 | 11 | ## Requirements 12 | - Pillow ~= 9.2.0 13 | - beard-portscan ~= 0.1.5 14 | - ffmpeg in your $PATH 15 | 16 | ## Command Line Utility Usage 17 | ``` 18 | usage: rtspscanner.py [-h] [-w WHITESPACE] [-a ADDRESS] [-n NAME] [-p PORTS] [-pp PATHS] [-c CREDS] -m MODE [-A APIADDR] [-P APIPORT] [-t APITRANSPORT] [-T TIMEOUT] 19 | [-R TIMEOUTRETRIES] [-v] 20 | 21 | Scans given ports of an IPv4 Address or an IPv4 Network for RTSP streams and adds them to rtsp-simple-server 22 | 23 | options: 24 | -h, --help show this help message and exit 25 | -w WHITESPACE, --whitespace WHITESPACE 26 | Whitespace Replacement can be - _ or # 27 | -a ADDRESS, --address ADDRESS 28 | Single ipv4 address or ipv4 network in CIDR notation ex: 192.168.0.100 or 192.168.0/24 29 | -n NAME, --name NAME Camera Name | only used if single address given 30 | -p PORTS, --ports PORTS 31 | csv format: 554,8554 32 | -pp PATHS, --paths PATHS 33 | csv format: '/Streaming/Channels/101,/live,/live2' 34 | -c CREDS, --creds CREDS 35 | csv formatted user:password pairs: username:password,user:pass 36 | -m MODE, --mode MODE add - add cameras found / rem - remove cameras found 37 | -A APIADDR, --apiaddr APIADDR 38 | rtsp-simple-server API IP Address/FQDN 39 | -P APIPORT, --apiport APIPORT 40 | rtsp-simple-server API Port 41 | -t APITRANSPORT, --apitransport APITRANSPORT 42 | rtsp-simple-server API transport (http/https) 43 | -T TIMEOUT, --timeout TIMEOUT 44 | Timeout for ffmpeg command to determine if rtsp stream exists 45 | -R TIMEOUTRETRIES, --timeoutretries TIMEOUTRETRIES 46 | Number of retries on timeout for ffmpeg command to determine if rtsp stream exists 47 | -v, --verbose Set verbosity to true 48 | ``` 49 | ## Scanning a Subnet 50 | The utility will scan a given network with CIDR notation 51 | ``` 52 | $~> rtspscanner -m scan -c admin:admin -a 192.168.2.0/24 53 | 54 | 4 Potential RTSP Sources: 55 | 192.168.2.63:8554 56 | 192.168.2.240:8554 57 | 192.168.2.190:8554 58 | 192.168.2.189:8554 59 | 60 | 1 Camera Found: 61 | 192.168.2.190: rtsp://admin:admin@192.168.2.190:8554/Streaming/Channels/101 62 | 63 | 1 Flaky Camera: 64 | Potential camera that cannot be verfied within 10 second timeout. 65 | This can be increased using the command line option -t 66 | 192.168.2.189: rtsp://admin:admin@192.168.2.189:8554/live 67 | 68 | Credentials Used: 69 | admin:admin 70 | 71 | Paths Used: 72 | /Streaming/Channels/101 73 | /live 74 | ``` 75 | 76 | ## Scan Single IP 77 | 78 | ``` 79 | $~> rtspscanner -m scan -c admin:admin -a 192.168.2.189 80 | 81 | 1 Potential RTSP Source: 82 | 192.168.2.190:8554 83 | 84 | 1 Camera(s) Found: 85 | 192.168.2.190: rtsp://admin:admin@192.168.2.190:8554/Streaming/Channels/101 86 | 87 | Credentials Used: 88 | admin:admin 89 | 90 | Paths Used: 91 | /Streaming/Channels/101 92 | /live 93 | ``` 94 | 95 | ## Add All Discovered RTSP Cameras to rtsp-simple-server 96 | 97 | ``` 98 | $~> rtspscanner -m add -A 192.168.2.240 -c admin:admin -a 192.168.2.0/24 99 | Adding 192.168.2.190 - rtsp://admin:admin@192.168.2.190:8554/Streaming/Channels/101 | 200 : SUCCESS 100 | Adding 192.168.2.189 - rtsp://admin:admin@192.168.2.189:8554/Streaming/Channels/101 | 200 : SUCCESS 101 | 102 | 4 Potential RTSP Sources: 103 | 192.168.2.63:8554 104 | 192.168.2.240:8554 105 | 192.168.2.190:8554 106 | 192.168.2.189:8554 107 | 108 | 2 Cameras Found: 109 | 192.168.2.190: rtsp://admin:admin@192.168.2.190:8554/Streaming/Channels/101 110 | 192.168.2.189: rtsp://admin:admin@192.168.2.189:8554/Streaming/Channels/101 111 | 112 | Credentials Used: 113 | admin:admin 114 | 115 | Paths Used: 116 | /Streaming/Channels/101 117 | /live 118 | ``` 119 | 120 | ## Add Single RTSP Camera to rtsp-simple-server 121 | 122 | ``` 123 | $~> rtspscanner -m add -A 192.168.2.240 -c admin:admin -a 192.168.2.190 124 | Adding 192.168.2.190 - rtsp://admin:admin@192.168.2.190:8554/Streaming/Channels/101 | 200 : SUCCESS 125 | 126 | 1 Potential RTSP Source: 127 | 192.168.2.190:8554 128 | 129 | 1 Camera Found: 130 | 192.168.2.190: rtsp://admin:admin@192.168.2.190:8554/Streaming/Channels/101 131 | 132 | Credentials Used: 133 | admin:admin 134 | 135 | Paths Used: 136 | /Streaming/Channels/101 137 | /live 138 | ``` 139 | 140 | ## Use it in a python3 project as a class: 141 | ``` 142 | from rtspscanner import RTSPScanner 143 | scanner = RTSPScanner() 144 | 145 | # Set address to net wth CIDR notation or single host 146 | scanner.address = 192.168.2.0/24 147 | 148 | # Set to scan mode (add/rem to/from rtsp-simple-server still under development and considered alpha) 149 | scanner.mode = "scan" 150 | 151 | # override default paths in csv (default shown) 152 | # scanner.paths = "live,Streaming/Channels/101" 153 | 154 | # override default credentials in csv (default is of type None) 155 | # scanner.creds = "admin:admin,"user:pass" 156 | 157 | # override default ports in csv (default shown) 158 | # scanner.ports = "554,8554" 159 | 160 | #run the scan 161 | scanner.scan() 162 | 163 | # Print the list of cameras found as a dict 164 | print(scanner.scanResults) 165 | ``` 166 | 167 | ## Environment variables 168 | Environment variables can be set for all options (useful for use inside a docker container) 169 | ``` 170 | RTSP_SCAN_PORTS="554,8554" 171 | FFMPEG_TIMEOUT=10 172 | FFMPEG_RETRIES=2 173 | RTSP_SS_ADDRESS="192.168.2.240" 174 | RTSP_SS_PORT=9997 175 | RTSP_SS_TRANSPORT="http" 176 | RTSP_MODE="scan" 177 | RTSP_VERBOSE="false" 178 | RTSP_WHITESPACE="-" 179 | RTSP_CREDS="admin:admin,user:password" 180 | RTSP_PATHS="/Streaming/Channels/101,/live,live2" 181 | RTSP_ADDRESS="192.168.2.0/24" 182 | ``` -------------------------------------------------------------------------------- /rtspscanner.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # This code is a portion of frigate Event Video Recorder (fEVR) 3 | # 4 | # Copyright (C) 2021-2022 The Bearded Tek (http://www.beardedtek.com) William Kenny 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU Affero General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU AfferoGeneral Public License 17 | # along with this program. If not, see . 18 | # 19 | # Scans given ports of an IPv4 Address or an IPv4 Network for RTSP Streams and 20 | # adds them to or removes them from rtsp-simple-server via its API 21 | 22 | 23 | from os import getenv,path,system 24 | import subprocess 25 | import requests 26 | import json 27 | from PIL import Image 28 | from portscan import PortScan 29 | 30 | class RTSPScanner: 31 | def __init__(self,verbose=False,wspace="-"): 32 | # GET ENVIRONMENT VARIABLES 33 | self.ports = getenv("RTSP_SCAN_PORTS","554,8554") 34 | self.timeout=getenv("FFMPEG_TIMEOUT",10) 35 | self.retries=getenv("FFMPEG_RETRIES",2) 36 | self.apiaddress = getenv("RTSP_SS_ADDRESS","192.168.2.240") 37 | self.apiport = getenv("RTSP_SS_PORT","9997") 38 | self.apitransport = getenv("RTSP_SS_TRANSPORT","http") 39 | self.mode = getenv("RTSP_MODE").lower() if getenv("RTSP_MODE") else "scan" 40 | self.verbose = True if verbose or str(getenv("RTSP_VERBOSE","false")).lower() == "true" else False 41 | self.whitespace = getenv("RTSP_WHITESPACE") if getenv("RTSP_WHITESPACE") else wspace 42 | self.creds = self.splitCSV(getenv("RTSP_CREDS","none")) 43 | self.paths = self.splitCSV(getenv("RTSP_PATHS","/Streaming/Channels/101,/live,live2")) 44 | self.address = getenv("RTSP_ADDRESS","192.168.2.0/24") 45 | self.cameras = [] 46 | 47 | def run(self): 48 | self.scanner() 49 | if self.mode == "rem": 50 | self.delCameras() 51 | elif self.mode == "add": 52 | if self.verbose: 53 | print(f"Cameras Found: {self.cameras}") 54 | print(f"Creds Used: {self.creds}") 55 | print(f"Paths: {self.paths}") 56 | print(f"Scanned Address(es): {self.address}") 57 | print(f"Scanned Ports: {self.ports}") 58 | self.addCameras() 59 | else: 60 | for c in range(0,len(self.cameras)): 61 | self.cameras[c][0] = self.cameras[c][0].replace('.',self.whitespace) 62 | 63 | if not self.mode != "add": 64 | return self.cameras 65 | 66 | def resizeImg(self,img,output,height=180,ratio=1.777777778,fmt="webp"): 67 | if path.exists(img): 68 | # Resizes an image from the filesystem 69 | if path.exists(img): 70 | Image.open(img).resize((int(height*ratio),height)).save(output,fmt, quality=100,optimize=True) 71 | return "OK" 72 | else: 73 | return "resizeImg(): Image Path Does Not Exist" 74 | 75 | def splitCSV(self,csv): 76 | values = [] 77 | for value in csv.split(','): 78 | values.append(value) 79 | return values 80 | 81 | def scanner(self): 82 | self.portscan = PortScan(self.address,self.ports,stdout=False) 83 | results = self.portscan.run() 84 | with self.portscan.q.mutex: 85 | unfinished = self.portscan.q.unfinished_tasks - len(self.portscan.q.queue) 86 | if unfinished <= 0: 87 | if unfinished < 0: 88 | raise ValueError('task_done() called too many times') 89 | self.portscan.q.unfinished_tasks = unfinished 90 | self.portscan.q.queue.clear() 91 | self.portscan.q.not_full.notify_all() 92 | #if self.verbose: 93 | #print(results) 94 | for result in results: 95 | if result: 96 | for path in self.paths: 97 | for cred in self.creds: 98 | transport = f"rtsp://{cred}@" if cred != "none" else "rtsp://" 99 | rtsp = f'{transport}{result["ip"]}:{result["port"]}{path}' 100 | status = f"Checking {rtsp}... " 101 | if self.verbose: 102 | print(status) 103 | snapshot = f"/tmp/test.png" 104 | thumbnail = f"/tmp/test.webp" 105 | flaky = [] 106 | command = ['ffmpeg', '-y', '-frames', '1', snapshot, '-rtsp_transport', 'tcp', '-i', rtsp] 107 | for x in range(0,self.retries): 108 | try: 109 | cmd = subprocess.run(command,stderr=subprocess.DEVNULL,timeout=self.timeout) 110 | break 111 | except subprocess.TimeoutExpired as e: 112 | if self.verbose: 113 | label = f"Retry # {x}" if x > 0 else "1st Attempt" 114 | print(f"{label}: {e}") 115 | timedout = True 116 | if self.verbose: 117 | print(f"Return Code: {cmd.returncode}") 118 | if 'timedout' in locals(): 119 | if timedout: 120 | flaky.append([str(result['ip']),rtsp]) 121 | if 'cmd' in locals() and cmd.returncode == 0: 122 | self.cameras.append([str(result['ip']),rtsp]) 123 | status = "RTSP " 124 | #resizeImg(self,img,output,height=180,ratio=1.777777778,fmt="webp"): 125 | resize = self.resizeImg(snapshot,thumbnail) 126 | if resize == "OK": 127 | status += "VALID IMAGE" 128 | else: 129 | status += "NO IMAGE" 130 | if self.verbose: 131 | print(status) 132 | self.scanResults = {"cameras":self.cameras,"flaky":flaky,"portscan":results} 133 | 134 | def delCameras(self): 135 | for cam in range(0,len(self.cameras)): 136 | self.cameras[cam][0] = self.cameras[cam][0].replace(".",self.whitespace).replace(" ","_") 137 | apiURL = f'{self.apitransport}://{self.apiaddress}:{self.apiport}/v1/config/paths/remove/{self.cameras[cam][0]}' 138 | outputString = f"Deleting {self.cameras[cam][0]} - {self.cameras[cam][1]} | " 139 | response = requests.post(apiURL) 140 | outputCode = f"{response.status_code} : " 141 | if response.status_code == 200: 142 | outputResult = "SUCCESS" 143 | else: 144 | outputResult = "FAILURE" 145 | print(f"{outputString}{outputCode}{outputResult}") 146 | 147 | def addCameras(self): 148 | for cam in range(0,len(self.cameras)): 149 | jsonPostData = { 150 | "source": self.cameras[cam][1], 151 | "sourceProtocol": "automatic", 152 | "sourceAnyPortEnable": False, 153 | "sourceFingerprint": "", 154 | "sourceOnDemand": False, 155 | "sourceOnDemandStartTimeout": "10s", 156 | "sourceOnDemandCloseAfter": "10s", 157 | "sourceRedirect": "", 158 | "disablePublisherOverride": False, 159 | "fallback": "", 160 | "publishUser": "", 161 | "publishPass": "", 162 | "publishIPs": [], 163 | "readUser": "", 164 | "readPass": "", 165 | "readIPs": [], 166 | "runOnInit": "", 167 | "runOnInitRestart": False, 168 | "runOnDemand": "", 169 | "runOnDemandRestart": False, 170 | "runOnDemandStartTimeout": "10s", 171 | "runOnDemandCloseAfter": "10s", 172 | "runOnReady": "python3 /app/rtsp_event.py $RTSP_PATH READY", 173 | "runOnReadyRestart": False, 174 | "runOnRead": "python3 /app/rtsp_event.py $RTSP_PATH READ", 175 | "runOnReadRestart": False 176 | } 177 | cameraName = self.cameras[cam][0].replace(".",self.whitespace).replace(" ","-") 178 | outputString = f"Adding {self.cameras[cam][0]} - {self.cameras[cam][1]} | " 179 | outputCode = "" 180 | outputResult = "" 181 | apiHost = f'{self.apitransport}://{self.apiaddress}:{self.apiport}' 182 | apiURL = f'{apiHost}/v1/config/paths/add/{cameraName}' 183 | if self.mode == "add": 184 | try: 185 | response = requests.post(apiURL,json=jsonPostData) 186 | except requests.ConnectionError as e: 187 | print() 188 | if self.verbose: 189 | print(e) 190 | print() 191 | print(f"Cannot reach rtsp-simple-server at {apiHost}.") 192 | print(f"Possible Causes: API not enabled") 193 | print(f" transport (http/https) not correct: {self.apitransport}") 194 | print(f" ip/fqdn not correct: {self.apiaddress}") 195 | print(f" port number not correct: {self.apiport}") 196 | return 197 | outputCode = f"{response.status_code} : " 198 | if response.status_code == 200: 199 | outputResult = "SUCCESS" 200 | else: 201 | outputResult = "FAILURE" 202 | else: 203 | outputResult = "DISABLED" 204 | print(f"{outputString}{outputCode}{outputResult}") 205 | if self.verbose and outputResult != "SUCCESS": 206 | print(json.dumps(jsonPostData,indent=2,sort_keys=True,ensure_ascii=True)) 207 | 208 | if __name__ == "__main__": 209 | 210 | def cla(): 211 | # Import argparse here in case we don't want to use it... 212 | import argparse 213 | parser = argparse.ArgumentParser(description="Scans given ports of an IPv4 Address or an IPv4 Network for RTSP streams and adds them to rtsp-simple-server") 214 | parser.add_argument('-w','--whitespace',type=str,required=False,default='-', 215 | help="Whitespace Replacement can be - _ or #") 216 | parser.add_argument('-a','--address',type=str,required=False,default='192.168.2.0/24', 217 | help="Single ipv4 address or ipv4 network in CIDR notation ex: 192.168.0.100 or 192.168.0/24") 218 | 219 | parser.add_argument('-n','--name',required=False,default=None, 220 | help="Camera Name | only used if single address given") 221 | 222 | parser.add_argument('-p','--ports',type=str,required=False,default='554,8554', 223 | help="csv format: 554,8554") 224 | 225 | parser.add_argument('-pp','--paths',type=str,required=False,default="/Streaming/Channels/101,/live,/live2", 226 | help="csv format: '/Streaming/Channels/101,/live,/live2'") 227 | 228 | parser.add_argument('-c','--creds',required=False,default="none", 229 | help="csv formatted user:password pairs: username:password,user:pass") 230 | 231 | parser.add_argument('-m','--mode',type=str,required=True, 232 | help="add - add cameras found / rem - remove cameras found") 233 | 234 | parser.add_argument('-A','--apiaddr',type=str,required=False,default="192.168.0.100", 235 | help="rtsp-simple-server API IP Address/FQDN") 236 | 237 | parser.add_argument('-P','--apiport',type=str,required=False,default="9997", 238 | help="rtsp-simple-server API Port") 239 | 240 | parser.add_argument('-t','--apitransport',type=str,required=False,default="http", 241 | help='rtsp-simple-server API transport (http/https)') 242 | 243 | parser.add_argument('-T','--timeout',type=int,required=False,default=10, 244 | help="Timeout for ffmpeg command to determine if rtsp stream exists") 245 | 246 | parser.add_argument('-R','--timeoutretries',type=int,required=False,default=3, 247 | help="Number of retries on timeout for ffmpeg command to determine if rtsp stream exists") 248 | 249 | parser.add_argument('-v','--verbose',action='store_true',default=False, 250 | help="Set verbosity to true") 251 | 252 | args = parser.parse_args() 253 | return args 254 | 255 | def main(): 256 | system('stty sane') 257 | args = vars(cla()) 258 | #print(args) 259 | scanner = RTSPScanner() 260 | scanner.address = args['address'] 261 | scanner.ports = args['ports'] 262 | scanner.verbose = args['verbose'] 263 | scanner.whitespace = args['whitespace'] 264 | scanner.creds = scanner.splitCSV(args['creds']) 265 | scanner.paths = scanner.splitCSV(args['paths']) 266 | scanner.apiaddress = args['apiaddr'] 267 | scanner.apiport = args['apiport'] 268 | scanner.apitransport = args['apitransport'] 269 | scanner.timeout = args['timeout'] 270 | scanner.retries = args['timeoutretries'] 271 | args['mode'] = args['mode'].lower() 272 | if args['mode'] == "rem" or args['mode'] == "add": 273 | scanner.mode = args['mode'] 274 | scanner.run() 275 | elif args['mode'] == "scan": 276 | scanner.scanner() 277 | else: 278 | print("\nInvalid Mode") 279 | print(" Valid modes are 'add' 'rem' 'scan'.\n") 280 | return 281 | # Print Results of the Port Scan 282 | sourcesCount = 0 283 | sources = "" 284 | for item in scanner.scanResults['portscan']: 285 | if item: 286 | sourcesCount += 1 287 | if item['open']: 288 | sources += f" {item['ip']}:{item['port']}\n" 289 | sourcesDisp = "Sources" if sourcesCount > 1 else "Source" 290 | output = f"\n{sourcesCount} Potential RTSP {sourcesDisp}:\n" + sources 291 | print(output) 292 | 293 | # Print Results of the RTSP Scan 294 | 295 | # Cameras Found 296 | cameraCount = len(scanner.scanResults['cameras']) 297 | CamDisp = "Cameras" if cameraCount > 1 else "Camera" 298 | print(f"{cameraCount} {CamDisp} Found:") 299 | for camera in scanner.scanResults['cameras']: 300 | print(f" {camera[0]}: {camera[1]}") 301 | 302 | # Flaky Cameras Found 303 | flakyCount = len(scanner.scanResults['flaky']) 304 | if flakyCount > 0: 305 | CamDisp = "Cameras" if flakyCount > 1 else "Camera" 306 | print(f"\n{len(scanner.scanResults['flaky'])} Flaky {CamDisp}:") 307 | print(f"Potential {CamDisp.lower()} that cannot be verfied within {scanner.timeout} second timeout.") 308 | print("This can be increased using the command line option -t ") 309 | for camera in scanner.scanResults['flaky']: 310 | print(f" {camera[0]}: {camera[1]}") 311 | 312 | # Credentials Used 313 | print(f"\nCredentials Used:") 314 | for cred in scanner.creds: 315 | print(f" {cred}") 316 | 317 | #Paths Used 318 | print(f"\nPaths Used:") 319 | for path in scanner.paths: 320 | print(f" {path}") 321 | system('stty sane') 322 | 323 | main() 324 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------