Skip to content

Commit

Permalink
Updated chapter 02, Features Defined as C Pre-processor Macro. In add…
Browse files Browse the repository at this point in the history
…ition, I also created a shared wolfSSL Macro Documentation sheets in hopes that it can be updated as new macros are created so we have an ongoing, easy to reference list.

Here is the link that can only be accessed by being apart of the wolfSSL engineering shared drive: https://docs.google.com/spreadsheets/d/10rEf_mU7xul9BoIebyhasugUxSXVuHXhkkb7bnbtjXA/edit?usp=sharing
- spelling fixes and corrections.
  • Loading branch information
aidan garske committed Jun 17, 2024
1 parent 1c8a65b commit e772901
Showing 1 changed file with 17 additions and 29 deletions.
46 changes: 17 additions & 29 deletions wolfSSL/src/chapter02.md
Original file line number Diff line number Diff line change
Expand Up @@ -440,11 +440,11 @@ Used for compiling out special characters that embedded devices may have problem
#### NO_OLD_SSL_NAMES
Removes unended namespace.
Removes unneeded namespace.
#### NO_OLD_WC_NAMES
Removes unended namespace.
Removes unneeded namespace.
#### NO_OLD_POLY1305
Expand Down Expand Up @@ -500,7 +500,7 @@ No default ticket encryption callback, server only. The application must set its

#### WOLFSSL_NO_SOCK

Board-specific, no sock platform.
Board-specific, no socket platform.

#### WOLFSSL_NO_TLS12

Expand Down Expand Up @@ -936,23 +936,23 @@ Used as a guard on redeclaration.
#### WOLFSSL_DH_TYPE_DEFINED
Used as redeclaration gaurd for DH.
Used as redeclaration guard for DH.
#### WOLFSSL_DSA_TYPE_DEFINED
Used as redeclaration gaurd for DSA.
Used as redeclaration guard for DSA.
#### WOLFSSL_EC_TYPE_DEFINED
Used as redeclaration gaurd for EC.
Used as redeclaration guard for EC.
#### WOLFSSL_RSA_TYPE_DEFINED
Used as redeclaration gaurd for RSA.
Used as redeclaration guard for RSA.
#### WOLFSSL_ECDSA_TYPE_DEFINED
Used as redeclaration gaurd for ECDSA.
Used as redeclaration guard for ECDSA.
#### WOLFSSL_DTLS_EXPORT_TYPES
Expand Down Expand Up @@ -1024,11 +1024,11 @@ Implements the use of AEAD and is required for TLS 1.3.
#### HAVE_AES_CBC
Used In the case when Static RSA is needed.
Enable option for AES.
#### HAVE_AES_DECRYPT
Enables AES to decrypt symmetric cypher.
This setting controls whether the decrypt direction of the various AES modes is supported.
#### HAVE_ALPN
Expand Down Expand Up @@ -1060,7 +1060,7 @@ Define for Curve448 support. Additional macro settings can be changed. The defau
#### HAVE_DANE
To verify Raw Public Key cert, DANE(RFC6698) add macro HAVE_DANE for dane authentification.
This macro is a protocol that uses DNSSEC(domain lookup with crypto signatures) to allow certificates to be validated without depending certificate authority. This can provide a stronger garuntee of legitamicy. To verify Raw Public Key cert, DANE(RFC6698) add macro HAVE_DANE for DANE authentication.
#### HAVE_DILITHIUM
Expand All @@ -1086,10 +1086,6 @@ Enables post-quantum crypto FALCON from OpenQuantumSafe.
Used when implementing different FIPS versions.
#### HAVE_FUZZER
Used when implementing different F versions.
#### HAVE_KEYING_MATERIAL
Enables exporting keying material based on section 7.5 of RFC 8446.
Expand Down Expand Up @@ -1200,19 +1196,19 @@ Enables user-defined PSK cipher.
#### WOLFSSL_OLD_PRIME_CHECK
Enable feature which uses faster DH prime checking.
Enable feature which uses faster DH and RSA prime checking.
#### WOLFSSL_STATIC_RSA
Static ciphers are strongly discouraged and should never be used if avoidable. However there are still legacy systems that ONLY support static cipher suites. To that end if you need to connect to a legacy peer only supporting static RSA cipher suites use this to enable support for static RSA in wolfSSL. (See also [`WOLFSSL_STATIC_PSK`](#wolfssl_static_psk) and [`WOLFSSL_STATIC_DH`](#wolfssl_static_dh))
#### WOLFSSL_STATIC_PSK
Static ciphers are highly discouraged see [`WOLFSSL_STATIC_RSA`](#wolfssl_static_rsa)
Feature that enables static PSK cipher suites. Static ciphers are highly discouraged see [`WOLFSSL_STATIC_RSA`](#wolfssl_static_rsa)
#### WOLFSSL_STATIC_DH
Static ciphers are highly discouraged see [`WOLFSSL_STATIC_RSA`](#wolfssl_static_rsa)
Feature that enables static ECDH cipher suites. Static ciphers are highly discouraged see [`WOLFSSL_STATIC_RSA`](#wolfssl_static_rsa)
#### HAVE_NULL_CIPHER
Expand Down Expand Up @@ -1513,7 +1509,7 @@ Cleanup of the socket close code used, for example, CRL/OCSP and BIO, to use sin
#### CONFIG_POSIX_API
We need POSIX names for networking systems calls. This can either be enabled with CONFIG_NET_SOCKETS_POSIX_NAMES or with CONFIG_POSIX_API. This commit enables support for the latter."
Enables POSIX names for networking systems calls.
#### WOLFSSL_USER_CURRTIME
Expand All @@ -1531,21 +1527,13 @@ Identifies the minimum number of bits in ECCkey.
Identifies the minimum number of bits in RSA key.
#### EXIT_FAILURE
Defined as 1 and is implemented to exit with a failure.
#### EXIT_SUCCESS
Defined as 0 but exits with success.
#### EXTERNAL_SERIAL_SIZE
A raw serial number byte that writes X509 serial numbers in unsigned binary to a buffer. For all cases, the buffer needs to be at least EXTERNAL_SERIAL_SIZE (32). On success, it returns WOLFSSL_SUCCESS.
#### FIPS_VERSION_GE
Define for use with FIPSv2.
Define for use with general FIPS version comparisons.
#### LARGE_STATIC_BUFFERS
Expand Down Expand Up @@ -2086,7 +2074,7 @@ Enable Single-Precision (SP) S390X assembly speedup macros. Only applies if `WOL
#### SP_INT_BITS
Single-Precision (SP) assembly speedup macro. Math configuration that can specify size.
The number of bits to have in an sp_int. Which can determine the largest bignum that the library can handle.
### Stack or Chip Specific Defines
Expand Down

0 comments on commit e772901

Please sign in to comment.