Referrer HTTP Header no longer ignored when set via RequestInterceptor

Make sure the HTTP referer is properly placed on a request when it's set
via the QWebEngineUrlRequestInterceptor.

Added test case to catch future incidents.

Fixes: QTBUG-60203
Change-Id: Ida2f713a7352c3199fc9f8e15b5d8350d50afdda
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
 

3 files changed, 54 insertions, 3 deletions

diff --git a/src/core/net/network_delegate_qt.cpp b/src/core/net/network_delegate_qt.cpp
index 1441ec336..f6202cf1b 100644
--- a/src/core/net/network_delegate_qt.cpp
+++ b/src/core/net/network_delegate_qt.cpp
@@ -252,15 +252,22 @@ int NetworkDelegateQt::OnBeforeURLRequest(net::URLRequest *request, net::Complet
 
             if (!infoPrivate->extraHeaders.isEmpty()) {
                 auto end = infoPrivate->extraHeaders.constEnd();
-                for (auto header = infoPrivate->extraHeaders.constBegin(); header != end; ++header)
-                    request->SetExtraRequestHeaderByName(header.key().toStdString(), header.value().toStdString(), /* overwrite */ true);
+                for (auto header = infoPrivate->extraHeaders.constBegin(); header != end; ++header) {
+                    std::string h = header.key().toStdString();
+                    if (base::LowerCaseEqualsASCII(h, "referer")) {
+                        request->SetReferrer(header.value().toStdString());
+                    } else {
+                        request->SetExtraRequestHeaderByName(h, header.value().toStdString(), /* overwrite */ true);
+                    }
+                }
             }
 
             if (result != net::OK)
                 return result;
         }
-    } else
+    } else {
         m_profileIOData->releaseInterceptor();
+    }
 
     if (!resourceInfo)
         return net::OK;
diff --git a/tests/auto/core/qwebengineurlrequestinterceptor/qwebengineurlrequestinterceptor.pro b/tests/auto/core/qwebengineurlrequestinterceptor/qwebengineurlrequestinterceptor.pro
index e99c7f493..9c239f1a7 100644
--- a/tests/auto/core/qwebengineurlrequestinterceptor/qwebengineurlrequestinterceptor.pro
+++ b/tests/auto/core/qwebengineurlrequestinterceptor/qwebengineurlrequestinterceptor.pro
@@ -1 +1,2 @@
 include(../tests.pri)
+include(../../shared/http.pri)
diff --git a/tests/auto/core/qwebengineurlrequestinterceptor/tst_qwebengineurlrequestinterceptor.cpp b/tests/auto/core/qwebengineurlrequestinterceptor/tst_qwebengineurlrequestinterceptor.cpp
index 23bf88417..653a1e421 100644
--- a/tests/auto/core/qwebengineurlrequestinterceptor/tst_qwebengineurlrequestinterceptor.cpp
+++ b/tests/auto/core/qwebengineurlrequestinterceptor/tst_qwebengineurlrequestinterceptor.cpp
@@ -34,6 +34,9 @@
 #include <QtWebEngineWidgets/qwebengineprofile.h>
 #include <QtWebEngineWidgets/qwebenginesettings.h>
 
+#include <httpserver.h>
+#include <httpreqrep.h>
+
 class tst_QWebEngineUrlRequestInterceptor : public QObject
 {
     Q_OBJECT
@@ -59,6 +62,7 @@ private Q_SLOTS:
     void requestInterceptorByResourceType_data();
     void requestInterceptorByResourceType();
     void firstPartyUrlHttp();
+    void passRefererHeader();
 };
 
 tst_QWebEngineUrlRequestInterceptor::tst_QWebEngineUrlRequestInterceptor()
@@ -97,6 +101,9 @@ struct RequestInfo {
     int resourceType;
 };
 
+static const QByteArray kHttpHeaderReferrerValue = QByteArrayLiteral("http://somereferrer.com/");
+static const QByteArray kHttpHeaderRefererName = QByteArrayLiteral("referer");
+
 class TestRequestInterceptor : public QWebEngineUrlRequestInterceptor
 {
 public:
@@ -112,6 +119,9 @@ public:
         if (shouldIntercept && info.requestUrl().toString().endsWith(QLatin1String("__placeholder__")))
             info.redirect(QUrl("qrc:///resources/content.html"));
 
+        // Set referrer header
+        info.setHttpHeader(kHttpHeaderRefererName, kHttpHeaderReferrerValue);
+
         requestInfos.append(info);
     }
 
@@ -487,5 +497,38 @@ void tst_QWebEngineUrlRequestInterceptor::firstPartyUrlHttp()
         QCOMPARE(info.firstPartyUrl, firstPartyUrl);
 }
 
+void tst_QWebEngineUrlRequestInterceptor::passRefererHeader()
+{
+    // Create HTTP Server to parse the request.
+    HttpServer httpServer;
+
+    if (!httpServer.start())
+        QSKIP("Failed to start http server");
+
+    bool succeeded = false;
+    connect(&httpServer, &HttpServer::newRequest, [&succeeded](HttpReqRep *rr) {
+        const QByteArray headerValue = rr->requestHeader(kHttpHeaderRefererName);
+        QCOMPARE(headerValue, kHttpHeaderReferrerValue);
+        succeeded = headerValue == kHttpHeaderReferrerValue;
+        rr->setResponseStatus(200);
+        rr->sendResponse();
+    });
+
+    QWebEngineProfile profile;
+    TestRequestInterceptor interceptor(true);
+    profile.setRequestInterceptor(&interceptor);
+
+    QWebEnginePage page(&profile);
+    QSignalSpy spy(&page, SIGNAL(loadFinished(bool)));
+    QWebEngineHttpRequest httpRequest;
+    QUrl requestUrl = httpServer.url();
+    httpRequest.setUrl(requestUrl);
+    page.load(httpRequest);
+
+    QVERIFY(spy.wait());
+    (void) httpServer.stop();
+    QVERIFY(succeeded);
+}
+
 QTEST_MAIN(tst_QWebEngineUrlRequestInterceptor)
 #include "tst_qwebengineurlrequestinterceptor.moc"