Kapela.Security.Encryption.Tools
10.0.3
Prefix Reserved
dotnet tool install --global Kapela.Security.Encryption.Tools --version 10.0.3
dotnet new tool-manifest
dotnet tool install --local Kapela.Security.Encryption.Tools --version 10.0.3
#tool dotnet:?package=Kapela.Security.Encryption.Tools&version=10.0.3
nuke :add-package Kapela.Security.Encryption.Tools --version 10.0.3
🛠️ Kapela.Security.Encryption.Tools
Outil CLI .NET pour chiffrer, déchiffrer et migrer des valeurs à utiliser avec Kapela.Security.Encryption.
📦 Installation
dotnet tool install --global Kapela.Security.Encryption.Tools
🗝️ Notion de projet
Le paramètre -p / --project correspond au nom du projet principal de votre application, permettant à l'utilitaire de récupérer les informations nécessaires.
Pour fournir explicitement la clé de chiffrement, deux options en complément de -p :
-k/--key: passe directement la clé personnalisée en argument.--env: utilise la variable d'environnementKAPELA_ENCRYPTION_KEY(recommandé en production lorsque la clé est gérée par un secret manager).
⚠️ La même valeur doit être utilisée pour chiffrer et déchiffrer.
💡 L'utilisation des single quotes (
') est recommandée pour encadrer les valeurs afin d'éviter tout conflit d'interprétation avec PowerShell.
✏️ encrypt — Chiffrer une valeur
Kapela-Encryption encrypt -p <projet> -v <valeur_en_clair>
| Option | Description |
|---|---|
-p / --project |
Nom du projet principal de votre application |
-k / --key |
Clé initialisée via SetEncryptionKey dans l'application |
--env |
Utiliser la variable d'environnement KAPELA_ENCRYPTION_KEY comme clé |
-v / --value |
Valeur en clair à chiffrer |
--net4 |
Utiliser le mode de chiffrement compatibilité .NET Framework |
**Exemple avec le nom du projet 😗*
Kapela-Encryption encrypt -p 'MonApplication' -v 'MonMotDePasse'
>>> SGVsbG8gV29ybGQ...
**Exemple avec une clé personnalisée 😗*
Kapela-Encryption encrypt -p 'MonApplication' -k 'MaCléPersonnalisée' -v 'MonMotDePasse'
>>> Q2lwaGVyVGV4dEFCQw...
**Exemple via la variable d'environnement 😗*
Kapela-Encryption encrypt -p 'MonApplication' --env -v 'MonMotDePasse'
>>> RW52U2VjcmV0VmFsdWU...
Copiez la valeur retournée dans votre appsettings.json (ou votre web.config pour .NET Framework). ✅
🔍 decrypt — Déchiffrer une valeur
Kapela-Encryption decrypt -p <projet> -v <valeur_chiffrée>
| Option | Description |
|---|---|
-p / --project |
Nom du projet principal de votre application |
-k / --key |
Clé initialisée via SetEncryptionKey dans l'application |
--env |
Utiliser la variable d'environnement KAPELA_ENCRYPTION_KEY comme clé |
-v / --value |
Valeur chiffrée à déchiffrer |
--net4 |
Déchiffrer une valeur chiffrée avec le mode compatibilité .NET Framework |
**Exemple 😗*
Kapela-Encryption decrypt -p 'MonApplication' -v 'SGVsbG8gV29ybGQ...'
>>> MonMotDePasse
🔄 migrate — Migrer une valeur de .NET Framework vers .NET
Déchiffre une valeur chiffrée avec l'implémentation .NET Framework et la rechiffre au format .NET, prête à l'emploi dans Kapela.Security.Encryption.
Kapela-Encryption migrate -p <projet> -v <valeur_chiffrée_net4>
| Option | Description |
|---|---|
-p / --project |
Nom du projet principal de votre application (cible) |
-k / --key |
Clé initialisée via SetEncryptionKey dans l'application (cible) |
--env |
Utiliser la variable d'environnement KAPELA_ENCRYPTION_KEY comme clé cible |
-v / --value |
Valeur chiffrée en .NET Framework |
-pnet4 / --project-net4 |
Nom du projet principal d'origine, si différent de la cible |
-knet4 / --key-net4 |
Clé initialisée via SetEncryptionKey dans l'application (origine) |
**Exemple 😗*
Kapela-Encryption migrate -p 'MonApplication' -k 'MaCléPersonnalisée' -v 'ancienneValeurChiffrée...'
>>> nouvelleValeurChiffrée...
Si le nom du projet d'origine ou la clé diffère du nom ou de la clé cible, ajoutez -pnet4 et/ou -knet4 :
Kapela-Encryption migrate -p 'NouvelleApp' -k 'CléCible' -pnet4 'AncienneApp' -knet4 'CléOrigine' -v 'ancienneValeurChiffrée...'
>>> nouvelleValeurChiffrée...
🖥️ environment — Afficher les informations d'assembly
🔧 Commande utilitaire destinée au débogage — peu utile en utilisation standard.
Affiche les noms de différents paramètres du contexte courant.
Kapela-Encryption environment
EntryAssembly : Kapela-Encryption
CallingAssembly : Kapela-Encryption
ExecutingAssembly: Kapela-Encryption
❓ Aide
Kapela-Encryption --help
Kapela-Encryption encrypt --help
Kapela-Encryption decrypt --help
Kapela-Encryption migrate --help
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
This package has no dependencies.