├── x64-shellcode-loader ├── shellcodes │ ├── exit.bin │ ├── helloworld.bin │ ├── exit.s │ └── helloworld.s ├── hex_to_bin.py └── main.c ├── README.md ├── machoentropy ├── README.md ├── compute_entropy.py └── MachoEntropyComputer.py ├── malware_toys ├── plot_entropy.py ├── parse_vtreports.py └── classify_macho.py ├── .gitignore └── LICENSE /x64-shellcode-loader/shellcodes/exit.bin: -------------------------------------------------------------------------------- 1 | 1۸ -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # MacRE 2 | Scripts and tools for Mac OS X reversing 3 | -------------------------------------------------------------------------------- /x64-shellcode-loader/shellcodes/helloworld.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/twodayslate/macos-re/master/x64-shellcode-loader/shellcodes/helloworld.bin -------------------------------------------------------------------------------- /x64-shellcode-loader/shellcodes/exit.s: -------------------------------------------------------------------------------- 1 | .section __TEXT,__text 2 | .globl _main 3 | _main: 4 | xor %rbx, %rbx 5 | movl $0x2000001, %eax # exit 0 6 | syscall 7 | -------------------------------------------------------------------------------- /x64-shellcode-loader/hex_to_bin.py: -------------------------------------------------------------------------------- 1 | import sys 2 | 3 | def main(argv): 4 | 5 | if len(argv) != 3: 6 | print "Usage: hex_to_bin.py HEXSTRING OUTPUT_FILENAME" 7 | else: 8 | print "Opening file", argv[2] 9 | f = open(argv[2], "wb") 10 | tmp = argv[1].decode("hex") 11 | print "Writing hexstring", argv[1], "to file" 12 | f.write(tmp) 13 | f.close() 14 | print "All done." 15 | 16 | if __name__ == "__main__": 17 | main(sys.argv) 18 | -------------------------------------------------------------------------------- /machoentropy/README.md: -------------------------------------------------------------------------------- 1 | Simple python script for computing the entropy of all relevant sections of a Mach-O file. 2 | A higher entropy might suggest a packed or crypted section. 3 | 4 | python compute_entropy.py /bin/mv 5 | __TEXT has 8192 bytes with entropy of 4.813855 6 | __DATA has 4096 bytes with entropy of 0.325840 7 | __LINKEDIT has 11856 bytes with entropy of 4.444262 8 | 9 | python compute_entropy.py /Applications/Skype.app/Contents/MacOS/Skype 10 | __TEXT has 31965184 bytes with entropy of 6.563878 11 | __DATA has 3067904 bytes with entropy of 3.299411 12 | __LINKEDIT has 370384 bytes with entropy of 7.323416 13 | -------------------------------------------------------------------------------- /x64-shellcode-loader/shellcodes/helloworld.s: -------------------------------------------------------------------------------- 1 | # hello_asm.s 2 | # as hello_asm.s -o hello_asm.o 3 | # ld hello_asm.o -e _main -o hello_asm 4 | 5 | # the following program boils down to 6 | # 4831db5348b8726c64215048b848656c6c50b804000002bf01000000488d342448c7c20e00000f05 7 | # in hex 8 | 9 | .section __TEXT,__text 10 | .globl _main 11 | _main: 12 | 13 | xor %rbx, %rbx # push the zero terminating C string to the stack 14 | pushq %rbx 15 | movq $0x0a21646c72, %rax 16 | pushq %rax 17 | movq $0x6f77206f6c6c6548, %rax 18 | pushq %rax 19 | 20 | movl $0x2000004, %eax # 4 == write syscall 21 | movl $1, %edi # 1 == STDOUT file descriptor 22 | leaq (%rsp), %rsi # string to print 23 | movq $14, %rdx # size of string 24 | syscall 25 | 26 | xor %rbx, %rbx 27 | movl $0x2000001, %eax # exit 0 28 | syscall 29 | -------------------------------------------------------------------------------- /malware_toys/plot_entropy.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import pandas as pd 3 | import matplotlib.pyplot as plt 4 | import matplotlib 5 | matplotlib.style.use('ggplot') 6 | 7 | names = ["PROGRAM_NAME", "__TEXT", "__DATA", "__LINKEDIT"] 8 | 9 | def plotEntropyData(pathToEntropyCsv, filename): 10 | data = pd.read_csv(pathToEntropyCsv, names=names) 11 | data.info() 12 | print data.describe() 13 | 14 | fig, ax = plt.subplots() 15 | hist = data.hist(grid=False, layout=(1,3), ax=ax, normed= True) 16 | for array in hist: 17 | for subplot in array: 18 | subplot.set_xlim((0,8)) 19 | subplot.set_ylim((0,1)) 20 | fig.savefig(filename + ".svg") 21 | 22 | 23 | def main(args): 24 | if len(args) != 2: 25 | print "Usage: plot_entropy.py ENTROPY_DATA.CSV" 26 | else: 27 | plotEntropyData(args[1], args[1].split(".")[0]) 28 | 29 | if __name__ == "__main__": 30 | main(sys.argv) -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | *.egg-info/ 23 | .installed.cfg 24 | *.egg 25 | 26 | # PyInstaller 27 | # Usually these files are written by a python script from a template 28 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 29 | *.manifest 30 | *.spec 31 | 32 | # Installer logs 33 | pip-log.txt 34 | pip-delete-this-directory.txt 35 | 36 | # Unit test / coverage reports 37 | htmlcov/ 38 | .tox/ 39 | .coverage 40 | .coverage.* 41 | .cache 42 | nosetests.xml 43 | coverage.xml 44 | *,cover 45 | 46 | # Translations 47 | *.mo 48 | *.pot 49 | 50 | # Django stuff: 51 | *.log 52 | 53 | # Sphinx documentation 54 | docs/_build/ 55 | 56 | # PyBuilder 57 | target/ 58 | -------------------------------------------------------------------------------- /malware_toys/parse_vtreports.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import os 3 | import json 4 | import collections 5 | import operator 6 | 7 | def readInVtData(pathToVtData): 8 | res = [] 9 | for f in os.listdir(pathToVtData): 10 | if not ".json" in f: 11 | continue 12 | vtData = open(os.path.join(pathToVtData, f)).read() 13 | jsonData = json.loads(vtData, strict=False) 14 | res.append(jsonData) 15 | return res 16 | 17 | def processVtData(vtData): 18 | familyCount = collections.defaultdict(int) 19 | labeling = collections.defaultdict(str) 20 | 21 | for sample in vtData: 22 | scans = sample.get("scans", {}) 23 | family = str(scans["AVG"]["result"]).replace("a variant of ", "").replace(" potentially unsafe", "") 24 | if "." in family: 25 | family = family.split(".")[0] 26 | familyCount[family] = familyCount[family] + 1 27 | labeling[sample["sha256"]] = family 28 | 29 | sorted_x = sorted(familyCount.items(), key=operator.itemgetter(1)) 30 | sorted_x.reverse() 31 | for family in sorted_x: 32 | print family[0] + ": " + str(family[1]) 33 | 34 | resultFile = open("labeling.csv", "w") 35 | resultFile.write("sha256,LABEL\n") 36 | for md5, label in labeling.items(): 37 | resultFile.write(md5 + "," + label + "\n") 38 | resultFile.close() 39 | 40 | 41 | def main(args): 42 | if len(args) != 2: 43 | print "Usage: parse_vtreports.py PATH_TO_VT_JSON_REPORTS" 44 | else: 45 | vtData = readInVtData(args[1]) 46 | processVtData(vtData) 47 | 48 | if __name__ == "__main__": 49 | main(sys.argv) -------------------------------------------------------------------------------- /machoentropy/compute_entropy.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import os 3 | from collections import defaultdict 4 | from macholib.MachO import MachO 5 | from MachoEntropyComputer import MachoEntropyComputer 6 | 7 | def processFile(filename): 8 | res = defaultdict() 9 | 10 | try: 11 | machoEntropyComputer = MachoEntropyComputer(filename, MachO(filename)) 12 | except: 13 | print "ERROR while parsing", filename 14 | return None 15 | for s in machoEntropyComputer.compute(): 16 | print "%s has %i bytes with entropy of %f" % (s.sectionName, s.sectionSize, s.sectionEntropy) 17 | res[s.sectionName] = s.sectionEntropy 18 | return res 19 | 20 | def storeCsv(f, programName, data): 21 | f.write(programName + "," + str(data["__TEXT"]) + "," + str(data["__DATA"]) + "," + str(data["__LINKEDIT"]) + "\n") 22 | 23 | def process(arg, csv=None): 24 | if os.path.isdir(arg): 25 | csvFile = None 26 | if csv: 27 | csvFile = open(csv, "w") 28 | 29 | fileList = os.listdir(arg) 30 | for f in fileList: 31 | print "Current program:", f 32 | res = processFile(os.path.join(arg, f)) 33 | print "-" * 80 34 | 35 | if csvFile and res: 36 | storeCsv(csvFile, f, res) 37 | 38 | csvFile.close() 39 | else: 40 | processFile(arg) 41 | 42 | def main(arguments): 43 | if len(arguments) != 2 and len(arguments) != 4: 44 | print "Usage:", arguments[0], "-csv CSVFILENAME MACHO_FILE/FOLDER_OF_MACHOs" 45 | print "-csv is optional. Stores results in csv file." 46 | elif len(arguments) == 2: 47 | process(arguments[1]) 48 | else: 49 | process(arguments[3], csv=arguments[2]) 50 | 51 | 52 | if __name__ == "__main__": 53 | main(sys.argv) 54 | -------------------------------------------------------------------------------- /machoentropy/MachoEntropyComputer.py: -------------------------------------------------------------------------------- 1 | import math 2 | import collections 3 | 4 | MachoEntropyInfo = collections.namedtuple('MachoEntropyInfo', 'sectionName sectionSize sectionEntropy') 5 | 6 | class MachoEntropyComputer(object): 7 | 8 | def __init__(self, filename, macho): 9 | self.macho = macho 10 | self.filename = filename 11 | 12 | def _computeEntropyForSection(self, sectionData): 13 | # taken from http://rosettacode.org/wiki/Entropy#python 14 | log2=lambda x:math.log(x)/math.log(2) 15 | exr={} 16 | infoc=0 17 | for each in sectionData: 18 | try: 19 | exr[each]+=1 20 | except: 21 | exr[each]=1 22 | dataLen=len(sectionData) 23 | for k,v in exr.items(): 24 | freq = 1.0*v/dataLen 25 | infoc+=freq*log2(freq) 26 | infoc*=-1 27 | return infoc 28 | 29 | def _getSectionData(self, fileoff, filesize): 30 | f = open(self.filename, 'rb') 31 | f.seek(fileoff) 32 | data = f.read(filesize) 33 | f.close() 34 | return data 35 | 36 | def compute(self): 37 | res = [] 38 | 39 | for (load_cmd, cmd, data) in self.macho.headers[0].commands: 40 | if hasattr(cmd, "segname"): 41 | 42 | segmentName = getattr(cmd, 'segname', '').rstrip('\0') 43 | sectionOffset = cmd.fileoff 44 | sectionSize = cmd.filesize 45 | if cmd.filesize > 0: 46 | code = self._getSectionData(sectionOffset, sectionSize) 47 | sectionEntropy = self._computeEntropyForSection(code) 48 | res.append(MachoEntropyInfo(segmentName, sectionSize, sectionEntropy)) 49 | 50 | return res 51 | 52 | 53 | 54 | 55 | -------------------------------------------------------------------------------- /x64-shellcode-loader/main.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | 8 | const char* MOV_RAX = "\x48\xb8"; 9 | const char* CALL_RAX = "\xff\xD0"; 10 | // make this variable global, i.e. they should be passed around 11 | // especially not when the stack is involved, only God knows what happens 12 | // to the stack during shell code execution 13 | void *shellcode_buffer; 14 | 15 | void printLine(){ 16 | printf("---------------------------------------------------------------------\n"); 17 | } 18 | 19 | long getFileSize(FILE* file){ 20 | fseek(file, 0, SEEK_END); 21 | long file_size = ftell(file); 22 | rewind(file); 23 | return file_size; 24 | } 25 | 26 | void printShellcode(long file_size){ 27 | printf("Hexdump of shellcode:\n"); 28 | printLine(); 29 | for(int i=0;i < file_size;i++) 30 | printf("%x", *(int*)(shellcode_buffer+i)); 31 | printf("\n"); 32 | printLine(); 33 | } 34 | 35 | long readFileToBuffer(FILE *file) { 36 | long file_size = getFileSize(file); 37 | size_t page_size = getpagesize(); 38 | 39 | if (file_size > page_size){ 40 | printf("File is too big: %ld exceeds limit of %ld\n", file_size, page_size); 41 | exit(-1); 42 | } 43 | 44 | printf("Trying to read %ld bytes.\n", file_size); 45 | fread(shellcode_buffer, file_size, 1, file); 46 | fclose(file); 47 | 48 | printShellcode(file_size); 49 | 50 | return file_size; 51 | } 52 | 53 | void exitGracefully(){ 54 | printLine(); 55 | printf("Executed shellcode successfully\n"); 56 | munmap(shellcode_buffer, getpagesize()); 57 | printf("Freed shellcode buffer. Exiting.\n"); 58 | exit(0); 59 | } 60 | 61 | void writeTrampoline(long file_size){ 62 | void (*p)(void) = exitGracefully; 63 | printf("Writing trampoline to clean up function @%p after shellcode\n", p); 64 | memcpy((shellcode_buffer+file_size), MOV_RAX, 2); 65 | memcpy((shellcode_buffer+file_size+2), &p, sizeof(void*)); 66 | memcpy((shellcode_buffer+file_size+2+sizeof(void*)), CALL_RAX, 2); 67 | } 68 | 69 | int main(int argc, const char * argv[]) { 70 | if (argc != 2){ 71 | printf("Usage: shellcode_loader FILENAME\n"); 72 | return 0; 73 | } 74 | else 75 | { 76 | char *filename = (char *)argv[1]; 77 | size_t page_size = getpagesize(); 78 | shellcode_buffer = mmap(NULL, page_size, 79 | PROT_READ | PROT_WRITE, 80 | MAP_ANON | MAP_PRIVATE, 81 | -1, 0); 82 | 83 | 84 | printf("Opening %s\n", filename); 85 | FILE *file = fopen(filename, "r"); 86 | if (file != NULL) { 87 | long file_size = readFileToBuffer(file); 88 | writeTrampoline(file_size); 89 | 90 | } 91 | else 92 | { 93 | printf("Could not open %s. Exiting...\n", filename); 94 | return -1; 95 | } 96 | 97 | printf("Changing protection to RX.\n"); 98 | if (mprotect(shellcode_buffer, page_size, PROT_READ | PROT_EXEC) != 0){ 99 | printf("Could not change to RX...\n"); 100 | return -1; 101 | } 102 | 103 | printf("Loaded shell code to 0x%x. Calling in...\n", (unsigned int)shellcode_buffer); 104 | printLine(); 105 | ((void (*)())shellcode_buffer)(); 106 | 107 | // should never reach this point, either shellcode terminates program or the control flow 108 | //is directed to the cleaning function via the trampoline 109 | } 110 | } -------------------------------------------------------------------------------- /malware_toys/classify_macho.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | from macholib.MachO import MachO 4 | 5 | from scipy import interp 6 | import numpy 7 | import matplotlib.pyplot as plt 8 | import pandas as pd 9 | from pandas.tools.plotting import scatter_matrix 10 | 11 | from sklearn.preprocessing import StandardScaler 12 | from sklearn.neighbors import KNeighborsClassifier 13 | from sklearn.svm import SVC 14 | from sklearn.tree import DecisionTreeClassifier 15 | from sklearn.ensemble import AdaBoostClassifier 16 | from sklearn.naive_bayes import GaussianNB 17 | from sklearn.cross_validation import StratifiedKFold 18 | from sklearn.metrics import roc_curve, auc 19 | import matplotlib 20 | matplotlib.style.use('ggplot') 21 | 22 | 23 | names = ["Nearest Neighbors", "Linear SVM", "Decision Tree", "AdaBoost", "Naive Bayes"] 24 | classifiers = [ 25 | KNeighborsClassifier(3), 26 | SVC(kernel="linear", C=0.025, probability=True), 27 | DecisionTreeClassifier(max_depth=5), 28 | AdaBoostClassifier(), 29 | GaussianNB()] 30 | colors = ["b", "g", "r", "c", "m"] 31 | 32 | def getSectionCount(macho): 33 | sectionCount = 0 34 | for load_cmd, cmd, data in macho.headers[0].commands: 35 | if hasattr(cmd, "segname"): 36 | sectionCount += len(data) 37 | f_sections = sectionCount 38 | return f_sections 39 | 40 | 41 | def getSizeInKiloByte(fullpath): 42 | size = os.path.getsize(fullpath) 43 | f_size = size / 1024.0 44 | return f_size 45 | 46 | def getData(pathToSamples, c): 47 | df = pd.DataFrame(columns=('f_size', 'f_sections', 'f_flags', 'c')) 48 | currentRow = 0 49 | 50 | for f in os.listdir(pathToSamples): 51 | if not ".json" in f: 52 | fullpath = os.path.join(pathToSamples, f) 53 | f_size = getSizeInKiloByte(fullpath) 54 | 55 | try: 56 | macho = MachO(fullpath) 57 | f_sections = getSectionCount(macho) 58 | f_flags = macho.headers[0].header.flags 59 | except: 60 | continue 61 | 62 | df.loc[currentRow] = [f_size, f_sections, f_flags, c] 63 | currentRow += 1 64 | 65 | return df 66 | 67 | def prepareDatasetsForLearning(dataSet): 68 | X = [] 69 | y = [] 70 | 71 | for index, row in dataSet.iterrows(): 72 | X.append([row.f_size, row.f_sections, row.f_flags]) 73 | y.append(row.c) 74 | 75 | return X,y 76 | 77 | def classify(X, y): 78 | # TODO: split learning and plotting 79 | X = numpy.array(X) 80 | y = numpy.array(y) 81 | 82 | X = StandardScaler().fit_transform(X) 83 | skf = StratifiedKFold(y, n_folds=10) 84 | 85 | for classifier in range(0,len(classifiers)): 86 | print "Training classifier %s..." % (names[classifier]) 87 | 88 | mean_tpr = 0.0 89 | mean_fpr = numpy.linspace(0, 1, 100) 90 | 91 | for train_index, test_index in skf: 92 | X_train, X_test = X[train_index], X[test_index] 93 | y_train, y_test = y[train_index], y[test_index] 94 | clf = classifiers[classifier] 95 | probas_ = clf.fit(X_train, y_train).predict_proba(X_test) 96 | fpr, tpr, thresholds = roc_curve(y_test, probas_[:, 1]) 97 | mean_tpr += interp(mean_fpr, fpr, tpr) 98 | mean_tpr[0] = 0.0 99 | mean_tpr /= len(skf) 100 | mean_tpr[-1] = 1.0 101 | mean_auc = auc(mean_fpr, mean_tpr) 102 | plt.plot(mean_fpr, mean_tpr, 'k--', 103 | label= names[classifier] + ' (AUC = %0.3f)' % mean_auc, lw=2, c=colors[classifier]) 104 | 105 | plt.plot([0, 1], [0, 1], '--', color=(0.6, 0.6, 0.6), label='Luck') 106 | 107 | plt.xlim([-0.05, 1.05]) 108 | plt.ylim([-0.05, 1.05]) 109 | plt.xlabel('False Positive Rate') 110 | plt.ylabel('True Positive Rate') 111 | plt.legend(loc="lower right", fancybox=True, shadow=True, fontsize=10) 112 | plt.tight_layout() 113 | plt.savefig("osx_malware_goodware_roc.svg") 114 | 115 | def plotDataset(dataSet): 116 | colors=['green','red'] 117 | fig, ax = plt.subplots() 118 | scatter_matrix(dataSet.ix[:,:'f_flags'], alpha=0.8, figsize=(6, 6), ax=ax, marker='x', diagonal="kde", c=dataSet.c.apply(lambda x:colors[int(x)])) 119 | plt.tight_layout() 120 | fig.savefig("scatter.svg") 121 | 122 | def main(args): 123 | if len(args) != 3: 124 | print "Usage: cluster_macho.py PATH_TO_MALWARE PATH_TO_GOODWARE" 125 | else: 126 | malicious = getData(args[1], 1) 127 | print "Read in %i malicious samples." % len(malicious) 128 | print malicious.info() 129 | print malicious.describe() 130 | 131 | benign = getData(args[2], 0) 132 | print "Read in %i benign samples." % len(benign) 133 | print benign.info() 134 | print benign.describe() 135 | 136 | dataSet = pd.concat([malicious, benign]) 137 | X,y = prepareDatasetsForLearning(dataSet) 138 | 139 | classify(X, y) 140 | 141 | plotDataset(dataSet) 142 | 143 | if __name__ == "__main__": 144 | main(sys.argv) -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | 341 | --------------------------------------------------------------------------------