wolfSSL / wolfssl

The wolfSSL library is a small, fast, portable implementation of TLS/SSL for embedded devices to the cloud. wolfSSL supports up to TLS 1.3 and DTLS 1.3!
https://www.wolfssl.com
GNU General Public License v2.0
2.36k stars 834 forks source link

[Bug]: wolfSSL_CTX_use_certificate_buffer documentation argument nits #8144

Open bagder opened 2 weeks ago

bagder commented 2 weeks ago

Contact Details

reply here

Version

current online docs

Description

The example snippet for wolfSSL_CTX_use_certificate_buffer does two "suspicious" things:

  1. it sets sz to zero, when it should be the size of the buffer
  2. the third argument wants a long so sz is using the wrong type

Reproduction steps

No response

Relevant log output

No response

bagder commented 2 weeks ago

This same mistake exists for multiple function calls in the documentation.

ColtonWilley commented 2 weeks ago

@bagder I have a PR up here https://github.com/wolfSSL/wolfssl/pull/8161 which should fix this issue, please let me know if you had something else in mind.