Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
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 Holds the list of SslOption values, that are activated by configuration.
23
24 \sa QSsl::SslOption
25*/
26
27/*!
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.
31
32 \sa QSslConfiguration::ciphers
33*/
34
35/*!
36 \qmlproperty enumeration sslConfiguration::protocol
37 Holds SslProtocol enumeration value.
38 \sa QSsl::SslProtocol
39 */
40
41/*!
42 \qmlproperty enumeration sslConfiguration::peerVerifyMode
43 Holds PeerVerifyMode enumeration value.
44
45 \sa QSslSocket::PeerVerifyMode
46 */
47
48/*!
49 \qmlproperty int sslConfiguration::peerVerifyDepth
50
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
54 should be checked.
55
56 \sa QSslConfiguration::peerVerifyDepth
57 */
58
59/*!
60 \qmlproperty bytearray sslConfiguration::sessionTicket
61
62 Holds the session ticket used in the SSL handshake in ASN.1
63 format, suitable to e.g. be persisted to disk.
64
65 \sa QSslConfiguration::sessionTicket
66 */
67
68/*!
69 \qmlmethod void sslConfiguration::setCertificateFiles(const QStringList &certificateFiles);
70
71 This function loads into configuration the list of certificates \a certificateFiles
72 provided by user.
73*/
74
75/*!
76 \qmlmethod void sslConfiguration::setPrivateKey(const QQmlSslKey &privateKey);
77
78 This function sets into configuration user defined Private key value \a privateKey.
79
80 \sa QSslKey, sslKey
81*/
82
83/*!
84 \qmltype sslDtlsConfiguration
85 \inqmlmodule QtNetwork
86
87 \brief The sslDtlsConfiguration class holds the Dtls
88 default configuration and state of an SSL connection.
89
90 \sa QSslConfiguration
91*/
92
93/*!
94 \qmlproperty QList sslDtlsConfiguration::sslOptions
95 Holds the list of SslOption values, that are activated by configuration.
96
97 \sa QSsl::SslOption
98*/
99
100/*!
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.
104
105 \sa QSslConfiguration::ciphers
106*/
107
108/*!
109 \qmlproperty enumeration sslDtlsConfiguration::protocol
110 Holds SslProtocol enumeration value.
111 \sa QSsl::SslProtocol
112 */
113
114/*!
115 \qmlproperty enumeration sslDtlsConfiguration::peerVerifyMode
116 Holds PeerVerifyMode enumeration value.
117
118 \sa QSslSocket::PeerVerifyMode
119*/
120
121/*!
122 \qmlproperty int sslDtlsConfiguration::peerVerifyDepth
123
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
127 should be checked.
128
129 \sa QSslConfiguration::peerVerifyDepth
130*/
131
132/*!
133 \qmlproperty bytearray sslDtlsConfiguration::sessionTicket
134
135 Holds the session ticket used in the SSL handshake in ASN.1
136 format, suitable to e.g. be persisted to disk.
137
138 \sa QSslConfiguration::sessionTicket
139*/
140
141/*!
142 \qmlmethod void sslDtlsConfiguration::setCertificateFiles(const QStringList &certificateFiles);
143
144 This function loads into configuration the list of certificates \a certificateFiles
145 provided by user.
146*/
147
148/*!
149 \qmlmethod void sslDtlsConfiguration::setPrivateKey(const QQmlSslKey &privateKey);
150
151 This function sets into configuration user defined Private key value \a privateKey.
152
153 \sa QSslKey, sslKey
154*/
155
156/*!
157 \qmltype sslKey
158 \inqmlmodule QtNetwork
159
160 \instantiates QSslKey
161 \brief The sslKey class provides the interface for private and public keys.
162
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.
166
167 \sa QSslKey
168*/
169
170/*!
171 \qmlproperty string sslKey::keyFile
172 Holds the path to the \c *.pem key file.
173*/
174
175/*!
176 \qmlproperty enumeration sslKey::keyAlgorithm
177 Holds KeyAlgorithm enumeration value.
178
179 \sa QSsl::KeyAlgorithm
180*/
181
182/*!
183 \qmlproperty enumeration sslKey::keyFormat
184 Holds EncodingFormat enumeration value.
185 \sa QSsl::EncodingFormat
186*/
187
188/*!
189 \qmlproperty bytearray sslKey::keyPassPhrase
190
191 Holds the value to be used to decrypt QSslKey.
192
193 \sa QSslKey
194*/
195
196/*!
197 \qmlproperty enumeration sslKey::keyType
198 Holds KeyType enumeration value.
199 \sa QSsl::KeyType
200*/