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

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

1.5 KiB

Pbkdf2(String) Method

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

C#

public static Password Pbkdf2(
	string password
)

F#

static member Pbkdf2 : 
        password : string -> Password 

Parameters

  String
The clear text password to be hashed.

Return Value

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