Create new X509CertificateLoader by bartonjs · Pull Request #102167 · dotnet/runtime

bartonjs · 2024-05-13T19:21:19Z

The new certificate loader only loads one data type per method, unlike the previous loader mechanism (new X509Certiicate2(bytes, ...)). It also allows for caller configuration to control cost-of-work limits and some common usability gotchas around Windows PFX loading.

This change adds the new loader, and changes the X509Certificate2 ctors to use it; a followup will mark the ctors as Obsolete and update usage in the dotnet/runtime codebase.

Contributes to #91763.

The new certificate loader only loads one data type per method, unlike the previous loader mechanism (new X509Certiicate2(bytes, ...)). It also allows for caller configuration to control cost-of-work limits and some common usability gotchas around Windows PFX loading. This change adds the new loader, and changes the X509Certificate2 ctors to use it; a followup will mark the ctors as Obsolete and update usage in the dotnet/runtime codebase.

ghost · 2024-05-13T19:21:28Z

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

src/libraries/Common/src/System/IO/MemoryMappedFiles/MemoryMappedFileMemoryManager.cs

stephentoub · 2024-05-13T21:07:35Z

src/libraries/Common/src/System/Security/Cryptography/X509Certificates/Pkcs12LoaderLimits.cs

+            set
+            {
+                if (value < 0)
+                    throw new ArgumentOutOfRangeException(nameof(value), SR.ArgumentOutOfRange_NeedNonNegNum);


Earlier an ifdef was used to use ObjectDisposedException.ThrowIf if it's available. I assume we're not doing so here with AOORE just because there are a bunch of them and it'd be abnoxious?

That was the reason, yeah; but looking at it now in this file it's just repeating a negative check, so making a helper seems reasonable (it'll get re-used)

How "amusing"... I updated every instance except the one this comment was on. Fixed locally now.

stephentoub · 2024-05-13T21:25:56Z

...ies/Common/src/System/Security/Cryptography/X509Certificates/X509CertificateLoader.Pkcs12.cs

