package org.signal.chat.keys

Get desktop application:
View/edit binary Protocol Buffers messages

Provides methods for working with pre-keys.

• rpc GetPreKeyCount (GetPreKeyCountRequest, GetPreKeyCountResponse)

  keys.proto:25

  Retrieves an approximate count of the number of the various kinds of pre-keys stored for the authenticated device.

  message GetPreKeyCountRequest

  keys.proto:78

  (message has no fields)

  message GetPreKeyCountResponse

  keys.proto:81

  • uint32 aci_ec_pre_key_count = 1

    The approximate number of one-time EC pre-keys stored for the authenticated device and associated with the caller's ACI.

  • uint32 aci_kem_pre_key_count = 2

    The approximate number of one-time Kyber pre-keys stored for the authenticated device and associated with the caller's ACI.

  • uint32 pni_ec_pre_key_count = 3

    The approximate number of one-time EC pre-keys stored for the authenticated device and associated with the caller's PNI. 0 if the account does not possess a phone number.

  • uint32 pni_kem_pre_key_count = 4

    The approximate number of one-time KEM pre-keys stored for the authenticated device and associated with the caller's PNI. 0 if the account does not possess a phone number.

• rpc GetPreKeys (GetPreKeysRequest, GetPreKeysResponse)

  keys.proto:31

  Retrieves a set of pre-keys for establishing a session with the targeted device or devices. Note that callers with an unidentified access key for the targeted account should use the version of this method in `KeysAnonymous` instead.

  message GetPreKeysResponse

  keys.proto:162

  • oneof response

    • AccountPreKeyBundles pre_keys = 1

      The requested pre-key bundles

    • errors.NotFound target_not_found = 2

      Either the target account was not found, no active device with the given ID (if specified) was found on the target account.

• rpc SetEcSignedPreKey (SetEcSignedPreKeyRequest, SetPreKeyResponse)

  keys.proto:51

  Sets the signed EC pre-key for one identity (i.e. ACI or PNI) associated with the authenticated device.

  message SetEcSignedPreKeyRequest

  keys.proto:205

  • common.IdentityType identity_type = 1

    The identity type (i.e. ACI/PNI) with which this key is associated.

  • optional common.EcSignedPreKey signed_pre_key = 2

    The signed EC pre-key itself.

• rpc SetKemLastResortPreKey (SetKemLastResortPreKeyRequest, SetPreKeyResponse)

  keys.proto:55

  Sets the last-resort KEM pre-key for one identity (i.e. ACI or PNI) associated with the authenticated device.

  message SetKemLastResortPreKeyRequest

  keys.proto:213

  • common.IdentityType identity_type = 1

    The identity type (i.e. ACI/PNI) with which this key is associated.

  • optional common.KemSignedPreKey signed_pre_key = 2

    The signed KEM pre-key itself.

• rpc SetOneTimeEcPreKeys (SetOneTimeEcPreKeysRequest, SetPreKeyResponse)

  keys.proto:39

  Uploads a new set of one-time EC pre-keys for the authenticated device, clearing any previously-stored pre-keys. Note that all keys submitted via a single call to this method _must_ have the same identity type (i.e. if the first key has an ACI identity type, then all other keys in the same stream must also have an ACI identity type). The provided list of pre-keys must be non-empty.

  message SetOneTimeEcPreKeysRequest

  keys.proto:187

  • common.IdentityType identity_type = 1

    The identity type (i.e. ACI/PNI) with which the keys in this request are associated.

  • repeated common.EcPreKey pre_keys = 2

    The unsigned EC pre-keys to be stored.

• rpc SetOneTimeKemSignedPreKeys (SetOneTimeKemSignedPreKeysRequest, SetPreKeyResponse)

  keys.proto:47

  Uploads a new set of one-time KEM pre-keys for the authenticated device, clearing any previously-stored pre-keys. Note that all keys submitted via a single call to this method _must_ have the same identity type (i.e. if the first key has an ACI identity type, then all other keys in the same stream must also have an ACI identity type). The provided list of pre-keys must be non-empty.

  message SetOneTimeKemSignedPreKeysRequest

  keys.proto:196

  • common.IdentityType identity_type = 1

    The identity type (i.e. ACI/PNI) with which the keys in this request are associated.

  • repeated common.KemSignedPreKey pre_keys = 2

    The KEM pre-keys to be stored.

