PassKey

PassKey

Object Hierarchy:

Description:

[ Compact ]
public class PassKey

This type represents a pass-key.

A pass-key and a password are two different concepts: a password is given by the user in plain text. A pass-key is the generated symmetric key used for encryption and decryption. It is derived from a salt and the user- provided password.

Namespace: ToxEncryptSave

Package: toxcore

Content:

Creation methods:

public PassKey.derive (uint8[] passphrase, out ErrKeyDerivation error)
Generates a secret symmetric key from the given passphrase.
public PassKey.derive_with_salt (uint8[] passphrase, uint8[] salt, out ErrKeyDerivation error)
Same as above, except use the given salt for deterministic key derivation.

Methods:

public uint8[]? decrypt (uint8[] ciphertext, out ErrDecryption error)
This is the inverse of PassKey.encrypt, also using only keys produced by PassKey.PassKey.derive or PassKey.PassKey.derive_with_salt.
public uint8[]? encrypt (uint8[] plaintext, out ErrEncryption error)
Encrypt a plain text with a key produced by PassKey.PassKey.derive or PassKey.PassKey.derive_with_salt.