+                    {
+                        if (!pfxAsn.VerifyMac(password, authSafeContents))
+                        {
+                            password = password.ContainsNull() ? "".AsSpan() : default;


I'm not clear on the reasoning here. If it contains null we make it non-null and if it doesn't contain null we make it null?

Yep. From the API perspective null and empty are the same thing, but from the algorithm perspective they're different. So if we got null, try again with empty, and if we got empty, try again with null.

vcsjones

What I have so far. Scrollbar says I have a ways to go still.

src/libraries/Common/src/System/IO/MemoryMappedFiles/MemoryMappedFileMemoryManager.cs

src/libraries/Common/src/System/Security/Cryptography/Helpers.cs

src/libraries/Common/src/System/Security/Cryptography/PasswordBasedEncryption.cs

src/libraries/Microsoft.Bcl.Cryptography/src/System/Security/Cryptography/NetStandardShims.cs

...soft.Bcl.Cryptography/src/System/Security/Cryptography/PbeEncryptionAlgorithm.netstandard.cs

...ies/Microsoft.Bcl.Cryptography/src/System/Security/Cryptography/PbeParameters.netstandard.cs

src/libraries/Microsoft.Bcl.Cryptography/tests/X509Certificates/TestData.cs

...em.Security.Cryptography/src/System/Security/Cryptography/X509Certificates/StorePal.macOS.cs

...yptography/src/System/Security/Cryptography/X509Certificates/X509Certificate.LegacyLimits.cs

...ptography/src/System/Security/Cryptography/X509Certificates/X509CertificateLoader.OpenSsl.cs

src/libraries/System.Security.Cryptography/tests/X509Certificates/CertLoaderTests.cs

src/libraries/System.Security.Cryptography/tests/X509Certificates/CollectionImportTests.cs

src/libraries/System.Security.Cryptography/tests/X509Certificates/CtorTests.cs

...ies/Common/tests/System/Security/Cryptography/X509Certificates/X509CertificateLoaderTests.cs

...ryptography/src/System/Security/Cryptography/X509Certificates/X509CertificateLoader.macOS.cs

...Cryptography/src/System/Security/Cryptography/X509Certificates/X509CertificateLoader.Unix.cs

vcsjones · 2024-06-23T14:39:16Z

/azp run runtime-androidemulator

azure-pipelines · 2024-06-23T14:39:29Z

Azure Pipelines successfully started running 1 pipeline(s).

bartonjs · 2024-06-24T18:14:00Z

/azp run runtime-androidemulator

azure-pipelines · 2024-06-24T18:14:09Z

Azure Pipelines successfully started running 1 pipeline(s).

bartonjs · 2024-06-24T21:50:14Z

/azp run runtime-androidemulator

azure-pipelines · 2024-06-24T21:50:25Z

Azure Pipelines successfully started running 1 pipeline(s).

vcsjones · 2024-06-25T19:53:55Z

/azp run runtime-ioslikesimulator

azure-pipelines · 2024-06-25T19:54:09Z

Azure Pipelines successfully started running 1 pipeline(s).

pavelsavara · 2024-06-26T08:45:46Z

this is preventing code flow into azdo internal repo because the security scanner detects credentials.

 ! [remote rejected]         main -> main (VS403654: The push was rejected because it contains one or more secrets.

Resolve the following secrets before pushing again. For help, see https://aka.ms/1ESSecretScanning.

Secrets:

commit: d4fe4a7e987584bfa4904dd1027a873029b2005d
paths:
/src/libraries/Common/tests/System/Security/Cryptography/X509Certificates/TestData.cs(2710,1-26) : SEC101/013 : PemPrivateKey
/src/libraries/Common/tests/System/Security/Cryptography/X509Certificates/TestData.cs(2723,1-26) : SEC101/013 : PemPrivateKey
/src/libraries/Common/tests/System/Security/Cryptography/X509Certificates/TestData.cs(2745,1-29) : SEC101/013 : PemPrivateKey
/src/libraries/Common/tests/System/Security/Cryptography/X509Certificates/TestData.cs(2752,1-30) : SEC101/013 : PemPrivateKey
/src/libraries/Common/tests/System/Security/Cryptography/X509Certificates/TestData.cs(2802,1-26) : SEC101/013 : PemPrivateKey
/src/libraries/Common/tests/System/Security/Cryptography/X509Certificates/TestData.cs(2881,1-30) : SEC101/013 : PemPrivateKey
/src/libraries/Common/tests/System/Security/Cryptography/X509Certificates/TestData.cs(2964,1-26) : SEC101/013 : PemPrivateKey
/src/libraries/Common/tests/System/Security/Cryptography/X509Certificates/TestData.cs(57,149-13) : SEC101/055 : Pkcs12PrivateKey
/src/libraries/Common/tests/System/Security/Cryptography/X509Certificates/TestData.cs(1476,41-55) : SEC101/055 : Pkcs12PrivateKey
/src/libraries/Common/tests/System/Security/Cryptography/X509Certificates/TestData.cs(3443,13-26) : SEC101/055 : Pkcs12PrivateKey)

See also #104021

bartonjs · 2024-09-12T23:55:44Z

Breaking change docs written. dotnet/docs#42613

bartonjs added the area-System.Security label May 13, 2024

bartonjs added this to the 9.0.0 milestone May 13, 2024

bartonjs self-assigned this May 13, 2024

ghost added the new-api-needs-documentation label May 13, 2024

stephentoub reviewed May 13, 2024

View reviewed changes

src/libraries/Common/src/System/IO/MemoryMappedFiles/MemoryMappedFileMemoryManager.cs Outdated Show resolved Hide resolved

stephentoub reviewed May 13, 2024

View reviewed changes

vcsjones reviewed May 13, 2024

View reviewed changes

build-analysis bot mentioned this pull request May 13, 2024

System.IO.Net5Compat.Tests and System.IO.Tests suddenly exiting with error 137 #100558

Closed

vcsjones reviewed May 14, 2024

View reviewed changes

vcsjones reviewed May 15, 2024

View reviewed changes

bartonjs added 4 commits May 15, 2024 12:52

Apply mechanical review feedback

f41eae5

Respond to further feedback

c704627

Merge remote-tracking branch 'dotnet/main' into x509loader

04091d1

Finish moving/unifying the TestData file

2753a11

Add more DisabledOnBrowser attributes

e58c076

vcsjones reviewed Jun 18, 2024

View reviewed changes

...ryptography/src/System/Security/Cryptography/X509Certificates/X509CertificateLoader.macOS.cs Show resolved Hide resolved

vcsjones reviewed Jun 18, 2024

View reviewed changes

...Cryptography/src/System/Security/Cryptography/X509Certificates/X509CertificateLoader.Unix.cs Outdated Show resolved Hide resolved

bartonjs added 3 commits June 18, 2024 15:13

Apply further feedback

f1cab83

Complete the move to TempFileHolder

b3e18c8

Fix handling of DSA keys in cert loader on macOS

e45cf60

This was referenced Jun 19, 2024

Test failure WindowsAlternateDataStreamOverwrite #83659

Open

The Operation will be canceled. The next steps may not contain expected logs. dotnet/dnceng#3008

Open

LibraryTests (mostly) timing out #103674

Closed

Prevent Android PKCS7 content sniffing in X509 load

cbcf611

build-analysis bot mentioned this pull request Jun 24, 2024

The "RestoreTask" task returned false but did not log an error dotnet/dnceng#3100

Closed

3 tasks

Use lax reading in Android content filter

dce56f4

This was referenced Jun 25, 2024

Build failure: Static graph-based restore failed with exit code .* but did not log an error. #103526

Closed

Build failure: Static graph-based restore failed with exit code .* but did not log an error. dotnet/dnceng#3139

Closed

vcsjones approved these changes Jun 25, 2024

View reviewed changes

bartonjs merged commit d4fe4a7 into dotnet:main Jun 25, 2024

bartonjs deleted the x509loader branch June 25, 2024 22:10

adamsitnik mentioned this pull request Jun 26, 2024

[Android] PlatformNotSupported failures inside System.Net.Security.Tests #104010

Closed

This was referenced Jun 26, 2024

[Android][arm] Algorithm 'RC2' not supported on Android causing failures in X509Certificates tests #104030

Closed

[apple] TvOS/MacCatalyst/iOSSimulator X509Certificates failures during AppleCrypto interop #104161

Closed

ellahathaway mentioned this pull request Jul 8, 2024

Update Source-Build SDK Diff Tests Baselines and Exclusions dotnet/sdk#41929

Merged

ViktorHofer mentioned this pull request Jul 15, 2024

Don't use obsolete X509Certificate2 ctor on .NET 9.0 dotnet/arcade#14935

Closed

matouskozak mentioned this pull request Jul 23, 2024

[Android] Arm32 Android running out of memory at PfxIterationCountTests_X509Certificate2 tests #105325

Closed

github-actions bot locked and limited conversation to collaborators Jul 27, 2024

bartonjs added the cryptographic-docs-impact Issues impacting cryptographic docs. Cleared and reused after documentation is updated each release. label Aug 15, 2024

bartonjs added the breaking-change Issue or PR that represents a breaking API or functional change over a previous release. label Sep 12, 2024

dotnet-policy-service bot added the needs-breaking-change-doc-created Breaking changes need an issue opened with https://github.com/dotnet/docs/issues/new?template=dotnet label Sep 12, 2024

bartonjs removed the needs-breaking-change-doc-created Breaking changes need an issue opened with https://github.com/dotnet/docs/issues/new?template=dotnet label Sep 12, 2024

bartonjs added the tracking This issue is tracking the completion of other related issues. label Oct 22, 2024

Conversation

bartonjs commented May 13, 2024

Uh oh!

ghost commented May 13, 2024

Uh oh!

Uh oh!

stephentoub May 13, 2024

Choose a reason for hiding this comment

Uh oh!

bartonjs May 13, 2024

Choose a reason for hiding this comment

Uh oh!

bartonjs May 15, 2024

Choose a reason for hiding this comment

Uh oh!

stephentoub May 13, 2024

Choose a reason for hiding this comment

Uh oh!

bartonjs May 13, 2024

Choose a reason for hiding this comment

Uh oh!

vcsjones left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vcsjones commented Jun 23, 2024

Uh oh!

azure-pipelines bot commented Jun 23, 2024

Uh oh!

bartonjs commented Jun 24, 2024

Uh oh!

azure-pipelines bot commented Jun 24, 2024

Uh oh!

bartonjs commented Jun 24, 2024

Uh oh!

azure-pipelines bot commented Jun 24, 2024

Uh oh!

vcsjones commented Jun 25, 2024

Uh oh!

azure-pipelines bot commented Jun 25, 2024

Uh oh!

pavelsavara commented Jun 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bartonjs commented Sep 12, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

pavelsavara commented Jun 26, 2024 •

edited

Loading