Skip to content

Commit

Permalink
Rename 'userAgent' to 'signalAgent'.
Browse files Browse the repository at this point in the history
This wasn't actually being used in the User-Agent header. Instead, it
was used as the value for an X-Signal-Agent header. To avoid confusion,
I'm renaming this.
  • Loading branch information
greyson-signal committed Jan 27, 2020
1 parent f1147c1 commit a31da76
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 34 deletions.
2 changes: 1 addition & 1 deletion app/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ android {
buildConfigField "String", "SIGNAL_KEY_BACKUP_URL", "\"https://api.backup.signal.org\""
buildConfigField "String", "CONTENT_PROXY_HOST", "\"contentproxy.signal.org\""
buildConfigField "int", "CONTENT_PROXY_PORT", "443"
buildConfigField "String", "USER_AGENT", "\"OWA\""
buildConfigField "String", "SIGNAL_AGENT", "\"OWA\""
buildConfigField "boolean", "DEV_BUILD", "false"
buildConfigField "String", "MRENCLAVE", "\"cd6cfc342937b23b1bdd3bbf9721aa5615ac9ff50a75c5527d441cd3276826c9\""
buildConfigField "String", "KEY_BACKUP_ENCLAVE_NAME", "\"\""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,15 @@ public ApplicationDependencyProvider(@NonNull Application context, @NonNull Sign
public @NonNull SignalServiceAccountManager provideSignalServiceAccountManager() {
return new SignalServiceAccountManager(networkAccess.getConfiguration(context),
new DynamicCredentialsProvider(context),
BuildConfig.USER_AGENT);
BuildConfig.SIGNAL_AGENT);
}

@Override
public @NonNull SignalServiceMessageSender provideSignalServiceMessageSender() {
return new SignalServiceMessageSender(networkAccess.getConfiguration(context),
new DynamicCredentialsProvider(context),
new SignalProtocolStoreImpl(context),
BuildConfig.USER_AGENT,
BuildConfig.SIGNAL_AGENT,
TextSecurePreferences.isMultiDevice(context),
Optional.fromNullable(IncomingMessageObserver.getPipe()),
Optional.fromNullable(IncomingMessageObserver.getUnidentifiedPipe()),
Expand All @@ -78,7 +78,7 @@ public ApplicationDependencyProvider(@NonNull Application context, @NonNull Sign
: new UptimeSleepTimer();
return new SignalServiceMessageReceiver(networkAccess.getConfiguration(context),
new DynamicCredentialsProvider(context),
BuildConfig.USER_AGENT,
BuildConfig.SIGNAL_AGENT,
new PipeConnectivityListener(),
sleepTimer);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public class AccountManagerFactory {
}

return new SignalServiceAccountManager(new SignalServiceNetworkAccess(context).getConfiguration(number),
uuid, number, password, BuildConfig.USER_AGENT);
uuid, number, password, BuildConfig.SIGNAL_AGENT);
}

/**
Expand All @@ -57,7 +57,7 @@ public class AccountManagerFactory {
}

return new SignalServiceAccountManager(new SignalServiceNetworkAccess(context).getConfiguration(number),
null, number, password, BuildConfig.USER_AGENT);
null, number, password, BuildConfig.SIGNAL_AGENT);
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -95,22 +95,22 @@ public class SignalServiceAccountManager {
* @param uuid The Signal Service UUID.
* @param e164 The Signal Service phone number.
* @param password A Signal Service password.
* @param userAgent A string which identifies the client software.
* @param signalAgent A string which identifies the client software.
*/
public SignalServiceAccountManager(SignalServiceConfiguration configuration,
UUID uuid, String e164, String password,
String userAgent)
String signalAgent)
{
this(configuration, new StaticCredentialsProvider(uuid, e164, password, null), userAgent);
this(configuration, new StaticCredentialsProvider(uuid, e164, password, null), signalAgent);
}

public SignalServiceAccountManager(SignalServiceConfiguration configuration,
CredentialsProvider credentialsProvider,
String userAgent)
String signalAgent)
{
this.pushServiceSocket = new PushServiceSocket(configuration, credentialsProvider, userAgent);
this.pushServiceSocket = new PushServiceSocket(configuration, credentialsProvider, signalAgent);
this.credentials = credentialsProvider;
this.userAgent = userAgent;
this.userAgent = signalAgent;
}

