├── .gitignore
├── src
    ├── ta_types.hpp
    ├── main.cpp
    ├── Tainter.hpp
    ├── InstrumentHelper.hpp
    ├── Instrumenter.hpp
    ├── Registers.hpp
    ├── Tainter.cpp
    ├── InstrumentHelper.cpp
    ├── Registers.cpp
    └── Instrumenter.cpp
├── compile.sh
├── README.md
├── ida-plugin
    └── ta_plugin.py
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
 1 | # Compiled Object files
 2 | *.slo
 3 | *.lo
 4 | *.o
 5 | *.obj
 6 | 
 7 | # Precompiled Headers
 8 | *.gch
 9 | *.pch
10 | 
11 | # Compiled Dynamic libraries
12 | *.so
13 | *.dylib
14 | *.dll
15 | 
16 | # Fortran module files
17 | *.mod
18 | 
19 | # Compiled Static libraries
20 | *.lai
21 | *.la
22 | *.a
23 | *.lib
24 | 
25 | # Executables
26 | *.exe
27 | *.out
28 | *.app
29 | 
30 | .DS_Store
31 | 


--------------------------------------------------------------------------------
/src/ta_types.hpp:
--------------------------------------------------------------------------------
 1 | //
 2 | //  ta_types.h
 3 | //  
 4 | //
 5 | //  Created by Onur on 09/12/15.
 6 | //
 7 | //
 8 | 
 9 | #ifndef ta_types_h
10 | #define ta_types_h
11 | 
12 | #define TA_UINT    unsigned long int
13 | #define TA_UCHAR   unsigned char
14 | #define TA_BYTE    1
15 | #define TA_WORD    2
16 | #define TA_DWORD   4
17 | #define TA_QWORD   8
18 | #define TA_OWORD   16
19 | #define TA_YWORD   32
20 | #define TA_BYTE_SIZE   8
21 | #define OSX_KERNEL_ADDR_SPACE   0x7FFFFFFFFFFF
22 | #define OSX_SHARED_ADDR_SPACE   0x7FFF00000000
23 | 
24 | #endif /* ta_types_h */
25 | 


--------------------------------------------------------------------------------
/src/main.cpp:
--------------------------------------------------------------------------------
 1 | //
 2 | //  main.c
 3 | //  TaintAll
 4 | //
 5 | //  Created by Onur on 09/12/15.
 6 | //  Copyright © 2015 taintall. All rights reserved.
 7 | //
 8 | 
 9 | #include "Tainter.hpp"
10 | #include "Instrumenter.hpp"
11 | #include <iostream>
12 | 
13 | 
14 | using namespace std;
15 | 
16 | 
17 | 
18 | int main(int argc, char * argv[]) {
19 |     Tainter tainter;
20 |     Instrumenter instrumenter;
21 | 
22 |     //cmd arguments
23 |     instrumenter.init(argc, argv);
24 |     
25 |     instrumenter.runProgram();
26 |     instrumenter.clean();
27 |     
28 |     return 0;
29 | }
30 | 


--------------------------------------------------------------------------------
/compile.sh:
--------------------------------------------------------------------------------
1 | c++ -DBIGARRAY_MULTIPLIER=1 -Wall -Werror -Wno-unknown-pragmas -fno-stack-protector -DTARGET_IA32E -DHOST_IA32E -fPIC -DTARGET_MAC -stdlib=libstdc++ -fomit-frame-pointer -fno-strict-aliasing -I../../include/pin/ -I../../include/pin/gen/ -I../../../extras/components/include -I../../../extras/xed-intel64/include -I../InstLib -c src/*.cpp
2 | 
3 | mkdir obj-intel64
4 | mv *.o obj-intel64/
5 | 
6 | c++ -shared -w -Wl,-exported_symbols_list -Wl,../../include/pin/pintool.exp -stdlib=libstdc++ -o obj-intel64/main.dylib obj-intel64/*.o -L../../../intel64/lib -L../../../intel64/lib-ext -L../../../intel64/runtime/glibc -L../../../extras/xed-intel64/lib -lpin -lxed -lpindwarf
7 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # TaintAll
 2 | TaintAll, a taint analysis and concolic execution tool.
 3 | 
 4 | # Installation
 5 | - Install boost >= 1.5
 6 | - Install pin = 2.14
 7 | - cd your_pin_path/source/tools
 8 | - git clone https://github.com/onura/TaintAll.git
 9 | - cd TaintAll
10 | - ./compile.sh
11 | - open ida-plugin/ta_plugin.py and set CONF_PIN_PATH variable to point your pin directory 
12 | - cp ta_plugin.py into IDA Pro plugin directory.
13 | 
14 | 
15 | # Usage
16 | - init plugin
17 | ```python
18 | t = ta_plugin()
19 | t.run(1)
20 | ```
21 | - start tainting at the address
22 | ```python
23 | t.a.startTaintAt(0x100000EB0)
24 | ```
25 | - stop tainting at the address
26 | ```python
27 | t.a.stopTaintAt(0x100000F41)
28 | ```
29 | - taint 5 bytes from the address that RSI register is pointing to
30 | ```python
31 | t.a.taintPointer(0x100000F17, Registers.RSI, 5)
32 | ```
33 | - taint EAX registers
34 | ```python
35 | t.a.taintRegister(0x100000BBC, Registers.RAX, RegParts.DWORD)
36 | ```
37 | - taint 4 bytes from the memory 0x100000992
38 | ```python
39 | t.a.taintAddress(0x100000BBC, 0x100000992, 4)
40 | ```
41 | - start analysis
42 | ```python
43 | t.a.startDynamicAnalysis()
44 | ```
45 | - show/hide taints
46 | ```python
47 | t.a.hideTaints()
48 | t.a.showTaints()
49 | ```
50 | - print tainted registers/memories at the address which the cursor is pointing
51 | ```python
52 | t.a.printRegsEA()
53 | t.a.printMemsEA()
54 | ```
55 | - print all affected addresses
56 | ```python
57 | t.a.printAffectedAddrs()
58 | ```
59 | 


--------------------------------------------------------------------------------
/src/Tainter.hpp:
--------------------------------------------------------------------------------
 1 | //
 2 | //  tainter.h
 3 | //  
 4 | //
 5 | //  Created by Onur on 09/12/15.
 6 | //
 7 | //
 8 | 
 9 | #ifndef tainter_h
10 | #define tainter_h
11 | 
12 | #include "Registers.hpp"
13 | #include "ta_types.hpp"
14 | #include <list>
15 | #include <iostream>
16 | 
17 | 
18 | class Tainter {
19 | private:
20 |     //attributes
21 |     std::list<TA_UINT> taintedAddrs;
22 |     bool taintedRegs[R_END][TA_YWORD];
23 |     void taintRegInner(RegId reg, RegPart rp, bool val);
24 |     
25 | public:
26 |     //constructors
27 |     Tainter();
28 |     
29 |     //methods
30 |     void taint(TA_UINT addr);
31 |     void taint(RegId reg, RegPart rp);
32 |     void taint(TA_UINT addr, TA_UINT msize);
33 |     void untaint(TA_UINT addr);
34 |     void untaint(RegId reg, RegPart rp);
35 |     void untaint(TA_UINT addr, TA_UINT msize);
36 |     bool isTainted(TA_UINT addr);
37 |     bool isTainted(RegId reg, RegPart rp);
38 |     void cleanAll();
39 |     void spreadTaintMI(TA_UINT addr, TA_UINT wsize);
40 |     void spreadTaintMR(TA_UINT addr, RegId reg, RegPart rp);
41 |     void spreadTaintRI(RegId reg, RegPart rp);
42 |     void spreadTaintRM(RegId reg, RegPart rp, TA_UINT addr);
43 |     void spreadTaintRR(RegId dstReg, RegPart dstRp, RegId srcReg, RegPart srcRp);
44 |     void spreadTaintMM(TA_UINT dstAddr, TA_UINT srcAddr, TA_UINT dataSize);
45 |     void getTaintedRegs(bool regList[R_END][R_TA_OWORD]);
46 |     std::list<TA_UINT> getTaintedMem(TA_UINT begin, TA_UINT end);
47 |     std::list<TA_UINT> getTaintedMem();
48 | };
49 | 
50 | 
51 | #endif /* tainter_h */
52 | 


--------------------------------------------------------------------------------
/src/InstrumentHelper.hpp:
--------------------------------------------------------------------------------
 1 | //
 2 | //  InstrumentHelper.hpp
 3 | //  TaintAll
 4 | //
 5 | //  Created by Onur on 06/01/16.
 6 | //  Copyright © 2016 taintall. All rights reserved.
 7 | //
 8 | 
 9 | #ifndef InstrumentHelper_hpp
10 | #define InstrumentHelper_hpp
11 | 
12 | #include "Tainter.hpp"
13 | #include "pin.H"
14 | #include "Registers.hpp"
15 | #include <iostream>
16 | #include <iomanip>
17 | #include <sstream>
18 | #include <fstream>
19 | 
20 | 
21 | class InsData {
22 | public:
23 |     TA_UINT addr;
24 |     TA_UINT pieIter;
25 |     TA_UINT opcode;
26 |     UINT32 size;
27 |     std::string mnemonic;
28 |     std::ofstream* rFile;
29 | };
30 | 
31 | typedef void TInst;
32 | 
33 | class InstrumentHelper {    
34 | public:    
35 |     /* methods */
36 |     static void taintMemToReg(const CONTEXT *ctxt, InsData *insData, Tainter *tainter, TA_UINT memEA, REG reg);
37 |     static void taintImmToMem(const CONTEXT *ctxt, InsData *insData, Tainter *tainter, TA_UINT memEA, short immSize);
38 |     static void taintRegToMem(const CONTEXT *ctxt, InsData *insData, Tainter *tainter, TA_UINT memEA, REG reg);
39 |     static void taintImmToReg(const CONTEXT *ctxt, InsData *insData, Tainter *tainter, REG reg);
40 |     static void taintRegToReg(const CONTEXT *ctxt, InsData *insData, Tainter *tainter, REG dstReg, REG srcReg);
41 |     
42 |     static void printInfo(InsData *insData, Tainter *tainter);
43 |     static void printFormatted(InsData *insData, Tainter *tainter);
44 |     
45 |     static void analyseLea(const CONTEXT *ctxt, InsData *insData, Tainter * tainter, REG baseReg, REG indexReg, long int displacement, UINT32 scale, TInst* tinst, bool* isAnyTainted);
46 |     static void analyseMem(const CONTEXT *ctxt, InsData *insData, Tainter * tainter, TA_UINT memEA, short immSize, TInst* tinst, bool* isAnyTainted);
47 |     static void analyseReg(const CONTEXT *ctxt, InsData *insData, Tainter * tainter, REG reg, TInst* tinst, bool* isAnyTainted);
48 |     static void processTInst(const CONTEXT *ctxt, InsData *insData, Tainter *tainter, TInst* tinst, bool* isAnyTainted);
49 |     
50 |     static string getOpcodeBytes(TA_UINT addr, short size);
51 |     static string getOpcodeStr(TA_UINT addr, short size);
52 |     static void clearRegs(const CONTEXT *ctxt, Tainter *tainter);
53 |     
54 | 
55 | 
56 | };
57 | 
58 | #endif /* InstrumentHelper_hpp */
59 | 
60 | 
61 | 


