brettw@chromium.org | d805c6a | 2012-03-08 12:30:28 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
license.bot | bf09a50 | 2008-08-24 00:55:55 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 4 | |
agl@chromium.org | 946d1b2 | 2009-07-22 23:57:21 | [diff] [blame] | 5 | #ifndef IPC_IPC_CHANNEL_H_ |
| 6 | #define IPC_IPC_CHANNEL_H_ |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 7 | |
jschuh@chromium.org | 5c41e6e1 | 2012-03-17 02:20:46 | [diff] [blame] | 8 | #include <string> |
| 9 | |
shenhan@google.com | 3fcbd4b | 2012-06-05 01:54:46 | [diff] [blame] | 10 | #if defined(OS_POSIX) |
| 11 | #include <sys/types.h> |
| 12 | #endif |
| 13 | |
evan@chromium.org | 39703fb | 2010-10-19 19:11:15 | [diff] [blame] | 14 | #include "base/compiler_specific.h" |
morrita | a409ccc | 2014-10-20 23:53:25 | [diff] [blame^] | 15 | #include "base/files/scoped_file.h" |
rsesek@chromium.org | e66ef60 | 2013-07-24 05:15:24 | [diff] [blame] | 16 | #include "base/process/process.h" |
dmaclach@chromium.org | 42ce94e | 2010-12-08 19:28:09 | [diff] [blame] | 17 | #include "ipc/ipc_channel_handle.h" |
agl@chromium.org | 946d1b2 | 2009-07-22 23:57:21 | [diff] [blame] | 18 | #include "ipc/ipc_message.h" |
brettw@chromium.org | 57319ce | 2012-06-11 22:35:26 | [diff] [blame] | 19 | #include "ipc/ipc_sender.h" |
| 20 | |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 21 | namespace IPC { |
brettw@chromium.org | 57319ce | 2012-06-11 22:35:26 | [diff] [blame] | 22 | |
| 23 | class Listener; |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 24 | |
| 25 | //------------------------------------------------------------------------------ |
dmaclach@chromium.org | 22b42c5 | 2010-12-20 06:59:23 | [diff] [blame] | 26 | // See |
| 27 | // http://www.chromium.org/developers/design-documents/inter-process-communication |
| 28 | // for overview of IPC in Chromium. |
| 29 | |
| 30 | // Channels are implemented using named pipes on Windows, and |
| 31 | // socket pairs (or in some special cases unix domain sockets) on POSIX. |
| 32 | // On Windows we access pipes in various processes by name. |
| 33 | // On POSIX we pass file descriptors to child processes and assign names to them |
| 34 | // in a lookup table. |
| 35 | // In general on POSIX we do not use unix domain sockets due to security |
| 36 | // concerns and the fact that they can leave garbage around the file system |
| 37 | // (MacOS does not support abstract named unix domain sockets). |
| 38 | // You can use unix domain sockets if you like on POSIX by constructing the |
| 39 | // the channel with the mode set to one of the NAMED modes. NAMED modes are |
| 40 | // currently used by automation and service processes. |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 41 | |
brettw@chromium.org | 57319ce | 2012-06-11 22:35:26 | [diff] [blame] | 42 | class IPC_EXPORT Channel : public Sender { |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 43 | // Security tests need access to the pipe handle. |
| 44 | friend class ChannelTest; |
| 45 | |
| 46 | public: |
dmaclach@chromium.org | 1707726c | 2011-02-03 20:35:09 | [diff] [blame] | 47 | // Flags to test modes |
| 48 | enum ModeFlags { |
| 49 | MODE_NO_FLAG = 0x0, |
| 50 | MODE_SERVER_FLAG = 0x1, |
| 51 | MODE_CLIENT_FLAG = 0x2, |
wez@chromium.org | 8ec3fbe | 2011-04-06 12:01:44 | [diff] [blame] | 52 | MODE_NAMED_FLAG = 0x4, |
| 53 | #if defined(OS_POSIX) |
| 54 | MODE_OPEN_ACCESS_FLAG = 0x8, // Don't restrict access based on client UID. |
| 55 | #endif |
dmaclach@chromium.org | 1707726c | 2011-02-03 20:35:09 | [diff] [blame] | 56 | }; |
| 57 | |
| 58 | // Some Standard Modes |
morrita@chromium.org | e482111a8 | 2014-05-30 03:58:59 | [diff] [blame] | 59 | // TODO(morrita): These are under deprecation work. You should use Create*() |
| 60 | // functions instead. |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 61 | enum Mode { |
dmaclach@chromium.org | 1707726c | 2011-02-03 20:35:09 | [diff] [blame] | 62 | MODE_NONE = MODE_NO_FLAG, |
| 63 | MODE_SERVER = MODE_SERVER_FLAG, |
| 64 | MODE_CLIENT = MODE_CLIENT_FLAG, |
dmaclach@chromium.org | 1707726c | 2011-02-03 20:35:09 | [diff] [blame] | 65 | MODE_NAMED_SERVER = MODE_SERVER_FLAG | MODE_NAMED_FLAG, |
| 66 | MODE_NAMED_CLIENT = MODE_CLIENT_FLAG | MODE_NAMED_FLAG, |
wez@chromium.org | 8ec3fbe | 2011-04-06 12:01:44 | [diff] [blame] | 67 | #if defined(OS_POSIX) |
wez@chromium.org | 8ec3fbe | 2011-04-06 12:01:44 | [diff] [blame] | 68 | MODE_OPEN_NAMED_SERVER = MODE_OPEN_ACCESS_FLAG | MODE_SERVER_FLAG | |
| 69 | MODE_NAMED_FLAG |
| 70 | #endif |
brettw@chromium.org | d805c6a | 2012-03-08 12:30:28 | [diff] [blame] | 71 | }; |
| 72 | |
hubbe@chromium.org | dc875dc | 2013-10-15 00:07:00 | [diff] [blame] | 73 | // Messages internal to the IPC implementation are defined here. |
| 74 | // Uses Maximum value of message type (uint16), to avoid conflicting |
| 75 | // with normal message types, which are enumeration constants starting from 0. |
brettw@chromium.org | d805c6a | 2012-03-08 12:30:28 | [diff] [blame] | 76 | enum { |
hubbe@chromium.org | dc875dc | 2013-10-15 00:07:00 | [diff] [blame] | 77 | // The Hello message is sent by the peer when the channel is connected. |
| 78 | // The message contains just the process id (pid). |
| 79 | // The message has a special routing_id (MSG_ROUTING_NONE) |
| 80 | // and type (HELLO_MESSAGE_TYPE). |
| 81 | HELLO_MESSAGE_TYPE = kuint16max, |
| 82 | // The CLOSE_FD_MESSAGE_TYPE is used in the IPC class to |
| 83 | // work around a bug in sendmsg() on Mac. When an FD is sent |
| 84 | // over the socket, a CLOSE_FD_MESSAGE is sent with hops = 2. |
| 85 | // The client will return the message with hops = 1, *after* it |
| 86 | // has received the message that contains the FD. When we |
| 87 | // receive it again on the sender side, we close the FD. |
| 88 | CLOSE_FD_MESSAGE_TYPE = HELLO_MESSAGE_TYPE - 1 |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 89 | }; |
| 90 | |
pkasting@chromium.org | 05094a3 | 2011-09-01 00:50:13 | [diff] [blame] | 91 | // The maximum message size in bytes. Attempting to receive a message of this |
| 92 | // size or bigger results in a channel error. |
| 93 | static const size_t kMaximumMessageSize = 128 * 1024 * 1024; |
jeremy@chromium.org | 514411fc | 2008-12-10 22:28:11 | [diff] [blame] | 94 | |
viettrungluu@chromium.org | 4c4c0dc | 2013-01-05 02:13:04 | [diff] [blame] | 95 | // Amount of data to read at once from the pipe. |
pkasting@chromium.org | 05094a3 | 2011-09-01 00:50:13 | [diff] [blame] | 96 | static const size_t kReadBufferSize = 4 * 1024; |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 97 | |
| 98 | // Initialize a Channel. |
| 99 | // |
dmaclach@chromium.org | 42ce94e | 2010-12-08 19:28:09 | [diff] [blame] | 100 | // |channel_handle| identifies the communication Channel. For POSIX, if |
| 101 | // the file descriptor in the channel handle is != -1, the channel takes |
| 102 | // ownership of the file descriptor and will close it appropriately, otherwise |
| 103 | // it will create a new descriptor internally. |
rvargas@google.com | c1afbd2c | 2008-10-13 19:19:36 | [diff] [blame] | 104 | // |listener| receives a callback on the current thread for each newly |
| 105 | // received message. |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 106 | // |
morrita@chromium.org | e482111a8 | 2014-05-30 03:58:59 | [diff] [blame] | 107 | // There are four type of modes how channels operate: |
| 108 | // |
| 109 | // - Server and named server: In these modes, the Channel is |
| 110 | // responsible for settingb up the IPC object |
| 111 | // - An "open" named server: It accepts connections from ANY client. |
| 112 | // The caller must then implement their own access-control based on the |
| 113 | // client process' user Id. |
| 114 | // - Client and named client: In these mode, the Channel merely |
| 115 | // connects to the already established IPC object. |
| 116 | // |
| 117 | // Each mode has its own Create*() API to create the Channel object. |
| 118 | // |
| 119 | // TODO(morrita): Replace CreateByModeForProxy() with one of above Create*(). |
| 120 | // |
morrita@chromium.org | 2f60c9b | 2014-06-06 20:13:51 | [diff] [blame] | 121 | static scoped_ptr<Channel> Create( |
morrita | 373af03 | 2014-09-09 19:35:24 | [diff] [blame] | 122 | const IPC::ChannelHandle &channel_handle, Mode mode, Listener* listener); |
morrita@chromium.org | 2f60c9b | 2014-06-06 20:13:51 | [diff] [blame] | 123 | |
morrita@chromium.org | e482111a8 | 2014-05-30 03:58:59 | [diff] [blame] | 124 | static scoped_ptr<Channel> CreateClient( |
| 125 | const IPC::ChannelHandle &channel_handle, Listener* listener); |
| 126 | |
| 127 | // Channels on Windows are named by default and accessible from other |
| 128 | // processes. On POSIX channels are anonymous by default and not accessible |
| 129 | // from other processes. Named channels work via named unix domain sockets. |
| 130 | // On Windows MODE_NAMED_SERVER is equivalent to MODE_SERVER and |
| 131 | // MODE_NAMED_CLIENT is equivalent to MODE_CLIENT. |
| 132 | static scoped_ptr<Channel> CreateNamedServer( |
| 133 | const IPC::ChannelHandle &channel_handle, Listener* listener); |
| 134 | static scoped_ptr<Channel> CreateNamedClient( |
| 135 | const IPC::ChannelHandle &channel_handle, Listener* listener); |
| 136 | #if defined(OS_POSIX) |
| 137 | // An "open" named server accepts connections from ANY client. |
| 138 | // The caller must then implement their own access-control based on the |
| 139 | // client process' user Id. |
| 140 | static scoped_ptr<Channel> CreateOpenNamedServer( |
| 141 | const IPC::ChannelHandle &channel_handle, Listener* listener); |
| 142 | #endif |
| 143 | static scoped_ptr<Channel> CreateServer( |
| 144 | const IPC::ChannelHandle &channel_handle, Listener* listener); |
| 145 | |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 146 | |
hans@chromium.org | 3690ebe0 | 2011-05-25 09:08:19 | [diff] [blame] | 147 | virtual ~Channel(); |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 148 | |
| 149 | // Connect the pipe. On the server side, this will initiate |
| 150 | // waiting for connections. On the client, it attempts to |
| 151 | // connect to a pre-existing pipe. Note, calling Connect() |
| 152 | // will not block the calling thread and may complete |
| 153 | // asynchronously. |
morrita@chromium.org | 2f60c9b | 2014-06-06 20:13:51 | [diff] [blame] | 154 | virtual bool Connect() WARN_UNUSED_RESULT = 0; |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 155 | |
| 156 | // Close this Channel explicitly. May be called multiple times. |
dmaclach@chromium.org | 22b42c5 | 2010-12-20 06:59:23 | [diff] [blame] | 157 | // On POSIX calling close on an IPC channel that listens for connections will |
| 158 | // cause it to close any accepted connections, and it will stop listening for |
| 159 | // new connections. If you just want to close the currently accepted |
| 160 | // connection and listen for new ones, use ResetToAcceptingConnectionState. |
morrita@chromium.org | 2f60c9b | 2014-06-06 20:13:51 | [diff] [blame] | 161 | virtual void Close() = 0; |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 162 | |
jschuh@chromium.org | 0a6fc4b | 2012-04-05 02:38:34 | [diff] [blame] | 163 | // Get the process ID for the connected peer. |
brettw@chromium.org | 108fd34 | 2013-01-04 20:46:54 | [diff] [blame] | 164 | // |
| 165 | // Returns base::kNullProcessId if the peer is not connected yet. Watch out |
| 166 | // for race conditions. You can easily get a channel to another process, but |
| 167 | // if your process has not yet processed the "hello" message from the remote |
| 168 | // side, this will fail. You should either make sure calling this is either |
| 169 | // in response to a message from the remote side (which guarantees that it's |
| 170 | // been connected), or you wait for the "connected" notification on the |
| 171 | // listener. |
morrita@chromium.org | 2f60c9b | 2014-06-06 20:13:51 | [diff] [blame] | 172 | virtual base::ProcessId GetPeerPID() const = 0; |
jschuh@chromium.org | 0a6fc4b | 2012-04-05 02:38:34 | [diff] [blame] | 173 | |
morrita@chromium.org | 6486088 | 2014-08-04 23:44:17 | [diff] [blame] | 174 | // Get its own process id. This value is told to the peer. |
| 175 | virtual base::ProcessId GetSelfPID() const = 0; |
| 176 | |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 177 | // Send a message over the Channel to the listener on the other end. |
| 178 | // |
rvargas@google.com | c1afbd2c | 2008-10-13 19:19:36 | [diff] [blame] | 179 | // |message| must be allocated using operator new. This object will be |
| 180 | // deleted once the contents of the Message have been sent. |
morrita@chromium.org | 2f60c9b | 2014-06-06 20:13:51 | [diff] [blame] | 181 | virtual bool Send(Message* message) = 0; |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 182 | |
morrita@chromium.org | 2f60c9b | 2014-06-06 20:13:51 | [diff] [blame] | 183 | #if defined(OS_POSIX) && !defined(OS_NACL) |
jeremy@chromium.org | df3c1ca1 | 2008-12-19 21:37:01 | [diff] [blame] | 184 | // On POSIX an IPC::Channel wraps a socketpair(), this method returns the |
agl@chromium.org | cc8f146 | 2009-06-12 17:36:55 | [diff] [blame] | 185 | // FD # for the client end of the socket. |
jeremy@chromium.org | df3c1ca1 | 2008-12-19 21:37:01 | [diff] [blame] | 186 | // This method may only be called on the server side of a channel. |
phajdan.jr@chromium.org | 2ce26c43 | 2011-09-19 17:08:12 | [diff] [blame] | 187 | // This method can be called on any thread. |
morrita@chromium.org | 2f60c9b | 2014-06-06 20:13:51 | [diff] [blame] | 188 | virtual int GetClientFileDescriptor() const = 0; |
dmaclach@chromium.org | 22b42c5 | 2010-12-20 06:59:23 | [diff] [blame] | 189 | |
phajdan.jr@chromium.org | 2ce26c43 | 2011-09-19 17:08:12 | [diff] [blame] | 190 | // Same as GetClientFileDescriptor, but transfers the ownership of the |
| 191 | // file descriptor to the caller. |
| 192 | // This method can be called on any thread. |
morrita | a409ccc | 2014-10-20 23:53:25 | [diff] [blame^] | 193 | virtual base::ScopedFD TakeClientFileDescriptor() = 0; |
wez@chromium.org | 8ec3fbe | 2011-04-06 12:01:44 | [diff] [blame] | 194 | #endif // defined(OS_POSIX) && !defined(OS_NACL) |
neb@chromium.org | 74f2754 | 2010-03-31 17:44:57 | [diff] [blame] | 195 | |
kkania@chromium.org | 313c00e5 | 2011-08-09 06:46:06 | [diff] [blame] | 196 | // Returns true if a named server channel is initialized on the given channel |
| 197 | // ID. Even if true, the server may have already accepted a connection. |
| 198 | static bool IsNamedServerInitialized(const std::string& channel_id); |
| 199 | |
bbudge@chromium.org | bccbaf2 | 2012-09-28 21:46:01 | [diff] [blame] | 200 | #if !defined(OS_NACL) |
jschuh@chromium.org | 5c41e6e1 | 2012-03-17 02:20:46 | [diff] [blame] | 201 | // Generates a channel ID that's non-predictable and unique. |
| 202 | static std::string GenerateUniqueRandomChannelID(); |
| 203 | |
| 204 | // Generates a channel ID that, if passed to the client as a shared secret, |
| 205 | // will validate that the client's authenticity. On platforms that do not |
| 206 | // require additional this is simply calls GenerateUniqueRandomChannelID(). |
| 207 | // For portability the prefix should not include the \ character. |
| 208 | static std::string GenerateVerifiedChannelID(const std::string& prefix); |
bbudge@chromium.org | bccbaf2 | 2012-09-28 21:46:01 | [diff] [blame] | 209 | #endif |
jschuh@chromium.org | 5c41e6e1 | 2012-03-17 02:20:46 | [diff] [blame] | 210 | |
jamescook@chromium.org | e1d67a88 | 2011-08-31 21:11:04 | [diff] [blame] | 211 | #if defined(OS_LINUX) |
| 212 | // Sandboxed processes live in a PID namespace, so when sending the IPC hello |
| 213 | // message from client to server we need to send the PID from the global |
| 214 | // PID namespace. |
| 215 | static void SetGlobalPid(int pid); |
| 216 | #endif |
| 217 | |
epenner@chromium.org | e097b93 | 2014-03-19 06:34:52 | [diff] [blame] | 218 | #if defined(OS_ANDROID) |
| 219 | // Most tests are single process and work the same on all platforms. However |
| 220 | // in some cases we want to test multi-process, and Android differs in that it |
| 221 | // can't 'exec' after forking. This callback resets any data in the forked |
| 222 | // process such that it acts similar to if it was exec'd, for tests. |
| 223 | static void NotifyProcessForkedForTesting(); |
| 224 | #endif |
| 225 | |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 226 | }; |
| 227 | |
hidehiko@chromium.org | 2648d5f9 | 2014-02-21 15:05:25 | [diff] [blame] | 228 | #if defined(OS_POSIX) |
| 229 | // SocketPair() creates a pair of socket FDs suitable for using with |
| 230 | // IPC::Channel. |
| 231 | IPC_EXPORT bool SocketPair(int* fd1, int* fd2); |
| 232 | #endif |
| 233 | |
jeremy@chromium.org | 514411fc | 2008-12-10 22:28:11 | [diff] [blame] | 234 | } // namespace IPC |
initial.commit | 09911bf | 2008-07-26 23:55:29 | [diff] [blame] | 235 | |
agl@chromium.org | 946d1b2 | 2009-07-22 23:57:21 | [diff] [blame] | 236 | #endif // IPC_IPC_CHANNEL_H_ |