Interface EncryptedFile

Information on encrypted media attachments.

Used within m.room.message events that reference files, such as m.file and m.image.

See

https://spec.matrix.org/v1.11/client-server-api/#extensions-to-mroommessage-msgtypes

interface EncryptedFile {
    hashes: {
        [alg: string]: string;
    };
    iv: string;
    key: {
        alg: string;
        ext: boolean;
        k: string;
        key_ops: string[];
        kty: string;
    };
    url: string;
    v: string;
}

Properties

hashes iv key url v

Properties

hashes

hashes: {
    [alg: string]: string;
}

A map from an algorithm name to a hash of the ciphertext, encoded as unpadded base64. Clients should support the SHA-256 hash, which uses the key sha256.

iv

iv: string

The 128-bit unique counter block used by AES-CTR, encoded as unpadded base64.

key

key: {
    alg: string;
    ext: boolean;
    k: string;
    key_ops: string[];
    kty: string;
}

A JSON Web Key object.

url

url: string

The URL to the file.

v

v: string

Version of the encrypted attachment's protocol. Must be v2.

Settings

Member Visibility

On This Page

Properties