mirror of
https://github.com/wagesj45/CapyKit.git
synced 2024-10-18 07:01:50 -05:00
Jordan Wages
87bd044b31
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.
86 lines
3.7 KiB
Markdown
86 lines
3.7 KiB
Markdown
# Password Class
|
||
|
||
|
||
Represents a password with its hash, salt and algorithm used for encryption.
|
||
|
||
|
||
|
||
## Definition
|
||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||
|
||
**C#**
|
||
``` C#
|
||
public class Password
|
||
```
|
||
**F#**
|
||
``` F#
|
||
type Password = class end
|
||
```
|
||
|
||
<table><tr><td><strong>Inheritance</strong></td><td><a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a> → Password</td></tr>
|
||
</table>
|
||
|
||
|
||
|
||
## Constructors
|
||
<table>
|
||
<tr>
|
||
<td><a href="M_CapyKit_Password__cctor.md">Password</a></td>
|
||
<td> </td></tr>
|
||
<tr>
|
||
<td><a href="M_CapyKit_Password__ctor.md">Password</a></td>
|
||
<td>Constructor.</td></tr>
|
||
</table>
|
||
|
||
## Properties
|
||
<table>
|
||
<tr>
|
||
<td><a href="P_CapyKit_Password_Algorithm.md">Algorithm</a></td>
|
||
<td>Gets or sets the algorithm used for password encryption.</td></tr>
|
||
<tr>
|
||
<td><a href="P_CapyKit_Password_Hash.md">Hash</a></td>
|
||
<td>Gets or sets the hash of the password.</td></tr>
|
||
<tr>
|
||
<td><a href="P_CapyKit_Password_Pbkdf2Algorithm.md">Pbkdf2Algorithm</a></td>
|
||
<td> </td></tr>
|
||
<tr>
|
||
<td><a href="P_CapyKit_Password_Salt.md">Salt</a></td>
|
||
<td>Gets or sets the salt used for encryption.</td></tr>
|
||
</table>
|
||
|
||
## Methods
|
||
<table>
|
||
<tr>
|
||
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)" target="_blank" rel="noopener noreferrer">Equals</a></td>
|
||
<td>Determines whether the specified object is equal to the current object.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
|
||
<tr>
|
||
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.finalize" target="_blank" rel="noopener noreferrer">Finalize</a></td>
|
||
<td>Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
|
||
<tr>
|
||
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode" target="_blank" rel="noopener noreferrer">GetHashCode</a></td>
|
||
<td>Serves as the default hash function.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
|
||
<tr>
|
||
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.gettype" target="_blank" rel="noopener noreferrer">GetType</a></td>
|
||
<td>Gets the <a href="https://learn.microsoft.com/dotnet/api/system.type" target="_blank" rel="noopener noreferrer">Type</a> of the current instance.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
|
||
<tr>
|
||
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone" target="_blank" rel="noopener noreferrer">MemberwiseClone</a></td>
|
||
<td>Creates a shallow copy of the current <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
|
||
<tr>
|
||
<td><a href="M_CapyKit_Password_ToString.md">ToString</a></td>
|
||
<td>Returns a string that represents the current object.<br />(Overrides <a href="https://learn.microsoft.com/dotnet/api/system.object.tostring" target="_blank" rel="noopener noreferrer">Object.ToString()</a>)</td></tr>
|
||
</table>
|
||
|
||
## Fields
|
||
<table>
|
||
<tr>
|
||
<td><a href="F_CapyKit_Password_algorithm.md">algorithm</a></td>
|
||
<td> </td></tr>
|
||
</table>
|
||
|
||
## See Also
|
||
|
||
|
||
#### Reference
|
||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|