diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..dbcc0ed --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = Manticore +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..4e1b045 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,10 @@ +API +=== + +.. module:: manticore + +Manticore +--------- + +.. autoclass:: Manticore + :members: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..0f195a7 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,156 @@ +# -*- coding: utf-8 -*- +# +# Manticore documentation build configuration file, created by +# sphinx-quickstart on Fri Mar 10 18:04:51 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Manticore' +copyright = u'2017, Trail of Bits' +author = u'Trail of Bits' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'0.1.0' +# The full version, including alpha/beta/rc tags. +release = u'0.1.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Manticoredoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'Manticore.tex', u'Manticore Documentation', + u'Trail of Bits', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'manticore', u'Manticore Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'Manticore', u'Manticore Documentation', + author, 'Manticore', 'One line description of project.', + 'Miscellaneous'), +] + + + diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..4109a3c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,18 @@ +Welcome to Manticore's documentation! +===================================== + +This is the documentation for the Manticore project. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + api + + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..908666a --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build +set SPHINXPROJ=Manticore + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/manticore/manticore.py b/manticore/manticore.py index a6bb079..dac9224 100644 --- a/manticore/manticore.py +++ b/manticore/manticore.py @@ -129,10 +129,19 @@ def binary_type(path): raise NotImplementedError("Binary {} not supported.".format(path)) class Manticore(object): + ''' + The central analysis object. - def __init__(self, binary_path, args = [], verbose = False): + :param str binary_path: Path to binary to analyze + :param args: Arguments to provide to binary + :type args: list[str] + ''' + + def __init__(self, binary_path, args=None): assert os.path.isfile(binary_path) + args = [] if args is None else args + self._binary = binary_path self._binary_type = binary_type(binary_path) self._argv = args # args.programs[1:] @@ -285,6 +294,13 @@ class Manticore(object): @property def verbosity(self): + ''' + Convenience property for controlling the logging verbosity to a number of presets + + :getter: Get current verbosity level + :setter: Set current verbosity level [0-5] + :type: int + ''' return self._verbosity @verbosity.setter @@ -308,8 +324,11 @@ class Manticore(object): def hook(self, pc): ''' - A decorator used to register a hook function for a given instruction address - (`pc`). Equivalent to calling `add_hook`. + A decorator used to register a hook function for a given instruction address. + Equivalent to calling :func:`~add_hook`. + + :param pc: Address of instruction to hook + :type pc: int or None ''' def decorator(f): self.add_hook(pc, f) @@ -318,9 +337,13 @@ class Manticore(object): def add_hook(self, pc, callback): ''' - Add a callback to be invoked on executing a program counter. Pass 'None' + Add a callback to be invoked on executing a program counter. Pass `None` for pc to invoke callback on every instruction. `callback` should be a callable - that takes one `manticore.core.executor.State` argument. + that takes one :class:`~manticore.core.executor.State` argument. + + :param pc: Address of instruction to hook + :type pc: int or None + :param callable callback: Hook function ''' if not (isinstance(pc, (int, long)) or pc is None): raise TypeError("pc must be either an int or None, not {}".format(pc.__class__.__name__)) @@ -534,7 +557,7 @@ class Manticore(object): def run(self): ''' - Start Manticore, creating all necessary support classes. + Runs analysis. ''' assert not self._running, "Manticore is already running." args = self._args @@ -577,7 +600,10 @@ class Manticore(object): self._running = False def terminate(self): - 'Gracefully terminate the currently-executing Manticore run.' + ''' + Gracefully terminate the currently-executing run. Typically called from within + a :func:`~hook`. + ''' self._executor.shutdown() def _assertions_callback(self, state, pc): diff --git a/setup.py b/setup.py index e0d3e10..9ef4b59 100644 --- a/setup.py +++ b/setup.py @@ -15,6 +15,7 @@ setup( 'keystone-engine', 'coverage', 'nose', + 'Sphinx', ] }, entry_points={