// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/40284755): Remove this and spanify to fix the errors.
#pragma allow_unsafe_buffers
#endif
#include "net/ssl/ssl_platform_key_win.h"
#include <string>
#include <vector>
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "crypto/scoped_capi_types.h"
#include "crypto/scoped_cng_types.h"
#include "crypto/unexportable_key.h"
#include "net/base/features.h"
#include "net/cert/x509_certificate.h"
#include "net/ssl/ssl_private_key.h"
#include "net/ssl/ssl_private_key_test_util.h"
#include "net/test/cert_test_util.h"
#include "net/test/test_data_directory.h"
#include "net/test/test_with_task_environment.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/boringssl/src/include/openssl/bn.h"
#include "third_party/boringssl/src/include/openssl/bytestring.h"
#include "third_party/boringssl/src/include/openssl/ec.h"
#include "third_party/boringssl/src/include/openssl/ec_key.h"
#include "third_party/boringssl/src/include/openssl/evp.h"
#include "third_party/boringssl/src/include/openssl/mem.h"
#include "third_party/boringssl/src/include/openssl/rsa.h"
#include "third_party/boringssl/src/include/openssl/ssl.h"
namespace net {
namespace {
struct TestKey {
const char* name;
const char* cert_file;
const char* key_file;
int type;
};
const TestKey kTestKeys[] = {
{.name = "RSA",
.cert_file = "client_1.pem",
.key_file = "client_1.pk8",
.type = EVP_PKEY_RSA},
{.name = "P256",
.cert_file = "client_4.pem",
.key_file = "client_4.pk8",
.type = EVP_PKEY_EC},
{.name = "P384",
.cert_file = "client_5.pem",
.key_file = "client_5.pk8",
.type = EVP_PKEY_EC},
{.name = "P521",
.cert_file = "client_6.pem",
.key_file = "client_6.pk8",
.type = EVP_PKEY_EC},
{.name = "RSA1024",
.cert_file = "client_7.pem",
.key_file = "client_7.pk8",
.type = EVP_PKEY_RSA},
};
std::string TestParamsToString(const testing::TestParamInfo<TestKey>& params) {
return params.param.name;
}
// Appends |bn| to |cbb|, represented as |len| bytes in little-endian order,
// zero-padded as needed. Returns true on success and false if |len| is too
// small.
bool AddBIGNUMLittleEndian(CBB* cbb, const BIGNUM* bn, size_t len) {
uint8_t* ptr;
return CBB_add_space(cbb, &ptr, len) && BN_bn2le_padded(ptr, len, bn);
}
// Converts the PKCS#8 PrivateKeyInfo structure serialized in |pkcs8| to a
// private key BLOB, suitable for import with CAPI using Microsoft Base
// Cryptographic Provider.
bool PKCS8ToBLOBForCAPI(const std::string& pkcs8, std::vector<uint8_t>* blob) {
CBS cbs;
CBS_init(&cbs, reinterpret_cast<const uint8_t*>(pkcs8.data()), pkcs8.size());
bssl::UniquePtr<EVP_PKEY> key(EVP_parse_private_key(&cbs));
if (!key || CBS_len(&cbs) != 0 || EVP_PKEY_id(key.get()) != EVP_PKEY_RSA)
return false;
const RSA* rsa = EVP_PKEY_get0_RSA(key.get());
// See
// https://msdn.microsoft.com/en-us/library/windows/desktop/aa375601(v=vs.85).aspx
PUBLICKEYSTRUC header = {0};
header.bType = PRIVATEKEYBLOB;
header.bVersion = 2;
header.aiKeyAlg = CALG_RSA_SIGN;
RSAPUBKEY rsapubkey = {0};
rsapubkey.magic = 0x32415352;
rsapubkey.bitlen = RSA_bits(rsa);
rsapubkey.pubexp = BN_get_word(RSA_get0_e(rsa));
uint8_t* blob_data;
size_t blob_len;
bssl::ScopedCBB cbb;
if (!CBB_init(cbb.get(), sizeof(header) + sizeof(rsapubkey) + pkcs8.size()) ||
!CBB_add_bytes(cbb.get(), reinterpret_cast<const uint8_t*>(&header),
sizeof(header)) ||
!CBB_add_bytes(cbb.get(), reinterpret_cast<const uint8_t*>(&rsapubkey),
sizeof(rsapubkey)) ||
!AddBIGNUMLittleEndian(cbb.get(), RSA_get0_n(rsa),
rsapubkey.bitlen / 8) ||
!AddBIGNUMLittleEndian(cbb.get(), RSA_get0_p(rsa),
rsapubkey.bitlen / 16) ||
!AddBIGNUMLittleEndian(cbb.get(), RSA_get0_q(rsa),
rsapubkey.bitlen / 16) ||
!AddBIGNUMLittleEndian(cbb.get(), RSA_get0_dmp1(rsa),
rsapubkey.bitlen / 16) ||
!AddBIGNUMLittleEndian(cbb.get(), RSA_get0_dmq1(rsa),
rsapubkey.bitlen / 16) ||
!AddBIGNUMLittleEndian(cbb.get(), RSA_get0_iqmp(rsa),
rsapubkey.bitlen / 16) ||
!AddBIGNUMLittleEndian(cbb.get(), RSA_get0_d(rsa),
rsapubkey.bitlen / 8) ||
!CBB_finish(cbb.get(), &blob_data, &blob_len)) {
return false;
}
blob->assign(blob_data, blob_data + blob_len);
OPENSSL_free(blob_data);
return true;
}
// Appends |bn| to |cbb|, represented as |len| bytes in big-endian order,
// zero-padded as needed. Returns true on success and false if |len| is too
// small.
bool AddBIGNUMBigEndian(CBB* cbb, const BIGNUM* bn, size_t len) {
uint8_t* ptr;
return CBB_add_space(cbb, &ptr, len) && BN_bn2bin_padded(ptr, len, bn);
}
// Converts the PKCS#8 PrivateKeyInfo structure serialized in |pkcs8| to a
// private key BLOB, suitable for import with CNG using the Microsoft Software
// KSP, and sets |*blob_type| to the type of the BLOB.
bool PKCS8ToBLOBForCNG(const std::string& pkcs8,
LPCWSTR* blob_type,
std::vector<uint8_t>* blob) {
CBS cbs;
CBS_init(&cbs, reinterpret_cast<const uint8_t*>(pkcs8.data()), pkcs8.size());
bssl::UniquePtr<EVP_PKEY> key(EVP_parse_private_key(&cbs));
if (!key || CBS_len(&cbs) != 0)
return false;
if (EVP_PKEY_id(key.get()) == EVP_PKEY_RSA) {
// See
// https://msdn.microsoft.com/en-us/library/windows/desktop/aa375531(v=vs.85).aspx.
const RSA* rsa = EVP_PKEY_get0_RSA(key.get());
BCRYPT_RSAKEY_BLOB header = {0};
header.Magic = BCRYPT_RSAFULLPRIVATE_MAGIC;
header.BitLength = RSA_bits(rsa);
header.cbPublicExp = BN_num_bytes(RSA_get0_e(rsa));
header.cbModulus = BN_num_bytes(RSA_get0_n(rsa));
header.cbPrime1 = BN_num_bytes(RSA_get0_p(rsa));
header.cbPrime2 = BN_num_bytes(RSA_get0_q(rsa));
uint8_t* blob_data;
size_t blob_len;
bssl::ScopedCBB cbb;
if (!CBB_init(cbb.get(), sizeof(header) + pkcs8.size()) ||
!CBB_add_bytes(cbb.get(), reinterpret_cast<const uint8_t*>(&header),
sizeof(header)) ||
!AddBIGNUMBigEndian(cbb.get(), RSA_get0_e(rsa), header.cbPublicExp) ||
!AddBIGNUMBigEndian(cbb.get(), RSA_get0_n(rsa), header.cbModulus) ||
!AddBIGNUMBigEndian(cbb.get(), RSA_get0_p(rsa), header.cbPrime1) ||
!AddBIGNUMBigEndian(cbb.get(), RSA_get0_q(rsa), header.cbPrime2) ||
!AddBIGNUMBigEndian(cbb.get(), RSA_get0_dmp1(rsa), header.cbPrime1) ||
!AddBIGNUMBigEndian(cbb.get(), RSA_get0_dmq1(rsa), header.cbPrime2) ||
!AddBIGNUMBigEndian(cbb.get(), RSA_get0_iqmp(rsa), header.cbPrime1) ||
!AddBIGNUMBigEndian(cbb.get(), RSA_get0_d(rsa), header.cbModulus) ||
!CBB_finish(cbb.get(), &blob_data, &blob_len)) {
return false;
}
*blob_type = BCRYPT_RSAFULLPRIVATE_BLOB;
blob->assign(blob_data, blob_data + blob_len);
OPENSSL_free(blob_data);
return true;
}
if (EVP_PKEY_id(key.get()) == EVP_PKEY_EC) {
// See
// https://msdn.microsoft.com/en-us/library/windows/desktop/aa375520(v=vs.85).aspx.
const EC_KEY* ec_key = EVP_PKEY_get0_EC_KEY(key.get());
const EC_GROUP* group = EC_KEY_get0_group(ec_key);
bssl::UniquePtr<BIGNUM> x(BN_new());
bssl::UniquePtr<BIGNUM> y(BN_new());
if (!EC_POINT_get_affine_coordinates_GFp(
group, EC_KEY_get0_public_key(ec_key), x.get(), y.get(), nullptr)) {
return false;
}
BCRYPT_ECCKEY_BLOB header = {0};
switch (EC_GROUP_get_curve_name(EC_KEY_get0_group(ec_key))) {
case NID_X9_62_prime256v1:
header.dwMagic = BCRYPT_ECDSA_PRIVATE_P256_MAGIC;
break;
case NID_secp384r1:
header.dwMagic = BCRYPT_ECDSA_PRIVATE_P384_MAGIC;
break;
case NID_secp521r1:
header.dwMagic = BCRYPT_ECDSA_PRIVATE_P521_MAGIC;
break;
default:
return false;
}
header.cbKey = BN_num_bytes(EC_GROUP_get0_order(group));
uint8_t* blob_data;
size_t blob_len;
bssl::ScopedCBB cbb;
if (!CBB_init(cbb.get(), sizeof(header) + header.cbKey * 3) ||
!CBB_add_bytes(cbb.get(), reinterpret_cast<const uint8_t*>(&header),
sizeof(header)) ||
!AddBIGNUMBigEndian(cbb.get(), x.get(), header.cbKey) ||
!AddBIGNUMBigEndian(cbb.get(), y.get(), header.cbKey) ||
!AddBIGNUMBigEndian(cbb.get(), EC_KEY_get0_private_key(ec_key),
header.cbKey) ||
!CBB_finish(cbb.get(), &blob_data, &blob_len)) {
return false;
}
*blob_type = BCRYPT_ECCPRIVATE_BLOB;
blob->assign(blob_data, blob_data + blob_len);
OPENSSL_free(blob_data);
return true;
}
return false;
}
} // namespace
class SSLPlatformKeyWinTest
: public testing::TestWithParam<TestKey>,
public WithTaskEnvironment {
public:
const TestKey& GetTestKey() const { return GetParam(); }
};
TEST_P(SSLPlatformKeyWinTest, KeyMatchesCNG) {
const TestKey& test_key = GetTestKey();
// Load test data.
scoped_refptr<X509Certificate> cert =
ImportCertFromFile(GetTestCertsDirectory(), test_key.cert_file);
ASSERT_TRUE(cert);
std::string pkcs8;
base::FilePath pkcs8_path =
GetTestCertsDirectory().AppendASCII(test_key.key_file);
ASSERT_TRUE(base::ReadFileToString(pkcs8_path, &pkcs8));
// Import the key into CNG. Per MSDN's documentation on NCryptImportKey, if a
// key name is not supplied (via the pParameterList parameter for the BLOB
// types we use), the Microsoft Software KSP will treat the key as ephemeral.
//
// https://msdn.microsoft.com/en-us/library/windows/desktop/aa376276(v=vs.85).aspx
crypto::ScopedNCryptProvider prov;
SECURITY_STATUS status = NCryptOpenStorageProvider(
crypto::ScopedNCryptProvider::Receiver(prov).get(),
MS_KEY_STORAGE_PROVIDER, 0);
ASSERT_FALSE(FAILED(status)) << status;
LPCWSTR blob_type;
std::vector<uint8_t> blob;
ASSERT_TRUE(PKCS8ToBLOBForCNG(pkcs8, &blob_type, &blob));
crypto::ScopedNCryptKey ncrypt_key;
status = NCryptImportKey(prov.get(), /*hImportKey=*/0, blob_type,
/*pParameterList=*/nullptr,
crypto::ScopedNCryptKey::Receiver(ncrypt_key).get(),
blob.data(), blob.size(), NCRYPT_SILENT_FLAG);
ASSERT_FALSE(FAILED(status)) << status;
scoped_refptr<SSLPrivateKey> key =
WrapCNGPrivateKey(cert.get(), std::move(ncrypt_key));
ASSERT_TRUE(key);
EXPECT_EQ(SSLPrivateKey::DefaultAlgorithmPreferences(test_key.type,
/*supports_pss=*/true),
key->GetAlgorithmPreferences());
TestSSLPrivateKeyMatches(key.get(), pkcs8);
}
TEST_P(SSLPlatformKeyWinTest, KeyMatchesCAPI) {
const TestKey& test_key = GetTestKey();
if (test_key.type != EVP_PKEY_RSA) {
GTEST_SKIP() << "CAPI only supports RSA keys";
}
// Load test data.
scoped_refptr<X509Certificate> cert =
ImportCertFromFile(GetTestCertsDirectory(), test_key.cert_file);
ASSERT_TRUE(cert);
std::string pkcs8;
base::FilePath pkcs8_path =
GetTestCertsDirectory().AppendASCII(test_key.key_file);
ASSERT_TRUE(base::ReadFileToString(pkcs8_path, &pkcs8));
// Import the key into CAPI. Use CRYPT_VERIFYCONTEXT for an ephemeral key.
crypto::ScopedHCRYPTPROV prov;
ASSERT_NE(FALSE,
CryptAcquireContext(crypto::ScopedHCRYPTPROV::Receiver(prov).get(),
nullptr, nullptr, PROV_RSA_AES,
CRYPT_VERIFYCONTEXT | CRYPT_SILENT))
<< GetLastError();
std::vector<uint8_t> blob;
ASSERT_TRUE(PKCS8ToBLOBForCAPI(pkcs8, &blob));
crypto::ScopedHCRYPTKEY hcryptkey;
ASSERT_NE(FALSE,
CryptImportKey(prov.get(), blob.data(), blob.size(),
/*hPubKey=*/0, /*dwFlags=*/0,
crypto::ScopedHCRYPTKEY::Receiver(hcryptkey).get()))
<< GetLastError();
// Release |hcryptkey| so it does not outlive |prov|.
hcryptkey.reset();
scoped_refptr<SSLPrivateKey> key =
WrapCAPIPrivateKey(cert.get(), std::move(prov), AT_SIGNATURE);
ASSERT_TRUE(key);
std::vector<uint16_t> expected = {
SSL_SIGN_RSA_PKCS1_SHA256,
SSL_SIGN_RSA_PKCS1_SHA384,
SSL_SIGN_RSA_PKCS1_SHA512,
SSL_SIGN_RSA_PKCS1_SHA1,
};
EXPECT_EQ(expected, key->GetAlgorithmPreferences());
TestSSLPrivateKeyMatches(key.get(), pkcs8);
}
INSTANTIATE_TEST_SUITE_P(All,
SSLPlatformKeyWinTest,
testing::ValuesIn(kTestKeys),
TestParamsToString);
TEST(UnexportableSSLPlatformKeyWinTest, WrapUnexportableKeySlowly) {
auto provider = crypto::GetUnexportableKeyProvider({});
if (!provider) {
GTEST_SKIP() << "Hardware-backed keys are not supported.";
}
const crypto::SignatureVerifier::SignatureAlgorithm algorithms[] = {
crypto::SignatureVerifier::SignatureAlgorithm::ECDSA_SHA256,
crypto::SignatureVerifier::SignatureAlgorithm::RSA_PKCS1_SHA256};
auto key = provider->GenerateSigningKeySlowly(algorithms);
if (!key) {
// Could be hitting crbug.com/41494935. Fine to skip the test as the
// UnexportableKeyProvider logic is covered in another test suite.
GTEST_SKIP()
<< "Workaround for https://issues.chromium.org/issues/41494935";
}
auto ssl_private_key = WrapUnexportableKeySlowly(*key);
ASSERT_TRUE(ssl_private_key);
}
} // namespace net
Codebase Browser
chromium