--------------------------------------------------------------------------------
/src/Instrumenter.hpp:
--------------------------------------------------------------------------------
  1 | //
  2 | //  Instrumenter.hpp
  3 | //  TaintAll
  4 | //
  5 | //  Created by Onur on 15/12/15.
  6 | //  Copyright © 2015 taintall. All rights reserved.
  7 | //
  8 | 
  9 | #ifndef Instrumenter_hpp
 10 | #define Instrumenter_hpp
 11 | 
 12 | #include "Registers.hpp"
 13 | #include "Tainter.hpp"
 14 | #include "InstrumentHelper.hpp"
 15 | #include "pin.H"
 16 | #include <list>
 17 | 
 18 | 
 19 | class TAddr {
 20 | public:
 21 |     TA_UINT instAddr;
 22 |     TA_UINT memAddr;
 23 |     TA_UINT msize;
 24 | };
 25 | 
 26 | class TReg {
 27 | public:
 28 |     TA_UINT instAddr;
 29 |     RegId reg;
 30 |     RegPart rp;
 31 | };
 32 | 
 33 | class TPtr {
 34 | public:
 35 |     TA_UINT instAddr;
 36 |     RegId reg;
 37 |     TA_UINT msize;
 38 | };
 39 | 
 40 | class IMGInfo {
 41 | public:
 42 |     TA_UINT imageBase;
 43 |     TA_UINT staticImageBase;
 44 |     TA_UINT pieIter;
 45 | };
 46 | 
 47 | class readSysCall {
 48 | public:
 49 |     TA_UINT memAddr;
 50 |     TA_UINT size;
 51 | };
 52 | 
 53 | class UserCommands {
 54 | public:
 55 |     TA_UINT startTaint;
 56 |     TA_UINT stopTaint;
 57 | };
 58 | 
 59 | 
 60 | 
 61 | class Instrumenter {
 62 | public:
 63 |     /* instrumentation functions */
 64 |     static void insInstFunc(INS ins, void *v);
 65 |     static void imgInstFunc(IMG img, void *v);
 66 |     static void sysCallInstFunc(THREADID thread_id, CONTEXT *ctxt, SYSCALL_STANDARD std, void *v);
 67 |     static void sysCallExitInstFunc(THREADID thread_id, CONTEXT *ctxt, SYSCALL_STANDARD std, void *v);
 68 |     static void programFinFunc(int code, void *v);
 69 |     static bool init(int argc, char** argv);
 70 |     static void clean();
 71 |     
 72 |     static void runProgram();
 73 |     static std::string getRelativeAddr(TA_UINT virtualAddr, TA_UINT baseAddr);
 74 |     static void setStaticImageBase(TA_UINT);
 75 |     static void startAt(TA_UINT addr);
 76 |     static void stopAt(TA_UINT addr);
 77 |   
 78 |     /* taint - untaint functions */
 79 |     static void taintAtAddr(TA_UINT instAddr, TA_UINT memAddr, TA_UINT msize);
 80 |     static void taintAtAddr(TA_UINT instAddr, RegId reg, RegPart rp);
 81 |     static void unTaintAtAddr(TA_UINT instAddr, TA_UINT memAddr, TA_UINT msize);
 82 |     static void unTaintAtAddr(TA_UINT instAddr, RegId reg, RegPart rp);
 83 |     static void taintAtAddr(TA_UINT instAddr, RegId reg, TA_UINT msize);
 84 |     static void unTaintAtAddr(TA_UINT instAddr, RegId reg, TA_UINT msize);
 85 |     
 86 | private:
 87 |     //Attributes
 88 |     static Tainter tainter;
 89 |     static std::list<TAddr> addrsToBeTainted;
 90 |     static std::list<TReg> regsToBeTainted;
 91 |     static std::list<TAddr> addrsToBeUntainted;
 92 |     static std::list<TReg> regsToBeUntainted;
 93 |     static std::list<TPtr> pointersToBeTainted;
 94 |     static std::list<TPtr> pointersToBeUntainted;
 95 | 
 96 |     static std::ofstream resultFile;
 97 | 
 98 |     
 99 |     static IMGInfo imgInfo;
100 |     static readSysCall lastReadSysCall;
101 |     static bool isEngineRunning;
102 |     static UserCommands usrCmd;
103 |     static bool isSERunning;
104 |     static bool isRegsCleared;
105 |     
106 |     //methods
107 |     static void checkToBeInst(const CONTEXT* ctxt, TA_UINT instAddr);
108 |     static void parseCmdLine();
109 | 
110 | };
111 | 
112 | 
113 | #endif /* Instrumenter_hpp */
114 | 


--------------------------------------------------------------------------------
/src/Registers.hpp:
--------------------------------------------------------------------------------
  1 | //
  2 | //  registers.hpp
  3 | //  
  4 | //
  5 | //  Created by Onur on 07/12/15.
  6 | //
  7 | //
  8 | 
  9 | #include "ta_types.hpp"
 10 | #include <map>
 11 | #include <string>
 12 | #include "pin.H"
 13 | #include <fstream>
 14 | 
 15 | 
 16 | #ifndef registers_h
 17 | #define registers_h
 18 | 
 19 | #define GET_REGSIZE(reg) regSizes[reg]
 20 | 
 21 | //enum for x86_64 registers
 22 | enum RegId {
 23 |     R_RAX,
 24 |     R_RBX,
 25 |     R_RCX,
 26 |     R_RDX,
 27 |     R_RDI,
 28 |     R_RSI,
 29 |     R_RBP,
 30 |     R_RSP,
 31 |     R_RIP,
 32 |     R_R8,
 33 |     R_R9,
 34 |     R_R10,
 35 |     R_R11,
 36 |     R_R12,
 37 |     R_R13,
 38 |     R_R14,
 39 |     R_R15,
 40 |     R_XMM0,
 41 |     R_XMM1,
 42 |     R_XMM2,
 43 |     R_XMM3,
 44 |     R_XMM4,
 45 |     R_XMM5,
 46 |     R_XMM6,
 47 |     R_XMM7,
 48 |     R_XMM8,
 49 |     R_XMM9,
 50 |     R_XMM10,
 51 |     R_XMM11,
 52 |     R_XMM12,
 53 |     R_XMM13,
 54 |     R_XMM14,
 55 |     R_XMM15,
 56 |     R_RFLAGS,
 57 |     R_YMM0,
 58 |     R_YMM1,
 59 |     R_YMM2,
 60 |     R_YMM3,
 61 |     R_YMM4,
 62 |     R_YMM5,
 63 |     R_YMM6,
 64 |     R_YMM7,
 65 |     R_YMM8,
 66 |     R_YMM9,
 67 |     R_YMM10,
 68 |     R_YMM11,
 69 |     R_YMM12,
 70 |     R_YMM13,
 71 |     R_YMM14,
 72 |     R_YMM15,
 73 |     R_END
 74 | };
 75 | 
 76 | 
 77 | //registers sizes in bytes
 78 | const short regSizes[] = {
 79 |     TA_QWORD,
 80 |     TA_QWORD,
 81 |     TA_QWORD,
 82 |     TA_QWORD,
 83 |     TA_QWORD,
 84 |     TA_QWORD,
 85 |     TA_QWORD,
 86 |     TA_QWORD,
 87 |     TA_QWORD,
 88 |     TA_QWORD,
 89 |     TA_QWORD,
 90 |     TA_QWORD,
 91 |     TA_QWORD,
 92 |     TA_QWORD,
 93 |     TA_QWORD,
 94 |     TA_QWORD,
 95 |     TA_QWORD,
 96 |     TA_OWORD,
 97 |     TA_OWORD,
 98 |     TA_OWORD,
 99 |     TA_OWORD,
100 |     TA_OWORD,
101 |     TA_OWORD,
102 |     TA_OWORD,
103 |     TA_OWORD,
104 |     TA_OWORD,
105 |     TA_OWORD,
106 |     TA_OWORD,
107 |     TA_OWORD,
108 |     TA_OWORD,
109 |     TA_OWORD,
110 |     TA_OWORD,
111 |     TA_OWORD,
112 |     TA_QWORD,
113 |     TA_YWORD,
114 |     TA_YWORD,
115 |     TA_YWORD,
116 |     TA_YWORD,
117 |     TA_YWORD,
118 |     TA_YWORD,
119 |     TA_YWORD,
120 |     TA_YWORD,
121 |     TA_YWORD,
122 |     TA_YWORD,
123 |     TA_YWORD,
124 |     TA_YWORD,
125 |     TA_YWORD,
126 |     TA_YWORD,
127 |     TA_YWORD,
128 |     TA_YWORD,
129 |     0
130 | };
131 | 
132 | //cpu flags
133 | enum RegFlags {
134 |     R_AF,
135 |     R_CF,
136 |     R_DF,
137 |     R_IF,
138 |     R_OF,
139 |     R_PF,
140 |     R_SF,
141 |     R_TF,
142 |     R_ZF
143 | };
144 | 
145 | //x86_64 Reg Parts
146 | enum RegPart {
147 |     R_LOW = 0,
148 |     R_HIGH = 1,
149 |     R_TA_WORD = 2,
150 |     R_TA_DWORD = 4,
151 |     R_TA_QWORD = 8,
152 |     R_TA_OWORD = 16,
153 |     R_TA_YWORD = 32,
154 |     RP_SIZE = 8,
155 |     RP_NONE = 17
156 | };
157 | 
158 | class Registers {
159 | public:
160 |     static std::string getRegName(RegId reg, RegPart regPart);
161 |     static void printTaintedRegs(bool regList[R_END][R_TA_OWORD]);
162 |     static void printTaintedRegs(bool regList[R_END][R_TA_OWORD], std::ofstream* rfile);
163 |     static RegPart getRegPartBySize(short val);
164 |     static RegPart getRegPartByOrdinal(short ordinal);
165 |     static short getRegPartOrder(RegPart rp);
166 |     static RegId parsePINReg(REG pinReg, RegPart * regPart);
167 |     static REG convertPINReg(RegId reg);
168 | };
169 | 
170 | #endif /* registers_h */
171 | 


