010efb77eb4bfe428711a1ca16081b65cf15606a
[WebKit-https.git] / Source / WebCore / Modules / navigatorcontentutils / NavigatorContentUtils.cpp
1 /*
2  * Copyright (C) 2011, Google Inc. All rights reserved.
3  * Copyright (C) 2012, Samsung Electronics. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
21  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
24  * DAMAGE.
25  */
26
27 #include "config.h"
28 #include "NavigatorContentUtils.h"
29
30 #if ENABLE(NAVIGATOR_CONTENT_UTILS)
31
32 #include "Document.h"
33 #include "ExceptionCode.h"
34 #include "Frame.h"
35 #include "Navigator.h"
36 #include "Page.h"
37 #include <wtf/HashSet.h>
38 #include <wtf/NeverDestroyed.h>
39
40 namespace WebCore {
41
42 static bool verifyCustomHandlerURL(const URL& baseURL, const String& url)
43 {
44     // The specification requires that it is a SYNTAX_ERR if the "%s" token is
45     // not present.
46     static const char token[] = "%s";
47     int index = url.find(token);
48     if (-1 == index)
49         return false;
50
51     // It is also a SYNTAX_ERR if the custom handler URL, as created by removing
52     // the "%s" token and prepending the base url, does not resolve.
53     String newURL = url;
54     newURL.remove(index, WTF_ARRAY_LENGTH(token) - 1);
55
56     URL kurl(baseURL, newURL);
57
58     if (kurl.isEmpty() || !kurl.isValid())
59         return false;
60
61     return true;
62 }
63
64 static inline bool isProtocolWhitelisted(const String& scheme)
65 {
66     static NeverDestroyed<HashSet<String, ASCIICaseInsensitiveHash>> protocolWhitelist = []() {
67         HashSet<String, ASCIICaseInsensitiveHash> set;
68         for (auto* protocol : { "bitcoin", "geo", "im", "irc", "ircs", "magnet", "mailto", "mms", "news", "nntp", "sip", "sms", "smsto", "ssh", "tel", "urn", "webcal", "wtai", "xmpp" })
69             set.add(protocol);
70         return set;
71     }();
72     return protocolWhitelist.get().contains(scheme);
73 }
74
75 static bool verifyProtocolHandlerScheme(const String& scheme)
76 {
77     if (isProtocolWhitelisted(scheme))
78         return true;
79
80     // FIXME: Should this be case sensitive, or should it be ASCII case-insensitive?
81     if (scheme.startsWith("web+")) {
82         // The specification requires that the length of scheme is at least five characters (including 'web+' prefix).
83         if (scheme.length() >= 5 && isValidProtocol(scheme))
84             return true;
85     }
86
87     return false;
88 }
89
90 NavigatorContentUtils* NavigatorContentUtils::from(Page* page)
91 {
92     return static_cast<NavigatorContentUtils*>(Supplement<Page>::from(page, supplementName()));
93 }
94
95 NavigatorContentUtils::~NavigatorContentUtils()
96 {
97 }
98
99 ExceptionOr<void> NavigatorContentUtils::registerProtocolHandler(Navigator& navigator, const String& scheme, const String& url, const String& title)
100 {
101     if (!navigator.frame())
102         return { };
103
104     URL baseURL = navigator.frame()->document()->baseURL();
105
106     if (!verifyCustomHandlerURL(baseURL, url))
107         return Exception { SYNTAX_ERR };
108
109     if (!verifyProtocolHandlerScheme(scheme))
110         return Exception { SECURITY_ERR };
111
112     NavigatorContentUtils::from(navigator.frame()->page())->client()->registerProtocolHandler(scheme, baseURL, URL(ParsedURLString, url), navigator.frame()->displayStringModifiedByEncoding(title));
113     return { };
114 }
115
116 #if ENABLE(CUSTOM_SCHEME_HANDLER)
117
118 static String customHandlersStateString(const NavigatorContentUtilsClient::CustomHandlersState state)
119 {
120     static NeverDestroyed<String> newHandler(ASCIILiteral("new"));
121     static NeverDestroyed<String> registeredHandler(ASCIILiteral("registered"));
122     static NeverDestroyed<String> declinedHandler(ASCIILiteral("declined"));
123
124     switch (state) {
125     case NavigatorContentUtilsClient::CustomHandlersNew:
126         return newHandler;
127     case NavigatorContentUtilsClient::CustomHandlersRegistered:
128         return registeredHandler;
129     case NavigatorContentUtilsClient::CustomHandlersDeclined:
130         return declinedHandler;
131     }
132
133     ASSERT_NOT_REACHED();
134     return String();
135 }
136
137 ExceptionOr<String> NavigatorContentUtils::isProtocolHandlerRegistered(Navigator& navigator, const String& scheme, const String& url)
138 {
139     static NeverDestroyed<String> declined(ASCIILiteral("declined"));
140
141     if (!navigator.frame())
142         return String { declined };
143
144     URL baseURL = navigator.frame()->document()->baseURL();
145
146     if (!verifyCustomHandlerURL(baseURL, url))
147         return Exception { SYNTAX_ERR };
148
149     if (!verifyProtocolHandlerScheme(scheme))
150         return Exception { SECURITY_ERR };
151
152     return customHandlersStateString(NavigatorContentUtils::from(navigator.frame()->page())->client()->isProtocolHandlerRegistered(scheme, baseURL, URL(ParsedURLString, url)));
153 }
154
155 ExceptionOr<void> NavigatorContentUtils::unregisterProtocolHandler(Navigator& navigator, const String& scheme, const String& url)
156 {
157     if (!navigator.frame())
158         return { };
159
160     URL baseURL = navigator.frame()->document()->baseURL();
161
162     if (!verifyCustomHandlerURL(baseURL, url))
163         return Exception { SYNTAX_ERR };
164
165     if (!verifyProtocolHandlerScheme(scheme))
166         return Exception { SECURITY_ERR };
167
168     NavigatorContentUtils::from(navigator.frame()->page())->client()->unregisterProtocolHandler(scheme, baseURL, URL(ParsedURLString, url));
169     return { };
170 }
171
172 #endif
173
174 const char* NavigatorContentUtils::supplementName()
175 {
176     return "NavigatorContentUtils";
177 }
178
179 void provideNavigatorContentUtilsTo(Page* page, std::unique_ptr<NavigatorContentUtilsClient> client)
180 {
181     NavigatorContentUtils::provideTo(page, NavigatorContentUtils::supplementName(), std::make_unique<NavigatorContentUtils>(WTFMove(client)));
182 }
183
184 } // namespace WebCore
185
186 #endif // ENABLE(NAVIGATOR_CONTENT_UTILS)