├── .gitignore ├── mcrits.mtz ├── transforms ├── relatedpcaps.py ├── relatedsamples.py ├── relatedcertificates.py ├── relatedevents.py ├── relateddomains.py ├── relatedrawdatas.py ├── relatedscreenshots.py ├── relatedips.py ├── relatedemails.py ├── relatedactors.py ├── relatedindicators.py ├── relatedcampaigns.py ├── mcrits_utils.py └── MaltegoTransform.py ├── README.md └── LICENSE.md /.gitignore: -------------------------------------------------------------------------------- 1 | *.swp 2 | *.pyc 3 | local/mcrits.conf 4 | -------------------------------------------------------------------------------- /mcrits.mtz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/brianwarehime/mcrits/HEAD/mcrits.mtz -------------------------------------------------------------------------------- /transforms/relatedpcaps.py: -------------------------------------------------------------------------------- 1 | from MaltegoTransform import * 2 | from mcrits_utils import * 3 | 4 | crits = mcrits() 5 | 6 | me = MaltegoTransform() 7 | me.parseArguments(sys.argv) 8 | id_ = me.getVar('id') 9 | crits_type = me.getVar('crits_type') 10 | 11 | for result in crits.get_related(crits_type, id_, 'PCAP'): 12 | me.addEntity(result[0], result[1]) 13 | 14 | me.returnOutput() 15 | -------------------------------------------------------------------------------- /transforms/relatedsamples.py: -------------------------------------------------------------------------------- 1 | from MaltegoTransform import * 2 | from mcrits_utils import * 3 | 4 | crits = mcrits() 5 | 6 | me = MaltegoTransform() 7 | me.parseArguments(sys.argv) 8 | id_ = me.getVar('id') 9 | crits_type = me.getVar('crits_type') 10 | 11 | for result in crits.get_related(crits_type, id_, 'Sample'): 12 | me.addEntity(result[0], result[1]) 13 | 14 | me.returnOutput() 15 | -------------------------------------------------------------------------------- /transforms/relatedcertificates.py: -------------------------------------------------------------------------------- 1 | from MaltegoTransform import * 2 | from mcrits_utils import * 3 | 4 | crits = mcrits() 5 | 6 | me = MaltegoTransform() 7 | me.parseArguments(sys.argv) 8 | id_ = me.getVar('id') 9 | crits_type = me.getVar('crits_type') 10 | 11 | for result in crits.get_related(crits_type, id_, 'Certificate'): 12 | me.addEntity(result[0], result[1]) 13 | 14 | me.returnOutput() 15 | -------------------------------------------------------------------------------- /transforms/relatedevents.py: -------------------------------------------------------------------------------- 1 | from MaltegoTransform import * 2 | from mcrits_utils import * 3 | 4 | crits = mcrits() 5 | 6 | me = MaltegoTransform() 7 | me.parseArguments(sys.argv) 8 | id_ = me.getVar('id') 9 | crits_type = me.getVar('crits_type') 10 | 11 | for result in crits.get_related(crits_type, id_, 'Event'): 12 | # For each related object, get the details. 13 | obj = crits.get_single_obj('Event', result[1]) 14 | ent = me.addEntity(result[0], obj['title']) 15 | ent.addAdditionalFields(fieldName='id', 16 | displayName='id', 17 | value=result[1]) 18 | 19 | me.returnOutput() 20 | -------------------------------------------------------------------------------- /transforms/relateddomains.py: -------------------------------------------------------------------------------- 1 | from MaltegoTransform import * 2 | from mcrits_utils import * 3 | 4 | crits = mcrits() 5 | 6 | me = MaltegoTransform() 7 | me.parseArguments(sys.argv) 8 | id_ = me.getVar('id') 9 | crits_type = me.getVar('crits_type') 10 | 11 | for result in crits.get_related(crits_type, id_, 'Domain'): 12 | # For each related object, get the details. 13 | obj = crits.get_single_obj('Domain', result[1]) 14 | ent = me.addEntity(result[0], obj['domain']) 15 | ent.addAdditionalFields(fieldName='id', 16 | displayName='id', 17 | value=result[1]) 18 | 19 | me.returnOutput() 20 | -------------------------------------------------------------------------------- /transforms/relatedrawdatas.py: -------------------------------------------------------------------------------- 1 | from MaltegoTransform import * 2 | from mcrits_utils import * 3 | 4 | crits = mcrits() 5 | 6 | me = MaltegoTransform() 7 | me.parseArguments(sys.argv) 8 | id_ = me.getVar('id') 9 | crits_type = me.getVar('crits_type') 10 | 11 | for result in crits.get_related(crits_type, id_, 'RawData'): 12 | # For each related object, get the details. 13 | obj = crits.get_single_obj('RawData', result[1]) 14 | ent = me.addEntity(result[0], result[1]) 15 | ent.addAdditionalFields(fieldName='title', 16 | displayName='Title', 17 | value=obj['title']) 18 | 19 | me.returnOutput() 20 | -------------------------------------------------------------------------------- /transforms/relatedscreenshots.py: -------------------------------------------------------------------------------- 1 | from MaltegoTransform import * 2 | from mcrits_utils import * 3 | 4 | crits = mcrits() 5 | 6 | me = MaltegoTransform() 7 | me.parseArguments(sys.argv) 8 | id_ = me.getVar('id') 9 | crits_type = me.getVar('crits_type') 10 | 11 | # While rare, screenshots can actually be related to other objects. 12 | for result in crits.get_related(crits_type, id_, 'Screenshot'): 13 | me.addEntity(result[0], result[1]) 14 | 15 | # They are more commonly stored as a list of IDs in a given object. 16 | obj = crits.get_single_obj(crits_type, id_) 17 | for screenshot in obj.get('screenshots', []): 18 | me.addEntity('mcrits.Screenshot', screenshot) 19 | 20 | me.returnOutput() 21 | -------------------------------------------------------------------------------- /transforms/relatedips.py: -------------------------------------------------------------------------------- 1 | from MaltegoTransform import * 2 | from mcrits_utils import * 3 | 4 | crits = mcrits() 5 | 6 | me = MaltegoTransform() 7 | me.parseArguments(sys.argv) 8 | id_ = me.getVar('id') 9 | crits_type = me.getVar('crits_type') 10 | 11 | for result in crits.get_related(crits_type, id_, 'IP'): 12 | # For each related object, get the details. 13 | obj = crits.get_single_obj('IP', result[1]) 14 | ent = me.addEntity(result[0], result[1]) 15 | ent.addAdditionalFields(fieldName='ip', 16 | displayName='IP', 17 | value=obj['ip']) 18 | ent.addAdditionalFields(fieldName='type', 19 | displayName='Type', 20 | value=obj['type']) 21 | 22 | me.returnOutput() 23 | -------------------------------------------------------------------------------- /transforms/relatedemails.py: -------------------------------------------------------------------------------- 1 | from MaltegoTransform import * 2 | from mcrits_utils import * 3 | 4 | crits = mcrits() 5 | 6 | me = MaltegoTransform() 7 | me.parseArguments(sys.argv) 8 | id_ = me.getVar('id') 9 | crits_type = me.getVar('crits_type') 10 | 11 | for result in crits.get_related(crits_type, id_, 'Email'): 12 | # For each related object, get the details. 13 | obj = crits.get_single_obj('Email', result[1]) 14 | ent = me.addEntity(result[0], result[1]) 15 | ent.addAdditionalFields(fieldName='date', 16 | displayName='Date', 17 | value=obj['date']) 18 | ent.addAdditionalFields(fieldName='from', 19 | displayName='From', 20 | value=obj['from']) 21 | ent.addAdditionalFields(fieldName='subject', 22 | displayName='subject', 23 | value=obj['subject']) 24 | 25 | me.returnOutput() 26 | -------------------------------------------------------------------------------- /transforms/relatedactors.py: -------------------------------------------------------------------------------- 1 | from MaltegoTransform import * 2 | from mcrits_utils import * 3 | 4 | crits = mcrits() 5 | 6 | me = MaltegoTransform() 7 | me.parseArguments(sys.argv) 8 | id_ = me.getVar('id') 9 | crits_type = me.getVar('crits_type') 10 | 11 | for result in crits.get_related(crits_type, id_, 'Actor'): 12 | # For each related object, get the details. 13 | obj = crits.get_single_obj('Actor', result[1]) 14 | ent = me.addEntity(result[0], obj['name']) 15 | ent.addAdditionalFields(fieldName='id', 16 | displayName='id', 17 | value=result[1]) 18 | ent.addAdditionalFields(fieldName='aliases', 19 | displayName='Aliases', 20 | value=obj['aliases']) 21 | ent.addAdditionalFields(fieldName='identifiers', 22 | displayName='Identifiers', 23 | value=obj['identifiers']) 24 | 25 | me.returnOutput() 26 | -------------------------------------------------------------------------------- /transforms/relatedindicators.py: -------------------------------------------------------------------------------- 1 | from MaltegoTransform import * 2 | from mcrits_utils import * 3 | 4 | crits = mcrits() 5 | 6 | me = MaltegoTransform() 7 | me.parseArguments(sys.argv) 8 | id_ = me.getVar('id') 9 | crits_type = me.getVar('crits_type') 10 | 11 | for result in crits.get_related(crits_type, id_, 'Indicator'): 12 | # For each related object, get the details. 13 | obj = crits.get_single_obj('Indicator', result[1]) 14 | ent = me.addEntity(result[0], obj['value']) 15 | ent.addAdditionalFields(fieldName='id', 16 | displayName='id', 17 | value=result[1]) 18 | ent.addAdditionalFields(fieldName='ind_type', 19 | displayName='Indicator Type', 20 | value=obj['type']) 21 | ent.addAdditionalFields(fieldName='value', 22 | displayName='Indicator Value', 23 | value=obj['value']) 24 | 25 | me.returnOutput() 26 | -------------------------------------------------------------------------------- /transforms/relatedcampaigns.py: -------------------------------------------------------------------------------- 1 | from MaltegoTransform import * 2 | from mcrits_utils import * 3 | 4 | crits = mcrits() 5 | 6 | me = MaltegoTransform() 7 | me.parseArguments(sys.argv) 8 | id_ = me.getVar('id') 9 | crits_type = me.getVar('crits_type') 10 | 11 | if id_ == crits._NEED_ID: 12 | me.returnOutput() 13 | 14 | # Because we can get campaigns from two places (tagged vs related) 15 | # we need to store the mapping of id to name to make sure we don't 16 | # create two entities for the same campaign if both tagged and related. 17 | campaigns = {} 18 | 19 | # Campaigns can be used to tag objects, but also related to an object. 20 | # The loop walks each campaign this object is tagged with and fetches the 21 | # campaign object from crits via name. If the name and id are not in the 22 | # dictionary create an entity for it. 23 | obj = crits.get_single_obj(crits_type, id_) 24 | for campaign in obj.get('campaign', []): 25 | # Should only ever be one of these. 26 | campaign_obj = crits.crits.campaign_by_name(campaign['name'])[0] 27 | if (campaign['name'] in campaigns and 28 | campaigns[campaign['name']] == campaign_obj['_id']): 29 | # Repeat campaign, skip it. 30 | continue 31 | 32 | campaigns[campaign['name']] = campaign_obj['_id'] 33 | 34 | ent = me.addEntity('mcrits.Campaign', campaign['name']) 35 | ent.addAdditionalFields(fieldName='id', 36 | displayName=campaign_obj['_id'], 37 | value=campaign_obj['_id']) 38 | 39 | # This loop is the inverse of the above. For each related campaign use the 40 | # id to get the name. 41 | for result in crits.get_related(crits_type, id_, 'Campaign'): 42 | # For each related Campaign, get the name. 43 | campaignname = crits.crits.campaign(result[1])['name'] 44 | if (campaignname in campaigns and 45 | campaigns[campaignname] == result[1]): 46 | # Repeat campaign, skip it. 47 | continue 48 | 49 | campaigns[campaignname] = result[1] 50 | 51 | ent = me.addEntity(result[0], campaignname) 52 | ent.addAdditionalFields(fieldName='id', 53 | displayName=result[1], 54 | value=result[1]) 55 | 56 | me.returnOutput() 57 | -------------------------------------------------------------------------------- /transforms/mcrits_utils.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | import ConfigParser 4 | 5 | from pycrits import pycrits 6 | 7 | class mcrits(object): 8 | def __init__(self): 9 | self.crits = self.get_crits() 10 | # Default string if no ID provided. 11 | self._NEED_ID = 'NEED ID' 12 | self._get_single_obj = { 13 | 'Sample': self.crits.sample, 14 | 'PCAP': self.crits.pcap, 15 | 'Campaign': self.crits.campaign, 16 | 'Indicator': self.crits.indicator, 17 | 'Domain': self.crits.domain, 18 | 'Event': self.crits.event, 19 | 'Certificate': self.crits.certificate, 20 | 'Email': self.crits.email, 21 | 'IP': self.crits.ip, 22 | 'RawData': self.crits.raw_data, 23 | 'Screenshot': self.crits.screenshot, 24 | 'Actor': self.crits.actor 25 | } 26 | 27 | self._get_multi_obj = { 28 | 'Sample': self.crits.samples, 29 | 'PCAP': self.crits.pcaps, 30 | 'Campaign': self.crits.campaigns, 31 | 'Indicator': self.crits.indicators, 32 | 'Domain': self.crits.domains, 33 | 'Event': self.crits.events, 34 | 'Certificate': self.crits.certificates, 35 | 'Email': self.crits.emails, 36 | 'IP': self.crits.ips, 37 | 'RawData': self.crits.raw_datas, 38 | 'Screenshot': self.crits.screenshots, 39 | 'Actor': self.crits.actors 40 | } 41 | 42 | def get_crits(self): 43 | configFile = os.path.join(os.path.abspath(os.path.dirname(sys.argv[0])), 44 | '..', 'local', 'mcrits.conf') 45 | config = ConfigParser.SafeConfigParser() 46 | config.read(configFile) 47 | url = config.get('info', 'url') 48 | api_key = config.get('info', 'api_key') 49 | username = config.get('info', 'username') 50 | verify = config.get('info', 'verify') 51 | crits = pycrits(url, username, api_key) 52 | if verify == 'False': 53 | crits.verify = False 54 | return crits 55 | 56 | def get_single_obj(self, crits_type, id_): 57 | func = self._get_single_obj.get(crits_type, None) 58 | if func == None: 59 | return {} 60 | return func(id_) 61 | 62 | def get_multi_obj(self, crits_type, params): 63 | func = self._get_multi_obj.get(crits_type, None) 64 | if func == None: 65 | return [] 66 | return func(params=params) 67 | 68 | # crits_type is the type of the object to fetch. 69 | # id_ is the ID of the object to fetch. 70 | # type_ is the type of objects to get relationships for. 71 | # Return list of tuples [(mcrits.type_, ID)]. 72 | def get_related(self, crits_type, id_, type_): 73 | results = [] 74 | if id_ == self._NEED_ID: 75 | return results 76 | 77 | obj = self.get_single_obj(crits_type, id_) 78 | 79 | for relationship in obj.get('relationships', []): 80 | if relationship['type'] == type_: 81 | results.append(("mcrits.%s" % type_, relationship['value'])) 82 | 83 | # If dealing with a campaign, walk the desired object type and find 84 | # all that are tagged with that campaign too. We already have the 85 | # campaign name in 'obj'. Do a search for all objects of desired 86 | # type tagged with that campaign. 87 | if crits_type == 'Campaign': 88 | params = {'c-campaign.name': obj['name']} 89 | for new_obj in self.get_multi_obj(type_, params): 90 | results.append(("mcrits.%s" % type_, new_obj['_id'])) 91 | return results 92 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Update 2 | This project has been graciously taken over by the guys at MITRE who are working on the CRITs project. You can find new information about this project on the official CRITs github page: https://github.com/crits/mcrits Special thanks to @mjxg and @wxs for their help and support, and ultimate takeover of this project, they'll do more with it than I could and give it the attention it needs. 3 | 4 | 5 | ### mcrits 6 | ##### Visualize CRITs IOC's in Maltego 7 | ------------------------------------------------- 8 | 9 | mcrits is a set of Maltego transforms that enable you to visualize your CRIT's DB, which currently includes the ability to view the current campaigns, the types of indicators in each campaign, as well as the indicators and actors in each campaign. There is an abundance of information available in CRITs, so I'm trying to determine the best way to visualize that in Maltego without overloading the user and maintaining some sort of order. If you have any additions you think would be good to mcrits, please let me know. 10 | 11 | ### Requirements 12 | 13 | ``` 14 | pycrits Python Module 15 | ``` 16 | 17 | ### Installation 18 | 19 | ``` 20 | $ cd /opt 21 | $ git clone git@github.com:brianwarehime/mcrits.git 22 | In Maltego, click on Maltego icon > Import > Import Configuration 23 | Select mcrits.mtz 24 | ``` 25 | 26 | Before running mcrits, you will need to create the configuration file mcrits/local/mcrits.conf. It should look something like this (change username and api_key accordingly). 27 | 28 | ``` 29 | [info] 30 | url = https://crits 31 | username = test 32 | api_key = da39a3ee5e6b4b0d3255bfef95601890afd80709 33 | verify = True 34 | ``` 35 | 36 | You will also need to enable API access for mcrits to be able to use CRITs. This can be done by going into CRITs and clicking on the gear icon in the top left, next, select "CRITs Control Panel", then under "SYSTEM", go into "General". There will be an option about 4 lines down, to "Enable API". Once you enable it, do a quick restart ```service apache2 restart``` and you should be good to go. 37 | 38 | Please note that this was made for *nix/OS X environments, so, if you are using this is Windows or save the transforms in another directory besides /opt, you'll need to follow the guide below to get it working. 39 | 40 | #####Installing in Windows 41 | 42 | Using mcrits in Windows isn't that much work, just a few things you'll need to change. In Maltego, click on the Manage tab, then "Manage Tranforms". Once the dialog pops up, click on the search bar in the top right, then type in "List". This will return all the transforms named "List " which all the transforms for mcrits start with. Go into each of the following transforms: 43 | 44 | List Actors 45 | List Campaigns 46 | List Indicator Types 47 | List Indicators 48 | Click on each one of those, and for each one, in the bottom right, under "Transform Inputs", change the variables to fit your needs. So, change "Command Line" to where Python is, e.g. C:\Python27\python.exe, then "Command Parameters" can stay the same, lastly change "Working Directory" to where you saved the mcrits transforms, e.g. C:\Transforms\mcrits\transforms\ 49 | 50 | After that, you should be good to go. Just run the transforms as normal. 51 | 52 | ### Using mcrits 53 | 54 | After you edited the configuration file and imported the mcrits.mtz file into Maltego, you are ready to go. To get started, from the palette, under mcrits, drag the "CRITs Server" icon into the main graph window. Right-clicking on the CRITs server will allow you to list the current campaigns in your CRITs DB. There are two categories of campaigns that will be displayed under the server, one is the campaigns you define, and the other is an "UNKNOWN" default category that will hold all the indicators that aren't assigned to a campaign. So, once the campaigns are displayed, you can right-click on each campaign to either display the indicator types or the actors belonging to that campaign. For now, the actors are the last-object and there is no more transforms available, however, if you right-click on an indicator type, you can list the indicators belonging to that type and that campaign. Below is a screenshot of a sample environment. 55 | 56 |

