21d1f3fc9482b2b4d77bfd6fbb39ffe527c898c2
[WebKit-https.git] / Source / WebCore / Modules / 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 "WebSocketExtensionDispatcher.h"
39 #include "WebSocketExtensionProcessor.h"
40 #include "WebSocketHandshakeRequest.h"
41 #include "WebSocketHandshakeResponse.h"
42 #include <wtf/PassOwnPtr.h>
43
44 namespace WebCore {
45
46 class ScriptExecutionContext;
47
48 class WebSocketHandshake {
49     WTF_MAKE_NONCOPYABLE(WebSocketHandshake);
50 public:
51     enum Mode {
52         Incomplete, Normal, Failed, Connected
53     };
54     WebSocketHandshake(const KURL&, const String& protocol, ScriptExecutionContext*, bool useHixie76Protocol);
55     ~WebSocketHandshake();
56
57     const KURL& url() const;
58     void setURL(const KURL&);
59     const String host() const;
60
61     const String& clientProtocol() const;
62     void setClientProtocol(const String&);
63
64     bool secure() const;
65
66     String clientOrigin() const;
67     String clientLocation() const;
68
69     CString clientHandshakeMessage() const;
70     PassRefPtr<WebSocketHandshakeRequest> clientHandshakeRequest() const;
71
72     void reset();
73     void clearScriptExecutionContext();
74
75     int readServerHandshake(const char* header, size_t len);
76     Mode mode() const;
77     String failureReason() const; // Returns a string indicating the reason of failure if mode() == Failed.
78
79     String serverWebSocketOrigin() const; // Only for hixie-76 handshake.
80     String serverWebSocketLocation() const; // Only for hixie-76 handshake.
81     String serverWebSocketProtocol() const;
82     String serverSetCookie() const;
83     String serverSetCookie2() const;
84     String serverUpgrade() const;
85     String serverConnection() const;
86     String serverWebSocketAccept() const; // Only for hybi-10 handshake.
87     String acceptedExtensions() const;
88
89     const WebSocketHandshakeResponse& serverHandshakeResponse() const;
90
91     void addExtensionProcessor(PassOwnPtr<WebSocketExtensionProcessor>);
92
93     static String getExpectedWebSocketAccept(const String& secWebSocketKey);
94
95 private:
96     KURL httpURLForAuthenticationAndCookies() const;
97
98     int readStatusLine(const char* header, size_t headerLength, int& statusCode, String& statusText);
99
100     // Reads all headers except for the two predefined ones.
101     const char* readHTTPHeaders(const char* start, const char* end);
102     void processHeaders();
103     bool checkResponseHeaders();
104
105     KURL m_url;
106     String m_clientProtocol;
107     bool m_secure;
108     ScriptExecutionContext* m_context;
109     bool m_useHixie76Protocol;
110
111     Mode m_mode;
112
113     WebSocketHandshakeResponse m_response;
114
115     String m_failureReason;
116
117     // For hixie-76 handshake.
118     String m_hixie76SecWebSocketKey1;
119     String m_hixie76SecWebSocketKey2;
120     unsigned char m_hixie76Key3[8];
121     unsigned char m_hixie76ExpectedChallengeResponse[16];
122
123     // For hybi-10 handshake.
124     String m_secWebSocketKey;
125     String m_expectedAccept;
126
127     WebSocketExtensionDispatcher m_extensionDispatcher;
128 };
129
130 } // namespace WebCore
131
132 #endif // ENABLE(WEB_SOCKETS)
133
134 #endif // WebSocketHandshake_h