--------------------------------------------------------------------------------
/src/Tainter.cpp:
--------------------------------------------------------------------------------
  1 | //
  2 | //  tainter.cpp
  3 | //  
  4 | //
  5 | //  Created by Onur on 09/12/15.
  6 | //
  7 | //
  8 | 
  9 | #include "Tainter.hpp"
 10 | 
 11 | 
 12 | 
 13 | Tainter::Tainter() {
 14 |     cleanAll();
 15 | }
 16 | 
 17 | void Tainter::cleanAll() {
 18 |     taintedAddrs.empty();
 19 |     
 20 |     for (short i = 0; i < R_END; i++)
 21 |         for (short j = 0; j < R_TA_OWORD; j++)
 22 |             taintedRegs[i][j] = false;
 23 | }
 24 | 
 25 | void Tainter::taint(TA_UINT addr) {
 26 |     if (!isTainted(addr))
 27 |         taintedAddrs.push_back(addr);
 28 | }
 29 | 
 30 | void Tainter::taint(TA_UINT addr, TA_UINT msize) {
 31 |     for (TA_UINT i = addr; i < addr + msize; i++)
 32 |         taint(i);
 33 | }
 34 | 
 35 | void Tainter::untaint(TA_UINT addr) {
 36 |     if (isTainted(addr))
 37 |         taintedAddrs.remove(addr);
 38 | }
 39 | 
 40 | void Tainter::untaint(TA_UINT addr, TA_UINT msize) {
 41 |     for (TA_UINT i = addr; i < addr + msize; i++)
 42 |         untaint(i);
 43 | }
 44 | 
 45 | bool Tainter::isTainted(TA_UINT addr) {
 46 |     std::list<TA_UINT>::iterator found = find(taintedAddrs.begin(), taintedAddrs.end(), addr);
 47 |     
 48 |     return (found != taintedAddrs.end());
 49 | }
 50 | 
 51 | //Taint a register by name
 52 | void Tainter::taint(RegId reg, RegPart rp) {
 53 |     taintRegInner(reg, rp, true);
 54 | }
 55 | 
 56 | //Untaint a register by name
 57 | void Tainter::untaint(RegId reg, RegPart rp) {
 58 |     taintRegInner(reg, rp, false);
 59 | }
 60 | 
 61 | void Tainter::taintRegInner(RegId reg, RegPart rp, bool val) {
 62 |     if (rp == R_LOW || rp == R_HIGH)
 63 |         taintedRegs[reg][rp] = val;
 64 |     else
 65 |         for (short i = 0; i < rp; i++)
 66 |             taintedRegs[reg][i] = val;
 67 | }
 68 | 
 69 | 
 70 | bool Tainter::isTainted(RegId reg, RegPart rp) {
 71 |     if (rp == R_LOW || rp == R_HIGH)
 72 |         return taintedRegs[reg][rp];
 73 |     else {
 74 |         for (short i = 0; i < rp; i++)
 75 |             if (taintedRegs[reg][i])
 76 |                 return true;
 77 |         return false;
 78 |     }
 79 | }
 80 | 
 81 | 
 82 | //Immediate to Memory spreading
 83 | void Tainter::spreadTaintMI(TA_UINT addr, TA_UINT wsize) {
 84 |     for (TA_UINT i = addr; i < addr + wsize; i++)
 85 |         untaint(i);
 86 | }
 87 | 
 88 | //Register to Memory spreading
 89 | void Tainter::spreadTaintMR(TA_UINT addr, RegId reg, RegPart rp) {
 90 |     if (rp == R_LOW || rp == R_HIGH) {
 91 |         if (taintedRegs[reg][rp])
 92 |             taint(addr);
 93 |         else
 94 |             untaint(addr);
 95 |     } else {
 96 |         for (short i = 0; i < rp; i++)
 97 |             if (taintedRegs[reg][i])
 98 |                 taint(addr + i);
 99 |             else
100 |                 untaint(addr + i);
101 |     }
102 | }
103 | 
104 | //Immediate to Register spreading
105 | void Tainter::spreadTaintRI(RegId reg, RegPart rp) {
106 |     untaint(reg, rp);
107 | }
108 | 
109 | //Memory to Register Spreading
110 | void Tainter::spreadTaintRM(RegId reg, RegPart rp, TA_UINT addr) {
111 |     if (rp == R_LOW || rp == R_HIGH)
112 |         taintedRegs[reg][rp] = isTainted(addr);
113 |     else
114 |         for (short i = 0; i < rp; i++)
115 |             taintedRegs[reg][i] = isTainted(addr + i);
116 | }
117 | 
118 | //Register to Register Spreading
119 | void Tainter::spreadTaintRR(RegId dstReg, RegPart dstRp, RegId srcReg, RegPart srcRp) {
120 |     if ((dstRp == R_LOW || dstRp == R_HIGH) && (srcRp == R_LOW || srcRp == R_HIGH))
121 |         taintedRegs[dstReg][dstRp] = taintedRegs[srcReg][srcRp];
122 |     else
123 |         for (short i = 0; i < dstRp; i++)
124 |             taintedRegs[dstReg][i] = taintedRegs[srcReg][i];
125 | }
126 | 
127 | //Memory to Memory spreading
128 | void Tainter::spreadTaintMM(TA_UINT dstAddr, TA_UINT srcAddr, TA_UINT dataSize) {
129 |     for (TA_UINT i = 0 ; i < dataSize; i++)
130 |         if (isTainted(srcAddr + i))
131 |             taint(dstAddr + i);
132 |         else
133 |             untaint(dstAddr + i);
134 | }
135 | 
136 | void Tainter::getTaintedRegs(bool regList[R_END][R_TA_OWORD]) {
137 |     for (short i = 0; i < R_END; i++)
138 |         for (short j = 0; j < R_TA_OWORD; j++)
139 |             regList[i][j] = taintedRegs[i][j];
140 | }
141 | 
142 | 
143 | std::list<TA_UINT> Tainter::getTaintedMem(TA_UINT begin, TA_UINT end) {
144 |     std::list<TA_UINT> memlist;
145 |     
146 |     for (TA_UINT i = 0; i < end; i++)
147 |         if (isTainted(i))
148 |             memlist.push_back(i);
149 |     
150 |     memlist.sort();
151 |     return memlist;
152 | }
153 | 
154 | std::list<TA_UINT> Tainter::getTaintedMem() {
155 |     std::list<TA_UINT> memlist;
156 |     
157 |     for (std::list<TA_UINT>::iterator iter = taintedAddrs.begin(); iter != taintedAddrs.end(); iter++) {
158 |         memlist.push_back(*iter);
159 |     }
160 | 
161 |     memlist.sort();
162 |     return memlist;
163 | }
164 | 
165 | 


--------------------------------------------------------------------------------
/ida-plugin/ta_plugin.py:
--------------------------------------------------------------------------------
  1 | import idaapi, idc
  2 | import subprocess
  3 | from enum import IntEnum
  4 | 
  5 | CONF_PIN_PATH =  "~/Workspace/pin-2.14/"
  6 | 
  7 | class RegParts(IntEnum):
  8 |     LOW = 0,
  9 |     HIGH = 1,
 10 |     WORD = 2,
 11 |     DWORD = 4,
 12 |     QWORD = 8,
 13 |     OWORD = 16,
 14 |     YWORD = 32,
 15 | 
 16 | 
 17 | class Registers(IntEnum):
 18 |     RAX = 0,
 19 |     RBX = 1,
 20 |     RCX = 2,
 21 |     RDX = 3,
 22 |     RDI = 4,
 23 |     RSI = 5,
 24 |     RBP = 6,
 25 |     RSP = 7,
 26 |     RIP = 8,
 27 |     R8 = 9,
 28 |     R9 = 10,
 29 |     R10 = 11,
 30 |     R11 = 12,
 31 |     R12 = 13,
 32 |     R13 = 14,
 33 |     R14 = 15,
 34 |     R15 = 16,
 35 |     XMM0 = 17,
 36 |     XMM1 = 18,
 37 |     XMM2 = 19,
 38 |     XMM3 = 20,
 39 |     XMM4 = 21,
 40 |     XMM5 = 22,
 41 |     XMM6 = 23,
 42 |     XMM7 = 24,
 43 |     XMM8 = 25,
 44 |     XMM9 = 26,
 45 |     XMM10 = 27,
 46 |     XMM11 = 28,
 47 |     XMM12 = 29,
 48 |     XMM13 = 30,
 49 |     XMM14 = 31,
 50 |     XMM15 = 32,
 51 |     RFLAGS = 33,
 52 |     YMM0 = 34,
 53 |     YMM1 = 35,
 54 |     YMM2 = 36,
 55 |     YMM3 = 37,
 56 |     YMM4 = 38,
 57 |     YMM5 = 39,
 58 |     YMM6 = 40,
 59 |     YMM7 = 41,
 60 |     YMM8 = 42,
 61 |     YMM9 = 43,
 62 |     YMM10 = 44,
 63 |     YMM11 = 45,
 64 |     YMM12 = 46,
 65 |     YMM13 = 47,
 66 |     YMM14 = 48,
 67 |     QueueYMM15 = 49,
 68 | 
 69 | 
 70 | class Flags(IntEnum):
 71 |     AF = 0,
 72 |     CF = 1,
 73 |     DF = 2,
 74 |     IF = 3,
 75 |     OF = 4,
 76 |     PF = 5,
 77 |     SF = 6,
 78 |     TF = 7,
 79 |     ZF = 8,
 80 | 
 81 | 
 82 | class TaintAll(object):
 83 |     """TaintAll"""
 84 | 
 85 |     PIN_PATH = CONF_PIN_PATH + "/pin"
 86 |     TA_PATH = CONF_PIN_PATH + "/source/tools/TaintAll/obj-intel64/main.dylib"
 87 |     TARGET_FILE = None
 88 |     TARGET_PATH = None
 89 |     RESULT_FILE = "results.ta"
 90 |     COLOR_TAINTED = 0x00A5EE
 91 |     COLOR_CLEAR = 0xFFFFFF
 92 | 
 93 |     def __init__(self):
 94 |         self.__tpargs = ""
 95 |         self.__trargs = ""
 96 |         self.__taargs = ""
 97 |         self.__sffargs = ""
 98 |         self.__sfrargs = ""
 99 |         self.__taintStart = None
100 |         self.__taintStop = None
101 |         self.TARGET_FILE = idaapi.get_root_filename()
102 |         self.TARGET_PATH = idaapi.get_input_file_path()[:-len(self.TARGET_FILE)]
103 |         self.__programArguments = []
104 | 
105 |         self.__taintedRegs = []
106 |         self.__taintedMems = []
107 |         self.__taintedAddrs = []
108 |         self.__solutions = []
109 |         self.__chains = []
110 | 
111 |     def start(self):
112 |         """
113 |         print ("PIN_PATH: {0}".format(self.PIN_PATH))
114 |         print("TA_PATH: {0}".format(self.TA_PATH))
115 |         print ("TARGET_FILE: {0}".format(self.TARGET_FILE))
116 |         print ("TARGET_PATH: {0}".format(self.TARGET_PATH))
117 |         """
118 |         pass
119 | 
120 |     def taintPointer(self, insaddr, reg, size):
121 |         tmp = "0x{0:x},{1},{2}".format(insaddr, reg, size)
122 |         self.__tpargs = self.__concatArgs(self.__tpargs, tmp)
123 | 
124 |     def taintRegister(self, insaddr, reg, regpart):
125 |         tmp = "0x{0:x},{1},{2}".format(insaddr, reg, regpart)
126 |         self.__trargs = self.__concatArgs(self.__trargs, tmp)
127 | 
128 |     def taintAddress(self, insaddr, memaddr, size):
129 |         tmp = "0x{0:x},{1},{2}".format(insaddr, memaddr, size)
130 |         self.__taargs = self.__concatArgs(self.__taargs, tmp)
131 | 
132 |     def __concatArgs(self, old, new):
133 |         if len(old) > 1:
134 |             return "{0},{1}".format(old, new)
135 |         else:
136 |             return new
137 | 
138 |     def startTaintAt(self, addr):
139 |         self.__taintStart = addr
140 | 
141 |     def stopTaintAt(self, addr):
142 |         self.__taintStop = addr
143 | 
144 |     def prepCMDLine(self):
145 |         cmd = [
146 |             self.PIN_PATH,
147 |             '-t',
148 |             self.TA_PATH,
149 |             '-sib',
150 |             "0x{0:x}".format(idaapi.get_imagebase()),
151 |             "-bt",
152 |             "0x{0:x}".format(self.__taintStart),
153 |             "-et",
154 |             "0x{0:x}".format(self.__taintStop)]
155 | 
156 |         if len(self.__tpargs) > 1:
157 |             cmd.append("-tp")
158 |             cmd.append(self.__tpargs)
159 | 
160 |         if len(self.__trargs) > 1:
161 |             cmd.append("-tr")
162 |             cmd.append(self.__trargs)
163 | 
164 |         if len(self.__taargs) > 1:
165 |             cmd.append("-ta")
166 |             cmd.append(self.__taargs)
167 | 
168 |         if len(self.__sffargs) > 1:
169 |             cmd.append("-sff")
170 |             cmd.append(self.__sffargs)
171 | 
172 |         if len(self.__sfrargs) > 1:
173 |             cmd.append("-sfr")
174 |             cmd.append(self.__sfrargs)
175 | 
176 |         cmd.append("--")
177 |         cmd.append(self.TARGET_PATH + self.TARGET_FILE)
178 | 
179 |         return cmd + self.__programArguments
180 | 
181 |     def startDynamicAnalysis(self):
182 |         print("Starting dynamic analysis!")
183 | 
184 |         subprocess.check_call(
185 |             self.prepCMDLine(),
186 |             cwd=self.TARGET_PATH)
187 | 
188 |         with open(self.TARGET_PATH + self.RESULT_FILE, "r") as f:
189 |             for l in f.readlines():
190 |                 line = l[:-1].split(',')
191 |                 if line[0] == 'T':
192 |                     regs = line[2].split(':')[1:-1]
193 |                     mems = line[3].split(':')[1:-1]
194 |                     self.__taintedRegs.append((int(line[1], 16), regs))
195 |                     self.__taintedMems.append((int(line[1], 16), mems))
196 |                     self.__taintedAddrs.append(int(line[1], 16))
197 |                     idc.SetColor(int(line[1], 16), 1, self.COLOR_TAINTED)
198 |                 elif line[0] == 'R':
199 |                     self.__solutions.append((
200 |                         int(line[1], 16),
201 |                         int(line[2], 16),
202 |                         line[3]))
203 | 
204 |         if self.__taintedAddrs:
205 |             idc.Jump(self.__taintedAddrs[0])
206 |             print("Done!")
207 |         else:
208 |             print("There aren't any affected addresses.")
209 | 
210 |     def printRegsEA(self):
211 |         ea = idc.ScreenEA()
212 | 
213 |         for line in self.__taintedRegs:
214 |             if line[0] == ea:
215 |                 print(line[1])
216 |                 break
217 | 
218 |     def printMemsEA(self):
219 |         ea = idc.ScreenEA()
220 | 
221 |         for line in self.__taintedMems:
222 |             if line[0] == ea:
223 |                 print(line[1])
224 |                 break
225 | 
226 |     def printAffectedAddrs(self):
227 |         for line in self.__taintedAddrs:
228 |             print(hex(line))
229 | 
230 |     def addProgramArguments(self, args):
231 |         self.__programArguments = args
232 | 
233 |     def hideTaints(self):
234 |         for insaddr in self.__taintedAddrs:
235 |             idc.SetColor(insaddr, 1, self.COLOR_CLEAR)
236 | 
237 |     def showTaints(self):
238 |         for insaddr in self.__taintedAddrs:
239 |             idc.SetColor(insaddr, 1, self.COLOR_TAINTED)
240 | 
241 | 
242 | class ta_plugin(idaapi.plugin_t):
243 |     flags = idaapi.PLUGIN_PROC
244 |     comment = "TaintAll IDA Plugin"
245 |     help = "Somebody call 911"
246 |     wanted_name = "TaintAll"
247 |     wanted_hotkey = ""
248 | 
249 |     def init(self):
250 |         self.ida_msg("Initializing")
251 |         return idaapi.PLUGIN_SKIP
252 | 
253 |     def run(self, arg):
254 |         self.a = TaintAll()
255 |         self.a.start()
256 | 
257 |     def term(self):
258 |         self.ida_msg("Terminating")
259 | 
260 |     def ida_msg(self, msg):
261 |         idaapi.msg("[TA] {0}\n".format(msg))
262 | 
263 | 
264 | def PLUGIN_ENTRY():
265 |     return ta_plugin()
266 | 


