Directives

Configurations

The following configuration options are available :

osint_emit_warnings = False
osint_default_cats = {'other': {'shape': 'octogon', 'style': 'dashed'}}
osint_org_cats = None
osint_ident_cats = None
osint_event_cats = None
osint_relation_cats = None
osint_link_cats = None
osint_quote_cats = None
osint_source_cats = None
osint_country = None
osint_csv_store = csv_store
osint_local_store = local_store
osint_xref_text = sdescription
osint_extsrc_text = sdescription
osint_auths = []
  • osint_auths : a list of (domain, user, password, apikey)

Look at cats.

Indexes

The following indexes are available :

events : Events Index
sources : Sources Index
orgs : Orgs Index
csvs : Csvs Index
reports : Reports Index
links : Links Index
relations : Relations Index
idents : Idents Index
osint : OSInt Index
graphs : Graphs Index
quotes : Quotes Index

Roles

The following roles are available :

extsrc : Create http links from the first linked sources in items in quest.

        :osint:extsrc:`ident.testid`
        :osint:extsrc:`External link <ident.testid>`
        :osint:extsrc:`event.testev`
        ...
    
ref : Create internal reference to items in quest.

        :osint:ref:`ident.testid`
        :osint:ref:`External link <ident.testid>`
        :osint:ref:`event.testev`
        ...

Directive Event

Represent an event : ie a meeting, an article, a manifestation, …

You can create a Link to an Event from an Ident.

class : class_option
source : unchanged
sources : unchanged
label : unchanged_required
description : unchanged_required
url : unchanged_required
link : unchanged_required
local : unchanged
scrap : unchanged_required
from : unchanged_required
from-label : unchanged_required
from-begin : unchanged_required
from-end : unchanged_required
to : unchanged_required
to-label : unchanged_required
to-begin : unchanged_required
to-end : unchanged_required
begin : unchanged_required
end : unchanged_required
cats : unchanged_required
orgs : unchanged_required
country : unchanged_required
style : unchanged_required
shape : unchanged

Directive Ident

Represent an ident : ie a person, company, …

You can create a Relation from an Ident to an Ident.

You can create a Link from an Ident to an Event.

An ident can belong to one or many orgs.

class : class_option
source : unchanged
sources : unchanged
label : unchanged_required
description : unchanged_required
url : unchanged_required
link : unchanged_required
local : unchanged
scrap : unchanged_required
from : unchanged_required
from-label : unchanged_required
from-begin : unchanged_required
from-end : unchanged_required
to : unchanged_required
to-label : unchanged_required
to-begin : unchanged_required
to-end : unchanged_required
cats : unchanged_required
orgs : unchanged_required
country : unchanged_required
style : unchanged_required
shape : unchanged

Directive Org

Represent an organisation used idents.

Use :ident: to automatically create an ident.

class : class_option
ident : unchanged
source : unchanged
sources : unchanged
label : unchanged_required
description : unchanged_required
url : unchanged_required
link : unchanged_required
local : unchanged
scrap : unchanged_required
cats : unchanged_required
orgs : unchanged_required
country : unchanged_required
style : unchanged_required
shape : unchanged

Directive Quote

Represent a quote from an Event to an Event.

class : class_option
sources : unchanged
label : unchanged_required
description : unchanged_required
from : unchanged_required
to : unchanged_required
cats : unchanged_required
orgs : unchanged_required
country : unchanged_required
style : unchanged_required
shape : unchanged

Directive Relation

Represent a relation from an Ident to an Ident.

class : class_option
source : unchanged
sources : unchanged
label : unchanged_required
description : unchanged_required
from : unchanged_required
begin : unchanged_required
end : unchanged_required
to : unchanged_required
cats : unchanged_required
orgs : unchanged_required
country : unchanged_required
url : unchanged_required
link : unchanged_required
local : unchanged
scrap : unchanged_required
style : unchanged_required
shape : unchanged

Directive Source

Represent a source. They are used for analyse, …

A source can automatically created from an ident, event, … using the :source: and :link: (or other)

class : class_option
label : unchanged_required
description : unchanged_required
cats : unchanged_required
orgs : unchanged_required
country : unchanged_required
style : unchanged_required
shape : unchanged
url : unchanged_required
link : unchanged_required
local : unchanged
scrap : unchanged_required

Directive Csv

Filter data using orgs, cats and countries ang create csv to download.

class : class_option
caption : unchanged
cats : unchanged_required
orgs : unchanged_required
countries : unchanged_required
borders : yesno
with-json : yesno
with-archive : yesno
label : unchanged_required
description : unchanged_required

Directive Graph

Filter data using orgs, cats and countries ang create a graph.

class : class_option
alt : unchanged
caption : unchanged
borders : yesno
width : positive_int
height : positive_int
link-report : yesno
label : unchanged_required
description : unchanged_required
cats : unchanged_required
orgs : unchanged_required
countries : unchanged_required

Directive Report

Filter data using orgs, cats and countries ang create report in table.

class : class_option
caption : unchanged
borders : yesno
label : unchanged_required
description : unchanged_required
cats : unchanged_required
orgs : unchanged_required
countries : unchanged_required

Cats

Categories are used to filter and represent data in graphs.

You can configure them with the following values in conf.py. If a value is None, the osint_default_cats is used.

osint_default_cats
osint_org_cats
osint_ident_cats
osint_event_cats
osint_relation_cats
osint_link_cats
osint_quote_cats
osint_source_cats

Here is a sample :

osint_default_cats = {
        'media' : {
            'shape' : 'egg',
            'style' : 'solid',
            'color' : 'blue',
        },
        'financial' : {
            'shape' : 'hexagon',
            'style' : 'solid',
        'fillcolor' : 'red',
        },
        'other' : {
            'shape' : 'octogon',
            'style' : 'dashed',
        },
    }

Graph are created using graphviz.

You can find more shapes, styles and colors in their documentation.