Browse Source

Revision for string-encryption document

pull/8636/head
Halil İbrahim Kalkan 5 years ago
committed by GitHub
parent
commit
05d6752947
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 16
      docs/en/String-Encryption.md

16
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<AbpStringEncryptionOptions>(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.

Loading…
Cancel
Save