CapyKit/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md
Jordan Wages 87bd044b31 Settings Helper + Documentation
The `SettingsHelper` is an agnostic way to access settings values uniformly through code. The accessor methods are controlled by the consumer.

Documentation has been a bit wonky. I changed the max number of version number components allowed, so each new build should not create new changes on every single bit of documentation now.
2024-04-22 18:28:21 -05:00

45 lines
921 B
Markdown

# IPasswordAlgorithm Interface
Defines the contract for password encryption algorithms.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**C#**
``` C#
public interface IPasswordAlgorithm
```
**F#**
``` F#
type IPasswordAlgorithm = interface end
```
## Properties
<table>
<tr>
<td><a href="P_CapyKit_IPasswordAlgorithm_AlgorithmName.md">AlgorithmName</a></td>
<td>Gets the name of the algorithm.</td></tr>
</table>
## Methods
<table>
<tr>
<td><a href="M_CapyKit_IPasswordAlgorithm_Compare.md">Compare</a></td>
<td>Compares the given plaintext password with an encrypted value using PBKDF2 algorithm.</td></tr>
<tr>
<td><a href="M_CapyKit_IPasswordAlgorithm_Encrypt.md">Encrypt</a></td>
<td>Encrypts the given password using a defined algorithm.</td></tr>
</table>
## See Also
#### Reference
<a href="N_CapyKit.md">CapyKit Namespace</a>