Metadata-Version: 2.1
Name: zelos-crashd
Version: 0.0.2
Summary: A zelos plugin for crash analysis.
Home-page: https://github.com/zeropointdynamics/zelos-crashd
Author: Zeropoint Dynamics
Author-email: zelos@zeropointdynamics.com
Maintainer: Zeropoint Dynamics
Maintainer-email: zelos@zeropointdynamics.com
License: AGPLv3
Project-URL: Bug Tracker, https://github.com/zeropointdynamics/zelos-crashd/issues
Project-URL: Source Code, https://github.com/zeropointdynamics/zelos-crashd
Description: # Zelos CrasHD Plugin
        
        A plugin for [Zelos](https://github.com/zeropointdynamics/zelos) to enhance crash triaging by performing dataflow & root cause analysis.
        
        ## Optional Prerequisites
        
        This plugin has an optional dependency on the [graphviz](https://pypi.org/project/graphviz/) package to render control flow graphs to png. The graphviz python package can be installed normally via `pip install graphviz`, but will also require [Graphviz](https://www.graphviz.org/) itself to be installed locally as well. Instructions for installing Graphviz locally can be found [here](https://graphviz.org/download/). 
        
        If you do not wish to install the graphviz package or Graphviz, you can safely ignore this optional dependency and zelos-crashd will still work as intended, but control flow graphs will not be rendered to png.
        
        ## Installation
        
        Install from pypi
        ```console
        $ pip install zelos-crashd
        ```
        
        Or install directly from the repo
        ```console
        $ git clone https://github.com/zeropointdynamics/zelos-crashd.git
        $ cd zelos-crashd
        $ pip install .
        ```
        
        Alternatively, install an _editable_ version for development
        ```console
        $ git clone https://github.com/zeropointdynamics/zelos-crashd.git
        $ cd zelos-crashd
        $ pip install -e '.[dev]'
        ```
        
        ## Related Resources
        
        [CrasHD Visualizer](https://github.com/zeropointdynamics/vscode-crashd) is a VS Code extension for visualizing the results & output of this plugin that features:
        - Contextual source code highlighting
        - Interactive graph of data flow
        - Additional context & runtime information
        
        [CrasHD Examples](https://github.com/zeropointdynamics/examples-crashd) is a collection of reproducible crashes that can be used with this plugin.
        
        ## Usage
        
        The following snippets use the example from [examples-crashd/afl_training/vulnerable.c](https://github.com/zeropointdynamics/examples-crashd/tree/master/afl_training)
        
        After compiling the above example (`vulnerable.c`) you can emulate the binary using zelos:
        ```console
        $ zelos vulnerable < inputs/crashing_input
        ```
        
        To gain a more information on the crashing program, use the `--taint` and `--taint_output` flags in order to keep track of dataflow leading from the crash. When the `--taint` flag is used, Zelos will calculate the dataflow and taint information related to the crash. `--taint_output terminal` is used to specify that the output of `--taint` will be to stdout.
        ```console
        $ zelos --taint --taint_output terminal vulnerable < inputs/crashing_input
        ```
        
        
        # Changelog
        
        All notable changes to this project will be documented in this file.
        
        The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
        and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
        
        ## [Version 0.0.2] - 2020-08-06
        
        Remove graphviz as a required dependency, add the taint_output flag.
        
        ### Added
        
        - taint_output flag
        
        ### Changed
        
        - N/A
        
        ### Removed
        
        - Dependency on graphviz package
        
        [0.0.2]: https://github.com/zeropointdynamics/zelos-crashd/releases/tag/v0.0.2
        
        ## [Version 0.0.1] - 2020-08-05
        
        Initial public release.
        
        ### Added
        
        - Initial open source commit.
        
        ### Changed
        
        - N/A
        
        ### Removed
        
        - N/A
        
        [0.0.1]: https://github.com/zeropointdynamics/zelos-crashd/releases/tag/v0.0.1
        
        # Authors
        
        * [Ryan Court](//www.linkedin.com/in/rccourt)
        * [Kevin Z. Snow](//www.linkedin.com/in/kevinsnow/)
        * [Kevin Valakuzhy](//www.linkedin.com/in/kevin-valakuzhy-319a5447/)
        * Suyup Kim
Keywords: emulation,dynamic analysis,binary analysis,zelos,crash,vulnerability assessment
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