--------------------------------------------------------------------------------
/src/InstrumentHelper.cpp:
--------------------------------------------------------------------------------
  1 | //
  2 | //  InstrumentHelper.cpp
  3 | //  TaintAll
  4 | //
  5 | //  Created by Onur on 06/01/16.
  6 | //  Copyright © 2016 taintall. All rights reserved.
  7 | //
  8 | 
  9 | #include "InstrumentHelper.hpp"
 10 | 
 11 | #define TA_DEBUG 6
 12 | 
 13 | 
 14 | void InstrumentHelper::taintMemToReg(const CONTEXT *ctxt, InsData *insData, Tainter *tainter,
 15 |                                      TA_UINT memEA, REG reg) {
 16 | 
 17 |     RegId tmpReg;
 18 |     RegPart tmpPart;
 19 |     
 20 |     tmpReg = Registers::parsePINReg(reg, &tmpPart);
 21 |     
 22 |     if (tmpReg == R_END) return;
 23 |     
 24 |     tainter->spreadTaintRM(tmpReg, tmpPart, memEA);
 25 |     
 26 |     if (TA_DEBUG == 1) {
 27 |         cout << "taintMemToReg: 0x" << hex << memEA << " - " << dec << Registers::getRegName(Registers::parsePINReg(reg, &tmpPart), R_TA_QWORD) << endl;
 28 |         printInfo(insData, tainter);
 29 |     } else if (TA_DEBUG == 2) {
 30 |         printInfo(insData, tainter);
 31 |     } else if (TA_DEBUG == 4) {
 32 |         if (tainter->isTainted(tmpReg, tmpPart)) {
 33 |             printInfo(insData, tainter);
 34 |         }
 35 |     }
 36 | }
 37 | 
 38 | void InstrumentHelper::taintImmToMem(const CONTEXT *ctxt, InsData *insData, Tainter *tainter,
 39 |                                      TA_UINT memEA, short immSize) {
 40 |     
 41 |     tainter->spreadTaintMI(memEA, immSize);
 42 |     
 43 |     if (TA_DEBUG == 1) {
 44 |         cout << "taintImmToMem: 0x" << hex << memEA << " - " << dec << immSize << endl;
 45 |         printInfo(insData, tainter);
 46 |         
 47 |     } else if (TA_DEBUG == 2) {
 48 |         printInfo(insData, tainter);
 49 |     }
 50 | }
 51 | 
 52 | void InstrumentHelper::taintRegToMem(const CONTEXT *ctxt, InsData *insData, Tainter *tainter,
 53 |                                      TA_UINT memEA, REG reg) {
 54 |     RegId tmpReg;
 55 |     RegPart tmpPart;
 56 | 
 57 |     tmpReg = Registers::parsePINReg(reg, &tmpPart);
 58 |     
 59 |     if (tmpReg != R_END) {
 60 |         tainter->spreadTaintMR(memEA, tmpReg, tmpPart);
 61 |     }
 62 |     
 63 |     if (TA_DEBUG == 1) {
 64 |         cout << "taintRegToMem:" << dec << Registers::getRegName(tmpReg, tmpPart) << "\tmem: 0x" << hex << memEA << endl;
 65 |         printInfo(insData, tainter);
 66 |     } else if (TA_DEBUG == 2) {
 67 |         printInfo(insData, tainter);
 68 |     } else if (TA_DEBUG == 4) {
 69 |         if (tainter->isTainted(memEA)) {
 70 |             printInfo(insData, tainter);
 71 |         }
 72 |     }
 73 | }
 74 | 
 75 | void InstrumentHelper::taintImmToReg(const CONTEXT *ctxt, InsData *insData, Tainter *tainter,
 76 |                                      REG reg) {
 77 |     RegId tmpReg;
 78 |     RegPart tmpPart;
 79 |     
 80 |     tmpReg = Registers::parsePINReg(reg, &tmpPart);
 81 |     tainter->spreadTaintRI(tmpReg, tmpPart);
 82 |     
 83 |     if (TA_DEBUG == 1) {
 84 |         cout << "taintImmToReg: " << Registers::getRegName(Registers::parsePINReg(reg, &tmpPart), R_TA_QWORD) << endl;
 85 |         printInfo(insData, tainter);
 86 | 
 87 |     } else if (TA_DEBUG == 2) {
 88 |         printInfo(insData, tainter);
 89 |     }
 90 | }
 91 | 
 92 | void InstrumentHelper::taintRegToReg(const CONTEXT *ctxt, InsData *insData, Tainter *tainter,
 93 |                                     REG dstReg, REG srcReg) {
 94 |     RegId tmpReg, tmpReg2;
 95 |     RegPart tmpPart, tmpPart2;
 96 |     
 97 |     tmpReg = Registers::parsePINReg(dstReg, &tmpPart);
 98 |     tmpReg2 = Registers::parsePINReg(srcReg, &tmpPart2);
 99 |     
100 |     /* 
101 |      cout << Registers::getRegName(tmpReg, tmpPart) << "," << Registers::getRegName(tmpReg2, tmpPart2);
102 |      */
103 |     
104 |     tainter->spreadTaintRR(tmpReg, tmpPart, tmpReg2, tmpPart2);
105 |     
106 |     if (TA_DEBUG == 1) {
107 |         cout << "taintRegToReg" << endl;
108 |         printInfo(insData, tainter);
109 |     } else if (TA_DEBUG == 2) {
110 |         printInfo(insData, tainter);
111 |     } else if (TA_DEBUG == 4) {
112 |         if (tainter->isTainted(tmpReg, tmpPart)) {
113 |             printInfo(insData, tainter);
114 |         }
115 |     }
116 | }
117 | 
118 | 
119 | void InstrumentHelper::printInfo(InsData *insData, Tainter *tainter) {
120 |     bool tr[R_END][R_TA_OWORD];
121 |     std::list<TA_UINT> ta;
122 | 
123 |     
124 |     if (insData->addr - insData->pieIter > OSX_SHARED_ADDR_SPACE) {
125 |         cout.setstate(std::ios_base::badbit);
126 |     } else {
127 |         cout.clear();
128 |     }
129 |     
130 |     /* print instruction */
131 |     cout << std::hex << insData->addr - insData->pieIter << "\t" << insData->mnemonic << std::endl;
132 |     
133 |     /* print tainted registers */
134 |     cout << "Tainted Regs" << std::endl;
135 |     tainter->getTaintedRegs(tr);
136 |     Registers::printTaintedRegs(tr);
137 |     
138 |     /* print tainted addresses */
139 |     cout << "Tainted Mems" << std::endl;
140 |     ta = tainter->getTaintedMem();
141 |     for (std::list<TA_UINT>::iterator iter = ta.begin(); iter != ta.end(); iter++) {
142 |         cout << "0x" << hex << *iter << endl;
143 |     }
144 |     cout << "-----------" << endl;
145 |     
146 | }
147 | 
148 | void InstrumentHelper::printFormatted(InsData *insData, Tainter *tainter) {
149 |     bool tr[R_END][R_TA_OWORD];
150 |     std::list<TA_UINT> ta;
151 | 
152 |     
153 |     *(insData->rFile) << "T,0x" << std::hex << insData->addr - insData->pieIter << ",";
154 |     
155 |     *(insData->rFile) << "tregs:";
156 |     tainter->getTaintedRegs(tr);
157 |     Registers::printTaintedRegs(tr, insData->rFile);
158 |     *(insData->rFile) << ",";
159 |     
160 |     *(insData->rFile) << "tmems:";
161 |     ta = tainter->getTaintedMem();
162 |     for (std::list<TA_UINT>::iterator iter = ta.begin(); iter != ta.end(); iter++) {
163 |         *(insData->rFile) << "0x" << hex << *iter << ":";
164 |     }
165 | 
166 |     *(insData->rFile) << std::endl;
167 | }
168 | 
169 | void InstrumentHelper::analyseLea(const CONTEXT *ctxt, InsData *insData, Tainter * tainter, REG baseReg, REG indexReg, long int displacement, UINT32 scale, TInst* tinst, bool* isAnyTainted) {
170 |     TA_UINT base = 0;
171 |     TA_UINT index = 0;
172 |     TA_UINT memEA;
173 |     
174 |     if (baseReg != REG_INVALID())
175 |         PIN_GetContextRegval(ctxt, baseReg, (UINT8*)&base);
176 |     if (indexReg != REG_INVALID())
177 |         PIN_GetContextRegval(ctxt, indexReg, (UINT8*)&index);
178 |     
179 |     memEA = displacement + base + index * scale;
180 |     
181 |     //cout << std::hex << insData->addr - insData->pieIter << "\t" << insData->mnemonic << "---" << hex << memEA << " - val:"  << getOpcodeBytes(memEA, 5) << std::endl;
182 |     
183 |     if (tainter->isTainted(memEA)) {
184 |         *isAnyTainted = true;
185 |     }
186 |     
187 | }
188 | 
189 | void InstrumentHelper::analyseMem(const CONTEXT *ctxt, InsData *insData, Tainter *tainter, TA_UINT memEA, short immSize, TInst* tinst, bool* isAnyTainted) {
190 |     
191 |     
192 |     for (int i = 0; i < immSize; i++)
193 |         if (tainter->isTainted(memEA + i)) {
194 |             *isAnyTainted = true;
195 |             break;
196 |         }
197 | }
198 | 
199 | void InstrumentHelper::analyseReg(const CONTEXT *ctxt, InsData *insData, Tainter *tainter, REG reg, TInst* tinst, bool* isAnyTainted) {
200 |     RegId tmpReg;
201 |     RegPart tmpPart;
202 |     
203 |     
204 |     tmpReg = Registers::parsePINReg(reg, &tmpPart);
205 |     
206 |     if (tainter->isTainted(tmpReg, tmpPart))  {
207 |         *isAnyTainted = true;
208 |     }
209 | }
210 | 
211 | void InstrumentHelper::processTInst(const CONTEXT *ctxt, InsData *insData, Tainter *tainter, TInst* tinst, bool* isAnyTainted) {
212 |     
213 |     
214 |     if (*isAnyTainted) {
215 |         if (TA_DEBUG == 3) {
216 |             cout << getOpcodeStr(insData->addr, insData->size) << endl;
217 |             printInfo(insData, tainter);
218 |         } else if (TA_DEBUG == 6) {
219 |             printFormatted(insData, tainter);
220 |         }
221 |     }
222 | }
223 | 
224 | string InstrumentHelper::getOpcodeBytes(TA_UINT addr, short size) {
225 |     std::stringstream ss;
226 |     
227 |     for (short j = 0; j < size; j++) {
228 |         ss << setfill('0') << setw(2) << hex << (((unsigned int) *(unsigned char*)(addr + j)) & 0xFF);
229 |     }
230 |     
231 |     return ss.str();
232 | }
233 | 
234 | string InstrumentHelper::getOpcodeStr(TA_UINT addr, short size) {
235 |     std::stringstream ss;
236 |     
237 |     for (short j = 0; j < size; j++) {
238 |         ss << "\\x" << setfill('0') << setw(2) << hex << (((unsigned int) *(unsigned char*)(addr + j)) & 0xFF);
239 |     }
240 |     
241 |     return ss.str();
242 | }
243 | 
244 | void InstrumentHelper::clearRegs(const CONTEXT *ctxt, Tainter *tainter) {
245 |     tainter->untaint(R_RAX, R_TA_QWORD);
246 |     tainter->untaint(R_RCX, R_TA_QWORD);
247 |     tainter->untaint(R_RDX, R_TA_QWORD);
248 |     tainter->untaint(R_R8, R_TA_QWORD);
249 |     tainter->untaint(R_R9, R_TA_QWORD);
250 |     tainter->untaint(R_R10, R_TA_QWORD);
251 |     tainter->untaint(R_R11, R_TA_QWORD);
252 | }
253 | 
254 | 
255 | 
256 | 


