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

RD AD: editorial comments #357

Closed
mcr opened this issue Nov 16, 2021 · 10 comments
Closed

RD AD: editorial comments #357

mcr opened this issue Nov 16, 2021 · 10 comments
Labels
wontfix Should respond via email but does not warrant doc changes

Comments

@mcr
Copy link
Collaborator

mcr commented Nov 16, 2021

** Section 3.3.  Editorial. s/In consequence/Consequently,/

** Section 4.  The following terms appeared repeatedly in the document but were defined here: root of trust, target environment, and lead attester.  Should they be?

** Section 4.1. Relying Party.  Figure 1 says that the relying party also consume the "Appraisal Policy for Attestation Results" by that isn't noted here.

** Section 4.*.  Editorial.  
-- Section 4.1.  In the definition of relying party, what does the sentence fragment "Compare /relying party/ in [RFC4949]" mean?
-- Section 4.2.  Per the definition of "Claim", what does "Compare /claim/ in [RFC7519]" mean?
-- Section 4.3.  Per the definition of "Appraisal Policy for Attestation Results", what does "Compare /security policy/ in [RFC4949]" mean?

** Section 4.2.  Claim is the only definition that doesn't explicitly call out what "consumes" and "produces" it.
````
@mcr
Copy link
Collaborator Author

mcr commented Nov 16, 2021

** Section 8.1.  In the spirit of inclusive terminology please use alternative phrasing for "man-in-the-middle attackers".

@mcr
Copy link
Collaborator Author

mcr commented Nov 16, 2021

** Section 11.  Typo. s/are disclosed/is disclosed/?

@mcr
Copy link
Collaborator Author

mcr commented Nov 16, 2021

** Section 12.1.2.1.  Editorial.

OLD
So, this is why, in general, ...

NEW
Commonly,

** Section 12.2.  Editorial.  The section title of "Integrity Protection" seems narrow given the content of this section.

@henkbirkholz
Copy link
Member

henkbirkholz commented Nov 16, 2021

** Section 3.3. Editorial. s/In consequence/Consequently,/

Comment on Section 3.3 addressed in dfe38d9

@henkbirkholz
Copy link
Member

** Section 4. The following terms appeared repeatedly in the document but were defined here: root of trust, target environment, and lead attester. Should they be?

That has been a long discussion with a few hence of forth. It might look not ideal, but there was no consensus to move it to a more prominent position or even to the terminology (as it is not really a special term to this document, just a very important one). I am hesitant to touch this again. Any other thoughts?

@henkbirkholz
Copy link
Member

** Section 4.1. Relying Party. Figure 1 says that the relying party also consume the "Appraisal Policy for Attestation Results" by that isn't noted here.

Good catch. Fixed in 1556f1e

@henkbirkholz
Copy link
Member

henkbirkholz commented Nov 16, 2021

** Section 4.*. Editorial.
-- Section 4.1. In the definition of relying party, what does the sentence fragment "Compare /relying party/ in [RFC4949]" mean?
-- Section 4.2. Per the definition of "Claim", what does "Compare /claim/ in [RFC7519]" mean?
-- Section 4.3. Per the definition of "Appraisal Policy for Attestation Results", what does "Compare /security policy/ in [RFC4949]" mean?

The note for comparison is intended to encourage the reader to get more context about the meaning of Relying Parties outside of the terminology specific use in this document. Should we not do this? Or should we do we do this differently? I am okay with this, I think.

Same for 4.2 and 4.3. Thoughts?

@henkbirkholz
Copy link
Member

** Section 4.2. Claim is the only definition that doesn't explicitly call out what "consumes" and "produces" it.

That is intentional. It is actually the only term that is neither about a conceptual message nor a role. It still work slightly different than the encoding specific claim definitions in web tokens and belongs into the terminology. I understand that is a little bit surprising this way, but I do not see an elegant way to fix this without reducing the readability of the text. Anybody else has a proposal? Otherwise, I would leave it be.

@mcr
Copy link
Collaborator Author

mcr commented Nov 19, 2021

Reply to items with a heart.

@mcr mcr added the wontfix Should respond via email but does not warrant doc changes label Nov 19, 2021
@mcr
Copy link
Collaborator Author

mcr commented Dec 9, 2021

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix Should respond via email but does not warrant doc changes
Projects
None yet
Development

No branches or pull requests

2 participants