<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qssl.cpp -->
<title>Qt 4.8: QSsl Namespace</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="namespaces.html">Namespaces</a></li>
<li>QSsl Namespace</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#types">Types</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QSsl Namespace</h1>
<!-- $$$QSsl-brief -->
<p>The QSsl namespace declares enums common to all SSL classes in <a href="qtnetwork.html">QtNetwork</a>. <a href="#details">More...</a></p>
<!-- @@@QSsl -->
<pre class="cpp"> <span class="preprocessor">#include <QSsl></span></pre><p>This namespace was introduced in Qt 4.3.</p>
<ul>
</ul>
<a name="types"></a>
<h2>Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qssl.html#AlternateNameEntryType-enum">AlternateNameEntryType</a></b> { EmailEntry, DnsEntry }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qssl.html#EncodingFormat-enum">EncodingFormat</a></b> { Pem, Der }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qssl.html#KeyAlgorithm-enum">KeyAlgorithm</a></b> { Rsa, Dsa }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qssl.html#KeyType-enum">KeyType</a></b> { PrivateKey, PublicKey }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qssl.html#SslOption-enum">SslOption</a></b> { SslOptionDisableEmptyFragments, SslOptionDisableSessionTickets, SslOptionDisableCompression, SslOptionDisableServerNameIndication, SslOptionDisableLegacyRenegotiation }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qssl.html#SslOption-enum">SslOptions</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qssl.html#SslProtocol-enum">SslProtocol</a></b> { SslV3, SslV2, TlsV1, UnknownProtocol, ..., SecureProtocols }</td></tr>
</table>
<a name="details"></a>
<!-- $$$QSsl-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QSsl namespace declares enums common to all SSL classes in <a href="qtnetwork.html">QtNetwork</a>.</p>
</div>
<!-- @@@QSsl -->
<div class="types">
<h2>Type Documentation</h2>
<!-- $$$AlternateNameEntryType$$$EmailEntry$$$DnsEntry -->
<h3 class="fn"><a name="AlternateNameEntryType-enum"></a>enum QSsl::<span class="name">AlternateNameEntryType</span></h3>
<p>Describes the key types for alternate name entries in <a href="qsslcertificate.html">QSslCertificate</a>.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QSsl::EmailEntry</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">An email entry; the entry contains an email address that the certificate is valid for.</td></tr>
<tr><td class="topAlign"><tt>QSsl::DnsEntry</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">A DNS host name entry; the entry contains a host name entry that the certificate is valid for. The entry may contain wildcards.</td></tr>
</table>
<p><b>See also </b><a href="qsslcertificate.html#alternateSubjectNames">QSslCertificate::alternateSubjectNames</a>().</p>
<!-- @@@AlternateNameEntryType -->
<!-- $$$EncodingFormat$$$Pem$$$Der -->
<h3 class="fn"><a name="EncodingFormat-enum"></a>enum QSsl::<span class="name">EncodingFormat</span></h3>
<p>Describes supported encoding formats for certificates and keys.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QSsl::Pem</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The PEM format.</td></tr>
<tr><td class="topAlign"><tt>QSsl::Der</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The DER format.</td></tr>
</table>
<!-- @@@EncodingFormat -->
<!-- $$$KeyAlgorithm$$$Rsa$$$Dsa -->
<h3 class="fn"><a name="KeyAlgorithm-enum"></a>enum QSsl::<span class="name">KeyAlgorithm</span></h3>
<p>Describes the different key algorithms supported by <a href="qsslkey.html">QSslKey</a>.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QSsl::Rsa</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The RSA algorithm.</td></tr>
<tr><td class="topAlign"><tt>QSsl::Dsa</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The DSA algorithm.</td></tr>
</table>
<!-- @@@KeyAlgorithm -->
<!-- $$$KeyType$$$PrivateKey$$$PublicKey -->
<h3 class="fn"><a name="KeyType-enum"></a>enum QSsl::<span class="name">KeyType</span></h3>
<p>Describes the two types of keys <a href="qsslkey.html">QSslKey</a> supports.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QSsl::PrivateKey</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">A private key.</td></tr>
<tr><td class="topAlign"><tt>QSsl::PublicKey</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">A public key.</td></tr>
</table>
<!-- @@@KeyType -->
<!-- $$$SslOption$$$SslOptionDisableEmptyFragments$$$SslOptionDisableSessionTickets$$$SslOptionDisableCompression$$$SslOptionDisableServerNameIndication$$$SslOptionDisableLegacyRenegotiation -->
<h3 class="flags"><a name="SslOption-enum"></a>enum QSsl::<span class="name">SslOption</span><br/>flags QSsl::<span class="name">SslOptions</span></h3>
<p>Describes the options that can be used to control the details of SSL behaviour. These options are generally used to turn features off to work around buggy servers.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QSsl::SslOptionDisableEmptyFragments</tt></td><td class="topAlign"><tt>0x01</tt></td><td class="topAlign">Disables the insertion of empty fragments into the data when using block ciphers. When enabled, this prevents some attacks (such as the BEAST attack), however it is incompatible with some servers.</td></tr>
<tr><td class="topAlign"><tt>QSsl::SslOptionDisableSessionTickets</tt></td><td class="topAlign"><tt>0x02</tt></td><td class="topAlign">Disables the SSL session ticket extension. This can cause slower connection setup, however some servers are not compatible with the extension.</td></tr>
<tr><td class="topAlign"><tt>QSsl::SslOptionDisableCompression</tt></td><td class="topAlign"><tt>0x04</tt></td><td class="topAlign">Disables the SSL compression extension. When enabled, this allows the data being passed over SSL to be compressed, however some servers are not compatible with this extension.</td></tr>
<tr><td class="topAlign"><tt>QSsl::SslOptionDisableServerNameIndication</tt></td><td class="topAlign"><tt>0x08</tt></td><td class="topAlign">Disables the SSL server name indication extension. When enabled, this tells the server the virtual host being accessed allowing it to respond with the correct certificate.</td></tr>
<tr><td class="topAlign"><tt>QSsl::SslOptionDisableLegacyRenegotiation</tt></td><td class="topAlign"><tt>0x10</tt></td><td class="topAlign">Disables the older insecure mechanism for renegotiating the connection parameters. When enabled, this option can allow connections for legacy servers, but it introduces the possibility that an attacker could inject plaintext into the SSL session.</td></tr>
</table>
<p>By default, SslOptionDisableEmptyFragments is turned on since this causes problems with a large number of servers. SslOptionDisableLegacyRenegotiation is also turned on, since it introduces a security risk. SslOptionDisableCompression is turned on to prevent the attack publicised by CRIME. The other options are turned off.</p>
<p>Note: Availability of above options depends on the version of the SSL backend in use.</p>
<p>The SslOptions type is a typedef for <a href="qflags.html">QFlags</a><SslOption>. It stores an OR combination of SslOption values.</p>
<!-- @@@SslOption -->
<!-- $$$SslProtocol$$$SslV3$$$SslV2$$$TlsV1$$$AnyProtocol$$$TlsV1SslV3$$$SecureProtocols$$$UnknownProtocol -->
<h3 class="fn"><a name="SslProtocol-enum"></a>enum QSsl::<span class="name">SslProtocol</span></h3>
<p>Describes the protocol of the cipher.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QSsl::SslV3</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">SSLv3</td></tr>
<tr><td class="topAlign"><tt>QSsl::SslV2</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">SSLv2</td></tr>
<tr><td class="topAlign"><tt>QSsl::TlsV1</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">TLSv1</td></tr>
<tr><td class="topAlign"><tt>QSsl::UnknownProtocol</tt></td><td class="topAlign"><tt>-1</tt></td><td class="topAlign">The cipher's protocol cannot be determined.</td></tr>
<tr><td class="topAlign"><tt>QSsl::AnyProtocol</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">The socket understands SSLv2, SSLv3, and TLSv1. This value is used by <a href="qsslsocket.html">QSslSocket</a> only.</td></tr>
<tr><td class="topAlign"><tt>QSsl::TlsV1SslV3</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">On the client side, this will send a TLS 1.0 Client Hello, enabling TLSv1 and SSLv3 connections. On the server side, this will enable both SSLv3 and TLSv1 connections.</td></tr>
<tr><td class="topAlign"><tt>QSsl::SecureProtocols</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">The default option, using protocols known to be secure; currently behaves like TlsV1SslV3.</td></tr>
</table>
<p>Note: most servers using SSL understand both versions (2 and 3), but it is recommended to use the latest version only for security reasons. However, SSL and TLS are not compatible with each other: if you get unexpected handshake failures, verify that you chose the correct setting for your protocol.</p>
<!-- @@@SslProtocol -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Digia, Qt and their respective logos are trademarks of Digia Plc
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
