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