WebSocket: Add binaryType attribute
[WebKit-https.git] / Source / WebCore / websockets / WebSocketHandshake.h
1 /*
2  * Copyright (C) 2011 Google Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebSocketHandshake_h
32 #define WebSocketHandshake_h
33
34 #if ENABLE(WEB_SOCKETS)
35
36 #include "KURL.h"
37 #include "PlatformString.h"
38 #include "WebSocketHandshakeRequest.h"
39 #include "WebSocketHandshakeResponse.h"
40
41 namespace WebCore {
42
43     class ScriptExecutionContext;
44
45     class WebSocketHandshake {
46         WTF_MAKE_NONCOPYABLE(WebSocketHandshake);
47     public:
48         enum Mode {
49             Incomplete, Normal, Failed, Connected
50         };
51         WebSocketHandshake(const KURL&, const String& protocol, ScriptExecutionContext*, bool useHixie76Protocol);
52         ~WebSocketHandshake();
53
54         const KURL& url() const;
55         void setURL(const KURL&);
56         const String host() const;
57
58         const String& clientProtocol() const;
59         void setClientProtocol(const String& protocol);
60
61         bool secure() const;
62
63         String clientOrigin() const;
64         String clientLocation() const;
65
66         CString clientHandshakeMessage() const;
67         WebSocketHandshakeRequest clientHandshakeRequest() const;
68
69         void reset();
70         void clearScriptExecutionContext();
71
72         int readServerHandshake(const char* header, size_t len);
73         Mode mode() const;
74         String failureReason() const; // Returns a string indicating the reason of failure if mode() == Failed.
75
76         String serverWebSocketOrigin() const; // Only for hixie-76 handshake.
77         String serverWebSocketLocation() const; // Only for hixie-76 handshake.
78         String serverWebSocketProtocol() const;
79         String serverSetCookie() const;
80         String serverSetCookie2() const;
81         String serverUpgrade() const;
82         String serverConnection() const;
83         String serverWebSocketAccept() const; // Only for hybi-10 handshake.
84         String serverWebSocketExtensions() const; // Only for hybi-10 handshake.
85
86         const WebSocketHandshakeResponse& serverHandshakeResponse() const;
87
88     private:
89         KURL httpURLForAuthenticationAndCookies() const;
90
91         int readStatusLine(const char* header, size_t headerLength, int& statusCode, String& statusText);
92
93         // Reads all headers except for the two predefined ones.
94         const char* readHTTPHeaders(const char* start, const char* end);
95         void processHeaders();
96         bool checkResponseHeaders();
97
98         KURL m_url;
99         String m_clientProtocol;
100         bool m_secure;
101         ScriptExecutionContext* m_context;
102         bool m_useHixie76Protocol;
103
104         Mode m_mode;
105
106         WebSocketHandshakeResponse m_response;
107
108         String m_failureReason;
109
110         // For hixie-76 handshake.
111         String m_hixie76SecWebSocketKey1;
112         String m_hixie76SecWebSocketKey2;
113         unsigned char m_hixie76Key3[8];
114         unsigned char m_hixie76ExpectedChallengeResponse[16];
115
116         // For hybi-10 handshake.
117         String m_secWebSocketKey;
118         String m_expectedAccept;
119     };
120
121 } // namespace WebCore
122
123 #endif // ENABLE(WEB_SOCKETS)
124
125 #endif // WebSocketHandshake_h