CapyKit/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md

47 lines
1.5 KiB
Markdown
Raw Normal View History

# Compare Method
Compares the given plaintext password with an encrypted value using PBKDF2 algorithm.
## Definition
2024-04-21 03:30:36 -05:00
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
2024-04-21 01:20:26 -05:00
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
bool Compare(
string password,
byte[] encryptedValue,
params Object[] args
)
```
**F#**
``` F#
abstract Compare :
password : string *
encryptedValue : byte[] *
args : Object[] -> bool
override Compare :
password : string *
encryptedValue : byte[] *
args : Object[] -> bool
```
#### 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 to compare.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]</dt><dd>The encrypted value to compare against.</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, such as salt and length.</dd></dl>
#### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.boolean" target="_blank" rel="noopener noreferrer">Boolean</a>
True if the given *password* matches the *encryptedValue*, false if they are different.
## See Also
#### Reference
2024-04-21 03:30:36 -05:00
<a href="T_CapyKit_IPasswordAlgorithm.md">IPasswordAlgorithm Interface</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>