capstone

node-capstone

node-capstone provides Node.js bindings for the Capstone disassembler library, allowing binary data in Buffer objects to be disassembled using any of Capstone's supported architectures.

Dependencies

• node.js v0.12.x
  • npm
• Capstone

Install

npm install capstone

libcapstone

The Capstone library is not included, and must be installed separately. The recommended method to install on OSX is using homebrew:

brew install capstone

On Windows and Linux, install a pre-compiled binary from the Capstone download page, or build from source.

Ensure libcapstone is available in your PATH. Additionally, the libcapstone version needs to match the binding's version.

Basic usage

var capstone = require("capstone");
var code = new Buffer([ 0x55, 0x48, 0x8b, 0x05, 0xb8, 0x13, 0x00, 0x00 ]);
 
var cs = new capstone.Cs(capstone.ARCH_X86, capstone.MODE_64);
 
cs.detail = true;
cs.disasm(code, 0x1000).forEach(function (insn) {
    console.log(
        "0x%s:\t%s\t%s\t%s",
        insn.address.toString(16), insn.mnemonic, insn.op_str,
        JSON.stringify(insn.detail)
    );
});
 
cs.close();

For other examples, see the tests in the spec directory.

Full documentation is available at https://parasyte.github.io/node-capstone-docs

License

The source code is hereby released under the MIT License. The full text of the license appears below.

Copyright (c) 2014-2015 Jay Oster

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.