Provides methods for working with pre-keys using "unidentified access" credentials.

• rpc CheckIdentityKeys (stream CheckIdentityKeyRequest, stream CheckIdentityKeyResponse)

  keys.proto:75

  Checks identity key fingerprints of the target accounts. Returns a stream of elements, each one representing an account that had a mismatched identity key fingerprint with the server and the corresponding identity key stored by the server.

  message CheckIdentityKeyRequest

  keys.proto:224

  • optional common.ServiceIdentifier target_identifier = 1

    The service identifier of the account for which we want to check the associated identity key fingerprint.

  • bytes fingerprint = 2

    The most significant 4 bytes of the SHA-256 hash of the identity key associated with the target account/identity type.

  message CheckIdentityKeyResponse

  keys.proto:231

  • optional common.ServiceIdentifier target_identifier = 1

    The service identifier of the account for which there is a mismatch between the client and server identity key fingerprints.

  • bytes identity_key = 2

    The identity key that is stored by the server for the target account/identity type.

• rpc GetPreKeys (GetPreKeysAnonymousRequest, GetPreKeysAnonymousResponse)

  keys.proto:69

  Retrieves a set of pre-keys for establishing a session with the targeted device or devices. Callers must not submit any self-identifying credentials when calling this method and must instead present the targeted account's unidentified access key as an anonymous authentication mechanism. Callers without an unidentified access key should use the equivalent, authenticated method in `Keys` instead.

  message GetPreKeysAnonymousRequest

  keys.proto:111

  • optional GetPreKeysRequest request = 1

    The request to retrieve pre-keys for a specific account/device(s).

  • oneof authorization

    A means to authorize the request.

    • bytes unidentified_access_key = 2

      The unidentified access key (UAK) for the targeted account.

    • bytes group_send_token = 3

      A group send endorsement token for the targeted account.

    • google.protobuf.Empty unrestricted_access = 4

      The destination account allows unrestricted unidentified access

  message GetPreKeysAnonymousResponse

  keys.proto:173

  • oneof response

    • AccountPreKeyBundles pre_keys = 1

      The requested pre-key bundles

    • errors.NotFound target_not_found = 2

      Either the target account was not found, no active device with the given ID (if specified) was found on the target account.

    • errors.FailedUnidentifiedAuthorization failed_unidentified_authorization = 3

      The provided unidentified authorization credential was invalid

Used in: GetPreKeysAnonymousResponse, GetPreKeysResponse

• bytes identity_key = 1

  The identity key associated with the targeted account/identity.

• map<uint32, DevicePreKeyBundle> device_pre_keys = 2

  A map of device IDs to pre-key "bundles" for the targeted account.

• bool unrestricted_unidentified_access = 3

  Whether the account has enabled sealed sender from anyone. Always false if the request was for a PNI, which does not allow any unidentified access.

• bytes unidentified_access_key_fingerprint = 4

  If the target supports unidentified access and has an unidentified access key, a fingerprint of the target's UAK. This may be used to detect a change in the UAK that the sender has for the target before actually sending a message. Otherwise, empty.

Used in: AccountPreKeyBundles

• optional common.EcSignedPreKey ec_signed_pre_key = 1

  The EC signed pre-key associated with the targeted account/device/identity.

• optional common.EcPreKey ec_one_time_pre_key = 2

  A one-time EC pre-key for the targeted account/device/identity. May not be set if no one-time EC pre-keys are available.

• optional common.KemSignedPreKey kem_one_time_pre_key = 3

  A one-time KEM pre-key (or a last-resort KEM pre-key) for the targeted account/device/identity.

• uint32 registration_id = 4

  The registration ID for the targeted account/device/identity.

Used as request type in: Keys.GetPreKeys

Used as field type in: GetPreKeysAnonymousRequest

• optional common.ServiceIdentifier target_identifier = 1

  The service identifier of the account for which to retrieve pre-keys.

• optional uint32 device_id = 2

  The ID of the device associated with the targeted account for which to retrieve pre-keys. If not set, pre-keys are returned for all devices associated with the targeted account.

Used as response type in: Keys.SetEcSignedPreKey, Keys.SetKemLastResortPreKey, Keys.SetOneTimeEcPreKeys, Keys.SetOneTimeKemSignedPreKeys

(message has no fields)