blob: c92e9a941b6a1167971d721e485b72e47f7d3b17 [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;
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +090023import static android.provider.DeviceConfig.NAMESPACE_TETHERING;
paulhu2b9ed952022-02-10 21:58:32 +080024
Remi NGUYEN VANbeb03f12023-03-08 19:03:27 +090025import static com.android.modules.utils.build.SdkLevel.isAtLeastU;
26
Paul Hu23fa2022023-01-13 22:57:24 +080027import android.annotation.NonNull;
Paul Hu4bd98ef2023-01-12 13:42:07 +080028import android.annotation.Nullable;
paulhua262cc12019-08-12 16:25:11 +080029import android.content.Context;
Irfan Sheriff75006652012-04-17 23:15:29 -070030import android.content.Intent;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +090031import android.net.ConnectivityManager;
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +090032import android.net.INetd;
Paul Hu75069ed2023-01-14 00:31:09 +080033import android.net.InetAddresses;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +090034import android.net.LinkProperties;
35import android.net.Network;
paulhu2b9ed952022-02-10 21:58:32 +080036import android.net.mdns.aidl.DiscoveryInfo;
37import android.net.mdns.aidl.GetAddressInfo;
38import android.net.mdns.aidl.IMDnsEventListener;
39import android.net.mdns.aidl.RegistrationInfo;
40import android.net.mdns.aidl.ResolutionInfo;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070041import android.net.nsd.INsdManager;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +090042import android.net.nsd.INsdManagerCallback;
43import android.net.nsd.INsdServiceConnector;
paulhu2b9ed952022-02-10 21:58:32 +080044import android.net.nsd.MDnsManager;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070045import android.net.nsd.NsdManager;
paulhua262cc12019-08-12 16:25:11 +080046import android.net.nsd.NsdServiceInfo;
Hugo Benichi803a2f02017-04-24 11:35:06 +090047import android.os.Handler;
paulhua262cc12019-08-12 16:25:11 +080048import android.os.HandlerThread;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +090049import android.os.IBinder;
Paul Hu4bd98ef2023-01-12 13:42:07 +080050import android.os.Looper;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070051import android.os.Message;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +090052import android.os.RemoteException;
Dianne Hackborn692107e2012-08-29 18:32:08 -070053import android.os.UserHandle;
Paul Hu23fa2022023-01-13 22:57:24 +080054import android.text.TextUtils;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +090055import android.util.Log;
56import android.util.Pair;
Irfan Sheriffe4c42f42012-05-03 16:44:27 -070057import android.util.SparseArray;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070058
paulhua262cc12019-08-12 16:25:11 +080059import com.android.internal.annotations.VisibleForTesting;
paulhua262cc12019-08-12 16:25:11 +080060import com.android.internal.util.State;
61import com.android.internal.util.StateMachine;
Paul Hu4bd98ef2023-01-12 13:42:07 +080062import com.android.net.module.util.DeviceConfigUtils;
paulhu3ffffe72021-09-16 10:15:22 +080063import com.android.net.module.util.PermissionUtils;
Paul Hu4bd98ef2023-01-12 13:42:07 +080064import com.android.server.connectivity.mdns.ExecutorProvider;
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +090065import com.android.server.connectivity.mdns.MdnsAdvertiser;
Paul Hu4bd98ef2023-01-12 13:42:07 +080066import com.android.server.connectivity.mdns.MdnsDiscoveryManager;
67import com.android.server.connectivity.mdns.MdnsMultinetworkSocketClient;
Paul Hu23fa2022023-01-13 22:57:24 +080068import com.android.server.connectivity.mdns.MdnsSearchOptions;
69import com.android.server.connectivity.mdns.MdnsServiceBrowserListener;
70import com.android.server.connectivity.mdns.MdnsServiceInfo;
Paul Hu4bd98ef2023-01-12 13:42:07 +080071import com.android.server.connectivity.mdns.MdnsSocketClientBase;
72import com.android.server.connectivity.mdns.MdnsSocketProvider;
paulhua262cc12019-08-12 16:25:11 +080073
Irfan Sheriff77ec5582012-03-22 17:01:39 -070074import java.io.FileDescriptor;
75import java.io.PrintWriter;
Irfan Sheriffe8de2462012-04-11 14:52:19 -070076import java.net.InetAddress;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +090077import java.net.NetworkInterface;
78import java.net.SocketException;
79import java.net.UnknownHostException;
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +090080import java.nio.ByteBuffer;
81import java.nio.CharBuffer;
82import java.nio.charset.Charset;
83import java.nio.charset.CharsetEncoder;
84import java.nio.charset.StandardCharsets;
Paul Hu2b865912023-03-06 14:27:53 +080085import java.util.ArrayList;
Irfan Sheriffe8de2462012-04-11 14:52:19 -070086import java.util.HashMap;
Paul Hu23fa2022023-01-13 22:57:24 +080087import java.util.List;
Paul Hu75069ed2023-01-14 00:31:09 +080088import java.util.Map;
Paul Hu23fa2022023-01-13 22:57:24 +080089import java.util.regex.Matcher;
90import java.util.regex.Pattern;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070091
Irfan Sheriff77ec5582012-03-22 17:01:39 -070092/**
93 * Network Service Discovery Service handles remote service discovery operation requests by
94 * implementing the INsdManager interface.
95 *
96 * @hide
97 */
98public class NsdService extends INsdManager.Stub {
99 private static final String TAG = "NsdService";
100 private static final String MDNS_TAG = "mDnsConnector";
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900101 /**
102 * Enable discovery using the Java DiscoveryManager, instead of the legacy mdnsresponder
103 * implementation.
104 */
Paul Hu4bd98ef2023-01-12 13:42:07 +0800105 private static final String MDNS_DISCOVERY_MANAGER_VERSION = "mdns_discovery_manager_version";
Paul Hu23fa2022023-01-13 22:57:24 +0800106 private static final String LOCAL_DOMAIN_NAME = "local";
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900107 // Max label length as per RFC 1034/1035
108 private static final int MAX_LABEL_LENGTH = 63;
Irfan Sheriff77ec5582012-03-22 17:01:39 -0700109
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900110 /**
111 * Enable advertising using the Java MdnsAdvertiser, instead of the legacy mdnsresponder
112 * implementation.
113 */
114 private static final String MDNS_ADVERTISER_VERSION = "mdns_advertiser_version";
115
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +0900116 /**
117 * Comma-separated list of type:flag mappings indicating the flags to use to allowlist
118 * discovery/advertising using MdnsDiscoveryManager / MdnsAdvertiser for a given type.
119 *
120 * For example _mytype._tcp.local and _othertype._tcp.local would be configured with:
121 * _mytype._tcp:mytype,_othertype._tcp.local:othertype
122 *
123 * In which case the flags:
124 * "mdns_discovery_manager_allowlist_mytype_version",
125 * "mdns_advertiser_allowlist_mytype_version",
126 * "mdns_discovery_manager_allowlist_othertype_version",
127 * "mdns_advertiser_allowlist_othertype_version"
128 * would be used to toggle MdnsDiscoveryManager / MdnsAdvertiser for each type. The flags will
129 * be read with
130 * {@link DeviceConfigUtils#isFeatureEnabled(Context, String, String, String, boolean)}.
131 *
132 * @see #MDNS_DISCOVERY_MANAGER_ALLOWLIST_FLAG_PREFIX
133 * @see #MDNS_ADVERTISER_ALLOWLIST_FLAG_PREFIX
134 * @see #MDNS_ALLOWLIST_FLAG_SUFFIX
135 */
136 private static final String MDNS_TYPE_ALLOWLIST_FLAGS = "mdns_type_allowlist_flags";
137
138 private static final String MDNS_DISCOVERY_MANAGER_ALLOWLIST_FLAG_PREFIX =
139 "mdns_discovery_manager_allowlist_";
140 private static final String MDNS_ADVERTISER_ALLOWLIST_FLAG_PREFIX =
141 "mdns_advertiser_allowlist_";
142 private static final String MDNS_ALLOWLIST_FLAG_SUFFIX = "_version";
143
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900144 public static final boolean DBG = Log.isLoggable(TAG, Log.DEBUG);
Luke Huang92860f92021-06-23 06:29:30 +0000145 private static final long CLEANUP_DELAY_MS = 10000;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +0900146 private static final int IFACE_IDX_ANY = 0;
Irfan Sheriff77ec5582012-03-22 17:01:39 -0700147
Hugo Benichi32be63d2017-04-05 14:06:11 +0900148 private final Context mContext;
Hugo Benichi32be63d2017-04-05 14:06:11 +0900149 private final NsdStateMachine mNsdStateMachine;
paulhu2b9ed952022-02-10 21:58:32 +0800150 private final MDnsManager mMDnsManager;
151 private final MDnsEventCallback mMDnsEventCallback;
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900152 @NonNull
153 private final Dependencies mDeps;
154 @NonNull
Paul Hu4bd98ef2023-01-12 13:42:07 +0800155 private final MdnsMultinetworkSocketClient mMdnsSocketClient;
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900156 @NonNull
Paul Hu4bd98ef2023-01-12 13:42:07 +0800157 private final MdnsDiscoveryManager mMdnsDiscoveryManager;
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900158 @NonNull
Paul Hu4bd98ef2023-01-12 13:42:07 +0800159 private final MdnsSocketProvider mMdnsSocketProvider;
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900160 @NonNull
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900161 private final MdnsAdvertiser mAdvertiser;
Paul Hu23fa2022023-01-13 22:57:24 +0800162 // WARNING : Accessing these values in any thread is not safe, it must only be changed in the
paulhu2b9ed952022-02-10 21:58:32 +0800163 // state machine thread. If change this outside state machine, it will need to introduce
164 // synchronization.
165 private boolean mIsDaemonStarted = false;
Paul Hu23fa2022023-01-13 22:57:24 +0800166 private boolean mIsMonitoringSocketsStarted = false;
Irfan Sheriff77ec5582012-03-22 17:01:39 -0700167
168 /**
169 * Clients receiving asynchronous messages
170 */
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900171 private final HashMap<NsdServiceConnector, ClientInfo> mClients = new HashMap<>();
Irfan Sheriff77ec5582012-03-22 17:01:39 -0700172
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700173 /* A map from unique id to client info */
Hugo Benichi32be63d2017-04-05 14:06:11 +0900174 private final SparseArray<ClientInfo> mIdToClientInfoMap= new SparseArray<>();
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700175
Luke Huang05298582021-06-13 16:52:05 +0000176 private final long mCleanupDelayMs;
Irfan Sheriff77ec5582012-03-22 17:01:39 -0700177
Hugo Benichi32be63d2017-04-05 14:06:11 +0900178 private static final int INVALID_ID = 0;
Irfan Sheriffe8de2462012-04-11 14:52:19 -0700179 private int mUniqueId = 1;
Luke Huangf7277ed2021-07-12 21:15:10 +0800180 // The count of the connected legacy clients.
181 private int mLegacyClientCount = 0;
Irfan Sheriffe8de2462012-04-11 14:52:19 -0700182
Paul Hu23fa2022023-01-13 22:57:24 +0800183 private static class MdnsListener implements MdnsServiceBrowserListener {
184 protected final int mClientId;
185 protected final int mTransactionId;
186 @NonNull
187 protected final NsdServiceInfo mReqServiceInfo;
188 @NonNull
189 protected final String mListenedServiceType;
190
191 MdnsListener(int clientId, int transactionId, @NonNull NsdServiceInfo reqServiceInfo,
192 @NonNull String listenedServiceType) {
193 mClientId = clientId;
194 mTransactionId = transactionId;
195 mReqServiceInfo = reqServiceInfo;
196 mListenedServiceType = listenedServiceType;
197 }
198
199 @NonNull
200 public String getListenedServiceType() {
201 return mListenedServiceType;
202 }
203
204 @Override
205 public void onServiceFound(@NonNull MdnsServiceInfo serviceInfo) { }
206
207 @Override
208 public void onServiceUpdated(@NonNull MdnsServiceInfo serviceInfo) { }
209
210 @Override
211 public void onServiceRemoved(@NonNull MdnsServiceInfo serviceInfo) { }
212
213 @Override
214 public void onServiceNameDiscovered(@NonNull MdnsServiceInfo serviceInfo) { }
215
216 @Override
217 public void onServiceNameRemoved(@NonNull MdnsServiceInfo serviceInfo) { }
218
219 @Override
220 public void onSearchStoppedWithError(int error) { }
221
222 @Override
223 public void onSearchFailedToStart() { }
224
225 @Override
226 public void onDiscoveryQuerySent(@NonNull List<String> subtypes, int transactionId) { }
227
228 @Override
229 public void onFailedToParseMdnsResponse(int receivedPacketNumber, int errorCode) { }
230 }
231
232 private class DiscoveryListener extends MdnsListener {
233
234 DiscoveryListener(int clientId, int transactionId, @NonNull NsdServiceInfo reqServiceInfo,
235 @NonNull String listenServiceType) {
236 super(clientId, transactionId, reqServiceInfo, listenServiceType);
237 }
238
239 @Override
240 public void onServiceNameDiscovered(@NonNull MdnsServiceInfo serviceInfo) {
Paul Hu019621e2023-01-13 23:26:49 +0800241 mNsdStateMachine.sendMessage(MDNS_DISCOVERY_MANAGER_EVENT, mTransactionId,
242 NsdManager.SERVICE_FOUND,
243 new MdnsEvent(mClientId, mReqServiceInfo.getServiceType(), serviceInfo));
Paul Hu23fa2022023-01-13 22:57:24 +0800244 }
245
246 @Override
247 public void onServiceNameRemoved(@NonNull MdnsServiceInfo serviceInfo) {
Paul Hu319751a2023-01-13 23:56:34 +0800248 mNsdStateMachine.sendMessage(MDNS_DISCOVERY_MANAGER_EVENT, mTransactionId,
249 NsdManager.SERVICE_LOST,
250 new MdnsEvent(mClientId, mReqServiceInfo.getServiceType(), serviceInfo));
Paul Hu23fa2022023-01-13 22:57:24 +0800251 }
252 }
253
Paul Hu75069ed2023-01-14 00:31:09 +0800254 private class ResolutionListener extends MdnsListener {
255
256 ResolutionListener(int clientId, int transactionId, @NonNull NsdServiceInfo reqServiceInfo,
257 @NonNull String listenServiceType) {
258 super(clientId, transactionId, reqServiceInfo, listenServiceType);
259 }
260
261 @Override
262 public void onServiceFound(MdnsServiceInfo serviceInfo) {
263 mNsdStateMachine.sendMessage(MDNS_DISCOVERY_MANAGER_EVENT, mTransactionId,
264 NsdManager.RESOLVE_SERVICE_SUCCEEDED,
265 new MdnsEvent(mClientId, mReqServiceInfo.getServiceType(), serviceInfo));
266 }
267 }
268
Paul Hu30bd70d2023-02-07 13:20:56 +0000269 private class ServiceInfoListener extends MdnsListener {
270
271 ServiceInfoListener(int clientId, int transactionId, @NonNull NsdServiceInfo reqServiceInfo,
272 @NonNull String listenServiceType) {
273 super(clientId, transactionId, reqServiceInfo, listenServiceType);
274 }
275
276 @Override
277 public void onServiceFound(@NonNull MdnsServiceInfo serviceInfo) {
278 mNsdStateMachine.sendMessage(MDNS_DISCOVERY_MANAGER_EVENT, mTransactionId,
279 NsdManager.SERVICE_UPDATED,
280 new MdnsEvent(mClientId, mReqServiceInfo.getServiceType(), serviceInfo));
281 }
282
283 @Override
284 public void onServiceUpdated(@NonNull MdnsServiceInfo serviceInfo) {
285 mNsdStateMachine.sendMessage(MDNS_DISCOVERY_MANAGER_EVENT, mTransactionId,
286 NsdManager.SERVICE_UPDATED,
287 new MdnsEvent(mClientId, mReqServiceInfo.getServiceType(), serviceInfo));
288 }
289
290 @Override
291 public void onServiceRemoved(@NonNull MdnsServiceInfo serviceInfo) {
292 mNsdStateMachine.sendMessage(MDNS_DISCOVERY_MANAGER_EVENT, mTransactionId,
293 NsdManager.SERVICE_UPDATED_LOST,
294 new MdnsEvent(mClientId, mReqServiceInfo.getServiceType(), serviceInfo));
295 }
296 }
297
Paul Hu019621e2023-01-13 23:26:49 +0800298 /**
299 * Data class of mdns service callback information.
300 */
301 private static class MdnsEvent {
302 final int mClientId;
303 @NonNull
304 final String mRequestedServiceType;
305 @NonNull
306 final MdnsServiceInfo mMdnsServiceInfo;
307
308 MdnsEvent(int clientId, @NonNull String requestedServiceType,
309 @NonNull MdnsServiceInfo mdnsServiceInfo) {
310 mClientId = clientId;
311 mRequestedServiceType = requestedServiceType;
312 mMdnsServiceInfo = mdnsServiceInfo;
313 }
314 }
315
Irfan Sheriff75006652012-04-17 23:15:29 -0700316 private class NsdStateMachine extends StateMachine {
317
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700318 private final DefaultState mDefaultState = new DefaultState();
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700319 private final EnabledState mEnabledState = new EnabledState();
Irfan Sheriff75006652012-04-17 23:15:29 -0700320
321 @Override
Wink Saville358f5d42012-05-29 12:40:46 -0700322 protected String getWhatToString(int what) {
Hugo Benichi32be63d2017-04-05 14:06:11 +0900323 return NsdManager.nameOf(what);
Irfan Sheriff75006652012-04-17 23:15:29 -0700324 }
325
Luke Huang92860f92021-06-23 06:29:30 +0000326 private void maybeStartDaemon() {
paulhu2b9ed952022-02-10 21:58:32 +0800327 if (mIsDaemonStarted) {
328 if (DBG) Log.d(TAG, "Daemon is already started.");
329 return;
330 }
331 mMDnsManager.registerEventListener(mMDnsEventCallback);
332 mMDnsManager.startDaemon();
333 mIsDaemonStarted = true;
Luke Huang05298582021-06-13 16:52:05 +0000334 maybeScheduleStop();
335 }
336
paulhu2b9ed952022-02-10 21:58:32 +0800337 private void maybeStopDaemon() {
338 if (!mIsDaemonStarted) {
339 if (DBG) Log.d(TAG, "Daemon has not been started.");
340 return;
341 }
342 mMDnsManager.unregisterEventListener(mMDnsEventCallback);
343 mMDnsManager.stopDaemon();
344 mIsDaemonStarted = false;
345 }
346
Luke Huang92860f92021-06-23 06:29:30 +0000347 private boolean isAnyRequestActive() {
348 return mIdToClientInfoMap.size() != 0;
349 }
350
351 private void scheduleStop() {
352 sendMessageDelayed(NsdManager.DAEMON_CLEANUP, mCleanupDelayMs);
353 }
354 private void maybeScheduleStop() {
Luke Huangf7277ed2021-07-12 21:15:10 +0800355 // The native daemon should stay alive and can't be cleanup
356 // if any legacy client connected.
357 if (!isAnyRequestActive() && mLegacyClientCount == 0) {
Luke Huang92860f92021-06-23 06:29:30 +0000358 scheduleStop();
Luke Huang05298582021-06-13 16:52:05 +0000359 }
360 }
361
Luke Huang92860f92021-06-23 06:29:30 +0000362 private void cancelStop() {
Luke Huang05298582021-06-13 16:52:05 +0000363 this.removeMessages(NsdManager.DAEMON_CLEANUP);
364 }
365
Paul Hu23fa2022023-01-13 22:57:24 +0800366 private void maybeStartMonitoringSockets() {
367 if (mIsMonitoringSocketsStarted) {
368 if (DBG) Log.d(TAG, "Socket monitoring is already started.");
369 return;
370 }
371
372 mMdnsSocketProvider.startMonitoringSockets();
373 mIsMonitoringSocketsStarted = true;
374 }
375
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900376 private void maybeStopMonitoringSocketsIfNoActiveRequest() {
377 if (!mIsMonitoringSocketsStarted) return;
378 if (isAnyRequestActive()) return;
379
Paul Hu58f20602023-02-18 11:41:07 +0800380 mMdnsSocketProvider.requestStopWhenInactive();
Paul Hu23fa2022023-01-13 22:57:24 +0800381 mIsMonitoringSocketsStarted = false;
382 }
383
Hugo Benichi803a2f02017-04-24 11:35:06 +0900384 NsdStateMachine(String name, Handler handler) {
385 super(name, handler);
Irfan Sheriff75006652012-04-17 23:15:29 -0700386 addState(mDefaultState);
Irfan Sheriff75006652012-04-17 23:15:29 -0700387 addState(mEnabledState, mDefaultState);
paulhu5568f452021-11-30 13:31:29 +0800388 State initialState = mEnabledState;
Hugo Benichi912db992017-04-24 16:41:03 +0900389 setInitialState(initialState);
Wink Saville358f5d42012-05-29 12:40:46 -0700390 setLogRecSize(25);
Irfan Sheriff75006652012-04-17 23:15:29 -0700391 }
392
393 class DefaultState extends State {
394 @Override
395 public boolean processMessage(Message msg) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900396 final ClientInfo cInfo;
397 final int clientId = msg.arg2;
Irfan Sheriff75006652012-04-17 23:15:29 -0700398 switch (msg.what) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900399 case NsdManager.REGISTER_CLIENT:
400 final Pair<NsdServiceConnector, INsdManagerCallback> arg =
401 (Pair<NsdServiceConnector, INsdManagerCallback>) msg.obj;
402 final INsdManagerCallback cb = arg.second;
403 try {
404 cb.asBinder().linkToDeath(arg.first, 0);
405 cInfo = new ClientInfo(cb);
406 mClients.put(arg.first, cInfo);
407 } catch (RemoteException e) {
408 Log.w(TAG, "Client " + clientId + " has already died");
Irfan Sheriff75006652012-04-17 23:15:29 -0700409 }
410 break;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900411 case NsdManager.UNREGISTER_CLIENT:
412 final NsdServiceConnector connector = (NsdServiceConnector) msg.obj;
413 cInfo = mClients.remove(connector);
Dave Plattfeff2af2014-03-07 14:48:22 -0800414 if (cInfo != null) {
415 cInfo.expungeAllRequests();
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900416 if (cInfo.isPreSClient()) {
Luke Huangf7277ed2021-07-12 21:15:10 +0800417 mLegacyClientCount -= 1;
418 }
Dave Plattfeff2af2014-03-07 14:48:22 -0800419 }
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900420 maybeStopMonitoringSocketsIfNoActiveRequest();
Luke Huangf7277ed2021-07-12 21:15:10 +0800421 maybeScheduleStop();
Irfan Sheriff75006652012-04-17 23:15:29 -0700422 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700423 case NsdManager.DISCOVER_SERVICES:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900424 cInfo = getClientInfoForReply(msg);
425 if (cInfo != null) {
426 cInfo.onDiscoverServicesFailed(
427 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
428 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700429 break;
430 case NsdManager.STOP_DISCOVERY:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900431 cInfo = getClientInfoForReply(msg);
432 if (cInfo != null) {
433 cInfo.onStopDiscoveryFailed(
434 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
435 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700436 break;
437 case NsdManager.REGISTER_SERVICE:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900438 cInfo = getClientInfoForReply(msg);
439 if (cInfo != null) {
440 cInfo.onRegisterServiceFailed(
441 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
442 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700443 break;
444 case NsdManager.UNREGISTER_SERVICE:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900445 cInfo = getClientInfoForReply(msg);
446 if (cInfo != null) {
447 cInfo.onUnregisterServiceFailed(
448 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
449 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700450 break;
451 case NsdManager.RESOLVE_SERVICE:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900452 cInfo = getClientInfoForReply(msg);
453 if (cInfo != null) {
454 cInfo.onResolveServiceFailed(
455 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
456 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700457 break;
Paul Hub58deb72022-12-26 09:24:42 +0000458 case NsdManager.STOP_RESOLUTION:
459 cInfo = getClientInfoForReply(msg);
460 if (cInfo != null) {
461 cInfo.onStopResolutionFailed(
462 clientId, NsdManager.FAILURE_OPERATION_NOT_RUNNING);
463 }
464 break;
Paul Hu18aeccc2022-12-27 08:48:48 +0000465 case NsdManager.REGISTER_SERVICE_CALLBACK:
466 cInfo = getClientInfoForReply(msg);
467 if (cInfo != null) {
468 cInfo.onServiceInfoCallbackRegistrationFailed(
469 clientId, NsdManager.FAILURE_BAD_PARAMETERS);
470 }
471 break;
Luke Huang05298582021-06-13 16:52:05 +0000472 case NsdManager.DAEMON_CLEANUP:
paulhu2b9ed952022-02-10 21:58:32 +0800473 maybeStopDaemon();
Luke Huang05298582021-06-13 16:52:05 +0000474 break;
Luke Huangf7277ed2021-07-12 21:15:10 +0800475 // This event should be only sent by the legacy (target SDK < S) clients.
476 // Mark the sending client as legacy.
477 case NsdManager.DAEMON_STARTUP:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900478 cInfo = getClientInfoForReply(msg);
Luke Huangf7277ed2021-07-12 21:15:10 +0800479 if (cInfo != null) {
480 cancelStop();
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900481 cInfo.setPreSClient();
Luke Huangf7277ed2021-07-12 21:15:10 +0800482 mLegacyClientCount += 1;
483 maybeStartDaemon();
484 }
485 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700486 default:
paulhub2225702021-11-17 09:35:33 +0800487 Log.e(TAG, "Unhandled " + msg);
Irfan Sheriff75006652012-04-17 23:15:29 -0700488 return NOT_HANDLED;
489 }
490 return HANDLED;
491 }
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900492
493 private ClientInfo getClientInfoForReply(Message msg) {
494 final ListenerArgs args = (ListenerArgs) msg.obj;
495 return mClients.get(args.connector);
496 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700497 }
498
Irfan Sheriff75006652012-04-17 23:15:29 -0700499 class EnabledState extends State {
500 @Override
501 public void enter() {
502 sendNsdStateChangeBroadcast(true);
Irfan Sheriff75006652012-04-17 23:15:29 -0700503 }
504
505 @Override
506 public void exit() {
Luke Huang05298582021-06-13 16:52:05 +0000507 // TODO: it is incorrect to stop the daemon without expunging all requests
508 // and sending error callbacks to clients.
Luke Huang92860f92021-06-23 06:29:30 +0000509 scheduleStop();
Irfan Sheriff75006652012-04-17 23:15:29 -0700510 }
511
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700512 private boolean requestLimitReached(ClientInfo clientInfo) {
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900513 if (clientInfo.mClientRequests.size() >= ClientInfo.MAX_LIMIT) {
paulhub2225702021-11-17 09:35:33 +0800514 if (DBG) Log.d(TAG, "Exceeded max outstanding requests " + clientInfo);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700515 return true;
516 }
517 return false;
518 }
519
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900520 private void storeLegacyRequestMap(int clientId, int globalId, ClientInfo clientInfo,
521 int what) {
522 clientInfo.mClientRequests.put(clientId, new LegacyClientRequest(globalId, what));
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700523 mIdToClientInfoMap.put(globalId, clientInfo);
Luke Huang05298582021-06-13 16:52:05 +0000524 // Remove the cleanup event because here comes a new request.
525 cancelStop();
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700526 }
527
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900528 private void storeAdvertiserRequestMap(int clientId, int globalId,
Paul Hu23fa2022023-01-13 22:57:24 +0800529 ClientInfo clientInfo) {
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900530 clientInfo.mClientRequests.put(clientId, new AdvertiserClientRequest(globalId));
531 mIdToClientInfoMap.put(globalId, clientInfo);
Paul Hu23fa2022023-01-13 22:57:24 +0800532 }
533
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900534 private void removeRequestMap(int clientId, int globalId, ClientInfo clientInfo) {
535 final ClientRequest existing = clientInfo.mClientRequests.get(clientId);
536 if (existing == null) return;
537 clientInfo.mClientRequests.remove(clientId);
538 mIdToClientInfoMap.remove(globalId);
539
540 if (existing instanceof LegacyClientRequest) {
541 maybeScheduleStop();
542 } else {
543 maybeStopMonitoringSocketsIfNoActiveRequest();
544 }
545 }
546
547 private void storeDiscoveryManagerRequestMap(int clientId, int globalId,
548 MdnsListener listener, ClientInfo clientInfo) {
549 clientInfo.mClientRequests.put(clientId,
550 new DiscoveryManagerRequest(globalId, listener));
551 mIdToClientInfoMap.put(globalId, clientInfo);
Paul Hu23fa2022023-01-13 22:57:24 +0800552 }
553
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900554 /**
555 * Truncate a service name to up to 63 UTF-8 bytes.
556 *
557 * See RFC6763 4.1.1: service instance names are UTF-8 and up to 63 bytes. Truncating
558 * names used in registerService follows historical behavior (see mdnsresponder
559 * handle_regservice_request).
560 */
561 @NonNull
562 private String truncateServiceName(@NonNull String originalName) {
563 // UTF-8 is at most 4 bytes per character; return early in the common case where
564 // the name can't possibly be over the limit given its string length.
565 if (originalName.length() <= MAX_LABEL_LENGTH / 4) return originalName;
566
567 final Charset utf8 = StandardCharsets.UTF_8;
568 final CharsetEncoder encoder = utf8.newEncoder();
569 final ByteBuffer out = ByteBuffer.allocate(MAX_LABEL_LENGTH);
570 // encode will write as many characters as possible to the out buffer, and just
571 // return an overflow code if there were too many characters (no need to check the
572 // return code here, this method truncates the name on purpose).
573 encoder.encode(CharBuffer.wrap(originalName), out, true /* endOfInput */);
574 return new String(out.array(), 0, out.position(), utf8);
Paul Hu23fa2022023-01-13 22:57:24 +0800575 }
576
Paul Hue4f5f252023-02-16 21:13:47 +0800577 private void stopDiscoveryManagerRequest(ClientRequest request, int clientId, int id,
578 ClientInfo clientInfo) {
579 clientInfo.unregisterMdnsListenerFromRequest(request);
580 removeRequestMap(clientId, id, clientInfo);
581 }
582
Irfan Sheriff75006652012-04-17 23:15:29 -0700583 @Override
584 public boolean processMessage(Message msg) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900585 final ClientInfo clientInfo;
586 final int id;
587 final int clientId = msg.arg2;
588 final ListenerArgs args;
Irfan Sheriff75006652012-04-17 23:15:29 -0700589 switch (msg.what) {
Paul Hu75069ed2023-01-14 00:31:09 +0800590 case NsdManager.DISCOVER_SERVICES: {
paulhub2225702021-11-17 09:35:33 +0800591 if (DBG) Log.d(TAG, "Discover services");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900592 args = (ListenerArgs) msg.obj;
593 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000594 // If the binder death notification for a INsdManagerCallback was received
595 // before any calls are received by NsdService, the clientInfo would be
596 // cleared and cause NPE. Add a null check here to prevent this corner case.
597 if (clientInfo == null) {
598 Log.e(TAG, "Unknown connector in discovery");
599 break;
600 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700601
602 if (requestLimitReached(clientInfo)) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900603 clientInfo.onDiscoverServicesFailed(
604 clientId, NsdManager.FAILURE_MAX_LIMIT);
Irfan Sheriff75006652012-04-17 23:15:29 -0700605 break;
606 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700607
Paul Hu23fa2022023-01-13 22:57:24 +0800608 final NsdServiceInfo info = args.serviceInfo;
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700609 id = getUniqueId();
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +0900610 final String serviceType = constructServiceType(info.getServiceType());
611 if (mDeps.isMdnsDiscoveryManagerEnabled(mContext)
612 || useDiscoveryManagerForType(serviceType)) {
Paul Hu23fa2022023-01-13 22:57:24 +0800613 if (serviceType == null) {
614 clientInfo.onDiscoverServicesFailed(clientId,
615 NsdManager.FAILURE_INTERNAL_ERROR);
616 break;
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700617 }
Paul Hu23fa2022023-01-13 22:57:24 +0800618
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900619 final String listenServiceType = serviceType + ".local";
Paul Hu23fa2022023-01-13 22:57:24 +0800620 maybeStartMonitoringSockets();
621 final MdnsListener listener =
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900622 new DiscoveryListener(clientId, id, info, listenServiceType);
Paul Hu23fa2022023-01-13 22:57:24 +0800623 final MdnsSearchOptions options = MdnsSearchOptions.newBuilder()
624 .setNetwork(info.getNetwork())
625 .setIsPassiveMode(true)
626 .build();
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900627 mMdnsDiscoveryManager.registerListener(
628 listenServiceType, listener, options);
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900629 storeDiscoveryManagerRequestMap(clientId, id, listener, clientInfo);
Paul Hu23fa2022023-01-13 22:57:24 +0800630 clientInfo.onDiscoverServicesStarted(clientId, info);
Irfan Sheriff75006652012-04-17 23:15:29 -0700631 } else {
Paul Hu23fa2022023-01-13 22:57:24 +0800632 maybeStartDaemon();
633 if (discoverServices(id, info)) {
634 if (DBG) {
635 Log.d(TAG, "Discover " + msg.arg2 + " " + id
636 + info.getServiceType());
637 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900638 storeLegacyRequestMap(clientId, id, clientInfo, msg.what);
Paul Hu23fa2022023-01-13 22:57:24 +0800639 clientInfo.onDiscoverServicesStarted(clientId, info);
640 } else {
641 stopServiceDiscovery(id);
642 clientInfo.onDiscoverServicesFailed(clientId,
643 NsdManager.FAILURE_INTERNAL_ERROR);
644 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700645 }
646 break;
Paul Hu75069ed2023-01-14 00:31:09 +0800647 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900648 case NsdManager.STOP_DISCOVERY: {
paulhub2225702021-11-17 09:35:33 +0800649 if (DBG) Log.d(TAG, "Stop service discovery");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900650 args = (ListenerArgs) msg.obj;
651 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000652 // If the binder death notification for a INsdManagerCallback was received
653 // before any calls are received by NsdService, the clientInfo would be
654 // cleared and cause NPE. Add a null check here to prevent this corner case.
655 if (clientInfo == null) {
656 Log.e(TAG, "Unknown connector in stop discovery");
657 break;
658 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700659
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900660 final ClientRequest request = clientInfo.mClientRequests.get(clientId);
661 if (request == null) {
662 Log.e(TAG, "Unknown client request in STOP_DISCOVERY");
Irfan Sheriff75006652012-04-17 23:15:29 -0700663 break;
664 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900665 id = request.mGlobalId;
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900666 // Note isMdnsDiscoveryManagerEnabled may have changed to false at this
667 // point, so this needs to check the type of the original request to
668 // unregister instead of looking at the flag value.
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900669 if (request instanceof DiscoveryManagerRequest) {
Paul Hue4f5f252023-02-16 21:13:47 +0800670 stopDiscoveryManagerRequest(request, clientId, id, clientInfo);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900671 clientInfo.onStopDiscoverySucceeded(clientId);
Irfan Sheriff75006652012-04-17 23:15:29 -0700672 } else {
Paul Hu23fa2022023-01-13 22:57:24 +0800673 removeRequestMap(clientId, id, clientInfo);
674 if (stopServiceDiscovery(id)) {
675 clientInfo.onStopDiscoverySucceeded(clientId);
676 } else {
677 clientInfo.onStopDiscoveryFailed(
678 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
679 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700680 }
681 break;
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900682 }
683 case NsdManager.REGISTER_SERVICE: {
paulhub2225702021-11-17 09:35:33 +0800684 if (DBG) Log.d(TAG, "Register service");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900685 args = (ListenerArgs) msg.obj;
686 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000687 // If the binder death notification for a INsdManagerCallback was received
688 // before any calls are received by NsdService, the clientInfo would be
689 // cleared and cause NPE. Add a null check here to prevent this corner case.
690 if (clientInfo == null) {
691 Log.e(TAG, "Unknown connector in registration");
692 break;
693 }
694
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700695 if (requestLimitReached(clientInfo)) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900696 clientInfo.onRegisterServiceFailed(
697 clientId, NsdManager.FAILURE_MAX_LIMIT);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700698 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700699 }
700
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700701 id = getUniqueId();
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +0900702 final NsdServiceInfo serviceInfo = args.serviceInfo;
703 final String serviceType = serviceInfo.getServiceType();
704 final String registerServiceType = constructServiceType(serviceType);
705 if (mDeps.isMdnsAdvertiserEnabled(mContext)
706 || useAdvertiserForType(registerServiceType)) {
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900707 if (registerServiceType == null) {
708 Log.e(TAG, "Invalid service type: " + serviceType);
709 clientInfo.onRegisterServiceFailed(clientId,
710 NsdManager.FAILURE_INTERNAL_ERROR);
711 break;
712 }
713 serviceInfo.setServiceType(registerServiceType);
714 serviceInfo.setServiceName(truncateServiceName(
715 serviceInfo.getServiceName()));
716
717 maybeStartMonitoringSockets();
718 mAdvertiser.addService(id, serviceInfo);
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900719 storeAdvertiserRequestMap(clientId, id, clientInfo);
Irfan Sheriff75006652012-04-17 23:15:29 -0700720 } else {
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900721 maybeStartDaemon();
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +0900722 if (registerService(id, serviceInfo)) {
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900723 if (DBG) Log.d(TAG, "Register " + clientId + " " + id);
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900724 storeLegacyRequestMap(clientId, id, clientInfo, msg.what);
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900725 // Return success after mDns reports success
726 } else {
727 unregisterService(id);
728 clientInfo.onRegisterServiceFailed(
729 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
730 }
731
Irfan Sheriff75006652012-04-17 23:15:29 -0700732 }
733 break;
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900734 }
735 case NsdManager.UNREGISTER_SERVICE: {
paulhub2225702021-11-17 09:35:33 +0800736 if (DBG) Log.d(TAG, "unregister service");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900737 args = (ListenerArgs) msg.obj;
738 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000739 // If the binder death notification for a INsdManagerCallback was received
740 // before any calls are received by NsdService, the clientInfo would be
741 // cleared and cause NPE. Add a null check here to prevent this corner case.
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900742 if (clientInfo == null) {
paulhub2225702021-11-17 09:35:33 +0800743 Log.e(TAG, "Unknown connector in unregistration");
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700744 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700745 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900746 final ClientRequest request = clientInfo.mClientRequests.get(clientId);
747 if (request == null) {
748 Log.e(TAG, "Unknown client request in UNREGISTER_SERVICE");
749 break;
750 }
751 id = request.mGlobalId;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900752 removeRequestMap(clientId, id, clientInfo);
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900753
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900754 // Note isMdnsAdvertiserEnabled may have changed to false at this point,
755 // so this needs to check the type of the original request to unregister
756 // instead of looking at the flag value.
757 if (request instanceof AdvertiserClientRequest) {
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900758 mAdvertiser.removeService(id);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900759 clientInfo.onUnregisterServiceSucceeded(clientId);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700760 } else {
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900761 if (unregisterService(id)) {
762 clientInfo.onUnregisterServiceSucceeded(clientId);
763 } else {
764 clientInfo.onUnregisterServiceFailed(
765 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
766 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700767 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700768 break;
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900769 }
Paul Hu75069ed2023-01-14 00:31:09 +0800770 case NsdManager.RESOLVE_SERVICE: {
paulhub2225702021-11-17 09:35:33 +0800771 if (DBG) Log.d(TAG, "Resolve service");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900772 args = (ListenerArgs) msg.obj;
773 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000774 // If the binder death notification for a INsdManagerCallback was received
775 // before any calls are received by NsdService, the clientInfo would be
776 // cleared and cause NPE. Add a null check here to prevent this corner case.
777 if (clientInfo == null) {
778 Log.e(TAG, "Unknown connector in resolution");
779 break;
780 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700781
Paul Hu75069ed2023-01-14 00:31:09 +0800782 final NsdServiceInfo info = args.serviceInfo;
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700783 id = getUniqueId();
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +0900784 final String serviceType = constructServiceType(info.getServiceType());
785 if (mDeps.isMdnsDiscoveryManagerEnabled(mContext)
786 || useDiscoveryManagerForType(serviceType)) {
Paul Hu75069ed2023-01-14 00:31:09 +0800787 if (serviceType == null) {
788 clientInfo.onResolveServiceFailed(clientId,
789 NsdManager.FAILURE_INTERNAL_ERROR);
790 break;
791 }
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900792 final String resolveServiceType = serviceType + ".local";
Paul Hu75069ed2023-01-14 00:31:09 +0800793
794 maybeStartMonitoringSockets();
795 final MdnsListener listener =
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900796 new ResolutionListener(clientId, id, info, resolveServiceType);
Paul Hu75069ed2023-01-14 00:31:09 +0800797 final MdnsSearchOptions options = MdnsSearchOptions.newBuilder()
798 .setNetwork(info.getNetwork())
799 .setIsPassiveMode(true)
Remi NGUYEN VANbb62b1d2023-02-27 12:18:27 +0900800 .setResolveInstanceName(info.getServiceName())
Paul Hu75069ed2023-01-14 00:31:09 +0800801 .build();
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900802 mMdnsDiscoveryManager.registerListener(
803 resolveServiceType, listener, options);
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900804 storeDiscoveryManagerRequestMap(clientId, id, listener, clientInfo);
Irfan Sheriff75006652012-04-17 23:15:29 -0700805 } else {
Paul Hu75069ed2023-01-14 00:31:09 +0800806 if (clientInfo.mResolvedService != null) {
807 clientInfo.onResolveServiceFailed(
808 clientId, NsdManager.FAILURE_ALREADY_ACTIVE);
809 break;
810 }
811
812 maybeStartDaemon();
Remi NGUYEN VANbb62b1d2023-02-27 12:18:27 +0900813 if (resolveService(id, info)) {
Paul Hu75069ed2023-01-14 00:31:09 +0800814 clientInfo.mResolvedService = new NsdServiceInfo();
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900815 storeLegacyRequestMap(clientId, id, clientInfo, msg.what);
Paul Hu75069ed2023-01-14 00:31:09 +0800816 } else {
817 clientInfo.onResolveServiceFailed(
818 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
819 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700820 }
821 break;
Paul Hu75069ed2023-01-14 00:31:09 +0800822 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900823 case NsdManager.STOP_RESOLUTION: {
Paul Hub58deb72022-12-26 09:24:42 +0000824 if (DBG) Log.d(TAG, "Stop service resolution");
825 args = (ListenerArgs) msg.obj;
826 clientInfo = mClients.get(args.connector);
827 // If the binder death notification for a INsdManagerCallback was received
828 // before any calls are received by NsdService, the clientInfo would be
829 // cleared and cause NPE. Add a null check here to prevent this corner case.
830 if (clientInfo == null) {
831 Log.e(TAG, "Unknown connector in stop resolution");
832 break;
833 }
834
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900835 final ClientRequest request = clientInfo.mClientRequests.get(clientId);
836 if (request == null) {
837 Log.e(TAG, "Unknown client request in STOP_RESOLUTION");
838 break;
839 }
840 id = request.mGlobalId;
Paul Hue4f5f252023-02-16 21:13:47 +0800841 // Note isMdnsDiscoveryManagerEnabled may have changed to false at this
842 // point, so this needs to check the type of the original request to
843 // unregister instead of looking at the flag value.
844 if (request instanceof DiscoveryManagerRequest) {
845 stopDiscoveryManagerRequest(request, clientId, id, clientInfo);
Paul Hub58deb72022-12-26 09:24:42 +0000846 clientInfo.onStopResolutionSucceeded(clientId);
847 } else {
Paul Hue4f5f252023-02-16 21:13:47 +0800848 removeRequestMap(clientId, id, clientInfo);
849 if (stopResolveService(id)) {
850 clientInfo.onStopResolutionSucceeded(clientId);
851 } else {
852 clientInfo.onStopResolutionFailed(
853 clientId, NsdManager.FAILURE_OPERATION_NOT_RUNNING);
854 }
855 clientInfo.mResolvedService = null;
Paul Hub58deb72022-12-26 09:24:42 +0000856 }
Paul Hub58deb72022-12-26 09:24:42 +0000857 break;
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900858 }
Paul Hu30bd70d2023-02-07 13:20:56 +0000859 case NsdManager.REGISTER_SERVICE_CALLBACK: {
Paul Hu18aeccc2022-12-27 08:48:48 +0000860 if (DBG) Log.d(TAG, "Register a service callback");
861 args = (ListenerArgs) msg.obj;
862 clientInfo = mClients.get(args.connector);
863 // If the binder death notification for a INsdManagerCallback was received
864 // before any calls are received by NsdService, the clientInfo would be
865 // cleared and cause NPE. Add a null check here to prevent this corner case.
866 if (clientInfo == null) {
867 Log.e(TAG, "Unknown connector in callback registration");
868 break;
869 }
870
Paul Hu30bd70d2023-02-07 13:20:56 +0000871 final NsdServiceInfo info = args.serviceInfo;
872 id = getUniqueId();
873 final String serviceType = constructServiceType(info.getServiceType());
874 if (serviceType == null) {
875 clientInfo.onServiceInfoCallbackRegistrationFailed(clientId,
876 NsdManager.FAILURE_BAD_PARAMETERS);
Paul Hu18aeccc2022-12-27 08:48:48 +0000877 break;
878 }
Paul Hu30bd70d2023-02-07 13:20:56 +0000879 final String resolveServiceType = serviceType + ".local";
Paul Hu18aeccc2022-12-27 08:48:48 +0000880
Paul Hu30bd70d2023-02-07 13:20:56 +0000881 maybeStartMonitoringSockets();
882 final MdnsListener listener =
883 new ServiceInfoListener(clientId, id, info, resolveServiceType);
884 final MdnsSearchOptions options = MdnsSearchOptions.newBuilder()
885 .setNetwork(info.getNetwork())
886 .setIsPassiveMode(true)
887 .setResolveInstanceName(info.getServiceName())
888 .build();
889 mMdnsDiscoveryManager.registerListener(
890 resolveServiceType, listener, options);
891 storeDiscoveryManagerRequestMap(clientId, id, listener, clientInfo);
Paul Hu18aeccc2022-12-27 08:48:48 +0000892 break;
Paul Hu30bd70d2023-02-07 13:20:56 +0000893 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900894 case NsdManager.UNREGISTER_SERVICE_CALLBACK: {
Paul Hu18aeccc2022-12-27 08:48:48 +0000895 if (DBG) Log.d(TAG, "Unregister a service callback");
896 args = (ListenerArgs) msg.obj;
897 clientInfo = mClients.get(args.connector);
898 // If the binder death notification for a INsdManagerCallback was received
899 // before any calls are received by NsdService, the clientInfo would be
900 // cleared and cause NPE. Add a null check here to prevent this corner case.
901 if (clientInfo == null) {
902 Log.e(TAG, "Unknown connector in callback unregistration");
903 break;
904 }
905
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900906 final ClientRequest request = clientInfo.mClientRequests.get(clientId);
907 if (request == null) {
Paul Hu30bd70d2023-02-07 13:20:56 +0000908 Log.e(TAG, "Unknown client request in UNREGISTER_SERVICE_CALLBACK");
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900909 break;
910 }
911 id = request.mGlobalId;
Paul Hu30bd70d2023-02-07 13:20:56 +0000912 if (request instanceof DiscoveryManagerRequest) {
913 stopDiscoveryManagerRequest(request, clientId, id, clientInfo);
Paul Hu18aeccc2022-12-27 08:48:48 +0000914 clientInfo.onServiceInfoCallbackUnregistered(clientId);
915 } else {
Paul Hu30bd70d2023-02-07 13:20:56 +0000916 loge("Unregister failed with non-DiscoveryManagerRequest.");
Paul Hu18aeccc2022-12-27 08:48:48 +0000917 }
Paul Hu18aeccc2022-12-27 08:48:48 +0000918 break;
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900919 }
paulhu2b9ed952022-02-10 21:58:32 +0800920 case MDNS_SERVICE_EVENT:
921 if (!handleMDnsServiceEvent(msg.arg1, msg.arg2, msg.obj)) {
Hugo Benichif0c84092017-04-05 14:43:29 +0900922 return NOT_HANDLED;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700923 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700924 break;
Paul Hu019621e2023-01-13 23:26:49 +0800925 case MDNS_DISCOVERY_MANAGER_EVENT:
926 if (!handleMdnsDiscoveryManagerEvent(msg.arg1, msg.arg2, msg.obj)) {
927 return NOT_HANDLED;
928 }
929 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700930 default:
Hugo Benichif0c84092017-04-05 14:43:29 +0900931 return NOT_HANDLED;
Irfan Sheriff75006652012-04-17 23:15:29 -0700932 }
Hugo Benichif0c84092017-04-05 14:43:29 +0900933 return HANDLED;
Irfan Sheriff75006652012-04-17 23:15:29 -0700934 }
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700935
paulhu2b9ed952022-02-10 21:58:32 +0800936 private boolean handleMDnsServiceEvent(int code, int id, Object obj) {
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700937 NsdServiceInfo servInfo;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700938 ClientInfo clientInfo = mIdToClientInfoMap.get(id);
939 if (clientInfo == null) {
paulhu2b9ed952022-02-10 21:58:32 +0800940 Log.e(TAG, String.format("id %d for %d has no client mapping", id, code));
Hugo Benichif0c84092017-04-05 14:43:29 +0900941 return false;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700942 }
943
944 /* This goes in response as msg.arg2 */
Christopher Lane74411222014-04-25 18:39:07 -0700945 int clientId = clientInfo.getClientId(id);
946 if (clientId < 0) {
Vinit Deshapnde930a8512013-06-25 19:45:03 -0700947 // This can happen because of race conditions. For example,
948 // SERVICE_FOUND may race with STOP_SERVICE_DISCOVERY,
949 // and we may get in this situation.
paulhu2b9ed952022-02-10 21:58:32 +0800950 Log.d(TAG, String.format("%d for listener id %d that is no longer active",
951 code, id));
Hugo Benichif0c84092017-04-05 14:43:29 +0900952 return false;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700953 }
Hugo Benichi32be63d2017-04-05 14:06:11 +0900954 if (DBG) {
paulhu2b9ed952022-02-10 21:58:32 +0800955 Log.d(TAG, String.format("MDns service event code:%d id=%d", code, id));
Hugo Benichi32be63d2017-04-05 14:06:11 +0900956 }
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700957 switch (code) {
paulhu2b9ed952022-02-10 21:58:32 +0800958 case IMDnsEventListener.SERVICE_FOUND: {
959 final DiscoveryInfo info = (DiscoveryInfo) obj;
960 final String name = info.serviceName;
961 final String type = info.registrationType;
962 servInfo = new NsdServiceInfo(name, type);
963 final int foundNetId = info.netId;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +0900964 if (foundNetId == 0L) {
965 // Ignore services that do not have a Network: they are not usable
966 // by apps, as they would need privileged permissions to use
967 // interfaces that do not have an associated Network.
968 break;
969 }
Remi NGUYEN VAN643edb62023-01-23 19:14:57 +0900970 if (foundNetId == INetd.DUMMY_NET_ID) {
971 // Ignore services on the dummy0 interface: they are only seen when
972 // discovering locally advertised services, and are not reachable
973 // through that interface.
974 break;
975 }
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +0900976 setServiceNetworkForCallback(servInfo, info.netId, info.interfaceIdx);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900977 clientInfo.onServiceFound(clientId, servInfo);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700978 break;
paulhu2b9ed952022-02-10 21:58:32 +0800979 }
980 case IMDnsEventListener.SERVICE_LOST: {
981 final DiscoveryInfo info = (DiscoveryInfo) obj;
982 final String name = info.serviceName;
983 final String type = info.registrationType;
984 final int lostNetId = info.netId;
985 servInfo = new NsdServiceInfo(name, type);
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +0900986 // The network could be set to null (netId 0) if it was torn down when the
987 // service is lost
988 // TODO: avoid returning null in that case, possibly by remembering
989 // found services on the same interface index and their network at the time
990 setServiceNetworkForCallback(servInfo, lostNetId, info.interfaceIdx);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900991 clientInfo.onServiceLost(clientId, servInfo);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700992 break;
paulhu2b9ed952022-02-10 21:58:32 +0800993 }
994 case IMDnsEventListener.SERVICE_DISCOVERY_FAILED:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900995 clientInfo.onDiscoverServicesFailed(
996 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700997 break;
paulhu2b9ed952022-02-10 21:58:32 +0800998 case IMDnsEventListener.SERVICE_REGISTERED: {
999 final RegistrationInfo info = (RegistrationInfo) obj;
1000 final String name = info.serviceName;
1001 servInfo = new NsdServiceInfo(name, null /* serviceType */);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001002 clientInfo.onRegisterServiceSucceeded(clientId, servInfo);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001003 break;
paulhu2b9ed952022-02-10 21:58:32 +08001004 }
1005 case IMDnsEventListener.SERVICE_REGISTRATION_FAILED:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001006 clientInfo.onRegisterServiceFailed(
1007 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001008 break;
paulhu2b9ed952022-02-10 21:58:32 +08001009 case IMDnsEventListener.SERVICE_RESOLVED: {
1010 final ResolutionInfo info = (ResolutionInfo) obj;
Sreeram Ramachandrana53dd7f2014-09-03 15:45:59 -07001011 int index = 0;
paulhu2b9ed952022-02-10 21:58:32 +08001012 final String fullName = info.serviceFullName;
1013 while (index < fullName.length() && fullName.charAt(index) != '.') {
1014 if (fullName.charAt(index) == '\\') {
Sreeram Ramachandrana53dd7f2014-09-03 15:45:59 -07001015 ++index;
1016 }
1017 ++index;
1018 }
paulhu2b9ed952022-02-10 21:58:32 +08001019 if (index >= fullName.length()) {
1020 Log.e(TAG, "Invalid service found " + fullName);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001021 break;
1022 }
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001023
paulhube186602022-04-12 07:18:23 +00001024 String name = unescape(fullName.substring(0, index));
paulhu2b9ed952022-02-10 21:58:32 +08001025 String rest = fullName.substring(index);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001026 String type = rest.replace(".local.", "");
1027
Paul Hu30bd70d2023-02-07 13:20:56 +00001028 final NsdServiceInfo serviceInfo = clientInfo.mResolvedService;
Paul Hu18aeccc2022-12-27 08:48:48 +00001029 serviceInfo.setServiceName(name);
1030 serviceInfo.setServiceType(type);
1031 serviceInfo.setPort(info.port);
1032 serviceInfo.setTxtRecords(info.txtRecord);
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001033 // Network will be added after SERVICE_GET_ADDR_SUCCESS
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001034
1035 stopResolveService(id);
Vinit Deshapnde4429e872013-11-12 15:36:37 -08001036 removeRequestMap(clientId, id, clientInfo);
1037
paulhu2b9ed952022-02-10 21:58:32 +08001038 final int id2 = getUniqueId();
1039 if (getAddrInfo(id2, info.hostname, info.interfaceIdx)) {
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001040 storeLegacyRequestMap(clientId, id2, clientInfo,
1041 NsdManager.RESOLVE_SERVICE);
Vinit Deshapnde4429e872013-11-12 15:36:37 -08001042 } else {
Paul Hu30bd70d2023-02-07 13:20:56 +00001043 clientInfo.onResolveServiceFailed(
1044 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
1045 clientInfo.mResolvedService = null;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001046 }
1047 break;
paulhu2b9ed952022-02-10 21:58:32 +08001048 }
1049 case IMDnsEventListener.SERVICE_RESOLUTION_FAILED:
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001050 /* NNN resolveId errorCode */
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001051 stopResolveService(id);
1052 removeRequestMap(clientId, id, clientInfo);
Paul Hu30bd70d2023-02-07 13:20:56 +00001053 clientInfo.onResolveServiceFailed(
1054 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
1055 clientInfo.mResolvedService = null;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001056 break;
paulhu2b9ed952022-02-10 21:58:32 +08001057 case IMDnsEventListener.SERVICE_GET_ADDR_FAILED:
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001058 /* NNN resolveId errorCode */
1059 stopGetAddrInfo(id);
1060 removeRequestMap(clientId, id, clientInfo);
Paul Hu30bd70d2023-02-07 13:20:56 +00001061 clientInfo.onResolveServiceFailed(
1062 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
1063 clientInfo.mResolvedService = null;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001064 break;
paulhu2b9ed952022-02-10 21:58:32 +08001065 case IMDnsEventListener.SERVICE_GET_ADDR_SUCCESS: {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001066 /* NNN resolveId hostname ttl addr interfaceIdx netId */
paulhu2b9ed952022-02-10 21:58:32 +08001067 final GetAddressInfo info = (GetAddressInfo) obj;
1068 final String address = info.address;
1069 final int netId = info.netId;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001070 InetAddress serviceHost = null;
1071 try {
paulhu2b9ed952022-02-10 21:58:32 +08001072 serviceHost = InetAddress.getByName(address);
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001073 } catch (UnknownHostException e) {
1074 Log.wtf(TAG, "Invalid host in GET_ADDR_SUCCESS", e);
1075 }
1076
1077 // If the resolved service is on an interface without a network, consider it
1078 // as a failure: it would not be usable by apps as they would need
1079 // privileged permissions.
Paul Hu30bd70d2023-02-07 13:20:56 +00001080 if (netId != NETID_UNSET && serviceHost != null) {
1081 clientInfo.mResolvedService.setHost(serviceHost);
1082 setServiceNetworkForCallback(clientInfo.mResolvedService,
1083 netId, info.interfaceIdx);
1084 clientInfo.onResolveServiceSucceeded(
1085 clientId, clientInfo.mResolvedService);
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001086 } else {
Paul Hu30bd70d2023-02-07 13:20:56 +00001087 clientInfo.onResolveServiceFailed(
1088 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001089 }
Paul Hu30bd70d2023-02-07 13:20:56 +00001090 stopGetAddrInfo(id);
1091 removeRequestMap(clientId, id, clientInfo);
1092 clientInfo.mResolvedService = null;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001093 break;
paulhu2b9ed952022-02-10 21:58:32 +08001094 }
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001095 default:
Hugo Benichif0c84092017-04-05 14:43:29 +09001096 return false;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001097 }
Hugo Benichif0c84092017-04-05 14:43:29 +09001098 return true;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001099 }
Paul Hu019621e2023-01-13 23:26:49 +08001100
1101 private NsdServiceInfo buildNsdServiceInfoFromMdnsEvent(final MdnsEvent event) {
1102 final MdnsServiceInfo serviceInfo = event.mMdnsServiceInfo;
1103 final String serviceType = event.mRequestedServiceType;
1104 final String serviceName = serviceInfo.getServiceInstanceName();
1105 final NsdServiceInfo servInfo = new NsdServiceInfo(serviceName, serviceType);
1106 final Network network = serviceInfo.getNetwork();
1107 setServiceNetworkForCallback(
1108 servInfo,
1109 network == null ? NETID_UNSET : network.netId,
1110 serviceInfo.getInterfaceIndex());
1111 return servInfo;
1112 }
1113
1114 private boolean handleMdnsDiscoveryManagerEvent(
1115 int transactionId, int code, Object obj) {
1116 final ClientInfo clientInfo = mIdToClientInfoMap.get(transactionId);
1117 if (clientInfo == null) {
1118 Log.e(TAG, String.format(
1119 "id %d for %d has no client mapping", transactionId, code));
1120 return false;
1121 }
1122
1123 final MdnsEvent event = (MdnsEvent) obj;
1124 final int clientId = event.mClientId;
Paul Hu319751a2023-01-13 23:56:34 +08001125 final NsdServiceInfo info = buildNsdServiceInfoFromMdnsEvent(event);
Paul Hu019621e2023-01-13 23:26:49 +08001126 if (DBG) {
1127 Log.d(TAG, String.format("MdnsDiscoveryManager event code=%s transactionId=%d",
1128 NsdManager.nameOf(code), transactionId));
1129 }
1130 switch (code) {
1131 case NsdManager.SERVICE_FOUND:
Paul Hu319751a2023-01-13 23:56:34 +08001132 clientInfo.onServiceFound(clientId, info);
1133 break;
1134 case NsdManager.SERVICE_LOST:
1135 clientInfo.onServiceLost(clientId, info);
Paul Hu019621e2023-01-13 23:26:49 +08001136 break;
Paul Hu75069ed2023-01-14 00:31:09 +08001137 case NsdManager.RESOLVE_SERVICE_SUCCEEDED: {
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001138 final ClientRequest request = clientInfo.mClientRequests.get(clientId);
1139 if (request == null) {
1140 Log.e(TAG, "Unknown client request in RESOLVE_SERVICE_SUCCEEDED");
1141 break;
1142 }
Paul Hu75069ed2023-01-14 00:31:09 +08001143 final MdnsServiceInfo serviceInfo = event.mMdnsServiceInfo;
1144 // Add '.' in front of the service type that aligns with historical behavior
1145 info.setServiceType("." + event.mRequestedServiceType);
1146 info.setPort(serviceInfo.getPort());
1147
1148 Map<String, String> attrs = serviceInfo.getAttributes();
1149 for (Map.Entry<String, String> kv : attrs.entrySet()) {
1150 final String key = kv.getKey();
1151 try {
1152 info.setAttribute(key, serviceInfo.getAttributeAsBytes(key));
1153 } catch (IllegalArgumentException e) {
1154 Log.e(TAG, "Invalid attribute", e);
1155 }
1156 }
Paul Hu2b865912023-03-06 14:27:53 +08001157 final List<InetAddress> addresses = new ArrayList<>();
1158 for (String ipv4Address : serviceInfo.getIpv4Addresses()) {
1159 try {
1160 addresses.add(InetAddresses.parseNumericAddress(ipv4Address));
1161 } catch (IllegalArgumentException e) {
1162 Log.wtf(TAG, "Invalid ipv4 address", e);
Paul Hu75069ed2023-01-14 00:31:09 +08001163 }
Paul Hu2b865912023-03-06 14:27:53 +08001164 }
1165 for (String ipv6Address : serviceInfo.getIpv6Addresses()) {
1166 try {
1167 addresses.add(InetAddresses.parseNumericAddress(ipv6Address));
1168 } catch (IllegalArgumentException e) {
1169 Log.wtf(TAG, "Invalid ipv6 address", e);
1170 }
1171 }
1172
1173 if (addresses.size() != 0) {
1174 info.setHostAddresses(addresses);
Paul Hu75069ed2023-01-14 00:31:09 +08001175 clientInfo.onResolveServiceSucceeded(clientId, info);
Paul Hu2b865912023-03-06 14:27:53 +08001176 } else {
1177 // No address. Notify resolution failure.
Paul Hu75069ed2023-01-14 00:31:09 +08001178 clientInfo.onResolveServiceFailed(
1179 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
1180 }
1181
1182 // Unregister the listener immediately like IMDnsEventListener design
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001183 if (!(request instanceof DiscoveryManagerRequest)) {
1184 Log.wtf(TAG, "non-DiscoveryManager request in DiscoveryManager event");
1185 break;
1186 }
Paul Hue4f5f252023-02-16 21:13:47 +08001187 stopDiscoveryManagerRequest(request, clientId, transactionId, clientInfo);
Paul Hu75069ed2023-01-14 00:31:09 +08001188 break;
1189 }
Paul Hu30bd70d2023-02-07 13:20:56 +00001190 case NsdManager.SERVICE_UPDATED: {
1191 final MdnsServiceInfo serviceInfo = event.mMdnsServiceInfo;
1192 info.setPort(serviceInfo.getPort());
1193
1194 Map<String, String> attrs = serviceInfo.getAttributes();
1195 for (Map.Entry<String, String> kv : attrs.entrySet()) {
1196 final String key = kv.getKey();
1197 try {
1198 info.setAttribute(key, serviceInfo.getAttributeAsBytes(key));
1199 } catch (IllegalArgumentException e) {
1200 Log.e(TAG, "Invalid attribute", e);
1201 }
1202 }
1203
1204 final List<InetAddress> addresses = new ArrayList<>();
1205 for (String ipv4Address : serviceInfo.getIpv4Addresses()) {
1206 try {
1207 addresses.add(InetAddresses.parseNumericAddress(ipv4Address));
1208 } catch (IllegalArgumentException e) {
1209 Log.wtf(TAG, "Invalid ipv4 address", e);
1210 }
1211 }
1212 for (String ipv6Address : serviceInfo.getIpv6Addresses()) {
1213 try {
1214 addresses.add(InetAddresses.parseNumericAddress(ipv6Address));
1215 } catch (IllegalArgumentException e) {
1216 Log.wtf(TAG, "Invalid ipv6 address", e);
1217 }
1218 }
1219 info.setHostAddresses(addresses);
1220 clientInfo.onServiceUpdated(clientId, info);
1221 break;
1222 }
1223 case NsdManager.SERVICE_UPDATED_LOST:
1224 clientInfo.onServiceUpdatedLost(clientId);
1225 break;
Paul Hu019621e2023-01-13 23:26:49 +08001226 default:
1227 return false;
1228 }
1229 return true;
1230 }
Irfan Sheriff75006652012-04-17 23:15:29 -07001231 }
1232 }
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001233
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001234 private static void setServiceNetworkForCallback(NsdServiceInfo info, int netId, int ifaceIdx) {
1235 switch (netId) {
1236 case NETID_UNSET:
1237 info.setNetwork(null);
1238 break;
1239 case INetd.LOCAL_NET_ID:
1240 // Special case for LOCAL_NET_ID: Networks on netId 99 are not generally
1241 // visible / usable for apps, so do not return it. Store the interface
1242 // index instead, so at least if the client tries to resolve the service
1243 // with that NsdServiceInfo, it will be done on the same interface.
1244 // If they recreate the NsdServiceInfo themselves, resolution would be
1245 // done on all interfaces as before T, which should also work.
1246 info.setNetwork(null);
1247 info.setInterfaceIndex(ifaceIdx);
1248 break;
1249 default:
1250 info.setNetwork(new Network(netId));
1251 }
1252 }
1253
paulhube186602022-04-12 07:18:23 +00001254 // The full service name is escaped from standard DNS rules on mdnsresponder, making it suitable
1255 // for passing to standard system DNS APIs such as res_query() . Thus, make the service name
1256 // unescape for getting right service address. See "Notes on DNS Name Escaping" on
1257 // external/mdnsresponder/mDNSShared/dns_sd.h for more details.
1258 private String unescape(String s) {
1259 StringBuilder sb = new StringBuilder(s.length());
1260 for (int i = 0; i < s.length(); ++i) {
1261 char c = s.charAt(i);
1262 if (c == '\\') {
1263 if (++i >= s.length()) {
1264 Log.e(TAG, "Unexpected end of escape sequence in: " + s);
1265 break;
1266 }
1267 c = s.charAt(i);
1268 if (c != '.' && c != '\\') {
1269 if (i + 2 >= s.length()) {
1270 Log.e(TAG, "Unexpected end of escape sequence in: " + s);
1271 break;
1272 }
1273 c = (char) ((c - '0') * 100 + (s.charAt(i + 1) - '0') * 10
1274 + (s.charAt(i + 2) - '0'));
1275 i += 2;
1276 }
1277 }
1278 sb.append(c);
1279 }
1280 return sb.toString();
1281 }
1282
Paul Hu7445e3d2023-03-03 15:14:00 +08001283 /**
1284 * Check the given service type is valid and construct it to a service type
1285 * which can use for discovery / resolution service.
1286 *
1287 * <p> The valid service type should be 2 labels, or 3 labels if the query is for a
1288 * subtype (see RFC6763 7.1). Each label is up to 63 characters and must start with an
1289 * underscore; they are alphanumerical characters or dashes or underscore, except the
1290 * last one that is just alphanumerical. The last label must be _tcp or _udp.
1291 *
1292 * @param serviceType the request service type for discovery / resolution service
1293 * @return constructed service type or null if the given service type is invalid.
1294 */
1295 @Nullable
1296 public static String constructServiceType(String serviceType) {
1297 if (TextUtils.isEmpty(serviceType)) return null;
1298
1299 final Pattern serviceTypePattern = Pattern.compile(
1300 "^(_[a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]\\.)?"
1301 + "(_[a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]\\._(?:tcp|udp))"
1302 // Drop '.' at the end of service type that is compatible with old backend.
1303 + "\\.?$");
1304 final Matcher matcher = serviceTypePattern.matcher(serviceType);
1305 if (!matcher.matches()) return null;
1306 return matcher.group(1) == null
1307 ? matcher.group(2)
1308 : matcher.group(1) + "_sub." + matcher.group(2);
1309 }
1310
Hugo Benichi803a2f02017-04-24 11:35:06 +09001311 @VisibleForTesting
paulhu2b9ed952022-02-10 21:58:32 +08001312 NsdService(Context ctx, Handler handler, long cleanupDelayMs) {
Paul Hu4bd98ef2023-01-12 13:42:07 +08001313 this(ctx, handler, cleanupDelayMs, new Dependencies());
1314 }
1315
1316 @VisibleForTesting
1317 NsdService(Context ctx, Handler handler, long cleanupDelayMs, Dependencies deps) {
Luke Huang05298582021-06-13 16:52:05 +00001318 mCleanupDelayMs = cleanupDelayMs;
Hugo Benichi803a2f02017-04-24 11:35:06 +09001319 mContext = ctx;
Hugo Benichi803a2f02017-04-24 11:35:06 +09001320 mNsdStateMachine = new NsdStateMachine(TAG, handler);
Irfan Sheriff75006652012-04-17 23:15:29 -07001321 mNsdStateMachine.start();
paulhu2b9ed952022-02-10 21:58:32 +08001322 mMDnsManager = ctx.getSystemService(MDnsManager.class);
1323 mMDnsEventCallback = new MDnsEventCallback(mNsdStateMachine);
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +09001324 mDeps = deps;
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001325
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +09001326 mMdnsSocketProvider = deps.makeMdnsSocketProvider(ctx, handler.getLooper());
1327 mMdnsSocketClient =
1328 new MdnsMultinetworkSocketClient(handler.getLooper(), mMdnsSocketProvider);
1329 mMdnsDiscoveryManager =
1330 deps.makeMdnsDiscoveryManager(new ExecutorProvider(), mMdnsSocketClient);
1331 handler.post(() -> mMdnsSocketClient.setCallback(mMdnsDiscoveryManager));
1332 mAdvertiser = deps.makeMdnsAdvertiser(handler.getLooper(), mMdnsSocketProvider,
1333 new AdvertiserCallback());
Paul Hu4bd98ef2023-01-12 13:42:07 +08001334 }
1335
1336 /**
1337 * Dependencies of NsdService, for injection in tests.
1338 */
1339 @VisibleForTesting
1340 public static class Dependencies {
1341 /**
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001342 * Check whether the MdnsDiscoveryManager feature is enabled.
Paul Hu4bd98ef2023-01-12 13:42:07 +08001343 *
1344 * @param context The global context information about an app environment.
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001345 * @return true if the MdnsDiscoveryManager feature is enabled.
Paul Hu4bd98ef2023-01-12 13:42:07 +08001346 */
1347 public boolean isMdnsDiscoveryManagerEnabled(Context context) {
Remi NGUYEN VANbeb03f12023-03-08 19:03:27 +09001348 return isAtLeastU() || DeviceConfigUtils.isFeatureEnabled(context,
1349 NAMESPACE_CONNECTIVITY, MDNS_DISCOVERY_MANAGER_VERSION,
1350 false /* defaultEnabled */);
Paul Hu4bd98ef2023-01-12 13:42:07 +08001351 }
1352
1353 /**
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001354 * Check whether the MdnsAdvertiser feature is enabled.
1355 *
1356 * @param context The global context information about an app environment.
1357 * @return true if the MdnsAdvertiser feature is enabled.
1358 */
1359 public boolean isMdnsAdvertiserEnabled(Context context) {
Remi NGUYEN VANbeb03f12023-03-08 19:03:27 +09001360 return isAtLeastU() || DeviceConfigUtils.isFeatureEnabled(context,
1361 NAMESPACE_CONNECTIVITY, MDNS_ADVERTISER_VERSION, false /* defaultEnabled */);
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001362 }
1363
1364 /**
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +09001365 * Get the type allowlist flag value.
1366 * @see #MDNS_TYPE_ALLOWLIST_FLAGS
1367 */
1368 @Nullable
1369 public String getTypeAllowlistFlags() {
1370 return DeviceConfigUtils.getDeviceConfigProperty(NAMESPACE_TETHERING,
1371 MDNS_TYPE_ALLOWLIST_FLAGS, null);
1372 }
1373
1374 /**
1375 * @see DeviceConfigUtils#isFeatureEnabled(Context, String, String, String, boolean)
1376 */
1377 public boolean isFeatureEnabled(Context context, String feature) {
1378 return DeviceConfigUtils.isFeatureEnabled(context, NAMESPACE_TETHERING,
1379 feature, DeviceConfigUtils.TETHERING_MODULE_NAME, false /* defaultEnabled */);
1380 }
1381
1382 /**
Paul Hu4bd98ef2023-01-12 13:42:07 +08001383 * @see MdnsDiscoveryManager
1384 */
1385 public MdnsDiscoveryManager makeMdnsDiscoveryManager(
1386 ExecutorProvider executorProvider, MdnsSocketClientBase socketClient) {
1387 return new MdnsDiscoveryManager(executorProvider, socketClient);
1388 }
1389
1390 /**
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001391 * @see MdnsAdvertiser
1392 */
1393 public MdnsAdvertiser makeMdnsAdvertiser(
1394 @NonNull Looper looper, @NonNull MdnsSocketProvider socketProvider,
1395 @NonNull MdnsAdvertiser.AdvertiserCallback cb) {
1396 return new MdnsAdvertiser(looper, socketProvider, cb);
1397 }
1398
1399 /**
Paul Hu4bd98ef2023-01-12 13:42:07 +08001400 * @see MdnsSocketProvider
1401 */
1402 public MdnsSocketProvider makeMdnsSocketProvider(Context context, Looper looper) {
1403 return new MdnsSocketProvider(context, looper);
1404 }
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001405 }
1406
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +09001407 /**
1408 * Return whether a type is allowlisted to use the Java backend.
1409 * @param type The service type
1410 * @param flagPrefix One of {@link #MDNS_ADVERTISER_ALLOWLIST_FLAG_PREFIX} or
1411 * {@link #MDNS_DISCOVERY_MANAGER_ALLOWLIST_FLAG_PREFIX}.
1412 */
1413 private boolean isTypeAllowlistedForJavaBackend(@Nullable String type,
1414 @NonNull String flagPrefix) {
1415 if (type == null) return false;
1416 final String typesConfig = mDeps.getTypeAllowlistFlags();
1417 if (TextUtils.isEmpty(typesConfig)) return false;
1418
1419 final String mappingPrefix = type + ":";
1420 String mappedFlag = null;
1421 for (String mapping : TextUtils.split(typesConfig, ",")) {
1422 if (mapping.startsWith(mappingPrefix)) {
1423 mappedFlag = mapping.substring(mappingPrefix.length());
1424 break;
1425 }
1426 }
1427
1428 if (mappedFlag == null) return false;
1429
1430 return mDeps.isFeatureEnabled(mContext,
1431 flagPrefix + mappedFlag + MDNS_ALLOWLIST_FLAG_SUFFIX);
1432 }
1433
1434 private boolean useDiscoveryManagerForType(@Nullable String type) {
1435 return isTypeAllowlistedForJavaBackend(type, MDNS_DISCOVERY_MANAGER_ALLOWLIST_FLAG_PREFIX);
1436 }
1437
1438 private boolean useAdvertiserForType(@Nullable String type) {
1439 return isTypeAllowlistedForJavaBackend(type, MDNS_ADVERTISER_ALLOWLIST_FLAG_PREFIX);
1440 }
1441
paulhu1b35e822022-04-08 14:48:41 +08001442 public static NsdService create(Context context) {
Hugo Benichi803a2f02017-04-24 11:35:06 +09001443 HandlerThread thread = new HandlerThread(TAG);
1444 thread.start();
1445 Handler handler = new Handler(thread.getLooper());
paulhu2b9ed952022-02-10 21:58:32 +08001446 NsdService service = new NsdService(context, handler, CLEANUP_DELAY_MS);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001447 return service;
1448 }
1449
paulhu2b9ed952022-02-10 21:58:32 +08001450 private static class MDnsEventCallback extends IMDnsEventListener.Stub {
1451 private final StateMachine mStateMachine;
1452
1453 MDnsEventCallback(StateMachine sm) {
1454 mStateMachine = sm;
1455 }
1456
1457 @Override
1458 public void onServiceRegistrationStatus(final RegistrationInfo status) {
1459 mStateMachine.sendMessage(
1460 MDNS_SERVICE_EVENT, status.result, status.id, status);
1461 }
1462
1463 @Override
1464 public void onServiceDiscoveryStatus(final DiscoveryInfo status) {
1465 mStateMachine.sendMessage(
1466 MDNS_SERVICE_EVENT, status.result, status.id, status);
1467 }
1468
1469 @Override
1470 public void onServiceResolutionStatus(final ResolutionInfo status) {
1471 mStateMachine.sendMessage(
1472 MDNS_SERVICE_EVENT, status.result, status.id, status);
1473 }
1474
1475 @Override
1476 public void onGettingServiceAddressStatus(final GetAddressInfo status) {
1477 mStateMachine.sendMessage(
1478 MDNS_SERVICE_EVENT, status.result, status.id, status);
1479 }
1480
1481 @Override
1482 public int getInterfaceVersion() throws RemoteException {
1483 return this.VERSION;
1484 }
1485
1486 @Override
1487 public String getInterfaceHash() throws RemoteException {
1488 return this.HASH;
1489 }
1490 }
1491
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001492 private class AdvertiserCallback implements MdnsAdvertiser.AdvertiserCallback {
1493 @Override
1494 public void onRegisterServiceSucceeded(int serviceId, NsdServiceInfo registeredInfo) {
1495 final ClientInfo clientInfo = getClientInfoOrLog(serviceId);
1496 if (clientInfo == null) return;
1497
1498 final int clientId = getClientIdOrLog(clientInfo, serviceId);
1499 if (clientId < 0) return;
1500
1501 // onRegisterServiceSucceeded only has the service name in its info. This aligns with
1502 // historical behavior.
1503 final NsdServiceInfo cbInfo = new NsdServiceInfo(registeredInfo.getServiceName(), null);
1504 clientInfo.onRegisterServiceSucceeded(clientId, cbInfo);
1505 }
1506
1507 @Override
1508 public void onRegisterServiceFailed(int serviceId, int errorCode) {
1509 final ClientInfo clientInfo = getClientInfoOrLog(serviceId);
1510 if (clientInfo == null) return;
1511
1512 final int clientId = getClientIdOrLog(clientInfo, serviceId);
1513 if (clientId < 0) return;
1514
1515 clientInfo.onRegisterServiceFailed(clientId, errorCode);
1516 }
1517
1518 private ClientInfo getClientInfoOrLog(int serviceId) {
1519 final ClientInfo clientInfo = mIdToClientInfoMap.get(serviceId);
1520 if (clientInfo == null) {
1521 Log.e(TAG, String.format("Callback for service %d has no client", serviceId));
1522 }
1523 return clientInfo;
1524 }
1525
1526 private int getClientIdOrLog(@NonNull ClientInfo info, int serviceId) {
1527 final int clientId = info.getClientId(serviceId);
1528 if (clientId < 0) {
1529 Log.e(TAG, String.format("Client ID not found for service %d", serviceId));
1530 }
1531 return clientId;
1532 }
1533 }
1534
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001535 @Override
1536 public INsdServiceConnector connect(INsdManagerCallback cb) {
Hugo Benichi803a2f02017-04-24 11:35:06 +09001537 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.INTERNET, "NsdService");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001538 final INsdServiceConnector connector = new NsdServiceConnector();
1539 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1540 NsdManager.REGISTER_CLIENT, new Pair<>(connector, cb)));
1541 return connector;
Irfan Sheriff75006652012-04-17 23:15:29 -07001542 }
1543
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001544 private static class ListenerArgs {
1545 public final NsdServiceConnector connector;
1546 public final NsdServiceInfo serviceInfo;
1547 ListenerArgs(NsdServiceConnector connector, NsdServiceInfo serviceInfo) {
1548 this.connector = connector;
1549 this.serviceInfo = serviceInfo;
1550 }
1551 }
1552
1553 private class NsdServiceConnector extends INsdServiceConnector.Stub
1554 implements IBinder.DeathRecipient {
1555 @Override
1556 public void registerService(int listenerKey, NsdServiceInfo serviceInfo) {
1557 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1558 NsdManager.REGISTER_SERVICE, 0, listenerKey,
1559 new ListenerArgs(this, serviceInfo)));
1560 }
1561
1562 @Override
1563 public void unregisterService(int listenerKey) {
1564 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1565 NsdManager.UNREGISTER_SERVICE, 0, listenerKey,
1566 new ListenerArgs(this, null)));
1567 }
1568
1569 @Override
1570 public void discoverServices(int listenerKey, NsdServiceInfo serviceInfo) {
1571 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1572 NsdManager.DISCOVER_SERVICES, 0, listenerKey,
1573 new ListenerArgs(this, serviceInfo)));
1574 }
1575
1576 @Override
1577 public void stopDiscovery(int listenerKey) {
1578 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1579 NsdManager.STOP_DISCOVERY, 0, listenerKey, new ListenerArgs(this, null)));
1580 }
1581
1582 @Override
1583 public void resolveService(int listenerKey, NsdServiceInfo serviceInfo) {
1584 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1585 NsdManager.RESOLVE_SERVICE, 0, listenerKey,
1586 new ListenerArgs(this, serviceInfo)));
1587 }
1588
1589 @Override
Paul Hub58deb72022-12-26 09:24:42 +00001590 public void stopResolution(int listenerKey) {
1591 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1592 NsdManager.STOP_RESOLUTION, 0, listenerKey, new ListenerArgs(this, null)));
1593 }
1594
1595 @Override
Paul Hu18aeccc2022-12-27 08:48:48 +00001596 public void registerServiceInfoCallback(int listenerKey, NsdServiceInfo serviceInfo) {
1597 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1598 NsdManager.REGISTER_SERVICE_CALLBACK, 0, listenerKey,
1599 new ListenerArgs(this, serviceInfo)));
1600 }
1601
1602 @Override
1603 public void unregisterServiceInfoCallback(int listenerKey) {
1604 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1605 NsdManager.UNREGISTER_SERVICE_CALLBACK, 0, listenerKey,
1606 new ListenerArgs(this, null)));
1607 }
1608
1609 @Override
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001610 public void startDaemon() {
1611 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1612 NsdManager.DAEMON_STARTUP, new ListenerArgs(this, null)));
1613 }
1614
1615 @Override
1616 public void binderDied() {
1617 mNsdStateMachine.sendMessage(
1618 mNsdStateMachine.obtainMessage(NsdManager.UNREGISTER_CLIENT, this));
1619 }
Irfan Sheriff75006652012-04-17 23:15:29 -07001620 }
1621
Hugo Benichi912db992017-04-24 16:41:03 +09001622 private void sendNsdStateChangeBroadcast(boolean isEnabled) {
Irfan Sheriff52fc83a2012-04-19 10:26:34 -07001623 final Intent intent = new Intent(NsdManager.ACTION_NSD_STATE_CHANGED);
Irfan Sheriff75006652012-04-17 23:15:29 -07001624 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT);
Hugo Benichi912db992017-04-24 16:41:03 +09001625 int nsdState = isEnabled ? NsdManager.NSD_STATE_ENABLED : NsdManager.NSD_STATE_DISABLED;
1626 intent.putExtra(NsdManager.EXTRA_NSD_STATE, nsdState);
Dianne Hackborn692107e2012-08-29 18:32:08 -07001627 mContext.sendStickyBroadcastAsUser(intent, UserHandle.ALL);
Irfan Sheriff75006652012-04-17 23:15:29 -07001628 }
1629
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001630 private int getUniqueId() {
1631 if (++mUniqueId == INVALID_ID) return ++mUniqueId;
1632 return mUniqueId;
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001633 }
1634
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001635 private boolean registerService(int regId, NsdServiceInfo service) {
Hugo Benichi6d706442017-04-24 16:19:58 +09001636 if (DBG) {
paulhub2225702021-11-17 09:35:33 +08001637 Log.d(TAG, "registerService: " + regId + " " + service);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001638 }
Hugo Benichi6d706442017-04-24 16:19:58 +09001639 String name = service.getServiceName();
1640 String type = service.getServiceType();
1641 int port = service.getPort();
1642 byte[] textRecord = service.getTxtRecord();
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001643 final int registerInterface = getNetworkInterfaceIndex(service);
1644 if (service.getNetwork() != null && registerInterface == IFACE_IDX_ANY) {
Paul Hu360a8e92022-04-26 11:14:14 +08001645 Log.e(TAG, "Interface to register service on not found");
1646 return false;
1647 }
1648 return mMDnsManager.registerService(regId, name, type, port, textRecord, registerInterface);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001649 }
1650
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001651 private boolean unregisterService(int regId) {
paulhu2b9ed952022-02-10 21:58:32 +08001652 return mMDnsManager.stopOperation(regId);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001653 }
1654
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001655 private boolean discoverServices(int discoveryId, NsdServiceInfo serviceInfo) {
paulhu2b9ed952022-02-10 21:58:32 +08001656 final String type = serviceInfo.getServiceType();
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001657 final int discoverInterface = getNetworkInterfaceIndex(serviceInfo);
1658 if (serviceInfo.getNetwork() != null && discoverInterface == IFACE_IDX_ANY) {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001659 Log.e(TAG, "Interface to discover service on not found");
1660 return false;
1661 }
paulhu2b9ed952022-02-10 21:58:32 +08001662 return mMDnsManager.discover(discoveryId, type, discoverInterface);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001663 }
1664
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001665 private boolean stopServiceDiscovery(int discoveryId) {
paulhu2b9ed952022-02-10 21:58:32 +08001666 return mMDnsManager.stopOperation(discoveryId);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001667 }
1668
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001669 private boolean resolveService(int resolveId, NsdServiceInfo service) {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001670 final String name = service.getServiceName();
1671 final String type = service.getServiceType();
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001672 final int resolveInterface = getNetworkInterfaceIndex(service);
1673 if (service.getNetwork() != null && resolveInterface == IFACE_IDX_ANY) {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001674 Log.e(TAG, "Interface to resolve service on not found");
1675 return false;
1676 }
paulhu2b9ed952022-02-10 21:58:32 +08001677 return mMDnsManager.resolve(resolveId, name, type, "local.", resolveInterface);
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001678 }
1679
1680 /**
1681 * Guess the interface to use to resolve or discover a service on a specific network.
1682 *
1683 * This is an imperfect guess, as for example the network may be gone or not yet fully
1684 * registered. This is fine as failing is correct if the network is gone, and a client
1685 * attempting to resolve/discover on a network not yet setup would have a bad time anyway; also
1686 * this is to support the legacy mdnsresponder implementation, which historically resolved
1687 * services on an unspecified network.
1688 */
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001689 private int getNetworkInterfaceIndex(NsdServiceInfo serviceInfo) {
1690 final Network network = serviceInfo.getNetwork();
1691 if (network == null) {
1692 // Fallback to getInterfaceIndex if present (typically if the NsdServiceInfo was
1693 // provided by NsdService from discovery results, and the service was found on an
1694 // interface that has no app-usable Network).
1695 if (serviceInfo.getInterfaceIndex() != 0) {
1696 return serviceInfo.getInterfaceIndex();
1697 }
1698 return IFACE_IDX_ANY;
1699 }
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001700
1701 final ConnectivityManager cm = mContext.getSystemService(ConnectivityManager.class);
1702 if (cm == null) {
1703 Log.wtf(TAG, "No ConnectivityManager for resolveService");
1704 return IFACE_IDX_ANY;
1705 }
1706 final LinkProperties lp = cm.getLinkProperties(network);
1707 if (lp == null) return IFACE_IDX_ANY;
1708
1709 // Only resolve on non-stacked interfaces
1710 final NetworkInterface iface;
1711 try {
1712 iface = NetworkInterface.getByName(lp.getInterfaceName());
1713 } catch (SocketException e) {
1714 Log.e(TAG, "Error querying interface", e);
1715 return IFACE_IDX_ANY;
1716 }
1717
1718 if (iface == null) {
1719 Log.e(TAG, "Interface not found: " + lp.getInterfaceName());
1720 return IFACE_IDX_ANY;
1721 }
1722
1723 return iface.getIndex();
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001724 }
1725
1726 private boolean stopResolveService(int resolveId) {
paulhu2b9ed952022-02-10 21:58:32 +08001727 return mMDnsManager.stopOperation(resolveId);
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001728 }
1729
paulhu2b9ed952022-02-10 21:58:32 +08001730 private boolean getAddrInfo(int resolveId, String hostname, int interfaceIdx) {
1731 return mMDnsManager.getServiceAddress(resolveId, hostname, interfaceIdx);
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001732 }
1733
1734 private boolean stopGetAddrInfo(int resolveId) {
paulhu2b9ed952022-02-10 21:58:32 +08001735 return mMDnsManager.stopOperation(resolveId);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001736 }
1737
1738 @Override
Irfan Sheriff75006652012-04-17 23:15:29 -07001739 public void dump(FileDescriptor fd, PrintWriter pw, String[] args) {
paulhu3ffffe72021-09-16 10:15:22 +08001740 if (!PermissionUtils.checkDumpPermission(mContext, TAG, pw)) return;
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001741
Irfan Sheriff75006652012-04-17 23:15:29 -07001742 for (ClientInfo client : mClients.values()) {
1743 pw.println("Client Info");
1744 pw.println(client);
1745 }
1746
1747 mNsdStateMachine.dump(fd, pw, args);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001748 }
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001749
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001750 private abstract static class ClientRequest {
1751 private final int mGlobalId;
1752
1753 private ClientRequest(int globalId) {
1754 mGlobalId = globalId;
1755 }
1756 }
1757
1758 private static class LegacyClientRequest extends ClientRequest {
1759 private final int mRequestCode;
1760
1761 private LegacyClientRequest(int globalId, int requestCode) {
1762 super(globalId);
1763 mRequestCode = requestCode;
1764 }
1765 }
1766
1767 private static class AdvertiserClientRequest extends ClientRequest {
1768 private AdvertiserClientRequest(int globalId) {
1769 super(globalId);
1770 }
1771 }
1772
1773 private static class DiscoveryManagerRequest extends ClientRequest {
1774 @NonNull
1775 private final MdnsListener mListener;
1776
1777 private DiscoveryManagerRequest(int globalId, @NonNull MdnsListener listener) {
1778 super(globalId);
1779 mListener = listener;
1780 }
1781 }
1782
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001783 /* Information tracked per client */
1784 private class ClientInfo {
1785
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001786 private static final int MAX_LIMIT = 10;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001787 private final INsdManagerCallback mCb;
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001788 /* Remembers a resolved service until getaddrinfo completes */
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001789 private NsdServiceInfo mResolvedService;
1790
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001791 /* A map from client-side ID (listenerKey) to the request */
1792 private final SparseArray<ClientRequest> mClientRequests = new SparseArray<>();
Paul Hu23fa2022023-01-13 22:57:24 +08001793
Luke Huangf7277ed2021-07-12 21:15:10 +08001794 // The target SDK of this client < Build.VERSION_CODES.S
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001795 private boolean mIsPreSClient = false;
Luke Huangf7277ed2021-07-12 21:15:10 +08001796
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001797 private ClientInfo(INsdManagerCallback cb) {
1798 mCb = cb;
paulhub2225702021-11-17 09:35:33 +08001799 if (DBG) Log.d(TAG, "New client");
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001800 }
Irfan Sheriff75006652012-04-17 23:15:29 -07001801
1802 @Override
1803 public String toString() {
Jeff Sharkey63465382020-10-17 21:20:13 -06001804 StringBuilder sb = new StringBuilder();
Irfan Sheriff75006652012-04-17 23:15:29 -07001805 sb.append("mResolvedService ").append(mResolvedService).append("\n");
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001806 sb.append("mIsLegacy ").append(mIsPreSClient).append("\n");
1807 for (int i = 0; i < mClientRequests.size(); i++) {
1808 int clientID = mClientRequests.keyAt(i);
1809 sb.append("clientId ")
1810 .append(clientID)
1811 .append(" mDnsId ").append(mClientRequests.valueAt(i).mGlobalId)
1812 .append(" type ").append(
1813 mClientRequests.valueAt(i).getClass().getSimpleName())
1814 .append("\n");
Irfan Sheriff75006652012-04-17 23:15:29 -07001815 }
1816 return sb.toString();
1817 }
Dave Plattfeff2af2014-03-07 14:48:22 -08001818
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001819 private boolean isPreSClient() {
1820 return mIsPreSClient;
Luke Huangf7277ed2021-07-12 21:15:10 +08001821 }
1822
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001823 private void setPreSClient() {
1824 mIsPreSClient = true;
Luke Huangf7277ed2021-07-12 21:15:10 +08001825 }
1826
Paul Hue4f5f252023-02-16 21:13:47 +08001827 private void unregisterMdnsListenerFromRequest(ClientRequest request) {
1828 final MdnsListener listener =
1829 ((DiscoveryManagerRequest) request).mListener;
1830 mMdnsDiscoveryManager.unregisterListener(
1831 listener.getListenedServiceType(), listener);
1832 }
1833
Dave Plattfeff2af2014-03-07 14:48:22 -08001834 // Remove any pending requests from the global map when we get rid of a client,
1835 // and send cancellations to the daemon.
1836 private void expungeAllRequests() {
Hugo Benichid2552ae2017-04-11 14:42:47 +09001837 // TODO: to keep handler responsive, do not clean all requests for that client at once.
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001838 for (int i = 0; i < mClientRequests.size(); i++) {
1839 final int clientId = mClientRequests.keyAt(i);
1840 final ClientRequest request = mClientRequests.valueAt(i);
1841 final int globalId = request.mGlobalId;
Dave Plattfeff2af2014-03-07 14:48:22 -08001842 mIdToClientInfoMap.remove(globalId);
paulhub2225702021-11-17 09:35:33 +08001843 if (DBG) {
1844 Log.d(TAG, "Terminating client-ID " + clientId
1845 + " global-ID " + globalId + " type " + mClientRequests.get(clientId));
1846 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001847
1848 if (request instanceof DiscoveryManagerRequest) {
Paul Hue4f5f252023-02-16 21:13:47 +08001849 unregisterMdnsListenerFromRequest(request);
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001850 continue;
1851 }
1852
1853 if (request instanceof AdvertiserClientRequest) {
1854 mAdvertiser.removeService(globalId);
1855 continue;
1856 }
1857
1858 if (!(request instanceof LegacyClientRequest)) {
1859 throw new IllegalStateException("Unknown request type: " + request.getClass());
1860 }
1861
1862 switch (((LegacyClientRequest) request).mRequestCode) {
Dave Plattfeff2af2014-03-07 14:48:22 -08001863 case NsdManager.DISCOVER_SERVICES:
1864 stopServiceDiscovery(globalId);
1865 break;
1866 case NsdManager.RESOLVE_SERVICE:
1867 stopResolveService(globalId);
1868 break;
1869 case NsdManager.REGISTER_SERVICE:
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001870 unregisterService(globalId);
Dave Plattfeff2af2014-03-07 14:48:22 -08001871 break;
1872 default:
1873 break;
1874 }
1875 }
Dave Plattfeff2af2014-03-07 14:48:22 -08001876 mClientRequests.clear();
1877 }
1878
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001879 // mClientRequests is a sparse array of listener id -> ClientRequest. For a given
1880 // mDnsClient id, return the corresponding listener id. mDnsClient id is also called a
1881 // global id.
Christopher Lane74411222014-04-25 18:39:07 -07001882 private int getClientId(final int globalId) {
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001883 for (int i = 0; i < mClientRequests.size(); i++) {
1884 if (mClientRequests.valueAt(i).mGlobalId == globalId) {
1885 return mClientRequests.keyAt(i);
1886 }
Christopher Lane74411222014-04-25 18:39:07 -07001887 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001888 return -1;
Christopher Lane74411222014-04-25 18:39:07 -07001889 }
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001890
1891 void onDiscoverServicesStarted(int listenerKey, NsdServiceInfo info) {
1892 try {
1893 mCb.onDiscoverServicesStarted(listenerKey, info);
1894 } catch (RemoteException e) {
1895 Log.e(TAG, "Error calling onDiscoverServicesStarted", e);
1896 }
1897 }
1898
1899 void onDiscoverServicesFailed(int listenerKey, int error) {
1900 try {
1901 mCb.onDiscoverServicesFailed(listenerKey, error);
1902 } catch (RemoteException e) {
1903 Log.e(TAG, "Error calling onDiscoverServicesFailed", e);
1904 }
1905 }
1906
1907 void onServiceFound(int listenerKey, NsdServiceInfo info) {
1908 try {
1909 mCb.onServiceFound(listenerKey, info);
1910 } catch (RemoteException e) {
1911 Log.e(TAG, "Error calling onServiceFound(", e);
1912 }
1913 }
1914
1915 void onServiceLost(int listenerKey, NsdServiceInfo info) {
1916 try {
1917 mCb.onServiceLost(listenerKey, info);
1918 } catch (RemoteException e) {
1919 Log.e(TAG, "Error calling onServiceLost(", e);
1920 }
1921 }
1922
1923 void onStopDiscoveryFailed(int listenerKey, int error) {
1924 try {
1925 mCb.onStopDiscoveryFailed(listenerKey, error);
1926 } catch (RemoteException e) {
1927 Log.e(TAG, "Error calling onStopDiscoveryFailed", e);
1928 }
1929 }
1930
1931 void onStopDiscoverySucceeded(int listenerKey) {
1932 try {
1933 mCb.onStopDiscoverySucceeded(listenerKey);
1934 } catch (RemoteException e) {
1935 Log.e(TAG, "Error calling onStopDiscoverySucceeded", e);
1936 }
1937 }
1938
1939 void onRegisterServiceFailed(int listenerKey, int error) {
1940 try {
1941 mCb.onRegisterServiceFailed(listenerKey, error);
1942 } catch (RemoteException e) {
1943 Log.e(TAG, "Error calling onRegisterServiceFailed", e);
1944 }
1945 }
1946
1947 void onRegisterServiceSucceeded(int listenerKey, NsdServiceInfo info) {
1948 try {
1949 mCb.onRegisterServiceSucceeded(listenerKey, info);
1950 } catch (RemoteException e) {
1951 Log.e(TAG, "Error calling onRegisterServiceSucceeded", e);
1952 }
1953 }
1954
1955 void onUnregisterServiceFailed(int listenerKey, int error) {
1956 try {
1957 mCb.onUnregisterServiceFailed(listenerKey, error);
1958 } catch (RemoteException e) {
1959 Log.e(TAG, "Error calling onUnregisterServiceFailed", e);
1960 }
1961 }
1962
1963 void onUnregisterServiceSucceeded(int listenerKey) {
1964 try {
1965 mCb.onUnregisterServiceSucceeded(listenerKey);
1966 } catch (RemoteException e) {
1967 Log.e(TAG, "Error calling onUnregisterServiceSucceeded", e);
1968 }
1969 }
1970
1971 void onResolveServiceFailed(int listenerKey, int error) {
1972 try {
1973 mCb.onResolveServiceFailed(listenerKey, error);
1974 } catch (RemoteException e) {
1975 Log.e(TAG, "Error calling onResolveServiceFailed", e);
1976 }
1977 }
1978
1979 void onResolveServiceSucceeded(int listenerKey, NsdServiceInfo info) {
1980 try {
1981 mCb.onResolveServiceSucceeded(listenerKey, info);
1982 } catch (RemoteException e) {
1983 Log.e(TAG, "Error calling onResolveServiceSucceeded", e);
1984 }
1985 }
Paul Hub58deb72022-12-26 09:24:42 +00001986
1987 void onStopResolutionFailed(int listenerKey, int error) {
1988 try {
1989 mCb.onStopResolutionFailed(listenerKey, error);
1990 } catch (RemoteException e) {
1991 Log.e(TAG, "Error calling onStopResolutionFailed", e);
1992 }
1993 }
1994
1995 void onStopResolutionSucceeded(int listenerKey) {
1996 try {
1997 mCb.onStopResolutionSucceeded(listenerKey);
1998 } catch (RemoteException e) {
1999 Log.e(TAG, "Error calling onStopResolutionSucceeded", e);
2000 }
2001 }
Paul Hu18aeccc2022-12-27 08:48:48 +00002002
2003 void onServiceInfoCallbackRegistrationFailed(int listenerKey, int error) {
2004 try {
2005 mCb.onServiceInfoCallbackRegistrationFailed(listenerKey, error);
2006 } catch (RemoteException e) {
2007 Log.e(TAG, "Error calling onServiceInfoCallbackRegistrationFailed", e);
2008 }
2009 }
2010
2011 void onServiceUpdated(int listenerKey, NsdServiceInfo info) {
2012 try {
2013 mCb.onServiceUpdated(listenerKey, info);
2014 } catch (RemoteException e) {
2015 Log.e(TAG, "Error calling onServiceUpdated", e);
2016 }
2017 }
2018
2019 void onServiceUpdatedLost(int listenerKey) {
2020 try {
2021 mCb.onServiceUpdatedLost(listenerKey);
2022 } catch (RemoteException e) {
2023 Log.e(TAG, "Error calling onServiceUpdatedLost", e);
2024 }
2025 }
2026
2027 void onServiceInfoCallbackUnregistered(int listenerKey) {
2028 try {
2029 mCb.onServiceInfoCallbackUnregistered(listenerKey);
2030 } catch (RemoteException e) {
2031 Log.e(TAG, "Error calling onServiceInfoCallbackUnregistered", e);
2032 }
2033 }
Irfan Sheriffe8de2462012-04-11 14:52:19 -07002034 }
Irfan Sheriff77ec5582012-03-22 17:01:39 -07002035}