El kolo es un baile en corro: personas iguales, de la mano, nadie en medio. Kolo funciona igual. Cada peer tiene su propia clave, encuentra a los demás por topic, se conecta a ellos directamente y mantiene un log firmado que cualquiera puede comprobar. Ningún servidor se interpone en el camino de tus datos.
Kolo está hecho por Ciranda.
¿Acabas de llegar? Empieza por el tutorial Construye un chat en tu terminal: dos peers en tu ordenador, paso a paso, en unos diez minutos.
Qué hay en el stack
Un conjunto de pequeñas bibliotecas, cada una con una sola tarea. Puedes usar una por separado o combinarlas.
Datos
- kolo-idIdentidad del peer. Claves Ed25519 e identificadores cortos, una frase de recuperación de 24 palabras y certificados de dispositivo.
- kolo-codecCodificación binaria compacta para mensajes.
- kolo-logLog firmado, append-only, con pruebas de Merkle, según el RFC 9162.
- kolo-storeAlmacenamiento local para logs y claves, sobre Pebble.
- kolo-blobsAlmacenamiento de archivos cifrado y direccionado por contenido, legible en cualquier rango.
- kolo-filesCarpetas, nombres y versiones cifrados sobre kolo-blobs.
- kolo-syncCopia un log de un peer a otro. Solo en modo pull.
- kolo-kvUn almacén clave-valor sobre un log, con un solo escritor.
- kolo-braidLos logs firmados de varios miembros, unidos en un solo orden determinista.
Red
- kolo-transportConexiones entre peers, directas cuando se puede.
- kolo-secureCanal TLS 1.3 ligado a la clave del peer.
- kolo-dhtEncuentra peers por topic, sin servidor.
- kolo-swarmÚnete a un topic y recibe peers conectados.
- kolo-relayUn relay opcional para peers sin camino directo.
- kolo-inviteCódigos de invitación para un grupo o un dispositivo nuevo: crea uno, únete con él, aprueba o rechaza.
- kolo-moqPublica, suscríbete y reenvía tracks en vivo, con MoQ Transport draft 22.
- kolo-mediaUn catálogo, un reloj, la reproducción y la sincronía A/V de frames de audio y video sobre kolo-moq.
- kolo-audioDispositivos de audio, reproducción, remuestreo, mezcla y Opus, sin cgo.
- kolo-videoCaptura de cámara, frames I420, VP8 y VP9, y H.264 opcional con el códec del sistema operativo.
Servidores que ejecutas
Cómo encajan las piezas
Cómo encajan las bibliotecas
Cada biblioteca hace una sola cosa. Los pasos siguen a un peer desde su clave hasta sus datos en otros peers.
- kolo-id da a cada peer una clave Ed25519. La clave pública es la identidad del peer.
- kolo-dht y kolo-swarm encuentran los peers de un topic y se conectan a ellos. kolo-invite permite que un peer nuevo se una a un grupo con un código.
- kolo-transport lleva conexiones QUIC y kolo-secure ata cada una a la clave del peer. kolo-relay reenvía paquetes cifrados entre dos peers sin camino directo, solo cuando tu app se lo pide.
- kolo-log guarda un log firmado y append-only, kolo-codec codifica sus bytes y kolo-store lo guarda en disco. kolo-blobs guarda archivos cifrados como entradas de un log, y kolo-files añade nombres, carpetas y versiones encima.
- kolo-sync copia un log de un peer a otro, kolo-kv lee un log como un almacén clave-valor, y kolo-braid une los logs de varios miembros en un solo orden.
- Dos servidores que puedes ejecutar: kolo-node, el nodo de arranque por el que entran los peers nuevos, y kolo-pin, un pinning peer que mantiene los logs en línea como texto cifrado.
- Datos en vivo: kolo-moq publica tracks y se suscribe a ellos por esas conexiones, y un relay comparte una suscripción entre muchos suscriptores. kolo-media añade un catálogo, un reloj y la reproducción de frames de audio y video ya codificados. kolo-audio graba, reproduce y remuestrea audio y lo codifica con Opus. kolo-video captura la cámara y codifica y decodifica vídeo.
- kolo-id da a cada peer su clave Ed25519.
- kolo-dht y kolo-swarm encuentran los peers de un topic y se conectan a ellos, sobre kolo-transport y kolo-secure.
- kolo-log mantiene un log firmado y append-only, y kolo-store lo guarda en disco.
- kolo-sync copia un log de un peer a otro, y kolo-kv lee un log como un almacén clave-valor.
- kolo-node ejecuta el servidor de bootstrap por el que entran los peers nuevos, y kolo-relay ayuda a dos peers que no pueden alcanzarse, solo si lo activas.
- kolo-pin ejecuta un peer de anclaje que mantiene tus logs disponibles mientras tus dispositivos están desconectados, como texto cifrado que no puede leer.
- kolo-moq publica tracks en vivo y se suscribe a ellos por esas conexiones, y un relay comparte una suscripción entre muchos suscriptores. kolo-media añade un catálogo, un reloj y la reproducción de frames de audio y video ya codificados. kolo-audio lista dispositivos de audio, graba y reproduce, remuestrea y codifica audio con Opus. kolo-video lista y abre cámaras, y codifica y decodifica VP8 y VP9.
Por dónde empezar
- Construye un chat en tu terminal es el tutorial principal: cada comando y lo que deberías ver después de cada uno.
- Primeros pasos ejecuta dos peers en una misma máquina y deja que chateen.
- Ejecuta un peer de anclaje en un VPS pone un peer de anclaje en un servidor Linux y ancla un log en él.
- Ejecuta tu propia infraestructura tiene los comandos para tus propios nodos de entrada, relay y pin.
- Las Preguntas frecuentes responden dudas habituales, cada una con un enlace a la página que lo muestra.
- Conceptos explica los peers, los topics, los logs, las réplicas, el borrado y el relay, con una página para cada uno.
- Límites y Seguridad cuentan con palabras sencillas lo que Kolo todavía no hace.
- Para las ideas sin código, lee Cómo funciona y Casos de uso en kolo.ciranda.dev.
Estado
Versión 0.1, experimental. La API puede cambiar antes de la v1.0.0. Kolo solo usa IPv4. Cada página de esta documentación describe código que existe hoy; cuando falta algo, la página lo dice.