CapyKit/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md
Jordan Wages 735d7c4c91 Documentation + Unfinished SecurityHelper
Committing the unfinished changes to the SecurityHelper as I flesh it out during the migration. Also starting a documentation folder powered by Sandcastle.
2024-04-19 23:12:24 -05:00

1.8 KiB

Compare Method

Compares the given plaintext password with an encrypted value using PBKDF2 algorithm.

Definition

Namespace: CapyKit
Assembly: CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d

C#

bool Compare(
	string password,
	byte[] encryptedValue,
	params Object[] args
)

VB

Function Compare ( 
	password As String,
	encryptedValue As Byte(),
	ParamArray args As Object()
) As Boolean

C++

bool Compare(
	String^ password, 
	array<unsigned char>^ encryptedValue, 
	... array<Object^>^ args
)

F#

abstract Compare : 
        password : string * 
        encryptedValue : byte[] * 
        args : Object[] -> bool 
override Compare : 
        password : string * 
        encryptedValue : byte[] * 
        args : Object[] -> bool 

Parameters

  String
The plaintext password to compare.
  Byte[]
The encrypted value to compare against.
  Object[]
Additional arguments for the encryption process, such as salt and length.

Return Value

Boolean
True if the given password matches the encryptedValue, false if they are different.

See Also

Reference

IPasswordAlgorithm Interface
CapyKit Namespace