Skip to content
This repository has been archived by the owner on Jun 8, 2022. It is now read-only.

Complete REST API documentation #77

Open
ansasaki opened this issue Mar 22, 2022 · 2 comments
Open

Complete REST API documentation #77

ansasaki opened this issue Mar 22, 2022 · 2 comments
Assignees

Comments

@ansasaki
Copy link

Some changes to the API were not reflected to the documentation and/or the documentation is missing the description of some fields.

For example: in the cloud agent API documentation, the description for the response to a GET request to /v2.0/quotes/integrity does not include some fields like hash_alg, enc_alg, sign_alg, or pubkey. Also, the example response does not include some of the fields described below it, like ima_measurement_list, ima_measurement_list_entry, and mb_measurement_list. The description of some fields are insufficient to determine the expected format.

@THS-on
Copy link
Member

THS-on commented Mar 29, 2022

@ansasaki thanks for catching that. I thought I fixed all of them, but this is clearly not the case.
If you find a description insufficient can list the entry here, so that I can add a better description?

@mpeters can you assign this to me?

@mpeters mpeters assigned mpeters and THS-on and unassigned mpeters Mar 29, 2022
@ansasaki
Copy link
Author

ansasaki commented May 19, 2022

Some entries that I find insufficient are:

In agent's /v2.0/quotes/identity response specification:

"hash_alg"
"enc_alg"
"sign_alg"
"pubkey"

Specification for the format and accepted values for the fields above are missing.

In agent's /v2.0/quotes/integrity response specification:

"quote"
"hash_alg"
"enc_alg"
"sign_alg"
"pubkey"

Specification for the format and accepted values for the fields above are missing.

ima_measurement_list (string) – (optional) IMA entry list. Is included if IMA_PCR (10) is included in the mask
mb_measurement_list (string) – (optional) UEFI Eventlog list base64 encoded. Is included if PCR 0 is included in the mask

There is no specification for the format of the entries in these lists. It should at least provide an example of a valid entry.

ima_measurement_list_entry (string) – (optional) Starting line offset of the IMA entry list returned

The expected value is also an integer and not a string.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants