1 // Copyright 2013 The Chromium Authors. All rights reserved. 2 // Use of this source code is governed by a BSD-style license that can be 3 // found in the LICENSE file. 4 5 // Multiply-included message file, hence no include guard. 6 7 // This file defines the IPCs for the browser-side implementation of 8 // WebSockets. For the legacy renderer-side implementation, see 9 // socket_stream_messages.h. 10 // TODO(ricea): Fix this comment when the legacy implementation has been 11 // removed. 12 // 13 // This IPC interface is based on the WebSocket multiplexing draft spec, 14 // http://tools.ietf.org/html/draft-ietf-hybi-websocket-multiplexing-09 15 16 #include <string> 17 #include <vector> 18 19 #include "base/basictypes.h" 20 #include "content/common/content_export.h" 21 #include "content/common/websocket.h" 22 #include "ipc/ipc_message_macros.h" 23 #include "url/gurl.h" 24 #include "url/origin.h" 25 26 #undef IPC_MESSAGE_EXPORT 27 #define IPC_MESSAGE_EXPORT CONTENT_EXPORT 28 #define IPC_MESSAGE_START WebSocketMsgStart 29 30 IPC_ENUM_TRAITS_MAX_VALUE(content::WebSocketMessageType, 31 content::WEB_SOCKET_MESSAGE_TYPE_LAST) 32 33 IPC_STRUCT_TRAITS_BEGIN(content::WebSocketHandshakeRequest) 34 IPC_STRUCT_TRAITS_MEMBER(url) 35 IPC_STRUCT_TRAITS_MEMBER(headers) 36 IPC_STRUCT_TRAITS_MEMBER(headers_text) 37 IPC_STRUCT_TRAITS_MEMBER(request_time) 38 IPC_STRUCT_TRAITS_END() 39 40 IPC_STRUCT_TRAITS_BEGIN(content::WebSocketHandshakeResponse) 41 IPC_STRUCT_TRAITS_MEMBER(url) 42 IPC_STRUCT_TRAITS_MEMBER(status_code) 43 IPC_STRUCT_TRAITS_MEMBER(status_text) 44 IPC_STRUCT_TRAITS_MEMBER(headers) 45 IPC_STRUCT_TRAITS_MEMBER(headers_text) 46 IPC_STRUCT_TRAITS_MEMBER(response_time) 47 IPC_STRUCT_TRAITS_END() 48 49 // WebSocket messages sent from the renderer to the browser. 50 51 // Open new virtual WebSocket connection to |socket_url|. |channel_id| is an 52 // identifier chosen by the renderer for the new channel. It cannot correspond 53 // to an existing open channel, and must be between 1 and 54 // 0x7FFFFFFF. |requested_protocols| is a list of tokens identifying 55 // sub-protocols the renderer would like to use, as described in RFC6455 56 // "Subprotocols Using the WebSocket Protocol". 57 // 58 // The browser process will not send |channel_id| as-is to the remote server; it 59 // will try to use a short id on the wire. This saves the renderer from 60 // having to try to choose the ids cleverly. 61 IPC_MESSAGE_ROUTED4(WebSocketHostMsg_AddChannelRequest, 62 GURL /* socket_url */, 63 std::vector<std::string> /* requested_protocols */, 64 url::Origin /* origin */, 65 int /* render_frame_id */) 66 67 // WebSocket messages sent from the browser to the renderer. 68 69 // Respond to an AddChannelRequest for channel |channel_id|. |channel_id| is 70 // scoped to the renderer process; while it is unique per-renderer, the browser 71 // may have multiple renderers using the same id. If |fail| is true, the channel 72 // could not be established (the cause of the failure is not provided to the 73 // renderer in order to limit its ability to abuse WebSockets to perform network 74 // probing, etc.). If |fail| is set then the |channel_id| is available for 75 // re-use. |selected_protocol| is the sub-protocol the server selected, 76 // or empty if no sub-protocol was selected. |extensions| is the list of 77 // extensions negotiated for the connection. 78 IPC_MESSAGE_ROUTED3(WebSocketMsg_AddChannelResponse, 79 bool /* fail */, 80 std::string /* selected_protocol */, 81 std::string /* extensions */) 82 83 // Notify the renderer that the browser has started an opening handshake. 84 // This message is for showing the request in the inspector and 85 // can be omitted if the inspector is not active. 86 IPC_MESSAGE_ROUTED1(WebSocketMsg_NotifyStartOpeningHandshake, 87 content::WebSocketHandshakeRequest /* request */) 88 89 // Notify the renderer that the browser has finished an opening handshake. 90 // This message precedes AddChannelResponse. 91 // This message is for showing the response in the inspector and 92 // can be omitted if the inspector is not active. 93 IPC_MESSAGE_ROUTED1(WebSocketMsg_NotifyFinishOpeningHandshake, 94 content::WebSocketHandshakeResponse /* response */) 95 96 // Notify the renderer that the browser is required to fail the connection 97 // (see RFC6455 7.1.7 for details). 98 // When the renderer process receives this messages it does the following: 99 // 1. Fire an error event. 100 // 2. Show |message| to the inspector. 101 // 3. Close the channel immediately uncleanly, as if it received 102 // DropChannel(was_clean = false, code = 1006, reason = ""). 103 // |message| will be shown in the inspector and won't be passed to the script. 104 // TODO(yhirano): Find the way to pass |message| directly to the inspector 105 // process. 106 IPC_MESSAGE_ROUTED1(WebSocketMsg_NotifyFailure, 107 std::string /* message */) 108 109 // WebSocket messages that can be sent in either direction. 110 111 // Send a non-control frame on |channel_id|. If the sender is the renderer, it 112 // will be sent to the remote server. If the sender is the browser, it comes 113 // from the remote server. |fin| indicates that this frame is the last in the 114 // current message. |type| is the type of the message. On the first frame of a 115 // message, it must be set to either WEB_SOCKET_MESSAGE_TYPE_TEXT or 116 // WEB_SOCKET_MESSAGE_TYPE_BINARY. On subsequent frames, it must be set to 117 // WEB_SOCKET_MESSAGE_TYPE_CONTINUATION, and the type is the same as that of the 118 // first message. If |type| is WEB_SOCKET_MESSAGE_TYPE_TEXT, then the 119 // concatenation of the |data| from every frame in the message must be valid 120 // UTF-8. If |fin| is not set, |data| must be non-empty. 121 IPC_MESSAGE_ROUTED3(WebSocketMsg_SendFrame, 122 bool /* fin */, 123 content::WebSocketMessageType /* type */, 124 std::vector<char> /* data */) 125 126 // Add |quota| tokens of send quota for channel |channel_id|. |quota| must be a 127 // positive integer. Both the browser and the renderer set send quota for the 128 // other side, and check that quota has not been exceeded when receiving 129 // messages. Both sides start a new channel with a quota of 0, and must wait for 130 // a FlowControl message before calling SendFrame. The total available quota on 131 // one side must never exceed 0x7FFFFFFFFFFFFFFF tokens. 132 IPC_MESSAGE_ROUTED1(WebSocketMsg_FlowControl, 133 int64 /* quota */) 134 135 // Drop the channel. 136 // When sent by the renderer, this will cause a DropChannel message to be sent 137 // if the multiplex extension is in use, otherwise a Close message will be sent 138 // and the TCP/IP connection will be closed. 139 // When sent by the browser, this indicates that a Close or DropChannel has been 140 // received, the connection was closed, or a network or protocol error 141 // occurred. On receiving DropChannel, the renderer process may consider the 142 // |channel_id| available for reuse by a new AddChannelRequest. 143 // |code| is one of the reason codes specified in RFC6455 or 144 // draft-ietf-hybi-websocket-multiplexing-09. |reason|, if non-empty, is a 145 // UTF-8 encoded string which may be useful for debugging but is not necessarily 146 // human-readable, as supplied by the server in the Close or DropChannel 147 // message. 148 // If |was_clean| is false on a message from the browser, then the WebSocket 149 // connection was not closed cleanly. If |was_clean| is false on a message from 150 // the renderer, then the connection should be closed immediately without a 151 // closing handshake and the renderer cannot accept any new messages on this 152 // connection. 153 IPC_MESSAGE_ROUTED3(WebSocketMsg_DropChannel, 154 bool /* was_clean */, 155 unsigned short /* code */, 156 std::string /* reason */) 157 158 // Notify the renderer that a closing handshake has been initiated by the 159 // server, so that it can set the Javascript readyState to CLOSING. 160 IPC_MESSAGE_ROUTED0(WebSocketMsg_NotifyClosing) 161
