blob: f426062b64f5f055a70f219653e8f5c9817322d4 [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
Paul Hu23fa2022023-01-13 22:57:24 +080025import android.annotation.NonNull;
Paul Hu4bd98ef2023-01-12 13:42:07 +080026import android.annotation.Nullable;
paulhua262cc12019-08-12 16:25:11 +080027import android.content.Context;
Irfan Sheriff75006652012-04-17 23:15:29 -070028import android.content.Intent;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +090029import android.net.ConnectivityManager;
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +090030import android.net.INetd;
Paul Hu75069ed2023-01-14 00:31:09 +080031import android.net.InetAddresses;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +090032import android.net.LinkProperties;
33import android.net.Network;
paulhu2b9ed952022-02-10 21:58:32 +080034import android.net.mdns.aidl.DiscoveryInfo;
35import android.net.mdns.aidl.GetAddressInfo;
36import android.net.mdns.aidl.IMDnsEventListener;
37import android.net.mdns.aidl.RegistrationInfo;
38import android.net.mdns.aidl.ResolutionInfo;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070039import android.net.nsd.INsdManager;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +090040import android.net.nsd.INsdManagerCallback;
41import android.net.nsd.INsdServiceConnector;
paulhu2b9ed952022-02-10 21:58:32 +080042import android.net.nsd.MDnsManager;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070043import android.net.nsd.NsdManager;
paulhua262cc12019-08-12 16:25:11 +080044import android.net.nsd.NsdServiceInfo;
Hugo Benichi803a2f02017-04-24 11:35:06 +090045import android.os.Handler;
paulhua262cc12019-08-12 16:25:11 +080046import android.os.HandlerThread;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +090047import android.os.IBinder;
Paul Hu4bd98ef2023-01-12 13:42:07 +080048import android.os.Looper;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070049import android.os.Message;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +090050import android.os.RemoteException;
Dianne Hackborn692107e2012-08-29 18:32:08 -070051import android.os.UserHandle;
Paul Hu23fa2022023-01-13 22:57:24 +080052import android.text.TextUtils;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +090053import android.util.Log;
54import android.util.Pair;
Irfan Sheriffe4c42f42012-05-03 16:44:27 -070055import android.util.SparseArray;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070056
paulhua262cc12019-08-12 16:25:11 +080057import com.android.internal.annotations.VisibleForTesting;
paulhua262cc12019-08-12 16:25:11 +080058import com.android.internal.util.State;
59import com.android.internal.util.StateMachine;
Paul Hu4bd98ef2023-01-12 13:42:07 +080060import com.android.net.module.util.DeviceConfigUtils;
paulhu3ffffe72021-09-16 10:15:22 +080061import com.android.net.module.util.PermissionUtils;
Paul Hu4bd98ef2023-01-12 13:42:07 +080062import com.android.server.connectivity.mdns.ExecutorProvider;
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +090063import com.android.server.connectivity.mdns.MdnsAdvertiser;
Paul Hu4bd98ef2023-01-12 13:42:07 +080064import com.android.server.connectivity.mdns.MdnsDiscoveryManager;
65import com.android.server.connectivity.mdns.MdnsMultinetworkSocketClient;
Paul Hu23fa2022023-01-13 22:57:24 +080066import com.android.server.connectivity.mdns.MdnsSearchOptions;
67import com.android.server.connectivity.mdns.MdnsServiceBrowserListener;
68import com.android.server.connectivity.mdns.MdnsServiceInfo;
Paul Hu4bd98ef2023-01-12 13:42:07 +080069import com.android.server.connectivity.mdns.MdnsSocketClientBase;
70import com.android.server.connectivity.mdns.MdnsSocketProvider;
paulhua262cc12019-08-12 16:25:11 +080071
Irfan Sheriff77ec5582012-03-22 17:01:39 -070072import java.io.FileDescriptor;
73import java.io.PrintWriter;
Irfan Sheriffe8de2462012-04-11 14:52:19 -070074import java.net.InetAddress;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +090075import java.net.NetworkInterface;
76import java.net.SocketException;
77import java.net.UnknownHostException;
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +090078import java.nio.ByteBuffer;
79import java.nio.CharBuffer;
80import java.nio.charset.Charset;
81import java.nio.charset.CharsetEncoder;
82import java.nio.charset.StandardCharsets;
Paul Hu30bd70d2023-02-07 13:20:56 +000083import java.util.ArrayList;
Irfan Sheriffe8de2462012-04-11 14:52:19 -070084import java.util.HashMap;
Paul Hu23fa2022023-01-13 22:57:24 +080085import java.util.List;
Paul Hu75069ed2023-01-14 00:31:09 +080086import java.util.Map;
Paul Hu23fa2022023-01-13 22:57:24 +080087import java.util.regex.Matcher;
88import java.util.regex.Pattern;
Irfan Sheriff77ec5582012-03-22 17:01:39 -070089
Irfan Sheriff77ec5582012-03-22 17:01:39 -070090/**
91 * Network Service Discovery Service handles remote service discovery operation requests by
92 * implementing the INsdManager interface.
93 *
94 * @hide
95 */
96public class NsdService extends INsdManager.Stub {
97 private static final String TAG = "NsdService";
98 private static final String MDNS_TAG = "mDnsConnector";
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +090099 /**
100 * Enable discovery using the Java DiscoveryManager, instead of the legacy mdnsresponder
101 * implementation.
102 */
Paul Hu4bd98ef2023-01-12 13:42:07 +0800103 private static final String MDNS_DISCOVERY_MANAGER_VERSION = "mdns_discovery_manager_version";
Paul Hu23fa2022023-01-13 22:57:24 +0800104 private static final String LOCAL_DOMAIN_NAME = "local";
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900105 // Max label length as per RFC 1034/1035
106 private static final int MAX_LABEL_LENGTH = 63;
Irfan Sheriff77ec5582012-03-22 17:01:39 -0700107
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900108 /**
109 * Enable advertising using the Java MdnsAdvertiser, instead of the legacy mdnsresponder
110 * implementation.
111 */
112 private static final String MDNS_ADVERTISER_VERSION = "mdns_advertiser_version";
113
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +0900114 /**
115 * Comma-separated list of type:flag mappings indicating the flags to use to allowlist
116 * discovery/advertising using MdnsDiscoveryManager / MdnsAdvertiser for a given type.
117 *
118 * For example _mytype._tcp.local and _othertype._tcp.local would be configured with:
119 * _mytype._tcp:mytype,_othertype._tcp.local:othertype
120 *
121 * In which case the flags:
122 * "mdns_discovery_manager_allowlist_mytype_version",
123 * "mdns_advertiser_allowlist_mytype_version",
124 * "mdns_discovery_manager_allowlist_othertype_version",
125 * "mdns_advertiser_allowlist_othertype_version"
126 * would be used to toggle MdnsDiscoveryManager / MdnsAdvertiser for each type. The flags will
127 * be read with
128 * {@link DeviceConfigUtils#isFeatureEnabled(Context, String, String, String, boolean)}.
129 *
130 * @see #MDNS_DISCOVERY_MANAGER_ALLOWLIST_FLAG_PREFIX
131 * @see #MDNS_ADVERTISER_ALLOWLIST_FLAG_PREFIX
132 * @see #MDNS_ALLOWLIST_FLAG_SUFFIX
133 */
134 private static final String MDNS_TYPE_ALLOWLIST_FLAGS = "mdns_type_allowlist_flags";
135
136 private static final String MDNS_DISCOVERY_MANAGER_ALLOWLIST_FLAG_PREFIX =
137 "mdns_discovery_manager_allowlist_";
138 private static final String MDNS_ADVERTISER_ALLOWLIST_FLAG_PREFIX =
139 "mdns_advertiser_allowlist_";
140 private static final String MDNS_ALLOWLIST_FLAG_SUFFIX = "_version";
141
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900142 public static final boolean DBG = Log.isLoggable(TAG, Log.DEBUG);
Luke Huang92860f92021-06-23 06:29:30 +0000143 private static final long CLEANUP_DELAY_MS = 10000;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +0900144 private static final int IFACE_IDX_ANY = 0;
Irfan Sheriff77ec5582012-03-22 17:01:39 -0700145
Hugo Benichi32be63d2017-04-05 14:06:11 +0900146 private final Context mContext;
Hugo Benichi32be63d2017-04-05 14:06:11 +0900147 private final NsdStateMachine mNsdStateMachine;
paulhu2b9ed952022-02-10 21:58:32 +0800148 private final MDnsManager mMDnsManager;
149 private final MDnsEventCallback mMDnsEventCallback;
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900150 @NonNull
151 private final Dependencies mDeps;
152 @NonNull
Paul Hu4bd98ef2023-01-12 13:42:07 +0800153 private final MdnsMultinetworkSocketClient mMdnsSocketClient;
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900154 @NonNull
Paul Hu4bd98ef2023-01-12 13:42:07 +0800155 private final MdnsDiscoveryManager mMdnsDiscoveryManager;
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900156 @NonNull
Paul Hu4bd98ef2023-01-12 13:42:07 +0800157 private final MdnsSocketProvider mMdnsSocketProvider;
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900158 @NonNull
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900159 private final MdnsAdvertiser mAdvertiser;
Paul Hu23fa2022023-01-13 22:57:24 +0800160 // WARNING : Accessing these values in any thread is not safe, it must only be changed in the
paulhu2b9ed952022-02-10 21:58:32 +0800161 // state machine thread. If change this outside state machine, it will need to introduce
162 // synchronization.
163 private boolean mIsDaemonStarted = false;
Paul Hu23fa2022023-01-13 22:57:24 +0800164 private boolean mIsMonitoringSocketsStarted = false;
Irfan Sheriff77ec5582012-03-22 17:01:39 -0700165
166 /**
167 * Clients receiving asynchronous messages
168 */
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900169 private final HashMap<NsdServiceConnector, ClientInfo> mClients = new HashMap<>();
Irfan Sheriff77ec5582012-03-22 17:01:39 -0700170
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700171 /* A map from unique id to client info */
Hugo Benichi32be63d2017-04-05 14:06:11 +0900172 private final SparseArray<ClientInfo> mIdToClientInfoMap= new SparseArray<>();
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700173
Luke Huang05298582021-06-13 16:52:05 +0000174 private final long mCleanupDelayMs;
Irfan Sheriff77ec5582012-03-22 17:01:39 -0700175
Hugo Benichi32be63d2017-04-05 14:06:11 +0900176 private static final int INVALID_ID = 0;
Irfan Sheriffe8de2462012-04-11 14:52:19 -0700177 private int mUniqueId = 1;
Luke Huangf7277ed2021-07-12 21:15:10 +0800178 // The count of the connected legacy clients.
179 private int mLegacyClientCount = 0;
Irfan Sheriffe8de2462012-04-11 14:52:19 -0700180
Paul Hu23fa2022023-01-13 22:57:24 +0800181 private static class MdnsListener implements MdnsServiceBrowserListener {
182 protected final int mClientId;
183 protected final int mTransactionId;
184 @NonNull
185 protected final NsdServiceInfo mReqServiceInfo;
186 @NonNull
187 protected final String mListenedServiceType;
188
189 MdnsListener(int clientId, int transactionId, @NonNull NsdServiceInfo reqServiceInfo,
190 @NonNull String listenedServiceType) {
191 mClientId = clientId;
192 mTransactionId = transactionId;
193 mReqServiceInfo = reqServiceInfo;
194 mListenedServiceType = listenedServiceType;
195 }
196
197 @NonNull
198 public String getListenedServiceType() {
199 return mListenedServiceType;
200 }
201
202 @Override
203 public void onServiceFound(@NonNull MdnsServiceInfo serviceInfo) { }
204
205 @Override
206 public void onServiceUpdated(@NonNull MdnsServiceInfo serviceInfo) { }
207
208 @Override
209 public void onServiceRemoved(@NonNull MdnsServiceInfo serviceInfo) { }
210
211 @Override
212 public void onServiceNameDiscovered(@NonNull MdnsServiceInfo serviceInfo) { }
213
214 @Override
215 public void onServiceNameRemoved(@NonNull MdnsServiceInfo serviceInfo) { }
216
217 @Override
218 public void onSearchStoppedWithError(int error) { }
219
220 @Override
221 public void onSearchFailedToStart() { }
222
223 @Override
224 public void onDiscoveryQuerySent(@NonNull List<String> subtypes, int transactionId) { }
225
226 @Override
227 public void onFailedToParseMdnsResponse(int receivedPacketNumber, int errorCode) { }
228 }
229
230 private class DiscoveryListener extends MdnsListener {
231
232 DiscoveryListener(int clientId, int transactionId, @NonNull NsdServiceInfo reqServiceInfo,
233 @NonNull String listenServiceType) {
234 super(clientId, transactionId, reqServiceInfo, listenServiceType);
235 }
236
237 @Override
238 public void onServiceNameDiscovered(@NonNull MdnsServiceInfo serviceInfo) {
Paul Hu019621e2023-01-13 23:26:49 +0800239 mNsdStateMachine.sendMessage(MDNS_DISCOVERY_MANAGER_EVENT, mTransactionId,
240 NsdManager.SERVICE_FOUND,
241 new MdnsEvent(mClientId, mReqServiceInfo.getServiceType(), serviceInfo));
Paul Hu23fa2022023-01-13 22:57:24 +0800242 }
243
244 @Override
245 public void onServiceNameRemoved(@NonNull MdnsServiceInfo serviceInfo) {
Paul Hu319751a2023-01-13 23:56:34 +0800246 mNsdStateMachine.sendMessage(MDNS_DISCOVERY_MANAGER_EVENT, mTransactionId,
247 NsdManager.SERVICE_LOST,
248 new MdnsEvent(mClientId, mReqServiceInfo.getServiceType(), serviceInfo));
Paul Hu23fa2022023-01-13 22:57:24 +0800249 }
250 }
251
Paul Hu75069ed2023-01-14 00:31:09 +0800252 private class ResolutionListener extends MdnsListener {
253
254 ResolutionListener(int clientId, int transactionId, @NonNull NsdServiceInfo reqServiceInfo,
255 @NonNull String listenServiceType) {
256 super(clientId, transactionId, reqServiceInfo, listenServiceType);
257 }
258
259 @Override
260 public void onServiceFound(MdnsServiceInfo serviceInfo) {
261 mNsdStateMachine.sendMessage(MDNS_DISCOVERY_MANAGER_EVENT, mTransactionId,
262 NsdManager.RESOLVE_SERVICE_SUCCEEDED,
263 new MdnsEvent(mClientId, mReqServiceInfo.getServiceType(), serviceInfo));
264 }
265 }
266
Paul Hu30bd70d2023-02-07 13:20:56 +0000267 private class ServiceInfoListener extends MdnsListener {
268
269 ServiceInfoListener(int clientId, int transactionId, @NonNull NsdServiceInfo reqServiceInfo,
270 @NonNull String listenServiceType) {
271 super(clientId, transactionId, reqServiceInfo, listenServiceType);
272 }
273
274 @Override
275 public void onServiceFound(@NonNull MdnsServiceInfo serviceInfo) {
276 mNsdStateMachine.sendMessage(MDNS_DISCOVERY_MANAGER_EVENT, mTransactionId,
277 NsdManager.SERVICE_UPDATED,
278 new MdnsEvent(mClientId, mReqServiceInfo.getServiceType(), serviceInfo));
279 }
280
281 @Override
282 public void onServiceUpdated(@NonNull MdnsServiceInfo serviceInfo) {
283 mNsdStateMachine.sendMessage(MDNS_DISCOVERY_MANAGER_EVENT, mTransactionId,
284 NsdManager.SERVICE_UPDATED,
285 new MdnsEvent(mClientId, mReqServiceInfo.getServiceType(), serviceInfo));
286 }
287
288 @Override
289 public void onServiceRemoved(@NonNull MdnsServiceInfo serviceInfo) {
290 mNsdStateMachine.sendMessage(MDNS_DISCOVERY_MANAGER_EVENT, mTransactionId,
291 NsdManager.SERVICE_UPDATED_LOST,
292 new MdnsEvent(mClientId, mReqServiceInfo.getServiceType(), serviceInfo));
293 }
294 }
295
Paul Hu019621e2023-01-13 23:26:49 +0800296 /**
297 * Data class of mdns service callback information.
298 */
299 private static class MdnsEvent {
300 final int mClientId;
301 @NonNull
302 final String mRequestedServiceType;
303 @NonNull
304 final MdnsServiceInfo mMdnsServiceInfo;
305
306 MdnsEvent(int clientId, @NonNull String requestedServiceType,
307 @NonNull MdnsServiceInfo mdnsServiceInfo) {
308 mClientId = clientId;
309 mRequestedServiceType = requestedServiceType;
310 mMdnsServiceInfo = mdnsServiceInfo;
311 }
312 }
313
Irfan Sheriff75006652012-04-17 23:15:29 -0700314 private class NsdStateMachine extends StateMachine {
315
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700316 private final DefaultState mDefaultState = new DefaultState();
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700317 private final EnabledState mEnabledState = new EnabledState();
Irfan Sheriff75006652012-04-17 23:15:29 -0700318
319 @Override
Wink Saville358f5d42012-05-29 12:40:46 -0700320 protected String getWhatToString(int what) {
Hugo Benichi32be63d2017-04-05 14:06:11 +0900321 return NsdManager.nameOf(what);
Irfan Sheriff75006652012-04-17 23:15:29 -0700322 }
323
Luke Huang92860f92021-06-23 06:29:30 +0000324 private void maybeStartDaemon() {
paulhu2b9ed952022-02-10 21:58:32 +0800325 if (mIsDaemonStarted) {
326 if (DBG) Log.d(TAG, "Daemon is already started.");
327 return;
328 }
329 mMDnsManager.registerEventListener(mMDnsEventCallback);
330 mMDnsManager.startDaemon();
331 mIsDaemonStarted = true;
Luke Huang05298582021-06-13 16:52:05 +0000332 maybeScheduleStop();
333 }
334
paulhu2b9ed952022-02-10 21:58:32 +0800335 private void maybeStopDaemon() {
336 if (!mIsDaemonStarted) {
337 if (DBG) Log.d(TAG, "Daemon has not been started.");
338 return;
339 }
340 mMDnsManager.unregisterEventListener(mMDnsEventCallback);
341 mMDnsManager.stopDaemon();
342 mIsDaemonStarted = false;
343 }
344
Luke Huang92860f92021-06-23 06:29:30 +0000345 private boolean isAnyRequestActive() {
346 return mIdToClientInfoMap.size() != 0;
347 }
348
349 private void scheduleStop() {
350 sendMessageDelayed(NsdManager.DAEMON_CLEANUP, mCleanupDelayMs);
351 }
352 private void maybeScheduleStop() {
Luke Huangf7277ed2021-07-12 21:15:10 +0800353 // The native daemon should stay alive and can't be cleanup
354 // if any legacy client connected.
355 if (!isAnyRequestActive() && mLegacyClientCount == 0) {
Luke Huang92860f92021-06-23 06:29:30 +0000356 scheduleStop();
Luke Huang05298582021-06-13 16:52:05 +0000357 }
358 }
359
Luke Huang92860f92021-06-23 06:29:30 +0000360 private void cancelStop() {
Luke Huang05298582021-06-13 16:52:05 +0000361 this.removeMessages(NsdManager.DAEMON_CLEANUP);
362 }
363
Paul Hu23fa2022023-01-13 22:57:24 +0800364 private void maybeStartMonitoringSockets() {
365 if (mIsMonitoringSocketsStarted) {
366 if (DBG) Log.d(TAG, "Socket monitoring is already started.");
367 return;
368 }
369
370 mMdnsSocketProvider.startMonitoringSockets();
371 mIsMonitoringSocketsStarted = true;
372 }
373
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900374 private void maybeStopMonitoringSocketsIfNoActiveRequest() {
375 if (!mIsMonitoringSocketsStarted) return;
376 if (isAnyRequestActive()) return;
377
Paul Hu58f20602023-02-18 11:41:07 +0800378 mMdnsSocketProvider.requestStopWhenInactive();
Paul Hu23fa2022023-01-13 22:57:24 +0800379 mIsMonitoringSocketsStarted = false;
380 }
381
Hugo Benichi803a2f02017-04-24 11:35:06 +0900382 NsdStateMachine(String name, Handler handler) {
383 super(name, handler);
Irfan Sheriff75006652012-04-17 23:15:29 -0700384 addState(mDefaultState);
Irfan Sheriff75006652012-04-17 23:15:29 -0700385 addState(mEnabledState, mDefaultState);
paulhu5568f452021-11-30 13:31:29 +0800386 State initialState = mEnabledState;
Hugo Benichi912db992017-04-24 16:41:03 +0900387 setInitialState(initialState);
Wink Saville358f5d42012-05-29 12:40:46 -0700388 setLogRecSize(25);
Irfan Sheriff75006652012-04-17 23:15:29 -0700389 }
390
391 class DefaultState extends State {
392 @Override
393 public boolean processMessage(Message msg) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900394 final ClientInfo cInfo;
395 final int clientId = msg.arg2;
Irfan Sheriff75006652012-04-17 23:15:29 -0700396 switch (msg.what) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900397 case NsdManager.REGISTER_CLIENT:
398 final Pair<NsdServiceConnector, INsdManagerCallback> arg =
399 (Pair<NsdServiceConnector, INsdManagerCallback>) msg.obj;
400 final INsdManagerCallback cb = arg.second;
401 try {
402 cb.asBinder().linkToDeath(arg.first, 0);
403 cInfo = new ClientInfo(cb);
404 mClients.put(arg.first, cInfo);
405 } catch (RemoteException e) {
406 Log.w(TAG, "Client " + clientId + " has already died");
Irfan Sheriff75006652012-04-17 23:15:29 -0700407 }
408 break;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900409 case NsdManager.UNREGISTER_CLIENT:
410 final NsdServiceConnector connector = (NsdServiceConnector) msg.obj;
411 cInfo = mClients.remove(connector);
Dave Plattfeff2af2014-03-07 14:48:22 -0800412 if (cInfo != null) {
413 cInfo.expungeAllRequests();
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900414 if (cInfo.isPreSClient()) {
Luke Huangf7277ed2021-07-12 21:15:10 +0800415 mLegacyClientCount -= 1;
416 }
Dave Plattfeff2af2014-03-07 14:48:22 -0800417 }
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900418 maybeStopMonitoringSocketsIfNoActiveRequest();
Luke Huangf7277ed2021-07-12 21:15:10 +0800419 maybeScheduleStop();
Irfan Sheriff75006652012-04-17 23:15:29 -0700420 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700421 case NsdManager.DISCOVER_SERVICES:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900422 cInfo = getClientInfoForReply(msg);
423 if (cInfo != null) {
424 cInfo.onDiscoverServicesFailed(
425 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
426 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700427 break;
428 case NsdManager.STOP_DISCOVERY:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900429 cInfo = getClientInfoForReply(msg);
430 if (cInfo != null) {
431 cInfo.onStopDiscoveryFailed(
432 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
433 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700434 break;
435 case NsdManager.REGISTER_SERVICE:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900436 cInfo = getClientInfoForReply(msg);
437 if (cInfo != null) {
438 cInfo.onRegisterServiceFailed(
439 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
440 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700441 break;
442 case NsdManager.UNREGISTER_SERVICE:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900443 cInfo = getClientInfoForReply(msg);
444 if (cInfo != null) {
445 cInfo.onUnregisterServiceFailed(
446 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
447 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700448 break;
449 case NsdManager.RESOLVE_SERVICE:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900450 cInfo = getClientInfoForReply(msg);
451 if (cInfo != null) {
452 cInfo.onResolveServiceFailed(
453 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
454 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700455 break;
Paul Hub58deb72022-12-26 09:24:42 +0000456 case NsdManager.STOP_RESOLUTION:
457 cInfo = getClientInfoForReply(msg);
458 if (cInfo != null) {
459 cInfo.onStopResolutionFailed(
460 clientId, NsdManager.FAILURE_OPERATION_NOT_RUNNING);
461 }
462 break;
Paul Hu18aeccc2022-12-27 08:48:48 +0000463 case NsdManager.REGISTER_SERVICE_CALLBACK:
464 cInfo = getClientInfoForReply(msg);
465 if (cInfo != null) {
466 cInfo.onServiceInfoCallbackRegistrationFailed(
467 clientId, NsdManager.FAILURE_BAD_PARAMETERS);
468 }
469 break;
Luke Huang05298582021-06-13 16:52:05 +0000470 case NsdManager.DAEMON_CLEANUP:
paulhu2b9ed952022-02-10 21:58:32 +0800471 maybeStopDaemon();
Luke Huang05298582021-06-13 16:52:05 +0000472 break;
Luke Huangf7277ed2021-07-12 21:15:10 +0800473 // This event should be only sent by the legacy (target SDK < S) clients.
474 // Mark the sending client as legacy.
475 case NsdManager.DAEMON_STARTUP:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900476 cInfo = getClientInfoForReply(msg);
Luke Huangf7277ed2021-07-12 21:15:10 +0800477 if (cInfo != null) {
478 cancelStop();
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900479 cInfo.setPreSClient();
Luke Huangf7277ed2021-07-12 21:15:10 +0800480 mLegacyClientCount += 1;
481 maybeStartDaemon();
482 }
483 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700484 default:
paulhub2225702021-11-17 09:35:33 +0800485 Log.e(TAG, "Unhandled " + msg);
Irfan Sheriff75006652012-04-17 23:15:29 -0700486 return NOT_HANDLED;
487 }
488 return HANDLED;
489 }
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900490
491 private ClientInfo getClientInfoForReply(Message msg) {
492 final ListenerArgs args = (ListenerArgs) msg.obj;
493 return mClients.get(args.connector);
494 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700495 }
496
Irfan Sheriff75006652012-04-17 23:15:29 -0700497 class EnabledState extends State {
498 @Override
499 public void enter() {
500 sendNsdStateChangeBroadcast(true);
Irfan Sheriff75006652012-04-17 23:15:29 -0700501 }
502
503 @Override
504 public void exit() {
Luke Huang05298582021-06-13 16:52:05 +0000505 // TODO: it is incorrect to stop the daemon without expunging all requests
506 // and sending error callbacks to clients.
Luke Huang92860f92021-06-23 06:29:30 +0000507 scheduleStop();
Irfan Sheriff75006652012-04-17 23:15:29 -0700508 }
509
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700510 private boolean requestLimitReached(ClientInfo clientInfo) {
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900511 if (clientInfo.mClientRequests.size() >= ClientInfo.MAX_LIMIT) {
paulhub2225702021-11-17 09:35:33 +0800512 if (DBG) Log.d(TAG, "Exceeded max outstanding requests " + clientInfo);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700513 return true;
514 }
515 return false;
516 }
517
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900518 private void storeLegacyRequestMap(int clientId, int globalId, ClientInfo clientInfo,
519 int what) {
520 clientInfo.mClientRequests.put(clientId, new LegacyClientRequest(globalId, what));
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700521 mIdToClientInfoMap.put(globalId, clientInfo);
Luke Huang05298582021-06-13 16:52:05 +0000522 // Remove the cleanup event because here comes a new request.
523 cancelStop();
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700524 }
525
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900526 private void storeAdvertiserRequestMap(int clientId, int globalId,
Paul Hu23fa2022023-01-13 22:57:24 +0800527 ClientInfo clientInfo) {
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900528 clientInfo.mClientRequests.put(clientId, new AdvertiserClientRequest(globalId));
529 mIdToClientInfoMap.put(globalId, clientInfo);
Paul Hu23fa2022023-01-13 22:57:24 +0800530 }
531
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900532 private void removeRequestMap(int clientId, int globalId, ClientInfo clientInfo) {
533 final ClientRequest existing = clientInfo.mClientRequests.get(clientId);
534 if (existing == null) return;
535 clientInfo.mClientRequests.remove(clientId);
536 mIdToClientInfoMap.remove(globalId);
537
538 if (existing instanceof LegacyClientRequest) {
539 maybeScheduleStop();
540 } else {
541 maybeStopMonitoringSocketsIfNoActiveRequest();
542 }
543 }
544
545 private void storeDiscoveryManagerRequestMap(int clientId, int globalId,
546 MdnsListener listener, ClientInfo clientInfo) {
547 clientInfo.mClientRequests.put(clientId,
548 new DiscoveryManagerRequest(globalId, listener));
549 mIdToClientInfoMap.put(globalId, clientInfo);
Paul Hu23fa2022023-01-13 22:57:24 +0800550 }
551
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900552 /**
553 * Truncate a service name to up to 63 UTF-8 bytes.
554 *
555 * See RFC6763 4.1.1: service instance names are UTF-8 and up to 63 bytes. Truncating
556 * names used in registerService follows historical behavior (see mdnsresponder
557 * handle_regservice_request).
558 */
559 @NonNull
560 private String truncateServiceName(@NonNull String originalName) {
561 // UTF-8 is at most 4 bytes per character; return early in the common case where
562 // the name can't possibly be over the limit given its string length.
563 if (originalName.length() <= MAX_LABEL_LENGTH / 4) return originalName;
564
565 final Charset utf8 = StandardCharsets.UTF_8;
566 final CharsetEncoder encoder = utf8.newEncoder();
567 final ByteBuffer out = ByteBuffer.allocate(MAX_LABEL_LENGTH);
568 // encode will write as many characters as possible to the out buffer, and just
569 // return an overflow code if there were too many characters (no need to check the
570 // return code here, this method truncates the name on purpose).
571 encoder.encode(CharBuffer.wrap(originalName), out, true /* endOfInput */);
572 return new String(out.array(), 0, out.position(), utf8);
Paul Hu23fa2022023-01-13 22:57:24 +0800573 }
574
Paul Hue4f5f252023-02-16 21:13:47 +0800575 private void stopDiscoveryManagerRequest(ClientRequest request, int clientId, int id,
576 ClientInfo clientInfo) {
577 clientInfo.unregisterMdnsListenerFromRequest(request);
578 removeRequestMap(clientId, id, clientInfo);
579 }
580
Irfan Sheriff75006652012-04-17 23:15:29 -0700581 @Override
582 public boolean processMessage(Message msg) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900583 final ClientInfo clientInfo;
584 final int id;
585 final int clientId = msg.arg2;
586 final ListenerArgs args;
Irfan Sheriff75006652012-04-17 23:15:29 -0700587 switch (msg.what) {
Paul Hu75069ed2023-01-14 00:31:09 +0800588 case NsdManager.DISCOVER_SERVICES: {
paulhub2225702021-11-17 09:35:33 +0800589 if (DBG) Log.d(TAG, "Discover services");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900590 args = (ListenerArgs) msg.obj;
591 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000592 // If the binder death notification for a INsdManagerCallback was received
593 // before any calls are received by NsdService, the clientInfo would be
594 // cleared and cause NPE. Add a null check here to prevent this corner case.
595 if (clientInfo == null) {
596 Log.e(TAG, "Unknown connector in discovery");
597 break;
598 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700599
600 if (requestLimitReached(clientInfo)) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900601 clientInfo.onDiscoverServicesFailed(
602 clientId, NsdManager.FAILURE_MAX_LIMIT);
Irfan Sheriff75006652012-04-17 23:15:29 -0700603 break;
604 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700605
Paul Hu23fa2022023-01-13 22:57:24 +0800606 final NsdServiceInfo info = args.serviceInfo;
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700607 id = getUniqueId();
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +0900608 final String serviceType = constructServiceType(info.getServiceType());
609 if (mDeps.isMdnsDiscoveryManagerEnabled(mContext)
610 || useDiscoveryManagerForType(serviceType)) {
Paul Hu23fa2022023-01-13 22:57:24 +0800611 if (serviceType == null) {
612 clientInfo.onDiscoverServicesFailed(clientId,
613 NsdManager.FAILURE_INTERNAL_ERROR);
614 break;
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700615 }
Paul Hu23fa2022023-01-13 22:57:24 +0800616
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900617 final String listenServiceType = serviceType + ".local";
Paul Hu23fa2022023-01-13 22:57:24 +0800618 maybeStartMonitoringSockets();
619 final MdnsListener listener =
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900620 new DiscoveryListener(clientId, id, info, listenServiceType);
Paul Hu23fa2022023-01-13 22:57:24 +0800621 final MdnsSearchOptions options = MdnsSearchOptions.newBuilder()
622 .setNetwork(info.getNetwork())
623 .setIsPassiveMode(true)
624 .build();
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900625 mMdnsDiscoveryManager.registerListener(
626 listenServiceType, listener, options);
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900627 storeDiscoveryManagerRequestMap(clientId, id, listener, clientInfo);
Paul Hu23fa2022023-01-13 22:57:24 +0800628 clientInfo.onDiscoverServicesStarted(clientId, info);
Irfan Sheriff75006652012-04-17 23:15:29 -0700629 } else {
Paul Hu23fa2022023-01-13 22:57:24 +0800630 maybeStartDaemon();
631 if (discoverServices(id, info)) {
632 if (DBG) {
633 Log.d(TAG, "Discover " + msg.arg2 + " " + id
634 + info.getServiceType());
635 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900636 storeLegacyRequestMap(clientId, id, clientInfo, msg.what);
Paul Hu23fa2022023-01-13 22:57:24 +0800637 clientInfo.onDiscoverServicesStarted(clientId, info);
638 } else {
639 stopServiceDiscovery(id);
640 clientInfo.onDiscoverServicesFailed(clientId,
641 NsdManager.FAILURE_INTERNAL_ERROR);
642 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700643 }
644 break;
Paul Hu75069ed2023-01-14 00:31:09 +0800645 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900646 case NsdManager.STOP_DISCOVERY: {
paulhub2225702021-11-17 09:35:33 +0800647 if (DBG) Log.d(TAG, "Stop service discovery");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900648 args = (ListenerArgs) msg.obj;
649 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000650 // If the binder death notification for a INsdManagerCallback was received
651 // before any calls are received by NsdService, the clientInfo would be
652 // cleared and cause NPE. Add a null check here to prevent this corner case.
653 if (clientInfo == null) {
654 Log.e(TAG, "Unknown connector in stop discovery");
655 break;
656 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700657
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900658 final ClientRequest request = clientInfo.mClientRequests.get(clientId);
659 if (request == null) {
660 Log.e(TAG, "Unknown client request in STOP_DISCOVERY");
Irfan Sheriff75006652012-04-17 23:15:29 -0700661 break;
662 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900663 id = request.mGlobalId;
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900664 // Note isMdnsDiscoveryManagerEnabled may have changed to false at this
665 // point, so this needs to check the type of the original request to
666 // unregister instead of looking at the flag value.
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900667 if (request instanceof DiscoveryManagerRequest) {
Paul Hue4f5f252023-02-16 21:13:47 +0800668 stopDiscoveryManagerRequest(request, clientId, id, clientInfo);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900669 clientInfo.onStopDiscoverySucceeded(clientId);
Irfan Sheriff75006652012-04-17 23:15:29 -0700670 } else {
Paul Hu23fa2022023-01-13 22:57:24 +0800671 removeRequestMap(clientId, id, clientInfo);
672 if (stopServiceDiscovery(id)) {
673 clientInfo.onStopDiscoverySucceeded(clientId);
674 } else {
675 clientInfo.onStopDiscoveryFailed(
676 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
677 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700678 }
679 break;
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900680 }
681 case NsdManager.REGISTER_SERVICE: {
paulhub2225702021-11-17 09:35:33 +0800682 if (DBG) Log.d(TAG, "Register service");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900683 args = (ListenerArgs) msg.obj;
684 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000685 // If the binder death notification for a INsdManagerCallback was received
686 // before any calls are received by NsdService, the clientInfo would be
687 // cleared and cause NPE. Add a null check here to prevent this corner case.
688 if (clientInfo == null) {
689 Log.e(TAG, "Unknown connector in registration");
690 break;
691 }
692
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700693 if (requestLimitReached(clientInfo)) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900694 clientInfo.onRegisterServiceFailed(
695 clientId, NsdManager.FAILURE_MAX_LIMIT);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700696 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700697 }
698
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700699 id = getUniqueId();
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +0900700 final NsdServiceInfo serviceInfo = args.serviceInfo;
701 final String serviceType = serviceInfo.getServiceType();
702 final String registerServiceType = constructServiceType(serviceType);
703 if (mDeps.isMdnsAdvertiserEnabled(mContext)
704 || useAdvertiserForType(registerServiceType)) {
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900705 if (registerServiceType == null) {
706 Log.e(TAG, "Invalid service type: " + serviceType);
707 clientInfo.onRegisterServiceFailed(clientId,
708 NsdManager.FAILURE_INTERNAL_ERROR);
709 break;
710 }
711 serviceInfo.setServiceType(registerServiceType);
712 serviceInfo.setServiceName(truncateServiceName(
713 serviceInfo.getServiceName()));
714
715 maybeStartMonitoringSockets();
716 mAdvertiser.addService(id, serviceInfo);
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900717 storeAdvertiserRequestMap(clientId, id, clientInfo);
Irfan Sheriff75006652012-04-17 23:15:29 -0700718 } else {
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900719 maybeStartDaemon();
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +0900720 if (registerService(id, serviceInfo)) {
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900721 if (DBG) Log.d(TAG, "Register " + clientId + " " + id);
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900722 storeLegacyRequestMap(clientId, id, clientInfo, msg.what);
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900723 // Return success after mDns reports success
724 } else {
725 unregisterService(id);
726 clientInfo.onRegisterServiceFailed(
727 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
728 }
729
Irfan Sheriff75006652012-04-17 23:15:29 -0700730 }
731 break;
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900732 }
733 case NsdManager.UNREGISTER_SERVICE: {
paulhub2225702021-11-17 09:35:33 +0800734 if (DBG) Log.d(TAG, "unregister service");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900735 args = (ListenerArgs) msg.obj;
736 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000737 // If the binder death notification for a INsdManagerCallback was received
738 // before any calls are received by NsdService, the clientInfo would be
739 // cleared and cause NPE. Add a null check here to prevent this corner case.
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900740 if (clientInfo == null) {
paulhub2225702021-11-17 09:35:33 +0800741 Log.e(TAG, "Unknown connector in unregistration");
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700742 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700743 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900744 final ClientRequest request = clientInfo.mClientRequests.get(clientId);
745 if (request == null) {
746 Log.e(TAG, "Unknown client request in UNREGISTER_SERVICE");
747 break;
748 }
749 id = request.mGlobalId;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900750 removeRequestMap(clientId, id, clientInfo);
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900751
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900752 // Note isMdnsAdvertiserEnabled may have changed to false at this point,
753 // so this needs to check the type of the original request to unregister
754 // instead of looking at the flag value.
755 if (request instanceof AdvertiserClientRequest) {
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900756 mAdvertiser.removeService(id);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900757 clientInfo.onUnregisterServiceSucceeded(clientId);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700758 } else {
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900759 if (unregisterService(id)) {
760 clientInfo.onUnregisterServiceSucceeded(clientId);
761 } else {
762 clientInfo.onUnregisterServiceFailed(
763 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
764 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700765 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700766 break;
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900767 }
Paul Hu75069ed2023-01-14 00:31:09 +0800768 case NsdManager.RESOLVE_SERVICE: {
paulhub2225702021-11-17 09:35:33 +0800769 if (DBG) Log.d(TAG, "Resolve service");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900770 args = (ListenerArgs) msg.obj;
771 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000772 // If the binder death notification for a INsdManagerCallback was received
773 // before any calls are received by NsdService, the clientInfo would be
774 // cleared and cause NPE. Add a null check here to prevent this corner case.
775 if (clientInfo == null) {
776 Log.e(TAG, "Unknown connector in resolution");
777 break;
778 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700779
Paul Hu75069ed2023-01-14 00:31:09 +0800780 final NsdServiceInfo info = args.serviceInfo;
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700781 id = getUniqueId();
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +0900782 final String serviceType = constructServiceType(info.getServiceType());
783 if (mDeps.isMdnsDiscoveryManagerEnabled(mContext)
784 || useDiscoveryManagerForType(serviceType)) {
Paul Hu75069ed2023-01-14 00:31:09 +0800785 if (serviceType == null) {
786 clientInfo.onResolveServiceFailed(clientId,
787 NsdManager.FAILURE_INTERNAL_ERROR);
788 break;
789 }
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900790 final String resolveServiceType = serviceType + ".local";
Paul Hu75069ed2023-01-14 00:31:09 +0800791
792 maybeStartMonitoringSockets();
793 final MdnsListener listener =
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900794 new ResolutionListener(clientId, id, info, resolveServiceType);
Paul Hu75069ed2023-01-14 00:31:09 +0800795 final MdnsSearchOptions options = MdnsSearchOptions.newBuilder()
796 .setNetwork(info.getNetwork())
797 .setIsPassiveMode(true)
Remi NGUYEN VANbb62b1d2023-02-27 12:18:27 +0900798 .setResolveInstanceName(info.getServiceName())
Paul Hu75069ed2023-01-14 00:31:09 +0800799 .build();
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900800 mMdnsDiscoveryManager.registerListener(
801 resolveServiceType, listener, options);
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900802 storeDiscoveryManagerRequestMap(clientId, id, listener, clientInfo);
Irfan Sheriff75006652012-04-17 23:15:29 -0700803 } else {
Paul Hu75069ed2023-01-14 00:31:09 +0800804 if (clientInfo.mResolvedService != null) {
805 clientInfo.onResolveServiceFailed(
806 clientId, NsdManager.FAILURE_ALREADY_ACTIVE);
807 break;
808 }
809
810 maybeStartDaemon();
Remi NGUYEN VANbb62b1d2023-02-27 12:18:27 +0900811 if (resolveService(id, info)) {
Paul Hu75069ed2023-01-14 00:31:09 +0800812 clientInfo.mResolvedService = new NsdServiceInfo();
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900813 storeLegacyRequestMap(clientId, id, clientInfo, msg.what);
Paul Hu75069ed2023-01-14 00:31:09 +0800814 } else {
815 clientInfo.onResolveServiceFailed(
816 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
817 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700818 }
819 break;
Paul Hu75069ed2023-01-14 00:31:09 +0800820 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900821 case NsdManager.STOP_RESOLUTION: {
Paul Hub58deb72022-12-26 09:24:42 +0000822 if (DBG) Log.d(TAG, "Stop service resolution");
823 args = (ListenerArgs) msg.obj;
824 clientInfo = mClients.get(args.connector);
825 // If the binder death notification for a INsdManagerCallback was received
826 // before any calls are received by NsdService, the clientInfo would be
827 // cleared and cause NPE. Add a null check here to prevent this corner case.
828 if (clientInfo == null) {
829 Log.e(TAG, "Unknown connector in stop resolution");
830 break;
831 }
832
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900833 final ClientRequest request = clientInfo.mClientRequests.get(clientId);
834 if (request == null) {
835 Log.e(TAG, "Unknown client request in STOP_RESOLUTION");
836 break;
837 }
838 id = request.mGlobalId;
Paul Hue4f5f252023-02-16 21:13:47 +0800839 // Note isMdnsDiscoveryManagerEnabled may have changed to false at this
840 // point, so this needs to check the type of the original request to
841 // unregister instead of looking at the flag value.
842 if (request instanceof DiscoveryManagerRequest) {
843 stopDiscoveryManagerRequest(request, clientId, id, clientInfo);
Paul Hub58deb72022-12-26 09:24:42 +0000844 clientInfo.onStopResolutionSucceeded(clientId);
845 } else {
Paul Hue4f5f252023-02-16 21:13:47 +0800846 removeRequestMap(clientId, id, clientInfo);
847 if (stopResolveService(id)) {
848 clientInfo.onStopResolutionSucceeded(clientId);
849 } else {
850 clientInfo.onStopResolutionFailed(
851 clientId, NsdManager.FAILURE_OPERATION_NOT_RUNNING);
852 }
853 clientInfo.mResolvedService = null;
Paul Hub58deb72022-12-26 09:24:42 +0000854 }
Paul Hub58deb72022-12-26 09:24:42 +0000855 break;
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900856 }
Paul Hu30bd70d2023-02-07 13:20:56 +0000857 case NsdManager.REGISTER_SERVICE_CALLBACK: {
Paul Hu18aeccc2022-12-27 08:48:48 +0000858 if (DBG) Log.d(TAG, "Register a service callback");
859 args = (ListenerArgs) msg.obj;
860 clientInfo = mClients.get(args.connector);
861 // If the binder death notification for a INsdManagerCallback was received
862 // before any calls are received by NsdService, the clientInfo would be
863 // cleared and cause NPE. Add a null check here to prevent this corner case.
864 if (clientInfo == null) {
865 Log.e(TAG, "Unknown connector in callback registration");
866 break;
867 }
868
Paul Hu30bd70d2023-02-07 13:20:56 +0000869 final NsdServiceInfo info = args.serviceInfo;
870 id = getUniqueId();
871 final String serviceType = constructServiceType(info.getServiceType());
872 if (serviceType == null) {
873 clientInfo.onServiceInfoCallbackRegistrationFailed(clientId,
874 NsdManager.FAILURE_BAD_PARAMETERS);
Paul Hu18aeccc2022-12-27 08:48:48 +0000875 break;
876 }
Paul Hu30bd70d2023-02-07 13:20:56 +0000877 final String resolveServiceType = serviceType + ".local";
Paul Hu18aeccc2022-12-27 08:48:48 +0000878
Paul Hu30bd70d2023-02-07 13:20:56 +0000879 maybeStartMonitoringSockets();
880 final MdnsListener listener =
881 new ServiceInfoListener(clientId, id, info, resolveServiceType);
882 final MdnsSearchOptions options = MdnsSearchOptions.newBuilder()
883 .setNetwork(info.getNetwork())
884 .setIsPassiveMode(true)
885 .setResolveInstanceName(info.getServiceName())
886 .build();
887 mMdnsDiscoveryManager.registerListener(
888 resolveServiceType, listener, options);
889 storeDiscoveryManagerRequestMap(clientId, id, listener, clientInfo);
Paul Hu18aeccc2022-12-27 08:48:48 +0000890 break;
Paul Hu30bd70d2023-02-07 13:20:56 +0000891 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900892 case NsdManager.UNREGISTER_SERVICE_CALLBACK: {
Paul Hu18aeccc2022-12-27 08:48:48 +0000893 if (DBG) Log.d(TAG, "Unregister a service callback");
894 args = (ListenerArgs) msg.obj;
895 clientInfo = mClients.get(args.connector);
896 // If the binder death notification for a INsdManagerCallback was received
897 // before any calls are received by NsdService, the clientInfo would be
898 // cleared and cause NPE. Add a null check here to prevent this corner case.
899 if (clientInfo == null) {
900 Log.e(TAG, "Unknown connector in callback unregistration");
901 break;
902 }
903
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900904 final ClientRequest request = clientInfo.mClientRequests.get(clientId);
905 if (request == null) {
Paul Hu30bd70d2023-02-07 13:20:56 +0000906 Log.e(TAG, "Unknown client request in UNREGISTER_SERVICE_CALLBACK");
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900907 break;
908 }
909 id = request.mGlobalId;
Paul Hu30bd70d2023-02-07 13:20:56 +0000910 if (request instanceof DiscoveryManagerRequest) {
911 stopDiscoveryManagerRequest(request, clientId, id, clientInfo);
Paul Hu18aeccc2022-12-27 08:48:48 +0000912 clientInfo.onServiceInfoCallbackUnregistered(clientId);
913 } else {
Paul Hu30bd70d2023-02-07 13:20:56 +0000914 loge("Unregister failed with non-DiscoveryManagerRequest.");
Paul Hu18aeccc2022-12-27 08:48:48 +0000915 }
Paul Hu18aeccc2022-12-27 08:48:48 +0000916 break;
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900917 }
paulhu2b9ed952022-02-10 21:58:32 +0800918 case MDNS_SERVICE_EVENT:
919 if (!handleMDnsServiceEvent(msg.arg1, msg.arg2, msg.obj)) {
Hugo Benichif0c84092017-04-05 14:43:29 +0900920 return NOT_HANDLED;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700921 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700922 break;
Paul Hu019621e2023-01-13 23:26:49 +0800923 case MDNS_DISCOVERY_MANAGER_EVENT:
924 if (!handleMdnsDiscoveryManagerEvent(msg.arg1, msg.arg2, msg.obj)) {
925 return NOT_HANDLED;
926 }
927 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700928 default:
Hugo Benichif0c84092017-04-05 14:43:29 +0900929 return NOT_HANDLED;
Irfan Sheriff75006652012-04-17 23:15:29 -0700930 }
Hugo Benichif0c84092017-04-05 14:43:29 +0900931 return HANDLED;
Irfan Sheriff75006652012-04-17 23:15:29 -0700932 }
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700933
paulhu2b9ed952022-02-10 21:58:32 +0800934 private boolean handleMDnsServiceEvent(int code, int id, Object obj) {
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700935 NsdServiceInfo servInfo;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700936 ClientInfo clientInfo = mIdToClientInfoMap.get(id);
937 if (clientInfo == null) {
paulhu2b9ed952022-02-10 21:58:32 +0800938 Log.e(TAG, String.format("id %d for %d has no client mapping", id, code));
Hugo Benichif0c84092017-04-05 14:43:29 +0900939 return false;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700940 }
941
942 /* This goes in response as msg.arg2 */
Christopher Lane74411222014-04-25 18:39:07 -0700943 int clientId = clientInfo.getClientId(id);
944 if (clientId < 0) {
Vinit Deshapnde930a8512013-06-25 19:45:03 -0700945 // This can happen because of race conditions. For example,
946 // SERVICE_FOUND may race with STOP_SERVICE_DISCOVERY,
947 // and we may get in this situation.
paulhu2b9ed952022-02-10 21:58:32 +0800948 Log.d(TAG, String.format("%d for listener id %d that is no longer active",
949 code, id));
Hugo Benichif0c84092017-04-05 14:43:29 +0900950 return false;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700951 }
Hugo Benichi32be63d2017-04-05 14:06:11 +0900952 if (DBG) {
paulhu2b9ed952022-02-10 21:58:32 +0800953 Log.d(TAG, String.format("MDns service event code:%d id=%d", code, id));
Hugo Benichi32be63d2017-04-05 14:06:11 +0900954 }
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700955 switch (code) {
paulhu2b9ed952022-02-10 21:58:32 +0800956 case IMDnsEventListener.SERVICE_FOUND: {
957 final DiscoveryInfo info = (DiscoveryInfo) obj;
958 final String name = info.serviceName;
959 final String type = info.registrationType;
960 servInfo = new NsdServiceInfo(name, type);
961 final int foundNetId = info.netId;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +0900962 if (foundNetId == 0L) {
963 // Ignore services that do not have a Network: they are not usable
964 // by apps, as they would need privileged permissions to use
965 // interfaces that do not have an associated Network.
966 break;
967 }
Remi NGUYEN VAN643edb62023-01-23 19:14:57 +0900968 if (foundNetId == INetd.DUMMY_NET_ID) {
969 // Ignore services on the dummy0 interface: they are only seen when
970 // discovering locally advertised services, and are not reachable
971 // through that interface.
972 break;
973 }
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +0900974 setServiceNetworkForCallback(servInfo, info.netId, info.interfaceIdx);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900975 clientInfo.onServiceFound(clientId, servInfo);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700976 break;
paulhu2b9ed952022-02-10 21:58:32 +0800977 }
978 case IMDnsEventListener.SERVICE_LOST: {
979 final DiscoveryInfo info = (DiscoveryInfo) obj;
980 final String name = info.serviceName;
981 final String type = info.registrationType;
982 final int lostNetId = info.netId;
983 servInfo = new NsdServiceInfo(name, type);
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +0900984 // The network could be set to null (netId 0) if it was torn down when the
985 // service is lost
986 // TODO: avoid returning null in that case, possibly by remembering
987 // found services on the same interface index and their network at the time
988 setServiceNetworkForCallback(servInfo, lostNetId, info.interfaceIdx);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900989 clientInfo.onServiceLost(clientId, servInfo);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700990 break;
paulhu2b9ed952022-02-10 21:58:32 +0800991 }
992 case IMDnsEventListener.SERVICE_DISCOVERY_FAILED:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900993 clientInfo.onDiscoverServicesFailed(
994 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700995 break;
paulhu2b9ed952022-02-10 21:58:32 +0800996 case IMDnsEventListener.SERVICE_REGISTERED: {
997 final RegistrationInfo info = (RegistrationInfo) obj;
998 final String name = info.serviceName;
999 servInfo = new NsdServiceInfo(name, null /* serviceType */);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001000 clientInfo.onRegisterServiceSucceeded(clientId, servInfo);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001001 break;
paulhu2b9ed952022-02-10 21:58:32 +08001002 }
1003 case IMDnsEventListener.SERVICE_REGISTRATION_FAILED:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001004 clientInfo.onRegisterServiceFailed(
1005 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001006 break;
paulhu2b9ed952022-02-10 21:58:32 +08001007 case IMDnsEventListener.SERVICE_RESOLVED: {
1008 final ResolutionInfo info = (ResolutionInfo) obj;
Sreeram Ramachandrana53dd7f2014-09-03 15:45:59 -07001009 int index = 0;
paulhu2b9ed952022-02-10 21:58:32 +08001010 final String fullName = info.serviceFullName;
1011 while (index < fullName.length() && fullName.charAt(index) != '.') {
1012 if (fullName.charAt(index) == '\\') {
Sreeram Ramachandrana53dd7f2014-09-03 15:45:59 -07001013 ++index;
1014 }
1015 ++index;
1016 }
paulhu2b9ed952022-02-10 21:58:32 +08001017 if (index >= fullName.length()) {
1018 Log.e(TAG, "Invalid service found " + fullName);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001019 break;
1020 }
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001021
paulhube186602022-04-12 07:18:23 +00001022 String name = unescape(fullName.substring(0, index));
paulhu2b9ed952022-02-10 21:58:32 +08001023 String rest = fullName.substring(index);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001024 String type = rest.replace(".local.", "");
1025
Paul Hu30bd70d2023-02-07 13:20:56 +00001026 final NsdServiceInfo serviceInfo = clientInfo.mResolvedService;
Paul Hu18aeccc2022-12-27 08:48:48 +00001027 serviceInfo.setServiceName(name);
1028 serviceInfo.setServiceType(type);
1029 serviceInfo.setPort(info.port);
1030 serviceInfo.setTxtRecords(info.txtRecord);
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001031 // Network will be added after SERVICE_GET_ADDR_SUCCESS
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001032
1033 stopResolveService(id);
Vinit Deshapnde4429e872013-11-12 15:36:37 -08001034 removeRequestMap(clientId, id, clientInfo);
1035
paulhu2b9ed952022-02-10 21:58:32 +08001036 final int id2 = getUniqueId();
1037 if (getAddrInfo(id2, info.hostname, info.interfaceIdx)) {
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001038 storeLegacyRequestMap(clientId, id2, clientInfo,
1039 NsdManager.RESOLVE_SERVICE);
Vinit Deshapnde4429e872013-11-12 15:36:37 -08001040 } else {
Paul Hu30bd70d2023-02-07 13:20:56 +00001041 clientInfo.onResolveServiceFailed(
1042 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
1043 clientInfo.mResolvedService = null;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001044 }
1045 break;
paulhu2b9ed952022-02-10 21:58:32 +08001046 }
1047 case IMDnsEventListener.SERVICE_RESOLUTION_FAILED:
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001048 /* NNN resolveId errorCode */
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001049 stopResolveService(id);
1050 removeRequestMap(clientId, id, clientInfo);
Paul Hu30bd70d2023-02-07 13:20:56 +00001051 clientInfo.onResolveServiceFailed(
1052 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
1053 clientInfo.mResolvedService = null;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001054 break;
paulhu2b9ed952022-02-10 21:58:32 +08001055 case IMDnsEventListener.SERVICE_GET_ADDR_FAILED:
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001056 /* NNN resolveId errorCode */
1057 stopGetAddrInfo(id);
1058 removeRequestMap(clientId, id, clientInfo);
Paul Hu30bd70d2023-02-07 13:20:56 +00001059 clientInfo.onResolveServiceFailed(
1060 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
1061 clientInfo.mResolvedService = null;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001062 break;
paulhu2b9ed952022-02-10 21:58:32 +08001063 case IMDnsEventListener.SERVICE_GET_ADDR_SUCCESS: {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001064 /* NNN resolveId hostname ttl addr interfaceIdx netId */
paulhu2b9ed952022-02-10 21:58:32 +08001065 final GetAddressInfo info = (GetAddressInfo) obj;
1066 final String address = info.address;
1067 final int netId = info.netId;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001068 InetAddress serviceHost = null;
1069 try {
paulhu2b9ed952022-02-10 21:58:32 +08001070 serviceHost = InetAddress.getByName(address);
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001071 } catch (UnknownHostException e) {
1072 Log.wtf(TAG, "Invalid host in GET_ADDR_SUCCESS", e);
1073 }
1074
1075 // If the resolved service is on an interface without a network, consider it
1076 // as a failure: it would not be usable by apps as they would need
1077 // privileged permissions.
Paul Hu30bd70d2023-02-07 13:20:56 +00001078 if (netId != NETID_UNSET && serviceHost != null) {
1079 clientInfo.mResolvedService.setHost(serviceHost);
1080 setServiceNetworkForCallback(clientInfo.mResolvedService,
1081 netId, info.interfaceIdx);
1082 clientInfo.onResolveServiceSucceeded(
1083 clientId, clientInfo.mResolvedService);
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001084 } else {
Paul Hu30bd70d2023-02-07 13:20:56 +00001085 clientInfo.onResolveServiceFailed(
1086 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001087 }
Paul Hu30bd70d2023-02-07 13:20:56 +00001088 stopGetAddrInfo(id);
1089 removeRequestMap(clientId, id, clientInfo);
1090 clientInfo.mResolvedService = null;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001091 break;
paulhu2b9ed952022-02-10 21:58:32 +08001092 }
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001093 default:
Hugo Benichif0c84092017-04-05 14:43:29 +09001094 return false;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001095 }
Hugo Benichif0c84092017-04-05 14:43:29 +09001096 return true;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001097 }
Paul Hu019621e2023-01-13 23:26:49 +08001098
1099 private NsdServiceInfo buildNsdServiceInfoFromMdnsEvent(final MdnsEvent event) {
1100 final MdnsServiceInfo serviceInfo = event.mMdnsServiceInfo;
1101 final String serviceType = event.mRequestedServiceType;
1102 final String serviceName = serviceInfo.getServiceInstanceName();
1103 final NsdServiceInfo servInfo = new NsdServiceInfo(serviceName, serviceType);
1104 final Network network = serviceInfo.getNetwork();
1105 setServiceNetworkForCallback(
1106 servInfo,
1107 network == null ? NETID_UNSET : network.netId,
1108 serviceInfo.getInterfaceIndex());
1109 return servInfo;
1110 }
1111
1112 private boolean handleMdnsDiscoveryManagerEvent(
1113 int transactionId, int code, Object obj) {
1114 final ClientInfo clientInfo = mIdToClientInfoMap.get(transactionId);
1115 if (clientInfo == null) {
1116 Log.e(TAG, String.format(
1117 "id %d for %d has no client mapping", transactionId, code));
1118 return false;
1119 }
1120
1121 final MdnsEvent event = (MdnsEvent) obj;
1122 final int clientId = event.mClientId;
Paul Hu319751a2023-01-13 23:56:34 +08001123 final NsdServiceInfo info = buildNsdServiceInfoFromMdnsEvent(event);
Paul Hu019621e2023-01-13 23:26:49 +08001124 if (DBG) {
1125 Log.d(TAG, String.format("MdnsDiscoveryManager event code=%s transactionId=%d",
1126 NsdManager.nameOf(code), transactionId));
1127 }
1128 switch (code) {
1129 case NsdManager.SERVICE_FOUND:
Paul Hu319751a2023-01-13 23:56:34 +08001130 clientInfo.onServiceFound(clientId, info);
1131 break;
1132 case NsdManager.SERVICE_LOST:
1133 clientInfo.onServiceLost(clientId, info);
Paul Hu019621e2023-01-13 23:26:49 +08001134 break;
Paul Hu75069ed2023-01-14 00:31:09 +08001135 case NsdManager.RESOLVE_SERVICE_SUCCEEDED: {
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001136 final ClientRequest request = clientInfo.mClientRequests.get(clientId);
1137 if (request == null) {
1138 Log.e(TAG, "Unknown client request in RESOLVE_SERVICE_SUCCEEDED");
1139 break;
1140 }
Paul Hu75069ed2023-01-14 00:31:09 +08001141 final MdnsServiceInfo serviceInfo = event.mMdnsServiceInfo;
1142 // Add '.' in front of the service type that aligns with historical behavior
1143 info.setServiceType("." + event.mRequestedServiceType);
1144 info.setPort(serviceInfo.getPort());
1145
1146 Map<String, String> attrs = serviceInfo.getAttributes();
1147 for (Map.Entry<String, String> kv : attrs.entrySet()) {
1148 final String key = kv.getKey();
1149 try {
1150 info.setAttribute(key, serviceInfo.getAttributeAsBytes(key));
1151 } catch (IllegalArgumentException e) {
1152 Log.e(TAG, "Invalid attribute", e);
1153 }
1154 }
1155 try {
1156 if (serviceInfo.getIpv4Address() != null) {
1157 info.setHost(InetAddresses.parseNumericAddress(
1158 serviceInfo.getIpv4Address()));
1159 } else {
1160 info.setHost(InetAddresses.parseNumericAddress(
1161 serviceInfo.getIpv6Address()));
1162 }
1163 clientInfo.onResolveServiceSucceeded(clientId, info);
1164 } catch (IllegalArgumentException e) {
1165 Log.wtf(TAG, "Invalid address in RESOLVE_SERVICE_SUCCEEDED", e);
1166 clientInfo.onResolveServiceFailed(
1167 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
1168 }
1169
1170 // Unregister the listener immediately like IMDnsEventListener design
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001171 if (!(request instanceof DiscoveryManagerRequest)) {
1172 Log.wtf(TAG, "non-DiscoveryManager request in DiscoveryManager event");
1173 break;
1174 }
Paul Hue4f5f252023-02-16 21:13:47 +08001175 stopDiscoveryManagerRequest(request, clientId, transactionId, clientInfo);
Paul Hu75069ed2023-01-14 00:31:09 +08001176 break;
1177 }
Paul Hu30bd70d2023-02-07 13:20:56 +00001178 case NsdManager.SERVICE_UPDATED: {
1179 final MdnsServiceInfo serviceInfo = event.mMdnsServiceInfo;
1180 info.setPort(serviceInfo.getPort());
1181
1182 Map<String, String> attrs = serviceInfo.getAttributes();
1183 for (Map.Entry<String, String> kv : attrs.entrySet()) {
1184 final String key = kv.getKey();
1185 try {
1186 info.setAttribute(key, serviceInfo.getAttributeAsBytes(key));
1187 } catch (IllegalArgumentException e) {
1188 Log.e(TAG, "Invalid attribute", e);
1189 }
1190 }
1191
1192 final List<InetAddress> addresses = new ArrayList<>();
1193 for (String ipv4Address : serviceInfo.getIpv4Addresses()) {
1194 try {
1195 addresses.add(InetAddresses.parseNumericAddress(ipv4Address));
1196 } catch (IllegalArgumentException e) {
1197 Log.wtf(TAG, "Invalid ipv4 address", e);
1198 }
1199 }
1200 for (String ipv6Address : serviceInfo.getIpv6Addresses()) {
1201 try {
1202 addresses.add(InetAddresses.parseNumericAddress(ipv6Address));
1203 } catch (IllegalArgumentException e) {
1204 Log.wtf(TAG, "Invalid ipv6 address", e);
1205 }
1206 }
1207 info.setHostAddresses(addresses);
1208 clientInfo.onServiceUpdated(clientId, info);
1209 break;
1210 }
1211 case NsdManager.SERVICE_UPDATED_LOST:
1212 clientInfo.onServiceUpdatedLost(clientId);
1213 break;
Paul Hu019621e2023-01-13 23:26:49 +08001214 default:
1215 return false;
1216 }
1217 return true;
1218 }
Irfan Sheriff75006652012-04-17 23:15:29 -07001219 }
1220 }
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001221
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001222 private static void setServiceNetworkForCallback(NsdServiceInfo info, int netId, int ifaceIdx) {
1223 switch (netId) {
1224 case NETID_UNSET:
1225 info.setNetwork(null);
1226 break;
1227 case INetd.LOCAL_NET_ID:
1228 // Special case for LOCAL_NET_ID: Networks on netId 99 are not generally
1229 // visible / usable for apps, so do not return it. Store the interface
1230 // index instead, so at least if the client tries to resolve the service
1231 // with that NsdServiceInfo, it will be done on the same interface.
1232 // If they recreate the NsdServiceInfo themselves, resolution would be
1233 // done on all interfaces as before T, which should also work.
1234 info.setNetwork(null);
1235 info.setInterfaceIndex(ifaceIdx);
1236 break;
1237 default:
1238 info.setNetwork(new Network(netId));
1239 }
1240 }
1241
paulhube186602022-04-12 07:18:23 +00001242 // The full service name is escaped from standard DNS rules on mdnsresponder, making it suitable
1243 // for passing to standard system DNS APIs such as res_query() . Thus, make the service name
1244 // unescape for getting right service address. See "Notes on DNS Name Escaping" on
1245 // external/mdnsresponder/mDNSShared/dns_sd.h for more details.
1246 private String unescape(String s) {
1247 StringBuilder sb = new StringBuilder(s.length());
1248 for (int i = 0; i < s.length(); ++i) {
1249 char c = s.charAt(i);
1250 if (c == '\\') {
1251 if (++i >= s.length()) {
1252 Log.e(TAG, "Unexpected end of escape sequence in: " + s);
1253 break;
1254 }
1255 c = s.charAt(i);
1256 if (c != '.' && c != '\\') {
1257 if (i + 2 >= s.length()) {
1258 Log.e(TAG, "Unexpected end of escape sequence in: " + s);
1259 break;
1260 }
1261 c = (char) ((c - '0') * 100 + (s.charAt(i + 1) - '0') * 10
1262 + (s.charAt(i + 2) - '0'));
1263 i += 2;
1264 }
1265 }
1266 sb.append(c);
1267 }
1268 return sb.toString();
1269 }
1270
Paul Hu7445e3d2023-03-03 15:14:00 +08001271 /**
1272 * Check the given service type is valid and construct it to a service type
1273 * which can use for discovery / resolution service.
1274 *
1275 * <p> The valid service type should be 2 labels, or 3 labels if the query is for a
1276 * subtype (see RFC6763 7.1). Each label is up to 63 characters and must start with an
1277 * underscore; they are alphanumerical characters or dashes or underscore, except the
1278 * last one that is just alphanumerical. The last label must be _tcp or _udp.
1279 *
1280 * @param serviceType the request service type for discovery / resolution service
1281 * @return constructed service type or null if the given service type is invalid.
1282 */
1283 @Nullable
1284 public static String constructServiceType(String serviceType) {
1285 if (TextUtils.isEmpty(serviceType)) return null;
1286
1287 final Pattern serviceTypePattern = Pattern.compile(
1288 "^(_[a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]\\.)?"
1289 + "(_[a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]\\._(?:tcp|udp))"
1290 // Drop '.' at the end of service type that is compatible with old backend.
1291 + "\\.?$");
1292 final Matcher matcher = serviceTypePattern.matcher(serviceType);
1293 if (!matcher.matches()) return null;
1294 return matcher.group(1) == null
1295 ? matcher.group(2)
1296 : matcher.group(1) + "_sub." + matcher.group(2);
1297 }
1298
Hugo Benichi803a2f02017-04-24 11:35:06 +09001299 @VisibleForTesting
paulhu2b9ed952022-02-10 21:58:32 +08001300 NsdService(Context ctx, Handler handler, long cleanupDelayMs) {
Paul Hu4bd98ef2023-01-12 13:42:07 +08001301 this(ctx, handler, cleanupDelayMs, new Dependencies());
1302 }
1303
1304 @VisibleForTesting
1305 NsdService(Context ctx, Handler handler, long cleanupDelayMs, Dependencies deps) {
Luke Huang05298582021-06-13 16:52:05 +00001306 mCleanupDelayMs = cleanupDelayMs;
Hugo Benichi803a2f02017-04-24 11:35:06 +09001307 mContext = ctx;
Hugo Benichi803a2f02017-04-24 11:35:06 +09001308 mNsdStateMachine = new NsdStateMachine(TAG, handler);
Irfan Sheriff75006652012-04-17 23:15:29 -07001309 mNsdStateMachine.start();
paulhu2b9ed952022-02-10 21:58:32 +08001310 mMDnsManager = ctx.getSystemService(MDnsManager.class);
1311 mMDnsEventCallback = new MDnsEventCallback(mNsdStateMachine);
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +09001312 mDeps = deps;
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001313
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +09001314 mMdnsSocketProvider = deps.makeMdnsSocketProvider(ctx, handler.getLooper());
1315 mMdnsSocketClient =
1316 new MdnsMultinetworkSocketClient(handler.getLooper(), mMdnsSocketProvider);
1317 mMdnsDiscoveryManager =
1318 deps.makeMdnsDiscoveryManager(new ExecutorProvider(), mMdnsSocketClient);
1319 handler.post(() -> mMdnsSocketClient.setCallback(mMdnsDiscoveryManager));
1320 mAdvertiser = deps.makeMdnsAdvertiser(handler.getLooper(), mMdnsSocketProvider,
1321 new AdvertiserCallback());
Paul Hu4bd98ef2023-01-12 13:42:07 +08001322 }
1323
1324 /**
1325 * Dependencies of NsdService, for injection in tests.
1326 */
1327 @VisibleForTesting
1328 public static class Dependencies {
1329 /**
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001330 * Check whether the MdnsDiscoveryManager feature is enabled.
Paul Hu4bd98ef2023-01-12 13:42:07 +08001331 *
1332 * @param context The global context information about an app environment.
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001333 * @return true if the MdnsDiscoveryManager feature is enabled.
Paul Hu4bd98ef2023-01-12 13:42:07 +08001334 */
1335 public boolean isMdnsDiscoveryManagerEnabled(Context context) {
1336 return DeviceConfigUtils.isFeatureEnabled(context, NAMESPACE_CONNECTIVITY,
1337 MDNS_DISCOVERY_MANAGER_VERSION, false /* defaultEnabled */);
1338 }
1339
1340 /**
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001341 * Check whether the MdnsAdvertiser feature is enabled.
1342 *
1343 * @param context The global context information about an app environment.
1344 * @return true if the MdnsAdvertiser feature is enabled.
1345 */
1346 public boolean isMdnsAdvertiserEnabled(Context context) {
1347 return DeviceConfigUtils.isFeatureEnabled(context, NAMESPACE_CONNECTIVITY,
1348 MDNS_ADVERTISER_VERSION, false /* defaultEnabled */);
1349 }
1350
1351 /**
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +09001352 * Get the type allowlist flag value.
1353 * @see #MDNS_TYPE_ALLOWLIST_FLAGS
1354 */
1355 @Nullable
1356 public String getTypeAllowlistFlags() {
1357 return DeviceConfigUtils.getDeviceConfigProperty(NAMESPACE_TETHERING,
1358 MDNS_TYPE_ALLOWLIST_FLAGS, null);
1359 }
1360
1361 /**
1362 * @see DeviceConfigUtils#isFeatureEnabled(Context, String, String, String, boolean)
1363 */
1364 public boolean isFeatureEnabled(Context context, String feature) {
1365 return DeviceConfigUtils.isFeatureEnabled(context, NAMESPACE_TETHERING,
1366 feature, DeviceConfigUtils.TETHERING_MODULE_NAME, false /* defaultEnabled */);
1367 }
1368
1369 /**
Paul Hu4bd98ef2023-01-12 13:42:07 +08001370 * @see MdnsDiscoveryManager
1371 */
1372 public MdnsDiscoveryManager makeMdnsDiscoveryManager(
1373 ExecutorProvider executorProvider, MdnsSocketClientBase socketClient) {
1374 return new MdnsDiscoveryManager(executorProvider, socketClient);
1375 }
1376
1377 /**
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001378 * @see MdnsAdvertiser
1379 */
1380 public MdnsAdvertiser makeMdnsAdvertiser(
1381 @NonNull Looper looper, @NonNull MdnsSocketProvider socketProvider,
1382 @NonNull MdnsAdvertiser.AdvertiserCallback cb) {
1383 return new MdnsAdvertiser(looper, socketProvider, cb);
1384 }
1385
1386 /**
Paul Hu4bd98ef2023-01-12 13:42:07 +08001387 * @see MdnsSocketProvider
1388 */
1389 public MdnsSocketProvider makeMdnsSocketProvider(Context context, Looper looper) {
1390 return new MdnsSocketProvider(context, looper);
1391 }
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001392 }
1393
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +09001394 /**
1395 * Return whether a type is allowlisted to use the Java backend.
1396 * @param type The service type
1397 * @param flagPrefix One of {@link #MDNS_ADVERTISER_ALLOWLIST_FLAG_PREFIX} or
1398 * {@link #MDNS_DISCOVERY_MANAGER_ALLOWLIST_FLAG_PREFIX}.
1399 */
1400 private boolean isTypeAllowlistedForJavaBackend(@Nullable String type,
1401 @NonNull String flagPrefix) {
1402 if (type == null) return false;
1403 final String typesConfig = mDeps.getTypeAllowlistFlags();
1404 if (TextUtils.isEmpty(typesConfig)) return false;
1405
1406 final String mappingPrefix = type + ":";
1407 String mappedFlag = null;
1408 for (String mapping : TextUtils.split(typesConfig, ",")) {
1409 if (mapping.startsWith(mappingPrefix)) {
1410 mappedFlag = mapping.substring(mappingPrefix.length());
1411 break;
1412 }
1413 }
1414
1415 if (mappedFlag == null) return false;
1416
1417 return mDeps.isFeatureEnabled(mContext,
1418 flagPrefix + mappedFlag + MDNS_ALLOWLIST_FLAG_SUFFIX);
1419 }
1420
1421 private boolean useDiscoveryManagerForType(@Nullable String type) {
1422 return isTypeAllowlistedForJavaBackend(type, MDNS_DISCOVERY_MANAGER_ALLOWLIST_FLAG_PREFIX);
1423 }
1424
1425 private boolean useAdvertiserForType(@Nullable String type) {
1426 return isTypeAllowlistedForJavaBackend(type, MDNS_ADVERTISER_ALLOWLIST_FLAG_PREFIX);
1427 }
1428
paulhu1b35e822022-04-08 14:48:41 +08001429 public static NsdService create(Context context) {
Hugo Benichi803a2f02017-04-24 11:35:06 +09001430 HandlerThread thread = new HandlerThread(TAG);
1431 thread.start();
1432 Handler handler = new Handler(thread.getLooper());
paulhu2b9ed952022-02-10 21:58:32 +08001433 NsdService service = new NsdService(context, handler, CLEANUP_DELAY_MS);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001434 return service;
1435 }
1436
paulhu2b9ed952022-02-10 21:58:32 +08001437 private static class MDnsEventCallback extends IMDnsEventListener.Stub {
1438 private final StateMachine mStateMachine;
1439
1440 MDnsEventCallback(StateMachine sm) {
1441 mStateMachine = sm;
1442 }
1443
1444 @Override
1445 public void onServiceRegistrationStatus(final RegistrationInfo status) {
1446 mStateMachine.sendMessage(
1447 MDNS_SERVICE_EVENT, status.result, status.id, status);
1448 }
1449
1450 @Override
1451 public void onServiceDiscoveryStatus(final DiscoveryInfo status) {
1452 mStateMachine.sendMessage(
1453 MDNS_SERVICE_EVENT, status.result, status.id, status);
1454 }
1455
1456 @Override
1457 public void onServiceResolutionStatus(final ResolutionInfo status) {
1458 mStateMachine.sendMessage(
1459 MDNS_SERVICE_EVENT, status.result, status.id, status);
1460 }
1461
1462 @Override
1463 public void onGettingServiceAddressStatus(final GetAddressInfo status) {
1464 mStateMachine.sendMessage(
1465 MDNS_SERVICE_EVENT, status.result, status.id, status);
1466 }
1467
1468 @Override
1469 public int getInterfaceVersion() throws RemoteException {
1470 return this.VERSION;
1471 }
1472
1473 @Override
1474 public String getInterfaceHash() throws RemoteException {
1475 return this.HASH;
1476 }
1477 }
1478
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001479 private class AdvertiserCallback implements MdnsAdvertiser.AdvertiserCallback {
1480 @Override
1481 public void onRegisterServiceSucceeded(int serviceId, NsdServiceInfo registeredInfo) {
1482 final ClientInfo clientInfo = getClientInfoOrLog(serviceId);
1483 if (clientInfo == null) return;
1484
1485 final int clientId = getClientIdOrLog(clientInfo, serviceId);
1486 if (clientId < 0) return;
1487
1488 // onRegisterServiceSucceeded only has the service name in its info. This aligns with
1489 // historical behavior.
1490 final NsdServiceInfo cbInfo = new NsdServiceInfo(registeredInfo.getServiceName(), null);
1491 clientInfo.onRegisterServiceSucceeded(clientId, cbInfo);
1492 }
1493
1494 @Override
1495 public void onRegisterServiceFailed(int serviceId, int errorCode) {
1496 final ClientInfo clientInfo = getClientInfoOrLog(serviceId);
1497 if (clientInfo == null) return;
1498
1499 final int clientId = getClientIdOrLog(clientInfo, serviceId);
1500 if (clientId < 0) return;
1501
1502 clientInfo.onRegisterServiceFailed(clientId, errorCode);
1503 }
1504
1505 private ClientInfo getClientInfoOrLog(int serviceId) {
1506 final ClientInfo clientInfo = mIdToClientInfoMap.get(serviceId);
1507 if (clientInfo == null) {
1508 Log.e(TAG, String.format("Callback for service %d has no client", serviceId));
1509 }
1510 return clientInfo;
1511 }
1512
1513 private int getClientIdOrLog(@NonNull ClientInfo info, int serviceId) {
1514 final int clientId = info.getClientId(serviceId);
1515 if (clientId < 0) {
1516 Log.e(TAG, String.format("Client ID not found for service %d", serviceId));
1517 }
1518 return clientId;
1519 }
1520 }
1521
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001522 @Override
1523 public INsdServiceConnector connect(INsdManagerCallback cb) {
Hugo Benichi803a2f02017-04-24 11:35:06 +09001524 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.INTERNET, "NsdService");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001525 final INsdServiceConnector connector = new NsdServiceConnector();
1526 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1527 NsdManager.REGISTER_CLIENT, new Pair<>(connector, cb)));
1528 return connector;
Irfan Sheriff75006652012-04-17 23:15:29 -07001529 }
1530
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001531 private static class ListenerArgs {
1532 public final NsdServiceConnector connector;
1533 public final NsdServiceInfo serviceInfo;
1534 ListenerArgs(NsdServiceConnector connector, NsdServiceInfo serviceInfo) {
1535 this.connector = connector;
1536 this.serviceInfo = serviceInfo;
1537 }
1538 }
1539
1540 private class NsdServiceConnector extends INsdServiceConnector.Stub
1541 implements IBinder.DeathRecipient {
1542 @Override
1543 public void registerService(int listenerKey, NsdServiceInfo serviceInfo) {
1544 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1545 NsdManager.REGISTER_SERVICE, 0, listenerKey,
1546 new ListenerArgs(this, serviceInfo)));
1547 }
1548
1549 @Override
1550 public void unregisterService(int listenerKey) {
1551 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1552 NsdManager.UNREGISTER_SERVICE, 0, listenerKey,
1553 new ListenerArgs(this, null)));
1554 }
1555
1556 @Override
1557 public void discoverServices(int listenerKey, NsdServiceInfo serviceInfo) {
1558 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1559 NsdManager.DISCOVER_SERVICES, 0, listenerKey,
1560 new ListenerArgs(this, serviceInfo)));
1561 }
1562
1563 @Override
1564 public void stopDiscovery(int listenerKey) {
1565 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1566 NsdManager.STOP_DISCOVERY, 0, listenerKey, new ListenerArgs(this, null)));
1567 }
1568
1569 @Override
1570 public void resolveService(int listenerKey, NsdServiceInfo serviceInfo) {
1571 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1572 NsdManager.RESOLVE_SERVICE, 0, listenerKey,
1573 new ListenerArgs(this, serviceInfo)));
1574 }
1575
1576 @Override
Paul Hub58deb72022-12-26 09:24:42 +00001577 public void stopResolution(int listenerKey) {
1578 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1579 NsdManager.STOP_RESOLUTION, 0, listenerKey, new ListenerArgs(this, null)));
1580 }
1581
1582 @Override
Paul Hu18aeccc2022-12-27 08:48:48 +00001583 public void registerServiceInfoCallback(int listenerKey, NsdServiceInfo serviceInfo) {
1584 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1585 NsdManager.REGISTER_SERVICE_CALLBACK, 0, listenerKey,
1586 new ListenerArgs(this, serviceInfo)));
1587 }
1588
1589 @Override
1590 public void unregisterServiceInfoCallback(int listenerKey) {
1591 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1592 NsdManager.UNREGISTER_SERVICE_CALLBACK, 0, listenerKey,
1593 new ListenerArgs(this, null)));
1594 }
1595
1596 @Override
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001597 public void startDaemon() {
1598 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1599 NsdManager.DAEMON_STARTUP, new ListenerArgs(this, null)));
1600 }
1601
1602 @Override
1603 public void binderDied() {
1604 mNsdStateMachine.sendMessage(
1605 mNsdStateMachine.obtainMessage(NsdManager.UNREGISTER_CLIENT, this));
1606 }
Irfan Sheriff75006652012-04-17 23:15:29 -07001607 }
1608
Hugo Benichi912db992017-04-24 16:41:03 +09001609 private void sendNsdStateChangeBroadcast(boolean isEnabled) {
Irfan Sheriff52fc83a2012-04-19 10:26:34 -07001610 final Intent intent = new Intent(NsdManager.ACTION_NSD_STATE_CHANGED);
Irfan Sheriff75006652012-04-17 23:15:29 -07001611 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT);
Hugo Benichi912db992017-04-24 16:41:03 +09001612 int nsdState = isEnabled ? NsdManager.NSD_STATE_ENABLED : NsdManager.NSD_STATE_DISABLED;
1613 intent.putExtra(NsdManager.EXTRA_NSD_STATE, nsdState);
Dianne Hackborn692107e2012-08-29 18:32:08 -07001614 mContext.sendStickyBroadcastAsUser(intent, UserHandle.ALL);
Irfan Sheriff75006652012-04-17 23:15:29 -07001615 }
1616
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001617 private int getUniqueId() {
1618 if (++mUniqueId == INVALID_ID) return ++mUniqueId;
1619 return mUniqueId;
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001620 }
1621
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001622 private boolean registerService(int regId, NsdServiceInfo service) {
Hugo Benichi6d706442017-04-24 16:19:58 +09001623 if (DBG) {
paulhub2225702021-11-17 09:35:33 +08001624 Log.d(TAG, "registerService: " + regId + " " + service);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001625 }
Hugo Benichi6d706442017-04-24 16:19:58 +09001626 String name = service.getServiceName();
1627 String type = service.getServiceType();
1628 int port = service.getPort();
1629 byte[] textRecord = service.getTxtRecord();
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001630 final int registerInterface = getNetworkInterfaceIndex(service);
1631 if (service.getNetwork() != null && registerInterface == IFACE_IDX_ANY) {
Paul Hu360a8e92022-04-26 11:14:14 +08001632 Log.e(TAG, "Interface to register service on not found");
1633 return false;
1634 }
1635 return mMDnsManager.registerService(regId, name, type, port, textRecord, registerInterface);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001636 }
1637
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001638 private boolean unregisterService(int regId) {
paulhu2b9ed952022-02-10 21:58:32 +08001639 return mMDnsManager.stopOperation(regId);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001640 }
1641
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001642 private boolean discoverServices(int discoveryId, NsdServiceInfo serviceInfo) {
paulhu2b9ed952022-02-10 21:58:32 +08001643 final String type = serviceInfo.getServiceType();
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001644 final int discoverInterface = getNetworkInterfaceIndex(serviceInfo);
1645 if (serviceInfo.getNetwork() != null && discoverInterface == IFACE_IDX_ANY) {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001646 Log.e(TAG, "Interface to discover service on not found");
1647 return false;
1648 }
paulhu2b9ed952022-02-10 21:58:32 +08001649 return mMDnsManager.discover(discoveryId, type, discoverInterface);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001650 }
1651
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001652 private boolean stopServiceDiscovery(int discoveryId) {
paulhu2b9ed952022-02-10 21:58:32 +08001653 return mMDnsManager.stopOperation(discoveryId);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001654 }
1655
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001656 private boolean resolveService(int resolveId, NsdServiceInfo service) {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001657 final String name = service.getServiceName();
1658 final String type = service.getServiceType();
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001659 final int resolveInterface = getNetworkInterfaceIndex(service);
1660 if (service.getNetwork() != null && resolveInterface == IFACE_IDX_ANY) {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001661 Log.e(TAG, "Interface to resolve service on not found");
1662 return false;
1663 }
paulhu2b9ed952022-02-10 21:58:32 +08001664 return mMDnsManager.resolve(resolveId, name, type, "local.", resolveInterface);
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001665 }
1666
1667 /**
1668 * Guess the interface to use to resolve or discover a service on a specific network.
1669 *
1670 * This is an imperfect guess, as for example the network may be gone or not yet fully
1671 * registered. This is fine as failing is correct if the network is gone, and a client
1672 * attempting to resolve/discover on a network not yet setup would have a bad time anyway; also
1673 * this is to support the legacy mdnsresponder implementation, which historically resolved
1674 * services on an unspecified network.
1675 */
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001676 private int getNetworkInterfaceIndex(NsdServiceInfo serviceInfo) {
1677 final Network network = serviceInfo.getNetwork();
1678 if (network == null) {
1679 // Fallback to getInterfaceIndex if present (typically if the NsdServiceInfo was
1680 // provided by NsdService from discovery results, and the service was found on an
1681 // interface that has no app-usable Network).
1682 if (serviceInfo.getInterfaceIndex() != 0) {
1683 return serviceInfo.getInterfaceIndex();
1684 }
1685 return IFACE_IDX_ANY;
1686 }
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001687
1688 final ConnectivityManager cm = mContext.getSystemService(ConnectivityManager.class);
1689 if (cm == null) {
1690 Log.wtf(TAG, "No ConnectivityManager for resolveService");
1691 return IFACE_IDX_ANY;
1692 }
1693 final LinkProperties lp = cm.getLinkProperties(network);
1694 if (lp == null) return IFACE_IDX_ANY;
1695
1696 // Only resolve on non-stacked interfaces
1697 final NetworkInterface iface;
1698 try {
1699 iface = NetworkInterface.getByName(lp.getInterfaceName());
1700 } catch (SocketException e) {
1701 Log.e(TAG, "Error querying interface", e);
1702 return IFACE_IDX_ANY;
1703 }
1704
1705 if (iface == null) {
1706 Log.e(TAG, "Interface not found: " + lp.getInterfaceName());
1707 return IFACE_IDX_ANY;
1708 }
1709
1710 return iface.getIndex();
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001711 }
1712
1713 private boolean stopResolveService(int resolveId) {
paulhu2b9ed952022-02-10 21:58:32 +08001714 return mMDnsManager.stopOperation(resolveId);
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001715 }
1716
paulhu2b9ed952022-02-10 21:58:32 +08001717 private boolean getAddrInfo(int resolveId, String hostname, int interfaceIdx) {
1718 return mMDnsManager.getServiceAddress(resolveId, hostname, interfaceIdx);
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001719 }
1720
1721 private boolean stopGetAddrInfo(int resolveId) {
paulhu2b9ed952022-02-10 21:58:32 +08001722 return mMDnsManager.stopOperation(resolveId);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001723 }
1724
1725 @Override
Irfan Sheriff75006652012-04-17 23:15:29 -07001726 public void dump(FileDescriptor fd, PrintWriter pw, String[] args) {
paulhu3ffffe72021-09-16 10:15:22 +08001727 if (!PermissionUtils.checkDumpPermission(mContext, TAG, pw)) return;
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001728
Irfan Sheriff75006652012-04-17 23:15:29 -07001729 for (ClientInfo client : mClients.values()) {
1730 pw.println("Client Info");
1731 pw.println(client);
1732 }
1733
1734 mNsdStateMachine.dump(fd, pw, args);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001735 }
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001736
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001737 private abstract static class ClientRequest {
1738 private final int mGlobalId;
1739
1740 private ClientRequest(int globalId) {
1741 mGlobalId = globalId;
1742 }
1743 }
1744
1745 private static class LegacyClientRequest extends ClientRequest {
1746 private final int mRequestCode;
1747
1748 private LegacyClientRequest(int globalId, int requestCode) {
1749 super(globalId);
1750 mRequestCode = requestCode;
1751 }
1752 }
1753
1754 private static class AdvertiserClientRequest extends ClientRequest {
1755 private AdvertiserClientRequest(int globalId) {
1756 super(globalId);
1757 }
1758 }
1759
1760 private static class DiscoveryManagerRequest extends ClientRequest {
1761 @NonNull
1762 private final MdnsListener mListener;
1763
1764 private DiscoveryManagerRequest(int globalId, @NonNull MdnsListener listener) {
1765 super(globalId);
1766 mListener = listener;
1767 }
1768 }
1769
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001770 /* Information tracked per client */
1771 private class ClientInfo {
1772
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001773 private static final int MAX_LIMIT = 10;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001774 private final INsdManagerCallback mCb;
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001775 /* Remembers a resolved service until getaddrinfo completes */
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001776 private NsdServiceInfo mResolvedService;
1777
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001778 /* A map from client-side ID (listenerKey) to the request */
1779 private final SparseArray<ClientRequest> mClientRequests = new SparseArray<>();
Paul Hu23fa2022023-01-13 22:57:24 +08001780
Luke Huangf7277ed2021-07-12 21:15:10 +08001781 // The target SDK of this client < Build.VERSION_CODES.S
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001782 private boolean mIsPreSClient = false;
Luke Huangf7277ed2021-07-12 21:15:10 +08001783
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001784 private ClientInfo(INsdManagerCallback cb) {
1785 mCb = cb;
paulhub2225702021-11-17 09:35:33 +08001786 if (DBG) Log.d(TAG, "New client");
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001787 }
Irfan Sheriff75006652012-04-17 23:15:29 -07001788
1789 @Override
1790 public String toString() {
Jeff Sharkey63465382020-10-17 21:20:13 -06001791 StringBuilder sb = new StringBuilder();
Irfan Sheriff75006652012-04-17 23:15:29 -07001792 sb.append("mResolvedService ").append(mResolvedService).append("\n");
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001793 sb.append("mIsLegacy ").append(mIsPreSClient).append("\n");
1794 for (int i = 0; i < mClientRequests.size(); i++) {
1795 int clientID = mClientRequests.keyAt(i);
1796 sb.append("clientId ")
1797 .append(clientID)
1798 .append(" mDnsId ").append(mClientRequests.valueAt(i).mGlobalId)
1799 .append(" type ").append(
1800 mClientRequests.valueAt(i).getClass().getSimpleName())
1801 .append("\n");
Irfan Sheriff75006652012-04-17 23:15:29 -07001802 }
1803 return sb.toString();
1804 }
Dave Plattfeff2af2014-03-07 14:48:22 -08001805
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001806 private boolean isPreSClient() {
1807 return mIsPreSClient;
Luke Huangf7277ed2021-07-12 21:15:10 +08001808 }
1809
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001810 private void setPreSClient() {
1811 mIsPreSClient = true;
Luke Huangf7277ed2021-07-12 21:15:10 +08001812 }
1813
Paul Hue4f5f252023-02-16 21:13:47 +08001814 private void unregisterMdnsListenerFromRequest(ClientRequest request) {
1815 final MdnsListener listener =
1816 ((DiscoveryManagerRequest) request).mListener;
1817 mMdnsDiscoveryManager.unregisterListener(
1818 listener.getListenedServiceType(), listener);
1819 }
1820
Dave Plattfeff2af2014-03-07 14:48:22 -08001821 // Remove any pending requests from the global map when we get rid of a client,
1822 // and send cancellations to the daemon.
1823 private void expungeAllRequests() {
Hugo Benichid2552ae2017-04-11 14:42:47 +09001824 // TODO: to keep handler responsive, do not clean all requests for that client at once.
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001825 for (int i = 0; i < mClientRequests.size(); i++) {
1826 final int clientId = mClientRequests.keyAt(i);
1827 final ClientRequest request = mClientRequests.valueAt(i);
1828 final int globalId = request.mGlobalId;
Dave Plattfeff2af2014-03-07 14:48:22 -08001829 mIdToClientInfoMap.remove(globalId);
paulhub2225702021-11-17 09:35:33 +08001830 if (DBG) {
1831 Log.d(TAG, "Terminating client-ID " + clientId
1832 + " global-ID " + globalId + " type " + mClientRequests.get(clientId));
1833 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001834
1835 if (request instanceof DiscoveryManagerRequest) {
Paul Hue4f5f252023-02-16 21:13:47 +08001836 unregisterMdnsListenerFromRequest(request);
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001837 continue;
1838 }
1839
1840 if (request instanceof AdvertiserClientRequest) {
1841 mAdvertiser.removeService(globalId);
1842 continue;
1843 }
1844
1845 if (!(request instanceof LegacyClientRequest)) {
1846 throw new IllegalStateException("Unknown request type: " + request.getClass());
1847 }
1848
1849 switch (((LegacyClientRequest) request).mRequestCode) {
Dave Plattfeff2af2014-03-07 14:48:22 -08001850 case NsdManager.DISCOVER_SERVICES:
1851 stopServiceDiscovery(globalId);
1852 break;
1853 case NsdManager.RESOLVE_SERVICE:
1854 stopResolveService(globalId);
1855 break;
1856 case NsdManager.REGISTER_SERVICE:
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001857 unregisterService(globalId);
Dave Plattfeff2af2014-03-07 14:48:22 -08001858 break;
1859 default:
1860 break;
1861 }
1862 }
Dave Plattfeff2af2014-03-07 14:48:22 -08001863 mClientRequests.clear();
1864 }
1865
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001866 // mClientRequests is a sparse array of listener id -> ClientRequest. For a given
1867 // mDnsClient id, return the corresponding listener id. mDnsClient id is also called a
1868 // global id.
Christopher Lane74411222014-04-25 18:39:07 -07001869 private int getClientId(final int globalId) {
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001870 for (int i = 0; i < mClientRequests.size(); i++) {
1871 if (mClientRequests.valueAt(i).mGlobalId == globalId) {
1872 return mClientRequests.keyAt(i);
1873 }
Christopher Lane74411222014-04-25 18:39:07 -07001874 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001875 return -1;
Christopher Lane74411222014-04-25 18:39:07 -07001876 }
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001877
1878 void onDiscoverServicesStarted(int listenerKey, NsdServiceInfo info) {
1879 try {
1880 mCb.onDiscoverServicesStarted(listenerKey, info);
1881 } catch (RemoteException e) {
1882 Log.e(TAG, "Error calling onDiscoverServicesStarted", e);
1883 }
1884 }
1885
1886 void onDiscoverServicesFailed(int listenerKey, int error) {
1887 try {
1888 mCb.onDiscoverServicesFailed(listenerKey, error);
1889 } catch (RemoteException e) {
1890 Log.e(TAG, "Error calling onDiscoverServicesFailed", e);
1891 }
1892 }
1893
1894 void onServiceFound(int listenerKey, NsdServiceInfo info) {
1895 try {
1896 mCb.onServiceFound(listenerKey, info);
1897 } catch (RemoteException e) {
1898 Log.e(TAG, "Error calling onServiceFound(", e);
1899 }
1900 }
1901
1902 void onServiceLost(int listenerKey, NsdServiceInfo info) {
1903 try {
1904 mCb.onServiceLost(listenerKey, info);
1905 } catch (RemoteException e) {
1906 Log.e(TAG, "Error calling onServiceLost(", e);
1907 }
1908 }
1909
1910 void onStopDiscoveryFailed(int listenerKey, int error) {
1911 try {
1912 mCb.onStopDiscoveryFailed(listenerKey, error);
1913 } catch (RemoteException e) {
1914 Log.e(TAG, "Error calling onStopDiscoveryFailed", e);
1915 }
1916 }
1917
1918 void onStopDiscoverySucceeded(int listenerKey) {
1919 try {
1920 mCb.onStopDiscoverySucceeded(listenerKey);
1921 } catch (RemoteException e) {
1922 Log.e(TAG, "Error calling onStopDiscoverySucceeded", e);
1923 }
1924 }
1925
1926 void onRegisterServiceFailed(int listenerKey, int error) {
1927 try {
1928 mCb.onRegisterServiceFailed(listenerKey, error);
1929 } catch (RemoteException e) {
1930 Log.e(TAG, "Error calling onRegisterServiceFailed", e);
1931 }
1932 }
1933
1934 void onRegisterServiceSucceeded(int listenerKey, NsdServiceInfo info) {
1935 try {
1936 mCb.onRegisterServiceSucceeded(listenerKey, info);
1937 } catch (RemoteException e) {
1938 Log.e(TAG, "Error calling onRegisterServiceSucceeded", e);
1939 }
1940 }
1941
1942 void onUnregisterServiceFailed(int listenerKey, int error) {
1943 try {
1944 mCb.onUnregisterServiceFailed(listenerKey, error);
1945 } catch (RemoteException e) {
1946 Log.e(TAG, "Error calling onUnregisterServiceFailed", e);
1947 }
1948 }
1949
1950 void onUnregisterServiceSucceeded(int listenerKey) {
1951 try {
1952 mCb.onUnregisterServiceSucceeded(listenerKey);
1953 } catch (RemoteException e) {
1954 Log.e(TAG, "Error calling onUnregisterServiceSucceeded", e);
1955 }
1956 }
1957
1958 void onResolveServiceFailed(int listenerKey, int error) {
1959 try {
1960 mCb.onResolveServiceFailed(listenerKey, error);
1961 } catch (RemoteException e) {
1962 Log.e(TAG, "Error calling onResolveServiceFailed", e);
1963 }
1964 }
1965
1966 void onResolveServiceSucceeded(int listenerKey, NsdServiceInfo info) {
1967 try {
1968 mCb.onResolveServiceSucceeded(listenerKey, info);
1969 } catch (RemoteException e) {
1970 Log.e(TAG, "Error calling onResolveServiceSucceeded", e);
1971 }
1972 }
Paul Hub58deb72022-12-26 09:24:42 +00001973
1974 void onStopResolutionFailed(int listenerKey, int error) {
1975 try {
1976 mCb.onStopResolutionFailed(listenerKey, error);
1977 } catch (RemoteException e) {
1978 Log.e(TAG, "Error calling onStopResolutionFailed", e);
1979 }
1980 }
1981
1982 void onStopResolutionSucceeded(int listenerKey) {
1983 try {
1984 mCb.onStopResolutionSucceeded(listenerKey);
1985 } catch (RemoteException e) {
1986 Log.e(TAG, "Error calling onStopResolutionSucceeded", e);
1987 }
1988 }
Paul Hu18aeccc2022-12-27 08:48:48 +00001989
1990 void onServiceInfoCallbackRegistrationFailed(int listenerKey, int error) {
1991 try {
1992 mCb.onServiceInfoCallbackRegistrationFailed(listenerKey, error);
1993 } catch (RemoteException e) {
1994 Log.e(TAG, "Error calling onServiceInfoCallbackRegistrationFailed", e);
1995 }
1996 }
1997
1998 void onServiceUpdated(int listenerKey, NsdServiceInfo info) {
1999 try {
2000 mCb.onServiceUpdated(listenerKey, info);
2001 } catch (RemoteException e) {
2002 Log.e(TAG, "Error calling onServiceUpdated", e);
2003 }
2004 }
2005
2006 void onServiceUpdatedLost(int listenerKey) {
2007 try {
2008 mCb.onServiceUpdatedLost(listenerKey);
2009 } catch (RemoteException e) {
2010 Log.e(TAG, "Error calling onServiceUpdatedLost", e);
2011 }
2012 }
2013
2014 void onServiceInfoCallbackUnregistered(int listenerKey) {
2015 try {
2016 mCb.onServiceInfoCallbackUnregistered(listenerKey);
2017 } catch (RemoteException e) {
2018 Log.e(TAG, "Error calling onServiceInfoCallbackUnregistered", e);
2019 }
2020 }
Irfan Sheriffe8de2462012-04-11 14:52:19 -07002021 }
Irfan Sheriff77ec5582012-03-22 17:01:39 -07002022}