https://github.com/bit-nation/x3dh
https://github.com/bit-nation/x3dh
key-exchanges signal
Last synced: 25 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/bit-nation/x3dh
- Owner: Bit-Nation
- License: mit
- Created: 2018-05-29T10:04:07.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-07-21T08:02:31.000Z (almost 7 years ago)
- Last Synced: 2025-03-25T19:13:50.309Z (about 1 month ago)
- Topics: key-exchanges, signal
- Language: Go
- Size: 29.3 KB
- Stars: 10
- Watchers: 8
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: security-bitnation.co.key.pub
Awesome Lists containing this project
README
# x3dh
[](https://github.com/RichardLitt/standard-readme)
[](https://travis-ci.org/Bit-Nation/x3dh)
> An x3dh implementation.
This is an almost complete implementation of the [x3dh](https://signal.org/docs/specifications/x3dh/) key agreement protocol. However, there are a few things that you need to take care of yourself:
1. If you fetch a preKeyBundle (holds information about the person you would like to chat with, like the identity key, etc) you have to check the signature yourself. It's not built into the code. We only "ask you" IF the key is valid. You can then say yes/no. If you say no, the protocol will be aborted.
2. You are responsible for handling the initial message (and the encoding), we only give you the calculated secret + the ephemeral key generated during the protocol run.
3. Currently we only support curve25519 (but you can implement the `Curve` interface in order to use another curve).
## Table of Contents
- [Security](#security)
- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [Maintainers](#maintainers)
- [Contribute](#contribute)
- [License](#license)
## Security
If you find a security bug/ vulnerability please DO NOT open an issue. Write to [email protected] PLEASE use [this](security-bitnation.co.key.pub) PGP key to encrypt your report / email.
## Install
```
go get github.com/Bit-Nation/x3dh
```
It might make sense to chose a dependency manager of your choise to pin the version to a specific commit.
## Usage
```
// create an instance of the curve util
c := &Curve25519{}
// make sure ot save this somewhere
myKeyPair, err := c.GenerateKeyPair()
x := x3dh.New(c, sha256.New(), "test", myKeyPair)
```
## API
The following methods are available:
- `CalculateSecret` calculate a secret based on your Idkey and a received PreKeyBundle.
- `SecretFromRemote` create a secret based on the received intial data.
## Maintainers
[@florianlenz](https://github.com/florianlenz)
## Contribute
Pull requests are accepted.
Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specifications.
## License
MIT © 2018 Bitnation