blob: c5eeff3fef839db84ac14aeb7061f01d71eb2891 [file] [log] [blame]
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001/*
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09002 * Copyright (C) 2021 The Android Open Source Project
Irfan Sheriff77ec5582012-03-22 17:01:39 -07003 *
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.server;
18
paulhu2b9ed952022-02-10 21:58:32 +080019import static android.net.ConnectivityManager.NETID_UNSET;
Paul Hu019621e2023-01-13 23:26:49 +080020import static android.net.nsd.NsdManager.MDNS_DISCOVERY_MANAGER_EVENT;
paulhu2b9ed952022-02-10 21:58:32 +080021import static android.net.nsd.NsdManager.MDNS_SERVICE_EVENT;
Paul Hu4bd98ef2023-01-12 13:42:07 +080022import static android.provider.DeviceConfig.NAMESPACE_CONNECTIVITY;
paulhu2b9ed952022-02-10 21:58:32 +080023
Paul Hu23fa2022023-01-13 22:57:24 +080024import android.annotation.NonNull;
Paul Hu4bd98ef2023-01-12 13:42:07 +080025import android.annotation.Nullable;
paulhua262cc12019-08-12 16:25:11 +080026import android.content.Context;
Irfan Sheriff75006652012-04-17 23:15:29 -070027import android.content.Intent;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +090028import android.net.ConnectivityManager;
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +090029import android.net.INetd;
Paul Hu75069ed2023-01-14 00:31:09 +080030import android.net.InetAddresses;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +090031import android.net.LinkProperties;
32import android.net.Network;
paulhu2b9ed952022-02-10 21:58:32 +080033import android.net.mdns.aidl.DiscoveryInfo;
34import android.net.mdns.aidl.GetAddressInfo;
35import android.net.mdns.aidl.IMDnsEventListener;
36import android.net.mdns.aidl.RegistrationInfo;
37import android.net.mdns.aidl.ResolutionInfo;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070038import android.net.nsd.INsdManager;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +090039import android.net.nsd.INsdManagerCallback;
40import android.net.nsd.INsdServiceConnector;
paulhu2b9ed952022-02-10 21:58:32 +080041import android.net.nsd.MDnsManager;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070042import android.net.nsd.NsdManager;
paulhua262cc12019-08-12 16:25:11 +080043import android.net.nsd.NsdServiceInfo;
Hugo Benichi803a2f02017-04-24 11:35:06 +090044import android.os.Handler;
paulhua262cc12019-08-12 16:25:11 +080045import android.os.HandlerThread;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +090046import android.os.IBinder;
Paul Hu4bd98ef2023-01-12 13:42:07 +080047import android.os.Looper;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070048import android.os.Message;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +090049import android.os.RemoteException;
Dianne Hackborn692107e2012-08-29 18:32:08 -070050import android.os.UserHandle;
Paul Hu23fa2022023-01-13 22:57:24 +080051import android.text.TextUtils;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +090052import android.util.Log;
53import android.util.Pair;
Irfan Sheriffe4c42f42012-05-03 16:44:27 -070054import android.util.SparseArray;
Hugo Benichid2552ae2017-04-11 14:42:47 +090055import android.util.SparseIntArray;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070056
paulhua262cc12019-08-12 16:25:11 +080057import com.android.internal.annotations.VisibleForTesting;
paulhua262cc12019-08-12 16:25:11 +080058import com.android.internal.util.State;
59import com.android.internal.util.StateMachine;
Paul Hu4bd98ef2023-01-12 13:42:07 +080060import com.android.net.module.util.DeviceConfigUtils;
paulhu3ffffe72021-09-16 10:15:22 +080061import com.android.net.module.util.PermissionUtils;
Paul Hu4bd98ef2023-01-12 13:42:07 +080062import com.android.server.connectivity.mdns.ExecutorProvider;
63import com.android.server.connectivity.mdns.MdnsDiscoveryManager;
64import com.android.server.connectivity.mdns.MdnsMultinetworkSocketClient;
Paul Hu23fa2022023-01-13 22:57:24 +080065import com.android.server.connectivity.mdns.MdnsSearchOptions;
66import com.android.server.connectivity.mdns.MdnsServiceBrowserListener;
67import com.android.server.connectivity.mdns.MdnsServiceInfo;
Paul Hu4bd98ef2023-01-12 13:42:07 +080068import com.android.server.connectivity.mdns.MdnsSocketClientBase;
69import com.android.server.connectivity.mdns.MdnsSocketProvider;
paulhua262cc12019-08-12 16:25:11 +080070
Irfan Sheriff77ec5582012-03-22 17:01:39 -070071import java.io.FileDescriptor;
72import java.io.PrintWriter;
Irfan Sheriffe8de2462012-04-11 14:52:19 -070073import java.net.InetAddress;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +090074import java.net.NetworkInterface;
75import java.net.SocketException;
76import java.net.UnknownHostException;
Irfan Sheriffe8de2462012-04-11 14:52:19 -070077import java.util.HashMap;
Paul Hu23fa2022023-01-13 22:57:24 +080078import java.util.List;
Paul Hu75069ed2023-01-14 00:31:09 +080079import java.util.Map;
Paul Hu23fa2022023-01-13 22:57:24 +080080import java.util.regex.Matcher;
81import java.util.regex.Pattern;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070082
Irfan Sheriff77ec5582012-03-22 17:01:39 -070083/**
84 * Network Service Discovery Service handles remote service discovery operation requests by
85 * implementing the INsdManager interface.
86 *
87 * @hide
88 */
89public class NsdService extends INsdManager.Stub {
90 private static final String TAG = "NsdService";
91 private static final String MDNS_TAG = "mDnsConnector";
Paul Hu4bd98ef2023-01-12 13:42:07 +080092 private static final String MDNS_DISCOVERY_MANAGER_VERSION = "mdns_discovery_manager_version";
Paul Hu23fa2022023-01-13 22:57:24 +080093 private static final String LOCAL_DOMAIN_NAME = "local";
Irfan Sheriff77ec5582012-03-22 17:01:39 -070094
paulhu2b9ed952022-02-10 21:58:32 +080095 private static final boolean DBG = Log.isLoggable(TAG, Log.DEBUG);
Luke Huang92860f92021-06-23 06:29:30 +000096 private static final long CLEANUP_DELAY_MS = 10000;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +090097 private static final int IFACE_IDX_ANY = 0;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070098
Hugo Benichi32be63d2017-04-05 14:06:11 +090099 private final Context mContext;
Hugo Benichi32be63d2017-04-05 14:06:11 +0900100 private final NsdStateMachine mNsdStateMachine;
paulhu2b9ed952022-02-10 21:58:32 +0800101 private final MDnsManager mMDnsManager;
102 private final MDnsEventCallback mMDnsEventCallback;
Paul Hu4bd98ef2023-01-12 13:42:07 +0800103 @Nullable
104 private final MdnsMultinetworkSocketClient mMdnsSocketClient;
105 @Nullable
106 private final MdnsDiscoveryManager mMdnsDiscoveryManager;
107 @Nullable
108 private final MdnsSocketProvider mMdnsSocketProvider;
Paul Hu23fa2022023-01-13 22:57:24 +0800109 // WARNING : Accessing these values in any thread is not safe, it must only be changed in the
paulhu2b9ed952022-02-10 21:58:32 +0800110 // state machine thread. If change this outside state machine, it will need to introduce
111 // synchronization.
112 private boolean mIsDaemonStarted = false;
Paul Hu23fa2022023-01-13 22:57:24 +0800113 private boolean mIsMonitoringSocketsStarted = false;
Irfan Sheriff77ec5582012-03-22 17:01:39 -0700114
115 /**
116 * Clients receiving asynchronous messages
117 */
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900118 private final HashMap<NsdServiceConnector, ClientInfo> mClients = new HashMap<>();
Irfan Sheriff77ec5582012-03-22 17:01:39 -0700119
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700120 /* A map from unique id to client info */
Hugo Benichi32be63d2017-04-05 14:06:11 +0900121 private final SparseArray<ClientInfo> mIdToClientInfoMap= new SparseArray<>();
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700122
Luke Huang05298582021-06-13 16:52:05 +0000123 private final long mCleanupDelayMs;
Irfan Sheriff77ec5582012-03-22 17:01:39 -0700124
Hugo Benichi32be63d2017-04-05 14:06:11 +0900125 private static final int INVALID_ID = 0;
Irfan Sheriffe8de2462012-04-11 14:52:19 -0700126 private int mUniqueId = 1;
Luke Huangf7277ed2021-07-12 21:15:10 +0800127 // The count of the connected legacy clients.
128 private int mLegacyClientCount = 0;
Irfan Sheriffe8de2462012-04-11 14:52:19 -0700129
Paul Hu23fa2022023-01-13 22:57:24 +0800130 private static class MdnsListener implements MdnsServiceBrowserListener {
131 protected final int mClientId;
132 protected final int mTransactionId;
133 @NonNull
134 protected final NsdServiceInfo mReqServiceInfo;
135 @NonNull
136 protected final String mListenedServiceType;
137
138 MdnsListener(int clientId, int transactionId, @NonNull NsdServiceInfo reqServiceInfo,
139 @NonNull String listenedServiceType) {
140 mClientId = clientId;
141 mTransactionId = transactionId;
142 mReqServiceInfo = reqServiceInfo;
143 mListenedServiceType = listenedServiceType;
144 }
145
146 @NonNull
147 public String getListenedServiceType() {
148 return mListenedServiceType;
149 }
150
151 @Override
152 public void onServiceFound(@NonNull MdnsServiceInfo serviceInfo) { }
153
154 @Override
155 public void onServiceUpdated(@NonNull MdnsServiceInfo serviceInfo) { }
156
157 @Override
158 public void onServiceRemoved(@NonNull MdnsServiceInfo serviceInfo) { }
159
160 @Override
161 public void onServiceNameDiscovered(@NonNull MdnsServiceInfo serviceInfo) { }
162
163 @Override
164 public void onServiceNameRemoved(@NonNull MdnsServiceInfo serviceInfo) { }
165
166 @Override
167 public void onSearchStoppedWithError(int error) { }
168
169 @Override
170 public void onSearchFailedToStart() { }
171
172 @Override
173 public void onDiscoveryQuerySent(@NonNull List<String> subtypes, int transactionId) { }
174
175 @Override
176 public void onFailedToParseMdnsResponse(int receivedPacketNumber, int errorCode) { }
177 }
178
179 private class DiscoveryListener extends MdnsListener {
180
181 DiscoveryListener(int clientId, int transactionId, @NonNull NsdServiceInfo reqServiceInfo,
182 @NonNull String listenServiceType) {
183 super(clientId, transactionId, reqServiceInfo, listenServiceType);
184 }
185
186 @Override
187 public void onServiceNameDiscovered(@NonNull MdnsServiceInfo serviceInfo) {
Paul Hu019621e2023-01-13 23:26:49 +0800188 mNsdStateMachine.sendMessage(MDNS_DISCOVERY_MANAGER_EVENT, mTransactionId,
189 NsdManager.SERVICE_FOUND,
190 new MdnsEvent(mClientId, mReqServiceInfo.getServiceType(), serviceInfo));
Paul Hu23fa2022023-01-13 22:57:24 +0800191 }
192
193 @Override
194 public void onServiceNameRemoved(@NonNull MdnsServiceInfo serviceInfo) {
Paul Hu319751a2023-01-13 23:56:34 +0800195 mNsdStateMachine.sendMessage(MDNS_DISCOVERY_MANAGER_EVENT, mTransactionId,
196 NsdManager.SERVICE_LOST,
197 new MdnsEvent(mClientId, mReqServiceInfo.getServiceType(), serviceInfo));
Paul Hu23fa2022023-01-13 22:57:24 +0800198 }
199 }
200
Paul Hu75069ed2023-01-14 00:31:09 +0800201 private class ResolutionListener extends MdnsListener {
202
203 ResolutionListener(int clientId, int transactionId, @NonNull NsdServiceInfo reqServiceInfo,
204 @NonNull String listenServiceType) {
205 super(clientId, transactionId, reqServiceInfo, listenServiceType);
206 }
207
208 @Override
209 public void onServiceFound(MdnsServiceInfo serviceInfo) {
210 mNsdStateMachine.sendMessage(MDNS_DISCOVERY_MANAGER_EVENT, mTransactionId,
211 NsdManager.RESOLVE_SERVICE_SUCCEEDED,
212 new MdnsEvent(mClientId, mReqServiceInfo.getServiceType(), serviceInfo));
213 }
214 }
215
Paul Hu019621e2023-01-13 23:26:49 +0800216 /**
217 * Data class of mdns service callback information.
218 */
219 private static class MdnsEvent {
220 final int mClientId;
221 @NonNull
222 final String mRequestedServiceType;
223 @NonNull
224 final MdnsServiceInfo mMdnsServiceInfo;
225
226 MdnsEvent(int clientId, @NonNull String requestedServiceType,
227 @NonNull MdnsServiceInfo mdnsServiceInfo) {
228 mClientId = clientId;
229 mRequestedServiceType = requestedServiceType;
230 mMdnsServiceInfo = mdnsServiceInfo;
231 }
232 }
233
Irfan Sheriff75006652012-04-17 23:15:29 -0700234 private class NsdStateMachine extends StateMachine {
235
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700236 private final DefaultState mDefaultState = new DefaultState();
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700237 private final EnabledState mEnabledState = new EnabledState();
Irfan Sheriff75006652012-04-17 23:15:29 -0700238
239 @Override
Wink Saville358f5d42012-05-29 12:40:46 -0700240 protected String getWhatToString(int what) {
Hugo Benichi32be63d2017-04-05 14:06:11 +0900241 return NsdManager.nameOf(what);
Irfan Sheriff75006652012-04-17 23:15:29 -0700242 }
243
Luke Huang92860f92021-06-23 06:29:30 +0000244 private void maybeStartDaemon() {
paulhu2b9ed952022-02-10 21:58:32 +0800245 if (mIsDaemonStarted) {
246 if (DBG) Log.d(TAG, "Daemon is already started.");
247 return;
248 }
249 mMDnsManager.registerEventListener(mMDnsEventCallback);
250 mMDnsManager.startDaemon();
251 mIsDaemonStarted = true;
Luke Huang05298582021-06-13 16:52:05 +0000252 maybeScheduleStop();
253 }
254
paulhu2b9ed952022-02-10 21:58:32 +0800255 private void maybeStopDaemon() {
256 if (!mIsDaemonStarted) {
257 if (DBG) Log.d(TAG, "Daemon has not been started.");
258 return;
259 }
260 mMDnsManager.unregisterEventListener(mMDnsEventCallback);
261 mMDnsManager.stopDaemon();
262 mIsDaemonStarted = false;
263 }
264
Luke Huang92860f92021-06-23 06:29:30 +0000265 private boolean isAnyRequestActive() {
266 return mIdToClientInfoMap.size() != 0;
267 }
268
269 private void scheduleStop() {
270 sendMessageDelayed(NsdManager.DAEMON_CLEANUP, mCleanupDelayMs);
271 }
272 private void maybeScheduleStop() {
Luke Huangf7277ed2021-07-12 21:15:10 +0800273 // The native daemon should stay alive and can't be cleanup
274 // if any legacy client connected.
275 if (!isAnyRequestActive() && mLegacyClientCount == 0) {
Luke Huang92860f92021-06-23 06:29:30 +0000276 scheduleStop();
Luke Huang05298582021-06-13 16:52:05 +0000277 }
278 }
279
Luke Huang92860f92021-06-23 06:29:30 +0000280 private void cancelStop() {
Luke Huang05298582021-06-13 16:52:05 +0000281 this.removeMessages(NsdManager.DAEMON_CLEANUP);
282 }
283
Paul Hu23fa2022023-01-13 22:57:24 +0800284 private void maybeStartMonitoringSockets() {
285 if (mIsMonitoringSocketsStarted) {
286 if (DBG) Log.d(TAG, "Socket monitoring is already started.");
287 return;
288 }
289
290 mMdnsSocketProvider.startMonitoringSockets();
291 mIsMonitoringSocketsStarted = true;
292 }
293
294 private void maybeStopMonitoringSockets() {
295 if (!mIsMonitoringSocketsStarted) {
296 if (DBG) Log.d(TAG, "Socket monitoring has not been started.");
297 return;
298 }
299 mMdnsSocketProvider.stopMonitoringSockets();
300 mIsMonitoringSocketsStarted = false;
301 }
302
303 private void maybeStopMonitoringSocketsIfNoActiveRequest() {
304 if (!isAnyRequestActive()) {
305 maybeStopMonitoringSockets();
306 }
307 }
308
Hugo Benichi803a2f02017-04-24 11:35:06 +0900309 NsdStateMachine(String name, Handler handler) {
310 super(name, handler);
Irfan Sheriff75006652012-04-17 23:15:29 -0700311 addState(mDefaultState);
Irfan Sheriff75006652012-04-17 23:15:29 -0700312 addState(mEnabledState, mDefaultState);
paulhu5568f452021-11-30 13:31:29 +0800313 State initialState = mEnabledState;
Hugo Benichi912db992017-04-24 16:41:03 +0900314 setInitialState(initialState);
Wink Saville358f5d42012-05-29 12:40:46 -0700315 setLogRecSize(25);
Irfan Sheriff75006652012-04-17 23:15:29 -0700316 }
317
318 class DefaultState extends State {
319 @Override
320 public boolean processMessage(Message msg) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900321 final ClientInfo cInfo;
322 final int clientId = msg.arg2;
Irfan Sheriff75006652012-04-17 23:15:29 -0700323 switch (msg.what) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900324 case NsdManager.REGISTER_CLIENT:
325 final Pair<NsdServiceConnector, INsdManagerCallback> arg =
326 (Pair<NsdServiceConnector, INsdManagerCallback>) msg.obj;
327 final INsdManagerCallback cb = arg.second;
328 try {
329 cb.asBinder().linkToDeath(arg.first, 0);
330 cInfo = new ClientInfo(cb);
331 mClients.put(arg.first, cInfo);
332 } catch (RemoteException e) {
333 Log.w(TAG, "Client " + clientId + " has already died");
Irfan Sheriff75006652012-04-17 23:15:29 -0700334 }
335 break;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900336 case NsdManager.UNREGISTER_CLIENT:
337 final NsdServiceConnector connector = (NsdServiceConnector) msg.obj;
338 cInfo = mClients.remove(connector);
Dave Plattfeff2af2014-03-07 14:48:22 -0800339 if (cInfo != null) {
Paul Hu23fa2022023-01-13 22:57:24 +0800340 if (mMdnsDiscoveryManager != null) {
341 cInfo.unregisterAllListeners();
342 }
Dave Plattfeff2af2014-03-07 14:48:22 -0800343 cInfo.expungeAllRequests();
Luke Huangf7277ed2021-07-12 21:15:10 +0800344 if (cInfo.isLegacy()) {
345 mLegacyClientCount -= 1;
346 }
Dave Plattfeff2af2014-03-07 14:48:22 -0800347 }
Paul Hu23fa2022023-01-13 22:57:24 +0800348 if (mMdnsDiscoveryManager != null) {
349 maybeStopMonitoringSocketsIfNoActiveRequest();
350 }
Luke Huangf7277ed2021-07-12 21:15:10 +0800351 maybeScheduleStop();
Irfan Sheriff75006652012-04-17 23:15:29 -0700352 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700353 case NsdManager.DISCOVER_SERVICES:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900354 cInfo = getClientInfoForReply(msg);
355 if (cInfo != null) {
356 cInfo.onDiscoverServicesFailed(
357 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
358 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700359 break;
360 case NsdManager.STOP_DISCOVERY:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900361 cInfo = getClientInfoForReply(msg);
362 if (cInfo != null) {
363 cInfo.onStopDiscoveryFailed(
364 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
365 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700366 break;
367 case NsdManager.REGISTER_SERVICE:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900368 cInfo = getClientInfoForReply(msg);
369 if (cInfo != null) {
370 cInfo.onRegisterServiceFailed(
371 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
372 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700373 break;
374 case NsdManager.UNREGISTER_SERVICE:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900375 cInfo = getClientInfoForReply(msg);
376 if (cInfo != null) {
377 cInfo.onUnregisterServiceFailed(
378 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
379 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700380 break;
381 case NsdManager.RESOLVE_SERVICE:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900382 cInfo = getClientInfoForReply(msg);
383 if (cInfo != null) {
384 cInfo.onResolveServiceFailed(
385 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
386 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700387 break;
Paul Hub58deb72022-12-26 09:24:42 +0000388 case NsdManager.STOP_RESOLUTION:
389 cInfo = getClientInfoForReply(msg);
390 if (cInfo != null) {
391 cInfo.onStopResolutionFailed(
392 clientId, NsdManager.FAILURE_OPERATION_NOT_RUNNING);
393 }
394 break;
Luke Huang05298582021-06-13 16:52:05 +0000395 case NsdManager.DAEMON_CLEANUP:
paulhu2b9ed952022-02-10 21:58:32 +0800396 maybeStopDaemon();
Luke Huang05298582021-06-13 16:52:05 +0000397 break;
Luke Huangf7277ed2021-07-12 21:15:10 +0800398 // This event should be only sent by the legacy (target SDK < S) clients.
399 // Mark the sending client as legacy.
400 case NsdManager.DAEMON_STARTUP:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900401 cInfo = getClientInfoForReply(msg);
Luke Huangf7277ed2021-07-12 21:15:10 +0800402 if (cInfo != null) {
403 cancelStop();
404 cInfo.setLegacy();
405 mLegacyClientCount += 1;
406 maybeStartDaemon();
407 }
408 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700409 default:
paulhub2225702021-11-17 09:35:33 +0800410 Log.e(TAG, "Unhandled " + msg);
Irfan Sheriff75006652012-04-17 23:15:29 -0700411 return NOT_HANDLED;
412 }
413 return HANDLED;
414 }
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900415
416 private ClientInfo getClientInfoForReply(Message msg) {
417 final ListenerArgs args = (ListenerArgs) msg.obj;
418 return mClients.get(args.connector);
419 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700420 }
421
Irfan Sheriff75006652012-04-17 23:15:29 -0700422 class EnabledState extends State {
423 @Override
424 public void enter() {
425 sendNsdStateChangeBroadcast(true);
Irfan Sheriff75006652012-04-17 23:15:29 -0700426 }
427
428 @Override
429 public void exit() {
Luke Huang05298582021-06-13 16:52:05 +0000430 // TODO: it is incorrect to stop the daemon without expunging all requests
431 // and sending error callbacks to clients.
Luke Huang92860f92021-06-23 06:29:30 +0000432 scheduleStop();
Irfan Sheriff75006652012-04-17 23:15:29 -0700433 }
434
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700435 private boolean requestLimitReached(ClientInfo clientInfo) {
436 if (clientInfo.mClientIds.size() >= ClientInfo.MAX_LIMIT) {
paulhub2225702021-11-17 09:35:33 +0800437 if (DBG) Log.d(TAG, "Exceeded max outstanding requests " + clientInfo);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700438 return true;
439 }
440 return false;
441 }
442
Dave Plattfeff2af2014-03-07 14:48:22 -0800443 private void storeRequestMap(int clientId, int globalId, ClientInfo clientInfo, int what) {
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700444 clientInfo.mClientIds.put(clientId, globalId);
Dave Plattfeff2af2014-03-07 14:48:22 -0800445 clientInfo.mClientRequests.put(clientId, what);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700446 mIdToClientInfoMap.put(globalId, clientInfo);
Luke Huang05298582021-06-13 16:52:05 +0000447 // Remove the cleanup event because here comes a new request.
448 cancelStop();
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700449 }
450
451 private void removeRequestMap(int clientId, int globalId, ClientInfo clientInfo) {
Hugo Benichid2552ae2017-04-11 14:42:47 +0900452 clientInfo.mClientIds.delete(clientId);
453 clientInfo.mClientRequests.delete(clientId);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700454 mIdToClientInfoMap.remove(globalId);
Luke Huang05298582021-06-13 16:52:05 +0000455 maybeScheduleStop();
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700456 }
457
Paul Hu23fa2022023-01-13 22:57:24 +0800458 private void storeListenerMap(int clientId, int transactionId, MdnsListener listener,
459 ClientInfo clientInfo) {
460 clientInfo.mClientIds.put(clientId, transactionId);
461 clientInfo.mListeners.put(clientId, listener);
462 mIdToClientInfoMap.put(transactionId, clientInfo);
Paul Hu23fa2022023-01-13 22:57:24 +0800463 }
464
465 private void removeListenerMap(int clientId, int transactionId, ClientInfo clientInfo) {
466 clientInfo.mClientIds.delete(clientId);
467 clientInfo.mListeners.delete(clientId);
468 mIdToClientInfoMap.remove(transactionId);
469 maybeStopMonitoringSocketsIfNoActiveRequest();
470 }
471
472 /**
473 * Check the given service type is valid and construct it to a service type
474 * which can use for discovery / resolution service.
475 *
476 * <p> The valid service type should be 2 labels, or 3 labels if the query is for a
477 * subtype (see RFC6763 7.1). Each label is up to 63 characters and must start with an
478 * underscore; they are alphanumerical characters or dashes or underscore, except the
479 * last one that is just alphanumerical. The last label must be _tcp or _udp.
480 *
481 * @param serviceType the request service type for discovery / resolution service
482 * @return constructed service type or null if the given service type is invalid.
483 */
484 @Nullable
485 private String constructServiceType(String serviceType) {
486 if (TextUtils.isEmpty(serviceType)) return null;
487
488 final Pattern serviceTypePattern = Pattern.compile(
489 "^(_[a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]\\.)?"
490 + "(_[a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]\\._(?:tcp|udp))$");
491 final Matcher matcher = serviceTypePattern.matcher(serviceType);
492 if (!matcher.matches()) return null;
493 return matcher.group(1) == null
494 ? serviceType + ".local"
Paul Hu75069ed2023-01-14 00:31:09 +0800495 : matcher.group(1) + "_sub." + matcher.group(2) + ".local";
Paul Hu23fa2022023-01-13 22:57:24 +0800496 }
497
Irfan Sheriff75006652012-04-17 23:15:29 -0700498 @Override
499 public boolean processMessage(Message msg) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900500 final ClientInfo clientInfo;
501 final int id;
502 final int clientId = msg.arg2;
503 final ListenerArgs args;
Irfan Sheriff75006652012-04-17 23:15:29 -0700504 switch (msg.what) {
Paul Hu75069ed2023-01-14 00:31:09 +0800505 case NsdManager.DISCOVER_SERVICES: {
paulhub2225702021-11-17 09:35:33 +0800506 if (DBG) Log.d(TAG, "Discover services");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900507 args = (ListenerArgs) msg.obj;
508 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000509 // If the binder death notification for a INsdManagerCallback was received
510 // before any calls are received by NsdService, the clientInfo would be
511 // cleared and cause NPE. Add a null check here to prevent this corner case.
512 if (clientInfo == null) {
513 Log.e(TAG, "Unknown connector in discovery");
514 break;
515 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700516
517 if (requestLimitReached(clientInfo)) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900518 clientInfo.onDiscoverServicesFailed(
519 clientId, NsdManager.FAILURE_MAX_LIMIT);
Irfan Sheriff75006652012-04-17 23:15:29 -0700520 break;
521 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700522
Paul Hu23fa2022023-01-13 22:57:24 +0800523 final NsdServiceInfo info = args.serviceInfo;
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700524 id = getUniqueId();
Paul Hu23fa2022023-01-13 22:57:24 +0800525 if (mMdnsDiscoveryManager != null) {
526 final String serviceType = constructServiceType(info.getServiceType());
527 if (serviceType == null) {
528 clientInfo.onDiscoverServicesFailed(clientId,
529 NsdManager.FAILURE_INTERNAL_ERROR);
530 break;
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700531 }
Paul Hu23fa2022023-01-13 22:57:24 +0800532
533 maybeStartMonitoringSockets();
534 final MdnsListener listener =
535 new DiscoveryListener(clientId, id, info, serviceType);
536 final MdnsSearchOptions options = MdnsSearchOptions.newBuilder()
537 .setNetwork(info.getNetwork())
538 .setIsPassiveMode(true)
539 .build();
540 mMdnsDiscoveryManager.registerListener(serviceType, listener, options);
541 storeListenerMap(clientId, id, listener, clientInfo);
542 clientInfo.onDiscoverServicesStarted(clientId, info);
Irfan Sheriff75006652012-04-17 23:15:29 -0700543 } else {
Paul Hu23fa2022023-01-13 22:57:24 +0800544 maybeStartDaemon();
545 if (discoverServices(id, info)) {
546 if (DBG) {
547 Log.d(TAG, "Discover " + msg.arg2 + " " + id
548 + info.getServiceType());
549 }
550 storeRequestMap(clientId, id, clientInfo, msg.what);
551 clientInfo.onDiscoverServicesStarted(clientId, info);
552 } else {
553 stopServiceDiscovery(id);
554 clientInfo.onDiscoverServicesFailed(clientId,
555 NsdManager.FAILURE_INTERNAL_ERROR);
556 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700557 }
558 break;
Paul Hu75069ed2023-01-14 00:31:09 +0800559 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700560 case NsdManager.STOP_DISCOVERY:
paulhub2225702021-11-17 09:35:33 +0800561 if (DBG) Log.d(TAG, "Stop service discovery");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900562 args = (ListenerArgs) msg.obj;
563 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000564 // If the binder death notification for a INsdManagerCallback was received
565 // before any calls are received by NsdService, the clientInfo would be
566 // cleared and cause NPE. Add a null check here to prevent this corner case.
567 if (clientInfo == null) {
568 Log.e(TAG, "Unknown connector in stop discovery");
569 break;
570 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700571
572 try {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900573 id = clientInfo.mClientIds.get(clientId);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700574 } catch (NullPointerException e) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900575 clientInfo.onStopDiscoveryFailed(
576 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Irfan Sheriff75006652012-04-17 23:15:29 -0700577 break;
578 }
Paul Hu23fa2022023-01-13 22:57:24 +0800579 if (mMdnsDiscoveryManager != null) {
580 final MdnsListener listener = clientInfo.mListeners.get(clientId);
581 if (listener == null) {
582 clientInfo.onStopDiscoveryFailed(
583 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
584 break;
585 }
586 mMdnsDiscoveryManager.unregisterListener(
587 listener.getListenedServiceType(), listener);
588 removeListenerMap(clientId, id, clientInfo);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900589 clientInfo.onStopDiscoverySucceeded(clientId);
Irfan Sheriff75006652012-04-17 23:15:29 -0700590 } else {
Paul Hu23fa2022023-01-13 22:57:24 +0800591 removeRequestMap(clientId, id, clientInfo);
592 if (stopServiceDiscovery(id)) {
593 clientInfo.onStopDiscoverySucceeded(clientId);
594 } else {
595 clientInfo.onStopDiscoveryFailed(
596 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
597 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700598 }
599 break;
600 case NsdManager.REGISTER_SERVICE:
paulhub2225702021-11-17 09:35:33 +0800601 if (DBG) Log.d(TAG, "Register service");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900602 args = (ListenerArgs) msg.obj;
603 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000604 // If the binder death notification for a INsdManagerCallback was received
605 // before any calls are received by NsdService, the clientInfo would be
606 // cleared and cause NPE. Add a null check here to prevent this corner case.
607 if (clientInfo == null) {
608 Log.e(TAG, "Unknown connector in registration");
609 break;
610 }
611
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700612 if (requestLimitReached(clientInfo)) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900613 clientInfo.onRegisterServiceFailed(
614 clientId, NsdManager.FAILURE_MAX_LIMIT);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700615 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700616 }
617
Luke Huang05298582021-06-13 16:52:05 +0000618 maybeStartDaemon();
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700619 id = getUniqueId();
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900620 if (registerService(id, args.serviceInfo)) {
paulhub2225702021-11-17 09:35:33 +0800621 if (DBG) Log.d(TAG, "Register " + clientId + " " + id);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900622 storeRequestMap(clientId, id, clientInfo, msg.what);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700623 // Return success after mDns reports success
Irfan Sheriff75006652012-04-17 23:15:29 -0700624 } else {
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700625 unregisterService(id);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900626 clientInfo.onRegisterServiceFailed(
627 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Irfan Sheriff75006652012-04-17 23:15:29 -0700628 }
629 break;
630 case NsdManager.UNREGISTER_SERVICE:
paulhub2225702021-11-17 09:35:33 +0800631 if (DBG) Log.d(TAG, "unregister service");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900632 args = (ListenerArgs) msg.obj;
633 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000634 // If the binder death notification for a INsdManagerCallback was received
635 // before any calls are received by NsdService, the clientInfo would be
636 // cleared and cause NPE. Add a null check here to prevent this corner case.
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900637 if (clientInfo == null) {
paulhub2225702021-11-17 09:35:33 +0800638 Log.e(TAG, "Unknown connector in unregistration");
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700639 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700640 }
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900641 id = clientInfo.mClientIds.get(clientId);
642 removeRequestMap(clientId, id, clientInfo);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700643 if (unregisterService(id)) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900644 clientInfo.onUnregisterServiceSucceeded(clientId);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700645 } else {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900646 clientInfo.onUnregisterServiceFailed(
647 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700648 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700649 break;
Paul Hu75069ed2023-01-14 00:31:09 +0800650 case NsdManager.RESOLVE_SERVICE: {
paulhub2225702021-11-17 09:35:33 +0800651 if (DBG) Log.d(TAG, "Resolve service");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900652 args = (ListenerArgs) msg.obj;
653 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000654 // If the binder death notification for a INsdManagerCallback was received
655 // before any calls are received by NsdService, the clientInfo would be
656 // cleared and cause NPE. Add a null check here to prevent this corner case.
657 if (clientInfo == null) {
658 Log.e(TAG, "Unknown connector in resolution");
659 break;
660 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700661
Paul Hu75069ed2023-01-14 00:31:09 +0800662 final NsdServiceInfo info = args.serviceInfo;
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700663 id = getUniqueId();
Paul Hu75069ed2023-01-14 00:31:09 +0800664 if (mMdnsDiscoveryManager != null) {
665 final String serviceType = constructServiceType(info.getServiceType());
666 if (serviceType == null) {
667 clientInfo.onResolveServiceFailed(clientId,
668 NsdManager.FAILURE_INTERNAL_ERROR);
669 break;
670 }
671
672 maybeStartMonitoringSockets();
673 final MdnsListener listener =
674 new ResolutionListener(clientId, id, info, serviceType);
675 final MdnsSearchOptions options = MdnsSearchOptions.newBuilder()
676 .setNetwork(info.getNetwork())
677 .setIsPassiveMode(true)
678 .build();
679 mMdnsDiscoveryManager.registerListener(serviceType, listener, options);
680 storeListenerMap(clientId, id, listener, clientInfo);
Irfan Sheriff75006652012-04-17 23:15:29 -0700681 } else {
Paul Hu75069ed2023-01-14 00:31:09 +0800682 if (clientInfo.mResolvedService != null) {
683 clientInfo.onResolveServiceFailed(
684 clientId, NsdManager.FAILURE_ALREADY_ACTIVE);
685 break;
686 }
687
688 maybeStartDaemon();
689 if (resolveService(id, args.serviceInfo)) {
690 clientInfo.mResolvedService = new NsdServiceInfo();
691 storeRequestMap(clientId, id, clientInfo, msg.what);
692 } else {
693 clientInfo.onResolveServiceFailed(
694 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
695 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700696 }
697 break;
Paul Hu75069ed2023-01-14 00:31:09 +0800698 }
Paul Hub58deb72022-12-26 09:24:42 +0000699 case NsdManager.STOP_RESOLUTION:
700 if (DBG) Log.d(TAG, "Stop service resolution");
701 args = (ListenerArgs) msg.obj;
702 clientInfo = mClients.get(args.connector);
703 // If the binder death notification for a INsdManagerCallback was received
704 // before any calls are received by NsdService, the clientInfo would be
705 // cleared and cause NPE. Add a null check here to prevent this corner case.
706 if (clientInfo == null) {
707 Log.e(TAG, "Unknown connector in stop resolution");
708 break;
709 }
710
711 id = clientInfo.mClientIds.get(clientId);
712 removeRequestMap(clientId, id, clientInfo);
713 if (stopResolveService(id)) {
714 clientInfo.onStopResolutionSucceeded(clientId);
715 } else {
716 clientInfo.onStopResolutionFailed(
717 clientId, NsdManager.FAILURE_OPERATION_NOT_RUNNING);
718 }
719 clientInfo.mResolvedService = null;
720 // TODO: Implement the stop resolution with MdnsDiscoveryManager.
721 break;
paulhu2b9ed952022-02-10 21:58:32 +0800722 case MDNS_SERVICE_EVENT:
723 if (!handleMDnsServiceEvent(msg.arg1, msg.arg2, msg.obj)) {
Hugo Benichif0c84092017-04-05 14:43:29 +0900724 return NOT_HANDLED;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700725 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700726 break;
Paul Hu019621e2023-01-13 23:26:49 +0800727 case MDNS_DISCOVERY_MANAGER_EVENT:
728 if (!handleMdnsDiscoveryManagerEvent(msg.arg1, msg.arg2, msg.obj)) {
729 return NOT_HANDLED;
730 }
731 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700732 default:
Hugo Benichif0c84092017-04-05 14:43:29 +0900733 return NOT_HANDLED;
Irfan Sheriff75006652012-04-17 23:15:29 -0700734 }
Hugo Benichif0c84092017-04-05 14:43:29 +0900735 return HANDLED;
Irfan Sheriff75006652012-04-17 23:15:29 -0700736 }
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700737
paulhu2b9ed952022-02-10 21:58:32 +0800738 private boolean handleMDnsServiceEvent(int code, int id, Object obj) {
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700739 NsdServiceInfo servInfo;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700740 ClientInfo clientInfo = mIdToClientInfoMap.get(id);
741 if (clientInfo == null) {
paulhu2b9ed952022-02-10 21:58:32 +0800742 Log.e(TAG, String.format("id %d for %d has no client mapping", id, code));
Hugo Benichif0c84092017-04-05 14:43:29 +0900743 return false;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700744 }
745
746 /* This goes in response as msg.arg2 */
Christopher Lane74411222014-04-25 18:39:07 -0700747 int clientId = clientInfo.getClientId(id);
748 if (clientId < 0) {
Vinit Deshapnde930a8512013-06-25 19:45:03 -0700749 // This can happen because of race conditions. For example,
750 // SERVICE_FOUND may race with STOP_SERVICE_DISCOVERY,
751 // and we may get in this situation.
paulhu2b9ed952022-02-10 21:58:32 +0800752 Log.d(TAG, String.format("%d for listener id %d that is no longer active",
753 code, id));
Hugo Benichif0c84092017-04-05 14:43:29 +0900754 return false;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700755 }
Hugo Benichi32be63d2017-04-05 14:06:11 +0900756 if (DBG) {
paulhu2b9ed952022-02-10 21:58:32 +0800757 Log.d(TAG, String.format("MDns service event code:%d id=%d", code, id));
Hugo Benichi32be63d2017-04-05 14:06:11 +0900758 }
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700759 switch (code) {
paulhu2b9ed952022-02-10 21:58:32 +0800760 case IMDnsEventListener.SERVICE_FOUND: {
761 final DiscoveryInfo info = (DiscoveryInfo) obj;
762 final String name = info.serviceName;
763 final String type = info.registrationType;
764 servInfo = new NsdServiceInfo(name, type);
765 final int foundNetId = info.netId;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +0900766 if (foundNetId == 0L) {
767 // Ignore services that do not have a Network: they are not usable
768 // by apps, as they would need privileged permissions to use
769 // interfaces that do not have an associated Network.
770 break;
771 }
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +0900772 setServiceNetworkForCallback(servInfo, info.netId, info.interfaceIdx);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900773 clientInfo.onServiceFound(clientId, servInfo);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700774 break;
paulhu2b9ed952022-02-10 21:58:32 +0800775 }
776 case IMDnsEventListener.SERVICE_LOST: {
777 final DiscoveryInfo info = (DiscoveryInfo) obj;
778 final String name = info.serviceName;
779 final String type = info.registrationType;
780 final int lostNetId = info.netId;
781 servInfo = new NsdServiceInfo(name, type);
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +0900782 // The network could be set to null (netId 0) if it was torn down when the
783 // service is lost
784 // TODO: avoid returning null in that case, possibly by remembering
785 // found services on the same interface index and their network at the time
786 setServiceNetworkForCallback(servInfo, lostNetId, info.interfaceIdx);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900787 clientInfo.onServiceLost(clientId, servInfo);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700788 break;
paulhu2b9ed952022-02-10 21:58:32 +0800789 }
790 case IMDnsEventListener.SERVICE_DISCOVERY_FAILED:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900791 clientInfo.onDiscoverServicesFailed(
792 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700793 break;
paulhu2b9ed952022-02-10 21:58:32 +0800794 case IMDnsEventListener.SERVICE_REGISTERED: {
795 final RegistrationInfo info = (RegistrationInfo) obj;
796 final String name = info.serviceName;
797 servInfo = new NsdServiceInfo(name, null /* serviceType */);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900798 clientInfo.onRegisterServiceSucceeded(clientId, servInfo);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700799 break;
paulhu2b9ed952022-02-10 21:58:32 +0800800 }
801 case IMDnsEventListener.SERVICE_REGISTRATION_FAILED:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900802 clientInfo.onRegisterServiceFailed(
803 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700804 break;
paulhu2b9ed952022-02-10 21:58:32 +0800805 case IMDnsEventListener.SERVICE_RESOLVED: {
806 final ResolutionInfo info = (ResolutionInfo) obj;
Sreeram Ramachandrana53dd7f2014-09-03 15:45:59 -0700807 int index = 0;
paulhu2b9ed952022-02-10 21:58:32 +0800808 final String fullName = info.serviceFullName;
809 while (index < fullName.length() && fullName.charAt(index) != '.') {
810 if (fullName.charAt(index) == '\\') {
Sreeram Ramachandrana53dd7f2014-09-03 15:45:59 -0700811 ++index;
812 }
813 ++index;
814 }
paulhu2b9ed952022-02-10 21:58:32 +0800815 if (index >= fullName.length()) {
816 Log.e(TAG, "Invalid service found " + fullName);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700817 break;
818 }
Remi NGUYEN VAN23651302021-12-16 15:31:16 +0900819
paulhube186602022-04-12 07:18:23 +0000820 String name = unescape(fullName.substring(0, index));
paulhu2b9ed952022-02-10 21:58:32 +0800821 String rest = fullName.substring(index);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700822 String type = rest.replace(".local.", "");
823
824 clientInfo.mResolvedService.setServiceName(name);
825 clientInfo.mResolvedService.setServiceType(type);
paulhu2b9ed952022-02-10 21:58:32 +0800826 clientInfo.mResolvedService.setPort(info.port);
827 clientInfo.mResolvedService.setTxtRecords(info.txtRecord);
Remi NGUYEN VAN23651302021-12-16 15:31:16 +0900828 // Network will be added after SERVICE_GET_ADDR_SUCCESS
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700829
830 stopResolveService(id);
Vinit Deshapnde4429e872013-11-12 15:36:37 -0800831 removeRequestMap(clientId, id, clientInfo);
832
paulhu2b9ed952022-02-10 21:58:32 +0800833 final int id2 = getUniqueId();
834 if (getAddrInfo(id2, info.hostname, info.interfaceIdx)) {
Dave Plattfeff2af2014-03-07 14:48:22 -0800835 storeRequestMap(clientId, id2, clientInfo, NsdManager.RESOLVE_SERVICE);
Vinit Deshapnde4429e872013-11-12 15:36:37 -0800836 } else {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900837 clientInfo.onResolveServiceFailed(
838 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700839 clientInfo.mResolvedService = null;
840 }
841 break;
paulhu2b9ed952022-02-10 21:58:32 +0800842 }
843 case IMDnsEventListener.SERVICE_RESOLUTION_FAILED:
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700844 /* NNN resolveId errorCode */
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700845 stopResolveService(id);
846 removeRequestMap(clientId, id, clientInfo);
847 clientInfo.mResolvedService = null;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900848 clientInfo.onResolveServiceFailed(
849 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700850 break;
paulhu2b9ed952022-02-10 21:58:32 +0800851 case IMDnsEventListener.SERVICE_GET_ADDR_FAILED:
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700852 /* NNN resolveId errorCode */
853 stopGetAddrInfo(id);
854 removeRequestMap(clientId, id, clientInfo);
855 clientInfo.mResolvedService = null;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900856 clientInfo.onResolveServiceFailed(
857 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700858 break;
paulhu2b9ed952022-02-10 21:58:32 +0800859 case IMDnsEventListener.SERVICE_GET_ADDR_SUCCESS: {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +0900860 /* NNN resolveId hostname ttl addr interfaceIdx netId */
paulhu2b9ed952022-02-10 21:58:32 +0800861 final GetAddressInfo info = (GetAddressInfo) obj;
862 final String address = info.address;
863 final int netId = info.netId;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +0900864 InetAddress serviceHost = null;
865 try {
paulhu2b9ed952022-02-10 21:58:32 +0800866 serviceHost = InetAddress.getByName(address);
Remi NGUYEN VAN23651302021-12-16 15:31:16 +0900867 } catch (UnknownHostException e) {
868 Log.wtf(TAG, "Invalid host in GET_ADDR_SUCCESS", e);
869 }
870
871 // If the resolved service is on an interface without a network, consider it
872 // as a failure: it would not be usable by apps as they would need
873 // privileged permissions.
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +0900874 if (netId != NETID_UNSET && serviceHost != null) {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +0900875 clientInfo.mResolvedService.setHost(serviceHost);
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +0900876 setServiceNetworkForCallback(clientInfo.mResolvedService,
877 netId, info.interfaceIdx);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900878 clientInfo.onResolveServiceSucceeded(
879 clientId, clientInfo.mResolvedService);
Remi NGUYEN VAN23651302021-12-16 15:31:16 +0900880 } else {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900881 clientInfo.onResolveServiceFailed(
882 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700883 }
884 stopGetAddrInfo(id);
885 removeRequestMap(clientId, id, clientInfo);
886 clientInfo.mResolvedService = null;
887 break;
paulhu2b9ed952022-02-10 21:58:32 +0800888 }
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700889 default:
Hugo Benichif0c84092017-04-05 14:43:29 +0900890 return false;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700891 }
Hugo Benichif0c84092017-04-05 14:43:29 +0900892 return true;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700893 }
Paul Hu019621e2023-01-13 23:26:49 +0800894
895 private NsdServiceInfo buildNsdServiceInfoFromMdnsEvent(final MdnsEvent event) {
896 final MdnsServiceInfo serviceInfo = event.mMdnsServiceInfo;
897 final String serviceType = event.mRequestedServiceType;
898 final String serviceName = serviceInfo.getServiceInstanceName();
899 final NsdServiceInfo servInfo = new NsdServiceInfo(serviceName, serviceType);
900 final Network network = serviceInfo.getNetwork();
901 setServiceNetworkForCallback(
902 servInfo,
903 network == null ? NETID_UNSET : network.netId,
904 serviceInfo.getInterfaceIndex());
905 return servInfo;
906 }
907
908 private boolean handleMdnsDiscoveryManagerEvent(
909 int transactionId, int code, Object obj) {
910 final ClientInfo clientInfo = mIdToClientInfoMap.get(transactionId);
911 if (clientInfo == null) {
912 Log.e(TAG, String.format(
913 "id %d for %d has no client mapping", transactionId, code));
914 return false;
915 }
916
917 final MdnsEvent event = (MdnsEvent) obj;
918 final int clientId = event.mClientId;
Paul Hu319751a2023-01-13 23:56:34 +0800919 final NsdServiceInfo info = buildNsdServiceInfoFromMdnsEvent(event);
Paul Hu019621e2023-01-13 23:26:49 +0800920 if (DBG) {
921 Log.d(TAG, String.format("MdnsDiscoveryManager event code=%s transactionId=%d",
922 NsdManager.nameOf(code), transactionId));
923 }
924 switch (code) {
925 case NsdManager.SERVICE_FOUND:
Paul Hu319751a2023-01-13 23:56:34 +0800926 clientInfo.onServiceFound(clientId, info);
927 break;
928 case NsdManager.SERVICE_LOST:
929 clientInfo.onServiceLost(clientId, info);
Paul Hu019621e2023-01-13 23:26:49 +0800930 break;
Paul Hu75069ed2023-01-14 00:31:09 +0800931 case NsdManager.RESOLVE_SERVICE_SUCCEEDED: {
932 final MdnsServiceInfo serviceInfo = event.mMdnsServiceInfo;
933 // Add '.' in front of the service type that aligns with historical behavior
934 info.setServiceType("." + event.mRequestedServiceType);
935 info.setPort(serviceInfo.getPort());
936
937 Map<String, String> attrs = serviceInfo.getAttributes();
938 for (Map.Entry<String, String> kv : attrs.entrySet()) {
939 final String key = kv.getKey();
940 try {
941 info.setAttribute(key, serviceInfo.getAttributeAsBytes(key));
942 } catch (IllegalArgumentException e) {
943 Log.e(TAG, "Invalid attribute", e);
944 }
945 }
946 try {
947 if (serviceInfo.getIpv4Address() != null) {
948 info.setHost(InetAddresses.parseNumericAddress(
949 serviceInfo.getIpv4Address()));
950 } else {
951 info.setHost(InetAddresses.parseNumericAddress(
952 serviceInfo.getIpv6Address()));
953 }
954 clientInfo.onResolveServiceSucceeded(clientId, info);
955 } catch (IllegalArgumentException e) {
956 Log.wtf(TAG, "Invalid address in RESOLVE_SERVICE_SUCCEEDED", e);
957 clientInfo.onResolveServiceFailed(
958 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
959 }
960
961 // Unregister the listener immediately like IMDnsEventListener design
962 final MdnsListener listener = clientInfo.mListeners.get(clientId);
963 mMdnsDiscoveryManager.unregisterListener(
964 listener.getListenedServiceType(), listener);
965 removeListenerMap(clientId, transactionId, clientInfo);
966 break;
967 }
Paul Hu019621e2023-01-13 23:26:49 +0800968 default:
969 return false;
970 }
971 return true;
972 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700973 }
974 }
Irfan Sheriff77ec5582012-03-22 17:01:39 -0700975
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +0900976 private static void setServiceNetworkForCallback(NsdServiceInfo info, int netId, int ifaceIdx) {
977 switch (netId) {
978 case NETID_UNSET:
979 info.setNetwork(null);
980 break;
981 case INetd.LOCAL_NET_ID:
982 // Special case for LOCAL_NET_ID: Networks on netId 99 are not generally
983 // visible / usable for apps, so do not return it. Store the interface
984 // index instead, so at least if the client tries to resolve the service
985 // with that NsdServiceInfo, it will be done on the same interface.
986 // If they recreate the NsdServiceInfo themselves, resolution would be
987 // done on all interfaces as before T, which should also work.
988 info.setNetwork(null);
989 info.setInterfaceIndex(ifaceIdx);
990 break;
991 default:
992 info.setNetwork(new Network(netId));
993 }
994 }
995
paulhube186602022-04-12 07:18:23 +0000996 // The full service name is escaped from standard DNS rules on mdnsresponder, making it suitable
997 // for passing to standard system DNS APIs such as res_query() . Thus, make the service name
998 // unescape for getting right service address. See "Notes on DNS Name Escaping" on
999 // external/mdnsresponder/mDNSShared/dns_sd.h for more details.
1000 private String unescape(String s) {
1001 StringBuilder sb = new StringBuilder(s.length());
1002 for (int i = 0; i < s.length(); ++i) {
1003 char c = s.charAt(i);
1004 if (c == '\\') {
1005 if (++i >= s.length()) {
1006 Log.e(TAG, "Unexpected end of escape sequence in: " + s);
1007 break;
1008 }
1009 c = s.charAt(i);
1010 if (c != '.' && c != '\\') {
1011 if (i + 2 >= s.length()) {
1012 Log.e(TAG, "Unexpected end of escape sequence in: " + s);
1013 break;
1014 }
1015 c = (char) ((c - '0') * 100 + (s.charAt(i + 1) - '0') * 10
1016 + (s.charAt(i + 2) - '0'));
1017 i += 2;
1018 }
1019 }
1020 sb.append(c);
1021 }
1022 return sb.toString();
1023 }
1024
Hugo Benichi803a2f02017-04-24 11:35:06 +09001025 @VisibleForTesting
paulhu2b9ed952022-02-10 21:58:32 +08001026 NsdService(Context ctx, Handler handler, long cleanupDelayMs) {
Paul Hu4bd98ef2023-01-12 13:42:07 +08001027 this(ctx, handler, cleanupDelayMs, new Dependencies());
1028 }
1029
1030 @VisibleForTesting
1031 NsdService(Context ctx, Handler handler, long cleanupDelayMs, Dependencies deps) {
Luke Huang05298582021-06-13 16:52:05 +00001032 mCleanupDelayMs = cleanupDelayMs;
Hugo Benichi803a2f02017-04-24 11:35:06 +09001033 mContext = ctx;
Hugo Benichi803a2f02017-04-24 11:35:06 +09001034 mNsdStateMachine = new NsdStateMachine(TAG, handler);
Irfan Sheriff75006652012-04-17 23:15:29 -07001035 mNsdStateMachine.start();
paulhu2b9ed952022-02-10 21:58:32 +08001036 mMDnsManager = ctx.getSystemService(MDnsManager.class);
1037 mMDnsEventCallback = new MDnsEventCallback(mNsdStateMachine);
Paul Hu4bd98ef2023-01-12 13:42:07 +08001038 if (deps.isMdnsDiscoveryManagerEnabled(ctx)) {
1039 mMdnsSocketProvider = deps.makeMdnsSocketProvider(ctx, handler.getLooper());
1040 mMdnsSocketClient =
1041 new MdnsMultinetworkSocketClient(handler.getLooper(), mMdnsSocketProvider);
1042 mMdnsDiscoveryManager =
1043 deps.makeMdnsDiscoveryManager(new ExecutorProvider(), mMdnsSocketClient);
1044 handler.post(() -> mMdnsSocketClient.setCallback(mMdnsDiscoveryManager));
1045 } else {
1046 mMdnsSocketProvider = null;
1047 mMdnsSocketClient = null;
1048 mMdnsDiscoveryManager = null;
1049 }
1050 }
1051
1052 /**
1053 * Dependencies of NsdService, for injection in tests.
1054 */
1055 @VisibleForTesting
1056 public static class Dependencies {
1057 /**
1058 * Check whether or not MdnsDiscoveryManager feature is enabled.
1059 *
1060 * @param context The global context information about an app environment.
1061 * @return true if MdnsDiscoveryManager feature is enabled.
1062 */
1063 public boolean isMdnsDiscoveryManagerEnabled(Context context) {
1064 return DeviceConfigUtils.isFeatureEnabled(context, NAMESPACE_CONNECTIVITY,
1065 MDNS_DISCOVERY_MANAGER_VERSION, false /* defaultEnabled */);
1066 }
1067
1068 /**
1069 * @see MdnsDiscoveryManager
1070 */
1071 public MdnsDiscoveryManager makeMdnsDiscoveryManager(
1072 ExecutorProvider executorProvider, MdnsSocketClientBase socketClient) {
1073 return new MdnsDiscoveryManager(executorProvider, socketClient);
1074 }
1075
1076 /**
1077 * @see MdnsSocketProvider
1078 */
1079 public MdnsSocketProvider makeMdnsSocketProvider(Context context, Looper looper) {
1080 return new MdnsSocketProvider(context, looper);
1081 }
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001082 }
1083
paulhu1b35e822022-04-08 14:48:41 +08001084 public static NsdService create(Context context) {
Hugo Benichi803a2f02017-04-24 11:35:06 +09001085 HandlerThread thread = new HandlerThread(TAG);
1086 thread.start();
1087 Handler handler = new Handler(thread.getLooper());
paulhu2b9ed952022-02-10 21:58:32 +08001088 NsdService service = new NsdService(context, handler, CLEANUP_DELAY_MS);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001089 return service;
1090 }
1091
paulhu2b9ed952022-02-10 21:58:32 +08001092 private static class MDnsEventCallback extends IMDnsEventListener.Stub {
1093 private final StateMachine mStateMachine;
1094
1095 MDnsEventCallback(StateMachine sm) {
1096 mStateMachine = sm;
1097 }
1098
1099 @Override
1100 public void onServiceRegistrationStatus(final RegistrationInfo status) {
1101 mStateMachine.sendMessage(
1102 MDNS_SERVICE_EVENT, status.result, status.id, status);
1103 }
1104
1105 @Override
1106 public void onServiceDiscoveryStatus(final DiscoveryInfo status) {
1107 mStateMachine.sendMessage(
1108 MDNS_SERVICE_EVENT, status.result, status.id, status);
1109 }
1110
1111 @Override
1112 public void onServiceResolutionStatus(final ResolutionInfo status) {
1113 mStateMachine.sendMessage(
1114 MDNS_SERVICE_EVENT, status.result, status.id, status);
1115 }
1116
1117 @Override
1118 public void onGettingServiceAddressStatus(final GetAddressInfo status) {
1119 mStateMachine.sendMessage(
1120 MDNS_SERVICE_EVENT, status.result, status.id, status);
1121 }
1122
1123 @Override
1124 public int getInterfaceVersion() throws RemoteException {
1125 return this.VERSION;
1126 }
1127
1128 @Override
1129 public String getInterfaceHash() throws RemoteException {
1130 return this.HASH;
1131 }
1132 }
1133
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001134 @Override
1135 public INsdServiceConnector connect(INsdManagerCallback cb) {
Hugo Benichi803a2f02017-04-24 11:35:06 +09001136 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.INTERNET, "NsdService");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001137 final INsdServiceConnector connector = new NsdServiceConnector();
1138 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1139 NsdManager.REGISTER_CLIENT, new Pair<>(connector, cb)));
1140 return connector;
Irfan Sheriff75006652012-04-17 23:15:29 -07001141 }
1142
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001143 private static class ListenerArgs {
1144 public final NsdServiceConnector connector;
1145 public final NsdServiceInfo serviceInfo;
1146 ListenerArgs(NsdServiceConnector connector, NsdServiceInfo serviceInfo) {
1147 this.connector = connector;
1148 this.serviceInfo = serviceInfo;
1149 }
1150 }
1151
1152 private class NsdServiceConnector extends INsdServiceConnector.Stub
1153 implements IBinder.DeathRecipient {
1154 @Override
1155 public void registerService(int listenerKey, NsdServiceInfo serviceInfo) {
1156 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1157 NsdManager.REGISTER_SERVICE, 0, listenerKey,
1158 new ListenerArgs(this, serviceInfo)));
1159 }
1160
1161 @Override
1162 public void unregisterService(int listenerKey) {
1163 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1164 NsdManager.UNREGISTER_SERVICE, 0, listenerKey,
1165 new ListenerArgs(this, null)));
1166 }
1167
1168 @Override
1169 public void discoverServices(int listenerKey, NsdServiceInfo serviceInfo) {
1170 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1171 NsdManager.DISCOVER_SERVICES, 0, listenerKey,
1172 new ListenerArgs(this, serviceInfo)));
1173 }
1174
1175 @Override
1176 public void stopDiscovery(int listenerKey) {
1177 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1178 NsdManager.STOP_DISCOVERY, 0, listenerKey, new ListenerArgs(this, null)));
1179 }
1180
1181 @Override
1182 public void resolveService(int listenerKey, NsdServiceInfo serviceInfo) {
1183 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1184 NsdManager.RESOLVE_SERVICE, 0, listenerKey,
1185 new ListenerArgs(this, serviceInfo)));
1186 }
1187
1188 @Override
Paul Hub58deb72022-12-26 09:24:42 +00001189 public void stopResolution(int listenerKey) {
1190 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1191 NsdManager.STOP_RESOLUTION, 0, listenerKey, new ListenerArgs(this, null)));
1192 }
1193
1194 @Override
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001195 public void startDaemon() {
1196 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1197 NsdManager.DAEMON_STARTUP, new ListenerArgs(this, null)));
1198 }
1199
1200 @Override
1201 public void binderDied() {
1202 mNsdStateMachine.sendMessage(
1203 mNsdStateMachine.obtainMessage(NsdManager.UNREGISTER_CLIENT, this));
1204 }
Irfan Sheriff75006652012-04-17 23:15:29 -07001205 }
1206
Hugo Benichi912db992017-04-24 16:41:03 +09001207 private void sendNsdStateChangeBroadcast(boolean isEnabled) {
Irfan Sheriff52fc83a2012-04-19 10:26:34 -07001208 final Intent intent = new Intent(NsdManager.ACTION_NSD_STATE_CHANGED);
Irfan Sheriff75006652012-04-17 23:15:29 -07001209 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT);
Hugo Benichi912db992017-04-24 16:41:03 +09001210 int nsdState = isEnabled ? NsdManager.NSD_STATE_ENABLED : NsdManager.NSD_STATE_DISABLED;
1211 intent.putExtra(NsdManager.EXTRA_NSD_STATE, nsdState);
Dianne Hackborn692107e2012-08-29 18:32:08 -07001212 mContext.sendStickyBroadcastAsUser(intent, UserHandle.ALL);
Irfan Sheriff75006652012-04-17 23:15:29 -07001213 }
1214
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001215 private int getUniqueId() {
1216 if (++mUniqueId == INVALID_ID) return ++mUniqueId;
1217 return mUniqueId;
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001218 }
1219
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001220 private boolean registerService(int regId, NsdServiceInfo service) {
Hugo Benichi6d706442017-04-24 16:19:58 +09001221 if (DBG) {
paulhub2225702021-11-17 09:35:33 +08001222 Log.d(TAG, "registerService: " + regId + " " + service);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001223 }
Hugo Benichi6d706442017-04-24 16:19:58 +09001224 String name = service.getServiceName();
1225 String type = service.getServiceType();
1226 int port = service.getPort();
1227 byte[] textRecord = service.getTxtRecord();
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001228 final int registerInterface = getNetworkInterfaceIndex(service);
1229 if (service.getNetwork() != null && registerInterface == IFACE_IDX_ANY) {
Paul Hu360a8e92022-04-26 11:14:14 +08001230 Log.e(TAG, "Interface to register service on not found");
1231 return false;
1232 }
1233 return mMDnsManager.registerService(regId, name, type, port, textRecord, registerInterface);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001234 }
1235
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001236 private boolean unregisterService(int regId) {
paulhu2b9ed952022-02-10 21:58:32 +08001237 return mMDnsManager.stopOperation(regId);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001238 }
1239
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001240 private boolean discoverServices(int discoveryId, NsdServiceInfo serviceInfo) {
paulhu2b9ed952022-02-10 21:58:32 +08001241 final String type = serviceInfo.getServiceType();
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001242 final int discoverInterface = getNetworkInterfaceIndex(serviceInfo);
1243 if (serviceInfo.getNetwork() != null && discoverInterface == IFACE_IDX_ANY) {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001244 Log.e(TAG, "Interface to discover service on not found");
1245 return false;
1246 }
paulhu2b9ed952022-02-10 21:58:32 +08001247 return mMDnsManager.discover(discoveryId, type, discoverInterface);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001248 }
1249
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001250 private boolean stopServiceDiscovery(int discoveryId) {
paulhu2b9ed952022-02-10 21:58:32 +08001251 return mMDnsManager.stopOperation(discoveryId);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001252 }
1253
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001254 private boolean resolveService(int resolveId, NsdServiceInfo service) {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001255 final String name = service.getServiceName();
1256 final String type = service.getServiceType();
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001257 final int resolveInterface = getNetworkInterfaceIndex(service);
1258 if (service.getNetwork() != null && resolveInterface == IFACE_IDX_ANY) {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001259 Log.e(TAG, "Interface to resolve service on not found");
1260 return false;
1261 }
paulhu2b9ed952022-02-10 21:58:32 +08001262 return mMDnsManager.resolve(resolveId, name, type, "local.", resolveInterface);
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001263 }
1264
1265 /**
1266 * Guess the interface to use to resolve or discover a service on a specific network.
1267 *
1268 * This is an imperfect guess, as for example the network may be gone or not yet fully
1269 * registered. This is fine as failing is correct if the network is gone, and a client
1270 * attempting to resolve/discover on a network not yet setup would have a bad time anyway; also
1271 * this is to support the legacy mdnsresponder implementation, which historically resolved
1272 * services on an unspecified network.
1273 */
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001274 private int getNetworkInterfaceIndex(NsdServiceInfo serviceInfo) {
1275 final Network network = serviceInfo.getNetwork();
1276 if (network == null) {
1277 // Fallback to getInterfaceIndex if present (typically if the NsdServiceInfo was
1278 // provided by NsdService from discovery results, and the service was found on an
1279 // interface that has no app-usable Network).
1280 if (serviceInfo.getInterfaceIndex() != 0) {
1281 return serviceInfo.getInterfaceIndex();
1282 }
1283 return IFACE_IDX_ANY;
1284 }
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001285
1286 final ConnectivityManager cm = mContext.getSystemService(ConnectivityManager.class);
1287 if (cm == null) {
1288 Log.wtf(TAG, "No ConnectivityManager for resolveService");
1289 return IFACE_IDX_ANY;
1290 }
1291 final LinkProperties lp = cm.getLinkProperties(network);
1292 if (lp == null) return IFACE_IDX_ANY;
1293
1294 // Only resolve on non-stacked interfaces
1295 final NetworkInterface iface;
1296 try {
1297 iface = NetworkInterface.getByName(lp.getInterfaceName());
1298 } catch (SocketException e) {
1299 Log.e(TAG, "Error querying interface", e);
1300 return IFACE_IDX_ANY;
1301 }
1302
1303 if (iface == null) {
1304 Log.e(TAG, "Interface not found: " + lp.getInterfaceName());
1305 return IFACE_IDX_ANY;
1306 }
1307
1308 return iface.getIndex();
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001309 }
1310
1311 private boolean stopResolveService(int resolveId) {
paulhu2b9ed952022-02-10 21:58:32 +08001312 return mMDnsManager.stopOperation(resolveId);
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001313 }
1314
paulhu2b9ed952022-02-10 21:58:32 +08001315 private boolean getAddrInfo(int resolveId, String hostname, int interfaceIdx) {
1316 return mMDnsManager.getServiceAddress(resolveId, hostname, interfaceIdx);
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001317 }
1318
1319 private boolean stopGetAddrInfo(int resolveId) {
paulhu2b9ed952022-02-10 21:58:32 +08001320 return mMDnsManager.stopOperation(resolveId);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001321 }
1322
1323 @Override
Irfan Sheriff75006652012-04-17 23:15:29 -07001324 public void dump(FileDescriptor fd, PrintWriter pw, String[] args) {
paulhu3ffffe72021-09-16 10:15:22 +08001325 if (!PermissionUtils.checkDumpPermission(mContext, TAG, pw)) return;
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001326
Irfan Sheriff75006652012-04-17 23:15:29 -07001327 for (ClientInfo client : mClients.values()) {
1328 pw.println("Client Info");
1329 pw.println(client);
1330 }
1331
1332 mNsdStateMachine.dump(fd, pw, args);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001333 }
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001334
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001335 /* Information tracked per client */
1336 private class ClientInfo {
1337
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001338 private static final int MAX_LIMIT = 10;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001339 private final INsdManagerCallback mCb;
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001340 /* Remembers a resolved service until getaddrinfo completes */
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001341 private NsdServiceInfo mResolvedService;
1342
1343 /* A map from client id to unique id sent to mDns */
Hugo Benichid2552ae2017-04-11 14:42:47 +09001344 private final SparseIntArray mClientIds = new SparseIntArray();
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001345
Dave Plattfeff2af2014-03-07 14:48:22 -08001346 /* A map from client id to the type of the request we had received */
Hugo Benichid2552ae2017-04-11 14:42:47 +09001347 private final SparseIntArray mClientRequests = new SparseIntArray();
Dave Plattfeff2af2014-03-07 14:48:22 -08001348
Paul Hu23fa2022023-01-13 22:57:24 +08001349 /* A map from client id to the MdnsListener */
1350 private final SparseArray<MdnsListener> mListeners = new SparseArray<>();
1351
Luke Huangf7277ed2021-07-12 21:15:10 +08001352 // The target SDK of this client < Build.VERSION_CODES.S
1353 private boolean mIsLegacy = false;
1354
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001355 private ClientInfo(INsdManagerCallback cb) {
1356 mCb = cb;
paulhub2225702021-11-17 09:35:33 +08001357 if (DBG) Log.d(TAG, "New client");
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001358 }
Irfan Sheriff75006652012-04-17 23:15:29 -07001359
1360 @Override
1361 public String toString() {
Jeff Sharkey63465382020-10-17 21:20:13 -06001362 StringBuilder sb = new StringBuilder();
Irfan Sheriff75006652012-04-17 23:15:29 -07001363 sb.append("mResolvedService ").append(mResolvedService).append("\n");
Luke Huangf7277ed2021-07-12 21:15:10 +08001364 sb.append("mIsLegacy ").append(mIsLegacy).append("\n");
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001365 for(int i = 0; i< mClientIds.size(); i++) {
Dave Plattfeff2af2014-03-07 14:48:22 -08001366 int clientID = mClientIds.keyAt(i);
1367 sb.append("clientId ").append(clientID).
1368 append(" mDnsId ").append(mClientIds.valueAt(i)).
1369 append(" type ").append(mClientRequests.get(clientID)).append("\n");
Irfan Sheriff75006652012-04-17 23:15:29 -07001370 }
1371 return sb.toString();
1372 }
Dave Plattfeff2af2014-03-07 14:48:22 -08001373
Luke Huangf7277ed2021-07-12 21:15:10 +08001374 private boolean isLegacy() {
1375 return mIsLegacy;
1376 }
1377
1378 private void setLegacy() {
1379 mIsLegacy = true;
1380 }
1381
Dave Plattfeff2af2014-03-07 14:48:22 -08001382 // Remove any pending requests from the global map when we get rid of a client,
1383 // and send cancellations to the daemon.
1384 private void expungeAllRequests() {
1385 int globalId, clientId, i;
Hugo Benichid2552ae2017-04-11 14:42:47 +09001386 // TODO: to keep handler responsive, do not clean all requests for that client at once.
Dave Plattfeff2af2014-03-07 14:48:22 -08001387 for (i = 0; i < mClientIds.size(); i++) {
1388 clientId = mClientIds.keyAt(i);
1389 globalId = mClientIds.valueAt(i);
1390 mIdToClientInfoMap.remove(globalId);
paulhub2225702021-11-17 09:35:33 +08001391 if (DBG) {
1392 Log.d(TAG, "Terminating client-ID " + clientId
1393 + " global-ID " + globalId + " type " + mClientRequests.get(clientId));
1394 }
Dave Plattfeff2af2014-03-07 14:48:22 -08001395 switch (mClientRequests.get(clientId)) {
1396 case NsdManager.DISCOVER_SERVICES:
1397 stopServiceDiscovery(globalId);
1398 break;
1399 case NsdManager.RESOLVE_SERVICE:
1400 stopResolveService(globalId);
1401 break;
1402 case NsdManager.REGISTER_SERVICE:
1403 unregisterService(globalId);
1404 break;
1405 default:
1406 break;
1407 }
1408 }
1409 mClientIds.clear();
1410 mClientRequests.clear();
1411 }
1412
Paul Hu23fa2022023-01-13 22:57:24 +08001413 void unregisterAllListeners() {
1414 for (int i = 0; i < mListeners.size(); i++) {
1415 final MdnsListener listener = mListeners.valueAt(i);
1416 mMdnsDiscoveryManager.unregisterListener(
1417 listener.getListenedServiceType(), listener);
1418 }
1419 mListeners.clear();
1420 }
1421
Christopher Lane74411222014-04-25 18:39:07 -07001422 // mClientIds is a sparse array of listener id -> mDnsClient id. For a given mDnsClient id,
1423 // return the corresponding listener id. mDnsClient id is also called a global id.
1424 private int getClientId(final int globalId) {
Hugo Benichid2552ae2017-04-11 14:42:47 +09001425 int idx = mClientIds.indexOfValue(globalId);
1426 if (idx < 0) {
1427 return idx;
Christopher Lane74411222014-04-25 18:39:07 -07001428 }
Hugo Benichid2552ae2017-04-11 14:42:47 +09001429 return mClientIds.keyAt(idx);
Christopher Lane74411222014-04-25 18:39:07 -07001430 }
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001431
1432 void onDiscoverServicesStarted(int listenerKey, NsdServiceInfo info) {
1433 try {
1434 mCb.onDiscoverServicesStarted(listenerKey, info);
1435 } catch (RemoteException e) {
1436 Log.e(TAG, "Error calling onDiscoverServicesStarted", e);
1437 }
1438 }
1439
1440 void onDiscoverServicesFailed(int listenerKey, int error) {
1441 try {
1442 mCb.onDiscoverServicesFailed(listenerKey, error);
1443 } catch (RemoteException e) {
1444 Log.e(TAG, "Error calling onDiscoverServicesFailed", e);
1445 }
1446 }
1447
1448 void onServiceFound(int listenerKey, NsdServiceInfo info) {
1449 try {
1450 mCb.onServiceFound(listenerKey, info);
1451 } catch (RemoteException e) {
1452 Log.e(TAG, "Error calling onServiceFound(", e);
1453 }
1454 }
1455
1456 void onServiceLost(int listenerKey, NsdServiceInfo info) {
1457 try {
1458 mCb.onServiceLost(listenerKey, info);
1459 } catch (RemoteException e) {
1460 Log.e(TAG, "Error calling onServiceLost(", e);
1461 }
1462 }
1463
1464 void onStopDiscoveryFailed(int listenerKey, int error) {
1465 try {
1466 mCb.onStopDiscoveryFailed(listenerKey, error);
1467 } catch (RemoteException e) {
1468 Log.e(TAG, "Error calling onStopDiscoveryFailed", e);
1469 }
1470 }
1471
1472 void onStopDiscoverySucceeded(int listenerKey) {
1473 try {
1474 mCb.onStopDiscoverySucceeded(listenerKey);
1475 } catch (RemoteException e) {
1476 Log.e(TAG, "Error calling onStopDiscoverySucceeded", e);
1477 }
1478 }
1479
1480 void onRegisterServiceFailed(int listenerKey, int error) {
1481 try {
1482 mCb.onRegisterServiceFailed(listenerKey, error);
1483 } catch (RemoteException e) {
1484 Log.e(TAG, "Error calling onRegisterServiceFailed", e);
1485 }
1486 }
1487
1488 void onRegisterServiceSucceeded(int listenerKey, NsdServiceInfo info) {
1489 try {
1490 mCb.onRegisterServiceSucceeded(listenerKey, info);
1491 } catch (RemoteException e) {
1492 Log.e(TAG, "Error calling onRegisterServiceSucceeded", e);
1493 }
1494 }
1495
1496 void onUnregisterServiceFailed(int listenerKey, int error) {
1497 try {
1498 mCb.onUnregisterServiceFailed(listenerKey, error);
1499 } catch (RemoteException e) {
1500 Log.e(TAG, "Error calling onUnregisterServiceFailed", e);
1501 }
1502 }
1503
1504 void onUnregisterServiceSucceeded(int listenerKey) {
1505 try {
1506 mCb.onUnregisterServiceSucceeded(listenerKey);
1507 } catch (RemoteException e) {
1508 Log.e(TAG, "Error calling onUnregisterServiceSucceeded", e);
1509 }
1510 }
1511
1512 void onResolveServiceFailed(int listenerKey, int error) {
1513 try {
1514 mCb.onResolveServiceFailed(listenerKey, error);
1515 } catch (RemoteException e) {
1516 Log.e(TAG, "Error calling onResolveServiceFailed", e);
1517 }
1518 }
1519
1520 void onResolveServiceSucceeded(int listenerKey, NsdServiceInfo info) {
1521 try {
1522 mCb.onResolveServiceSucceeded(listenerKey, info);
1523 } catch (RemoteException e) {
1524 Log.e(TAG, "Error calling onResolveServiceSucceeded", e);
1525 }
1526 }
Paul Hub58deb72022-12-26 09:24:42 +00001527
1528 void onStopResolutionFailed(int listenerKey, int error) {
1529 try {
1530 mCb.onStopResolutionFailed(listenerKey, error);
1531 } catch (RemoteException e) {
1532 Log.e(TAG, "Error calling onStopResolutionFailed", e);
1533 }
1534 }
1535
1536 void onStopResolutionSucceeded(int listenerKey) {
1537 try {
1538 mCb.onStopResolutionSucceeded(listenerKey);
1539 } catch (RemoteException e) {
1540 Log.e(TAG, "Error calling onStopResolutionSucceeded", e);
1541 }
1542 }
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001543 }
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001544}