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

Incorrect Links in Leveraging SSP and Component Definition #69

Closed
rgauss opened this issue May 6, 2021 · 11 comments
Closed

Incorrect Links in Leveraging SSP and Component Definition #69

rgauss opened this issue May 6, 2021 · 11 comments
Labels
bug The issue is a bug report.

Comments

@rgauss
Copy link

rgauss commented May 6, 2021

Describe the bug

  1. The source values in the example component definition reference a relative catalog and profile that contain /content in the path, which is no longer correct. The /content segment of the path should be removed.
  2. The leveraged-authorizations in the example leveraging SSP references a relative link that no longer exists. It is likely intended to point to oscal_leveraged-example_ssp.<format> (and the rel value should probably indicate the correct format).

Who is the bug affecting?

Anyone working with the leveraging SSP and component definition examples.

What is affected by this bug?

The examples are incorrect and developers building tooling around them must compensate.

When does this occur?

Always

How do we replicate the issue?

N/A

Expected behavior (i.e. solution)

Links should be resolvable and correct.

Other Comments

@rgauss rgauss added the bug The issue is a bug report. label May 6, 2021
@rgauss
Copy link
Author

rgauss commented May 19, 2021

It looks like the component definition profile mentioned above will need to point to a different repo and filename as a result of recent commits.

@ohsh6o
Copy link
Contributor

ohsh6o commented May 19, 2021

I had missed this during my PR and did not realize the sample components used the FedRAMP baselines in situ when drafting #70. @david-waltermire-nist, let me know. Since source can be a uri reference in JSON and uri-reference in XML should I just update the URL in a follow up PR?

Something like "source": "https://github.com/GSA/fedramp-automation/blob/master/baselines/json/FedRAMP_HIGH-baseline_profile.json" instead of the relative path?

@ohsh6o
Copy link
Contributor

ohsh6o commented May 19, 2021

Talked to Dave, PR forthcoming.

@ohsh6o
Copy link
Contributor

ohsh6o commented May 19, 2021

@rgauss, howdy, can you tell me if I got them all? The pipeline will generate the fixes from src/examples/xml so sometimes it will seem odd that I am fixing in a different respective format. Let me know if I got it right from eyeballing. I decided to fix not only the FedRAMP relevant things. :-)

@rgauss
Copy link
Author

rgauss commented May 20, 2021

@ohsh6o, looks good from what I'm eyeballing as well, though I think we'll still have the issue of JSON SSP representation pointing to XML references, similar to #59.

@ohsh6o
Copy link
Contributor

ohsh6o commented May 20, 2021

In which SSP? The only SSP I had looked at was that impacted by this issue, and it has an import-profile directive and no a back-matter/resource declaration. That example SSP in JSON form does not even have back matter statements either when put through the pipeline, and the import-profile directive is properly fixed.

Am I missing something in the PRed files or you want me to look at #59 at the same time?

@rgauss
Copy link
Author

rgauss commented May 20, 2021

@ohsh6o, in the leveraging SSP, the leveraged-authorizations href and rel in the JSON representation point to the XML representation.

@iMichaela
Copy link
Contributor

@ohsh6o and @rgauss - the XML reference in the JSON file is caused by the way the JSON content is generated automatically from the XML ones. There is an issue pointing to this fact and we will address it but it might be after 1.0.0 is released

@ohsh6o
Copy link
Contributor

ohsh6o commented May 20, 2021

@ohsh6o, in the leveraging SSP, the leveraged-authorizations href and rel in the JSON representation point to the XML representation.

Sorry I thought you were being literal about placement in back-matter, apologies. Follow-up comment is applicable to Michaela's comment as well.

@ohsh6o and @rgauss - the XML reference in the JSON file is caused by the way the JSON content is generated automatically from the XML ones. There is an issue pointing to this fact and we will address it but it might be after 1.0.0 is released

Thanks for clarifying @iMichaela, I asked Dave to clarify on #59 on that very issue because I asked how to help with particular issue and how it matters here. @rgauss , I am sure you saw that update as well. It might be possible for me to help. I just wanted to clarify that here and now after conversation with Dave because it seems best to keep #74 scoped and not muck around with a significant pipeline enhancement here. :-)

Given that limited scope, I think #74 is ready for review. Sorry, Ray!

@rgauss
Copy link
Author

rgauss commented May 20, 2021

@ohsh6o, sorry, I wasn't very clear in comments above. I was not expecting the XML references to be fixed as part of this issue, I was just mentioning it since those types of references were changed with the PR.

Thanks for your work on this!

david-waltermire pushed a commit that referenced this issue Jun 29, 2021
* Update paths to updated FedRAMP component for #69.
* Fix leveraged SSP href in leveraging SSP.
* And fix NIST 800-53 source profile paths.

Remove `/content/` from relative path structure, like elsewhere. This
reflects the move from a sub-dir of usnistgov/OSCAL to the use of a
discrete and separate repo, usnistgov/oscal-content.

* Changes based on feedback from @rgauss.
* Per review remove edit to post-compilation content.
@david-waltermire
Copy link
Contributor

Merged PR #74, which addresses this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug The issue is a bug report.
Projects
None yet
Development

No branches or pull requests

4 participants