Implement dynamic DLL resolution of NativeShims for .NET 4.7 x86/x64 architectures

[DennisDyallo]

Description

Quote: @romerod

Current Behavior
When the library is used in a project compiled with AnyCPU which is compiled on a x64 bit system the applications fails with a BadImageFormatException on 32bit PC as the Yubico.NativeShims.dll in the build output folder is the x64 version. The same thing happens when setting the Prefer32Bit flag.

The Yubico.NativeShims.targets file in the Yubico.NativeShims nuget package copies the file over depending of the architecture of the build system.

Expected Behavior
When a project is build with AnyCPU the build output should contain the x86 and the x64 bit of the dll, and the dll to load should be detected on runtime.

Fixes include:

• Implementing dynamic DLL resolution based on process architecture (x86/x64)

Fixes: #151

Type of change

• Refactor (non-breaking change which improves code quality or performance)
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How has this been tested?

I built a NET47 32 bit application according to the #151 issue and reproduced the bug. Loaded the SDK dlls into that application and proceeded testing and fixing.

Test configuration:

• OS version: Windows 11
• Firmware version: 5.4.3
• Yubikey model¹: 5C

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have run dotnet format to format my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

Footnotes

1. See Yubikey models (Multi-protocol, Security Key, FIPS, Bio, YubiHSM, YubiHSM FIPS) ↩

[github-actions]

Test Results: Windows

    2 files      2 suites   4s ⏱️
3 703 tests 3 703 ✅ 0 💤 0 ❌
3 705 runs  3 705 ✅ 0 💤 0 ❌

Results for commit 211a94c.

♻️ This comment has been updated with latest results.

[github-actions]

Test Results: Ubuntu

    2 files      2 suites   9s ⏱️
3 695 tests 3 695 ✅ 0 💤 0 ❌
3 697 runs  3 697 ✅ 0 💤 0 ❌

Results for commit 211a94c.

♻️ This comment has been updated with latest results.

[github-actions]

Test Results: MacOS

    2 files      2 suites   4s ⏱️
3 695 tests 3 695 ✅ 0 💤 0 ❌
3 697 runs  3 697 ✅ 0 💤 0 ❌

Results for commit 211a94c.

♻️ This comment has been updated with latest results.

[GregDomzalski]

Just two final thoughts - otherwise looks good to me.

[github-actions]

Package	Line Rate	Branch Rate	Complexity	Health
Yubico.Core	43%	32%	4221	➖
Yubico.YubiKey	50%	47%	19158	➖
Summary	49% (32194 / 66075)	44% (8197 / 18585)	23379	➖

Minimum allowed line rate is 40%

[GregDomzalski]

OK, ok - two last foods for thought. Take it if you like the idea.

Instead of #if !NET47 around the entire Libraries.cs file, let's scope it down to just the internal const string definition.

We can get rid of the EnsureInitialized method in the non NET47 file altogether, if we put an #if NET47 around the static NativeMethods() method decl in NativeMethods.cs.

I dunno. You're call. I think it's also fine as is. 😄

Consider this my sign-off.