CapyKit/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.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

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

C#

bool Compare(
	string password,
	byte[] encryptedValue,
	params 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