├── FILTERS.txt ├── README.txt ├── spilpconfig.py ├── spilp.py └── LICENSE.txt /FILTERS.txt: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /README.txt: -------------------------------------------------------------------------------- 1 | # Copyright 2011, Tihomir Kit (kittihomir@gmail.com) 2 | # spilp is distributed under the terms of GNU General Public License v3 3 | # A copy of GNU GPL v3 license can be found in LICENSE.txt or at http://www.gnu.org/licenses/gpl-3.0.html 4 | 5 | 6 | Simple Python IIS log parser (spilp) is a simple Python parser that takes IIS logs, 7 | parses them and creates statistical reports which can be used to discover unusual 8 | IP activity more easily. 9 | 10 | 11 | 1. Features 12 | 2. Usage 13 | 3. Download links 14 | 15 | 16 | 17 | 1. Features 18 | -------------------------------------------------------- 19 | - extracts a list of IP addresses with number of hits they made sorted by number of hits 20 | - extracts a list of "close" IP addresses that made a certain number of hits 21 | - extracts a list of user agents sorted by number of hits 22 | - extracts a list of cs-method hits (GET method excluded) 23 | - extracts a list of file hits sorted by number of hits 24 | - .pdf, .doc, .xls, .ppt (document files) 25 | - .js, .htm, .asp (web files) 26 | - extracts extended information for document and web file hits 27 | - includes timestamps, client IP addresses, methods, ports, user agent details and http status codes 28 | - extracts a list of "unusual" http status code hits sorted by number of hits 29 | - client IP address list 30 | - a list of files hit by an IP and number of hits for that file 31 | - filtering results (include or exclude filtering - works in "either-or" way) 32 | - ability to auto-generate an IP range list as a filter 33 | - reverse DNS country lookup using MaxMinds GeoIP country downloadable database 34 | - additional info in certain reports 35 | - filtering results by country of origin (as a separate filtering option using spilpconf.py file) 36 | - ability to process large amount of IIS log files 37 | - CONFIG file for performance and output tweaking 38 | 39 | 40 | 41 | 2. Usage 42 | -------------------------------------------------------- 43 | Spilp is written in python3.2 so you will need that installed (if not using Windows binary 44 | version). 45 | 46 | Spilp requires pygeoip python module to work properly. It also requires GeoIP country free 47 | database (find links below). After downloading GeoIP.dat.gz from MaxMind website, extract 48 | the archive, and put GeoIP.dat database into the same folder as spilp.py. GeoIP country 49 | database binary should be updated every once in a while to get the latest country IP ranges. 50 | 51 | To tweak the amount of output and/or performance, edit spilpconfig.py. 52 | Note that if you have large amounts of log files (more than 2/3 of your free amount of RAM), 53 | you must change DB_STORAGE option to ".tempdb". 54 | 55 | IIS log files will be automatically parsed if they are in spilp root directory or in any 1st 56 | level subdirectory residing in spilp root directory. 57 | 58 | Spilp currently works with default IIS log format meaning that it uses the following IIS fields: 59 | date time s-sitename s-ip cs-method cs-uri-stem cs-uri-query s-port cs-username c-ip cs(User-Agent) sc-status sc-substatus sc-win32-status 60 | 61 | If you are using a different IIS log format, you will need to add/remove certain variables in 62 | splitLogLine() function in spilp.py (left part of the line that contains "log_line.split"). 63 | Be careful when doing so though, because you must have the same number of variables there 64 | as you have fields in your IIS logs and they must be in same order. Keeping variable names 65 | the same is recommended unless you know what you are doing. 66 | 67 | To use an IP range list for filtering, use the following syntax: 68 | $$.ip_range(192.168.1.1 - 192.170.127.234) 69 | and put that line into your FILTERS.txt file as you would do with any other filter expression. 70 | 71 | Windows users can use spilp.exe binary. In that case there is no need for Python and pygeoip 72 | to be installed on the machine. GeoIP country database still needs to be downloaded from 73 | MaxMinds website and it needs to be put into the same folder where spilp.exe is located. 74 | 75 | 76 | 77 | 3. Download links 78 | -------------------------------------------------------- 79 | pygeoip: http://code.google.com/p/pygeoip 80 | GeoIP country: http://www.maxmind.com/app/geolitecountry 81 | GeoIP database: http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz 82 | 83 | 84 | -------------------------------------------------------------------------------- /spilpconfig.py: -------------------------------------------------------------------------------- 1 | #################################################################### 2 | #==================================================================# 3 | # -------------- SPILP CONFIG OPTIONS -------------- # 4 | #==================================================================# 5 | #################################################################### 6 | # Copyright 2011, Tihomir Kit (kittihomir@gmail.com) 7 | # spilp is distributed under the terms of GNU General Public License v3 8 | # A copy of GNU GPL v3 license can be found in LICENSE.txt or at http://www.gnu.org/licenses/gpl-3.0.html 9 | # 10 | # TO TURN OFF ANY OPTION, SET ITS VALUE TO 0 11 | # TO TURN ON ANY OPTION, SET ITS VALUE TO 1 12 | 13 | 14 | 15 | 16 | # -- put db in RAM - for smaller databases (faster) 17 | # Use if total ammount of log files is smaller than 2/3 of your total ammount of free RAM. 18 | # :: set to ':memory:' to put the database to RAM 19 | # 20 | # -- put db on HDD - for bigger databases (bigger) 21 | # Use if total ammount of log files is bigger than 2/3 of your total ammount of free RAM. 22 | # :: set to '.tempdb' to put the database to HDD 23 | DB_STORAGE = ':memory:' 24 | 25 | 26 | 27 | 28 | # -- set to 1 to get hit counts per client IP -- 29 | # Results are sorted by number of hits. 30 | CHECK_HITS_PER_IP = 1 31 | 32 | 33 | 34 | 35 | # -- set to 1 to get the close IP's -- 36 | # Shows sorted IP's so attacks from the same region could be more easily identified. 37 | CHECK_CLOSE_IPS = 1 38 | 39 | # - minimum number of hits per IP to trigger logging -- 40 | # If an IP made less than CLOSE_IP_TRESHOLD number of hits, it will be ignored. 41 | # Bigger CLOSE_IP_TRESHOLD value will show IP's with more activity, and will generate less output. 42 | # Smaller CLOSE_IP_TRESHOLD value will show more IP's, and will generate more output. 43 | # :: RECOMMENDED: 75-100 44 | CLOSE_IP_TRESHOLD = 75 45 | 46 | 47 | 48 | 49 | # -- set to 1 to get hit counts per agent -- 50 | # Results are sorted by number of hits. 51 | CHECK_AGENTS = 1 52 | 53 | 54 | 55 | 56 | # -- set to 1 to get method hits -- 57 | # Results show hits for all methods except get. 58 | CHECK_METHODS = 1 59 | 60 | 61 | 62 | 63 | # -- set to 1 to get hits per text file -- 64 | # Results are sorted by number of hits. 65 | CHECK_HITS_PER_TEXT_FILE = 1 66 | 67 | # -- add or remove text filetype events to be logged -- 68 | # Only filetypes in DPTF_TYPES_TO_CHECK will be in output. 69 | # :: RECOMMENDED filetypes: ('.pdf', '.doc', '.xls', '.ppt') - this will also look for .docx, .xlsx and .pptx files 70 | DPTF_TYPES_TO_CHECK = ('.pdf', '.doc', '.xls', '.ppt') 71 | 72 | # -- number of top hit files to get extended info -- 73 | # Only top DPTF_LINES_OUTPUT_LIMIT number of files will get extended information about 74 | # hits (date, time, ip's agents, status code...). 75 | # :: for precise reports (when using filtering) - RECOMMENDED 10000 or higher 76 | # :: for generic statistical reports - RECOMMENDED 50 77 | DPTF_LINES_OUTPUT_LIMIT = 50 78 | 79 | 80 | 81 | 82 | # -- set to 1 to get hits per web file -- 83 | # Results are sorted by number of hits. 84 | CHECK_HITS_PER_WEB_FILE = 1 85 | 86 | # -- add or remove web filetype events to be logged -- 87 | # Only filetypes in DPTF_TYPES_TO_CHECK will be in output. 88 | # :: RECOMMENDED filetypes: ('.js', '.htm', '.asp') - this will also look for .html and .aspx files 89 | DPWF_TYPES_TO_CHECK = ('.js', '.htm', '.asp') 90 | 91 | # -- number of top hit files to get extended info -- 92 | # Only top DPWF_LINES_OUTPUT_LIMIT number of files will get extended information about 93 | # hits (date, time, ip's agents, status code...). 94 | # :: for precise reports (when using filtering) - RECOMMENDED 10000 or higher 95 | # :: for generic statistical reports - RECOMMENDED 50 96 | DPWF_LINES_OUTPUT_LIMIT = 50 97 | 98 | 99 | 100 | 101 | # -- set to 1 to get hit counts by HTTP status codes-- 102 | CHECK_STATUS_CODES_HITS = 1 103 | 104 | # -- add or remove status codes to be examined in more detail -- 105 | # :: RECOMMENDED codes: ('400', '401', '403', '404', '405', '406', '416', '500', '501', '505') 106 | STATUS_CODES_TO_CHECK = ('400', '401', '403', '404', '405', '406', '416', '500', '501', '505') 107 | 108 | # -- maximum number of events for each HTTP status code that will allow logging -- 109 | # If there are too many hits for a certain HTTP status code, only STATUS_CODES_CODE_COUNT_TRESHOLD number 110 | # of events with the highest count will be in output. Higher number means more output and slower performance, 111 | # smaller nubmer means less output and faster performance. 112 | # :: for precise reports (when using filtering) - RECOMMENDED 5000 or higher 113 | # :: for generic statistical reports - RECOMMENDED 50 114 | STATUS_CODES_CODE_COUNT_TRESHOLD = 50 115 | 116 | # -- maximum number of events for HTTP status code event for each IP to trigger logging -- 117 | # If there are too many hits from an IP for a certain HTTP status code, only STATUS_CODES_EVENT_COUNT_TRESHOLD number 118 | # of events with the highest count will be in output. Higher number means more output and slower performance, 119 | # smaller nubmer means less output and faster performance. 120 | # :: for precise reports (when using filtering) - RECOMMENDED 5000 or higher 121 | # :: for generic statistical reports - RECOMMENDED 15 122 | STATUS_CODES_EVENT_COUNT_TRESHOLD = 15 123 | 124 | # -- minimum number of hits IP needs to make to trigger logging for that IP -- 125 | # If there are too many IP events to log, only events from IP's that made more than STATUS_CODES_IP_COUNT_TRESHOLD number 126 | # of hits will be in output. Higher number means less output and faster performance, smaller nubmer means more 127 | # output and slower performance. 128 | # :: for precise reports (when using filtering) - RECOMMENDED 1 129 | # :: for generic statistical reports - RECOMMENDED 50 130 | STATUS_CODES_IP_COUNT_TRESHOLD = 50 131 | 132 | # -- maximum number of hits per URI to trigger logging for that URI -- 133 | # If there are too many URI hits to log, only STATUS_CODES_URI_COUNT_TRESHOLD number of hits with the highest 134 | # count will be in output. Higher number means more output and slower performance, smaller nubmer means 135 | # less output and faster performance. 136 | # :: for precise reports (when using filtering) - RECOMMENDED 5000 or higher 137 | # :: for generic statistical reports - RECOMMENDED 50 138 | STATUS_CODES_URI_COUNT_TRESHOLD = 50 139 | 140 | 141 | 142 | 143 | # -- set to 1 to turn on filtering by IP, date, agent... multiple parameters allowed -- 144 | # If a log line contains an expression from any of filter expressions, that line will or will not be further 145 | # processed depending on PARSING_FILTER_INCLUDE_EXCLUDE_SWITCH option. All other data will be dropped and 146 | # will not be a part of a generated report. 147 | CHECK_PARSING_FILTER = 0 148 | 149 | # -- set to 1 to use parsing filter to INCLUDE by expression -- 150 | # -- set to 0 to use parsing filter to EXCLUDE by expression -- 151 | # If set to 1, only results that match filter expressions will be included in reports. 152 | # If set to 0, all results that match filter expressions will be excluded from reports. 153 | PARSING_FILTER_INCLUDE_EXCLUDE_SWITCH = 1 154 | 155 | # -- path and filename for *.txt file used for generating the parsing filter -- 156 | # Best placed in the same folder as spilp.py. 157 | # Each line in the *.txt file is one filter expression. 158 | PARSING_FILTER_FILE_NAME = "FILTERS.txt" 159 | 160 | 161 | 162 | 163 | # -- set to 1 to turn on filtering by country -- 164 | # If you want to generate reports based on hits coming from a single country, use this option. 165 | # If you are using this option, make sure to also set the COUNTRY_TO_CHECK option up. 166 | # NOTE that if the CHECK_PARSING_FILTER option is set to 1, PARSING_FILTER_INCLUDE_EXCLUDE_SWITCH 167 | # option will decide whether events for the chosen country will get included or excluded. 168 | CHECK_COUNTRY = 0 169 | 170 | # -- name of a country to be checked upon -- 171 | # If a page hit is not coming from COUNTRY_TO_CHECK country, that event will get dropped 172 | # and it will not be further processed. 173 | COUNTRY_TO_CHECK = "Croatia" 174 | 175 | 176 | 177 | 178 | 179 | 180 | -------------------------------------------------------------------------------- /spilp.py: -------------------------------------------------------------------------------- 1 | ############################################################# 2 | #===========================================================# 3 | # Simple Python IIS Log Parser (SPILP) -- Python3.2 -- # 4 | #===========================================================# 5 | ############################################################# 6 | # Copyright 2011, Tihomir Kit (kittihomir@gmail.com) 7 | # spilp is distributed under the terms of GNU General Public License v3 8 | # A copy of GNU GPL v3 license can be found in LICENSE.txt or at http://www.gnu.org/licenses/gpl-3.0.html 9 | # 10 | # SPILP config file ==>> spilpconfig.py 11 | # last modification - 12/09/11 12 | 13 | from collections import defaultdict 14 | from itertools import filterfalse 15 | from time import gmtime, strftime, mktime 16 | from spilpconfig import * 17 | import operator 18 | import pygeoip 19 | import sqlite3 20 | import shutil 21 | import codecs 22 | import socket 23 | import os 24 | import re 25 | 26 | 27 | # ---- dump the data into a file ---- # 28 | def dumpToFile(file_name, data_dump): 29 | file_name = "generated_reports/" + file_name 30 | data_file = open(file_name, 'w') 31 | data_file.write(str(data_dump)) 32 | data_file.close() 33 | 34 | 35 | # ---- remove leftover temp files and folders ---- # 36 | def cleanUp(): 37 | if os.path.exists("__pycache__"): 38 | shutil.rmtree("__pycache__") 39 | if os.path.exists(".tempdb"): 40 | os.remove(".tempdb") 41 | 42 | 43 | # ---- add dates and extension to filenames ---- # 44 | def setFileName(file_name): 45 | date = gmtime() 46 | file_name += strftime("_%y%m%d", date) + ".txt" 47 | return file_name 48 | 49 | 50 | # ---- if filtering is turned on, initialize filter ---- # 51 | def initializeFilters(): 52 | global country_filter 53 | filter = [] 54 | 55 | # converts the filter file into a list for later use 56 | if CHECK_PARSING_FILTER: 57 | with open(PARSING_FILTER_FILE_NAME, 'r', encoding='utf-8', errors='ignore') as filter_lines: 58 | for line in filter_lines: 59 | line = line.strip() 60 | 61 | # if there is an IP range in FILTERS.txt, generate the list and append it 62 | if line.startswith("$$.ip_range"): 63 | ips = re.findall(r'[0-9]+(?:\.[0-9]+){3}', line) 64 | ip_range = ipRange(ips[0], ips[1]) 65 | for ip in ip_range: 66 | filter.append(ip) 67 | continue 68 | 69 | filter.append(line) 70 | 71 | return filter 72 | 73 | 74 | # ---- generates a list of IP addresses based on given range ---- # 75 | def ipRange(start_ip, end_ip): 76 | start = list(map(int, start_ip.split("."))) 77 | end = list(map(int, end_ip.split("."))) 78 | temp = start 79 | ip_range = [] 80 | 81 | # increments leading IP octets on overflow 82 | ip_range.append(start_ip) 83 | while temp != end: 84 | start[3] += 1 85 | for i in (3, 2, 1): 86 | if temp[i] == 256: 87 | temp[i] = 0 88 | temp[i-1] += 1 89 | ip_range.append(".".join(map(str, temp))) 90 | 91 | return ip_range 92 | 93 | 94 | # ---- return short HTTP status code description ---- # 95 | def httpCodeDescription(sc_status): 96 | result = "HTTP Code " + str(sc_status) + " (" 97 | 98 | # dictionary of HTTP status codes 99 | codes = { 100 | '200': "OK", 101 | '206': "Partial content", 102 | '301': "Moved permanently", 103 | '302': "Found", 104 | '304': "Not modified", 105 | '400': "Bad request", 106 | '401': "Unauthorized", 107 | '403': "Forbidden", 108 | '404': "Not found", 109 | '405': "Method not allowed", 110 | '406': "Not acceptable", 111 | '416': "Requested range not satisfiable", 112 | '500': "Internal server error", 113 | '501': "Not implemented", 114 | '502': "Bad gateway", 115 | '503': "Service unavailable", 116 | '505': "HTTP version not supported" 117 | } 118 | 119 | if sc_status in codes: 120 | result += codes[sc_status] + ")" 121 | else: 122 | result += "NO HTTP STATUS CODE DESCRIPTION - check the code meaning on the Internet)" 123 | 124 | return result 125 | 126 | 127 | # ---- get hit counts per client IP ---- # 128 | def hitsPerIp(file_name): 129 | file_name = setFileName(file_name) 130 | file_output = "" 131 | i = 1 132 | 133 | print("::\n:: Preparing", file_name) 134 | file_output += "Number of hits made per IP (sorted)\n\n" 135 | 136 | # sorts by IP hit counts 137 | for c_ip, count in sorted(ip_count.items(), key=operator.itemgetter(1), reverse=True): 138 | country_name = gio.country_name_by_addr(c_ip) 139 | if country_name == "": 140 | country_name = "-" 141 | file_output = file_output + str(i) + ". (" + str(count) + " hits) --- " + str(c_ip) + " (" + country_name + ")\n" 142 | i += 1 143 | 144 | dumpToFile(file_name, file_output) 145 | print(":: => report dumped") 146 | 147 | 148 | # ---- get hit counts for "close" IP addresses ---- # 149 | def closeIps(file_name, CLOSE_IP_TRESHOLD): 150 | file_name = setFileName(file_name) 151 | file_output = "" 152 | i = 1 153 | 154 | print("::\n:: Preparing", file_name) 155 | file_output += "Close IP addresses (with more than " + str(CLOSE_IP_TRESHOLD) + " hits per IP)\n\n" 156 | 157 | # sorts by IP, so 'close' IP's could be identified 158 | for c_ip, count in sorted(ip_count.items(), key=lambda item: socket.inet_aton(item[0])): 159 | # if less hits than CLOSE_IP_TRESHOLD (per IP address), then gtfo 160 | if count > CLOSE_IP_TRESHOLD: 161 | country_name = gio.country_name_by_addr(c_ip) 162 | if country_name == "": 163 | country_name = "-" 164 | file_output = file_output + str(i) + ". (" + str(count) + " hits) --- " + str(c_ip) + " (" + country_name + ")\n" 165 | i += 1 166 | 167 | dumpToFile(file_name, file_output) 168 | print(":: => report dumped") 169 | 170 | 171 | # ---- get agent counts ---- # 172 | def agentHits(file_name): 173 | file_name = setFileName(file_name) 174 | file_output = "" 175 | i = 1 176 | 177 | print("::\n:: Preparing", file_name) 178 | file_output += "Agent hits\n\n" 179 | 180 | # sorts agents by counts (descending) 181 | for cs_user_agent, count in sorted(agent_count.items(), key=operator.itemgetter(1), reverse=True): 182 | file_output += str(i) + ". (" + str(count) + " hits) --- " + str(cs_user_agent) + "\n" 183 | i += 1 184 | 185 | dumpToFile(file_name, file_output) 186 | print(":: => report dumped") 187 | 188 | 189 | # ---- get cs-methods ---- # 190 | def methodHits(file_name): 191 | file_name = setFileName(file_name) 192 | file_output = "" 193 | i = 1 194 | 195 | print("::\n:: Preparing", file_name) 196 | file_output += "CS-Method hits" 197 | 198 | # sorts methods by counts 199 | for method, count in sorted(hits_by_method.items(), key=operator.itemgetter(1), reverse=True): 200 | # skips the GET method 201 | if method == "GET": 202 | continue 203 | 204 | file_output += "\n\n" + str(i) + ". Method: " + str(method) + "\n:: " + str(count) + " hits\n\n" 205 | i += 1 206 | 207 | # filters db data and outputs rows 208 | rows = db_cursor.execute("SELECT date, time, c_ip, cs_method, s_port, cs_uri_stem, cs_user_agent, sc_status FROM hits_by_extension_table WHERE cs_method = '" + method + "'") 209 | for row in rows: 210 | file_output += " " 211 | for element in row: 212 | file_output += str(element) + " " 213 | file_output += "\n" 214 | 215 | dumpToFile(file_name, file_output) 216 | print(":: => report dumped") 217 | 218 | 219 | # ---- get hit counts by status ---- # 220 | def statusHits(file_name): 221 | file_name = setFileName(file_name) 222 | status_ip_count = defaultdict(int) 223 | status_uri_count = defaultdict(int) 224 | file_output = "" 225 | i = 1 226 | 227 | print("::\n:: Preparing", file_name) 228 | file_output += "Number of hits by HTTP status code\nDetailed output for -> " + str(STATUS_CODES_TO_CHECK) + "\n\n" 229 | 230 | # sorts HTTP status codes 231 | for sc_status, code_count in sorted(hits_by_status_count.items(), key=operator.itemgetter(1), reverse=True): 232 | file_output += "\n" + str(i) + ". " + httpCodeDescription(sc_status) + "\n:: " + str(code_count) + " hits\n" 233 | 234 | # proceed if HTTP status code is in STATUS_CODES_TO_CHECK 235 | if sc_status in STATUS_CODES_TO_CHECK: 236 | status_ip_rows = db_cursor.execute("SELECT c_ip FROM hits_by_extension_table WHERE sc_status = '" + sc_status + "'") 237 | status_ip_count.clear() 238 | for ip_status in status_ip_rows: 239 | status_ip_count[ip_status[0]] += 1 #count by IP 240 | 241 | event_count = 0 242 | # sorts hits by IP addresses 243 | for c_ip, ip_count in sorted(status_ip_count.items(), key=operator.itemgetter(1), reverse=True): 244 | event_count += 1 245 | if (event_count >= STATUS_CODES_EVENT_COUNT_TRESHOLD or ip_count < STATUS_CODES_IP_COUNT_TRESHOLD) and code_count >= STATUS_CODES_CODE_COUNT_TRESHOLD: 246 | break 247 | file_output += "\n " + str(c_ip) + " (" + gio.country_name_by_addr(c_ip) + ") --- " + str(ip_count) + " hits\n" 248 | 249 | status_uri_rows = db_cursor.execute("SELECT cs_uri_stem FROM hits_by_extension_table WHERE sc_status = '" + sc_status + "' AND c_ip ='" + c_ip + "'") 250 | status_uri_count.clear() 251 | for uri_status in status_uri_rows: 252 | status_uri_count[uri_status[0]] += 1 #count by URI 253 | 254 | uri_count_check = 0 255 | # sorts hits by URI 256 | for cs_uri_stem, uri_count in sorted(status_uri_count.items(), key=operator.itemgetter(1), reverse=True): 257 | file_output += " " + str(cs_uri_stem) + " --- " + str(uri_count) + " hits\n" 258 | uri_count_check += 1 259 | if uri_count_check >= STATUS_CODES_URI_COUNT_TRESHOLD: 260 | break 261 | file_output += "\n" 262 | else: 263 | file_output += "\n No detailed output for events of this status code because the status is not listed in STATUS_CODES_TO_CHECK option in spilpconfig.py\n\n" 264 | i += 1 265 | 266 | dumpToFile(file_name, file_output) 267 | print(":: => report dumped") 268 | 269 | 270 | # ---- get hit counts per file ---- # 271 | def hitsByExtension(file_name, extensions_to_check, limit): 272 | file_name_extended = setFileName(file_name + "Extended") 273 | file_name = setFileName(file_name) 274 | file_output_extended = "" 275 | file_output = "" 276 | i = 0 277 | 278 | # fetch the data from sqlite db, and convert it from an iterator to a list 279 | db_rows = db_cursor.execute("SELECT * FROM hits_by_extension_table") 280 | db_rows = list(db_rows) 281 | 282 | print("::\n:: Preparing", file_name, "\n:: Extensions to check - {0}".format(extensions_to_check)) 283 | file_output += "Number of times files have been hit (sorted)\n\n" 284 | file_output_extended += "Number of times files have been hit (sorted and extended with additional information)\n" 285 | file_output_extended += "Detailed output for -> " + str(extensions_to_check) + "\n" 286 | file_output_extended += "Output format: DATE TIME CLIENT_IP METHOD PORT AGENT STATUS_CODE\n\n" 287 | 288 | # sort by hits (groups by file extensions) 289 | for cs_uri_stem, count in sorted(hits_by_extension_count.items(), key=operator.itemgetter(1), reverse=True): 290 | if cs_uri_stem.endswith(extensions_to_check): 291 | full_path = str(cs_uri_stem.encode('utf-8', 'backslashreplace'))[2:-1] 292 | file_output += str(i + 1) + ". (" + str(count) + " hits) --- " + full_path + "\n" 293 | 294 | #time_bla = gmtime() 295 | #print(strftime("%H:%M:%S", time_bla), full_path.encode('utf-8', 'backslashreplace')) 296 | 297 | # more detailed file output 298 | file_output_extended += str(i + 1) + ". (" + str(count) + " hits) --- " + full_path + "\n\n" 299 | for row in db_rows: 300 | if row[5] == full_path: 301 | file_output_extended += " " 302 | for element in row: 303 | if element != full_path: 304 | file_output_extended += element + " " 305 | file_output_extended += "\n" 306 | file_output_extended += "\n\n" 307 | 308 | # stop iterating at output_line_limit 309 | i += 1 310 | if i == limit: 311 | break 312 | 313 | dumpToFile(file_name, file_output) 314 | dumpToFile(file_name_extended, file_output_extended) 315 | print(":: => report dumped") 316 | 317 | 318 | # ---- split each logline into multiple variables, populate dictionaries and db ---- # 319 | def splitLogline(log_line): 320 | # IIS log fields layout 321 | date, time, s_sitename, s_ip, cs_method, cs_uri_stem, cs_uri_query, s_port, cs_username, c_ip, cs_user_agent, sc_status, sc_substatus, sc_win32_status = log_line.split(" ") 322 | 323 | # filter by country 324 | if CHECK_COUNTRY: 325 | if COUNTRY_TO_CHECK != gio.country_name_by_addr(c_ip): 326 | return 327 | 328 | # populating dictionaries and sqlite3 db 329 | ip_count[c_ip] += 1 330 | agent_count[cs_user_agent] += 1 331 | hits_by_method[cs_method] += 1 332 | hits_by_status_count[sc_status] += 1 333 | hits_by_extension_count[cs_uri_stem] += 1 334 | 335 | db_cursor.execute( 336 | "INSERT INTO hits_by_extension_table(date, time, c_ip, cs_method, s_port, cs_uri_stem, cs_user_agent, sc_status) VALUES (?, ?, ?, ?, ?, ?, ?, ?)", 337 | (date, time, c_ip, cs_method, s_port, cs_uri_stem, cs_user_agent, sc_status) 338 | ) 339 | 340 | 341 | # ---- fetch log files from current folder and its 1st level subfolders ---- # 342 | def fetchData(folder_name): 343 | global total_events 344 | 345 | # look for folders in current folder 346 | print("\n\nENTERING FOLDER: ", end="") 347 | if folder_name == "": 348 | print(os.getcwd()) 349 | folder_name = "." 350 | else: 351 | print("{0}\{1}".format(os.getcwd(), folder_name)) 352 | 353 | # for each log file found, filter data and populate dicts and db 354 | for file_name in os.listdir(folder_name): 355 | if ".log" in file_name: 356 | print("::\n:: Gathering data from", file_name) 357 | file_path = folder_name + "/" + file_name 358 | 359 | with open(file_path, 'r', encoding='utf-8', errors='ignore') as log_lines: 360 | # skip the log line if it does not contain one of the values from PARSING_FILTER 361 | if CHECK_PARSING_FILTER: 362 | # exclusion filter turned on 363 | if PARSING_FILTER_INCLUDE_EXCLUDE_SWITCH == 0: 364 | for log_line in filterfalse(lambda log_line: log_line.startswith("#"), log_lines): 365 | if any(filter in log_line for filter in parsing_filter): 366 | continue 367 | else: 368 | splitLogline(log_line) 369 | total_events += 1 370 | # inclusion filter turned on 371 | elif PARSING_FILTER_INCLUDE_EXCLUDE_SWITCH == 1: 372 | for log_line in filterfalse(lambda log_line: log_line.startswith("#"), log_lines): 373 | if any(filter in log_line for filter in parsing_filter): 374 | splitLogline(log_line) 375 | total_events += 1 376 | else: 377 | for log_line in filterfalse(lambda log_line: log_line.startswith("#"), log_lines): 378 | splitLogline(log_line) 379 | total_events += 1 380 | 381 | db_connection.commit() 382 | print(":: => done.") 383 | print("::\n:: exiting folder...") 384 | 385 | 386 | 387 | ############################################################ 388 | ### ----------------------- MAIN ----------------------- ### 389 | ############################################################ 390 | time_start = gmtime() 391 | print("\n\nJob started at", strftime("%H:%M:%S", time_start)) 392 | 393 | # check/create a directory for dumping reports 394 | if not os.path.exists("generated_reports"): 395 | os.makedirs("generated_reports") 396 | 397 | # initialize vars 398 | parsing_filter = initializeFilters() 399 | gio = pygeoip.GeoIP("GeoIP.dat") 400 | hits_by_extension_list = [] 401 | log_lines = [] 402 | folder_name = "" 403 | total_events = 0 404 | 405 | # initialize sqlite DB 406 | db_connection = sqlite3.connect(DB_STORAGE) 407 | db_cursor = db_connection.cursor() 408 | db_cursor.execute("CREATE TABLE IF NOT EXISTS hits_by_extension_table(date, time, c_ip, cs_method, s_port, cs_uri_stem, cs_user_agent, sc_status)") 409 | db_connection.commit() 410 | 411 | # initialize empty defaultdicts 412 | ip_count = defaultdict(int) 413 | agent_count = defaultdict(int) 414 | hits_by_method = defaultdict(int) 415 | hits_by_status_count = defaultdict(int) 416 | hits_by_extension_count = defaultdict(int) 417 | 418 | # split raw log data (events) through multiple variables 419 | fetchData(folder_name) 420 | for folder_name in os.listdir(): 421 | if os.path.isdir(folder_name): 422 | fetchData(folder_name) 423 | 424 | # dumping time! :D 425 | print("\n\nPROCESSING", total_events, "log events...") 426 | closeIps("closeIps", CLOSE_IP_TRESHOLD) if CHECK_CLOSE_IPS else 0 427 | hitsPerIp("hitsPerIp") if CHECK_HITS_PER_IP else 0 428 | statusHits("hitsByStatus") if CHECK_STATUS_CODES_HITS else 0 429 | hitsByExtension("documentDownloads", DPTF_TYPES_TO_CHECK, DPTF_LINES_OUTPUT_LIMIT) if CHECK_HITS_PER_TEXT_FILE else 0 430 | hitsByExtension("webFilesHits", DPWF_TYPES_TO_CHECK, DPWF_LINES_OUTPUT_LIMIT) if CHECK_HITS_PER_WEB_FILE else 0 431 | agentHits("agentHits") if CHECK_AGENTS else 0 432 | methodHits("methodHits") if CHECK_METHODS else 0 433 | 434 | db_connection.close() 435 | cleanUp() 436 | 437 | time_stop = gmtime() 438 | time_diff_seconds = mktime(time_stop) - mktime(time_start) 439 | time_diff_minutes = time_diff_seconds / 60 440 | print("::\n:: done...\n\n\nTime elapsed: {0:0.1f} minutes ({1}s)".format(time_diff_minutes, time_diff_seconds), "\nJob finished at", strftime("%H:%M:%S", time_stop), "\n\n") 441 | input("\nPres Enter to continue...\n\n\n\n\n\n\n\n") -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 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 | --------------------------------------------------------------------------------