Improve CSharp Examples by gojimmypi · Pull Request #8562 · wolfSSL/wolfssl

gojimmypi · 2025-03-14T02:39:31Z

Description

Updates C# Wrapper examples, adds features to wolfSSL C# wrapper, fixes Windows build-time warnings, revised code for compatibility with older frameworks missing language and library features otherwise found in recent versions..

edit: I've put together a blog to help explain in more detail the DLL challenges encountered in Visual Studio (and Windows in General), as well as the value of having the new App.config settings: WOLFSSL_DLL_PATH and WOLFSSL_CERTS_PATH.

See: https://gojimmypi.github.io/Using-wolfssl-in-Visual-Studio/

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <startup>
        <supportedRuntime version="v2.0.50727"/>
    </startup>
    <appSettings>
        <add key="WOLFSSL_DLL_PATH" value="C:/Windows/System32"/>
        <add key="WOLFSSL_CERTS_PATH" value="C:/workspace/wolfssl/certs"/>
    </appSettings>
</configuration>

edit[2]: The enclosed new .github/workflows/visual-studio.yml is intentionally separate from the existing win-csharp-test.yml workflow. This new visual-studio.yml is intended to grow to be repository-wide, checking all the Visual Studio project files everywhere for line endings, file encoding, and check build configurations for projects beyond just the C# wrapper. Actual functional tests are expected to remain in a separate workflow. See the WIP my_visual-studio.yml which is beyond the scope of this PR.

NET 3.5 Compatibility for wolfSSL C# Wrappers

Overview

This PR adds compatibility with .NET Framework 3.5 to the wolfSSL C# wrappers and examples, enabling wolfSSL to be used in environments that require older .NET Framework versions.

Key Changes

Framework Targeting

Changed target framework from .NET 4.8 to .NET 3.5 in all C# projects
Updated App.config files to use supportedRuntime version="v2.0.50727" instead of v4.0
Removed references to newer framework assemblies not available in .NET 3.5 (System.Core, System.Xml.Linq, System.Data.DataSetExtensions)
Added System.Configuration reference for configuration management

DLL Import/Export Handling

Modified header files ( curve25519.h, ed25519.h) to fix DLL import/export declarations for better compatibility, fixing warning C4141: 'dllexport': used more than once
Added cpp.hint file to assist Visual Studio with C++ identifier interpretation
Updated wolfSSL.cs with improved DLL path handling for .NET 3.5 environments
Updated sniffer.h to not define SSL_SNIFFER_API __declspec(dllexport) unless SSL_SNIFFER_EXPORTS found

Build System

Added new GitHub Actions workflow (visual_studio.yml) to test building with .NET 3.5
Added new solution file (wolfSSL_CSharp-Clients.sln) specifically for client examples
Updated include.am to include new files in distribution

Error Handling and Logging

Improved error handling in example applications with proper exit codes
Enhanced debug logging with conditional compilation based on build configuration
Added configuration settings for DLL and certificate paths in App.config files

Documentation

Updated README.md with expanded instructions for Windows and Linux environments
Updated copyright information to reflect current year

Benefits

Enables wolfSSL to be used in legacy systems that require .NET 3.5
Improves compatibility with older Windows environments
Provides better error handling and configuration options
Adds CI testing for .NET 3.5 builds to prevent regressions

Fixes zd#

Testing

How did you test?

Tested manually on Windows 2022, Visual Studio 2022. See also new workflow (build only) from my visual_studio.yml

Checklist

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

gasbytes · 2025-03-14T13:10:52Z

wrapper/CSharp/wolfSSL_CSharp/wolfCrypt.cs

        /// Export both private and public keys from a Curve25519 key structure
        /// </summary>
        /// <param name="key">Curve25519 key structure</param>
        /// <returns>A tuple containing the private key and public key as byte arrays</returns>


Update the returns tags to match the new return type (void).
Maybe we could move the comments at line 2428-2429 directly here.

yes, good catch. updated & removed code that was commented out.

gasbytes · 2025-03-14T13:13:11Z

wrapper/CSharp/wolfSSL_CSharp/wolfSSL.cs

+            //var configAttr = (AssemblyConfigurationAttribute)Attribute.GetCustomAttribute(
+            //    Assembly.GetExecutingAssembly(), typeof(AssemblyConfigurationAttribute));
+
+            //return configAttr?.Configuration ?? "Unknown";


Can this commented code be removed?

ah yes, I did not intend to keep the code commented out.

gasbytes

Just a couple of minor things that I noticed.

gasbytes

Some more minor changes.

gasbytes · 2025-03-14T16:43:35Z

