O seguinte projeto procura criar uma API que seja capaz de fazer análises de arquivos PCAPs, trazendo informações sobre os pacotes que compõem o arquivo.
Foi escolhido utilizar o Python como linguagem da API pelo motivo da linguagem ter bibliotecas boas para trabalhar com pacotes de rede. Tendo isso em mente, decidimos por utilizar a framework FastApi, que possibilita a criação de APIs em Python com alta configuração e documentação do sistema.
A instalação do projeto é extremamente simples, basta ter o Python 3.1.* instalado na máquina e rodar o seguinte comando na raiz do projeto.
pip install -r requirements.txt
Esse comando irá instalar todas as dependências do projeto.
Para rodar a API é preciso entrar no arquivo main.py e executar o arquivo, se estiver usando uma IDE, é preciso descobrir como a IDE roda arquivos Python, caso queira rodar no terminal, execute o seguinte comando:
python -u main.py
Dentro da pasta Modules o grupo deve fazer uma copia da pasta Grupo1 e fazer as alterações necessárias para identificação do grupo, sendo primeironomemembro1_primeironomemembro2_primeironomemembro3. No arquivo membros.mb coloquem uma lista com os nomes completos dos membros.
Lembre de adicionar dentro do arquivo de rotas, o prefixo do grupo, mesmo nome do modulo.
Para acessar a documentação do FastApi é preciso pesquisar a seguinte url no navegador:
{url}/docs exemplo: http://localhost:3001/docs#/
Para acessar as views dos protocolos basta pesquisr
127.0.0.1:5500/Modules/virginia_vitoria/views/
Onde {url} é onde o FastApi está rodando no seu sistema.
Toda contribuição é bem-vinda para o projeto, basta enviar uma Pull Request de um fork feito na sua conta do Github, lembre de adicionar o membros do grupo no repositório, em caso de duvidas peça ajuda no grupo do Whatsapp.
- DeivisFelipe
- Todos os colaboradores