OxideTalis Messaging Protocol homeserver implementation written in Rust https://otmp.4rs.nl
Go to file
Awiteb 8021b15f41
All checks were successful
Write changelog / write-changelog (push) Successful in 3s
Rust CI / Rust CI (push) Successful in 3m49s
chore: Update CONTRIBUTING.md
Reviewed-on: #18
Signed-off-by: Awiteb <a@4rs.nl>
2024-07-14 04:54:44 +03:00
.forgejo feat: Developer Certificate of Origin 2024-07-14 04:00:23 +03:00
.github/workflows feat: Create CI/CD 2024-07-07 20:59:04 +03:00
crates change: Remove the nonce cache limit 2024-07-06 14:07:48 +03:00
.dockerignore chore: Initialize the project 2024-06-26 23:05:17 +03:00
.gitignore chore: Initialize the project 2024-06-26 23:05:17 +03:00
Cargo.lock chore: Add new dependencies for websocket 2024-07-05 02:16:10 +03:00
Cargo.toml feat: Make the executable little small 2024-07-07 20:59:05 +03:00
CHANGELOG.md chore(changelog): Update changelog 2024-07-14 01:01:09 +00:00
cliff.toml chore: Add used utility files 2024-06-26 23:02:11 +03:00
CONTRIBUTING.md chore: Update CONTRIBUTING.md 2024-07-14 04:54:44 +03:00
DCO feat: Developer Certificate of Origin 2024-07-14 04:00:23 +03:00
docker-compose.yml chore: Add docker-compose.yml 2024-06-26 23:00:57 +03:00
Justfile chore: Add used utility files 2024-06-26 23:02:11 +03:00
LICENSE-AGPLv3 chore: Add licenses 2024-06-26 23:03:01 +03:00
LICENSE-MIT chore: Add licenses 2024-06-26 23:03:01 +03:00
README.md fix: Use old alert blocks style 2024-07-08 17:49:59 +03:00
rust-toolchain.toml chore: Add rust files 2024-06-26 23:02:33 +03:00
rustfmt.toml chore: Add rust files 2024-06-26 23:02:33 +03:00
sumi.toml chore: Add used utility files 2024-06-26 23:02:11 +03:00

OTMP Logo

Oxidetalis

An open-source OxideTalis Messaging Protocol (OTMP) homeserver implementation written in Rust.

Forgejo CI Status Forgejo CD Status

agplv3-or-later

Warning

The project is still in very early development and is not ready for any kind of use yet, the protocol is not finalized and the server is not feature complete, also not all protocol features are implemented yet.

About

OTMP is a federated chat protocol that aims to be a secure and privacy-respecting alternative to existing chat protocols, OTMP does not rely on a central server, but instead uses a federated network of servers to deliver messages. When you send a message to a friend, you will connect to your friend's server and send the message directly to them. This way, your messages are not stored on a central server, and only you and your friend can read them.

Key Features

  • Federated: No central server, messages are sent directly to the recipient server by you.
  • End-to-End Encryption: Messages are encrypted on the client and decrypted on the client.
  • Self-Hosted: You can host your own server and have full control over your data.
  • Privacy-Respecting: No tracking, no ads, no data mining, no email/usernames/passwords required.
  • Secure: Messages are encrypted and signed, and the protocol is designed to be secure.
  • Lightweight: Simple protocol, easy to implement, easy to use. No bloat.

Protocol non-goals

  • Group chats
  • Voice/video calls

How to authenticate without usernames and passwords

OTMP uses a different authroization mechanism than most chat protocols. Instead of using usernames and passwords, OTMP uses public/private key pairs to authenticate users. When you create an account, you generate a key pair on your device, and the public key is sent to the server. When you sent a request to the server, you sign the request with shared secret key between you and the server. This way, the server can verify that the request is coming from you and authroize the request.

E2EE, how does it work?

OTMP key pairs are used for more than just authroization, they are also used for end-to-end encryption. When you send a message to a friend, you encrypt the message with shared secret key, the shared secret key is generated by diffie-hellman key exchange using your private key and your friend's public key. This way, only you and your friend can read the message, even the server can't read it.

Running the server

Note

You must update OXIDETALIS_CONFIG in the docker-compose.yml file to point to the correct configuration file. And you must update the configuration file.

To run the server, you need to have docker and docker-compose installed on your system. You can run the server by running the following command:

docker-compose up -d

Contributing

For information on how to contribute to the project, please see the CONTRIBUTING.md file.

Repository mirrors

Licenses

The project is split into multiple crates, each with its own license: