b66c10fa002275d0fa03112a8e9f39403018307b
[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 #pragma once
32
33 #include "URL.h"
34 #include "ResourceResponse.h"
35 #include "WebSocketExtensionDispatcher.h"
36 #include "WebSocketExtensionProcessor.h"
37 #include <wtf/text/WTFString.h>
38
39 namespace WebCore {
40
41 class Document;
42 class ResourceRequest;
43
44 class WebSocketHandshake {
45     WTF_MAKE_NONCOPYABLE(WebSocketHandshake); WTF_MAKE_FAST_ALLOCATED;
46 public:
47     enum Mode {
48         Incomplete, Normal, Failed, Connected
49     };
50     WebSocketHandshake(const URL&, const String& protocol, Document*, bool allowCookies);
51     ~WebSocketHandshake();
52
53     const URL& url() const;
54     void setURL(const URL&);
55     URL httpURLForAuthenticationAndCookies() const;
56     const String host() const;
57
58     const String& clientProtocol() const;
59     void setClientProtocol(const String&);
60
61     bool secure() const;
62
63     String clientOrigin() const;
64     String clientLocation() const;
65
66     CString clientHandshakeMessage();
67     ResourceRequest clientHandshakeRequest();
68
69     void reset();
70     void clearDocument();
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 serverWebSocketProtocol() const;
77     String serverSetCookie() const;
78     String serverUpgrade() const;
79     String serverConnection() const;
80     String serverWebSocketAccept() const;
81     String acceptedExtensions() const;
82
83     const ResourceResponse& serverHandshakeResponse() const;
84
85     void addExtensionProcessor(std::unique_ptr<WebSocketExtensionProcessor>);
86
87     static String getExpectedWebSocketAccept(const String& secWebSocketKey);
88
89 private:
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     URL m_url;
99     String m_clientProtocol;
100     bool m_secure;
101     Document* m_document;
102
103     Mode m_mode;
104     bool m_allowCookies;
105
106     ResourceResponse m_serverHandshakeResponse;
107
108     String m_failureReason;
109
110     String m_secWebSocketKey;
111     String m_expectedAccept;
112
113     WebSocketExtensionDispatcher m_extensionDispatcher;
114 };
115
116 } // namespace WebCore