--------------------------------------------------------------------------------
/src/Registers.cpp:
--------------------------------------------------------------------------------
  1 | //
  2 | //  Registers.cpp
  3 | //  TaintAll
  4 | //
  5 | //  Created by Onur on 09/12/15.
  6 | //  Copyright © 2015 taintall. All rights reserved.
  7 | //
  8 | 
  9 | #include "Registers.hpp"
 10 | #include <iostream>
 11 | 
 12 | 
 13 | 
 14 | std::string Registers::getRegName(RegId reg, RegPart rp) {
 15 |     switch (reg) {
 16 |         case R_RAX:
 17 |             switch (rp) {
 18 |                 case R_LOW: return "R_AL";
 19 |                 case R_HIGH: return "R_AH";
 20 |                 case R_TA_WORD: return "R_AX";
 21 |                 case R_TA_DWORD: return "R_EAX";
 22 |                 case R_TA_QWORD: return "R_RAX";
 23 |                 default: return "R_NONE";
 24 |             }
 25 |         case R_RBX:
 26 |             switch (rp) {
 27 |                 case R_LOW: return "R_BL";
 28 |                 case R_HIGH: return "R_BH";
 29 |                 case R_TA_WORD: return "R_BX";
 30 |                 case R_TA_DWORD: return "R_EBX";
 31 |                 case R_TA_QWORD: return "R_RBX";
 32 |                 default: return "R_NONE";
 33 |             }
 34 |         case R_RCX:
 35 |             switch (rp) {
 36 |                 case R_LOW: return "R_CL";
 37 |                 case R_HIGH: return "R_CH";
 38 |                 case R_TA_WORD: return "R_CX";
 39 |                 case R_TA_DWORD: return "R_ECX";
 40 |                 case R_TA_QWORD: return "R_RCX";
 41 |                 default: return "R_NONE";
 42 |             }
 43 |         case R_RDX:
 44 |             switch (rp) {
 45 |                 case R_LOW: return "R_DL";
 46 |                 case R_HIGH: return "R_DH";
 47 |                 case R_TA_WORD: return "R_DX";
 48 |                 case R_TA_DWORD: return "R_EDX";
 49 |                 case R_TA_QWORD: return "R_RDX";
 50 |                 default: return "R_NONE";
 51 |             }
 52 |         case R_RDI:
 53 |             switch (rp) {
 54 |                 case R_LOW: return "R_DIL";
 55 |                 case R_TA_WORD: return "R_DI";
 56 |                 case R_TA_DWORD: return "R_EDI";
 57 |                 case R_TA_QWORD: return "R_RDI";
 58 |                 default: return "R_NONE";
 59 |             }
 60 |         case R_RSI:
 61 |             switch (rp) {
 62 |                 case R_LOW: return "R_SIL";
 63 |                 case R_TA_WORD: return "R_SI";
 64 |                 case R_TA_DWORD: return "R_ESI";
 65 |                 case R_TA_QWORD: return "R_RSI";
 66 |                 default: return "R_NONE";
 67 |             }
 68 |         case R_RBP:
 69 |             switch (rp) {
 70 |                 case R_TA_WORD: return "R_BP";
 71 |                 case R_TA_DWORD: return "R_EBP";
 72 |                 case R_TA_QWORD: return "R_RBP";
 73 |                 default: return "R_NONE";
 74 |             }
 75 |         case R_RSP:
 76 |             switch (rp) {
 77 |                 case R_TA_WORD: return "R_SP";
 78 |                 case R_TA_DWORD: return "R_ESP";
 79 |                 case R_TA_QWORD: return "R_RSP";
 80 |                 default: return "R_NONE";
 81 |             }
 82 |         case R_RIP:
 83 |             switch (rp) {
 84 |                 case R_TA_WORD: return "R_IP";
 85 |                 case R_TA_DWORD: return "R_EIP";
 86 |                 case R_TA_QWORD: return "R_RIP";
 87 |                 default: return "R_NONE";
 88 |             }
 89 |         case R_R8:
 90 |             switch (rp) {
 91 |                 case R_TA_QWORD: return "R_R8";
 92 |                 default: return "R_NONE";
 93 |             }
 94 |         case R_R9:
 95 |             switch (rp) {
 96 |                 case R_TA_QWORD: return "R_R9";
 97 |                 default: return "R_NONE";
 98 |             }
 99 |         case R_R10:
100 |             switch (rp) {
101 |                 case R_TA_QWORD: return "R_R10";
102 |                 default: return "R_NONE";
103 |             }
104 |         case R_R11:
105 |             switch (rp) {
106 |                 case R_TA_QWORD: return "R_R11";
107 |                 default: return "R_NONE";
108 |             }
109 |         case R_R12:
110 |             switch (rp) {
111 |                 case R_TA_QWORD: return "R_R12";
112 |                 default: return "R_NONE";
113 |             }
114 |         case R_R13:
115 |             switch (rp) {
116 |                 case R_TA_QWORD: return "R_R13";
117 |                 default: return "R_NONE";
118 |             }
119 |         case R_R14:
120 |             switch (rp) {
121 |                 case R_TA_QWORD: return "R_R14";
122 |                 default: return "R_NONE";
123 |             }
124 |         case R_R15:
125 |             switch (rp) {
126 |                 case R_TA_QWORD: return "R_R15";
127 |                 default: return "R_NONE";
128 |             }
129 |         case R_RFLAGS:
130 |             switch (rp) {
131 |                 case R_TA_DWORD: return "R_EFLAGS";
132 |                 case R_TA_QWORD: return "R_RFLAGS";
133 |                 default: return "R_NONE";
134 |             }
135 |         case R_XMM0:
136 |             return "R_XMM0";
137 |         case R_XMM1:
138 |            return "R_XMM1";
139 |         case R_XMM2:
140 |             return "R_XMM2";
141 |         case R_XMM3:
142 |             return "R_XMM3";
143 |         case R_XMM4:
144 |             return "R_XMM4";
145 |         case R_XMM5:
146 |             return "R_XMM5";
147 |         case R_XMM6:
148 |             return "R_XMM6";
149 |         case R_XMM7:
150 |             return "R_XMM7";
151 |         case R_XMM8:
152 |             return "R_XMM8";
153 |         case R_XMM9:
154 |             return "R_XMM9";
155 |         case R_XMM10:
156 |             return "R_XMM10";
157 |         case R_XMM11:
158 |             return "R_XMM11";
159 |         case R_XMM12:
160 |             return "R_XMM12";
161 |         case R_XMM13:
162 |             return "R_XMM13";
163 |         case R_XMM14:
164 |             return "R_XMM14";
165 |         case R_XMM15:
166 |             return "R_XMM15";
167 |         case R_YMM0:
168 |             return "R_YMM0";
169 |         case R_YMM1:
170 |             return "R_YMM1";
171 |         case R_YMM2:
172 |             return "R_YMM2";
173 |         case R_YMM3:
174 |             return "R_YMM3";
175 |         case R_YMM4:
176 |             return "R_YMM4";
177 |         case R_YMM5:
178 |             return "R_YMM5";
179 |         case R_YMM6:
180 |             return "R_YMM6";
181 |         case R_YMM7:
182 |             return "R_YMM7";
183 |         case R_YMM8:
184 |             return "R_YMM8";
185 |         case R_YMM9:
186 |             return "R_YMM9";
187 |         case R_YMM10:
188 |             return "R_YMM10";
189 |         case R_YMM11:
190 |             return "R_YMM11";
191 |         case R_YMM12:
192 |             return "R_YMM12";
193 |         case R_YMM13:
194 |             return "R_YMM13";
195 |         case R_YMM14:
196 |             return "R_YMM14";
197 |         case R_YMM15:
198 |             return "R_YMM15";
199 |         default:
200 |             return "R_NONE";
201 |     }
202 | }
203 | 
204 | RegPart Registers::getRegPartBySize(short val) {
205 |     if (val == 0) return R_LOW;
206 |     if (val == TA_BYTE) return R_HIGH;
207 |     if (val < TA_WORD) return R_TA_WORD;
208 |     if (val < TA_DWORD) return R_TA_DWORD;
209 |     if (val < TA_QWORD) return R_TA_QWORD;
210 |     if (val < TA_OWORD) return R_TA_OWORD;
211 |     if (val < TA_YWORD) return R_TA_YWORD;
212 |     
213 |     return RP_NONE;
214 | }
215 | 
216 | RegPart Registers::getRegPartByOrdinal(short ordinal) {
217 |     switch (ordinal) {
218 |         case 0: return R_LOW;
219 |         case 1: return R_HIGH;
220 |         case 2: return R_TA_WORD;
221 |         case 3: return R_TA_DWORD;
222 |         case 4: return R_TA_QWORD;
223 |         case 5: return R_TA_OWORD;
224 |         case 6: return R_TA_YWORD;
225 |         default: return RP_NONE;
226 |     }
227 | }
228 | 
229 | short Registers::getRegPartOrder(RegPart rp) {
230 |     switch (rp) {
231 |         case R_LOW: return 0;
232 |         case R_HIGH: return 1;
233 |         case R_TA_WORD: return 2;
234 |         case R_TA_DWORD: return 3;
235 |         case R_TA_QWORD: return 4;
236 |         case R_TA_OWORD: return 5;
237 |         default: return 6;
238 |     }
239 | }
240 | 
241 | 
242 | void Registers::printTaintedRegs(bool regList[R_END][R_TA_OWORD]) {
243 |     std::string regName;
244 |     
245 |     for (short i = 0; i < R_END; i++)
246 |         for (short j = 0; j < R_TA_OWORD; j++)
247 |             if (regList[i][j]) {
248 |                 for (short rp = getRegPartOrder(getRegPartBySize(j)); rp < RP_SIZE; rp++) {
249 |                     /* exception for R_HIGH registers */
250 |                     if (getRegPartByOrdinal(rp) == R_HIGH && !regList[i][getRegPartByOrdinal(rp)])
251 |                         continue;
252 | 
253 |                     regName = getRegName(RegId(i), getRegPartByOrdinal(rp));
254 |                     if (regName.compare("R_NONE") != 0)
255 |                         std::cout << regName << std::endl;
256 |                     if (regName.find("R_XMM") != std::string::npos)
257 |                         break;
258 |                 }
259 |                 break;
260 |             }
261 | }
262 | 
263 | void Registers::printTaintedRegs(bool regList[R_END][R_TA_OWORD], std::ofstream* rFile) {
264 |     std::string regName;
265 |     
266 |     for (short i = 0; i < R_END; i++)
267 |         for (short j = 0; j < R_TA_OWORD; j++)
268 |             if (regList[i][j]) {
269 |                 for (short rp = getRegPartOrder(getRegPartBySize(j)); rp < RP_SIZE; rp++) {
270 |                     /* exception for R_HIGH registers */
271 |                     if (getRegPartByOrdinal(rp) == R_HIGH && !regList[i][getRegPartByOrdinal(rp)])
272 |                         continue;
273 |                     
274 |                     regName = getRegName(RegId(i), getRegPartByOrdinal(rp));
275 |                     if (regName.compare("R_NONE") != 0)
276 |                         *rFile << regName << ":";
277 |                     if (regName.find("R_XMM") != std::string::npos)
278 |                         break;
279 |                 }
280 |                 break;
281 |             }
282 | }
283 | 
284 | RegId Registers::parsePINReg(REG pinReg, RegPart * regPart) {
285 |     
286 |     switch (pinReg) {
287 |         case REG_RAX: *regPart = R_TA_QWORD; return R_RAX;
288 |         case REG_EAX: *regPart = R_TA_DWORD; return R_RAX;
289 |         case REG_AX: *regPart = R_TA_WORD; return R_RAX;
290 |         case REG_AH: *regPart = R_HIGH; return R_RAX;
291 |         case REG_AL: *regPart = R_LOW; return R_RAX;
292 |             
293 |         case REG_RBX: *regPart = R_TA_QWORD; return R_RBX;
294 |         case REG_EBX: *regPart = R_TA_DWORD; return R_RBX;
295 |         case REG_BX: *regPart = R_TA_WORD; return R_RBX;
296 |         case REG_BH: *regPart = R_HIGH; return R_RBX;
297 |         case REG_BL: *regPart = R_LOW; return R_RBX;
298 |             
299 |         case REG_RCX: *regPart = R_TA_QWORD; return R_RCX;
300 |         case REG_ECX: *regPart = R_TA_DWORD; return R_RCX;
301 |         case REG_CX: *regPart = R_TA_WORD; return R_RCX;
302 |         case REG_CH: *regPart = R_HIGH; return R_RCX;
303 |         case REG_CL: *regPart = R_LOW; return R_RCX;
304 |             
305 |         case REG_RDX: *regPart = R_TA_QWORD; return R_RDX;
306 |         case REG_EDX: *regPart = R_TA_DWORD; return R_RDX;
307 |         case REG_DX: *regPart = R_TA_WORD; return R_RDX;
308 |         case REG_DH: *regPart = R_HIGH; return R_RDX;
309 |         case REG_DL: *regPart = R_LOW; return R_RDX;
310 |         
311 |         case REG_RDI: *regPart = R_TA_QWORD; return R_RDI;
312 |         case REG_EDI: *regPart = R_TA_DWORD; return R_RDI;
313 |         case REG_DI: *regPart = R_TA_WORD; return R_RDI;
314 |         case REG_DIL: *regPart = R_LOW; return R_RDI;
315 |         
316 |         case REG_RSI: *regPart = R_TA_QWORD; return R_RSI;
317 |         case REG_ESI: *regPart = R_TA_DWORD; return R_RSI;
318 |         case REG_SI: *regPart = R_TA_WORD; return R_RSI;
319 |         case REG_SIL: *regPart = R_LOW; return R_RSI;
320 |             
321 |         case REG_RBP: *regPart = R_TA_QWORD; return R_RBP;
322 |         case REG_EBP: *regPart = R_TA_DWORD; return R_RBP;
323 |         case REG_BP: *regPart = R_TA_WORD; return R_RBP;
324 |         case REG_BPL: *regPart = R_LOW; return R_RBP;
325 |             
326 |         case REG_RSP: *regPart = R_TA_QWORD; return R_RSP;
327 |         case REG_ESP: *regPart = R_TA_DWORD; return R_RSP;
328 |         case REG_SP: *regPart = R_TA_WORD; return R_RSP;
329 |         case REG_SPL: *regPart = R_LOW; return R_RSP;
330 | 
331 |         case REG_R8: *regPart = R_TA_QWORD; return R_R8;
332 |         case REG_R8D: *regPart = R_TA_DWORD; return R_R8;
333 |         case REG_R8W: *regPart = R_TA_WORD; return R_R8;
334 |         case REG_R8B: *regPart = R_LOW; return R_R8;
335 |             
336 |         case REG_R9: *regPart = R_TA_QWORD; return R_R9;
337 |         case REG_R9D: *regPart = R_TA_DWORD; return R_R9;
338 |         case REG_R9W: *regPart = R_TA_WORD; return R_R9;
339 |         case REG_R9B: *regPart = R_LOW; return R_R9;
340 |         
341 |         case REG_R10: *regPart = R_TA_QWORD; return R_R10;
342 |         case REG_R10D: *regPart = R_TA_DWORD; return R_R10;
343 |         case REG_R10W: *regPart = R_TA_WORD; return R_R10;
344 |         case REG_R10B: *regPart = R_LOW; return R_R10;
345 |         
346 |         case REG_R11: *regPart = R_TA_QWORD; return R_R11;
347 |         case REG_R11D: *regPart = R_TA_DWORD; return R_R11;
348 |         case REG_R11W: *regPart = R_TA_WORD; return R_R11;
349 |         case REG_R11B: *regPart = R_LOW; return R_R11;
350 |             
351 |         case REG_R12: *regPart = R_TA_QWORD; return R_R12;
352 |         case REG_R12D: *regPart = R_TA_DWORD; return R_R12;
353 |         case REG_R12W: *regPart = R_TA_WORD; return R_R12;
354 |         case REG_R12B: *regPart = R_LOW; return R_R12;
355 |         
356 |         case REG_R13: *regPart = R_TA_QWORD; return R_R13;
357 |         case REG_R13D: *regPart = R_TA_DWORD; return R_R13;
358 |         case REG_R13W: *regPart = R_TA_WORD; return R_R13;
359 |         case REG_R13B: *regPart = R_LOW; return R_R13;
360 | 
361 |         case REG_R14: *regPart = R_TA_QWORD; return R_R14;
362 |         case REG_R14D: *regPart = R_TA_DWORD; return R_R14;
363 |         case REG_R14W: *regPart = R_TA_WORD; return R_R14;
364 |         case REG_R14B: *regPart = R_LOW; return R_R14;
365 | 
366 |         case REG_R15: *regPart = R_TA_QWORD; return R_R15;
367 |         case REG_R15D: *regPart = R_TA_DWORD; return R_R15;
368 |         case REG_R15W: *regPart = R_TA_WORD; return R_R15;
369 |         case REG_R15B: *regPart = R_LOW; return R_R15;
370 | 
371 |         case REG_RFLAGS: *regPart = R_TA_QWORD; return R_RFLAGS;
372 |         case REG_EFLAGS: *regPart = R_TA_DWORD; return R_RFLAGS;
373 |             
374 |         case REG_RIP: *regPart = R_TA_QWORD; return R_RIP;
375 |         case REG_EIP: *regPart = R_TA_DWORD; return R_RIP;
376 |             
377 |         case REG_XMM0: *regPart = R_TA_OWORD; return R_XMM0;
378 |         case REG_XMM1: *regPart = R_TA_OWORD; return R_XMM1;
379 |         case REG_XMM2: *regPart = R_TA_OWORD; return R_XMM2;
380 |         case REG_XMM3: *regPart = R_TA_OWORD; return R_XMM3;
381 |         case REG_XMM4: *regPart = R_TA_OWORD; return R_XMM4;
382 |         case REG_XMM5: *regPart = R_TA_OWORD; return R_XMM5;
383 |         case REG_XMM6: *regPart = R_TA_OWORD; return R_XMM6;
384 |         case REG_XMM7: *regPart = R_TA_OWORD; return R_XMM7;
385 |         case REG_XMM8: *regPart = R_TA_OWORD; return R_XMM8;
386 |         case REG_XMM9: *regPart = R_TA_OWORD; return R_XMM9;
387 |         case REG_XMM10: *regPart = R_TA_OWORD; return R_XMM10;
388 |         case REG_XMM11: *regPart = R_TA_OWORD; return R_XMM11;
389 |         case REG_XMM12: *regPart = R_TA_OWORD; return R_XMM12;
390 |         case REG_XMM13: *regPart = R_TA_OWORD; return R_XMM13;
391 |         case REG_XMM14: *regPart = R_TA_OWORD; return R_XMM14;
392 |         case REG_XMM15: *regPart = R_TA_OWORD; return R_XMM15;
393 |             
394 |         case REG_YMM0: *regPart = R_TA_YWORD; return R_YMM0;
395 |         case REG_YMM1: *regPart = R_TA_YWORD; return R_YMM1;
396 |         case REG_YMM2: *regPart = R_TA_YWORD; return R_YMM2;
397 |         case REG_YMM3: *regPart = R_TA_YWORD; return R_YMM3;
398 |         case REG_YMM4: *regPart = R_TA_YWORD; return R_YMM4;
399 |         case REG_YMM5: *regPart = R_TA_YWORD; return R_YMM5;
400 |         case REG_YMM6: *regPart = R_TA_YWORD; return R_YMM6;
401 |         case REG_YMM7: *regPart = R_TA_YWORD; return R_YMM7;
402 |         case REG_YMM8: *regPart = R_TA_YWORD; return R_YMM8;
403 |         case REG_YMM9: *regPart = R_TA_YWORD; return R_YMM9;
404 |         case REG_YMM10: *regPart = R_TA_YWORD; return R_YMM10;
405 |         case REG_YMM11: *regPart = R_TA_YWORD; return R_YMM11;
406 |         case REG_YMM12: *regPart = R_TA_YWORD; return R_YMM12;
407 |         case REG_YMM13: *regPart = R_TA_YWORD; return R_YMM13;
408 |         case REG_YMM14: *regPart = R_TA_YWORD; return R_YMM14;
409 |         case REG_YMM15: *regPart = R_TA_YWORD; return R_YMM15;
410 |             
411 |         default:
412 |             return R_END;
413 |     }
414 | }
415 | 
416 | REG Registers::convertPINReg(RegId reg) {
417 |     
418 |     switch (reg) {
419 |         case R_RAX: return REG_RAX;
420 |         case R_RBX: return REG_RBX;
421 |         case R_RCX: return REG_RCX;
422 |         case R_RDX: return REG_RDX;
423 |         case R_RDI: return REG_RDI;
424 |         case R_RSI: return REG_RSI;
425 |         case R_RBP: return REG_RBP;
426 |         case R_RSP: return REG_RSP;
427 |         case R_R8: return REG_R8;
428 |         case R_R9: return REG_R9;
429 |         case R_R10: return REG_R10;
430 |         case R_R11: return REG_R11;
431 |         case R_R12: return REG_R12;
432 |         case R_R13: return REG_R13;
433 |         case R_R14: return REG_R14;
434 |         case R_R15: return REG_R15;
435 |         default:
436 |             return REG_INVALID_;
437 |     }
438 | }
439 | 
440 | 
441 | 


