Add in documentation

pull/393/head
Andras Fekete 2023-07-31 13:53:31 -04:00
parent 4c58c2ba8e
commit 5a4cd11c9c
2 changed files with 15 additions and 5 deletions

View File

@ -10,7 +10,7 @@ DEBUGOPT=
#DEBUGOPT=-DWOLFSSL_DEBUG_TLS -DDEBUG_WOLFSSL -DDEBUG_CRYPTOCB
#DEBUGOPT=-DWOLFSSL_DEBUG_TLS -DDEBUG_WOLFSSL
COMMONOPT=-O0 -g -IMagicCrypto/include -LMagicCrypto/lib -lwolfssl -lMagicCrypto -lm -DWOLF_CRYPTO_CB
COMMONOPT=-O0 -g -IMagicCrypto/include -lwolfssl -lm -DWOLF_CRYPTO_CB
%: %.c $(DEPS)
$(CC) $< $(DEBUGOPT) $(COMMONOPT) -o $@

View File

@ -1,5 +1,15 @@
# MagicCrypto example usage with wolfSSL
Place this folder into wolfssl/MagicCrypto. You will need to compile wolfSSL with:
./configure --enable-ariagcm --disable-shared --enable-cryptocb --enable-all && make -j16 src/libwolfssl.la
# Overview
The MagicCrypto library is created by [Dream Security](https://dreamsecurity.com) which contains a certified implementation of the [ARIA cipher](https://en.wikipedia.org/wiki/ARIA_(cipher)) that is used by the South Korean government. This example makes use of the wolfSSL bindings to create a TLS 1.2 connection.
Then simply doing `make` in the MagicCrypto folder will produce a client and server example. This uses some certificates from the wolfSSL repo. To run, simply start `./server` and `./client 127.0.0.1` in the MagicCrypto folder.
# Compiling
You will need to compile wolfSSL with:
./configure --enable-ariagcm --enable-cryptocb && make install
You will need to have the MagicCrypto headers and library in the wolfSSL source directory. You may need to apply the patch file to clear up some of the compiler warnings.
Once the wolfSSL library in installed, you can run `make` in this folder to generate the sample client and server applications. You may need to modify the Makefile to point to the MagicCrypto includes directory.
# Usage
The sample applications depend on using the certificates found in the wolfSSL source directory. You should execute them from the folder containing the 'certs' folder. Alternatively, you can modify the `#define` in 'common.h'.
To run, simply start `./server` and `./client 127.0.0.1`.