Move URL from WebCore to WTF
[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 "CookieRequestHeaderFieldProxy.h"
34 #include <wtf/URL.h>
35 #include "ResourceResponse.h"
36 #include "WebSocketExtensionDispatcher.h"
37 #include "WebSocketExtensionProcessor.h"
38 #include <wtf/text/WTFString.h>
39
40 namespace WebCore {
41
42 class Document;
43 class ResourceRequest;
44
45 class WebSocketHandshake {
46     WTF_MAKE_NONCOPYABLE(WebSocketHandshake); WTF_MAKE_FAST_ALLOCATED;
47 public:
48     enum Mode {
49         Incomplete, Normal, Failed, Connected
50     };
51     WebSocketHandshake(const URL&, const String& protocol, Document*, bool allowCookies);
52     ~WebSocketHandshake();
53
54     const URL& url() const;
55     void setURL(const URL&);
56     URL httpURLForAuthenticationAndCookies() const;
57     const String host() const;
58
59     const String& clientProtocol() const;
60     void setClientProtocol(const String&);
61
62     bool secure() const;
63
64     String clientOrigin() const;
65     String clientLocation() const;
66
67     CString clientHandshakeMessage() const;
68     ResourceRequest clientHandshakeRequest() const;
69     std::optional<CookieRequestHeaderFieldProxy> clientHandshakeCookieRequestHeaderFieldProxy() const;
70
71     void reset();
72     void clearDocument();
73
74     int readServerHandshake(const char* header, size_t len);
75     Mode mode() const;
76     String failureReason() const; // Returns a string indicating the reason of failure if mode() == Failed.
77
78     String serverWebSocketProtocol() const;
79     String serverSetCookie() const;
80     String serverUpgrade() const;
81     String serverConnection() const;
82     String serverWebSocketAccept() const;
83     String acceptedExtensions() const;
84
85     const ResourceResponse& serverHandshakeResponse() const;
86
87     void addExtensionProcessor(std::unique_ptr<WebSocketExtensionProcessor>);
88
89     static String getExpectedWebSocketAccept(const String& secWebSocketKey);
90
91 private:
92
93     int readStatusLine(const char* header, size_t headerLength, int& statusCode, String& statusText);
94
95     // Reads all headers except for the two predefined ones.
96     const char* readHTTPHeaders(const char* start, const char* end);
97     void processHeaders();
98     bool checkResponseHeaders();
99
100     URL m_url;
101     String m_clientProtocol;
102     bool m_secure;
103     Document* m_document;
104
105     Mode m_mode;
106     bool m_allowCookies;
107
108     ResourceResponse m_serverHandshakeResponse;
109
110     String m_failureReason;
111
112     String m_secWebSocketKey;
113     String m_expectedAccept;
114
115     WebSocketExtensionDispatcher m_extensionDispatcher;
116 };
117
118 } // namespace WebCore