// Copyright (C) 2016 The Qt Company Ltd.

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

// Qt-Security score:significant reason:default

#include "qnetworkcookiejar.h"

#include "qnetworkcookiejar_p.h"

#include "QtNetwork/qnetworkcookie.h"

#include "QtCore/qurl.h"

#include "QtCore/qdatetime.h"

#if QT_CONFIG(topleveldomain)

#include "private/qtldurl_p.h"

#else

QT_BEGIN_NAMESPACE

static bool qIsEffectiveTLD(QStringView domain)

{

    // provide minimal checking by not accepting cookies on real TLDs

    return !domain.contains(u'.');

}

QT_END_NAMESPACE

#endif

QT_BEGIN_NAMESPACE

using namespace Qt::StringLiterals;

/*!

    \class QNetworkCookieJar

    \since 4.4

    \inmodule QtNetwork

    \brief The QNetworkCookieJar class implements a simple jar of QNetworkCookie objects.

    Cookies are small bits of information that stateless protocols

    like HTTP use to maintain some persistent information across

    requests.

    A cookie is set by a remote server when it replies to a request

    and it expects the same cookie to be sent back when further

    requests are sent.

    The cookie jar is the object that holds all cookies set in

    previous requests. Web browsers save their cookie jars to disk in

    order to conserve permanent cookies across invocations of the

    application.

    QNetworkCookieJar does not implement permanent storage: it only

    keeps the cookies in memory. Once the QNetworkCookieJar object is

    deleted, all cookies it held will be discarded as well. If you

    want to save the cookies, you should derive from this class and

    implement the saving to disk to your own storage format.

    This class implements only the basic security recommended by the

    cookie specifications and does not implement any cookie acceptance

    policy (it accepts all cookies set by any requests). In order to

    override those rules, you should reimplement the

    cookiesForUrl() and setCookiesFromUrl() virtual

    functions. They are called by QNetworkReply and

    QNetworkAccessManager when they detect new cookies and when they

    require cookies.

    \sa QNetworkCookie, QNetworkAccessManager, QNetworkReply,

    QNetworkRequest, QNetworkAccessManager::setCookieJar()

*/

/*!

    Creates a QNetworkCookieJar object and sets the parent object to

    be \a parent.

    The cookie jar is initialized to empty.

*/

QNetworkCookieJar::QNetworkCookieJar(QObject *parent)

    : QObject(*new QNetworkCookieJarPrivate, parent)

{

}

/*!

    Destroys this cookie jar object and discards all cookies stored in

    it. Cookies are not saved to disk in the QNetworkCookieJar default

    implementation.

    If you need to save the cookies to disk, you have to derive from

    QNetworkCookieJar and save the cookies to disk yourself.

*/

QNetworkCookieJar::~QNetworkCookieJar()

{

}

/*!

    Returns all cookies stored in this cookie jar. This function is

    suitable for derived classes to save cookies to disk, as well as

    to implement cookie expiration and other policies.

    \sa setAllCookies(), cookiesForUrl()

*/

QList<QNetworkCookie> QNetworkCookieJar::allCookies() const

{

    return d_func()->allCookies;

}

/*!

    Sets the internal list of cookies held by this cookie jar to be \a

    cookieList. This function is suitable for derived classes to

    implement loading cookies from permanent storage, or their own

    cookie acceptance policies by reimplementing

    setCookiesFromUrl().

    \sa allCookies(), setCookiesFromUrl()

*/

void QNetworkCookieJar::setAllCookies(const QList<QNetworkCookie> &cookieList)

{

    Q_D(QNetworkCookieJar);

    d->allCookies = cookieList;

}

static inline bool isParentPath(QStringView path, QStringView reference)

{

    if ((path.isEmpty() && reference == "/"_L1) || path.startsWith(reference)) {

        //The cookie-path and the request-path are identical.

        if (path.size() == reference.size())

            return true;

        //The cookie-path is a prefix of the request-path, and the last

        //character of the cookie-path is %x2F ("/").

        if (reference.endsWith(u'/'))

            return true;

        //The cookie-path is a prefix of the request-path, and the first

        //character of the request-path that is not included in the cookie-

        //path is a %x2F ("/") character.

        if (path.at(reference.size()) == u'/')

            return true;

    }

    return false;

}

static inline bool isParentDomain(QStringView domain, QStringView reference)

{

    if (!reference.startsWith(u'.'))

        return domain == reference;

    return domain.endsWith(reference) || domain == reference.mid(1);

}

/*!

    Adds the cookies in the list \a cookieList to this cookie

    jar. Before being inserted cookies are normalized.

    Returns \c true if one or more cookies are set for \a url,

    otherwise false.

    If a cookie already exists in the cookie jar, it will be

    overridden by those in \a cookieList.

    The default QNetworkCookieJar class implements only a very basic

    security policy (it makes sure that the cookies' domain and path

    match the reply's). To enhance the security policy with your own

    algorithms, override setCookiesFromUrl().

    Also, QNetworkCookieJar does not have a maximum cookie jar

    size. Reimplement this function to discard older cookies to create

    room for new ones.

    \sa cookiesForUrl(), QNetworkAccessManager::setCookieJar(), QNetworkCookie::normalize()

*/

bool QNetworkCookieJar::setCookiesFromUrl(const QList<QNetworkCookie> &cookieList,

                                          const QUrl &url)

{

    bool added = false;

    for (QNetworkCookie cookie : cookieList) {

        cookie.normalize(url);

        if (validateCookie(cookie, url) && insertCookie(cookie))

            added = true;

    }

    return added;

}

