Class SecretStorageCrypto

m.secret_storage.v1.aes-hmac-sha2 encryption and the recovery key format.

Inheritance
object
SecretStorageCrypto
Inherited Members
Namespace: Uniform.Matrix.Protocol.Crypto
Assembly: Uniform.Matrix.Protocol.Crypto.dll
Syntax
public static class SecretStorageCrypto

Fields

| Edit this page View Source

Algorithm

Algorithm name of the secret storage keys this class handles.

Declaration
public const string Algorithm = "m.secret_storage.v1.aes-hmac-sha2"
Field Value
Type Description
string

Methods

| Edit this page View Source

CheckKey(ReadOnlySpan<byte>, string, string)

Return whether key matches a key description's iv and mac.

Declaration
public static bool CheckKey(ReadOnlySpan<byte> key, string iv, string mac)
Parameters
Type Name Description
ReadOnlySpan<byte> key
string iv
string mac
Returns
Type Description
bool
| Edit this page View Source

CreateKeyCheck(ReadOnlySpan<byte>)

Return the iv and mac that prove knowledge of key: 32 zero bytes encrypted under the empty name.

Declaration
public static (string Iv, string Mac) CreateKeyCheck(ReadOnlySpan<byte> key)
Parameters
Type Name Description
ReadOnlySpan<byte> key
Returns
Type Description
(string Username, string Password)
| Edit this page View Source

DecodeRecoveryKey(string)

Parse a recovery key, ignoring spaces; throw FormatException when the prefix, length or parity is wrong.

Declaration
public static byte[] DecodeRecoveryKey(string recoveryKey)
Parameters
Type Name Description
string recoveryKey
Returns
Type Description
byte[]
| Edit this page View Source

Decrypt(ReadOnlySpan<byte>, string, EncryptedSecret)

Decrypt a text secret.

Declaration
public static string Decrypt(ReadOnlySpan<byte> key, string name, EncryptedSecret secret)
Parameters
Type Name Description
ReadOnlySpan<byte> key
string name
EncryptedSecret secret
Returns
Type Description
string
| Edit this page View Source

DecryptBytes(ReadOnlySpan<byte>, string, EncryptedSecret)

Verify the MAC and decrypt; throw CryptographicException for a wrong key or changed data.

Declaration
public static byte[] DecryptBytes(ReadOnlySpan<byte> key, string name, EncryptedSecret secret)
Parameters
Type Name Description
ReadOnlySpan<byte> key
string name
EncryptedSecret secret
Returns
Type Description
byte[]
| Edit this page View Source

EncodeRecoveryKey(ReadOnlySpan<byte>)

Format a 32-byte key as a recovery key: prefix, key and parity in base58, in groups of four.

Declaration
public static string EncodeRecoveryKey(ReadOnlySpan<byte> key)
Parameters
Type Name Description
ReadOnlySpan<byte> key
Returns
Type Description
string
Examples
string shown = SecretStorageCrypto.EncodeRecoveryKey(key); // "EsTc 5rr1 4mpm ..."
| Edit this page View Source

Encrypt(ReadOnlySpan<byte>, string, ReadOnlySpan<byte>)

Encrypt plaintext under name, e.g. m.cross_signing.master.

Declaration
public static EncryptedSecret Encrypt(ReadOnlySpan<byte> key, string name, ReadOnlySpan<byte> plaintext)
Parameters
Type Name Description
ReadOnlySpan<byte> key
string name
ReadOnlySpan<byte> plaintext
Returns
Type Description
EncryptedSecret
| Edit this page View Source

Encrypt(ReadOnlySpan<byte>, string, string)

Encrypt a text secret, such as a base64 private key.

Declaration
public static EncryptedSecret Encrypt(ReadOnlySpan<byte> key, string name, string secret)
Parameters
Type Name Description
ReadOnlySpan<byte> key
string name
string secret
Returns
Type Description
EncryptedSecret
| Edit this page View Source

KeyFromPassphrase(string, string, int, int)

Derive a key from a passphrase with PBKDF2-SHA-512, as in m.pbkdf2 passphrase settings.

Declaration
public static byte[] KeyFromPassphrase(string passphrase, string salt, int iterations, int bits = 256)
Parameters
Type Name Description
string passphrase
string salt
int iterations
int bits
Returns
Type Description
byte[]