IPC: Add attachment brokering support to the message header.

ipc/attachment_broker_privileged_win_unittest.cc

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "build/build_config.h"
 
 #include <windows.h>
 
 #include "base/files/file_path.h"
 #include "base/files/file_util.h"
 #include "base/files/scoped_temp_dir.h"
 #include "base/memory/scoped_ptr.h"
 #include "ipc/attachment_broker_privileged_win.h"
 #include "ipc/attachment_broker_unprivileged_win.h"
 #include "ipc/handle_attachment_win.h"
 #include "ipc/handle_win.h"
 #include "ipc/ipc_listener.h"
 #include "ipc/ipc_message.h"
 #include "ipc/ipc_test_base.h"
+#include "ipc/ipc_test_messages.h"
 
 namespace {
 
 const char kDataBuffer[] = "This is some test data to write to the file.";
 
 // Returns the contents of the file represented by |h| as a std::string.
 std::string ReadFromFile(HANDLE h) {
   SetFilePointer(h, 0, nullptr, FILE_BEGIN);
   char buffer[100];
   DWORD bytes_read;
   BOOL success = ::ReadFile(h, buffer, static_cast<DWORD>(strlen(kDataBuffer)),
                             &bytes_read, nullptr);
   return success ? std::string(buffer, bytes_read) : std::string();
 }
 
 HANDLE GetHandleFromBrokeredAttachment(
     const scoped_refptr<IPC::BrokerableAttachment>& attachment) {
   if (attachment->GetType() !=
-      IPC::BrokerableAttachment::TYPE_BROKERABLE_ATTACHMENT)
+      IPC::BrokerableAttachment::TYPE_BROKERABLE_ATTACHMENT) {
+    LOG(INFO) << "Attachment type not TYPE_BROKERABLE_ATTACHMENT.";
     return nullptr;
-  if (attachment->GetBrokerableType() != IPC::BrokerableAttachment::WIN_HANDLE)
+  }
+
+  if (attachment->GetBrokerableType() !=
+      IPC::BrokerableAttachment::WIN_HANDLE) {
+    LOG(INFO) << "Brokerable type not WIN_HANDLE.";
     return nullptr;
+  }
+
   IPC::internal::HandleAttachmentWin* received_handle_attachment =
       static_cast<IPC::internal::HandleAttachmentWin*>(attachment.get());
   return received_handle_attachment->get_handle();
 }
 
