Skip to content
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

Fixing 3212 and cleaning-up technical debt #3213

Merged
merged 3 commits into from
Jan 23, 2025
Merged

Fixing 3212 and cleaning-up technical debt #3213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98f1c07
Fixing 3212 and cleaning-up technical debt
jmprieur Jan 23, 2025
1d41c34
Addressing PR feedback
jmprieur Jan 23, 2025
510a8b7
Update version
jmprieur Jan 23, 2025
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
4 changes: 2 additions & 2 deletions Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<PropertyGroup>
<!--This should be passed from the VSTS build-->
<!-- This needs to be greater than or equal to the validation baseline version -->
<MicrosoftIdentityWebVersion Condition="'$(MicrosoftIdentityWebVersion)' == ''">3.2.3</MicrosoftIdentityWebVersion>
<MicrosoftIdentityWebVersion Condition="'$(MicrosoftIdentityWebVersion)' == ''">3.6.2</MicrosoftIdentityWebVersion>
<!--This will generate AssemblyVersion, AssemblyFileVersion and AssemblyInformationVersion-->
<Version>$(MicrosoftIdentityWebVersion)</Version>

Expand Down Expand Up @@ -96,7 +96,7 @@
<MicrosoftGraphVersion>4.36.0</MicrosoftGraphVersion>
<MicrosoftGraphBetaVersion>4.57.0-preview</MicrosoftGraphBetaVersion>
<MicrosoftExtensionsHttpVersion>3.1.3</MicrosoftExtensionsHttpVersion>
<MicrosoftIdentityAbstractionsVersion>7.2.1</MicrosoftIdentityAbstractionsVersion>
<MicrosoftIdentityAbstractionsVersion>8.0.0</MicrosoftIdentityAbstractionsVersion>
<!--CVE-2024-43485-->
<SystemTextJsonVersion>8.0.5</SystemTextJsonVersion>
<!--CVE-2023-29331-->
Expand Down
25 changes: 1 addition & 24 deletions src/Microsoft.Identity.Web.Certificate/CertificateDescription.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,12 @@ public CertificateDescription()
/// </summary>
/// <param name="credentialDescription"></param>
public CertificateDescription(CredentialDescription credentialDescription)
: base(credentialDescription)
{
_ = Throws.IfNull(credentialDescription);

// TODO: Check credentialDescription is really a cert
SourceType = (CertificateSource)credentialDescription.SourceType;
Container = credentialDescription.Container;
Certificate = credentialDescription.Certificate;
ReferenceOrValue = credentialDescription.ReferenceOrValue;
}

