kolo docsbeta

Ejecuta tu propia infraestructura

Comandos para copiar y pegar con los que ejecutar tu propio nodo de entrada, tu relay y tu pin, y apuntar a ellos los ejemplos de Kolo. No hay ningún relay ni ningún pin públicos.

En esta página

Los ejemplos de Kolo no necesitan ningún servidor tuyo para empezar: por defecto entran en la red pública. Ejecutas servidores tú mismo para tu propia red, para un relay o para un pin. Un nodo de entrada es la dirección a la que cada ejemplo se dirige primero para encontrar a los demás. Un relay lleva la conexión entre dos ordenadores que no pueden conectarse directamente. Un pin guarda una copia cifrada de un log para quien está sin conexión. Esta página tiene los comandos de cada uno y los flags que apuntan los ejemplos a ellos.

Un ejemplo tiene tres modos de red:

  • Red pública (por defecto). Sin ningún flag, el ejemplo usa los dos nodos de entrada públicos que ejecuta Ciranda, incluidos en las bibliotecas. Dos personas en redes distintas se encuentran sin configurar nada. Es gratis y sin garantía de disponibilidad mientras Kolo sea una beta.
  • Tu propia red. -bootstrap host:port[,host:port] usa solo los nodos de entrada que indicas: los públicos no se tocan. Los ejecutas con kolo-node, más abajo.
  • Solo este ordenador. -local mantiene todo en 127.0.0.1: la primera ventana ejecuta un nodo de entrada y las demás se unen a él. Kolo Share, Kolo Meet y Kolo Board lo tienen; Kolo Chat no tiene modo local, y su propia red es -bootstrap. -local junto con -bootstrap es un error.

Si no se puede llegar a la red pública al arrancar, el ejemplo muestra un error que nombra estas tres opciones; nunca recurre a otra red por su cuenta.

No hay ningún relay ni ningún pin públicos, y ningún ejemplo usa uno por defecto. Los dos siguen siendo opcionales (-relay, -pin) y ejecutas los tuyos. Un relay solo importa detrás de NATs estrictos, donde dos ordenadores no pueden conectarse directamente.

Todos los pasos

Los servidores que ejecutas

Los ejecutas tú para tu propia red. No hay ningún relay ni ningún pin públicos; los nodos de entrada públicos son de Ciranda y son los de por defecto.

  1. Con -bootstrap, un ejemplo usa solo la dirección de tu nodo de entrada y a través de él encuentra los otros ejemplos de su topic. Sin ningún flag usa los nodos de entrada públicos.
  2. Dos ejemplos se conectan directamente cuando pueden. El nodo de entrada solo los ayuda a encontrarse y no transporta ninguno de sus datos.
  3. Si la conexión directa falla, dos ejemplos se encuentran a través de un relay que ambos indican con -relay host:port@key. El relay copia bytes cifrados que no puede leer.
  4. Kolo Chat además guarda en un pin una copia cifrada del log de cada miembro. Un ejemplo llega al pin directamente, nunca a través de un relay, así que el pin necesita una dirección a la que lleguen todos los miembros.
ServidorComandoPuerto por defectoLo usa
Nodo de entradakolo-node runUDP 7447cada ejemplo
Relaykolo-node relayUDP 7448 (-listen)Kolo Chat, Kolo Share y Kolo Meet, cuando indicas uno
Pinkolo-pin runUDP 7450 (-listen)Kolo Chat

Los comandos de abajo usan 203.0.113.10 como dirección de tu servidor. Usa su dirección IPv4 pública real, o un nombre que resuelva a ella. Kolo es solo IPv4. Abre cada puerto UDP que uses en el cortafuegos de la máquina y en el del proveedor.

Instala los comandos

Instala kolo-node, que ejecuta nodos de entrada y relays:

Terminal
go install github.com/ciranda-dev/kolo-node/cmd/kolo-node@v0.1.0

Instala kolo-pin, para un pin:

Terminal
go install github.com/ciranda-dev/kolo-pin/cmd/kolo-pin@v0.1.0

