kolo docsbeta

Introducción

Kolo es un conjunto de pequeñas bibliotecas de Go para crear aplicaciones peer-to-peer. Los peers se encuentran, se conectan directamente y mantienen un log firmado, sin ningún servidor en medio.

En esta página

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

Red

Servidores que ejecutas

Cómo encajan las piezas

Todos los pasos

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.

  1. kolo-id da a cada peer una clave Ed25519. La clave pública es la identidad del peer.
  2. 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.
  3. 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.
  4. 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.
  5. 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.
  6. 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.
  7. 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

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.