blob: 2078c42791637b47377382b6159e1443958f898d [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;
Irfan Sheriffe8de2462012-04-11 14:52:19 -070083import java.util.HashMap;
Paul Hu23fa2022023-01-13 22:57:24 +080084import java.util.List;
Paul Hu75069ed2023-01-14 00:31:09 +080085import java.util.Map;
Paul Hu18aeccc2022-12-27 08:48:48 +000086import java.util.Objects;
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 Hu019621e2023-01-13 23:26:49 +0800267 /**
268 * Data class of mdns service callback information.
269 */
270 private static class MdnsEvent {
271 final int mClientId;
272 @NonNull
273 final String mRequestedServiceType;
274 @NonNull
275 final MdnsServiceInfo mMdnsServiceInfo;
276
277 MdnsEvent(int clientId, @NonNull String requestedServiceType,
278 @NonNull MdnsServiceInfo mdnsServiceInfo) {
279 mClientId = clientId;
280 mRequestedServiceType = requestedServiceType;
281 mMdnsServiceInfo = mdnsServiceInfo;
282 }
283 }
284
Irfan Sheriff75006652012-04-17 23:15:29 -0700285 private class NsdStateMachine extends StateMachine {
286
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700287 private final DefaultState mDefaultState = new DefaultState();
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700288 private final EnabledState mEnabledState = new EnabledState();
Irfan Sheriff75006652012-04-17 23:15:29 -0700289
290 @Override
Wink Saville358f5d42012-05-29 12:40:46 -0700291 protected String getWhatToString(int what) {
Hugo Benichi32be63d2017-04-05 14:06:11 +0900292 return NsdManager.nameOf(what);
Irfan Sheriff75006652012-04-17 23:15:29 -0700293 }
294
Luke Huang92860f92021-06-23 06:29:30 +0000295 private void maybeStartDaemon() {
paulhu2b9ed952022-02-10 21:58:32 +0800296 if (mIsDaemonStarted) {
297 if (DBG) Log.d(TAG, "Daemon is already started.");
298 return;
299 }
300 mMDnsManager.registerEventListener(mMDnsEventCallback);
301 mMDnsManager.startDaemon();
302 mIsDaemonStarted = true;
Luke Huang05298582021-06-13 16:52:05 +0000303 maybeScheduleStop();
304 }
305
paulhu2b9ed952022-02-10 21:58:32 +0800306 private void maybeStopDaemon() {
307 if (!mIsDaemonStarted) {
308 if (DBG) Log.d(TAG, "Daemon has not been started.");
309 return;
310 }
311 mMDnsManager.unregisterEventListener(mMDnsEventCallback);
312 mMDnsManager.stopDaemon();
313 mIsDaemonStarted = false;
314 }
315
Luke Huang92860f92021-06-23 06:29:30 +0000316 private boolean isAnyRequestActive() {
317 return mIdToClientInfoMap.size() != 0;
318 }
319
320 private void scheduleStop() {
321 sendMessageDelayed(NsdManager.DAEMON_CLEANUP, mCleanupDelayMs);
322 }
323 private void maybeScheduleStop() {
Luke Huangf7277ed2021-07-12 21:15:10 +0800324 // The native daemon should stay alive and can't be cleanup
325 // if any legacy client connected.
326 if (!isAnyRequestActive() && mLegacyClientCount == 0) {
Luke Huang92860f92021-06-23 06:29:30 +0000327 scheduleStop();
Luke Huang05298582021-06-13 16:52:05 +0000328 }
329 }
330
Luke Huang92860f92021-06-23 06:29:30 +0000331 private void cancelStop() {
Luke Huang05298582021-06-13 16:52:05 +0000332 this.removeMessages(NsdManager.DAEMON_CLEANUP);
333 }
334
Paul Hu23fa2022023-01-13 22:57:24 +0800335 private void maybeStartMonitoringSockets() {
336 if (mIsMonitoringSocketsStarted) {
337 if (DBG) Log.d(TAG, "Socket monitoring is already started.");
338 return;
339 }
340
341 mMdnsSocketProvider.startMonitoringSockets();
342 mIsMonitoringSocketsStarted = true;
343 }
344
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900345 private void maybeStopMonitoringSocketsIfNoActiveRequest() {
346 if (!mIsMonitoringSocketsStarted) return;
347 if (isAnyRequestActive()) return;
348
Paul Hu58f20602023-02-18 11:41:07 +0800349 mMdnsSocketProvider.requestStopWhenInactive();
Paul Hu23fa2022023-01-13 22:57:24 +0800350 mIsMonitoringSocketsStarted = false;
351 }
352
Hugo Benichi803a2f02017-04-24 11:35:06 +0900353 NsdStateMachine(String name, Handler handler) {
354 super(name, handler);
Irfan Sheriff75006652012-04-17 23:15:29 -0700355 addState(mDefaultState);
Irfan Sheriff75006652012-04-17 23:15:29 -0700356 addState(mEnabledState, mDefaultState);
paulhu5568f452021-11-30 13:31:29 +0800357 State initialState = mEnabledState;
Hugo Benichi912db992017-04-24 16:41:03 +0900358 setInitialState(initialState);
Wink Saville358f5d42012-05-29 12:40:46 -0700359 setLogRecSize(25);
Irfan Sheriff75006652012-04-17 23:15:29 -0700360 }
361
362 class DefaultState extends State {
363 @Override
364 public boolean processMessage(Message msg) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900365 final ClientInfo cInfo;
366 final int clientId = msg.arg2;
Irfan Sheriff75006652012-04-17 23:15:29 -0700367 switch (msg.what) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900368 case NsdManager.REGISTER_CLIENT:
369 final Pair<NsdServiceConnector, INsdManagerCallback> arg =
370 (Pair<NsdServiceConnector, INsdManagerCallback>) msg.obj;
371 final INsdManagerCallback cb = arg.second;
372 try {
373 cb.asBinder().linkToDeath(arg.first, 0);
374 cInfo = new ClientInfo(cb);
375 mClients.put(arg.first, cInfo);
376 } catch (RemoteException e) {
377 Log.w(TAG, "Client " + clientId + " has already died");
Irfan Sheriff75006652012-04-17 23:15:29 -0700378 }
379 break;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900380 case NsdManager.UNREGISTER_CLIENT:
381 final NsdServiceConnector connector = (NsdServiceConnector) msg.obj;
382 cInfo = mClients.remove(connector);
Dave Plattfeff2af2014-03-07 14:48:22 -0800383 if (cInfo != null) {
384 cInfo.expungeAllRequests();
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900385 if (cInfo.isPreSClient()) {
Luke Huangf7277ed2021-07-12 21:15:10 +0800386 mLegacyClientCount -= 1;
387 }
Dave Plattfeff2af2014-03-07 14:48:22 -0800388 }
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900389 maybeStopMonitoringSocketsIfNoActiveRequest();
Luke Huangf7277ed2021-07-12 21:15:10 +0800390 maybeScheduleStop();
Irfan Sheriff75006652012-04-17 23:15:29 -0700391 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700392 case NsdManager.DISCOVER_SERVICES:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900393 cInfo = getClientInfoForReply(msg);
394 if (cInfo != null) {
395 cInfo.onDiscoverServicesFailed(
396 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
397 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700398 break;
399 case NsdManager.STOP_DISCOVERY:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900400 cInfo = getClientInfoForReply(msg);
401 if (cInfo != null) {
402 cInfo.onStopDiscoveryFailed(
403 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
404 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700405 break;
406 case NsdManager.REGISTER_SERVICE:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900407 cInfo = getClientInfoForReply(msg);
408 if (cInfo != null) {
409 cInfo.onRegisterServiceFailed(
410 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
411 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700412 break;
413 case NsdManager.UNREGISTER_SERVICE:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900414 cInfo = getClientInfoForReply(msg);
415 if (cInfo != null) {
416 cInfo.onUnregisterServiceFailed(
417 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
418 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700419 break;
420 case NsdManager.RESOLVE_SERVICE:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900421 cInfo = getClientInfoForReply(msg);
422 if (cInfo != null) {
423 cInfo.onResolveServiceFailed(
424 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
425 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700426 break;
Paul Hub58deb72022-12-26 09:24:42 +0000427 case NsdManager.STOP_RESOLUTION:
428 cInfo = getClientInfoForReply(msg);
429 if (cInfo != null) {
430 cInfo.onStopResolutionFailed(
431 clientId, NsdManager.FAILURE_OPERATION_NOT_RUNNING);
432 }
433 break;
Paul Hu18aeccc2022-12-27 08:48:48 +0000434 case NsdManager.REGISTER_SERVICE_CALLBACK:
435 cInfo = getClientInfoForReply(msg);
436 if (cInfo != null) {
437 cInfo.onServiceInfoCallbackRegistrationFailed(
438 clientId, NsdManager.FAILURE_BAD_PARAMETERS);
439 }
440 break;
Luke Huang05298582021-06-13 16:52:05 +0000441 case NsdManager.DAEMON_CLEANUP:
paulhu2b9ed952022-02-10 21:58:32 +0800442 maybeStopDaemon();
Luke Huang05298582021-06-13 16:52:05 +0000443 break;
Luke Huangf7277ed2021-07-12 21:15:10 +0800444 // This event should be only sent by the legacy (target SDK < S) clients.
445 // Mark the sending client as legacy.
446 case NsdManager.DAEMON_STARTUP:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900447 cInfo = getClientInfoForReply(msg);
Luke Huangf7277ed2021-07-12 21:15:10 +0800448 if (cInfo != null) {
449 cancelStop();
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900450 cInfo.setPreSClient();
Luke Huangf7277ed2021-07-12 21:15:10 +0800451 mLegacyClientCount += 1;
452 maybeStartDaemon();
453 }
454 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700455 default:
paulhub2225702021-11-17 09:35:33 +0800456 Log.e(TAG, "Unhandled " + msg);
Irfan Sheriff75006652012-04-17 23:15:29 -0700457 return NOT_HANDLED;
458 }
459 return HANDLED;
460 }
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900461
462 private ClientInfo getClientInfoForReply(Message msg) {
463 final ListenerArgs args = (ListenerArgs) msg.obj;
464 return mClients.get(args.connector);
465 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700466 }
467
Irfan Sheriff75006652012-04-17 23:15:29 -0700468 class EnabledState extends State {
469 @Override
470 public void enter() {
471 sendNsdStateChangeBroadcast(true);
Irfan Sheriff75006652012-04-17 23:15:29 -0700472 }
473
474 @Override
475 public void exit() {
Luke Huang05298582021-06-13 16:52:05 +0000476 // TODO: it is incorrect to stop the daemon without expunging all requests
477 // and sending error callbacks to clients.
Luke Huang92860f92021-06-23 06:29:30 +0000478 scheduleStop();
Irfan Sheriff75006652012-04-17 23:15:29 -0700479 }
480
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700481 private boolean requestLimitReached(ClientInfo clientInfo) {
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900482 if (clientInfo.mClientRequests.size() >= ClientInfo.MAX_LIMIT) {
paulhub2225702021-11-17 09:35:33 +0800483 if (DBG) Log.d(TAG, "Exceeded max outstanding requests " + clientInfo);
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700484 return true;
485 }
486 return false;
487 }
488
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900489 private void storeLegacyRequestMap(int clientId, int globalId, ClientInfo clientInfo,
490 int what) {
491 clientInfo.mClientRequests.put(clientId, new LegacyClientRequest(globalId, what));
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700492 mIdToClientInfoMap.put(globalId, clientInfo);
Luke Huang05298582021-06-13 16:52:05 +0000493 // Remove the cleanup event because here comes a new request.
494 cancelStop();
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700495 }
496
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900497 private void storeAdvertiserRequestMap(int clientId, int globalId,
Paul Hu23fa2022023-01-13 22:57:24 +0800498 ClientInfo clientInfo) {
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900499 clientInfo.mClientRequests.put(clientId, new AdvertiserClientRequest(globalId));
500 mIdToClientInfoMap.put(globalId, clientInfo);
Paul Hu23fa2022023-01-13 22:57:24 +0800501 }
502
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900503 private void removeRequestMap(int clientId, int globalId, ClientInfo clientInfo) {
504 final ClientRequest existing = clientInfo.mClientRequests.get(clientId);
505 if (existing == null) return;
506 clientInfo.mClientRequests.remove(clientId);
507 mIdToClientInfoMap.remove(globalId);
508
509 if (existing instanceof LegacyClientRequest) {
510 maybeScheduleStop();
511 } else {
512 maybeStopMonitoringSocketsIfNoActiveRequest();
513 }
514 }
515
516 private void storeDiscoveryManagerRequestMap(int clientId, int globalId,
517 MdnsListener listener, ClientInfo clientInfo) {
518 clientInfo.mClientRequests.put(clientId,
519 new DiscoveryManagerRequest(globalId, listener));
520 mIdToClientInfoMap.put(globalId, clientInfo);
Paul Hu23fa2022023-01-13 22:57:24 +0800521 }
522
Paul Hu18aeccc2022-12-27 08:48:48 +0000523 private void clearRegisteredServiceInfo(ClientInfo clientInfo) {
524 clientInfo.mRegisteredService = null;
525 clientInfo.mClientIdForServiceUpdates = 0;
526 }
527
Paul Hu23fa2022023-01-13 22:57:24 +0800528 /**
529 * Check the given service type is valid and construct it to a service type
530 * which can use for discovery / resolution service.
531 *
532 * <p> The valid service type should be 2 labels, or 3 labels if the query is for a
533 * subtype (see RFC6763 7.1). Each label is up to 63 characters and must start with an
534 * underscore; they are alphanumerical characters or dashes or underscore, except the
535 * last one that is just alphanumerical. The last label must be _tcp or _udp.
536 *
537 * @param serviceType the request service type for discovery / resolution service
538 * @return constructed service type or null if the given service type is invalid.
539 */
540 @Nullable
541 private String constructServiceType(String serviceType) {
542 if (TextUtils.isEmpty(serviceType)) return null;
543
544 final Pattern serviceTypePattern = Pattern.compile(
545 "^(_[a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]\\.)?"
546 + "(_[a-zA-Z0-9-_]{1,61}[a-zA-Z0-9]\\._(?:tcp|udp))$");
547 final Matcher matcher = serviceTypePattern.matcher(serviceType);
548 if (!matcher.matches()) return null;
549 return matcher.group(1) == null
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900550 ? serviceType
551 : matcher.group(1) + "_sub." + matcher.group(2);
552 }
553
554 /**
555 * Truncate a service name to up to 63 UTF-8 bytes.
556 *
557 * See RFC6763 4.1.1: service instance names are UTF-8 and up to 63 bytes. Truncating
558 * names used in registerService follows historical behavior (see mdnsresponder
559 * handle_regservice_request).
560 */
561 @NonNull
562 private String truncateServiceName(@NonNull String originalName) {
563 // UTF-8 is at most 4 bytes per character; return early in the common case where
564 // the name can't possibly be over the limit given its string length.
565 if (originalName.length() <= MAX_LABEL_LENGTH / 4) return originalName;
566
567 final Charset utf8 = StandardCharsets.UTF_8;
568 final CharsetEncoder encoder = utf8.newEncoder();
569 final ByteBuffer out = ByteBuffer.allocate(MAX_LABEL_LENGTH);
570 // encode will write as many characters as possible to the out buffer, and just
571 // return an overflow code if there were too many characters (no need to check the
572 // return code here, this method truncates the name on purpose).
573 encoder.encode(CharBuffer.wrap(originalName), out, true /* endOfInput */);
574 return new String(out.array(), 0, out.position(), utf8);
Paul Hu23fa2022023-01-13 22:57:24 +0800575 }
576
Irfan Sheriff75006652012-04-17 23:15:29 -0700577 @Override
578 public boolean processMessage(Message msg) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900579 final ClientInfo clientInfo;
580 final int id;
581 final int clientId = msg.arg2;
582 final ListenerArgs args;
Irfan Sheriff75006652012-04-17 23:15:29 -0700583 switch (msg.what) {
Paul Hu75069ed2023-01-14 00:31:09 +0800584 case NsdManager.DISCOVER_SERVICES: {
paulhub2225702021-11-17 09:35:33 +0800585 if (DBG) Log.d(TAG, "Discover services");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900586 args = (ListenerArgs) msg.obj;
587 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000588 // If the binder death notification for a INsdManagerCallback was received
589 // before any calls are received by NsdService, the clientInfo would be
590 // cleared and cause NPE. Add a null check here to prevent this corner case.
591 if (clientInfo == null) {
592 Log.e(TAG, "Unknown connector in discovery");
593 break;
594 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700595
596 if (requestLimitReached(clientInfo)) {
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900597 clientInfo.onDiscoverServicesFailed(
598 clientId, NsdManager.FAILURE_MAX_LIMIT);
Irfan Sheriff75006652012-04-17 23:15:29 -0700599 break;
600 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700601
Paul Hu23fa2022023-01-13 22:57:24 +0800602 final NsdServiceInfo info = args.serviceInfo;
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700603 id = getUniqueId();
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +0900604 final String serviceType = constructServiceType(info.getServiceType());
605 if (mDeps.isMdnsDiscoveryManagerEnabled(mContext)
606 || useDiscoveryManagerForType(serviceType)) {
Paul Hu23fa2022023-01-13 22:57:24 +0800607 if (serviceType == null) {
608 clientInfo.onDiscoverServicesFailed(clientId,
609 NsdManager.FAILURE_INTERNAL_ERROR);
610 break;
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700611 }
Paul Hu23fa2022023-01-13 22:57:24 +0800612
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900613 final String listenServiceType = serviceType + ".local";
Paul Hu23fa2022023-01-13 22:57:24 +0800614 maybeStartMonitoringSockets();
615 final MdnsListener listener =
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900616 new DiscoveryListener(clientId, id, info, listenServiceType);
Paul Hu23fa2022023-01-13 22:57:24 +0800617 final MdnsSearchOptions options = MdnsSearchOptions.newBuilder()
618 .setNetwork(info.getNetwork())
619 .setIsPassiveMode(true)
620 .build();
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +0900621 mMdnsDiscoveryManager.registerListener(
622 listenServiceType, listener, options);
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900623 storeDiscoveryManagerRequestMap(clientId, id, listener, clientInfo);
Paul Hu23fa2022023-01-13 22:57:24 +0800624 clientInfo.onDiscoverServicesStarted(clientId, info);
Irfan Sheriff75006652012-04-17 23:15:29 -0700625 } else {
Paul Hu23fa2022023-01-13 22:57:24 +0800626 maybeStartDaemon();
627 if (discoverServices(id, info)) {
628 if (DBG) {
629 Log.d(TAG, "Discover " + msg.arg2 + " " + id
630 + info.getServiceType());
631 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900632 storeLegacyRequestMap(clientId, id, clientInfo, msg.what);
Paul Hu23fa2022023-01-13 22:57:24 +0800633 clientInfo.onDiscoverServicesStarted(clientId, info);
634 } else {
635 stopServiceDiscovery(id);
636 clientInfo.onDiscoverServicesFailed(clientId,
637 NsdManager.FAILURE_INTERNAL_ERROR);
638 }
Irfan Sheriff75006652012-04-17 23:15:29 -0700639 }
640 break;
Paul Hu75069ed2023-01-14 00:31:09 +0800641 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900642 case NsdManager.STOP_DISCOVERY: {
paulhub2225702021-11-17 09:35:33 +0800643 if (DBG) Log.d(TAG, "Stop service discovery");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900644 args = (ListenerArgs) msg.obj;
645 clientInfo = mClients.get(args.connector);
Paul Hu116b4c02022-08-16 07:21:55 +0000646 // If the binder death notification for a INsdManagerCallback was received
647 // before any calls are received by NsdService, the clientInfo would be
648 // cleared and cause NPE. Add a null check here to prevent this corner case.
649 if (clientInfo == null) {
650 Log.e(TAG, "Unknown connector in stop discovery");
651 break;
652 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700653
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900654 final ClientRequest request = clientInfo.mClientRequests.get(clientId);
655 if (request == null) {
656 Log.e(TAG, "Unknown client request in STOP_DISCOVERY");
Irfan Sheriff75006652012-04-17 23:15:29 -0700657 break;
658 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900659 id = request.mGlobalId;
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +0900660 // Note isMdnsDiscoveryManagerEnabled may have changed to false at this
661 // point, so this needs to check the type of the original request to
662 // unregister instead of looking at the flag value.
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900663 if (request instanceof DiscoveryManagerRequest) {
Ahmad Khalil4b8d45a2023-03-02 11:43:25 +0000664 final MdnsListener listener =
665 ((DiscoveryManagerRequest) request).mListener;
666 mMdnsDiscoveryManager.unregisterListener(
667 listener.getListenedServiceType(), listener);
668 removeRequestMap(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;
Ahmad Khalil4b8d45a2023-03-02 11:43:25 +0000839 removeRequestMap(clientId, id, clientInfo);
840 if (stopResolveService(id)) {
Paul Hub58deb72022-12-26 09:24:42 +0000841 clientInfo.onStopResolutionSucceeded(clientId);
842 } else {
Ahmad Khalil4b8d45a2023-03-02 11:43:25 +0000843 clientInfo.onStopResolutionFailed(
844 clientId, NsdManager.FAILURE_OPERATION_NOT_RUNNING);
Paul Hub58deb72022-12-26 09:24:42 +0000845 }
Ahmad Khalil4b8d45a2023-03-02 11:43:25 +0000846 clientInfo.mResolvedService = null;
847 // TODO: Implement the stop resolution with MdnsDiscoveryManager.
Paul Hub58deb72022-12-26 09:24:42 +0000848 break;
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900849 }
Paul Hu18aeccc2022-12-27 08:48:48 +0000850 case NsdManager.REGISTER_SERVICE_CALLBACK:
851 if (DBG) Log.d(TAG, "Register a service callback");
852 args = (ListenerArgs) msg.obj;
853 clientInfo = mClients.get(args.connector);
854 // If the binder death notification for a INsdManagerCallback was received
855 // before any calls are received by NsdService, the clientInfo would be
856 // cleared and cause NPE. Add a null check here to prevent this corner case.
857 if (clientInfo == null) {
858 Log.e(TAG, "Unknown connector in callback registration");
859 break;
860 }
861
862 if (clientInfo.mRegisteredService != null) {
863 clientInfo.onServiceInfoCallbackRegistrationFailed(
864 clientId, NsdManager.FAILURE_ALREADY_ACTIVE);
865 break;
866 }
867
868 maybeStartDaemon();
869 id = getUniqueId();
870 if (resolveService(id, args.serviceInfo)) {
871 clientInfo.mRegisteredService = new NsdServiceInfo();
872 clientInfo.mClientIdForServiceUpdates = clientId;
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900873 storeLegacyRequestMap(clientId, id, clientInfo, msg.what);
Paul Hu18aeccc2022-12-27 08:48:48 +0000874 } else {
875 clientInfo.onServiceInfoCallbackRegistrationFailed(
876 clientId, NsdManager.FAILURE_BAD_PARAMETERS);
877 }
878 break;
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900879 case NsdManager.UNREGISTER_SERVICE_CALLBACK: {
Paul Hu18aeccc2022-12-27 08:48:48 +0000880 if (DBG) Log.d(TAG, "Unregister a service callback");
881 args = (ListenerArgs) msg.obj;
882 clientInfo = mClients.get(args.connector);
883 // If the binder death notification for a INsdManagerCallback was received
884 // before any calls are received by NsdService, the clientInfo would be
885 // cleared and cause NPE. Add a null check here to prevent this corner case.
886 if (clientInfo == null) {
887 Log.e(TAG, "Unknown connector in callback unregistration");
888 break;
889 }
890
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900891 final ClientRequest request = clientInfo.mClientRequests.get(clientId);
892 if (request == null) {
893 Log.e(TAG, "Unknown client request in STOP_RESOLUTION");
894 break;
895 }
896 id = request.mGlobalId;
Paul Hu18aeccc2022-12-27 08:48:48 +0000897 removeRequestMap(clientId, id, clientInfo);
898 if (stopResolveService(id)) {
899 clientInfo.onServiceInfoCallbackUnregistered(clientId);
900 } else {
901 Log.e(TAG, "Failed to unregister service info callback");
902 }
903 clearRegisteredServiceInfo(clientInfo);
904 break;
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +0900905 }
paulhu2b9ed952022-02-10 21:58:32 +0800906 case MDNS_SERVICE_EVENT:
907 if (!handleMDnsServiceEvent(msg.arg1, msg.arg2, msg.obj)) {
Hugo Benichif0c84092017-04-05 14:43:29 +0900908 return NOT_HANDLED;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700909 }
Irfan Sheriffe4c42f42012-05-03 16:44:27 -0700910 break;
Paul Hu019621e2023-01-13 23:26:49 +0800911 case MDNS_DISCOVERY_MANAGER_EVENT:
912 if (!handleMdnsDiscoveryManagerEvent(msg.arg1, msg.arg2, msg.obj)) {
913 return NOT_HANDLED;
914 }
915 break;
Irfan Sheriff75006652012-04-17 23:15:29 -0700916 default:
Hugo Benichif0c84092017-04-05 14:43:29 +0900917 return NOT_HANDLED;
Irfan Sheriff75006652012-04-17 23:15:29 -0700918 }
Hugo Benichif0c84092017-04-05 14:43:29 +0900919 return HANDLED;
Irfan Sheriff75006652012-04-17 23:15:29 -0700920 }
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700921
Paul Hu18aeccc2022-12-27 08:48:48 +0000922 private void notifyResolveFailedResult(boolean isListenedToUpdates, int clientId,
923 ClientInfo clientInfo, int error) {
924 if (isListenedToUpdates) {
925 clientInfo.onServiceInfoCallbackRegistrationFailed(clientId, error);
926 clearRegisteredServiceInfo(clientInfo);
927 } else {
928 // The resolve API always returned FAILURE_INTERNAL_ERROR on error; keep it
929 // for backwards compatibility.
930 clientInfo.onResolveServiceFailed(clientId, NsdManager.FAILURE_INTERNAL_ERROR);
931 clientInfo.mResolvedService = null;
932 }
933 }
934
paulhu2b9ed952022-02-10 21:58:32 +0800935 private boolean handleMDnsServiceEvent(int code, int id, Object obj) {
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700936 NsdServiceInfo servInfo;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700937 ClientInfo clientInfo = mIdToClientInfoMap.get(id);
938 if (clientInfo == null) {
paulhu2b9ed952022-02-10 21:58:32 +0800939 Log.e(TAG, String.format("id %d for %d has no client mapping", id, code));
Hugo Benichif0c84092017-04-05 14:43:29 +0900940 return false;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700941 }
942
943 /* This goes in response as msg.arg2 */
Christopher Lane74411222014-04-25 18:39:07 -0700944 int clientId = clientInfo.getClientId(id);
945 if (clientId < 0) {
Vinit Deshapnde930a8512013-06-25 19:45:03 -0700946 // This can happen because of race conditions. For example,
947 // SERVICE_FOUND may race with STOP_SERVICE_DISCOVERY,
948 // and we may get in this situation.
paulhu2b9ed952022-02-10 21:58:32 +0800949 Log.d(TAG, String.format("%d for listener id %d that is no longer active",
950 code, id));
Hugo Benichif0c84092017-04-05 14:43:29 +0900951 return false;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700952 }
Hugo Benichi32be63d2017-04-05 14:06:11 +0900953 if (DBG) {
paulhu2b9ed952022-02-10 21:58:32 +0800954 Log.d(TAG, String.format("MDns service event code:%d id=%d", code, id));
Hugo Benichi32be63d2017-04-05 14:06:11 +0900955 }
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700956 switch (code) {
paulhu2b9ed952022-02-10 21:58:32 +0800957 case IMDnsEventListener.SERVICE_FOUND: {
958 final DiscoveryInfo info = (DiscoveryInfo) obj;
959 final String name = info.serviceName;
960 final String type = info.registrationType;
961 servInfo = new NsdServiceInfo(name, type);
962 final int foundNetId = info.netId;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +0900963 if (foundNetId == 0L) {
964 // Ignore services that do not have a Network: they are not usable
965 // by apps, as they would need privileged permissions to use
966 // interfaces that do not have an associated Network.
967 break;
968 }
Remi NGUYEN VAN643edb62023-01-23 19:14:57 +0900969 if (foundNetId == INetd.DUMMY_NET_ID) {
970 // Ignore services on the dummy0 interface: they are only seen when
971 // discovering locally advertised services, and are not reachable
972 // through that interface.
973 break;
974 }
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +0900975 setServiceNetworkForCallback(servInfo, info.netId, info.interfaceIdx);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900976 clientInfo.onServiceFound(clientId, servInfo);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700977 break;
paulhu2b9ed952022-02-10 21:58:32 +0800978 }
979 case IMDnsEventListener.SERVICE_LOST: {
980 final DiscoveryInfo info = (DiscoveryInfo) obj;
981 final String name = info.serviceName;
982 final String type = info.registrationType;
983 final int lostNetId = info.netId;
984 servInfo = new NsdServiceInfo(name, type);
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +0900985 // The network could be set to null (netId 0) if it was torn down when the
986 // service is lost
987 // TODO: avoid returning null in that case, possibly by remembering
988 // found services on the same interface index and their network at the time
989 setServiceNetworkForCallback(servInfo, lostNetId, info.interfaceIdx);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900990 clientInfo.onServiceLost(clientId, servInfo);
Paul Hu18aeccc2022-12-27 08:48:48 +0000991 // TODO: also support registered service lost when not discovering
992 clientInfo.maybeNotifyRegisteredServiceLost(servInfo);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700993 break;
paulhu2b9ed952022-02-10 21:58:32 +0800994 }
995 case IMDnsEventListener.SERVICE_DISCOVERY_FAILED:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +0900996 clientInfo.onDiscoverServicesFailed(
997 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -0700998 break;
paulhu2b9ed952022-02-10 21:58:32 +0800999 case IMDnsEventListener.SERVICE_REGISTERED: {
1000 final RegistrationInfo info = (RegistrationInfo) obj;
1001 final String name = info.serviceName;
1002 servInfo = new NsdServiceInfo(name, null /* serviceType */);
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001003 clientInfo.onRegisterServiceSucceeded(clientId, servInfo);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001004 break;
paulhu2b9ed952022-02-10 21:58:32 +08001005 }
1006 case IMDnsEventListener.SERVICE_REGISTRATION_FAILED:
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001007 clientInfo.onRegisterServiceFailed(
1008 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001009 break;
paulhu2b9ed952022-02-10 21:58:32 +08001010 case IMDnsEventListener.SERVICE_RESOLVED: {
1011 final ResolutionInfo info = (ResolutionInfo) obj;
Sreeram Ramachandrana53dd7f2014-09-03 15:45:59 -07001012 int index = 0;
paulhu2b9ed952022-02-10 21:58:32 +08001013 final String fullName = info.serviceFullName;
1014 while (index < fullName.length() && fullName.charAt(index) != '.') {
1015 if (fullName.charAt(index) == '\\') {
Sreeram Ramachandrana53dd7f2014-09-03 15:45:59 -07001016 ++index;
1017 }
1018 ++index;
1019 }
paulhu2b9ed952022-02-10 21:58:32 +08001020 if (index >= fullName.length()) {
1021 Log.e(TAG, "Invalid service found " + fullName);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001022 break;
1023 }
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001024
paulhube186602022-04-12 07:18:23 +00001025 String name = unescape(fullName.substring(0, index));
paulhu2b9ed952022-02-10 21:58:32 +08001026 String rest = fullName.substring(index);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001027 String type = rest.replace(".local.", "");
1028
Paul Hu18aeccc2022-12-27 08:48:48 +00001029 final boolean isListenedToUpdates =
1030 clientId == clientInfo.mClientIdForServiceUpdates;
1031 final NsdServiceInfo serviceInfo = isListenedToUpdates
1032 ? clientInfo.mRegisteredService : clientInfo.mResolvedService;
1033
1034 serviceInfo.setServiceName(name);
1035 serviceInfo.setServiceType(type);
1036 serviceInfo.setPort(info.port);
1037 serviceInfo.setTxtRecords(info.txtRecord);
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001038 // Network will be added after SERVICE_GET_ADDR_SUCCESS
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001039
1040 stopResolveService(id);
Vinit Deshapnde4429e872013-11-12 15:36:37 -08001041 removeRequestMap(clientId, id, clientInfo);
1042
paulhu2b9ed952022-02-10 21:58:32 +08001043 final int id2 = getUniqueId();
1044 if (getAddrInfo(id2, info.hostname, info.interfaceIdx)) {
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001045 storeLegacyRequestMap(clientId, id2, clientInfo,
1046 NsdManager.RESOLVE_SERVICE);
Vinit Deshapnde4429e872013-11-12 15:36:37 -08001047 } else {
Paul Hu18aeccc2022-12-27 08:48:48 +00001048 notifyResolveFailedResult(isListenedToUpdates, clientId, clientInfo,
1049 NsdManager.FAILURE_BAD_PARAMETERS);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001050 }
1051 break;
paulhu2b9ed952022-02-10 21:58:32 +08001052 }
1053 case IMDnsEventListener.SERVICE_RESOLUTION_FAILED:
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001054 /* NNN resolveId errorCode */
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001055 stopResolveService(id);
1056 removeRequestMap(clientId, id, clientInfo);
Paul Hu18aeccc2022-12-27 08:48:48 +00001057 notifyResolveFailedResult(
1058 clientId == clientInfo.mClientIdForServiceUpdates,
1059 clientId, clientInfo, NsdManager.FAILURE_BAD_PARAMETERS);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001060 break;
paulhu2b9ed952022-02-10 21:58:32 +08001061 case IMDnsEventListener.SERVICE_GET_ADDR_FAILED:
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001062 /* NNN resolveId errorCode */
1063 stopGetAddrInfo(id);
1064 removeRequestMap(clientId, id, clientInfo);
Paul Hu18aeccc2022-12-27 08:48:48 +00001065 notifyResolveFailedResult(
1066 clientId == clientInfo.mClientIdForServiceUpdates,
1067 clientId, clientInfo, NsdManager.FAILURE_BAD_PARAMETERS);
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001068 break;
paulhu2b9ed952022-02-10 21:58:32 +08001069 case IMDnsEventListener.SERVICE_GET_ADDR_SUCCESS: {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001070 /* NNN resolveId hostname ttl addr interfaceIdx netId */
paulhu2b9ed952022-02-10 21:58:32 +08001071 final GetAddressInfo info = (GetAddressInfo) obj;
1072 final String address = info.address;
1073 final int netId = info.netId;
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001074 InetAddress serviceHost = null;
1075 try {
paulhu2b9ed952022-02-10 21:58:32 +08001076 serviceHost = InetAddress.getByName(address);
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001077 } catch (UnknownHostException e) {
1078 Log.wtf(TAG, "Invalid host in GET_ADDR_SUCCESS", e);
1079 }
1080
1081 // If the resolved service is on an interface without a network, consider it
1082 // as a failure: it would not be usable by apps as they would need
1083 // privileged permissions.
Paul Hu18aeccc2022-12-27 08:48:48 +00001084 if (clientId == clientInfo.mClientIdForServiceUpdates) {
1085 if (netId != NETID_UNSET && serviceHost != null) {
1086 setServiceNetworkForCallback(clientInfo.mRegisteredService,
1087 netId, info.interfaceIdx);
1088 final List<InetAddress> addresses =
1089 clientInfo.mRegisteredService.getHostAddresses();
1090 addresses.add(serviceHost);
1091 clientInfo.mRegisteredService.setHostAddresses(addresses);
1092 clientInfo.onServiceUpdated(
1093 clientId, clientInfo.mRegisteredService);
1094 } else {
1095 stopGetAddrInfo(id);
1096 removeRequestMap(clientId, id, clientInfo);
1097 clearRegisteredServiceInfo(clientInfo);
1098 clientInfo.onServiceInfoCallbackRegistrationFailed(
1099 clientId, NsdManager.FAILURE_BAD_PARAMETERS);
1100 }
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001101 } else {
Paul Hu18aeccc2022-12-27 08:48:48 +00001102 if (netId != NETID_UNSET && serviceHost != null) {
1103 clientInfo.mResolvedService.setHost(serviceHost);
1104 setServiceNetworkForCallback(clientInfo.mResolvedService,
1105 netId, info.interfaceIdx);
1106 clientInfo.onResolveServiceSucceeded(
1107 clientId, clientInfo.mResolvedService);
1108 } else {
1109 clientInfo.onResolveServiceFailed(
1110 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
1111 }
1112 stopGetAddrInfo(id);
1113 removeRequestMap(clientId, id, clientInfo);
1114 clientInfo.mResolvedService = null;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001115 }
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001116 break;
paulhu2b9ed952022-02-10 21:58:32 +08001117 }
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001118 default:
Hugo Benichif0c84092017-04-05 14:43:29 +09001119 return false;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001120 }
Hugo Benichif0c84092017-04-05 14:43:29 +09001121 return true;
Vairavan Srinivasan6ce48182012-08-05 13:14:12 -07001122 }
Paul Hu019621e2023-01-13 23:26:49 +08001123
1124 private NsdServiceInfo buildNsdServiceInfoFromMdnsEvent(final MdnsEvent event) {
1125 final MdnsServiceInfo serviceInfo = event.mMdnsServiceInfo;
1126 final String serviceType = event.mRequestedServiceType;
1127 final String serviceName = serviceInfo.getServiceInstanceName();
1128 final NsdServiceInfo servInfo = new NsdServiceInfo(serviceName, serviceType);
1129 final Network network = serviceInfo.getNetwork();
1130 setServiceNetworkForCallback(
1131 servInfo,
1132 network == null ? NETID_UNSET : network.netId,
1133 serviceInfo.getInterfaceIndex());
1134 return servInfo;
1135 }
1136
1137 private boolean handleMdnsDiscoveryManagerEvent(
1138 int transactionId, int code, Object obj) {
1139 final ClientInfo clientInfo = mIdToClientInfoMap.get(transactionId);
1140 if (clientInfo == null) {
1141 Log.e(TAG, String.format(
1142 "id %d for %d has no client mapping", transactionId, code));
1143 return false;
1144 }
1145
1146 final MdnsEvent event = (MdnsEvent) obj;
1147 final int clientId = event.mClientId;
Paul Hu319751a2023-01-13 23:56:34 +08001148 final NsdServiceInfo info = buildNsdServiceInfoFromMdnsEvent(event);
Paul Hu019621e2023-01-13 23:26:49 +08001149 if (DBG) {
1150 Log.d(TAG, String.format("MdnsDiscoveryManager event code=%s transactionId=%d",
1151 NsdManager.nameOf(code), transactionId));
1152 }
1153 switch (code) {
1154 case NsdManager.SERVICE_FOUND:
Paul Hu319751a2023-01-13 23:56:34 +08001155 clientInfo.onServiceFound(clientId, info);
1156 break;
1157 case NsdManager.SERVICE_LOST:
1158 clientInfo.onServiceLost(clientId, info);
Paul Hu019621e2023-01-13 23:26:49 +08001159 break;
Paul Hu75069ed2023-01-14 00:31:09 +08001160 case NsdManager.RESOLVE_SERVICE_SUCCEEDED: {
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001161 final ClientRequest request = clientInfo.mClientRequests.get(clientId);
1162 if (request == null) {
1163 Log.e(TAG, "Unknown client request in RESOLVE_SERVICE_SUCCEEDED");
1164 break;
1165 }
Paul Hu75069ed2023-01-14 00:31:09 +08001166 final MdnsServiceInfo serviceInfo = event.mMdnsServiceInfo;
1167 // Add '.' in front of the service type that aligns with historical behavior
1168 info.setServiceType("." + event.mRequestedServiceType);
1169 info.setPort(serviceInfo.getPort());
1170
1171 Map<String, String> attrs = serviceInfo.getAttributes();
1172 for (Map.Entry<String, String> kv : attrs.entrySet()) {
1173 final String key = kv.getKey();
1174 try {
1175 info.setAttribute(key, serviceInfo.getAttributeAsBytes(key));
1176 } catch (IllegalArgumentException e) {
1177 Log.e(TAG, "Invalid attribute", e);
1178 }
1179 }
1180 try {
1181 if (serviceInfo.getIpv4Address() != null) {
1182 info.setHost(InetAddresses.parseNumericAddress(
1183 serviceInfo.getIpv4Address()));
1184 } else {
1185 info.setHost(InetAddresses.parseNumericAddress(
1186 serviceInfo.getIpv6Address()));
1187 }
1188 clientInfo.onResolveServiceSucceeded(clientId, info);
1189 } catch (IllegalArgumentException e) {
1190 Log.wtf(TAG, "Invalid address in RESOLVE_SERVICE_SUCCEEDED", e);
1191 clientInfo.onResolveServiceFailed(
1192 clientId, NsdManager.FAILURE_INTERNAL_ERROR);
1193 }
1194
1195 // Unregister the listener immediately like IMDnsEventListener design
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001196 if (!(request instanceof DiscoveryManagerRequest)) {
1197 Log.wtf(TAG, "non-DiscoveryManager request in DiscoveryManager event");
1198 break;
1199 }
Ahmad Khalil4b8d45a2023-03-02 11:43:25 +00001200 final MdnsListener listener = ((DiscoveryManagerRequest) request).mListener;
1201 mMdnsDiscoveryManager.unregisterListener(
1202 listener.getListenedServiceType(), listener);
1203 removeRequestMap(clientId, transactionId, clientInfo);
Paul Hu75069ed2023-01-14 00:31:09 +08001204 break;
1205 }
Paul Hu019621e2023-01-13 23:26:49 +08001206 default:
1207 return false;
1208 }
1209 return true;
1210 }
Irfan Sheriff75006652012-04-17 23:15:29 -07001211 }
1212 }
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001213
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001214 private static void setServiceNetworkForCallback(NsdServiceInfo info, int netId, int ifaceIdx) {
1215 switch (netId) {
1216 case NETID_UNSET:
1217 info.setNetwork(null);
1218 break;
1219 case INetd.LOCAL_NET_ID:
1220 // Special case for LOCAL_NET_ID: Networks on netId 99 are not generally
1221 // visible / usable for apps, so do not return it. Store the interface
1222 // index instead, so at least if the client tries to resolve the service
1223 // with that NsdServiceInfo, it will be done on the same interface.
1224 // If they recreate the NsdServiceInfo themselves, resolution would be
1225 // done on all interfaces as before T, which should also work.
1226 info.setNetwork(null);
1227 info.setInterfaceIndex(ifaceIdx);
1228 break;
1229 default:
1230 info.setNetwork(new Network(netId));
1231 }
1232 }
1233
paulhube186602022-04-12 07:18:23 +00001234 // The full service name is escaped from standard DNS rules on mdnsresponder, making it suitable
1235 // for passing to standard system DNS APIs such as res_query() . Thus, make the service name
1236 // unescape for getting right service address. See "Notes on DNS Name Escaping" on
1237 // external/mdnsresponder/mDNSShared/dns_sd.h for more details.
1238 private String unescape(String s) {
1239 StringBuilder sb = new StringBuilder(s.length());
1240 for (int i = 0; i < s.length(); ++i) {
1241 char c = s.charAt(i);
1242 if (c == '\\') {
1243 if (++i >= s.length()) {
1244 Log.e(TAG, "Unexpected end of escape sequence in: " + s);
1245 break;
1246 }
1247 c = s.charAt(i);
1248 if (c != '.' && c != '\\') {
1249 if (i + 2 >= s.length()) {
1250 Log.e(TAG, "Unexpected end of escape sequence in: " + s);
1251 break;
1252 }
1253 c = (char) ((c - '0') * 100 + (s.charAt(i + 1) - '0') * 10
1254 + (s.charAt(i + 2) - '0'));
1255 i += 2;
1256 }
1257 }
1258 sb.append(c);
1259 }
1260 return sb.toString();
1261 }
1262
Hugo Benichi803a2f02017-04-24 11:35:06 +09001263 @VisibleForTesting
paulhu2b9ed952022-02-10 21:58:32 +08001264 NsdService(Context ctx, Handler handler, long cleanupDelayMs) {
Paul Hu4bd98ef2023-01-12 13:42:07 +08001265 this(ctx, handler, cleanupDelayMs, new Dependencies());
1266 }
1267
1268 @VisibleForTesting
1269 NsdService(Context ctx, Handler handler, long cleanupDelayMs, Dependencies deps) {
Luke Huang05298582021-06-13 16:52:05 +00001270 mCleanupDelayMs = cleanupDelayMs;
Hugo Benichi803a2f02017-04-24 11:35:06 +09001271 mContext = ctx;
Hugo Benichi803a2f02017-04-24 11:35:06 +09001272 mNsdStateMachine = new NsdStateMachine(TAG, handler);
Irfan Sheriff75006652012-04-17 23:15:29 -07001273 mNsdStateMachine.start();
paulhu2b9ed952022-02-10 21:58:32 +08001274 mMDnsManager = ctx.getSystemService(MDnsManager.class);
1275 mMDnsEventCallback = new MDnsEventCallback(mNsdStateMachine);
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +09001276 mDeps = deps;
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001277
Remi NGUYEN VANa8a777b2023-01-18 18:57:41 +09001278 mMdnsSocketProvider = deps.makeMdnsSocketProvider(ctx, handler.getLooper());
1279 mMdnsSocketClient =
1280 new MdnsMultinetworkSocketClient(handler.getLooper(), mMdnsSocketProvider);
1281 mMdnsDiscoveryManager =
1282 deps.makeMdnsDiscoveryManager(new ExecutorProvider(), mMdnsSocketClient);
1283 handler.post(() -> mMdnsSocketClient.setCallback(mMdnsDiscoveryManager));
1284 mAdvertiser = deps.makeMdnsAdvertiser(handler.getLooper(), mMdnsSocketProvider,
1285 new AdvertiserCallback());
Paul Hu4bd98ef2023-01-12 13:42:07 +08001286 }
1287
1288 /**
1289 * Dependencies of NsdService, for injection in tests.
1290 */
1291 @VisibleForTesting
1292 public static class Dependencies {
1293 /**
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001294 * Check whether the MdnsDiscoveryManager feature is enabled.
Paul Hu4bd98ef2023-01-12 13:42:07 +08001295 *
1296 * @param context The global context information about an app environment.
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001297 * @return true if the MdnsDiscoveryManager feature is enabled.
Paul Hu4bd98ef2023-01-12 13:42:07 +08001298 */
1299 public boolean isMdnsDiscoveryManagerEnabled(Context context) {
1300 return DeviceConfigUtils.isFeatureEnabled(context, NAMESPACE_CONNECTIVITY,
1301 MDNS_DISCOVERY_MANAGER_VERSION, false /* defaultEnabled */);
1302 }
1303
1304 /**
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001305 * Check whether the MdnsAdvertiser feature is enabled.
1306 *
1307 * @param context The global context information about an app environment.
1308 * @return true if the MdnsAdvertiser feature is enabled.
1309 */
1310 public boolean isMdnsAdvertiserEnabled(Context context) {
1311 return DeviceConfigUtils.isFeatureEnabled(context, NAMESPACE_CONNECTIVITY,
1312 MDNS_ADVERTISER_VERSION, false /* defaultEnabled */);
1313 }
1314
1315 /**
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +09001316 * Get the type allowlist flag value.
1317 * @see #MDNS_TYPE_ALLOWLIST_FLAGS
1318 */
1319 @Nullable
1320 public String getTypeAllowlistFlags() {
1321 return DeviceConfigUtils.getDeviceConfigProperty(NAMESPACE_TETHERING,
1322 MDNS_TYPE_ALLOWLIST_FLAGS, null);
1323 }
1324
1325 /**
1326 * @see DeviceConfigUtils#isFeatureEnabled(Context, String, String, String, boolean)
1327 */
1328 public boolean isFeatureEnabled(Context context, String feature) {
1329 return DeviceConfigUtils.isFeatureEnabled(context, NAMESPACE_TETHERING,
1330 feature, DeviceConfigUtils.TETHERING_MODULE_NAME, false /* defaultEnabled */);
1331 }
1332
1333 /**
Paul Hu4bd98ef2023-01-12 13:42:07 +08001334 * @see MdnsDiscoveryManager
1335 */
1336 public MdnsDiscoveryManager makeMdnsDiscoveryManager(
1337 ExecutorProvider executorProvider, MdnsSocketClientBase socketClient) {
1338 return new MdnsDiscoveryManager(executorProvider, socketClient);
1339 }
1340
1341 /**
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001342 * @see MdnsAdvertiser
1343 */
1344 public MdnsAdvertiser makeMdnsAdvertiser(
1345 @NonNull Looper looper, @NonNull MdnsSocketProvider socketProvider,
1346 @NonNull MdnsAdvertiser.AdvertiserCallback cb) {
1347 return new MdnsAdvertiser(looper, socketProvider, cb);
1348 }
1349
1350 /**
Paul Hu4bd98ef2023-01-12 13:42:07 +08001351 * @see MdnsSocketProvider
1352 */
1353 public MdnsSocketProvider makeMdnsSocketProvider(Context context, Looper looper) {
1354 return new MdnsSocketProvider(context, looper);
1355 }
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001356 }
1357
Remi NGUYEN VAN151d0a52023-03-03 17:50:50 +09001358 /**
1359 * Return whether a type is allowlisted to use the Java backend.
1360 * @param type The service type
1361 * @param flagPrefix One of {@link #MDNS_ADVERTISER_ALLOWLIST_FLAG_PREFIX} or
1362 * {@link #MDNS_DISCOVERY_MANAGER_ALLOWLIST_FLAG_PREFIX}.
1363 */
1364 private boolean isTypeAllowlistedForJavaBackend(@Nullable String type,
1365 @NonNull String flagPrefix) {
1366 if (type == null) return false;
1367 final String typesConfig = mDeps.getTypeAllowlistFlags();
1368 if (TextUtils.isEmpty(typesConfig)) return false;
1369
1370 final String mappingPrefix = type + ":";
1371 String mappedFlag = null;
1372 for (String mapping : TextUtils.split(typesConfig, ",")) {
1373 if (mapping.startsWith(mappingPrefix)) {
1374 mappedFlag = mapping.substring(mappingPrefix.length());
1375 break;
1376 }
1377 }
1378
1379 if (mappedFlag == null) return false;
1380
1381 return mDeps.isFeatureEnabled(mContext,
1382 flagPrefix + mappedFlag + MDNS_ALLOWLIST_FLAG_SUFFIX);
1383 }
1384
1385 private boolean useDiscoveryManagerForType(@Nullable String type) {
1386 return isTypeAllowlistedForJavaBackend(type, MDNS_DISCOVERY_MANAGER_ALLOWLIST_FLAG_PREFIX);
1387 }
1388
1389 private boolean useAdvertiserForType(@Nullable String type) {
1390 return isTypeAllowlistedForJavaBackend(type, MDNS_ADVERTISER_ALLOWLIST_FLAG_PREFIX);
1391 }
1392
paulhu1b35e822022-04-08 14:48:41 +08001393 public static NsdService create(Context context) {
Hugo Benichi803a2f02017-04-24 11:35:06 +09001394 HandlerThread thread = new HandlerThread(TAG);
1395 thread.start();
1396 Handler handler = new Handler(thread.getLooper());
paulhu2b9ed952022-02-10 21:58:32 +08001397 NsdService service = new NsdService(context, handler, CLEANUP_DELAY_MS);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001398 return service;
1399 }
1400
paulhu2b9ed952022-02-10 21:58:32 +08001401 private static class MDnsEventCallback extends IMDnsEventListener.Stub {
1402 private final StateMachine mStateMachine;
1403
1404 MDnsEventCallback(StateMachine sm) {
1405 mStateMachine = sm;
1406 }
1407
1408 @Override
1409 public void onServiceRegistrationStatus(final RegistrationInfo status) {
1410 mStateMachine.sendMessage(
1411 MDNS_SERVICE_EVENT, status.result, status.id, status);
1412 }
1413
1414 @Override
1415 public void onServiceDiscoveryStatus(final DiscoveryInfo status) {
1416 mStateMachine.sendMessage(
1417 MDNS_SERVICE_EVENT, status.result, status.id, status);
1418 }
1419
1420 @Override
1421 public void onServiceResolutionStatus(final ResolutionInfo status) {
1422 mStateMachine.sendMessage(
1423 MDNS_SERVICE_EVENT, status.result, status.id, status);
1424 }
1425
1426 @Override
1427 public void onGettingServiceAddressStatus(final GetAddressInfo status) {
1428 mStateMachine.sendMessage(
1429 MDNS_SERVICE_EVENT, status.result, status.id, status);
1430 }
1431
1432 @Override
1433 public int getInterfaceVersion() throws RemoteException {
1434 return this.VERSION;
1435 }
1436
1437 @Override
1438 public String getInterfaceHash() throws RemoteException {
1439 return this.HASH;
1440 }
1441 }
1442
Remi NGUYEN VAN5b9074c2023-01-18 15:58:03 +09001443 private class AdvertiserCallback implements MdnsAdvertiser.AdvertiserCallback {
1444 @Override
1445 public void onRegisterServiceSucceeded(int serviceId, NsdServiceInfo registeredInfo) {
1446 final ClientInfo clientInfo = getClientInfoOrLog(serviceId);
1447 if (clientInfo == null) return;
1448
1449 final int clientId = getClientIdOrLog(clientInfo, serviceId);
1450 if (clientId < 0) return;
1451
1452 // onRegisterServiceSucceeded only has the service name in its info. This aligns with
1453 // historical behavior.
1454 final NsdServiceInfo cbInfo = new NsdServiceInfo(registeredInfo.getServiceName(), null);
1455 clientInfo.onRegisterServiceSucceeded(clientId, cbInfo);
1456 }
1457
1458 @Override
1459 public void onRegisterServiceFailed(int serviceId, int errorCode) {
1460 final ClientInfo clientInfo = getClientInfoOrLog(serviceId);
1461 if (clientInfo == null) return;
1462
1463 final int clientId = getClientIdOrLog(clientInfo, serviceId);
1464 if (clientId < 0) return;
1465
1466 clientInfo.onRegisterServiceFailed(clientId, errorCode);
1467 }
1468
1469 private ClientInfo getClientInfoOrLog(int serviceId) {
1470 final ClientInfo clientInfo = mIdToClientInfoMap.get(serviceId);
1471 if (clientInfo == null) {
1472 Log.e(TAG, String.format("Callback for service %d has no client", serviceId));
1473 }
1474 return clientInfo;
1475 }
1476
1477 private int getClientIdOrLog(@NonNull ClientInfo info, int serviceId) {
1478 final int clientId = info.getClientId(serviceId);
1479 if (clientId < 0) {
1480 Log.e(TAG, String.format("Client ID not found for service %d", serviceId));
1481 }
1482 return clientId;
1483 }
1484 }
1485
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001486 @Override
1487 public INsdServiceConnector connect(INsdManagerCallback cb) {
Hugo Benichi803a2f02017-04-24 11:35:06 +09001488 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.INTERNET, "NsdService");
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001489 final INsdServiceConnector connector = new NsdServiceConnector();
1490 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1491 NsdManager.REGISTER_CLIENT, new Pair<>(connector, cb)));
1492 return connector;
Irfan Sheriff75006652012-04-17 23:15:29 -07001493 }
1494
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001495 private static class ListenerArgs {
1496 public final NsdServiceConnector connector;
1497 public final NsdServiceInfo serviceInfo;
1498 ListenerArgs(NsdServiceConnector connector, NsdServiceInfo serviceInfo) {
1499 this.connector = connector;
1500 this.serviceInfo = serviceInfo;
1501 }
1502 }
1503
1504 private class NsdServiceConnector extends INsdServiceConnector.Stub
1505 implements IBinder.DeathRecipient {
1506 @Override
1507 public void registerService(int listenerKey, NsdServiceInfo serviceInfo) {
1508 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1509 NsdManager.REGISTER_SERVICE, 0, listenerKey,
1510 new ListenerArgs(this, serviceInfo)));
1511 }
1512
1513 @Override
1514 public void unregisterService(int listenerKey) {
1515 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1516 NsdManager.UNREGISTER_SERVICE, 0, listenerKey,
1517 new ListenerArgs(this, null)));
1518 }
1519
1520 @Override
1521 public void discoverServices(int listenerKey, NsdServiceInfo serviceInfo) {
1522 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1523 NsdManager.DISCOVER_SERVICES, 0, listenerKey,
1524 new ListenerArgs(this, serviceInfo)));
1525 }
1526
1527 @Override
1528 public void stopDiscovery(int listenerKey) {
1529 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1530 NsdManager.STOP_DISCOVERY, 0, listenerKey, new ListenerArgs(this, null)));
1531 }
1532
1533 @Override
1534 public void resolveService(int listenerKey, NsdServiceInfo serviceInfo) {
1535 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1536 NsdManager.RESOLVE_SERVICE, 0, listenerKey,
1537 new ListenerArgs(this, serviceInfo)));
1538 }
1539
1540 @Override
Paul Hub58deb72022-12-26 09:24:42 +00001541 public void stopResolution(int listenerKey) {
1542 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1543 NsdManager.STOP_RESOLUTION, 0, listenerKey, new ListenerArgs(this, null)));
1544 }
1545
1546 @Override
Paul Hu18aeccc2022-12-27 08:48:48 +00001547 public void registerServiceInfoCallback(int listenerKey, NsdServiceInfo serviceInfo) {
1548 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1549 NsdManager.REGISTER_SERVICE_CALLBACK, 0, listenerKey,
1550 new ListenerArgs(this, serviceInfo)));
1551 }
1552
1553 @Override
1554 public void unregisterServiceInfoCallback(int listenerKey) {
1555 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1556 NsdManager.UNREGISTER_SERVICE_CALLBACK, 0, listenerKey,
1557 new ListenerArgs(this, null)));
1558 }
1559
1560 @Override
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001561 public void startDaemon() {
1562 mNsdStateMachine.sendMessage(mNsdStateMachine.obtainMessage(
1563 NsdManager.DAEMON_STARTUP, new ListenerArgs(this, null)));
1564 }
1565
1566 @Override
1567 public void binderDied() {
1568 mNsdStateMachine.sendMessage(
1569 mNsdStateMachine.obtainMessage(NsdManager.UNREGISTER_CLIENT, this));
1570 }
Irfan Sheriff75006652012-04-17 23:15:29 -07001571 }
1572
Hugo Benichi912db992017-04-24 16:41:03 +09001573 private void sendNsdStateChangeBroadcast(boolean isEnabled) {
Irfan Sheriff52fc83a2012-04-19 10:26:34 -07001574 final Intent intent = new Intent(NsdManager.ACTION_NSD_STATE_CHANGED);
Irfan Sheriff75006652012-04-17 23:15:29 -07001575 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT);
Hugo Benichi912db992017-04-24 16:41:03 +09001576 int nsdState = isEnabled ? NsdManager.NSD_STATE_ENABLED : NsdManager.NSD_STATE_DISABLED;
1577 intent.putExtra(NsdManager.EXTRA_NSD_STATE, nsdState);
Dianne Hackborn692107e2012-08-29 18:32:08 -07001578 mContext.sendStickyBroadcastAsUser(intent, UserHandle.ALL);
Irfan Sheriff75006652012-04-17 23:15:29 -07001579 }
1580
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001581 private int getUniqueId() {
1582 if (++mUniqueId == INVALID_ID) return ++mUniqueId;
1583 return mUniqueId;
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001584 }
1585
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001586 private boolean registerService(int regId, NsdServiceInfo service) {
Hugo Benichi6d706442017-04-24 16:19:58 +09001587 if (DBG) {
paulhub2225702021-11-17 09:35:33 +08001588 Log.d(TAG, "registerService: " + regId + " " + service);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001589 }
Hugo Benichi6d706442017-04-24 16:19:58 +09001590 String name = service.getServiceName();
1591 String type = service.getServiceType();
1592 int port = service.getPort();
1593 byte[] textRecord = service.getTxtRecord();
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001594 final int registerInterface = getNetworkInterfaceIndex(service);
1595 if (service.getNetwork() != null && registerInterface == IFACE_IDX_ANY) {
Paul Hu360a8e92022-04-26 11:14:14 +08001596 Log.e(TAG, "Interface to register service on not found");
1597 return false;
1598 }
1599 return mMDnsManager.registerService(regId, name, type, port, textRecord, registerInterface);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001600 }
1601
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001602 private boolean unregisterService(int regId) {
paulhu2b9ed952022-02-10 21:58:32 +08001603 return mMDnsManager.stopOperation(regId);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001604 }
1605
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001606 private boolean discoverServices(int discoveryId, NsdServiceInfo serviceInfo) {
paulhu2b9ed952022-02-10 21:58:32 +08001607 final String type = serviceInfo.getServiceType();
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001608 final int discoverInterface = getNetworkInterfaceIndex(serviceInfo);
1609 if (serviceInfo.getNetwork() != null && discoverInterface == IFACE_IDX_ANY) {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001610 Log.e(TAG, "Interface to discover service on not found");
1611 return false;
1612 }
paulhu2b9ed952022-02-10 21:58:32 +08001613 return mMDnsManager.discover(discoveryId, type, discoverInterface);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001614 }
1615
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001616 private boolean stopServiceDiscovery(int discoveryId) {
paulhu2b9ed952022-02-10 21:58:32 +08001617 return mMDnsManager.stopOperation(discoveryId);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001618 }
1619
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001620 private boolean resolveService(int resolveId, NsdServiceInfo service) {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001621 final String name = service.getServiceName();
1622 final String type = service.getServiceType();
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001623 final int resolveInterface = getNetworkInterfaceIndex(service);
1624 if (service.getNetwork() != null && resolveInterface == IFACE_IDX_ANY) {
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001625 Log.e(TAG, "Interface to resolve service on not found");
1626 return false;
1627 }
paulhu2b9ed952022-02-10 21:58:32 +08001628 return mMDnsManager.resolve(resolveId, name, type, "local.", resolveInterface);
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001629 }
1630
1631 /**
1632 * Guess the interface to use to resolve or discover a service on a specific network.
1633 *
1634 * This is an imperfect guess, as for example the network may be gone or not yet fully
1635 * registered. This is fine as failing is correct if the network is gone, and a client
1636 * attempting to resolve/discover on a network not yet setup would have a bad time anyway; also
1637 * this is to support the legacy mdnsresponder implementation, which historically resolved
1638 * services on an unspecified network.
1639 */
Remi NGUYEN VAN1a8ee102022-05-30 12:42:24 +09001640 private int getNetworkInterfaceIndex(NsdServiceInfo serviceInfo) {
1641 final Network network = serviceInfo.getNetwork();
1642 if (network == null) {
1643 // Fallback to getInterfaceIndex if present (typically if the NsdServiceInfo was
1644 // provided by NsdService from discovery results, and the service was found on an
1645 // interface that has no app-usable Network).
1646 if (serviceInfo.getInterfaceIndex() != 0) {
1647 return serviceInfo.getInterfaceIndex();
1648 }
1649 return IFACE_IDX_ANY;
1650 }
Remi NGUYEN VAN23651302021-12-16 15:31:16 +09001651
1652 final ConnectivityManager cm = mContext.getSystemService(ConnectivityManager.class);
1653 if (cm == null) {
1654 Log.wtf(TAG, "No ConnectivityManager for resolveService");
1655 return IFACE_IDX_ANY;
1656 }
1657 final LinkProperties lp = cm.getLinkProperties(network);
1658 if (lp == null) return IFACE_IDX_ANY;
1659
1660 // Only resolve on non-stacked interfaces
1661 final NetworkInterface iface;
1662 try {
1663 iface = NetworkInterface.getByName(lp.getInterfaceName());
1664 } catch (SocketException e) {
1665 Log.e(TAG, "Error querying interface", e);
1666 return IFACE_IDX_ANY;
1667 }
1668
1669 if (iface == null) {
1670 Log.e(TAG, "Interface not found: " + lp.getInterfaceName());
1671 return IFACE_IDX_ANY;
1672 }
1673
1674 return iface.getIndex();
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001675 }
1676
1677 private boolean stopResolveService(int resolveId) {
paulhu2b9ed952022-02-10 21:58:32 +08001678 return mMDnsManager.stopOperation(resolveId);
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001679 }
1680
paulhu2b9ed952022-02-10 21:58:32 +08001681 private boolean getAddrInfo(int resolveId, String hostname, int interfaceIdx) {
1682 return mMDnsManager.getServiceAddress(resolveId, hostname, interfaceIdx);
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001683 }
1684
1685 private boolean stopGetAddrInfo(int resolveId) {
paulhu2b9ed952022-02-10 21:58:32 +08001686 return mMDnsManager.stopOperation(resolveId);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001687 }
1688
1689 @Override
Irfan Sheriff75006652012-04-17 23:15:29 -07001690 public void dump(FileDescriptor fd, PrintWriter pw, String[] args) {
paulhu3ffffe72021-09-16 10:15:22 +08001691 if (!PermissionUtils.checkDumpPermission(mContext, TAG, pw)) return;
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001692
Irfan Sheriff75006652012-04-17 23:15:29 -07001693 for (ClientInfo client : mClients.values()) {
1694 pw.println("Client Info");
1695 pw.println(client);
1696 }
1697
1698 mNsdStateMachine.dump(fd, pw, args);
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001699 }
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001700
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001701 private abstract static class ClientRequest {
1702 private final int mGlobalId;
1703
1704 private ClientRequest(int globalId) {
1705 mGlobalId = globalId;
1706 }
1707 }
1708
1709 private static class LegacyClientRequest extends ClientRequest {
1710 private final int mRequestCode;
1711
1712 private LegacyClientRequest(int globalId, int requestCode) {
1713 super(globalId);
1714 mRequestCode = requestCode;
1715 }
1716 }
1717
1718 private static class AdvertiserClientRequest extends ClientRequest {
1719 private AdvertiserClientRequest(int globalId) {
1720 super(globalId);
1721 }
1722 }
1723
1724 private static class DiscoveryManagerRequest extends ClientRequest {
1725 @NonNull
1726 private final MdnsListener mListener;
1727
1728 private DiscoveryManagerRequest(int globalId, @NonNull MdnsListener listener) {
1729 super(globalId);
1730 mListener = listener;
1731 }
1732 }
1733
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001734 /* Information tracked per client */
1735 private class ClientInfo {
1736
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001737 private static final int MAX_LIMIT = 10;
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001738 private final INsdManagerCallback mCb;
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001739 /* Remembers a resolved service until getaddrinfo completes */
Irfan Sheriffe4c42f42012-05-03 16:44:27 -07001740 private NsdServiceInfo mResolvedService;
1741
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001742 /* A map from client-side ID (listenerKey) to the request */
1743 private final SparseArray<ClientRequest> mClientRequests = new SparseArray<>();
Paul Hu23fa2022023-01-13 22:57:24 +08001744
Luke Huangf7277ed2021-07-12 21:15:10 +08001745 // The target SDK of this client < Build.VERSION_CODES.S
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001746 private boolean mIsPreSClient = false;
Luke Huangf7277ed2021-07-12 21:15:10 +08001747
Paul Hu18aeccc2022-12-27 08:48:48 +00001748 /*** The service that is registered to listen to its updates */
1749 private NsdServiceInfo mRegisteredService;
1750 /*** The client id that listen to updates */
1751 private int mClientIdForServiceUpdates;
1752
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001753 private ClientInfo(INsdManagerCallback cb) {
1754 mCb = cb;
paulhub2225702021-11-17 09:35:33 +08001755 if (DBG) Log.d(TAG, "New client");
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001756 }
Irfan Sheriff75006652012-04-17 23:15:29 -07001757
1758 @Override
1759 public String toString() {
Jeff Sharkey63465382020-10-17 21:20:13 -06001760 StringBuilder sb = new StringBuilder();
Irfan Sheriff75006652012-04-17 23:15:29 -07001761 sb.append("mResolvedService ").append(mResolvedService).append("\n");
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001762 sb.append("mIsLegacy ").append(mIsPreSClient).append("\n");
1763 for (int i = 0; i < mClientRequests.size(); i++) {
1764 int clientID = mClientRequests.keyAt(i);
1765 sb.append("clientId ")
1766 .append(clientID)
1767 .append(" mDnsId ").append(mClientRequests.valueAt(i).mGlobalId)
1768 .append(" type ").append(
1769 mClientRequests.valueAt(i).getClass().getSimpleName())
1770 .append("\n");
Irfan Sheriff75006652012-04-17 23:15:29 -07001771 }
1772 return sb.toString();
1773 }
Dave Plattfeff2af2014-03-07 14:48:22 -08001774
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001775 private boolean isPreSClient() {
1776 return mIsPreSClient;
Luke Huangf7277ed2021-07-12 21:15:10 +08001777 }
1778
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001779 private void setPreSClient() {
1780 mIsPreSClient = true;
Luke Huangf7277ed2021-07-12 21:15:10 +08001781 }
1782
Dave Plattfeff2af2014-03-07 14:48:22 -08001783 // Remove any pending requests from the global map when we get rid of a client,
1784 // and send cancellations to the daemon.
1785 private void expungeAllRequests() {
Hugo Benichid2552ae2017-04-11 14:42:47 +09001786 // TODO: to keep handler responsive, do not clean all requests for that client at once.
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001787 for (int i = 0; i < mClientRequests.size(); i++) {
1788 final int clientId = mClientRequests.keyAt(i);
1789 final ClientRequest request = mClientRequests.valueAt(i);
1790 final int globalId = request.mGlobalId;
Dave Plattfeff2af2014-03-07 14:48:22 -08001791 mIdToClientInfoMap.remove(globalId);
paulhub2225702021-11-17 09:35:33 +08001792 if (DBG) {
1793 Log.d(TAG, "Terminating client-ID " + clientId
1794 + " global-ID " + globalId + " type " + mClientRequests.get(clientId));
1795 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001796
1797 if (request instanceof DiscoveryManagerRequest) {
Ahmad Khalil4b8d45a2023-03-02 11:43:25 +00001798 final MdnsListener listener =
1799 ((DiscoveryManagerRequest) request).mListener;
1800 mMdnsDiscoveryManager.unregisterListener(
1801 listener.getListenedServiceType(), listener);
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001802 continue;
1803 }
1804
1805 if (request instanceof AdvertiserClientRequest) {
1806 mAdvertiser.removeService(globalId);
1807 continue;
1808 }
1809
1810 if (!(request instanceof LegacyClientRequest)) {
1811 throw new IllegalStateException("Unknown request type: " + request.getClass());
1812 }
1813
1814 switch (((LegacyClientRequest) request).mRequestCode) {
Dave Plattfeff2af2014-03-07 14:48:22 -08001815 case NsdManager.DISCOVER_SERVICES:
1816 stopServiceDiscovery(globalId);
1817 break;
1818 case NsdManager.RESOLVE_SERVICE:
1819 stopResolveService(globalId);
1820 break;
1821 case NsdManager.REGISTER_SERVICE:
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001822 unregisterService(globalId);
Dave Plattfeff2af2014-03-07 14:48:22 -08001823 break;
1824 default:
1825 break;
1826 }
1827 }
Dave Plattfeff2af2014-03-07 14:48:22 -08001828 mClientRequests.clear();
1829 }
1830
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001831 // mClientRequests is a sparse array of listener id -> ClientRequest. For a given
1832 // mDnsClient id, return the corresponding listener id. mDnsClient id is also called a
1833 // global id.
Christopher Lane74411222014-04-25 18:39:07 -07001834 private int getClientId(final int globalId) {
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001835 for (int i = 0; i < mClientRequests.size(); i++) {
1836 if (mClientRequests.valueAt(i).mGlobalId == globalId) {
1837 return mClientRequests.keyAt(i);
1838 }
Christopher Lane74411222014-04-25 18:39:07 -07001839 }
Remi NGUYEN VAN8f453b92023-01-18 17:44:36 +09001840 return -1;
Christopher Lane74411222014-04-25 18:39:07 -07001841 }
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001842
Paul Hu18aeccc2022-12-27 08:48:48 +00001843 private void maybeNotifyRegisteredServiceLost(@NonNull NsdServiceInfo info) {
1844 if (mRegisteredService == null) return;
1845 if (!Objects.equals(mRegisteredService.getServiceName(), info.getServiceName())) return;
1846 // Resolved services have a leading dot appended at the beginning of their type, but in
1847 // discovered info it's at the end
1848 if (!Objects.equals(
1849 mRegisteredService.getServiceType() + ".", "." + info.getServiceType())) {
1850 return;
1851 }
1852 onServiceUpdatedLost(mClientIdForServiceUpdates);
1853 }
1854
Remi NGUYEN VAN62eb76e2021-09-09 17:39:05 +09001855 void onDiscoverServicesStarted(int listenerKey, NsdServiceInfo info) {
1856 try {
1857 mCb.onDiscoverServicesStarted(listenerKey, info);
1858 } catch (RemoteException e) {
1859 Log.e(TAG, "Error calling onDiscoverServicesStarted", e);
1860 }
1861 }
1862
1863 void onDiscoverServicesFailed(int listenerKey, int error) {
1864 try {
1865 mCb.onDiscoverServicesFailed(listenerKey, error);
1866 } catch (RemoteException e) {
1867 Log.e(TAG, "Error calling onDiscoverServicesFailed", e);
1868 }
1869 }
1870
1871 void onServiceFound(int listenerKey, NsdServiceInfo info) {
1872 try {
1873 mCb.onServiceFound(listenerKey, info);
1874 } catch (RemoteException e) {
1875 Log.e(TAG, "Error calling onServiceFound(", e);
1876 }
1877 }
1878
1879 void onServiceLost(int listenerKey, NsdServiceInfo info) {
1880 try {
1881 mCb.onServiceLost(listenerKey, info);
1882 } catch (RemoteException e) {
1883 Log.e(TAG, "Error calling onServiceLost(", e);
1884 }
1885 }
1886
1887 void onStopDiscoveryFailed(int listenerKey, int error) {
1888 try {
1889 mCb.onStopDiscoveryFailed(listenerKey, error);
1890 } catch (RemoteException e) {
1891 Log.e(TAG, "Error calling onStopDiscoveryFailed", e);
1892 }
1893 }
1894
1895 void onStopDiscoverySucceeded(int listenerKey) {
1896 try {
1897 mCb.onStopDiscoverySucceeded(listenerKey);
1898 } catch (RemoteException e) {
1899 Log.e(TAG, "Error calling onStopDiscoverySucceeded", e);
1900 }
1901 }
1902
1903 void onRegisterServiceFailed(int listenerKey, int error) {
1904 try {
1905 mCb.onRegisterServiceFailed(listenerKey, error);
1906 } catch (RemoteException e) {
1907 Log.e(TAG, "Error calling onRegisterServiceFailed", e);
1908 }
1909 }
1910
1911 void onRegisterServiceSucceeded(int listenerKey, NsdServiceInfo info) {
1912 try {
1913 mCb.onRegisterServiceSucceeded(listenerKey, info);
1914 } catch (RemoteException e) {
1915 Log.e(TAG, "Error calling onRegisterServiceSucceeded", e);
1916 }
1917 }
1918
1919 void onUnregisterServiceFailed(int listenerKey, int error) {
1920 try {
1921 mCb.onUnregisterServiceFailed(listenerKey, error);
1922 } catch (RemoteException e) {
1923 Log.e(TAG, "Error calling onUnregisterServiceFailed", e);
1924 }
1925 }
1926
1927 void onUnregisterServiceSucceeded(int listenerKey) {
1928 try {
1929 mCb.onUnregisterServiceSucceeded(listenerKey);
1930 } catch (RemoteException e) {
1931 Log.e(TAG, "Error calling onUnregisterServiceSucceeded", e);
1932 }
1933 }
1934
1935 void onResolveServiceFailed(int listenerKey, int error) {
1936 try {
1937 mCb.onResolveServiceFailed(listenerKey, error);
1938 } catch (RemoteException e) {
1939 Log.e(TAG, "Error calling onResolveServiceFailed", e);
1940 }
1941 }
1942
1943 void onResolveServiceSucceeded(int listenerKey, NsdServiceInfo info) {
1944 try {
1945 mCb.onResolveServiceSucceeded(listenerKey, info);
1946 } catch (RemoteException e) {
1947 Log.e(TAG, "Error calling onResolveServiceSucceeded", e);
1948 }
1949 }
Paul Hub58deb72022-12-26 09:24:42 +00001950
1951 void onStopResolutionFailed(int listenerKey, int error) {
1952 try {
1953 mCb.onStopResolutionFailed(listenerKey, error);
1954 } catch (RemoteException e) {
1955 Log.e(TAG, "Error calling onStopResolutionFailed", e);
1956 }
1957 }
1958
1959 void onStopResolutionSucceeded(int listenerKey) {
1960 try {
1961 mCb.onStopResolutionSucceeded(listenerKey);
1962 } catch (RemoteException e) {
1963 Log.e(TAG, "Error calling onStopResolutionSucceeded", e);
1964 }
1965 }
Paul Hu18aeccc2022-12-27 08:48:48 +00001966
1967 void onServiceInfoCallbackRegistrationFailed(int listenerKey, int error) {
1968 try {
1969 mCb.onServiceInfoCallbackRegistrationFailed(listenerKey, error);
1970 } catch (RemoteException e) {
1971 Log.e(TAG, "Error calling onServiceInfoCallbackRegistrationFailed", e);
1972 }
1973 }
1974
1975 void onServiceUpdated(int listenerKey, NsdServiceInfo info) {
1976 try {
1977 mCb.onServiceUpdated(listenerKey, info);
1978 } catch (RemoteException e) {
1979 Log.e(TAG, "Error calling onServiceUpdated", e);
1980 }
1981 }
1982
1983 void onServiceUpdatedLost(int listenerKey) {
1984 try {
1985 mCb.onServiceUpdatedLost(listenerKey);
1986 } catch (RemoteException e) {
1987 Log.e(TAG, "Error calling onServiceUpdatedLost", e);
1988 }
1989 }
1990
1991 void onServiceInfoCallbackUnregistered(int listenerKey) {
1992 try {
1993 mCb.onServiceInfoCallbackUnregistered(listenerKey);
1994 } catch (RemoteException e) {
1995 Log.e(TAG, "Error calling onServiceInfoCallbackUnregistered", e);
1996 }
1997 }
Irfan Sheriffe8de2462012-04-11 14:52:19 -07001998 }
Irfan Sheriff77ec5582012-03-22 17:01:39 -07001999}