57 |

58 | 59 | After you display the indicators from each type, you can then perform the indicator type specific functions you normally can in Maltego, such as Domain to IP, or Email Address to Social Network accounts. 60 | 61 |

62 |

63 | 64 | Once you display the indicators under each type/campaign, you are able to view additional information about each indicator in the right-hand column under "Properties". Below is a snapshot of some of the available fields. 65 | 66 |

67 |

68 | 69 | ### Todo 70 | 71 | - Add relationships to each indicator. When you right-click on an entity, you will be able to view the relationships, which will connect the indicator to other indicators/actors/campaigns that were defined. 72 | 73 | ### Credits 74 | 75 | - Thanks to http://www.flaticon.com/ for the icons used in mcrits 76 | - Thanks to @mjxg and @wxs for their contributions to the project. 77 | 78 | -------------------------------------------------------------------------------- /transforms/MaltegoTransform.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | ####################################################### 3 | # Maltego Python Local Transform Helper # 4 | # Version 0.2 # 5 | # # 6 | # Local transform specification can be found at: # 7 | # http://ctas.paterva.com/view/Specification # 8 | # # 9 | # For more help and other local transforms # 10 | # try the forum or mail me: # 11 | # # 12 | # http://www.paterva.com/forum # 13 | # # 14 | # Andrew MacPherson [ andrew <> Paterva.com ] # 15 | # # 16 | ####################################################### 17 | import sys 18 | 19 | class MaltegoEntity(object): 20 | value = ""; 21 | weight = 100; 22 | displayInformation = None; 23 | additionalFields = []; 24 | iconURL = ""; 25 | entityType = "Phrase" 26 | 27 | def __init__(self,eT=None,v=None): 28 | if (eT is not None): 29 | self.entityType = eT; 30 | if (v is not None): 31 | self.value = sanitise(v); 32 | self.additionalFields = []; 33 | self.displayInformation = None; 34 | 35 | def setType(self,eT=None): 36 | if (eT is not None): 37 | self.entityType = eT; 38 | 39 | def setValue(self,eV=None): 40 | if (eV is not None): 41 | self.value = sanitise(eV); 42 | 43 | def setWeight(self,w=None): 44 | if (w is not None): 45 | self.weight = w; 46 | 47 | def setDisplayInformation(self,di=None): 48 | if (di is not None): 49 | self.displayInformation = di; 50 | 51 | def addAdditionalFields(self,fieldName=None,displayName=None,matchingRule=False,value=None): 52 | self.additionalFields.append([sanitise(fieldName),sanitise(displayName),matchingRule,sanitise(value)]); 53 | 54 | def setIconURL(self,iU=None): 55 | if (iU is not None): 56 | self.iconURL = iU; 57 | 58 | def returnEntity(self): 59 | print ""; 60 | print "" + str(self.value) + ""; 61 | print "" + str(self.weight) + ""; 62 | if (self.displayInformation is not None): 63 | print ""; 64 | if (len(self.additionalFields) > 0): 65 | print ""; 66 | for i in range(len(self.additionalFields)): 67 | if (str(self.additionalFields[i][2]) <> "strict"): 68 | print "" + str(self.additionalFields[i][3]) + ""; 69 | else: 70 | print "" + str(self.additionalFields[i][3]) + ""; 71 | print ""; 72 | if (len(self.iconURL) > 0): 73 | print "" + self.iconURL + ""; 74 | print ""; 75 | 76 | class MaltegoTransform(object): 77 | entities = [] 78 | exceptions = [] 79 | UIMessages = [] 80 | values = {}; 81 | 82 | def __init__(self): 83 | values = {}; 84 | value = None; 85 | 86 | def parseArguments(self,argv): 87 | if (argv[1] is not None): 88 | self.value = argv[1]; 89 | 90 | if (len(argv) > 2): 91 | if (argv[2] is not None): 92 | vars = argv[2].split('#'); 93 | for x in range(0,len(vars)): 94 | vars_values = vars[x].split('=') 95 | if (len(vars_values) == 2): 96 | self.values[vars_values[0]] = vars_values[1]; 97 | 98 | def getValue(self): 99 | if (self.value is not None): 100 | return self.value; 101 | 102 | def getVar(self,varName): 103 | if (varName in self.values.keys()): 104 | if (self.values[varName] is not None): 105 | return self.values[varName]; 106 | 107 | def addEntity(self,enType,enValue): 108 | me = MaltegoEntity(enType,enValue); 109 | self.addEntityToMessage(me); 110 | return self.entities[len(self.entities)-1]; 111 | 112 | def addEntityToMessage(self,maltegoEntity): 113 | self.entities.append(maltegoEntity); 114 | 115 | def addUIMessage(self,message,messageType="Inform"): 116 | self.UIMessages.append([messageType,message]); 117 | 118 | def addException(self,exceptionString): 119 | self.exceptions.append(exceptionString); 120 | 121 | def throwExceptions(self): 122 | print ""; 123 | print ""; 124 | print "" 125 | 126 | for i in range(len(self.exceptions)): 127 | print "" + self.exceptions[i] + ""; 128 | print "" 129 | print ""; 130 | print ""; 131 | exit(); 132 | 133 | def returnOutput(self): 134 | print ""; 135 | print ""; 136 | 137 | print "" 138 | for i in range(len(self.entities)): 139 | self.entities[i].returnEntity(); 140 | print "" 141 | 142 | print "" 143 | for i in range(len(self.UIMessages)): 144 | print "" + self.UIMessages[i][1] + ""; 145 | print "" 146 | 147 | print ""; 148 | print ""; 149 | 150 | def writeSTDERR(self,msg): 151 | sys.stderr.write(str(msg)); 152 | 153 | def heartbeat(self): 154 | self.writeSTDERR("+"); 155 | 156 | def progress(self,percent): 157 | self.writeSTDERR("%" + str(percent)); 158 | 159 | def debug(self,msg): 160 | self.writeSTDERR("D:" + str(msg)); 161 | 162 | 163 | 164 | def sanitise(value): 165 | replace_these = ["&",">","<"]; 166 | replace_with = ["&",">","<"]; 167 | if isinstance(value, list): 168 | for j in range(0, len(value)): 169 | for i in range(0, len(replace_these)): 170 | value[j].replace(replace_these[i], replace_with[i]); 171 | else: 172 | for i in range(0, len(replace_these)): 173 | value.replace(replace_these[i], replace_with[i]); 174 | return value; 175 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | --------------------------------------------------------------------------------