package org.signal.chat.credentials

Get desktop application:
View/edit binary Protocol Buffers messages

Provides methods for obtaining and verifying credentials that allow an authenticated user to authenticate in another service or context without revealing their identity.

• rpc GetCreateCallLinkCredential (GetCreateCallLinkCredentialRequest, GetCreateCallLinkCredentialResponse)

  credentials.proto:37

  Generates zero-knowledge credentials for creating call links.

  message GetCreateCallLinkCredentialRequest

  credentials.proto:147

  • bytes credential_request = 1

    A zero-knowledge credential request

  message GetCreateCallLinkCredentialResponse

  credentials.proto:152

  • bytes credential = 1

    A zero-knowledge credential that may be redeemed at or up to one day after the given redemption time

• rpc GetDeliveryCertificate (GetDeliveryCertificateRequest, GetDeliveryCertificateResponse)

  credentials.proto:28

  Generates a pair of delivery certificates that the holder can include to identify themselves to a message recipient (but not the server) in a sealed-sender message.

  message GetDeliveryCertificateRequest

  credentials.proto:105

  (message has no fields)

  message GetDeliveryCertificateResponse

  credentials.proto:112

  A pair of message delivery certificates. The response unconditionally includes certificates with and without the caller's phone number so the server never learns anything about the caller's intent to share their phone number with their contacts.

  • bytes certificate_with_e164 = 1

    A delivery receipt that includes the caller's phone number; may be empty if the authenticated account does not have a phone number

  • bytes certificate_without_e164 = 2

    A delivery receipt that does not include the caller's phone number

• rpc GetExternalServiceCredentials (GetExternalServiceCredentialsRequest, GetExternalServiceCredentialsResponse)

  credentials.proto:22

  Generates and returns an external service credentials for the caller.

  message GetExternalServiceCredentialsRequest

  credentials.proto:62

  • ExternalServiceType externalService = 1

    A service to request credentials for.

  message GetExternalServiceCredentialsResponse

  credentials.proto:67

  • string username = 1

    A username that can be presented to authenticate with the external service.

  • string password = 2

    A password that can be presented to authenticate with the external service.

• rpc GetGroupCredentials (GetGroupCredentialsRequest, GetGroupCredentialsResponse)

  credentials.proto:33

  Generates a set of zero-knowledge credentials for various group-related actions.

  message GetGroupCredentialsRequest

  credentials.proto:121

  • uint64 redemption_start_seconds = 1

    The earliest time for which to issue group credentials; must be aligned to a UTC day boundary and may be no more than one day in the past at the time of the call.

  • uint64 redemption_end_seconds = 2

    The latest time for which to issue group credentials; must be aligned to a UTC day boundary and no more than seven days in the future at the time of the call.

  message GetGroupCredentialsResponse

  credentials.proto:133

  • repeated common.ZkCredential group_credentials = 1

    A collection of credentials allowing the holder to anonymously authenticate themselves for group-related actions

  • repeated common.ZkCredential call_link_auth_credentials = 2

    A collection of credentials allowing the holder to read, update, and delete group call links

  • bytes pni = 3

    The phone number identifier for which the included credentials were generated. Empty if the account does not have a phone number.

Provides methods for working with previously-generated credentials without revealing an association between the credentials and the caller's identity to the server.

• rpc CheckSvrCredentials (CheckSvrCredentialsRequest, CheckSvrCredentialsResponse)

  credentials.proto:50

  Given a list of secure value recovery (SVR) service credentials and a phone number, checks and returns which of the provided credentials were generated by the user with the given phone number and have not yet expired.

  message CheckSvrCredentialsRequest

  credentials.proto:88

  • string number = 1

    A phone number in the E164 format to check the passwords against. Only passwords generated for the user associated with the given number will be marked as `AUTH_CHECK_RESULT_MATCH`.

  • repeated string passwords = 2

    A list of credentials from previously made calls to `ExternalServiceCredentials.GetExternalServiceCredentials()` for `EXTERNAL_SERVICE_TYPE_SVR`. This list may contain credentials generated by different users. Up to 10 credentials can be checked.

  message CheckSvrCredentialsResponse

  credentials.proto:100

  For each of the credentials tokens in the `CheckSvrCredentialsRequest` contains the result of the check.

  • map<string, AuthCheckResult> matches = 1

Used in: CheckSvrCredentialsResponse

• AUTH_CHECK_RESULT_UNSPECIFIED = 0

• AUTH_CHECK_RESULT_MATCH = 1

  The credentials could be used to make a call to SVR service by the user associated with the `CheckSvrCredentialsRequest.number` phone number.

• AUTH_CHECK_RESULT_NO_MATCH = 2

  The credentials were generated by a different user.

• AUTH_CHECK_RESULT_INVALID = 3

  This status indicates that the corresponding credentials token should no longer be used. This may be because it has expired or invalid, but it can also mean that there is a more recent token in the request which should be used instead.

Used in: GetExternalServiceCredentialsRequest

• EXTERNAL_SERVICE_TYPE_UNSPECIFIED = 0

• EXTERNAL_SERVICE_TYPE_DIRECTORY = 1

• EXTERNAL_SERVICE_TYPE_PAYMENTS = 2

• EXTERNAL_SERVICE_TYPE_STORAGE = 3

• EXTERNAL_SERVICE_TYPE_SVR = 4