Moved documentation to sphinx/readthedocs. Deprecated the wiki.

parent 79a150c6
Pipeline #15987319 passed with stages
in 12 minutes and 17 seconds
This diff is collapsed.
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = failmap
SOURCEDIR = source
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 [email protected] "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
set SPHINXPROJ=failmap
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
from recommonmark.parser import CommonMarkParser
source_parsers = {
'.md': CommonMarkParser,
}
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# failmap documentation build configuration file, created by
# sphinx-quickstart on Wed Jan 10 10:12:08 2018.
#
# 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 = ['_documentation_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
source_suffix = ['.rst', '.md']
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'failmap'
copyright = '2018, Elger Jonker, Johan Bloemberg'
author = 'Elger Jonker, Johan Bloemberg'
# 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 = ''
# The full version, including alpha/beta/rc tags.
release = '2018_01'
# 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 = []
# 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 = ['_documentation_static']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
'**': [
'relations.html', # needs 'show_related': True theme option to display
'searchbox.html',
]
}
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'failmapdoc'
# -- 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, 'failmap.tex', 'failmap Documentation',
'Elger Jonker, Johan Bloemberg', '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, 'failmap', 'failmap 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, 'failmap', 'failmap Documentation',
author, 'failmap', 'One line description of project.',
'Miscellaneous'),
]
.. failmap documentation master file, created by
sphinx-quickstart on Wed Jan 10 10:12:08 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
So much fail, so little documentation 🤣
========================================
.. toctree::
:maxdepth: 2
:caption: Contents:
topics/getting_started
topics/gis_and_map_information
topics/scanners_scanning_and_ratings
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
This diff is collapsed.
Mapping Information / GeoJSON
=============================
Please go through the resources in order to understand how to add districts, points and lines of interest to the map.
1. Learn about how maps work: https://www.youtube.com/watch?v=2lR7s1Y6Zig
2. What projections Open Street Maps uses: http://openstreetmapdata.com/info/projections
3. Fail map / Open Street Maps uses GeoJson, described at: http://geojson.org
A harder challenge is to get data from a country in GeoJSON. Some countries publish a (large) map for the use with mapping tools (GIS Tools). A free mapping tool to work with this is QGIS, available at qgis.org
Any map you'll download will probably contain way too much details. Next steps describe the process to convert a large map to something smaller, so it uses (way) less data:
1. Download a map, for example administrative regions of the Netherlands: https://www.pdok.nl/nl/producten/pdok-downloads/basis-registratie-kadaster/bestuurlijke-grenzen-actueel
2. Open the map in QGIS, it will look heavily distorted as an unfamiliar (but correct) projection is used.
3. It's possible to change the projection on the fly. Look for the tiny globe icon and choose something like "Mercator (EPSG 3857)"
4. After you're happy with the projection and "the world makes sense again" remove complexities from the map.
5. Reducing complexities reduces the file size from 8 megabyte to hundreds of kiloytes.
6. Vector > Geometry Tools > Simplify Geometries, enter 500.0000 or something like that. Let the algorithm do it's job.
7. Now right click on the simplified layer and export it. You can export it to GeoJSON that the fail map software understands. The projection is called "WGS84 (EPSG 4326)".
8. Import the data into the database, a procedure not yet described.
### Wish: OSM only solution.
OSM uses the administrative regions etc, and it's possible to determine addresses and such.
There are API's that let one search through the data and export the right things. Yet this was not implemented yet. This would be the easiest way to have updated mapping data from all around the world that requires a lesser amount of special steps. (the data is always there, from everywhere =)
There are converters that reduce OSM to GeoJSON (but don't reduce complexity afaik):
1. https://tyrasd.github.io/osmtogeojson/
### Other things
Additionally there is an awesome world map in GeoJSON, available here:
https://github.com/datasets/geo-countries/blob/master/data/countries.geojson
\ No newline at end of file
# Scanners, scanning and ratings
## Supported scans
| Scan | Port(s) | IPv Support | Protocols | Rate limit
| :------------------ | :---------- | :---------- | :-------- | :-----
| DNS | A/AAAA | - | DNS | No
| HTTP(s) discovery | Defaults | 4 | http(s) | No
| TLS (qualys) | 443 | 4, 6 | TLS | 1/minute
| Headers | Any http(s) | 4 | http(s) | No
| Screenshots | Any http(s) | 4 | http(s) | 1 thread
| Plain HTTP | Any http(s) | 4 | http(s) | No
## Data Model
* Organization n<-->n Url,
* Url 1<-->n Endpoint
* Endpoint 1<-->n scans (various types)
todo: datamodel
## Scheduling
Scanners in Failmap run automatically. They are queued and then run in different strategies.
## Manual scans
It's possible to run manual scans, at the bottom of a selection. Note that this is beta functionality and please don't do this too much as the "priority" scanning queue is not functioning. You can try out a scan or two, some take a lot of time.
![admin_actions](scanners_scanning_and_ratings/admin_actions.png)
Data reduction / Stacking pattern
---------------------------------
Only changes in the result of a scan creates a new scan. This is to save on the amount of records in the database. Consider the following:
As seen in the below image, a rating was determined on 4 september, and all re-scans until the 28th of september resulted in the same rating.
What you can also see is that over time ratings changed.
![data_reduction](scanners_scanning_and_ratings/data_reduction.png)
## Ratings
Colors that are shown on the map are OrganizationRatings. These are built out of Url ratings, which are built on all kinds of scans that where performed at a certain time.
Creating a rating of an organization is a bit complex, as there is a time factor for all scans and all url ratings.
Currently ratings are automatically rebuilt every night.
......@@ -56,4 +56,9 @@ urllib3
# loading json is faster in simplejson
# https://stackoverflow.com/questions/712791/what-are-the-differences-between-json-and-simplejson-python-modules
# needed for mapping reasons.
simplejson
\ No newline at end of file
simplejson
# docs / readthedocs.io
sphinx
sphinx-autobuild
recommonmark
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment