Merge pull request #161 from haydenroche5/visual_studio

Add Visual Studio support.

Author: cconlon

.gitignore

@@ -50,3 +50,20 @@
 /scripts/*.log
 *.gcno
 *.gcda
+
+# Visual Studio files to ignore
+.vs
+x64
+Release
+DLL Release
+Debug
+DLL Debug
+test.rc
+test.aps
+test/resource.h
+
+# Eclipse files to ignore
+.autotools
+.cproject
+.project
+.settings

Makefile.am

@@ -6,6 +6,7 @@ check_PROGRAMS =
 dist_noinst_SCRIPTS =
 DISTCLEANFILES =
 pkginclude_HEADERS =
+EXTRA_DIST =
 
 ACLOCAL_AMFLAGS = -I m4
 
@@ -36,3 +37,11 @@ test: check
 AM_DISTCHECK_CONFIGURE_FLAGS=CPPFLAGS="-I@abs_top_srcdir@/include \
                                          @OPENSSL_INCLUDES@" \
                              LDFLAGS="@OPENSSL_LDFLAGS@"
+
+EXTRA_DIST+= README.md
+
+EXTRA_DIST += \
+    wolfEngine.sln \
+    wolfEngine.vcxproj \
+    wolfEngine.vcxproj.filters \
+    wolfEngine.vcxproj.user

README.md

@@ -1,4 +1,4 @@
-
+
 ## Description
 
 wolfEngine is a library that can be used as an Engine in OpenSSL.
@@ -40,7 +40,7 @@ wolfEngine is a library that can be used as an Engine in OpenSSL.
 * SHA-3 support is only available with OpenSSL versions 1.1.1+.
 * EC_KEY_METHOD is only available with OpenSSL versions 1.1.1+.
 
-## Building
+## Building on *nix Systems
 
 ### OpenSSL
 
@@ -91,7 +91,7 @@ make check
 * To use a custom user_settings.h file to override the defines produced by `./configure`, add `--enable-usersettings` and place a user_settings.h file with the defines you want in the include directory. See the root of the project for an example user_settings.h.
 * To build wolfEngine with debug support, add `--enable-debug`. Then, to activate the debug logging at runtime, your application should send this control command to wolfEngine (denoted "e" here): `ENGINE_ctrl_cmd(e, "enable_debug", 1, NULL, NULL, 0)`.
 
-## Testing
+## Testing on *nix Systems
 
 ### Unit Tests
 To run automated unit tests:
@@ -102,3 +102,109 @@ If you get an error like `error while loading shared libraries: libssl.so.3` the
 
 ### Integration Tests
 There are no automated integration tests, yet.
+
+## Building on Windows
+
+The `wolfEngine.sln` solution supplied in the root of the wolfEngine project 
+expects the following directory structure:
+
+```
+.
+├── openssl
+├── wolfEngine
+└── wolfssl
+```
+
+### Building OpenSSL
+
+Follow the instructions in the OpenSSL `INSTALL` file. The list of commands to run are:
+```
+    $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE }
+    $ nmake clean # This command needs to be run if OpenSSL has previously been built in this directory with a different configuration.
+    $ nmake
+```
+
+### Building wolfSSL
+
+Compile wolfSSL using one of the solution projects available in the 
+project (`wolfssl.sln` or `wolfssl64.sln`). The following is a list of defines 
+that are generated when using the configure script. You do not need to turn all
+of them on but this list will provide full functionality. For ease of use, it is
+recommended to add the desired defines to the `user_settings.h` file used in
+the chosen wolfSSL Visual Studio solution. Please make sure to update the defines
+in the wolfEngine `user_settings.h` file to match the defines used to compile
+wolfSSL.
+
+```
+/* Settings generated by the configure script when compiling for wolfEngine */
+#define HAVE_AES_ECB
+#define WC_RSA_NO_PADDING
+#define WOLFSSL_PUBLIC_MP
+#define ECC_MIN_KEY_SZ 192
+#define WOLFSSL_PSS_LONG_SALT
+#define WOLFSSL_PSS_SALT_LEN_DISCOVER
+#define WOLFSSL_TLS13
+#define HAVE_TLS_EXTENSIONS
+#define HAVE_SUPPORTED_CURVES
+#define HAVE_FFDHE_2048
+#define HAVE_THREAD_LS
+#define TFM_TIMING_RESISTANT
+#define ECC_TIMING_RESISTANT
+#define WC_RSA_BLINDING
+#define HAVE_AESCCM
+#define WOLFSSL_AES_COUNTER
+#define WOLFSSL_AES_DIRECT
+#define WOLFSSL_SHA224
+#define WOLFSSL_SHA512
+#define WOLFSSL_SHA384
+#define WOLFSSL_KEY_GEN
+#define HAVE_HKDF
+#define HAVE_X963_KDF
+#define NO_DSA
+#define HAVE_ECC
+#define TFM_ECC256
+#define ECC_SHAMIR
+#define WC_RSA_PSS
+#define WOLFSSL_BASE64_ENCODE
+#define NO_RC4
+#define WOLFSSL_CMAC
+#define NO_HC128
+#define NO_RABBIT
+#define WOLFSSL_SHA3
+#define WOLFSSL_SHAKE256
+#define HAVE_POLY1305
+#define HAVE_ONE_TIME_AUTH
+#define HAVE_CHACHA
+#define HAVE_HASHDRBG
+#define HAVE_EXTENDED_MASTER
+#define HAVE_ENCRYPT_THEN_MAC
+#define NO_PSK
+#define NO_MD4
+#define NO_PWDBASED
+#define USE_FAST_MATH
+#define WC_NO_ASYNC_THREADING
+#define HAVE_DH_DEFAULT_PARAMS
+#define GCM_TABLE_4BIT
+#define HAVE_AESGCM
+#define HAVE_WC_INTROSPECTION
+#define OPENSSL_COEXIST
+#define NO_OLD_RNGNAME
+#define NO_OLD_WC_NAMES
+#define NO_OLD_SSL_NAMES
+#define NO_OLD_SHA_NAMES
+#define NO_OLD_MD5_NAME
+```
+
+### Building wolfEngine
+
+It is enough to compile the wolfEngine solution to generate the DLL file. 
+Please make sure that you have updated the `user_settings.h` header to match 
+the defines used to compile wolfSSL. The `test` project in the wolfEngine 
+solution compiles an executable file that is dynamically linked to the 
+wolfEngine and OpenSSL libraries. The `test` solution copies the OpenSSL DLL 
+files into the output directory. If you want to skip this step and use system
+supplied versions of OpenSSL, delete the command under:
+
+```
+test Properties -> Configuration Properties -> Build Events -> Post-Build Event -> Command Line
+```

bench.c

@@ -25,8 +25,9 @@
 
 #ifdef WOLFENGINE_USER_SETTINGS
 #include <user_settings.h>
-#endif
+#else
 #include <wolfssl/options.h>
+#endif
 #include <wolfssl/wolfcrypt/wc_port.h>
 
 #include <wolfengine/we_wolfengine.h>

configure.ac

@@ -71,6 +71,9 @@ fi
 AC_CHECK_HEADERS([wolfssl/wolfcrypt/kdf.h])
 AC_CHECK_FUNCS([wc_DhSetNamedKey])
 
+# Export symbols in dynamic lib
+CFLAGS="$CFLAGS -DBUILDING_WOLFENGINE"
+
 # DEBUG
 DEBUG_CFLAGS="-g -O0 -DWOLFENGINE_DEBUG"
 AX_DEBUG

include/include.am

@@ -7,4 +7,5 @@ noinst_HEADERS += include/wolfengine/we_internal.h \
 
 pkginclude_HEADERS += include/wolfengine/we_wolfengine.h \
                       include/wolfengine/we_logging.h \
-                      include/wolfengine/we_fips.h
+                      include/wolfengine/we_fips.h \
+                      include/wolfengine/we_visibility.h

include/wolfengine/we_fips.h

@@ -24,9 +24,12 @@
 
 #ifdef WOLFENGINE_USER_SETTINGS
     #include "user_settings.h"
+#else
+    #include <wolfssl/options.h>
 #endif
 
-#include <wolfssl/options.h>
+#include <wolfengine/we_visibility.h>
+
 
 enum wolfEngine_FipsCheck {
     /* check that RSA key size is valid */
@@ -47,8 +50,8 @@ enum wolfEngine_FipsCheck {
 };
 
 /* Set FIPS checks, bitmask of wolfEngine_FipsCheck. */
-void wolfEngine_SetFipsChecks(long checksMask);
+WOLFENGINE_API void wolfEngine_SetFipsChecks(long checksMask);
 /* Get FIPS checks mask. */
-long wolfEngine_GetFipsChecks(void);
+WOLFENGINE_API long wolfEngine_GetFipsChecks(void);
 
 #endif /* WE_FIPS_H */