CSharp Wrapper Improvements #8946

gojimmypi · 2025-07-01T04:18:17Z

Description

Summary: CSharp Wrapper Improvements

This PR enhances the C# wrapper and improves cross-platform compatibility, developer experience, and debugging support when using wolfSSL with .NET applications.

CSharp Wrapper Enhancements

New Structs and Functions
- Added WOLFSSL_ALERT and WOLFSSL_ALERT_HISTORY structs to expose alert-level history to .NET apps.
- Added new public method get_alert_history() in C# to retrieve and display alert codes/levels from the native wolfSSL context.
Improved Path Detection
- Dynamically searches for the certs folder in parent directories to better support different working directories across Windows and Linux.
Sample Application Improvements
- Enhanced logging and diagnostics in:
  - wolfSSL-TLS-Client
  - wolfSSL-TLS-PSK-Client
  - wolfSSL-TLS-Server
- Added constant definitions for SERVER_NAME, SERVER_PORT, and cipher suite selection.
- Introduced a new Visual Studio solution: wolfSSL_CSharp-Clients.sln to support concurrent client/server projects.
Documentation Updates
- Updated README.md with:
  - Troubleshooting for pwsh.exe not recognized
  - Architecture mismatch errors (AnyCPU vs. x64)
  - Best practices for setting startup projects and debugging

Compatibility Improvements

Replaced #warning with #pragma message when compiling with MSVC (_MSC_VER) to prevent build interruptions.
Added Visual Studio 2015+ specific suppression for enum-type mismatch warnings (C5287) around wc_static_assert.
Updated the XINET_PTON macro to cast to PCWSTR or PCSTR based on Visual Studio version for better Windows API compliance.

Dynamic DLL Loading

Added wolfssl.LoadDLL() to locate and load wolfssl.dll at runtime.
Searches common subdirectories (e.g. Debug, Debug\\x64) when not found in the working directory.
Added SetVerbosity(true) for diagnostic output about the load process, DLL size, and timestamp.

Improved Path Resolution

setPath() now recursively searches parent directories for a certs folder.
Added platform-specific logging to help identify missing files or incorrect paths.

Verbose Debug Mode

New global flag in the C# wrapper enables detailed output for:
- DLL discovery
- Certificate path detection
- Wrapper initialization behavior

Alert History & Diagnostics

Sample clients now retrieve and print TLS alert history after handshake failures using get_alert_history().
Improves post-failure analysis for SSL/TLS issues.

Other Fixes

Initialized unassigned local variables (keyTypeTemp, keySizeTemp) to eliminate compiler warnings.
Minor cleanup of whitespace, formatting, and redundant logic across several files.

MSVC Compatibility Enhancements

Replaced #warning with #pragma message(...) for MSVC (_MSC_VER) to suppress noisy or incompatible warnings during build:

#ifndef WOLFSSL_IGNORE_FILE_WARN
    #if defined(_MSC_VER)
        #pragma message("file.c does not need to be compiled separately from ssl.c")
    #else
        #warning file.c does not need to be compiled separately from ssl.c
    #endif
#endif

Fixes zd# n/a

Testing

How did you test?

Manually tested in VS2022, VS2008

Checklist

added tests
updated/added doxygen
updated appropriate READMEs
Updated manual and documentation

gojimmypi · 2025-07-01T13:10:17Z

Jenkins retest this please.

For missing results, SSL_read input error -308, error state on socket

devin-ai-integration · 2025-07-01T19:37:12Z

🛟 Devin Lifeguard found 1 likely issues in this PR

check-all-return-codes snippet snippet: Capture the bool returned by wolfssl.LoadDLL("") in the client and server files and abort or report an error when it is false, e.g. if (!wolfssl.LoadDLL("")) { Console.WriteLine("DLL load failed"); return; }.

@gojimmypi
please take a look at the above issues which Devin flagged. Devin will not fix these issues automatically.

wrapper/CSharp/wolfSSL_CSharp/wolfSSL.cs

Copilot

Pull Request Overview

This PR enhances the C# wolfSSL wrapper with dynamic DLL loading, improved path detection, verbose logging, and TLS alert history retrieval; adds a new Visual Studio solution for concurrent client/server projects; and applies MSVC compatibility fixes across native code.

Added SetVerbosity, LoadDLL, recursive setPath, and alert history support in wolfSSL.cs
Introduced WOLFSSL_ALERT, WOLFSSL_ALERT_HISTORY, and get_alert_history binding
Created wolfSSL_CSharp-Clients.sln and updated documentation for cross-platform builds
Replaced #warning with #pragma message for MSVC in multiple native source headers