Los dos son solo Go, sin cgo, y go install los deja en $(go env GOPATH)/bin, que debe estar en tu PATH.

Ejecuta un nodo de entrada

El primer nodo de entrada de tu red arranca con -first, porque todavía no hay nodos de entrada. Crea su archivo de clave con modo 0600 en el primer arranque y lo conserva para los siguientes:

Terminal
kolo-node run -listen 0.0.0.0:7447 -identity "$HOME/kolo-node/node.key" -first

Un segundo nodo de entrada, en otra máquina, se une al primero con -bootstrap, para que la red siga en pie cuando uno de los dos se detiene:

Terminal
kolo-node run -listen 0.0.0.0:7447 -identity "$HOME/kolo-node/node.key" -bootstrap 203.0.113.10:7447

-bootstrap acepta una lista separada por comas y se puede repetir, -bootstrap-file lee un host:port por línea, y KOLO_BOOTSTRAP solo se lee cuando no se da ninguno de los dos; como máximo 16 entradas en total. Sin ninguno de ellos y sin -first, run sale con el código 2, así que una lista que quedó vacía por error nunca arranca un nodo aislado.

Abre su puerto. Con ufw:

Terminal
sudo ufw allow 7447/udp

Desde cada ordenador que vaya a ejecutar un ejemplo, comprueba que el nodo responde. Imprime ok 203.0.113.10:7447:

Terminal
kolo-node check 203.0.113.10:7447

La lista de nodos de entrada no es un secreto ni un control de acceso: cualquiera que conozca una dirección puede unirse a esa red. Consulta kolo-node para ver el archivo de configuración, la unidad de systemd y los límites.

Ejecuta un relay

Un relay tiene su propio archivo de clave y su propio puerto UDP. Al arrancar registra su clave como key en su línea identity: es la <relay-key> de abajo, 64 caracteres hexadecimales.

Terminal
kolo-node relay -listen 0.0.0.0:7448 -identity "$HOME/kolo-node/relay.key"

Sin -allow-file el relay está abierto: cualquier clave puede ocupar una plaza (una reserva) en él, y registra el aviso open relay. Con -allow-file, solo las claves del archivo pueden ocupar una plaza: una clave por línea, en 64 caracteres hexadecimales, con comentarios #. Cada ejemplo imprime su propia clave en el terminal, en su línea kolo-id. Cualquier clave puede seguir conectándose a través del relay a un ejemplo que ocupe una plaza en él.

Terminal
kolo-node relay -listen 0.0.0.0:7448 -identity "$HOME/kolo-node/relay.key" -allow-file "$HOME/kolo-node/allow.txt"

Una lista de permitidos no puede nombrar una clave creada para un solo código de emparejamiento o una sola llamada. Por eso, con -allow-file, un código de emparejamiento de Kolo Share nunca espera en el relay, y el relay de una llamada de Kolo Meet no puede ocupar una plaza en él: un invitado que no llega directamente al anfitrión necesita un relay sin lista de permitidos.

Abre su puerto. Con ufw:

Terminal
sudo ufw allow 7448/udp

Desde cada ordenador, comprueba que el relay responde con esa clave. Imprime ok relay 203.0.113.10:7448@<relay-key> y no reserva nada:

Terminal
kolo-node check -relay 203.0.113.10:7448@<relay-key>

Los límites del relay (plazas, sesiones, bytes, ritmo) son flags -relay-*; consulta kolo-node y kolo-relay.

Ejecuta un pin

Solo Kolo Chat usa un pin, y es opcional. Guarda una copia cifrada del log de cada miembro y nunca recibe las claves para leerla. Arráncalo con una carpeta de datos privada y un límite de tamaño:

Terminal
kolo-pin run -data "$HOME/kolo-pin" -listen 0.0.0.0:7450 -max-bytes 100GB

Imprime su clave pública, que va después de la @ en la lista de pins de los ejemplos:

