############ ProbeManager ############

.. image:: https://www.ko-fi.com/img/donate_sm.png :alt: Donate :target: https://ko-fi.com/mtreussart

|Licence| |Version|

.. image:: https://api.codacy.com/project/badge/Grade/afc2ab5226584ac3b594eb09ebcc2ccc?branch=master :alt: Codacy Grade :target: https://app.codacy.com/app/treussart/ProbeManager?utm_source=github.com&utm_medium=referral&utm_content=treussart/ProbeManager&utm_campaign=badger

.. image:: https://api.codacy.com/project/badge/Coverage/8c16c475964d4db58ce0c7de0d03abbf?branch=master :alt: Codacy Coverage :target: https://www.codacy.com/app/treussart/ProbeManager?utm_source=github.com&utm_medium=referral&utm_content=treussart/ProbeManager&utm_campaign=Badge_Coverage

+------------------+--------------------+ | Status | Sistema operacional| +==================+====================+ | |Build_Status| | Linux x86_64 | +------------------+--------------------+

.. |Licence| image:: https://img.shields.io/github/license/treussart/ProbeManager.svg .. |Stars| image:: https://img.shields.io/github/stars/treussart/ProbeManager.svg .. |Forks| image:: https://img.shields.io/github/forks/treussart/ProbeManager.svg .. |Downloads| image:: https://img.shields.io/github/downloads/treussart/ProbeManager/total.svg .. |Version| image:: https://img.shields.io/github/tag/treussart/ProbeManager.svg .. |Commits| image:: https://img.shields.io/github/commits-since/treussart/ProbeManager/latest.svg .. |Build_Status| image:: https://travis-ci.org/treussart/ProbeManager.svg?branch=master :target: https://travis-ci.org/treussart/ProbeManager

Apresentação

É comum ver que muitos IDS (sistema de detecção e intrusão), incluindo o software e suas regras, não são atualizados regularmente. Isso pode ser explicado pelo fato de que o gerenciamento de software e regras é frequentemente complicado, o que pode ser um problema particular para pequenas e médias empresas que normalmente não possuem expertise em segurança de sistemas e operadores em tempo integral para supervisionar seus respectivos IDS. Essa constatação me incentivou a desenvolver uma aplicação (ProbeManager) que gerencie melhor as sondas de detecção de rede e de máquinas em um sistema.

ProbeManager é uma aplicação que centraliza o gerenciamento de sistemas de detecção de intrusão. O objetivo do ProbeManager é simplificar a implantação de sondas de detecção e reunir todas as suas funcionalidades em um único lugar. ProbeManager também permite verificar o status das sondas e ser notificado sempre que houver um problema ou disfunção. ProbeManager não é um SIEM (gerenciamento de informações e eventos de segurança), portanto, não exibe as saídas das sondas (alertas, logs, etc...)

ProbeManager é atualmente compatível com NIDS Suricata e Bro, e em breve também será compatível com OSSEC.

Funcionalidades

• Pesquisar regras em todas as sondas.
• Listar sondas instaladas e seu status (em execução ou não, tempo de atividade ...).
• Instalar, atualizar sonda.
• Iniciar, parar, recarregar e reiniciar sonda.
• Notificações Push e Email (mudança de status, ...).
• API Restful.
• Ver todos os trabalhos assíncronos.

Uso

.. image:: https://raw.githubusercontent.com/treussart/ProbeManager/master/docs/data/Deployement_example_of_Probemanager_in_a_network.png :alt: Exemplo de implantação do Probemanager em uma rede

.. image:: https://raw.githubusercontent.com/treussart/ProbeManager/master/docs/data/Deployement_example_of_Probemanager_in_a_VPS.png :alt: Exemplo de implantação do Probemanager em um VPS

Instalação

Sistema Operacional

+------------+------------+-----------+ | SO | Produção | Teste | +============+============+===========+ | OSX 12+ | | X | +------------+------------+-----------+ | Debian 9 | X | | +------------+------------+-----------+ | Ubuntu 14 | X | | +------------+------------+-----------+

OSX 12+ (Apenas para desenvolvimento do projeto), Debian estável e Ubuntu 14.04+ são suportados e testados.

Requisitos

• Python3.5+
• Pip
• Rabbitmq-server (instalado com o script de instalação)
• Postgresql (instalado com o script de instalação)

Obter o projeto

Código fonte no Github <https://github.com/treussart/ProbeManager/>_

.. code-block:: sh

git clone --recursive https://github.com/treussart/ProbeManager.git

Instalação

Para desenvolvedor : ^^^^^^^^^^^^^^^

.. code-block:: sh

./install.sh
./start.sh

Para produção : ^^^^^^^^^^^^^^^^

Caminho de destino padrão : /usr/local/share

Para o mesmo caminho de destino : .

Certifique-se de ter permissões de escrita no caminho de destino.

.. code-block:: sh

./install.sh prod [destination path]

Com servidor Django (não recomendado) :

.. code-block:: sh

[destination path]./start.sh prod

Com Apache (Apenas para Debian) :

.. code-block:: sh

 http://localhost

Executar os testes

(Apenas para Dev ou Travis) :

.. code-block:: sh

./test.sh

Abra o arquivo com um navegador web :

::

coverage_html/index.html

Adicionar um submódulo

.. code-block:: sh

git submodule add -b master --name suricata https://github.com/treussart/ProbeManager_Suricata.git probemanager/suricata

Os módulos devem respeitar algumas regras:

• Um arquivo version.txt (gerado pelo script de instalação)
• Um arquivo README.rst
• Uma pasta api com uma variável 'urls_to_register' em urls.py (Opcional)
• Um script de instalação : install.sh (Opcional)
• Um script para inicializar o banco de dados : init_db.sh (Opcional)

Documentação

Respeitar o padrão : reStructuredText (RST).

.. code-block:: sh

venv/bin/python probemanager/manage.py runscript generate_doc --settings=probemanager.settings.dev

Abra o arquivo com um navegador web :

::

docs/_build/html/index.html

Ou obtenha a documentação completa aqui <https://treussart.github.io/ProbeManager/>_