Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2011 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 | |
| 17 | package android.net; |
| 18 | |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 19 | import static android.net.ConnectivityManager.TYPE_WIFI; |
| 20 | import static android.net.ConnectivityManager.getNetworkTypeName; |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 21 | import static android.net.ConnectivityManager.isNetworkTypeMobile; |
| 22 | |
| 23 | import android.content.Context; |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 24 | import android.net.wifi.WifiInfo; |
| 25 | import android.net.wifi.WifiManager; |
Jeff Sharkey | 02e21d6 | 2011-07-17 15:53:33 -0700 | [diff] [blame] | 26 | import android.os.Build; |
Makoto Onuki | da65a52 | 2017-01-13 10:23:30 -0800 | [diff] [blame] | 27 | import android.service.NetworkIdentityProto; |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 28 | import android.telephony.TelephonyManager; |
Jeff Sharkey | 3256601 | 2014-12-02 18:30:14 -0800 | [diff] [blame] | 29 | import android.util.Slog; |
Makoto Onuki | da65a52 | 2017-01-13 10:23:30 -0800 | [diff] [blame] | 30 | import android.util.proto.ProtoOutputStream; |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 31 | |
Kenny Root | e6585b3 | 2013-12-13 12:00:26 -0800 | [diff] [blame] | 32 | import java.util.Objects; |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 33 | |
| 34 | /** |
| 35 | * Network definition that includes strong identity. Analogous to combining |
| 36 | * {@link NetworkInfo} and an IMSI. |
| 37 | * |
| 38 | * @hide |
| 39 | */ |
Jeff Sharkey | 55a442e | 2014-11-18 18:22:21 -0800 | [diff] [blame] | 40 | public class NetworkIdentity implements Comparable<NetworkIdentity> { |
Jeff Sharkey | 3256601 | 2014-12-02 18:30:14 -0800 | [diff] [blame] | 41 | private static final String TAG = "NetworkIdentity"; |
| 42 | |
Jeff Sharkey | d4dd771 | 2012-03-16 11:11:54 -0700 | [diff] [blame] | 43 | /** |
| 44 | * When enabled, combine all {@link #mSubType} together under |
| 45 | * {@link #SUBTYPE_COMBINED}. |
Jeff Sharkey | 6973634 | 2014-12-08 14:50:12 -0800 | [diff] [blame] | 46 | * |
| 47 | * @deprecated we no longer offer to collect statistics on a per-subtype |
| 48 | * basis; this is always disabled. |
Jeff Sharkey | d4dd771 | 2012-03-16 11:11:54 -0700 | [diff] [blame] | 49 | */ |
Jeff Sharkey | 6973634 | 2014-12-08 14:50:12 -0800 | [diff] [blame] | 50 | @Deprecated |
Jeff Sharkey | d4dd771 | 2012-03-16 11:11:54 -0700 | [diff] [blame] | 51 | public static final boolean COMBINE_SUBTYPE_ENABLED = true; |
| 52 | |
| 53 | public static final int SUBTYPE_COMBINED = -1; |
| 54 | |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 55 | final int mType; |
| 56 | final int mSubType; |
| 57 | final String mSubscriberId; |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 58 | final String mNetworkId; |
Jeff Sharkey | 5dc0c26 | 2011-06-19 22:21:05 -0700 | [diff] [blame] | 59 | final boolean mRoaming; |
Jack Yu | 66a6be3 | 2016-03-30 11:14:39 -0700 | [diff] [blame] | 60 | final boolean mMetered; |
Lorenzo Colitti | d3e4a1e | 2018-01-19 01:12:04 +0900 | [diff] [blame^] | 61 | final boolean mDefaultNetwork; |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 62 | |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 63 | public NetworkIdentity( |
Jack Yu | 66a6be3 | 2016-03-30 11:14:39 -0700 | [diff] [blame] | 64 | int type, int subType, String subscriberId, String networkId, boolean roaming, |
Lorenzo Colitti | d3e4a1e | 2018-01-19 01:12:04 +0900 | [diff] [blame^] | 65 | boolean metered, boolean defaultNetwork) { |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 66 | mType = type; |
| 67 | mSubType = COMBINE_SUBTYPE_ENABLED ? SUBTYPE_COMBINED : subType; |
| 68 | mSubscriberId = subscriberId; |
| 69 | mNetworkId = networkId; |
| 70 | mRoaming = roaming; |
Jack Yu | 66a6be3 | 2016-03-30 11:14:39 -0700 | [diff] [blame] | 71 | mMetered = metered; |
Lorenzo Colitti | d3e4a1e | 2018-01-19 01:12:04 +0900 | [diff] [blame^] | 72 | mDefaultNetwork = defaultNetwork; |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 73 | } |
| 74 | |
| 75 | @Override |
| 76 | public int hashCode() { |
Lorenzo Colitti | d3e4a1e | 2018-01-19 01:12:04 +0900 | [diff] [blame^] | 77 | return Objects.hash(mType, mSubType, mSubscriberId, mNetworkId, mRoaming, mMetered, |
| 78 | mDefaultNetwork); |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 79 | } |
| 80 | |
| 81 | @Override |
| 82 | public boolean equals(Object obj) { |
| 83 | if (obj instanceof NetworkIdentity) { |
| 84 | final NetworkIdentity ident = (NetworkIdentity) obj; |
Jeff Sharkey | d4dd771 | 2012-03-16 11:11:54 -0700 | [diff] [blame] | 85 | return mType == ident.mType && mSubType == ident.mSubType && mRoaming == ident.mRoaming |
Kenny Root | e6585b3 | 2013-12-13 12:00:26 -0800 | [diff] [blame] | 86 | && Objects.equals(mSubscriberId, ident.mSubscriberId) |
Jack Yu | 66a6be3 | 2016-03-30 11:14:39 -0700 | [diff] [blame] | 87 | && Objects.equals(mNetworkId, ident.mNetworkId) |
Lorenzo Colitti | d3e4a1e | 2018-01-19 01:12:04 +0900 | [diff] [blame^] | 88 | && mMetered == ident.mMetered |
| 89 | && mDefaultNetwork == ident.mDefaultNetwork; |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 90 | } |
| 91 | return false; |
| 92 | } |
| 93 | |
| 94 | @Override |
| 95 | public String toString() { |
Jeff Sharkey | 55a442e | 2014-11-18 18:22:21 -0800 | [diff] [blame] | 96 | final StringBuilder builder = new StringBuilder("{"); |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 97 | builder.append("type=").append(getNetworkTypeName(mType)); |
| 98 | builder.append(", subType="); |
Jeff Sharkey | d4dd771 | 2012-03-16 11:11:54 -0700 | [diff] [blame] | 99 | if (COMBINE_SUBTYPE_ENABLED) { |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 100 | builder.append("COMBINED"); |
Jeff Sharkey | d4dd771 | 2012-03-16 11:11:54 -0700 | [diff] [blame] | 101 | } else if (ConnectivityManager.isNetworkTypeMobile(mType)) { |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 102 | builder.append(TelephonyManager.getNetworkTypeName(mSubType)); |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 103 | } else { |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 104 | builder.append(mSubType); |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 105 | } |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 106 | if (mSubscriberId != null) { |
| 107 | builder.append(", subscriberId=").append(scrubSubscriberId(mSubscriberId)); |
| 108 | } |
| 109 | if (mNetworkId != null) { |
| 110 | builder.append(", networkId=").append(mNetworkId); |
| 111 | } |
| 112 | if (mRoaming) { |
| 113 | builder.append(", ROAMING"); |
| 114 | } |
Jack Yu | 66a6be3 | 2016-03-30 11:14:39 -0700 | [diff] [blame] | 115 | builder.append(", metered=").append(mMetered); |
Lorenzo Colitti | d3e4a1e | 2018-01-19 01:12:04 +0900 | [diff] [blame^] | 116 | builder.append(", defaultNetwork=").append(mDefaultNetwork); |
Jeff Sharkey | 55a442e | 2014-11-18 18:22:21 -0800 | [diff] [blame] | 117 | return builder.append("}").toString(); |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 118 | } |
| 119 | |
Makoto Onuki | da65a52 | 2017-01-13 10:23:30 -0800 | [diff] [blame] | 120 | public void writeToProto(ProtoOutputStream proto, long tag) { |
| 121 | final long start = proto.start(tag); |
| 122 | |
| 123 | proto.write(NetworkIdentityProto.TYPE, mType); |
| 124 | |
| 125 | // Not dumping mSubType, subtypes are no longer supported. |
| 126 | |
| 127 | if (mSubscriberId != null) { |
| 128 | proto.write(NetworkIdentityProto.SUBSCRIBER_ID, scrubSubscriberId(mSubscriberId)); |
| 129 | } |
| 130 | proto.write(NetworkIdentityProto.NETWORK_ID, mNetworkId); |
| 131 | proto.write(NetworkIdentityProto.ROAMING, mRoaming); |
| 132 | proto.write(NetworkIdentityProto.METERED, mMetered); |
| 133 | |
| 134 | proto.end(start); |
| 135 | } |
| 136 | |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 137 | public int getType() { |
| 138 | return mType; |
| 139 | } |
| 140 | |
| 141 | public int getSubType() { |
| 142 | return mSubType; |
| 143 | } |
| 144 | |
| 145 | public String getSubscriberId() { |
| 146 | return mSubscriberId; |
| 147 | } |
| 148 | |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 149 | public String getNetworkId() { |
| 150 | return mNetworkId; |
| 151 | } |
| 152 | |
Jeff Sharkey | 5dc0c26 | 2011-06-19 22:21:05 -0700 | [diff] [blame] | 153 | public boolean getRoaming() { |
| 154 | return mRoaming; |
| 155 | } |
| 156 | |
Jack Yu | 66a6be3 | 2016-03-30 11:14:39 -0700 | [diff] [blame] | 157 | public boolean getMetered() { |
| 158 | return mMetered; |
| 159 | } |
| 160 | |
Lorenzo Colitti | d3e4a1e | 2018-01-19 01:12:04 +0900 | [diff] [blame^] | 161 | public boolean getDefaultNetwork() { |
| 162 | return mDefaultNetwork; |
| 163 | } |
| 164 | |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 165 | /** |
Jeff Sharkey | 02e21d6 | 2011-07-17 15:53:33 -0700 | [diff] [blame] | 166 | * Scrub given IMSI on production builds. |
| 167 | */ |
| 168 | public static String scrubSubscriberId(String subscriberId) { |
Jeff Sharkey | 5ab0243 | 2017-06-27 11:01:36 -0600 | [diff] [blame] | 169 | if (Build.IS_ENG) { |
Jeff Sharkey | 02e21d6 | 2011-07-17 15:53:33 -0700 | [diff] [blame] | 170 | return subscriberId; |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 171 | } else if (subscriberId != null) { |
| 172 | // TODO: parse this as MCC+MNC instead of hard-coding |
| 173 | return subscriberId.substring(0, Math.min(6, subscriberId.length())) + "..."; |
Jeff Sharkey | 02e21d6 | 2011-07-17 15:53:33 -0700 | [diff] [blame] | 174 | } else { |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 175 | return "null"; |
Jeff Sharkey | 02e21d6 | 2011-07-17 15:53:33 -0700 | [diff] [blame] | 176 | } |
| 177 | } |
| 178 | |
| 179 | /** |
Jeff Sharkey | 3256601 | 2014-12-02 18:30:14 -0800 | [diff] [blame] | 180 | * Scrub given IMSI on production builds. |
| 181 | */ |
| 182 | public static String[] scrubSubscriberId(String[] subscriberId) { |
| 183 | if (subscriberId == null) return null; |
| 184 | final String[] res = new String[subscriberId.length]; |
| 185 | for (int i = 0; i < res.length; i++) { |
| 186 | res[i] = NetworkIdentity.scrubSubscriberId(subscriberId[i]); |
| 187 | } |
| 188 | return res; |
| 189 | } |
| 190 | |
| 191 | /** |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 192 | * Build a {@link NetworkIdentity} from the given {@link NetworkState}, |
| 193 | * assuming that any mobile networks are using the current IMSI. |
| 194 | */ |
Lorenzo Colitti | d3e4a1e | 2018-01-19 01:12:04 +0900 | [diff] [blame^] | 195 | public static NetworkIdentity buildNetworkIdentity(Context context, NetworkState state, |
| 196 | boolean defaultNetwork) { |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 197 | final int type = state.networkInfo.getType(); |
| 198 | final int subType = state.networkInfo.getSubtype(); |
| 199 | |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 200 | String subscriberId = null; |
| 201 | String networkId = null; |
Jeff Sharkey | 72f9c42 | 2017-10-27 17:22:59 -0600 | [diff] [blame] | 202 | boolean roaming = !state.networkCapabilities.hasCapability( |
| 203 | NetworkCapabilities.NET_CAPABILITY_NOT_ROAMING); |
Stephen Chen | 2514787 | 2016-10-21 12:44:26 -0700 | [diff] [blame] | 204 | boolean metered = !state.networkCapabilities.hasCapability( |
| 205 | NetworkCapabilities.NET_CAPABILITY_NOT_METERED); |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 206 | |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 207 | if (isNetworkTypeMobile(type)) { |
Jeff Sharkey | 3256601 | 2014-12-02 18:30:14 -0800 | [diff] [blame] | 208 | if (state.subscriberId == null) { |
Jack Yu | bfd1d6e | 2016-08-23 16:09:36 -0700 | [diff] [blame] | 209 | if (state.networkInfo.getState() != NetworkInfo.State.DISCONNECTED && |
| 210 | state.networkInfo.getState() != NetworkInfo.State.UNKNOWN) { |
| 211 | Slog.w(TAG, "Active mobile network without subscriber! ni = " |
| 212 | + state.networkInfo); |
| 213 | } |
Jeff Sharkey | b09540f | 2011-06-19 01:08:12 -0700 | [diff] [blame] | 214 | } |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 215 | |
Jeff Sharkey | 3256601 | 2014-12-02 18:30:14 -0800 | [diff] [blame] | 216 | subscriberId = state.subscriberId; |
Jeff Sharkey | 3256601 | 2014-12-02 18:30:14 -0800 | [diff] [blame] | 217 | |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 218 | } else if (type == TYPE_WIFI) { |
Jeff Sharkey | e8914c3 | 2012-05-01 16:26:09 -0700 | [diff] [blame] | 219 | if (state.networkId != null) { |
| 220 | networkId = state.networkId; |
| 221 | } else { |
| 222 | final WifiManager wifi = (WifiManager) context.getSystemService( |
| 223 | Context.WIFI_SERVICE); |
| 224 | final WifiInfo info = wifi.getConnectionInfo(); |
| 225 | networkId = info != null ? info.getSSID() : null; |
| 226 | } |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 227 | } |
Jeff Sharkey | 8fc27e8 | 2012-04-04 20:40:58 -0700 | [diff] [blame] | 228 | |
Lorenzo Colitti | d3e4a1e | 2018-01-19 01:12:04 +0900 | [diff] [blame^] | 229 | return new NetworkIdentity(type, subType, subscriberId, networkId, roaming, metered, |
| 230 | defaultNetwork); |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 231 | } |
Jeff Sharkey | 55a442e | 2014-11-18 18:22:21 -0800 | [diff] [blame] | 232 | |
| 233 | @Override |
| 234 | public int compareTo(NetworkIdentity another) { |
| 235 | int res = Integer.compare(mType, another.mType); |
| 236 | if (res == 0) { |
| 237 | res = Integer.compare(mSubType, another.mSubType); |
| 238 | } |
| 239 | if (res == 0 && mSubscriberId != null && another.mSubscriberId != null) { |
| 240 | res = mSubscriberId.compareTo(another.mSubscriberId); |
| 241 | } |
| 242 | if (res == 0 && mNetworkId != null && another.mNetworkId != null) { |
| 243 | res = mNetworkId.compareTo(another.mNetworkId); |
| 244 | } |
| 245 | if (res == 0) { |
| 246 | res = Boolean.compare(mRoaming, another.mRoaming); |
| 247 | } |
Jack Yu | 66a6be3 | 2016-03-30 11:14:39 -0700 | [diff] [blame] | 248 | if (res == 0) { |
| 249 | res = Boolean.compare(mMetered, another.mMetered); |
| 250 | } |
Lorenzo Colitti | d3e4a1e | 2018-01-19 01:12:04 +0900 | [diff] [blame^] | 251 | if (res == 0) { |
| 252 | res = Boolean.compare(mDefaultNetwork, another.mDefaultNetwork); |
| 253 | } |
Jeff Sharkey | 55a442e | 2014-11-18 18:22:21 -0800 | [diff] [blame] | 254 | return res; |
| 255 | } |
Jeff Sharkey | 1b5a2a9 | 2011-06-18 18:34:16 -0700 | [diff] [blame] | 256 | } |