Skip to content

Commit b1d42d6

Browse files
authored
clarify OpenSSL config [skip ci] (#1429)
1 parent d61d81c commit b1d42d6

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

CONFIGURE.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,16 @@ These can be set to `ON` or `OFF` and take an effect if liboqs is built for use
9595

9696
## OQS_USE_OPENSSL
9797

98-
This can be set to `ON` or `OFF`. When `ON`, the additional options `OQS_USE_AES_OPENSSL`, `OQS_USE_SHA2_OPENSSL`, and `OQS_USE_SHA3_OPENSSL` are made available to control whether liboqs uses OpenSSL's AES, SHA-2, and SHA-3 implementations. By default, `OQS_USE_AES_OPENSSL` is `ON` (on x86-64 only if `OQS_DIST_BUILD` and `OQS_USE_AES_INSTRUCTIONS` are not set), `OQS_USE_SHA2_OPENSSL` is `ON` while `OQS_USE_SHA3_OPENSSL` is `OFF`.
98+
In order to save size and limit the mount of different cryptographic code bases, it is possible to use OpenSSL as a crypto code provider by setting this configuration option.
99+
100+
This can be set to `ON` or `OFF`. When `ON`, the additional options `OQS_USE_AES_OPENSSL`, `OQS_USE_SHA2_OPENSSL`, and `OQS_USE_SHA3_OPENSSL` are made available to control whether liboqs uses OpenSSL's AES, SHA-2, and SHA-3 implementations.
101+
102+
By default,
103+
- `OQS_USE_AES_OPENSSL` is `ON` (on x86-64 only if `OQS_DIST_BUILD` and `OQS_USE_AES_INSTRUCTIONS` are not set)
104+
- `OQS_USE_SHA2_OPENSSL` is `ON`
105+
- `OQS_USE_SHA3_OPENSSL` is `OFF`.
106+
107+
These default choices have been made in order to optimize the default performance of all algorithms. Changing them implies performance penalties.
99108

100109
When `OQS_USE_OPENSSL` is `ON`, CMake also scans the filesystem to find the minimum version of OpenSSL required by liboqs (which happens to be 1.1.1). The `OPENSSL_ROOT_DIR` option can be set to aid CMake in its search.
101110

0 commit comments

Comments
 (0)