diff --git a/README.md b/README.md new file mode 100644 index 0000000..ed91f4c --- /dev/null +++ b/README.md @@ -0,0 +1,155 @@ +# CBS CyberScan - Escaner Web Antivirus + +

+ CBS Logo +

+ +## Descripción +CBS CyberScan es una aplicación web que proporciona un servicio de escaneo de archivos y URLs en tiempo real. Utiliza ClamAV como motor de análisis antivirus y ofrece una interfaz moderna y cibernética para una experiencia de usuario mejorada. + +## Características Principales +- 🔍 Escaneo de archivos locales +- 🌐 Análisis de archivos desde URLs +- 🔄 Verificación de hashes (MD5, SHA1, SHA256) +- 💾 Almacenamiento de resultados en base de datos +- ⚡ Interfaz en tiempo real con WebSockets +- 📊 Estadísticas detalladas de escaneo +- 🎯 Detección y conteo de amenazas + +## Requisitos del Sistema +- Python 3.8+ +- MySQL/MariaDB +- ClamAV +- Navegador web moderno + +## Dependencias Principales +```plaintext +Flask==3.0.2 +flask-socketio==5.3.6 +python-dotenv==1.0.1 +mysql-connector-python==8.3.0 +filetype==1.2.0 +requests==2.31.0 +``` + +## Instalación + +1. Clonar el repositorio: +```bash +git clone https://condorcs.net/mrhacker/cbs-web-antivirus-scanner.git +cd cbs-web-antivirus-scanner +``` + +2. Crear y activar entorno virtual: +```bash +python -m venv venv + +# En Linux/Mac: +source venv/bin/activate + +# En Windows: +.\venv\Scripts\activate +``` + +3. Instalar dependencias: +```bash +pip install -r requirements.txt +``` + +4. Configurar la base de datos: +```sql +CREATE DATABASE cbswebscan; +USE cbswebscan; + +CREATE TABLE file_scans ( + id INT AUTO_INCREMENT PRIMARY KEY, + filename VARCHAR(255), + md5_hash VARCHAR(32), + sha1_hash VARCHAR(40), + sha256_hash VARCHAR(64), + file_type VARCHAR(50), + scan_result TEXT, + scan_date TIMESTAMP DEFAULT CURRENT_TIMESTAMP +); +``` + +5. Configurar variables de entorno: +Crear archivo `.env`: +```plaintext +DB_HOST=localhost +DB_USER=your_username +DB_PASSWD=your_password +DB_NAME=cbswebscan +DB_CHARSET=utf8mb4 +DB_COALLITION=utf8mb4_unicode_ci +``` + +## Uso + +1. Iniciar el servidor: +```bash +python app.py +``` + +2. Acceder a la aplicación: +Abrir en el navegador: `http://localhost:5000` + +## Historial de Versiones + +### v2.0.0 (Actual) +![CBS CyberScan v2.0.0](screenshots/v2.0.0.png) +- Interfaz completamente rediseñada con estilo cibernético +- Sistema de escritura tipo terminal +- Panel de estadísticas en tiempo real +- Efectos visuales y animaciones mejoradas +- Mejor manejo de amenazas y resultados + +### v1.0.0 +![CBS CyberScan v1.0.0](screenshots/v1.0.0.png) +- Primera versión estable +- Funcionalidades básicas de escaneo +- Interfaz simple y funcional + +## Estructura del Proyecto +```plaintext +cbs-cyberscan/ +├── app.py # Aplicación principal +├── requirements.txt # Dependencias del proyecto +├── .env # Variables de entorno +├── static/ # Archivos estáticos +├── templates/ # Plantillas HTML +│ └── index.html # Interfaz principal +└── README.md # Documentación +``` + +## Seguridad +- Los archivos se escanean en un entorno aislado +- Verificación de hashes para evitar escaneos duplicados +- Limpieza automática de archivos temporales +- Validación de tipos de archivo y URLs + +## Contribuir +1. Fork del repositorio +2. Crear rama para nueva característica (`git checkout -b feature/nueva-caracteristica`) +3. Commit de cambios (`git commit -am 'Agregar nueva característica'`) +4. Push a la rama (`git push origin feature/nueva-caracteristica`) +5. Crear Pull Request + +## Screenshots + +Para agregar capturas de pantalla de nuevas versiones: +1. Crear carpeta `screenshots` si no existe +2. Nombrar las imágenes siguiendo el formato `vX.X.X.png` +3. Actualizar la sección "Historial de Versiones" de este README + + +## Autores +- Kevin Muñoz + +## Soporte +Para reportar problemas o solicitar ayuda: +- Crear un issue en GitHub +- Contactar a helpdesk@condorbs.net + +--- +Desarrollado con ❤️ por Kevin Muñoz diff --git a/screenshots/v1.0.0.png b/screenshots/v1.0.0.png new file mode 100644 index 0000000..473e9f2 Binary files /dev/null and b/screenshots/v1.0.0.png differ diff --git a/screenshots/v2.0.0.png b/screenshots/v2.0.0.png new file mode 100644 index 0000000..7967725 Binary files /dev/null and b/screenshots/v2.0.0.png differ