Reviewed Changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
wrapper/CSharp/wolfSSL_CSharp/wolfSSL.cs	Added verbose DLL loading, path search, alert history API
wrapper/CSharp/wolfSSL_CSharp/wolfCrypt.cs	Updated comments on CPU architecture matching
wrapper/CSharp/wolfSSL_CSharp-Clients.sln	New solution for concurrent client/server samples
wrapper/CSharp/README.md	Expanded build and troubleshooting instructions
wrapper/CSharp/include.am	Added new solution to distribution list
wolfssl/wolfio.h	Updated `XINET_PTON` macro for MSVC version casting
wolfssl/wolfcrypt/sp.h	Adjusted typedef condition for older MSVC
wolfssl/error-ssl.h	Wrapped `wc_static_assert` in MSVC warning suppression
wolfcrypt/src/.c, src/.c	Replaced `#warning` with `#pragma message` for MSVC builds

Comments suppressed due to low confidence (1)

wrapper/CSharp/wolfSSL_CSharp/wolfSSL.cs:81

Invalid C# preprocessor directive #pragma "Only DEBUG and RELEASE supported". In C#, use #error or #warning for conditional compilation messages, or update to a supported directive to avoid build errors.

#pragma "Only DEBUG and RELEASE supported"

wrapper/CSharp/wolfSSL_CSharp/wolfSSL.cs

gojimmypi · 2025-07-02T20:28:21Z

@dgarske @JacobBarthelmeh sorry for the delay, I ended up down a rabbit hole & should be done by the end of the day.

I've implemented a new StringToAnsiPtr and I'm converting callbacks from

public static void standard_log(int lvl, StringBuilder msg)

to

