├── .gitignore
├── README.md
├── ida_batch_decompile.py
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
 1 | # Byte-compiled / optimized / DLL files
 2 | __pycache__/
 3 | *.py[cod]
 4 | *$py.class
 5 | 
 6 | # C extensions
 7 | *.so
 8 | 
 9 | # Distribution / packaging
10 | .Python
11 | env/
12 | build/
13 | develop-eggs/
14 | dist/
15 | downloads/
16 | eggs/
17 | .eggs/
18 | lib/
19 | lib64/
20 | parts/
21 | sdist/
22 | var/
23 | *.egg-info/
24 | .installed.cfg
25 | *.egg
26 | 
27 | # PyInstaller
28 | #  Usually these files are written by a python script from a template
29 | #  before PyInstaller builds the exe, so as to inject date/other infos into it.
30 | *.manifest
31 | *.spec
32 | 
33 | # Installer logs
34 | pip-log.txt
35 | pip-delete-this-directory.txt
36 | 
37 | # Unit test / coverage reports
38 | htmlcov/
39 | .tox/
40 | .coverage
41 | .coverage.*
42 | .cache
43 | nosetests.xml
44 | coverage.xml
45 | *,cover
46 | .hypothesis/
47 | 
48 | # Translations
49 | *.mo
50 | *.pot
51 | 
52 | # Django stuff:
53 | *.log
54 | local_settings.py
55 | 
56 | # Flask stuff:
57 | instance/
58 | .webassets-cache
59 | 
60 | # Scrapy stuff:
61 | .scrapy
62 | 
63 | # Sphinx documentation
64 | docs/_build/
65 | 
66 | # PyBuilder
67 | target/
68 | 
69 | # IPython Notebook
70 | .ipynb_checkpoints
71 | 
72 | # pyenv
73 | .python-version
74 | 
75 | # celery beat schedule file
76 | celerybeat-schedule
77 | 
78 | # dotenv
79 | .env
80 | 
81 | # virtualenv
82 | venv/
83 | ENV/
84 | 
85 | # Spyder project settings
86 | .spyderproject
87 | 
88 | # Rope project settings
89 | .ropeproject
90 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # ida-batch_decompile
 2 | 
 3 | *Decompile all the things!*
 4 | 
 5 | IDA Batch Decompile is a plugin for Hex-Ray's IDA Pro that adds the ability to batch decompile multiple files and their imports with additional annotations (xref, stack var size) to the pseudocode .c file
 6 | 
 7 | ![idabatchdecompile](https://cloud.githubusercontent.com/assets/2865694/19421079/a88707d6-93f8-11e6-86b2-483b923f5574.gif)
 8 | 
 9 | 
10 | :baby_chick: pssst! *- *ida-batch_decompile* is also part of project: [unbox](https://github.com/tintinweb/unbox) - a nobrainer commandline tool to unpack and decompile all sorts of things.*
11 | 
12 | # Usage
13 | 
14 | ## idascript (gui mode)
15 | 
16 | 1. open target, wait for analysis to finish
17 | 2. `IDA Pro -> File/Script file... -> <this_python_script>`
18 | 3. `IDA Pro -> File/Produce file-> IdaDecompileBatch ...`
19 | 3. tick `Annotate StackVarSize`, `Annotate Func XRefs`
20 | 4. click `OK` to decompile.
21 | 
22 | Note: File will be saved in target folder as `<target_image_name.c>`
23 | 
24 | ## idascript (cmdline batch mode)
25 | 
26 |     <path_to_ida>/ida(w|w64)(.exe) -B -M -S"<path_to_this_script> \"--option1\" \"--option2\"" "<target>"
27 | 
28 | Note that options need to be quoted with `\"`
29 | 
30 | Available options, see `--help`
31 | 
32 |     --output                        ... output file path
33 |     --annotate-stackvar-size        ... annotate function stack variable sizes
34 |     --annotate-xrefs                ... annotate function xrefs
35 |     --imports                       ... process imports
36 |     --recursive                     ... recursive batch decompile
37 |     --experimental-decompile-cgraph ... experimental: manually decompile function call graph
38 | 
39 | ## Ida Plugin
40 | 
41 | 1. Follow the IDA Pro documentation on how to add python plugins.
42 | 2. `IDA Pro -> File/Produce file -> IdaDecompileBatch ...`
43 | 
44 | # run
45 | 
46 | ### ida console: decompiling dbghelp.dll
47 | 
48 | ```python
49 | [__main__/36908][DEBUG     ] [idabatchdecompile.PLUGIN_ENTRY  ] [+] initializing IdaDecompileBatchPlugin
50 | [__main__/36908][DEBUG     ] [idabatchdecompile.__init__      ] [+] is_windows: True
51 | [__main__/36908][DEBUG     ] [idabatchdecompile.__init__      ] [+] is_ida64: False
52 | [__main__/36908][DEBUG     ] [idabatchdecompile.wait_for_analysis_to_finish] [+] waiting for analysis to finish...
53 | [__main__/36908][DEBUG     ] [idabatchdecompile.wait_for_analysis_to_finish] [+] analysis finished.
54 | [__main__/36908][DEBUG     ] [idabatchdecompile.load_plugin_decompiler] [+] trying to load decompiler plugins
55 | [__main__/36908][DEBUG     ] [idabatchdecompile.load_plugin_decompiler] [+] decompiler plugins loaded.
56 | [__main__/36908][DEBUG     ] [idabatchdecompile.PLUGIN_ENTRY  ] [+] Mode: commandline w/o args
57 | [__main__/36908][DEBUG     ] [idabatchdecompile.set_ctrl      ] [+] IdaDecompileBatchPlugin.set_ctrl(<__main__.IdaDecompileBatchController object at 0x056FCF90>)
58 | [__main__/36908][DEBUG     ] [idabatchdecompile.init          ] [+] IdaDecompileBatchPlugin.init()
59 | [__main__/36908][DEBUG     ] [idabatchdecompile.init          ] [+] setting up menus
60 | [__main__/36908][INFO      ] [idabatchdecompile.PLUGIN_ENTRY  ] [i] IdaDecompileBatch loaded, see Menu: ('File/Produce file/', 'IdaDecompileBatch ...')
61 | ...
62 |  The application has been completely decompiled.
63 | [__main__/36908][DEBUG     ] [idabatchdecompile.decompile_all ] [+] finished decompiling 'dbghelp.dll' as 'dbghelp.c'
64 | ```
65 | 
66 | ### annotated pseudocode: dbghelp.c
67 | 
68 | ```c
69 | //----- (03052800) --------------------------------------------------------
70 | // **** Variables ****
71 | // * stack size: 20
72 | // {"diff_size": 4, "offset_text": "[bp+0h]", "size": 4, "name": " s", "offset": 0}
73 | // {"diff_size": 4, "offset_text": "[bp+4h]", "size": 4, "name": " r", "offset": 4}
74 | // {"diff_size": 4, "offset_text": "[bp+8h]", "size": 4, "name": "arg_0", "offset": 8}
75 | // {"diff_size": 4, "offset_text": "[bp+Ch]", "size": 4, "name": "dwBytes", "offset": 12}
76 | // {"diff_size": 4, "offset_text": "[bp+10h]", "size": 4, "name": "arg_8", "offset": 16}
77 | // *******************
78 | // ***** XREFS *****
79 | // * # 1
80 | // sub_30733D0+30
81 | // *******************
82 | int __stdcall sub_3052800(int a1, SIZE_T dwBytes, int a3)
83 | {
84 |   int result; // eax@17
85 |   HANDLE v4; // eax@21
86 | ...
87 | ```
88 | 
89 | 
90 | //github.com/tintinweb
91 | 


--------------------------------------------------------------------------------
/ida_batch_decompile.py:
--------------------------------------------------------------------------------
  1 | #! /usr/bin/env python
  2 | # -*- coding: UTF-8 -*-
  3 | # Author : <github.com/tintinweb>
  4 | """
  5 | IdaBatchDecompile Plugin and Script adds annotation and batch decompilation functionality to IDA Pro
  6 | 
  7 | * requires hexrays decompiler plugin
  8 | 
  9 | Usage:
 10 | 
 11 | * as idascript in ida gui mode: IDA Pro -> File/Script file... -> IdaDecompileBatch ...
 12 | * as idascript in ida cmdline mode: ida(w|w64) -B -M -S"<path_to_this_script> \"--option1\" \"--option2\"", "<target>"
 13 |  * see --help for options
 14 | * as Plugin: follow ida documentation on how to add python plugins
 15 | 
 16 | """
 17 | import sys
 18 | import json
 19 | import glob
 20 | import subprocess
 21 | import shutil
 22 | import os
 23 | import tempfile
 24 | from optparse import OptionParser
 25 | 
 26 | import idaapi
 27 | import idautils
 28 | from idc import *
 29 | 
 30 | if idaapi.IDA_SDK_VERSION >= 700:
 31 |     import ida_idaapi
 32 |     import ida_kernwin
 33 |     from idaapi import *
 34 |     from idc import *
 35 | 
 36 | import logging
 37 | 
 38 | logger = logging.getLogger(__name__)
 39 | 
 40 | 
 41 | class IdaLocation(object):
 42 |     """ Wrap idautils Function
 43 |     """
 44 | 
 45 |     def __init__(self, location):
 46 |         self.at = location
 47 |         # self.name = GetFunctionName(location)
 48 |         self.name = GetFuncOffset(location)
 49 |         self.start = 0
 50 |         self.end = 0
 51 |         self.func_offset = 0
 52 |         try:
 53 |             _func = idaapi.get_func(location)
 54 |             self.start = _func.startEA
 55 |             self.end = _func.endEA  # ==FindFuncEnd(location)
 56 |             self.func_offset = self.start - self.at
 57 |         except Exception, e:
 58 |             logger.exception(e)
 59 |         if not self.name:
 60 |             self.indirect = True
 61 |         else:
 62 |             self.indirect = False
 63 | 
 64 |     def __repr__(self, *args, **kwargs):
 65 |         return "<Function %r at 0x%x (0x%x::0x%x)>" % (self.name, self.at,
 66 |                                                        self.start, self.end)
 67 | 
 68 |     def get_xrefs(self):
 69 |         return (IdaLocation(x.frm) for x in idautils.XrefsTo(self.at))
 70 | 
 71 |     def get_coderefs(self):
 72 |         return (IdaLocation(frm) for frm in idautils.CodeRefsTo(self.at, 0))
 73 | 
 74 |     def as_dict(self):
 75 |         return {'at': self.at, 'name': self.name}
 76 | 
 77 |     def decompile(self):
 78 |         """ decompile function
 79 |         """
 80 |         try:
 81 |             return idaapi.decompile(self.at)
 82 |         except idaapi.DecompilationFailure, e:
 83 |             return repr(str(e))
 84 |         text = str(idaapi.decompile(self.at)).strip()
 85 |         '''
 86 |         sprintf:
 87 |         Python>for w in idaapi.decompile(0x00001578 ).lvars: print w.name
 88 |             s
 89 |             format
 90 |             result
 91 |         '''
 92 |         # decompile.arguments
 93 |         # for w in idaapi.decompile(0x00001EF0 ).lvars: print w.name
 94 |         if not grep:
 95 |             return text.split('\n')
 96 |         # return all lines 
 97 |         return [line.strip() for line in text.split('\n') if grep in line]
 98 | 
 99 |     def get_function_args(self):
100 |         # find the stack frame
101 |         stack = GetFrame(self.start)
102 |         stack_size = GetStrucSize(stack)
103 |         # figure out all of the variable names
104 |         # base is either ' s' ... saved register or ' r' ... return address
105 |         base = GetMemberOffset(stack, ' s')
106 |         if base == -1:
107 |             base = GetMemberOffset(stack, ' r')
108 |         if base == -1:
109 |             # no ' s' no ' r' assume zero
110 |             base == 0
111 |         stack_vars = []
112 | 
113 |         for memberoffset in xrange(stack_size):
114 |             previous = stack_vars[-1] if len(stack_vars) else None
115 |             var_name = GetMemberName(stack, memberoffset)
116 |             if not var_name or (previous and var_name == previous.get("name")):
117 |                 # skip that entry, already processed
118 |                 continue
119 | 
120 |             offset = GetMemberOffset(stack, var_name) - base
121 |             size = GetMemberSize(stack, memberoffset)
122 |             if previous:
123 |                 diff = offset - previous['offset']
124 |                 previous['diff_size'] = diff
125 |             stack_vars.append({'name': var_name,
126 |                                'offset': offset,
127 |                                'offset_text': '[bp%Xh]' % offset if offset < 0 else '[bp+%Xh]' % offset,
128 |                                'size': size,
129 |                                'diff_size': size})
130 |         return stack_size, stack_vars
131 | 
132 | 
133 | class IdaHelper(object):
134 |     """ Namespace for ida helper functions
135 |     """
136 | 
137 |     @staticmethod
138 |     def get_functions():
139 |         return (IdaLocation(f) for f in idautils.Functions())
140 | 
141 |     @staticmethod
142 |     def get_imports():
143 |         for i in xrange(0, idaapi.get_import_module_qty()):
144 |             name = idaapi.get_import_module_name(i)
145 |             if name:
146 |                 yield name
147 | 
148 |     @staticmethod
149 |     def decompile_full(outfile):
150 |         return idaapi.decompile_many(outfile, None, 0)
151 | 
152 |     @staticmethod
153 |     def annotate_xrefs():
154 |         stats = {'annotated_functions': 0, 'errors': 0}
155 |         for f in IdaHelper.get_functions():
156 |             try:
157 |                 function_comment = GetFunctionCmt(f.start, 0)
158 |                 if '**** XREFS ****' in function_comment:
159 |                     logger.debug("[i] skipping function %r, already annotated." % f.name)
160 |                     continue
161 |                 xrefs = [x.name for x in f.get_coderefs()]
162 |                 comment = []
163 |                 if function_comment:
164 |                     comment.append(function_comment)
165 |                 comment.append("***** XREFS *****")
166 |                 comment.append("* # %d" % len(xrefs))
167 |                 comment.append(', '.join(xrefs))
168 |                 comment.append("*******************")
169 |                 SetFunctionCmt(f.start, '\n'.join(comment), 0)
170 |                 stats['annotated_functions'] += 1
171 |             except Exception as e:
172 |                 print ("Annotate XRefs: %r"%e)
173 |                 stats['errors'] += 1
174 |         print "[+] stats: %r" % stats
175 |         print "[+] Done!"
176 | 
177 |     @staticmethod
178 |     def annotate_functions_with_local_var_size():
179 |         stats = {'annotated_functions': 0, 'errors': 0}
180 |         for f in IdaHelper.get_functions():
181 |             try:
182 |                 function_comment = GetFunctionCmt(f.start, 0)
183 |                 if '**** Variables ****' in function_comment:
184 |                     logger.debug("[i] skipping function %r, already annotated." % f.name)
185 |                     continue
186 |                 size, stack_vars = f.get_function_args()
187 |                 comment = []
188 |                 if function_comment:
189 |                     comment.append(function_comment)
190 |                 comment.append("**** Variables ****")
191 |                 comment.append("* stack size: %s" % size)
192 |                 for s in stack_vars:
193 |                     comment.append(json.dumps(s))
194 |                 comment.append("*******************")
195 |                 SetFunctionCmt(f.start, '\n'.join(comment), 0)
196 |                 stats['annotated_functions'] += 1
197 |             except Exception, e:
198 |                 print ("Annotate Funcs: %r" % e)
199 |                 stats['errors'] += 1
200 |         print "[+] stats: %r" % stats
201 |         print "[+] Done!"
202 | 
203 | 
204 | class IdaDecompileBatchController(object):
205 |     def __init__(self):
206 |         self.is_windows = sys.platform.startswith('win')
207 |         self.is_ida64 = GetIdbPath().endswith(".i64")  # hackhackhack - check if we're ida64 or ida32
208 |         logger.debug("[+] is_windows: %r" % self.is_windows)
209 |         logger.debug("[+] is_ida64: %r" % self.is_ida64)
210 |         self.my_path = os.path.abspath(__file__)
211 |         self.temp_path = None
212 |         self._init_target()
213 |         # settings (form)
214 |         # todo: load from configfile if available.
215 |         self.output_path = None
216 |         self.chk_annotate_stackvar_size = False
217 |         self.chk_annotate_xrefs = False
218 |         self.chk_decompile_imports = False
219 |         self.chk_decompile_imports_recursive = False
220 |         self.chk_decompile_alternative = False
221 |         # self.ida_home = idaapi.idadir(".")
222 |         self.ida_home = GetIdaDirectory()
223 |         # wait for ida analysis to finish
224 |         self.wait_for_analysis_to_finish()
225 |         if not idaapi.init_hexrays_plugin():
226 |             logger.warning("forcing hexrays to load...")
227 |             self.load_plugin_decompiler()
228 |         if not idaapi.init_hexrays_plugin():
229 |             raise Exception("hexrays decompiler is not available :(")
230 | 
231 |     def _init_target(self):
232 |         self.target_path = idc.GetInputFilePath()
233 |         self.target_file = idc.GetInputFile()
234 |         self.target_dir = os.path.split(self.target_path)[0]
235 |         logger.debug("reinitializing target: %r" % self.target_file)
236 | 
237 |     def init_tempdir(self):
238 |         self.temp_path = self.temp_path or tempfile.mkdtemp(prefix="idbc_")
239 |         logger.debug("[i] using tempdir: %r" % self.temp_path)
240 | 
241 |     def remove_tempdir(self):
242 |         if not self.temp_path:
243 |             return
244 |         logger.debug("[i] removing tempdir: %r" % self.temp_path)
245 |         shutil.rmtree(self.temp_path)
246 |         self.temp_path = None
247 | 
248 |     def wait_for_analysis_to_finish(self):
249 |         logger.debug("[+] waiting for analysis to finish...")
250 |         idaapi.autoWait()
251 |         idc.Wait()
252 |         logger.debug("[+] analysis finished.")
253 | 
254 |     def load_plugin_decompiler(self):
255 |         # load decompiler plugins (32 and 64 bits, just let it fail)
256 |         logger.debug("[+] trying to load decompiler plugins")
257 |         if self.is_ida64:
258 |             # 64bit plugins
259 |             idc.RunPlugin("hexx64", 0)
260 |         else:
261 |             # 32bit plugins
262 |             idc.RunPlugin("hexrays", 0)
263 |             idc.RunPlugin("hexarm", 0)
264 |         logger.debug("[+] decompiler plugins loaded.")
265 | 
266 |     def run(self):
267 |         files_decompiled = []
268 |         self._init_target()
269 | 
270 |         if self.chk_decompile_imports:
271 |             self.init_tempdir()
272 |             if self.chk_decompile_imports_recursive:
273 |                 pass
274 |             for image_type, image_name, image_path in self.enumerate_import_images():
275 |                 try:
276 |                     self.exec_ida_batch_decompile(target = image_path, output = self.output_path,
277 |                                                   annotate_stackvar_size = self.chk_annotate_stackvar_size,
278 |                                                   annotate_xrefs = self.chk_annotate_xrefs,
279 |                                                   imports = self.chk_decompile_imports,
280 |                                                   recursive = self.chk_decompile_imports_recursive,
281 |                                                   experimental_decomile_cgraph = self.chk_decompile_alternative)
282 |                     files_decompiled.append(image_path)
283 |                 except subprocess.CalledProcessError, cpe:
284 |                     logger.warning("[!] failed to decompile %r - %r" % (image_path, cpe))
285 | 
286 |             self.remove_tempdir()
287 | 
288 |         if self.chk_annotate_stackvar_size:
289 |             self.annotate_stack_variable_size()
290 |         if self.chk_annotate_xrefs:
291 |             self.annotate_xrefs()
292 | 
293 |         if self.chk_decompile_alternative:
294 |             raise NotImplemented("Not yet implemented")
295 |             pass
296 |         else:
297 |             self.decompile_all(self.output_path)
298 |             files_decompiled.append(self.target_file)
299 | 
300 |         logger.info("[+] finished decompiling: %r" % files_decompiled)
301 |         logger.info("    output dir: %s"%self.output_path if self.output_path else self.target_dir)
302 |         return files_decompiled
303 | 
304 |     def annotate_stack_variable_size(self):
305 |         logger.debug("[+] annotating function stack variables")
306 |         IdaHelper.annotate_functions_with_local_var_size()
307 |         logger.debug("[+] done.")
308 | 
309 |     def annotate_xrefs(self):
310 |         logger.debug("[+] annotating function xrefs")
311 |         IdaHelper.annotate_xrefs()
312 |         logger.debug("[+] done.")
313 | 
314 |     def file_is_decompilable(self, path):
315 |         with open(path, 'rb') as ftest:
316 |             magic = ftest.read(4)
317 |             if magic == 'MZ\x90\x00':
318 |                 return 'pe/dos'
319 |             elif magic == "\x7fELF":
320 |                 return 'elf'
321 |         return None
322 | 
323 |     def enumerate_import_images(self):
324 |         for import_name in IdaHelper.get_imports():
325 |             logger.debug("[i] trying to find image for %r" % import_name)
326 |             for image_path in glob.glob(os.path.join(self.target_dir, import_name) + '*'):
327 |                 image_type = self.file_is_decompilable(image_path)
328 |                 if image_type:
329 |                     logger.debug("[i] got image %r as %r" % (image_path, image_type))
330 |                     yield image_type, os.path.split(image_path)[1], image_path
331 |                     # I do not think there's any need to check other files with the same name ?!
332 |                     break
333 | 
334 |     def enumerate_files(self, recursive=False):
335 |         for root, dirs, files in os.walk(self.target_dir):
336 |             for name in files:
337 |                 fpath = os.path.join(root, name)
338 |                 logger.debug("[+] checking %r" % fpath)
339 |                 try:
340 |                     ftype = self.file_is_decompilable(fpath)
341 |                     if ftype:
342 |                         logger.debug("[+] is candidate %r" % [fpath, ftype])
343 |                         yield ftype, name, fpath
344 |                 except IOError: pass
345 | 
346 |     def decompile_all(self, outfile=None):
347 |         outfile = self._get_suggested_output_filename(outfile or self.target_path)
348 |         logger.warning(outfile)
349 |         logger.debug("[+] trying to decompile %r as %r" % (self.target_file,
350 |                                                            os.path.split(outfile)[1]))
351 |         IdaHelper.decompile_full(outfile)
352 |         logger.debug("[+] finished decompiling %r as %r" % (self.target_file,
353 |                                                             os.path.split(outfile)[1]))
354 | 
355 |     def _get_suggested_output_filename(self, target):
356 |         # /a/b/c/d/e/bin.ext
357 |         # target is a directory
358 |         if os.path.isdir(target):
359 |             fname, fext = os.path.splitext(self.target_file)
360 |             return '%s.c' % os.path.join(target, fname)
361 |         # target is not a directory
362 |         root, fname = os.path.split(target)
363 |         if fname:
364 |             fname, fext = os.path.splitext(fname)  # bin,ext
365 |         else:
366 |             fname, fext = os.path.splitext(self.target_file)
367 | 
368 |         # obsolete
369 |         # suggested_outpath = '%s.c'%os.path.join(root,fname)
370 |         # if not os.path.exists(suggested_outpath):
371 |         #    return suggested_outpath
372 |         return '%s.c' % os.path.join(root, fname)
373 | 
374 |     def exec_ida_batch_decompile(self, target, output, annotate_stackvar_size, annotate_xrefs, imports, recursive,
375 |                                  experimental_decomile_cgraph):
376 |         logger.debug("[+] batch decompile %r" % target)
377 |         # todo: pass commandlines,
378 |         # todo parse commandline
379 |         script_args = ['--output=%s' % output]
380 |         if annotate_stackvar_size:
381 |             script_args.append("--annotate-stackvar-size")
382 |         if annotate_xrefs:
383 |             script_args.append("--annotate-xrefs")
384 |         if imports:
385 |             script_args.append("--imports")
386 |         if recursive:
387 |             script_args.append("--recursive")
388 |         if experimental_decomile_cgraph:
389 |             script_args.append("--experimental-decompile-cgraph")
390 | 
391 |         script_args = ['\\"%s\\"' % a for a in script_args]
392 |         command = "%s %s" % (self.my_path, ' '.join(script_args))
393 |         self._exec_ida_batch(target, command)
394 | 
395 |     def _exec_ida_batch(self, target, command):
396 |         # build exe path
397 |         if self.is_windows:
398 |             ida_exe = os.path.join(self.ida_home, 'idaw64.exe' if self.is_ida64 else 'idaw.exe')
399 |         else:
400 |             ida_exe = os.path.join(self.ida_home, 'idal64' if self.is_ida64 else 'idal')
401 |         '''
402 |         https://www.hex-rays.com/products/ida/support/idadoc/417.shtml
403 |         -B  ..  Batch mode
404 |         -M  ..  disable mouse
405 |         -c  ..  create new database
406 |         -o  ..  database output path
407 |         -S  ..  execute script
408 |         '''
409 |         #temp_path = os.path.join(self.temp_path, os.path.splitext(os.path.split(target)[1])[0] + '.idb')
410 |         cmd = [ida_exe, '-B', '-M', '-c', '-o"%s"'%self.temp_path if self.temp_path else '', '-S"%s"' % command, '"' + target + '"']
411 |         logger.debug(' '.join(cmd))
412 |         logger.debug('[+] executing: %r' % cmd)
413 |         #return 0
414 |         # TODO: INSECURE!
415 |         return subprocess.check_call(' '.join(cmd), shell=True)
416 | 
417 | 
418 | class TestEmbeddedChooserClass(Choose,Choose2):
419 |     """
420 |     A simple chooser to be used as an embedded chooser
421 |     """
422 |     def __init__(self, title, nb = 5, flags=0):
423 |         Choose.__init__(self,
424 |                          title,
425 |                          [["Type", 10], ["Name", 10], ["Path", 30]],
426 |                          flags=flags)
427 |         Choose2.__init__(self,
428 |                          title,
429 |                          [ ["Type", 10], ["Name", 10],  ["Path", 30] ],
430 |                          embedded=True, width=50, height=10, flags=flags)
431 |         self.n = 0
432 |         self.items = []
433 |         self.icon = 5
434 |         self.selcount = 0
435 | 
436 |         self.selected = []
437 | 
438 |     def OnClose(self):
439 |         pass
440 | 
441 |     def OnGetLine(self, n):
442 |         return self.items[n]
443 | 
444 |     def OnGetSize(self):
445 |         n = len(self.items)
446 |         return n
447 | 
448 |     def OnRefresh(self, n):
449 |         print "refresh %s"%n
450 | 
451 |     def OnSelectionChange(self, sel_list):
452 |         self.selected = sel_list
453 | 
454 |     def getSelected(self):
455 |         for idx in self.selected:
456 |             yield self.items[idx-1]
457 | 
458 |     def addItem(self, e):
459 |         if e not in self.items:
460 |             self.items.append(e)
461 | 
462 | 
463 | class DecompileBatchForm(Form):
464 |     """
465 |     Form to prompt for target file, backup file, and the address
466 |     range to save patched bytes.
467 |     """
468 | 
469 |     def __init__(self, idbctrl, enumerate_imports=True, enumerate_other=False):
470 |         self.idbctrl = idbctrl
471 |         self.EChooser = TestEmbeddedChooserClass("Batch Decompile", flags=Choose2.CH_MULTI)
472 |         self.propagateItems(enumerate_imports=enumerate_imports, enumerate_other=enumerate_other)
473 |         Form.__init__(self,
474 |                       r"""Ida Batch Decompile ...
475 | {FormChangeCb}
476 | <##Target    :{target}>
477 | <##OutputPath:{outputPath}>
478 | <##Annotate StackVar Size:{chkAnnotateStackVars}>
479 | <##Annotate Func XRefs   :{chkAnnotateXrefs}>
480 | <##Process Imports       :{chkDecompileImports}>
481 | <##Cgraph (experimental) :{chkDecompileAlternative}>{cGroup1}>
482 | 
483 | 
484 | <##Scan Target Directory:{btnLoad}> <##Recursive:{chkDecompileImportsRecursive}>{cGroup2}>
485 | <##Decompile!:{btnProcessFiles}>
486 | <Please select items to decompile:{cEChooser}>
487 | 
488 | 
489 | """, {
490 |                           'target': Form.FileInput(swidth=50, open=True, value=idbctrl.target_path),
491 |                           'outputPath': Form.DirInput(swidth=50, value=idbctrl.output_path),
492 |                           'cGroup1': Form.ChkGroupControl(("chkAnnotateStackVars", "chkAnnotateXrefs",
493 |                                                            "chkDecompileImports",
494 |                                                            "chkDecompileAlternative")),
495 |                           'cGroup2': Form.ChkGroupControl(("chkDecompileImportsRecursive", )),
496 |                           'FormChangeCb': Form.FormChangeCb(self.OnFormChange),
497 |                           'btnLoad':  Form.ButtonInput(self.OnButtonLoad),
498 |                           'btnProcessFiles': Form.ButtonInput(self.OnButtonProcess),
499 |                           'cEChooser': Form.EmbeddedChooserControl(self.EChooser),
500 |                       })
501 |         self.Compile()
502 | 
503 |     def propagateItems(self, enumerate_imports=False, enumerate_other=False):
504 |         self.EChooser.addItem([self.idbctrl.file_is_decompilable(self.idbctrl.target_path),
505 |                                os.path.split(self.idbctrl.target_path)[1],
506 |                                self.idbctrl.target_path])
507 | 
508 |         if enumerate_imports:
509 |             for candidate in self.idbctrl.enumerate_import_images():
510 |                 self.EChooser.addItem(list(candidate))
511 |         if enumerate_other:
512 |             for candidate in self.idbctrl.enumerate_files(recursive=self.chkDecompileImportsRecursive.checked):
513 |                 self.EChooser.addItem(list(candidate))
514 | 
515 |     def OnButtonProcess(self, code=0):
516 |         ### process selected files
517 |         if not len(list(self.EChooser.getSelected())):
518 |             logger.warning("[!] Aborting. Please select at least one item from the list!")
519 |             return
520 | 
521 |         self.idbctrl.target = self.target.value
522 |         outputPath = self.GetControlValue(self.outputPath)
523 |         if outputPath == '' or os.path.exists(outputPath):
524 |             self.idbctrl.output_path = outputPath
525 |         else:
526 |             logger.warning("[!!] output path not valid! %r" % outputPath)
527 |             self.idbctrl.output_path = None
528 | 
529 |         self.idbctrl.chk_annotate_stackvar_size = self.chkAnnotateStackVars.checked
530 |         self.idbctrl.chk_decompile_imports = self.chkDecompileImports.checked
531 |         self.idbctrl.chk_decompile_imports_recursive = self.chkDecompileImportsRecursive.checked
532 |         self.idbctrl.chk_annotate_xrefs = self.chkAnnotateXrefs.checked
533 |         self.idbctrl.chk_decompile_alternative = self.chkDecompileAlternative.checked
534 |         logger.debug("[+] config updated")
535 | 
536 |         files_decompiled = []
537 |         decompile_main_binary = False
538 | 
539 |         self.idbctrl.init_tempdir()
540 |         for _type, name, image_path in self.EChooser.getSelected():
541 |             if image_path is self.idbctrl.target_path:
542 |                 decompile_main_binary = True
543 |                 continue
544 |             try:
545 |                 self.idbctrl.exec_ida_batch_decompile(target=image_path, output=outputPath,
546 |                                               annotate_stackvar_size=self.idbctrl.chk_annotate_stackvar_size,
547 |                                               annotate_xrefs=self.idbctrl.chk_annotate_xrefs,
548 |                                               imports=self.idbctrl.chk_decompile_imports,
549 |                                               recursive=self.idbctrl.chk_decompile_imports_recursive,
550 |                                               experimental_decomile_cgraph=self.idbctrl.chk_decompile_alternative)
551 |                 files_decompiled.append(image_path)
552 |             except subprocess.CalledProcessError, cpe:
553 |                 logger.warning("[!] failed to decompile %r - %r" % (image_path, cpe))
554 | 
555 |         self.idbctrl.remove_tempdir()
556 |         ## process current file
557 |         if decompile_main_binary:
558 |             # well, loop here even though we know it can only
559 |             logger.debug("[+] decompiling current file...")
560 |             files_decompiled += self.idbctrl.run()  # decompile main binary
561 |             logger.info("[+] finished decompiling: %r" % files_decompiled)
562 |             logger.info("    output dir: %s" % self.idbctrl.output_path if self.idbctrl.output_path else self.idbctrl.target_dir)
563 | 
564 |     def OnButtonLoad(self, code=0):
565 |         self.Close(0)
566 |         self.propagateItems(enumerate_other=True, enumerate_imports=True)
567 |         self.Execute()
568 | 
569 |     def OnFormChange(self, fid):
570 |         # Set initial state
571 |         INIT = -1
572 |         BTN_OK = -2
573 | 
574 |         if fid == INIT:
575 |             self.EnableField(self.target, False)
576 |             self.EnableField(self.outputPath, True)
577 |             self.EnableField(self.chkDecompileAlternative, False)
578 | 
579 |         elif fid == BTN_OK:
580 |             # just return
581 |             return True
582 | 
583 |         # Toggle backup checkbox
584 |         elif fid == self.chkAnnotateStackVars.id:
585 |             self.chkAnnotateStackVars.checked = not self.chkAnnotateStackVars.checked
586 |         elif fid == self.chkDecompileImports.id:
587 |             self.chkDecompileImports.checked = not self.chkDecompileImports.checked
588 |         elif fid == self.chkDecompileImportsRecursive.id:
589 |             self.chkDecompileImportsRecursive.checked = not self.chkDecompileImportsRecursive.checked
590 |         elif fid == self.chkDecompileAlternative.id:
591 |             self.chkDecompileAlternative.checked = not self.chkDecompileAlternative.checked
592 |         elif fid == self.chkAnnotateXrefs.id:
593 |             self.chkAnnotateXrefs.checked = not self.chkAnnotateXrefs.checked
594 | 
595 |         return False
596 | 
597 | 
598 | if idaapi.IDA_SDK_VERSION >= 700:
599 |     class IdaDecompileUiActionHandler(idaapi.action_handler_t):
600 | 
601 |         def __init__(self, caller):
602 |             idaapi.action_handler_t.__init__(self)
603 |             self.caller = caller
604 | 
605 |         def activate(self, ctx):
606 |             self.caller.menu_config()
607 |             return 1
608 | 
609 |         def update(self, ctx):
610 |             return idaapi.AST_ENABLE_ALWAYS
611 | 
612 |             def update(self, ctx):
613 |                 return idaapi.AST_ENABLE_ALWAYS
614 | 
615 | 
616 | class IdaDecompileBatchPlugin(idaapi.plugin_t):
617 |     """ IDA Plugin Base"""
618 |     flags = idaapi.PLUGIN_FIX
619 |     comment = "Batch Decompile"
620 |     help = "github.com/tintinweb"
621 |     wanted_name = "Ida Batch Decompile"
622 |     wanted_hotkey = ""
623 |     wanted_menu = "File/Produce file/", "{} ...".format(wanted_name)
624 |     wanted_menu_id = 'tintinweb:batchdecompile'
625 | 
626 |     def init(self):
627 |         NO_HOTKEY = ""
628 |         SETMENU_INS = 0
629 |         NO_ARGS = tuple()
630 | 
631 |         logger.debug("[+] %s.init()" % self.__class__.__name__)
632 |         self.menuitems = []
633 | 
634 |         logger.debug("[+] setting up menus for ida version %s" % idaapi.IDA_SDK_VERSION)
635 | 
636 |         if idaapi.IDA_SDK_VERSION >= 700:
637 |             # >= 700
638 |             action_desc = idaapi.action_desc_t("tintinweb:batchdecompile:load", self.wanted_name, IdaDecompileUiActionHandler(self))
639 |             idaapi.register_action(action_desc)
640 |             idaapi.attach_action_to_menu(''.join(self.wanted_menu), "tintinweb:batchdecompile:load", idaapi.SETMENU_APP)
641 | 
642 |         else:
643 |             menu = idaapi.add_menu_item(self.wanted_menu[0],
644 |                                         self.wanted_menu[1],
645 |                                         NO_HOTKEY,
646 |                                         SETMENU_INS,
647 |                                         self.menu_config,
648 |                                         NO_ARGS)
649 | 
650 |             self.menuitems.append(menu)
651 | 
652 |         return idaapi.PLUGIN_KEEP
653 | 
654 |     def run(self, arg=None):
655 |         logger.debug("[+] %s.run()" % self.__class__.__name__)
656 | 
657 |     def term(self):
658 |         logger.debug("[+] %s.term()" % self.__class__.__name__)
659 |         if idaapi.IDA_SDK_VERSION < 700:
660 |             for menu in self.menuitems:
661 |                 idaapi.del_menu_item(menu)
662 | 
663 |     def menu_config(self):
664 |         logger.debug("[+] %s.menu_config()" % self.__class__.__name__)
665 |         self.idbctrl._init_target() # force target reinit
666 |         DecompileBatchForm(self.idbctrl).Execute()
667 | 
668 |     def set_ctrl(self, idbctrl):
669 |         logger.debug("[+] %s.set_ctrl(%r)" % (self.__class__.__name__, idbctrl))
670 |         self.idbctrl = idbctrl
671 | 
672 | 
673 | def PLUGIN_ENTRY(mode=None):
674 |     """ check execution mode:
675 | 
676 |         a) as Plugin, return plugin object
677 |         b) as script as part of a batch execution, do not spawn plugin object
678 |      """
679 |     logging.basicConfig(level=logging.DEBUG,
680 |                         format="[%(name)s/%(process)s][%(levelname)-10s] [%(module)s.%(funcName)-14s] %(message)s")
681 |     logger.setLevel(logging.DEBUG)
682 |     # always wait for analysis to finish
683 |     logger.debug("[+] initializing IdaDecompileBatchPlugin")
684 |     # create our controller interface
685 |     idbctrl = IdaDecompileBatchController()
686 |     # parse cmdline
687 |     if mode == '__main__':
688 |         # cmdline mode
689 |         if len(idc.ARGV) > 1:
690 |             # cmdline batch mode
691 |             logger.debug("[+] Mode: commandline")
692 |             parser = OptionParser()
693 |             parser.add_option("-o", "--output", dest="output",
694 |                               help="output path")
695 |             parser.add_option("-S", "--annotate-stackvar-size",
696 |                               action="store_true", default=False,
697 |                               help="Generate stack variable size annotations")
698 |             parser.add_option("-X", "--annotate-xrefs",
699 |                               action="store_true", default=False,
700 |                               help="Generate xref annotations")
701 |             parser.add_option("-I", "--imports",
702 |                               action="store_true", default=False,
703 |                               help="try to decompile files referenced in IAT")
704 |             parser.add_option("-R", "--recursive",
705 |                               action="store_true", default=False,
706 |                               help="Recursive decompile files/imports")
707 |             parser.add_option("-Z", "--experimental-decompile-cgraph",
708 |                               action="store_true", default=False,
709 |                               help="[experimental] decompile funcs referenced in calltree manually")
710 | 
711 |             options, args = parser.parse_args(idc.ARGV[1:])
712 |             # set options
713 |             idbctrl.output_path = options.output
714 |             idbctrl.chk_annotate_stackvar_size = options.annotate_stackvar_size
715 |             idbctrl.chk_annotate_xrefs = options.annotate_xrefs
716 |             idbctrl.chk_decompile_imports = options.imports
717 |             idbctrl.chk_decompile_imports_recursive = options.recursive
718 |             idbctrl.chk_decompile_alternative = options.experimental_decompile_cgraph
719 |             # set all the idbctrl checkboxes and files
720 |             idbctrl.run()
721 |             idc.Exit(0)
722 |             # return
723 | 
724 |         logger.debug("[+] Mode: commandline w/o args")
725 |         # PluginMode
726 |         plugin = IdaDecompileBatchPlugin()
727 |         plugin.set_ctrl(idbctrl=idbctrl)
728 |         plugin.init()
729 |         logger.info("[i] %s loaded, see Menu: %s" % (IdaDecompileBatchPlugin.wanted_name,
730 |                                                      IdaDecompileBatchPlugin.wanted_menu))
731 |         #plugin.menu_config()
732 |         return plugin
733 | 
734 |     else:
735 |         logger.debug("[+] Mode: plugin")
736 |         # PluginMode
737 |         plugin = IdaDecompileBatchPlugin()
738 |         plugin.set_ctrl(idbctrl=idbctrl)
739 |         return plugin
740 | 
741 | 
742 | if __name__ == '__main__':
743 |     PLUGIN_ENTRY(mode=__name__)
744 | 
745 | 


--------------------------------------------------------------------------------
/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 | 


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