The
QSslSocket
class provides an SSL encrypted socket for both clients and servers.
More...
#include <
qsslsocket.h
>
Inheritance diagram for QSslSocket:
VerifyPeer
,
AutoVerifyPeer
} Describes the peer verification modes for
QSslSocket
.
More...
enum
SslMode
{
UnencryptedMode
,
SslClientMode
,
SslServerMode
} Describes the connection modes available for
QSslSocket
.
More...

Public Types inherited from
QAbstractSocket
enum
NetworkLayerProtocol
{
IPv4Protocol
,
IPv6Protocol
,
UnknownNetworkLayerProtocol
= -1
} This enum describes the network layer protocol values used in
Qt
.
More...
enum
SocketError
{
ConnectionRefusedError
,
RemoteHostClosedError
,
HostNotFoundError
,
SocketAccessError
,
SocketResourceError
,
SocketTimeoutError
,
DatagramTooLargeError
,
NetworkError
,
AddressInUseError
,
SocketAddressNotAvailableError
,
UnsupportedSocketOperationError
,
UnfinishedSocketOperationError
,
ProxyAuthenticationRequiredError
,
SslHandshakeFailedError
,
ProxyConnectionRefusedError
,
ProxyConnectionClosedError
,
ProxyConnectionTimeoutError
,
ProxyNotFoundError
,
ProxyProtocolError
,
UnknownSocketError
= -1
} This enum describes the socket errors that can occur.
More...
enum
SocketOption
{
LowDelayOption
,
KeepAliveOption
,
MulticastTtlOption
,
MulticastLoopbackOption
} This enum represents the options that can be set on a socket.
More...
enum
SocketState
{
UnconnectedState
,
HostLookupState
,
ConnectingState
,
ConnectedState
,
BoundState
,
ListeningState
,
ClosingState
} This enum describes the different states in which a socket can be.
More...
enum
SocketType
{
TcpSocket
,
UdpSocket
,
UnknownSocketType
= -1
} This enum describes the transport layer protocol.
More...

Public Types inherited from
QIODevice
enum
OpenModeFlag
{
NotOpen
= 0x0000,
ReadOnly
= 0x0001,
WriteOnly
= 0x0002,
ReadWrite
= ReadOnly | WriteOnly,
Append
= 0x0004,
Truncate
= 0x0008,
Text
= 0x0010,
Unbuffered
= 0x0020
} This enum is used with
open()
to describe the mode in which a device is opened.
More...
Public Slots
void
ignoreSslErrors
()
This slot tells
QSslSocket
to ignore errors during
QSslSocket
's handshake phase and continue connecting.
More...
void
startClientEncryption
()
Starts a delayed SSL handshake for a client connection.
More...
void
startServerEncryption
()
Starts a delayed SSL handshake for a server connection.
More...

Public Slots inherited from
QObject
void
deleteLater
()
Schedules this object for deletion.
More...
Signals
void
encrypted
()
This signal is emitted when
QSslSocket
enters encrypted mode.
More...
void
encryptedBytesWritten
(
qint64
totalBytes)
This signal is emitted when
QSslSocket
writes its encrypted data to the network.
More...
void
modeChanged
(
QSslSocket::SslMode
newMode)
This signal is emitted when
QSslSocket
changes from
QSslSocket::UnencryptedMode
to either
QSslSocket::SslClientMode
or
QSslSocket::SslServerMode
.
More...
void
peerVerifyError
(const
QSslError
&
error
)
QSslSocket
can emit this signal several times during the SSL handshake, before encryption has been established, to indicate that an error has occurred while establishing the identity of the peer.
More...
void
sslErrors
(const
QList
<
QSslError
> &errors)
QSslSocket
emits this signal after the SSL handshake to indicate that one or more errors have occurred while establishing the identity of the peer.
More...

Signals inherited from
QAbstractSocket
void
connected
()
This signal is emitted after
connectToHost()
has been called and a connection has been successfully established.
More...
void
disconnected
()
This signal is emitted when the socket has been disconnected.
More...
void
error
(
QAbstractSocket::SocketError
)
This signal is emitted after an error occurred.
More...
void
hostFound
()
This signal is emitted after
connectToHost()
has been called and the host lookup has succeeded.
More...
void
proxyAuthenticationRequired
(const
QNetworkProxy
&
proxy
,
QAuthenticator
*authenticator)
void
stateChanged
(
QAbstractSocket::SocketState
)
This signal is emitted whenever
QAbstractSocket
's state changes.
More...

Signals inherited from
QIODevice
void
aboutToClose
()
This signal is emitted when the device is about to close.
More...
void
bytesWritten
(
qint64
bytes)
This signal is emitted every time a payload of data has been written to the device.
More...
void
readChannelFinished
()
This signal is emitted when the input (reading) stream is closed in this device.
More...
void
readyRead
()
This signal is emitted once every time new data is available for reading from the device.
More...

