goricochet

README

libricochet-go

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

Differences to Ricochet IM

• V3 Onion Support - libricochet-go updates the Ricochet protocol to use V3 tor onion service addresses, and implements a new authentication protocol providing greater deniability.
• Library - libricochet-go is designed to be integrated within your application, allowing your application to communicate with other peers or programs in a way that is privacy preserving and metadata resistant.

Using libricochet-go

Checkout our EchoBot Example to get started.

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.

Documentation

Index

• func NegotiateVersionInbound(conn net.Conn) (*connection.Connection, error)
• func NegotiateVersionOutbound(conn net.Conn, remoteHostname string) (*connection.Connection, error)
• func Open(acn connectivity.ACN, remoteHostname string) (*connection.Connection, error)

Functions

func NegotiateVersionInbound

func NegotiateVersionInbound(conn net.Conn) (*connection.Connection, error)

NegotiateVersionInbound takes in a connection and performs version negotiation as if that connection was a client. Returns a ricochet connection if successful error otherwise.

func NegotiateVersionOutbound

func NegotiateVersionOutbound(conn net.Conn, remoteHostname string) (*connection.Connection, error)

NegotiateVersionOutbound takes an open network connection and executes the ricochet version negotiation procedure.

func Open

func Open(acn connectivity.ACN, remoteHostname string) (*connection.Connection, error)

Open establishes a protocol session on an established net.conn, and returns a new OpenConnection instance representing this connection. On error, the connection will be closed. This function blocks until version negotiation has completed. The application should call Process() on the returned OpenConnection to continue handling protocol messages.