kolo docsbeta

Introdução

O Kolo é um conjunto de pequenas bibliotecas Go para criar apps peer-to-peer. Os peers se encontram, se conectam diretamente e mantêm um log assinado, sem nenhum servidor no meio.

Nesta página

Um kolo é uma dança de roda: pessoas iguais, de mãos dadas, ninguém no meio. O Kolo funciona do mesmo jeito. Cada peer tem a sua própria chave, encontra os outros pelo topic, se conecta a eles diretamente e mantém um log assinado que qualquer um pode verificar. Nenhum servidor fica no caminho dos seus dados.

O Kolo é feito pela Ciranda.

Chegou agora? Comece pelo tutorial Construa um chat no seu terminal: dois peers no seu computador, passo a passo, em uns dez minutos.

O que tem na stack

Um conjunto de pequenas bibliotecas, cada uma com uma única tarefa. Você pode usar uma delas sozinha ou combinar várias.

Dados

Rede

Servidores que você roda

Como as peças se encaixam

Todos os passos

Como as bibliotecas se encaixam

Cada biblioteca faz uma só coisa. Os passos seguem um peer da sua chave até os seus dados em outros peers.

  1. kolo-id dá a cada peer uma chave Ed25519. A chave pública é a identidade do peer.
  2. kolo-dht e kolo-swarm encontram os peers de um topic e se conectam a eles. kolo-invite deixa um peer novo entrar em um grupo com um código.
  3. kolo-transport leva conexões QUIC e kolo-secure liga cada uma à chave do peer. kolo-relay repassa pacotes criptografados entre dois peers sem caminho direto, só quando o seu app pede.
  4. kolo-log guarda um log assinado e append-only, kolo-codec codifica os seus bytes e kolo-store o guarda em disco. kolo-blobs guarda arquivos criptografados como entradas de um log, e kolo-files acrescenta nomes, pastas e versões por cima.
  5. kolo-sync copia um log de um peer para outro, kolo-kv lê um log como um armazenamento chave-valor, e kolo-braid une os logs de vários membros em uma única ordem.
  6. Dois servidores que você pode rodar: kolo-node, o nó de bootstrap por onde os peers novos entram, e kolo-pin, um pinning peer que mantém os logs online como texto cifrado.
  7. Dados ao vivo: kolo-moq publica tracks e os assina por essas conexões, e um relay compartilha uma assinatura entre muitos assinantes. kolo-media acrescenta um catálogo, um relógio e a reprodução de frames de áudio e vídeo já codificados. A kolo-audio grava, reproduz e reamostra áudio e o codifica com Opus. A kolo-video captura a câmera e codifica e decodifica vídeo.
  • kolo-id dá a um peer a sua chave Ed25519.
  • kolo-dht e kolo-swarm encontram os peers de um topic e se conectam a eles, por meio de kolo-transport e kolo-secure.
  • kolo-log mantém um log assinado e append-only, e kolo-store o guarda em disco.
  • kolo-sync copia um log de um peer para outro, e kolo-kv lê um log como um armazenamento chave-valor.
  • kolo-node roda o servidor de bootstrap por onde os novos peers entram, e kolo-relay ajuda dois peers que não conseguem se alcançar, só se você ativá-lo.
  • kolo-pin roda um peer de fixação que mantém os seus logs disponíveis enquanto os seus dispositivos estão offline, como texto cifrado que ele não consegue ler.
  • kolo-moq publica tracks ao vivo e os assina por essas conexões, e um relay compartilha uma assinatura entre muitos assinantes. kolo-media acrescenta um catálogo, um relógio e a reprodução de frames de áudio e vídeo já codificados. kolo-audio lista dispositivos de áudio, grava e reproduz, reamostra e codifica áudio com Opus. A kolo-video lista e abre câmeras, e codifica e decodifica VP8 e VP9.

Por onde começar

Status

Versão 0.1, experimental. A API pode mudar antes da v1.0.0. O Kolo usa só IPv4. Cada página aqui descreve código que existe hoje; quando falta alguma coisa, a página avisa.