You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Dan Ballard 7a1c1eb97e Merge branch 'rename' of openprivacy/libricochet-go into master 1 year ago
Godeps Adding bulb to godep 2 years ago
application Rename 1 year ago
channels Rename 1 year ago
connection Rename 1 year ago
examples/echobot Rename 1 year ago
identity Rename 1 year ago
policies Rename 1 year ago
testing Rename 1 year ago
utils Rename 1 year ago
wire Rename 1 year ago
.gitignore Add script for coveralls 3 years ago
.travis.yml fmt and travis update 1 year ago
CONTRIBUTING.md Rename 1 year ago
LICENSE Brand new API v0.2 2 years ago
README.md Rename 1 year ago
inbound_version_negotiation_test.go Rename 1 year ago
outbound_version_negotiation_test.go Rename 1 year ago
private_key Refactor GoRicochet 3 years ago
ricochet.go Rename 1 year ago
ricochet_test.go Adding Open Connection Failed Test 1 year ago
testing.md Adding Open Connection Failed Test 1 year ago

README.md

libricochet-go Build Status Go Report Card Coverage Status

libricochet-go is an experimental implementation of the Ricochet Protocol in Go.

Features

  • A simple API that you can use to build Automated Ricochet Applications
  • A suite of regression tests that test protocol compliance.

Building an Automated Ricochet Application

Below is a simple echo bot, which responds to any chat message. You can also find this code under examples/echobot

package main

import (
  "git.openprivacy.ca/openprivacy/libricochet-go/application"
  "git.openprivacy.ca/openprivacy/libricochet-go/utils"
  "log"
  "time"
)

func main() {
  echobot := new(application.RicochetApplication)
  pk, err := utils.LoadPrivateKeyFromFile("./private_key")

  if err != nil {
    log.Fatalf("error reading private key file: %v", err)
  }

  l, err := application.SetupOnion("127.0.0.1:9051", "tcp4", "", pk, 9878)

  if err != nil {
    log.Fatalf("error setting up onion service: %v", err)
  }

  echobot.Init(pk, new(application.AcceptAllContactManager))
  echobot.OnChatMessage(func(rai *application.RicochetApplicationInstance, id uint32, timestamp time.Time, message string) {
    log.Printf("message from %v - %v", rai.RemoteHostname, message)
    rai.SendChatMessage(message)
  })
  log.Printf("echobot listening on %s", l.Addr().String())
  echobot.Run(l)
}

Each automated ricochet service can extend of the StandardRicochetService. From there certain functions can be extended to fully build out a complete application.

Security and Usage Note

This project is experimental and has not been independently reviewed. If you are looking for a quick and easy way to use ricochet please check out Ricochet IM.