berty

module
v2.159.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 29, 2020 License: Apache-2.0, MIT

README

Berty

💬 Berty is a secure peer-to-peer messaging app that works with or without internet access, cellular data or trust in the network

berty.tech discord github twitter

GoDoc GitHub release CodeFactor


Introduction

Berty is an anonymous, secure, peer-to-peer protocol that doesn't need an internet connection to function.

There is a protocol that uses advanced cryptography and a messenger app that is built on top of the protocol.

  • No phone number or email required to create an account
  • End-to-end encryption used to encrypt all conversations
  • Focus on leaking as little metadata as possible
  • Decentralized, distributed, serverless
  • No consensus, no blockchain
  • No internet connection required (uses the BLE technology and mDNS)
  • Free forever, no data stored, transparent code, open-source

Berty is currently developed by Berty Technologies, a French non-profit organization.

Usages:

  • When you need to share sensitive information.
  • If you want to communicate with good anonymity.
  • If you don't want to use servers, because you want full control of your data.
  • In countries that have censorship and restrict network access and usage.
  • In areas with weak or no connection or cell reception.
  • When you travel and you want to communicate safely through insecure public connections.

Note: the project is made by a small team of humans who are not experts and who make mistakes. Please, do not hesitate to point out if you notice a bug or something missing. See the contribute section below.

We cannot promise to give you the best app, but we can commit to doing our best in that direction.

Development Status

Berty is still under active development and should not be used to exchange important data.

The current Berty Messenger implementation is using the Berty Protocol. Which means the encryption is safe and it's a P2P app! Berty Messenger has not been hardened yet so avoid using it on devices with weak sandboxes. If you're trying to roll your own app based on the protocol, beware that the app layer protocols used by Berty Messenger might change in the future.

The current Berty Protocol is partially implemented. The API will certainly change in a near future, so be prepared to have breaking changes if you start using it right now.

We will open betas for the different packages and apps soon, so anyone will be able to give it a try even without the coding skills. Subscribe to our newsletter if you want to be notified.

Note: this is an ongoing work. The repos are being opened progressively, and there will be more changes and updates.

Under the hood

Berty Protocol

go.dev reference Code coverage

A generic SDK that allows developers to write P2P applications. It contains everything needed (encryption, identities, network routing, group management, account management, device management, application lifecycle) so you can just focus on the high-level features of your app.

The main concept of the Berty Protocol is the "group", a virtual place where multiple devices can share messages and metadata using OrbitDB, which itself relies on IPFS.

Get it: go get -u berty.tech/berty/v2

Berty Messenger

A messenger application written in React Native, that uses the Berty Protocol using gomobile-ipfs, which, in its turn, is using gomobile.

Main items in the repo

  • ./go: Where all the Golang code belongs.
  • ./js: Where all the Javascript/Typescript code belongs, containing:
    • The Berty Messenger application, written in React Native.
  • ./docs: Mostly auto-generated documentation.

Philosophy

We want to contribute to the world of free, secure communication without fear of censorship and surveillance.

Open source is more secure, since anyone can examine the code, improve it and maintain it. Our ultimate goal is to completely lose control of Berty and have it evolve as a global community project.

More info on berty/community.

Contributing

Contribute to Berty

We really welcome contributions. Your input is the most precious material. We're well aware of that and we thank you in advance. Everyone is encouraged to look at what they can do on their own scale; no effort is too small.

There are plenty of ways to get involved and act for our community. It has been divided into two distinct parts: everything that is related to the code and everything that is not.

To put it very simply:

  • Code-related = Github
  • Not code-related = Open task

Everything on contribution is sum up here: CONTRIBUTING.MD

Stargazers over time

Stargazers over time

Other resources

Contact

Take a look at our community repo.

See all our available contact methods on the contact page of our website.

Licensing

© 2018-2020 Berty Technologies h0

Licensed under the Apache License, Version 2.0 (LICENSE-APACHE) or the MIT license (LICENSE-MIT), at your option. See the COPYRIGHT file for more details.

Directories

Path Synopsis
go
cmd/berty
Berty is the main CLI entrypoint to manage the Berty ecosystem (client, server, relay, dev).
Berty is the main CLI entrypoint to manage the Berty ecosystem (client, server, relay, dev).
cmd/berty/mini
Package mini contains main helpers to start a term-based Berty mini client.
Package mini contains main helpers to start a term-based Berty mini client.
cmd/rdvp
rdvp is a service to hold Berty's rendezvous point for faster peer discovery.
rdvp is a service to hold Berty's rendezvous point for faster peer discovery.
framework/bertybridge
Package bertybridge is the main gomobile entrypoint, used to generate iOS and Android frameworks.
Package bertybridge is the main gomobile entrypoint, used to generate iOS and Android frameworks.
internal/cryptoutil
Package cryptoutil contains generic & stateless crypto helpers.
Package cryptoutil contains generic & stateless crypto helpers.
internal/discordlog
discordlog is an unsafe package used during development to log info directly on the Berty's Discord server.
discordlog is an unsafe package used during development to log info directly on the Berty's Discord server.
internal/grpcutil
Package grpcutil contains gRPC lazy codecs, messages and a buf-based listener.
Package grpcutil contains gRPC lazy codecs, messages and a buf-based listener.
internal/handshake
Package handshake implements a capability-based handshake.
Package handshake implements a capability-based handshake.
internal/ipfsutil
Package ipfsutil contains helpers around IPFS (logging, datastore, networking, core API, ...).
Package ipfsutil contains helpers around IPFS (logging, datastore, networking, core API, ...).
internal/testutil
Package testutil contains testing helpers (logging, slow skipping).
Package testutil contains testing helpers (logging, slow skipping).
internal/tinder
Package tinder is a multi-driver service backed by a cache.
Package tinder is a multi-driver service backed by a cache.
internal/tools
Package tools ensures that `go mod` detect some required dependencies.
Package tools ensures that `go mod` detect some required dependencies.
pkg/banner
Package banner generates ASCII picture of the Berty logo with a message.
Package banner generates ASCII picture of the Berty logo with a message.
pkg/bertymessenger
Package bertymessenger is a reverse proxy.
Package bertymessenger is a reverse proxy.
pkg/bertyprotocol
Package bertyprotocol is a reverse proxy.
Package bertyprotocol is a reverse proxy.
pkg/bertytypes
This package is generated with Protobuf.
This package is generated with Protobuf.
pkg/errcode
Package errcode contains the list of Berty error codes.
Package errcode contains the list of Berty error codes.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL