Guia de Desenvolvimento de Módulos do Brasilware
Este documento fornece instruções detalhadas para criar módulos personalizados para a plataforma Brasilware.
O que são Módulos do Brasilware?
Os módulos do Brasilware são componentes HTML independentes que podem ser carregados na plataforma para adicionar funcionalidades específicas de análise de malware.
Estrutura Básica de um Módulo
Um módulo do Brasilware é essencialmente um arquivo HTML contendo todo o código necessário para sua funcionalidade.
<!DOCTYPE html>
<html>
<head>
<title>Meu Módulo</title>
<script>
console.log("Módulo carregado!");
</script>
</head>
<body>
<h1>Meu Módulo do Brasilware</h1>
</body>
</html>
Boas Práticas para Desenvolvimento de Módulos
Desempenho
- Carregamento Assíncrono: Carregue recursos pesados de forma assíncrona.
- Processamento em Etapas: Divida tarefas complexas para evitar travamento.
- Web Workers: Para operações intensivas, use Web Workers.
Segurança
- Sanitização de Entrada: Sempre valide e sanitize dados.
- Execução Isolada: O módulo será executado em um iframe isolado.
- Evite eval(): Nunca use eval() ou funções similares.
Interface do Usuário
- Responsividade: O módulo deve se adaptar a diferentes telas.
- Feedback Visual: Forneça feedback para operações demoradas.
- Consistência: Siga os padrões de design do Brasilware.
Exemplos de Módulos
- Analisador de JavaScript: Identifica padrões suspeitos.
- Visualizador de Tráfego de Rede: Analisa tráfego suspeito.
- Scanner de Phishing: Detecta tentativas de phishing.
Depuração de Módulos
- Use
console.log()
para registrar informações.
- Inspecione o iframe com as ferramentas do navegador.
- Teste seu módulo isoladamente antes da integração.
Enviando seu Módulo para a Comunidade
- Armazene seu módulo em um repositório GitHub público.
- Documente claramente sua funcionalidade.
- Forneça exemplos e casos de uso.
- Submeta o link no nosso github
FAQ para Desenvolvedores de Módulos
Como posso acessar arquivos do sistema?
Você pode acessar os arquivos por todos os meios considerados possíveis como se estivesse usando um arquivo HTML normal, só que isolado em um iframe. Então, escolha seus métodos para usar bibliotecas CDN de forma segura usando o allow script para a sandbox.
Posso usar bibliotecas externas?
Sim, recomendando-se incluir via CDNs confiáveis e especificar versões exatas.
Como fazer chamadas de API para serviços externos?
Use fetch
ou XMLHttpRequest
, respeitando a política CORS.
Recursos Adicionais