public static void standard_log(int lvl, IntPtr msg) {

gojimmypi · 2025-07-02T23:31:54Z

@dgarske @JacobBarthelmeh This PR has changed substantially since submitted. I've left the new changes in a separate commit for now.

I've addressed the compile issues for CE, but I have been still unable to figure out how to run native C wolfSSL in any of the CE emulators with the wolfSSL_CSharp C# wrapper class.

@dgarske please test on customer hardware. Thank you.

devin-ai-integration · 2025-07-02T23:32:36Z

🛟 Devin Lifeguard found 1 likely issues in this PR

do-not-change-external-apis snippet: Re-introduce the original delegate (loggingCb with StringBuilder msg) and add a new one (e.g., loggingCbEx) that uses IntPtr; keep the old overloads that accept the original delegate and internally marshal to the new implementation.

@gojimmypi
please take a look at the above issues which Devin flagged. Devin will not fix these issues automatically.

devin-ai-integration · 2025-07-03T18:40:21Z

🛟 Devin Lifeguard found 2 likely issues in this PR

do-not-change-external-apis snippet: Restore the original get_ciphers(StringBuilder …) overload and introduce a new overload (e.g. get_ciphers_ex(string …)), having the old method call the new one internally so existing user code keeps compiling.
no-memory-leaks snippet: After the call sequence that uses sniHostName, add Marshal.FreeHGlobal(sniHostName); (inside a finally block) to release the unmanaged memory allocated by wolfssl.StringToAnsiPtr.

@gojimmypi
please take a look at the above issues which Devin flagged. Devin will not fix these issues automatically.

dgarske

Running tests on customer hardware now. Please remove the .c/.h use of WindowsCE... it never existed and don't add a new construct. If needed use compiler provided _WIN32_WCE

dgarske · 2025-07-03T18:52:30Z

IDE/WIN/user_settings.h

 #error This user_settings.h header is only designed for Windows
 #endif

+/* Optional WindowsCE, needed here for all CE configurations:


Remove this

dgarske · 2025-07-03T18:53:31Z

wolfssl/wolfio.h

            #define XINET_PTON(a,b,c)   InetPton((a),(b),(c))
        #else
-            #define XINET_PTON(a,b,c)   InetPton((a),(PCWSTR)(b),(c))
+            #if (defined(_MSC_VER) && (_MSC_VER >= 1600)) || defined(WindowsCE)


Remove || defined(WindowsCE) or use the existing _WIN32_WCE instead...

Without WindowsCE, the _WIN32_WCE is not automatically assigned for me, and I see these compile-time warnings:

2>c:\workspace\wolfssl-gojimmypi\src\ssl.c(1928) : warning C4133: 'function' : incompatible types - from 'PCSTR' to 'PCWSTR' 2>c:\workspace\wolfssl-gojimmypi\src\ssl.c(22180) : warning C4133: 'function' : incompatible types - from 'const char *' to 'PCWSTR'

I've removed the WindowsCE and added explicit known CE macros:

#if (defined(_MSC_VER) && (_MSC_VER >= 1600)) || \ defined(_WIN32_WCE) || defined(WINCE) || defined(PocketPC) #define XINET_PTON(a,b,c) InetPton((a),(PCWSTR)(b),(c)) #else #define XINET_PTON(a,b,c) InetPton((a),(PCSTR)(b),(c)) #endif

@dgarske what do you think of revising the Windows API logic and first check for UNICODE like this:

#ifndef XINET_PTON #if defined(__WATCOMC__) #if defined(__OS2__) || defined(__NT__) && \ (NTDDI_VERSION >= NTDDI_VISTA) #define XINET_PTON(a,b,c) inet_pton((a),(b),(c)) #else #define XINET_PTON(a,b,c) *(unsigned *)(c) = inet_addr((b)) #endif #elif defined(USE_WINDOWS_API) /* Windows-friendly definition */ #if defined(UNICODE) /* Use Win API Pointer to a constant wide-character string */ #define XINET_PTON(a,b,c) InetPton((a),(PCWSTR)(b),(c)) #elif defined(__MINGW64__) && !defined(UNICODE) #define XINET_PTON(a,b,c) InetPton((a),(b),(c)) #else #if (defined(_MSC_VER) && (_MSC_VER >= 1600)) || defined(_WIN32_WCE) #define XINET_PTON(a,b,c) InetPton((a),(PCWSTR)(b),(c)) #else #define XINET_PTON(a,b,c) InetPton((a),(PCSTR)(b),(c)) #endif #endif #else #define XINET_PTON(a,b,c) inet_pton((a),(b),(c)) #endif #endif

dgarske · 2025-07-03T19:06:20Z

wrapper/CSharp/wolfCrypt-Test/wolfCrypt-Test.cs

-        }
-    }
-}
+/* wolfCrypt-Test.cs


This file shows a full replace. Guessing a CRLF issue. Please try and avoid that change if possible.

Yes, the prior file was LF only. Windows / Visual Studio default is CRLF.

I'll revert for this PR, but I recommend we change line endings at some future time.

Are you saying this file specifically is different? If so go ahead and keep it.

Correct. All of the other examples are CRLF. I'll change the wolfCrypt-Test.cs from LF to CRLF.

dgarske · 2025-07-03T19:07:36Z

wrapper/CSharp/wolfSSL-TLS-Client/wolfSSL-TLS-Client.cs

+            {
+                if (addr.AddressFamily == AddressFamily.InterNetwork)
+                {
+                    tcp.Connect(new IPEndPoint(addr, SERVER_PORT));


Why is this new logic needed? Where is the break;?

I've been still trying to get my CE emulator to work and use the wolfssl-tls-client example.

Why is this new logic needed?

Because this:

tcp.Connect(SERVER_NAME, SERVER_PORT);

on WindowsCE gives this error (connect takes only 1 param on CE, 2 on others):

Error 1 No overload for method 'Connect' takes '2' arguments C:\workspace\wolfssl-gojimmypi\wrapper\CSharp\wolfSSL-TLS-Client\wolfSSL-TLS-Client.cs 281 13 wolfSSL-TLS_CE_2008

Where is the break;?

added

dgarske · 2025-07-03T19:10:36Z

wrapper/CSharp/wolfSSL-TLS-Client/wolfSSL-TLS-Client.cs

        Console.WriteLine("SSL cipher suite is " + wolfssl.get_current_cipher(ssl));

+        /* Optional code & level history */
+        show_alert_history(ssl);


This belongs at the end before cleanup.

dgarske · 2025-07-03T19:16:07Z

wrapper/CSharp/wolfSSL-TLS-Client/wolfSSL-TLS-Client.cs

    }
+#endif
+
+    public static void show_alert_history_code(WOLFSSL_ALERT h, string m)


Make show_alert_history and show_alert_history_code private.

dgarske · 2025-07-03T19:18:51Z

