Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify protocol port-range docs for #2065 #2070

Merged
merged 3 commits into from
Nov 15, 2024

Conversation

aj-stein-gsa
Copy link
Contributor

@aj-stein-gsa aj-stein-gsa commented Nov 13, 2024

Committer Notes

This documentation fix clarifies ambiguity about how transport layer ports conform with standards that layer on top of the Internet Protocol (IPv4, IPv6 for now, potentially others in the future), not directly as only as "IPv4 port ranges" as it implies.

Closes #2065.

All Submissions:

By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.

(For reviewers: The wiki has guidance on code review and overall issue review for completeness.)

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable? This repo does not contain model-based/instance-based testing; we will update the GSA FedRAMP Automation Team's test suite accordingly for public review and ongoing use.
  • Have you included examples of how to use your new feature(s)? Not in this repository, but will work with GSA FedRAMP Automation Team to update our constraints and examples accordingly.
  • Have you updated all OSCAL website and readme documentation affected by the changes you made? Changes to the OSCAL website can be made in the docs/content directory of your branch.

@aj-stein-gsa aj-stein-gsa requested a review from a team as a code owner November 13, 2024 01:18
@iMichaela
Copy link
Contributor

@aj-stein-gsa - Port range error has been fixed. The fix is already in the develop branch

@aj-stein-gsa
Copy link
Contributor Author

@aj-stein-gsa - Port range error has been fixed. The fix is already in the develop branch

This PR does not modify the constraint, it clarifies the documentation, specifically in a way that PR did not address. That documentation string has implied, before and after fix, that only mentions IPv4 and is not really about the Internet Protocol.

For context on a related but different issue, you will see discussion from this message and below about a (very common) misunderstandings of transport/IP layer confusion and how that misconstrues what port ranges are valid and/or recommended.

#1772 (comment)

@iMichaela
Copy link
Contributor

@aj-stein-gsa - please submit the PR against the develop branch so we can expedite the patch release once reviewed.

@aj-stein-gsa
Copy link
Contributor Author

aj-stein-gsa commented Nov 13, 2024

@aj-stein-gsa - please submit the PR against the develop branch so we can expedite the patch release once reviewed.

Did you read explicitly what I wrote in the PR message and the related mailing list discussion about hotfix and following NIST OSCAL release guidance? It may seem redundant, but it is important. If you are not willing to accept this PR and accept my proposed plan, please let me know. I will close this PR and plan accordingly.

@iMichaela iMichaela added the Waiting for Action Waiting for an external action to be taken label Nov 14, 2024
@aj-stein-gsa aj-stein-gsa changed the base branch from main to develop November 15, 2024 02:40
@aj-stein-gsa aj-stein-gsa force-pushed the 2065-port-range-docs-fixes branch from eabc7a2 to d48cfa9 Compare November 15, 2024 02:41
@aj-stein-gsa
Copy link
Contributor Author

aj-stein-gsa commented Nov 15, 2024

@iMichaela, against the documented guidance and my recommendations, per your request I rebased and this PR now targets develop. I would welcome the following.

  1. Enable the GitHub Actions workflow to run the CI/CD actions and validate it is good for merge, post-approval.
  2. A review to approve.

By rebasing I reintroduced the deprecated CamelCase datatype variant.
This change reintroduces the new kebab case preferred in Metaschema
models, per @imichael's request during code review.
@iMichaela
Copy link
Contributor

@aj-stein-gsa - Thank you.

Copy link
Contributor

@iMichaela iMichaela left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@iMichaela iMichaela merged commit 708ffcf into usnistgov:develop Nov 15, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Waiting for Action Waiting for an external action to be taken
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation about transport layer ports being IPv4 implies they are not IPv6
2 participants