CapyKit/Documentation/Help/T_CapyKit_Password.md

96 lines
3.9 KiB
Markdown
Raw Normal View History

# Password Class
Represents a password with its hash, salt and algorithm used for encryption.
## 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 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>
2024-04-21 03:30:36 -05:00
## 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>
2024-04-21 03:30:36 -05:00
<td><a href="P_CapyKit_Password_Algorithm.md">Algorithm</a></td>
<td>Gets or sets the algorithm used for password encryption.</td></tr>
<tr>
2024-04-21 03:30:36 -05:00
<td><a href="P_CapyKit_Password_Hash.md">Hash</a></td>
<td>Gets or sets the hash of the password.</td></tr>
<tr>
2024-04-21 03:30:36 -05:00
<td><a href="P_CapyKit_Password_Pbkdf2Algorithm.md">Pbkdf2Algorithm</a></td>
2024-06-24 01:17:33 -05:00
<td>Gets the preconfigured PBKDF2 algorithm.</td></tr>
2024-04-21 01:20:26 -05:00
<tr>
2024-04-21 03:30:36 -05:00
<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>
2024-06-24 01:17:33 -05:00
<td><a href="M_CapyKit_Password_Equals.md">Equals</a></td>
<td>Determines whether the specified object is equal to the current object.<br />(Overrides <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)" target="_blank" rel="noopener noreferrer">Object.Equals(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>
2024-04-21 03:30:36 -05:00
<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>
2024-06-24 01:17:33 -05:00
## Operators
<table>
<tr>
<td><a href="M_CapyKit_Password_op_Equality.md">Equality(Password, Password)</a></td>
<td> </td></tr>
<tr>
<td><a href="M_CapyKit_Password_op_Inequality.md">Inequality(Password, Password)</a></td>
<td> </td></tr>
</table>
2024-04-21 03:30:36 -05:00
## Fields
<table>
<tr>
2024-06-24 01:17:33 -05:00
<td><a href="F_CapyKit_Password_pbkdf2Algorithm.md">pbkdf2Algorithm</a></td>
2024-04-21 03:30:36 -05:00
<td> </td></tr>
</table>
## See Also
#### Reference
2024-04-21 03:30:36 -05:00
<a href="N_CapyKit.md">CapyKit Namespace</a>