11#include "../shared/qasn1element_p.h"
13#include <QtNetwork/private/qsslcertificate_p.h>
14#include <QtNetwork/private/qsslcipher_p.h>
15#include <QtNetwork/private/qssl_p.h>
17#include <QtNetwork/qsslcertificate.h>
18#include <QtNetwork/qsslcertificateextension.h>
19#include <QtNetwork/qsslsocket.h>
21#include <QtCore/qscopeguard.h>
22#include <QtCore/qoperatingsystemversion.h>
23#include <QtCore/qregularexpression.h>
24#include <QtCore/qdatastream.h>
25#include <QtCore/qmutex.h>
31#if NTDDI_VERSION >= NTDDI_WINBLUE && defined(SECBUFFER_APPLICATION_PROTOCOLS)
33#define SUPPORTS_ALPN 1
37#ifndef SECBUFFER_ALERT
38#define SECBUFFER_ALERT 17
40#ifndef SECPKG_ATTR_APPLICATION_PROTOCOL
41#define SECPKG_ATTR_APPLICATION_PROTOCOL 35
45#ifndef SEC_E_APPLICATION_PROTOCOL_MISMATCH
46#define SEC_E_APPLICATION_PROTOCOL_MISMATCH _HRESULT_TYPEDEF_(0x80090367L
)
50#ifndef SP_PROT_TLS1_SERVER
51#define SP_PROT_TLS1_SERVER 0x00000040
53#ifndef SP_PROT_TLS1_CLIENT
54#define SP_PROT_TLS1_CLIENT 0x00000080
56#ifndef SP_PROT_TLS1_0_SERVER
59#ifndef SP_PROT_TLS1_0_CLIENT
65#ifndef SP_PROT_TLS1_1_SERVER
66#define SP_PROT_TLS1_1_SERVER 0x00000100
68#ifndef SP_PROT_TLS1_1_CLIENT
69#define SP_PROT_TLS1_1_CLIENT 0x00000200
74#ifndef SP_PROT_TLS1_2_SERVER
75#define SP_PROT_TLS1_2_SERVER 0x00000400
77#ifndef SP_PROT_TLS1_2_CLIENT
78#define SP_PROT_TLS1_2_CLIENT 0x00000800
83#ifndef SP_PROT_TLS1_3_SERVER
84#define SP_PROT_TLS1_3_SERVER 0x00001000
86#ifndef SP_PROT_TLS1_3_CLIENT
87#define SP_PROT_TLS1_3_CLIENT 0x00002000
92#ifndef BCRYPT_ECDH_ALGORITHM
93#define BCRYPT_ECDH_ALGORITHM L"ECDH"
95#ifndef BCRYPT_ECDSA_ALGORITHM
96#define BCRYPT_ECDSA_ALGORITHM L"ECDSA"
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
126using namespace Qt::StringLiterals;
132 const QString &passPhrase);
157QT_WARNING_DISABLE_DEPRECATED
159 {
"TLS_AES_256_GCM_SHA384",
"TLS_AES_256_GCM_SHA384",
"",
"",
"AES", 256,
"SHA384", {
QSsl::
TlsV1_3}},
160 {
"TLS_AES_128_GCM_SHA256",
"TLS_AES_128_GCM_SHA256",
"",
"",
"AES", 128,
"SHA256", {
QSsl::
TlsV1_3}},
161 {
"ECDHE-ECDSA-AES256-GCM-SHA384",
"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384",
"ECDH",
"ECDSA",
"AES", 256,
"SHA384", {
QSsl::
TlsV1_2}},
162 {
"ECDHE-ECDSA-AES128-GCM-SHA256",
"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256",
"ECDH",
"ECDSA",
"AES", 128,
"SHA256", {
QSsl::
TlsV1_2}},
163 {
"ECDHE-RSA-AES256-GCM-SHA384",
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
"ECDH",
"RSA",
"AES", 256,
"SHA384", {
QSsl::
TlsV1_2}},
164 {
"ECDHE-RSA-AES128-GCM-SHA256",
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"ECDH",
"RSA",
"AES", 128,
"SHA256", {
QSsl::
TlsV1_2}},
165 {
"DHE-RSA-AES256-GCM-SHA384",
"TLS_DHE_RSA_WITH_AES_256_GCM_SHA384",
"DH",
"RSA",
"AES", 256,
"SHA384", {
QSsl::
TlsV1_2}},
166 {
"DHE-RSA-AES128-GCM-SHA256",
"TLS_DHE_RSA_WITH_AES_128_GCM_SHA256",
"DH",
"RSA",
"AES", 128,
"SHA256", {
QSsl::
TlsV1_2}},
167 {
"ECDHE-ECDSA-AES256-SHA384",
"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384",
"ECDH",
"ECDSA",
"AES", 256,
"SHA384", {
QSsl::
TlsV1_2}},
168 {
"ECDHE-ECDSA-AES128-SHA256",
"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256",
"ECDH",
"ECDSA",
"AES", 128,
"SHA256", {
QSsl::
TlsV1_2}},
169 {
"ECDHE-RSA-AES256-SHA384",
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384",
"ECDH",
"RSA",
"AES", 256,
"SHA384", {
QSsl::
TlsV1_2}},
170 {
"ECDHE-RSA-AES128-SHA256",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
"ECDH",
"RSA",
"AES", 128,
"SHA256", {
QSsl::
TlsV1_2}},
171 {
"ECDHE-ECDSA-AES256-SHA",
"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA",
"ECDH",
"ECDSA",
"AES", 256,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
172 {
"ECDHE-ECDSA-AES128-SHA",
"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA",
"ECDH",
"ECDSA",
"AES", 128,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
173 {
"ECDHE-RSA-AES256-SHA",
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA",
"ECDH",
"RSA",
"AES", 256,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
174 {
"ECDHE-RSA-AES128-SHA",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA",
"ECDH",
"RSA",
"AES", 128,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
175 {
"AES256-GCM-SHA384",
"TLS_RSA_WITH_AES_256_GCM_SHA384",
"RSA",
"RSA",
"AES", 256,
"SHA384", {
QSsl::
TlsV1_2}},
176 {
"AES128-GCM-SHA256",
"TLS_RSA_WITH_AES_128_GCM_SHA256",
"RSA",
"RSA",
"AES", 128,
"SHA256", {
QSsl::
TlsV1_2}},
177 {
"AES256-SHA256",
"TLS_RSA_WITH_AES_256_CBC_SHA256",
"RSA",
"RSA",
"AES", 256,
"SHA256", {
QSsl::
TlsV1_2}},
178 {
"AES128-SHA256",
"TLS_RSA_WITH_AES_128_CBC_SHA256",
"RSA",
"RSA",
"AES", 128,
"SHA256", {
QSsl::
TlsV1_2}},
179 {
"AES256-SHA",
"TLS_RSA_WITH_AES_256_CBC_SHA",
"RSA",
"RSA",
"AES", 256,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
180 {
"AES128-SHA",
"TLS_RSA_WITH_AES_128_CBC_SHA",
"RSA",
"RSA",
"AES", 128,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
181 {
"DES-CBC3-SHA",
"TLS_RSA_WITH_3DES_EDE_CBC_SHA",
"RSA",
"RSA",
"3DES", 168,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
182 {
"NULL-SHA256",
"TLS_RSA_WITH_NULL_SHA256",
"RSA",
"RSA",
"", 0,
"SHA256", {
QSsl::
TlsV1_2}},
183 {
"NULL-SHA",
"TLS_RSA_WITH_NULL_SHA",
"RSA",
"RSA",
"", 0,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
186 {
"TLS_CHACHA20_POLY1305_SHA256",
"TLS_CHACHA20_POLY1305_SHA256",
"",
"",
"CHACHA20_POLY1305", 0,
"", {
QSsl::
TlsV1_3}},
187 {
"DHE-RSA-AES256-SHA",
"TLS_DHE_RSA_WITH_AES_256_CBC_SHA",
"DH",
"RSA",
"AES", 256,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
188 {
"DHE-RSA-AES128-SHA",
"TLS_DHE_RSA_WITH_AES_128_CBC_SHA",
"DH",
"RSA",
"AES", 128,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
189 {
"DHE-DSS-AES256-SHA256",
"TLS_DHE_DSS_WITH_AES_256_CBC_SHA256",
"DH",
"DSA",
"AES", 256,
"SHA256", {
QSsl::
TlsV1_2}},
190 {
"DHE-DSS-AES128-SHA256",
"TLS_DHE_DSS_WITH_AES_128_CBC_SHA256",
"DH",
"DSA",
"AES", 128,
"SHA256", {
QSsl::
TlsV1_2}},
191 {
"DHE-DSS-AES256-SHA",
"TLS_DHE_DSS_WITH_AES_256_CBC_SHA",
"DH",
"DSA",
"AES", 256,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
192 {
"DHE-DSS-AES128-SHA",
"TLS_DHE_DSS_WITH_AES_128_CBC_SHA",
"DH",
"DSA",
"AES", 128,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
193 {
"EDH-DSS-DES-CBC3-SHA",
"TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA",
"DH",
"DSA",
"3DES", 168,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
194 {
"RC4-SHA",
"TLS_RSA_WITH_RC4_128_SHA",
"RSA",
"RSA",
"RC4", 128,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
195 {
"RC4-MD5",
"TLS_RSA_WITH_RC4_128_MD5",
"RSA",
"RSA",
"RC4", 128,
"MD5", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
196 {
"DES-CBC-SHA",
"TLS_RSA_WITH_DES_CBC_SHA",
"RSA",
"RSA",
"DES", 56,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
197 {
"EDH-DSS-DES-CBC-SHA",
"TLS_DHE_DSS_WITH_DES_CBC_SHA",
"DH",
"DSA",
"DES", 56,
"SHA1", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
198 {
"NULL-MD5",
"TLS_RSA_WITH_NULL_MD5",
"RSA",
"RSA",
"", 0,
"MD5", {
QSsl::
TlsV1_2,
QSsl::
TlsV1_1,
QSsl::
TlsV1_0}},
201 {
"PSK-AES256-GCM-SHA384",
"TLS_PSK_WITH_AES_256_GCM_SHA384",
"PSK",
"",
"AES", 256,
"SHA384", {
QSsl::
TlsV1_2}},
202 {
"PSK-AES128-GCM-SHA256",
"TLS_PSK_WITH_AES_128_GCM_SHA256",
"PSK",
"",
"AES", 128,
"SHA256", {
QSsl::
TlsV1_2}},
203 {
"PSK-AES256-CBC-SHA384",
"TLS_PSK_WITH_AES_256_CBC_SHA384",
"PSK",
"",
"AES", 256,
"SHA384", {
QSsl::
TlsV1_2}},
204 {
"PSK-AES128-CBC-SHA256",
"TLS_PSK_WITH_AES_128_CBC_SHA256",
"PSK",
"",
"AES", 128,
"SHA256", {
QSsl::
TlsV1_2}},
205 {
"PSK-NULL-SHA384",
"TLS_PSK_WITH_NULL_SHA384",
"PSK",
"",
"", 0,
"SHA384", {
QSsl::
TlsV1_2}},
206 {
"PSK-NULL-SHA256",
"TLS_PSK_WITH_NULL_SHA256",
"PSK",
"",
"", 0,
"SHA256", {
QSsl::
TlsV1_2}},
233
234
235
238 static const QList<QSslCipher> defaultCipherList = defaultCiphers();
240 if (defaultCipherList == ciphers) {
245 QList<
const SchannelCipherInfo*> cipherInfo;
247 for (
const auto &cipher : ciphers) {
251 const auto *info = cipherInfoByOpenSslName(cipher.name());
252 if (!cipherInfo.contains(info))
253 cipherInfo.append(info);
256 QList<CRYPTO_SETTINGS> cryptoSettings;
258 const auto assignUnicodeString = [](UNICODE_STRING &unicodeString,
const wchar_t *characters) {
259 unicodeString.Length =
static_cast<USHORT>(wcslen(characters) *
sizeof(WCHAR));
260 unicodeString.MaximumLength = unicodeString.Length +
sizeof(UNICODE_NULL);
261 unicodeString.Buffer =
const_cast<
wchar_t*>(characters);
265 const auto allKeyExchangeAlgorithms = {BCRYPT_RSA_ALGORITHM,
267 BCRYPT_DH_ALGORITHM};
269 for (
const auto &algorithm : allKeyExchangeAlgorithms) {
270 const auto method = QStringView(algorithm);
272 const auto usesMethod = [method](
const SchannelCipherInfo *info) {
273 return QLatin1StringView(info->keyExchangeMethod) == method;
276 const bool exclude = std::none_of(cipherInfo.cbegin(), cipherInfo.cend(), usesMethod);
279 CRYPTO_SETTINGS settings = {};
280 settings.eAlgorithmUsage = TlsParametersCngAlgUsageKeyExchange;
281 assignUnicodeString(settings.strCngAlgId, algorithm);
282 cryptoSettings.append(settings);
287 const auto allAuthenticationAlgorithms = {BCRYPT_RSA_ALGORITHM,
288 BCRYPT_DSA_ALGORITHM,
290 BCRYPT_DH_ALGORITHM};
292 for (
const auto &algorithm : allAuthenticationAlgorithms) {
293 const auto method = QStringView(algorithm);
295 const auto usesMethod = [method](
const SchannelCipherInfo *info) {
296 return QLatin1StringView(info->authenticationMethod) == method;
299 const bool exclude = std::none_of(cipherInfo.begin(), cipherInfo.end(), usesMethod);
302 CRYPTO_SETTINGS settings = {};
303 settings.eAlgorithmUsage = TlsParametersCngAlgUsageSignature;
304 assignUnicodeString(settings.strCngAlgId, algorithm);
305 cryptoSettings.append(settings);
311 const auto allEncryptionAlgorithms = {BCRYPT_AES_ALGORITHM,
312 BCRYPT_RC4_ALGORITHM,
313 BCRYPT_DES_ALGORITHM,
314 BCRYPT_3DES_ALGORITHM};
316 for (
const auto &algorithm : allEncryptionAlgorithms) {
317 const auto method = QStringView(algorithm);
319 if (method == QLatin1StringView(
"AES")) {
320 bool uses128Bit =
false;
321 bool uses256Bit =
false;
322 bool usesGcm =
false;
323 bool usesCbc =
false;
324 for (
const auto *info : cipherInfo) {
325 if (QLatin1StringView(info->encryptionMethod) == method) {
326 uses128Bit = uses128Bit || (info->encryptionBits == 128);
327 uses256Bit = uses256Bit || (info->encryptionBits == 256);
329 QLatin1StringView(info->schannelCipherSuite).contains(
"_GCM_"_L1);
331 QLatin1StringView(info->schannelCipherSuite).contains(
"_CBC_"_L1);
335 CRYPTO_SETTINGS settings = {};
336 settings.eAlgorithmUsage = TlsParametersCngAlgUsageCipher;
337 assignUnicodeString(settings.strCngAlgId, algorithm);
339 if (usesGcm && !usesCbc) {
340 settings.cChainingModes = 1;
341 settings.rgstrChainingModes = &cbcChainingMode;
342 }
else if (!usesGcm && usesCbc) {
343 settings.cChainingModes = 1;
344 settings.rgstrChainingModes = &gcmChainingMode;
347 if (!uses128Bit && uses256Bit) {
348 settings.dwMinBitLength = 256;
349 cryptoSettings.append(settings);
350 }
else if (uses128Bit && !uses256Bit) {
351 settings.dwMaxBitLength = 128;
352 cryptoSettings.append(settings);
353 }
else if (!uses128Bit && !uses256Bit) {
354 cryptoSettings.append(settings);
357 const auto usesMethod = [method](
const SchannelCipherInfo *info) {
358 return QLatin1StringView(info->encryptionMethod) == method;
361 const bool exclude = std::none_of(cipherInfo.begin(), cipherInfo.end(), usesMethod);
364 CRYPTO_SETTINGS settings = {};
365 settings.eAlgorithmUsage = TlsParametersCngAlgUsageCipher;
366 assignUnicodeString(settings.strCngAlgId, algorithm);
367 cryptoSettings.append(settings);
373 const auto allHashAlgorithms = {BCRYPT_MD5_ALGORITHM,
374 BCRYPT_SHA1_ALGORITHM,
375 BCRYPT_SHA256_ALGORITHM,
376 BCRYPT_SHA384_ALGORITHM};
378 for (
const auto &algorithm : allHashAlgorithms) {
379 const auto method = QStringView(algorithm);
381 const auto usesMethod = [method](
const SchannelCipherInfo *info) {
382 return QLatin1StringView(info->hashMethod) == method;
385 const bool exclude = std::none_of(cipherInfo.begin(), cipherInfo.end(), usesMethod);
388 CRYPTO_SETTINGS settings = {};
389 settings.eAlgorithmUsage = TlsParametersCngAlgUsageDigest;
390 assignUnicodeString(settings.strCngAlgId, algorithm);
391 cryptoSettings.append(settings);
395 return cryptoSettings;
400 QList<QSslCipher> ciphers;
402 for (
const auto &cipher : schannelCipherInfo) {
403 if (QLatin1StringView(cipher.schannelCipherSuite) == schannelSuiteName) {
404 for (
const auto &protocol : cipher.protocols) {
406QT_WARNING_DISABLE_DEPRECATED
407 const QString protocolName = (
408 protocol == QSsl::TlsV1_0 ? QStringLiteral(
"TLSv1.0") :
409 protocol == QSsl::TlsV1_1 ? QStringLiteral(
"TLSv1.1") :
410 protocol == QSsl::TlsV1_2 ? QStringLiteral(
"TLSv1.2") :
411 protocol == QSsl::TlsV1_3 ? QStringLiteral(
"TLSv1.3") :
415 ciphers.append(QTlsBackend::createCiphersuite(QLatin1StringView(cipher.openSslCipherSuite),
416 QLatin1StringView(cipher.keyExchangeMethod),
417 QLatin1StringView(cipher.encryptionMethod),
418 QLatin1StringView(cipher.authenticationMethod),
419 cipher.encryptionBits,
420 protocol, protocolName));
430 ULONG contextFunctionsCount = {};
431 PCRYPT_CONTEXT_FUNCTIONS contextFunctions = {};
433 const auto status = BCryptEnumContextFunctions(CRYPT_LOCAL, L"SSL", NCRYPT_SCHANNEL_INTERFACE,
434 &contextFunctionsCount, &contextFunctions);
435 if (!NT_SUCCESS(status)) {
436 qCWarning(lcTlsBackendSchannel,
"Failed to enumerate ciphers");
440 const bool supportsV13 = supportsTls13();
442 QList<QSslCipher> ciphers;
444 for (ULONG index = 0; index < contextFunctions->cFunctions; ++index) {
445 const auto suiteName = QStringView(contextFunctions->rgpszFunctions[index]);
447 const QList<QSslCipher> allCiphers = ciphersByName(suiteName);
449 for (
const auto &cipher : allCiphers) {
450 if (!supportsV13 && (cipher.protocol() == QSsl::TlsV1_3))
453 ciphers.append(cipher);
457 BCryptFreeBuffer(contextFunctions);
464 return std::any_of(ciphers.cbegin(), ciphers.cend(),
465 [](
const QSslCipher &cipher) {
return cipher.protocol() == QSsl::TlsV1_3; });
470bool QSchannelBackend::s_loadedCiphersAndCerts =
false;
473long QSchannelBackend::tlsLibraryVersionNumber()
const
475 const auto os = QOperatingSystemVersion::current();
476 return (os.majorVersion() << 24) | ((os.minorVersion() & 0xFF) << 16) | (os.microVersion() & 0xFFFF);
479QString QSchannelBackend::tlsLibraryVersionString()
const
481 const auto os = QOperatingSystemVersion::current();
482 return "Secure Channel, %1 %2.%3.%4"_L1
484 QString::number(os.majorVersion()),
485 QString::number(os.minorVersion()),
486 QString::number(os.microVersion()));
489long QSchannelBackend::tlsLibraryBuildVersionNumber()
const
491 return NTDDI_VERSION;
494QString QSchannelBackend::tlsLibraryBuildVersionString()
const
496 return "Secure Channel (NTDDI: 0x%1)"_L1
497 .arg(QString::number(NTDDI_VERSION, 16).toUpper());
500void QSchannelBackend::ensureInitialized()
const
502 ensureInitializedImplementation();
505void QSchannelBackend::ensureInitializedImplementation()
507 const QMutexLocker<QRecursiveMutex> locker(qt_schannel_mutex);
508 if (s_loadedCiphersAndCerts)
510 s_loadedCiphersAndCerts =
true;
512 setDefaultCaCertificates(systemCaCertificatesImplementation());
514 QSslSocketPrivate::setRootCertOnDemandLoadingSupported(
true);
516 resetDefaultCiphers();
519void QSchannelBackend::resetDefaultCiphers()
521 setDefaultSupportedCiphers(QTlsPrivate::defaultCiphers());
522 setDefaultCiphers(QTlsPrivate::defaultCiphers());
525QString QSchannelBackend::backendName()
const
527 return builtinBackendNames[nameIndexSchannel];
530QList<QSsl::SslProtocol> QSchannelBackend::supportedProtocols()
const
532 QList<QSsl::SslProtocol> protocols;
534 protocols << QSsl::AnyProtocol;
535 protocols << QSsl::SecureProtocols;
537QT_WARNING_DISABLE_DEPRECATED
538 protocols << QSsl::TlsV1_0;
539 protocols << QSsl::TlsV1_0OrLater;
540 protocols << QSsl::TlsV1_1;
541 protocols << QSsl::TlsV1_1OrLater;
543 protocols << QSsl::TlsV1_2;
544 protocols << QSsl::TlsV1_2OrLater;
546 if (supportsTls13()) {
547 protocols << QSsl::TlsV1_3;
548 protocols << QSsl::TlsV1_3OrLater;
554QList<QSsl::SupportedFeature> QSchannelBackend::supportedFeatures()
const
556 QList<QSsl::SupportedFeature> features;
559 features << QSsl::SupportedFeature::ClientSideAlpn;
560 features << QSsl::SupportedFeature::ServerSideAlpn;
566QList<QSsl::ImplementedClass> QSchannelBackend::implementedClasses()
const
568 QList<QSsl::ImplementedClass> classes;
570 classes << QSsl::ImplementedClass::Socket;
571 classes << QSsl::ImplementedClass::Certificate;
572 classes << QSsl::ImplementedClass::Key;
577QTlsPrivate::TlsKey *QSchannelBackend::createKey()
const
582QTlsPrivate::X509Certificate *QSchannelBackend::createCertificate()
const
587QList<QSslCertificate> QSchannelBackend::systemCaCertificates()
const
589 return systemCaCertificatesImplementation();
592QTlsPrivate::TlsCryptograph *QSchannelBackend::createTlsCryptograph()
const
597QList<QSslCertificate> QSchannelBackend::systemCaCertificatesImplementation()
601 QList<QSslCertificate> systemCerts;
604 CertOpenStore(CERT_STORE_PROV_SYSTEM, 0, 0,
605 CERT_STORE_READONLY_FLAG | CERT_SYSTEM_STORE_CURRENT_USER, L"ROOT"));
608 PCCERT_CONTEXT pc =
nullptr;
609 while ((pc = CertFindCertificateInStore(hSystemStore.get(), X509_ASN_ENCODING, 0,
610 CERT_FIND_ANY,
nullptr, pc))) {
611 systemCerts.append(QTlsPrivate::X509CertificateSchannel::QSslCertificate_from_CERT_CONTEXT(pc));
617QTlsPrivate::X509PemReaderPtr QSchannelBackend::X509PemReader()
const
619 return QTlsPrivate::X509CertificateGeneric::certificatesFromPem;
622QTlsPrivate::X509DerReaderPtr QSchannelBackend::X509DerReader()
const
624 return QTlsPrivate::X509CertificateGeneric::certificatesFromDer;
627QTlsPrivate::X509Pkcs12ReaderPtr QSchannelBackend::X509Pkcs12Reader()
const
629 return QTlsPrivate::X509CertificateSchannel::importPkcs12;
634SecBuffer createSecBuffer(
void *ptr,
unsigned long length,
unsigned long bufferType)
636 return SecBuffer{ length, bufferType, ptr };
639SecBuffer createSecBuffer(QByteArray &buffer,
unsigned long bufferType)
641 return createSecBuffer(buffer.data(),
static_cast<
unsigned long>(buffer.length()), bufferType);
644QString schannelErrorToString(qint32 status)
647 case SEC_E_INSUFFICIENT_MEMORY:
648 return QSslSocket::tr(
"Insufficient memory");
649 case SEC_E_INTERNAL_ERROR:
650 return QSslSocket::tr(
"Internal error");
651 case SEC_E_INVALID_HANDLE:
652 return QSslSocket::tr(
"An internal handle was invalid");
653 case SEC_E_INVALID_TOKEN:
654 return QSslSocket::tr(
"An internal token was invalid");
655 case SEC_E_LOGON_DENIED:
658 return QSslSocket::tr(
"Access denied");
659 case SEC_E_NO_AUTHENTICATING_AUTHORITY:
660 return QSslSocket::tr(
"No authority could be contacted for authorization");
661 case SEC_E_NO_CREDENTIALS:
662 return QSslSocket::tr(
"No credentials");
663 case SEC_E_TARGET_UNKNOWN:
664 return QSslSocket::tr(
"The target is unknown or unreachable");
665 case SEC_E_UNSUPPORTED_FUNCTION:
666 return QSslSocket::tr(
"An unsupported function was requested");
667 case SEC_E_WRONG_PRINCIPAL:
669 return QSslSocket::tr(
"The hostname provided does not match the one received from the peer");
671 return QSslSocket::tr(
"No common protocol exists between the client and the server");
672 case SEC_E_ILLEGAL_MESSAGE:
673 return QSslSocket::tr(
"Unexpected or badly-formatted message received");
674 case SEC_E_ENCRYPT_FAILURE:
675 return QSslSocket::tr(
"The data could not be encrypted");
676 case SEC_E_DECRYPT_FAILURE:
677 return QSslSocket::tr(
"The data could not be decrypted");
678 case SEC_E_ALGORITHM_MISMATCH:
679 return QSslSocket::tr(
"No cipher suites in common");
680 case SEC_E_UNKNOWN_CREDENTIALS:
682 return QSslSocket::tr(
"The credentials were not recognized / Invalid argument");
683 case SEC_E_MESSAGE_ALTERED:
686 return QSslSocket::tr(
"The message was tampered with, damaged or out of sequence.");
687 case SEC_E_OUT_OF_SEQUENCE:
688 return QSslSocket::tr(
"A message was received out of sequence.");
689 case SEC_E_CONTEXT_EXPIRED:
690 return QSslSocket::tr(
"The TLS/SSL connection has been closed");
692 return QSslSocket::tr(
"Unknown error occurred: %1").arg(status);
698 static bool supported = []() {
699 const auto current = QOperatingSystemVersion::current();
702 QOperatingSystemVersion(QOperatingSystemVersion::Windows, 10, 0, 20221);
703 return current >= minimum;
709DWORD toSchannelProtocol(QSsl::SslProtocol protocol)
711 DWORD protocols = SP_PROT_NONE;
713 case QSsl::UnknownProtocol:
716QT_WARNING_DISABLE_DEPRECATED
718 case QSsl::DtlsV1_0OrLater:
721 case QSsl::DtlsV1_2OrLater:
723 case QSsl::AnyProtocol:
729QT_WARNING_DISABLE_DEPRECATED
744 protocols = DWORD(-1);
747QT_WARNING_DISABLE_DEPRECATED
748 case QSsl::TlsV1_0OrLater:
753 case QSsl::TlsV1_1OrLater:
757 case QSsl::SecureProtocols:
758 case QSsl::TlsV1_2OrLater:
761 case QSsl::TlsV1_3OrLater:
764 else if (protocol == QSsl::TlsV1_3OrLater)
765 protocols = DWORD(-1);
774DWORD negatedSchannelProtocols(DWORD wantedProtocols)
776 DWORD protocols = SP_PROT_ALL;
777 protocols &= ~wantedProtocols;
782
783
784
785
786
787
788QSsl::SslProtocol toQtSslProtocol(DWORD protocol)
790#define MAP_PROTOCOL(sp_protocol, q_protocol)
791 if (protocol & sp_protocol) {
792 Q_ASSERT(!(protocol & ~sp_protocol));
797QT_WARNING_DISABLE_DEPRECATED
805 return QSsl::UnknownProtocol;
809
810
811
812bool netscapeWrongCertType(
const QList<QSslCertificateExtension> &extensions,
bool isClient,
bool isLeaf)
814 const auto netscapeIt = std::find_if(
815 extensions.cbegin(), extensions.cend(),
816 [](
const QSslCertificateExtension &extension) {
817 return extension.oid() == u"2.16.840.1.113730.1.1";
819 if (netscapeIt != extensions.cend()) {
820 const QByteArray netscapeCertTypeByte = netscapeIt->value().toByteArray();
821 int netscapeCertType = 0;
822 QDataStream dataStream(netscapeCertTypeByte);
823 dataStream >> netscapeCertType;
824 if (dataStream.status() != QDataStream::Status::Ok)
826 const int expectedPeerCertType = [&]() {
828 return isClient ? NETSCAPE_SSL_SERVER_AUTH_CERT_TYPE
829 : NETSCAPE_SSL_CLIENT_AUTH_CERT_TYPE;
831 return NETSCAPE_SSL_CA_CERT_TYPE;
833 if ((netscapeCertType & expectedPeerCertType) == 0)
840
841
842
843
844
845
846bool isCertificateAuthority(
const QList<QSslCertificateExtension> &extensions)
848 auto it = std::find_if(extensions.cbegin(), extensions.cend(),
849 [](
const QSslCertificateExtension &extension) {
850 return extension.name() ==
"basicConstraints"_L1;
852 if (it != extensions.cend()) {
853 QVariantMap basicConstraints = it->value().toMap();
854 return basicConstraints.value(
"ca"_L1,
false).toBool();
860
861
862
863
864bool matchesContextRequirements(DWORD attributes, DWORD requirements,
865 QSslSocket::PeerVerifyMode verifyMode,
868#ifdef QSSLSOCKET_DEBUG
869#define DEBUG_WARN(message) qCWarning(lcTlsBackendSchannel, message)
871#define DEBUG_WARN(message)
874#define CHECK_ATTRIBUTE(attributeName)
876 const DWORD req##attributeName = isClient ? ISC_REQ_##attributeName : ASC_REQ_##attributeName;
877 const DWORD ret##attributeName = isClient ? ISC_RET_##attributeName : ASC_RET_##attributeName;
878 if (!(requirements & req##attributeName) != !(attributes & ret##attributeName)) {
879 DEBUG_WARN("Missing attribute \"" #attributeName "\"");
888 if (verifyMode == QSslSocket::PeerVerifyMode::VerifyPeer)
893 const auto reqManualCredValidation = ISC_REQ_MANUAL_CRED_VALIDATION;
894 const auto retManualCredValidation = ISC_RET_MANUAL_CRED_VALIDATION;
895 if (!(requirements & reqManualCredValidation) != !(attributes & retManualCredValidation)) {
896 DEBUG_WARN(
"Missing attribute \"MANUAL_CRED_VALIDATION\"");
902#undef CHECK_ATTRIBUTE
906template<
typename Required,
typename Actual>
907Required const_reinterpret_cast(Actual *p)
913QByteArray createAlpnString(
const QByteArrayList &nextAllowedProtocols)
915 QByteArray alpnString;
916 if (!nextAllowedProtocols.isEmpty()) {
917 const QByteArray names = [&nextAllowedProtocols]() {
918 QByteArray protocolString;
919 for (QByteArray proto : nextAllowedProtocols) {
920 if (proto.size() > 255) {
921 qCWarning(lcTlsBackendSchannel)
922 <<
"TLS ALPN extension" << proto <<
"is too long and will be ignored.";
924 }
else if (proto.isEmpty()) {
927 protocolString +=
char(proto.length()) + proto;
929 return protocolString;
934 const quint16 namesSize = names.size();
935 const quint32 alpnId = SecApplicationProtocolNegotiationExt_ALPN;
936 const quint32 totalSize =
sizeof(alpnId) +
sizeof(namesSize) + namesSize;
937 alpnString = QByteArray::fromRawData(
reinterpret_cast<
const char *>(&totalSize),
sizeof(totalSize))
938 + QByteArray::fromRawData(
reinterpret_cast<
const char *>(&alpnId),
sizeof(alpnId))
939 + QByteArray::fromRawData(
reinterpret_cast<
const char *>(&namesSize),
sizeof(namesSize))
946qint64 readToBuffer(QByteArray &buffer, QTcpSocket *plainSocket)
948 Q_ASSERT(plainSocket);
949 static const qint64 shrinkCutoff = 1024 * 12;
950 static const qint64 defaultRead = 1024 * 16;
951 qint64 bytesRead = 0;
953 const auto toRead =
std::min(defaultRead, plainSocket->bytesAvailable());
955 const auto bufferSize = buffer.size();
956 buffer.reserve(bufferSize + toRead);
957 buffer.resize(bufferSize + toRead);
958 bytesRead = plainSocket->read(buffer.data() + bufferSize, toRead);
959 buffer.resize(bufferSize + bytesRead);
961 if (buffer.size() < shrinkCutoff && buffer.capacity() > defaultRead)
962 buffer.shrink_to_fit();
968void retainExtraData(QByteArray &buffer,
const SecBuffer &secBuffer)
970 Q_ASSERT(secBuffer.BufferType == SECBUFFER_EXTRA);
971 if (
int(secBuffer.cbBuffer) >= buffer.size())
974#ifdef QSSLSOCKET_DEBUG
975 qCDebug(lcTlsBackendSchannel,
"We got SECBUFFER_EXTRA, will retain %lu bytes",
978 std::move(buffer.end() - secBuffer.cbBuffer, buffer.end(), buffer.begin());
979 buffer.resize(secBuffer.cbBuffer);
982qint64 checkIncompleteData(
const SecBuffer &secBuffer)
984 if (secBuffer.BufferType == SECBUFFER_MISSING) {
985#ifdef QSSLSOCKET_DEBUG
986 qCDebug(lcTlsBackendSchannel,
"Need %lu more bytes.", secBuffer.cbBuffer);
988 return secBuffer.cbBuffer;
993DWORD defaultCredsFlag()
995 return qEnvironmentVariableIsSet(
"QT_SCH_DEFAULT_CREDS") ? 0 : SCH_CRED_NO_DEFAULT_CREDS;
1004 SecInvalidateHandle(&credentialHandle);
1005 SecInvalidateHandle(&contextHandle);
1006 QSchannelBackend::ensureInitializedImplementation();
1011 closeCertificateStores();
1012 deallocateContext();
1013 freeCredentialsHandle();
1029 if (tokenLength == 0)
1033 auto *plainSocket = d->plainTcpSocket();
1034 Q_ASSERT(plainSocket);
1035 if (plainSocket->state() == QAbstractSocket::UnconnectedState || !plainSocket->isValid()
1036 || !plainSocket->isOpen()) {
1040 const qint64 written = plainSocket->write(
static_cast<
const char *>(token), tokenLength);
1041 if (written != qint64(tokenLength)) {
1044 setErrorAndEmit(d, plainSocket->error(), plainSocket->errorString());
1056 const auto verificationPeerName = d->verificationName();
1057 return verificationPeerName.isEmpty() ? q->peerName() : verificationPeerName;
1065 const bool isClient = d->tlsMode() == QSslSocket::SslClientMode;
1068 req |= ISC_REQ_ALLOCATE_MEMORY;
1069 req |= ISC_REQ_CONFIDENTIALITY;
1070 req |= ISC_REQ_REPLAY_DETECT;
1071 req |= ISC_REQ_SEQUENCE_DETECT;
1072 req |= ISC_REQ_STREAM;
1075 req |= ISC_REQ_MANUAL_CRED_VALIDATION;
1077 switch (q->peerVerifyMode()) {
1078 case QSslSocket::PeerVerifyMode::VerifyNone:
1080 case QSslSocket::PeerVerifyMode::AutoVerifyPeer:
1081 case QSslSocket::PeerVerifyMode::QueryPeer:
1083 case QSslSocket::PeerVerifyMode::VerifyPeer:
1084 req |= ISC_REQ_MUTUAL_AUTH;
1096 const auto &configuration = q->sslConfiguration();
1098 Q_ASSERT(schannelState == SchannelState::InitializeHandshake);
1100 const bool isClient = d->tlsMode() == QSslSocket::SslClientMode;
1101 DWORD protocols = toSchannelProtocol(configuration.protocol());
1102 if (protocols == DWORD(-1)) {
1103 setErrorAndEmit(d, QAbstractSocket::SslInvalidUserDataError,
1104 QSslSocket::tr(
"Invalid protocol chosen"));
1108 DWORD certsCount = 0;
1110 initializeCertificateStores();
1115 if (!configuration.localCertificateChain().isEmpty() && !localCertificateStore)
1118 PCCERT_CONTEXT localCertificate =
nullptr;
1119 if (localCertificateStore !=
nullptr) {
1121 localCertificate =
static_cast<PCCERT_CONTEXT>(configuration.localCertificate().handle());
1122 Q_ASSERT(localCertificate);
1125 const QList<QSslCipher> ciphers = configuration.ciphers();
1126 if (!ciphers.isEmpty() && !containsTls13Cipher(ciphers))
1129 QList<CRYPTO_SETTINGS> cryptoSettings;
1130 if (!ciphers.isEmpty())
1131 cryptoSettings = cryptoSettingsForCiphers(ciphers);
1133 TLS_PARAMETERS tlsParameters = {
1136 negatedSchannelProtocols(protocols),
1137 static_cast<DWORD>(cryptoSettings.size()),
1138 (cryptoSettings.isEmpty() ?
nullptr : cryptoSettings.data()),
1142 SCH_CREDENTIALS credentials = {
1143 SCH_CREDENTIALS_VERSION,
1151 SCH_CRED_REVOCATION_CHECK_CHAIN_EXCLUDE_ROOT | defaultCredsFlag(),
1156 TimeStamp expiration{};
1157 auto status = AcquireCredentialsHandle(
nullptr,
1158 const_cast<
wchar_t *>(UNISP_NAME),
1159 isClient ? SECPKG_CRED_OUTBOUND : SECPKG_CRED_INBOUND,
1168#ifdef QT_WIN_SERVER_2016_COMPAT
1169 if (status == SEC_E_UNKNOWN_CREDENTIALS) {
1170 if (!ciphers.isEmpty()) {
1171 qCWarning(lcTlsBackendSchannel,
1172 "Cipher suite restrictions are not supported by the "
1173 "Windows Server 2016 compatibility fallback");
1174 setErrorAndEmit(d, QAbstractSocket::SslInternalError, schannelErrorToString(status));
1178 SCHANNEL_CRED credentialsV4 = { SCHANNEL_CRED_VERSION,
1190 SCH_CRED_REVOCATION_CHECK_CHAIN_EXCLUDE_ROOT
1191 | defaultCredsFlag(),
1194 status = AcquireCredentialsHandle(
nullptr,
1195 const_cast<
wchar_t *>(UNISP_NAME),
1196 isClient ? SECPKG_CRED_OUTBOUND
1197 : SECPKG_CRED_INBOUND,
1208 if (status != SEC_E_OK) {
1209 setErrorAndEmit(d, QAbstractSocket::SslInternalError, schannelErrorToString(status));
1217 if (SecIsValidHandle(&contextHandle)) {
1218 DeleteSecurityContext(&contextHandle);
1219 SecInvalidateHandle(&contextHandle);
1225 if (SecIsValidHandle(&credentialHandle)) {
1226 FreeCredentialsHandle(&credentialHandle);
1227 SecInvalidateHandle(&credentialHandle);
1233 localCertificateStore.reset();
1234 peerCertificateStore.reset();
1235 caCertificateStore.reset();
1243 Q_ASSERT(SecIsValidHandle(&credentialHandle));
1244 Q_ASSERT(schannelState == SchannelState::InitializeHandshake);
1245 Q_ASSERT(d->tlsMode() == QSslSocket::SslClientMode);
1246 ULONG contextReq = getContextRequirements();
1248 SecBuffer outBuffers[3];
1249 outBuffers[0] = createSecBuffer(
nullptr, 0, SECBUFFER_TOKEN);
1251 outBuffers[2] = createSecBuffer(
nullptr, 0, SECBUFFER_EMPTY);
1252 auto freeBuffers = qScopeGuard([&outBuffers]() {
1253 for (
auto i = 0ull; i < ARRAYSIZE(outBuffers); i++) {
1254 if (outBuffers[i].pvBuffer)
1255 FreeContextBuffer(outBuffers[i].pvBuffer);
1258 SecBufferDesc outputBufferDesc{
1260 ARRAYSIZE(outBuffers),
1266 SecBufferDesc alpnBufferDesc;
1267 bool useAlpn =
false;
1269 QTlsBackend::setAlpnStatus(d, QSslConfiguration::NextProtocolNegotiationNone);
1270 QByteArray alpnString = createAlpnString(q->sslConfiguration().allowedNextProtocols());
1271 useAlpn = !alpnString.isEmpty();
1272 SecBuffer alpnBuffers[1];
1273 alpnBuffers[0] = createSecBuffer(alpnString, SECBUFFER_APPLICATION_PROTOCOLS);
1276 ARRAYSIZE(alpnBuffers),
1281 const QString encodedTargetName = QUrl::fromUserInput(targetName()).host(QUrl::EncodeUnicode);
1282 auto status = InitializeSecurityContext(&credentialHandle,
1284 const_reinterpret_cast<SEC_WCHAR *>(encodedTargetName.utf16()),
1288 useAlpn ? &alpnBufferDesc :
nullptr,
1298 if (status != SEC_I_CONTINUE_NEEDED) {
1299 setErrorAndEmit(d, QAbstractSocket::SslInternalError,
1300 QSslSocket::tr(
"Error creating SSL context (%1)").arg(schannelErrorToString(status)));
1304 if (!sendToken(outBuffers[0].pvBuffer, outBuffers[0].cbBuffer))
1306 schannelState = SchannelState::PerformHandshake;
1315 auto *plainSocket = d->plainTcpSocket();
1316 Q_ASSERT(plainSocket);
1318 Q_ASSERT(SecIsValidHandle(&credentialHandle));
1319 Q_ASSERT(schannelState == SchannelState::InitializeHandshake);
1320 Q_ASSERT(d->tlsMode() == QSslSocket::SslServerMode);
1321 ULONG contextReq = getContextRequirements();
1323 if (missingData > plainSocket->bytesAvailable())
1327 readToBuffer(intermediateBuffer, plainSocket);
1328 if (intermediateBuffer.isEmpty())
1331 SecBuffer inBuffers[2];
1332 inBuffers[0] = createSecBuffer(intermediateBuffer, SECBUFFER_TOKEN);
1335 QTlsBackend::setAlpnStatus(d, QSslConfiguration::NextProtocolNegotiationNone);
1337 QByteArray alpnString = createAlpnString(q->sslConfiguration().allowedNextProtocols());
1338 if (!alpnString.isEmpty()) {
1339 inBuffers[1] = createSecBuffer(alpnString, SECBUFFER_APPLICATION_PROTOCOLS);
1343 inBuffers[1] = createSecBuffer(
nullptr, 0, SECBUFFER_EMPTY);
1346 SecBufferDesc inputBufferDesc{
1348 ARRAYSIZE(inBuffers),
1352 SecBuffer outBuffers[3];
1353 outBuffers[0] = createSecBuffer(
nullptr, 0, SECBUFFER_TOKEN);
1355 outBuffers[2] = createSecBuffer(
nullptr, 0, SECBUFFER_EMPTY);
1356 auto freeBuffers = qScopeGuard([&outBuffers]() {
1357 for (
auto i = 0ull; i < ARRAYSIZE(outBuffers); i++) {
1358 if (outBuffers[i].pvBuffer)
1359 FreeContextBuffer(outBuffers[i].pvBuffer);
1362 SecBufferDesc outputBufferDesc{
1364 ARRAYSIZE(outBuffers),
1369 auto status = AcceptSecurityContext(
1381 if (status == SEC_E_INCOMPLETE_MESSAGE) {
1383 missingData = checkIncompleteData(outBuffers[0]);
1387 if (inBuffers[1].BufferType == SECBUFFER_EXTRA) {
1391 retainExtraData(intermediateBuffer, inBuffers[1]);
1393 intermediateBuffer.resize(0);
1396 if (status != SEC_I_CONTINUE_NEEDED) {
1397 setErrorAndEmit(d, QAbstractSocket::SslHandshakeFailedError,
1398 QSslSocket::tr(
"Error creating SSL context (%1)").arg(schannelErrorToString(status)));
1401 if (!sendToken(outBuffers[0].pvBuffer, outBuffers[0].cbBuffer))
1403 schannelState = SchannelState::PerformHandshake;
1410 auto *plainSocket = d->plainTcpSocket();
1411 Q_ASSERT(plainSocket);
1413 if (plainSocket->state() == QAbstractSocket::UnconnectedState || !plainSocket->isValid()
1414 || !plainSocket->isOpen()) {
1415 setErrorAndEmit(d, QAbstractSocket::RemoteHostClosedError,
1416 QSslSocket::tr(
"The TLS/SSL connection has been closed"));
1419 Q_ASSERT(SecIsValidHandle(&credentialHandle));
1420 Q_ASSERT(SecIsValidHandle(&contextHandle));
1421 Q_ASSERT(schannelState == SchannelState::PerformHandshake);
1423#ifdef QSSLSOCKET_DEBUG
1424 qCDebug(lcTlsBackendSchannel,
"Bytes available from socket: %lld",
1425 plainSocket->bytesAvailable());
1426 qCDebug(lcTlsBackendSchannel,
"intermediateBuffer size: %d", intermediateBuffer.size());
1429 if (missingData > plainSocket->bytesAvailable())
1433 readToBuffer(intermediateBuffer, plainSocket);
1434 if (intermediateBuffer.isEmpty())
1437 SecBuffer outBuffers[3] = {};
1438 const auto freeOutBuffers = [&outBuffers]() {
1439 for (
auto i = 0ull; i < ARRAYSIZE(outBuffers); i++) {
1440 if (outBuffers[i].pvBuffer)
1441 FreeContextBuffer(outBuffers[i].pvBuffer);
1444 const auto outBuffersGuard = qScopeGuard(freeOutBuffers);
1450 SECURITY_STATUS status;
1453 SecBuffer inputBuffers[2];
1454 inputBuffers[0] = createSecBuffer(intermediateBuffer, SECBUFFER_TOKEN);
1455 inputBuffers[1] = createSecBuffer(
nullptr, 0, SECBUFFER_EMPTY);
1456 SecBufferDesc inputBufferDesc{
1458 ARRAYSIZE(inputBuffers),
1463 outBuffers[0] = createSecBuffer(
nullptr, 0, SECBUFFER_TOKEN);
1465 outBuffers[2] = createSecBuffer(
nullptr, 0, SECBUFFER_EMPTY);
1466 SecBufferDesc outputBufferDesc{
1468 ARRAYSIZE(outBuffers),
1472 ULONG contextReq = getContextRequirements();
1474 status = InitializeSecurityContext(
1477 const_reinterpret_cast<SEC_WCHAR *>(targetName().utf16()),
1489 if (inputBuffers[1].BufferType == SECBUFFER_EXTRA) {
1493 retainExtraData(intermediateBuffer, inputBuffers[1]);
1494 }
else if (status != SEC_E_INCOMPLETE_MESSAGE) {
1496 intermediateBuffer.resize(0);
1500 }
while (status == SEC_I_INCOMPLETE_CREDENTIALS && attempts > 0);
1505 if (!sendToken(outBuffers[0].pvBuffer, outBuffers[0].cbBuffer))
1507 schannelState = SchannelState::VerifyHandshake;
1509 case SEC_I_CONTINUE_NEEDED:
1510 if (!sendToken(outBuffers[0].pvBuffer, outBuffers[0].cbBuffer))
1514 case SEC_I_INCOMPLETE_CREDENTIALS:
1517 setErrorAndEmit(d, QAbstractSocket::SslHandshakeFailedError,
1518 QSslSocket::tr(
"Server did not accept any certificate we could present."));
1520 case SEC_I_CONTEXT_EXPIRED:
1522 if (outBuffers[0].BufferType == SECBUFFER_TOKEN) {
1523 if (!sendToken(outBuffers[0].pvBuffer, outBuffers[0].cbBuffer))
1527 setErrorAndEmit(d, QAbstractSocket::RemoteHostClosedError,
1528 QSslSocket::tr(
"The TLS/SSL connection has been closed"));
1531 case SEC_E_INCOMPLETE_MESSAGE:
1533 missingData = checkIncompleteData(outBuffers[0]);
1535 case SEC_E_ALGORITHM_MISMATCH:
1536 setErrorAndEmit(d, QAbstractSocket::SslHandshakeFailedError,
1537 QSslSocket::tr(
"Algorithm mismatch"));
1545 setErrorAndEmit(d, QAbstractSocket::SslHandshakeFailedError,
1546 QSslSocket::tr(
"Handshake failed: %1").arg(schannelErrorToString(status)));
1554 const auto &configuration = q->sslConfiguration();
1558 const bool isClient = d->tlsMode() == QSslSocket::SslClientMode;
1559#define CHECK_STATUS(status)
1560 if (status != SEC_E_OK) {
1561 setErrorAndEmit(d, QAbstractSocket::SslInternalError,
1562 QSslSocket::tr("Failed to query the TLS context: %1")
1563 .arg(schannelErrorToString(status)));
1568 if (!matchesContextRequirements(contextAttributes, getContextRequirements(),
1569 configuration.peerVerifyMode(), isClient)) {
1570 setErrorAndEmit(d, QAbstractSocket::SslHandshakeFailedError,
1571 QSslSocket::tr(
"Did not get the required attributes for the connection."));
1576 auto status = QueryContextAttributes(&contextHandle,
1577 SECPKG_ATTR_STREAM_SIZES,
1582 status = QueryContextAttributes(&contextHandle,
1583 SECPKG_ATTR_CIPHER_INFO,
1587 status = QueryContextAttributes(&contextHandle,
1588 SECPKG_ATTR_CONNECTION_INFO,
1593 const auto allowedProtos = configuration.allowedNextProtocols();
1594 if (!allowedProtos.isEmpty()) {
1595 SecPkgContext_ApplicationProtocol alpn;
1596 status = QueryContextAttributes(&contextHandle,
1597 SECPKG_ATTR_APPLICATION_PROTOCOL,
1599 CHECK_STATUS(status);
1600 if (alpn.ProtoNegoStatus == SecApplicationProtocolNegotiationStatus_Success) {
1601 QByteArray negotiatedProto = QByteArray((
const char *)alpn.ProtocolId,
1602 alpn.ProtocolIdSize);
1603 if (!allowedProtos.contains(negotiatedProto)) {
1604 setErrorAndEmit(d, QAbstractSocket::SslHandshakeFailedError,
1605 QSslSocket::tr(
"Unwanted protocol was negotiated"));
1608 QTlsBackend::setNegotiatedProtocol(d, negotiatedProto);
1609 QTlsBackend::setAlpnStatus(d, QSslConfiguration::NextProtocolNegotiationNegotiated);
1611 QTlsBackend::setNegotiatedProtocol(d, {});
1612 QTlsBackend::setAlpnStatus(d, QSslConfiguration::NextProtocolNegotiationUnsupported);
1620 CERT_CONTEXT *certificateContext =
nullptr;
1621 auto freeCertificate = qScopeGuard([&certificateContext]() {
1622 if (certificateContext)
1623 CertFreeCertificateContext(certificateContext);
1625 status = QueryContextAttributes(&contextHandle,
1626 SECPKG_ATTR_REMOTE_CERT_CONTEXT,
1627 &certificateContext);
1634 if ((!isClient && configuration.peerVerifyMode() == QSslSocket::PeerVerifyMode::VerifyPeer)
1635 || (isClient && configuration.peerVerifyMode() != QSslSocket::PeerVerifyMode::VerifyNone
1636 && configuration.peerVerifyMode() != QSslSocket::PeerVerifyMode::QueryPeer)) {
1637 if (status != SEC_E_OK) {
1638#ifdef QSSLSOCKET_DEBUG
1639 qCDebug(lcTlsBackendSchannel) <<
"Couldn't retrieve peer certificate, status:"
1640 << schannelErrorToString(status);
1642 const QSslError error{ QSslError::NoPeerCertificate };
1644 emit q->peerVerifyError(error);
1645 if (q->state() != QAbstractSocket::ConnectedState)
1651 if (certificateContext && !verifyCertContext(certificateContext))
1654 if (!checkSslErrors() || q->state() != QAbstractSocket::ConnectedState) {
1655#ifdef QSSLSOCKET_DEBUG
1656 qCDebug(lcTlsBackendSchannel) <<
__func__ <<
"was unsuccessful. Paused:" << d->isPaused();
1659 return d->isPaused() && q->state() == QAbstractSocket::ConnectedState;
1662 schannelState = SchannelState::Done;
1670 SecBuffer outBuffers[3];
1671 outBuffers[0] = createSecBuffer(
nullptr, 0, SECBUFFER_TOKEN);
1673 outBuffers[2] = createSecBuffer(
nullptr, 0, SECBUFFER_EMPTY);
1674 auto freeBuffers = qScopeGuard([&outBuffers]() {
1675 for (
auto i = 0ull; i < ARRAYSIZE(outBuffers); i++) {
1676 if (outBuffers[i].pvBuffer)
1677 FreeContextBuffer(outBuffers[i].pvBuffer);
1680 SecBufferDesc outputBufferDesc{
1682 ARRAYSIZE(outBuffers),
1686 ULONG contextReq = getContextRequirements();
1688 SECURITY_STATUS status;
1689 if (d->tlsMode() == QSslSocket::SslClientMode) {
1690 status = InitializeSecurityContext(&credentialHandle,
1692 const_reinterpret_cast<SEC_WCHAR *>(targetName().utf16()),
1704 status = AcceptSecurityContext(
1716 if (status == SEC_I_CONTINUE_NEEDED) {
1717 schannelState = SchannelState::PerformHandshake;
1718 return sendToken(outBuffers[0].pvBuffer, outBuffers[0].cbBuffer);
1719 }
else if (status == SEC_E_OK) {
1720 schannelState = SchannelState::PerformHandshake;
1723 setErrorAndEmit(d, QAbstractSocket::SslHandshakeFailedError,
1724 QSslSocket::tr(
"Renegotiation was unsuccessful: %1").arg(schannelErrorToString(status)));
1729
1730
1731
1736 closeCertificateStores();
1737 deallocateContext();
1738 freeCredentialsHandle();
1741 connectionInfo = {};
1744 contextAttributes = 0;
1745 intermediateBuffer.clear();
1746 schannelState = SchannelState::InitializeHandshake;
1749 d->setEncrypted(
false);
1751 renegotiating =
false;
1760 if (q->isEncrypted())
1770 if (q->isEncrypted())
1778 MessageBufferResult result;
1779 QByteArray &fullMessage = result.messageBuffer;
1782 auto &writeBuffer = d->tlsWriteBuffer();
1784 auto allocateMessage = [&fullMessage](qsizetype size) -> QSpan<
char> {
1785 auto targetSize = fullMessage.size() + size;
1786 if (fullMessage.capacity() < targetSize) {
1787 qsizetype newSize = fullMessage.capacity() * 2;
1788 if (newSize < targetSize)
1789 newSize = targetSize;
1790 fullMessage.reserve(newSize);
1792 fullMessage.resizeForOverwrite(targetSize);
1793 return QSpan(fullMessage).subspan(fullMessage.size() - size);
1796 const int headerSize =
int(streamSizes.cbHeader);
1797 const int trailerSize =
int(streamSizes.cbTrailer);
1798 constexpr qsizetype MessageBufferThreshold = 128 * 1024;
1800 qint64 writeBufferSize = 0;
1801 while ((writeBufferSize = writeBuffer.size()) > 0
1802 && fullMessage.size() < MessageBufferThreshold) {
1804 const int bodySize =
int(
std::min(writeBufferSize, qint64(streamSizes.cbMaximumMessage)));
1805 const qsizetype messageSize = headerSize + bodySize + trailerSize;
1806 QSpan buffer = allocateMessage(messageSize);
1807 char *header = buffer.data();
1808 char *body = header + headerSize;
1809 char *trailer = body + bodySize;
1812 qint64 copied = writeBuffer.peek(body, bodySize);
1813 Q_ASSERT(copied == bodySize);
1816 SecBuffer inputBuffers[] = {
1817 createSecBuffer(header, headerSize, SECBUFFER_STREAM_HEADER),
1818 createSecBuffer(body, bodySize, SECBUFFER_DATA),
1819 createSecBuffer(trailer, trailerSize, SECBUFFER_STREAM_TRAILER),
1820 createSecBuffer(
nullptr, 0, SECBUFFER_EMPTY)
1822 SecBufferDesc message = {
1824 ARRAYSIZE(inputBuffers),
1828 if (
auto status = EncryptMessage(&contextHandle, 0, &message, 0); status != SEC_E_OK) {
1829 setErrorAndEmit(d, QAbstractSocket::SslInternalError,
1830 QSslSocket::tr(
"Schannel failed to encrypt data: %1")
1831 .arg(schannelErrorToString(status)));
1832 result.messageBuffer.chop(messageSize);
1836 writeBuffer.free(bodySize);
1839 auto finalSize = qsizetype(inputBuffers[0].cbBuffer + inputBuffers[1].cbBuffer
1840 + inputBuffers[2].cbBuffer);
1841 fullMessage.chop(messageSize - finalSize);
1851 auto *plainSocket = d->plainTcpSocket();
1852 Q_ASSERT(plainSocket);
1854 if (d->tlsMode() == QSslSocket::UnencryptedMode)
1858 if (plainSocket->state() == QAbstractSocket::UnconnectedState || !plainSocket->isValid()
1859 || !plainSocket->isOpen()) {
1863 if (schannelState != SchannelState::Done) {
1868 auto &buffer = d->tlsBuffer();
1869 if (q->isEncrypted()) {
1870 qint64 totalBytesWritten = 0;
1871 while (d->tlsWriteBuffer().size() > 0) {
1872 MessageBufferResult r = getNextEncryptedMessage();
1873 if (r.messageBuffer.isEmpty() && !r.ok)
1875 QByteArray fullMessage =
std::move(r.messageBuffer);
1876 const qint64 bytesWritten = plainSocket->write(fullMessage);
1877 if (!r.ok && bytesWritten < 0)
1879#ifdef QSSLSOCKET_DEBUG
1880 qCDebug(lcTlsBackendSchannel,
"Wrote %lld of total %d bytes", bytesWritten,
1881 fullMessage.size());
1883 if (bytesWritten >= 0) {
1884 totalBytesWritten += bytesWritten;
1886 setErrorAndEmit(d, plainSocket->error(), plainSocket->errorString());
1891 if (totalBytesWritten > 0) {
1893 bool &emittedBytesWritten = d->tlsEmittedBytesWritten();
1894 if (!emittedBytesWritten) {
1895 emittedBytesWritten =
true;
1896 emit q->bytesWritten(totalBytesWritten);
1897 emittedBytesWritten =
false;
1899 emit q->channelBytesWritten(0, totalBytesWritten);
1904 bool hadIncompleteData =
false;
1905 const auto readBufferMaxSize = d->maxReadBufferSize();
1906 while (!readBufferMaxSize || buffer.size() < readBufferMaxSize) {
1907 if (missingData > plainSocket->bytesAvailable()
1908 && (!readBufferMaxSize || readBufferMaxSize >= missingData)) {
1909#ifdef QSSLSOCKET_DEBUG
1910 qCDebug(lcTlsBackendSchannel,
"We're still missing %lld bytes, will check later.",
1917 const qint64 bytesRead = readToBuffer(intermediateBuffer, plainSocket);
1918#ifdef QSSLSOCKET_DEBUG
1919 qCDebug(lcTlsBackendSchannel,
"Read %lld encrypted bytes from the socket", bytesRead);
1921 if (intermediateBuffer.length() == 0 || (hadIncompleteData && bytesRead == 0)) {
1922#ifdef QSSLSOCKET_DEBUG
1923 qCDebug(lcTlsBackendSchannel,
1924 hadIncompleteData ?
"No new data received, leaving loop!"
1925 :
"Nothing to decrypt, leaving loop!");
1929 hadIncompleteData =
false;
1930#ifdef QSSLSOCKET_DEBUG
1931 qCDebug(lcTlsBackendSchannel,
"Total amount of bytes to decrypt: %d",
1932 intermediateBuffer.length());
1935 SecBuffer dataBuffer[4]{
1936 createSecBuffer(intermediateBuffer, SECBUFFER_DATA),
1937 createSecBuffer(
nullptr, 0, SECBUFFER_EMPTY),
1938 createSecBuffer(
nullptr, 0, SECBUFFER_EMPTY),
1939 createSecBuffer(
nullptr, 0, SECBUFFER_EMPTY)
1941 SecBufferDesc message{
1943 ARRAYSIZE(dataBuffer),
1946 auto status = DecryptMessage(&contextHandle, &message, 0,
nullptr);
1947 if (status == SEC_E_OK || status == SEC_I_RENEGOTIATE || status == SEC_I_CONTEXT_EXPIRED) {
1949 if (dataBuffer[1].cbBuffer > 0) {
1953 buffer.append(
static_cast<
char *>(dataBuffer[1].pvBuffer),
1954 dataBuffer[1].cbBuffer);
1955 totalRead += dataBuffer[1].cbBuffer;
1956#ifdef QSSLSOCKET_DEBUG
1957 qCDebug(lcTlsBackendSchannel,
"Decrypted %lu bytes. New read buffer size: %d",
1958 dataBuffer[1].cbBuffer, buffer.size());
1961 if (dataBuffer[3].BufferType == SECBUFFER_EXTRA) {
1965 retainExtraData(intermediateBuffer, dataBuffer[3]);
1967 intermediateBuffer.resize(0);
1971 if (status == SEC_E_INCOMPLETE_MESSAGE) {
1972 missingData = checkIncompleteData(dataBuffer[0]);
1973#ifdef QSSLSOCKET_DEBUG
1974 qCDebug(lcTlsBackendSchannel,
"We didn't have enough data to decrypt anything, will try again!");
1977 hadIncompleteData =
true;
1978 }
else if (status == SEC_E_INVALID_HANDLE) {
1980 qCWarning(lcTlsBackendSchannel,
"The internal SSPI handle is invalid!");
1982 }
else if (status == SEC_E_INVALID_TOKEN) {
1987 setErrorAndEmit(d, QAbstractSocket::SslInternalError, schannelErrorToString(status));
1989 }
else if (status == SEC_E_MESSAGE_ALTERED) {
1993 setErrorAndEmit(d, QAbstractSocket::SslInternalError,
1994 schannelErrorToString(status));
1996 }
else if (status == SEC_E_OUT_OF_SEQUENCE) {
2002 setErrorAndEmit(d, QAbstractSocket::SslInternalError,
2003 schannelErrorToString(status));
2005 }
else if (status == SEC_E_DECRYPT_FAILURE) {
2010 setErrorAndEmit(d, QAbstractSocket::SslInternalError, schannelErrorToString(status));
2012 }
else if (status == SEC_I_CONTEXT_EXPIRED) {
2016 }
else if (status == SEC_I_RENEGOTIATE) {
2018#ifdef QSSLSOCKET_DEBUG
2019 qCDebug(lcTlsBackendSchannel,
"The peer wants to renegotiate.");
2021 schannelState = SchannelState::Renegotiate;
2022 renegotiating =
true;
2031 if (
bool *readyReadEmittedPointer = d->readyReadPointer())
2032 *readyReadEmittedPointer =
true;
2033 emit q->readyRead();
2034 emit q->channelReadyRead(0);
2042 const bool isClient = d->tlsMode() == QSslSocket::SslClientMode;
2043 DWORD shutdownToken = SCHANNEL_SHUTDOWN;
2044 SecBuffer buffer = createSecBuffer(&shutdownToken,
sizeof(DWORD), SECBUFFER_TOKEN);
2045 SecBufferDesc token{
2050 auto status = ApplyControlToken(&contextHandle, &token);
2052 if (status != SEC_E_OK) {
2053#ifdef QSSLSOCKET_DEBUG
2054 qCDebug(lcTlsBackendSchannel)
2055 <<
"Failed to apply shutdown control token:" << schannelErrorToString(status);
2060 SecBuffer outBuffers[3];
2061 outBuffers[0] = createSecBuffer(
nullptr, 0, SECBUFFER_TOKEN);
2063 outBuffers[2] = createSecBuffer(
nullptr, 0, SECBUFFER_EMPTY);
2064 auto freeBuffers = qScopeGuard([&outBuffers]() {
2065 for (
auto i = 0ull; i < ARRAYSIZE(outBuffers); i++) {
2066 if (outBuffers[i].pvBuffer)
2067 FreeContextBuffer(outBuffers[i].pvBuffer);
2070 SecBufferDesc outputBufferDesc{
2072 ARRAYSIZE(outBuffers),
2076 ULONG contextReq = getContextRequirements();
2079 status = InitializeSecurityContext(&credentialHandle,
2081 const_reinterpret_cast<SEC_WCHAR *>(targetName().utf16()),
2093 status = AcceptSecurityContext(
2105 if (status == SEC_E_OK || status == SEC_I_CONTEXT_EXPIRED) {
2106 if (!sendToken(outBuffers[0].pvBuffer, outBuffers[0].cbBuffer,
false)) {
2112#ifdef QSSLSOCKET_DEBUG
2113 qCDebug(lcTlsBackendSchannel)
2114 <<
"Failed to initialize shutdown:" << schannelErrorToString(status);
2123 auto *plainSocket = d->plainTcpSocket();
2124 Q_ASSERT(plainSocket);
2126 if (SecIsValidHandle(&contextHandle)) {
2129 if (plainSocket->state() != QAbstractSocket::UnconnectedState && q->isEncrypted()) {
2135 plainSocket->disconnectFromHost();
2141 auto *plainSocket = d->plainTcpSocket();
2142 Q_ASSERT(plainSocket);
2143 d->setEncrypted(
false);
2148 qint64 tempMax = d->maxReadBufferSize();
2149 d->setMaxReadBufferSize(0);
2151 d->setMaxReadBufferSize(tempMax);
2156 deallocateContext();
2157 freeCredentialsHandle();
2165 if (!q->isEncrypted())
2168 const auto sessionProtocol = toQtSslProtocol(connectionInfo.dwProtocol);
2170 const auto ciphers = ciphersByName(QStringView(cipherInfo.szCipherSuite));
2171 for (
const auto& cipher : ciphers) {
2172 if (cipher.protocol() == sessionProtocol)
2181 if (!q->isEncrypted())
2182 return QSsl::SslProtocol::UnknownProtocol;
2183 return toQtSslProtocol(connectionInfo.dwProtocol);
2190 auto *plainSocket = d->plainTcpSocket();
2191 Q_ASSERT(plainSocket);
2193 const bool isServer = d->tlsMode() == QSslSocket::SslServerMode;
2194 switch (schannelState) {
2195 case SchannelState::InitializeHandshake:
2196 if (!SecIsValidHandle(&credentialHandle) && !acquireCredentialsHandle()) {
2200 if (!SecIsValidHandle(&credentialHandle))
2202 if (!SecIsValidHandle(&contextHandle) && !(isServer ? acceptContext() : createContext())) {
2206 if (schannelState != SchannelState::PerformHandshake)
2209 case SchannelState::PerformHandshake:
2210 if (!performHandshake()) {
2214 if (schannelState != SchannelState::VerifyHandshake)
2217 case SchannelState::VerifyHandshake:
2220 if (!verifyHandshake()) {
2226 if (schannelState != SchannelState::Done)
2229 case SchannelState::Done:
2231 if (!q->isEncrypted()) {
2232 d->setEncrypted(
true);
2233 emit q->encrypted();
2235 renegotiating =
false;
2236 if (d->isPendingClose()) {
2237 d->setPendingClose(
false);
2243 case SchannelState::Renegotiate:
2244 if (!renegotiate()) {
2247 }
else if (intermediateBuffer.size() || plainSocket->bytesAvailable()) {
2260
2261
2264 if (sslErrors.isEmpty())
2269 const auto &configuration = q->sslConfiguration();
2270 auto *plainSocket = d->plainTcpSocket();
2272 emit q->sslErrors(sslErrors);
2274 const bool doVerifyPeer = configuration.peerVerifyMode() == QSslSocket::VerifyPeer
2275 || (configuration.peerVerifyMode() == QSslSocket::AutoVerifyPeer
2276 && d->tlsMode() == QSslSocket::SslClientMode);
2277 const bool doEmitSslError = !d->verifyErrorsHaveBeenIgnored();
2279 if (doVerifyPeer && doEmitSslError) {
2280 if (q->pauseMode() & QAbstractSocket::PauseOnSslErrors) {
2281 QSslSocketPrivate::pauseSocketNotifiers(q);
2284 setErrorAndEmit(d, QAbstractSocket::SslHandshakeFailedError,
2285 sslErrors.constFirst().errorString());
2286 plainSocket->disconnectFromHost();
2295 const QSslKey &privateKey)
2299 QDataStream stream(&buffer, QDataStream::WriteOnly);
2301 NCRYPT_PROV_HANDLE provider = 0;
2302 SECURITY_STATUS status = NCryptOpenStorageProvider(&provider, MS_KEY_STORAGE_PROVIDER, 0);
2303 if (status != SEC_E_OK) {
2304 qCWarning(lcTlsBackendSchannel())
2305 <<
"Failed to open ncrypt storage provider:" << schannelErrorToString(status);
2308 const auto freeProvider = qScopeGuard([provider]() { NCryptFreeObject(provider); });
2310 const QString certName = [certificate]() {
2311 if (
auto cn = certificate.subjectInfo(QSslCertificate::CommonName); !cn.isEmpty())
2315 QSpan<
const QChar> nameSpan(certName);
2316 NCryptBuffer nbuffer{ ULONG(nameSpan.size_bytes() +
sizeof(
char16_t)),
2317 NCRYPTBUFFER_PKCS_KEY_NAME,
2318 const_reinterpret_cast<
void *>(nameSpan.data()) };
2319 NCryptBufferDesc bufferDesc{ NCRYPTBUFFER_VERSION, 1, &nbuffer };
2320 auto *bufferDescPtr = nameSpan.isEmpty() ?
nullptr : &bufferDesc;
2321 NCRYPT_KEY_HANDLE ncryptKey = 0;
2322 status = NCryptImportKey(provider, 0, NCRYPT_PKCS8_PRIVATE_KEY_BLOB, bufferDescPtr, &ncryptKey,
2323 PBYTE(buffer.data()), buffer.size(), 0);
2324 if (status != SEC_E_OK) {
2325 qCWarning(lcTlsBackendSchannel())
2326 <<
"Failed to import private key:" << schannelErrorToString(status);
2329 const auto freeKey = qScopeGuard([ncryptKey]() { NCryptFreeObject(ncryptKey); });
2331 CERT_CONTEXT *context = PCERT_CONTEXT(certificate.handle());
2334 CRYPT_DATA_BLOB keyBlob = {
sizeof(ncryptKey), PBYTE(&ncryptKey) };
2336 CertSetCertificateContextProperty(context, CERT_NCRYPT_KEY_HANDLE_PROP_ID, 0, &keyBlob);
2338 auto error = GetLastError();
2339 if (lcTlsBackendSchannel().isWarningEnabled())
2340 qErrnoWarning(
int(error),
"Failed to set ncrypt handle property.");
2344 CRYPT_KEY_PROV_INFO provInfo{
2345 const_reinterpret_cast<LPWSTR>(certName.constData()),
2346 const_cast<LPWSTR>(MS_KEY_STORAGE_PROVIDER),
2348 CERT_SET_KEY_PROV_HANDLE_PROP_ID | CERT_SET_KEY_CONTEXT_PROP_ID,
2353 ok = CertSetCertificateContextProperty(context, CERT_KEY_PROV_INFO_PROP_ID,
2354 CERT_SET_PROPERTY_INHIBIT_PERSIST_FLAG, &provInfo);
2356 auto error = GetLastError();
2357 if (lcTlsBackendSchannel().isWarningEnabled())
2358 qErrnoWarning(
int(error),
"Failed to set key provider info property.");
2368 const auto &configuration = q->sslConfiguration();
2370 auto createStoreFromCertificateChain = [](
const QList<QSslCertificate> certChain,
const QSslKey &privateKey) {
2371 const wchar_t *passphrase = L"";
2373 QByteArray pkcs12 = _q_makePkcs12(certChain,
2375 QString::fromWCharArray(passphrase, 0));
2376 CRYPT_DATA_BLOB pfxBlob;
2377 pfxBlob.cbData = DWORD(pkcs12.length());
2378 pfxBlob.pbData =
reinterpret_cast<
unsigned char *>(pkcs12.data());
2381 constexpr DWORD flags = PKCS12_ALWAYS_CNG_KSP | PKCS12_NO_PERSIST_KEY;
2382 return QHCertStorePointer(PFXImportCertStore(&pfxBlob, passphrase, flags));
2385 if (!configuration.localCertificateChain().isEmpty()) {
2386 if (configuration.privateKey().isNull()) {
2387 setErrorAndEmit(d, QAbstractSocket::SslInvalidUserDataError,
2388 QSslSocket::tr(
"Cannot provide a certificate with no key"));
2391 if (localCertificateStore ==
nullptr) {
2392 localCertificateStore =
2393 createStoreFromCertificateChain(configuration.localCertificateChain(), {});
2394 if (localCertificateStore) {
2395 const CERT_CONTEXT *certificateContext = CertFindCertificateInStore(
2396 localCertificateStore.get(), X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, 0,
2397 CERT_FIND_ANY,
nullptr,
nullptr);
2398 if (certificateContext) {
2399 auto *backend = QTlsBackend::backend<X509CertificateSchannel>(
2400 configuration.localCertificate());
2401 backend->certificateContext.reset(
2402 CertDuplicateCertificateContext(certificateContext));
2405 BOOL mustFree = FALSE;
2406 NCRYPT_KEY_HANDLE testKey = 0;
2407 BOOL ok = CryptAcquireCertificatePrivateKey(
2408 certificateContext, CRYPT_ACQUIRE_ONLY_NCRYPT_KEY_FLAG,
nullptr,
2409 &testKey, &keySpec, &mustFree);
2411 NCryptFreeObject(testKey);
2413 attachPrivateKeyToCertificate(configuration.localCertificate(),
2414 configuration.privateKey());
2418 qCWarning(lcTlsBackendSchannel,
"Failed to load certificate chain!");
2423 if (!configuration.caCertificates().isEmpty() && !caCertificateStore) {
2424 caCertificateStore = createStoreFromCertificateChain(configuration.caCertificates(),
2431 Q_ASSERT(certContext);
2435 const bool isClient = d->tlsMode() == QSslSocket::SslClientMode;
2439 auto tempCertCollection =
QHCertStorePointer(CertOpenStore(CERT_STORE_PROV_COLLECTION,
2442 CERT_STORE_CREATE_NEW_FLAG,
2444 if (!tempCertCollection) {
2445#ifdef QSSLSOCKET_DEBUG
2446 qCWarning(lcTlsBackendSchannel,
"Failed to create certificate store collection!");
2451 if (rootCertOnDemandLoadingAllowed()) {
2457 CertOpenStore(CERT_STORE_PROV_SYSTEM, 0, 0,
2458 CERT_STORE_READONLY_FLAG | CERT_SYSTEM_STORE_CURRENT_USER, L"ROOT"));
2461#ifdef QSSLSOCKET_DEBUG
2462 qCWarning(lcTlsBackendSchannel,
"Failed to open the system root CA certificate store!");
2465 }
else if (!CertAddStoreToCollection(tempCertCollection.get(), rootStore.get(), 0, 1)) {
2466#ifdef QSSLSOCKET_DEBUG
2467 qCWarning(lcTlsBackendSchannel,
2468 "Failed to add the system root CA certificate store to the certificate store "
2474 if (caCertificateStore) {
2475 if (!CertAddStoreToCollection(tempCertCollection.get(), caCertificateStore.get(), 0, 1)) {
2476#ifdef QSSLSOCKET_DEBUG
2477 qCWarning(lcTlsBackendSchannel,
2478 "Failed to add the user's CA certificate store to the certificate store "
2485 if (!CertAddStoreToCollection(tempCertCollection.get(), certContext->hCertStore, 0, 0)) {
2486#ifdef QSSLSOCKET_DEBUG
2487 qCWarning(lcTlsBackendSchannel,
2488 "Failed to add certificate's origin store to the certificate store collection!");
2493 CERT_CHAIN_PARA parameters;
2494 ZeroMemory(¶meters,
sizeof(parameters));
2495 parameters.cbSize =
sizeof(CERT_CHAIN_PARA);
2496 parameters.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
2497 parameters.RequestedUsage.Usage.cUsageIdentifier = 1;
2498 LPSTR oid = LPSTR(isClient ? szOID_PKIX_KP_SERVER_AUTH
2499 : szOID_PKIX_KP_CLIENT_AUTH);
2500 parameters.RequestedUsage.Usage.rgpszUsageIdentifier = &oid;
2502 QTlsBackend::clearPeerCertificates(d);
2503 const CERT_CHAIN_CONTEXT *chainContext =
nullptr;
2504 auto freeCertChain = qScopeGuard([&chainContext]() {
2506 CertFreeCertificateChain(chainContext);
2508 BOOL status = CertGetCertificateChain(
nullptr,
2511 tempCertCollection.get(),
2513 CERT_CHAIN_REVOCATION_CHECK_CHAIN_EXCLUDE_ROOT,
2517 if (status == FALSE || !chainContext || chainContext->cChain == 0) {
2518 QSslError error(QSslError::UnableToVerifyFirstCertificate);
2520 emit q->peerVerifyError(error);
2521 return q->state() == QAbstractSocket::ConnectedState;
2525 static auto getCertificateFromChainElement = [](CERT_CHAIN_ELEMENT *element) {
2527 return QSslCertificate();
2529 const CERT_CONTEXT *certContext = element->pCertContext;
2530 return QTlsPrivate::X509CertificateSchannel::QSslCertificate_from_CERT_CONTEXT(certContext);
2536 CERT_SIMPLE_CHAIN *chain = chainContext->rgpChain[chainContext->cChain - 1];
2538 if (chain->TrustStatus.dwErrorStatus & CERT_TRUST_IS_PARTIAL_CHAIN) {
2539 auto error = QSslError(QSslError::SslError::UnableToGetIssuerCertificate,
2540 getCertificateFromChainElement(chain->rgpElement[chain->cElement - 1]));
2542 emit q->peerVerifyError(error);
2543 if (q->state() != QAbstractSocket::ConnectedState)
2546 if (chain->TrustStatus.dwErrorStatus & CERT_TRUST_INVALID_BASIC_CONSTRAINTS) {
2550 auto error = QSslError(QSslError::PathLengthExceeded);
2552 emit q->peerVerifyError(error);
2553 if (q->state() != QAbstractSocket::ConnectedState)
2556 static const DWORD leftoverCertChainErrorMask = CERT_TRUST_IS_CYCLIC | CERT_TRUST_INVALID_EXTENSION
2557 | CERT_TRUST_INVALID_POLICY_CONSTRAINTS | CERT_TRUST_INVALID_NAME_CONSTRAINTS
2558 | CERT_TRUST_CTL_IS_NOT_TIME_VALID | CERT_TRUST_CTL_IS_NOT_SIGNATURE_VALID
2559 | CERT_TRUST_CTL_IS_NOT_VALID_FOR_USAGE;
2560 if (chain->TrustStatus.dwErrorStatus & leftoverCertChainErrorMask) {
2561 auto error = QSslError(QSslError::SslError::UnspecifiedError);
2563 emit q->peerVerifyError(error);
2564 if (q->state() != QAbstractSocket::ConnectedState)
2568 DWORD verifyDepth = chain->cElement;
2569 if (q->peerVerifyDepth() > 0 && DWORD(q->peerVerifyDepth()) < verifyDepth)
2570 verifyDepth = DWORD(q->peerVerifyDepth());
2572 const auto &caCertificates = q->sslConfiguration().caCertificates();
2574 if (!rootCertOnDemandLoadingAllowed()
2575 && !(chain->TrustStatus.dwErrorStatus & CERT_TRUST_IS_PARTIAL_CHAIN)
2576 && (q->peerVerifyMode() == QSslSocket::VerifyPeer
2577 || (isClient && q->peerVerifyMode() == QSslSocket::AutoVerifyPeer))) {
2583 CERT_CHAIN_ELEMENT *element = chain->rgpElement[chain->cElement - 1];
2584 QSslCertificate certificate = getCertificateFromChainElement(element);
2585 if (!caCertificates.contains(certificate)) {
2586 auto error = QSslError(QSslError::CertificateUntrusted, certificate);
2588 emit q->peerVerifyError(error);
2589 if (q->state() != QAbstractSocket::ConnectedState)
2594 QList<QSslCertificate> peerCertificateChain;
2595 for (DWORD i = 0; i < verifyDepth; i++) {
2596 CERT_CHAIN_ELEMENT *element = chain->rgpElement[i];
2597 QSslCertificate certificate = getCertificateFromChainElement(element);
2598 if (certificate.isNull()) {
2599 const auto &previousCert = !peerCertificateChain.isEmpty() ? peerCertificateChain.last()
2600 : QSslCertificate();
2601 auto error = QSslError(QSslError::SslError::UnableToGetIssuerCertificate, previousCert);
2603 emit q->peerVerifyError(error);
2604 if (previousCert.isNull() || q->state() != QAbstractSocket::ConnectedState)
2607 const QList<QSslCertificateExtension> extensions = certificate.extensions();
2609#ifdef QSSLSOCKET_DEBUG
2610 qCDebug(lcTlsBackendSchannel) <<
"issuer:" << certificate.issuerDisplayName()
2611 <<
"\nsubject:" << certificate.subjectDisplayName()
2612 <<
"\nQSslCertificate info:" << certificate
2613 <<
"\nextended error info:" << element->pwszExtendedErrorInfo
2614 <<
"\nerror status:" << element->TrustStatus.dwErrorStatus;
2617 peerCertificateChain.append(certificate);
2618 QTlsBackend::storePeerCertificateChain(d, peerCertificateChain);
2620 if (certificate.isBlacklisted()) {
2621 const auto error = QSslError(QSslError::CertificateBlacklisted, certificate);
2623 emit q->peerVerifyError(error);
2624 if (q->state() != QAbstractSocket::ConnectedState)
2628 LONG result = CertVerifyTimeValidity(
nullptr , element->pCertContext->pCertInfo);
2630 auto error = QSslError(result == -1 ? QSslError::CertificateNotYetValid
2631 : QSslError::CertificateExpired,
2634 emit q->peerVerifyError(error);
2635 if (q->state() != QAbstractSocket::ConnectedState)
2640 if (element->TrustStatus.dwErrorStatus & CERT_TRUST_IS_NOT_TIME_VALID) {
2642 Q_ASSERT(!sslErrors.isEmpty());
2644 if (element->TrustStatus.dwErrorStatus & CERT_TRUST_IS_REVOKED) {
2645 auto error = QSslError(QSslError::CertificateRevoked, certificate);
2647 emit q->peerVerifyError(error);
2648 if (q->state() != QAbstractSocket::ConnectedState)
2651 if (element->TrustStatus.dwErrorStatus & CERT_TRUST_IS_NOT_SIGNATURE_VALID) {
2652 auto error = QSslError(QSslError::CertificateSignatureFailed, certificate);
2654 emit q->peerVerifyError(error);
2655 if (q->state() != QAbstractSocket::ConnectedState)
2662 if (netscapeWrongCertType(extensions, isClient, i == 0))
2663 element->TrustStatus.dwErrorStatus |= CERT_TRUST_IS_NOT_VALID_FOR_USAGE;
2665 if (element->TrustStatus.dwErrorStatus & CERT_TRUST_IS_NOT_VALID_FOR_USAGE) {
2666 auto error = QSslError(QSslError::InvalidPurpose, certificate);
2668 emit q->peerVerifyError(error);
2669 if (q->state() != QAbstractSocket::ConnectedState)
2672 if (element->TrustStatus.dwErrorStatus & CERT_TRUST_IS_UNTRUSTED_ROOT) {
2674 const bool isTrustedRoot = caCertificates.contains(certificate);
2675 if (!isTrustedRoot) {
2676 auto error = QSslError(QSslError::CertificateUntrusted, certificate);
2678 emit q->peerVerifyError(error);
2679 if (q->state() != QAbstractSocket::ConnectedState)
2683 static const DWORD certRevocationCheckUnavailableError = CERT_TRUST_IS_OFFLINE_REVOCATION
2684 | CERT_TRUST_REVOCATION_STATUS_UNKNOWN;
2685 if (element->TrustStatus.dwErrorStatus & certRevocationCheckUnavailableError) {
2690 static const DWORD leftoverCertErrorMask = CERT_TRUST_IS_CYCLIC
2691 | CERT_TRUST_INVALID_EXTENSION | CERT_TRUST_INVALID_NAME_CONSTRAINTS
2692 | CERT_TRUST_INVALID_POLICY_CONSTRAINTS
2693 | CERT_TRUST_HAS_EXCLUDED_NAME_CONSTRAINT
2694 | CERT_TRUST_HAS_NOT_SUPPORTED_CRITICAL_EXT
2695 | CERT_TRUST_HAS_NOT_DEFINED_NAME_CONSTRAINT
2696 | CERT_TRUST_HAS_NOT_PERMITTED_NAME_CONSTRAINT
2697 | CERT_TRUST_HAS_NOT_SUPPORTED_NAME_CONSTRAINT;
2698 if (element->TrustStatus.dwErrorStatus & leftoverCertErrorMask) {
2699 auto error = QSslError(QSslError::UnspecifiedError, certificate);
2701 emit q->peerVerifyError(error);
2702 if (q->state() != QAbstractSocket::ConnectedState)
2705 if (element->TrustStatus.dwErrorStatus & CERT_TRUST_INVALID_BASIC_CONSTRAINTS) {
2706 auto it = std::find_if(extensions.cbegin(), extensions.cend(),
2707 [](
const QSslCertificateExtension &extension) {
2708 return extension.name() ==
"basicConstraints"_L1;
2710 if (it != extensions.cend()) {
2714 QVariantMap basicConstraints = it->value().toMap();
2716 if (i > 0 && !basicConstraints.value(
"ca"_L1,
false).toBool())
2717 error = QSslError(QSslError::InvalidPurpose, certificate);
2719 error = QSslError(QSslError::PathLengthExceeded, certificate);
2721 emit q->peerVerifyError(error);
2722 if (q->state() != QAbstractSocket::ConnectedState)
2726 if (element->TrustStatus.dwErrorStatus & CERT_TRUST_IS_EXPLICIT_DISTRUST) {
2727 auto error = QSslError(QSslError::CertificateBlacklisted, certificate);
2729 emit q->peerVerifyError(error);
2730 if (q->state() != QAbstractSocket::ConnectedState)
2734 if (element->TrustStatus.dwInfoStatus & CERT_TRUST_IS_SELF_SIGNED) {
2739 const bool isRootCertificateAuthority = isCertificateAuthority(extensions)
2740 || certificate.version() ==
"1";
2743 if (!isRootCertificateAuthority) {
2744 auto error = QSslError(QSslError::SelfSignedCertificate, certificate);
2746 emit q->peerVerifyError(error);
2747 if (q->state() != QAbstractSocket::ConnectedState)
2753 if (!peerCertificateChain.isEmpty())
2754 QTlsBackend::storePeerCertificate(d, peerCertificateChain.constFirst());
2756 const auto &configuration = q->sslConfiguration();
2758 const bool doVerifyPeer = q->peerVerifyMode() == QSslSocket::VerifyPeer
2759 || (q->peerVerifyMode() == QSslSocket::AutoVerifyPeer
2760 && d->tlsMode() == QSslSocket::SslClientMode);
2764 if (!configuration.peerCertificate().isNull()) {
2767 if (d->tlsMode() == QSslSocket::SslClientMode) {
2768 const auto verificationPeerName = d->verificationName();
2769 const QString peerName(verificationPeerName.isEmpty() ? q->peerName() : verificationPeerName);
2770 if (!isMatchingHostname(configuration.peerCertificate(), peerName)) {
2772 const QSslError error(QSslError::HostNameMismatch, configuration.peerCertificate());
2774 emit q->peerVerifyError(error);
2775 if (q->state() != QAbstractSocket::ConnectedState)
2779 }
else if (doVerifyPeer) {
2782 const QSslError error(QSslError::NoPeerCertificate);
2784 emit q->peerVerifyError(error);
2785 if (q->state() != QAbstractSocket::ConnectedState)
2795 return d->isRootsOnDemandAllowed() && QSslSocketPrivate::rootCertOnDemandLoadingSupported();
void startClientEncryption() override
void disconnected() override
void continueHandshake() override
void init(QSslSocket *q, QSslSocketPrivate *d) override
void startServerEncryption() override
QSsl::SslProtocol sessionProtocol() const override
void disconnectFromHost() override
~TlsCryptographSchannel()
bool hasUndecryptedData() const override
QSslCipher sessionCipher() const override
QList< QSslError > tlsErrors() const override
Q_DISABLE_COPY_MOVE(X509CertificateSchannel)
Combined button and popup list for selecting options.
Namespace containing onternal types that TLS backends implement.
QT_WARNING_PUSH QT_WARNING_DISABLE_DEPRECATED std::array< SchannelCipherInfo, 44 > schannelCipherInfo
QList< QSslCipher > defaultCiphers()
UNICODE_STRING cbcChainingMode
QList< CRYPTO_SETTINGS > cryptoSettingsForCiphers(const QList< QSslCipher > &ciphers)
bool containsTls13Cipher(const QList< QSslCipher > &ciphers)
UNICODE_STRING gcmChainingMode
QList< QSslCipher > ciphersByName(QStringView schannelSuiteName)
static void attachPrivateKeyToCertificate(const QSslCertificate &certificate, const QSslKey &privateKey)
Q_LOGGING_CATEGORY(lcEventDispatcher, "qt.eventdispatcher")
Q_GLOBAL_STATIC(QReadWriteLock, g_updateMutex)
#define SP_PROT_TLS1_0_SERVER
#define SP_PROT_TLS1_1_SERVER
#define SP_PROT_TLS1_2_SERVER
#define BCRYPT_ECDSA_ALGORITHM
#define SP_PROT_TLS1_3_SERVER
#define MAP_PROTOCOL(sp_protocol, q_protocol)
#define CHECK_STATUS(status)
#define CHECK_ATTRIBUTE(attributeName)
#define DEBUG_WARN(message)
QByteArray _q_makePkcs12(const QList< QSslCertificate > &certs, const QSslKey &key, const QString &passPhrase)
#define SP_PROT_TLS1_1_CLIENT
#define SP_PROT_TLS1_SERVER
QAsn1Element _q_PKCS12_key(const QSslKey &key)
#define BCRYPT_ECDH_ALGORITHM
#define SP_PROT_TLS1_3_CLIENT
#define SEC_E_APPLICATION_PROTOCOL_MISMATCH
#define SP_PROT_TLS1_CLIENT
#define SP_PROT_TLS1_0_CLIENT
#define SP_PROT_TLS1_2_CLIENT
std::unique_ptr< void, QHCertStoreDeleter > QHCertStorePointer
const char * authenticationMethod
const char * schannelCipherSuite
QList< QSsl::SslProtocol > protocols
const char * encryptionMethod
const char * openSslCipherSuite
const char * keyExchangeMethod