documentation + an explicit EAT profile #10
Conversation
* add a docs.go file with examples for how to use the API * add godoc comments to public-facing types and methods * add an eat_profile claim to the AttestationResult object * hide non-public methods Fix #5 Partially addresses #9 by defining an eat_profile claim Signed-off-by: Thomas Fossati <thomas.fossati@arm.com>
tclaim.go
Outdated
| // TrustTier provides the trust tier bucket of the trustworthiness claim | ||
| func (o TClaim) TrustTier(color bool) string { | ||
| // trustTier provides the trust tier bucket of the trustworthiness claim | ||
| func (o TClaim) trustTier(color bool) string { |
There was a problem hiding this comment.
Why has this been hidden? It seems that being able to easily get trust tier from a claim (and the associated Is checks below) would be generally useful?
There was a problem hiding this comment.
My plan was to only expose this through the Report() method. But yeah, it'd be a tad myopic to focus on just one use case (i.e., that of a CLI parsing the AR). Will change, thanks for the input.
There was a problem hiding this comment.
done in 10718e5
| type AttestationResult struct { | ||
| Status *TrustTier `json:"status"` | ||
| Profile *string `json:"eat_profile"` |
There was a problem hiding this comment.
What is the purpose of adding profile?
I thought the AttestationResult Object should be profile Agnostic, so that any RP can assess the Verification Results coming from any Verifier?
There was a problem hiding this comment.
What is the purpose of adding profile?
to make it an EAT -- see also #9
I thought the AttestationResult Object should be profile Agnostic, so that any RP can assess the Verification Results coming from any Verifier?
I am not sure I understand what you mean by "profile agnostic"
Signed-off-by: Thomas Fossati <thomas.fossati@arm.com>
Fix #5
Partially addresses #9 by defining an eat_profile claim
Signed-off-by: Thomas Fossati thomas.fossati@arm.com