Internet Cipher Relay Chat
Go to file
antifallobst 3b240d6ca9
feat(client >> storage): storing auth tokens in the persistent session storage system
2024-03-31 23:15:28 +02:00
client feat(client >> storage): storing auth tokens in the persistent session storage system 2024-03-31 23:15:28 +02:00
docs docs: added the opt type to the commit style definition 2024-03-24 20:19:40 +01:00
server feat(server >> api): implemented an endpoint that gives the client information about their authenticated account 2024-03-31 13:47:36 +02:00
.env refactor: renamed to icrc-server 2024-03-18 09:39:12 +01:00
.gitignore refactor: moved server code into a seperate directory 2024-03-31 12:13:56 +02:00
Cargo.lock feat(client >> storage): implemented a persistent key-value storage system 2024-03-31 20:44:00 +02:00
Cargo.toml refactor: moved server code into a seperate directory 2024-03-31 12:13:56 +02:00
LICENSE docs: updated README and corrected the copyright year in the license 2024-03-23 16:09:59 +01:00
README.md refactor: moved server code into a seperate directory 2024-03-31 12:13:56 +02:00
rust-toolchain.toml refactor: moved rust config to the top level directory 2024-03-31 12:24:24 +02:00
rustfmt.toml refactor: moved rust config to the top level directory 2024-03-31 12:24:24 +02:00

README.md

ICRC - Internet Cipher Relay Chat

ICRC is a chat protocol / system designed similar to IRC, but it has a heavy focus on security and privacy. All messages in a relay are end-to-end encrypted using strong encryption schemes. Messages are not saved persistent on the server, but only routed through the server. The only public identity a user has is a UUID, that is also unique per relay.

Project Status

ICRC is at the moment work in progress and not functional yet. Contribution is very welcome :)

Directory Structure

  • server - the reference implementation of the icrc server.
  • client - a rust crate that abstracts the icrc server API.
  • docs - contains purple unicorns, vibing to workers songs.

Documentation

Shortcuts to different documentation parts:

  • Server API (WIP)
  • Server Admin Docs (Coming Soon)

License (MIT)

Copyright 2024 antifallobst <antifallobst@systemausfall.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the “Software”), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.