-// Returns true if |attachment| is a file HANDLE whose contents is
-// |kDataBuffer|.
-bool CheckContentsOfBrokeredAttachment(
-    const scoped_refptr<IPC::BrokerableAttachment>& attachment) {
-  HANDLE h = GetHandleFromBrokeredAttachment(attachment);
-  if (h == nullptr)
+// |message| must be deserializable as a TestHandleWinMsg. Returns the HANDLE,
+// or nullptr if deserialization failed.
+HANDLE GetHandleFromTestHandleWinMsg(const IPC::Message& message) {
+  // Expect a message with a brokered attachment.
+  if (!message.HasBrokerableAttachments()) {
+    LOG(INFO) << "Message missing brokerable attachment.";
+    return nullptr;
+  }
+
+  TestHandleWinMsg::Schema::Param p;
+  bool success = TestHandleWinMsg::Read(&message, &p);
+  if (!success) {
+    LOG(INFO) << "Failed to deserialize message.";
+    return nullptr;
+  }
+
+  IPC::HandleWin handle_win = base::get<1>(p);
+  return handle_win.get_handle();
+}
+
+// |message| must be deserializable as a TestTwoHandleWinMsg. Returns the
+// HANDLE, or nullptr if deserialization failed.
+HANDLE GetHandleFromTestTwoHandleWinMsg(const IPC::Message& message,
+                                        int index) {
+  // Expect a message with a brokered attachment.
+  if (!message.HasBrokerableAttachments()) {
+    LOG(INFO) << "Message missing brokerable attachment.";
+    return nullptr;
+  }
+
+  TestTwoHandleWinMsg::Schema::Param p;
+  bool success = TestTwoHandleWinMsg::Read(&message, &p);
+  if (!success) {
+    LOG(INFO) << "Failed to deserialize message.";
+    return nullptr;
+  }
+
+  IPC::HandleWin handle_win;
+  if (index == 0)
+    handle_win = base::get<0>(p);
+  else if (index == 1)
+    handle_win = base::get<1>(p);
+  return handle_win.get_handle();
+}
+
+// |message| must be deserializable as a TestHandleWinMsg. Returns true if the
+// attached file HANDLE has contents |kDataBuffer|.
+bool CheckContentsOfTestMessage(const IPC::Message& message) {
+  HANDLE h = GetHandleFromTestHandleWinMsg(message);
+  if (h == nullptr) {
+    LOG(INFO) << "Failed to get handle from TestHandleWinMsg.";
     return false;
+  }
 
   std::string contents = ReadFromFile(h);
-  return contents == std::string(kDataBuffer);
+  bool success = (contents == std::string(kDataBuffer));
+  if (!success) {
+    LOG(INFO) << "Expected contents: " << std::string(kDataBuffer);
+    LOG(INFO) << "Read contents: " << contents;
+  }
+  return success;
 }
 
 enum TestResult {
   RESULT_UNKNOWN,
   RESULT_SUCCESS,
   RESULT_FAILURE,
 };
 
 // Once the test is finished, send a control message to the parent process with
 // the result. The message may require the runloop to be run before its
@@ skipping 14 matching lines @@
   IPC::BrokerableAttachment::AttachmentId* get_id() { return &id_; }
 
  private:
   IPC::BrokerableAttachment::AttachmentId id_;
 };
 
 // Forwards all messages to |listener_|.  Quits the message loop after a
 // message is received, or the channel has an error.
 class ProxyListener : public IPC::Listener {
  public:
-  ProxyListener() : reason_(MESSAGE_RECEIVED) {}
+  ProxyListener() : listener_(nullptr), reason_(MESSAGE_RECEIVED) {}
   ~ProxyListener() override {}
 
   // The reason for exiting the message loop.
   enum Reason { MESSAGE_RECEIVED, CHANNEL_ERROR };
 
   bool OnMessageReceived(const IPC::Message& message) override {
-    bool result = listener_->OnMessageReceived(message);
+    bool result = false;
+    if (listener_)
+      result = listener_->OnMessageReceived(message);
     reason_ = MESSAGE_RECEIVED;
-    base::MessageLoop::current()->Quit();
+    messages_.push_back(message);
+    base::MessageLoop::current()->QuitNow();
     return result;
   }
 
   void OnChannelError() override {
     reason_ = CHANNEL_ERROR;
-    base::MessageLoop::current()->Quit();
+    base::MessageLoop::current()->QuitNow();
   }
 
   void set_listener(IPC::Listener* listener) { listener_ = listener; }
   Reason get_reason() { return reason_; }
+  IPC::Message get_first_message() { return messages_[0]; }
+  void pop_first_message() { messages_.erase(messages_.begin()); }
+  bool has_message() { return !messages_.empty(); }
 
  private:
   IPC::Listener* listener_;
   Reason reason_;
+  std::vector<IPC::Message> messages_;
 };
 
 // Waits for a result to be sent over the channel.  Quits the message loop
 // after a message is received, or the channel has an error.
 class ResultListener : public IPC::Listener {
  public:
   ResultListener() : result_(RESULT_UNKNOWN) {}
   ~ResultListener() override {}
 
   bool OnMessageReceived(const IPC::Message& message) override {
     base::PickleIterator iter(message);
 
     int result;
     EXPECT_TRUE(iter.ReadInt(&result));
     result_ = static_cast<TestResult>(result);
     return true;
   }
 
   TestResult get_result() { return result_; }
 
  private:
   TestResult result_;
 };
 
 // The parent process acts as an unprivileged process. The forked process acts
 // as the privileged process.
 class IPCAttachmentBrokerPrivilegedWinTest : public IPCTestBase {
  public:
-  IPCAttachmentBrokerPrivilegedWinTest() : message_index_(0) {}
+  IPCAttachmentBrokerPrivilegedWinTest() {}
   ~IPCAttachmentBrokerPrivilegedWinTest() override {}
 
   void SetUp() override {
     IPCTestBase::SetUp();
     ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
     ASSERT_TRUE(base::CreateTemporaryFileInDir(temp_dir_.path(), &temp_path_));
   }
 
   void TearDown() override { IPCTestBase::TearDown(); }
 
@@ skipping 27 matching lines @@
                             static_cast<int>(strlen(kDataBuffer))));
 
     HANDLE h =
         CreateFile(temp_path_.value().c_str(), GENERIC_READ | GENERIC_WRITE, 0,
                    nullptr, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, nullptr);
     EXPECT_NE(h, INVALID_HANDLE_VALUE);
     return h;
   }
 
   void SendMessageWithAttachment(HANDLE h) {
-    IPC::Message* message =
-        new IPC::Message(0, 2, IPC::Message::PRIORITY_NORMAL);
-    message->WriteInt(message_index_++);
-    scoped_refptr<IPC::internal::HandleAttachmentWin> attachment(
-        new IPC::internal::HandleAttachmentWin(h, IPC::HandleWin::DUPLICATE));
-    ASSERT_TRUE(message->WriteAttachment(attachment));
+    IPC::HandleWin handle_win(h, IPC::HandleWin::FILE_READ_WRITE);
+    IPC::Message* message = new TestHandleWinMsg(100, handle_win, 200);
     sender()->Send(message);
   }
 
   ProxyListener* get_proxy_listener() { return &proxy_listener_; }
   IPC::AttachmentBrokerUnprivilegedWin* get_broker() { return broker_.get(); }
   MockObserver* get_observer() { return &observer_; }
 
  private:
   base::ScopedTempDir temp_dir_;
   base::FilePath temp_path_;
