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.

Sign up for GitHub

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

python/cctrusted_vm: correct naming in docstring #17

Merged
merged 1 commit into from
Mar 4, 2024
Merged

python/cctrusted_vm: correct naming in docstring #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/python/cctrusted_vm/cvm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,9 @@ def process_eventlog(self) -> bool:

@abstractmethod
def get_cc_report(self, nonce: bytearray, data: bytearray, extraArgs) -> CcReport:
"""Get the quote for given nonce and data.
"""Get the CcReport (i.e. quote) for given nonce and data.

The quote is signing of attestation data (IMR values or hashes of IMR
The CcReport is signing of attestation data (IMR values or hashes of IMR
values), made by a trusted foundation (TPM) using a key trusted by the
verifier.

Expand All @@ -134,7 +134,7 @@ def get_cc_report(self, nonce: bytearray, data: bytearray, extraArgs) -> CcRepor
extraArgs: for TPM, it will be given list of IMR/PCRs

Returns:
The ``Quote`` object.
The ``CcReport`` object.
"""
raise NotImplementedError("Should be implemented by inherited class")

Expand Down Expand Up @@ -379,7 +379,7 @@ def process_eventlog(self) -> bool:


def get_cc_report(self, nonce: bytearray, data: bytearray, extraArgs) -> CcReport:
"""Get quote.
"""Get CcReport (i.e. TD Quote in the context of TDX).

This depends on Quote Generation Service. Please reference "Whitepaper:
Linux* Stacks for Intel® Trust Domain Extensions (4.3 Attestation)" for
Expand All @@ -396,7 +396,7 @@ def get_cc_report(self, nonce: bytearray, data: bytearray, extraArgs) -> CcRepor
extraArgs: for TPM, it will be given list of IMR/PCRs

Returns:
The ``Quote`` object.
The ``CcReport`` object. Return None if it fails.

Raises:
binascii.Error when the parameter "nonce" or "data" is not base64 encoded.
Expand Down
6 changes: 3 additions & 3 deletions src/python/cctrusted_vm/sdk.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,9 @@ def get_cc_report(
data: bytearray = None,
extraArgs = None
) -> CcReport:
"""Get the quote for given nonce and data.
"""Get the CcReport (i.e. quote) for given nonce and data.

The quote is signing of attestation data (IMR values or hashes of IMR
The CcReport is signing of attestation data (IMR values or hashes of IMR
values), made by a trusted foundation (TPM) using a key trusted by the
verifier.

Expand All @@ -112,7 +112,7 @@ def get_cc_report(
extraArgs: for TPM, it will be given list of IMR/PCRs

Returns:
The ``Quote`` object.
The ``CcReport`` object. Return None if it fails.
"""
return self._cvm.get_cc_report(nonce, data, extraArgs)

Expand Down