1/****************************************************************************
2**
3** Copyright (C) 2017 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtNetwork module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QHSTS_P_H
41#define QHSTS_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists for the convenience
48// of the Network Access API. This header file may change from
49// version to version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtNetwork/private/qtnetworkglobal_p.h>
55
56#include <QtNetwork/qhstspolicy.h>
57
58#include <QtCore/qbytearray.h>
59#include <QtCore/qdatetime.h>
60#include <QtCore/qstring.h>
61#include <QtCore/qglobal.h>
62#include <QtCore/qpair.h>
63#include <QtCore/qurl.h>
64#include <QtCore/qcontainerfwd.h>
65
66#include <map>
67
68QT_BEGIN_NAMESPACE
69
70class Q_AUTOTEST_EXPORT QHstsCache
71{
72public:
73
74 void updateFromHeaders(const QList<QPair<QByteArray, QByteArray>> &headers,
75 const QUrl &url);
76 void updateFromPolicies(const QList<QHstsPolicy> &hosts);
77 void updateKnownHost(const QUrl &url, const QDateTime &expires,
78 bool includeSubDomains);
79 bool isKnownHost(const QUrl &url) const;
80 void clear();
81
82 QList<QHstsPolicy> policies() const;
83
84#if QT_CONFIG(settings)
85 void setStore(class QHstsStore *store);
86#endif // QT_CONFIG(settings)
87
88private:
89
90 void updateKnownHost(const QString &hostName, const QDateTime &expires,
91 bool includeSubDomains);
92
93 struct HostName
94 {
95 explicit HostName(const QString &n) : name(n) { }
96 explicit HostName(QStringView r) : fragment(r) { }
97
98 bool operator < (const HostName &rhs) const
99 {
100 if (fragment.size()) {
101 if (rhs.fragment.size())
102 return fragment < rhs.fragment;
103 return fragment < QStringView{rhs.name};
104 }
105
106 if (rhs.fragment.size())
107 return QStringView{name} < rhs.fragment;
108 return name < rhs.name;
109 }
110
111 // We use 'name' for a HostName object contained in our dictionary;
112 // we use 'fragment' only during lookup, when chopping the complete host
113 // name, removing subdomain names (such HostName object is 'transient', it
114 // must not outlive the original QString object.
115 QString name;
116 QStringView fragment;
117 };
118
119 mutable std::map<HostName, QHstsPolicy> knownHosts;
120#if QT_CONFIG(settings)
121 QHstsStore *hstsStore = nullptr;
122#endif // QT_CONFIG(settings)
123};
124
125class Q_AUTOTEST_EXPORT QHstsHeaderParser
126{
127public:
128
129 bool parse(const QList<QPair<QByteArray, QByteArray>> &headers);
130
131 QDateTime expirationDate() const { return expiry; }
132 bool includeSubDomains() const { return subDomainsFound; }
133
134private:
135
136 bool parseSTSHeader();
137 bool parseDirective();
138 bool processDirective(const QByteArray &name, const QByteArray &value);
139 bool nextToken();
140
141 QByteArray header;
142 QByteArray token;
143
144 QDateTime expiry;
145 int tokenPos = 0;
146 bool maxAgeFound = false;
147 qint64 maxAge = 0;
148 bool subDomainsFound = false;
149};
150
151QT_END_NAMESPACE
152
153#endif
154