org.whispersystems.signalservice.api

Class SignalServiceAccountManager

java.lang.Object

org.whispersystems.signalservice.api.SignalServiceAccountManager

public class SignalServiceAccountManager
extends java.lang.Object

The main interface for creating, registering, and managing a Signal Service account.

Constructor Summary

Constructors

Constructor and Description
SignalServiceAccountManager(java.lang.String url, TrustStore trustStore, java.lang.String user, java.lang.String password, java.lang.String userAgent) Construct a SignalServiceAccountManager.

Method Summary

Modifier and Type	Method and Description
void	addDevice(java.lang.String deviceIdentifier, org.whispersystems.libsignal.ecc.ECPublicKey deviceKey, org.whispersystems.libsignal.IdentityKeyPair identityKeyPair, java.lang.String code)
java.lang.String	getAccountVerificationToken()
org.whispersystems.libsignal.util.guava.Optional<ContactTokenDetails>	getContact(java.lang.String e164number) Checks whether a contact is currently registered with the server.
java.util.List<ContactTokenDetails>	getContacts(java.util.Set<java.lang.String> e164numbers) Checks which contacts in a set are registered with the server.
java.util.List<DeviceInfo>	getDevices()
java.lang.String	getNewDeviceVerificationCode()
int	getPreKeysCount()
SignedPreKeyEntity	getSignedPreKey()
void	removeDevice(long deviceId)
void	requestSmsVerificationCode() Request an SMS verification code.
void	requestVoiceVerificationCode() Request a Voice verification code.
void	setAccountAttributes(java.lang.String signalingKey, int signalProtocolRegistrationId, boolean voice) Refresh account attributes with server.
void	setGcmId(org.whispersystems.libsignal.util.guava.Optional<java.lang.String> gcmRegistrationId) Register/Unregister a Google Cloud Messaging registration ID.
void	setPreKeys(org.whispersystems.libsignal.IdentityKey identityKey, org.whispersystems.libsignal.state.PreKeyRecord lastResortKey, org.whispersystems.libsignal.state.SignedPreKeyRecord signedPreKey, java.util.List<org.whispersystems.libsignal.state.PreKeyRecord> oneTimePreKeys) Register an identity key, last resort key, signed prekey, and list of one time prekeys with the server.
void	setSignedPreKey(org.whispersystems.libsignal.state.SignedPreKeyRecord signedPreKey) Set the client's signed prekey.
void	verifyAccountWithCode(java.lang.String verificationCode, java.lang.String signalingKey, int signalProtocolRegistrationId, boolean voice) Verify a Signal Service account with a received SMS or voice verification code.
void	verifyAccountWithToken(java.lang.String verificationToken, java.lang.String signalingKey, int axolotlRegistrationId, boolean voice) Verify a Signal Service account with a signed token from a trusted source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SignalServiceAccountManager

public SignalServiceAccountManager(java.lang.String url,
                                   TrustStore trustStore,
                                   java.lang.String user,
                                   java.lang.String password,
                                   java.lang.String userAgent)

Construct a SignalServiceAccountManager.

Parameters:

url - The URL for the Signal Service.

trustStore - The TrustStore for the SignalService server's TLS certificate.

user - A Signal Service phone number.

password - A Signal Service password.

userAgent - A string which identifies the client software.

Method Detail

setGcmId

public void setGcmId(org.whispersystems.libsignal.util.guava.Optional<java.lang.String> gcmRegistrationId)
              throws java.io.IOException

Register/Unregister a Google Cloud Messaging registration ID.

Parameters:

gcmRegistrationId - The GCM id to register. A call with an absent value will unregister.

Throws:

java.io.IOException

requestSmsVerificationCode

public void requestSmsVerificationCode()
                                throws java.io.IOException

Request an SMS verification code. On success, the server will send an SMS verification code to this Signal user.

Throws:

java.io.IOException

requestVoiceVerificationCode

public void requestVoiceVerificationCode()
                                  throws java.io.IOException

Request a Voice verification code. On success, the server will make a voice call to this Signal user.

Throws:

java.io.IOException

verifyAccountWithCode

public void verifyAccountWithCode(java.lang.String verificationCode,
                                  java.lang.String signalingKey,
                                  int signalProtocolRegistrationId,
                                  boolean voice)
                           throws java.io.IOException

Verify a Signal Service account with a received SMS or voice verification code.

Parameters:

verificationCode - The verification code received via SMS or Voice (see requestSmsVerificationCode() and requestVoiceVerificationCode()).

signalingKey - 52 random bytes. A 32 byte AES key and a 20 byte Hmac256 key, concatenated.

