mirror of
https://github.com/wagesj45/CapyKit.git
synced 2024-10-17 22:54:01 -05:00
Fix broken XML stuff.
This commit is contained in:
parent
6d1980f279
commit
746ac82051
61 changed files with 3231 additions and 2010 deletions
1898
CapyKit/Color.cs
1898
CapyKit/Color.cs
File diff suppressed because it is too large
Load diff
|
|
@ -52,8 +52,7 @@ namespace CapyKit.Helpers
|
|||
#region Members
|
||||
|
||||
/// <summary>
|
||||
/// Private delegate function that retrieves a setting with the given <c>key</c>. Returns the
|
||||
/// setting as an uncast <see cref="object"/>.
|
||||
/// Private delegate function that retrieves a setting with the given <c>key</c>.
|
||||
/// </summary>
|
||||
private static Func<string, object> accessor = (key) => default(object);
|
||||
|
||||
|
|
@ -68,7 +67,7 @@ namespace CapyKit.Helpers
|
|||
#region Methods
|
||||
|
||||
/// <summary>
|
||||
/// Retrieves a setting with the given <c>key</c>. Returns the setting as an uncast <typeparamref name="T"/>.
|
||||
/// Retrieves a setting with the given <c>key</c>.
|
||||
/// </summary>
|
||||
/// <typeparam name="T"> The type of the setting to be retrieved. </typeparam>
|
||||
/// <param name="settingName"> The name of the setting to retrieve. </param>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,31 @@
|
|||
# encryptionKey Field
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "F:CapyKit.Helpers.EncryptionHelper.encryptionKey"\]
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
private string encryptionKey
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
val mutable private encryptionKey: string
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Field Value
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_EncryptionHelper.md">EncryptionHelper Class</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
# saltSize Field
|
||||
# SALT_SIZE Field
|
||||
|
||||
|
||||
Default size of the generated salt.
|
||||
Default size to use when generating a new salt.
|
||||
|
||||
|
||||
|
||||
|
|
@ -11,11 +11,11 @@ Default size of the generated salt.
|
|||
|
||||
**C#**
|
||||
``` C#
|
||||
private const int saltSize = 32
|
||||
private const int SALT_SIZE = 32
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
static val mutable private saltSize: int
|
||||
static val mutable private SALT_SIZE: int
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
# accessor Field
|
||||
|
||||
|
||||
Private delegate function that retrieves a setting with the given `key`. Returns the setting as an uncast <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>.
|
||||
Private delegate function that retrieves a setting with the given `key`.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# algorithm Field
|
||||
# pbkdf2Algorithm Field
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "F:CapyKit.Password.algorithm"\]
|
||||
\[Missing <summary> documentation for "F:CapyKit.Password.pbkdf2Algorithm"\]
|
||||
|
||||
|
||||
|
||||
|
|
@ -11,11 +11,11 @@
|
|||
|
||||
**C#**
|
||||
``` C#
|
||||
private static Lazy<Pbkdf2Algorithm> algorithm
|
||||
private static Lazy<Pbkdf2Algorithm> pbkdf2Algorithm
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
static val mutable private algorithm: Lazy<Pbkdf2Algorithm>
|
||||
static val mutable private pbkdf2Algorithm: Lazy<Pbkdf2Algorithm>
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
# EncryptionHelper Fields
|
||||
|
||||
|
||||
|
||||
|
||||
## Fields
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="F_CapyKit_Helpers_EncryptionHelper_encryptionKey.md">encryptionKey</a></td>
|
||||
<td> </td></tr>
|
||||
</table>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_EncryptionHelper.md">EncryptionHelper Class</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
@ -12,8 +12,8 @@
|
|||
<td><a href="F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md">NUMBER_CHARACTERS</a></td>
|
||||
<td>A string of all the numeric characters.</td></tr>
|
||||
<tr>
|
||||
<td><a href="F_CapyKit_Helpers_SecurityHelper_saltSize.md">saltSize</a></td>
|
||||
<td>Default size of the generated salt.</td></tr>
|
||||
<td><a href="F_CapyKit_Helpers_SecurityHelper_SALT_SIZE.md">SALT_SIZE</a></td>
|
||||
<td>Default size to use when generating a new salt.</td></tr>
|
||||
<tr>
|
||||
<td><a href="F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md">SPECIAL_CHARACTERS</a></td>
|
||||
<td>A string of the most common non-alphanumeric characters.</td></tr>
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
<table>
|
||||
<tr>
|
||||
<td><a href="F_CapyKit_Helpers_SettingsHelper_accessor.md">accessor</a></td>
|
||||
<td>Private delegate function that retrieves a setting with the given <code>key</code>. Returns the setting as an uncast <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>.</td></tr>
|
||||
<td>Private delegate function that retrieves a setting with the given <code>key</code>.</td></tr>
|
||||
<tr>
|
||||
<td><a href="F_CapyKit_Helpers_SettingsHelper_detector.md">detector</a></td>
|
||||
<td>Private delegate function that detects if a setting with a given <code>key</code> exists. Returns true if the setting exists, false if not.</td></tr>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
## Fields
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="F_CapyKit_Password_algorithm.md">algorithm</a></td>
|
||||
<td><a href="F_CapyKit_Password_pbkdf2Algorithm.md">pbkdf2Algorithm</a></td>
|
||||
<td> </td></tr>
|
||||
</table>
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,42 @@
|
|||
# GetFormatParameterizedString Method
|
||||
|
||||
|
||||
Gets a parameterized formatted string for the specified index.
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public string GetFormatParameterizedString(
|
||||
int index = 0
|
||||
)
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
member GetFormatParameterizedString :
|
||||
?index : int
|
||||
(* Defaults:
|
||||
let _index = defaultArg index 0
|
||||
*)
|
||||
-> string
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a> (Optional)</dt><dd>(Optional) Zero-based index of the item in the string to format.</dd></dl>
|
||||
|
||||
#### Return Value
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
||||
A formatted string with the specified index and format.
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute Class</a>
|
||||
<a href="N_CapyKit_Attributes.md">CapyKit.Attributes Namespace</a>
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
# ValueFormatAttribute Constructor
|
||||
|
||||
|
||||
Default constructor. Initializes a new instance of the <a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute</a> class with an empty format string.
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public ValueFormatAttribute()
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
new : unit -> ValueFormatAttribute
|
||||
```
|
||||
|
||||
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute Class</a>
|
||||
<a href="Overload_CapyKit_Attributes_ValueFormatAttribute__ctor.md">ValueFormatAttribute Overload</a>
|
||||
<a href="N_CapyKit_Attributes.md">CapyKit.Attributes Namespace</a>
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
# ValueFormatAttribute(String) Constructor
|
||||
|
||||
|
||||
Constructor. Initializes a new instance of the <a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute</a> class with the specified format string.
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public ValueFormatAttribute(
|
||||
string format
|
||||
)
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
new :
|
||||
format : string -> ValueFormatAttribute
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The format string used to format the value.</dd></dl>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute Class</a>
|
||||
<a href="Overload_CapyKit_Attributes_ValueFormatAttribute__ctor.md">ValueFormatAttribute Overload</a>
|
||||
<a href="N_CapyKit_Attributes.md">CapyKit.Attributes Namespace</a>
|
||||
|
|
@ -11,7 +11,7 @@ Emits an event with the given severity level, message, and method name.
|
|||
|
||||
**C#**
|
||||
``` C#
|
||||
internal static void EmitEvent(
|
||||
public static void EmitEvent(
|
||||
EventLevel eventLevel,
|
||||
string message,
|
||||
string method = null,
|
||||
|
|
@ -20,7 +20,7 @@ internal static void EmitEvent(
|
|||
```
|
||||
**F#**
|
||||
``` F#
|
||||
internal static member EmitEvent :
|
||||
static member EmitEvent :
|
||||
eventLevel : EventLevel *
|
||||
message : string *
|
||||
?method : string *
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Emits an event with the given severity level, message, unique identifier, and me
|
|||
|
||||
**C#**
|
||||
``` C#
|
||||
internal static void EmitEventOnce(
|
||||
public static void EmitEventOnce(
|
||||
EventLevel eventLevel,
|
||||
string message,
|
||||
string uniqueIdentifier,
|
||||
|
|
@ -21,7 +21,7 @@ internal static void EmitEventOnce(
|
|||
```
|
||||
**F#**
|
||||
``` F#
|
||||
internal static member EmitEventOnce :
|
||||
static member EmitEventOnce :
|
||||
eventLevel : EventLevel *
|
||||
message : string *
|
||||
uniqueIdentifier : string *
|
||||
|
|
|
|||
28
Documentation/Help/M_CapyKit_EncryptedValue_1__ctor.md
Normal file
28
Documentation/Help/M_CapyKit_EncryptedValue_1__ctor.md
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
# EncryptedValue<T> Constructor
|
||||
|
||||
|
||||
Initializes a new instance of the <a href="T_CapyKit_EncryptedValue_1.md">EncryptedValue(T)</a> class
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public EncryptedValue()
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
new : unit -> EncryptedValue
|
||||
```
|
||||
|
||||
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_EncryptedValue_1.md">EncryptedValue(T) Class</a>
|
||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
# EncryptionHelper Constructor
|
||||
|
||||
|
||||
Initializes a new instance of the <a href="T_CapyKit_Helpers_EncryptionHelper.md">EncryptionHelper</a> class
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public EncryptionHelper(
|
||||
string encryptionKey
|
||||
)
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
new :
|
||||
encryptionKey : string -> EncryptionHelper
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>\[Missing <param name="encryptionKey"/> documentation for "M:CapyKit.Helpers.EncryptionHelper.#ctor(System.String)"\]</dd></dl>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_EncryptionHelper.md">EncryptionHelper Class</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
# Decrypt<T> Method
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])"\]
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
T Decrypt<T>(
|
||||
EncryptedValue<T> encryptedValue,
|
||||
params Object[] args
|
||||
)
|
||||
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
abstract Decrypt :
|
||||
encryptedValue : EncryptedValue<'T> *
|
||||
args : Object[] -> 'T
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
<dl><dt> <a href="T_CapyKit_EncryptedValue_1.md">EncryptedValue</a>(T)</dt><dd>\[Missing <param name="encryptedValue"/> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])"\]</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>[]</dt><dd>\[Missing <param name="args"/> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])"\]</dd></dl>
|
||||
|
||||
#### Type Parameters
|
||||
<dl><dt /><dd>\[Missing <typeparam name="T"/> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])"\]</dd></dl>
|
||||
|
||||
#### Return Value
|
||||
T
|
||||
\[Missing <returns> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])"\]
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_IEncryptionAlgorithm.md">IEncryptionAlgorithm Interface</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
# Encrypt<T> Method
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])"\]
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
EncryptedValue<T> Encrypt<T>(
|
||||
Object obj,
|
||||
params Object[] args
|
||||
)
|
||||
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
abstract Encrypt :
|
||||
obj : Object *
|
||||
args : Object[] -> EncryptedValue<'T>
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a></dt><dd>\[Missing <param name="obj"/> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])"\]</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>[]</dt><dd>\[Missing <param name="args"/> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])"\]</dd></dl>
|
||||
|
||||
#### Type Parameters
|
||||
<dl><dt /><dd>\[Missing <typeparam name="T"/> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])"\]</dd></dl>
|
||||
|
||||
#### Return Value
|
||||
<a href="T_CapyKit_EncryptedValue_1.md">EncryptedValue</a>(T)
|
||||
\[Missing <returns> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])"\]
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_IEncryptionAlgorithm.md">IEncryptionAlgorithm Interface</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
# CompareHashedPassword Method
|
||||
# CompareHashedPassword(Password, String, Byte[], IPasswordAlgorithm, Object[]) Method
|
||||
|
||||
|
||||
Compares an unencrypted *providedPassword* with a stored, encrypted *existingPassword*.
|
||||
Compares an unencrypted *password* with a stored, encrypted *existingPassword*. This method uses the specified *algorithm* to retrieve the hashed version of the *password* and then compares it with the *existingPassword*.
|
||||
|
||||
|
||||
|
||||
|
|
@ -12,21 +12,27 @@ Compares an unencrypted *providedPassword* with a stored, encrypted *existingPas
|
|||
**C#**
|
||||
``` C#
|
||||
public static bool CompareHashedPassword(
|
||||
string providedPassword,
|
||||
string existingPassword
|
||||
Password existingPassword,
|
||||
string password,
|
||||
byte[] salt,
|
||||
IPasswordAlgorithm algorithm,
|
||||
params Object[] args
|
||||
)
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
static member CompareHashedPassword :
|
||||
providedPassword : string *
|
||||
existingPassword : string -> bool
|
||||
existingPassword : Password *
|
||||
password : string *
|
||||
salt : byte[] *
|
||||
algorithm : IPasswordAlgorithm *
|
||||
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 provided password, unencrypted.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The existing, encrypted password.</dd></dl>
|
||||
<dl><dt> <a href="T_CapyKit_Password.md">Password</a></dt><dd>The existing, encrypted password.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The unencrypted password to be compared.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]</dt><dd>The salt value used in password hashing.</dd><dt> <a href="T_CapyKit_IPasswordAlgorithm.md">IPasswordAlgorithm</a></dt><dd>The password hashing algorithm.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>[]</dt><dd>Additional arguments required for constructing the password algorithm instance.</dd></dl>
|
||||
|
||||
#### Return Value
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.boolean" target="_blank" rel="noopener noreferrer">Boolean</a>
|
||||
|
|
@ -37,4 +43,5 @@ true if hash comparison succeeds, false if it fails.
|
|||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
|
||||
<a href="Overload_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md">CompareHashedPassword Overload</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,49 @@
|
|||
# CompareHashedPassword<T>(Password, String, Byte[], Object[]) Method
|
||||
|
||||
|
||||
Compares an unencrypted *password* with a stored, encrypted *existingPassword*. This method uses the specified password algorithm type *T* to retrieve the hashed version of the *password* and then compares it with the *existingPassword*.
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public static bool CompareHashedPassword<T>(
|
||||
Password existingPassword,
|
||||
string password,
|
||||
byte[] salt,
|
||||
params Object[] args
|
||||
)
|
||||
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
static member CompareHashedPassword :
|
||||
existingPassword : Password *
|
||||
password : string *
|
||||
salt : byte[] *
|
||||
args : Object[] -> bool
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
<dl><dt> <a href="T_CapyKit_Password.md">Password</a></dt><dd>The existing, encrypted password.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The unencrypted password to be compared.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]</dt><dd>The salt value used in password hashing.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>[]</dt><dd>Additional arguments required for constructing the password algorithm instance.</dd></dl>
|
||||
|
||||
#### Type Parameters
|
||||
<dl><dt /><dd>The type of the password hashing algorithm.</dd></dl>
|
||||
|
||||
#### Return Value
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.boolean" target="_blank" rel="noopener noreferrer">Boolean</a>
|
||||
true if hash comparison succeeds, false if it fails.
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
|
||||
<a href="Overload_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md">CompareHashedPassword Overload</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
# GetPassword<T>(String, Byte[], Object[]) Method
|
||||
|
||||
|
||||
Retrieves a <a href="T_CapyKit_Password.md">Password</a> object using the specified password, salt, and optional constructor arguments.
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public static Password GetPassword<T>(
|
||||
string password,
|
||||
byte[] salt,
|
||||
params Object[] args
|
||||
)
|
||||
where T : IPasswordAlgorithm
|
||||
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
static member GetPassword :
|
||||
password : string *
|
||||
salt : byte[] *
|
||||
args : Object[] -> Password when 'T : IPasswordAlgorithm
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### 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 be hashed.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]</dt><dd>A random value used as an additional input to the one-way function that hashes data, a password or passphrase. This is used to make each output different for the same input thus adding security.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>[]</dt><dd>Optional constructor arguments for the <a href="T_CapyKit_IPasswordAlgorithm.md">IPasswordAlgorithm</a> implementation instance.</dd></dl>
|
||||
|
||||
#### Type Parameters
|
||||
<dl><dt /><dd>The type of <a href="T_CapyKit_IPasswordAlgorithm.md">IPasswordAlgorithm</a> implementation to use.</dd></dl>
|
||||
|
||||
#### Return Value
|
||||
<a href="T_CapyKit_Password.md">Password</a>
|
||||
A new <a href="T_CapyKit_Password.md">Password</a> object with the given password and salt, as well as an instance of *T* created using the provided constructor arguments.
|
||||
|
||||
## Remarks
|
||||
This method uses reflection to find a constructor for the specified password algorithm type (*T*). It emits an error event if a suitable constructor is not found or if there is an error invoking the constructor.
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
|
||||
<a href="Overload_CapyKit_Helpers_SecurityHelper_GetPassword.md">GetPassword Overload</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
# GetPassword<T>(String, Object[]) Method
|
||||
|
||||
|
||||
Retrieves a <a href="T_CapyKit_Password.md">Password</a> object using the specified password and generates a random salt value. Then it uses that salt to call the overloaded <a href="M_CapyKit_Helpers_SecurityHelper_GetPassword__1.md">GetPassword(T)(String, Byte[], Object[])</a> method with the given password and the generated salt as arguments.
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public static Password GetPassword<T>(
|
||||
string password,
|
||||
params Object[] args
|
||||
)
|
||||
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
static member GetPassword :
|
||||
password : string *
|
||||
args : Object[] -> Password
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### 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 be hashed.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>[]</dt><dd>Optional constructor arguments for the <a href="T_CapyKit_IPasswordAlgorithm.md">IPasswordAlgorithm</a> implementation instance.</dd></dl>
|
||||
|
||||
#### Type Parameters
|
||||
<dl><dt /><dd>The type of <a href="T_CapyKit_IPasswordAlgorithm.md">IPasswordAlgorithm</a> implementation to use.</dd></dl>
|
||||
|
||||
#### Return Value
|
||||
<a href="T_CapyKit_Password.md">Password</a>
|
||||
A new <a href="T_CapyKit_Password.md">Password</a> object with the given password and a randomly generated salt, as well as an instance of *T* created using any optional constructor arguments provided.
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
|
||||
<a href="Overload_CapyKit_Helpers_SecurityHelper_GetPassword.md">GetPassword Overload</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
<a href="F_CapyKit_Helpers_SecurityHelper_SALT_SIZE.md">SALT_SIZE</a>
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
# GetValidCharacterComposition Method
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "M:CapyKit.Helpers.SecurityHelper.GetValidCharacterComposition(CapyKit.Helpers.ValidCharacterCollection[])"\]
|
||||
Static method that returns a valid character composition based on the given ValidCharacterCollection parameters.
|
||||
|
||||
|
||||
|
||||
|
|
@ -24,11 +24,11 @@ private static member GetValidCharacterComposition :
|
|||
|
||||
|
||||
#### Parameters
|
||||
<dl><dt> <a href="T_CapyKit_Helpers_ValidCharacterCollection.md">ValidCharacterCollection</a>[]</dt><dd>\[Missing <param name="validCharacters"/> documentation for "M:CapyKit.Helpers.SecurityHelper.GetValidCharacterComposition(CapyKit.Helpers.ValidCharacterCollection[])"\]</dd></dl>
|
||||
<dl><dt> <a href="T_CapyKit_Helpers_ValidCharacterCollection.md">ValidCharacterCollection</a>[]</dt><dd>An array of ValidCharacterCollection enumeration values representing the desired character sets.</dd></dl>
|
||||
|
||||
#### Return Value
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
||||
\[Missing <returns> documentation for "M:CapyKit.Helpers.SecurityHelper.GetValidCharacterComposition(CapyKit.Helpers.ValidCharacterCollection[])"\]
|
||||
A string containing all the characters from the specified character sets.
|
||||
|
||||
## See Also
|
||||
|
||||
|
|
|
|||
|
|
@ -1,38 +0,0 @@
|
|||
# HashPassword Method
|
||||
|
||||
|
||||
Hashes an unencrypted password.
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public static string HashPassword(
|
||||
string password
|
||||
)
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
static member HashPassword :
|
||||
password : string -> string
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The password.</dd></dl>
|
||||
|
||||
#### Return Value
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
||||
The hashed password.
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
# GetApplicationSetting<T> Method
|
||||
|
||||
|
||||
Retrieves a setting with the given `key`. Returns the setting as an uncast *T*.
|
||||
Retrieves a setting with the given `key`.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
40
Documentation/Help/M_CapyKit_Password_Equals.md
Normal file
40
Documentation/Help/M_CapyKit_Password_Equals.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# Equals Method
|
||||
|
||||
|
||||
Determines whether the specified object is equal to the current object.
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public override bool Equals(
|
||||
Object? obj
|
||||
)
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
abstract Equals :
|
||||
obj : Object -> bool
|
||||
override Equals :
|
||||
obj : Object -> bool
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a></dt><dd>The object to compare with the current object.</dd></dl>
|
||||
|
||||
#### Return Value
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.boolean" target="_blank" rel="noopener noreferrer">Boolean</a>
|
||||
true if the specified object is equal to the current object; otherwise, false.
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Password.md">Password Class</a>
|
||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
||||
40
Documentation/Help/M_CapyKit_Password_op_Equality.md
Normal file
40
Documentation/Help/M_CapyKit_Password_op_Equality.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# Equality Operator
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "M:CapyKit.Password.op_Equality(CapyKit.Password,CapyKit.Password)"\]
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public static bool operator ==(
|
||||
Password a,
|
||||
Password b
|
||||
)
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
static let inline (=)
|
||||
a : Password *
|
||||
b : Password : bool
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
<dl><dt> <a href="T_CapyKit_Password.md">Password</a></dt><dd>\[Missing <param name="a"/> documentation for "M:CapyKit.Password.op_Equality(CapyKit.Password,CapyKit.Password)"\]</dd><dt> <a href="T_CapyKit_Password.md">Password</a></dt><dd>\[Missing <param name="b"/> documentation for "M:CapyKit.Password.op_Equality(CapyKit.Password,CapyKit.Password)"\]</dd></dl>
|
||||
|
||||
#### Return Value
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.boolean" target="_blank" rel="noopener noreferrer">Boolean</a>
|
||||
\[Missing <returns> documentation for "M:CapyKit.Password.op_Equality(CapyKit.Password,CapyKit.Password)"\]
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Password.md">Password Class</a>
|
||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
||||
40
Documentation/Help/M_CapyKit_Password_op_Inequality.md
Normal file
40
Documentation/Help/M_CapyKit_Password_op_Inequality.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# Inequality Operator
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "M:CapyKit.Password.op_Inequality(CapyKit.Password,CapyKit.Password)"\]
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public static bool operator !=(
|
||||
Password a,
|
||||
Password b
|
||||
)
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
static let inline (<>)
|
||||
a : Password *
|
||||
b : Password : bool
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
<dl><dt> <a href="T_CapyKit_Password.md">Password</a></dt><dd>\[Missing <param name="a"/> documentation for "M:CapyKit.Password.op_Inequality(CapyKit.Password,CapyKit.Password)"\]</dd><dt> <a href="T_CapyKit_Password.md">Password</a></dt><dd>\[Missing <param name="b"/> documentation for "M:CapyKit.Password.op_Inequality(CapyKit.Password,CapyKit.Password)"\]</dd></dl>
|
||||
|
||||
#### Return Value
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.boolean" target="_blank" rel="noopener noreferrer">Boolean</a>
|
||||
\[Missing <returns> documentation for "M:CapyKit.Password.op_Inequality(CapyKit.Password,CapyKit.Password)"\]
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Password.md">Password Class</a>
|
||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
# ValueFormatAttribute Methods
|
||||
|
||||
|
||||
|
||||
|
||||
## Methods
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="https://learn.microsoft.com/dotnet/api/system.attribute.equals" target="_blank" rel="noopener noreferrer">Equals</a></td>
|
||||
<td>Returns a value that indicates whether this instance is equal to a specified object.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.attribute" target="_blank" rel="noopener noreferrer">Attribute</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="M_CapyKit_Attributes_ValueFormatAttribute_GetFormatParameterizedString.md">GetFormatParameterizedString</a></td>
|
||||
<td>Gets a parameterized formatted string for the specified index.</td></tr>
|
||||
<tr>
|
||||
<td><a href="https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode" target="_blank" rel="noopener noreferrer">GetHashCode</a></td>
|
||||
<td>Returns the hash code for this instance.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.attribute" target="_blank" rel="noopener noreferrer">Attribute</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.attribute.isdefaultattribute" target="_blank" rel="noopener noreferrer">IsDefaultAttribute</a></td>
|
||||
<td>When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.attribute" target="_blank" rel="noopener noreferrer">Attribute</a>)</td></tr>
|
||||
<tr>
|
||||
<td><a href="https://learn.microsoft.com/dotnet/api/system.attribute.match" target="_blank" rel="noopener noreferrer">Match</a></td>
|
||||
<td>When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.attribute" target="_blank" rel="noopener noreferrer">Attribute</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="https://learn.microsoft.com/dotnet/api/system.object.tostring" target="_blank" rel="noopener noreferrer">ToString</a></td>
|
||||
<td>Returns a string that represents 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>
|
||||
</table>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute Class</a>
|
||||
<a href="N_CapyKit_Attributes.md">CapyKit.Attributes Namespace</a>
|
||||
33
Documentation/Help/Methods_T_CapyKit_EncryptedValue_1.md
Normal file
33
Documentation/Help/Methods_T_CapyKit_EncryptedValue_1.md
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
# EncryptedValue<T> Methods
|
||||
|
||||
|
||||
|
||||
|
||||
## 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="https://learn.microsoft.com/dotnet/api/system.object.tostring" target="_blank" rel="noopener noreferrer">ToString</a></td>
|
||||
<td>Returns a string that represents 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>
|
||||
</table>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_EncryptedValue_1.md">EncryptedValue(T) Class</a>
|
||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
# EncryptionHelper Methods
|
||||
|
||||
|
||||
|
||||
|
||||
## 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="https://learn.microsoft.com/dotnet/api/system.object.tostring" target="_blank" rel="noopener noreferrer">ToString</a></td>
|
||||
<td>Returns a string that represents 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>
|
||||
</table>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_EncryptionHelper.md">EncryptionHelper Class</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
# IEncryptionAlgorithm Methods
|
||||
|
||||
|
||||
|
||||
|
||||
## Methods
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1.md">Decrypt(T)</a></td>
|
||||
<td> </td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1.md">Encrypt(T)</a></td>
|
||||
<td> </td></tr>
|
||||
</table>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_IEncryptionAlgorithm.md">IEncryptionAlgorithm Interface</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
@ -6,8 +6,11 @@
|
|||
## Methods
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md">CompareHashedPassword</a></td>
|
||||
<td>Compares an unencrypted <em>providedPassword</em> with a stored, encrypted <em>existingPassword</em>.</td></tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md">CompareHashedPassword(Password, String, Byte[], IPasswordAlgorithm, Object[])</a></td>
|
||||
<td>Compares an unencrypted <em>password</em> with a stored, encrypted <em>existingPassword</em>. This method uses the specified <em>algorithm</em> to retrieve the hashed version of the <em>password</em> and then compares it with the <em>existingPassword</em>.</td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword__1.md">CompareHashedPassword(T)(Password, String, Byte[], Object[])</a></td>
|
||||
<td>Compares an unencrypted <em>password</em> with a stored, encrypted <em>existingPassword</em>. This method uses the specified password algorithm type <em>T</em> to retrieve the hashed version of the <em>password</em> and then compares it with the <em>existingPassword</em>.</td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md">CompareSessionID</a></td>
|
||||
<td>Compares two session identifiers.</td></tr>
|
||||
|
|
@ -24,6 +27,12 @@
|
|||
<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="M_CapyKit_Helpers_SecurityHelper_GetPassword__1_1.md">GetPassword(T)(String, Object[])</a></td>
|
||||
<td>Retrieves a <a href="T_CapyKit_Password.md">Password</a> object using the specified password and generates a random salt value. Then it uses that salt to call the overloaded <a href="M_CapyKit_Helpers_SecurityHelper_GetPassword__1.md">GetPassword(T)(String, Byte[], Object[])</a> method with the given password and the generated salt as arguments.</td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetPassword__1.md">GetPassword(T)(String, Byte[], Object[])</a></td>
|
||||
<td>Retrieves a <a href="T_CapyKit_Password.md">Password</a> object using the specified password, salt, and optional constructor arguments.</td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md">GetRandomBytes</a></td>
|
||||
<td>Generates a new byte array of the specified length with random values.</td></tr>
|
||||
<tr>
|
||||
|
|
@ -40,10 +49,7 @@
|
|||
<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="M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md">GetValidCharacterComposition</a></td>
|
||||
<td> </td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_HashPassword.md">HashPassword</a></td>
|
||||
<td>Hashes an unencrypted password.</td></tr>
|
||||
<td>Static method that returns a valid character composition based on the given ValidCharacterCollection parameters.</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>
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
<table>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1.md">GetApplicationSetting(T)</a></td>
|
||||
<td>Retrieves a setting with the given <code>key</code>. Returns the setting as an uncast <em>T</em>.</td></tr>
|
||||
<td>Retrieves a setting with the given <code>key</code>.</td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SettingsHelper_SetAccessorMethod.md">SetAccessorMethod</a></td>
|
||||
<td>Sets the function used to retrieve application settings.</td></tr>
|
||||
|
|
|
|||
|
|
@ -6,8 +6,8 @@
|
|||
## 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>
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -14,6 +14,9 @@
|
|||
<td><a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter</a></td>
|
||||
<td>The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</td></tr>
|
||||
<tr>
|
||||
<td><a href="T_CapyKit_EncryptedValue_1.md">EncryptedValue(T)</a></td>
|
||||
<td> </td></tr>
|
||||
<tr>
|
||||
<td><a href="T_CapyKit_Password.md">Password</a></td>
|
||||
<td>Represents a password with its hash, salt and algorithm used for encryption.</td></tr>
|
||||
<tr>
|
||||
|
|
|
|||
|
|
@ -13,4 +13,7 @@
|
|||
<tr>
|
||||
<td><a href="T_CapyKit_Attributes_EnumerationDescriptionAttribute.md">EnumerationDescriptionAttribute</a></td>
|
||||
<td>An attribute class for decorating enumeration fields with a description.</td></tr>
|
||||
<tr>
|
||||
<td><a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute</a></td>
|
||||
<td>Custom attribute for formatting values in a specific way.</td></tr>
|
||||
</table>
|
||||
|
|
@ -14,6 +14,9 @@
|
|||
<td><a href="T_CapyKit_Helpers_CompressionHelper.md">CompressionHelper</a></td>
|
||||
<td>A class that contains methods for managing data compression.</td></tr>
|
||||
<tr>
|
||||
<td><a href="T_CapyKit_Helpers_EncryptionHelper.md">EncryptionHelper</a></td>
|
||||
<td> </td></tr>
|
||||
<tr>
|
||||
<td><a href="T_CapyKit_Helpers_LanguageHelper.md">LanguageHelper</a></td>
|
||||
<td>Helper class for handling text transformations.</td></tr>
|
||||
<tr>
|
||||
|
|
@ -27,6 +30,13 @@
|
|||
<td>Static class containing helper methods for retrieving and setting application settings.</td></tr>
|
||||
</table>
|
||||
|
||||
## Interfaces
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="T_CapyKit_Helpers_IEncryptionAlgorithm.md">IEncryptionAlgorithm</a></td>
|
||||
<td> </td></tr>
|
||||
</table>
|
||||
|
||||
## Enumerations
|
||||
<table>
|
||||
<tr>
|
||||
|
|
|
|||
21
Documentation/Help/Operators_T_CapyKit_Password.md
Normal file
21
Documentation/Help/Operators_T_CapyKit_Password.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# Password Operators
|
||||
|
||||
|
||||
|
||||
|
||||
## 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>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Password.md">Password Class</a>
|
||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
# ValueFormatAttribute Constructor
|
||||
|
||||
|
||||
## Overload List
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Attributes_ValueFormatAttribute__ctor.md">ValueFormatAttribute()</a></td>
|
||||
<td>Default constructor. Initializes a new instance of the <a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute</a> class with an empty format string.</td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Attributes_ValueFormatAttribute__ctor_1.md">ValueFormatAttribute(String)</a></td>
|
||||
<td>Constructor. Initializes a new instance of the <a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute</a> class with the specified format string.</td></tr>
|
||||
</table>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute Class</a>
|
||||
<a href="N_CapyKit_Attributes.md">CapyKit.Attributes Namespace</a>
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
# CompareHashedPassword Method
|
||||
|
||||
|
||||
## Overload List
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md">CompareHashedPassword(Password, String, Byte[], IPasswordAlgorithm, Object[])</a></td>
|
||||
<td>Compares an unencrypted <em>password</em> with a stored, encrypted <em>existingPassword</em>. This method uses the specified <em>algorithm</em> to retrieve the hashed version of the <em>password</em> and then compares it with the <em>existingPassword</em>.</td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword__1.md">CompareHashedPassword(T)(Password, String, Byte[], Object[])</a></td>
|
||||
<td>Compares an unencrypted <em>password</em> with a stored, encrypted <em>existingPassword</em>. This method uses the specified password algorithm type <em>T</em> to retrieve the hashed version of the <em>password</em> and then compares it with the <em>existingPassword</em>.</td></tr>
|
||||
</table>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
# GetPassword Method
|
||||
|
||||
|
||||
## Overload List
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetPassword__1_1.md">GetPassword(T)(String, Object[])</a></td>
|
||||
<td>Retrieves a <a href="T_CapyKit_Password.md">Password</a> object using the specified password and generates a random salt value. Then it uses that salt to call the overloaded <a href="M_CapyKit_Helpers_SecurityHelper_GetPassword__1.md">GetPassword(T)(String, Byte[], Object[])</a> method with the given password and the generated salt as arguments.</td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetPassword__1.md">GetPassword(T)(String, Byte[], Object[])</a></td>
|
||||
<td>Retrieves a <a href="T_CapyKit_Password.md">Password</a> object using the specified password, salt, and optional constructor arguments.</td></tr>
|
||||
</table>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# Format Property
|
||||
|
||||
|
||||
Gets or sets the format to use for formatting the value.
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public string Format { get; private set; }
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
member Format : string with get, private set
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Property Value
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
||||
The format string used to format the value.
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute Class</a>
|
||||
<a href="N_CapyKit_Attributes.md">CapyKit.Attributes Namespace</a>
|
||||
31
Documentation/Help/P_CapyKit_EncryptedValue_1_Value.md
Normal file
31
Documentation/Help/P_CapyKit_EncryptedValue_1_Value.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
# Value Property
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "P:CapyKit.EncryptedValue`1.Value"\]
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public T Value { get; set; }
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
member Value : 'T with get, set
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Property Value
|
||||
<a href="T_CapyKit_EncryptedValue_1.md">T</a>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_EncryptedValue_1.md">EncryptedValue(T) Class</a>
|
||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
# AlgorithmName Property
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "P:CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName"\]
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
string AlgorithmName { get; }
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
abstract AlgorithmName : string with get
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Property Value
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_IEncryptionAlgorithm.md">IEncryptionAlgorithm Interface</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
# Pbkdf2Algorithm Property
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "P:CapyKit.Password.Pbkdf2Algorithm"\]
|
||||
Gets the preconfigured PBKDF2 algorithm.
|
||||
|
||||
|
||||
|
||||
|
|
@ -21,7 +21,8 @@ static member Pbkdf2Algorithm : Pbkdf2Algorithm with get
|
|||
|
||||
|
||||
#### Property Value
|
||||
<a href="T_CapyKit_Pbkdf2Algorithm.md">Pbkdf2Algorithm</a>
|
||||
<a href="T_CapyKit_Pbkdf2Algorithm.md">Pbkdf2Algorithm</a>
|
||||
The preconfigured PBKDF2 algorithm.
|
||||
|
||||
## See Also
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,21 @@
|
|||
# ValueFormatAttribute Properties
|
||||
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="P_CapyKit_Attributes_ValueFormatAttribute_Format.md">Format</a></td>
|
||||
<td>Gets or sets the format to use for formatting the value.</td></tr>
|
||||
<tr>
|
||||
<td><a href="https://learn.microsoft.com/dotnet/api/system.attribute.typeid" target="_blank" rel="noopener noreferrer">TypeId</a></td>
|
||||
<td>When implemented in a derived class, gets a unique identifier for this <a href="https://learn.microsoft.com/dotnet/api/system.attribute" target="_blank" rel="noopener noreferrer">Attribute</a>.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.attribute" target="_blank" rel="noopener noreferrer">Attribute</a>)</td></tr>
|
||||
</table>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute Class</a>
|
||||
<a href="N_CapyKit_Attributes.md">CapyKit.Attributes Namespace</a>
|
||||
18
Documentation/Help/Properties_T_CapyKit_EncryptedValue_1.md
Normal file
18
Documentation/Help/Properties_T_CapyKit_EncryptedValue_1.md
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
# EncryptedValue<T> Properties
|
||||
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="P_CapyKit_EncryptedValue_1_Value.md">Value</a></td>
|
||||
<td> </td></tr>
|
||||
</table>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_EncryptedValue_1.md">EncryptedValue(T) Class</a>
|
||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
# IEncryptionAlgorithm Properties
|
||||
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="P_CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName.md">AlgorithmName</a></td>
|
||||
<td> </td></tr>
|
||||
</table>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="T_CapyKit_Helpers_IEncryptionAlgorithm.md">IEncryptionAlgorithm Interface</a>
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
@ -13,7 +13,7 @@
|
|||
<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>
|
||||
<td>Gets the preconfigured PBKDF2 algorithm.</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>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,86 @@
|
|||
# ValueFormatAttribute Class
|
||||
|
||||
|
||||
Custom attribute for formatting values in a specific way.
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
[AttributeUsageAttribute(AttributeTargets.Property)]
|
||||
public class ValueFormatAttribute : Attribute
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
[<AttributeUsageAttribute(AttributeTargets.Property)>]
|
||||
type ValueFormatAttribute =
|
||||
class
|
||||
inherit Attribute
|
||||
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> → <a href="https://learn.microsoft.com/dotnet/api/system.attribute" target="_blank" rel="noopener noreferrer">Attribute</a> → ValueFormatAttribute</td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
## Constructors
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Attributes_ValueFormatAttribute__ctor.md">ValueFormatAttribute()</a></td>
|
||||
<td>Default constructor. Initializes a new instance of the ValueFormatAttribute class with an empty format string.</td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Attributes_ValueFormatAttribute__ctor_1.md">ValueFormatAttribute(String)</a></td>
|
||||
<td>Constructor. Initializes a new instance of the ValueFormatAttribute class with the specified format string.</td></tr>
|
||||
</table>
|
||||
|
||||
## Properties
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="P_CapyKit_Attributes_ValueFormatAttribute_Format.md">Format</a></td>
|
||||
<td>Gets or sets the format to use for formatting the value.</td></tr>
|
||||
<tr>
|
||||
<td><a href="https://learn.microsoft.com/dotnet/api/system.attribute.typeid" target="_blank" rel="noopener noreferrer">TypeId</a></td>
|
||||
<td>When implemented in a derived class, gets a unique identifier for this <a href="https://learn.microsoft.com/dotnet/api/system.attribute" target="_blank" rel="noopener noreferrer">Attribute</a>.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.attribute" target="_blank" rel="noopener noreferrer">Attribute</a>)</td></tr>
|
||||
</table>
|
||||
|
||||
## Methods
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="https://learn.microsoft.com/dotnet/api/system.attribute.equals" target="_blank" rel="noopener noreferrer">Equals</a></td>
|
||||
<td>Returns a value that indicates whether this instance is equal to a specified object.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.attribute" target="_blank" rel="noopener noreferrer">Attribute</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="M_CapyKit_Attributes_ValueFormatAttribute_GetFormatParameterizedString.md">GetFormatParameterizedString</a></td>
|
||||
<td>Gets a parameterized formatted string for the specified index.</td></tr>
|
||||
<tr>
|
||||
<td><a href="https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode" target="_blank" rel="noopener noreferrer">GetHashCode</a></td>
|
||||
<td>Returns the hash code for this instance.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.attribute" target="_blank" rel="noopener noreferrer">Attribute</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.attribute.isdefaultattribute" target="_blank" rel="noopener noreferrer">IsDefaultAttribute</a></td>
|
||||
<td>When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.attribute" target="_blank" rel="noopener noreferrer">Attribute</a>)</td></tr>
|
||||
<tr>
|
||||
<td><a href="https://learn.microsoft.com/dotnet/api/system.attribute.match" target="_blank" rel="noopener noreferrer">Match</a></td>
|
||||
<td>When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.attribute" target="_blank" rel="noopener noreferrer">Attribute</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="https://learn.microsoft.com/dotnet/api/system.object.tostring" target="_blank" rel="noopener noreferrer">ToString</a></td>
|
||||
<td>Returns a string that represents 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>
|
||||
</table>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="N_CapyKit_Attributes.md">CapyKit.Attributes Namespace</a>
|
||||
File diff suppressed because it is too large
Load diff
70
Documentation/Help/T_CapyKit_EncryptedValue_1.md
Normal file
70
Documentation/Help/T_CapyKit_EncryptedValue_1.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# EncryptedValue<T> Class
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "T:CapyKit.EncryptedValue`1"\]
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public class EncryptedValue<T>
|
||||
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
type EncryptedValue<'T> = 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> → EncryptedValue(T)</td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
#### Type Parameters
|
||||
<dl><dt /><dd>\[Missing <typeparam name="T"/> documentation for "T:CapyKit.EncryptedValue`1"\]</dd></dl>
|
||||
|
||||
## Constructors
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_EncryptedValue_1__ctor.md">EncryptedValue(T)</a></td>
|
||||
<td>Initializes a new instance of the EncryptedValue(T) class</td></tr>
|
||||
</table>
|
||||
|
||||
## Properties
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="P_CapyKit_EncryptedValue_1_Value.md">Value</a></td>
|
||||
<td> </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="https://learn.microsoft.com/dotnet/api/system.object.tostring" target="_blank" rel="noopener noreferrer">ToString</a></td>
|
||||
<td>Returns a string that represents 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>
|
||||
</table>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
||||
66
Documentation/Help/T_CapyKit_Helpers_EncryptionHelper.md
Normal file
66
Documentation/Help/T_CapyKit_Helpers_EncryptionHelper.md
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
# EncryptionHelper Class
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "T:CapyKit.Helpers.EncryptionHelper"\]
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public class EncryptionHelper
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
type EncryptionHelper = 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> → EncryptionHelper</td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
## Constructors
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_EncryptionHelper__ctor.md">EncryptionHelper</a></td>
|
||||
<td>Initializes a new instance of the EncryptionHelper class</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="https://learn.microsoft.com/dotnet/api/system.object.tostring" target="_blank" rel="noopener noreferrer">ToString</a></td>
|
||||
<td>Returns a string that represents 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>
|
||||
</table>
|
||||
|
||||
## Fields
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="F_CapyKit_Helpers_EncryptionHelper_encryptionKey.md">encryptionKey</a></td>
|
||||
<td> </td></tr>
|
||||
</table>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
44
Documentation/Help/T_CapyKit_Helpers_IEncryptionAlgorithm.md
Normal file
44
Documentation/Help/T_CapyKit_Helpers_IEncryptionAlgorithm.md
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
# IEncryptionAlgorithm Interface
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "T:CapyKit.Helpers.IEncryptionAlgorithm"\]
|
||||
|
||||
|
||||
|
||||
## Definition
|
||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
|
||||
|
||||
**C#**
|
||||
``` C#
|
||||
public interface IEncryptionAlgorithm
|
||||
```
|
||||
**F#**
|
||||
``` F#
|
||||
type IEncryptionAlgorithm = interface end
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="P_CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName.md">AlgorithmName</a></td>
|
||||
<td> </td></tr>
|
||||
</table>
|
||||
|
||||
## Methods
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1.md">Decrypt(T)</a></td>
|
||||
<td> </td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1.md">Encrypt(T)</a></td>
|
||||
<td> </td></tr>
|
||||
</table>
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Reference
|
||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
||||
|
|
@ -33,8 +33,11 @@ type SecurityHelper = class end
|
|||
## Methods
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md">CompareHashedPassword</a></td>
|
||||
<td>Compares an unencrypted <em>providedPassword</em> with a stored, encrypted <em>existingPassword</em>.</td></tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md">CompareHashedPassword(Password, String, Byte[], IPasswordAlgorithm, Object[])</a></td>
|
||||
<td>Compares an unencrypted <em>password</em> with a stored, encrypted <em>existingPassword</em>. This method uses the specified <em>algorithm</em> to retrieve the hashed version of the <em>password</em> and then compares it with the <em>existingPassword</em>.</td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword__1.md">CompareHashedPassword(T)(Password, String, Byte[], Object[])</a></td>
|
||||
<td>Compares an unencrypted <em>password</em> with a stored, encrypted <em>existingPassword</em>. This method uses the specified password algorithm type <em>T</em> to retrieve the hashed version of the <em>password</em> and then compares it with the <em>existingPassword</em>.</td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md">CompareSessionID</a></td>
|
||||
<td>Compares two session identifiers.</td></tr>
|
||||
|
|
@ -51,6 +54,12 @@ type SecurityHelper = class end
|
|||
<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="M_CapyKit_Helpers_SecurityHelper_GetPassword__1_1.md">GetPassword(T)(String, Object[])</a></td>
|
||||
<td>Retrieves a <a href="T_CapyKit_Password.md">Password</a> object using the specified password and generates a random salt value. Then it uses that salt to call the overloaded <a href="M_CapyKit_Helpers_SecurityHelper_GetPassword__1.md">GetPassword(T)(String, Byte[], Object[])</a> method with the given password and the generated salt as arguments.</td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetPassword__1.md">GetPassword(T)(String, Byte[], Object[])</a></td>
|
||||
<td>Retrieves a <a href="T_CapyKit_Password.md">Password</a> object using the specified password, salt, and optional constructor arguments.</td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md">GetRandomBytes</a></td>
|
||||
<td>Generates a new byte array of the specified length with random values.</td></tr>
|
||||
<tr>
|
||||
|
|
@ -67,10 +76,7 @@ type SecurityHelper = class end
|
|||
<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="M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md">GetValidCharacterComposition</a></td>
|
||||
<td> </td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SecurityHelper_HashPassword.md">HashPassword</a></td>
|
||||
<td>Hashes an unencrypted password.</td></tr>
|
||||
<td>Static method that returns a valid character composition based on the given ValidCharacterCollection parameters.</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>
|
||||
|
|
@ -94,8 +100,8 @@ type SecurityHelper = class end
|
|||
<td><a href="F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md">NUMBER_CHARACTERS</a></td>
|
||||
<td>A string of all the numeric characters.</td></tr>
|
||||
<tr>
|
||||
<td><a href="F_CapyKit_Helpers_SecurityHelper_saltSize.md">saltSize</a></td>
|
||||
<td>Default size of the generated salt.</td></tr>
|
||||
<td><a href="F_CapyKit_Helpers_SecurityHelper_SALT_SIZE.md">SALT_SIZE</a></td>
|
||||
<td>Default size to use when generating a new salt.</td></tr>
|
||||
<tr>
|
||||
<td><a href="F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md">SPECIAL_CHARACTERS</a></td>
|
||||
<td>A string of the most common non-alphanumeric characters.</td></tr>
|
||||
|
|
|
|||
|
|
@ -73,7 +73,7 @@ public int main(string[] args)
|
|||
<table>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1.md">GetApplicationSetting(T)</a></td>
|
||||
<td>Retrieves a setting with the given <code>key</code>. Returns the setting as an uncast <em>T</em>.</td></tr>
|
||||
<td>Retrieves a setting with the given <code>key</code>.</td></tr>
|
||||
<tr>
|
||||
<td><a href="M_CapyKit_Helpers_SettingsHelper_SetAccessorMethod.md">SetAccessorMethod</a></td>
|
||||
<td>Sets the function used to retrieve application settings.</td></tr>
|
||||
|
|
@ -86,7 +86,7 @@ public int main(string[] args)
|
|||
<table>
|
||||
<tr>
|
||||
<td><a href="F_CapyKit_Helpers_SettingsHelper_accessor.md">accessor</a></td>
|
||||
<td>Private delegate function that retrieves a setting with the given <code>key</code>. Returns the setting as an uncast <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>.</td></tr>
|
||||
<td>Private delegate function that retrieves a setting with the given <code>key</code>.</td></tr>
|
||||
<tr>
|
||||
<td><a href="F_CapyKit_Helpers_SettingsHelper_detector.md">detector</a></td>
|
||||
<td>Private delegate function that detects if a setting with a given <code>key</code> exists. Returns true if the setting exists, false if not.</td></tr>
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ type Password = class end
|
|||
<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>
|
||||
<td>Gets the preconfigured PBKDF2 algorithm.</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>
|
||||
|
|
@ -52,8 +52,8 @@ type Password = class end
|
|||
## 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>
|
||||
<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>
|
||||
|
|
@ -71,10 +71,20 @@ type Password = class end
|
|||
<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>
|
||||
|
||||
## 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>
|
||||
|
||||
## Fields
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="F_CapyKit_Password_algorithm.md">algorithm</a></td>
|
||||
<td><a href="F_CapyKit_Password_pbkdf2Algorithm.md">pbkdf2Algorithm</a></td>
|
||||
<td> </td></tr>
|
||||
</table>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +0,0 @@
|
|||
<doc>
|
||||
<assembly>
|
||||
<name>_InheritedDocs_</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="M:CapyKit.Password.ToString">
|
||||
|
||||
<summary>Returns a string that represents the current object.</summary><returns>A string that represents the current object.</returns></member><member name="P:CapyKit.Pbkdf2Algorithm.AlgorithmName">
|
||||
|
||||
<summary>
|
||||
Gets the name of the algorithm.
|
||||
</summary></member></members>
|
||||
</doc>
|
||||
|
|
@ -19,6 +19,11 @@
|
|||
- [CapyEventReporter Fields](Fields_T_CapyKit_CapyEventReporter.md)
|
||||
- [uniqueIdentifiers Field](F_CapyKit_CapyEventReporter_uniqueIdentifiers.md)
|
||||
- [Color Enumeration](T_CapyKit_Color.md)
|
||||
- [EncryptedValue<T> Class](T_CapyKit_EncryptedValue_1.md)
|
||||
- [EncryptedValue<T> Constructor](M_CapyKit_EncryptedValue_1__ctor.md)
|
||||
- [EncryptedValue<T> Properties](Properties_T_CapyKit_EncryptedValue_1.md)
|
||||
- [Value Property](P_CapyKit_EncryptedValue_1_Value.md)
|
||||
- [EncryptedValue<T> Methods](Methods_T_CapyKit_EncryptedValue_1.md)
|
||||
- [EventLevel Enumeration](T_CapyKit_EventLevel.md)
|
||||
- [IPasswordAlgorithm Interface](T_CapyKit_IPasswordAlgorithm.md)
|
||||
- [IPasswordAlgorithm Properties](Properties_T_CapyKit_IPasswordAlgorithm.md)
|
||||
|
|
@ -35,9 +40,13 @@
|
|||
- [Pbkdf2Algorithm Property](P_CapyKit_Password_Pbkdf2Algorithm.md)
|
||||
- [Salt Property](P_CapyKit_Password_Salt.md)
|
||||
- [Password Methods](Methods_T_CapyKit_Password.md)
|
||||
- [Equals Method](M_CapyKit_Password_Equals.md)
|
||||
- [ToString Method](M_CapyKit_Password_ToString.md)
|
||||
- [Password Operators](Operators_T_CapyKit_Password.md)
|
||||
- [Equality Operator](M_CapyKit_Password_op_Equality.md)
|
||||
- [Inequality Operator](M_CapyKit_Password_op_Inequality.md)
|
||||
- [Password Fields](Fields_T_CapyKit_Password.md)
|
||||
- [algorithm Field](F_CapyKit_Password_algorithm.md)
|
||||
- [pbkdf2Algorithm Field](F_CapyKit_Password_pbkdf2Algorithm.md)
|
||||
- [Pbkdf2Algorithm Class](T_CapyKit_Pbkdf2Algorithm.md)
|
||||
- [Pbkdf2Algorithm Constructor](M_CapyKit_Pbkdf2Algorithm__ctor.md)
|
||||
- [Pbkdf2Algorithm Properties](Properties_T_CapyKit_Pbkdf2Algorithm.md)
|
||||
|
|
@ -97,6 +106,14 @@
|
|||
- [EnumerationDescriptionAttribute Constructor](M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md)
|
||||
- [EnumerationDescriptionAttribute Properties](Properties_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md)
|
||||
- [EnumerationDescriptionAttribute Methods](Methods_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md)
|
||||
- [ValueFormatAttribute Class](T_CapyKit_Attributes_ValueFormatAttribute.md)
|
||||
- [ValueFormatAttribute Constructor](Overload_CapyKit_Attributes_ValueFormatAttribute__ctor.md)
|
||||
- [ValueFormatAttribute Constructor](M_CapyKit_Attributes_ValueFormatAttribute__ctor.md)
|
||||
- [ValueFormatAttribute(String) Constructor](M_CapyKit_Attributes_ValueFormatAttribute__ctor_1.md)
|
||||
- [ValueFormatAttribute Properties](Properties_T_CapyKit_Attributes_ValueFormatAttribute.md)
|
||||
- [Format Property](P_CapyKit_Attributes_ValueFormatAttribute_Format.md)
|
||||
- [ValueFormatAttribute Methods](Methods_T_CapyKit_Attributes_ValueFormatAttribute.md)
|
||||
- [GetFormatParameterizedString Method](M_CapyKit_Attributes_ValueFormatAttribute_GetFormatParameterizedString.md)
|
||||
- [CapyKit.Enumerations Namespace](N_CapyKit_Enumerations.md)
|
||||
- [MeasurementSystem Enumeration](T_CapyKit_Enumerations_MeasurementSystem.md)
|
||||
- [CapyKit.Extensions Namespace](N_CapyKit_Extensions.md)
|
||||
|
|
@ -153,6 +170,17 @@
|
|||
- [Decompress<T>(Byte[]) Method](M_CapyKit_Helpers_CompressionHelper_Decompress__1.md)
|
||||
- [Decompress<T>(String) Method](M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md)
|
||||
- [DecompressToString Method](M_CapyKit_Helpers_CompressionHelper_DecompressToString.md)
|
||||
- [EncryptionHelper Class](T_CapyKit_Helpers_EncryptionHelper.md)
|
||||
- [EncryptionHelper Constructor](M_CapyKit_Helpers_EncryptionHelper__ctor.md)
|
||||
- [EncryptionHelper Methods](Methods_T_CapyKit_Helpers_EncryptionHelper.md)
|
||||
- [EncryptionHelper Fields](Fields_T_CapyKit_Helpers_EncryptionHelper.md)
|
||||
- [encryptionKey Field](F_CapyKit_Helpers_EncryptionHelper_encryptionKey.md)
|
||||
- [IEncryptionAlgorithm Interface](T_CapyKit_Helpers_IEncryptionAlgorithm.md)
|
||||
- [IEncryptionAlgorithm Properties](Properties_T_CapyKit_Helpers_IEncryptionAlgorithm.md)
|
||||
- [AlgorithmName Property](P_CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName.md)
|
||||
- [IEncryptionAlgorithm Methods](Methods_T_CapyKit_Helpers_IEncryptionAlgorithm.md)
|
||||
- [Decrypt<T> Method](M_CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1.md)
|
||||
- [Encrypt<T> Method](M_CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1.md)
|
||||
- [LanguageHelper Class](T_CapyKit_Helpers_LanguageHelper.md)
|
||||
- [LanguageHelper Constructor](M_CapyKit_Helpers_LanguageHelper__ctor.md)
|
||||
- [LanguageHelper Methods](Methods_T_CapyKit_Helpers_LanguageHelper.md)
|
||||
|
|
@ -160,23 +188,27 @@
|
|||
- [SecurityHelper Class](T_CapyKit_Helpers_SecurityHelper.md)
|
||||
- [SecurityHelper Constructor](M_CapyKit_Helpers_SecurityHelper__ctor.md)
|
||||
- [SecurityHelper Methods](Methods_T_CapyKit_Helpers_SecurityHelper.md)
|
||||
- [CompareHashedPassword Method](M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md)
|
||||
- [CompareHashedPassword Method](Overload_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md)
|
||||
- [CompareHashedPassword<T>(Password, String, Byte[], Object[]) Method](M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword__1.md)
|
||||
- [CompareHashedPassword(Password, String, Byte[], IPasswordAlgorithm, Object[]) Method](M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md)
|
||||
- [CompareSessionID Method](M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md)
|
||||
- [CompareStrings Method](M_CapyKit_Helpers_SecurityHelper_CompareStrings.md)
|
||||
- [GetPassword Method](Overload_CapyKit_Helpers_SecurityHelper_GetPassword.md)
|
||||
- [GetPassword<T>(String, Object[]) Method](M_CapyKit_Helpers_SecurityHelper_GetPassword__1_1.md)
|
||||
- [GetPassword<T>(String, Byte[], Object[]) Method](M_CapyKit_Helpers_SecurityHelper_GetPassword__1.md)
|
||||
- [GetRandomBytes Method](M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md)
|
||||
- [GetRandomPassword Method](M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md)
|
||||
- [GetRandomString Method](Overload_CapyKit_Helpers_SecurityHelper_GetRandomString.md)
|
||||
- [GetRandomString(Int32) Method](M_CapyKit_Helpers_SecurityHelper_GetRandomString.md)
|
||||
- [GetRandomString(Int32, ValidCharacterCollection[]) Method](M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md)
|
||||
- [GetValidCharacterComposition Method](M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md)
|
||||
- [HashPassword Method](M_CapyKit_Helpers_SecurityHelper_HashPassword.md)
|
||||
- [Pbkdf2 Method](Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2.md)
|
||||
- [Pbkdf2(String) Method](M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md)
|
||||
- [Pbkdf2(String, Byte[]) Method](M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md)
|
||||
- [SecurityHelper Fields](Fields_T_CapyKit_Helpers_SecurityHelper.md)
|
||||
- [LOWER_CASE_CHARACTERS Field](F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md)
|
||||
- [NUMBER_CHARACTERS Field](F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md)
|
||||
- [saltSize Field](F_CapyKit_Helpers_SecurityHelper_saltSize.md)
|
||||
- [SALT_SIZE Field](F_CapyKit_Helpers_SecurityHelper_SALT_SIZE.md)
|
||||
- [SPECIAL_CHARACTERS Field](F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md)
|
||||
- [UPPER_CASE_CHARACTERS Field](F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md)
|
||||
- [SerializationHelper Class](T_CapyKit_Helpers_SerializationHelper.md)
|
||||
|
|
|
|||
Loading…
Reference in a new issue