CaptivePortalLoginActivity.java revision fd11ce5fafeb599822f6a0b6a4071a8cf6ccc01a
1/* 2 * Copyright (C) 2017 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package com.android.carrierdefaultapp; 18 19import android.app.Activity; 20import android.app.LoadedApk; 21import android.content.Context; 22import android.content.Intent; 23import android.graphics.Bitmap; 24import android.net.ConnectivityManager; 25import android.net.ConnectivityManager.NetworkCallback; 26import android.net.Network; 27import android.net.NetworkCapabilities; 28import android.net.NetworkRequest; 29import android.net.Proxy; 30import android.net.TrafficStats; 31import android.net.Uri; 32import android.net.http.SslError; 33import android.os.Bundle; 34import android.telephony.CarrierConfigManager; 35import android.telephony.Rlog; 36import android.telephony.SubscriptionManager; 37import android.util.ArrayMap; 38import android.util.Log; 39import android.util.TypedValue; 40import android.webkit.SslErrorHandler; 41import android.webkit.WebChromeClient; 42import android.webkit.WebSettings; 43import android.webkit.WebView; 44import android.webkit.WebViewClient; 45import android.widget.ProgressBar; 46import android.widget.TextView; 47 48import com.android.internal.telephony.PhoneConstants; 49import com.android.internal.telephony.TelephonyIntents; 50import com.android.internal.util.ArrayUtils; 51 52import java.io.IOException; 53import java.lang.reflect.Field; 54import java.lang.reflect.Method; 55import java.net.HttpURLConnection; 56import java.net.MalformedURLException; 57import java.net.URL; 58import java.util.Random; 59 60/** 61 * Activity that launches in response to the captive portal notification 62 * @see com.android.carrierdefaultapp.CarrierActionUtils#CARRIER_ACTION_SHOW_PORTAL_NOTIFICATION 63 * This activity requests network connection if there is no available one before loading the real 64 * portal page and apply carrier actions on the portal activation result. 65 */ 66public class CaptivePortalLoginActivity extends Activity { 67 private static final String TAG = CaptivePortalLoginActivity.class.getSimpleName(); 68 private static final boolean DBG = true; 69 70 private static final int SOCKET_TIMEOUT_MS = 10 * 1000; 71 public static final int NETWORK_REQUEST_TIMEOUT_MS = 5 * 1000; 72 73 private URL mUrl; 74 private Network mNetwork; 75 private NetworkCallback mNetworkCallback; 76 private ConnectivityManager mCm; 77 private WebView mWebView; 78 private MyWebViewClient mWebViewClient; 79 private boolean mLaunchBrowser = false; 80 81 @Override 82 protected void onCreate(Bundle savedInstanceState) { 83 super.onCreate(savedInstanceState); 84 mCm = ConnectivityManager.from(this); 85 mUrl = getUrlForCaptivePortal(); 86 if (mUrl == null) { 87 done(false); 88 return; 89 } 90 if (DBG) logd(String.format("onCreate for %s", mUrl.toString())); 91 setContentView(R.layout.activity_captive_portal_login); 92 getActionBar().setDisplayShowHomeEnabled(false); 93 94 mWebView = findViewById(R.id.webview); 95 mWebView.clearCache(true); 96 WebSettings webSettings = mWebView.getSettings(); 97 webSettings.setJavaScriptEnabled(true); 98 webSettings.setMixedContentMode(WebSettings.MIXED_CONTENT_COMPATIBILITY_MODE); 99 webSettings.setUseWideViewPort(true); 100 webSettings.setLoadWithOverviewMode(true); 101 webSettings.setSupportZoom(true); 102 webSettings.setBuiltInZoomControls(true); 103 mWebViewClient = new MyWebViewClient(); 104 mWebView.setWebViewClient(mWebViewClient); 105 mWebView.setWebChromeClient(new MyWebChromeClient()); 106 107 mNetwork = getNetworkForCaptivePortal(); 108 if (mNetwork == null) { 109 requestNetworkForCaptivePortal(); 110 } else { 111 mCm.bindProcessToNetwork(mNetwork); 112 // Start initial page load so WebView finishes loading proxy settings. 113 // Actual load of mUrl is initiated by MyWebViewClient. 114 mWebView.loadData("", "text/html", null); 115 } 116 } 117 118 @Override 119 public void onBackPressed() { 120 WebView myWebView = findViewById(R.id.webview); 121 if (myWebView.canGoBack() && mWebViewClient.allowBack()) { 122 myWebView.goBack(); 123 } else { 124 super.onBackPressed(); 125 } 126 } 127 128 @Override 129 public void onDestroy() { 130 super.onDestroy(); 131 releaseNetworkRequest(); 132 if (mLaunchBrowser) { 133 // Give time for this network to become default. After 500ms just proceed. 134 for (int i = 0; i < 5; i++) { 135 // TODO: This misses when mNetwork underlies a VPN. 136 if (mNetwork.equals(mCm.getActiveNetwork())) break; 137 try { 138 Thread.sleep(100); 139 } catch (InterruptedException e) { 140 } 141 } 142 final String url = mUrl.toString(); 143 if (DBG) logd("starting activity with intent ACTION_VIEW for " + url); 144 startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse(url))); 145 } 146 } 147 148 // Find WebView's proxy BroadcastReceiver and prompt it to read proxy system properties. 149 private void setWebViewProxy() { 150 LoadedApk loadedApk = getApplication().mLoadedApk; 151 try { 152 Field receiversField = LoadedApk.class.getDeclaredField("mReceivers"); 153 receiversField.setAccessible(true); 154 ArrayMap receivers = (ArrayMap) receiversField.get(loadedApk); 155 for (Object receiverMap : receivers.values()) { 156 for (Object rec : ((ArrayMap) receiverMap).keySet()) { 157 Class clazz = rec.getClass(); 158 if (clazz.getName().contains("ProxyChangeListener")) { 159 Method onReceiveMethod = clazz.getDeclaredMethod("onReceive", Context.class, 160 Intent.class); 161 Intent intent = new Intent(Proxy.PROXY_CHANGE_ACTION); 162 onReceiveMethod.invoke(rec, getApplicationContext(), intent); 163 Log.v(TAG, "Prompting WebView proxy reload."); 164 } 165 } 166 } 167 } catch (Exception e) { 168 loge("Exception while setting WebView proxy: " + e); 169 } 170 } 171 172 private void done(boolean success) { 173 if (DBG) logd(String.format("Result success %b for %s", success, 174 mUrl != null ? mUrl.toString() : "null")); 175 if (success) { 176 // Trigger re-evaluation upon success http response code 177 CarrierActionUtils.applyCarrierAction( 178 CarrierActionUtils.CARRIER_ACTION_ENABLE_RADIO, getIntent(), 179 getApplicationContext()); 180 CarrierActionUtils.applyCarrierAction( 181 CarrierActionUtils.CARRIER_ACTION_ENABLE_METERED_APNS, getIntent(), 182 getApplicationContext()); 183 CarrierActionUtils.applyCarrierAction( 184 CarrierActionUtils.CARRIER_ACTION_CANCEL_ALL_NOTIFICATIONS, getIntent(), 185 getApplicationContext()); 186 187 } 188 finishAndRemoveTask(); 189 } 190 191 private URL getUrlForCaptivePortal() { 192 String url = getIntent().getStringExtra(TelephonyIntents.EXTRA_REDIRECTION_URL_KEY); 193 if (url.isEmpty()) { 194 url = mCm.getCaptivePortalServerUrl(); 195 } 196 final CarrierConfigManager configManager = getApplicationContext() 197 .getSystemService(CarrierConfigManager.class); 198 final int subId = getIntent().getIntExtra(PhoneConstants.SUBSCRIPTION_KEY, 199 SubscriptionManager.getDefaultVoiceSubscriptionId()); 200 final String[] portalURLs = configManager.getConfigForSubId(subId).getStringArray( 201 CarrierConfigManager.KEY_CARRIER_DEFAULT_REDIRECTION_URL_STRING_ARRAY); 202 if (!ArrayUtils.isEmpty(portalURLs)) { 203 for (String portalUrl : portalURLs) { 204 if (url.startsWith(portalUrl)) { 205 break; 206 } 207 } 208 url = null; 209 } 210 try { 211 return new URL(url); 212 } catch (MalformedURLException e) { 213 loge("Invalid captive portal URL " + url); 214 } 215 return null; 216 } 217 218 private void testForCaptivePortal() { 219 new Thread(new Runnable() { 220 public void run() { 221 // Give time for captive portal to open. 222 try { 223 Thread.sleep(1000); 224 } catch (InterruptedException e) { 225 } 226 HttpURLConnection urlConnection = null; 227 int httpResponseCode = 500; 228 int oldTag = TrafficStats.getAndSetThreadStatsTag(TrafficStats.TAG_SYSTEM_PROBE); 229 try { 230 urlConnection = (HttpURLConnection) mNetwork.openConnection(mUrl); 231 urlConnection.setInstanceFollowRedirects(false); 232 urlConnection.setConnectTimeout(SOCKET_TIMEOUT_MS); 233 urlConnection.setReadTimeout(SOCKET_TIMEOUT_MS); 234 urlConnection.setUseCaches(false); 235 urlConnection.getInputStream(); 236 httpResponseCode = urlConnection.getResponseCode(); 237 } catch (IOException e) { 238 } finally { 239 if (urlConnection != null) urlConnection.disconnect(); 240 TrafficStats.setThreadStatsTag(oldTag); 241 } 242 if (httpResponseCode == 204) { 243 done(true); 244 } 245 } 246 }).start(); 247 } 248 249 private Network getNetworkForCaptivePortal() { 250 Network[] info = mCm.getAllNetworks(); 251 if (!ArrayUtils.isEmpty(info)) { 252 for (Network nw : info) { 253 final NetworkCapabilities nc = mCm.getNetworkCapabilities(nw); 254 if (nc.hasTransport(NetworkCapabilities.TRANSPORT_CELLULAR) 255 && nc.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)) { 256 return nw; 257 } 258 } 259 } 260 return null; 261 } 262 263 private void requestNetworkForCaptivePortal() { 264 NetworkRequest request = new NetworkRequest.Builder() 265 .addTransportType(NetworkCapabilities.TRANSPORT_CELLULAR) 266 .addCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET) 267 .removeCapability(NetworkCapabilities.NET_CAPABILITY_NOT_RESTRICTED) 268 .build(); 269 270 mNetworkCallback = new ConnectivityManager.NetworkCallback() { 271 @Override 272 public void onAvailable(Network network) { 273 if (DBG) logd("Network available: " + network); 274 mCm.bindProcessToNetwork(network); 275 mNetwork = network; 276 runOnUiThreadIfNotFinishing(() -> { 277 // Start initial page load so WebView finishes loading proxy settings. 278 // Actual load of mUrl is initiated by MyWebViewClient. 279 mWebView.loadData("", "text/html", null); 280 }); 281 } 282 283 @Override 284 public void onUnavailable() { 285 if (DBG) logd("Network unavailable"); 286 runOnUiThreadIfNotFinishing(() -> { 287 // Instead of not loading anything in webview, simply load the page and return 288 // HTTP error page in the absence of network connection. 289 mWebView.loadUrl(mUrl.toString()); 290 }); 291 } 292 }; 293 logd("request Network for captive portal"); 294 mCm.requestNetwork(request, mNetworkCallback, NETWORK_REQUEST_TIMEOUT_MS); 295 } 296 297 private void releaseNetworkRequest() { 298 logd("release Network for captive portal"); 299 if (mNetworkCallback != null) { 300 mCm.unregisterNetworkCallback(mNetworkCallback); 301 mNetworkCallback = null; 302 mNetwork = null; 303 } 304 } 305 306 private class MyWebViewClient extends WebViewClient { 307 private static final String INTERNAL_ASSETS = "file:///android_asset/"; 308 private final String mBrowserBailOutToken = Long.toString(new Random().nextLong()); 309 // How many Android device-independent-pixels per scaled-pixel 310 // dp/sp = (px/sp) / (px/dp) = (1/sp) / (1/dp) 311 private final float mDpPerSp = TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_SP, 1, 312 getResources().getDisplayMetrics()) 313 / TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, 1, 314 getResources().getDisplayMetrics()); 315 private int mPagesLoaded; 316 317 // If we haven't finished cleaning up the history, don't allow going back. 318 public boolean allowBack() { 319 return mPagesLoaded > 1; 320 } 321 322 @Override 323 public void onPageStarted(WebView view, String url, Bitmap favicon) { 324 if (url.contains(mBrowserBailOutToken)) { 325 mLaunchBrowser = true; 326 done(false); 327 return; 328 } 329 // The first page load is used only to cause the WebView to 330 // fetch the proxy settings. Don't update the URL bar, and 331 // don't check if the captive portal is still there. 332 if (mPagesLoaded == 0) return; 333 // For internally generated pages, leave URL bar listing prior URL as this is the URL 334 // the page refers to. 335 if (!url.startsWith(INTERNAL_ASSETS)) { 336 final TextView myUrlBar = findViewById(R.id.url_bar); 337 myUrlBar.setText(url); 338 } 339 if (mNetwork != null) { 340 testForCaptivePortal(); 341 } 342 } 343 344 @Override 345 public void onPageFinished(WebView view, String url) { 346 mPagesLoaded++; 347 if (mPagesLoaded == 1) { 348 // Now that WebView has loaded at least one page we know it has read in the proxy 349 // settings. Now prompt the WebView read the Network-specific proxy settings. 350 setWebViewProxy(); 351 // Load the real page. 352 view.loadUrl(mUrl.toString()); 353 return; 354 } else if (mPagesLoaded == 2) { 355 // Prevent going back to empty first page. 356 view.clearHistory(); 357 } 358 if (mNetwork != null) { 359 testForCaptivePortal(); 360 } 361 } 362 363 // Convert Android device-independent-pixels (dp) to HTML size. 364 private String dp(int dp) { 365 // HTML px's are scaled just like dp's, so just add "px" suffix. 366 return Integer.toString(dp) + "px"; 367 } 368 369 // Convert Android scaled-pixels (sp) to HTML size. 370 private String sp(int sp) { 371 // Convert sp to dp's. 372 float dp = sp * mDpPerSp; 373 // Apply a scale factor to make things look right. 374 dp *= 1.3; 375 // Convert dp's to HTML size. 376 return dp((int) dp); 377 } 378 379 // A web page consisting of a large broken lock icon to indicate SSL failure. 380 private final String SSL_ERROR_HTML = "<html><head><style>" 381 + "body { margin-left:" + dp(48) + "; margin-right:" + dp(48) + "; " 382 + "margin-top:" + dp(96) + "; background-color:#fafafa; }" 383 + "img { width:" + dp(48) + "; height:" + dp(48) + "; }" 384 + "div.warn { font-size:" + sp(16) + "; margin-top:" + dp(16) + "; " 385 + " opacity:0.87; line-height:1.28; }" 386 + "div.example { font-size:" + sp(14) + "; margin-top:" + dp(16) + "; " 387 + " opacity:0.54; line-height:1.21905; }" 388 + "a { font-size:" + sp(14) + "; text-decoration:none; text-transform:uppercase; " 389 + " margin-top:" + dp(24) + "; display:inline-block; color:#4285F4; " 390 + " height:" + dp(48) + "; font-weight:bold; }" 391 + "</style></head><body><p><img src=quantum_ic_warning_amber_96.png><br>" 392 + "<div class=warn>%s</div>" 393 + "<div class=example>%s</div>" + "<a href=%s>%s</a></body></html>"; 394 395 @Override 396 public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) { 397 Log.w(TAG, "SSL error (error: " + error.getPrimaryError() + " host: " 398 // Only show host to avoid leaking private info. 399 + Uri.parse(error.getUrl()).getHost() + " certificate: " 400 + error.getCertificate() + "); displaying SSL warning."); 401 final String html = String.format(SSL_ERROR_HTML, getString(R.string.ssl_error_warning), 402 getString(R.string.ssl_error_example), mBrowserBailOutToken, 403 getString(R.string.ssl_error_continue)); 404 view.loadDataWithBaseURL(INTERNAL_ASSETS, html, "text/HTML", "UTF-8", null); 405 } 406 407 @Override 408 public boolean shouldOverrideUrlLoading(WebView view, String url) { 409 if (url.startsWith("tel:")) { 410 startActivity(new Intent(Intent.ACTION_DIAL, Uri.parse(url))); 411 return true; 412 } 413 return false; 414 } 415 } 416 417 private class MyWebChromeClient extends WebChromeClient { 418 @Override 419 public void onProgressChanged(WebView view, int newProgress) { 420 final ProgressBar myProgressBar = findViewById(R.id.progress_bar); 421 myProgressBar.setProgress(newProgress); 422 } 423 } 424 425 private void runOnUiThreadIfNotFinishing(Runnable r) { 426 if (!isFinishing()) { 427 runOnUiThread(r); 428 } 429 } 430 431 private static void logd(String s) { 432 Rlog.d(TAG, s); 433 } 434 435 private static void loge(String s) { 436 Rlog.d(TAG, s); 437 } 438 439} 440