wrapper/CSharp/README.md

+Calling ctx Init from wolfSSL
+```
+
+Note the `WOLFSSL_DLL` is used in the wolfssl `visibiility.h` and defines the `WOLFSSL_API` like this:


Spelling and maybe we could provide the full path to the header file?:
wolfssl/wolfssl/wolfcrypt/visibility.h

good idea. updated

gasbytes · 2025-03-14T16:43:40Z

wrapper/CSharp/README.md

+
+### Build wolfSSL and install to arbitrary directory
+
+To have a n isolated instance of wolfSSL, in this case `$HOME/wolfssl-install-psk`:


oh, good catch! fixed.

gojimmypi · 2025-03-16T20:25:28Z

Jenkins retest this please.

for Unable to create live FilePath for wolf-linux-cloud-node marked offline: Connection was broken in PRB-dtls.txt_39 from 'PRB-generic-config-parser/7682`

gojimmypi · 2025-03-16T23:21:53Z

Jenkins retest this please.

for "Cannot contact wolf-linux-cloud-node"

dgarske · 2025-03-21T19:43:23Z

Please resolve merge conflicts

gojimmypi · 2025-04-08T09:46:25Z

Jenkins retest this please.

for: "Remote call on wolf-linux-cloud-node-nnn failed. The channel is closing down or has closed down"

gojimmypi · 2025-04-08T10:06:12Z

Hi @dgarske - merge conflicts resolved.

dgarske · 2025-04-08T22:14:11Z

Please don't merge this yet. I am not sure if I want to have the VS2005 / .NET 3.5 support introduced this way. I've got a large portion of these changes in #8621 already. The changes made to CSharp for .NET 3.5 should hopefully be backwards compatible. And the actual project files I may want to keep elsewhere.

gojimmypi · 2025-04-10T11:14:59Z

Marked as draft per @dgarske #8562 (comment)

dgarske · 2025-05-06T22:13:31Z

This PR was replaced with:
#8621
#8709
There is a plan to add a small VS 2005 and .NET 3.5 example and test.

gojimmypi requested review from JacobBarthelmeh and gasbytes March 14, 2025 02:39

gojimmypi assigned JacobBarthelmeh, gojimmypi and gasbytes Mar 14, 2025

gasbytes reviewed Mar 14, 2025

View reviewed changes

gasbytes requested changes Mar 14, 2025

View reviewed changes

gojimmypi force-pushed the pr-vs-dotnet35 branch from cb69f56 to 5bd701d Compare March 16, 2025 19:30

gojimmypi requested a review from gasbytes March 16, 2025 21:37

dgarske assigned gojimmypi and unassigned JacobBarthelmeh, gojimmypi and gasbytes Mar 21, 2025

dgarske self-requested a review March 21, 2025 19:43

dgarske assigned dgarske and unassigned dgarske Mar 31, 2025

dgarske removed their request for review April 4, 2025 22:49

gojimmypi force-pushed the pr-vs-dotnet35 branch from 6a26918 to fcd98ce Compare April 8, 2025 08:52

Improve CSharp Examples

61bce5e

gojimmypi force-pushed the pr-vs-dotnet35 branch from d579dbe to 61bce5e Compare April 8, 2025 09:05

gojimmypi assigned dgarske and gasbytes Apr 8, 2025

dgarske unassigned gasbytes Apr 8, 2025

dgarske removed request for JacobBarthelmeh and gasbytes April 8, 2025 22:12

gojimmypi marked this pull request as draft April 10, 2025 11:14

dgarske closed this May 6, 2025


		### Build wolfSSL and install to arbitrary directory

		To have a n isolated instance of wolfSSL, in this case `$HOME/wolfssl-install-psk`:

Conversation

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

Uh oh!

Description

NET 3.5 Compatibility for wolfSSL C# Wrappers

Overview

Key Changes

Framework Targeting

DLL Import/Export Handling

Build System

Error Handling and Logging

Documentation

Benefits

Testing

Checklist

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!

gasbytes left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gasbytes 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!

gojimmypi commented Mar 16, 2025

Uh oh!

gojimmypi commented Mar 16, 2025

Uh oh!

dgarske commented Mar 21, 2025

Uh oh!

gojimmypi commented Apr 8, 2025

Uh oh!

gojimmypi commented Apr 8, 2025

Uh oh!

dgarske commented Apr 8, 2025

Uh oh!

gojimmypi commented Apr 10, 2025

Uh oh!

dgarske commented May 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gojimmypi commented Mar 14, 2025 •

edited

Loading

gasbytes left a comment •

edited

Loading