--------------------------------------------------------------------------------
/src/Instrumenter.cpp:
--------------------------------------------------------------------------------
  1 | //
  2 | //  Instrumenter.cpp
  3 | //  TaintAll
  4 | //
  5 | //  Created by Onur on 15/12/15.
  6 | //  Copyright © 2015 taintall. All rights reserved.
  7 | //
  8 | 
  9 | #include "Instrumenter.hpp"
 10 | #include <iostream>
 11 | #include <sstream>
 12 | #include <sys/syscall.h>
 13 | #include <boost/algorithm/string.hpp>
 14 | 
 15 | 
 16 | Tainter Instrumenter::tainter;
 17 | std::list<TAddr> Instrumenter::addrsToBeTainted;
 18 | std::list<TReg> Instrumenter::regsToBeTainted;
 19 | std::list<TAddr> Instrumenter::addrsToBeUntainted;
 20 | std::list<TReg> Instrumenter::regsToBeUntainted;
 21 | std::list<TPtr> Instrumenter::pointersToBeTainted;
 22 | std::list<TPtr> Instrumenter::pointersToBeUntainted;
 23 | 
 24 | 
 25 | IMGInfo Instrumenter::imgInfo;
 26 | readSysCall Instrumenter::lastReadSysCall;
 27 | bool Instrumenter::isEngineRunning;
 28 | UserCommands Instrumenter::usrCmd;
 29 | bool Instrumenter::isSERunning;
 30 | bool Instrumenter::isRegsCleared;
 31 | std::ofstream Instrumenter::resultFile;
 32 | 
 33 | 
 34 | KNOB<UINT64> KnobSIB(KNOB_MODE_WRITEONCE, "pintool", "sib", "0x100000000", "Static Image Base");
 35 | KNOB<UINT64> KnobTaintStart(KNOB_MODE_WRITEONCE, "pintool", "bt", "0x0", "Start Tainting");
 36 | KNOB<UINT64> KnobTaintStop(KNOB_MODE_WRITEONCE, "pintool", "et", "0x0", "Stop Tainting");
 37 | KNOB<string> KnobTaintPointer(KNOB_MODE_WRITEONCE, "pintool", "tp", "none", "Taint Pointer insaddr1,reg1,size1,insaddr2,reg2,size2");
 38 | KNOB<string> KnobTaintReg(KNOB_MODE_WRITEONCE, "pintool", "tr", "none", "Taint Register insaddr1,reg1,regpart1,insaddr2,reg2,regpart2");
 39 | KNOB<string> KnobTaintAddr(KNOB_MODE_WRITEONCE, "pintool", "ta", "none", "Taint Memory Address insaddr1,memaddr1,size1,insaddr2,memaddr2,size2");
 40 | 
 41 | 
 42 | bool Instrumenter::init(int argc, char** argv) {
 43 |     
 44 |     if (PIN_Init(argc, argv))
 45 |         return false;
 46 |     
 47 |     isEngineRunning = false;
 48 |     isSERunning = false;
 49 |     isRegsCleared = false;
 50 |     resultFile.open("results.ta");
 51 |     
 52 |     parseCmdLine();
 53 |     
 54 |     PIN_InitSymbols();
 55 |     PIN_SetSyntaxIntel();
 56 |     IMG_AddInstrumentFunction(imgInstFunc, 0);
 57 |     INS_AddInstrumentFunction(insInstFunc, 0);
 58 |     PIN_AddSyscallEntryFunction(sysCallInstFunc, 0);
 59 |     PIN_AddFiniFunction(programFinFunc, 0);
 60 |     return true;
 61 | }
 62 | 
 63 | void Instrumenter::parseCmdLine() {
 64 |     vector<string>tpointers;
 65 |     vector<string>tregs;
 66 |     vector<string>taddrs;
 67 |     
 68 |     /*
 69 |     cout << hex << KnobSIB.Value() << endl;
 70 |     cout << hex << KnobTaintStart.Value() << endl;
 71 |     cout << hex << KnobTaintStop.Value() << endl;
 72 |     cout << KnobTaintPointer.Value() << endl;
 73 |     cout << KnobTaintReg.Value() << endl;
 74 |     cout << KnobTaintAddr.Value() << endl;
 75 |     */
 76 |     
 77 |     setStaticImageBase(KnobSIB.Value());
 78 |     startAt(KnobTaintStart.Value());
 79 |     stopAt(KnobTaintStop.Value());
 80 | 
 81 |     /* taint pointers */
 82 |     if(strncmp(KnobTaintPointer.Value().c_str(), "none", 4)) {
 83 |         boost::split(tpointers, KnobTaintPointer.Value(), boost::is_any_of(","));
 84 |         for (int i = 0; i < tpointers.size(); i += 3) {
 85 |             taintAtAddr(strtoul(tpointers[i].c_str(), NULL, 16),
 86 |                         static_cast<RegId>(atoi(tpointers[i+1].c_str())),
 87 |                         strtoul(tpointers[i+2].c_str(), NULL, 16));
 88 |         }
 89 |     }
 90 |     
 91 |     /* taint registers */
 92 |     if(strncmp(KnobTaintReg.Value().c_str(), "none", 4)) {
 93 |         boost::split(tregs, KnobTaintReg.Value(), boost::is_any_of(","));
 94 |         for (int i = 0; i < tregs.size(); i += 3) {
 95 |             taintAtAddr(strtoul(tregs[i].c_str(), NULL, 16),
 96 |                         static_cast<RegId>(atoi(tregs[i+1].c_str())),
 97 |                         Registers::getRegPartByOrdinal(atoi(tregs[i+2].c_str())));
 98 |         }
 99 |     }
100 |     
101 |     /* taint memories */
102 |     if(strncmp(KnobTaintAddr.Value().c_str(), "none", 4)) {
103 |         boost::split(taddrs, KnobTaintAddr.Value(), boost::is_any_of(","));
104 |         for (int i = 0; i < taddrs.size(); i += 3) {
105 |             taintAtAddr(strtoul(taddrs[i].c_str(), NULL, 16),
106 |                         strtoul(taddrs[i+1].c_str(), NULL, 16),
107 |                         strtoul(taddrs[i+2].c_str(), NULL, 16));
108 |         }
109 |     }
110 | }
111 | 
112 | 
113 | void Instrumenter::insInstFunc(INS ins, void *v) {
114 |     InsData *insData;
115 |     TA_UINT insAddr;
116 |     
117 |     
118 |     if (!INS_Valid(ins))
119 |         return;
120 |     
121 |     insAddr = INS_Address(ins);
122 |     
123 |     /* clear caller save registers */
124 |     if (insAddr > OSX_SHARED_ADDR_SPACE && !isRegsCleared) {
125 |         isRegsCleared = true;
126 |         INS_InsertCall(ins,
127 |                        IPOINT_BEFORE,
128 |                        (AFUNPTR)InstrumentHelper::clearRegs,
129 |                        IARG_CONST_CONTEXT,
130 |                        IARG_PTR, &tainter,
131 |                        IARG_CALL_ORDER, CALL_ORDER_FIRST,
132 |                        IARG_END);
133 |         
134 |         return;
135 |     }
136 | 
137 |     
138 |     if (!isEngineRunning && insAddr-imgInfo.pieIter == usrCmd.startTaint) {
139 |         isEngineRunning = true;
140 |     }
141 |     
142 |     if (isEngineRunning && insAddr-imgInfo.pieIter == usrCmd.stopTaint) {
143 |         isEngineRunning = false;
144 |     }
145 |     
146 |     if (!isEngineRunning)
147 |         return;
148 |     
149 |     //TODO: check again
150 |     if (INS_IsSyscall(ins)) {
151 |         tainter.untaint(R_RAX, R_TA_QWORD);
152 |         return;
153 |     }
154 |     
155 |     isRegsCleared = false;
156 | 
157 |     insData = new InsData();
158 |     insData->addr = insAddr;
159 |     insData->mnemonic = INS_Disassemble(ins);
160 |     insData->pieIter = imgInfo.pieIter;
161 |     insData->opcode = INS_Opcode(ins);
162 |     insData->size = INS_Size(ins);
163 |     insData->rFile = &resultFile;
164 |     
165 | 
166 |     /* Decide to be instrumented or not */
167 |     INS_InsertCall(ins,
168 |                    IPOINT_BEFORE,
169 |                    (AFUNPTR)checkToBeInst,
170 |                    IARG_CONST_CONTEXT,
171 |                    IARG_INST_PTR,
172 |                    IARG_CALL_ORDER, CALL_ORDER_FIRST,
173 |                    IARG_END);
174 | 
175 | 
176 |     /* Taint and follow instructions */
177 |     if (INS_OperandCount(ins) > 1) {
178 |         if (INS_MemoryOperandCount(ins) > 0 ) {
179 |             if (INS_MemoryOperandIsRead(ins, 0) && INS_OperandIsReg(ins, 0)) {
180 |                 INS_InsertCall(ins,
181 |                                IPOINT_BEFORE,
182 |                                (AFUNPTR)InstrumentHelper::taintMemToReg,
183 |                                IARG_CONST_CONTEXT,
184 |                                IARG_PTR, insData,
185 |                                IARG_PTR, &tainter,
186 |                                IARG_MEMORYOP_EA, 0,
187 |                                IARG_UINT32, REG(INS_OperandReg(ins, 0)),
188 |                                IARG_CALL_ORDER, CALL_ORDER_FIRST+1,
189 |                                IARG_END);
190 |             } else if (INS_MemoryOperandIsWritten(ins, 0)) {
191 |                 if (INS_OperandCount(ins) == 2) {
192 |                     if (INS_OperandIsImmediate(ins, 1)) {
193 |                         INS_InsertCall(ins,
194 |                                        IPOINT_BEFORE,
195 |                                        (AFUNPTR)InstrumentHelper::taintImmToMem,
196 |                                        IARG_CONST_CONTEXT,
197 |                                        IARG_PTR, insData,
198 |                                        IARG_PTR, &tainter,
199 |                                        IARG_MEMORYOP_EA, 0,
200 |                                        IARG_UINT32, INS_MemoryOperandSize(ins, 0),
201 |                                        IARG_CALL_ORDER, CALL_ORDER_FIRST+1,
202 |                                        IARG_END);
203 |                     } else if (INS_OperandIsReg(ins, 1)) {
204 |                         INS_InsertCall(ins,
205 |                                        IPOINT_BEFORE,
206 |                                        (AFUNPTR)InstrumentHelper::taintRegToMem,
207 |                                        IARG_CONST_CONTEXT,
208 |                                        IARG_PTR, insData,
209 |                                        IARG_PTR, &tainter,
210 |                                        IARG_MEMORYOP_EA, 0,
211 |                                        IARG_UINT32, REG(INS_OperandReg(ins, 1)),
212 |                                        IARG_CALL_ORDER, CALL_ORDER_FIRST+1,
213 |                                        IARG_END);
214 |                     }
215 |                 } else if (INS_OperandCount(ins) == 4) {
216 |                     if (INS_OperandIsImmediate(ins, 0)) {
217 |                         INS_InsertCall(ins,
218 |                                        IPOINT_BEFORE,
219 |                                        (AFUNPTR)InstrumentHelper::taintImmToMem,
220 |                                        IARG_CONST_CONTEXT,
221 |                                        IARG_PTR, insData,
222 |                                        IARG_PTR, &tainter,
223 |                                        IARG_MEMORYOP_EA, 0,
224 |                                        IARG_UINT32, INS_MemoryOperandSize(ins, 0),
225 |                                        IARG_CALL_ORDER, CALL_ORDER_FIRST+1,
226 |                                        IARG_END);
227 |                     } else if (INS_OperandIsReg(ins, 0)) {
228 |                         INS_InsertCall(ins,
229 |                                       IPOINT_BEFORE,
230 |                                       (AFUNPTR)InstrumentHelper::taintRegToMem,
231 |                                       IARG_CONST_CONTEXT,
232 |                                       IARG_PTR, insData,
233 |                                       IARG_PTR, &tainter,
234 |                                       IARG_MEMORYOP_EA, 0,
235 |                                       IARG_UINT32, REG(INS_OperandReg(ins, 0)),
236 |                                       IARG_CALL_ORDER, CALL_ORDER_FIRST+1,
237 |                                       IARG_END);
238 |                     }
239 |                 }
240 |             }
241 |         } else if (INS_OperandIsReg(ins, 0)) {
242 |                 if (INS_OperandIsImmediate(ins, 1) && INS_OperandWrittenOnly(ins,0)) {
243 |                     INS_InsertCall(ins,
244 |                                    IPOINT_BEFORE,
245 |                                    (AFUNPTR)InstrumentHelper::taintImmToReg,
246 |                                    IARG_CONST_CONTEXT,
247 |                                    IARG_PTR, insData,
248 |                                    IARG_PTR, &tainter,
249 |                                    IARG_UINT32, REG(INS_OperandReg(ins, 0)),
250 |                                    IARG_CALL_ORDER, CALL_ORDER_FIRST+1,
251 |                                    IARG_END);
252 |                 } else if (INS_OperandIsReg(ins, 1) && INS_OperandWrittenOnly(ins,0)) {
253 |                     INS_InsertCall(ins,
254 |                                    IPOINT_BEFORE,
255 |                                    (AFUNPTR)InstrumentHelper::taintRegToReg,
256 |                                    IARG_CONST_CONTEXT,
257 |                                    IARG_PTR, insData,
258 |                                    IARG_PTR, &tainter,
259 |                                    IARG_UINT32, REG(INS_OperandReg(ins, 0)),
260 |                                    IARG_UINT32, REG(INS_OperandReg(ins, 1)),
261 |                                    IARG_CALL_ORDER, CALL_ORDER_FIRST+1,
262 |                                    IARG_END);
263 |                 }
264 |         }
265 |     } /* end of tainting */
266 |     
267 |     
268 |     TInst* tinst = NULL; // it will be used for concolic execution.
269 |     bool *isAnyTainted;
270 |     isAnyTainted = (bool*) malloc(sizeof(bool));
271 |    
272 | 
273 |     if (INS_IsLea(ins)) {
274 |         
275 |         //catch lea
276 |         INS_InsertCall(ins,
277 |                        IPOINT_BEFORE,
278 |                        (AFUNPTR)InstrumentHelper::analyseLea,
279 |                        IARG_CONST_CONTEXT,
280 |                        IARG_PTR, insData,
281 |                        IARG_PTR, &tainter,
282 |                        IARG_UINT32, INS_OperandMemoryBaseReg(ins,1),
283 |                        IARG_UINT32, INS_OperandMemoryIndexReg(ins,1),
284 |                        IARG_ADDRINT, INS_OperandMemoryDisplacement(ins, 1),
285 |                        IARG_UINT32, INS_OperandMemoryScale(ins,1),
286 |                        IARG_PTR, tinst,
287 |                        IARG_PTR, isAnyTainted,
288 |                        IARG_CALL_ORDER, CALL_ORDER_FIRST+2,
289 |                        IARG_END);
290 |         
291 |     } else {
292 |         //look for memory operands
293 |         if (INS_IsStandardMemop(ins) || INS_HasMemoryVector(ins)) {
294 |             for (int i = 0; i < INS_MemoryOperandCount(ins); i++) {                
295 |                 INS_InsertCall(ins,
296 |                                IPOINT_BEFORE,
297 |                                (AFUNPTR)InstrumentHelper::analyseMem,
298 |                                IARG_CONST_CONTEXT,
299 |                                IARG_PTR, insData,
300 |                                IARG_PTR, &tainter,
301 |                                IARG_MEMORYOP_EA, i,
302 |                                IARG_UINT32, INS_MemoryOperandSize(ins, i),
303 |                                IARG_PTR, tinst,
304 |                                IARG_PTR, isAnyTainted,
305 |                                IARG_CALL_ORDER, CALL_ORDER_FIRST+2,
306 |                                IARG_END);
307 |             }
308 |         }
309 |         
310 |         
311 |         //look for register operands
312 |         for (int i = 0; i < INS_OperandCount(ins); i++) {
313 |             if(INS_OperandIsReg(ins, i)) {
314 |                 INS_InsertCall(ins,
315 |                                IPOINT_BEFORE,
316 |                                (AFUNPTR)InstrumentHelper::analyseReg,
317 |                                IARG_CONST_CONTEXT,
318 |                                IARG_PTR, insData,
319 |                                IARG_PTR, &tainter,
320 |                                IARG_UINT32, REG(INS_OperandReg(ins, i)),
321 |                                IARG_PTR, tinst,
322 |                                IARG_PTR, isAnyTainted,
323 |                                IARG_CALL_ORDER, CALL_ORDER_FIRST+2,
324 |                                IARG_END);
325 |             }
326 |         }
327 |         
328 |         
329 |         //process tinst
330 |         INS_InsertCall(ins,
331 |                        IPOINT_BEFORE,
332 |                        (AFUNPTR)InstrumentHelper::processTInst,
333 |                        IARG_CONST_CONTEXT,
334 |                        IARG_PTR, insData,
335 |                        IARG_PTR, &tainter,
336 |                        IARG_PTR, tinst,
337 |                        IARG_PTR, isAnyTainted,
338 |                        IARG_CALL_ORDER, CALL_ORDER_FIRST+3,
339 |                        IARG_END);
340 |     }
341 | }
342 | 
343 | void Instrumenter::imgInstFunc(IMG img, void *v) {
344 |     
345 |     if (IMG_LowAddress(img) > OSX_SHARED_ADDR_SPACE)
346 |         return;
347 |     
348 |     /* calculate pie iterator */
349 |     imgInfo.imageBase = IMG_LowAddress(img);
350 |     imgInfo.pieIter = imgInfo.imageBase - imgInfo.staticImageBase;
351 |     
352 |     std::cout << "Dynamic IMG Base: 0x" << std::hex << imgInfo.imageBase << std::endl;
353 |     std::cout << "Static Base: 0x" << std::hex << imgInfo.staticImageBase << std::endl;
354 |     std::cout << "PIE Iterator: 0x" << std::hex << imgInfo.pieIter << std::endl;
355 | }
356 | 
357 | 
358 | void Instrumenter::checkToBeInst(const CONTEXT* ctxt, TA_UINT instAddr) {
359 | 
360 |     TA_UINT regVal = 0;
361 | 
362 |     //pointers
363 |     for (list<TPtr>::iterator i = pointersToBeTainted.begin(); i != pointersToBeTainted.end(); i++) {
364 |         if (i->instAddr + imgInfo.pieIter == instAddr) {
365 |             regVal = 0;
366 |             PIN_GetContextRegval(ctxt, Registers::convertPINReg(i->reg), (UINT8*)&regVal);
367 |             tainter.taint(regVal, i->msize);
368 |         }
369 |     }
370 |     
371 |     for (list<TPtr>::iterator i = pointersToBeUntainted.begin(); i != pointersToBeUntainted.end(); i++)
372 |         if (i->instAddr + imgInfo.pieIter == instAddr) {
373 |             regVal = 0;
374 |             PIN_GetContextRegval(ctxt, Registers::convertPINReg(i->reg), (UINT8*)&regVal);
375 |             tainter.untaint(regVal, i->msize);
376 |         }
377 |     
378 |     //addresses
379 |     for (list<TAddr>::iterator i = addrsToBeTainted.begin(); i != addrsToBeTainted.end(); i++)
380 |         if (i->instAddr + imgInfo.pieIter == instAddr) {
381 |             tainter.taint(i->memAddr, i->msize);
382 |         }
383 |     
384 |     for (list<TAddr>::iterator i = addrsToBeUntainted.begin(); i != addrsToBeUntainted.end(); i++)
385 |         if (i->instAddr + imgInfo.pieIter == instAddr)
386 |             tainter.untaint(i->memAddr, i->msize);
387 |     
388 |     //registers
389 |     for (list<TReg>::iterator i = regsToBeTainted.begin(); i != regsToBeTainted.end(); i++)
390 |         if (i->instAddr + imgInfo.pieIter == instAddr) {
391 |             tainter.taint(i->reg, i->rp);
392 |         }
393 |     
394 |     for (list<TReg>::iterator i = regsToBeUntainted.begin(); i != regsToBeUntainted.end(); i++)
395 |         if (i->instAddr + imgInfo.pieIter == instAddr) {
396 |             tainter.untaint(i->reg, i->rp);
397 |         }
398 | }
399 | 
400 | void Instrumenter::programFinFunc(int code, void *v) {
401 |     std::cout << "Program finished." << std::endl;
402 |     
403 |     resultFile.close();
404 | }
405 | 
406 | void Instrumenter::setStaticImageBase(TA_UINT imgbase) {
407 |     imgInfo.staticImageBase = imgbase;
408 | }
409 | 
410 | void Instrumenter::taintAtAddr(TA_UINT instAddr, TA_UINT memAddr, TA_UINT msize) {
411 |     TAddr taddr;
412 |     taddr.instAddr = instAddr;
413 |     taddr.memAddr = memAddr;
414 |     taddr.msize = msize;
415 |     addrsToBeTainted.push_back(taddr);
416 | }
417 | 
418 | void Instrumenter::taintAtAddr(TA_UINT instAddr, RegId reg, RegPart rp) {
419 |     TReg treg;
420 |     treg.instAddr = instAddr;
421 |     treg.reg = reg;
422 |     treg.rp = rp;
423 |     regsToBeTainted.push_back(treg);
424 | }
425 | 
426 | void Instrumenter::unTaintAtAddr(TA_UINT instAddr, TA_UINT memAddr, TA_UINT msize) {
427 |     TAddr taddr;
428 |     taddr.instAddr = instAddr;
429 |     taddr.memAddr = memAddr;
430 |     taddr.msize = msize;
431 |     addrsToBeUntainted.push_back(taddr);
432 | }
433 | 
434 | void Instrumenter::unTaintAtAddr(TA_UINT instAddr, RegId reg, RegPart rp) {
435 |     TReg treg;
436 |     treg.instAddr = instAddr;
437 |     treg.reg = reg;
438 |     treg.rp = rp;
439 |     regsToBeUntainted.push_back(treg);
440 | }
441 | 
442 | void Instrumenter::taintAtAddr(TA_UINT instAddr, RegId reg, TA_UINT msize) {
443 |     TPtr tptr;
444 |     tptr.instAddr = instAddr;
445 |     tptr.reg = reg;
446 |     tptr.msize = msize;
447 |     pointersToBeTainted.push_back(tptr);
448 | }
449 | 
450 | void Instrumenter::unTaintAtAddr(TA_UINT instAddr, RegId reg, TA_UINT msize) {
451 |     TPtr tptr;
452 |     tptr.instAddr = instAddr;
453 |     tptr.reg = reg;
454 |     tptr.msize = msize;
455 |     pointersToBeUntainted.push_back(tptr);
456 | }
457 | 
458 | void Instrumenter::sysCallInstFunc(THREADID thread_id, CONTEXT *ctxt, SYSCALL_STANDARD std, void *v) {
459 |     if (isEngineRunning)
460 |         cout << "Syscall Number: 0x" << std::hex << PIN_GetSyscallNumber(ctxt, std) << std::endl;
461 |     /*
462 |     if (PIN_GetSyscallNumber(ctxt, std) == (0x2000000 + (TA_UINT)SYS_read)) {
463 |         ;
464 |     }
465 |      */
466 | }
467 | 
468 | std::string Instrumenter::getRelativeAddr(TA_UINT virtualAddr, TA_UINT baseAddr) {
469 |     long long int rAddr;
470 |     std::stringstream result;
471 |     
472 |     rAddr = virtualAddr - baseAddr;
473 |     
474 |     if (rAddr < 0)
475 |         result << "-0x" << std::hex << -rAddr;
476 |     else
477 |         result << "0x" << std::hex << rAddr;
478 |     
479 |     return result.str();
480 | }
481 | 
482 | 
483 | void Instrumenter::startAt(TA_UINT addr) {
484 |     usrCmd.startTaint = addr;
485 | }
486 | 
487 | void Instrumenter::stopAt(TA_UINT addr) {
488 |     usrCmd.stopTaint = addr;
489 | }
490 | 
491 | void Instrumenter::runProgram() {
492 |     PIN_StartProgram();
493 | }
494 | 
495 | void Instrumenter::clean() {
496 |     ;
497 | }
498 | 
499 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  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 |     {one line to give the program's name and a brief idea of what it does.}
635 |     Copyright (C) {year}  {name of author}
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 <http://www.gnu.org/licenses/>.
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 |     {project}  Copyright (C) {year}  {fullname}
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 | <http://www.gnu.org/licenses/>.
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 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------