Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
47 changes: 47 additions & 0 deletions CSharp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# C# Wrapper Examples

This directory contains examples that demonstrate using the C# wrapper.

These assume the use of `wolfssl\wrapper\CSharp\wolfSSL_CSharp.sln`.

## wolfSSL-TLS-pq

wolfSSL Server and Client using PQC algorithms (ML-KEM / ML-DSA).

### Build Options

The following build options need to be added.

#### for `wolfssl` Project

```
HAVE_MLKEM
WOLFSSL_WC_MLKEM
WOLFSSL_HAVE_MLKEM
WOLFSSL_DTLS_CH_FRAG
HAVE_DILITHIUM
WOLFSSL_WC_DILITHIUM
WOLFSSL_SHAKE128
WOLFSSL_SHAKE256
```

#### for `wolfSSL_CSharp` Project

```
HAVE_MLKEM
HAVE_MLDSA
```

If you want to execute `wolfCrypt-Test` Project as well, add these options to `wolfCrypt-Test` Project.

### wolfSSL-TLS-pq-Server

wolfSSL Server using ML-DSA-87.

### wolfSSL-TLS-pq-ServerThreaded

Threaded version of `wolfSSL-TLS-pq-Server`.

### wolfSSL-TLS-pq-Client

wolfSSL Client using ML-KEM-1024/ML-DSA-87.
6 changes: 6 additions & 0 deletions CSharp/wolfSSL-TLS-pq-Client/App.config
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8"/>
</startup>
</configuration>
36 changes: 36 additions & 0 deletions CSharp/wolfSSL-TLS-pq-Client/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

// General Information about an assembly is controlled through the following
// set of attributes. Change these attribute values to modify the information
// associated with an assembly.
[assembly: AssemblyTitle("wolfSSL-TLS-Client")]
[assembly: AssemblyDescription("")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("wolfSSL")]
[assembly: AssemblyProduct("wolfSSL-TLS-Client")]
[assembly: AssemblyCopyright("Copyright wolfSSL 2020")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]

// Setting ComVisible to false makes the types in this assembly not visible
// to COM components. If you need to access a type in this assembly from
// COM, set the ComVisible attribute to true on that type.
[assembly: ComVisible(false)]

// The following GUID is for the ID of the typelib if this project is exposed to COM
[assembly: Guid("05aad2b4-445e-4f0e-8e16-8f8512696505")]

// Version information for an assembly consists of the following four values:
//
// Major Version
// Minor Version
// Build Number
// Revision
//
// You can specify all the values or you can default the Build and Revision Numbers
// by using the '*' as shown below:
// [assembly: AssemblyVersion("1.0.*")]
[assembly: AssemblyVersion("1.1.0.0")]
[assembly: AssemblyFileVersion("1.1.0.0")]
272 changes: 272 additions & 0 deletions CSharp/wolfSSL-TLS-pq-Client/wolfSSL-TLS-Client.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,272 @@
/* wolfSSL-TLS-Client.cs
*
* Copyright (C) 2006-2025 wolfSSL Inc.
*
* This file is part of wolfSSL.
*
* wolfSSL is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* wolfSSL is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
*/

using System;
using System.Runtime.InteropServices;
using System.Text;
using System.IO;
using System.Net;
using System.Net.Sockets;
using wolfSSL.CSharp;

