QWebSecurityOrigin Class Reference

#include <mw/QtWebKit/qwebsecurityorigin.h>

class QWebSecurityOrigin

The QWebSecurityOrigin class defines a security boundary for web sites.

Public Member Functions
QWebSecurityOrigin(const QWebSecurityOrigin &)
voidaddLocalScheme(const QString &)
QList< QWebSecurityOrigin >allOrigins()
qint64 databaseQuota()
qint64 databaseUsage()
QList< QWebDatabase >databases()
QString host()
QStringList localSchemes()
QWebSecurityOrigin &operator=(const QWebSecurityOrigin &)
voidremoveLocalScheme(const QString &)
QString scheme()

Detailed Description

4.5 QtWebKit
QWebSecurityOrigin 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 {http://www.example.com/my/page.html} is allowed to share the same database as {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 {http://www.malicious.com/evil.html} from accessing {http://www.example.com/}'s resources, because they are of a different security origin.

By default local schemes like {file://} and {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 QWebSecurityOrigin::addLocalScheme(), or override the default same-origin behavior by setting QWebSettings::LocalContentCanAccessFileUrls to {false}.


Local resources are by default restricted from accessing remote content, which means your {file://} will not be able to access {http://domain.com/foo.html}. You can relax this restriction by setting QWebSettings::LocalContentCanAccessRemoteUrls to {true}.

Call QWebFrame::securityOrigin() to get the QWebSecurityOrigin 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 {http://en.wikipedia.org/wiki/Same_origin_policy}{"Same origin policy" Wikipedia Article}.

See also: QWebFrame::securityOrigin()

Constructor & Destructor Documentation

QWebSecurityOrigin ( const QWebSecurityOrigin & )

QWebSecurityOrigin(const QWebSecurityOrigin &other)

Constructs a security origin from other.

~QWebSecurityOrigin ( )


Destroys the security origin.

Member Function Documentation

addLocalScheme ( const QString & )

voidaddLocalScheme(const QString &scheme)[static]
Adds the given scheme to the list of schemes that are considered equivalent to the file: scheme.

Cross domain restrictions depend on the two web settings QWebSettings::LocalContentCanAccessFileUrls and QWebSettings::LocalContentCanAccessFileUrls. By default all local schemes are concidered to be in the same security origin, and local schemes can not access remote content.

allOrigins ( )

QList< QWebSecurityOrigin >allOrigins()[static]

Returns a list of all security origins with a database quota defined.

databaseQuota ( )

qint64 databaseQuota()const

Returns the quota for the databases in the security origin.

databaseUsage ( )

qint64 databaseUsage()const

Returns the number of bytes all databases in the security origin use on the disk.

databases ( )

QList< QWebDatabase >databases()const

Returns a list of all databases defined in the security origin.

host ( )

QString host()const

Returns the host name defining the security origin.

localSchemes ( )

QStringList localSchemes()[static]
4.6 Returns a list of all the schemes concidered to be local.
By default this is {file://} and {qrc://}.

See also: addLocalScheme(), removeLocalScheme()

operator= ( const QWebSecurityOrigin & )

QWebSecurityOrigin &operator=(const QWebSecurityOrigin &other)

Assigns the other security origin to this.

port ( )


Returns the port number defining the security origin.

removeLocalScheme ( const QString & )

voidremoveLocalScheme(const QString &scheme)[static]
Removes the given scheme from the list of local schemes.

You can not remove the {file://} scheme from the list of local schemes.

See also: addLocalScheme()

scheme ( )

QString scheme()const

Returns the scheme defining the security origin.

setDatabaseQuota ( qint64 )


Sets the quota for the databases in the security origin to 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.