Signals inherited from
QObject
void
destroyed
(
QObject
*=0)
This signal is emitted immediately before the object
obj
is destroyed, and can not be blocked.
More...
Public Functions
void
abort
()
Aborts the current connection and resets the socket.
More...
void
addCaCertificate
(const
QSslCertificate
&certificate)
Adds the
certificate
to this socket's CA certificate database.
More...
bool
addCaCertificates
(const
QString
&path,
QSsl::EncodingFormat
format
=
QSsl::Pem
,
QRegExp::PatternSyntax
syntax=
QRegExp::FixedString
)
Searches all files in the
path
for certificates encoded in the specified
format
and adds them to this socket's CA certificate database.
More...
void
addCaCertificates
(const
QList
<
QSslCertificate
> &certificates)
Adds the
certificates
to this socket's CA certificate database.
More...
bool
atEnd
() const
Reimplemented Function
More...
qint64
bytesAvailable
() const
Returns the number of decrypted bytes that are immediately available for reading.
More...
qint64
bytesToWrite
() const
Returns the number of unencrypted bytes that are waiting to be encrypted and written to the network.
More...
QList
<
QSslCertificate
>
caCertificates
() const
Returns this socket's CA certificate database.
More...
bool
canReadLine
() const
Returns true if you can read one while line (terminated by a single ASCII '
' character) of decrypted characters; otherwise, false is returned.
More...
QList
<
QSslCipher
>
ciphers
() const
Returns this socket's current cryptographic cipher suite.
More...
void
close
()
Reimplemented Function
More...
void
connectToHostEncrypted
(const
QString
&hostName,
quint16
port, OpenMode
mode
=
ReadWrite
)
Starts an encrypted connection to the device
hostName
on
port
, using
mode
as the
OpenMode
.
More...
void
connectToHostEncrypted
(const
QString
&hostName,
quint16
port, const
QString
&sslPeerName, OpenMode
mode
=
ReadWrite
)
In addition to the original behaviour of connectToHostEncrypted, this overloaded method enables the usage of a different hostname (
sslPeerName
) for the certificate validation instead of the one used for the TCP connection (
hostName
).
More...
qint64
encryptedBytesAvailable
() const
Returns the number of encrypted bytes that are awaiting decryption.
More...
qint64
encryptedBytesToWrite
() const
Returns the number of encrypted bytes that are waiting to be written to the network.
More...
bool
flush
()
This function writes as much as possible from the internal write buffer to the underlying network socket, without blocking.
More...
void
ignoreSslErrors
(const
QList
<
QSslError
> &errors)
This method tells
QSslSocket
to ignore only the errors given in
errors
.
More...
bool
isEncrypted
() const
Returns true if the socket is encrypted; otherwise, false is returned.
More...
QSslCertificate
localCertificate
() const
Returns the socket's local
QSslCertificate
{certificate}, or an empty certificate if no local certificate has been assigned.
More...
SslMode
mode
() const
Returns the current mode for the socket; either UnencryptedMode, where
QSslSocket
behaves identially to
QTcpSocket
, or one of SslClientMode or SslServerMode, where the client is either negotiating or in encrypted mode.
More...
QSslCertificate
peerCertificate
() const
Returns the peer's digital certificate (i.e., the immediate certificate of the host you are connected to), or a null certificate, if the peer has not assigned a certificate.
More...
QList
<
QSslCertificate
>
peerCertificateChain
() const
Returns the peer's chain of digital certificates, or an empty list of certificates.
More...
int
peerVerifyDepth
() const
Returns the maximum number of certificates in the peer's certificate chain to be checked during the SSL handshake phase, or 0 (the default) if no maximum depth has been set, indicating that the whole certificate chain should be checked.
More...
QSslSocket::PeerVerifyMode
peerVerifyMode
() const
Returns the socket's verify mode.
More...
QString
peerVerifyName
() const
Returns the different hostname for the certificate validation, as set by setPeerVerifyName or by connectToHostEncrypted.
More...
QSslKey
privateKey
() const
Returns this socket's private key.
More...
QSsl::SslProtocol
protocol
() const
Returns the socket's SSL protocol.
More...
QSslSocket
(
QObject
*
parent
=0)
Constructs a
QSslSocket
object.
More...
QSslCipher
sessionCipher
() const
Returns the socket's cryptographic
QSslCipher
{cipher}, or a null cipher if the connection isn't encrypted.
More...
void
setCaCertificates
(const
QList
<
QSslCertificate
> &certificates)
Sets this socket's CA certificate database to be
certificates
.
More...
void
setCiphers
(const
QList
<
QSslCipher
> &
ciphers
)
Sets the cryptographic cipher suite for this socket to
ciphers
, which must contain a subset of the ciphers in the list returned by
supportedCiphers()
.
More...
void
setCiphers
(const
QString
&
ciphers
)
Sets the cryptographic cipher suite for this socket to
ciphers
, which is a colon-separated list of cipher suite names.
More...
void
setLocalCertificate
(const
QSslCertificate
&certificate)
Sets the socket's local certificate to
certificate
.
More...
void
setLocalCertificate
(const
QString
&
fileName
,
QSsl::EncodingFormat
format
=
QSsl::Pem
)
Sets the socket's local
QSslCertificate
{certificate} to the first one found in file
path
, which is parsed according to the specified
format
.
More...
void
setPeerVerifyDepth
(int depth)
Sets the maximum number of certificates in the peer's certificate chain to be checked during the SSL handshake phase, to
depth
.
More...
void
setPeerVerifyMode
(
QSslSocket::PeerVerifyMode
mode
)
Sets the socket's verify mode to
mode
.
More...
void
setPeerVerifyName
(const
QString
&hostName)
Sets a different host name, given by
hostName
, for the certificate validation instead of the one used for the TCP connection.
More...
void
setPrivateKey
(const
QSslKey
&
key
)
Sets the socket's private
QSslKey
{key} to
key
.
More...
void
setPrivateKey
(const
QString
&
fileName
,
QSsl::KeyAlgorithm
algorithm=
QSsl::Rsa
,
QSsl::EncodingFormat
format
=
QSsl::Pem
, const
QByteArray
&passPhrase=
QByteArray
())
Reads the string in file
fileName
and decodes it using a specified
algorithm
and encoding
format
to construct an
QSslKey
{SSL key}.
More...
void
setProtocol
(
QSsl::SslProtocol
protocol
)
Sets the socket's SSL protocol to
protocol
.
More...
void
setReadBufferSize
(
qint64
size
)
Sets the size of
QSslSocket
's internal read buffer to be
size
bytes.
More...
bool
setSocketDescriptor
(int
socketDescriptor
,
SocketState
state
=
ConnectedState
, OpenMode
openMode
=
ReadWrite
)
Initializes
QSslSocket
with the native socket descriptor
socketDescriptor
.
More...
void
setSocketOption
(
QAbstractSocket::SocketOption
option, const
QVariant
&value)
Sets the given
option
to the value described by
value
.
More...
void
setSslConfiguration
(const
QSslConfiguration
&config)
Sets the socket's SSL configuration to be the contents of
configuration
.
More...
QVariant
socketOption
(
QAbstractSocket::SocketOption
option)
Returns the value of the
option
option.
More...
QSslConfiguration
sslConfiguration
() const
Returns the socket's SSL configuration state.
More...
QList
<
QSslError
>
sslErrors
() const
Returns a list of the last SSL errors that occurred.
More...
bool
waitForBytesWritten
(int msecs=30000)
Reimplemented Function
More...
bool
waitForConnected
(int msecs=30000)
Waits until the socket is connected, or
msecs
milliseconds, whichever happens first.
More...
bool
waitForDisconnected
(int msecs=30000)
Waits until the socket has disconnected or
msecs
milliseconds, whichever comes first.
More...
bool
waitForEncrypted
(int msecs=30000)
Waits until the socket has completed the SSL handshake and has emitted
encrypted()
, or
msecs
milliseconds, whichever comes first.
More...
bool
waitForReadyRead
(int msecs=30000)
Reimplemented Function
More...
~QSslSocket
()
Destroys the
QSslSocket
.
More...

Public Functions inherited from
QTcpSocket
QTcpSocket
(
QObject
*
parent
=0)
Creates a
QTcpSocket
object in state
UnconnectedState
.
More...
virtual
~QTcpSocket
()
Destroys the socket, closing the connection if necessary.
More...

Public Functions inherited from
QAbstractSocket
void
abort
()
Aborts the current connection and resets the socket.
More...
void
connectToHost
(const
QString
&hostName,
quint16
port, OpenMode mode=
ReadWrite
)
Attempts to make a connection to
hostName
on the given
port
.
More...
void
connectToHost
(const
QHostAddress
&address,
quint16
port, OpenMode mode=
ReadWrite
)
Attempts to make a connection to
address
on port
port
.
More...
void
disconnectFromHost
()
Attempts to close the socket.
More...
SocketError
error
() const
Returns the type of error that last occurred.
More...
bool
flush
()
This function writes as much as possible from the internal write buffer to the underlying network socket, without blocking.
More...
bool
isSequential
() const
Reimplemented Function
More...
bool
isValid
() const
Returns true if the socket is valid and ready for use; otherwise returns false.
More...
QHostAddress
localAddress
() const
Returns the host address of the local socket if available; otherwise returns
QHostAddress::Null
.
More...
quint16
localPort
() const
Returns the host port number (in native byte order) of the local socket if available; otherwise returns 0.
More...
QHostAddress
peerAddress
() const
Returns the address of the connected peer if the socket is in ConnectedState; otherwise returns
QHostAddress::Null
.
More...
QString
peerName
() const
Returns the name of the peer as specified by
connectToHost()
, or an empty
QString
if
connectToHost()
has not been called.
More...
quint16
peerPort
() const
Returns the port of the connected peer if the socket is in ConnectedState; otherwise returns 0.
More...
QNetworkProxy
proxy
() const
Returns the network proxy for this socket.
More...
QAbstractSocket
(
SocketType
socketType
,
QObject
*
parent
)
Creates a new abstract socket of type
socketType
.
More...
qint64
readBufferSize
() const
Returns the size of the internal read buffer.
More...
void
setProxy
(const
QNetworkProxy
&networkProxy)
Sets the explicit network proxy for this socket to
networkProxy
.
More...
void
setReadBufferSize
(
qint64
size
)
Sets the size of
QAbstractSocket
's internal read buffer to be
size
bytes.
More...
bool
setSocketDescriptor
(int
socketDescriptor
,
SocketState
state
=
ConnectedState
, OpenMode
openMode
=
ReadWrite
)
Initializes
QAbstractSocket
with the native socket descriptor
socketDescriptor
.
More...
void
setSocketOption
(
QAbstractSocket::SocketOption
option, const
QVariant
&value)
Sets the given
option
to the value described by
value
.
More...
int
socketDescriptor
() const
Returns the native socket descriptor of the
QAbstractSocket
object if this is available; otherwise returns -1.
More...
QVariant
socketOption
(
QAbstractSocket::SocketOption
option)
Returns the value of the
option
option.
More...
SocketType
socketType
() const
Returns the socket type (TCP, UDP, or other).
More...
SocketState
state
() const
Returns the state of the socket.
More...
bool
waitForConnected
(int msecs=30000)
Waits until the socket is connected, up to
msecs
milliseconds.
More...
bool
waitForDisconnected
(int msecs=30000)
Waits until the socket has disconnected, up to
msecs
milliseconds.
More...
virtual
~QAbstractSocket
()
Destroys the socket.
More...

Public Functions inherited from
QIODevice
QString
errorString
() const
Returns a human-readable description of the last device error that occurred.
More...
bool
getChar
(char *
c
)
Reads one character from the device and stores it in
c
.
More...
bool
isOpen
() const
Returns true if the device is open; otherwise returns false.
More...
bool
isReadable
() const
Returns true if data can be read from the device; otherwise returns false.
More...
bool
isTextModeEnabled
() const
Returns true if the
Text
flag is enabled; otherwise returns false.
More...
bool
isWritable
() const
Returns true if data can be written to the device; otherwise returns false.
More...
virtual bool
open
(OpenMode mode)
Opens the device and sets its OpenMode to
mode
.
More...
OpenMode
openMode
() const
Returns the mode in which the device has been opened; i.e.
More...
qint64
peek
(char *
data
,
qint64
maxlen)
Reads at most
maxSize
bytes from the device into
data
, without side effects (i.
More...
QByteArray
peek
(
qint64
maxlen)
Peeks at most
maxSize
bytes from the device, returning the data peeked as a
QByteArray
.
More...
virtual
qint64
pos
() const
For random-access devices, this function returns the position that data is written to or read from.
More...
bool
putChar
(char
c
)
Writes the character
c
to the device.
More...
QIODevice
()
Constructs a
QIODevice
object.
More...
QIODevice
(
QObject
*
parent
)
Constructs a
QIODevice
object with the given
parent
.
More...
qint64
read
(char *
data
,
qint64
maxlen)
Reads at most
maxSize
bytes from the device into
data
, and returns the number of bytes read.
More...
QByteArray
read
(
qint64
maxlen)
Reads at most
maxSize
bytes from the device, and returns the data read as a
QByteArray
.
More...
QByteArray
readAll
()
Reads all available data from the device, and returns it as a
QByteArray
.
More...
qint64
readLine
(char *
data
,
qint64
maxlen)
This function reads a line of ASCII characters from the device, up to a maximum of
maxSize
- 1 bytes, stores the characters in
data
, and returns the number of bytes read.
More...
QByteArray
readLine
(
qint64
maxlen=0)
Reads a line from the device, but no more than
maxSize
characters, and returns the result as a
QByteArray
.
More...
virtual bool
reset
()
Seeks to the start of input for random-access devices.
More...
virtual bool
seek
(
qint64
pos
)
For random-access devices, this function sets the current position to
pos
, returning true on success, or false if an error occurred.
More...
void
setTextModeEnabled
(bool
enabled
)
If
enabled
is true, this function sets the
Text
flag on the device; otherwise the
Text
flag is removed.
More...
virtual
qint64
size
() const
For open random-access devices, this function returns the size of the device.
More...
void
ungetChar
(char
c
)
Puts the character
c
back into the device, and decrements the current position unless the position is 0.
More...
qint64
write
(const char *
data
,
qint64
len)
Writes at most
maxSize
bytes of data from
data
to the device.
More...
qint64
write
(const char *
data
)
Writes data from a zero-terminated string of 8-bit characters to the device.
More...
qint64
write
(const
QByteArray
&
data
)
Writes the content of
byteArray
to the device.
More...
virtual
~QIODevice
()
The destructor is virtual, and
QIODevice
is an abstract base class.
More...

Public Functions inherited from
QObject
bool
blockSignals
(bool b)
If
block
is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
More...
const
QObjectList
&
children
() const
Returns a list of child objects.
More...
bool
connect
(const
QObject
*
sender
, const char *signal, const char *member,
Qt::ConnectionType
type
=
Qt::AutoConnection
) const
bool
disconnect
(const char *signal=0, const
QObject
*receiver=0, const char *member=0)
bool
disconnect
(const
QObject
*receiver, const char *member=0)
void
dumpObjectInfo
()
Dumps information about signal connections, etc.
More...
void
dumpObjectTree
()
Dumps a tree of children to the debug output.
More...
QList
<
QByteArray
>
dynamicPropertyNames
() const
Returns the names of all properties that were dynamically added to the object using
setProperty()
.
More...
virtual bool
event
(
QEvent
*)
This virtual function receives events to an object and should return true if the event
e
was recognized and processed.
More...
virtual bool
eventFilter
(
QObject
*,
QEvent
*)
Filters events if this object has been installed as an event filter for the
watched
object.
More...
template<typename T >
T
findChild
(const
QString
&aName=
QString
()) const
Returns the child of this object that can be cast into type T and that is called
name
, or 0 if there is no such object.
More...
template<typename T >
QList
< T >
findChildren
(const
QString
&aName=
QString
()) const
Returns all children of this object with the given
name
that can be cast to type T, or an empty list if there are no such objects.
More...
template<typename T >
QList
< T >
findChildren
(const
QRegExp
&re) const
bool
inherits
(const char *classname) const
Returns true if this object is an instance of a class that inherits
className
or a
QObject
subclass that inherits
className
; otherwise returns false.
More...
void
installEventFilter
(
QObject
*)
Installs an event filter
filterObj
on this object.
More...
bool
isWidgetType
() const
Returns true if the object is a widget; otherwise returns false.
More...
void
killTimer
(int id)
Kills the timer with timer identifier,
id
.
More...
virtual const
QMetaObject
*
metaObject
() const
Returns a pointer to the meta-object of this object.
More...
void
moveToThread
(
QThread
*
thread
)
Changes the thread affinity for this object and its children.
More...
QString
objectName
() const
QObject
*
parent
() const
Returns a pointer to the parent object.
More...
QVariant
property
(const char *
name
) const
Returns the value of the object's
name
property.
More...
Q_INVOKABLE
QObject
(
QObject
*
parent
=0)
Constructs an object with parent object
parent
.
More...
void
removeEventFilter
(
QObject
*)
Removes an event filter object
obj
from this object.
More...
void
setObjectName
(const
QString
&
name
)
void
setParent
(
QObject
*)
Makes the object a child of
parent
.
More...
bool
setProperty
(const char *
name
, const
QVariant
&value)
Sets the value of the object's
name
property to
value
.
More...
void
setUserData
(
uint
id,
QObjectUserData
*
data
)
bool
signalsBlocked
() const
Returns true if signals are blocked; otherwise returns false.
More...
int
startTimer
(int interval)
Starts a timer and returns a timer identifier, or returns zero if it could not start a timer.
More...
QThread
*
thread
() const
Returns the thread in which the object lives.
More...
QObjectUserData
*
userData
(
uint
id) const
virtual
~QObject
()
Destroys the object, deleting all its child objects.
More...
Static Public Functions
static void
addDefaultCaCertificate
(const
QSslCertificate
&certificate)
Adds
certificate
to the default CA certificate database.
More...
static bool
addDefaultCaCertificates
(const
QString
&path,
QSsl::EncodingFormat
format
=
QSsl::Pem
,
QRegExp::PatternSyntax
syntax=
QRegExp::FixedString
)
Searches all files in the
path
for certificates with the specified
encoding
and adds them to the default CA certificate database.
More...
static void
addDefaultCaCertificates
(const
QList
<
QSslCertificate
> &certificates)
Adds
certificates
to the default CA certificate database.
More...
static
QList
<
QSslCertificate
>
defaultCaCertificates
()
Returns the current default CA certificate database.
More...
static
QList
<
QSslCipher
>
defaultCiphers
()
Returns the default cryptographic cipher suite for all sockets in this application.
More...
static void
setDefaultCaCertificates
(const
QList
<
QSslCertificate
> &certificates)
Sets the default CA certificate database to
certificates
.
More...
static void
setDefaultCiphers
(const
QList
<
QSslCipher
> &
ciphers
)
Sets the default cryptographic cipher suite for all sockets in this application to
ciphers
, which must contain a subset of the ciphers in the list returned by
supportedCiphers()
.
More...
static
QList
<
QSslCipher
>
supportedCiphers
()
Returns the list of cryptographic ciphers supported by this system.
More...
static bool
supportsSsl
()
Returns true if this platform supports SSL; otherwise, returns false.
More...
static
QList
<
QSslCertificate
>
systemCaCertificates
()
This function provides the CA certificate database provided by the operating system.
More...

Static Public Functions inherited from
QObject
static bool
connect
(const
QObject
*
sender
, const char *signal, const
QObject
*receiver, const char *member,
Qt::ConnectionType
=
Qt::AutoConnection
)
Creates a connection of the given
type
from the
signal
in the
sender
object to the
method
in the
receiver
object.
More...
static bool
connect
(const
QObject
*
sender
, const
QMetaMethod
&signal, const
QObject
*receiver, const
QMetaMethod
&method,
Qt::ConnectionType
type
=
Qt::AutoConnection
)
static bool
disconnect
(const
QObject
*
sender
, const char *signal, const
QObject
*receiver, const char *member)
Disconnects
signal
in object
sender
from
method
in object
receiver
.
More...
static bool
disconnect
(const
QObject
*
sender
, const
QMetaMethod
&signal, const
QObject
*receiver, const
QMetaMethod
&member)
static
uint
registerUserData
()
static
QString
tr
(const char *sourceText, const char *comment=0, int n=-1)
static
QString
trUtf8
(const char *sourceText, const char *comment=0, int n=-1)
Protected Slots
void
connectToHostImplementation
(const
QString
&hostName,
quint16
port, OpenMode
openMode
)
void
disconnectFromHostImplementation
()

Protected Slots inherited from
QAbstractSocket
void
connectToHostImplementation
(const
QString
&hostName,
quint16
port, OpenMode mode=
ReadWrite
)
Contains the implementation of
connectToHost()
.
More...
void
disconnectFromHostImplementation
()
Contains the implementation of
disconnectFromHost()
.
More...
Protected Functions
qint64
readData
(char *
data
,
qint64
maxlen)
Reimplemented Function
More...
qint64
writeData
(const char *
data
,
qint64
len)
Reimplemented Function
More...

Protected Functions inherited from
QTcpSocket
QTcpSocket
(
QTcpSocketPrivate
&dd,
QObject
*
parent
=0)

Protected Functions inherited from
QAbstractSocket
QAbstractSocket
(
SocketType
socketType
,
QAbstractSocketPrivate
&dd,
QObject
*
parent
=0)
Constructs a new abstract socket of type
socketType
.
More...
qint64
readLineData
(char *
data
,
qint64
maxlen)
Reimplemented Function
More...
void
setLocalAddress
(const
QHostAddress
&address)
Sets the address on the local side of a connection to
address
.
More...
void
setLocalPort
(
quint16
port)
Sets the port on the local side of a connection to
port
.
More...
void
setPeerAddress
(const
QHostAddress
&address)
Sets the address of the remote side of the connection to
address
.
More...
void
setPeerName
(const
QString
&
name
)
Sets the host name of the remote peer to
name
.
More...
void
setPeerPort
(
quint16
port)
Sets the port of the remote side of the connection to
port
.
More...
void
setSocketError
(
SocketError
socketError)
Sets the type of error that last occurred to
socketError
.
More...
void
setSocketState
(
SocketState
state
)
Sets the state of the socket to
state
.
More...

Protected Functions inherited from
QIODevice
QIODevice
(
QIODevicePrivate
&dd,
QObject
*
parent
=0)
void
setErrorString
(const
QString
&
errorString
)
Sets the human readable description of the last device error that occurred to
str
.
More...
void
setOpenMode
(OpenMode
openMode
)
Sets the OpenMode of the device to
openMode
.
More...

Protected Functions inherited from
QObject
virtual void
childEvent
(
QChildEvent
*)
This event handler can be reimplemented in a subclass to receive child events.
More...
virtual void
connectNotify
(const char *signal)
This virtual function is called when something has been connected to
signal
in this object.
More...
virtual void
customEvent
(
QEvent
*)
This event handler can be reimplemented in a subclass to receive custom events.
More...
virtual void
disconnectNotify
(const char *signal)
This virtual function is called when something has been disconnected from
signal
in this object.
More...
QObject
(
QObjectPrivate
&dd,
QObject
*
parent
=0)
int
receivers
(const char *signal) const
Returns the number of receivers connected to the
signal
.
More...
QObject
*
sender
() const
Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0.
More...
int
senderSignalIndex
() const
virtual void
timerEvent
(
QTimerEvent
*)
This event handler can be reimplemented in a subclass to receive timer events for the object.
More...
Friends
class
QSslSocketBackendPrivate
Additional Inherited Members

Static Public Variables inherited from
QObject
static const
QMetaObject
staticMetaObject
This variable stores the meta-object for the class.
More...

Protected Variables inherited from
QObject
QScopedPointer
<
QObjectData
>
d_ptr

Static Protected Variables inherited from
QObject
static const
QMetaObject
staticQtMetaObject

Related Functions inherited from
QObject
T
qFindChildqFindChildren
(const
QObject
*obj, const
QString
&
name
)()
QList
< T >
qFindChildrenqFindChildren
(const
QObject
*obj, const
QString
&
name
)()
QList
< T >
qFindChildrenqFindChildren
(const
QObject
*obj, const
QRegExp
®Exp)()
T *
qobject_cast
(
QObject
*object)
QObjectList
void *
qt_find_obj_child
(
QObject
*
parent
, const char *
type
, const
QString
&
name
)
Returns a pointer to the object named
name
that inherits
type
and with a given
parent
.
More...
The
QSslSocket
class provides an SSL encrypted socket for both clients and servers.
-
Since
-
4.3
-
Note
-
This class or function is
reentrant
.
-
Attention
-
Module:
QtNetwork
QSslSocket
establishes a secure, encrypted TCP connection you can use for transmitting encrypted data. It can operate in both client and server mode, and it supports modern SSL protocols, including SSLv3 and TLSv1. By default,
QSslSocket
uses TLSv1, but you can change the SSL protocol by calling
setProtocol()
as long as you do it before the handshake has started.
SSL encryption operates on top of the existing TCP stream after the socket enters the ConnectedState. There are two simple ways to establish a secure connection using
QSslSocket
: With an immediate SSL handshake, or with a delayed SSL handshake occurring after the connection has been established in unencrypted mode.
The most common way to use
QSslSocket
is to construct an object and start a secure connection by calling
connectToHostEncrypted()
. This method starts an immediate SSL handshake once the connection has been established.
As with a plain
QTcpSocket
,
QSslSocket
enters the HostLookupState, ConnectingState, and finally the ConnectedState, if the connection is successful. The handshake then starts automatically, and if it succeeds, the
encrypted()
signal is emitted to indicate the socket has entered the encrypted state and is ready for use.
Note that data can be written to the socket immediately after the return from
connectToHostEncrypted()
(i.e., before the
encrypted()
signal is emitted). The data is queued in
QSslSocket
until after the
encrypted()
signal is emitted.
An example of using the delayed SSL handshake to secure an existing connection is the case where an SSL server secures an incoming connection. Suppose you create an SSL server class as a subclass of
QTcpServer
. You would override
QTcpServer::incomingConnection()
with something like the example below, which first constructs an instance of
QSslSocket
and then calls
setSocketDescriptor()
to set the new socket's descriptor to the existing one passed in. It then initiates the SSL handshake by calling
startServerEncryption()
.
{
}
else
{
delete
serverSocket;
}
}
If an error occurs,
QSslSocket
emits the
sslErrors()
signal. In this case, if no action is taken to ignore the
error(s)
, the connection is dropped. To continue, despite the occurrence of an error, you can call
ignoreSslErrors()
, either from within this slot after the error occurs, or any time after construction of the
QSslSocket
and before the connection is attempted. This will allow
QSslSocket
to ignore the errors it encounters when establishing the identity of the peer. Ignoring errors during an SSL handshake should be used with caution, since a fundamental characteristic of secure connections is that they should be established with a successful handshake.
Once encrypted, you use
QSslSocket
as a regular
QTcpSocket
. When
readyRead()
is emitted, you can call
read()
,
canReadLine()
and
readLine()
, or
getChar()
to read decrypted data from
QSslSocket
's internal buffer, and you can call
write()
or
putChar()
to write data back to the peer.
QSslSocket
will automatically encrypt the written data for you, and emit
encryptedBytesWritten()
once the data has been written to the peer.
As a convenience,
QSslSocket
supports
QTcpSocket
's blocking functions
waitForConnected()
,
waitForReadyRead()
,
waitForBytesWritten()
, and
waitForDisconnected()
. It also provides
waitForEncrypted()
, which will block the calling thread until an encrypted connection has been established.
return
false
;
}
socket.
write
(
"GET / HTTP/1.0\r\n\r\n"
);
QSslSocket
provides an extensive, easy-to-use API for handling cryptographic ciphers, private keys, and local, peer, and Certification Authority (CA) certificates. It also provides an API for handling errors that occur during the handshake phase.
The following features can also be customized:
The socket's cryptographic cipher suite can be customized before the handshake phase with
setCiphers()
and
setDefaultCiphers()
.
The socket's local certificate and private key can be customized before the handshake phase with
setLocalCertificate()
and
setPrivateKey()
.
The CA certificate database can be extended and customized with
addCaCertificate()
,
addCaCertificates()
,
setCaCertificates()
,
addDefaultCaCertificate()
,
addDefaultCaCertificates()
, and
setDefaultCaCertificates()
.
-
Note
-
If available, root certificates on Unix (excluding Mac OS X) will be loaded on demand from the standard certificate directories. If you do not want to load root certificates on demand, you need to call either the static function
setDefaultCaCertificates()
before the first SSL handshake is made in your application, (e.g. via "QSslSocket::setDefaultCaCertificates(QSslSocket::systemCaCertificates());"), or call
setCaCertificates()
on your
QSslSocket
instance prior to the SSL handshake.
For more information about ciphers and certificates, refer to
QSslCipher
and
QSslCertificate
.
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (
qmake-variable-reference.html#target-capability
{TARGET.CAPABILITY} qmake variable.
-
See also
-
QSslCertificate
,
QSslCipher
,
QSslError
Definition at line
67
of file
qsslsocket.h
.
◆
PeerVerifyMode
Describes the peer verification modes for
QSslSocket
.
-
Since
-
4.4
The default mode is AutoVerifyPeer, which selects an appropriate mode depending on the socket's QSocket::SslMode.
VerifyNone
QSslSocket
will not request a certificate from the peer. You can set this mode if you are not interested in the identity of the other side of the connection. The connection will still be encrypted, and your socket will still send its local certificate to the peer if it's requested.
QueryPeer
QSslSocket
will request a certificate from the peer, but does not require this certificate to be valid. This is useful when you want to display peer certificate details to the user without affecting the actual SSL handshake. This mode is the default for servers.
VerifyPeer
QSslSocket
will request a certificate from the peer during the SSL handshake phase, and requires that this certificate is valid. On failure,
QSslSocket
will emit the
QSslSocket::sslErrors()
signal. This mode is the default for clients.
AutoVerifyPeer
QSslSocket
will automatically use QueryPeer for server sockets and VerifyPeer for client sockets.
-
See also
-
QSslSocket::peerVerifyMode()
Enumerator
VerifyNone
QueryPeer
VerifyPeer
AutoVerifyPeer
Definition at line
77
of file
qsslsocket.h
.
Describes the connection modes available for
QSslSocket
.
UnencryptedMode
The socket is unencrypted. Its behavior is identical to
QTcpSocket
.
SslClientMode
The socket is a client-side SSL socket. It is either alreayd encrypted, or it is in the SSL handshake phase (see
QSslSocket::isEncrypted()
).
SslServerMode
The socket is a server-side SSL socket. It is either already encrypted, or it is in the SSL handshake phase (see
QSslSocket::isEncrypted()
).
Enumerator
UnencryptedMode
SslClientMode
SslServerMode
Definition at line
71
of file
qsslsocket.h
.
◆
QSslSocket()
Constructs a
QSslSocket
object.
parent
is passed to
QObject
's constructor. The new socket's
QSslCipher
{cipher} suite is set to the one returned by the static method
defaultCiphers()
.
Definition at line
350
of file
qsslsocket.cpp
.
354
#ifdef QSSLSOCKET_DEBUG
355
qDebug
() <<
"QSslSocket::QSslSocket("
<< parent <<
"), this ="
<< (
void
*)
this
;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
QTcpSocket(QObject *parent=0)
Creates a QTcpSocket object in state UnconnectedState.
Q_CORE_EXPORT void qDebug(const char *,...)
Definition at line
364
of file
qsslsocket.cpp
.
367
#ifdef QSSLSOCKET_DEBUG
368
qDebug
() <<
"QSslSocket::~QSslSocket(), this ="
<< (
void
*)
this
;
370
delete
d
->plainSocket;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Q_CORE_EXPORT void qDebug(const char *,...)
◆
abort()
Aborts the current connection and resets the socket.
Unlike
disconnectFromHost()
, this function immediately closes the socket, clearing any pending data in the write buffer.
-
See also
-
disconnectFromHost()
,
close()
Definition at line
893
of file
qsslsocket.cpp
.
896
#ifdef QSSLSOCKET_DEBUG
897
qDebug
() <<
"QSslSocket::abort()"
;
899
if
(
d
->plainSocket)
900
d
->plainSocket->abort();
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Q_CORE_EXPORT void qDebug(const char *,...)
void close()
Reimplemented Function
Adds the
certificate
to this socket's CA certificate database.
The CA certificate database is used by the socket during the handshake phase to validate the peer's certificate.
To add multiple certificates, use
addCaCertificates()
.
-
See also
-
caCertificates()
,
setCaCertificates()
Definition at line
1316
of file
qsslsocket.cpp
.
1319
d
->configuration.caCertificates += certificate;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Searches all files in the
path
for certificates encoded in the specified
format
and adds them to this socket's CA certificate database.
path
can be explicit, or it can contain wildcards in the format specified by
syntax
. Returns true if one or more certificates are added to the socket's CA certificate database; otherwise returns false.
The CA certificate database is used by the socket during the handshake phase to validate the peer's certificate.
For more precise control, use
addCaCertificate()
.
-
See also
-
addCaCertificate()
,
QSslCertificate::fromPath()
Definition at line
1295
of file
qsslsocket.cpp
.
1303
d
->configuration.caCertificates += certs;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
bool isEmpty() const
Returns true if the list contains no items; otherwise returns false.
static QList< QSslCertificate > fromPath(const QString &path, QSsl::EncodingFormat format=QSsl::Pem, QRegExp::PatternSyntax syntax=QRegExp::FixedString)
Searches all files in the path for certificates encoded in the specified format and returns them in a...
Adds the
certificates
to this socket's CA certificate database.
The CA certificate database is used by the socket during the handshake phase to validate the peer's certificate.
For more precise control, use
addCaCertificate()
.
-
See also
-
caCertificates()
,
addDefaultCaCertificate()
Definition at line
1331
of file
qsslsocket.cpp
.
1334
d
->configuration.caCertificates += certificates;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Adds
certificate
to the default CA certificate database.
Each SSL socket's CA certificate database is initialized to the default CA certificate database.
-
See also
-
defaultCaCertificates()
,
addCaCertificates()
Definition at line
1399
of file
qsslsocket.cpp
.
static void addDefaultCaCertificate(const QSslCertificate &cert)
Searches all files in the
path
for certificates with the specified
encoding
and adds them to the default CA certificate database.
path
can be an explicit file, or it can contain wildcards in the format specified by
syntax
. Returns true if any CA certificates are added to the default database.
Each SSL socket's CA certificate database is initialized to the default CA certificate database.
-
See also
-
defaultCaCertificates()
,
addCaCertificates()
,
addDefaultCaCertificate()
Definition at line
1386
of file
qsslsocket.cpp
.
static bool addDefaultCaCertificates(const QString &path, QSsl::EncodingFormat format, QRegExp::PatternSyntax syntax)
Adds
certificates
to the default CA certificate database.
Each SSL socket's CA certificate database is initialized to the default CA certificate database.
-
See also
-
defaultCaCertificates()
,
addCaCertificates()
Definition at line
1411
of file
qsslsocket.cpp
.
static bool addDefaultCaCertificates(const QString &path, QSsl::EncodingFormat format, QRegExp::PatternSyntax syntax)
Definition at line
833
of file
qsslsocket.cpp
.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
virtual bool atEnd() const
Returns true if the current read and write position is at the end of the device (i.e.
Returns the number of decrypted bytes that are immediately available for reading.
Reimplemented Function
Reimplemented from
QAbstractSocket
.
Definition at line
731
of file
qsslsocket.cpp
.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
virtual qint64 bytesAvailable() const
Returns the number of bytes that are available for reading.
Returns the number of unencrypted bytes that are waiting to be encrypted and written to the network.
Reimplemented Function
Reimplemented from
QAbstractSocket
.
Definition at line
748
of file
qsslsocket.cpp
.
752
return
d
->plainSocket ?
d
->plainSocket->bytesToWrite() : 0;
753
return
d
->writeBuffer.size();
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Returns this socket's CA certificate database.
The CA certificate database is used by the socket during the handshake phase to validate the peer's certificate. It can be moodified prior to the handshake with
addCaCertificate()
,
addCaCertificates()
, and
setCaCertificates()
.
-
Note
-
On Unix, this method may return an empty list if the root certificates are loaded on demand.
-
See also
-
addCaCertificate()
,
addCaCertificates()
,
setCaCertificates()
Definition at line
1368
of file
qsslsocket.cpp
.
1371
return
d
->configuration.caCertificates;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Returns true if you can read one while line (terminated by a single ASCII '
' character) of decrypted characters; otherwise, false is returned.
Reimplemented Function
Reimplemented from
QAbstractSocket
.
Definition at line
800
of file
qsslsocket.cpp
.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
virtual bool canReadLine() const
Returns true if a complete line of data can be read from the device; otherwise returns false...
Returns this socket's current cryptographic cipher suite.
This list is used during the socket's handshake phase for choosing a session cipher. The returned list of ciphers is ordered by descending preference. (i.e., the first cipher in the list is the most preferred cipher). The session cipher will be the first one in the list that is also supported by the peer.
By default, the handshake phase can choose any of the ciphers supported by this system's SSL libraries, which may vary from system to system. The list of ciphers supported by this system's SSL libraries is returned by
supportedCiphers()
. You can restrict the list of ciphers used for choosing the session cipher for this socket by calling
setCiphers()
with a subset of the supported ciphers. You can revert to using the entire set by calling
setCiphers()
with the list returned by
supportedCiphers()
.
You can restrict the list of ciphers used for choosing the session cipher for
all
sockets by calling
setDefaultCiphers()
with a subset of the supported ciphers. You can revert to using the entire set by calling
setCiphers()
with the list returned by
supportedCiphers()
.
-
See also
-
setCiphers()
,
defaultCiphers()
,
setDefaultCiphers()
,
supportedCiphers()
Definition at line
1183
of file
qsslsocket.cpp
.
1186
return
d
->configuration.ciphers;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Definition at line
811
of file
qsslsocket.cpp
.
813
#ifdef QSSLSOCKET_DEBUG
814
qDebug
() <<
"QSslSocket::close()"
;
817
if
(
d
->plainSocket)
818
d
->plainSocket->close();
822
d
->readBuffer.clear();
823
d
->writeBuffer.clear();
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Q_CORE_EXPORT void qDebug(const char *,...)
void close()
Closes the I/O device for the socket, disconnects the socket's connection with the host...
Starts an encrypted connection to the device
hostName
on
port
, using
mode
as the
OpenMode
.
This is equivalent to calling
connectToHost()
to establish the connection, followed by a call to
startClientEncryption()
.
QSslSocket
first enters the HostLookupState. Then, after entering either the event loop or one of the waitFor...() functions, it enters the ConnectingState, emits
connected()
, and then initiates the SSL client handshake. At each state change,
QSslSocket
emits signal
stateChanged()
.
After initiating the SSL client handshake, if the identity of the peer can't be established, signal
sslErrors()
is emitted. If you want to ignore the errors and continue connecting, you must call
ignoreSslErrors()
, either from inside a slot function connected to the
sslErrors()
signal, or prior to entering encrypted mode. If
ignoreSslErrors()
is not called, the connection is dropped, signal
disconnected()
is emitted, and
QSslSocket
returns to the UnconnectedState.
If the SSL handshake is successful,
QSslSocket
emits
encrypted()
.
socket->
write
(
"1 CAPABILITY\r\n"
);
Note:
The example above shows that text can be written to the socket immediately after requesting the encrypted connection, before the
encrypted()
signal has been emitted. In such cases, the text is queued in the object and written to the socket
after
the connection is established and the
encrypted()
signal has been emitted.
The default for
mode
is
ReadWrite
.
If you want to create a
QSslSocket
on the server side of a connection, you should instead call
startServerEncryption()
upon receiving the incoming connection through
QTcpServer
.
-
See also
-
connectToHost()
,
startClientEncryption()
,
waitForConnected()
,
waitForEncrypted()
Definition at line
414
of file
qsslsocket.cpp
.
Referenced by
QHttpPrivate::_q_slotSendRequest()
, and
QHttpNetworkConnectionChannel::ensureConnection()
.
418
qWarning
(
"QSslSocket::connectToHostEncrypted() called when already connecting/connected"
);
423
d
->autoStartHandshake =
true
;
424
d
->initialized =
true
;
SslMode mode() const
Returns the current mode for the socket; either UnencryptedMode, where QSslSocket behaves identially ...
void connectToHost(const QString &hostName, quint16 port, OpenMode mode=ReadWrite)
Attempts to make a connection to hostName on the given port.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Q_CORE_EXPORT void qWarning(const char *,...)
In addition to the original behaviour of connectToHostEncrypted, this overloaded method enables the usage of a different hostname (
sslPeerName
) for the certificate validation instead of the one used for the TCP connection (
hostName
).
-
Since
-
4.6 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
-
See also
-
connectToHostEncrypted()
Definition at line
445
of file
qsslsocket.cpp
.
450
qWarning
(
"QSslSocket::connectToHostEncrypted() called when already connecting/connected"
);
455
d
->autoStartHandshake =
true
;
456
d
->initialized =
true
;
457
d
->verificationPeerName = sslPeerName;
SslMode mode() const
Returns the current mode for the socket; either UnencryptedMode, where QSslSocket behaves identially ...
void connectToHost(const QString &hostName, quint16 port, OpenMode mode=ReadWrite)
Attempts to make a connection to hostName on the given port.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Q_CORE_EXPORT void qWarning(const char *,...)
-
Warning
-
This function is not part of the public interface.
Definition at line
1795
of file
qsslsocket.cpp
.
1799
if
(!
d
->initialized)
1801
d
->initialized =
false
;
1803
#ifdef QSSLSOCKET_DEBUG
1804
qDebug
() <<
"QSslSocket::connectToHostImplementation("
1805
<< hostName <<
','
<< port <<
','
<<
openMode
<<
')'
;
1807
if
(!
d
->plainSocket) {
1808
#ifdef QSSLSOCKET_DEBUG
1809
qDebug
() <<
"\tcreating internal plain socket"
;
1811
d
->createPlainSocket(openMode);
1813
#ifndef QT_NO_NETWORKPROXY
1814
d
->plainSocket->setProxy(
proxy
());
1816
d
->plainSocket->setProperty(
"_q_user-agent"
,
property
(
"_q_user-agent"
));
1819
d
->plainSocket->connectToHost(hostName, port, openMode);
1820
d
->cachedSocketDescriptor =
d
->plainSocket->socketDescriptor();
QNetworkProxy proxy() const
Returns the network proxy for this socket.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Q_CORE_EXPORT void qDebug(const char *,...)
OpenMode openMode() const
Returns the mode in which the device has been opened; i.e.
virtual bool open(OpenMode mode)
Opens the device and sets its OpenMode to mode.
QVariant property(const char *name) const
Returns the value of the object's name property.
Returns the current default CA certificate database.
This database is originally set to your system's default CA certificate database. If no system default database is found, an empty database will be returned. You can override the default CA certificate database with your own CA certificate database using
setDefaultCaCertificates()
.
Each SSL socket's CA certificate database is initialized to the default CA certificate database.
-
Note
-
On Unix, this method may return an empty list if the root certificates are loaded on demand.
-
See also
-
caCertificates()
Definition at line
1448
of file
qsslsocket.cpp
.
static QList< QSslCertificate > defaultCaCertificates()
Returns the default cryptographic cipher suite for all sockets in this application.
This list is used during the socket's handshake phase when negotiating with the peer to choose a session cipher. The list is ordered by preference (i.e., the first cipher in the list is the most preferred cipher).
By default, the handshake phase can choose any of the ciphers supported by this system's SSL libraries, which may vary from system to system. The list of ciphers supported by this system's SSL libraries is returned by
supportedCiphers()
.
-
See also
-
supportedCiphers()
Definition at line
1263
of file
qsslsocket.cpp
.
static QList< QSslCipher > defaultCiphers()
-
Warning
-
This function is not part of the public interface.
Definition at line
1826
of file
qsslsocket.cpp
.
1829
#ifdef QSSLSOCKET_DEBUG
1830
qDebug
() <<
"QSslSocket::disconnectFromHostImplementation()"
;
1832
if
(!
d
->plainSocket)
1837
d
->plainSocket->disconnectFromHost();
1841
d
->pendingClose =
true
;
1851
if
(!
d
->writeBuffer.isEmpty())
1855
d
->plainSocket->disconnectFromHost();
1857
d
->disconnectFromHost();
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Q_CORE_EXPORT void qDebug(const char *,...)
void stateChanged(QAbstractSocket::SocketState)
This signal is emitted whenever QAbstractSocket's state changes.
This signal is emitted when
QSslSocket
enters encrypted mode.
After this signal has been emitted,
QSslSocket::isEncrypted()
will return true, and all further transmissions on the socket will be encrypted.
-
See also
-
QSslSocket::connectToHostEncrypted()
,
QSslSocket::isEncrypted()
Returns the number of encrypted bytes that are awaiting decryption.
-
Since
-
4.4
Normally, this function will return 0 because
QSslSocket
decrypts its incoming data as soon as it can.
Definition at line
766
of file
qsslsocket.cpp
.
Referenced by
QHttpNetworkConnectionChannel::_q_error()
.
771
return
d
->plainSocket->bytesAvailable();
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Returns the number of encrypted bytes that are waiting to be written to the network.
-
Since
-
4.4
Definition at line
783
of file
qsslsocket.cpp
.
Referenced by
QHttpPrivate::postMoreData()
, and
QHttpNetworkConnectionChannel::sendRequest()
.
788
return
d
->plainSocket->bytesToWrite();
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
This signal is emitted when
QSslSocket
writes its encrypted data to the network.
-
Since
-
4.4
The
written
parameter contains the number of bytes that were successfully written.
-
See also
-
QIODevice::bytesWritten()
This function writes as much as possible from the internal write buffer to the underlying network socket, without blocking.
If any data was written, this function returns true; otherwise false is returned.
Call this function if you need
QSslSocket
to start sending buffered data immediately. The number of bytes successfully written depends on the operating system. In most cases, you do not need to call this function, because
QAbstractSocket
will start sending data automatically once control goes back to the event loop. In the absence of an event loop, call
waitForBytesWritten()
instead.
-
See also
-
write()
,
waitForBytesWritten()
Definition at line
856
of file
qsslsocket.cpp
.
Referenced by
QHttpNetworkConnectionChannel::_q_error()
.
859
#ifdef QSSLSOCKET_DEBUG
860
qDebug
() <<
"QSslSocket::flush()"
;
866
return
d
->plainSocket ?
d
->plainSocket->flush() :
false
;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Q_CORE_EXPORT void qDebug(const char *,...)
This method tells
QSslSocket
to ignore only the errors given in
errors
.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
-
Since
-
4.6
Note that you can set the expected certificate in the SSL error: If, for instance, you want to connect to a server that uses a self-signed certificate, consider the following snippet:
Multiple calls to this function will replace the list of errors that were passed in previous calls. You can clear the list of errors you want to ignore by calling this function with an empty list.
-
See also
-
sslErrors()
Definition at line
1786
of file
qsslsocket.cpp
.
Referenced by
QHttpNetworkConnectionChannel::ensureConnection()
, and
QHttp::ignoreSslErrors()
.
1789
d
->ignoreErrorsList = errors;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
This slot tells
QSslSocket
to ignore errors during
QSslSocket
's handshake phase and continue connecting.
If you want to continue with the connection even if errors occur during the handshake phase, then you must call this slot, either from a slot connected to
sslErrors()
, or before the handshake phase. If you don't call this slot, either in response to errors or before the handshake, the connection will be dropped after the
sslErrors()
signal has been emitted.
If there are no errors during the SSL handshake phase (i.e., the identity of the peer is established with no problems),
QSslSocket
will not emit the
sslErrors()
signal, and it is unnecessary to call this function.
-
Warning
-
Be sure to always let the user inspect the errors reported by the
sslErrors()
signal, and only call this method upon confirmation from the user that proceeding is ok. If there are unexpected errors, the connection should be aborted. Calling this method without inspecting the actual errors will most likely pose a security risk for your application. Use it with great care!
-
See also
-
sslErrors()
Definition at line
1757
of file
qsslsocket.cpp
.
1760
d
->ignoreAllSslErrors =
true
;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Returns true if the socket is encrypted; otherwise, false is returned.
An encrypted socket encrypts all data that is written by calling
write()
or
putChar()
before the data is written to the network, and decrypts all incoming data as the data is received from the network, before you call
read()
,
readLine()
or
getChar()
.
QSslSocket
emits
encrypted()
when it enters encrypted mode.
You can call
sessionCipher()
to find which cryptographic cipher is used to encrypt and decrypt your data.
-
See also
-
mode()
Definition at line
563
of file
qsslsocket.cpp
.
Referenced by
QHttpPrivate::_q_slotSendRequest()
.
566
return
d
->connectionEncrypted;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Returns the socket's local
QSslCertificate
{certificate}, or an empty certificate if no local certificate has been assigned.
-
See also
-
setLocalCertificate()
,
privateKey()
Definition at line
1008
of file
qsslsocket.cpp
.
1011
return
d
->configuration.localCertificate;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Returns the current mode for the socket; either UnencryptedMode, where
QSslSocket
behaves identially to
QTcpSocket
, or one of SslClientMode or SslServerMode, where the client is either negotiating or in encrypted mode.
When the mode changes,
QSslSocket
emits
modeChanged()
-
See also
-
SslMode
Definition at line
542
of file
qsslsocket.cpp
.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
This signal is emitted when
QSslSocket
changes from
QSslSocket::UnencryptedMode
to either
QSslSocket::SslClientMode
or
QSslSocket::SslServerMode
.
mode
is the new mode.
-
See also
-
QSslSocket::mode()
Returns the peer's digital certificate (i.e., the immediate certificate of the host you are connected to), or a null certificate, if the peer has not assigned a certificate.
The peer certificate is checked automatically during the handshake phase, so this function is normally used to fetch the certificate for display or for connection diagnostic purposes. It contains information about the peer, including its host name, the certificate issuer, and the peer's public key.
Because the peer certificate is set during the handshake phase, it is safe to access the peer certificate from a slot connected to the
sslErrors()
signal or the
encrypted()
signal.
If a null certificate is returned, it can mean the SSL handshake failed, or it can mean the host you are connected to doesn't have a certificate, or it can mean there is no connection.
If you want to check the peer's complete chain of certificates, use
peerCertificateChain()
to get them all at once.
-
See also
-
peerCertificateChain()
Definition at line
1039
of file
qsslsocket.cpp
.
1042
return
d
->configuration.peerCertificate;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Returns the peer's chain of digital certificates, or an empty list of certificates.
Peer certificates are checked automatically during the handshake phase. This function is normally used to fetch certificates for display, or for performing connection diagnostics. Certificates contain information about the peer and the certificate issuers, including host name, issuer names, and issuer public keys.
The peer certificates are set in
QSslSocket
during the handshake phase, so it is safe to call this function from a slot connected to the
sslErrors()
signal or the
encrypted()
signal.
If an empty list is returned, it can mean the SSL handshake failed, or it can mean the host you are connected to doesn't have a certificate, or it can mean there is no connection.
If you want to get only the peer's immediate certificate, use
peerCertificate()
.
-
See also
-
peerCertificate()
Definition at line
1068
of file
qsslsocket.cpp
.
1071
return
d
->configuration.peerCertificateChain;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Returns the maximum number of certificates in the peer's certificate chain to be checked during the SSL handshake phase, or 0 (the default) if no maximum depth has been set, indicating that the whole certificate chain should be checked.
-
Since
-
4.4
The certificates are checked in issuing order, starting with the peer's own certificate, then its issuer's certificate, and so on.
-
See also
-
setPeerVerifyDepth()
,
peerVerifyMode()
Definition at line
656
of file
qsslsocket.cpp
.
659
return
d
->configuration.peerVerifyDepth;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
QSslSocket
can emit this signal several times during the SSL handshake, before encryption has been established, to indicate that an error has occurred while establishing the identity of the peer.
-
Since
-
4.4
The
error
is usually an indication that
QSslSocket
is unable to securely identify the peer.
This signal provides you with an early indication when something's wrong. By connecting to this signal, you can manually choose to tear down the connection from inside the connected slot before the handshake has completed. If no action is taken,
QSslSocket
will proceed to emitting
QSslSocket::sslErrors()
.
-
See also
-
sslErrors()
Returns the socket's verify mode.
-
Since
-
4.4
This mode mode decides whether
QSslSocket
should request a certificate from the peer (i.e., the client requests a certificate from the server, or a server requesting a certificate from the client), and whether it should require that this certificate is valid.
The default mode is AutoVerifyPeer, which tells
QSslSocket
to use VerifyPeer for clients and QueryPeer for servers.
-
See also
-
setPeerVerifyMode()
,
peerVerifyDepth()
,
mode()
Definition at line
608
of file
qsslsocket.cpp
.
611
return
d
->configuration.peerVerifyMode;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Returns the different hostname for the certificate validation, as set by setPeerVerifyName or by connectToHostEncrypted.
-
Since
-
4.8
-
See also
-
setPeerVerifyName()
,
connectToHostEncrypted()
Definition at line
699
of file
qsslsocket.cpp
.
702
return
d
->verificationPeerName;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
-
See also
-
setPrivateKey()
,
localCertificate()
Definition at line
1152
of file
qsslsocket.cpp
.
1155
return
d
->configuration.privateKey;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Returns the socket's SSL protocol.
By default,
QSsl::SecureProtocols
is used.
-
See also
-
setProtocol()
Definition at line
574
of file
qsslsocket.cpp
.
577
return
d
->configuration.protocol;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Definition at line
1864
of file
qsslsocket.cpp
.
1870
readBytes =
d
->plainSocket->read(
data
, maxlen);
1873
const
char
*readPtr =
d
->readBuffer.readPointer();
1874
int
bytesToRead = qMin<int>(maxlen - readBytes,
d
->readBuffer.nextDataBlockSize());
1875
::memcpy(
data
+ readBytes, readPtr, bytesToRead);
1876
readBytes += bytesToRead;
1877
d
->readBuffer.free(bytesToRead);
1878
}
while
(!
d
->readBuffer.isEmpty() && readBytes < maxlen);
1880
#ifdef QSSLSOCKET_DEBUG
1881
qDebug
() <<
"QSslSocket::readData("
<< (
void
*)
data
<<
','
<< maxlen <<
") =="
<< readBytes;
1885
if
(
d
->readBuffer.isEmpty() &&
d
->plainSocket->bytesAvailable())
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Q_CORE_EXPORT void qDebug(const char *,...)
static const char * data(const QByteArray &arr)
Returns the socket's cryptographic
QSslCipher
{cipher}, or a null cipher if the connection isn't encrypted.
The socket's cipher for the session is set during the handshake phase. The cipher is used to encrypt and decrypt data transmitted through the socket.
QSslSocket
also provides functions for setting the ordered list of ciphers from which the handshake phase will eventually select the session cipher. This ordered list must be in place before the handshake phase begins.
-
See also
-
ciphers()
,
setCiphers()
,
setDefaultCiphers()
,
defaultCiphers()
,
supportedCiphers()
Definition at line
1088
of file
qsslsocket.cpp
.
1091
return
d
->sessionCipher();
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Sets this socket's CA certificate database to be
certificates
.
The certificate database must be set prior to the SSL handshake. The CA certificate database is used by the socket during the handshake phase to validate the peer's certificate.
The CA certificate database can be reset to the current default CA certificate database by calling this function with the list of CA certificates returned by
defaultCaCertificates()
.
-
See also
-
defaultCaCertificates()
Definition at line
1349
of file
qsslsocket.cpp
.
1352
d
->configuration.caCertificates = certificates;
1353
d
->allowRootCertOnDemandLoading =
false
;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Sets the cryptographic cipher suite for this socket to
ciphers
, which must contain a subset of the ciphers in the list returned by
supportedCiphers()
.
Restricting the cipher suite must be done before the handshake phase, where the session cipher is chosen.
-
See also
-
ciphers()
,
setDefaultCiphers()
,
supportedCiphers()
Definition at line
1199
of file
qsslsocket.cpp
.
1202
d
->configuration.ciphers =
ciphers
;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
QList< QSslCipher > ciphers() const
Returns this socket's current cryptographic cipher suite.
Sets the cryptographic cipher suite for this socket to
ciphers
, which is a colon-separated list of cipher suite names.
The ciphers are listed in order of preference, starting with the most preferred cipher. For example:
socket.
setCiphers
(
"DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:AES256-SHA"
);
Each cipher name in
ciphers
must be the name of a cipher in the list returned by
supportedCiphers()
. Restricting the cipher suite must be done before the handshake phase, where the session cipher is chosen.
-
See also
-
ciphers()
,
setDefaultCiphers()
,
supportedCiphers()
Definition at line
1219
of file
qsslsocket.cpp
.
1222
d
->configuration.ciphers.clear();
1224
for
(
int
i = 0; i < 3; ++i) {
1227
if
(!cipher.isNull())
1228
d
->configuration.ciphers << cipher;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
The QString class provides a Unicode character string.
The QSslCipher class represents an SSL cryptographic cipher.
SslProtocol
Describes the protocol of the cipher.
The QLatin1String class provides a thin wrapper around an US-ASCII/Latin-1 encoded string literal...
QStringList split(const QString &sep, SplitBehavior behavior=KeepEmptyParts, Qt::CaseSensitivity cs=Qt::CaseSensitive) const Q_REQUIRED_RESULT
Splits the string into substrings wherever sep occurs, and returns the list of those strings...
Sets the default CA certificate database to
certificates
.
The default CA certificate database is originally set to your system's default CA certificate database. You can override the default CA certificate database with your own CA certificate database using this function.
Each SSL socket's CA certificate database is initialized to the default CA certificate database.
-
See also
-
addDefaultCaCertificate()
Definition at line
1428
of file
qsslsocket.cpp
.
static void setDefaultCaCertificates(const QList< QSslCertificate > &certs)
Sets the default cryptographic cipher suite for all sockets in this application to
ciphers
, which must contain a subset of the ciphers in the list returned by
supportedCiphers()
.
Restricting the default cipher suite only affects SSL sockets that perform their handshake phase after the default cipher suite has been changed.
-
See also
-
setCiphers()
,
defaultCiphers()
,
supportedCiphers()
Definition at line
1244
of file
qsslsocket.cpp
.
static void setDefaultCiphers(const QList< QSslCipher > &ciphers)
Sets the socket's local certificate to
certificate
.
The local certificate is necessary if you need to confirm your identity to the peer. It is used together with the private key; if you set the local certificate, you must also set the private key.
The local certificate and private key are always necessary for server sockets, but are also rarely used by client sockets if the server requires the client to authenticate.
-
See also
-
localCertificate()
,
setPrivateKey()
Definition at line
977
of file
qsslsocket.cpp
.
980
d
->configuration.localCertificate = certificate;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Sets the socket's local
QSslCertificate
{certificate} to the first one found in file
path
, which is parsed according to the specified
format
.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line
993
of file
qsslsocket.cpp
.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
The QFile class provides an interface for reading from and writing to files.
The QSslCertificate class provides a convenient API for an X509 certificate.
Sets the maximum number of certificates in the peer's certificate chain to be checked during the SSL handshake phase, to
depth
.
-
Since
-
4.4
Setting a depth of 0 means that no maximum depth is set, indicating that the whole certificate chain should be checked.
The certificates are checked in issuing order, starting with the peer's own certificate, then its issuer's certificate, and so on.
-
See also
-
peerVerifyDepth()
,
setPeerVerifyMode()
Definition at line
678
of file
qsslsocket.cpp
.
682
qWarning
(
"QSslSocket::setPeerVerifyDepth: cannot set negative depth of %d"
, depth);
685
d
->configuration.peerVerifyDepth = depth;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Q_CORE_EXPORT void qWarning(const char *,...)
Sets the socket's verify mode to
mode
.
-
Since
-
4.4
This mode decides whether
QSslSocket
should request a certificate from the peer (i.e., the client requests a certificate from the server, or a server requesting a certificate from the client), and whether it should require that this certificate is valid.
The default mode is AutoVerifyPeer, which tells
QSslSocket
to use VerifyPeer for clients and QueryPeer for servers.
Setting this mode after encryption has started has no effect on the current connection.
-
See also
-
peerVerifyMode()
,
setPeerVerifyDepth()
,
mode()
Definition at line
634
of file
qsslsocket.cpp
.
637
d
->configuration.peerVerifyMode =
mode
;
SslMode mode() const
Returns the current mode for the socket; either UnencryptedMode, where QSslSocket behaves identially ...
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Sets a different host name, given by
hostName
, for the certificate validation instead of the one used for the TCP connection.
-
Since
-
4.8
-
See also
-
connectToHostEncrypted()
Definition at line
716
of file
qsslsocket.cpp
.
719
d
->verificationPeerName = hostName;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Sets the socket's private
QSslKey
{key} to
key
.
The private key and the local
QSslCertificate
{certificate} are used by clients and servers that must prove their identity to SSL peers.
Both the key and the local certificate are required if you are creating an SSL server socket. If you are creating an SSL client socket, the key and local certificate are required if your client must identify itself to an SSL server.
-
See also
-
privateKey()
,
setLocalCertificate()
Definition at line
1107
of file
qsslsocket.cpp
.
1110
d
->configuration.privateKey =
key
;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Reads the string in file
fileName
and decodes it using a specified
algorithm
and encoding
format
to construct an
QSslKey
{SSL key}.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
If the encoded key is encrypted,
passPhrase
is used to decrypt it.
The socket's private key is set to the constructed key. The private key and the local
QSslCertificate
{certificate} are used by clients and servers that must prove their identity to SSL peers.
Both the key and the local certificate are required if you are creating an SSL server socket. If you are creating an SSL client socket, the key and local certificate are required if your client must identify itself to an SSL server.
-
See also
-
privateKey()
,
setLocalCertificate()
Definition at line
1136
of file
qsslsocket.cpp
.
1140
QFile
file(fileName);
1142
d
->configuration.privateKey =
QSslKey
(file.readAll(), algorithm,
The QSslKey class provides an interface for private and public keys.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
The QFile class provides an interface for reading from and writing to files.
Sets the socket's SSL protocol to
protocol
.
This will affect the next initiated handshake; calling this function on an already-encrypted socket will not affect the socket's protocol.
Definition at line
585
of file
qsslsocket.cpp
.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
QSsl::SslProtocol protocol() const
Returns the socket's SSL protocol.
Definition at line
877
of file
qsslsocket.cpp
.
880
d
->readBufferMaxSize =
size
;
882
if
(
d
->plainSocket)
883
d
->plainSocket->setReadBufferSize(
size
);
virtual qint64 size() const
For open random-access devices, this function returns the size of the device.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Initializes
QSslSocket
with the native socket descriptor
socketDescriptor
.
Returns true if
socketDescriptor
is accepted as a valid socket descriptor; otherwise returns false. The socket is opened in the mode specified by
openMode
, and enters the socket state specified by
state
.
Note:
It is not possible to initialize two sockets with the same native socket descriptor.
-
See also
-
socketDescriptor()
Definition at line
476
of file
qsslsocket.cpp
.
479
#ifdef QSSLSOCKET_DEBUG
483
if
(!
d
->plainSocket)
484
d
->createPlainSocket(openMode);
486
d
->cachedSocketDescriptor =
d
->plainSocket->socketDescriptor();
int socketDescriptor() const
Returns the native socket descriptor of the QAbstractSocket object if this is available; otherwise re...
void setSocketError(SocketError socketError)
Sets the type of error that last occurred to socketError.
void setOpenMode(OpenMode openMode)
Sets the OpenMode of the device to openMode.
void setPeerName(const QString &name)
Sets the host name of the remote peer to name.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
void setSocketState(SocketState state)
Sets the state of the socket to state.
Q_CORE_EXPORT void qDebug(const char *,...)
void setLocalAddress(const QHostAddress &address)
Sets the address on the local side of a connection to address.
OpenMode openMode() const
Returns the mode in which the device has been opened; i.e.
void setLocalPort(quint16 port)
Sets the port on the local side of a connection to port.
void setPeerAddress(const QHostAddress &address)
Sets the address of the remote side of the connection to address.
void setPeerPort(quint16 port)
Sets the port of the remote side of the connection to port.
SocketState state() const
Returns the state of the socket.
Definition at line
507
of file
qsslsocket.cpp
.
510
if
(
d
->plainSocket)
511
d
->plainSocket->setSocketOption(option, value);
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Sets the socket's SSL configuration to be the contents of
configuration
.
-
Since
-
4.4
This function sets the local certificate, the ciphers, the private key and the CA certificates to those stored in
configuration
.
It is not possible to set the SSL-state related fields.
-
See also
-
setLocalCertificate()
,
setPrivateKey()
,
setCaCertificates()
,
setCiphers()
Definition at line
946
of file
qsslsocket.cpp
.
950
d
->configuration.privateKey = configuration.
privateKey
();
951
d
->configuration.ciphers = configuration.
ciphers
();
955
d
->configuration.protocol = configuration.
protocol
();
956
d
->configuration.sslOptions = configuration.
d
->
sslOptions
;
962
d
->allowRootCertOnDemandLoading =
false
;
QSharedDataPointer< QSslConfigurationPrivate > d
QList< QSslCipher > ciphers() const
Returns this connection's current cryptographic cipher suite.
QSsl::SslOptions sslOptions
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
QSsl::SslProtocol protocol() const
Returns the protocol setting for this SSL configuration.
QSslKey privateKey() const
Returns the QSslKey {SSL key} assigned to this connection or a null key if none has been assigned yet...
bool allowRootCertOnDemandLoading
int peerVerifyDepth() const
Returns the maximum number of certificates in the peer's certificate chain to be checked during the S...
QSslCertificate localCertificate() const
Returns the certificate to be presented to the peer during the SSL handshake process.
QSslSocket::PeerVerifyMode peerVerifyMode() const
Returns the verify mode.
QList< QSslCertificate > caCertificates() const
Returns this connection's CA certificate database.
Definition at line
523
of file
qsslsocket.cpp
.
526
if
(
d
->plainSocket)
527
return
d
->plainSocket->socketOption(option);
The QVariant class acts like a union for the most common Qt data types.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Returns the socket's SSL configuration state.
-
Since
-
4.4
The default SSL configuration of a socket is to use the default ciphers, default CA certificates, no local private key or certificate.
The SSL configuration also contains fields that can change with time without notice.
-
See also
-
localCertificate()
,
peerCertificate()
,
peerCertificateChain()
,
sessionCipher()
,
privateKey()
,
ciphers()
,
caCertificates()
Definition at line
920
of file
qsslsocket.cpp
.
Referenced by
QHttpNetworkReply::sslConfiguration()
.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
The QSslConfiguration class holds the configuration and state of an SSL connection.
Returns a list of the last SSL errors that occurred.
This is the same list as
QSslSocket
passes via the
sslErrors()
signal. If the connection has been encrypted with no errors, this function will return an empty list.
-
See also
-
connectToHostEncrypted()
Definition at line
1653
of file
qsslsocket.cpp
.
1656
return
d
->sslErrors;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
QSslSocket
emits this signal after the SSL handshake to indicate that one or more errors have occurred while establishing the identity of the peer.
The errors are usually an indication that
QSslSocket
is unable to securely identify the peer. Unless any action is taken, the connection will be dropped after this signal has been emitted.
If you want to continue connecting despite the errors that have occurred, you must call
QSslSocket::ignoreSslErrors()
from inside a slot connected to this signal. If you need to access the error list at a later point, you can call
sslErrors()
(without arguments).
errors
contains one or more errors that prevent
QSslSocket
from verifying the identity of the peer.
Note: You cannot use
Qt::QueuedConnection
when connecting to this signal, or calling
QSslSocket::ignoreSslErrors()
will have no effect.
-
See also
-
peerVerifyError()
Starts a delayed SSL handshake for a client connection.
This function can be called when the socket is in the
ConnectedState
but still in the
UnencryptedMode
. If it is not yet connected, or if it is already encrypted, this function has no effect.
Clients that implement STARTTLS functionality often make use of delayed SSL handshakes. Most other clients can avoid calling this function directly by using
connectToHostEncrypted()
instead, which automatically performs the handshake.
-
See also
-
connectToHostEncrypted()
,
startServerEncryption()
Definition at line
1682
of file
qsslsocket.cpp
.
1686
qWarning
(
"QSslSocket::startClientEncryption: cannot start handshake on non-plain connection"
);
1689
#ifdef QSSLSOCKET_DEBUG
1690
qDebug
() <<
"QSslSocket::startClientEncryption()"
;
1694
d
->startClientEncryption();
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Q_CORE_EXPORT void qDebug(const char *,...)
Q_CORE_EXPORT void qWarning(const char *,...)
void modeChanged(QSslSocket::SslMode newMode)
This signal is emitted when QSslSocket changes from QSslSocket::UnencryptedMode to either QSslSocket:...
Starts a delayed SSL handshake for a server connection.
This function can be called when the socket is in the
ConnectedState
but still in
UnencryptedMode
. If it is not connected or it is already encrypted, the function has no effect.
For server sockets, calling this function is the only way to initiate the SSL handshake. Most servers will call this function immediately upon receiving a connection, or as a result of having received a protocol-specific command to enter SSL mode (e.g, the server may respond to receiving the string "STARTTLS\r\n" by calling this function).
The most common way to implement an SSL server is to create a subclass of
QTcpServer
and reimplement
QTcpServer::incomingConnection()
. The returned socket descriptor is then passed to
QSslSocket::setSocketDescriptor()
.
-
See also
-
connectToHostEncrypted()
,
startClientEncryption()
Definition at line
1717
of file
qsslsocket.cpp
.
1721
qWarning
(
"QSslSocket::startServerEncryption: cannot start handshake on non-plain connection"
);
1724
#ifdef QSSLSOCKET_DEBUG
1725
qDebug
() <<
"QSslSocket::startServerEncryption()"
;
1729
d
->startServerEncryption();
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Q_CORE_EXPORT void qDebug(const char *,...)
Q_CORE_EXPORT void qWarning(const char *,...)
void modeChanged(QSslSocket::SslMode newMode)
This signal is emitted when QSslSocket changes from QSslSocket::UnencryptedMode to either QSslSocket:...
Returns the list of cryptographic ciphers supported by this system.
This list is set by the system's SSL libraries and may vary from system to system.
-
See also
-
defaultCiphers()
,
ciphers()
,
setCiphers()
Definition at line
1275
of file
qsslsocket.cpp
.
Referenced by
QSslCipher::QSslCipher()
.
static QList< QSslCipher > supportedCiphers()
Returns true if this platform supports SSL; otherwise, returns false.
If the platform doesn't support SSL, the socket will fail in the connection phase.
Definition at line
1664
of file
qsslsocket.cpp
.
Referenced by
QSslKeyPrivate::clear()
,
QSslKeyPrivate::decodePem()
,
QSslCertificatePrivate::QSslCertificate_from_X509()
,
QHttpPrivate::setSock()
, and
QSslKey::toPem()
.
static bool supportsSsl()
Does the minimum amount of initialization to determine whether SSL is supported or not...
This function provides the CA certificate database provided by the operating system.
The CA certificate database returned by this function is used to initialize the database returned by
defaultCaCertificates()
. You can replace that database with your own with
setDefaultCaCertificates()
.
-
See also
-
caCertificates()
,
defaultCaCertificates()
,
setDefaultCaCertificates()
Definition at line
1462
of file
qsslsocket.cpp
.
static QList< QSslCertificate > systemCaCertificates()
Definition at line
1582
of file
qsslsocket.cpp
.
1585
if
(!
d
->plainSocket)
1588
return
d
->plainSocket->waitForBytesWritten(msecs);
1591
stopWatch.
start
();
1593
if
(!
d
->connectionEncrypted) {
1598
if
(!
d
->writeBuffer.isEmpty()) {
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
The QElapsedTimer class provides a fast way to calculate elapsed times.
qint64 elapsed() const
Returns the number of milliseconds since this QElapsedTimer was last started.
static int qt_timeout_value(int msecs, int elapsed)
bool waitForEncrypted(int msecs=30000)
Waits until the socket has completed the SSL handshake and has emitted encrypted(), or msecs milliseconds, whichever comes first.
void start()
Starts this timer.
Waits until the socket is connected, or
msecs
milliseconds, whichever happens first.
If the connection has been established, this function returns true; otherwise it returns false.
-
See also
-
QAbstractSocket::waitForConnected()
Definition at line
1475
of file
qsslsocket.cpp
.
1478
if
(!
d
->plainSocket)
1480
bool
retVal =
d
->plainSocket->waitForConnected(msecs);
void setSocketError(SocketError socketError)
Sets the type of error that last occurred to socketError.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
void setSocketState(SocketState state)
Sets the state of the socket to state.
void setErrorString(const QString &errorString)
Sets the human readable description of the last device error that occurred to str.
Waits until the socket has disconnected or
msecs
milliseconds, whichever comes first.
If the connection has been disconnected, this function returns true; otherwise it returns false.
-
See also
-
QAbstractSocket::waitForDisconnected()
Definition at line
1613
of file
qsslsocket.cpp
.
1619
qWarning
(
"QSslSocket::waitForDisconnected() is not allowed in UnconnectedState"
);
1623
if
(!
d
->plainSocket)
1626
return
d
->plainSocket->waitForDisconnected(msecs);
1629
stopWatch.
start
();
1631
if
(!
d
->connectionEncrypted) {
void setSocketError(SocketError socketError)
Sets the type of error that last occurred to socketError.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
void setSocketState(SocketState state)
Sets the state of the socket to state.
The QElapsedTimer class provides a fast way to calculate elapsed times.
qint64 elapsed() const
Returns the number of milliseconds since this QElapsedTimer was last started.
Q_CORE_EXPORT void qWarning(const char *,...)
static int qt_timeout_value(int msecs, int elapsed)
void setErrorString(const QString &errorString)
Sets the human readable description of the last device error that occurred to str.
bool waitForEncrypted(int msecs=30000)
Waits until the socket has completed the SSL handshake and has emitted encrypted(), or msecs milliseconds, whichever comes first.
void start()
Starts this timer.
SocketState state() const
Returns the state of the socket.
Waits until the socket has completed the SSL handshake and has emitted
encrypted()
, or
msecs
milliseconds, whichever comes first.
If
encrypted()
has been emitted, this function returns true; otherwise (e.g., the socket is disconnected, or the SSL handshake fails), false is returned.
The following example waits up to one second for the socket to be encrypted:
socket->connectToHostEncrypted(
"imap"
, 993);
if
(socket->waitForEncrypted(1000))
If msecs is -1, this function will not time out.
-
See also
-
startClientEncryption()
,
startServerEncryption()
,
encrypted()
,
isEncrypted()
Definition at line
1505
of file
qsslsocket.cpp
.
1508
if
(!
d
->plainSocket ||
d
->connectionEncrypted)
1514
stopWatch.
start
();
1518
if
(!
d
->plainSocket->waitForConnected(msecs))
1522
while
(!
d
->connectionEncrypted) {
1531
return
d
->connectionEncrypted;
void startClientEncryption()
Starts a delayed SSL handshake for a client connection.
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
The QElapsedTimer class provides a fast way to calculate elapsed times.
qint64 elapsed() const
Returns the number of milliseconds since this QElapsedTimer was last started.
static int qt_timeout_value(int msecs, int elapsed)
void start()
Starts this timer.
Definition at line
1537
of file
qsslsocket.cpp
.
1540
if
(!
d
->plainSocket)
1543
return
d
->plainSocket->waitForReadyRead(msecs);
1549
bool
readyReadEmitted =
false
;
1550
bool
*previousReadyReadEmittedPointer =
d
->readyReadEmittedPointer;
1551
d
->readyReadEmittedPointer = &readyReadEmitted;
1554
stopWatch.
start
();
1556
if
(!
d
->connectionEncrypted) {
1559
d
->readyReadEmittedPointer = previousReadyReadEmittedPointer;
1564
if
(!
d
->writeBuffer.isEmpty()) {
1571
while
(!readyReadEmitted &&
1575
d
->readyReadEmittedPointer = previousReadyReadEmittedPointer;
1576
return
readyReadEmitted;
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
The QElapsedTimer class provides a fast way to calculate elapsed times.
qint64 elapsed() const
Returns the number of milliseconds since this QElapsedTimer was last started.
static int qt_timeout_value(int msecs, int elapsed)
bool waitForEncrypted(int msecs=30000)
Waits until the socket has completed the SSL handshake and has emitted encrypted(), or msecs milliseconds, whichever comes first.
void start()
Starts this timer.
Definition at line
1894
of file
qsslsocket.cpp
.
1897
#ifdef QSSLSOCKET_DEBUG
1898
qDebug
() <<
"QSslSocket::writeData("
<< (
void
*)
data
<<
','
<< len <<
')'
;
1901
return
d
->plainSocket->write(
data
, len);
1903
char
*writePtr =
d
->writeBuffer.reserve(len);
1904
::memcpy(writePtr,
data
, len);
The QSslSocket class provides an SSL encrypted socket for both clients and servers.
Q_CORE_EXPORT void qDebug(const char *,...)
static const char * data(const QByteArray &arr)
◆
QSslSocketBackendPrivate
The documentation for this class was generated from the following files: