From 05d6752947fa83373d3dcd6c3ab9f3db15a808fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Halil=20=C4=B0brahim=20Kalkan?= Date: Thu, 15 Apr 2021 15:28:39 +0300 Subject: [PATCH] Revision for string-encryption document --- docs/en/String-Encryption.md | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/docs/en/String-Encryption.md b/docs/en/String-Encryption.md index 76f0d2baa4..81bb4f119a 100644 --- a/docs/en/String-Encryption.md +++ b/docs/en/String-Encryption.md @@ -2,8 +2,6 @@ ABP Framework provides string encryption feature that allows to **Encrypt** and **Decrypt** strings. - - ## Installation > This package is already installed by default with the startup template. So, most of the time, you don't need to install it manually. @@ -38,8 +36,6 @@ If you want to manually install; } ``` - - ## Using String Encryption All encryption operations are included in `IStringEncryptionService`. You can inject it and start to use. @@ -68,14 +64,10 @@ All encryption operations are included in `IStringEncryptionService`. You can in } ``` - - ### Using Custom PassPhrase `IStringEncryptionService` methods has **passPharase** parameter with default value and it uses default PassPhrase when you don't pass passPhrase parameter. -Default value is `gsKnGZ041HLL4IM8` - ```csharp StringEncryptionService.Encrypt(value); // Default Pass Phrase StringEncryptionService.Encrypt(value, "MyCustomPassPhrase"); // Custom Pass Phrase @@ -84,14 +76,10 @@ StringEncryptionService.Encrypt(value, "MyCustomPassPhrase"); // Custom Pass Phr StringEncryptionService.Decrypt(value, "MyCustomPassPhrase"); ``` - - ### Using Custom Salt `IStringEncryptionService` methods has **salt** parameter with default value and it uses default Salt when you don't pass the parameter. -Default value is `Encoding.ASCII.GetBytes("hgt!16kl")` - ```csharp StringEncryptionService.Encrypt(value); // Default Salt StringEncryptionService.Encrypt(value, salt: Encoding.UTF8.GetBytes("MyCustomSalt")); // Custom Salt @@ -100,8 +88,6 @@ StringEncryptionService.Encrypt(value, salt: Encoding.UTF8.GetBytes("MyCustomSal StringEncryptionService.Decrypt(value, salt: Encoding.UTF8.GetBytes("MyCustomSalt")); ``` - - *** ## String Encryption Options @@ -118,8 +104,6 @@ Configure(opts => }); ``` - - - **DefaultPassPhrase**: Default password to encrypt/decrypt texts. It's recommended to set to another value for security. Default value: `gsKnGZ041HLL4IM8` - **DefaultSalt**: A value which is used as salt while encrypting/decrypting.