1
0
Atdalīts 0
Iet uz failu
Dan Ballard 7a1c1eb97e Merge branch 'rename' of openprivacy/libricochet-go into master 2018-06-09 16:08:40 +00:00
Godeps Adding bulb to godep 2017-08-05 12:48:25 -07:00
application Rename 2018-06-08 15:05:22 -07:00
channels Rename 2018-06-08 15:05:22 -07:00
connection Rename 2018-06-08 15:05:22 -07:00
examples/echobot Rename 2018-06-08 15:05:22 -07:00
identity Rename 2018-06-08 15:05:22 -07:00
policies Rename 2018-06-08 15:05:22 -07:00
testing Rename 2018-06-08 15:05:22 -07:00
utils Rename 2018-06-08 15:05:22 -07:00
wire Rename 2018-06-08 15:05:22 -07:00
.gitignore Add script for coveralls 2016-11-08 14:11:21 -08:00
.travis.yml fmt and travis update 2018-05-09 12:40:07 -07:00
CONTRIBUTING.md Rename 2018-06-08 15:05:22 -07:00
LICENSE Brand new API v0.2 2017-05-02 16:33:51 -07:00
README.md Rename 2018-06-08 15:05:22 -07:00
inbound_version_negotiation_test.go Rename 2018-06-08 15:05:22 -07:00
outbound_version_negotiation_test.go Rename 2018-06-08 15:05:22 -07:00
private_key Refactor GoRicochet 2016-07-02 18:52:28 -07:00
ricochet.go Rename 2018-06-08 15:05:22 -07:00
ricochet_test.go Adding Open Connection Failed Test 2018-01-03 10:20:53 -08:00
testing.md Adding Open Connection Failed Test 2018-01-03 10:20:53 -08:00

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.