Skip to content

Commit a9be38e

Browse files
committed
Improve wolfssl/options.h issues. Fixes #7853.
1 parent 1190d1b commit a9be38e

3 files changed

Lines changed: 16 additions & 3 deletions

File tree

INSTALL

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@
1212
$ make check # (optional, but highly recommended)
1313
$ sudo make install
1414

15+
Note: Building with configure generates a wolfssl/options.h file that contains
16+
all the generated build options. This file needs to be included in your application
17+
before any other wolfSSL headers. Optionally your application can define
18+
WOLFSSL_USE_OPTIONS_H to do this automatically.
19+
1520
2. Building on iOS
1621

1722
Use on the xcode project in IDE/iOS/wolfssl.xcodeproj
@@ -74,7 +79,7 @@
7479
13. Porting to a new platform
7580

7681
Please see section 2.4 in the manual:
77-
http://www.wolfssl.com/yaSSL/Docs-cyassl-manual-2-building-cyassl.html
82+
https://www.wolfssl.com/documentation/manuals/wolfssl/chapter02.html#customizing-or-porting-wolfssl
7883

7984
14. Building with CMake
8085
Note: Primary development uses automake (./configure). The support for CMake
@@ -91,6 +96,11 @@
9196
a header options.h in the wolfssl directory that contains the options used
9297
to configure the build.
9398

99+
Note: Building with configure generates a wolfssl/options.h file that contains
100+
all the generated build options. This file needs to be included in your application
101+
before any other wolfSSL headers. Optionally your application can define
102+
WOLFSSL_USE_OPTIONS_H to do this automatically.
103+
94104
Unix-based Platforms
95105
---
96106
1) Navigate to the wolfssl root directory containing "CMakeLists.txt".

configure.ac

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10409,7 +10409,7 @@ fi # $silent != yes
1040910409
1041010410
if test "$ENABLED_ASYNCCRYPT" = "yes" && ! test -s $srcdir/wolfcrypt/src/async.c
1041110411
then
10412-
AC_MSG_WARN([Make sure real async files are loaded. Contact wolfSSL for details on using the asynccrypt option.])
10412+
AC_MSG_WARN([Make sure real async files are loaded. See async-check.sh or the wolfssl/wolfAsyncCrypt GitHub repo.])
1041310413
fi
1041410414
1041510415
# MinGW static vs shared library
@@ -10436,3 +10436,6 @@ if test -n "$WITH_MAX_ECC_BITS"; then
1043610436
fi
1043710437
fi
1043810438
10439+
echo "---"
10440+
echo "Note: Make sure your application includes \"wolfssl/options.h\" before any other wolfSSL headers."
10441+
echo " You can define \"WOLFSSL_USE_OPTIONS_H\" in your application to include this automatically."

wolfssl/wolfcrypt/settings.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
/* This flag allows wolfSSL to include options.h instead of having client
5656
* projects do it themselves. This should *NEVER* be defined when building
5757
* wolfSSL as it can cause hard to debug problems. */
58-
#ifdef EXTERNAL_OPTS_OPENVPN
58+
#if defined(EXTERNAL_OPTS_OPENVPN) || defined(WOLFSSL_USE_OPTIONS_H)
5959
#include <wolfssl/options.h>
6060
#endif
6161

0 commit comments

Comments
 (0)