Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qqmlssl.qdoc
Go to the documentation of this file.
1// Copyright (C) 2023 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
3
4/*!
5 \qmltype sslConfiguration
6 \inqmlmodule QtNetwork
7
8 \brief The sslConfiguration class holds the configuration and state of an
9 SSL connection.
10
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.
16
17 \sa QSslConfiguration
18*/
19
20/*!
21 \qmlproperty QList sslConfiguration::sslOptions
22 \deprecated [6.11] Use sslOptionFlags instead. This property will be removed
23 in Qt 7.
24
25 Holds the list of SslOption values, that are activated by configuration.
26
27//! [usage-warning]
28 \warning This property has known issues and its usage is discouraged.
29 Specifically, it does not allow to disable an SSL option once it was
30 enabled and can get out of sync with the underlying SSL configuration.
31 It is kept only for source and behavior compatibility. Use \l sslOptionFlags
32 property instead.
33//! [usage-warning]
34
35 \sa QSsl::SslOption, sslOptionFlags
36*/
37
38/*!
39 \qmlproperty QSsl::SslOptions sslConfiguration::sslOptionFlags
40 \since 6.11
41
42 Holds the bitwise OR of SslOption values that are enabled in the
43 configuration.
44
45 The default value is the same as set by
46 \l QSslConfiguration::defaultSslConfiguration().
47
48 \sa QSsl::SslOptions
49*/
50
51/*!
52 \qmlproperty string sslConfiguration::ciphers
53 Holds the cryptographic cipher suite for this configuration to \a ciphers,
54 which is a colon-separated list of cipher suite names.
55
56 \sa QSslConfiguration::ciphers
57*/
58
59/*!
60 \qmlproperty enumeration sslConfiguration::protocol
61 Holds SslProtocol enumeration value.
62 \sa QSsl::SslProtocol
63 */
64
65/*!
66 \qmlproperty enumeration sslConfiguration::peerVerifyMode
67 Holds PeerVerifyMode enumeration value.
68
69 \sa QSslSocket::PeerVerifyMode
70 */
71
72/*!
73 \qmlproperty int sslConfiguration::peerVerifyDepth
74
75 Holds the maximum number of certificates in the peer's certificate chain
76 to be checked during the SSL handshake phase, or 0 (the default) if no
77 maximum depth has been set, indicating that the whole certificate chain
78 should be checked.
79
80 \sa QSslConfiguration::peerVerifyDepth
81 */
82
83/*!
84 \qmlproperty bytearray sslConfiguration::sessionTicket
85
86 Holds the session ticket used in the SSL handshake in ASN.1
87 format, suitable to e.g. be persisted to disk.
88
89 \sa QSslConfiguration::sessionTicket
90 */
91
92/*!
93 \qmlmethod void sslConfiguration::setCertificateFiles(const QStringList &certificateFiles);
94
95 This function loads into configuration the list of certificates \a certificateFiles
96 provided by user.
97*/
98
99/*!
100 \qmlmethod void sslConfiguration::setPrivateKey(const QQmlSslKey &privateKey);
101
102 This function sets into configuration user defined Private key value \a privateKey.
103
104 \sa QSslKey, sslKey
105*/
106
107/*!
108 \qmltype sslDtlsConfiguration
109 \inqmlmodule QtNetwork
110
111 \brief The sslDtlsConfiguration class holds the Dtls
112 default configuration and state of an SSL connection.
113
114 \sa QSslConfiguration
115*/
116
117/*!
118 \qmlproperty QList sslDtlsConfiguration::sslOptions
119 \deprecated [6.11] Use sslOptionFlags instead. This property will be removed
120 in Qt 7.
121
122 Holds the list of SslOption values, that are activated by configuration.
123
124 \include qqmlssl.qdoc usage-warning
125
126 \sa QSsl::SslOption, sslOptionFlags
127*/
128
129/*!
130 \qmlproperty QSsl::SslOptions sslDtlsConfiguration::sslOptionFlags
131 \since 6.11
132
133 Holds the bitwise OR of SslOption values that are enabled in the
134 configuration.
135
136 The default value is the same as set by
137 \l QSslConfiguration::defaultDtlsConfiguration().
138
139 \sa QSsl::SslOptions
140*/
141
142/*!
143 \qmlproperty string sslDtlsConfiguration::ciphers
144 Holds the cryptographic cipher suite for this configuration to \a ciphers,
145 which is a colon-separated list of cipher suite names.
146
147 \sa QSslConfiguration::ciphers
148*/
149
150/*!
151 \qmlproperty enumeration sslDtlsConfiguration::protocol
152 Holds SslProtocol enumeration value.
153 \sa QSsl::SslProtocol
154 */
155
156/*!
157 \qmlproperty enumeration sslDtlsConfiguration::peerVerifyMode
158 Holds PeerVerifyMode enumeration value.
159
160 \sa QSslSocket::PeerVerifyMode
161*/
162
163/*!
164 \qmlproperty int sslDtlsConfiguration::peerVerifyDepth
165
166 Holds the maximum number of certificates in the peer's certificate chain
167 to be checked during the SSL handshake phase, or 0 (the default) if no
168 maximum depth has been set, indicating that the whole certificate chain
169 should be checked.
170
171 \sa QSslConfiguration::peerVerifyDepth
172*/
173
174/*!
175 \qmlproperty bytearray sslDtlsConfiguration::sessionTicket
176
177 Holds the session ticket used in the SSL handshake in ASN.1
178 format, suitable to e.g. be persisted to disk.
179
180 \sa QSslConfiguration::sessionTicket
181*/
182
183/*!
184 \qmlmethod void sslDtlsConfiguration::setCertificateFiles(const QStringList &certificateFiles);
185
186 This function loads into configuration the list of certificates \a certificateFiles
187 provided by user.
188*/
189
190/*!
191 \qmlmethod void sslDtlsConfiguration::setPrivateKey(const QQmlSslKey &privateKey);
192
193 This function sets into configuration user defined Private key value \a privateKey.
194
195 \sa QSslKey, sslKey
196*/
197
198/*!
199 \qmltype sslKey
200 \inqmlmodule QtNetwork
201
202 \nativetype QSslKey
203 \brief The sslKey class provides the interface for private and public keys.
204
205 The sslKey provides an API for managing keys.
206 The QML sslKey class is \c Q_GADGET based, it generates QSslKey object
207 based on it's QML properties.
208
209 \sa QSslKey
210*/
211
212/*!
213 \qmlproperty string sslKey::keyFile
214 Holds the path to the \c *.pem key file.
215*/
216
217/*!
218 \qmlproperty enumeration sslKey::keyAlgorithm
219 Holds KeyAlgorithm enumeration value.
220
221 \sa QSsl::KeyAlgorithm
222*/
223
224/*!
225 \qmlproperty enumeration sslKey::keyFormat
226 Holds EncodingFormat enumeration value.
227 \sa QSsl::EncodingFormat
228*/
229
230/*!
231 \qmlproperty bytearray sslKey::keyPassPhrase
232
233 Holds the value to be used to decrypt QSslKey.
234
235 \sa QSslKey
236*/
237
238/*!
239 \qmlproperty enumeration sslKey::keyType
240 Holds KeyType enumeration value.
241 \sa QSsl::KeyType
242*/