ColirBackend

Колир (бэкэнд)

Колир-быстрое и безопасное платформу обмена сообщениями с сквозном шифрованием.

Веб -клиент можно найти здесь.

? Идея

Основная цель Колира - обеспечить способность надежно общаться .

Чтобы реализовать это, было выбрано сквозное шифрование . Перед использованием приложения пользователи должны обсудить секретный ключ , который будет использоваться для шифрования и расшифровки данных.

Примечание

Ключи шифрования для комнат хранятся только на клиенте . Они не отправляются на сервер .

Роль этого API заключается в передаче и хранении зашифрованных данных.

? Функции

Кроме того, Колир имеет несколько функций , которые могут вас заинтересовать:

• Номера - это места, где происходит зашифрованное общение. Когда пользователь создает комнату, он/она выбирает ключ шифрования (который будет храниться у клиента) и получает комнату . Они могут поделиться этим GUID с кем -то другим, чтобы присоединиться к этой комнате. Любой, у кого есть определение определенной комнаты , может присоединиться к нему, но будет невозможно расшифровать данные, если был предоставлен неправильный ключ шифрования .
• Дата истечения может быть предоставлена ​​для комнат . Когда наступит дата истечения , все данные не будут доступны и будут удалены навсегда.
• Есть только один голосовой канал на комнату.
• Аутентификация без пароля . Существует три способа аутентификации : анонимный (дает вам разовую JWT), учетную запись GitHub и учетную запись Google .
• У каждого пользователя есть уникальный «Colir Id» , который представляет собой шестнадцатеричный номер длиной в 6 символов для идентификации пользователя.

Осторожность

Если вы аутентифицируетесь как анонимный , вы не сможете снова войти в эту учетную запись.
Поэтому используйте сторонних поставщиков, таких как Github и Google, чтобы иметь возможность войти в систему столько, сколько вы хотите.

? Развертывание

1. Установите Docker
2. Клонировать это репо
   > git clone https://github.com/MrQuackDuck/ColirBackend.git
3. Запрыгнуть в папку
   > cd .ColirBackend
4. Запустите контейнер
   > docker compose up

Важный

Когда вы клонировали репозиторий, обязательно настройте эти переменные в appsettings.json :

• Authentication:JwtKey - секретный ключ , используемый для подписи токенов JWT
• Authentication:RefreshTokenKey - секретный ключ, используемый для подписи токенов обновления
• OAuth2:GitHubClientId - идентификатор клиента GitHub (см. Авторизация приложений OAuth)
• OAuth2:GitHubSecret - GitHub Client Secret (см. Авторизация приложений OAuth)
• OAuth2:GoogleClientId - идентификатор клиента Google (см. Использование OAuth 2.0 для доступа к API Google)
• OAuth2:GoogleClientSecret - Google Client Secret (см. Использование OAuth 2.0 для доступа к API Google)
• OAuth2:GoogleRedirectLink - Ссылка Google перенаправления (The Callback -Link после согласия Google OAuth2, которое вы настроили в Google Cloud Console)
• DatabaseEncryption:EncryptionPassword - пароль с 16 -х гром , который будет использоваться для шифрования некоторых данных о записи/чтении в/из базы данных.
• DatabaseEncryption:InitializationVector - вектор инициализации 16 -маршрутов , который будет использоваться для шифрования некоторых данных о записи/чтении в/из базы данных.

? Сервер разработки

1. Установить .NET 8
2. Клонировать это репо
3. Запустить dotnet run --project Colir.WebApi Command