-  int message_index_;
   ProxyListener proxy_listener_;
   scoped_ptr<IPC::AttachmentBrokerUnprivilegedWin> broker_;
   MockObserver observer_;
 };
 
 // A broker which always sets the current process as the destination process
 // for attachments.
 class MockBroker : public IPC::AttachmentBrokerUnprivilegedWin {
  public:
   MockBroker() {}
@@ skipping 35 matching lines @@
 
   CommonSetUp();
   ResultListener result_listener;
   get_proxy_listener()->set_listener(&result_listener);
 
   HANDLE h = CreateTempFile();
   HANDLE h2;
   BOOL result = ::DuplicateHandle(GetCurrentProcess(), h, GetCurrentProcess(),
                                   &h2, 0, FALSE, DUPLICATE_CLOSE_SOURCE);
   ASSERT_TRUE(result);
-  SendMessageWithAttachment(h2);
+  IPC::HandleWin handle_win(h2, IPC::HandleWin::DUPLICATE);
+  IPC::Message* message = new TestHandleWinMsg(100, handle_win, 200);
+  sender()->Send(message);
   base::MessageLoop::current()->Run();
 
   // Check the result.
   ASSERT_EQ(ProxyListener::MESSAGE_RECEIVED,
             get_proxy_listener()->get_reason());
   ASSERT_EQ(result_listener.get_result(), RESULT_SUCCESS);
 
   CommonTearDown();
 }
 
@@ skipping 25 matching lines @@
   EXPECT_NE(h2, h);
   EXPECT_NE(h2, nullptr);
 
   // But it still points to the same file.
   std::string contents = ReadFromFile(h);
   EXPECT_EQ(contents, std::string(kDataBuffer));
 
   CommonTearDown();
 }
 
