CapyKit/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.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.6 KiB

Encrypt Method

Encrypts the given password using a PBKDF2 algorithm.

Definition

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

C#

public byte[] Encrypt(
	string password,
	params Object[] args
)

VB

Public Function Encrypt ( 
	password As String,
	ParamArray args As Object()
) As Byte()

C++

public:
virtual array<unsigned char>^ Encrypt(
	String^ password, 
	... array<Object^>^ args
) sealed

F#

abstract Encrypt : 
        password : string * 
        args : Object[] -> byte[] 
override Encrypt : 
        password : string * 
        args : Object[] -> byte[] 

Parameters

  String
The plaintext password.
  Object[]
Additional arguments for the encryption process, specifically
  1. salt
  2. length
  3. iterations

Return Value

Byte[]
A byte array with the hashed password.

Implements

IPasswordAlgorithm.Encrypt(String, Object[])

See Also

Reference

Pbkdf2Algorithm Class
CapyKit Namespace