ColirBackend

Colir (backend)

Colir - plate-forme de messagerie rapide et sécurisée avec chiffrement de bout en bout .

Le client Web peut être trouvé ici.

? L'idée

L'objectif principal de Colir est de fournir la capacité de communiquer en toute sécurité .

Pour implémenter cela, le cryptage de bout en bout a été choisi. Avant d'utiliser l'application, les utilisateurs doivent discuter d'une clé secrète qui sera utilisée pour crypter et déchiffrer les données.

Note

Les clés de chiffrement pour les chambres sont stockées uniquement sur le client . Ils ne sont pas envoyés au serveur .

Le rôle de cette API est de transférer et de stocker les données cryptées.

? Caractéristiques

En plus de cela, Colir a quelques fonctionnalités , ce qui peut vous intéresser:

• Les chambres sont des endroits où la communication cryptée se produit. Lorsqu'un utilisateur crée une pièce, il / elle choisit une clé de chiffrement (qui sera stockée chez le client) et reçoit un guid de pièce . Ils peuvent partager ce GUID avec quelqu'un d'autre afin qu'ils puissent rejoindre cette pièce. Quiconque a le GUID d'une certaine salle peut le rejoindre , mais il sera impossible de déchiffrer les données si la mauvaise clé de cryptage était fournie.
• La date d'expiration peut être fournie pour les chambres . Lorsque la date d'expiration vient , toutes les données ne seront pas accessibles et seront supprimées pour toujours.
• Il n'y a qu'un seul canal vocal par pièce.
• Authentification sans mot de passe . Il existe trois façons d'authentifier : Anonyme (vous donne un JWT unique), un compte GitHub et un compte Google .
• Chaque utilisateur a un "Colir ID" unique, qui est un numéro hexadécimal de 6 symboles pour identifier un utilisateur.

Prudence

Si vous vous authentifiez comme anonyme , vous ne pourrez pas vous connecter à nouveau dans ce compte.
Par conséquent , utilisez des fournisseurs tiers tels que GitHub et Google pour pouvoir vous connecter autant que vous le souhaitez.

? Déploiement

1. Installer Docker
2. Cloner ce repo
   > git clone https://github.com/MrQuackDuck/ColirBackend.git
3. Sauter dans le dossier
   > cd .ColirBackend
4. Exécutez le conteneur
   > docker compose up

Important

Lorsque vous avez cloné le référentiel, assurez-vous de configurer ces variables dans appsettings.json :

• Authentication:JwtKey ​​- Une clé secrète utilisée pour signer des jetons JWT
• Authentication:RefreshTokenKey - Une clé secrète utilisée pour signer des jetons de rafraîchissement
• OAuth2:GitHubClientId - GitHub Client ID (voir Autoriser les applications OAuth)
• OAuth2:GitHubSecret - GitHub Client Secret (voir Autoriser les applications OAuth)
• OAuth2:GoogleClientId - ID du client Google (voir Utilisation d'OAuth 2.0 pour accéder aux API Google)
• OAuth2:GoogleClientSecret - Google Client Secret (voir Utilisation d'OAuth 2.0 pour accéder aux API Google)
• OAuth2:GoogleRedirectLink - Lien de redirection Google (le lien de rappel après le consentement de Google Oauth2 que vous avez configuré dans Google Cloud Console)
• DatabaseEncryption:EncryptionPassword - Le mot de passe à 16 char qui sera utilisé pour crypter certaines données sur l'écriture / la lecture dans / depuis la base de données.
• DatabaseEncryption:InitializationVector - Le vecteur d'initialisation à 16 charges qui sera utilisé pour crypter certaines données sur l'écriture / la lecture dans / depuis la base de données.

? Serveur de développement

1. Installer .net 8
2. Cloner ce repo
3. Exécuter dotnet run --project Colir.WebApi