-// Similar to SendHandle, except this test uses the HandleWin class.
-TEST_F(IPCAttachmentBrokerPrivilegedWinTest, SendHandleWin) {
-  Init("SendHandleWin");
+// Similar to SendHandle, but sends a message with the same handle twice.
+TEST_F(IPCAttachmentBrokerPrivilegedWinTest, SendTwoHandles) {
+  Init("SendTwoHandles");
 
   CommonSetUp();
   ResultListener result_listener;
   get_proxy_listener()->set_listener(&result_listener);
 
   HANDLE h = CreateTempFile();
-  IPC::HandleWin handle_win(h, IPC::HandleWin::FILE_READ_WRITE);
-  IPC::Message* message = new IPC::Message(0, 2, IPC::Message::PRIORITY_NORMAL);
-  message->WriteInt(0);
-  IPC::ParamTraits<IPC::HandleWin>::Write(message, handle_win);
+  IPC::HandleWin handle_win1(h, IPC::HandleWin::FILE_READ_WRITE);
+  IPC::HandleWin handle_win2(h, IPC::HandleWin::FILE_READ_WRITE);
+  IPC::Message* message = new TestTwoHandleWinMsg(handle_win1, handle_win2);
   sender()->Send(message);
   base::MessageLoop::current()->Run();
 
   // Check the result.
   ASSERT_EQ(ProxyListener::MESSAGE_RECEIVED,
             get_proxy_listener()->get_reason());
   ASSERT_EQ(result_listener.get_result(), RESULT_SUCCESS);
 
   CommonTearDown();
 }
 
-using OnMessageReceivedCallback =
-    void (*)(MockObserver* observer,
-             IPC::AttachmentBrokerPrivilegedWin* broker,
-             IPC::Sender* sender);
+// Similar to SendHandle, but sends the same message twice.
+TEST_F(IPCAttachmentBrokerPrivilegedWinTest, SendHandleTwice) {
+  Init("SendHandleTwice");
+
+  CommonSetUp();
+  ResultListener result_listener;
+  get_proxy_listener()->set_listener(&result_listener);
+
+  HANDLE h = CreateTempFile();
+  SendMessageWithAttachment(h);
+  SendMessageWithAttachment(h);
+  base::MessageLoop::current()->Run();
+
+  // Check the result.
+  ASSERT_EQ(ProxyListener::MESSAGE_RECEIVED,
+            get_proxy_listener()->get_reason());
+  ASSERT_EQ(result_listener.get_result(), RESULT_SUCCESS);
+
+  CommonTearDown();
+}
+
+using OnMessageReceivedCallback = void (*)(IPC::Sender* sender,
+                                           const IPC::Message& message);
 
 int CommonPrivilegedProcessMain(OnMessageReceivedCallback callback,
                                 const char* channel_name) {
+  LOG(INFO) << "Privileged process start.";
   base::MessageLoopForIO main_message_loop;
   ProxyListener listener;
 
   // Set up IPC channel.
   IPC::AttachmentBrokerPrivilegedWin broker;
-  listener.set_listener(&broker);
   scoped_ptr<IPC::Channel> channel(IPC::Channel::CreateClient(
       IPCTestBase::GetChannelName(channel_name), &listener, &broker));
   broker.RegisterCommunicationChannel(channel.get());
   CHECK(channel->Connect());
 
-  MockObserver observer;
-  broker.AddObserver(&observer);
-
   while (true) {
+    LOG(INFO) << "Privileged process spinning run loop.";
     base::MessageLoop::current()->Run();
     ProxyListener::Reason reason = listener.get_reason();
     if (reason == ProxyListener::CHANNEL_ERROR)
       break;
 
-    callback(&observer, &broker, channel.get());
+    while (listener.has_message()) {
+      LOG(INFO) << "Privileged process running callback.";
+      callback(channel.get(), listener.get_first_message());
+      LOG(INFO) << "Privileged process finishing callback.";
+      listener.pop_first_message();
+    }
   }
 
+  LOG(INFO) << "Privileged process end.";
   return 0;
 }
 
-void SendHandleCallback(MockObserver* observer,
-                        IPC::AttachmentBrokerPrivilegedWin* broker,
-                        IPC::Sender* sender) {
-  IPC::BrokerableAttachment::AttachmentId* id = observer->get_id();
-  scoped_refptr<IPC::BrokerableAttachment> received_attachment;
-  broker->GetAttachmentWithId(*id, &received_attachment);
-
-  // Check that it's the expected handle.
-  bool success = CheckContentsOfBrokeredAttachment(received_attachment);
-
+void SendHandleCallback(IPC::Sender* sender, const IPC::Message& message) {
+  bool success = CheckContentsOfTestMessage(message);
   SendControlMessage(sender, success);
 }
 
 MULTIPROCESS_IPC_TEST_CLIENT_MAIN(SendHandle) {
   return CommonPrivilegedProcessMain(&SendHandleCallback, "SendHandle");
 }
 
-void SendHandleWithoutPermissionsCallback(
-    MockObserver* observer,
-    IPC::AttachmentBrokerPrivilegedWin* broker,
-    IPC::Sender* sender) {
-  IPC::BrokerableAttachment::AttachmentId* id = observer->get_id();
-  scoped_refptr<IPC::BrokerableAttachment> received_attachment;
-  broker->GetAttachmentWithId(*id, &received_attachment);
-
-  // Check that it's the expected handle.
-  HANDLE h = GetHandleFromBrokeredAttachment(received_attachment);
+void SendHandleWithoutPermissionsCallback(IPC::Sender* sender,
+                                          const IPC::Message& message) {
+  HANDLE h = GetHandleFromTestHandleWinMsg(message);
   if (h != nullptr) {
     SetFilePointer(h, 0, nullptr, FILE_BEGIN);
 
     char buffer[100];
     DWORD bytes_read;
     BOOL success =
         ::ReadFile(h, buffer, static_cast<DWORD>(strlen(kDataBuffer)),
                    &bytes_read, nullptr);
     if (!success && GetLastError() == ERROR_ACCESS_DENIED) {
       SendControlMessage(sender, true);
       return;
     }
   }
 
   SendControlMessage(sender, false);
 }
 
 MULTIPROCESS_IPC_TEST_CLIENT_MAIN(SendHandleWithoutPermissions) {
   return CommonPrivilegedProcessMain(&SendHandleWithoutPermissionsCallback,
                                      "SendHandleWithoutPermissions");
 }
 
-void SendHandleToSelfCallback(MockObserver* observer,
-                              IPC::AttachmentBrokerPrivilegedWin* broker,
-                              IPC::Sender* sender) {
+void SendHandleToSelfCallback(IPC::Sender* sender, const IPC::Message&) {
   // Do nothing special. The default behavior already runs the
   // AttachmentBrokerPrivilegedWin.
 }
 
 MULTIPROCESS_IPC_TEST_CLIENT_MAIN(SendHandleToSelf) {
   return CommonPrivilegedProcessMain(&SendHandleToSelfCallback,
                                      "SendHandleToSelf");
 }
 
-MULTIPROCESS_IPC_TEST_CLIENT_MAIN(SendHandleWin) {
-  return CommonPrivilegedProcessMain(&SendHandleCallback, "SendHandleWin");
+void SendTwoHandlesCallback(IPC::Sender* sender, const IPC::Message& message) {
+  // Check for two handles.
+  HANDLE h1 = GetHandleFromTestTwoHandleWinMsg(message, 0);
+  HANDLE h2 = GetHandleFromTestTwoHandleWinMsg(message, 1);
+  if (h1 == nullptr || h2 == nullptr) {
+    SendControlMessage(sender, false);
+    return;
+  }
+
+  // Check that their contents are correct.
+  std::string contents1 = ReadFromFile(h1);
+  std::string contents2 = ReadFromFile(h2);
+  if (contents1 != std::string(kDataBuffer) ||
+      contents2 != std::string(kDataBuffer)) {
+    SendControlMessage(sender, false);
+    return;
+  }
+
+  // Check that the handles point to the same file.
+  const char text[] = "katy perry";
+  DWORD bytes_written = 0;
+  SetFilePointer(h1, 0, nullptr, FILE_BEGIN);
+  BOOL success = ::WriteFile(h1, text, static_cast<DWORD>(strlen(text)),
+                             &bytes_written, nullptr);
+  if (!success) {
+    SendControlMessage(sender, false);
+    return;
+  }
+
+  SetFilePointer(h2, 0, nullptr, FILE_BEGIN);
+  char buffer[100];
+  DWORD bytes_read;
+  success = ::ReadFile(h2, buffer, static_cast<DWORD>(strlen(text)),
+                       &bytes_read, nullptr);
+  if (!success) {
+    SendControlMessage(sender, false);
+    return;
+  }
+  success = std::string(buffer, bytes_read) == std::string(text);
+  SendControlMessage(sender, success);
+}
+
+MULTIPROCESS_IPC_TEST_CLIENT_MAIN(SendTwoHandles) {
+  return CommonPrivilegedProcessMain(&SendTwoHandlesCallback, "SendTwoHandles");
+}
+
+void SendHandleTwiceCallback(IPC::Sender* sender, const IPC::Message& message) {
+  // We expect the same message twice.
+  static int i = 0;
+  static bool success = true;
+  success &= CheckContentsOfTestMessage(message);
+  if (i == 0) {
+    LOG(INFO) << "Received first message.";
+    ++i;
+  } else {
+    LOG(INFO) << "Received second message.";
+    SendControlMessage(sender, success);
+  }
+}
+
+MULTIPROCESS_IPC_TEST_CLIENT_MAIN(SendHandleTwice) {
+  return CommonPrivilegedProcessMain(&SendHandleTwiceCallback,
+                                     "SendHandleTwice");
 }
 
 }  // namespace