Browse Source

Add documentation for the CSharp wrapper.

David Garske 1 year ago
parent
commit
ea80e9e0ea
2 changed files with 62 additions and 0 deletions
  1. 61 0
      wrapper/CSharp/README.md
  2. 1 0
      wrapper/CSharp/include.am

+ 61 - 0
wrapper/CSharp/README.md

@@ -0,0 +1,61 @@
+# wolfSSL CSharp Wrappers
+
+This directory contains the CSharp wrapper for the wolfSSL TLS layer with examples.
+
+* `wolfSSL_CSharp`: wolfSSL TLS layer wrappers (library)
+
+Examples:
+* `wolfSSL-DTLS-PSK-Server`
+* `wolfSSL-DTLS-Server`
+* `wolfSSL-Example-IOCallbacks`
+* `wolfSSL-TLS-Client`
+* `wolfSSL-TLS-PSK-Client`
+* `wolfSSL-TLS-PSK-Server`
+* `wolfSSL-TLS-Server`
+* `wolfSSL-TLS-ServerThreaded`
+
+## Windows
+
+A Visual Studio solution `wolfSSL_CSharp.sln` is provided. This will allow you
+to build the wrapper library and examples. It includes the wolfSSL Visual Studio
+project directly.
+
+## Linux (using Mono)
+
+Prerequisites for linux:
+
+```
+apt install mono-tools-devel
+```
+
+Build wolfSSL and install:
+
+```
+./autogen.sh
+./configure --enable-wolftpm
+make
+make check
+sudo make install
+```
+
+Build and run the wrapper:
+
+```
+cd wrapper/CSharp
+
+csc wolfSSL_CSharp/wolfSSL.cs wolfSSL_CSharp/X509.cs \
+    wolfSSL-TLS-Server/wolfSSL-TLS-Server.cs
+
+Run the example:
+
+```
+cp wolfSSL-TLS-Server.exe ../../certs
+cd ../../certs
+
+mono wolfSSL-TLS-Server.exe
+
+Calling ctx Init from wolfSSL
+Finished init of ctx .... now load in cert and key
+Ciphers : TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384:TLS13-CHACHA20-POLY1305-SHA256:DHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA:ECDHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-CHACHA20-POLY1305:DHE-RSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305-OLD:ECDHE-ECDSA-CHACHA20-POLY1305-OLD:DHE-RSA-CHACHA20-POLY1305-OLD
+Started TCP and waiting for a connection
+```

+ 1 - 0
wrapper/CSharp/include.am

@@ -1,4 +1,5 @@
 # wolfSSL CSharp wrapper files
+EXTRA_DIST+= wrapper/CSharp/README.md
 EXTRA_DIST+= wrapper/CSharp/wolfSSL-DTLS-PSK-Server/App.config
 EXTRA_DIST+= wrapper/CSharp/wolfSSL-DTLS-PSK-Server/Properties/AssemblyInfo.cs
 EXTRA_DIST+= wrapper/CSharp/wolfSSL-DTLS-PSK-Server/wolfSSL-DTLS-PSK-Server.cs