aws / aws/s2n-tls

Broken RFC links in duvet-compatible comments

Open
#4,002 0 comments 0 reactions 0 assignees View on GitHub
priority/low size/small
Dominant language
C
Stars
4.8k
Forks
803
Avg merge
5d 22h
Merged PRs (30d)
33

Description

### Problem:

While trying to a generate duvet report locally, the following errors were found:

`tests/unit/s2n_key_update_test.c#103:11 - section "6" not found in "https://tools.ietf.org/rfc/rfc9001.txt"
tests/unit/s2n_quic_transport_params_extension_test.c#73:11 - section "8.2" not found in "https://tools.ietf.org/rfc/rfc9001.txt"
tls/s2n_tls_parameters.h#116:3 - section "8.2" not found in "https://tools.ietf.org/rfc/rfc9001.txt"
source errors were found. no reports were generated`

The links to sections in `rfc9001` are broken and don't point to the specific sections. The same error showed up in a PR and the compliance/duvet(pull_request) job was failing. However, this seems to be flaky error and a re-run of the CI job fixed the issue on PR.
### Solution:

Fix broken `rfc9001` links and add `rfc9001` to extracted list of rfc's in initialize_duvet.sh

### Requirements / Acceptance Criteria:

What must a solution address in order to solve the problem? How do we know the solution is complete?

* **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?

[//]: # (NOTE: If you believe this might be a security issue, please email aws-security@amazon.com instead of creating a GitHub issue. For more details, see the AWS Vulnerability Reporting Guide: https://aws.amazon.com/security/vulnerability-reporting/ )

Contributor guide

Open the contributing guide

Research direction

Start with the RFC comments at tests/unit/s2n_key_update_test.c:103, tests/unit/s2n_quic_transport_params_extension_test.c:73, and tls/s2n_tls_parameters.h:116, then inspect initialize_duvet.sh. Run the local Duvet report to reproduce the missing-section errors, update the rfc9001 links and extracted RFC list, and rerun the report to confirm generation succeeds.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, shell
Domain
documentation, tooling
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.