diff --git a/docsource/basics.png b/docsource/basics.png new file mode 100644 index 0000000..461df50 Binary files /dev/null and b/docsource/basics.png differ diff --git a/docsource/conf.py b/docsource/conf.py new file mode 100644 index 0000000..b0c61d4 --- /dev/null +++ b/docsource/conf.py @@ -0,0 +1,180 @@ +# -*- coding: utf-8 -*- +# +# Crisk documentation build configuration file, created by +# sphinx-quickstart on Tue Feb 17 15:39:52 2009. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# The contents of this file are pickled, so don't put values in the namespace +# that aren't pickleable (module imports are okay, they're removed automatically). +# +# All configuration values have a default value; values that are commented out +# serve to show the default value. + +import sys, os + +# If your extensions are in another directory, add it here. If the directory +# is relative to the documentation root, use os.path.abspath to make it +# absolute, like shown here. +sys.path.append(os.path.abspath('src')) +sys.path.append(os.path.abspath('../src')) + +# General configuration +# --------------------- + +# 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 of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General substitutions. +project = 'Crisk' +copyright = '2009, Jose de Paula E. Junior (coredump)' + +# The default replacements for |version| and |release|, also used in various +# other places throughout the built documents. +# +# The short X.Y version. +version = '0.3' +# The full version, including alpha/beta/rc tags. +release = '0.3' + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +today_fmt = '%B %d, %Y' + +# List of documents that shouldn't be included in the build. +#unused_docs = [] + +# List of directories, relative to source directories, that shouldn't be searched +# for source files. +#exclude_dirs = [] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + + +# Options for HTML output +# ----------------------- + +# The style sheet to use for HTML and HTML Help pages. A file of that name +# must exist either in Sphinx' static/ path, or in one of the custom paths +# given in html_static_path. +html_style = 'default.css' + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (within the static path) to place at the top of +# the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# 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'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_use_modindex = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, the reST sources are included in the HTML build as _sources/. +#html_copy_source = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = '' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Criskdoc' + + +# Options for LaTeX output +# ------------------------ + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, document class [howto/manual]). +latex_documents = [ + ('index', 'Crisk.tex', 'Crisk Documentation', + 'Jose de Paula E. Junior (coredump)', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_use_modindex = True diff --git a/docsource/crisk.rst b/docsource/crisk.rst new file mode 100644 index 0000000..0fdb656 --- /dev/null +++ b/docsource/crisk.rst @@ -0,0 +1,11 @@ +The crisk Module +================ + +.. module:: crisk + +.. module:: crisk.mainview + +The crisk.reports Module +======================== + +.. automodule:: crisk.reports diff --git a/docsource/index.rst b/docsource/index.rst new file mode 100644 index 0000000..e8a253d --- /dev/null +++ b/docsource/index.rst @@ -0,0 +1,40 @@ +.. Crisk documentation master file, created by sphinx-quickstart on Tue Feb 17 15:39:52 2009. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +About Crisk +=========== + +Crisk is a simple risk management tool. Its objective is to provide risk analysts, security professionals and secure software developers with a tool to organize vulnerabilities, assets and (futurely) controls, generating reports and graphics for easy analysis. + +Tickets and Bug Reporting +========================= + +Crisk uses the `Lighthouse App as bug tracking system `_. Feel free to report bugs or suggest new features. + +Getting Crisk +============= + +Crisk right now is avaiable on source form only. You may: + +* `Download a tarball `_ +* `Download a zipfile `_ +* Clone the git repository: ``$ git clone git://github.com/coredump/crisk`` + +Contents +======== +.. toctree:: + :maxdepth: 2 + + crisk + screenshots + using + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docsource/inventory.png b/docsource/inventory.png new file mode 100644 index 0000000..63b1d41 Binary files /dev/null and b/docsource/inventory.png differ diff --git a/docsource/screenshots.rst b/docsource/screenshots.rst new file mode 100644 index 0000000..46f0675 --- /dev/null +++ b/docsource/screenshots.rst @@ -0,0 +1,26 @@ +Screenshots and examples +======================== + +Sample reports +-------------- + +`Inventory Report `_ + +`Total Vulnerability Risk Report `_ + +Basic info screen +----------------- + +.. image:: basics.png + +Asset inventory +--------------- + +.. image:: inventory.png + +Vulnerability list +------------------ + +.. image:: vulns.png + + diff --git a/docsource/using.rst b/docsource/using.rst new file mode 100644 index 0000000..25c0425 --- /dev/null +++ b/docsource/using.rst @@ -0,0 +1,12 @@ +Using Crisk +=========== + +Analyzing servers and computers +------------------------------- + +Analyzing information +--------------------- + +Analyzing software +------------------ + diff --git a/docsource/vulns.png b/docsource/vulns.png new file mode 100644 index 0000000..e069ed7 Binary files /dev/null and b/docsource/vulns.png differ