Skip to content

Commit

Permalink
doc: add the description of replay api in readme
Browse files Browse the repository at this point in the history
* add the `replay_cc_eventlog` api descriptions in the readme file
  • Loading branch information
Ruoyu-y committed Apr 7, 2024
1 parent 497076d commit 296dd99
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ The [APIs](common/python/cctrusted_base/api.py) are designed to be vendor agnost
| get_cc_measurement | Get measurement register according to given selected index and algorithms. | imr_select ([int, int]): The first is index of measurement register, the second is the algorithms ID | An integer telling the count of measurement registers |
| get_cc_report | Get the quote for given nonce and data. | nonce: a number used to protect private communications by preventing replay attacks<br> data: the data specified by user<br> extraArgs: the placeholder for extra arguments required in vTPM or other TEE cases | A `CcReport` (i.e. quote) object |
| get_cc_eventlog | Get eventlog for given index and count. | start: the index of the event log to start fetching<br> count: the number of event logs to fetch | A `TcgEventLog` object |
| replay_cc_eventlog | Replay eventlogs fetched through `get_cc_eventlog` api. | event_logs: a list of event logs fetched using `get_cc_eventlog` api | A dict listing the replay result containing information including IMR index number, algorithm using and replayed measurement |

Check warning on line 57 in README.md

View workflow job for this annotation

GitHub Actions / scan_doc

Unknown word (eventlogs)

## 4. SDKs

Expand Down

0 comments on commit 296dd99

Please sign in to comment.