Merge pull request #718 from p-l-/update-doc

Doc: add Yeti plugin
ivre · Jul 5, 2019 · cf1756d · cf1756d
2 parents 76d7fc8 + 61b9e7d
commit cf1756d
Show file tree

Hide file tree

Showing 28 changed files with 69 additions and 26 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -11,6 +11,7 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import os
+import re
 import sys
 sys.path.insert(0, os.path.abspath('..'))
 
@@ -24,6 +25,9 @@
 master_doc = 'index'
 
 from ivre import __version__ as version
+version = version.split('dev')[0]
+if version.endswith('.'):
+    version += 'dev'
 
 # -- General configuration ---------------------------------------------------
 

diff --git a/doc/usage/use-cases.rst b/doc/usage/use-cases.rst
@@ -65,6 +65,19 @@ following example (the results come from a PCAP file used in IVRE's
    ipv4.icanhazip.com A 216.69.252.101 (109.0.66.10:53, 1 time, 2014-01-02 09:37:57.197000 - 2014-01-02 09:37:57.197000)
    ipv4.icanhazip.com A 216.69.252.101 (109.0.66.20:53, 1 time, 2014-01-02 09:37:57.197000 - 2014-01-02 09:37:57.197000)
 
+YETI plugin
+-----------
+
+`Yeti <https://yeti-platform.github.io/>`_ is a platform meant to
+organize observables, indicators of compromise, TTPs, and knowledge on
+threats in a single, unified repository.
+
+It comes with an "analytics" plugin that uses IVRE's data to create
+links between IP addresses, hostnames, certificates, etc.
+
+To learn more about this plugin, have a look at `its documentation
+<https://github.com/yeti-platform/yeti/tree/master/contrib/analytics/ivre_api>`_.
+
 Blog posts and other resources
 ------------------------------
 

diff --git a/pkg/arch/PKGBUILD b/pkg/arch/PKGBUILD
@@ -23,7 +23,7 @@ pkgbase='ivre'
 pkgname=('ivre' 'ivre-docs' 'ivre-web' 'python-ivre' 'python2-ivre' 'ivre-data')
 pkgver=0.9.13
 pkgrel=1
-pkgdesc='Network recon framework'
+pkgdesc='Network recon framework based on Nmap, Masscan, Zeek (Bro), Argus, Netflow,...'
 arch=('any')
 url='https://ivre.rocks/'
 license=('GPL3')
@@ -55,10 +55,11 @@ build() {
 package_ivre() {
   depends=('python-ivre')
   optdepends=('ivre-docs: Documentation'
+              'ivre-web: Web server'
               'nmap: Network scan'
               'masscan: Network scan'
               'zmap: Network scan'
-              'bro: Network traffic analysis'
+              'zeek: Network traffic analysis'
               'argus: Network traffic analysis'
               'nfdump: Netflow analysis'
               'imagemagick: Screenshots via Nmap scripts'

diff --git a/web/static/doc/_sources/usage/use-cases.rst.txt b/web/static/doc/_sources/usage/use-cases.rst.txt
@@ -65,6 +65,19 @@ following example (the results come from a PCAP file used in IVRE's
    ipv4.icanhazip.com A 216.69.252.101 (109.0.66.10:53, 1 time, 2014-01-02 09:37:57.197000 - 2014-01-02 09:37:57.197000)
    ipv4.icanhazip.com A 216.69.252.101 (109.0.66.20:53, 1 time, 2014-01-02 09:37:57.197000 - 2014-01-02 09:37:57.197000)
 
+YETI plugin
+-----------
+
+`Yeti <https://yeti-platform.github.io/>`_ is a platform meant to
+organize observables, indicators of compromise, TTPs, and knowledge on
+threats in a single, unified repository.
+
+It comes with an "analytics" plugin that uses IVRE's data to create
+links between IP addresses, hostnames, certificates, etc.
+
+To learn more about this plugin, have a look at `its documentation
+<https://github.com/yeti-platform/yeti/tree/master/contrib/analytics/ivre_api>`_.
+
 Blog posts and other resources
 ------------------------------
 

diff --git a/web/static/doc/dev/index.html b/web/static/doc/dev/index.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/dev/tests.html b/web/static/doc/dev/tests.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/dev/web-api.html b/web/static/doc/dev/web-api.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/faq.html b/web/static/doc/faq.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/genindex.html b/web/static/doc/genindex.html
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/http-routingtable.html b/web/static/doc/http-routingtable.html
@@ -69,7 +69,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/index.html b/web/static/doc/index.html
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 
@@ -325,6 +325,7 @@ <h2>Content<a class="headerlink" href="#content" title="Permalink to this headli
 <li class="toctree-l1"><a class="reference internal" href="usage/use-cases.html">Some use cases</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="usage/use-cases.html#your-own-shodan-zoomeye-censys-binaryedgeio-whatever">Your own Shodan / ZoomEye / Censys / Binaryedgeio / whatever</a></li>
 <li class="toctree-l2"><a class="reference internal" href="usage/use-cases.html#your-own-passive-dns-service">Your own Passive DNS service</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/use-cases.html#yeti-plugin">YETI plugin</a></li>
 <li class="toctree-l2"><a class="reference internal" href="usage/use-cases.html#blog-posts-and-other-resources">Blog posts and other resources</a></li>
 </ul>
 </li>

diff --git a/web/static/doc/install/agents.html b/web/static/doc/install/agents.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/install/docker.html b/web/static/doc/install/docker.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/install/fast-install-and-first-run.html b/web/static/doc/install/fast-install-and-first-run.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/install/index.html b/web/static/doc/install/index.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/install/installation.html b/web/static/doc/install/installation.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/license-external.html b/web/static/doc/license-external.html
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/license.html b/web/static/doc/license.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/principles.html b/web/static/doc/principles.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/screenshots.html b/web/static/doc/screenshots.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/search.html b/web/static/doc/search.html
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/searchindex.js b/web/static/doc/searchindex.js
diff --git a/web/static/doc/usage/active-recon.html b/web/static/doc/usage/active-recon.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/usage/flow.html b/web/static/doc/usage/flow.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/usage/index.html b/web/static/doc/usage/index.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 
@@ -187,6 +187,7 @@
 <li class="toctree-l1"><a class="reference internal" href="use-cases.html">Some use cases</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="use-cases.html#your-own-shodan-zoomeye-censys-binaryedgeio-whatever">Your own Shodan / ZoomEye / Censys / Binaryedgeio / whatever</a></li>
 <li class="toctree-l2"><a class="reference internal" href="use-cases.html#your-own-passive-dns-service">Your own Passive DNS service</a></li>
+<li class="toctree-l2"><a class="reference internal" href="use-cases.html#yeti-plugin">YETI plugin</a></li>
 <li class="toctree-l2"><a class="reference internal" href="use-cases.html#blog-posts-and-other-resources">Blog posts and other resources</a></li>
 </ul>
 </li>

diff --git a/web/static/doc/usage/passive.html b/web/static/doc/usage/passive.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 

diff --git a/web/static/doc/usage/use-cases.html b/web/static/doc/usage/use-cases.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>
 
 
@@ -106,6 +106,7 @@
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Some use cases</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#your-own-shodan-zoomeye-censys-binaryedgeio-whatever">Your own Shodan / ZoomEye / Censys / Binaryedgeio / whatever</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#your-own-passive-dns-service">Your own Passive DNS service</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#yeti-plugin">YETI plugin</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#blog-posts-and-other-resources">Blog posts and other resources</a></li>
 </ul>
 </li>
@@ -241,6 +242,15 @@ <h2>Your own Passive DNS service<a class="headerlink" href="#your-own-passive-dn
 </pre></div>
 </div>
 </div>
+<div class="section" id="yeti-plugin">
+<h2>YETI plugin<a class="headerlink" href="#yeti-plugin" title="Permalink to this headline">¶</a></h2>
+<p><a class="reference external" href="https://yeti-platform.github.io/">Yeti</a> is a platform meant to
+organize observables, indicators of compromise, TTPs, and knowledge on
+threats in a single, unified repository.</p>
+<p>It comes with an “analytics” plugin that uses IVRE’s data to create
+links between IP addresses, hostnames, certificates, etc.</p>
+<p>To learn more about this plugin, have a look at <a class="reference external" href="https://github.com/yeti-platform/yeti/tree/master/contrib/analytics/ivre_api">its documentation</a>.</p>
+</div>
 <div class="section" id="blog-posts-and-other-resources">
 <h2>Blog posts and other resources<a class="headerlink" href="#blog-posts-and-other-resources" title="Permalink to this headline">¶</a></h2>
 <p>The author’s blog has some <a class="reference external" href="http://pierre.droids-corp.org/blog/html/tags/ivre.html">IVRE-related blog posts</a> that might be useful.</p>

diff --git a/web/static/doc/usage/web-ui.html b/web/static/doc/usage/web-ui.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.9.13.dev12
+                0.9.13.dev
               </div>