2024-03-18 08:39:12 +00:00
|
|
|
# ICRC - Internet Cipher Relay Chat
|
|
|
|
|
|
2024-03-23 15:09:59 +00:00
|
|
|
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.
|
2024-03-18 08:39:12 +00:00
|
|
|
|
2024-03-23 15:09:59 +00:00
|
|
|
## Project Status
|
|
|
|
|
|
|
|
|
|
ICRC is at the moment work in progress and not functional yet.
|
|
|
|
|
[Contribution](https://git.nerdcult.net/antifallobst/icrc-server/src/branch/master/docs/contribution_guide.md) is very
|
|
|
|
|
welcome :)
|
|
|
|
|
|
2024-03-31 10:13:56 +00:00
|
|
|
## 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.
|
|
|
|
|
|
2024-03-23 15:09:59 +00:00
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
Shortcuts to different documentation parts:
|
|
|
|
|
|
2024-03-24 15:36:44 +00:00
|
|
|
- [Server API](https://git.nerdcult.net/antifallobst/icrc-server/src/branch/master/docs/api) (WIP)
|
2024-03-23 15:09:59 +00:00
|
|
|
- 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.
|
|
|
|
|
```
|