signalProtocolRegistrationId - A random 14-bit number that identifies this Signal install. This value should remain consistent across registrations for the same install, but probabilistically differ across registrations for separate installs.

voice - A boolean that indicates whether the client supports secure voice (RedPhone) calls.

Throws:

java.io.IOException

verifyAccountWithToken

public void verifyAccountWithToken(java.lang.String verificationToken,
                                   java.lang.String signalingKey,
                                   int axolotlRegistrationId,
                                   boolean voice)
                            throws java.io.IOException

Verify a Signal Service account with a signed token from a trusted source.

Parameters:

verificationToken - The signed token provided by a trusted server.

signalingKey - 52 random bytes. A 32 byte AES key and a 20 byte Hmac256 key, concatenated.

axolotlRegistrationId - A random 14-bit number that identifies this Signal install. This value should remain consistent across registrations for the same install, but probabilistically differ across registrations for separate installs.

voice - A boolean that indicates whether the client supports secure voice (RedPhone) calls.

Throws:

java.io.IOException

setAccountAttributes

public void setAccountAttributes(java.lang.String signalingKey,
                                 int signalProtocolRegistrationId,
                                 boolean voice)
                          throws java.io.IOException

Refresh account attributes with server.

Parameters:

signalingKey - 52 random bytes. A 32 byte AES key and a 20 byte Hmac256 key, concatenated.

signalProtocolRegistrationId - A random 14-bit number that identifies this Signal install. This value should remain consistent across registrations for the same install, but probabilistically differ across registrations for separate installs.

voice - A boolean that indicates whether the client supports secure voice (RedPhone)

Throws:

java.io.IOException

setPreKeys

public void setPreKeys(org.whispersystems.libsignal.IdentityKey identityKey,
                       org.whispersystems.libsignal.state.PreKeyRecord lastResortKey,
                       org.whispersystems.libsignal.state.SignedPreKeyRecord signedPreKey,
                       java.util.List<org.whispersystems.libsignal.state.PreKeyRecord> oneTimePreKeys)
                throws java.io.IOException

Register an identity key, last resort key, signed prekey, and list of one time prekeys with the server.

Parameters:

identityKey - The client's long-term identity keypair.

lastResortKey - The client's "last resort" prekey.

signedPreKey - The client's signed prekey.

oneTimePreKeys - The client's list of one-time prekeys.

Throws:

java.io.IOException

getPreKeysCount

public int getPreKeysCount()
                    throws java.io.IOException

Returns:

The server's count of currently available (eg. unused) prekeys for this user.

Throws:

java.io.IOException

setSignedPreKey

public void setSignedPreKey(org.whispersystems.libsignal.state.SignedPreKeyRecord signedPreKey)
                     throws java.io.IOException

Set the client's signed prekey.

Parameters:

signedPreKey - The client's new signed prekey.

Throws:

java.io.IOException

getSignedPreKey

public SignedPreKeyEntity getSignedPreKey()
                                   throws java.io.IOException

Returns:

The server's view of the client's current signed prekey.

Throws:

java.io.IOException

getContact

public org.whispersystems.libsignal.util.guava.Optional<ContactTokenDetails> getContact(java.lang.String e164number)
                                                                                 throws java.io.IOException

Checks whether a contact is currently registered with the server.

Parameters:

e164number - The contact to check.

Returns:

An optional ContactTokenDetails, present if registered, absent if not.

Throws:

java.io.IOException

getContacts

public java.util.List<ContactTokenDetails> getContacts(java.util.Set<java.lang.String> e164numbers)
                                                throws java.io.IOException

Checks which contacts in a set are registered with the server.

Parameters:

e164numbers - The contacts to check.

Returns:

A list of ContactTokenDetails for the registered users.

Throws:

java.io.IOException

getAccountVerificationToken

public java.lang.String getAccountVerificationToken()
                                             throws java.io.IOException

Throws:

java.io.IOException

getNewDeviceVerificationCode

public java.lang.String getNewDeviceVerificationCode()
                                              throws java.io.IOException

Throws:

java.io.IOException

addDevice

public void addDevice(java.lang.String deviceIdentifier,
                      org.whispersystems.libsignal.ecc.ECPublicKey deviceKey,
                      org.whispersystems.libsignal.IdentityKeyPair identityKeyPair,
                      java.lang.String code)
               throws org.whispersystems.libsignal.InvalidKeyException,
                      java.io.IOException

Throws:

org.whispersystems.libsignal.InvalidKeyException

java.io.IOException

getDevices

public java.util.List<DeviceInfo> getDevices()
                                      throws java.io.IOException

Throws:

java.io.IOException

removeDevice

public void removeDevice(long deviceId)
                  throws java.io.IOException

Throws:

java.io.IOException