Compiling a configuration file

Compiling the Open Source

Adding support for a new version for an already supported library, requires only to compile a new (*.json) configuration file for it. As Karta is a source code assisted plugin, this process requires you to compile the open source library according to the guidelines of the open source project, together with the specific guidelines that can be found in the compilations directory.

Important: Karta will need two compiled parts for building the configuration

  1. A static library - .a in Linux, and .lib in Windows
  2. A folder containing all of the *.o (in Linux) or *.obj (in Windows) files

Note: Some libraries, such as OpenSSL, are split to several static libraries. In this case you should make sure you found all of the parts for each such static library

Running the script

Now that we have all of the parts, we should run in the command line, using the following arguments:

C:\Users\user\Documents\Karta\src>python --help
usage: [-h] [-D] [-N] [-W]
                            lib-name lib-version dir archive [dir archive ...]

Compiles a *.json configuration file for a specific version of an open source
library, later to be used by Karta's Matcher.

positional arguments:
  lib-name          name (case sensitive) of the open source library
  lib-version       version string (case sensitive) as used by the identifier
  dir archive       directory with the compiled *.o / *.obj files + path to
                    the matching *.a / *.lib file (if didn't use "--no-

optional arguments:
  -h, --help        show this help message and exit
  -D, --debug       set logging level to logging.DEBUG
  -N, --no-archive  extract data from all *.o / *.obj files in the directory
  -W, --windows     signals that the binary was compiled for Windows

Note: The script must be executed from Karta’s src directory.

  1. Name of the open source library (case sensitive)
  2. Version of the library (as will be identified by the identifier script)
  3. Path to the directory that contains the compiled (*.o / *.obj) files
  4. Path to the compiled static library file (if “–no-archive” wasn’t used) In case there are multiple static libraries, simply extend the list of “dir archive” (with archive) or list of “dir” (without archive), depending on the “–no-archive” flag)

The script will ask you for the path to your disassembler (IDA), and will suggest a default path. Enter the path to your disassembler, press ENTER, and a progress bar will show you the progress of the script.

Storing the config file

In the end, a new *.json file will be generated (using the library name + version), and it should be stored together with the rest of the configuration files in the configs directory.

Uploading the config file back to the community :)

So, you created a new config file and it works on your setup, Good Job :)

Please consider submitting it to the community collection of configurations and fingerprints. Feel free to submit it as a pull request for now, and in the future we might update it to a separate repository.