public class wolfSSL_TLS_Client
{
/// <summary>
/// Example of a logging function
/// </summary>
/// <param name="lvl">level of log</param>
/// <param name="msg">message to log</param>
public static void standard_log(int lvl, StringBuilder msg)
{
Console.WriteLine(msg);
}


private static void clean(IntPtr ssl, IntPtr ctx)
{
wolfssl.free(ssl);
wolfssl.CTX_free(ctx);
wolfssl.Cleanup();
}

/// <summary>
/// Verification callback
/// </summary>
/// <param name="preverify">1=Verify Okay, 0=Failure</param>
/// <param name="x509_ctx">Certificate in WOLFSSL_X509_STORE_CTX format</param>
private static int myVerify(int preverify, IntPtr x509_ctx)
{
int verify = preverify;
Console.WriteLine("myVerify is called.");

/* example for overriding an error code */
/* X509_STORE_CTX_get_error API can be enabled with
* OPENSSL_EXTRA_X509_SMALL or WOLFSSL_EXTRA */
int error = wolfssl.X509_STORE_CTX_get_error(x509_ctx);
if (error == wolfcrypt.ASN_BEFORE_DATE_E) {
verify = 1; /* override error */
}

/* Can optionally override failures by returning non-zero value */
return verify;
}

/// <summary>
/// Checks if the SNI option was enabled via command line.
/// Must be enabled with ./configure --enable-sni when configuring
/// wolfSSL.
/// <param name="args">Parameters passed via command line</param>
/// </summary>
private static int haveSNI(string[] args)
{
for (int i = 0; i < args.Length; i++) {
if (args[i] == "-S") {
Console.WriteLine("SNI IS ON");
return i+1;
}
}
Console.WriteLine("SNI IS OFF");
return -1;
}

public static void Main(string[] args)
{
IntPtr ctx;
IntPtr ssl;
Socket tcp;
IntPtr sniHostName;

/* These paths should be changed for use */
string caCert = wolfssl.setPath("mldsa87_root_cert.pem");
StringBuilder dhparam = new StringBuilder(wolfssl.setPath("dh2048.pem"));

if (caCert == "" || dhparam.Length == 0) {
Console.WriteLine("Platform not supported.");
return;
}

StringBuilder buff = new StringBuilder(1024);
StringBuilder reply = new StringBuilder("Hello, this is the wolfSSL C# wrapper");

//example of function used for setting logging
wolfssl.SetLogging(standard_log);

wolfssl.Init();

Console.WriteLine("Calling ctx Init from wolfSSL");
ctx = wolfssl.CTX_new(wolfssl.usev23_client());
if (ctx == IntPtr.Zero)
{
Console.WriteLine("Error in creating ctx structure");
return;
}
Console.WriteLine("Finished init of ctx .... now load in CA");


if (!File.Exists(caCert))
{
Console.WriteLine("Could not find CA cert file");
wolfssl.CTX_free(ctx);
return;
}

if (!File.Exists(dhparam.ToString())) {
Console.WriteLine("Could not find dh file");
wolfssl.CTX_free(ctx);
return;
}

if (wolfssl.CTX_load_verify_locations(ctx, caCert, null)
!= wolfssl.SUCCESS)
{
Console.WriteLine("Error loading CA cert");
wolfssl.CTX_free(ctx);
return;
}

int sniArg = haveSNI(args);
if (sniArg >= 0)
{
string sniHostNameString = args[sniArg].Trim();
sniHostName = Marshal.StringToHGlobalAnsi(sniHostNameString);

ushort size = (ushort)sniHostNameString.Length;

if (wolfssl.CTX_UseSNI(ctx, (byte)wolfssl.WOLFSSL_SNI_HOST_NAME, sniHostName, size) != wolfssl.SUCCESS)
{
Console.WriteLine("UseSNI failed");
wolfssl.CTX_free(ctx);
return;
}
}

StringBuilder ciphers = new StringBuilder(new String(' ', 4096));
wolfssl.get_ciphers(ciphers, 4096);
Console.WriteLine("Ciphers : " + ciphers.ToString());

/* Uncomment Section to enable specific cipher suite */
#if false
ciphers = new StringBuilder("ECDHE-ECDSA-AES128-GCM-SHA256");
if (wolfssl.CTX_set_cipher_list(ctx, ciphers) != wolfssl.SUCCESS)
{
Console.WriteLine("ERROR CTX_set_cipher_list()");
wolfssl.CTX_free(ctx);
return;
}
#endif

short minDhKey = 128;
wolfssl.CTX_SetMinDhKey_Sz(ctx, minDhKey);

/* Setup Verify Callback */
if (wolfssl.CTX_set_verify(ctx, wolfssl.SSL_VERIFY_PEER, myVerify)
!= wolfssl.SUCCESS)
{
Console.WriteLine("Error setting verify callback!");
}


/* set up TCP socket */
tcp = new Socket(AddressFamily.InterNetwork, SocketType.Stream,
ProtocolType.Tcp);
try
{
tcp.Connect("localhost", 11111);
}
catch (Exception e)
{
Console.WriteLine("tcp.Connect() error " + e.ToString());
wolfssl.CTX_free(ctx);
return;
}
if (!tcp.Connected)
{
Console.WriteLine("tcp.Connect() failed!");
tcp.Close();
wolfssl.CTX_free(ctx);
return;
}

Console.WriteLine("Connected TCP");
ssl = wolfssl.new_ssl(ctx);
if (ssl == IntPtr.Zero)
{
Console.WriteLine("Error in creating ssl object");
wolfssl.CTX_free(ctx);
return;
}

if (wolfssl.UseKeyShare(ssl, wolfssl.NamedGroup.WOLFSSL_ML_KEM_1024) != wolfssl.SUCCESS)
{
Console.WriteLine("Error enabling ML-KEM key share");
wolfssl.CTX_free(ctx);
return;
}

Console.WriteLine("Connection made wolfSSL_connect ");
if (wolfssl.set_fd(ssl, tcp) != wolfssl.SUCCESS)
{
/* get and print out the error */
Console.WriteLine(wolfssl.get_error(ssl));
tcp.Close();
clean(ssl, ctx);
return;
}

wolfssl.SetTmpDH_file(ssl, dhparam, wolfssl.SSL_FILETYPE_PEM);

if (wolfssl.connect(ssl) != wolfssl.SUCCESS)
{
/* get and print out the error */
Console.WriteLine(wolfssl.get_error(ssl));
tcp.Close();
clean(ssl, ctx);
return;
}

/* print out results of TLS/SSL accept */
Console.WriteLine("SSL version is " + wolfssl.get_version(ssl));
Console.WriteLine("SSL cipher suite is " + wolfssl.get_current_cipher(ssl));


if (wolfssl.write(ssl, reply, reply.Length) != reply.Length)
{
Console.WriteLine("Error in write");
tcp.Close();
clean(ssl, ctx);
return;
}

/* read and print out the message then reply */
if (wolfssl.read(ssl, buff, 1023) < 0)
{
Console.WriteLine("Error in read");
tcp.Close();
clean(ssl, ctx);
return;
}
Console.WriteLine(buff);

wolfssl.shutdown(ssl);
tcp.Close();
clean(ssl, ctx);
}
}
Loading
Loading