public byte[] getSenderCertificate() throws IOException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public class SignalServiceMessageReceiver {
private final PushServiceSocket socket;
private final SignalServiceConfiguration urls;
private final CredentialsProvider credentialsProvider;
private final String userAgent;
private final String signalAgent;
private final ConnectivityListener connectivityListener;
private final SleepTimer sleepTimer;

Expand All @@ -66,11 +66,11 @@ public class SignalServiceMessageReceiver {
*/
public SignalServiceMessageReceiver(SignalServiceConfiguration urls,
UUID uuid, String e164, String password,
String signalingKey, String userAgent,
String signalingKey, String signalAgent,
ConnectivityListener listener,
SleepTimer timer)
{
this(urls, new StaticCredentialsProvider(uuid, e164, password, signalingKey), userAgent, listener, timer);
this(urls, new StaticCredentialsProvider(uuid, e164, password, signalingKey), signalAgent, listener, timer);
}

/**
Expand All @@ -81,14 +81,14 @@ public SignalServiceMessageReceiver(SignalServiceConfiguration urls,
*/
public SignalServiceMessageReceiver(SignalServiceConfiguration urls,
CredentialsProvider credentials,
String userAgent,
String signalAgent,
ConnectivityListener listener,
SleepTimer timer)
{
this.urls = urls;
this.credentialsProvider = credentials;
this.socket = new PushServiceSocket(urls, credentials, userAgent);
this.userAgent = userAgent;
this.socket = new PushServiceSocket(urls, credentials, signalAgent);
this.signalAgent = signalAgent;
this.connectivityListener = listener;
this.sleepTimer = timer;
}
Expand Down Expand Up @@ -199,7 +199,7 @@ public SignalServiceStickerManifest retrieveStickerManifest(byte[] packId, byte[
public SignalServiceMessagePipe createMessagePipe() {
WebSocketConnection webSocket = new WebSocketConnection(urls.getSignalServiceUrls()[0].getUrl(),
urls.getSignalServiceUrls()[0].getTrustStore(),
Optional.of(credentialsProvider), userAgent, connectivityListener,
Optional.of(credentialsProvider), signalAgent, connectivityListener,
sleepTimer);

return new SignalServiceMessagePipe(webSocket, Optional.of(credentialsProvider));
Expand All @@ -208,7 +208,7 @@ public SignalServiceMessagePipe createMessagePipe() {
public SignalServiceMessagePipe createUnidentifiedMessagePipe() {
WebSocketConnection webSocket = new WebSocketConnection(urls.getSignalServiceUrls()[0].getUrl(),
urls.getSignalServiceUrls()[0].getTrustStore(),
Optional.<CredentialsProvider>absent(), userAgent, connectivityListener,
Optional.<CredentialsProvider>absent(), signalAgent, connectivityListener,
sleepTimer);

return new SignalServiceMessagePipe(webSocket, Optional.of(credentialsProvider));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,25 +118,25 @@ public class SignalServiceMessageSender {
public SignalServiceMessageSender(SignalServiceConfiguration urls,
UUID uuid, String e164, String password,
SignalProtocolStore store,
String userAgent,
String signalAgent,
boolean isMultiDevice,
Optional<SignalServiceMessagePipe> pipe,
Optional<SignalServiceMessagePipe> unidentifiedPipe,
Optional<EventListener> eventListener)
{
this(urls, new StaticCredentialsProvider(uuid, e164, password, null), store, userAgent, isMultiDevice, pipe, unidentifiedPipe, eventListener);
this(urls, new StaticCredentialsProvider(uuid, e164, password, null), store, signalAgent, isMultiDevice, pipe, unidentifiedPipe, eventListener);
}

public SignalServiceMessageSender(SignalServiceConfiguration urls,
CredentialsProvider credentialsProvider,
SignalProtocolStore store,
String userAgent,
String signalAgent,
boolean isMultiDevice,
Optional<SignalServiceMessagePipe> pipe,
Optional<SignalServiceMessagePipe> unidentifiedPipe,
Optional<EventListener> eventListener)
{
this.socket = new PushServiceSocket(urls, credentialsProvider, userAgent);
this.socket = new PushServiceSocket(urls, credentialsProvider, signalAgent);
this.store = store;
this.localAddress = new SignalServiceAddress(credentialsProvider.getUuid(), credentialsProvider.getE164());
this.pipe = new AtomicReference<>(pipe);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,12 +168,12 @@ public class PushServiceSocket {
private final OkHttpClient attachmentClient;

private final CredentialsProvider credentialsProvider;
private final String userAgent;
private final String signalAgent;
private final SecureRandom random;

public PushServiceSocket(SignalServiceConfiguration signalServiceConfiguration, CredentialsProvider credentialsProvider, String userAgent) {
public PushServiceSocket(SignalServiceConfiguration signalServiceConfiguration, CredentialsProvider credentialsProvider, String signalAgent) {
this.credentialsProvider = credentialsProvider;
this.userAgent = userAgent;
this.signalAgent = signalAgent;
this.serviceClients = createServiceConnectionHolders(signalServiceConfiguration.getSignalServiceUrls());
this.cdnClients = createConnectionHolders(signalServiceConfiguration.getSignalCdnUrls());
this.contactDiscoveryClients = createConnectionHolders(signalServiceConfiguration.getSignalContactDiscoveryUrls());
Expand Down Expand Up @@ -1068,8 +1068,8 @@ private Response getServiceConnection(String urlFragment, String method, String
}
}

if (userAgent != null) {
request.addHeader("X-Signal-Agent", userAgent);
if (signalAgent != null) {
request.addHeader("X-Signal-Agent", signalAgent);
}

if (connectionHolder.getHostHeader().isPresent()) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public class WebSocketConnection extends WebSocketListener {
private final String wsUri;
private final TrustStore trustStore;
private final Optional<CredentialsProvider> credentialsProvider;
private final String userAgent;
private final String signalAgent;
private final ConnectivityListener listener;
private final SleepTimer sleepTimer;

Expand All @@ -66,13 +66,13 @@ public class WebSocketConnection extends WebSocketListener {
public WebSocketConnection(String httpUri,
TrustStore trustStore,
Optional<CredentialsProvider> credentialsProvider,
String userAgent,
String signalAgent,
ConnectivityListener listener,
SleepTimer timer)
{
this.trustStore = trustStore;
this.credentialsProvider = credentialsProvider;
this.userAgent = userAgent;
this.signalAgent = signalAgent;
this.listener = listener;
this.sleepTimer = timer;
this.attempts = 0;
Expand Down Expand Up @@ -108,8 +108,8 @@ public synchronized void connect() {

Request.Builder requestBuilder = new Request.Builder().url(filledUri);

if (userAgent != null) {
requestBuilder.addHeader("X-Signal-Agent", userAgent);
if (signalAgent != null) {
requestBuilder.addHeader("X-Signal-Agent", signalAgent);
}

if (listener != null) {
Expand Down

0 comments on commit a31da76

Please sign in to comment.