/// <summary>
Expand Down Expand Up @@ -160,26 +158,6 @@ public static CertificateDescription FromStoreWithDistinguishedName(

// Should Container and ReferenceOrValue be moved to
// the tests (As extension methods)

#region Backwards compatibilty with 1.x
/// <summary>
/// <inheritdoc/>.
/// </summary>
internal new string? Container
{
get { return base.Container; }
set { base.Container = value; }
}

/// <summary>
/// <inheritdoc/>.
/// </summary>
internal new string? ReferenceOrValue
{
get { return base.ReferenceOrValue; }
set { base.ReferenceOrValue = value; }
}

/// <summary>
/// <inheritdoc/>.
/// </summary>
Expand All @@ -197,6 +175,5 @@ public static CertificateDescription FromStoreWithDistinguishedName(
get { return (CertificateSource)base.SourceType; }
set { base.SourceType = (CredentialSource)value; }
}
#endregion
}
}
10 changes: 1 addition & 9 deletions tests/Microsoft.Identity.Web.Test/Certificates/CertificateDescriptionTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ public void TestFromKeyVault(string keyVaultUrl, string certificateName)
{
CertificateDescription certificateDescription = CertificateDescription.FromKeyVault(keyVaultUrl, certificateName);
Assert.Equal(CertificateSource.KeyVault, certificateDescription.SourceType);
Assert.Equal(keyVaultUrl, certificateDescription.Container);
Assert.Equal(certificateName, certificateDescription.ReferenceOrValue);
Assert.Equal(keyVaultUrl, certificateDescription.KeyVaultUrl);
Assert.Equal(certificateName, certificateDescription.KeyVaultCertificateName);
Assert.Equal(keyVaultUrl, certificateDescription.KeyVaultUrl);
#if NET462
Expand All @@ -33,8 +32,6 @@ public void TestFromPath(string certificatePath, string password)
{
CertificateDescription certificateDescription = CertificateDescription.FromPath(certificatePath, password);
Assert.Equal(CertificateSource.Path, certificateDescription.SourceType);
Assert.Equal(certificatePath, certificateDescription.Container);
Assert.Equal(password, certificateDescription.ReferenceOrValue);
Assert.Equal(certificatePath, certificateDescription.CertificateDiskPath);
Assert.Equal(password, certificateDescription.CertificatePassword);
}
Expand All @@ -45,7 +42,6 @@ public void TestFromBase64Encoded(string base64Encoded)
{
CertificateDescription certificateDescription = CertificateDescription.FromBase64Encoded(base64Encoded);
Assert.Equal(CertificateSource.Base64Encoded, certificateDescription.SourceType);
Assert.Equal(base64Encoded, certificateDescription.ReferenceOrValue);
Assert.Equal(base64Encoded, certificateDescription.Base64EncodedValue);
}

Expand All @@ -56,8 +52,6 @@ public void TestFromCertificateDistinguishedName(string certificateDistinguished
CertificateDescription certificateDescription =
CertificateDescription.FromStoreWithDistinguishedName(certificateDistinguishedName, storeLocation, storeName);
Assert.Equal(CertificateSource.StoreWithDistinguishedName, certificateDescription.SourceType);
Assert.Equal($"{storeLocation}/{storeName}", certificateDescription.Container);
Assert.Equal(certificateDistinguishedName, certificateDescription.ReferenceOrValue);
Assert.Equal(certificateDistinguishedName, certificateDescription.CertificateDistinguishedName);
Assert.Equal($"{storeLocation}/{storeName}", certificateDescription.CertificateStorePath);
}
Expand All @@ -69,8 +63,6 @@ public void TestFromStoreWithThumbprint(string certificateThumbprint, StoreLocat
CertificateDescription certificateDescription =
CertificateDescription.FromStoreWithThumbprint(certificateThumbprint, storeLocation, storeName);
Assert.Equal(CertificateSource.StoreWithThumbprint, certificateDescription.SourceType);
Assert.Equal($"{storeLocation}/{storeName}", certificateDescription.Container);
Assert.Equal(certificateThumbprint, certificateDescription.ReferenceOrValue);
Assert.Equal($"{storeLocation}/{storeName}", certificateDescription.CertificateStorePath);
Assert.Equal(certificateThumbprint, certificateDescription.CertificateThumbprint);
}
Expand Down
56 changes: 7 additions & 49 deletions tests/Microsoft.Identity.Web.Test/Certificates/DefaultCertificateLoaderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,47 +55,22 @@ public void TestDefaultCertificateLoader(CertificateSource certificateSource, st
Assert.NotNull(certificateDescription.Certificate);
}

#pragma warning disable xUnit1012 // Null should only be used for nullable parameters
[InlineData(CertificateSource.Base64Encoded, null, TestConstants.CertificateX5c)]
#pragma warning restore xUnit1012 // Null should only be used for nullable parameters
[Theory]
public void TestLoadFirstCertificate(
CertificateSource certificateSource,
string container,
string referenceOrValue)
[Fact]
public void TestLoadFirstCertificate()
{
IEnumerable<CertificateDescription> certDescriptions = CreateCertificateDescriptions(
certificateSource,
container,
referenceOrValue);

IEnumerable<CertificateDescription> certDescriptions = [CertificateDescription.FromBase64Encoded(TestConstants.CertificateX5c)];
X509Certificate2? certificate = DefaultCertificateLoader.LoadFirstCertificate(certDescriptions);

Assert.NotNull(certificate);
Assert.Equal("CN=ACS2ClientCertificate", certificate.Issuer);
}

#pragma warning disable xUnit1012 // Null should only be used for nullable parameters
[InlineData(CertificateSource.Base64Encoded, null, TestConstants.CertificateX5c)]
#pragma warning restore xUnit1012 // Null should only be used for nullable parameters
[Theory]
public void TestLoadAllCertificates(
CertificateSource certificateSource,
string container,
string referenceOrValue)
[Fact]
public void TestLoadAllCertificates()
{
List<CertificateDescription> certDescriptions = CreateCertificateDescriptions(
certificateSource,
container,
referenceOrValue).ToList();

certDescriptions.Add(new CertificateDescription
{
SourceType = certificateSource,
Container = container,
ReferenceOrValue = referenceOrValue,
});
List<CertificateDescription> certDescriptions = [CertificateDescription.FromBase64Encoded(TestConstants.CertificateX5c)];

certDescriptions.Add(CertificateDescription.FromBase64Encoded(TestConstants.CertificateX5c));
certDescriptions.Add(CertificateDescription.FromCertificate(null!));

IEnumerable<X509Certificate2?> certificates = DefaultCertificateLoader.LoadAllCertificates(certDescriptions);
Expand Down Expand Up @@ -135,22 +110,5 @@ public void TestLoadCertificateWithPrivateKey(
Assert.NotNull(certificateDescription.Certificate);
Assert.True(certificateDescription.Certificate.HasPrivateKey);
}

private IEnumerable<CertificateDescription> CreateCertificateDescriptions(
CertificateSource certificateSource,
string container,
string referenceOrValue)
{
List<CertificateDescription> certificateDescription = new List<CertificateDescription>();

certificateDescription.Add(new CertificateDescription
{
SourceType = certificateSource,
Container = container,
ReferenceOrValue = referenceOrValue,
});

return certificateDescription;
}
}
}
Loading