Link porting guide table to header documentation #1540
Conversation
| SSL_set_hostflags<br> | ||
| </a> | ||
| <br> | ||
| <a href="https://www.openssl.org/docs/manmaster/man3/X509_VERIFY_PARAM_get0_peername.html"> |
There was a problem hiding this comment.
Can we add the required documentation to our header files and link to that instead of OpenSSL?
There was a problem hiding this comment.
I opted for this only because the functions were all over the place in the headers, but did similar things. I can add documentation to these functions, but I'll have to create a follow up PR to update the links.
There was a problem hiding this comment.
I noticed upstream had some commits to finish documenting x509.h: google/boringssl@5bed5b9
The documentation is much more robust here, should we prioritize taking these commits instead?
There was a problem hiding this comment.
Stole some documentation from google/boringssl@5bed5b9 prematurely and added a "TODO" to update the links once we officially take it. There's a large assortment of commits in the header file so we'll want to take these incrementally.
Updating the related functions now is better than the current state of no documentation. Will create a follow up PR to link the table to the new text.
d52018b Minor functions to build with Ruby's cipher module (#1564) 364d28b Changed SSL_client_hello_get0_ciphers to align with OpenSSL behavior (#1542) e8eb7de ppc64le: EVP_has_aes_hardware is false w/ no-asm (#1566) d726d06 OpenBSD 7.4 and 7.5 Support (#1437) a66c66e Remove comments about overread for entropy generation (#1551) f8a575f Migrate from __FreeBSD__ to __FreeBSD_version (#1562) c31d1ce Centralize handling of s2n-bignum alt/non-alt function selection (#1547) 00f3c45 CI for other MacOS versions (#1558) 0541314 Cleanup remaing duplicate symbol definitions and turn Wredundant-decls on (#1561) 4d280eb Fix ec2 CI testing framework (#1541) 9a4b43e Update x25519_test.cc array initialization to avoid a bug with a GCC 13 warning (#1555) 388cbe7 Remove duplicate X509_OBJECT_new and X509_OBJECT_free declarations (#1560) 2ea6706 Avoid 'z' format with MSVCRT (#1559) c25dc2a Add dependency to python3-six in github action grpc (#1554) 2bdcba3 Link porting guide table to header documentation (#1540) 311ca38 Basic GH CI build/test with full range of gcc/clang (#1546) 1f19717 Add SHA3-256 KAT to FIPS self-test (#1549) 0f3548a Add EC point add/dbl to speed.cc (#1545) d7ddfc4 Fix the NTP integration test (NTP website changed) (#1548) 8ccd85b Fix skipped tests in Mariadb integration CI (#1533) d940162 Support vpinsrq in delocater (#1543) 4cd6d21 Remove redundant test exec libraries (#1544) 56f3569 [ML-KEM] Add experimental support for ML-KEM-512-IPD (#1516) c295aef Upstream merge 2024 04 16 (#1535) 2e51629 Re-add function 0aebf17 Define OPENSSL_NO_TLS_PHA, typedef PSK callback signatures (#1526) 46056cf Pull the string-based extensions APIs into their own section 960ea42 Unexport X509_VERIFY_PARAM_lookup 3c597b1 Remove X509_VERIFY_PARAM_get0_peername 9c399e5 Document some key usage accessors 2fe70b5 Simplify and document X509_supported_extension 2e04897 Const-correct X509_LOOKUP_METHOD 9826568 Replace X509_LOOKUP_ctrl with real functions e47c056 Tidy up x509_lu.c functions a little 62e019f Clean up the by_file_ctrl x509 code to be slightly less obtuse 45c46c2 Use relative links in markdown files By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and the ISC license.
Description of changes:
This finalizes the changes for the previous two documentation PRS: #1463 and #1473. Now that these two PRs are in, we have a commit to link the header documentation from the table.
Call-outs:
N/A
Testing:
N/A
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and the ISC license.