1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/*
Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
// The documentation in this file was imported from QtWebKit and is thus constrained
// by its LGPL license. Documentation written from scratch for new methods should be
// placed inline in the code as usual.
/*!
\class QWebEngineSecurityOrigin
\since 4.5
\brief The QWebEngineSecurityOrigin class defines a security boundary for web sites.
\inmodule QtWebEngine
QWebEngineSecurityOrigin provides access to the security domains defined by web sites.
An origin consists of a host name, a scheme, and a port number. Web sites
with the same security origin can access each other's resources for client-side
scripting or databases.
For example the site \c{http://www.example.com/my/page.html} is allowed to share the same
database as \c{http://www.example.com/my/overview.html}, or access each other's
documents when used in HTML frame sets and JavaScript. At the same time it prevents
\c{http://www.malicious.com/evil.html} from accessing \c{http://www.example.com/}'s resources,
because they are of a different security origin.
By default local schemes like \c{file://} and \c{qrc://} are concidered to be in the same
security origin, and can access each other's resources. You can add additional local schemes
by using QWebEngineSecurityOrigin::addLocalScheme(), or override the default same-origin behavior
by setting QWebEngineSettings::LocalContentCanAccessFileUrls to \c{false}.
\note Local resources are by default restricted from accessing remote content, which
means your \c{file://} will not be able to access \c{http://domain.com/foo.html}. You
can relax this restriction by setting QWebEngineSettings::LocalContentCanAccessRemoteUrls to
\c{true}.
Call QWebEnginePage::securityOrigin() to get the QWebEngineSecurityOrigin for a frame in a
web page, and use host(), scheme() and port() to identify the security origin.
Use databases() to access the databases defined within a security origin. The
disk usage of the origin's databases can be limited with setDatabaseQuota().
databaseQuota() and databaseUsage() report the current limit as well as the
current usage.
For more information refer to the
\l{http://en.wikipedia.org/wiki/Same_origin_policy}{"Same origin policy" Wikipedia Article}.
\sa QWebEnginePage::securityOrigin()
*/
/*!
\fn QString QWebEngineSecurityOrigin::scheme() const
Returns the scheme defining the security origin.
*/
/*!
\fn QString QWebEngineSecurityOrigin::host() const
Returns the host name defining the security origin.
*/
/*!
\fn int QWebEngineSecurityOrigin::port() const
Returns the port number defining the security origin.
*/
/*!
\fn qint64 QWebEngineSecurityOrigin::databaseUsage() const
Returns the number of bytes all databases in the security origin
use on the disk.
*/
/*!
\fn qint64 QWebEngineSecurityOrigin::databaseQuota() const
Returns the quota for the databases in the security origin.
*/
/*!
\fn void QWebEngineSecurityOrigin::setDatabaseQuota(qint64 quota)
Sets the quota for the databases in the security origin to \a quota bytes.
If the quota is set to a value less than the current usage, the quota will remain
and no data will be purged to meet the new quota. However, no new data can be added
to databases in this origin.
*/
/*!
\fn QWebEngineSecurityOrigin::~QWebEngineSecurityOrigin()
Destroys the security origin.
*/
/*!
\fn QList<QWebEngineSecurityOrigin> QWebEngineSecurityOrigin::allOrigins()
Returns a list of all security origins with a database quota defined.
*/
/*!
\fn QList<QWebEngineDatabase> QWebEngineSecurityOrigin::databases() const
Returns a list of all databases defined in the security origin.
*/
/*!
\fn void QWebEngineSecurityOrigin::addLocalScheme(const QString& scheme)
\since 4.6
Adds the given \a scheme to the list of schemes that are considered equivalent
to the \c file: scheme.
Cross domain restrictions depend on the two web settings QWebEngineSettings::LocalContentCanAccessFileUrls
and QWebEngineSettings::LocalContentCanAccessFileUrls. By default all local schemes are concidered to be
in the same security origin, and local schemes can not access remote content.
*/
/*!
\fn void QWebEngineSecurityOrigin::removeLocalScheme(const QString& scheme)
\since 4.6
Removes the given \a scheme from the list of local schemes.
\note You can not remove the \c{file://} scheme from the list
of local schemes.
\sa addLocalScheme()
*/
/*!
\fn QStringList QWebEngineSecurityOrigin::localSchemes()
\since 4.6
Returns a list of all the schemes concidered to be local.
By default this is \c{file://} and \c{qrc://}.
\sa addLocalScheme(), removeLocalScheme()
*/
|