blob: 5ed9603793af097070816e52baa12602c048f71a [file] [log] [blame]
Steven Moreland5553ac42020-11-11 02:14:45 +00001/*
2 * Copyright (C) 2020 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Andrei Homescu9d8adb12022-08-02 04:38:30 +000017#include <aidl/IBinderRpcTest.h>
Frederick Maylea12b0962022-06-25 01:13:22 +000018#include <android-base/stringprintf.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000019
Steven Morelandc1635952021-04-01 16:20:47 +000020#include <chrono>
21#include <cstdlib>
22#include <iostream>
23#include <thread>
Steven Moreland659416d2021-05-11 00:47:50 +000024#include <type_traits>
Steven Morelandc1635952021-04-01 16:20:47 +000025
Andrei Homescu2a298012022-06-15 01:08:54 +000026#include <dlfcn.h>
Yifan Hong1deca4b2021-09-10 16:16:44 -070027#include <poll.h>
Steven Morelandc1635952021-04-01 16:20:47 +000028#include <sys/prctl.h>
Andrei Homescu992a4052022-06-28 21:26:18 +000029#include <sys/socket.h>
Steven Morelandc1635952021-04-01 16:20:47 +000030
Andrei Homescud65666d2023-03-03 07:28:02 +000031#ifdef BINDER_RPC_TO_TRUSTY_TEST
Andrei Homescu68a55612022-08-02 01:25:15 +000032#include <binder/RpcTransportTipcAndroid.h>
33#include <trusty/tipc.h>
Andrei Homescud65666d2023-03-03 07:28:02 +000034#endif // BINDER_RPC_TO_TRUSTY_TEST
Andrei Homescu68a55612022-08-02 01:25:15 +000035
Andrei Homescu2a298012022-06-15 01:08:54 +000036#include "binderRpcTestCommon.h"
Andrei Homescu96834632022-10-14 00:49:49 +000037#include "binderRpcTestFixture.h"
Steven Moreland5553ac42020-11-11 02:14:45 +000038
Yifan Hong1a235852021-05-13 16:07:47 -070039using namespace std::chrono_literals;
Yifan Hong67519322021-09-13 18:51:16 -070040using namespace std::placeholders;
Yifan Hong1deca4b2021-09-10 16:16:44 -070041using testing::AssertionFailure;
42using testing::AssertionResult;
43using testing::AssertionSuccess;
Yifan Hong1a235852021-05-13 16:07:47 -070044
Steven Moreland5553ac42020-11-11 02:14:45 +000045namespace android {
46
Andrei Homescu12106de2022-04-27 04:42:21 +000047#ifdef BINDER_TEST_NO_SHARED_LIBS
48constexpr bool kEnableSharedLibs = false;
49#else
50constexpr bool kEnableSharedLibs = true;
51#endif
52
Andrei Homescud65666d2023-03-03 07:28:02 +000053#ifdef BINDER_RPC_TO_TRUSTY_TEST
Andrei Homescu68a55612022-08-02 01:25:15 +000054constexpr char kTrustyIpcDevice[] = "/dev/trusty-ipc-dev0";
55#endif
56
Frederick Maylea12b0962022-06-25 01:13:22 +000057static std::string WaitStatusToString(int wstatus) {
58 if (WIFEXITED(wstatus)) {
59 return base::StringPrintf("exit status %d", WEXITSTATUS(wstatus));
60 }
61 if (WIFSIGNALED(wstatus)) {
62 return base::StringPrintf("term signal %d", WTERMSIG(wstatus));
63 }
64 return base::StringPrintf("unexpected state %d", wstatus);
65}
66
Steven Moreland276d8df2022-09-28 23:56:39 +000067static void debugBacktrace(pid_t pid) {
68 std::cerr << "TAKING BACKTRACE FOR PID " << pid << std::endl;
69 system((std::string("debuggerd -b ") + std::to_string(pid)).c_str());
70}
71
Steven Moreland5553ac42020-11-11 02:14:45 +000072class Process {
73public:
Andrei Homescu96834632022-10-14 00:49:49 +000074 Process(Process&& other)
75 : mCustomExitStatusCheck(std::move(other.mCustomExitStatusCheck)),
76 mReadEnd(std::move(other.mReadEnd)),
77 mWriteEnd(std::move(other.mWriteEnd)) {
78 // The default move constructor doesn't clear mPid after moving it,
79 // which we need to do because the destructor checks for mPid!=0
80 mPid = other.mPid;
81 other.mPid = 0;
82 }
Yifan Hong1deca4b2021-09-10 16:16:44 -070083 Process(const std::function<void(android::base::borrowed_fd /* writeEnd */,
84 android::base::borrowed_fd /* readEnd */)>& f) {
85 android::base::unique_fd childWriteEnd;
86 android::base::unique_fd childReadEnd;
Andrei Homescu2a298012022-06-15 01:08:54 +000087 CHECK(android::base::Pipe(&mReadEnd, &childWriteEnd, 0)) << strerror(errno);
88 CHECK(android::base::Pipe(&childReadEnd, &mWriteEnd, 0)) << strerror(errno);
Steven Moreland5553ac42020-11-11 02:14:45 +000089 if (0 == (mPid = fork())) {
90 // racey: assume parent doesn't crash before this is set
91 prctl(PR_SET_PDEATHSIG, SIGHUP);
92
Yifan Hong1deca4b2021-09-10 16:16:44 -070093 f(childWriteEnd, childReadEnd);
Steven Morelandaf4ca712021-05-24 23:22:08 +000094
95 exit(0);
Steven Moreland5553ac42020-11-11 02:14:45 +000096 }
97 }
98 ~Process() {
99 if (mPid != 0) {
Frederick Maylea12b0962022-06-25 01:13:22 +0000100 int wstatus;
101 waitpid(mPid, &wstatus, 0);
102 if (mCustomExitStatusCheck) {
103 mCustomExitStatusCheck(wstatus);
104 } else {
105 EXPECT_TRUE(WIFEXITED(wstatus) && WEXITSTATUS(wstatus) == 0)
106 << "server process failed: " << WaitStatusToString(wstatus);
107 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000108 }
109 }
Yifan Hong0f58fb92021-06-16 16:09:23 -0700110 android::base::borrowed_fd readEnd() { return mReadEnd; }
Yifan Hong1deca4b2021-09-10 16:16:44 -0700111 android::base::borrowed_fd writeEnd() { return mWriteEnd; }
Steven Moreland5553ac42020-11-11 02:14:45 +0000112
Frederick Maylea12b0962022-06-25 01:13:22 +0000113 void setCustomExitStatusCheck(std::function<void(int wstatus)> f) {
114 mCustomExitStatusCheck = std::move(f);
115 }
116
Frederick Mayle69a0c992022-05-26 20:38:39 +0000117 // Kill the process. Avoid if possible. Shutdown gracefully via an RPC instead.
118 void terminate() { kill(mPid, SIGTERM); }
119
Steven Moreland276d8df2022-09-28 23:56:39 +0000120 pid_t getPid() { return mPid; }
121
Steven Moreland5553ac42020-11-11 02:14:45 +0000122private:
Frederick Maylea12b0962022-06-25 01:13:22 +0000123 std::function<void(int wstatus)> mCustomExitStatusCheck;
Steven Moreland5553ac42020-11-11 02:14:45 +0000124 pid_t mPid = 0;
Yifan Hong0f58fb92021-06-16 16:09:23 -0700125 android::base::unique_fd mReadEnd;
Yifan Hong1deca4b2021-09-10 16:16:44 -0700126 android::base::unique_fd mWriteEnd;
Steven Moreland5553ac42020-11-11 02:14:45 +0000127};
128
129static std::string allocateSocketAddress() {
130 static size_t id = 0;
Steven Moreland4bfbf2e2021-04-14 22:15:16 +0000131 std::string temp = getenv("TMPDIR") ?: "/tmp";
Steven Morelanddfb05ad2023-03-07 17:00:53 +0000132 auto ret = temp + "/binderRpcTest_" + std::to_string(getpid()) + "_" + std::to_string(id++);
Yifan Hong1deca4b2021-09-10 16:16:44 -0700133 unlink(ret.c_str());
134 return ret;
Steven Moreland5553ac42020-11-11 02:14:45 +0000135};
136
Steven Morelandda573042021-06-12 01:13:45 +0000137static unsigned int allocateVsockPort() {
Andrei Homescu2a298012022-06-15 01:08:54 +0000138 static unsigned int vsockPort = 34567;
Steven Morelandda573042021-06-12 01:13:45 +0000139 return vsockPort++;
140}
141
Alice Wang893a9912022-10-24 10:44:09 +0000142static base::unique_fd initUnixSocket(std::string addr) {
143 auto socket_addr = UnixSocketAddress(addr.c_str());
144 base::unique_fd fd(
145 TEMP_FAILURE_RETRY(socket(socket_addr.addr()->sa_family, SOCK_STREAM, AF_UNIX)));
146 CHECK(fd.ok());
147 CHECK_EQ(0, TEMP_FAILURE_RETRY(bind(fd.get(), socket_addr.addr(), socket_addr.addrSize())));
148 return fd;
149}
150
Andrei Homescu96834632022-10-14 00:49:49 +0000151// Destructors need to be defined, even if pure virtual
152ProcessSession::~ProcessSession() {}
153
154class LinuxProcessSession : public ProcessSession {
155public:
Steven Moreland5553ac42020-11-11 02:14:45 +0000156 // reference to process hosting a socket server
157 Process host;
158
Andrei Homescu96834632022-10-14 00:49:49 +0000159 LinuxProcessSession(LinuxProcessSession&&) = default;
160 LinuxProcessSession(Process&& host) : host(std::move(host)) {}
161 ~LinuxProcessSession() override {
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000162 for (auto& session : sessions) {
163 session.root = nullptr;
Steven Moreland736664b2021-05-01 04:27:25 +0000164 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000165
Steven Moreland67f85902023-03-15 01:13:49 +0000166 for (size_t sessionNum = 0; sessionNum < sessions.size(); sessionNum++) {
167 auto& info = sessions.at(sessionNum);
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000168 sp<RpcSession>& session = info.session;
Steven Moreland736664b2021-05-01 04:27:25 +0000169
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000170 EXPECT_NE(nullptr, session);
171 EXPECT_NE(nullptr, session->state());
172 EXPECT_EQ(0, session->state()->countBinders()) << (session->state()->dump(), "dump:");
Steven Moreland736664b2021-05-01 04:27:25 +0000173
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000174 wp<RpcSession> weakSession = session;
175 session = nullptr;
Steven Moreland276d8df2022-09-28 23:56:39 +0000176
Steven Moreland57042712022-10-04 23:56:45 +0000177 // b/244325464 - 'getStrongCount' is printing '1' on failure here, which indicates the
178 // the object should not actually be promotable. By looping, we distinguish a race here
179 // from a bug causing the object to not be promotable.
180 for (size_t i = 0; i < 3; i++) {
181 sp<RpcSession> strongSession = weakSession.promote();
182 EXPECT_EQ(nullptr, strongSession)
Steven Moreland67f85902023-03-15 01:13:49 +0000183 << "For session " << sessionNum << ". "
Steven Moreland57042712022-10-04 23:56:45 +0000184 << (debugBacktrace(host.getPid()), debugBacktrace(getpid()),
185 "Leaked sess: ")
186 << strongSession->getStrongCount() << " checked time " << i;
187
188 if (strongSession != nullptr) {
189 sleep(1);
190 }
191 }
Steven Moreland736664b2021-05-01 04:27:25 +0000192 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000193 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000194
Andrei Homescu96834632022-10-14 00:49:49 +0000195 void setCustomExitStatusCheck(std::function<void(int wstatus)> f) override {
196 host.setCustomExitStatusCheck(std::move(f));
Steven Moreland5553ac42020-11-11 02:14:45 +0000197 }
Andrei Homescu96834632022-10-14 00:49:49 +0000198
199 void terminate() override { host.terminate(); }
Steven Moreland5553ac42020-11-11 02:14:45 +0000200};
201
Yifan Hong1deca4b2021-09-10 16:16:44 -0700202static base::unique_fd connectTo(const RpcSocketAddress& addr) {
Steven Moreland4198a122021-08-03 17:37:58 -0700203 base::unique_fd serverFd(
204 TEMP_FAILURE_RETRY(socket(addr.addr()->sa_family, SOCK_STREAM | SOCK_CLOEXEC, 0)));
205 int savedErrno = errno;
Yifan Hong1deca4b2021-09-10 16:16:44 -0700206 CHECK(serverFd.ok()) << "Could not create socket " << addr.toString() << ": "
207 << strerror(savedErrno);
Steven Moreland4198a122021-08-03 17:37:58 -0700208
209 if (0 != TEMP_FAILURE_RETRY(connect(serverFd.get(), addr.addr(), addr.addrSize()))) {
210 int savedErrno = errno;
Yifan Hong1deca4b2021-09-10 16:16:44 -0700211 LOG(FATAL) << "Could not connect to socket " << addr.toString() << ": "
212 << strerror(savedErrno);
Steven Moreland4198a122021-08-03 17:37:58 -0700213 }
214 return serverFd;
215}
216
Andrei Homescud65666d2023-03-03 07:28:02 +0000217#ifndef BINDER_RPC_TO_TRUSTY_TEST
David Brazdil21c887c2022-09-23 12:25:18 +0100218static base::unique_fd connectToUnixBootstrap(const RpcTransportFd& transportFd) {
219 base::unique_fd sockClient, sockServer;
220 if (!base::Socketpair(SOCK_STREAM, &sockClient, &sockServer)) {
221 int savedErrno = errno;
222 LOG(FATAL) << "Failed socketpair(): " << strerror(savedErrno);
223 }
224
225 int zero = 0;
226 iovec iov{&zero, sizeof(zero)};
227 std::vector<std::variant<base::unique_fd, base::borrowed_fd>> fds;
228 fds.emplace_back(std::move(sockServer));
229
230 if (sendMessageOnSocket(transportFd, &iov, 1, &fds) < 0) {
231 int savedErrno = errno;
232 LOG(FATAL) << "Failed sendMessageOnSocket: " << strerror(savedErrno);
233 }
234 return std::move(sockClient);
235}
Andrei Homescud65666d2023-03-03 07:28:02 +0000236#endif // BINDER_RPC_TO_TRUSTY_TEST
David Brazdil21c887c2022-09-23 12:25:18 +0100237
Andrei Homescuf30148c2023-03-10 00:31:45 +0000238std::unique_ptr<RpcTransportCtxFactory> BinderRpc::newFactory(RpcSecurity rpcSecurity) {
239 return newTlsFactory(rpcSecurity);
Andrei Homescu96834632022-10-14 00:49:49 +0000240}
Andrei Homescu2a298012022-06-15 01:08:54 +0000241
Andrei Homescu96834632022-10-14 00:49:49 +0000242// This creates a new process serving an interface on a certain number of
243// threads.
244std::unique_ptr<ProcessSession> BinderRpc::createRpcTestSocketServerProcessEtc(
245 const BinderRpcOptions& options) {
246 CHECK_GE(options.numSessions, 1) << "Must have at least one session to a server";
Frederick Mayle69a0c992022-05-26 20:38:39 +0000247
Steven Moreland67f85902023-03-15 01:13:49 +0000248 if (options.numIncomingConnectionsBySession.size() != 0) {
249 CHECK_EQ(options.numIncomingConnectionsBySession.size(), options.numSessions);
250 }
251
Steven Morelandb469f432023-07-28 22:13:47 +0000252 SocketType socketType = GetParam().type;
253 RpcSecurity rpcSecurity = GetParam().security;
254 uint32_t clientVersion = GetParam().clientVersion;
255 uint32_t serverVersion = GetParam().serverVersion;
256 bool singleThreaded = GetParam().singleThreaded;
257 bool noKernel = GetParam().noKernel;
Andrei Homescu96834632022-10-14 00:49:49 +0000258
259 std::string path = android::base::GetExecutableDirectory();
260 auto servicePath = android::base::StringPrintf("%s/binder_rpc_test_service%s%s", path.c_str(),
261 singleThreaded ? "_single_threaded" : "",
262 noKernel ? "_no_kernel" : "");
263
Alice Wang1ef010b2022-11-14 09:09:25 +0000264 base::unique_fd bootstrapClientFd, socketFd;
265
Alice Wang893a9912022-10-24 10:44:09 +0000266 auto addr = allocateSocketAddress();
267 // Initializes the socket before the fork/exec.
268 if (socketType == SocketType::UNIX_RAW) {
269 socketFd = initUnixSocket(addr);
Alice Wang1ef010b2022-11-14 09:09:25 +0000270 } else if (socketType == SocketType::UNIX_BOOTSTRAP) {
271 // Do not set O_CLOEXEC, bootstrapServerFd needs to survive fork/exec.
272 // This is because we cannot pass ParcelFileDescriptor over a pipe.
273 if (!base::Socketpair(SOCK_STREAM, &bootstrapClientFd, &socketFd)) {
274 int savedErrno = errno;
275 LOG(FATAL) << "Failed socketpair(): " << strerror(savedErrno);
276 }
Alice Wang893a9912022-10-24 10:44:09 +0000277 }
Andrei Homescua858b0e2022-08-01 23:43:09 +0000278
Andrei Homescu96834632022-10-14 00:49:49 +0000279 auto ret = std::make_unique<LinuxProcessSession>(
280 Process([=](android::base::borrowed_fd writeEnd, android::base::borrowed_fd readEnd) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000281 if (socketType == SocketType::TIPC) {
282 // Trusty has a single persistent service
283 return;
284 }
285
Andrei Homescu96834632022-10-14 00:49:49 +0000286 auto writeFd = std::to_string(writeEnd.get());
287 auto readFd = std::to_string(readEnd.get());
288 execl(servicePath.c_str(), servicePath.c_str(), writeFd.c_str(), readFd.c_str(),
289 NULL);
290 }));
291
292 BinderRpcTestServerConfig serverConfig;
293 serverConfig.numThreads = options.numThreads;
294 serverConfig.socketType = static_cast<int32_t>(socketType);
295 serverConfig.rpcSecurity = static_cast<int32_t>(rpcSecurity);
296 serverConfig.serverVersion = serverVersion;
297 serverConfig.vsockPort = allocateVsockPort();
Alice Wang893a9912022-10-24 10:44:09 +0000298 serverConfig.addr = addr;
Alice Wang893a9912022-10-24 10:44:09 +0000299 serverConfig.socketFd = socketFd.get();
Andrei Homescu96834632022-10-14 00:49:49 +0000300 for (auto mode : options.serverSupportedFileDescriptorTransportModes) {
301 serverConfig.serverSupportedFileDescriptorTransportModes.push_back(
302 static_cast<int32_t>(mode));
303 }
Andrei Homescu68a55612022-08-02 01:25:15 +0000304 if (socketType != SocketType::TIPC) {
305 writeToFd(ret->host.writeEnd(), serverConfig);
306 }
Andrei Homescu96834632022-10-14 00:49:49 +0000307
308 std::vector<sp<RpcSession>> sessions;
309 auto certVerifier = std::make_shared<RpcCertificateVerifierSimple>();
310 for (size_t i = 0; i < options.numSessions; i++) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000311 std::unique_ptr<RpcTransportCtxFactory> factory;
312 if (socketType == SocketType::TIPC) {
Andrei Homescud65666d2023-03-03 07:28:02 +0000313#ifdef BINDER_RPC_TO_TRUSTY_TEST
Andrei Homescu68a55612022-08-02 01:25:15 +0000314 factory = RpcTransportCtxFactoryTipcAndroid::make();
315#else
316 LOG_ALWAYS_FATAL("TIPC socket type only supported on vendor");
317#endif
318 } else {
Andrei Homescuf30148c2023-03-10 00:31:45 +0000319 factory = newTlsFactory(rpcSecurity, certVerifier);
Andrei Homescu68a55612022-08-02 01:25:15 +0000320 }
321 sessions.emplace_back(RpcSession::make(std::move(factory)));
David Brazdil21c887c2022-09-23 12:25:18 +0100322 }
323
Andrei Homescu68a55612022-08-02 01:25:15 +0000324 BinderRpcTestServerInfo serverInfo;
325 if (socketType != SocketType::TIPC) {
326 serverInfo = readFromFd<BinderRpcTestServerInfo>(ret->host.readEnd());
327 BinderRpcTestClientInfo clientInfo;
328 for (const auto& session : sessions) {
329 auto& parcelableCert = clientInfo.certs.emplace_back();
330 parcelableCert.data = session->getCertificate(RpcCertificateFormat::PEM);
331 }
332 writeToFd(ret->host.writeEnd(), clientInfo);
Andrei Homescu96834632022-10-14 00:49:49 +0000333
Andrei Homescu68a55612022-08-02 01:25:15 +0000334 CHECK_LE(serverInfo.port, std::numeric_limits<unsigned int>::max());
335 if (socketType == SocketType::INET) {
336 CHECK_NE(0, serverInfo.port);
337 }
Frederick Mayle69a0c992022-05-26 20:38:39 +0000338
Andrei Homescu68a55612022-08-02 01:25:15 +0000339 if (rpcSecurity == RpcSecurity::TLS) {
340 const auto& serverCert = serverInfo.cert.data;
341 CHECK_EQ(OK,
342 certVerifier->addTrustedPeerCertificate(RpcCertificateFormat::PEM,
343 serverCert));
344 }
Yifan Hong1deca4b2021-09-10 16:16:44 -0700345 }
346
Andrei Homescu96834632022-10-14 00:49:49 +0000347 status_t status;
Steven Moreland736664b2021-05-01 04:27:25 +0000348
Steven Moreland67f85902023-03-15 01:13:49 +0000349 for (size_t i = 0; i < sessions.size(); i++) {
350 const auto& session = sessions.at(i);
351
352 size_t numIncoming = options.numIncomingConnectionsBySession.size() > 0
353 ? options.numIncomingConnectionsBySession.at(i)
354 : 0;
355
Andrei Homescu96834632022-10-14 00:49:49 +0000356 CHECK(session->setProtocolVersion(clientVersion));
Steven Moreland67f85902023-03-15 01:13:49 +0000357 session->setMaxIncomingThreads(numIncoming);
Steven Morelandfeb13e82023-03-01 01:25:33 +0000358 session->setMaxOutgoingConnections(options.numOutgoingConnections);
Andrei Homescu96834632022-10-14 00:49:49 +0000359 session->setFileDescriptorTransportMode(options.clientFileDescriptorTransportMode);
Steven Morelandc1635952021-04-01 16:20:47 +0000360
Andrei Homescu96834632022-10-14 00:49:49 +0000361 switch (socketType) {
362 case SocketType::PRECONNECTED:
363 status = session->setupPreconnectedClient({}, [=]() {
364 return connectTo(UnixSocketAddress(serverConfig.addr.c_str()));
365 });
Frederick Mayle69a0c992022-05-26 20:38:39 +0000366 break;
Alice Wang893a9912022-10-24 10:44:09 +0000367 case SocketType::UNIX_RAW:
Andrei Homescu96834632022-10-14 00:49:49 +0000368 case SocketType::UNIX:
369 status = session->setupUnixDomainClient(serverConfig.addr.c_str());
370 break;
371 case SocketType::UNIX_BOOTSTRAP:
372 status = session->setupUnixDomainSocketBootstrapClient(
373 base::unique_fd(dup(bootstrapClientFd.get())));
374 break;
375 case SocketType::VSOCK:
376 status = session->setupVsockClient(VMADDR_CID_LOCAL, serverConfig.vsockPort);
377 break;
378 case SocketType::INET:
379 status = session->setupInetClient("127.0.0.1", serverInfo.port);
380 break;
Andrei Homescu68a55612022-08-02 01:25:15 +0000381 case SocketType::TIPC:
382 status = session->setupPreconnectedClient({}, [=]() {
Andrei Homescud65666d2023-03-03 07:28:02 +0000383#ifdef BINDER_RPC_TO_TRUSTY_TEST
Andrei Homescu68a55612022-08-02 01:25:15 +0000384 auto port = trustyIpcPort(serverVersion);
Andrei Homescu4bea21772023-03-21 23:28:33 +0000385 for (size_t i = 0; i < 5; i++) {
386 // Try to connect several times,
387 // in case the service is slow to start
388 int tipcFd = tipc_connect(kTrustyIpcDevice, port.c_str());
389 if (tipcFd >= 0) {
390 return android::base::unique_fd(tipcFd);
391 }
392 usleep(50000);
393 }
394 return android::base::unique_fd();
Andrei Homescu68a55612022-08-02 01:25:15 +0000395#else
396 LOG_ALWAYS_FATAL("Tried to connect to Trusty outside of vendor");
397 return android::base::unique_fd();
398#endif
399 });
400 break;
Andrei Homescu96834632022-10-14 00:49:49 +0000401 default:
402 LOG_ALWAYS_FATAL("Unknown socket type");
Steven Morelandc1635952021-04-01 16:20:47 +0000403 }
Andrei Homescu96834632022-10-14 00:49:49 +0000404 if (options.allowConnectFailure && status != OK) {
405 ret->sessions.clear();
406 break;
407 }
408 CHECK_EQ(status, OK) << "Could not connect: " << statusToString(status);
409 ret->sessions.push_back({session, session->getRootObject()});
Steven Morelandc1635952021-04-01 16:20:47 +0000410 }
Andrei Homescu96834632022-10-14 00:49:49 +0000411 return ret;
412}
Steven Morelandc1635952021-04-01 16:20:47 +0000413
Andrei Homescua858b0e2022-08-01 23:43:09 +0000414TEST_P(BinderRpc, ThreadPoolGreaterThanEqualRequested) {
415 if (clientOrServerSingleThreaded()) {
416 GTEST_SKIP() << "This test requires multiple threads";
417 }
418
Steven Moreland5553ac42020-11-11 02:14:45 +0000419 constexpr size_t kNumThreads = 10;
420
Steven Moreland4313d7e2021-07-15 23:41:22 +0000421 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumThreads});
Steven Moreland5553ac42020-11-11 02:14:45 +0000422
423 EXPECT_OK(proc.rootIface->lock());
424
425 // block all but one thread taking locks
426 std::vector<std::thread> ts;
427 for (size_t i = 0; i < kNumThreads - 1; i++) {
428 ts.push_back(std::thread([&] { proc.rootIface->lockUnlock(); }));
429 }
430
Steven Morelandd6d816f2022-12-23 01:37:17 +0000431 usleep(100000); // give chance for calls on other threads
Steven Moreland5553ac42020-11-11 02:14:45 +0000432
433 // other calls still work
434 EXPECT_EQ(OK, proc.rootBinder->pingBinder());
435
Steven Morelandd6d816f2022-12-23 01:37:17 +0000436 constexpr size_t blockTimeMs = 100;
Steven Moreland5553ac42020-11-11 02:14:45 +0000437 size_t epochMsBefore = epochMillis();
438 // after this, we should never see a response within this time
439 EXPECT_OK(proc.rootIface->unlockInMsAsync(blockTimeMs));
440
441 // this call should be blocked for blockTimeMs
442 EXPECT_EQ(OK, proc.rootBinder->pingBinder());
443
444 size_t epochMsAfter = epochMillis();
445 EXPECT_GE(epochMsAfter, epochMsBefore + blockTimeMs) << epochMsBefore;
446
447 for (auto& t : ts) t.join();
448}
449
Steven Moreland27f620a2023-03-06 19:44:36 +0000450static void testThreadPoolOverSaturated(sp<IBinderRpcTest> iface, size_t numCalls, size_t sleepMs) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000451 size_t epochMsBefore = epochMillis();
452
453 std::vector<std::thread> ts;
Yifan Hong1f44f982021-10-08 17:16:47 -0700454 for (size_t i = 0; i < numCalls; i++) {
455 ts.push_back(std::thread([&] { iface->sleepMs(sleepMs); }));
Steven Moreland5553ac42020-11-11 02:14:45 +0000456 }
457
458 for (auto& t : ts) t.join();
459
460 size_t epochMsAfter = epochMillis();
461
Yifan Hong1f44f982021-10-08 17:16:47 -0700462 EXPECT_GE(epochMsAfter, epochMsBefore + 2 * sleepMs);
Steven Moreland5553ac42020-11-11 02:14:45 +0000463
Steven Moreland9c203222023-05-31 21:26:41 +0000464 // Potential flake, but make sure calls are handled in parallel. Due
465 // to past flakes, this only checks that the amount of time taken has
466 // some parallelism. Other tests such as ThreadPoolGreaterThanEqualRequested
467 // check this more exactly.
468 EXPECT_LE(epochMsAfter, epochMsBefore + (numCalls - 1) * sleepMs);
Yifan Hong1f44f982021-10-08 17:16:47 -0700469}
470
Andrei Homescua858b0e2022-08-01 23:43:09 +0000471TEST_P(BinderRpc, ThreadPoolOverSaturated) {
472 if (clientOrServerSingleThreaded()) {
473 GTEST_SKIP() << "This test requires multiple threads";
474 }
475
Yifan Hong1f44f982021-10-08 17:16:47 -0700476 constexpr size_t kNumThreads = 10;
477 constexpr size_t kNumCalls = kNumThreads + 3;
478 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumThreads});
Steven Moreland73aa6f82023-03-15 21:49:07 +0000479
480 // b/272429574 - below 500ms, the test fails
481 testThreadPoolOverSaturated(proc.rootIface, kNumCalls, 500 /*ms*/);
Yifan Hong1f44f982021-10-08 17:16:47 -0700482}
483
Andrei Homescua858b0e2022-08-01 23:43:09 +0000484TEST_P(BinderRpc, ThreadPoolLimitOutgoing) {
485 if (clientOrServerSingleThreaded()) {
486 GTEST_SKIP() << "This test requires multiple threads";
487 }
488
Yifan Hong1f44f982021-10-08 17:16:47 -0700489 constexpr size_t kNumThreads = 20;
490 constexpr size_t kNumOutgoingConnections = 10;
491 constexpr size_t kNumCalls = kNumOutgoingConnections + 3;
492 auto proc = createRpcTestSocketServerProcess(
493 {.numThreads = kNumThreads, .numOutgoingConnections = kNumOutgoingConnections});
Steven Moreland73aa6f82023-03-15 21:49:07 +0000494
495 // b/272429574 - below 500ms, the test fails
496 testThreadPoolOverSaturated(proc.rootIface, kNumCalls, 500 /*ms*/);
Steven Moreland5553ac42020-11-11 02:14:45 +0000497}
498
Andrei Homescua858b0e2022-08-01 23:43:09 +0000499TEST_P(BinderRpc, ThreadingStressTest) {
500 if (clientOrServerSingleThreaded()) {
501 GTEST_SKIP() << "This test requires multiple threads";
502 }
503
Steven Moreland27f620a2023-03-06 19:44:36 +0000504 constexpr size_t kNumClientThreads = 5;
505 constexpr size_t kNumServerThreads = 5;
506 constexpr size_t kNumCalls = 50;
Steven Moreland5553ac42020-11-11 02:14:45 +0000507
Steven Moreland4313d7e2021-07-15 23:41:22 +0000508 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumServerThreads});
Steven Moreland5553ac42020-11-11 02:14:45 +0000509
510 std::vector<std::thread> threads;
511 for (size_t i = 0; i < kNumClientThreads; i++) {
512 threads.push_back(std::thread([&] {
513 for (size_t j = 0; j < kNumCalls; j++) {
514 sp<IBinder> out;
Steven Morelandc6046982021-04-20 00:49:42 +0000515 EXPECT_OK(proc.rootIface->repeatBinder(proc.rootBinder, &out));
Steven Moreland5553ac42020-11-11 02:14:45 +0000516 EXPECT_EQ(proc.rootBinder, out);
517 }
518 }));
519 }
520
521 for (auto& t : threads) t.join();
522}
523
Steven Moreland925ba0a2021-09-17 18:06:32 -0700524static void saturateThreadPool(size_t threadCount, const sp<IBinderRpcTest>& iface) {
525 std::vector<std::thread> threads;
526 for (size_t i = 0; i < threadCount; i++) {
527 threads.push_back(std::thread([&] { EXPECT_OK(iface->sleepMs(500)); }));
528 }
529 for (auto& t : threads) t.join();
530}
531
Andrei Homescua858b0e2022-08-01 23:43:09 +0000532TEST_P(BinderRpc, OnewayStressTest) {
533 if (clientOrServerSingleThreaded()) {
534 GTEST_SKIP() << "This test requires multiple threads";
535 }
536
Steven Morelandc6046982021-04-20 00:49:42 +0000537 constexpr size_t kNumClientThreads = 10;
538 constexpr size_t kNumServerThreads = 10;
Steven Moreland3c3ab8d2021-09-23 10:29:50 -0700539 constexpr size_t kNumCalls = 1000;
Steven Morelandc6046982021-04-20 00:49:42 +0000540
Steven Moreland4313d7e2021-07-15 23:41:22 +0000541 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumServerThreads});
Steven Morelandc6046982021-04-20 00:49:42 +0000542
543 std::vector<std::thread> threads;
544 for (size_t i = 0; i < kNumClientThreads; i++) {
545 threads.push_back(std::thread([&] {
546 for (size_t j = 0; j < kNumCalls; j++) {
547 EXPECT_OK(proc.rootIface->sendString("a"));
548 }
Steven Morelandc6046982021-04-20 00:49:42 +0000549 }));
550 }
551
552 for (auto& t : threads) t.join();
Steven Moreland925ba0a2021-09-17 18:06:32 -0700553
554 saturateThreadPool(kNumServerThreads, proc.rootIface);
Steven Morelandc6046982021-04-20 00:49:42 +0000555}
556
Frederick Mayleb0221d12022-10-03 23:10:53 +0000557TEST_P(BinderRpc, OnewayCallQueueingWithFds) {
558 if (!supportsFdTransport()) {
559 GTEST_SKIP() << "Would fail trivially (which is tested elsewhere)";
560 }
561 if (clientOrServerSingleThreaded()) {
562 GTEST_SKIP() << "This test requires multiple threads";
563 }
564
Andrei Homescu5f2bc562023-02-25 04:59:43 +0000565 constexpr size_t kNumServerThreads = 3;
566
Frederick Mayleb0221d12022-10-03 23:10:53 +0000567 // This test forces a oneway transaction to be queued by issuing two
568 // `blockingSendFdOneway` calls, then drains the queue by issuing two
569 // `blockingRecvFd` calls.
570 //
571 // For more details about the queuing semantics see
572 // https://developer.android.com/reference/android/os/IBinder#FLAG_ONEWAY
573
574 auto proc = createRpcTestSocketServerProcess({
Andrei Homescu5f2bc562023-02-25 04:59:43 +0000575 .numThreads = kNumServerThreads,
Frederick Mayleb0221d12022-10-03 23:10:53 +0000576 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
577 .serverSupportedFileDescriptorTransportModes =
578 {RpcSession::FileDescriptorTransportMode::UNIX},
579 });
580
581 EXPECT_OK(proc.rootIface->blockingSendFdOneway(
582 android::os::ParcelFileDescriptor(mockFileDescriptor("a"))));
583 EXPECT_OK(proc.rootIface->blockingSendFdOneway(
584 android::os::ParcelFileDescriptor(mockFileDescriptor("b"))));
585
586 android::os::ParcelFileDescriptor fdA;
587 EXPECT_OK(proc.rootIface->blockingRecvFd(&fdA));
588 std::string result;
589 CHECK(android::base::ReadFdToString(fdA.get(), &result));
590 EXPECT_EQ(result, "a");
591
592 android::os::ParcelFileDescriptor fdB;
593 EXPECT_OK(proc.rootIface->blockingRecvFd(&fdB));
594 CHECK(android::base::ReadFdToString(fdB.get(), &result));
595 EXPECT_EQ(result, "b");
Andrei Homescu5f2bc562023-02-25 04:59:43 +0000596
597 saturateThreadPool(kNumServerThreads, proc.rootIface);
Frederick Mayleb0221d12022-10-03 23:10:53 +0000598}
599
Andrei Homescua858b0e2022-08-01 23:43:09 +0000600TEST_P(BinderRpc, OnewayCallQueueing) {
601 if (clientOrServerSingleThreaded()) {
602 GTEST_SKIP() << "This test requires multiple threads";
603 }
604
Frederick Mayle96872592023-03-07 14:56:15 -0800605 constexpr size_t kNumQueued = 10;
Steven Moreland5553ac42020-11-11 02:14:45 +0000606 constexpr size_t kNumExtraServerThreads = 4;
Steven Moreland5553ac42020-11-11 02:14:45 +0000607
608 // make sure calls to the same object happen on the same thread
Steven Moreland4313d7e2021-07-15 23:41:22 +0000609 auto proc = createRpcTestSocketServerProcess({.numThreads = 1 + kNumExtraServerThreads});
Steven Moreland5553ac42020-11-11 02:14:45 +0000610
Frederick Mayle96872592023-03-07 14:56:15 -0800611 // all these *Oneway commands should be queued on the server sequentially,
Steven Moreland1c678802021-09-17 16:48:47 -0700612 // even though there are multiple threads.
Frederick Mayle96872592023-03-07 14:56:15 -0800613 for (size_t i = 0; i + 1 < kNumQueued; i++) {
614 proc.rootIface->blockingSendIntOneway(i);
Steven Moreland5553ac42020-11-11 02:14:45 +0000615 }
Frederick Mayle96872592023-03-07 14:56:15 -0800616 for (size_t i = 0; i + 1 < kNumQueued; i++) {
617 int n;
618 proc.rootIface->blockingRecvInt(&n);
619 EXPECT_EQ(n, i);
620 }
Steven Morelandf5174272021-05-25 00:39:28 +0000621
Steven Moreland925ba0a2021-09-17 18:06:32 -0700622 saturateThreadPool(1 + kNumExtraServerThreads, proc.rootIface);
Steven Moreland5553ac42020-11-11 02:14:45 +0000623}
624
Andrei Homescua858b0e2022-08-01 23:43:09 +0000625TEST_P(BinderRpc, OnewayCallExhaustion) {
626 if (clientOrServerSingleThreaded()) {
627 GTEST_SKIP() << "This test requires multiple threads";
628 }
629
Steven Morelandd45be622021-06-04 02:19:37 +0000630 constexpr size_t kNumClients = 2;
631 constexpr size_t kTooLongMs = 1000;
632
Steven Moreland4313d7e2021-07-15 23:41:22 +0000633 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumClients, .numSessions = 2});
Steven Morelandd45be622021-06-04 02:19:37 +0000634
635 // Build up oneway calls on the second session to make sure it terminates
636 // and shuts down. The first session should be unaffected (proc destructor
637 // checks the first session).
Andrei Homescu96834632022-10-14 00:49:49 +0000638 auto iface = interface_cast<IBinderRpcTest>(proc.proc->sessions.at(1).root);
Steven Morelandd45be622021-06-04 02:19:37 +0000639
640 std::vector<std::thread> threads;
641 for (size_t i = 0; i < kNumClients; i++) {
642 // one of these threads will get stuck queueing a transaction once the
643 // socket fills up, the other will be able to fill up transactions on
644 // this object
645 threads.push_back(std::thread([&] {
646 while (iface->sleepMsAsync(kTooLongMs).isOk()) {
647 }
648 }));
649 }
650 for (auto& t : threads) t.join();
651
652 Status status = iface->sleepMsAsync(kTooLongMs);
653 EXPECT_EQ(DEAD_OBJECT, status.transactionError()) << status;
654
Steven Moreland798e0d12021-07-14 23:19:25 +0000655 // now that it has died, wait for the remote session to shutdown
656 std::vector<int32_t> remoteCounts;
657 do {
658 EXPECT_OK(proc.rootIface->countBinders(&remoteCounts));
659 } while (remoteCounts.size() == kNumClients);
660
Steven Morelandd45be622021-06-04 02:19:37 +0000661 // the second session should be shutdown in the other process by the time we
662 // are able to join above (it'll only be hung up once it finishes processing
663 // any pending commands). We need to erase this session from the record
664 // here, so that the destructor for our session won't check that this
665 // session is valid, but we still want it to test the other session.
Andrei Homescu96834632022-10-14 00:49:49 +0000666 proc.proc->sessions.erase(proc.proc->sessions.begin() + 1);
Steven Morelandd45be622021-06-04 02:19:37 +0000667}
668
Steven Moreland67f85902023-03-15 01:13:49 +0000669TEST_P(BinderRpc, SessionWithIncomingThreadpoolDoesntLeak) {
670 if (clientOrServerSingleThreaded()) {
671 GTEST_SKIP() << "This test requires multiple threads";
672 }
673
674 // session 0 - will check for leaks in destrutor of proc
675 // session 1 - we want to make sure it gets deleted when we drop all references to it
676 auto proc = createRpcTestSocketServerProcess(
677 {.numThreads = 1, .numIncomingConnectionsBySession = {0, 1}, .numSessions = 2});
678
679 wp<RpcSession> session = proc.proc->sessions.at(1).session;
680
681 // remove all references to the second session
682 proc.proc->sessions.at(1).root = nullptr;
683 proc.proc->sessions.erase(proc.proc->sessions.begin() + 1);
684
685 // TODO(b/271830568) more efficient way to wait for other incoming threadpool
686 // to drain commands.
687 for (size_t i = 0; i < 100; i++) {
688 usleep(10 * 1000);
689 if (session.promote() == nullptr) break;
690 }
691
692 EXPECT_EQ(nullptr, session.promote());
Steven Morelandb5d2b642023-05-04 00:31:45 +0000693
Steven Moreland0ebdaad2023-06-14 19:33:37 +0000694 // now that it has died, wait for the remote session to shutdown
695 std::vector<int32_t> remoteCounts;
696 do {
697 EXPECT_OK(proc.rootIface->countBinders(&remoteCounts));
698 } while (remoteCounts.size() > 1);
Steven Moreland67f85902023-03-15 01:13:49 +0000699}
700
Devin Moore66d5b7a2022-07-07 21:42:10 +0000701TEST_P(BinderRpc, SingleDeathRecipient) {
Andrei Homescua858b0e2022-08-01 23:43:09 +0000702 if (clientOrServerSingleThreaded()) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000703 GTEST_SKIP() << "This test requires multiple threads";
704 }
705 class MyDeathRec : public IBinder::DeathRecipient {
706 public:
707 void binderDied(const wp<IBinder>& /* who */) override {
708 dead = true;
709 mCv.notify_one();
710 }
711 std::mutex mMtx;
712 std::condition_variable mCv;
713 bool dead = false;
714 };
715
716 // Death recipient needs to have an incoming connection to be called
717 auto proc = createRpcTestSocketServerProcess(
Steven Moreland67f85902023-03-15 01:13:49 +0000718 {.numThreads = 1, .numSessions = 1, .numIncomingConnectionsBySession = {1}});
Devin Moore66d5b7a2022-07-07 21:42:10 +0000719
720 auto dr = sp<MyDeathRec>::make();
721 ASSERT_EQ(OK, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
722
723 if (auto status = proc.rootIface->scheduleShutdown(); !status.isOk()) {
724 EXPECT_EQ(DEAD_OBJECT, status.transactionError()) << status;
725 }
726
727 std::unique_lock<std::mutex> lock(dr->mMtx);
Steven Morelanddd231e22022-09-08 19:47:49 +0000728 ASSERT_TRUE(dr->mCv.wait_for(lock, 100ms, [&]() { return dr->dead; }));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000729
730 // need to wait for the session to shutdown so we don't "Leak session"
Steven Moreland67f85902023-03-15 01:13:49 +0000731 // can't do this before checking the death recipient by calling
732 // forceShutdown earlier, because shutdownAndWait will also trigger
733 // a death recipient, but if we had a way to wait for the service
734 // to gracefully shutdown, we could use that here.
Andrei Homescu96834632022-10-14 00:49:49 +0000735 EXPECT_TRUE(proc.proc->sessions.at(0).session->shutdownAndWait(true));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000736 proc.expectAlreadyShutdown = true;
737}
738
739TEST_P(BinderRpc, SingleDeathRecipientOnShutdown) {
Andrei Homescua858b0e2022-08-01 23:43:09 +0000740 if (clientOrServerSingleThreaded()) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000741 GTEST_SKIP() << "This test requires multiple threads";
742 }
743 class MyDeathRec : public IBinder::DeathRecipient {
744 public:
745 void binderDied(const wp<IBinder>& /* who */) override {
746 dead = true;
747 mCv.notify_one();
748 }
749 std::mutex mMtx;
750 std::condition_variable mCv;
751 bool dead = false;
752 };
753
754 // Death recipient needs to have an incoming connection to be called
755 auto proc = createRpcTestSocketServerProcess(
Steven Moreland67f85902023-03-15 01:13:49 +0000756 {.numThreads = 1, .numSessions = 1, .numIncomingConnectionsBySession = {1}});
Devin Moore66d5b7a2022-07-07 21:42:10 +0000757
758 auto dr = sp<MyDeathRec>::make();
759 EXPECT_EQ(OK, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
760
761 // Explicitly calling shutDownAndWait will cause the death recipients
762 // to be called.
Andrei Homescu96834632022-10-14 00:49:49 +0000763 EXPECT_TRUE(proc.proc->sessions.at(0).session->shutdownAndWait(true));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000764
765 std::unique_lock<std::mutex> lock(dr->mMtx);
766 if (!dr->dead) {
Steven Morelanddd231e22022-09-08 19:47:49 +0000767 EXPECT_EQ(std::cv_status::no_timeout, dr->mCv.wait_for(lock, 100ms));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000768 }
769 EXPECT_TRUE(dr->dead) << "Failed to receive the death notification.";
770
Andrei Homescu96834632022-10-14 00:49:49 +0000771 proc.proc->terminate();
772 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000773 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGTERM)
774 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
775 });
776 proc.expectAlreadyShutdown = true;
777}
778
Steven Moreland5ec743f2023-01-18 01:02:06 +0000779TEST_P(BinderRpc, DeathRecipientFailsWithoutIncoming) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000780 if (socketType() == SocketType::TIPC) {
781 // This should work, but Trusty takes too long to restart the service
782 GTEST_SKIP() << "Service death test not supported on Trusty";
783 }
Devin Moore66d5b7a2022-07-07 21:42:10 +0000784 class MyDeathRec : public IBinder::DeathRecipient {
785 public:
786 void binderDied(const wp<IBinder>& /* who */) override {}
787 };
788
Steven Moreland67f85902023-03-15 01:13:49 +0000789 auto proc = createRpcTestSocketServerProcess({.numThreads = 1, .numSessions = 1});
Devin Moore66d5b7a2022-07-07 21:42:10 +0000790
791 auto dr = sp<MyDeathRec>::make();
Steven Moreland5ec743f2023-01-18 01:02:06 +0000792 EXPECT_EQ(INVALID_OPERATION, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000793}
794
795TEST_P(BinderRpc, UnlinkDeathRecipient) {
Andrei Homescua858b0e2022-08-01 23:43:09 +0000796 if (clientOrServerSingleThreaded()) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000797 GTEST_SKIP() << "This test requires multiple threads";
798 }
799 class MyDeathRec : public IBinder::DeathRecipient {
800 public:
801 void binderDied(const wp<IBinder>& /* who */) override {
802 GTEST_FAIL() << "This should not be called after unlinkToDeath";
803 }
804 };
805
806 // Death recipient needs to have an incoming connection to be called
807 auto proc = createRpcTestSocketServerProcess(
Steven Moreland67f85902023-03-15 01:13:49 +0000808 {.numThreads = 1, .numSessions = 1, .numIncomingConnectionsBySession = {1}});
Devin Moore66d5b7a2022-07-07 21:42:10 +0000809
810 auto dr = sp<MyDeathRec>::make();
811 ASSERT_EQ(OK, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
812 ASSERT_EQ(OK, proc.rootBinder->unlinkToDeath(dr, (void*)1, 0, nullptr));
813
Steven Moreland67f85902023-03-15 01:13:49 +0000814 proc.forceShutdown();
Devin Moore66d5b7a2022-07-07 21:42:10 +0000815}
816
Steven Morelandc1635952021-04-01 16:20:47 +0000817TEST_P(BinderRpc, Die) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000818 if (socketType() == SocketType::TIPC) {
819 // This should work, but Trusty takes too long to restart the service
820 GTEST_SKIP() << "Service death test not supported on Trusty";
821 }
822
Steven Moreland5553ac42020-11-11 02:14:45 +0000823 for (bool doDeathCleanup : {true, false}) {
Steven Moreland4313d7e2021-07-15 23:41:22 +0000824 auto proc = createRpcTestSocketServerProcess({});
Steven Moreland5553ac42020-11-11 02:14:45 +0000825
826 // make sure there is some state during crash
827 // 1. we hold their binder
828 sp<IBinderRpcSession> session;
829 EXPECT_OK(proc.rootIface->openSession("happy", &session));
830 // 2. they hold our binder
831 sp<IBinder> binder = new BBinder();
832 EXPECT_OK(proc.rootIface->holdBinder(binder));
833
834 EXPECT_EQ(DEAD_OBJECT, proc.rootIface->die(doDeathCleanup).transactionError())
835 << "Do death cleanup: " << doDeathCleanup;
836
Andrei Homescu96834632022-10-14 00:49:49 +0000837 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Maylea12b0962022-06-25 01:13:22 +0000838 EXPECT_TRUE(WIFEXITED(wstatus) && WEXITSTATUS(wstatus) == 1)
839 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
840 });
Steven Morelandaf4ca712021-05-24 23:22:08 +0000841 proc.expectAlreadyShutdown = true;
Steven Moreland5553ac42020-11-11 02:14:45 +0000842 }
843}
844
Steven Morelandd7302072021-05-15 01:32:04 +0000845TEST_P(BinderRpc, UseKernelBinderCallingId) {
Andrei Homescu2a298012022-06-15 01:08:54 +0000846 // This test only works if the current process shared the internal state of
847 // ProcessState with the service across the call to fork(). Both the static
848 // libraries and libbinder.so have their own separate copies of all the
849 // globals, so the test only works when the test client and service both use
850 // libbinder.so (when using static libraries, even a client and service
851 // using the same kind of static library should have separate copies of the
852 // variables).
Andrei Homescua858b0e2022-08-01 23:43:09 +0000853 if (!kEnableSharedLibs || serverSingleThreaded() || noKernel()) {
Andrei Homescu12106de2022-04-27 04:42:21 +0000854 GTEST_SKIP() << "Test disabled because Binder kernel driver was disabled "
855 "at build time.";
856 }
857
Steven Moreland4313d7e2021-07-15 23:41:22 +0000858 auto proc = createRpcTestSocketServerProcess({});
Steven Morelandd7302072021-05-15 01:32:04 +0000859
Andrei Homescu2a298012022-06-15 01:08:54 +0000860 // we can't allocate IPCThreadState so actually the first time should
861 // succeed :(
862 EXPECT_OK(proc.rootIface->useKernelBinderCallingId());
Steven Morelandd7302072021-05-15 01:32:04 +0000863
864 // second time! we catch the error :)
865 EXPECT_EQ(DEAD_OBJECT, proc.rootIface->useKernelBinderCallingId().transactionError());
866
Andrei Homescu96834632022-10-14 00:49:49 +0000867 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Maylea12b0962022-06-25 01:13:22 +0000868 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGABRT)
869 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
870 });
Steven Morelandaf4ca712021-05-24 23:22:08 +0000871 proc.expectAlreadyShutdown = true;
Steven Morelandd7302072021-05-15 01:32:04 +0000872}
873
Frederick Mayle69a0c992022-05-26 20:38:39 +0000874TEST_P(BinderRpc, FileDescriptorTransportRejectNone) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000875 if (socketType() == SocketType::TIPC) {
876 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
877 }
878
Frederick Mayle69a0c992022-05-26 20:38:39 +0000879 auto proc = createRpcTestSocketServerProcess({
880 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::NONE,
881 .serverSupportedFileDescriptorTransportModes =
882 {RpcSession::FileDescriptorTransportMode::UNIX},
883 .allowConnectFailure = true,
884 });
Andrei Homescu96834632022-10-14 00:49:49 +0000885 EXPECT_TRUE(proc.proc->sessions.empty()) << "session connections should have failed";
886 proc.proc->terminate();
887 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Mayle69a0c992022-05-26 20:38:39 +0000888 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGTERM)
889 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
890 });
891 proc.expectAlreadyShutdown = true;
892}
893
894TEST_P(BinderRpc, FileDescriptorTransportRejectUnix) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000895 if (socketType() == SocketType::TIPC) {
896 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
897 }
898
Frederick Mayle69a0c992022-05-26 20:38:39 +0000899 auto proc = createRpcTestSocketServerProcess({
900 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
901 .serverSupportedFileDescriptorTransportModes =
902 {RpcSession::FileDescriptorTransportMode::NONE},
903 .allowConnectFailure = true,
904 });
Andrei Homescu96834632022-10-14 00:49:49 +0000905 EXPECT_TRUE(proc.proc->sessions.empty()) << "session connections should have failed";
906 proc.proc->terminate();
907 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Mayle69a0c992022-05-26 20:38:39 +0000908 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGTERM)
909 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
910 });
911 proc.expectAlreadyShutdown = true;
912}
913
914TEST_P(BinderRpc, FileDescriptorTransportOptionalUnix) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000915 if (socketType() == SocketType::TIPC) {
916 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
917 }
918
Frederick Mayle69a0c992022-05-26 20:38:39 +0000919 auto proc = createRpcTestSocketServerProcess({
920 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::NONE,
921 .serverSupportedFileDescriptorTransportModes =
922 {RpcSession::FileDescriptorTransportMode::NONE,
923 RpcSession::FileDescriptorTransportMode::UNIX},
924 });
925
926 android::os::ParcelFileDescriptor out;
927 auto status = proc.rootIface->echoAsFile("hello", &out);
928 EXPECT_EQ(status.transactionError(), FDS_NOT_ALLOWED) << status;
929}
930
931TEST_P(BinderRpc, ReceiveFile) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000932 if (socketType() == SocketType::TIPC) {
933 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
934 }
935
Frederick Mayle69a0c992022-05-26 20:38:39 +0000936 auto proc = createRpcTestSocketServerProcess({
937 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
938 .serverSupportedFileDescriptorTransportModes =
939 {RpcSession::FileDescriptorTransportMode::UNIX},
940 });
941
942 android::os::ParcelFileDescriptor out;
943 auto status = proc.rootIface->echoAsFile("hello", &out);
944 if (!supportsFdTransport()) {
945 EXPECT_EQ(status.transactionError(), BAD_VALUE) << status;
946 return;
947 }
948 ASSERT_TRUE(status.isOk()) << status;
949
950 std::string result;
951 CHECK(android::base::ReadFdToString(out.get(), &result));
952 EXPECT_EQ(result, "hello");
953}
954
955TEST_P(BinderRpc, SendFiles) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000956 if (socketType() == SocketType::TIPC) {
957 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
958 }
959
Frederick Mayle69a0c992022-05-26 20:38:39 +0000960 auto proc = createRpcTestSocketServerProcess({
961 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
962 .serverSupportedFileDescriptorTransportModes =
963 {RpcSession::FileDescriptorTransportMode::UNIX},
964 });
965
966 std::vector<android::os::ParcelFileDescriptor> files;
967 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("123")));
968 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("a")));
969 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("b")));
970 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("cd")));
971
972 android::os::ParcelFileDescriptor out;
973 auto status = proc.rootIface->concatFiles(files, &out);
974 if (!supportsFdTransport()) {
975 EXPECT_EQ(status.transactionError(), BAD_VALUE) << status;
976 return;
977 }
978 ASSERT_TRUE(status.isOk()) << status;
979
980 std::string result;
981 CHECK(android::base::ReadFdToString(out.get(), &result));
982 EXPECT_EQ(result, "123abcd");
983}
984
985TEST_P(BinderRpc, SendMaxFiles) {
986 if (!supportsFdTransport()) {
987 GTEST_SKIP() << "Would fail trivially (which is tested by BinderRpc::SendFiles)";
988 }
989
990 auto proc = createRpcTestSocketServerProcess({
991 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
992 .serverSupportedFileDescriptorTransportModes =
993 {RpcSession::FileDescriptorTransportMode::UNIX},
994 });
995
996 std::vector<android::os::ParcelFileDescriptor> files;
997 for (int i = 0; i < 253; i++) {
998 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("a")));
999 }
1000
1001 android::os::ParcelFileDescriptor out;
1002 auto status = proc.rootIface->concatFiles(files, &out);
1003 ASSERT_TRUE(status.isOk()) << status;
1004
1005 std::string result;
1006 CHECK(android::base::ReadFdToString(out.get(), &result));
1007 EXPECT_EQ(result, std::string(253, 'a'));
1008}
1009
1010TEST_P(BinderRpc, SendTooManyFiles) {
1011 if (!supportsFdTransport()) {
1012 GTEST_SKIP() << "Would fail trivially (which is tested by BinderRpc::SendFiles)";
1013 }
1014
1015 auto proc = createRpcTestSocketServerProcess({
1016 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
1017 .serverSupportedFileDescriptorTransportModes =
1018 {RpcSession::FileDescriptorTransportMode::UNIX},
1019 });
1020
1021 std::vector<android::os::ParcelFileDescriptor> files;
1022 for (int i = 0; i < 254; i++) {
1023 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("a")));
1024 }
1025
1026 android::os::ParcelFileDescriptor out;
1027 auto status = proc.rootIface->concatFiles(files, &out);
1028 EXPECT_EQ(status.transactionError(), BAD_VALUE) << status;
1029}
1030
Andrei Homescufc221502022-10-08 03:51:17 +00001031TEST_P(BinderRpc, AppendInvalidFd) {
Andrei Homescu68a55612022-08-02 01:25:15 +00001032 if (socketType() == SocketType::TIPC) {
1033 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
1034 }
1035
Andrei Homescufc221502022-10-08 03:51:17 +00001036 auto proc = createRpcTestSocketServerProcess({
1037 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
1038 .serverSupportedFileDescriptorTransportModes =
1039 {RpcSession::FileDescriptorTransportMode::UNIX},
1040 });
1041
1042 int badFd = fcntl(STDERR_FILENO, F_DUPFD_CLOEXEC, 0);
1043 ASSERT_NE(badFd, -1);
1044
1045 // Close the file descriptor so it becomes invalid for dup
1046 close(badFd);
1047
1048 Parcel p1;
1049 p1.markForBinder(proc.rootBinder);
1050 p1.writeInt32(3);
1051 EXPECT_EQ(OK, p1.writeFileDescriptor(badFd, false));
1052
1053 Parcel pRaw;
1054 pRaw.markForBinder(proc.rootBinder);
1055 EXPECT_EQ(OK, pRaw.appendFrom(&p1, 0, p1.dataSize()));
1056
1057 pRaw.setDataPosition(0);
1058 EXPECT_EQ(3, pRaw.readInt32());
1059 ASSERT_EQ(-1, pRaw.readFileDescriptor());
1060}
1061
Andrei Homescu68a55612022-08-02 01:25:15 +00001062#ifndef __ANDROID_VENDOR__ // No AIBinder_fromPlatformBinder on vendor
Steven Moreland37aff182021-03-26 02:04:16 +00001063TEST_P(BinderRpc, WorksWithLibbinderNdkPing) {
Andrei Homescu12106de2022-04-27 04:42:21 +00001064 if constexpr (!kEnableSharedLibs) {
1065 GTEST_SKIP() << "Test disabled because Binder was built as a static library";
1066 }
1067
Steven Moreland4313d7e2021-07-15 23:41:22 +00001068 auto proc = createRpcTestSocketServerProcess({});
Steven Moreland37aff182021-03-26 02:04:16 +00001069
1070 ndk::SpAIBinder binder = ndk::SpAIBinder(AIBinder_fromPlatformBinder(proc.rootBinder));
1071 ASSERT_NE(binder, nullptr);
1072
1073 ASSERT_EQ(STATUS_OK, AIBinder_ping(binder.get()));
1074}
1075
1076TEST_P(BinderRpc, WorksWithLibbinderNdkUserTransaction) {
Andrei Homescu12106de2022-04-27 04:42:21 +00001077 if constexpr (!kEnableSharedLibs) {
1078 GTEST_SKIP() << "Test disabled because Binder was built as a static library";
1079 }
1080
Steven Moreland4313d7e2021-07-15 23:41:22 +00001081 auto proc = createRpcTestSocketServerProcess({});
Steven Moreland37aff182021-03-26 02:04:16 +00001082
1083 ndk::SpAIBinder binder = ndk::SpAIBinder(AIBinder_fromPlatformBinder(proc.rootBinder));
1084 ASSERT_NE(binder, nullptr);
1085
1086 auto ndkBinder = aidl::IBinderRpcTest::fromBinder(binder);
1087 ASSERT_NE(ndkBinder, nullptr);
1088
1089 std::string out;
1090 ndk::ScopedAStatus status = ndkBinder->doubleString("aoeu", &out);
1091 ASSERT_TRUE(status.isOk()) << status.getDescription();
1092 ASSERT_EQ("aoeuaoeu", out);
1093}
Andrei Homescu68a55612022-08-02 01:25:15 +00001094#endif // __ANDROID_VENDOR__
Steven Moreland37aff182021-03-26 02:04:16 +00001095
Steven Moreland5553ac42020-11-11 02:14:45 +00001096ssize_t countFds() {
1097 DIR* dir = opendir("/proc/self/fd/");
1098 if (dir == nullptr) return -1;
1099 ssize_t ret = 0;
1100 dirent* ent;
1101 while ((ent = readdir(dir)) != nullptr) ret++;
1102 closedir(dir);
1103 return ret;
1104}
1105
Andrei Homescua858b0e2022-08-01 23:43:09 +00001106TEST_P(BinderRpc, Fds) {
1107 if (serverSingleThreaded()) {
1108 GTEST_SKIP() << "This test requires multiple threads";
1109 }
Andrei Homescu68a55612022-08-02 01:25:15 +00001110 if (socketType() == SocketType::TIPC) {
1111 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
1112 }
Andrei Homescua858b0e2022-08-01 23:43:09 +00001113
Steven Moreland5553ac42020-11-11 02:14:45 +00001114 ssize_t beforeFds = countFds();
1115 ASSERT_GE(beforeFds, 0);
1116 {
Steven Moreland4313d7e2021-07-15 23:41:22 +00001117 auto proc = createRpcTestSocketServerProcess({.numThreads = 10});
Steven Moreland5553ac42020-11-11 02:14:45 +00001118 ASSERT_EQ(OK, proc.rootBinder->pingBinder());
1119 }
1120 ASSERT_EQ(beforeFds, countFds()) << (system("ls -l /proc/self/fd/"), "fd leak?");
1121}
1122
Andrei Homescud65666d2023-03-03 07:28:02 +00001123#ifdef BINDER_RPC_TO_TRUSTY_TEST
Steven Morelandb469f432023-07-28 22:13:47 +00001124
1125static std::vector<BinderRpc::ParamType> getTrustyBinderRpcParams() {
1126 std::vector<BinderRpc::ParamType> ret;
1127
1128 for (const auto& clientVersion : testVersions()) {
1129 for (const auto& serverVersion : testVersions()) {
1130 ret.push_back(BinderRpc::ParamType{
1131 .type = SocketType::TIPC,
1132 .security = RpcSecurity::RAW,
1133 .clientVersion = clientVersion,
1134 .serverVersion = serverVersion,
1135 .singleThreaded = true,
1136 .noKernel = true,
1137 });
1138 }
1139 }
1140
1141 return ret;
1142}
1143
1144INSTANTIATE_TEST_CASE_P(Trusty, BinderRpc, ::testing::ValuesIn(getTrustyBinderRpcParams()),
Andrei Homescud65666d2023-03-03 07:28:02 +00001145 BinderRpc::PrintParamInfo);
1146#else // BINDER_RPC_TO_TRUSTY_TEST
Steven Moreland9f250b02023-05-16 23:27:42 +00001147bool testSupportVsockLoopback() {
Yifan Hong702115c2021-06-24 15:39:18 -07001148 // We don't need to enable TLS to know if vsock is supported.
Steven Morelandda573042021-06-12 01:13:45 +00001149 unsigned int vsockPort = allocateVsockPort();
Steven Morelandda573042021-06-12 01:13:45 +00001150
Andrei Homescu992a4052022-06-28 21:26:18 +00001151 android::base::unique_fd serverFd(
1152 TEMP_FAILURE_RETRY(socket(AF_VSOCK, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0)));
Steven Morelanda27311b2023-04-11 22:13:35 +00001153
1154 if (errno == EAFNOSUPPORT) {
1155 return false;
1156 }
1157
Andrei Homescu992a4052022-06-28 21:26:18 +00001158 LOG_ALWAYS_FATAL_IF(serverFd == -1, "Could not create socket: %s", strerror(errno));
1159
1160 sockaddr_vm serverAddr{
1161 .svm_family = AF_VSOCK,
1162 .svm_port = vsockPort,
1163 .svm_cid = VMADDR_CID_ANY,
1164 };
1165 int ret = TEMP_FAILURE_RETRY(
1166 bind(serverFd.get(), reinterpret_cast<sockaddr*>(&serverAddr), sizeof(serverAddr)));
1167 LOG_ALWAYS_FATAL_IF(0 != ret, "Could not bind socket to port %u: %s", vsockPort,
1168 strerror(errno));
1169
1170 ret = TEMP_FAILURE_RETRY(listen(serverFd.get(), 1 /*backlog*/));
1171 LOG_ALWAYS_FATAL_IF(0 != ret, "Could not listen socket on port %u: %s", vsockPort,
1172 strerror(errno));
1173
1174 // Try to connect to the server using the VMADDR_CID_LOCAL cid
1175 // to see if the kernel supports it. It's safe to use a blocking
1176 // connect because vsock sockets have a 2 second connection timeout,
1177 // and they return ETIMEDOUT after that.
1178 android::base::unique_fd connectFd(
1179 TEMP_FAILURE_RETRY(socket(AF_VSOCK, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0)));
1180 LOG_ALWAYS_FATAL_IF(connectFd == -1, "Could not create socket for port %u: %s", vsockPort,
1181 strerror(errno));
1182
1183 bool success = false;
1184 sockaddr_vm connectAddr{
1185 .svm_family = AF_VSOCK,
1186 .svm_port = vsockPort,
1187 .svm_cid = VMADDR_CID_LOCAL,
1188 };
1189 ret = TEMP_FAILURE_RETRY(connect(connectFd.get(), reinterpret_cast<sockaddr*>(&connectAddr),
1190 sizeof(connectAddr)));
1191 if (ret != 0 && (errno == EAGAIN || errno == EINPROGRESS)) {
1192 android::base::unique_fd acceptFd;
1193 while (true) {
1194 pollfd pfd[]{
1195 {.fd = serverFd.get(), .events = POLLIN, .revents = 0},
1196 {.fd = connectFd.get(), .events = POLLOUT, .revents = 0},
1197 };
1198 ret = TEMP_FAILURE_RETRY(poll(pfd, arraysize(pfd), -1));
1199 LOG_ALWAYS_FATAL_IF(ret < 0, "Error polling: %s", strerror(errno));
1200
1201 if (pfd[0].revents & POLLIN) {
1202 sockaddr_vm acceptAddr;
1203 socklen_t acceptAddrLen = sizeof(acceptAddr);
1204 ret = TEMP_FAILURE_RETRY(accept4(serverFd.get(),
1205 reinterpret_cast<sockaddr*>(&acceptAddr),
1206 &acceptAddrLen, SOCK_CLOEXEC));
1207 LOG_ALWAYS_FATAL_IF(ret < 0, "Could not accept4 socket: %s", strerror(errno));
1208 LOG_ALWAYS_FATAL_IF(acceptAddrLen != static_cast<socklen_t>(sizeof(acceptAddr)),
1209 "Truncated address");
1210
1211 // Store the fd in acceptFd so we keep the connection alive
1212 // while polling connectFd
1213 acceptFd.reset(ret);
1214 }
1215
1216 if (pfd[1].revents & POLLOUT) {
1217 // Connect either succeeded or timed out
1218 int connectErrno;
1219 socklen_t connectErrnoLen = sizeof(connectErrno);
1220 int ret = getsockopt(connectFd.get(), SOL_SOCKET, SO_ERROR, &connectErrno,
1221 &connectErrnoLen);
1222 LOG_ALWAYS_FATAL_IF(ret == -1,
1223 "Could not getsockopt() after connect() "
1224 "on non-blocking socket: %s.",
1225 strerror(errno));
1226
1227 // We're done, this is all we wanted
1228 success = connectErrno == 0;
1229 break;
1230 }
1231 }
1232 } else {
1233 success = ret == 0;
1234 }
1235
1236 ALOGE("Detected vsock loopback supported: %s", success ? "yes" : "no");
1237
1238 return success;
Steven Morelandda573042021-06-12 01:13:45 +00001239}
1240
Yifan Hong1deca4b2021-09-10 16:16:44 -07001241static std::vector<SocketType> testSocketTypes(bool hasPreconnected = true) {
Alice Wang893a9912022-10-24 10:44:09 +00001242 std::vector<SocketType> ret = {SocketType::UNIX, SocketType::UNIX_BOOTSTRAP, SocketType::INET,
1243 SocketType::UNIX_RAW};
Yifan Hong1deca4b2021-09-10 16:16:44 -07001244
1245 if (hasPreconnected) ret.push_back(SocketType::PRECONNECTED);
Steven Morelandda573042021-06-12 01:13:45 +00001246
Steven Moreland9f250b02023-05-16 23:27:42 +00001247#ifdef __BIONIC__
1248 // Devices may not have vsock support. AVF tests will verify whether they do, but
1249 // we can't require it due to old kernels for the time being.
Steven Morelandda573042021-06-12 01:13:45 +00001250 static bool hasVsockLoopback = testSupportVsockLoopback();
Steven Moreland9f250b02023-05-16 23:27:42 +00001251#else
1252 // On host machines, we always assume we have vsock loopback. If we don't, the
1253 // subsequent failures will be more clear than showing one now.
1254 static bool hasVsockLoopback = true;
1255#endif
Steven Morelandda573042021-06-12 01:13:45 +00001256
1257 if (hasVsockLoopback) {
1258 ret.push_back(SocketType::VSOCK);
1259 }
1260
1261 return ret;
1262}
1263
Steven Morelandb469f432023-07-28 22:13:47 +00001264static std::vector<BinderRpc::ParamType> getBinderRpcParams() {
1265 std::vector<BinderRpc::ParamType> ret;
1266
Steven Morelandf7421432023-07-28 22:41:44 +00001267 constexpr bool full = false;
1268
Steven Morelandb469f432023-07-28 22:13:47 +00001269 for (const auto& type : testSocketTypes()) {
Steven Morelandf7421432023-07-28 22:41:44 +00001270 if (full || type == SocketType::UNIX) {
1271 for (const auto& security : RpcSecurityValues()) {
1272 for (const auto& clientVersion : testVersions()) {
1273 for (const auto& serverVersion : testVersions()) {
1274 for (bool singleThreaded : {false, true}) {
1275 for (bool noKernel : {false, true}) {
1276 ret.push_back(BinderRpc::ParamType{
1277 .type = type,
1278 .security = security,
1279 .clientVersion = clientVersion,
1280 .serverVersion = serverVersion,
1281 .singleThreaded = singleThreaded,
1282 .noKernel = noKernel,
1283 });
1284 }
Steven Morelandb469f432023-07-28 22:13:47 +00001285 }
1286 }
1287 }
1288 }
Steven Morelandf7421432023-07-28 22:41:44 +00001289 } else {
1290 ret.push_back(BinderRpc::ParamType{
1291 .type = type,
1292 .security = RpcSecurity::RAW,
1293 .clientVersion = RPC_WIRE_PROTOCOL_VERSION,
1294 .serverVersion = RPC_WIRE_PROTOCOL_VERSION,
1295 .singleThreaded = false,
1296 .noKernel = false,
1297 });
Steven Morelandb469f432023-07-28 22:13:47 +00001298 }
1299 }
Steven Morelandf7421432023-07-28 22:41:44 +00001300
Steven Morelandb469f432023-07-28 22:13:47 +00001301 return ret;
1302}
1303
1304INSTANTIATE_TEST_CASE_P(PerSocket, BinderRpc, ::testing::ValuesIn(getBinderRpcParams()),
Yifan Hong702115c2021-06-24 15:39:18 -07001305 BinderRpc::PrintParamInfo);
Steven Morelandc1635952021-04-01 16:20:47 +00001306
Yifan Hong702115c2021-06-24 15:39:18 -07001307class BinderRpcServerRootObject
1308 : public ::testing::TestWithParam<std::tuple<bool, bool, RpcSecurity>> {};
Yifan Hong4ffb0c72021-05-07 18:35:14 -07001309
1310TEST_P(BinderRpcServerRootObject, WeakRootObject) {
1311 using SetFn = std::function<void(RpcServer*, sp<IBinder>)>;
1312 auto setRootObject = [](bool isStrong) -> SetFn {
1313 return isStrong ? SetFn(&RpcServer::setRootObject) : SetFn(&RpcServer::setRootObjectWeak);
1314 };
1315
Yifan Hong702115c2021-06-24 15:39:18 -07001316 auto [isStrong1, isStrong2, rpcSecurity] = GetParam();
Andrei Homescuf30148c2023-03-10 00:31:45 +00001317 auto server = RpcServer::make(newTlsFactory(rpcSecurity));
Yifan Hong4ffb0c72021-05-07 18:35:14 -07001318 auto binder1 = sp<BBinder>::make();
1319 IBinder* binderRaw1 = binder1.get();
1320 setRootObject(isStrong1)(server.get(), binder1);
1321 EXPECT_EQ(binderRaw1, server->getRootObject());
1322 binder1.clear();
1323 EXPECT_EQ((isStrong1 ? binderRaw1 : nullptr), server->getRootObject());
1324
1325 auto binder2 = sp<BBinder>::make();
1326 IBinder* binderRaw2 = binder2.get();
1327 setRootObject(isStrong2)(server.get(), binder2);
1328 EXPECT_EQ(binderRaw2, server->getRootObject());
1329 binder2.clear();
1330 EXPECT_EQ((isStrong2 ? binderRaw2 : nullptr), server->getRootObject());
1331}
1332
1333INSTANTIATE_TEST_CASE_P(BinderRpc, BinderRpcServerRootObject,
Yifan Hong702115c2021-06-24 15:39:18 -07001334 ::testing::Combine(::testing::Bool(), ::testing::Bool(),
1335 ::testing::ValuesIn(RpcSecurityValues())));
Yifan Hong4ffb0c72021-05-07 18:35:14 -07001336
Yifan Hong1a235852021-05-13 16:07:47 -07001337class OneOffSignal {
1338public:
1339 // If notify() was previously called, or is called within |duration|, return true; else false.
1340 template <typename R, typename P>
1341 bool wait(std::chrono::duration<R, P> duration) {
1342 std::unique_lock<std::mutex> lock(mMutex);
1343 return mCv.wait_for(lock, duration, [this] { return mValue; });
1344 }
1345 void notify() {
1346 std::unique_lock<std::mutex> lock(mMutex);
1347 mValue = true;
1348 lock.unlock();
1349 mCv.notify_all();
1350 }
1351
1352private:
1353 std::mutex mMutex;
1354 std::condition_variable mCv;
1355 bool mValue = false;
1356};
1357
Yifan Hong194acf22021-06-29 18:44:56 -07001358TEST(BinderRpc, Java) {
1359#if !defined(__ANDROID__)
1360 GTEST_SKIP() << "This test is only run on Android. Though it can technically run on host on"
1361 "createRpcDelegateServiceManager() with a device attached, such test belongs "
1362 "to binderHostDeviceTest. Hence, just disable this test on host.";
1363#endif // !__ANDROID__
Andrei Homescu12106de2022-04-27 04:42:21 +00001364 if constexpr (!kEnableKernelIpc) {
1365 GTEST_SKIP() << "Test disabled because Binder kernel driver was disabled "
1366 "at build time.";
1367 }
1368
Yifan Hong194acf22021-06-29 18:44:56 -07001369 sp<IServiceManager> sm = defaultServiceManager();
1370 ASSERT_NE(nullptr, sm);
1371 // Any Java service with non-empty getInterfaceDescriptor() would do.
1372 // Let's pick batteryproperties.
1373 auto binder = sm->checkService(String16("batteryproperties"));
1374 ASSERT_NE(nullptr, binder);
1375 auto descriptor = binder->getInterfaceDescriptor();
1376 ASSERT_GE(descriptor.size(), 0);
1377 ASSERT_EQ(OK, binder->pingBinder());
1378
1379 auto rpcServer = RpcServer::make();
Yifan Hong194acf22021-06-29 18:44:56 -07001380 unsigned int port;
Steven Moreland2372f9d2021-08-05 15:42:01 -07001381 ASSERT_EQ(OK, rpcServer->setupInetServer(kLocalInetAddress, 0, &port));
Yifan Hong194acf22021-06-29 18:44:56 -07001382 auto socket = rpcServer->releaseServer();
1383
1384 auto keepAlive = sp<BBinder>::make();
Yifan Hongfe4b83f2021-11-08 16:29:53 -08001385 auto setRpcClientDebugStatus = binder->setRpcClientDebug(std::move(socket), keepAlive);
1386
Yifan Honge3caaf22022-01-12 14:46:56 -08001387 if (!android::base::GetBoolProperty("ro.debuggable", false) ||
1388 android::base::GetProperty("ro.build.type", "") == "user") {
Yifan Hongfe4b83f2021-11-08 16:29:53 -08001389 ASSERT_EQ(INVALID_OPERATION, setRpcClientDebugStatus)
Yifan Honge3caaf22022-01-12 14:46:56 -08001390 << "setRpcClientDebug should return INVALID_OPERATION on non-debuggable or user "
1391 "builds, but get "
Yifan Hongfe4b83f2021-11-08 16:29:53 -08001392 << statusToString(setRpcClientDebugStatus);
1393 GTEST_SKIP();
1394 }
1395
1396 ASSERT_EQ(OK, setRpcClientDebugStatus);
Yifan Hong194acf22021-06-29 18:44:56 -07001397
1398 auto rpcSession = RpcSession::make();
Steven Moreland2372f9d2021-08-05 15:42:01 -07001399 ASSERT_EQ(OK, rpcSession->setupInetClient("127.0.0.1", port));
Yifan Hong194acf22021-06-29 18:44:56 -07001400 auto rpcBinder = rpcSession->getRootObject();
1401 ASSERT_NE(nullptr, rpcBinder);
1402
1403 ASSERT_EQ(OK, rpcBinder->pingBinder());
1404
1405 ASSERT_EQ(descriptor, rpcBinder->getInterfaceDescriptor())
1406 << "getInterfaceDescriptor should not crash system_server";
1407 ASSERT_EQ(OK, rpcBinder->pingBinder());
1408}
1409
Andrei Homescu8d7f4bd2022-08-03 05:46:17 +00001410class BinderRpcServerOnly : public ::testing::TestWithParam<std::tuple<RpcSecurity, uint32_t>> {
1411public:
1412 static std::string PrintTestParam(const ::testing::TestParamInfo<ParamType>& info) {
Andrei Homescuf30148c2023-03-10 00:31:45 +00001413 return std::string(newTlsFactory(std::get<0>(info.param))->toCString()) + "_serverV" +
Andrei Homescu8d7f4bd2022-08-03 05:46:17 +00001414 std::to_string(std::get<1>(info.param));
1415 }
1416};
1417
1418TEST_P(BinderRpcServerOnly, SetExternalServerTest) {
1419 base::unique_fd sink(TEMP_FAILURE_RETRY(open("/dev/null", O_RDWR)));
1420 int sinkFd = sink.get();
Andrei Homescuf30148c2023-03-10 00:31:45 +00001421 auto server = RpcServer::make(newTlsFactory(std::get<0>(GetParam())));
Steven Morelandca3f6382023-05-11 23:23:26 +00001422 ASSERT_TRUE(server->setProtocolVersion(std::get<1>(GetParam())));
Andrei Homescu8d7f4bd2022-08-03 05:46:17 +00001423 ASSERT_FALSE(server->hasServer());
1424 ASSERT_EQ(OK, server->setupExternalServer(std::move(sink)));
1425 ASSERT_TRUE(server->hasServer());
1426 base::unique_fd retrieved = server->releaseServer();
1427 ASSERT_FALSE(server->hasServer());
1428 ASSERT_EQ(sinkFd, retrieved.get());
1429}
1430
1431TEST_P(BinderRpcServerOnly, Shutdown) {
1432 if constexpr (!kEnableRpcThreads) {
1433 GTEST_SKIP() << "Test skipped because threads were disabled at build time";
1434 }
1435
1436 auto addr = allocateSocketAddress();
Andrei Homescuf30148c2023-03-10 00:31:45 +00001437 auto server = RpcServer::make(newTlsFactory(std::get<0>(GetParam())));
Steven Morelandca3f6382023-05-11 23:23:26 +00001438 ASSERT_TRUE(server->setProtocolVersion(std::get<1>(GetParam())));
Andrei Homescu8d7f4bd2022-08-03 05:46:17 +00001439 ASSERT_EQ(OK, server->setupUnixDomainServer(addr.c_str()));
1440 auto joinEnds = std::make_shared<OneOffSignal>();
1441
1442 // If things are broken and the thread never stops, don't block other tests. Because the thread
1443 // may run after the test finishes, it must not access the stack memory of the test. Hence,
1444 // shared pointers are passed.
1445 std::thread([server, joinEnds] {
1446 server->join();
1447 joinEnds->notify();
1448 }).detach();
1449
1450 bool shutdown = false;
1451 for (int i = 0; i < 10 && !shutdown; i++) {
Steven Morelanddd231e22022-09-08 19:47:49 +00001452 usleep(30 * 1000); // 30ms; total 300ms
Andrei Homescu8d7f4bd2022-08-03 05:46:17 +00001453 if (server->shutdown()) shutdown = true;
1454 }
1455 ASSERT_TRUE(shutdown) << "server->shutdown() never returns true";
1456
1457 ASSERT_TRUE(joinEnds->wait(2s))
1458 << "After server->shutdown() returns true, join() did not stop after 2s";
1459}
1460
Frederick Mayledc07cf82022-05-26 20:30:12 +00001461INSTANTIATE_TEST_CASE_P(BinderRpc, BinderRpcServerOnly,
1462 ::testing::Combine(::testing::ValuesIn(RpcSecurityValues()),
1463 ::testing::ValuesIn(testVersions())),
1464 BinderRpcServerOnly::PrintTestParam);
Yifan Hong702115c2021-06-24 15:39:18 -07001465
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001466class RpcTransportTestUtils {
Yifan Hong1deca4b2021-09-10 16:16:44 -07001467public:
Frederick Mayledc07cf82022-05-26 20:30:12 +00001468 // Only parameterized only server version because `RpcSession` is bypassed
1469 // in the client half of the tests.
1470 using Param =
1471 std::tuple<SocketType, RpcSecurity, std::optional<RpcCertificateFormat>, uint32_t>;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001472 using ConnectToServer = std::function<base::unique_fd()>;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001473
1474 // A server that handles client socket connections.
1475 class Server {
1476 public:
David Brazdil21c887c2022-09-23 12:25:18 +01001477 using AcceptConnection = std::function<base::unique_fd(Server*)>;
1478
Yifan Hong1deca4b2021-09-10 16:16:44 -07001479 explicit Server() {}
1480 Server(Server&&) = default;
Yifan Honge07d2732021-09-13 21:59:14 -07001481 ~Server() { shutdownAndWait(); }
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001482 [[nodiscard]] AssertionResult setUp(
1483 const Param& param,
1484 std::unique_ptr<RpcAuth> auth = std::make_unique<RpcAuthSelfSigned>()) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001485 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = param;
Andrei Homescuf30148c2023-03-10 00:31:45 +00001486 auto rpcServer = RpcServer::make(newTlsFactory(rpcSecurity));
Steven Morelandca3f6382023-05-11 23:23:26 +00001487 if (!rpcServer->setProtocolVersion(serverVersion)) {
1488 return AssertionFailure() << "Invalid protocol version: " << serverVersion;
1489 }
Yifan Hong1deca4b2021-09-10 16:16:44 -07001490 switch (socketType) {
1491 case SocketType::PRECONNECTED: {
1492 return AssertionFailure() << "Not supported by this test";
1493 } break;
1494 case SocketType::UNIX: {
1495 auto addr = allocateSocketAddress();
1496 auto status = rpcServer->setupUnixDomainServer(addr.c_str());
1497 if (status != OK) {
1498 return AssertionFailure()
1499 << "setupUnixDomainServer: " << statusToString(status);
1500 }
1501 mConnectToServer = [addr] {
1502 return connectTo(UnixSocketAddress(addr.c_str()));
1503 };
1504 } break;
David Brazdil21c887c2022-09-23 12:25:18 +01001505 case SocketType::UNIX_BOOTSTRAP: {
1506 base::unique_fd bootstrapFdClient, bootstrapFdServer;
1507 if (!base::Socketpair(SOCK_STREAM, &bootstrapFdClient, &bootstrapFdServer)) {
1508 return AssertionFailure() << "Socketpair() failed";
1509 }
1510 auto status = rpcServer->setupUnixDomainSocketBootstrapServer(
1511 std::move(bootstrapFdServer));
1512 if (status != OK) {
1513 return AssertionFailure() << "setupUnixDomainSocketBootstrapServer: "
1514 << statusToString(status);
1515 }
1516 mBootstrapSocket = RpcTransportFd(std::move(bootstrapFdClient));
1517 mAcceptConnection = &Server::recvmsgServerConnection;
1518 mConnectToServer = [this] { return connectToUnixBootstrap(mBootstrapSocket); };
1519 } break;
Alice Wang893a9912022-10-24 10:44:09 +00001520 case SocketType::UNIX_RAW: {
1521 auto addr = allocateSocketAddress();
1522 auto status = rpcServer->setupRawSocketServer(initUnixSocket(addr));
1523 if (status != OK) {
1524 return AssertionFailure()
1525 << "setupRawSocketServer: " << statusToString(status);
1526 }
1527 mConnectToServer = [addr] {
1528 return connectTo(UnixSocketAddress(addr.c_str()));
1529 };
1530 } break;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001531 case SocketType::VSOCK: {
1532 auto port = allocateVsockPort();
David Brazdila47dfda2022-11-22 22:52:19 +00001533 auto status = rpcServer->setupVsockServer(VMADDR_CID_LOCAL, port);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001534 if (status != OK) {
1535 return AssertionFailure() << "setupVsockServer: " << statusToString(status);
1536 }
1537 mConnectToServer = [port] {
1538 return connectTo(VsockSocketAddress(VMADDR_CID_LOCAL, port));
1539 };
1540 } break;
1541 case SocketType::INET: {
1542 unsigned int port;
1543 auto status = rpcServer->setupInetServer(kLocalInetAddress, 0, &port);
1544 if (status != OK) {
1545 return AssertionFailure() << "setupInetServer: " << statusToString(status);
1546 }
1547 mConnectToServer = [port] {
1548 const char* addr = kLocalInetAddress;
1549 auto aiStart = InetSocketAddress::getAddrInfo(addr, port);
1550 if (aiStart == nullptr) return base::unique_fd{};
1551 for (auto ai = aiStart.get(); ai != nullptr; ai = ai->ai_next) {
1552 auto fd = connectTo(
1553 InetSocketAddress(ai->ai_addr, ai->ai_addrlen, addr, port));
1554 if (fd.ok()) return fd;
1555 }
1556 ALOGE("None of the socket address resolved for %s:%u can be connected",
1557 addr, port);
1558 return base::unique_fd{};
1559 };
Andrei Homescu68a55612022-08-02 01:25:15 +00001560 } break;
1561 case SocketType::TIPC: {
1562 LOG_ALWAYS_FATAL("RpcTransportTest should not be enabled for TIPC");
1563 } break;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001564 }
1565 mFd = rpcServer->releaseServer();
Pawan49d74cb2022-08-03 21:19:11 +00001566 if (!mFd.fd.ok()) return AssertionFailure() << "releaseServer returns invalid fd";
Andrei Homescuf30148c2023-03-10 00:31:45 +00001567 mCtx = newTlsFactory(rpcSecurity, mCertVerifier, std::move(auth))->newServerCtx();
Yifan Hong1deca4b2021-09-10 16:16:44 -07001568 if (mCtx == nullptr) return AssertionFailure() << "newServerCtx";
1569 mSetup = true;
1570 return AssertionSuccess();
1571 }
1572 RpcTransportCtx* getCtx() const { return mCtx.get(); }
1573 std::shared_ptr<RpcCertificateVerifierSimple> getCertVerifier() const {
1574 return mCertVerifier;
1575 }
1576 ConnectToServer getConnectToServerFn() { return mConnectToServer; }
1577 void start() {
1578 LOG_ALWAYS_FATAL_IF(!mSetup, "Call Server::setup first!");
1579 mThread = std::make_unique<std::thread>(&Server::run, this);
1580 }
David Brazdil21c887c2022-09-23 12:25:18 +01001581
1582 base::unique_fd acceptServerConnection() {
1583 return base::unique_fd(TEMP_FAILURE_RETRY(
1584 accept4(mFd.fd.get(), nullptr, nullptr, SOCK_CLOEXEC | SOCK_NONBLOCK)));
1585 }
1586
1587 base::unique_fd recvmsgServerConnection() {
1588 std::vector<std::variant<base::unique_fd, base::borrowed_fd>> fds;
1589 int buf;
1590 iovec iov{&buf, sizeof(buf)};
1591
1592 if (receiveMessageFromSocket(mFd, &iov, 1, &fds) < 0) {
1593 int savedErrno = errno;
1594 LOG(FATAL) << "Failed receiveMessage: " << strerror(savedErrno);
1595 }
1596 if (fds.size() != 1) {
1597 LOG(FATAL) << "Expected one FD from receiveMessage(), got " << fds.size();
1598 }
1599 return std::move(std::get<base::unique_fd>(fds[0]));
1600 }
1601
Yifan Hong1deca4b2021-09-10 16:16:44 -07001602 void run() {
1603 LOG_ALWAYS_FATAL_IF(!mSetup, "Call Server::setup first!");
1604
1605 std::vector<std::thread> threads;
1606 while (OK == mFdTrigger->triggerablePoll(mFd, POLLIN)) {
David Brazdil21c887c2022-09-23 12:25:18 +01001607 base::unique_fd acceptedFd = mAcceptConnection(this);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001608 threads.emplace_back(&Server::handleOne, this, std::move(acceptedFd));
1609 }
1610
1611 for (auto& thread : threads) thread.join();
1612 }
1613 void handleOne(android::base::unique_fd acceptedFd) {
1614 ASSERT_TRUE(acceptedFd.ok());
Pawan3e0061c2022-08-26 21:08:34 +00001615 RpcTransportFd transportFd(std::move(acceptedFd));
Pawan49d74cb2022-08-03 21:19:11 +00001616 auto serverTransport = mCtx->newTransport(std::move(transportFd), mFdTrigger.get());
Yifan Hong1deca4b2021-09-10 16:16:44 -07001617 if (serverTransport == nullptr) return; // handshake failed
Yifan Hong67519322021-09-13 18:51:16 -07001618 ASSERT_TRUE(mPostConnect(serverTransport.get(), mFdTrigger.get()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001619 }
Yifan Honge07d2732021-09-13 21:59:14 -07001620 void shutdownAndWait() {
Yifan Hong67519322021-09-13 18:51:16 -07001621 shutdown();
1622 join();
1623 }
1624 void shutdown() { mFdTrigger->trigger(); }
1625
1626 void setPostConnect(
1627 std::function<AssertionResult(RpcTransport*, FdTrigger* fdTrigger)> fn) {
1628 mPostConnect = std::move(fn);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001629 }
1630
1631 private:
1632 std::unique_ptr<std::thread> mThread;
1633 ConnectToServer mConnectToServer;
David Brazdil21c887c2022-09-23 12:25:18 +01001634 AcceptConnection mAcceptConnection = &Server::acceptServerConnection;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001635 std::unique_ptr<FdTrigger> mFdTrigger = FdTrigger::make();
David Brazdil21c887c2022-09-23 12:25:18 +01001636 RpcTransportFd mFd, mBootstrapSocket;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001637 std::unique_ptr<RpcTransportCtx> mCtx;
1638 std::shared_ptr<RpcCertificateVerifierSimple> mCertVerifier =
1639 std::make_shared<RpcCertificateVerifierSimple>();
1640 bool mSetup = false;
Yifan Hong67519322021-09-13 18:51:16 -07001641 // The function invoked after connection and handshake. By default, it is
1642 // |defaultPostConnect| that sends |kMessage| to the client.
1643 std::function<AssertionResult(RpcTransport*, FdTrigger* fdTrigger)> mPostConnect =
1644 Server::defaultPostConnect;
1645
1646 void join() {
1647 if (mThread != nullptr) {
1648 mThread->join();
1649 mThread = nullptr;
1650 }
1651 }
1652
1653 static AssertionResult defaultPostConnect(RpcTransport* serverTransport,
1654 FdTrigger* fdTrigger) {
1655 std::string message(kMessage);
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001656 iovec messageIov{message.data(), message.size()};
Devin Moore695368f2022-06-03 22:29:14 +00001657 auto status = serverTransport->interruptableWriteFully(fdTrigger, &messageIov, 1,
Frederick Mayle69a0c992022-05-26 20:38:39 +00001658 std::nullopt, nullptr);
Yifan Hong67519322021-09-13 18:51:16 -07001659 if (status != OK) return AssertionFailure() << statusToString(status);
1660 return AssertionSuccess();
1661 }
Yifan Hong1deca4b2021-09-10 16:16:44 -07001662 };
1663
1664 class Client {
1665 public:
1666 explicit Client(ConnectToServer connectToServer) : mConnectToServer(connectToServer) {}
1667 Client(Client&&) = default;
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001668 [[nodiscard]] AssertionResult setUp(const Param& param) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001669 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = param;
1670 (void)serverVersion;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001671 mFdTrigger = FdTrigger::make();
Andrei Homescuf30148c2023-03-10 00:31:45 +00001672 mCtx = newTlsFactory(rpcSecurity, mCertVerifier)->newClientCtx();
Yifan Hong1deca4b2021-09-10 16:16:44 -07001673 if (mCtx == nullptr) return AssertionFailure() << "newClientCtx";
1674 return AssertionSuccess();
1675 }
1676 RpcTransportCtx* getCtx() const { return mCtx.get(); }
1677 std::shared_ptr<RpcCertificateVerifierSimple> getCertVerifier() const {
1678 return mCertVerifier;
1679 }
Yifan Hong67519322021-09-13 18:51:16 -07001680 // connect() and do handshake
1681 bool setUpTransport() {
1682 mFd = mConnectToServer();
Pawan49d74cb2022-08-03 21:19:11 +00001683 if (!mFd.fd.ok()) return AssertionFailure() << "Cannot connect to server";
Yifan Hong67519322021-09-13 18:51:16 -07001684 mClientTransport = mCtx->newTransport(std::move(mFd), mFdTrigger.get());
1685 return mClientTransport != nullptr;
1686 }
1687 AssertionResult readMessage(const std::string& expectedMessage = kMessage) {
1688 LOG_ALWAYS_FATAL_IF(mClientTransport == nullptr, "setUpTransport not called or failed");
1689 std::string readMessage(expectedMessage.size(), '\0');
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001690 iovec readMessageIov{readMessage.data(), readMessage.size()};
Devin Moore695368f2022-06-03 22:29:14 +00001691 status_t readStatus =
1692 mClientTransport->interruptableReadFully(mFdTrigger.get(), &readMessageIov, 1,
Frederick Mayleffe9ac22022-06-30 02:07:36 +00001693 std::nullopt, nullptr);
Yifan Hong67519322021-09-13 18:51:16 -07001694 if (readStatus != OK) {
1695 return AssertionFailure() << statusToString(readStatus);
1696 }
1697 if (readMessage != expectedMessage) {
1698 return AssertionFailure()
1699 << "Expected " << expectedMessage << ", actual " << readMessage;
1700 }
1701 return AssertionSuccess();
1702 }
Yifan Hong1deca4b2021-09-10 16:16:44 -07001703 void run(bool handshakeOk = true, bool readOk = true) {
Yifan Hong67519322021-09-13 18:51:16 -07001704 if (!setUpTransport()) {
Yifan Hong1deca4b2021-09-10 16:16:44 -07001705 ASSERT_FALSE(handshakeOk) << "newTransport returns nullptr, but it shouldn't";
1706 return;
1707 }
1708 ASSERT_TRUE(handshakeOk) << "newTransport does not return nullptr, but it should";
Yifan Hong67519322021-09-13 18:51:16 -07001709 ASSERT_EQ(readOk, readMessage());
Yifan Hong1deca4b2021-09-10 16:16:44 -07001710 }
1711
Pawan49d74cb2022-08-03 21:19:11 +00001712 bool isTransportWaiting() { return mClientTransport->isWaiting(); }
1713
Yifan Hong1deca4b2021-09-10 16:16:44 -07001714 private:
1715 ConnectToServer mConnectToServer;
Pawan3e0061c2022-08-26 21:08:34 +00001716 RpcTransportFd mFd;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001717 std::unique_ptr<FdTrigger> mFdTrigger = FdTrigger::make();
1718 std::unique_ptr<RpcTransportCtx> mCtx;
1719 std::shared_ptr<RpcCertificateVerifierSimple> mCertVerifier =
1720 std::make_shared<RpcCertificateVerifierSimple>();
Yifan Hong67519322021-09-13 18:51:16 -07001721 std::unique_ptr<RpcTransport> mClientTransport;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001722 };
1723
1724 // Make A trust B.
1725 template <typename A, typename B>
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001726 static status_t trust(RpcSecurity rpcSecurity,
1727 std::optional<RpcCertificateFormat> certificateFormat, const A& a,
1728 const B& b) {
Yifan Hong1deca4b2021-09-10 16:16:44 -07001729 if (rpcSecurity != RpcSecurity::TLS) return OK;
Yifan Hong22211f82021-09-14 12:32:25 -07001730 LOG_ALWAYS_FATAL_IF(!certificateFormat.has_value());
1731 auto bCert = b->getCtx()->getCertificate(*certificateFormat);
1732 return a->getCertVerifier()->addTrustedPeerCertificate(*certificateFormat, bCert);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001733 }
1734
1735 static constexpr const char* kMessage = "hello";
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001736};
1737
1738class RpcTransportTest : public testing::TestWithParam<RpcTransportTestUtils::Param> {
1739public:
1740 using Server = RpcTransportTestUtils::Server;
1741 using Client = RpcTransportTestUtils::Client;
1742 static inline std::string PrintParamInfo(const testing::TestParamInfo<ParamType>& info) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001743 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = info.param;
Andrei Homescuf30148c2023-03-10 00:31:45 +00001744 auto ret = PrintToString(socketType) + "_" + newTlsFactory(rpcSecurity)->toCString();
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001745 if (certificateFormat.has_value()) ret += "_" + PrintToString(*certificateFormat);
Frederick Mayledc07cf82022-05-26 20:30:12 +00001746 ret += "_serverV" + std::to_string(serverVersion);
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001747 return ret;
1748 }
1749 static std::vector<ParamType> getRpcTranportTestParams() {
1750 std::vector<ParamType> ret;
Frederick Mayledc07cf82022-05-26 20:30:12 +00001751 for (auto serverVersion : testVersions()) {
1752 for (auto socketType : testSocketTypes(false /* hasPreconnected */)) {
1753 for (auto rpcSecurity : RpcSecurityValues()) {
1754 switch (rpcSecurity) {
1755 case RpcSecurity::RAW: {
1756 ret.emplace_back(socketType, rpcSecurity, std::nullopt, serverVersion);
1757 } break;
1758 case RpcSecurity::TLS: {
1759 ret.emplace_back(socketType, rpcSecurity, RpcCertificateFormat::PEM,
1760 serverVersion);
1761 ret.emplace_back(socketType, rpcSecurity, RpcCertificateFormat::DER,
1762 serverVersion);
1763 } break;
1764 }
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001765 }
1766 }
1767 }
1768 return ret;
1769 }
1770 template <typename A, typename B>
1771 status_t trust(const A& a, const B& b) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001772 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1773 (void)serverVersion;
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001774 return RpcTransportTestUtils::trust(rpcSecurity, certificateFormat, a, b);
1775 }
Andrei Homescu12106de2022-04-27 04:42:21 +00001776 void SetUp() override {
1777 if constexpr (!kEnableRpcThreads) {
1778 GTEST_SKIP() << "Test skipped because threads were disabled at build time";
1779 }
1780 }
Yifan Hong1deca4b2021-09-10 16:16:44 -07001781};
1782
1783TEST_P(RpcTransportTest, GoodCertificate) {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001784 auto server = std::make_unique<Server>();
1785 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001786
1787 Client client(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001788 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001789
1790 ASSERT_EQ(OK, trust(&client, server));
1791 ASSERT_EQ(OK, trust(server, &client));
1792
1793 server->start();
1794 client.run();
1795}
1796
1797TEST_P(RpcTransportTest, MultipleClients) {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001798 auto server = std::make_unique<Server>();
1799 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001800
1801 std::vector<Client> clients;
1802 for (int i = 0; i < 2; i++) {
1803 auto& client = clients.emplace_back(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001804 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001805 ASSERT_EQ(OK, trust(&client, server));
1806 ASSERT_EQ(OK, trust(server, &client));
1807 }
1808
1809 server->start();
1810 for (auto& client : clients) client.run();
1811}
1812
1813TEST_P(RpcTransportTest, UntrustedServer) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001814 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1815 (void)serverVersion;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001816
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001817 auto untrustedServer = std::make_unique<Server>();
1818 ASSERT_TRUE(untrustedServer->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001819
1820 Client client(untrustedServer->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001821 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001822
1823 ASSERT_EQ(OK, trust(untrustedServer, &client));
1824
1825 untrustedServer->start();
1826
1827 // For TLS, this should reject the certificate. For RAW sockets, it should pass because
1828 // the client can't verify the server's identity.
1829 bool handshakeOk = rpcSecurity != RpcSecurity::TLS;
1830 client.run(handshakeOk);
1831}
1832TEST_P(RpcTransportTest, MaliciousServer) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001833 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1834 (void)serverVersion;
1835
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001836 auto validServer = std::make_unique<Server>();
1837 ASSERT_TRUE(validServer->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001838
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001839 auto maliciousServer = std::make_unique<Server>();
1840 ASSERT_TRUE(maliciousServer->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001841
1842 Client client(maliciousServer->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001843 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001844
1845 ASSERT_EQ(OK, trust(&client, validServer));
1846 ASSERT_EQ(OK, trust(validServer, &client));
1847 ASSERT_EQ(OK, trust(maliciousServer, &client));
1848
1849 maliciousServer->start();
1850
1851 // For TLS, this should reject the certificate. For RAW sockets, it should pass because
1852 // the client can't verify the server's identity.
1853 bool handshakeOk = rpcSecurity != RpcSecurity::TLS;
1854 client.run(handshakeOk);
1855}
1856
1857TEST_P(RpcTransportTest, UntrustedClient) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001858 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1859 (void)serverVersion;
1860
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001861 auto server = std::make_unique<Server>();
1862 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001863
1864 Client client(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001865 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001866
1867 ASSERT_EQ(OK, trust(&client, server));
1868
1869 server->start();
1870
1871 // For TLS, Client should be able to verify server's identity, so client should see
1872 // do_handshake() successfully executed. However, server shouldn't be able to verify client's
1873 // identity and should drop the connection, so client shouldn't be able to read anything.
1874 bool readOk = rpcSecurity != RpcSecurity::TLS;
1875 client.run(true, readOk);
1876}
1877
1878TEST_P(RpcTransportTest, MaliciousClient) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001879 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1880 (void)serverVersion;
1881
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001882 auto server = std::make_unique<Server>();
1883 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001884
1885 Client validClient(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001886 ASSERT_TRUE(validClient.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001887 Client maliciousClient(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001888 ASSERT_TRUE(maliciousClient.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001889
1890 ASSERT_EQ(OK, trust(&validClient, server));
1891 ASSERT_EQ(OK, trust(&maliciousClient, server));
1892
1893 server->start();
1894
1895 // See UntrustedClient.
1896 bool readOk = rpcSecurity != RpcSecurity::TLS;
1897 maliciousClient.run(true, readOk);
1898}
1899
Yifan Hong67519322021-09-13 18:51:16 -07001900TEST_P(RpcTransportTest, Trigger) {
1901 std::string msg2 = ", world!";
1902 std::mutex writeMutex;
1903 std::condition_variable writeCv;
1904 bool shouldContinueWriting = false;
1905 auto serverPostConnect = [&](RpcTransport* serverTransport, FdTrigger* fdTrigger) {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001906 std::string message(RpcTransportTestUtils::kMessage);
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001907 iovec messageIov{message.data(), message.size()};
Frederick Mayle69a0c992022-05-26 20:38:39 +00001908 auto status = serverTransport->interruptableWriteFully(fdTrigger, &messageIov, 1,
1909 std::nullopt, nullptr);
Yifan Hong67519322021-09-13 18:51:16 -07001910 if (status != OK) return AssertionFailure() << statusToString(status);
1911
1912 {
1913 std::unique_lock<std::mutex> lock(writeMutex);
1914 if (!writeCv.wait_for(lock, 3s, [&] { return shouldContinueWriting; })) {
1915 return AssertionFailure() << "write barrier not cleared in time!";
1916 }
1917 }
1918
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001919 iovec msg2Iov{msg2.data(), msg2.size()};
Frederick Mayle69a0c992022-05-26 20:38:39 +00001920 status = serverTransport->interruptableWriteFully(fdTrigger, &msg2Iov, 1, std::nullopt,
1921 nullptr);
Steven Morelandc591b472021-09-16 13:56:11 -07001922 if (status != DEAD_OBJECT)
Yifan Hong67519322021-09-13 18:51:16 -07001923 return AssertionFailure() << "When FdTrigger is shut down, interruptableWriteFully "
Steven Morelandc591b472021-09-16 13:56:11 -07001924 "should return DEAD_OBJECT, but it is "
Yifan Hong67519322021-09-13 18:51:16 -07001925 << statusToString(status);
1926 return AssertionSuccess();
1927 };
1928
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001929 auto server = std::make_unique<Server>();
1930 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong67519322021-09-13 18:51:16 -07001931
1932 // Set up client
1933 Client client(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001934 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong67519322021-09-13 18:51:16 -07001935
1936 // Exchange keys
1937 ASSERT_EQ(OK, trust(&client, server));
1938 ASSERT_EQ(OK, trust(server, &client));
1939
1940 server->setPostConnect(serverPostConnect);
1941
Yifan Hong67519322021-09-13 18:51:16 -07001942 server->start();
1943 // connect() to server and do handshake
1944 ASSERT_TRUE(client.setUpTransport());
Yifan Hong22211f82021-09-14 12:32:25 -07001945 // read the first message. This ensures that server has finished handshake and start handling
1946 // client fd. Server thread should pause at writeCv.wait_for().
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001947 ASSERT_TRUE(client.readMessage(RpcTransportTestUtils::kMessage));
Yifan Hong67519322021-09-13 18:51:16 -07001948 // Trigger server shutdown after server starts handling client FD. This ensures that the second
1949 // write is on an FdTrigger that has been shut down.
1950 server->shutdown();
1951 // Continues server thread to write the second message.
1952 {
Yifan Hong22211f82021-09-14 12:32:25 -07001953 std::lock_guard<std::mutex> lock(writeMutex);
Yifan Hong67519322021-09-13 18:51:16 -07001954 shouldContinueWriting = true;
Yifan Hong67519322021-09-13 18:51:16 -07001955 }
Yifan Hong22211f82021-09-14 12:32:25 -07001956 writeCv.notify_all();
Yifan Hong67519322021-09-13 18:51:16 -07001957 // After this line, server thread unblocks and attempts to write the second message, but
Steven Morelandc591b472021-09-16 13:56:11 -07001958 // shutdown is triggered, so write should failed with DEAD_OBJECT. See |serverPostConnect|.
Yifan Hong67519322021-09-13 18:51:16 -07001959 // On the client side, second read fails with DEAD_OBJECT
1960 ASSERT_FALSE(client.readMessage(msg2));
1961}
1962
Pawan49d74cb2022-08-03 21:19:11 +00001963TEST_P(RpcTransportTest, CheckWaitingForRead) {
1964 std::mutex readMutex;
1965 std::condition_variable readCv;
1966 bool shouldContinueReading = false;
1967 // Server will write data on transport once its started
1968 auto serverPostConnect = [&](RpcTransport* serverTransport, FdTrigger* fdTrigger) {
1969 std::string message(RpcTransportTestUtils::kMessage);
1970 iovec messageIov{message.data(), message.size()};
1971 auto status = serverTransport->interruptableWriteFully(fdTrigger, &messageIov, 1,
1972 std::nullopt, nullptr);
1973 if (status != OK) return AssertionFailure() << statusToString(status);
1974
1975 {
1976 std::unique_lock<std::mutex> lock(readMutex);
1977 shouldContinueReading = true;
1978 lock.unlock();
1979 readCv.notify_all();
1980 }
1981 return AssertionSuccess();
1982 };
1983
1984 // Setup Server and client
1985 auto server = std::make_unique<Server>();
1986 ASSERT_TRUE(server->setUp(GetParam()));
1987
1988 Client client(server->getConnectToServerFn());
1989 ASSERT_TRUE(client.setUp(GetParam()));
1990
1991 ASSERT_EQ(OK, trust(&client, server));
1992 ASSERT_EQ(OK, trust(server, &client));
1993 server->setPostConnect(serverPostConnect);
1994
1995 server->start();
1996 ASSERT_TRUE(client.setUpTransport());
1997 {
1998 // Wait till server writes data
1999 std::unique_lock<std::mutex> lock(readMutex);
2000 ASSERT_TRUE(readCv.wait_for(lock, 3s, [&] { return shouldContinueReading; }));
2001 }
2002
2003 // Since there is no read polling here, we will get polling count 0
2004 ASSERT_FALSE(client.isTransportWaiting());
2005 ASSERT_TRUE(client.readMessage(RpcTransportTestUtils::kMessage));
2006 // Thread should increment polling count, read and decrement polling count
2007 // Again, polling count should be zero here
2008 ASSERT_FALSE(client.isTransportWaiting());
2009
2010 server->shutdown();
2011}
2012
Yifan Hong1deca4b2021-09-10 16:16:44 -07002013INSTANTIATE_TEST_CASE_P(BinderRpc, RpcTransportTest,
Yifan Hong22211f82021-09-14 12:32:25 -07002014 ::testing::ValuesIn(RpcTransportTest::getRpcTranportTestParams()),
Yifan Hong1deca4b2021-09-10 16:16:44 -07002015 RpcTransportTest::PrintParamInfo);
2016
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002017class RpcTransportTlsKeyTest
Frederick Mayledc07cf82022-05-26 20:30:12 +00002018 : public testing::TestWithParam<
2019 std::tuple<SocketType, RpcCertificateFormat, RpcKeyFormat, uint32_t>> {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002020public:
2021 template <typename A, typename B>
2022 status_t trust(const A& a, const B& b) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00002023 auto [socketType, certificateFormat, keyFormat, serverVersion] = GetParam();
2024 (void)serverVersion;
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002025 return RpcTransportTestUtils::trust(RpcSecurity::TLS, certificateFormat, a, b);
2026 }
2027 static std::string PrintParamInfo(const testing::TestParamInfo<ParamType>& info) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00002028 auto [socketType, certificateFormat, keyFormat, serverVersion] = info.param;
2029 return PrintToString(socketType) + "_certificate_" + PrintToString(certificateFormat) +
2030 "_key_" + PrintToString(keyFormat) + "_serverV" + std::to_string(serverVersion);
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002031 };
2032};
2033
2034TEST_P(RpcTransportTlsKeyTest, PreSignedCertificate) {
Andrei Homescu12106de2022-04-27 04:42:21 +00002035 if constexpr (!kEnableRpcThreads) {
2036 GTEST_SKIP() << "Test skipped because threads were disabled at build time";
2037 }
2038
Frederick Mayledc07cf82022-05-26 20:30:12 +00002039 auto [socketType, certificateFormat, keyFormat, serverVersion] = GetParam();
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002040
2041 std::vector<uint8_t> pkeyData, certData;
2042 {
2043 auto pkey = makeKeyPairForSelfSignedCert();
2044 ASSERT_NE(nullptr, pkey);
2045 auto cert = makeSelfSignedCert(pkey.get(), kCertValidSeconds);
2046 ASSERT_NE(nullptr, cert);
2047 pkeyData = serializeUnencryptedPrivatekey(pkey.get(), keyFormat);
2048 certData = serializeCertificate(cert.get(), certificateFormat);
2049 }
2050
2051 auto desPkey = deserializeUnencryptedPrivatekey(pkeyData, keyFormat);
2052 auto desCert = deserializeCertificate(certData, certificateFormat);
2053 auto auth = std::make_unique<RpcAuthPreSigned>(std::move(desPkey), std::move(desCert));
Frederick Mayledc07cf82022-05-26 20:30:12 +00002054 auto utilsParam = std::make_tuple(socketType, RpcSecurity::TLS,
2055 std::make_optional(certificateFormat), serverVersion);
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002056
2057 auto server = std::make_unique<RpcTransportTestUtils::Server>();
2058 ASSERT_TRUE(server->setUp(utilsParam, std::move(auth)));
2059
2060 RpcTransportTestUtils::Client client(server->getConnectToServerFn());
2061 ASSERT_TRUE(client.setUp(utilsParam));
2062
2063 ASSERT_EQ(OK, trust(&client, server));
2064 ASSERT_EQ(OK, trust(server, &client));
2065
2066 server->start();
2067 client.run();
2068}
2069
2070INSTANTIATE_TEST_CASE_P(
2071 BinderRpc, RpcTransportTlsKeyTest,
2072 testing::Combine(testing::ValuesIn(testSocketTypes(false /* hasPreconnected*/)),
2073 testing::Values(RpcCertificateFormat::PEM, RpcCertificateFormat::DER),
Frederick Mayledc07cf82022-05-26 20:30:12 +00002074 testing::Values(RpcKeyFormat::PEM, RpcKeyFormat::DER),
2075 testing::ValuesIn(testVersions())),
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002076 RpcTransportTlsKeyTest::PrintParamInfo);
Andrei Homescud65666d2023-03-03 07:28:02 +00002077#endif // BINDER_RPC_TO_TRUSTY_TEST
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002078
Steven Morelandc1635952021-04-01 16:20:47 +00002079} // namespace android
2080
2081int main(int argc, char** argv) {
Steven Moreland5553ac42020-11-11 02:14:45 +00002082 ::testing::InitGoogleTest(&argc, argv);
2083 android::base::InitLogging(argv, android::base::StderrLogger, android::base::DefaultAborter);
Steven Morelanda83191d2021-10-27 10:14:53 -07002084
Steven Moreland5553ac42020-11-11 02:14:45 +00002085 return RUN_ALL_TESTS();
2086}