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