wrapper/CSharp/wolfSSL_CSharp/wolfSSL.cs


 namespace wolfSSL.CSharp
 {
+    /********************************


Shouldn't these be part of the public class wolfssl? I'd prefer use wolfssl.WOLFSSL_ALERT, etc in the calling code.

Shouldn't these be part of the public class wolfssl?

Yes, it was at one point, but there was a scoping problem. I'll see if I can move it back or document why not.

dgarske · 2025-07-03T19:26:43Z

wrapper/CSharp/wolfSSL-TLS-Client/wolfSSL-TLS-Client.cs

+    public static void show_alert_history_code(WOLFSSL_ALERT h, string m)
+    {
+        /* VS initializes .code and .level to zero; wolfSSL sets to -1 until there's a valid value. */
+        if ((h.code > 0) || (h.level > 0)) {


Please cleanup example. You have if ((h.code > 0) || (h.level > 0)) twice.

Good catch, changed.

gojimmypi · 2025-07-03T21:04:58Z

Jenkins retest this please

For ERROR: Unable to tear down: java.io.IOException: Unexpected EOF; Python Remote call to wolf-linux-cloud-node no workspace for PRB-python-port #8458

dgarske · 2025-07-03T22:29:14Z

wolfssl/wolfio.h


+/* CE Not always reliably detected. Define our own _WIN32_WCE as needed. */
+#if defined(_WIN32_WCE) || defined(WINCE) || defined(PocketPC)
+    #if !_WIN32_WCE


Please change this to #if !defined(_WIN32_WCE). Why add another macro WINCE or PocketPC here? Are those supposed to supplied by the compiler or optionally by the user?

I will change this to only _WIN32_WCE. Neither that, nor WINCE have ever been auto-defined for me. I added them for likely completeness, although never actually tested.

edit: I'll remove this entire section and use only _WIN32_WCE for XINET_PTON detection of PCWSTR in this file.

#elif defined(USE_WINDOWS_API) /* Windows-friendly definition */ #if defined(__MINGW64__) && !defined(UNICODE) #define XINET_PTON(a,b,c) InetPton((a),(b),(c)) #else #if (defined(_MSC_VER) && (_MSC_VER >= 1600)) || defined(_WIN32_WCE) #define XINET_PTON(a,b,c) InetPton((a),(PCWSTR)(b),(c)) #else #define XINET_PTON(a,b,c) InetPton((a),(PCSTR)(b),(c)) #endif #endif

The PocketPC was auto-added at new project time here. I manually added the WindowsCE.

dgarske · 2025-07-03T22:29:46Z

wolfssl/wolfio.h

        #else
-            #define XINET_PTON(a,b,c)   InetPton((a),(PCWSTR)(b),(c))
+            #if (defined(_MSC_VER) && (_MSC_VER >= 1600)) || \
+                 defined(_WIN32_WCE) || defined(WINCE) || defined(PocketPC)


Just use _WIN32_WCE. You don't need WINCE or PocketPC

Ok, I'll use only _WIN32_WCE. It may need to be manually defined for some projects.

No, your logic a few lines up makes sure _WIN32_WCE is defined... So you can remove this duplicate logic.

dgarske · 2025-07-03T22:31:22Z

wrapper/CSharp/wolfSSL_CSharp/wolfCrypt.cs

        [DllImport(wolfssl_dll)]
        private extern static IntPtr wc_GetErrorString(int error);
-        public delegate void loggingCb(int lvl, string msg);
+        /* No Windows CE decorator for logging call-back */


I think this could break some users. I would prefer the logging continue to be duplicated. Technically its in wolfCrypt not wolfSSL. I don't want a refactor on this. Please duplicate the logging.

Ok. Do you have an example of what might be problematic & why the duplication is preferred?

I'd like to include a comment to avoid a future de-dupe.

WolfCrypt only users who are already calling wolfcrypt.setLogging

Hm. Interesting.

What do you think of moving it all from wolfSSL to wolfcrypt, no duplicating, but including API references to maintain current functionality?

That’s fine. As long as we keep the existing API’s. I do not want to break compatibility

gojimmypi · 2025-07-03T23:40:45Z

@dgarske you removed the For This Release tag today; If I have more time on this PR, would you like the other examples cleaned up and expanded (e.g. add new alert history)? I also have some new examples that are missing, such as wolfSSL-DTLS-PSK-Client.

We may also consider moving some of the C# examples to https://github.com/wolfSSL/wolfssl-examples

gojimmypi self-assigned this Jul 1, 2025

gojimmypi marked this pull request as draft July 1, 2025 04:18

gojimmypi force-pushed the pr-csharp-improvements branch from a1bc0fb to 9c2ec0b Compare July 1, 2025 04:27

gojimmypi marked this pull request as ready for review July 1, 2025 04:46

gojimmypi marked this pull request as draft July 1, 2025 04:47

gojimmypi force-pushed the pr-csharp-improvements branch from 9c2ec0b to 6f7aee2 Compare July 1, 2025 19:14

gojimmypi added the For This Release Release version 5.8.2 label Jul 1, 2025

gojimmypi assigned dgarske and wolfSSL-Bot Jul 1, 2025

gojimmypi requested a review from dgarske July 1, 2025 19:35

gojimmypi marked this pull request as ready for review July 1, 2025 19:36

dgarske requested changes Jul 2, 2025

View reviewed changes

wrapper/CSharp/wolfSSL_CSharp/wolfSSL.cs Show resolved Hide resolved

dgarske removed their assignment Jul 2, 2025

dgarske requested changes Jul 2, 2025

View reviewed changes

wrapper/CSharp/wolfSSL_CSharp/wolfSSL.cs Show resolved Hide resolved

JacobBarthelmeh previously approved these changes Jul 2, 2025

View reviewed changes

JacobBarthelmeh requested a review from Copilot July 2, 2025 19:35

JacobBarthelmeh unassigned wolfSSL-Bot Jul 2, 2025

Copilot AI reviewed Jul 2, 2025

View reviewed changes

wrapper/CSharp/wolfSSL_CSharp/wolfSSL.cs Outdated Show resolved Hide resolved

wrapper/CSharp/wolfSSL_CSharp/wolfSSL.cs Show resolved Hide resolved

wrapper/CSharp/wolfSSL_CSharp/wolfSSL.cs Show resolved Hide resolved

wrapper/CSharp/wolfSSL_CSharp/wolfSSL.cs Show resolved Hide resolved

gojimmypi marked this pull request as draft July 2, 2025 20:28

gojimmypi dismissed JacobBarthelmeh’s stale review via acd8fed July 2, 2025 23:10

gojimmypi marked this pull request as ready for review July 2, 2025 23:31

gojimmypi requested review from JacobBarthelmeh and dgarske July 2, 2025 23:32

gojimmypi assigned dgarske and JacobBarthelmeh Jul 2, 2025

dgarske unassigned dgarske and JacobBarthelmeh Jul 3, 2025

gojimmypi requested a review from dgarske July 3, 2025 18:38

gojimmypi assigned dgarske Jul 3, 2025

gojimmypi marked this pull request as ready for review July 3, 2025 18:39

dgarske requested changes Jul 3, 2025

View reviewed changes

dgarske reviewed Jul 3, 2025

View reviewed changes

dgarske requested changes Jul 3, 2025

View reviewed changes

dgarske removed their assignment Jul 3, 2025

gojimmypi requested a review from dgarske July 3, 2025 20:05

gojimmypi assigned dgarske Jul 3, 2025

dgarske requested changes Jul 3, 2025

View reviewed changes

dgarske removed their assignment Jul 3, 2025

gojimmypi marked this pull request as draft July 4, 2025 16:46

gojimmypi force-pushed the pr-csharp-improvements branch 2 times, most recently from 3086d2d to 5819622 Compare July 7, 2025 01:10

CSharp Wrapper Improvements

ed90c17

gojimmypi force-pushed the pr-csharp-improvements branch from ea54abc to ed90c17 Compare July 23, 2025 00:33

gojimmypi added 6 commits July 22, 2025 17:37

wolfSSL_user_settings_tag fix

0441ae8

WIP

d9c084a

WIP options

f31fcf4

WIP

31afe5f

wolfssl_CTX_SetMinVersion

aebb91b

TLSVersions, long X_options, WindowsCE, FORCE_MULTIBYTE_STRING

be065d1

gojimmypi mentioned this pull request Jul 30, 2025

Add ML-KEM/ML-DSA support for C# wrapper #9040

Open

4 tasks

misc WIP

f0823da

CSharp Wrapper Improvements #8946

Are you sure you want to change the base?

CSharp Wrapper Improvements #8946

Uh oh!

Conversation

gojimmypi commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Summary: CSharp Wrapper Improvements

CSharp Wrapper Enhancements

Compatibility Improvements

Dynamic DLL Loading

Improved Path Resolution

Verbose Debug Mode

Alert History & Diagnostics

Other Fixes

MSVC Compatibility Enhancements

Testing

Checklist

Uh oh!

gojimmypi commented Jul 1, 2025

Uh oh!

devin-ai-integration bot commented Jul 1, 2025

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gojimmypi commented Jul 2, 2025

Uh oh!

gojimmypi commented Jul 2, 2025

Uh oh!

devin-ai-integration bot commented Jul 2, 2025

Uh oh!

devin-ai-integration bot commented Jul 3, 2025

Uh oh!

dgarske left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gojimmypi commented Jul 1, 2025 •

edited

Loading

gojimmypi Jul 3, 2025 •

edited

Loading

gojimmypi Jul 3, 2025 •

edited

Loading