diff --git a/CapyKit/Helpers/SecurityHelper.cs b/CapyKit/Helpers/SecurityHelper.cs index 5e10b97..0ecfc64 100644 --- a/CapyKit/Helpers/SecurityHelper.cs +++ b/CapyKit/Helpers/SecurityHelper.cs @@ -1,6 +1,9 @@ -using System; +using CapyKit.Attributes; +using CapyKit.Extensions; +using System; using System.Collections.Generic; using System.Linq; +using System.Reflection.Metadata.Ecma335; using System.Security.Cryptography; using System.Text; using System.Threading.Tasks; @@ -12,23 +15,20 @@ namespace CapyKit.Helpers { #region Members - private int keySize = 32; - private int saltSize = 32; - - /// The salt used when creating a hash using the SHA256 algorithm. - private const string SALT = "D4260471-5DBA-4732-B960-6E2E438F8872"; + /// Default size of the generated salt. + private const int saltSize = 32; /// A string of all the lower case characters. - private const string LOWER_CASE_CHARACTERS = "abcdefghijklmnopqrstuvwxyz"; + internal const string LOWER_CASE_CHARACTERS = "abcdefghijklmnopqrstuvwxyz"; /// A string of all the upper case characters. - private const string UPPER_CASE_CHARACTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"; + internal const string UPPER_CASE_CHARACTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"; /// A string of all the numeric characters. - private const string NUMBER_CHARACTERS = "0123456789"; + internal const string NUMBER_CHARACTERS = "0123456789"; /// A string of the most common non-alphanumeric characters. - private const string SPECIAL_CHARACTERS = "!@#$%&?+-_"; + internal const string SPECIAL_CHARACTERS = "!@#$%&?+-_"; #endregion Members @@ -57,51 +57,56 @@ namespace CapyKit.Helpers } /// - /// Produces a SHA256 hash from a given - /// . + /// Generates a new object using the PBKDF2 algorithm with the provided + /// and . /// - /// The value. + /// + /// This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate + /// a new password hash. The algorithm iteratively applies a pseudorandom function to the + /// password and salt, which increases the security of the resulting hash. + /// + /// The clear text password to be hashed. + /// + /// A random value used to add an additional layer of security to the generated hash. + /// /// - /// A byte array equal to the SHA256 hash of or an empty array if it - /// fails. + /// A new object containing the hashed password and salt. /// - public static byte[] SHA256Hash(string value) + public static Password Pbkdf2(string password, byte[] salt) { - try - { - using (var hash = new SHA256Managed()) - { - var bytes = Encoding.Unicode.GetBytes(value + SALT); - var encrypted = hash.ComputeHash(bytes); - return encrypted; - } - } - catch (Exception ex) - { - CapyEventReporter.EmitEvent(EventLevel.Error, "Could not hash the given value {0}.", args: new[] { value }); - } + var pwd = new Password(password, salt, Password.Pbkdf2Algorithm); - return new byte[0]; + return pwd; } - public static string Pbkdf2(string password, out byte[] salt) + /// + /// Generates a new object using the PBKDF2 algorithm with the provided . + /// This overload of the method generates a random salt value for added security. + /// + /// + /// This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate + /// a new password hash. The algorithm iteratively applies a pseudorandom function to the + /// password and salt, which increases the security of the resulting hash. In this overload, + /// a random salt value is generated using method. + /// + /// The clear text password to be hashed. + /// + /// A new object containing the hashed password and a randomly generated salt. + /// + public static Password Pbkdf2(string password) { - throw new NotImplementedException(); + var salt = SecurityHelper.GetRandomBytes(saltSize); + var pwd = new Password(password, salt, Password.Pbkdf2Algorithm); + + return pwd; } /// Gets a cryptographically strong random password. /// The length of the password to generate. /// The password. - public static string GetRandomPassword(int length) + public static string GetRandomPassword(int length, params ValidCharacterCollection[] validCharacters) { - return GetRandomString(length); - } - - /// Gets a calendar key that is 32 characters long. - /// The calendar key. - public static string GetCalendarKey() - { - return GetRandomString(32); + return GetRandomString(length, validCharacters); } /// Compares two session identifiers. @@ -119,25 +124,93 @@ namespace CapyKit.Helpers return CompareStrings(first.Trim(), second.Trim()); } + /// + /// A convenience method to generate a random string of the specified length using all character sets. + /// + /// The desired length of the generated random string. + /// + /// + public static string GetRandomString(int length) + { + return GetRandomString(length, + ValidCharacterCollection.Lowercase, + ValidCharacterCollection.Uppercase, + ValidCharacterCollection.Numbers, + ValidCharacterCollection.Special); + } + /// Gets a cryptographically strong random string using the character values found in . /// The length of the string to create. /// The random string. - private static string GetRandomString(int length) + public static string GetRandomString(int length, params ValidCharacterCollection[] validChars) { - throw new NotImplementedException(); - //var buffer = new StringBuilder(); - //while (buffer.Length < length) - //{ - // var oneByte = new byte[1]; - // RandomNumberGenerator.GetBytes(oneByte); - // var character = (char)oneByte[0]; - // if (VALID_CHARACTERS.Contains(character)) - // { - // buffer.Append(character); - // } - //} + var buffer = new StringBuilder(length); + var randomNumberBuffer = new byte[length * 3]; // Overprovision the buffer so we can discard a small percentage. + var validCharacters = GetValidCharacterComposition(validChars); + var validByteUpperLimit = (256 / validCharacters.Length) * validCharacters.Length - 1; // Maintains equal distribution of valid characters. - //return buffer.ToString(); + using (var rng = RandomNumberGenerator.Create()) + { + while (buffer.Length < length) + { + rng.GetBytes(randomNumberBuffer); + foreach (byte b in randomNumberBuffer) + { + if (b <= validByteUpperLimit) + { + int index = b % validCharacters.Length; + buffer.Append(validCharacters[index]); + if (buffer.Length == length) + { + break; + } + } + } + } + } + + return buffer.ToString(); + } + + /// Generates a new byte array of the specified length with random values. + /// The desired length of the generated byte array. + /// A new byte array of the specified length filled with random values. + private static byte[] GetRandomBytes(int length) + { + var buffer = new byte[length]; + using (var rng = RandomNumberGenerator.Create()) + { + rng.GetBytes(buffer); + } + + return buffer; + } + + private static string GetValidCharacterComposition(params ValidCharacterCollection[] validCharacters) + { + var composition = new StringBuilder(); + foreach (var c in validCharacters) + { + switch (c) + { + case ValidCharacterCollection.Lowercase: + composition.Append(LOWER_CASE_CHARACTERS); + break; + case ValidCharacterCollection.Uppercase: + composition.Append(LOWER_CASE_CHARACTERS); + break; + case ValidCharacterCollection.Numbers: + composition.Append(LOWER_CASE_CHARACTERS); + break; + case ValidCharacterCollection.Special: + composition.Append(LOWER_CASE_CHARACTERS); + break; + default: + break; + } + } + + return composition.ToString(); } /// Compare two strings as case sensative. @@ -158,4 +231,31 @@ namespace CapyKit.Helpers #endregion Methods } + + /// + /// An enumeration that defines the types of characters that can be included in a random string. + /// + public enum ValidCharacterCollection + { + /// + /// Indicates that lower case characters should be included in the random string. + /// + [EnumerationDescriptionAttribute(SecurityHelper.LOWER_CASE_CHARACTERS)] + Lowercase, + /// + /// Indicates that upper case characters should be included in the random string. + /// + [EnumerationDescriptionAttribute(SecurityHelper.UPPER_CASE_CHARACTERS)] + Uppercase, + /// + /// Indicates that numeric characters should be included in the random string. + /// + [EnumerationDescriptionAttribute(SecurityHelper.NUMBER_CHARACTERS)] + Numbers, + /// + /// Indicates that special characters should be included in the random string. + /// + [EnumerationDescriptionAttribute(SecurityHelper.SPECIAL_CHARACTERS)] + Special, + } } diff --git a/CapyKit/Password.cs b/CapyKit/Password.cs index 57f4836..209b18d 100644 --- a/CapyKit/Password.cs +++ b/CapyKit/Password.cs @@ -16,7 +16,7 @@ namespace CapyKit { #region Members - // + private static Lazy algorithm = new Lazy(() => new Pbkdf2Algorithm()); #endregion @@ -37,6 +37,14 @@ namespace CapyKit /// public IPasswordAlgorithm Algorithm { get; private set; } + public static Pbkdf2Algorithm Pbkdf2Algorithm + { + get + { + return algorithm.Value; + } + } + #endregion /// Constructor. diff --git a/Documentation/Documentation.shfbproj b/Documentation/Documentation.shfbproj index 9dafa14..eb9fe05 100644 --- a/Documentation/Documentation.shfbproj +++ b/Documentation/Documentation.shfbproj @@ -31,7 +31,7 @@ Markdown - Standard + C#, F# Markdown True True diff --git a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md index 0e51d91..7b3e04b 100644 --- a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md +++ b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md @@ -7,21 +7,12 @@ The default number of iterations. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public const int ITERATIONS = 100000 ``` -**VB** -``` VB -Public Const ITERATIONS As Integer = 100000 -``` -**C++** -``` C++ -public: -literal int ITERATIONS = 100000 -``` **F#** ``` F# static val mutable ITERATIONS: int diff --git a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md index bcffc59..f9736a9 100644 --- a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md +++ b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md @@ -7,21 +7,12 @@ ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public const int LENGTH = 32 ``` -**VB** -``` VB -Public Const LENGTH As Integer = 32 -``` -**C++** -``` C++ -public: -literal int LENGTH = 32 -``` **F#** ``` F# static val mutable LENGTH: int diff --git a/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md b/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md index 2e50d70..a3877b7 100644 --- a/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md +++ b/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md @@ -7,7 +7,7 @@ Gets the value of the enumeration represented by this attribute. ## Definition **Namespace:** CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,19 +15,6 @@ protected EnumerationAttribute( T value ) ``` -**VB** -``` VB -Protected Sub New ( - value As T -) -``` -**C++** -``` C++ -protected: -EnumerationAttribute( - T value -) -``` **F#** ``` F# new : diff --git a/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md b/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md index 7bfd760..a6a4cf1 100644 --- a/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md +++ b/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,19 +15,6 @@ public EnumerationDescriptionAttribute( string description ) ``` -**VB** -``` VB -Public Sub New ( - description As String -) -``` -**C++** -``` C++ -public: -EnumerationDescriptionAttribute( - String^ description -) -``` **F#** ``` F# new : diff --git a/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md b/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md index 02d4d93..e959dce 100644 --- a/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md +++ b/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the CapyEventArgs class with the specified event l ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -17,23 +17,6 @@ public CapyEventArgs( string method = null ) ``` -**VB** -``` VB -Public Sub New ( - level As EventLevel, - message As String, - Optional method As String = Nothing -) -``` -**C++** -``` C++ -public: -CapyEventArgs( - EventLevel level, - String^ message, - String^ method = nullptr -) -``` **F#** ``` F# new : diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md b/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md index eba0460..55706d4 100644 --- a/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md @@ -7,7 +7,7 @@ Subscribes the specified event handler to the event with the given subscription ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -17,23 +17,6 @@ public static void Subscribe( string origin = null ) ``` -**VB** -``` VB -Public Shared Sub Subscribe ( - callback As CapyEventHandler, - subscriptionLevel As EventLevel, - Optional origin As String = Nothing -) -``` -**C++** -``` C++ -public: -static void Subscribe( - CapyEventHandler^ callback, - EventLevel subscriptionLevel, - String^ origin = nullptr -) -``` **F#** ``` F# static member Subscribe : diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md b/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md index 8a9e181..2075189 100644 --- a/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md @@ -7,7 +7,7 @@ Unsubscribes the specified event handler from the event with the given origin. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -16,21 +16,6 @@ public static void Unsubscribe( string origin ) ``` -**VB** -``` VB -Public Shared Sub Unsubscribe ( - callback As CapyEventHandler, - origin As String -) -``` -**C++** -``` C++ -public: -static void Unsubscribe( - CapyEventHandler^ callback, - String^ origin -) -``` **F#** ``` F# static member Unsubscribe : diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md index 8d3759c..15bd6e1 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md @@ -7,7 +7,7 @@ An CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,21 +15,6 @@ public static string GetDescription( this Enum enumeration ) ``` -**VB** -``` VB - -Public Shared Function GetDescription ( - enumeration As Enum -) As String -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -static String^ GetDescription( - Enum^ enumeration -) -``` **F#** ``` F# [] diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md index 61097de..f481d4e 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md @@ -7,7 +7,7 @@ An CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,21 +15,6 @@ public static string GetName( this Enum enumeration ) ``` -**VB** -``` VB - -Public Shared Function GetName ( - enumeration As Enum -) As String -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -static String^ GetName( - Enum^ enumeration -) -``` **F#** ``` F# [] diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md index bc6008d..8b94193 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md @@ -7,7 +7,7 @@ An CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,21 +15,6 @@ public static string GetPrettyName( this Enum enumeration ) ``` -**VB** -``` VB - -Public Shared Function GetPrettyName ( - enumeration As Enum -) As String -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -static String^ GetPrettyName( - Enum^ enumeration -) -``` **F#** ``` F# [] diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md index b4c1242..c2e088f 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md @@ -7,7 +7,7 @@ An CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,21 +15,6 @@ public static int GetValue( this Enum enumeration ) ``` -**VB** -``` VB - -Public Shared Function GetValue ( - enumeration As Enum -) As Integer -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -static int GetValue( - Enum^ enumeration -) -``` **F#** ``` F# [] diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md index 477b2fb..6a85563 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md @@ -7,7 +7,7 @@ A *T* extension method that parses a string into an enumeration. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -17,25 +17,6 @@ public static T Parse( ) where T : Enum -``` -**VB** -``` VB - -Public Shared Function Parse(Of T As Enum) ( - enumeration As T, - value As String -) As T -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -generic -where T : Enum -static T Parse( - T enumeration, - String^ value -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md index be67197..8c63acc 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md @@ -7,7 +7,7 @@ A *T* extension method that parses a string into an enumeration. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -18,27 +18,6 @@ public static T Parse( ) where T : Enum -``` -**VB** -``` VB - -Public Shared Function Parse(Of T As Enum) ( - enumeration As T, - value As String, - ignoreCase As Boolean -) As T -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -generic -where T : Enum -static T Parse( - T enumeration, - String^ value, - bool ignoreCase -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md index 481a8c5..c8b1de0 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md @@ -7,7 +7,7 @@ Enumerates distinct items in this collection as defined by the key *property*. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -16,24 +16,6 @@ public static IEnumerable Distinct( Func property ) -``` -**VB** -``` VB - -Public Shared Function Distinct(Of T, U) ( - items As IEnumerable(Of T), - property As Func(Of T, U) -) As IEnumerable(Of T) -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -generic -static IEnumerable^ Distinct( - IEnumerable^ items, - Func^ property -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md index d760ff4..c88adad 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md @@ -7,7 +7,7 @@ Filters out items matching a *predicate* from the collection. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -16,24 +16,6 @@ public static IEnumerable Filter( Func predicate ) -``` -**VB** -``` VB - -Public Shared Function Filter(Of T) ( - source As IEnumerable(Of T), - predicate As Func(Of T, Boolean) -) As IEnumerable(Of T) -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -generic -static IEnumerable^ Filter( - IEnumerable^ source, - Func^ predicate -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md index 9332331..58b053f 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md @@ -7,7 +7,7 @@ Filters out items matching a *predicate* from the collection. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -16,24 +16,6 @@ public static IQueryable Filter( Expression> predicate ) -``` -**VB** -``` VB - -Public Shared Function Filter(Of T) ( - source As IQueryable(Of T), - predicate As Expression(Of Func(Of T, Boolean)) -) As IQueryable(Of T) -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -generic -static IQueryable^ Filter( - IQueryable^ source, - Expression^>^ predicate -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md index acf2426..11d2cc9 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md @@ -7,7 +7,7 @@ An IEnumable<T> extension method that left outer join. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -20,32 +20,6 @@ public static IEnumerable LeftOuterJoin( Func defaultGenerator = null ) -``` -**VB** -``` VB - -Public Shared Function LeftOuterJoin(Of T, U, TKey, R) ( - source As IEnumerable(Of T), - inner As IEnumerable(Of U), - outerSelector As Func(Of T, TKey), - innerSelector As Func(Of U, TKey), - resultSelector As Func(Of T, IEnumerable(Of U), R), - Optional defaultGenerator As Func(Of T, U) = Nothing -) As IEnumerable(Of R) -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -generic -static IEnumerable^ LeftOuterJoin( - IEnumerable^ source, - IEnumerable^ inner, - Func^ outerSelector, - Func^ innerSelector, - Func^, R>^ resultSelector, - Func^ defaultGenerator = nullptr -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md index a1c3613..49443e8 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md @@ -7,7 +7,7 @@ An IQueryable<T> extension method that left outer join. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -20,32 +20,6 @@ public static IQueryable LeftOuterJoin( Func defaultGenerator = null ) -``` -**VB** -``` VB - -Public Shared Function LeftOuterJoin(Of T, U, TKey, R) ( - source As IQueryable(Of T), - inner As IQueryable(Of U), - outerSelector As Expression(Of Func(Of T, TKey)), - innerSelector As Expression(Of Func(Of U, TKey)), - resultSelector As Func(Of T, IEnumerable(Of U), R), - Optional defaultGenerator As Func(Of T, U) = Nothing -) As IQueryable(Of R) -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -generic -static IQueryable^ LeftOuterJoin( - IQueryable^ source, - IQueryable^ inner, - Expression^>^ outerSelector, - Expression^>^ innerSelector, - Func^, R>^ resultSelector, - Func^ defaultGenerator = nullptr -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md index f23ff20..1f2c65f 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md @@ -7,7 +7,7 @@ The number of pages of *pageSize* size in the given collection. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -16,24 +16,6 @@ public static int PageCount( int pageSize ) -``` -**VB** -``` VB - -Public Shared Function PageCount(Of T) ( - source As IEnumerable(Of T), - pageSize As Integer -) As Integer -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -generic -static int PageCount( - IEnumerable^ source, - int pageSize -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md index 798fe1e..0c196b9 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md @@ -7,7 +7,7 @@ The number of pages of *pageSize* size in the given collection. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -16,24 +16,6 @@ public static int PageCount( int pageSize ) -``` -**VB** -``` VB - -Public Shared Function PageCount(Of T) ( - source As IQueryable(Of T), - pageSize As Integer -) As Integer -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -generic -static int PageCount( - IQueryable^ source, - int pageSize -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md index c62cb5b..82d3dc6 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md @@ -7,7 +7,7 @@ Get a page of items from a collection, skipping *pageNumber* pages of *pageSize* ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -17,26 +17,6 @@ public static IEnumerable Page( int pageSize ) -``` -**VB** -``` VB - -Public Shared Function Page(Of T) ( - source As IEnumerable(Of T), - pageNumber As Integer, - pageSize As Integer -) As IEnumerable(Of T) -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -generic -static IEnumerable^ Page( - IEnumerable^ source, - int pageNumber, - int pageSize -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md index a93ed86..76affe0 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md @@ -7,7 +7,7 @@ Get a page of items from a collection, skipping *pageNumber* pages of *pageSize* ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -17,26 +17,6 @@ public static IQueryable Page( int pageSize ) -``` -**VB** -``` VB - -Public Shared Function Page(Of T) ( - source As IQueryable(Of T), - pageNumber As Integer, - pageSize As Integer -) As IQueryable(Of T) -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -generic -static IQueryable^ Page( - IQueryable^ source, - int pageNumber, - int pageSize -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md index 66c640c..c1c4e60 100644 --- a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md +++ b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md @@ -7,7 +7,7 @@ Replaces a null or empty string with a specified replacement string. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -16,23 +16,6 @@ public static string IfNullOrEmpty( string replacement ) ``` -**VB** -``` VB - -Public Shared Function IfNullOrEmpty ( - value As String, - replacement As String -) As String -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -static String^ IfNullOrEmpty( - String^ value, - String^ replacement -) -``` **F#** ``` F# [] diff --git a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md index 7bd277c..f0db1c0 100644 --- a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md +++ b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md @@ -7,7 +7,7 @@ Replaces a null or whitespace string with a specified replacement string. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -16,23 +16,6 @@ public static string IfNullOrWhiteSpace( string replacement ) ``` -**VB** -``` VB - -Public Shared Function IfNullOrWhiteSpace ( - value As String, - replacement As String -) As String -``` -**C++** -``` C++ -public: -[ExtensionAttribute] -static String^ IfNullOrWhiteSpace( - String^ value, - String^ replacement -) -``` **F#** ``` F# [] diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md index 7a40b45..7817e0f 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md @@ -7,7 +7,7 @@ Compresses a given object using the `gzip` algorithm. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,19 +15,6 @@ public static byte[] Compress( Object obj ) ``` -**VB** -``` VB -Public Shared Function Compress ( - obj As Object -) As Byte() -``` -**C++** -``` C++ -public: -static array^ Compress( - Object^ obj -) -``` **F#** ``` F# static member Compress : diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md index fe58803..0db3a8f 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md @@ -7,7 +7,7 @@ Compresses a given object to a string using `base64` encoding of `gzip` format. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,19 +15,6 @@ public static string CompressToString( Object obj ) ``` -**VB** -``` VB -Public Shared Function CompressToString ( - obj As Object -) As String -``` -**C++** -``` C++ -public: -static String^ CompressToString( - Object^ obj -) -``` **F#** ``` F# static member CompressToString : diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md index 84c1205..4ff8102 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md @@ -7,7 +7,7 @@ Decompresses the given `base64` string in `gzip` format. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,19 +15,6 @@ public static string DecompressToString( string compressed ) ``` -**VB** -``` VB -Public Shared Function DecompressToString ( - compressed As String -) As String -``` -**C++** -``` C++ -public: -static String^ DecompressToString( - String^ compressed -) -``` **F#** ``` F# static member DecompressToString : diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md index 3efbb5f..b0121cb 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md @@ -7,7 +7,7 @@ Decompresses a given compressed `gzip` byte stream. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,20 +15,6 @@ public static T Decompress( byte[] byteStream ) -``` -**VB** -``` VB -Public Shared Function Decompress(Of T) ( - byteStream As Byte() -) As T -``` -**C++** -``` C++ -public: -generic -static T Decompress( - array^ byteStream -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md index dd3be02..024109b 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md @@ -7,7 +7,7 @@ Decompresses a given `base64` encoded string of `gzip` format. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,20 +15,6 @@ public static T Decompress( string encodedString ) -``` -**VB** -``` VB -Public Shared Function Decompress(Of T) ( - encodedString As String -) As T -``` -**C++** -``` C++ -public: -generic -static T Decompress( - String^ encodedString -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md index 3df4c56..82381a0 100644 --- a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md +++ b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md @@ -7,7 +7,7 @@ Converts camel case text to human readable text. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,19 +15,6 @@ public static string CamelCaseToHumanReadable( string value ) ``` -**VB** -``` VB -Public Shared Function CamelCaseToHumanReadable ( - value As String -) As String -``` -**C++** -``` C++ -public: -static String^ CamelCaseToHumanReadable( - String^ value -) -``` **F#** ``` F# static member CamelCaseToHumanReadable : diff --git a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md index b804f83..11daf0c 100644 --- a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md +++ b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md @@ -7,21 +7,12 @@ Initializes a new instance of the Lan ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public LanguageHelper() ``` -**VB** -``` VB -Public Sub New -``` -**C++** -``` C++ -public: -LanguageHelper() -``` **F#** ``` F# new : unit -> LanguageHelper diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md index 36c352b..1b3f8a3 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md @@ -7,7 +7,7 @@ Compares an unencrypted *providedPassword* with a stored, encrypted *existingPas ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -16,21 +16,6 @@ public static bool CompareHashedPassword( string existingPassword ) ``` -**VB** -``` VB -Public Shared Function CompareHashedPassword ( - providedPassword As String, - existingPassword As String -) As Boolean -``` -**C++** -``` C++ -public: -static bool CompareHashedPassword( - String^ providedPassword, - String^ existingPassword -) -``` **F#** ``` F# static member CompareHashedPassword : diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md index 480f1eb..80bc1a9 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md @@ -7,7 +7,7 @@ Compares two session identifiers. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -16,21 +16,6 @@ public static bool CompareSessionID( string second ) ``` -**VB** -``` VB -Public Shared Function CompareSessionID ( - first As String, - second As String -) As Boolean -``` -**C++** -``` C++ -public: -static bool CompareSessionID( - String^ first, - String^ second -) -``` **F#** ``` F# static member CompareSessionID : diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetCalendarKey.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetCalendarKey.md deleted file mode 100644 index a2bc5d5..0000000 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetCalendarKey.md +++ /dev/null @@ -1,41 +0,0 @@ -# GetCalendarKey Method - - -Gets a calendar key that is `32` characters long. - - - -## Definition -**Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d - -**C#** -``` C# -public static string GetCalendarKey() -``` -**VB** -``` VB -Public Shared Function GetCalendarKey As String -``` -**C++** -``` C++ -public: -static String^ GetCalendarKey() -``` -**F#** -``` F# -static member GetCalendarKey : unit -> string -``` - - - -#### Return Value -String -The calendar key. - -## See Also - - -#### Reference -SecurityHelper Class -CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md index f7f1922..897a013 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md @@ -7,37 +7,26 @@ Gets a cryptographically strong random password. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public static string GetRandomPassword( - int length -) -``` -**VB** -``` VB -Public Shared Function GetRandomPassword ( - length As Integer -) As String -``` -**C++** -``` C++ -public: -static String^ GetRandomPassword( - int length + int length, + params ValidCharacterCollection[] validCharacters ) ``` **F#** ``` F# static member GetRandomPassword : - length : int -> string + length : int * + validCharacters : ValidCharacterCollection[] -> string ``` #### Parameters -
  Int32
The length of the password to generate.
+
  Int32
The length of the password to generate.
  ValidCharacterCollection[]
\[Missing <param name="validCharacters"/> documentation for "M:CapyKit.Helpers.SecurityHelper.GetRandomPassword(System.Int32,CapyKit.Helpers.ValidCharacterCollection[])"\]
#### Return Value String diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md new file mode 100644 index 0000000..3ce2f29 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md @@ -0,0 +1,41 @@ +# GetRandomString(Int32) Method + + +A convenience method to generate a random string of the specified length using all character sets. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +public static string GetRandomString( + int length +) +``` +**F#** +``` F# +static member GetRandomString : + length : int -> string +``` + + + +#### Parameters +
  Int32
The desired length of the generated random string.
+ +#### Return Value +String +\[Missing <returns> documentation for "M:CapyKit.Helpers.SecurityHelper.GetRandomString(System.Int32)"\] + +## See Also + + +#### Reference +SecurityHelper Class +GetRandomString Overload +CapyKit.Helpers Namespace +ValidCharacterCollection +GetRandomString(Int32, ValidCharacterCollection[]) diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md new file mode 100644 index 0000000..3f55610 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md @@ -0,0 +1,41 @@ +# GetRandomString(Int32, ValidCharacterCollection[]) Method + + +Gets a cryptographically strong random string using the character values found in [!:VALID_CHARACTERS]. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +public static string GetRandomString( + int length, + params ValidCharacterCollection[] validChars +) +``` +**F#** +``` F# +static member GetRandomString : + length : int * + validChars : ValidCharacterCollection[] -> string +``` + + + +#### Parameters +
  Int32
The length of the string to create.
  ValidCharacterCollection[]
\[Missing <param name="validChars"/> documentation for "M:CapyKit.Helpers.SecurityHelper.GetRandomString(System.Int32,CapyKit.Helpers.ValidCharacterCollection[])"\]
+ +#### Return Value +String +The random string. + +## See Also + + +#### Reference +SecurityHelper Class +GetRandomString Overload +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md index 7f9078e..446c88b 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md @@ -7,7 +7,7 @@ Hashes an unencrypted password. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,19 +15,6 @@ public static string HashPassword( string password ) ``` -**VB** -``` VB -Public Shared Function HashPassword ( - password As String -) As String -``` -**C++** -``` C++ -public: -static String^ HashPassword( - String^ password -) -``` **F#** ``` F# static member HashPassword : diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md index 450e58d..6872fd7 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md @@ -1,55 +1,42 @@ -# Pbkdf2 Method +# Pbkdf2(String) Method -\[Missing <summary> documentation for "M:CapyKit.Helpers.SecurityHelper.Pbkdf2(System.String,System.Byte[]@)"\] +Generates a new Password object using the PBKDF2 algorithm with the provided *password*. This overload of the method generates a random salt value for added security. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# -public static string Pbkdf2( - string password, - out byte[] salt -) -``` -**VB** -``` VB -Public Shared Function Pbkdf2 ( - password As String, - ByRef salt As Byte() -) As String -``` -**C++** -``` C++ -public: -static String^ Pbkdf2( - String^ password, - [OutAttribute] array^% salt +public static Password Pbkdf2( + string password ) ``` **F#** ``` F# static member Pbkdf2 : - password : string * - salt : byte[] byref -> string + password : string -> Password ``` #### Parameters -
  String
\[Missing <param name="password"/> documentation for "M:CapyKit.Helpers.SecurityHelper.Pbkdf2(System.String,System.Byte[]@)"\]
  Byte[]
\[Missing <param name="salt"/> documentation for "M:CapyKit.Helpers.SecurityHelper.Pbkdf2(System.String,System.Byte[]@)"\]
+
  String
The clear text password to be hashed.
#### Return Value -String -\[Missing <returns> documentation for "M:CapyKit.Helpers.SecurityHelper.Pbkdf2(System.String,System.Byte[]@)"\] +Password +A new Password object containing the hashed password and a randomly generated salt. + +## Remarks +This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate a new password hash. The algorithm iteratively applies a pseudorandom function to the password and salt, which increases the security of the resulting hash. In this overload, a random salt value is generated using GetRandomBytes(Int32) method. ## See Also #### Reference SecurityHelper Class +Pbkdf2 Overload CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md new file mode 100644 index 0000000..067fb28 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md @@ -0,0 +1,44 @@ +# Pbkdf2(String, Byte[]) Method + + +Generates a new Password object using the PBKDF2 algorithm with the provided *password* and *salt*. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +public static Password Pbkdf2( + string password, + byte[] salt +) +``` +**F#** +``` F# +static member Pbkdf2 : + password : string * + salt : byte[] -> Password +``` + + + +#### Parameters +
  String
The clear text password to be hashed.
  Byte[]
A random value used to add an additional layer of security to the generated hash.
+ +#### Return Value +Password +A new Password object containing the hashed password and salt. + +## Remarks +This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate a new password hash. The algorithm iteratively applies a pseudorandom function to the password and salt, which increases the security of the resulting hash. + +## See Also + + +#### Reference +SecurityHelper Class +Pbkdf2 Overload +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_SHA256Hash.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_SHA256Hash.md deleted file mode 100644 index a870023..0000000 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_SHA256Hash.md +++ /dev/null @@ -1,51 +0,0 @@ -# SHA256Hash Method - - -Produces a SHA256 hash from a given *value*. - - - -## Definition -**Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d - -**C#** -``` C# -public static byte[] SHA256Hash( - string value -) -``` -**VB** -``` VB -Public Shared Function SHA256Hash ( - value As String -) As Byte() -``` -**C++** -``` C++ -public: -static array^ SHA256Hash( - String^ value -) -``` -**F#** -``` F# -static member SHA256Hash : - value : string -> byte[] -``` - - - -#### Parameters -
  String
The value.
- -#### Return Value -Byte[] -A byte array equal to the SHA256 hash of *value* or an empty array if it fails. - -## See Also - - -#### Reference -SecurityHelper Class -CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md index 81655a4..bf5976e 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md @@ -7,21 +7,12 @@ Initializes a new instance of the Sec ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public SecurityHelper() ``` -**VB** -``` VB -Public Sub New -``` -**C++** -``` C++ -public: -SecurityHelper() -``` **F#** ``` F# new : unit -> SecurityHelper diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md index 8ad9c70..42059e2 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md @@ -7,7 +7,7 @@ Deserializes an object to a given *T* type. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,20 +15,6 @@ public static T Deserialize( byte[] bytes ) -``` -**VB** -``` VB -Public Shared Function Deserialize(Of T) ( - bytes As Byte() -) As T -``` -**C++** -``` C++ -public: -generic -static T Deserialize( - array^ bytes -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md index 0edaa72..a712fb8 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md @@ -7,7 +7,7 @@ Deserializes an object to a given *T* type. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,20 +15,6 @@ public static T Deserialize( Stream stream ) -``` -**VB** -``` VB -Public Shared Function Deserialize(Of T) ( - stream As Stream -) As T -``` -**C++** -``` C++ -public: -generic -static T Deserialize( - Stream^ stream -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md index b680351..3b98ade 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md @@ -7,7 +7,7 @@ Deserializes a `JSON` encoded string to the given *T*. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,20 +15,6 @@ public static T Deserialize( string str ) -``` -**VB** -``` VB -Public Shared Function Deserialize(Of T) ( - str As String -) As T -``` -**C++** -``` C++ -public: -generic -static T Deserialize( - String^ str -) ``` **F#** ``` F# diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md index c6d8910..7895081 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md @@ -7,7 +7,7 @@ Serializes an object to a byte array. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,19 +15,6 @@ public static byte[] SerializeToBytes( Object obj ) ``` -**VB** -``` VB -Public Shared Function SerializeToBytes ( - obj As Object -) As Byte() -``` -**C++** -``` C++ -public: -static array^ SerializeToBytes( - Object^ obj -) -``` **F#** ``` F# static member SerializeToBytes : diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md index 8c48be8..6d607c7 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md @@ -7,7 +7,7 @@ Serializes an object to a `JSON` encoded string. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,19 +15,6 @@ public static string SerializeToString( Object obj ) ``` -**VB** -``` VB -Public Shared Function SerializeToString ( - obj As Object -) As String -``` -**C++** -``` C++ -public: -static String^ SerializeToString( - Object^ obj -) -``` **F#** ``` F# static member SerializeToString : diff --git a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md index 68a85fd..c057997 100644 --- a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md +++ b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md @@ -7,7 +7,7 @@ Compares the given plaintext password with an encrypted value using PBKDF2 algor ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -17,22 +17,6 @@ bool Compare( params Object[] args ) ``` -**VB** -``` VB -Function Compare ( - password As String, - encryptedValue As Byte(), - ParamArray args As Object() -) As Boolean -``` -**C++** -``` C++ -bool Compare( - String^ password, - array^ encryptedValue, - ... array^ args -) -``` **F#** ``` F# abstract Compare : diff --git a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md index 50df59b..7d76d11 100644 --- a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md +++ b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md @@ -7,7 +7,7 @@ Encrypts the given password using a defined algorithm. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -16,20 +16,6 @@ byte[] Encrypt( params Object[] args ) ``` -**VB** -``` VB -Function Encrypt ( - password As String, - ParamArray args As Object() -) As Byte() -``` -**C++** -``` C++ -array^ Encrypt( - String^ password, - ... array^ args -) -``` **F#** ``` F# abstract Encrypt : diff --git a/Documentation/Help/M_CapyKit_Password_ToString.md b/Documentation/Help/M_CapyKit_Password_ToString.md index 4d9727b..83d72b7 100644 --- a/Documentation/Help/M_CapyKit_Password_ToString.md +++ b/Documentation/Help/M_CapyKit_Password_ToString.md @@ -7,21 +7,12 @@ Returns a string that represents the current object. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public override string ToString() ``` -**VB** -``` VB -Public Overrides Function ToString As String -``` -**C++** -``` C++ -public: -virtual String^ ToString() override -``` **F#** ``` F# abstract ToString : unit -> string diff --git a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md index 2102cf4..d6b2451 100644 --- a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md +++ b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md @@ -7,7 +7,7 @@ Encrypts the given password using a PBKDF2 algorithm. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -16,21 +16,6 @@ public byte[] Encrypt( params Object[] args ) ``` -**VB** -``` VB -Public Function Encrypt ( - password As String, - ParamArray args As Object() -) As Byte() -``` -**C++** -``` C++ -public: -virtual array^ Encrypt( - String^ password, - ... array^ args -) sealed -``` **F#** ``` F# abstract Encrypt : diff --git a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md index 8b35a39..a577a5a 100644 --- a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md +++ b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md @@ -7,21 +7,12 @@ Initializes a new instance of the Pbkdf2Algo ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public Pbkdf2Algorithm() ``` -**VB** -``` VB -Public Sub New -``` -**C++** -``` C++ -public: -Pbkdf2Algorithm() -``` **F#** ``` F# new : unit -> Pbkdf2Algorithm diff --git a/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md b/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md index 61fcee1..a7739bb 100644 --- a/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md +++ b/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md @@ -7,21 +7,12 @@ Releases the lock on the item. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public void ReleaseLock() ``` -**VB** -``` VB -Public Sub ReleaseLock -``` -**C++** -``` C++ -public: -void ReleaseLock() -``` **F#** ``` F# member ReleaseLock : unit -> unit diff --git a/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md b/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md index 0d019dc..b7d3ca9 100644 --- a/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md +++ b/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md @@ -7,21 +7,12 @@ Sets the lock on the item indicating that it is in use. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public bool SetLock() ``` -**VB** -``` VB -Public Function SetLock As Boolean -``` -**C++** -``` C++ -public: -bool SetLock() -``` **F#** ``` F# member SetLock : unit -> bool diff --git a/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md b/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md index 37b64f4..cbe5251 100644 --- a/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md +++ b/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md @@ -7,21 +7,12 @@ Returns a string that represents the current object and its lock state. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public override string ToString() ``` -**VB** -``` VB -Public Overrides Function ToString As String -``` -**C++** -``` C++ -public: -virtual String^ ToString() override -``` **F#** ``` F# abstract ToString : unit -> string diff --git a/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md b/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md index 3546e6a..21c8486 100644 --- a/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md +++ b/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md @@ -7,21 +7,12 @@ Gets the first available item from the pool and sets its lock. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public PoolItem GetAvailableItem() ``` -**VB** -``` VB -Public Function GetAvailableItem As PoolItem(Of T) -``` -**C++** -``` C++ -public: -PoolItem^ GetAvailableItem() -``` **F#** ``` F# member GetAvailableItem : unit -> PoolItem<'T> diff --git a/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md b/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md index 89a25e6..5fd7d39 100644 --- a/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md +++ b/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md @@ -7,7 +7,7 @@ Releases the lock on the specified item and returns it to the pool. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,19 +15,6 @@ public void ReleaseItem( PoolItem item ) ``` -**VB** -``` VB -Public Sub ReleaseItem ( - item As PoolItem(Of T) -) -``` -**C++** -``` C++ -public: -void ReleaseItem( - PoolItem^ item -) -``` **F#** ``` F# member ReleaseItem : diff --git a/Documentation/Help/M_CapyKit_Pool_1__ctor.md b/Documentation/Help/M_CapyKit_Pool_1__ctor.md index 45c3cde..4fa6cdd 100644 --- a/Documentation/Help/M_CapyKit_Pool_1__ctor.md +++ b/Documentation/Help/M_CapyKit_Pool_1__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the Pool(T) class w ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,19 +15,6 @@ public Pool( IEnumerable collection ) ``` -**VB** -``` VB -Public Sub New ( - collection As IEnumerable(Of T) -) -``` -**C++** -``` C++ -public: -Pool( - IEnumerable^ collection -) -``` **F#** ``` F# new : diff --git a/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md b/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md index 554a730..3dcb795 100644 --- a/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md +++ b/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md @@ -7,7 +7,7 @@ Initializes a new instance of the Pool(T) class w ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,19 +15,6 @@ public Pool( int poolSize ) ``` -**VB** -``` VB -Public Sub New ( - poolSize As Integer -) -``` -**C++** -``` C++ -public: -Pool( - int poolSize -) -``` **F#** ``` F# new : diff --git a/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md b/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md index 7577c0a..f46696e 100644 --- a/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md +++ b/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md @@ -7,7 +7,7 @@ Initializes a new instance of the Pool(T) class w ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -16,21 +16,6 @@ public Pool( Func constructorSelector ) ``` -**VB** -``` VB -Public Sub New ( - poolSize As Integer, - constructorSelector As Func(Of T) -) -``` -**C++** -``` C++ -public: -Pool( - int poolSize, - Func^ constructorSelector -) -``` **F#** ``` F# new : diff --git a/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md b/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md index c34af56..dbb2861 100644 --- a/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md +++ b/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md @@ -7,7 +7,7 @@ Determines whether the specified properties are equal. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -16,21 +16,6 @@ public bool Equals( T y ) ``` -**VB** -``` VB -Public Function Equals ( - x As T, - y As T -) As Boolean -``` -**C++** -``` C++ -public: -virtual bool Equals( - T x, - T y -) sealed -``` **F#** ``` F# abstract Equals : diff --git a/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md b/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md index 07f04e2..4004177 100644 --- a/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md +++ b/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md @@ -7,7 +7,7 @@ Returns a hash code for the specified object. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,19 +15,6 @@ public int GetHashCode( T obj ) ``` -**VB** -``` VB -Public Function GetHashCode ( - obj As T -) As Integer -``` -**C++** -``` C++ -public: -virtual int GetHashCode( - T obj -) sealed -``` **F#** ``` F# abstract GetHashCode : diff --git a/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md b/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md index 1d88f1b..4c16315 100644 --- a/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md +++ b/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md @@ -7,7 +7,7 @@ Constructor. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,19 +15,6 @@ public PropertyComparer( Func expression ) ``` -**VB** -``` VB -Public Sub New ( - expression As Func(Of T, U) -) -``` -**C++** -``` C++ -public: -PropertyComparer( - Func^ expression -) -``` **F#** ``` F# new : diff --git a/Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md b/Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md index 4d5fd06..febe6c3 100644 --- a/Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md +++ b/Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md @@ -18,15 +18,18 @@ Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object) -GetCalendarKey -Gets a calendar key that is 32 characters long. - GetHashCode Serves as the default hash function.
(Inherited from Object) GetRandomPassword Gets a cryptographically strong random password. +GetRandomString(Int32) +A convenience method to generate a random string of the specified length using all character sets. + +GetRandomString(Int32, ValidCharacterCollection[]) +Gets a cryptographically strong random string using the character values found in [!:VALID_CHARACTERS]. + GetType Gets the Type of the current instance.
(Inherited from Object) @@ -36,11 +39,11 @@ MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object) -Pbkdf2 -  +Pbkdf2(String) +Generates a new Password object using the PBKDF2 algorithm with the provided password. This overload of the method generates a random salt value for added security. -SHA256Hash -Produces a SHA256 hash from a given value. +Pbkdf2(String, Byte[]) +Generates a new Password object using the PBKDF2 algorithm with the provided password and salt. ToString Returns a string that represents the current object.
(Inherited from Object) diff --git a/Documentation/Help/N_CapyKit_Helpers.md b/Documentation/Help/N_CapyKit_Helpers.md index 3ea8737..f4802a7 100644 --- a/Documentation/Help/N_CapyKit_Helpers.md +++ b/Documentation/Help/N_CapyKit_Helpers.md @@ -19,4 +19,11 @@ SerializationHelper   + + +## Enumerations + + + +
ValidCharacterCollectionAn enumeration that defines the types of characters that can be included in a random string.
\ No newline at end of file diff --git a/Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_GetRandomString.md b/Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_GetRandomString.md new file mode 100644 index 0000000..204a3e8 --- /dev/null +++ b/Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_GetRandomString.md @@ -0,0 +1,19 @@ +# GetRandomString Method + + +## Overload List + + + + + + + +
GetRandomString(Int32)A convenience method to generate a random string of the specified length using all character sets.
GetRandomString(Int32, ValidCharacterCollection[])Gets a cryptographically strong random string using the character values found in [!:VALID_CHARACTERS].
+ +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2.md b/Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2.md new file mode 100644 index 0000000..817d7d6 --- /dev/null +++ b/Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2.md @@ -0,0 +1,19 @@ +# Pbkdf2 Method + + +## Overload List + + + + + + + +
Pbkdf2(String)Generates a new Password object using the PBKDF2 algorithm with the provided password. This overload of the method generates a random salt value for added security.
Pbkdf2(String, Byte[])Generates a new Password object using the PBKDF2 algorithm with the provided password and salt.
+ +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md b/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md index cc670ac..451d1d2 100644 --- a/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md +++ b/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md @@ -7,24 +7,12 @@ Initializes a new instance of the CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public T Value { get; } ``` -**VB** -``` VB -Public ReadOnly Property Value As T - Get -``` -**C++** -``` C++ -public: -property T Value { - T get (); -} -``` **F#** ``` F# member Value : 'T with get diff --git a/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md b/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md index 302fcd0..0811085 100644 --- a/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md +++ b/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md @@ -7,24 +7,12 @@ Gets the severity level of the event. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public EventLevel Level { get; } ``` -**VB** -``` VB -Public ReadOnly Property Level As EventLevel - Get -``` -**C++** -``` C++ -public: -property EventLevel Level { - EventLevel get (); -} -``` **F#** ``` F# member Level : EventLevel with get diff --git a/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md b/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md index 966d827..20d7336 100644 --- a/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md +++ b/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md @@ -7,24 +7,12 @@ Gets the message describing the reason for the event. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public string Message { get; } ``` -**VB** -``` VB -Public ReadOnly Property Message As String - Get -``` -**C++** -``` C++ -public: -property String^ Message { - String^ get (); -} -``` **F#** ``` F# member Message : string with get diff --git a/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md b/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md index d5d2ab5..44fff9d 100644 --- a/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md +++ b/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md @@ -7,24 +7,12 @@ Gets the name of the method where the event was raised. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public string MethodName { get; } ``` -**VB** -``` VB -Public ReadOnly Property MethodName As String - Get -``` -**C++** -``` C++ -public: -property String^ MethodName { - String^ get (); -} -``` **F#** ``` F# member MethodName : string with get diff --git a/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md b/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md index 6796667..8ebee49 100644 --- a/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md +++ b/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md @@ -7,23 +7,12 @@ Gets the name of the algorithm. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# string AlgorithmName { get; } ``` -**VB** -``` VB -ReadOnly Property AlgorithmName As String - Get -``` -**C++** -``` C++ -property String^ AlgorithmName { - String^ get (); -} -``` **F#** ``` F# abstract AlgorithmName : string with get diff --git a/Documentation/Help/P_CapyKit_Password_Algorithm.md b/Documentation/Help/P_CapyKit_Password_Algorithm.md index de1adcf..559711e 100644 --- a/Documentation/Help/P_CapyKit_Password_Algorithm.md +++ b/Documentation/Help/P_CapyKit_Password_Algorithm.md @@ -7,24 +7,12 @@ Gets or sets the algorithm used for password encryption. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public IPasswordAlgorithm Algorithm { get; } ``` -**VB** -``` VB -Public ReadOnly Property Algorithm As IPasswordAlgorithm - Get -``` -**C++** -``` C++ -public: -property IPasswordAlgorithm^ Algorithm { - IPasswordAlgorithm^ get (); -} -``` **F#** ``` F# member Algorithm : IPasswordAlgorithm with get diff --git a/Documentation/Help/P_CapyKit_Password_Hash.md b/Documentation/Help/P_CapyKit_Password_Hash.md index b797132..67d83dc 100644 --- a/Documentation/Help/P_CapyKit_Password_Hash.md +++ b/Documentation/Help/P_CapyKit_Password_Hash.md @@ -7,24 +7,12 @@ Gets or sets the hash of the password. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public byte[] Hash { get; } ``` -**VB** -``` VB -Public ReadOnly Property Hash As Byte() - Get -``` -**C++** -``` C++ -public: -property array^ Hash { - array^ get (); -} -``` **F#** ``` F# member Hash : byte[] with get diff --git a/Documentation/Help/P_CapyKit_Password_Pbkdf2Algorithm.md b/Documentation/Help/P_CapyKit_Password_Pbkdf2Algorithm.md new file mode 100644 index 0000000..ca9a7de --- /dev/null +++ b/Documentation/Help/P_CapyKit_Password_Pbkdf2Algorithm.md @@ -0,0 +1,31 @@ +# Pbkdf2Algorithm Property + + +\[Missing <summary> documentation for "P:CapyKit.Password.Pbkdf2Algorithm"\] + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +public static Pbkdf2Algorithm Pbkdf2Algorithm { get; } +``` +**F#** +``` F# +static member Pbkdf2Algorithm : Pbkdf2Algorithm with get +``` + + + +#### Property Value +Pbkdf2Algorithm + +## See Also + + +#### Reference +Password Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_Password_Salt.md b/Documentation/Help/P_CapyKit_Password_Salt.md index 2de9918..c6db9c0 100644 --- a/Documentation/Help/P_CapyKit_Password_Salt.md +++ b/Documentation/Help/P_CapyKit_Password_Salt.md @@ -7,24 +7,12 @@ Gets or sets the salt used for encryption. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public byte[] Salt { get; } ``` -**VB** -``` VB -Public ReadOnly Property Salt As Byte() - Get -``` -**C++** -``` C++ -public: -property array^ Salt { - array^ get (); -} -``` **F#** ``` F# member Salt : byte[] with get diff --git a/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md b/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md index 468e00c..30b04bc 100644 --- a/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md +++ b/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md @@ -7,24 +7,12 @@ Gets the name of the algorithm. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public string AlgorithmName { get; } ``` -**VB** -``` VB -Public ReadOnly Property AlgorithmName As String - Get -``` -**C++** -``` C++ -public: -virtual property String^ AlgorithmName { - String^ get () sealed; -} -``` **F#** ``` F# abstract AlgorithmName : string with get diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_Index.md b/Documentation/Help/P_CapyKit_PoolItem_1_Index.md index 5296ba4..1dff0e4 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_Index.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_Index.md @@ -7,24 +7,12 @@ Gets the zero-based index of the pooled item. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public int Index { get; } ``` -**VB** -``` VB -Public ReadOnly Property Index As Integer - Get -``` -**C++** -``` C++ -public: -property int Index { - int get (); -} -``` **F#** ``` F# member Index : int with get diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_Item.md b/Documentation/Help/P_CapyKit_PoolItem_1_Item.md index c96d191..505a23c 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_Item.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_Item.md @@ -7,24 +7,12 @@ Gets the pooled resource. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public T Item { get; } ``` -**VB** -``` VB -Public ReadOnly Property Item As T - Get -``` -**C++** -``` C++ -public: -property T Item { - T get (); -} -``` **F#** ``` F# member Item : 'T with get diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md b/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md index 977ec0c..6517154 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md @@ -7,24 +7,12 @@ Gets a value indicating whether this object is locked or not. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public bool Locked { get; } ``` -**VB** -``` VB -Public ReadOnly Property Locked As Boolean - Get -``` -**C++** -``` C++ -public: -property bool Locked { - bool get (); -} -``` **F#** ``` F# member Locked : bool with get diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md b/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md index c9afcab..999fba5 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md @@ -7,24 +7,12 @@ Gets the name of the CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public string TypeName { get; } ``` -**VB** -``` VB -Public ReadOnly Property TypeName As String - Get -``` -**C++** -``` C++ -public: -property String^ TypeName { - String^ get (); -} -``` **F#** ``` F# member TypeName : string with get diff --git a/Documentation/Help/Properties_T_CapyKit_Password.md b/Documentation/Help/Properties_T_CapyKit_Password.md index 910cdf2..8029d51 100644 --- a/Documentation/Help/Properties_T_CapyKit_Password.md +++ b/Documentation/Help/Properties_T_CapyKit_Password.md @@ -12,6 +12,9 @@ Hash Gets or sets the hash of the password. +Pbkdf2Algorithm +  + Salt Gets or sets the salt used for encryption. diff --git a/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md b/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md index b8a5d06..8712924 100644 --- a/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md +++ b/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md @@ -7,22 +7,12 @@ Custom attribute class for decorating enumeration fields with additional data. ## Definition **Namespace:** CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public abstract class EnumerationAttribute : Attribute -``` -**VB** -``` VB -Public MustInherit Class EnumerationAttribute(Of T) - Inherits Attribute -``` -**C++** -``` C++ -generic -public ref class EnumerationAttribute abstract : public Attribute ``` **F#** ``` F# diff --git a/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md b/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md index 5d0f1c5..a2e6750 100644 --- a/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md +++ b/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md @@ -7,21 +7,12 @@ An attribute class for decorating enumeration fields with a description. ## Definition **Namespace:** CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public class EnumerationDescriptionAttribute : EnumerationAttribute ``` -**VB** -``` VB -Public Class EnumerationDescriptionAttribute - Inherits EnumerationAttribute(Of String) -``` -**C++** -``` C++ -public ref class EnumerationDescriptionAttribute : public EnumerationAttribute -``` **F#** ``` F# type EnumerationDescriptionAttribute = diff --git a/Documentation/Help/T_CapyKit_CapyEventArgs.md b/Documentation/Help/T_CapyKit_CapyEventArgs.md index 352499e..b94fc08 100644 --- a/Documentation/Help/T_CapyKit_CapyEventArgs.md +++ b/Documentation/Help/T_CapyKit_CapyEventArgs.md @@ -7,21 +7,12 @@ The CapyEventArgs class represents an event argument instance with event level, ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public class CapyEventArgs : EventArgs ``` -**VB** -``` VB -Public Class CapyEventArgs - Inherits EventArgs -``` -**C++** -``` C++ -public ref class CapyEventArgs : public EventArgs -``` **F#** ``` F# type CapyEventArgs = diff --git a/Documentation/Help/T_CapyKit_CapyEventHandler.md b/Documentation/Help/T_CapyKit_CapyEventHandler.md index 93434ce..0b9f564 100644 --- a/Documentation/Help/T_CapyKit_CapyEventHandler.md +++ b/Documentation/Help/T_CapyKit_CapyEventHandler.md @@ -7,7 +7,7 @@ A delegate representing an event handler that accepts a CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# @@ -15,18 +15,6 @@ public delegate void CapyEventHandler( CapyEventArgs e ) ``` -**VB** -``` VB -Public Delegate Sub CapyEventHandler ( - e As CapyEventArgs -) -``` -**C++** -``` C++ -public delegate void CapyEventHandler( - CapyEventArgs^ e -) -``` **F#** ``` F# type CapyEventHandler = diff --git a/Documentation/Help/T_CapyKit_CapyEventReporter.md b/Documentation/Help/T_CapyKit_CapyEventReporter.md index 40d4592..a3dc2ca 100644 --- a/Documentation/Help/T_CapyKit_CapyEventReporter.md +++ b/Documentation/Help/T_CapyKit_CapyEventReporter.md @@ -7,20 +7,12 @@ The CapyEventReporter class is responsible for managing event subscriptions and ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public static class CapyEventReporter ``` -**VB** -``` VB -Public NotInheritable Class CapyEventReporter -``` -**C++** -``` C++ -public ref class CapyEventReporter abstract sealed -``` **F#** ``` F# [] diff --git a/Documentation/Help/T_CapyKit_Color.md b/Documentation/Help/T_CapyKit_Color.md index 75ce861..98d83d2 100644 --- a/Documentation/Help/T_CapyKit_Color.md +++ b/Documentation/Help/T_CapyKit_Color.md @@ -7,20 +7,12 @@ Enum representing a set of named colors with their corresponding HEX values. The ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public enum Color ``` -**VB** -``` VB -Public Enumeration Color -``` -**C++** -``` C++ -public enum class Color -``` **F#** ``` F# type Color diff --git a/Documentation/Help/T_CapyKit_EventLevel.md b/Documentation/Help/T_CapyKit_EventLevel.md index 51b2291..38e51d5 100644 --- a/Documentation/Help/T_CapyKit_EventLevel.md +++ b/Documentation/Help/T_CapyKit_EventLevel.md @@ -7,20 +7,12 @@ Enumeration representing different event level severity values. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public enum EventLevel ``` -**VB** -``` VB -Public Enumeration EventLevel -``` -**C++** -``` C++ -public enum class EventLevel -``` **F#** ``` F# type EventLevel diff --git a/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md b/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md index 6814285..a09f255 100644 --- a/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md +++ b/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md @@ -7,22 +7,12 @@ Provides static extentions methods for providing additional functionality for CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public static class EnumerationExtensions ``` -**VB** -``` VB - -Public NotInheritable Class EnumerationExtensions -``` -**C++** -``` C++ -[ExtensionAttribute] -public ref class EnumerationExtensions abstract sealed -``` **F#** ``` F# [] diff --git a/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md b/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md index de37fd1..8b4e8dd 100644 --- a/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md +++ b/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md @@ -7,22 +7,12 @@ Provides static extension methods for performing common LINQ operations on CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public static class LINQExtensions ``` -**VB** -``` VB - -Public NotInheritable Class LINQExtensions -``` -**C++** -``` C++ -[ExtensionAttribute] -public ref class LINQExtensions abstract sealed -``` **F#** ``` F# [] diff --git a/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md b/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md index 96ae019..f38347d 100644 --- a/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md +++ b/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md @@ -7,22 +7,12 @@ Provides static extentions methods for providing additional functionality for CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public static class StringExtensions ``` -**VB** -``` VB - -Public NotInheritable Class StringExtensions -``` -**C++** -``` C++ -[ExtensionAttribute] -public ref class StringExtensions abstract sealed -``` **F#** ``` F# [] diff --git a/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md b/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md index 45642cf..a91c960 100644 --- a/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md @@ -7,20 +7,12 @@ A class that contains methods for managing data compression. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public static class CompressionHelper ``` -**VB** -``` VB -Public NotInheritable Class CompressionHelper -``` -**C++** -``` C++ -public ref class CompressionHelper abstract sealed -``` **F#** ``` F# [] diff --git a/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md b/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md index 3d38a84..69e1666 100644 --- a/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md @@ -7,20 +7,12 @@ ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public class LanguageHelper ``` -**VB** -``` VB -Public Class LanguageHelper -``` -**C++** -``` C++ -public ref class LanguageHelper -``` **F#** ``` F# type LanguageHelper = class end diff --git a/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md b/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md index 7215b6b..e58494a 100644 --- a/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md @@ -7,20 +7,12 @@ A class that contains methods for managing secure data processing and cryptograp ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public class SecurityHelper ``` -**VB** -``` VB -Public Class SecurityHelper -``` -**C++** -``` C++ -public ref class SecurityHelper -``` **F#** ``` F# type SecurityHelper = class end @@ -53,15 +45,18 @@ type SecurityHelper = class end Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object) -GetCalendarKey -Gets a calendar key that is 32 characters long. - GetHashCode Serves as the default hash function.
(Inherited from Object) GetRandomPassword Gets a cryptographically strong random password. +GetRandomString(Int32) +A convenience method to generate a random string of the specified length using all character sets. + +GetRandomString(Int32, ValidCharacterCollection[]) +Gets a cryptographically strong random string using the character values found in [!:VALID_CHARACTERS]. + GetType Gets the Type of the current instance.
(Inherited from Object) @@ -71,11 +66,11 @@ type SecurityHelper = class end MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object) -Pbkdf2 -  +Pbkdf2(String) +Generates a new Password object using the PBKDF2 algorithm with the provided password. This overload of the method generates a random salt value for added security. -SHA256Hash -Produces a SHA256 hash from a given value. +Pbkdf2(String, Byte[]) +Generates a new Password object using the PBKDF2 algorithm with the provided password and salt. ToString Returns a string that represents the current object.
(Inherited from Object) diff --git a/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md b/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md index 5a28a7b..cc8d576 100644 --- a/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md @@ -7,20 +7,12 @@ ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public static class SerializationHelper ``` -**VB** -``` VB -Public NotInheritable Class SerializationHelper -``` -**C++** -``` C++ -public ref class SerializationHelper abstract sealed -``` **F#** ``` F# [] diff --git a/Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md b/Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md new file mode 100644 index 0000000..b82ca83 --- /dev/null +++ b/Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md @@ -0,0 +1,47 @@ +# ValidCharacterCollection Enumeration + + +An enumeration that defines the types of characters that can be included in a random string. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +public enum ValidCharacterCollection +``` +**F#** +``` F# +type ValidCharacterCollection +``` + + + +## Members + + + + + + + + + + + + + + + + + +
Lowercase0Indicates that lower case characters should be included in the random string.
Uppercase1Indicates that upper case characters should be included in the random string.
Numbers2Indicates that numeric characters should be included in the random string.
Special3Indicates that special characters should be included in the random string.
+ +## See Also + + +#### Reference +CapyKit.Helpers Namespace diff --git a/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md b/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md index 054e28b..bf756b3 100644 --- a/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md +++ b/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md @@ -7,20 +7,12 @@ Defines the contract for password encryption algorithms. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public interface IPasswordAlgorithm ``` -**VB** -``` VB -Public Interface IPasswordAlgorithm -``` -**C++** -``` C++ -public interface class IPasswordAlgorithm -``` **F#** ``` F# type IPasswordAlgorithm = interface end diff --git a/Documentation/Help/T_CapyKit_Password.md b/Documentation/Help/T_CapyKit_Password.md index f428f6c..38b2063 100644 --- a/Documentation/Help/T_CapyKit_Password.md +++ b/Documentation/Help/T_CapyKit_Password.md @@ -7,20 +7,12 @@ Represents a password with its hash, salt and algorithm used for encryption. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public class Password ``` -**VB** -``` VB -Public Class Password -``` -**C++** -``` C++ -public ref class Password -``` **F#** ``` F# type Password = class end @@ -40,6 +32,9 @@ type Password = class end Hash Gets or sets the hash of the password. +Pbkdf2Algorithm +  + Salt Gets or sets the salt used for encryption. diff --git a/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md b/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md index d14719d..e4275a6 100644 --- a/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md +++ b/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md @@ -7,21 +7,12 @@ Implements the PBKDF2 algorithm for password encryption. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public class Pbkdf2Algorithm : IPasswordAlgorithm ``` -**VB** -``` VB -Public Class Pbkdf2Algorithm - Implements IPasswordAlgorithm -``` -**C++** -``` C++ -public ref class Pbkdf2Algorithm : IPasswordAlgorithm -``` **F#** ``` F# type Pbkdf2Algorithm = diff --git a/Documentation/Help/T_CapyKit_PoolItem_1.md b/Documentation/Help/T_CapyKit_PoolItem_1.md index 3abe469..dcf7f1e 100644 --- a/Documentation/Help/T_CapyKit_PoolItem_1.md +++ b/Documentation/Help/T_CapyKit_PoolItem_1.md @@ -7,21 +7,12 @@ A pool item. This class cannot be inherited. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public sealed class PoolItem -``` -**VB** -``` VB -Public NotInheritable Class PoolItem(Of T) -``` -**C++** -``` C++ -generic -public ref class PoolItem sealed ``` **F#** ``` F# diff --git a/Documentation/Help/T_CapyKit_Pool_1.md b/Documentation/Help/T_CapyKit_Pool_1.md index 6ce17a9..5231cc8 100644 --- a/Documentation/Help/T_CapyKit_Pool_1.md +++ b/Documentation/Help/T_CapyKit_Pool_1.md @@ -7,21 +7,12 @@ A managed pool of resources. This class provides a thread-safe way to manage a c ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public class Pool -``` -**VB** -``` VB -Public Class Pool(Of T) -``` -**C++** -``` C++ -generic -public ref class Pool ``` **F#** ``` F# diff --git a/Documentation/Help/T_CapyKit_PropertyComparer_2.md b/Documentation/Help/T_CapyKit_PropertyComparer_2.md index 2237ebc..e1f1524 100644 --- a/Documentation/Help/T_CapyKit_PropertyComparer_2.md +++ b/Documentation/Help/T_CapyKit_PropertyComparer_2.md @@ -7,22 +7,12 @@ A object comparer that can accept a lambda expression to compare properties. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# public class PropertyComparer : IEqualityComparer -``` -**VB** -``` VB -Public Class PropertyComparer(Of T, U) - Implements IEqualityComparer(Of T) -``` -**C++** -``` C++ -generic -public ref class PropertyComparer : IEqualityComparer ``` **F#** ``` F# diff --git a/Documentation/Help/Working/_InheritedDocs_.xml b/Documentation/Help/Working/_InheritedDocs_.xml new file mode 100644 index 0000000..0bbb14e --- /dev/null +++ b/Documentation/Help/Working/_InheritedDocs_.xml @@ -0,0 +1,13 @@ + + + _InheritedDocs_ + + + + +Returns a string that represents the current object.A string that represents the current object. + + + Gets the name of the algorithm. + + \ No newline at end of file diff --git a/Documentation/Help/_Sidebar.md b/Documentation/Help/_Sidebar.md index c412f32..26ec29d 100644 --- a/Documentation/Help/_Sidebar.md +++ b/Documentation/Help/_Sidebar.md @@ -26,6 +26,7 @@ - [Password Properties](Properties_T_CapyKit_Password) - [Algorithm Property](P_CapyKit_Password_Algorithm) - [Hash Property](P_CapyKit_Password_Hash) + - [Pbkdf2Algorithm Property](P_CapyKit_Password_Pbkdf2Algorithm) - [Salt Property](P_CapyKit_Password_Salt) - [Password Methods](Methods_T_CapyKit_Password) - [ToString Method](M_CapyKit_Password_ToString) @@ -120,11 +121,14 @@ - [SecurityHelper Methods](Methods_T_CapyKit_Helpers_SecurityHelper) - [CompareHashedPassword Method](M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword) - [CompareSessionID Method](M_CapyKit_Helpers_SecurityHelper_CompareSessionID) - - [GetCalendarKey Method](M_CapyKit_Helpers_SecurityHelper_GetCalendarKey) - [GetRandomPassword Method](M_CapyKit_Helpers_SecurityHelper_GetRandomPassword) + - [GetRandomString Method](Overload_CapyKit_Helpers_SecurityHelper_GetRandomString) + - [GetRandomString(Int32) Method](M_CapyKit_Helpers_SecurityHelper_GetRandomString) + - [GetRandomString(Int32, ValidCharacterCollection[]) Method](M_CapyKit_Helpers_SecurityHelper_GetRandomString_1) - [HashPassword Method](M_CapyKit_Helpers_SecurityHelper_HashPassword) - - [Pbkdf2 Method](M_CapyKit_Helpers_SecurityHelper_Pbkdf2) - - [SHA256Hash Method](M_CapyKit_Helpers_SecurityHelper_SHA256Hash) + - [Pbkdf2 Method](Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2) + - [Pbkdf2(String) Method](M_CapyKit_Helpers_SecurityHelper_Pbkdf2) + - [Pbkdf2(String, Byte[]) Method](M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1) - [SerializationHelper Class](T_CapyKit_Helpers_SerializationHelper) - [SerializationHelper Methods](Methods_T_CapyKit_Helpers_SerializationHelper) - [Deserialize Method](Overload_CapyKit_Helpers_SerializationHelper_Deserialize) @@ -133,3 +137,4 @@ - [Deserialize(String) Method](M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2) - [SerializeToBytes Method](M_CapyKit_Helpers_SerializationHelper_SerializeToBytes) - [SerializeToString Method](M_CapyKit_Helpers_SerializationHelper_SerializeToString) + - [ValidCharacterCollection Enumeration](T_CapyKit_Helpers_ValidCharacterCollection)