package org.signal.chat.profile
Get desktop application:
View/edit binary Protocol Buffers messages
service Profile
profile.proto:20Provides methods for working with profiles and profile-related data.
rpc GetAvatarCredential (, )
profile.proto:33Returns an anonymous credential that may be presented with avatar operations in ProfilesAnonymous Note: `Accounts.SetZkCredentialKey` is a pre-requisite for this RPC
message
profile.proto:371bytes avatar_credential_request = 1
message
profile.proto:375oneof response
bytes avatar_credential = 1
missing_zk_credential_key = 2
the client must call Accounts.SetZkCredentialKey to call this method
rpc GetProfile (, )
profile.proto:28Retrieves profile data. Callers with an unidentified access key for the account should use the version of this method in `ProfileAnonymous` instead.
message
profile.proto:294oneof response
profile = 1
The full profile data. The current profile did not match the provided etag (or no etag was provided).
bool etag_matched = 2
The current profile matched the provided etag. If present, this will always be true.
not_found = 3
legacy_profile = 15
Will be present if there is no v2 Profile data for this version. Because this is a temporary field during the migration, it has the highest field number without serialization overhead. This is purely aesthetic.
rpc SetProfile (, )
profile.proto:24Sets profile data and, if needed, returns a credential used by clients to upload a v1 avatar.
message
profile.proto:117bytes version = 1
The profile version. Required.
bytes data = 2
The ciphertext of a serialized Profile protobuf. Required. 937 max length = 909 plaintext serialization + 28 bytes encryption overhead
bytes expected_current_data_hash = 3
The SHA-256 hash of the Profile ciphertext being replaced. This is used an optimistic lock against concurrent changes. Optional, if this is the initial request to create a version.
bytes expected_current_version = 4
The current profile version being updated. This is used as an optimistic lock against concurrent changes. Optional, if there is no current profile version for the account.
bytes payment_address = 5
The ciphertext of the MobileCoin wallet ID on the profile.
repeated string badge_ids = 6
A list of badge IDs associated with the profile.
bytes commitment = 7
The profile key commitment. Used to issue a profile key credential response. Required during the v1 -> v2 migration period. Afterwards will be optional, if this is an update to an existing version.
optional v1Request = 15
An embedded v1 request. Required during the v1 -> v2 migration period. Because this is a temporary field during the migration, it has the highest field number without serialization overhead. This is purely aesthetic.
message
profile.proto:178oneof response
result = 1
expected_data_write_conflict = 2
The current data hash did not match the request's expectation, indicating another device on the account may have written an update the caller does not know about.
payments_forbidden_in_region = 3
Payments are not permitted in the account's region, based on its phone number or the caller's IP address if the account does not have a phone number. The request should be retried without `payment_address.
expected_version_write_conflict = 4
The current version did not match the request's expectation, indicating another device on the account may have created a new version the caller does not know about.
rpc SetV1Avatar (, )
profile.proto:44Returns a credential used by clients to upload a v1 avatar, deleting any current avatar. This RPC streamlines avatar changes during the v1 -> v2 transition by minimizing uploads: 1. SetV1Avatar 2. Upload to CDN 3. SetProfile with v1 `AVATAR_CHANGE_UNCHANGED` and the v1 avatar in the v2 profile body Clients that do this will be required to upload current avatars using `ProfilesAnonymous.GetAvatarUploadFormRequest` once v1 Profile APIs are no longer supported.
message
profile.proto:104string version = 1
The profile version. Required.
bytes commitment = 2
The profile key commitment. Required if this is a new profile version.
message
profile.proto:112optional form = 1
the policy and credential used by clients to upload an avatar to the CDN
service ProfileAnonymous
profile.proto:53Provides methods for working with profiles and profile-related data using "unidentified access" credentials. Callers must not submit any self-identifying credentials when calling methods in this service 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 methods in `Profile` instead.
rpc DeleteAvatar (, )
profile.proto:78Deletes the avatar currently associated with the request’s avatar auth credential. Clients must also call SetProfile to remove the avatar from the encrypted `data`.
message
profile.proto:415bytes avatar_credential_presentation = 1
message
profile.proto:419oneof response
success = 1
invalid_credential_presentation = 2
rpc ExtendAvatarTTL (, )
profile.proto:73Extends the TTL of the avatar currently associated with the request’s avatar auth credential
message
profile.proto:401bytes avatar_credential_presentation = 1
message
profile.proto:405oneof response
string path = 1
The avatar that was extended. May be used as a check against state de-synchronization.
invalid_credential_presentation = 2
not_found = 3
the identity does not have an active avatar
rpc GetAvatarUploadForm (, )
profile.proto:70Returns a credential to upload a v2 avatar. After uploading the avatar, the client must call SetProfile with the new avatar URL in the encrypted `data`. Because avatars are uploaded anonymously, they have an expiration equal to the idle account expiration. Clients must periodically (recommended: every 90 days) call ExtendAvatarTTL to extend the TTl. Note: any existing avatar associated with this credential will be deleted immediately
message
profile.proto:384bytes avatar_credential_presentation = 1
uint32 upload_length = 2
The length of the attachment for the requested upload form. Uploads performed with this form will be limited to the provided length.
message
profile.proto:392oneof response
avatar_upload_form = 1
the policy and credential used by clients to upload an avatar to the CDN
invalid_credential_presentation = 2
rpc GetProfile (, )
profile.proto:57Retrieves profile data.
message
profile.proto:208optional request = 1
Contains the data necessary to request a profile.
oneof authentication
bytes unidentified_access_key = 2
The unidentified access key for the targeted account.
bytes group_send_token = 3
A group send endorsement token for the targeted account.
message
profile.proto:314oneof response
profile = 1
The full profile data. The current profile did not match the provided etag (or no etag was provided).
bool etag_matched = 2
The current profile matched the provided etag. If present, this will always be true.
not_found = 3
failed_unidentified_authorization = 4
profile_v1 = 15
Will be present if there is no v2 Profile data for this version. Because this is a temporary field during the migration, it has the highest field number without serialization overhead. This is purely aesthetic.
Retrieves a profile key credential.
message
profile.proto:335optional account_identifier = 1
The ACI of the account for which to get a profile key credential.
bytes credential_request = 2
A zkgroup request for a profile key credential for the target’s current profile.
CredentialType credential_type = 3
The type of credential being requested.
bytes unidentified_access_key = 4
The unidentified access key for the targeted account.
message
profile.proto:352oneof response
result = 1
not_found = 2
Indicates the account was not found or the account's current profile was not found. Use `AccountsAnonymous.CheckAccountExistence` for a canonical account existence check.
failed_unidentified_authorization = 3
The provided unidentified access key was incorrect
message
profile.proto:220Used in: ,
bytes identity_key = 1
The account identity key of the targeted account.
bytes unidentified_access_key_fingerprint = 2
A checksum of the unidentified access key for the targeted account.
bool unrestricted_unidentified_access = 3
Whether the account has enabled sealed sender from anyone.
repeated string badge_ids = 4
A list of the badges ids associated with the account. Metadata to display badges may be obtained by cross-referencing badge ids with RemoteConfiguration.GetBadges.
Used in:
CREDENTIAL_TYPE_UNSPECIFIED = 0
CREDENTIAL_TYPE_EXPIRING_PROFILE_KEY = 1
message
profile.proto:346Used in:
bytes profile_key_credential = 1
A zkgroup credential used by a client to prove that it has the profile key of a targeted account.
message
profile.proto:196Used as request type in: Profile.GetProfile
Used as field type in:
optional account_identifier = 1
The ACI of the account for which to get profile data.
bytes version = 2
The profile version to retrieve.
bytes etag = 3
The `etag` from the previous request for this Profile version. If unchanged, the response will omit `profile` and `etag_matched` will be `true`.
message
profile.proto:275Used in: ,
bytes name = 1
The ciphertext of the name on the profile.
bytes about = 2
The ciphertext of the description on the profile.
bytes about_emoji = 3
The ciphertext of the emoji on the profile.
string avatar = 4
The cdn0 path of the avatar on the profile.
bytes phone_number_sharing = 5
The ciphertext of the phone-number sharing setting on the profile.
bytes payment_address = 6
The ciphertext of the MobileCoin wallet ID on the profile.
optional account_info = 7
Information about the targeted account
message
profile.proto:160Indicates that the account is not permitted to set a payment address, due to a disallowed country prefix on the account's phone number.
Used in:
(message has no fields)
message
profile.proto:236Used in: ,
bytes data = 1
The ciphertext of the requested version of the profile
bytes payment_address = 2
The ciphertext of the MobileCoin wallet ID on the profile.
optional account_info = 3
Information about the targeted account
bytes etag = 4
An entity tag for the profile. This may be used in subsequent requests for this profile version to optimize bandwidth. Note that this hash will not match the expected_data_hash used on SetProfile for concurrency control. Clients may validate that the value has been correctly calculated by calculating a 10-byte truncated TupleHash256 as follows: ``` TupleHash256(S = "ProfileETag/v1", L = 80 bits, tuple = [ data, payment_address, account_info.identity_key, account_info.unidentified_access_key_fingerprint, account_info.unrestricted_unidentified_access ? 0x01 : 0x00, uint32BE(count(account_info.badge_ids)), utf8(id) for each id in sortLexAscendingByUtf8Bytes(account_info.badge_ids), ]) ``` Absent/empty fields contribute an empty element (not zero bytes omitted): a missing payment_address is still a present, zero-length tuple element. This etag will always exclusively cover the documented fields. If fields are added in the future, a new etag field must be introduced.
message
profile.proto:164Indicates that the account does not have the Profiles v2 capability, which is required to call Profiles.SetProfile
(message has no fields)
message
profile.proto:167Used in:
optional v1_avatar_upload_form = 15
If the request included a v1 avatar change, this field contains the policy and credential used by clients to upload an avatar to the CDN. Because this is a temporary field during the migration, it has the highest field number without serialization overhead. This is purely aesthetic.
message
profile.proto:81Used in:
bytes name = 1
The ciphertext of a name that users must set on the profile.
SetProfileV1Request.AvatarChange avatar_change = 2
An enum to indicate what change, if any, is made to the avatar with this request.
bytes about_emoji = 3
The ciphertext of an emoji that users can set on their profile.
bytes about = 4
The ciphertext of a description that users can set on their profile.
bytes phone_number_sharing = 6
The ciphertext of the phone-number sharing setting on the profile. 29-byte encrypted boolean.
Used in:
AVATAR_CHANGE_UNCHANGED = 0
AVATAR_CHANGE_CLEAR = 1
AVATAR_CHANGE_UPDATE = 2