CapyKit/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md

50 lines
1.4 KiB
Markdown
Raw Normal View History

# Encrypt Method
Encrypts the given password using a PBKDF2 algorithm.
## Definition
2024-04-21 03:30:36 -05:00
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**C#**
``` C#
public byte[] Encrypt(
string password,
params Object[] args
)
```
**F#**
``` F#
abstract Encrypt :
password : string *
args : Object[] -> byte[]
override Encrypt :
password : string *
args : Object[] -> byte[]
```
#### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The plaintext password.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>[]</dt><dd>Additional arguments for the encryption process, specifically <ol><li><code>salt</code></li><li><code>length</code></li><li><code>iterations</code></li></ol>
</dd></dl>
#### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]
A byte array with the hashed *password*.
#### Implements
2024-04-21 03:30:36 -05:00
<a href="M_CapyKit_IPasswordAlgorithm_Encrypt.md">IPasswordAlgorithm.Encrypt(String, Object[])</a>
## See Also
#### Reference
2024-04-21 03:30:36 -05:00
<a href="T_CapyKit_Pbkdf2Algorithm.md">Pbkdf2Algorithm Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>