Imported Upstream version 2.0.1+dfsg
[packages/binwalk.git] / API.md
1 Description
2 ===========
3
4 The binwalk python module can be used by any python script to programmatically perform binwalk scans and obtain the results of those scans. 
5
6 The classes, methods and objects in the binwalk modules are documented via pydoc, including examples, so those interested in using the binwalk module are encouraged to look there. However, several common usage examples are provided here to help jump-start development efforts.
7
8
9 Binwalk Scripting
10 =================
11
12 Each of binwalk's features (signature scans, entropy analysis, etc) are implemented as separate modules. These modules can be invoked via the binwalk.core.module.Modules class, which makes scripting trivial through its execute method.
13
14 In fact, the binwalk command line utility can be duplicated nearly entirely with just two lines of code:
15
16 ```python
17 import binwalk
18 binwalk.Modules().execute()
19 ```
20
21 The Modules class constructor as well as the execute method accept both Python args and kwargs corresponding to the normal command line options accepted by the binwalk command line utility, providing a large amount of freedom in how you choose to specify binwalk options (if none are specified, sys.argv is used by default).
22
23 For example, to execute a signature scan, you at the very least have to specify the --signature command line option, as well as a list of files to scan. This can be done in a number of ways:
24
25 ```python
26 binwalk.Modules().execute('firmware1.bin', 'firmware2.bin', signature=True)
27
28 binwalk.Modules().execute('firmware1.bin', 'firmware2.bin', **{'signature' : True})
29         
30 binwalk.Modules().execute(*['firmware1.bin', 'firmware2.bin'], signature=True)
31         
32 binwalk.Modules().execute(*['--signature', 'firmware1.bin', 'firmware2.bin',])
33
34 binwalk.Modules().execute('--signature', 'firmware1.bin', 'firmware2.bin')
35 ```
36
37 All args and kwargs keys/values correspond to binwalk's command line options. Either args or kwargs, or a combination of the two may be used, with the following caveats:
38
39 * All command line switches passed via args must be preceeded by hyphens (not required for kwargs)
40 * All file names must be passed via args, not kwargs
41
42 Accessing Scan Results
43 ======================
44
45 binwalk.Modules.execute returns a list of objects. Each object corresponds to a module that was run. For example, if you specified --signature and --entropy, then both the Signature and Entropy modules would be executed and you would be returned a list of two objects.
46
47 The two attributes of interest for each object are the 'results' and 'errors' objects. Each is a list of binwalk.core.module.Result and binwalk.core.module.Error objects respectively. Each Result or Error object may contain custom attributes set by each module, but are guarunteed to have at least the following attributes (though modules are not required to populate all attributes):
48
49 |  Attribute  | Description |
50 |-------------|-------------|
51 | offset      | The file offset of the result/error (usually unused for errors) |
52 | description | The result/error description, as displayed to the user |
53 | module      | Name of the module that generated the result/error |
54 | file        | The file object of the scanned file |
55 | valid       | Set to True if the result if value, False if invalid (usually unused for errors) |
56 | display     | Set to True to display the result to the user, False to hide it (usually unused for errors) |
57 | extract     | Set to True to flag this result for extraction (not used for errors) |
58 | plot        | Set to Flase to exclude this result from entropy plots (not used for errors) |
59
60 binwalk.core.module.Error has the additional guarunteed attribute:
61
62 |  Attribute  | Description |
63 |-------------|-------------|
64 | exception   | Contains the Python execption object if the encountered error was an exception |
65
66 Thus, scan results and errors can be programatically accessed rather easily:
67
68 ```python
69 for module in binwalk.Modules().execute('firmware1.bin', 'firmware2.bin', signature=True):
70     print ("%s Results:" % module.name)
71     for result in module.results:
72         print ("\t%s    0x%.8X    %s" % (result.file.name, result.offset, result.description))
73 ```
74
75 Module Exceptions
76 =================
77
78 The only expected exception that should be raised by binwalk.Modules is that of binwalk.ModuleException. This exception is thrown only if a required module encountered a fatal error (e.g., one of the specified target files could not be opened):
79
80 ```python
81 try:
82     binwalk.Modules().execute()
83 except binwalk.ModuleException as e:
84     print ("Critical failure:", e)
85 ```