/*!

    Returns the cookies to be added to when a request is sent to

    \a url. This function is called by the default

    QNetworkAccessManager::createRequest(), which adds the

    cookies returned by this function to the request being sent.

    If more than one cookie with the same name is found, but with

    differing paths, the one with longer path is returned before the

    one with shorter path. In other words, this function returns

    cookies sorted decreasingly by path length.

    The default QNetworkCookieJar class implements only a very basic

    security policy (it makes sure that the cookies' domain and path

    match the reply's). To enhance the security policy with your own

    algorithms, override cookiesForUrl().

    \sa setCookiesFromUrl(), QNetworkAccessManager::setCookieJar()

*/

QList<QNetworkCookie> QNetworkCookieJar::cookiesForUrl(const QUrl &url) const

{

//     \b Warning! This is only a dumb implementation!

//     It does NOT follow all of the recommendations from

//     http://wp.netscape.com/newsref/std/cookie_spec.html

//     It does not implement a very good cross-domain verification yet.

    Q_D(const QNetworkCookieJar);

    const QDateTime now = QDateTime::currentDateTimeUtc();

    QList<QNetworkCookie> result;

    const bool isEncrypted = url.scheme() == "https"_L1;

    // scan our cookies for something that matches

    for (const auto &cookie : std::as_const(d->allCookies)) {

        if (!isEncrypted && cookie.isSecure())

            continue;

        if (!cookie.isSessionCookie() && cookie.expirationDate() < now)

            continue;

        const QString urlHost = url.host();

        const QString cookieDomain = cookie.domain();

        if (!isParentDomain(urlHost, cookieDomain))

            continue;

        if (!isParentPath(url.path(), cookie.path()))

            continue;

        QStringView domain = cookieDomain;

        if (domain.startsWith(u'.')) /// Qt6?: remove when compliant with RFC6265

            domain = domain.sliced(1);

#if QT_CONFIG(topleveldomain)

        if (urlHost != domain && qIsEffectiveTLD(domain))

            continue;

#else

        if (!domain.contains(u'.') && urlHost != domain)

            continue;

#endif // topleveldomain

        result += cookie;

    }

    auto longerPath = [](const auto &c1, const auto &c2)

                      { return c1.path().size() > c2.path().size(); };

    std::sort(result.begin(), result.end(), longerPath);

    return result;

}

/*!

    \since 5.0

    Adds \a cookie to this cookie jar.

    Returns \c true if \a cookie was added, false otherwise.

    If a cookie with the same identifier already exists in the

    cookie jar, it will be overridden.

*/

bool QNetworkCookieJar::insertCookie(const QNetworkCookie &cookie)

{

    Q_D(QNetworkCookieJar);

    const QDateTime now = QDateTime::currentDateTimeUtc();

    bool isDeletion = !cookie.isSessionCookie() &&

                      cookie.expirationDate() < now;

    deleteCookie(cookie);

    if (!isDeletion) {

        d->allCookies += cookie;

        return true;

    }

    return false;

}

/*!

    \since 5.0

    If a cookie with the same identifier as \a cookie exists in this cookie jar

    it will be updated. This function uses insertCookie().

    Returns \c true if \a cookie was updated, false if no cookie in the jar matches

    the identifier of \a cookie.

    \sa QNetworkCookie::hasSameIdentifier()

*/

bool QNetworkCookieJar::updateCookie(const QNetworkCookie &cookie)

{

    if (deleteCookie(cookie))

        return insertCookie(cookie);

    return false;

}

/*!

    \since 5.0

    Deletes from cookie jar the cookie found to have the same identifier as \a cookie.

    Returns \c true if a cookie was deleted, false otherwise.

    \sa QNetworkCookie::hasSameIdentifier()

*/

bool QNetworkCookieJar::deleteCookie(const QNetworkCookie &cookie)

{

    Q_D(QNetworkCookieJar);

    const auto it = std::find_if(d->allCookies.cbegin(), d->allCookies.cend(),

                                 [&cookie](const auto &c) { return c.hasSameIdentifier(cookie); });

    if (it != d->allCookies.cend()) {

        d->allCookies.erase(it);

        return true;

    }

    return false;

}

/*!

    \since 5.0

    Returns \c true if the domain and path of \a cookie are valid, false otherwise.

    The \a url parameter is used to determine if the domain specified in the cookie

    is allowed.

*/

bool QNetworkCookieJar::validateCookie(const QNetworkCookie &cookie, const QUrl &url) const

{

    const QString cookieDomain = cookie.domain();

    QStringView domain = cookieDomain;

    const QString host = url.host();

    if (!isParentDomain(domain, host) && !isParentDomain(host, domain))

        return false; // not accepted

    if (domain.startsWith(u'.'))

        domain = domain.sliced(1);

    // We shouldn't reject if:

    // "[...] the domain-attribute is identical to the canonicalized request-host"

    // https://tools.ietf.org/html/rfc6265#section-5.3 step 5

    if (host == domain)

        return true;

    // the check for effective TLDs makes the "embedded dot" rule from RFC 2109 section 4.3.2

    // redundant; the "leading dot" rule has been relaxed anyway, see QNetworkCookie::normalize()

    // we remove the leading dot for this check if it's present

    // Normally defined in qtldurl_p.h, but uses fall-back in this file when topleveldomain isn't

    // configured:

    return !qIsEffectiveTLD(domain);

}

QT_END_NAMESPACE

#include "moc_qnetworkcookiejar.cpp"