Integration between GTIRB and the Capstone/Keystone libraries

gtirb-capstone

GTIRB-Capstone
==============

Integration between GTIRB and the Capstone/Keystone libraries.

## Abstract
GTIRB explicitly does not include any notion of instructions or
instruction semantics.  In general this is desirable as most tools
have their own intermediate languages and corresponding
encoders/decoders to deal with instructions.  However, in many cases
the high-quality Capstone/Keystone decoder/encoder libraries provide
sufficient instruction information for binary analysis and
transformation.  These libraries provide exceptional coverage of
multiple ISAs and are widely used.  GTIRB-Capstone integrates GTIRB
with the Capstone disassembler and the Keystone assembler allowing for
transparent access to instructions in GTIRB instances.

## Dependencies

This package requires:

 - [keystone](https://github.com/keystone-engine/keystone.git)
   To install keystone run:
   ```
   git clone https://github.com/keystone-engine/keystone.git
   cd keystone
   mkdir build
   cd build
   ../make-share.sh
   make install
   ldconfig
   ```

## Development
You can create a virtual environment for development using tox:
```
tox -e venv
. venv/bin/activate
```

This repository uses pre-commit to enforce code formatting. You should
have pre-commit installed. To activate pre-commit in this repository run:

```
pre-commit install
```

To run the tests execute tox:
```
tox
```

## Copyright and Acknowledgments

Copyright (C) 2020 GrammaTech, Inc.

This code is licensed under the MIT license. See the LICENSE file in
the project root for license terms.

This project is sponsored by the Office of Naval Research, One Liberty
Center, 875 N. Randolph Street, Arlington, VA 22203 under contract #
N68335-17-C-0700.  The content of the information does not necessarily
reflect the position or policy of the Government and no official
endorsement should be inferred.


asdf-package-system

gtirb-capstone/gtirb-capstone

GTIRB explicitly does not include any notion of
instructions or instruction semantics.  In general this is desirable
as most tools have their own intermediate languages and corresponding
encoders/decoders to deal with instructions.  However, in many cases
the high-quality Capstone/Keystone decoder/encoder libraries provide
sufficient instruction information for binary analysis and
transformation.  These libraries provide exceptional coverage of
multiple ISAs and are widely used.  GTIRB-Capstone integrates GTIRB
with the Capstone disassembler and the Keystone assembler allowing for
transparent access to instructions in GTIRB instances.

gtirb-capstone

Upstream URL

Author

License

gtirb-capstone

License:

Authors:

Defsystem Dependencies:

Dependencies:

gtirb-capstone/gtirb-capstone

Dependencies:

Dependencies (7)

Dependents (0)