Terminal
kolo-pin id -data "$HOME/kolo-pin"

La carpeta de datos se crea con modo 0700 y el archivo de clave con 0600. Para aceptar solo a tu gente, añade -owners con la clave de cada miembro, separadas por comas.

A un pin se llega directamente, nunca a través de un relay: necesita una dirección a la que lleguen todos los miembros, una dirección IPv4 pública o un router que le reenvíe el puerto UDP 7450. Abre su puerto. Con ufw:

Terminal
sudo ufw allow 7450/udp

Para ejecutarlo con systemd y vigilarlo, consulta Ejecuta un peer de anclaje en un VPS.

Apunta los ejemplos a ellos

Cada ejemplo recibe tus propios nodos de entrada con -bootstrap host:port; sin él, el ejemplo usa la red pública. Los relays se indican como host:port@key, con la clave en 64 caracteres hexadecimales:

  • -relay acepta una lista separada por comas y se puede repetir.
  • -relay-file lee un archivo de relays, uno por línea, con comentarios #.
  • Cada ejemplo tiene su propia variable de entorno, que solo se lee cuando no se da ninguno de los dos flags: KOLO_CHAT_RELAYS, KOLO_SHARE_RELAYS y KOLO_MEET_RELAYS.
  • Como máximo 16 relays en total. Se rechaza una clave en dos direcciones, o una dirección con dos claves.

Dos ordenadores solo se encuentran a través de un relay cuando los dos lo tienen en su lista, así que da a todos los ejemplos el mismo relay. Kolo Chat:

Terminal
./bin/kolo-chat -bootstrap 203.0.113.10:7447 -relay 203.0.113.10:7448@<relay-key>

Kolo Share:

Terminal
./bin/kolo-share -bootstrap 203.0.113.10:7447 -relay 203.0.113.10:7448@<relay-key>

Kolo Meet:

Terminal
./bin/kolo-meet -bootstrap 203.0.113.10:7447 -relay 203.0.113.10:7448@<relay-key>

La lista de pins de Kolo Chat es -pin IP:PORT@KEY o KOLO_CHAT_PIN, y la fija quien empieza la conversación; la invitación la lleva a todos los que se unen. La invitación no lleva los relays. Lo que necesita cada ejemplo está en Hecho con Kolo.

¿Por qué conexión voy?

Primero la directa, el relay como alternativa. Con relays en la lista, kolo-swarm intenta primero una conexión directa, con la perforación de NAT de kolo-dht, y solo prueba los relays cuando esta ha fallado. Un primer contacto puede tardar hasta 3 veces 45 segundos cuando las perforaciones empiezan pero nunca conectan, y después hasta 60 segundos por cada relay que prueba. A un peer que antes necesitó un relay se le llama la próxima vez directamente y a través de los relays a la vez, y una conexión directa que funciona sustituye a la que pasa por el relay.

Para ver en cuál estás:

  • En Go, Peer.Direct() es false para un peer al que se llega a través de un relay, y su Conn() es un *kolorelay.Conn cuyo RelayPublicKey() identifica el relay. Consulta kolo-swarm.
  • Kolo Meet marca con "via relay" el recuadro de una persona a la que se llega a través de un relay.
  • Kolo Chat y Kolo Share muestran cada relay y su estado en Ajustes.

Lo que puede ver quien opera un relay, en palabras del README de kolo-relay:

Lo que el relay llega a saber: las dos claves de cada sesión, las direcciones de los dos clientes, qué claves tienen reservas, cuándo empiezan y terminan las sesiones, y el tamaño y el ritmo de los paquetes internos. No puede leerlos ni cambiarlos, y siempre puede descartarlos, retrasarlos o cortarlos.

Los dos peers mantienen su propia conexión de kolo-secure a través del relay, así que este reenvía paquetes de una sesión de la que no forma parte. kolo-node relay no registra ninguna dirección ni ninguna clave de sus clientes. Un nodo de entrada no lleva ningún dato de las aplicaciones. Consulta Relay.

Siguientes pasos