Framework de análisis de enlaces y OSINT de código abierto
<div align="center"> <img src="https://assets.kitploit.com/production/public/readmes/12241/4d60ae367bb5f1d9b7d1d95df2b16186f01454c9610e40703f636923a0a70ced.png" alt="OGI Mascot" width="200" /> # OpenGraph Intel (OGI) **Framework de análisis visual de enlaces y OSINT de código abierto.** **Gratuito, autogestionable e impulsado por la comunidad.** [](https://www.gnu.org/licenses/agpl-3.0) [](https://github.com/khashashin/ogi/actions/workflows/ci.yml) [](https://github.com/khashashin/ogi/actions/workflows/docker-publish.yml) [](https://www.python.org) [](https://www.typescriptlang.org) [](https://react.dev) [](https://fastapi.tiangolo.com)  [Características](#features) • [Capturas de pantalla](#screenshots) • [Inicio rápido](#quick-start) • [Docker](#docker) • [Transform Hub](#transform-hub) • [Arquitectura](#architecture) • [Contribuir](#contributing) </div> --- > **Aviso:** Este proyecto está en evolución activa. Cuenta con capacidades principales sólidas y cobertura de pruebas, y seguimos mejorando la documentación, la solidez y la profundidad de las funcionalidades con cada versión. Las contribuciones, los informes de errores y los comentarios son muy bienvenidos. ## Características - **Investigación visual mediante grafos** — arrastre y suelte entidades, explore conexiones de forma interactiva. - **20+ transformaciones integradas** — DNS, WHOIS, certificados SSL, geolocalización, enriquecimiento web/correo electrónico/hash/redes sociales y más. - **Transform Hub** — explore e instale transformaciones comunitarias desde el [registro](https://github.com/opengraphintel/ogi-transforms). - **AI Investigator** — investigaciones agénticas basadas en indicaciones que planifican ejecuciones de transformaciones, transmiten el progreso en vivo y resumen hallazgos con capacidad de auditoría. - **Importar / Exportar** — importación en formato JSON, CSV, GraphML y MTGX. - **Análisis de grafos** — centralidad, detección de comunidades, caminos más cortos. - **Colaboración en tiempo real** — proyectos, compartición y sincronización en vivo mediante Supabase Realtime. - **Trabajos de transformación asíncronos** — cola Redis/RQ con actualizaciones de progreso vía WebSocket. - **Sistema de plugins** — descubrimiento de plugins basado en directorios con manifiestos YAML. - **Herramienta CLI** — busque, instale y administre transformaciones desde la terminal. - **Ejecutable en cualquier lugar** — modo local con SQLite (sin configuración) o PostgreSQL + Supabase para configuraciones en equipo/nube. - **Listo para Docker** — despliegue con un solo comando usando `docker compose up`. ## Capturas de pantalla <div align="center"> | Investigación con grafos | Enriquecimiento de entidades | | :----------------------------------------: | :----------------------------------------: | |  |  | | Transform Hub | Exportar / Importar | | :----------------------------------------: | :----------------------------------------: | |  |  | </div> ## Inicio rápido ### Requisitos previos | Herramienta | Versión | | -------------------------------- | ------- | | [Python](https://www.python.org) | 3.14+ | | [uv](https://docs.astral.sh/uv/) | latest | | [Node.js](https://nodejs.org) | 20+ | | [pnpm](https://pnpm.io) | latest | ### Backend```bash cd backend uv sync uv run uvicorn ogi.main:app --reload ``` La API estará disponible en `http://localhost:8000`. Para la ejecución de transformación local, Redis y el worker de transformación también deben estar ejecutándose. Solo Redis no es suficiente. Iniciar Redis:```bash docker run -d --name ogi-redis -p 6379:6379 redis:7-alpine ``` Inicia el worker de transformación en una segunda terminal:```bash cd backend uv run python -m ogi.worker.run_worker ``` Si ves `Job queue not available` o `Redis not available`, verifica que: - `OGI_REDIS_URL` apunta a `redis://localhost:6379/0` para ejecuciones locales en el host - el backend se reinició después de que Redis se iniciara - el proceso worker separado está en ejecución - no estás usando el nombre de host exclusivo de Docker `redis` fuera de Docker Compose Si ejecutas el backend contra PostgreSQL (`OGI_USE_SQLITE=false`), el inicio aplicará automáticamente las migraciones de Alembic antes de servir las solicitudes. Las implementaciones de Docker hacen lo mismo en el entrypoint del contenedor del backend. Las ejecuciones de AI Investigator son procesadas por otro worker separado:```bash cd backend uv run python -m ogi.agent.run_worker ``` ### Frontend```bash cd frontend pnpm install pnpm dev ``` Abre http://localhost:5173. Eso es todo. ### AI Investigator AI Investigator es un flujo de trabajo opcional respaldado por un proveedor que puede planificar secuencias de transformación, solicitar aprobaciones y resumir el progreso de la investigación dentro del espacio de trabajo. - Abre la pestaña `AI Investigator` dentro de un proyecto - Configura un proveedor y un modelo en el diálogo de configuración del investigador - Almacena las claves API del proveedor en `API Keys` - Ejecuta el proceso separado `agent-worker` junto al backend La implementación actual soporta configuración de proveedor por usuario y un trabajador dedicado que ejecuta pasos de investigación de forma independiente del servidor API principal. ### CLI Dos formas compatibles de ejecutar la CLI: **Recomendado** (sin necesidad de activación):```bash cd backend uv sync uv run ogi --help ``` **Virtualenv activado** (comando `ogi` simple):```bash cd backend uv venv # PowerShell: .\.venv\Scripts\Activate.ps1 uv pip install -e . ogi --help ``` ## Docker ### Desarrollo```bash cp .env.example .env docker compose up ``` ### Producción Usa las imágenes GHCR preconstruidas. Importante: [docker-compose.prod.yml](https://github.com/khashashin/ogi/blob/main/docker-compose.prod.yml) requiere una base de datos PostgreSQL externa. No incluye un servicio `db`. Si quieres la pila Docker local todo en uno con Postgres y Redis integrados, usa:```bash docker compose up -d ``` Use el archivo de compose de producción solo cuando ya tenga una instancia de PostgreSQL accesible y haya configurado `OGI_DATABASE_URL` en consecuencia:```bash docker compose -f docker-compose.prod.yml pull docker compose -f docker-compose.prod.yml up -d ``` Establece `OGI_IMAGE_TAG` en `.env` para fijar una etiqueta de imagen de lanzamiento específica (por ejemplo, `v0.2.6`). Por defecto es `latest`. ### Hetzner Cloud [](https://hetzner.cloud/?ref=LspEGc99USBa) [](https://console.hetzner.com/deploy/docker-ce) Los nuevos usuarios de Hetzner pueden usar el primer enlace para registrarse con créditos de Hetzner Cloud. Es un enlace de referencia, por lo que el mantenedor de OGI también puede recibir créditos de Hetzner Cloud si la referencia califica. Después de crear un servidor, usa los comandos de implementación de Docker anteriores para ejecutar OGI. ### Límites de transformación configurables OGI incluye valores máximos sensatos por transformación para cosas como `max_results`, `max_links`, `max_urls` y `max_content_chars`, pero estos límites ahora se pueden sobrescribir de forma centralizada para que las implementaciones en la nube puedan aplicarlos sin codificar límites locales. Usa `OGI_TRANSFORM_SETTING_MAX_OVERRIDES` en `.env`:```env OGI_TRANSFORM_SETTING_MAX_OVERRIDES=max_results=50,max_urls=25,max_links=40,max_content_chars=20000 ``` Para eliminar capacidades específicas en un despliegue local-first:```env OGI_TRANSFORM_SETTING_MAX_OVERRIDES=max_results=none,max_urls=none,max_links=none,max_content_chars=none ``` La anulación se basa en el nombre de la configuración de transformación y se aplica a las transformaciones integradas y a los plugins comunitarios que utilizan la base/tiempo de ejecución compartida de OGI. ### Instancia cloud alojada y plan de Soporte La versión cloud alojada en [ogi.khas.app](https://ogi.khas.app) fue construida inicialmente para que los usuarios pudieran probar OGI rápidamente antes de decidir si alojarlo ellos mismos. Desde entonces se ha convertido en la forma más popular de usar el proyecto, con más de 350 usuarios cloud activos. Ese uso también incrementó los costos de infraestructura para este proyecto secundario. El repositorio por lo tanto incluye una suscripción de Soporte solo para cloud y un sistema de enfriamiento de ejecuciones de transformadores. En la instancia cloud pública, los usuarios gratuitos pueden estar limitados por un tiempo de espera entre ejecuciones de transformadores, mientras que los usuarios de Soporte pueden suscribirse por un simbólico USD 3/mes para ayudar a cubrir los costos de Supabase y VPS. Las suscripciones de Soporte pueden cancelarse desde los controles de facturación del perfil o el portal de facturación de Stripe. La cancelación detiene la facturación futura, pero los períodos de suscripción pagados no se reembolsan ni se prorratean. Este código de facturación está intencionalmente protegido por configuración: solo tiene efecto cuando `OGI_DEPLOYMENT_MODE=cloud` y `OGI_CLOUD_BILLING_ENABLED=true`. Las implementaciones autoalojadas deben dejar la facturación deshabilitada y no deberían ver ningún comportamiento de facturación o muro de pago. ### Telemetría OGI incluye telemetría de producto a nivel de instalación destinada a ayudarnos a comprender el uso en el mundo real, especialmente en implementaciones autoalojadas. - `OGI_TELEMETRY_ENABLED=true` habilita la recolección de telemetría - `OGI_TELEMETRY_LEVEL=full` es el nivel de recolección predeterminado - establezca `OGI_TELEMETRY_ENABLED=false` para deshabilitar la telemetría por completo - establezca `OGI_TELEMETRY_LEVEL=basic` para reducir lo que se envía `basic` envía: - la versión de OGI - un ping diario de instalación activa `full` adicionalmente envía: - fecha de creación de la instancia - conteos agregados de proyectos, entidades, aristas, ejecuciones de transformadores, ejecuciones de investigador y usuarios activos para el período - transformaciones instaladas con sus versiones La telemetría está diseñada para evitar enviar contenidos del grafo, valores de entidades, claves API, prompts u otros datos de investigación. Los detalles de la política actual también se publican en la [Política de Privacidad](https://ogi.khas.app/privacy#telemetry). <details> <summary><strong>Servicios de Desarrollo con Compose</strong></summary> | Servicio | Descripción | Puerto | | ------------- | ----------------------------------- | ------ | | `backend` | servidor de aplicaciones FastAPI | 8000 | | `worker` | trabajador de trabajos asíncronos RQ| - | | `agent-worker`| trabajador de Investigador IA | - | | `frontend` | aplicación React servida a través de nginx| 80 | | `db` | PostgreSQL 16 | 5432 | | `redis` | Redis 7 (cola de trabajos) | 6379 | </details> <details> <summary><strong>Servicios de Producción con Compose</strong></summary> | Servicio | Descripción | Puerto | | ------------- | ----------------------------------- | ------ | | `backend` | servidor de aplicaciones FastAPI | 8000 | | `worker` | trabajador de trabajos asíncronos RQ| - | | `agent-worker`| trabajador de Investigador IA | - | | `frontend` | aplicación React servida a través de nginx| 80 | | `redis` | Redis 7 (cola de trabajos) | 6379 | `docker-compose.prod.yml` espera una base de datos PostgreSQL externa a través de `OGI_DATABASE_URL`. </details> --- <details> <summary><strong>Dependencias de plugins al inicio</strong></summary> Si usas imágenes preconstruidas y un plugin necesita bibliotecas Python adicionales, OGI instala las dependencias del plugin al inicio del contenedor desde: 1. `plugins/requirements.txt` (preferido), o 2. requisitos generados automáticamente derivados de `plugins/ogi-lock.json` cuando falta `requirements.txt`. **Variables de entorno:** | Variable | Predeterminado | Descripción | | --------------------------------- | -------------------------------- | ------------------------------------------------- | | `OGI_BOOT_REQUIREMENTS_ENABLE` | `true` | Habilitar/deshabilitar instalación al inicio | | `OGI_BOOT_REQUIREMENTS_FILE` | `/app/plugins/requirements.txt` | Ruta al archivo de requisitos | | `OGI_BOOT_LOCK_FILE` | `/app/plugins/ogi-lock.json` | Ruta al archivo de bloqueo | | `OGI_BOOT_REQUIREMENTS_STRICT` | `false` | Fallar inicio si faltan requisitos | | `OGI_BOOT_REQUIREMENTS_CACHE_DIR` | `/tmp/ogi-boot` | Directorio temporal/caché para requisitos generados| </details> --- ## Centro de Transformaciones OpenGraph Intel tiene un mercado de transformaciones integrado. Navega, instala y gestiona transformaciones desde el [repositorio comunitario](https://github.com/opengraphintel/ogi-transforms). > **Nota de seguridad:** Los plugins que requieren claves API deben tratarse como código privilegiado. Si un plugin puede acceder a tus secretos y realizar solicitudes de red salientes, puede hacer mal uso o extraer esos secretos. Revisa el nivel de confianza, los permisos y los servicios requeridos antes de instalar o ejecutar plugins de terceros.```bash # Search for transforms uv run ogi transform search dns # Install a transform uv run ogi transform install shodan-host-lookup ``` ### Categorías de Transformaciones Integradas | Categoría | Ejemplos | | -------------- | ----------------------------------------------- | | DNS | A, AAAA, MX, NS, CNAME registros | | IP y ASN | GeoIP, IP inversa, información ASN | | SSL/TLS | Transparencia de certificados, SSL labs | | Correo electrónico | Validación de servidor de correo, verificaciones de brechas | | Web | WHOIS, información de dominio, extracción web | | Social | Enumeración de nombres de usuario, perfiles sociales | | Hash | Consultas MD5, SHA1, SHA256 | | Ubicación | Geocodificación, clima, datos ASN cercanos | ### Tipos de Entidad Compatibles `Person` • `Username` • `Domain` • `IPAddress` • `EmailAddress` • `PhoneNumber` • `Organization` • `URL` • `SocialMedia` • `Hash` • `Document` • `Location` • `ASNumber` • `Network` • `MXRecord` • `NSRecord` • `Nameserver` • `SSLCertificate` • `Subdomain` • `HTTPHeader` ### Construyendo Tus Propias Transformaciones ¿Quieres construir las tuyas? Consulta la [guía de contribución](https://github.com/opengraphintel/ogi-transforms/blob/main/CONTRIBUTING.md). Si tu transformación necesita credenciales de servicio externas, decláralas en `api_keys_required`. No almacenes secretos en la configuración de la transformación. OGI los gestiona bajo `API Keys`, y los plugins que usan secretos se consideran código privilegiado. Si tu transformación expone configuraciones limitadas como `max_results` o `max_content_chars`, prefiere nombres de configuración estables sobre nombres personalizados únicos cuando sea posible. OGI puede anular centralmente los valores máximos con `OGI_TRANSFORM_SETTING_MAX_OVERRIDES`, lo que ayuda a que las implementaciones en la nube apliquen límites mientras que los usuarios locales pueden eliminarlos. Cada plugin es un directorio con un manifiesto `plugin.yaml`:```yaml name: my-transform version: "1.0.0" display_name: My Transform description: What it does author: Your Name license: MIT category: dns input_types: [Domain] output_types: [IPAddress] permissions: network: true filesystem: false subprocess: false ``` ## Arquitectura ### Stack Tecnológico | Capa | Tecnología | | ----------------------- | --------------------------------------------------------------------------- | | Backend | Python 3.14+, FastAPI, SQLModel, asyncpg / aiosqlite | | Frontend | React 19, TypeScript 5.9, Sigma.js (graphology), Zustand, Tailwind CSS 4 | | Base de datos | PostgreSQL 16 (principal) / SQLite (fallback local) | | Autenticación y tiempo real | Supabase Auth + JWT + Realtime (opcional en modo local) | | Cola de trabajos | Redis 7 + RQ (transformaciones asíncronas) | | Runtime de IA | Trabajador Investigador de IA respaldado por proveedor con orquestación de transformaciones auditadas | | Gestores de paquetes | uv (backend), pnpm (frontend) | | Despliegue | Docker, nginx, GHCR | ### Estructura del Proyecto``` ogi/ ├── backend/ │ └── ogi/ │ ├── api/ # REST API routes │ ├── cli/ # CLI tool (Typer) │ ├── db/ # Database layer (asyncpg + aiosqlite) │ ├── engine/ # Graph engine & transform engine │ ├── models/ # SQLModel definitions │ ├── store/ # Data stores │ ├── transforms/ # Built-in transforms │ │ ├── dns/ # DNS resolution transforms │ │ ├── cert/ # SSL certificate transforms │ │ ├── email/ # Email enrichment │ │ ├── hash/ # Hash lookups │ │ ├── ip/ # IP/ASN/geolocation │ │ ├── org/ # Organization info │ │ ├── social/ # Social media │ │ └── web/ # Web scraping/extraction │ ├── worker/ # Async job queue (RQ) │ ├── config.py # Pydantic settings │ └── main.py # FastAPI entry point ├── frontend/ │ └── src/ │ ├── api/ # API client │ ├── components/ # React components │ ├── hooks/ # Custom hooks (realtime sync, etc.) │ ├── stores/ # Zustand state management │ ├── types/ # TypeScript types │ └── App.tsx # Main application ├── plugins/ # Community plugins directory ├── docs/ # Documentation & images ├── docker-compose.yml # Development deployment ├── docker-compose.prod.yml # Production deployment └── .env.example # Environment template ``` ### Configuración OGI utiliza [pydantic-settings](https://docs.pydantic.dev/latest/concepts/pydantic_settings/) con soporte para archivos `.env`. Las variables de ejecución/backend tienen el prefijo `OGI_`. Las configuraciones de tipo lista aceptan: - Arreglos JSON, por ejemplo `["plugins","../plugins"]` - cadenas separadas por comas, por ejemplo `plugins,../plugins` <details> <summary><strong>Variables de entorno clave</strong></summary> | Variable | Descripción | Por defecto | | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | | `OGI_APP_NAME` | Nombre de la aplicación | `OGI` | | `OGI_HOST` | Host de enlace del backend | `0.0.0.0` | | `OGI_PORT` | Puerto del backend | `8000` | | `OGI_CORS_ORIGINS` | Orígenes de frontend permitidos | `http://localhost:5173,http://localhost:3000` | | `OGI_USE_SQLITE` | Usar SQLite en lugar de PostgreSQL | `true` | | `OGI_DB_PATH` | Ruta del archivo de base de datos SQLite | `ogi.db` | | `OGI_DATABASE_URL` | Cadena de conexión PostgreSQL | `postgresql://postgres:postgres@localhost:5432/ogi` | | `OGI_REDIS_URL` | Cadena de conexión Redis para RQ/trabajos | `redis://localhost:6379/0` | | `OGI_RQ_QUEUE_NAME` | Nombre de la cola para trabajos de transformación | `transforms` | | `OGI_TRANSFORM_TIMEOUT` | Tiempo de espera por trabajo de transformación en segundos | `300` | | `OGI_AGENT_WORKER_POLL_INTERVAL_SEC` | Intervalo de sondeo para el trabajador del Investigador IA | `2.0` | | `OGI_AGENT_CLAIM_TIMEOUT_SEC` | Tiempo de espera por reclamo obsoleto para recuperación de pasos del Investigador IA | `120` | | `OGI_AUTO_RUN_MIGRATIONS` | Ejecutar automáticamente Alembic al inicio local sin SQLite | `true` | | `OGI_RUN_DB_MIGRATIONS` | Ejecutar migraciones de BD en el punto de entrada del contenedor | `false` | | `OGI_DB_MIGRATION_RETRIES` | Número de reintentos de migración en el punto de entrada | `30` | | `OGI_DB_MIGRATION_DELAY_SECONDS` | Retraso entre reintentos de migración en el punto de entrada | `2` | | `OGI_PLUGIN_DIRS` | Directorios de búsqueda de plugins | `plugins,../plugins` | | `OGI_DEPLOYMENT_MODE` | Modo de despliegue (`self-hosted` o `cloud`) | `self-hosted` | | `OGI_CLOUD_BILLING_ENABLED` | Activar facturación de Soporte solo en nube y cumplimiento de enfriamiento de transformación | `false` | | `OGI_FREE_TRANSFORM_COOLDOWN_SECONDS` | Enfriamiento entre ejecuciones de transformador de usuario gratuito en la nube | `1800` | | `OGI_PAID_TRANSFORM_COOLDOWN_SECONDS` | Enfriamiento entre ejecuciones de transformador de usuario de pago en la nube | `0` | | `OGI_STRIPE_SECRET_KEY` | Clave secreta del lado del servidor de Stripe para sesiones de Checkout y portal | sin establecer | | `OGI_STRIPE_WEBHOOK_SECRET` | Secreto de firma de webhook de Stripe | sin establecer | | `OGI_STRIPE_SUPPORTER_PRICE_ID` | ID de precio recurrente de Stripe para el plan de Soporte | sin establecer | | `OGI_STRIPE_SUPPORTER_AMOUNT_CENTS` | Monto mostrado para el plan de Soporte | `300` | | `OGI_STRIPE_SUPPORTER_CURRENCY` | Moneda mostrada para el plan de Soporte | `usd` | | `OGI_BILLING_SUCCESS_URL` | Redirección opcional de éxito de Stripe Checkout | derivado de la solicitud | | `OGI_BILLING_CANCEL_URL` | Redirección opcional de cancelación de Stripe Checkout | derivado de la solicitud | | `OGI_BILLING_PORTAL_RETURN_URL` | URL de retorno opcional del portal de facturación de Stripe | derivado de la solicitud | | `OGI_REGISTRY_REPO` | Repositorio de GitHub del registro de transformaciones | `opengraphintel/ogi-transforms` | | `OGI_REGISTRY_CACHE_TTL` | TTL de caché del registro en segundos | `3600` | | `OGI_TRANSFORM_SETTING_MAX_OVERRIDES` | Mapa opcional de anulación máxima global para configuraciones de transformación | vacío | | `OGI_GITHUB_TOKEN` | Token opcional de GitHub para límites de tasa de registro/API | sin establecer | | `OGI_SUPABASE_URL` | URL del proyecto Supabase | sin establecer | | `OGI_SUPABASE_ANON_KEY` | Clave anónima/pública de Supabase | sin establecer | | `OGI_SUPABASE_SERVICE_ROLE_KEY` | Clave de función de servicio de Supabase | sin establecer | | `OGI_SUPABASE_JWT_SECRET` | Secreto JWT de Supabase | sin establecer | | `OGI_SUPABASE_REDIRECT_URL` | URL de redirección utilizada por flujos de autenticación del frontend | sin establecer | | `OGI_ADMIN_EMAILS` | Usuarios administradores para gestión de registro/plugins | sin establecer | | `OGI_TELEMETRY_ENABLED` | Habilitar o deshabilitar telemetría a nivel de instalación | `true` | | `OGI_TELEMETRY_LEVEL` | Nivel de telemetría (`basic` o `full`) | `full` | | `OGI_API_KEY_ENCRYPTION_KEY` | Clave Fernet para almacenamiento cifrado de claves API | sin establecer pero muy recomendado | | `OGI_API_KEY_INJECTION_ALLOW_COMMUNITY_PLUGINS` | Permitir que plugins comunitarios reciban claves API almacenadas | `true` | | `OGI_API_KEY_INJECTION_TRUSTED_TIERS_ONLY` | Restringir inyección de claves almacenadas solo a niveles de confianza | `false` | | `OGI_API_KEY_INJECTION_ALLOWED_TIERS` | Niveles permitidos cuando el modo solo confiable está habilitado | `official,verified` | | `OGI_API_KEY_SERVICE_ALLOWLIST` | Servicios permitidos opcionales para inyección de claves almacenadas | vacío | | `OGI_API_KEY_SERVICE_BLOCKLIST` | Servicios bloqueados opcionales para inyección de claves almacenadas | vacío | | `OGI_LLM_PROVIDER` | Proveedor predeterminado de respaldo del Investigador IA | `openai` | | `OGI_LLM_MODEL` | Modelo predeterminado de respaldo del Investigador IA | `gpt-4.1-mini` | ``` --- [Read more](https://github.com/khashashin/ogi)
