Skip to content

ClientCertificateCredential: better exception message for unsupported file extensions #5197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
antkmsft merged 8 commits into from
Nov 28, 2023
Merged

ClientCertificateCredential: better exception message for unsupported file extensions #5197

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6604e99
Cert Cred: better exception message for unsupported file extensions
antkmsft Nov 27, 2023
71ed7bc
fix spelling
antkmsft Nov 27, 2023
19f1c50
Make it better
antkmsft Nov 27, 2023
c54bf51
Empty path case
antkmsft Nov 27, 2023
1d988f0
Merge branch 'main' into pfx-error
antkmsft Nov 27, 2023
1665df3
Merge branch 'main' into pfx-error
antkmsft Nov 27, 2023
1feca2e
Merge branch 'main' into pfx-error
antkmsft Nov 28, 2023
91db9c0
adfs
antkmsft Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 24 additions & 6 deletions sdk/identity/azure-identity/src/client_certificate_credential.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
#include <azure/core/base64.hpp>
#include <azure/core/datetime.hpp>
#include <azure/core/internal/cryptography/sha_hash.hpp>
#include <azure/core/internal/strings.hpp>
#include <azure/core/io/body_stream.hpp>
#include <azure/core/platform.hpp>
#include <azure/core/uuid.hpp>
Expand Down Expand Up @@ -399,16 +400,33 @@ ClientCertificateCredential::ClientCertificateCredential(
CertificateThumbprint mdVec;
try
{
if (clientCertificatePath.empty())
{
throw AuthenticationException("Certificate file path is empty.");
}
Comment thread
antkmsft marked this conversation as resolved.

using Azure::Core::_internal::StringExtensions;
std::string const PemExtension = ".pem";
auto const certFileExtensionStart = clientCertificatePath.find_last_of('.');
auto const certFileExtension = certFileExtensionStart != std::string::npos
? clientCertificatePath.substr(certFileExtensionStart)
: std::string{};
Comment thread
antkmsft marked this conversation as resolved.

if (!StringExtensions::LocaleInvariantCaseInsensitiveEqual(certFileExtension, PemExtension))
{
throw AuthenticationException(
"Certificate format"
+ (certFileExtension.empty() ? " " : " ('" + certFileExtension + "') ")
+ "is not supported. Please convert your certificate to '" + PemExtension + "'.");
}

std::tie(mdVec, m_pkey) = ReadPemCertificate(clientCertificatePath);
}
catch (AuthenticationException&)
{
throw;
}
catch (std::exception& e)
catch (std::exception const& e)
{
// WIL does not throw AuthenticationException.
Comment thread
antkmsft marked this conversation as resolved.
throw AuthenticationException(e.what());
throw AuthenticationException(
std::string("Identity: ClientCertificateCredential: ") + e.what());
}

// Get thumbprint as hex string:
Expand Down
71 changes: 71 additions & 0 deletions sdk/identity/azure-identity/test/ut/client_certificate_credential_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,77 @@ TEST_P(GetCredentialName, )
EXPECT_EQ(cred.GetCredentialName(), "ClientCertificateCredential");
}

TEST(ClientCertificateCredential, UnsupportedExtension)
{
try
{
ClientCertificateCredential const cred(
"01234567-89ab-cdef-fedc-ba8976543210", "fedcba98-7654-3210-0123-456789abcdef", "file.pfx");

EXPECT_TRUE(
!"ClientCertificateCredential with unsupported extension (.pfx) is supposed to throw.");
Comment thread
antkmsft marked this conversation as resolved.
}
catch (Azure::Core::Credentials::AuthenticationException const& ex)
{
EXPECT_EQ(
ex.what(),
std::string("Identity: ClientCertificateCredential: "
"Certificate format ('.pfx') is not supported. "
"Please convert your certificate to '.pem'."));
}

try
{
ClientCertificateCredential const cred(
"01234567-89ab-cdef-fedc-ba8976543210",
"fedcba98-7654-3210-0123-456789abcdef",
"file.cert");

EXPECT_TRUE(
!"ClientCertificateCredential with unsupported extension (.cert) is supposed to throw.");
}
catch (Azure::Core::Credentials::AuthenticationException const& ex)
{
EXPECT_EQ(
ex.what(),
std::string("Identity: ClientCertificateCredential: "
"Certificate format ('.cert') is not supported. "
"Please convert your certificate to '.pem'."));
}

try
{
ClientCertificateCredential const cred(
"01234567-89ab-cdef-fedc-ba8976543210",
"fedcba98-7654-3210-0123-456789abcdef",
"noextension");

EXPECT_TRUE(!"ClientCertificateCredential without an extension is supposed to throw.");
}
catch (Azure::Core::Credentials::AuthenticationException const& ex)
{
EXPECT_EQ(
ex.what(),
std::string("Identity: ClientCertificateCredential: "
"Certificate format is not supported. "
"Please convert your certificate to '.pem'."));
}

try
{
ClientCertificateCredential const cred(
"01234567-89ab-cdef-fedc-ba8976543210", "fedcba98-7654-3210-0123-456789abcdef", "");

EXPECT_TRUE(!"ClientCertificateCredential with an empty path is supposed to throw.");
}
catch (Azure::Core::Credentials::AuthenticationException const& ex)
{
EXPECT_EQ(
ex.what(),
std::string("Identity: ClientCertificateCredential: Certificate file path is empty."));
}
}

TEST(ClientCertificateCredential, GetOptionsFromEnvironment)
{
{
Expand Down