1// Copyright (C) 2023 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
5 \qmltype sslConfiguration
8 \brief The sslConfiguration class holds the configuration and state of an
11 sslConfiguration is used to relay information
12 about an open SSL connection and to allow the application to control
13 certain features of that connection.
14 The sslConfiguration encapsulates QSslConfiguration object inside.
15 The sslConfiguration calls defaultSslCongiguration in ctor.
21 \qmlproperty QList sslConfiguration::sslOptions
22 Holds the list of SslOption values, that are activated by configuration.
28 \qmlproperty string sslConfiguration::ciphers
29 Holds the cryptographic cipher suite for this configuration to \a ciphers,
30 which is a colon-separated list of cipher suite names.
32 \sa QSslConfiguration::ciphers
36 \qmlproperty enumeration sslConfiguration::protocol
37 Holds SslProtocol enumeration value.
42 \qmlproperty enumeration sslConfiguration::peerVerifyMode
43 Holds PeerVerifyMode enumeration value.
45 \sa QSslSocket::PeerVerifyMode
49 \qmlproperty int sslConfiguration::peerVerifyDepth
51 Holds the maximum number of certificates in the peer's certificate chain
52 to be checked during the SSL handshake phase, or 0 (the default) if no
53 maximum depth has been set, indicating that the whole certificate chain
56 \sa QSslConfiguration::peerVerifyDepth
60 \qmlproperty bytearray sslConfiguration::sessionTicket
62 Holds the session ticket used in the SSL handshake in ASN.1
63 format, suitable to e.g. be persisted to disk.
65 \sa QSslConfiguration::sessionTicket
69 \qmlmethod void sslConfiguration::setCertificateFiles(const QStringList &certificateFiles);
71 This function loads into configuration the list of certificates \a certificateFiles
76 \qmlmethod void sslConfiguration::setPrivateKey(const QQmlSslKey &privateKey);
78 This function sets into configuration user defined Private key value \a privateKey.
84 \qmltype sslDtlsConfiguration
85 \inqmlmodule QtNetwork
87 \brief The sslDtlsConfiguration class holds the Dtls
88 default configuration and state of an SSL connection.
94 \qmlproperty QList sslDtlsConfiguration::sslOptions
95 Holds the list of SslOption values, that are activated by configuration.
101 \qmlproperty string sslDtlsConfiguration::ciphers
102 Holds the cryptographic cipher suite for this configuration to \a ciphers,
103 which is a colon-separated list of cipher suite names.
105 \sa QSslConfiguration::ciphers
109 \qmlproperty enumeration sslDtlsConfiguration::protocol
110 Holds SslProtocol enumeration value.
111 \sa QSsl::SslProtocol
115 \qmlproperty enumeration sslDtlsConfiguration::peerVerifyMode
116 Holds PeerVerifyMode enumeration value.
118 \sa QSslSocket::PeerVerifyMode
122 \qmlproperty int sslDtlsConfiguration::peerVerifyDepth
124 Holds the maximum number of certificates in the peer's certificate chain
125 to be checked during the SSL handshake phase, or 0 (the default) if no
126 maximum depth has been set, indicating that the whole certificate chain
129 \sa QSslConfiguration::peerVerifyDepth
133 \qmlproperty bytearray sslDtlsConfiguration::sessionTicket
135 Holds the session ticket used in the SSL handshake in ASN.1
136 format, suitable to e.g. be persisted to disk.
138 \sa QSslConfiguration::sessionTicket
142 \qmlmethod void sslDtlsConfiguration::setCertificateFiles(const QStringList &certificateFiles);
144 This function loads into configuration the list of certificates \a certificateFiles
149 \qmlmethod void sslDtlsConfiguration::setPrivateKey(const QQmlSslKey &privateKey);
151 This function sets into configuration user defined Private key value \a privateKey.
158 \inqmlmodule QtNetwork
160 \instantiates QSslKey
161 \brief The sslKey class provides the interface for private and public keys.
163 The sslKey provides an API for managing keys.
164 The QML sslKey class is \c Q_GADGET based, it generates QSslKey object
165 based on it's QML properties.
171 \qmlproperty string sslKey::keyFile
172 Holds the path to the \c *.pem key file.
176 \qmlproperty enumeration sslKey::keyAlgorithm
177 Holds KeyAlgorithm enumeration value.
179 \sa QSsl::KeyAlgorithm
183 \qmlproperty enumeration sslKey::keyFormat
184 Holds EncodingFormat enumeration value.
185 \sa QSsl::EncodingFormat
189 \qmlproperty bytearray sslKey::keyPassPhrase
191 Holds the value to be used to decrypt QSslKey.
197 \qmlproperty enumeration sslKey::keyType
198 Holds KeyType enumeration value.