Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Java-WebSocket problem on Android below 24 #808

Merged
merged 5 commits into from
Jun 22, 2022
Merged

Fix Java-WebSocket problem on Android below 24 #808

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1f9b8e2
Fix Java-WebSocket problem on Android below 24
KacperKluka Jun 21, 2022
2999d2a
Do not explicitly call connectListener when hostname verification fai…
KacperKluka Jun 22, 2022
99927b0
Change SSLSession variable to a final one
KacperKluka Jun 22, 2022
8831ae3
Change hostname verification log level to verbose
KacperKluka Jun 22, 2022
f35c5b6
Do manual hostname verification only if the automatic one fails
KacperKluka Jun 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 40 additions & 2 deletions lib/src/main/java/io/ably/lib/transport/WebSocketTransport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@
import java.util.Timer;
import java.util.TimerTask;

import javax.net.ssl.HttpsURLConnection;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLParameters;
import javax.net.ssl.SSLSession;

import org.java_websocket.client.WebSocketClient;
import org.java_websocket.exceptions.WebsocketNotConnectedException;
Expand Down Expand Up @@ -147,8 +150,28 @@ class WsClient extends WebSocketClient {
@Override
public void onOpen(ServerHandshake handshakedata) {
Log.d(TAG, "onOpen()");
connectListener.onTransportAvailable(WebSocketTransport.this);
flagActivity();
if (shouldExplicitlyVerifyHostname && !isHostnameVerified(params.host)) {
close();
} else {
connectListener.onTransportAvailable(WebSocketTransport.this);
flagActivity();
}
}

/**
* Added because we had to override the onSetSSLParameters() that usually performs this verification.
* When the minSdkVersion will be updated to 24 we should remove this method and its usages.
* https://github.com/TooTallNate/Java-WebSocket/wiki/No-such-method-error-setEndpointIdentificationAlgorithm#workaround
*/
private boolean isHostnameVerified(String hostname) {
final SSLSession session = getSSLSession();
if (HttpsURLConnection.getDefaultHostnameVerifier().verify(hostname, session)) {
Log.v(TAG, "Successfully verified hostname");
return true;
} else {
Log.e(TAG, "Hostname verification failed, expected " + hostname + ", found " + session.getPeerHost());
return false;
}
}

@Override
Expand Down Expand Up @@ -234,6 +257,20 @@ public void onError(final Exception e) {
connectListener.onTransportUnavailable(WebSocketTransport.this, new ErrorInfo(e.getMessage(), 503, 80000));
}

@Override
protected void onSetSSLParameters(SSLParameters sslParameters) {
try {
super.onSetSSLParameters(sslParameters);
shouldExplicitlyVerifyHostname = false;
} catch (NoSuchMethodError exception) {
// This error will be thrown on Android below level 24.
// When the minSdkVersion will be updated to 24 we should remove this overridden method.
// https://github.com/TooTallNate/Java-WebSocket/wiki/No-such-method-error-setEndpointIdentificationAlgorithm#workaround
Log.w(TAG, "Error when trying to set SSL parameters, most likely due to an old Java API version", exception);
shouldExplicitlyVerifyHostname = true;
}
}

private synchronized void dispose() {
/* dispose timer */
try {
Expand Down Expand Up @@ -307,6 +344,7 @@ private synchronized void schedule(TimerTask task, long delay) {
private Timer timer = new Timer();
private TimerTask activityTimerTask = null;
private long lastActivityTime;
private boolean shouldExplicitlyVerifyHostname = true;
}

public String toString() {
Expand Down