├── .gitignore ├── requirements.txt ├── README.md ├── lib.py ├── Keyring.py └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__ 2 | KRconfig 3 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | bs4==0.0.1 2 | shodan==1.15.0 3 | requests==2.22.0 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Keyring 2 | Keyring is a tool to search a given URL for API Keys and other secrets. 3 | 4 | 5 | ## Current Keys: 6 | - Shodan (Very High Confidence, checks validity and available credits with the shodan library) 7 | - Github API (High confidence, static characters and unique substring) 8 | - Slack (High Confidence, static characters) 9 | - Slack Bot (High Confidence, static characters) 10 | - Slack Webhook Links (High Confidence, static characters and unique substring) 11 | - Google API (High Confidence, static characters) 12 | - Google Access Tokens (High Confidence, static characters) 13 | - Google OAUTH Secrets (High Confidence, unique substring) 14 | - AWS Access Tokens (High Confidence, static characters) 15 | - Discord Bot Tokens (High Confidence, static characters and substring sizes) 16 | - Discord Webhook Links: (High Confidence, static characters and substring types) 17 | - Discord Nitro Links (High Confidence, static characters and substring sizes) 18 | - Redis URLs (High Confidence, static characters and unique substring) 19 | - SSH Keys (High Confidence, static characters) 20 | - Heroku API Keys (High Confidence, static characters and unique substring) 21 | - Twilio API Keys (Medium Confidence, few static characters but static string size) 22 | - Facebook OAUTH (High Confidence, static characters and unique substring) 23 | - Non-specific API Keys (Medium Confidence, static format may exclude potential keys) 24 | 25 | ## Severity Rating (1-10): 26 | - Access Tokens (10: can result in direct compromise of related systems) 27 | - Redis URLs (10: can lead to potentially severe leaks) 28 | - SSH Keys (9: can potentially lead to system access in systems with poorly configured access control) 29 | - OAUTH Secrets (7: can disclose sensitive information or lead to credential theft) 30 | - Bot Tokens and Webhooks (6: can result in sensitive information being viewed, members being banned/kicked/etc.) 31 | - API Keys (5: can result in either loss of credits or sensitive information being viewed) 32 | - Nitro Links (2 or 0: If not intended for giveaway, can result in neglibigle financial loss.) 33 | 34 | ### TODO: 35 | - Add more keys (please send me either a sample key or regex for anything you want added) 36 | - Bug fixes 37 | -------------------------------------------------------------------------------- /lib.py: -------------------------------------------------------------------------------- 1 | import os 2 | from random import choice 3 | 4 | # (Name, isHighSeverity):pattern 5 | patterns_dict = { 6 | ("Github_API", False):r"[g|G][i|I][t|T][h|H][u|U][b|B].{0,30}['\"\\s][0-9a-zA-Z]{35,40}['\"\\s]", 7 | ("AWS_Token", True):r"AKIA[0-9A-Z]{16}", 8 | ("google_token", True):r'ya29.[0-9a-zA-Z_\\-]{68}', 9 | ("google_OAUTH", True):r"(\"client_secret\":\"[a-zA-Z0-9-_]{24}\")", 10 | ("Google_API", False):r'AIzaSy[0-9a-zA-Z_\\-]{33}', 11 | ("Slack_API", False):r"xoxp-\\d+-\\d+-\\d+-[0-9a-f]+", 12 | ("Slack_Webhook", False):r"https://hooks.slack.com/services/T[a-zA-Z0-9_]{8}/B[a-zA-Z0-9_]{8}/[a-zA-Z0-9_]{24}", 13 | ("Slack_Bot_Token", False):r"xoxb-\\d+-[0-9a-zA-Z]+", 14 | ("Generic_API", False):r"[a|A][p|P][i|I][_]?[k|K][e|E][y|Y].{0,30}['\"\\s][0-9a-zA-Z]{32,45}['\"\\s]", 15 | ("Discord_Bot_Token", False):r"([\w\-\.]+[\-\.][\w\-\.]+)", 16 | ("Discord_Webhook", False):r"(https:\/\/discordapp\.com\/api\/webhooks\/[\d]+\/[\w]+)", 17 | ("Discord_Nitro", False):r"(https:\/\/discord\.gift\/.+[a-z{1,16}])", 18 | ("Heroku_API", False):r"[h|H][e|E][r|R][o|O][k|K][u|U].{0,30}[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}", 19 | ("Facebook_OAUTH", True):r"[f|F][a|A][c|C][e|E][b|B][o|O][o|O][k|K].{0,30}['\"\\s][0-9a-f]{32}['\"\\s]", 20 | ("Twilio_API", False):r"SK[a-z0-9]{32}", 21 | } 22 | 23 | user_agents = [ 24 | 'Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.99 Safari/537.36', 25 | 'Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.99 Safari/537.36', 26 | 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.99 Safari/537.36', 27 | 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/602.2.14 (KHTML, like Gecko) Version/10.0.1 Safari/602.2.14', 28 | 'Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.71 Safari/537.36', 29 | 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36', 30 | 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36', 31 | 'Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.71 Safari/537.36', 32 | 'Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.99 Safari/537.36', 33 | 'Mozilla/5.0 (Windows NT 10.0; WOW64; rv:50.0) Gecko/20100101 Firefox/50.0' 34 | ] 35 | 36 | def PrintSuccess(Msg): 37 | if os.name == 'nt': 38 | print('[+] ' + Msg) 39 | else: 40 | print('\033[1;32m[+]\033[1;m ' + Msg) 41 | 42 | def PrintStatus(Msg): 43 | if os.name == 'nt': 44 | print('[*] ' + Msg) 45 | else: 46 | print('\033[1;34m[*]\033[1;m ' + Msg) 47 | 48 | def PrintFailure(Msg): 49 | if os.name == 'nt': 50 | print('[-] ' + Msg) 51 | else: 52 | print('\033[1;31m[-]\033[1;m ' + Msg) 53 | 54 | def PrintError(Msg): 55 | if os.name == 'nt': 56 | print('[!] ' + Msg) 57 | else: 58 | print('\033[1;31m[!]\033[1;m ' + Msg) 59 | 60 | def PrintHighSeverity(Msg): 61 | if os.name == 'nt': 62 | print('[$] ' + Msg) 63 | else: 64 | print('\033[1;33m[!]\033[1;m ' + Msg) 65 | 66 | def random_headers(): 67 | return { 'User-Agent': choice(user_agents), 'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8' } 68 | -------------------------------------------------------------------------------- /Keyring.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # By Mili 3 | import re 4 | import lib 5 | import errno 6 | import codecs 7 | import shodan 8 | import requests 9 | from sys import path 10 | from time import sleep 11 | from bs4 import BeautifulSoup 12 | from configparser import ConfigParser 13 | from os import listdir, makedirs, mkdir 14 | from concurrent.futures import ThreadPoolExecutor 15 | from os.path import isfile, join, isdir, exists, dirname 16 | 17 | # Global Variables 18 | parser = ConfigParser() 19 | curdir = path[0] 20 | baselink = 'https://github.com/' 21 | baseraw = 'https://raw.githubusercontent.com/' 22 | 23 | # Global Functions 24 | def shodan_search(displaymode, page, repo_crawl, verbosity): 25 | if repo_crawl is False: 26 | lib.PrintStatus("Searching for Shodan keys...") 27 | elif repo_crawl is True and verbosity == 'on': 28 | lib.PrintStatus("Searching for Shodan keys...") 29 | shodan_pattern = r'\b[a-zA-Z0-9]{32}\b' 30 | pagetext = page.text 31 | keyset = [] 32 | for k in re.findall(shodan_pattern, pagetext): 33 | keyset.append(k) 34 | if not keyset: 35 | if repo_crawl is False: 36 | lib.PrintFailure("No valid shodan keys found in set.") 37 | elif repo_crawl is True and verbosity == 'on': 38 | lib.PrintFailure("No valid shodan keys found in set.") 39 | else: 40 | valid_paid_keys = {} 41 | valid_unpaid_keys = [] 42 | for key in set(keyset): 43 | api = shodan.Shodan(key) 44 | try: 45 | keydata = api.info() 46 | usage_limits = keydata['usage_limits'] 47 | if keydata['plan'] == 'dev' or keydata['plan'] == 'edu': 48 | credits_tuple = (usage_limits['scan_credits'], usage_limits['query_credits']) 49 | valid_paid_keys[key] = credits_tuple 50 | elif keydata['plan'] == 'oss': 51 | valid_unpaid_keys.append(key) 52 | except Exception: 53 | pass 54 | if displaymode == 's' or displaymode == 'b': 55 | shodan_output = f'{curdir}/Output/ShodanKeys.txt' 56 | if not exists(dirname(shodan_output)): 57 | try: 58 | makedirs(dirname(shodan_output)) 59 | except OSError as racecondition: 60 | if racecondition.errno != errno.EEXIST: 61 | raise 62 | with open(shodan_output, 'a') as sofile: 63 | sofile.write('----------VALID KEYS----------') 64 | for pkey in valid_paid_keys.keys(): 65 | sofile.write(f"Key: {pkey}\nCredits (scan, query): {valid_paid_keys[pkey][0]}, {valid_paid_keys[pkey][1]}\n\n") 66 | sofile.write('----------UNPAID KEYS----------') 67 | for upkeys in set(valid_unpaid_keys): 68 | sofile.write(f'Key: {upkeys}') 69 | def generic_search(key, displaymode, page, repo_crawl, verbosity): 70 | if repo_crawl is False: 71 | lib.PrintStatus(f"Searching for {key[0]} keys...") 72 | elif repo_crawl is True and verbosity == 'on': 73 | lib.PrintStatus(f"Searching for {key[0]} keys...") 74 | pagetext = page.text 75 | for k in re.findall(lib.patterns_dict[key], pagetext): 76 | if displaymode == 's' or 'b': 77 | if key[1] is True: 78 | lib.PrintHighSeverity("Warning: High Severity Item Found") 79 | gen_output = f'{curdir}/Output/{key[0]}.txt' 80 | if not exists(dirname(gen_output)): 81 | try: 82 | makedirs(dirname(gen_output)) 83 | except OSError as racecondition: 84 | if racecondition.errno != errno.EEXIST: 85 | raise 86 | with open(gen_output, 'a') as gofile: 87 | gofile.write(f'Potential Key: {k}\n') 88 | elif displaymode == 'p' or 'b': 89 | lib.PrintSuccess(f'Potential Key: {k}') 90 | def redis_search(displaymode, page, repo_crawl, verbosity): 91 | if repo_crawl is False: 92 | lib.PrintStatus("Scanning for Redis secrets...") 93 | elif repo_crawl is True and verbosity == 'on': 94 | lib.PrintStatus("Scanning for Redis secrets...") 95 | pagetext = page.text 96 | redis_pattern = r'redis://[0-9a-zA-Z:@.\\-]+' 97 | redis_artifacts = ['REDIS_PASSWORD', 'REDIS_CACHE_DATABASE', 'REDIS_HOST', 'REDIS_DATABASE'] 98 | for k in re.findall(redis_pattern, pagetext): 99 | if displaymode == 's' or 'b': 100 | lib.PrintHighSeverity('Warning: High Severity Item Found') 101 | redis_output = f'{curdir}/Output/Redis/RedisLinks.txt' 102 | if not exists(dirname(redis_output)): 103 | try: 104 | makedirs(dirname(redis_output)) 105 | except OSError as racecondition: 106 | if racecondition.errno != errno.EEXIST: 107 | raise 108 | with open(redis_output, 'a') as gofile: 109 | gofile.write(f'Potential link: {k}\n') 110 | elif displaymode == 'p' or 'b': 111 | lib.PrintSuccess(f'Potential link: {k}') 112 | lib.PrintHighSeverity('Warning: High Severity Item Found') 113 | for ra in set(redis_artifacts): 114 | if ra in pagetext: 115 | lib.PrintHighSeverity('Warning: High Severity Item Found') 116 | if displaymode == 's' or 'b': 117 | redis_artifacts_output = f'{curdir}/Output/Redis/RedisArtifacts.txt' 118 | if not exists(dirname(redis_artifacts_output)): 119 | try: 120 | makedirs(dirname(redis_artifacts_output)) 121 | except OSError as racecondition: 122 | if racecondition.errno != errno.EEXIST: 123 | raise 124 | with open(redis_artifacts_output, 'a') as rafile: 125 | rafile.write(f'Artifact found: {ra}') 126 | elif displaymode == 'p' or 'b': 127 | lib.PrintSuccess(f'Artifact Found: {ra}') 128 | def ssh_keys_search(displaymode, page, repo_crawl, verbosity): 129 | if repo_crawl is False: 130 | lib.PrintStatus("Scanning for SSH Keys...") 131 | elif repo_crawl is True and verbosity == 'on': 132 | lib.PrintStatus("Scanning for SSH Keys...") 133 | pagetext = page.text 134 | ssh_keys_identifiers = ["-----BEGIN OPENSSH PRIVATE KEY-----", "-----BEGIN DSA PRIVATE KEY-----", "-----BEGIN EC PRIVATE KEY-----"] 135 | for pattern in set(ssh_keys_identifiers): 136 | if pattern in pagetext: 137 | if displaymode == 's' or 'b': 138 | ssh_output = f'{curdir}/Output/SSHKeys.txt' 139 | if not exists(dirname(ssh_output)): 140 | try: 141 | makedirs(dirname(ssh_output)) 142 | except OSError as racecondition: 143 | if racecondition.errno != errno.EEXIST: 144 | raise 145 | with open(ssh_output, 'a') as gofile: 146 | gofile.write(f'SSH Key: {pattern}\n') 147 | elif displaymode == 'p' or 'b': 148 | lib.PrintSuccess(f'SSH Key: {pattern}') 149 | lib.PrintHighSeverity('Warning: High Severity Item Found') 150 | def misc_database_secrets(displaymode, page, repo_crawl, verbosity): 151 | if repo_crawl is False: 152 | lib.PrintStatus("Searching for miscellaneous database secrets...") 153 | elif repo_crawl is True and verbosity == 'on': 154 | lib.PrintStatus("Searching for miscellaneous database secrets...") 155 | pagetext = page.text 156 | database_secrets = ['DB_USER', 'DB_PASSWORD', 'SUPERUSER_NAME', 'SUPERUSER_PASSWORD', 'DB_NAME'] 157 | for ds in set(database_secrets): 158 | if ds in pagetext: 159 | lib.PrintHighSeverity('Warning: High Severity Item Found') 160 | if displaymode == 's' or 'b': 161 | db_output = f'{curdir}/Output/DatabaseSecrets.txt' 162 | if not exists(dirname(db_output)): 163 | try: 164 | makedirs(dirname(db_output)) 165 | except OSError as racecondition: 166 | if racecondition.errno != errno.EEXIST: 167 | raise 168 | with open(db_output, 'a') as gofile: 169 | gofile.write(f'Database Secret: {ds}\n') 170 | elif displaymode == 'p' or 'b': 171 | print(f"Database secret: {ds}") 172 | def better_search_execute(displaymode, page, repo_crawl, verbosity): 173 | shodan_search(displaymode, page, repo_crawl, verbosity) 174 | redis_search(displaymode, page, repo_crawl, verbosity) 175 | ssh_keys_search(displaymode, page, repo_crawl, verbosity) 176 | misc_database_secrets(displaymode, page, repo_crawl, verbosity) 177 | 178 | for x in lib.patterns_dict.keys(): 179 | generic_search(x, displaymode, page, repo_crawl, verbosity) 180 | def connect(url): 181 | # TODO: Add Color 182 | def PrintConnectError(): 183 | lib.PrintError(f""" 184 | Exception occurred: {e} 185 | Possible causes: Poor/Non-functioning Internet connection or {url} is unreachable 186 | Possible fixes: Troubleshoot internet connection or check status of {url} 187 | """) 188 | def PrintTimeoutError(): 189 | lib.PrintError(f""" 190 | Exception occurred: {e} 191 | Possible causes: Too many requests made to {url} 192 | Possible fixes: Check firewall settings and check the status of {url}. 193 | """) 194 | def PrintGenericError(): 195 | lib.PrintError(f""" 196 | Exception occurred: {e} 197 | """) 198 | try: 199 | page = requests.get(url, headers=lib.random_headers()) 200 | return page 201 | except Exception as e: 202 | if e is requests.exceptions.ConnectionError: 203 | PrintConnectError() 204 | elif e is requests.exceptions.Timeout: 205 | PrintTimeoutError() 206 | else: 207 | PrintGenericError() 208 | return 'connection_failed' 209 | def get_repos(profilelink): 210 | if profilelink.endswith('//'): 211 | profilelink = profilelink[:len(profilelink) - 1] 212 | repos = profilelink + '?tab=repositories' 213 | repos = repos.replace(' ', '') 214 | profilepage = connect(repos) 215 | soup = BeautifulSoup(profilepage.text, 'html.parser') 216 | hrefs = soup.findAll('a', href=True, itemprop="name codeRepository") 217 | repolist = [] 218 | for h in hrefs: 219 | repolink = baselink + str(h['href']) 220 | repolist.append(repolink) 221 | return repolist 222 | def traverse_repos(repolist, link_type, directory_filtering, blacklisted_directories, verbosity): # Here Be Recursion 223 | fileaddrs = [] 224 | def spider_current_level(page): 225 | dirnames = [] 226 | levelsoup = BeautifulSoup(page.text, 'html.parser') 227 | spans = levelsoup.findAll('span', {'class': "css-truncate css-truncate-target"}) 228 | for s in spans: 229 | subtags = s.findAll('a', {'class': "js-navigation-open"}, href=True) 230 | for st in subtags: 231 | if '/blob/' in st['href']: 232 | lnk = st['href'].replace('blob/', '') 233 | if verbosity == 'y': 234 | lib.PrintStatus(f"File: {lnk}") 235 | full = baseraw + lnk 236 | fileaddrs.append(full) 237 | else: 238 | if verbosity == 'y': 239 | lib.PrintStatus(f"Directory: {st['href']}") 240 | if directory_filtering is True: 241 | slashcount = 0 242 | for character in st['href']: 243 | if character == '/': 244 | slashcount += 1 245 | directory_name = st['href'].split('/')[slashcount] 246 | if directory_name not in set(blacklisted_directories): 247 | dirnames.append(st['href']) 248 | else: 249 | dirnames.append(st['href']) 250 | if len(dirnames) == 0: 251 | if verbosity == 'y': 252 | lib.PrintStatus("Branch exhausted") 253 | else: 254 | for subdir in dirnames: 255 | subdir_addr = baselink + subdir 256 | subdir_page = connect(subdir_addr) 257 | spider_current_level(subdir_page) 258 | if link_type == 'profile': 259 | for i in repolist: 260 | repopage = connect(i) 261 | if repopage == 'connection_failed': 262 | lib.PrintError(f'Connection to {i} failed.') 263 | else: 264 | spider_current_level(repopage) 265 | elif link_type == 'repo': 266 | repopage = connect(repolist) 267 | if repopage == 'connection_failed': 268 | lib.PrintError(f'Connection to {repolist} failed.') 269 | else: 270 | spider_current_level(repopage) 271 | return fileaddrs 272 | def scrape(scrape_input_method, displaymode, limiter, repo_crawl, link_type, directory_filtering, blacklisted_directories, verbosity): 273 | if scrape_input_method.lower() == 'm': 274 | url = input("Enter the URL: ") 275 | if url[len(url)-1] == ' ': 276 | url = url[:len(url)-1] 277 | urlpage = connect(url) 278 | if urlpage == 'connection failed': 279 | lib.PrintError("Connection to specified URL could not be established.") 280 | exit() 281 | else: 282 | lib.PrintStatus('Status: [200], Searching for API Keys...') 283 | if repo_crawl is False: 284 | better_search_execute(displaymode, urlpage, repo_crawl, verbosity) 285 | else: 286 | if link_type == 'profile': 287 | resources = get_repos(url) 288 | file_addresses = traverse_repos(resources, link_type, directory_filtering, blacklisted_directories, verbosity) 289 | elif link_type == 'repo': 290 | file_addresses = traverse_repos(url, link_type, directory_filtering, blacklisted_directories, verbosity) 291 | if len(file_addresses) > 0: 292 | executor = ThreadPoolExecutor(max_workers=len(file_addresses)) 293 | else: 294 | lib.PrintError("Fatal Error: No File Addresses Were Returned") 295 | lib.PrintError("This is likely a mistyped, but valid, URL in the input.") 296 | lib.PrintError("This also occurs if a github repo link is provided when the profile option is enabled, or vice versa") 297 | exit() 298 | for addr in set(file_addresses): 299 | urlpage = connect(addr) 300 | executor.submit(better_search_execute(displaymode, urlpage, repo_crawl, verbosity)) 301 | sleep(limiter) 302 | lib.PrintSuccess("Scanning complete.") 303 | else: 304 | while True: 305 | url_file = input("Enter the full path to the input file: ") 306 | if isfile(url_file) is True: 307 | break 308 | elif str(url_file) == "": 309 | pass 310 | else: 311 | lib.PrintError("No Such File Found.") 312 | continue 313 | with open(url_file) as ufile: 314 | count = 0 315 | for line in ufile.readlines(): 316 | if repo_crawl is False: 317 | count += 1 318 | urlpage = connect(line.rstrip()) 319 | if urlpage == 'connection failed': 320 | lib.PrintFailure(f"[Line: {count}] Connection failed on host {line}") 321 | else: 322 | better_search_execute(displaymode, urlpage, repo_crawl, verbosity) 323 | sleep(limiter) 324 | else: 325 | if link_type == 'profile': 326 | resources = get_repos(line) 327 | elif link_type == 'repo': 328 | resources = line 329 | file_addresses = traverse_repos(resources, link_type, directory_filtering, blacklisted_directories, verbosity) 330 | executor = ThreadPoolExecutor(max_workers=len(file_addresses)) 331 | for addr in set(file_addresses): 332 | urlpage = connect(addr) 333 | executor.submit(better_search_execute(displaymode, urlpage, repo_crawl, verbosity)) 334 | sleep(limiter) 335 | def load_config(): 336 | if isdir(f'{curdir}/KRconfig') is False: 337 | lib.PrintError(f"Config directory not detected in {curdir}...") 338 | lib.PrintStatus(f"Making config directory in {curdir}...") 339 | mkdir(f'{curdir}/KRconfig') 340 | config_files = {} 341 | count = 0 342 | onlyfiles = [f for f in listdir(f'{curdir}/KRconfig') if isfile(join(f'{curdir}/KRconfig', f))] 343 | for file in onlyfiles: 344 | if file.endswith('.ini'): 345 | count += 1 346 | config_files[file] = count 347 | if count == 0: 348 | lib.PrintStatus("No config files detected, making default...") 349 | with codecs.open(f'{curdir}/KRconfig/defaultconfig.ini', 'w', 'utf-8') as dconf: 350 | dconf.write( 351 | '''[initial_vars] 352 | displaymode = b 353 | [scraping_vars] 354 | scrape_input_method = m 355 | limiter = 5 356 | repo_crawl = False 357 | link_type = regular 358 | directory_filtering = False 359 | blacklisted_directories = [] 360 | verbosity = off''') 361 | config_files['Default Configuration'] = 1 362 | count += 1 363 | for k in config_files.keys(): 364 | print(f"[{config_files[k]}]: {k}") 365 | while True: 366 | try: 367 | load_choice = int(input("Select which config file to load: ")) 368 | if load_choice > count: 369 | raise ValueError 370 | elif load_choice == "": 371 | pass 372 | continue 373 | else: 374 | break 375 | except ValueError: 376 | lib.PrintFailure("Invalid Input. Please enter the integer that corresponds with the desired config file.") 377 | continue 378 | for k in config_files.keys(): 379 | if load_choice == config_files[k]: 380 | selected_file = k 381 | parser.read(f"{curdir}/KRconfig/{selected_file}", encoding='utf-8') 382 | # Initial Variables 383 | displaymode = parser.get('initial_vars', 'displaymode') 384 | # Scraping Variables 385 | scrape_input_method = parser.get('scraping_vars', 'scrape_input_method') 386 | limiter = int(parser.get('scraping_vars', 'limiter')) 387 | repo_crawl = parser.getboolean('scraping_vars', 'repo_crawl') 388 | link_type = parser.get('scraping_vars', 'link_type') 389 | directory_filtering = parser.getboolean('scraping_vars', 'directory_filtering') 390 | blacklisted_directories = parser.get('scraping_vars', 'blacklisted_directories') 391 | verbosity = parser.get('scraping_vars', 'verbosity') 392 | return displaymode, scrape_input_method, limiter, repo_crawl, link_type, directory_filtering, blacklisted_directories, verbosity 393 | def manual_setup(): 394 | while True: 395 | displaymode = input("[p]rint to screen, [s]ave to file, or [b]oth: ") 396 | if displaymode == "": 397 | pass 398 | continue 399 | elif displaymode.lower() == 'p' or 's' or 'b': 400 | break 401 | else: 402 | lib.PrintError("Invalid Input.") 403 | continue 404 | while True: 405 | scrape_input_method = input("[m]anual input (single url) or load from [f]ile: ") 406 | if scrape_input_method.lower() == 'm' or 'f': 407 | break 408 | elif scrape_input_method == "": 409 | pass 410 | continue 411 | else: 412 | lib.PrintError("Invalid Input.") 413 | continue 414 | while True: 415 | try: 416 | limiter = int(input("Enter the time between requests, in seconds: ")) 417 | if limiter < 0: 418 | continue 419 | elif limiter == "": 420 | pass 421 | continue 422 | break 423 | except ValueError: 424 | lib.PrintError("Invalid Input. Enter a positive integer.") 425 | continue 426 | lib.PrintStatus("If provided links to one (or multiple) github profiles, Keyring can crawl all repositories for secrets.") 427 | lib.PrintStatus("If provided links to github repositories, Keyring can crawl all files in that repository.") 428 | lib.PrintStatus("However, this means Keyring WILL NOT FUNCTION CORRECTLY if provided links to other pages in the same text file, or if profile and repo links are mixed.") 429 | lib.PrintStatus("Large profiles will also take a fairly long time, as Keyring fetches ALL files from ALL repos.") 430 | while True: 431 | repocrawlchoice = input("Enable repo crawling? [y]/[n]: ") 432 | if repocrawlchoice == "": 433 | pass 434 | continue 435 | elif repocrawlchoice.lower() == 'y': 436 | repo_crawl = True 437 | while True: 438 | lib.PrintHighSeverity("Warning: Turning on verbosity will output a LOT when spidering large profiles.") 439 | verbosity = input("Enable verbosity for spidering: [y]/[n]: ") 440 | if verbosity == "": 441 | pass 442 | continue 443 | elif verbosity.lower() == 'y' or 'n': 444 | break 445 | else: 446 | lib.PrintError("Invalid Input.") 447 | continue 448 | while True: 449 | link_type_input = input("Github [p]rofile links or Github [r]epository links?: ") 450 | if link_type_input == "": 451 | pass 452 | continue 453 | elif link_type_input.lower() == 'p': 454 | link_type = 'profile' 455 | break 456 | elif link_type_input.lower() == 'r': 457 | link_type = 'repo' 458 | break 459 | else: 460 | lib.PrintError("Invalid Input.") 461 | continue 462 | while True: 463 | lib.PrintStatus("Repositories may contain large directories with no value in crawling, such as dependency folders.") 464 | directory_filtering_status = input("Enable directory filtering: [y]/[n]: ") 465 | if directory_filtering_status.lower() == 'y': 466 | directory_filtering = True 467 | blacklisted_directories = [] 468 | blacklisted_directory_input = input("Enter the directory names you wish to filter (separated by a single comma): ").split(',') 469 | for directory in blacklisted_directory_input: 470 | blacklisted_directories.append(directory) 471 | break 472 | elif directory_filtering_status.lower() == 'n': 473 | directory_filtering = False 474 | blacklisted_directories = [] #placeholder for configparser 475 | break 476 | elif directory_filtering_status == "": 477 | pass 478 | continue 479 | else: 480 | lib.PrintError("Invalid Input.") 481 | continue 482 | break 483 | elif repocrawlchoice.lower() == 'n': 484 | repo_crawl = False 485 | link_type = 'regular' 486 | directory_filtering = False 487 | blacklisted_directories = [] 488 | verbosity = 'off' 489 | break 490 | else: 491 | lib.PrintError("Invalid Input.") 492 | continue 493 | while True: 494 | savechoice = input("Save choices as config file? [y]/[n]: ") 495 | if savechoice.lower() == 'n': 496 | break 497 | elif savechoice.lower() == 'y': 498 | while True: 499 | if isdir(f'{curdir}/KRconfig') is False: 500 | lib.PrintError(f"Config directory not detected in {curdir}...") 501 | lib.PrintStatus(f"Making config directory...") 502 | mkdir(f'{curdir}/KRconfig') 503 | break 504 | else: 505 | break 506 | configname = input("Enter the name for this configuration: ") 507 | with open(f'{curdir}/KRconfig/{configname}.ini', 'w') as cfile: 508 | cfile.write( 509 | f'''[initial_vars] 510 | displaymode = {displaymode} 511 | [scraping_vars] 512 | scrape_input_method = {scrape_input_method} 513 | limiter = {limiter} 514 | repo_crawl = {repo_crawl} 515 | link_type = {link_type} 516 | directory_filtering = {directory_filtering} 517 | blacklisted_directories = {blacklisted_directories} 518 | verbosity = {verbosity} 519 | ''') 520 | else: 521 | lib.PrintError("Invalid Input.") 522 | continue 523 | break 524 | return displaymode, scrape_input_method, limiter, repo_crawl, link_type, directory_filtering, blacklisted_directories, verbosity 525 | def main(): 526 | try: 527 | while True: 528 | initchoice = input("[L]oad config file or [m]anually enter?: ") 529 | if initchoice.lower() == 'l': 530 | displaymode, scrape_input_method, limiter, repo_crawl, link_type, directory_filtering, blacklisted_directories, verbosity = load_config() 531 | if scrape_input_method == 'f': 532 | while True: 533 | addressfile = input("Enter the full path to the address file: ") 534 | if isfile(addressfile) is True: 535 | break 536 | else: 537 | lib.PrintError("No such file found.") 538 | continue 539 | break 540 | elif initchoice.lower() == 'm': 541 | displaymode, scrape_input_method, limiter, repo_crawl, link_type, directory_filtering, blacklisted_directories, verbosity = manual_setup() 542 | break 543 | elif initchoice == "": 544 | pass 545 | else: 546 | lib.PrintError("Invalid Input.") 547 | continue 548 | scrape(scrape_input_method, displaymode, limiter, repo_crawl, link_type, directory_filtering, blacklisted_directories, verbosity) 549 | except KeyboardInterrupt: 550 | # print() # are you doing something with this? 551 | lib.PrintError("Search canceled.") 552 | 553 | if __name__ == '__main__': 554 | main() 555 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------