aws
Link to Doxygen from the USAGE-GUIDE
Security issue notifications
If you discover a potential security issue in s2n we ask that you notify AWS Security via our vulnerability reporting page. Please do not create a public github issue.
Problem:
Moving the API documentation from the USAGE-GUIDE.md to Doxygen removed links to function definitions in the Usage Guide. This makes it harder to read the Usage Guide because API documentation is no longer linked to.
Solution:
We should come up with a solution that allows the Usage Guide to link to Doxygen API definitions. This may be solve-able by modifying the Doxygen configuration or writing a script to generate the links.
- Does this change what S2N sends over the wire? No
- Does this change any public APIs? No
- Which versions of TLS will this impact? No
Requirements / Acceptance Criteria:
What must a solution address in order to solve the problem? How do we know the solution is complete? When the Usage Guide has a link to a Doxygen definition for every API that is mentioned.
- RFC links: Links to relevant RFC(s)
- Related Issues: Link any relevant issues
- Will the Usage Guide or other documentation need to be updated?
-
Testing: How will this change be tested? Call out new integration tests, functional tests, or particularly interesting/important unit tests.
- Will this change trigger SAW changes? Changes to the state machine, the s2n_handshake_io code that controls state transitions, the DRBG, or the corking/uncorking logic could trigger SAW failures.
- Should this change be fuzz tested? Will it handle untrusted input? Create a separate issue to track the fuzzing work.
Out of scope:
Is there anything the solution will intentionally NOT address?
It's uncertain whether Doxygen provides stable links to APIs. We don't know what the hashes are or when they change.
