AttestationClient class
證明用戶端類別。
AttestationClient 類別可讓您存取證明相關的 API：
- getOpenIdMetadata
- getAttestationSigners
- attestSgxEnclave
- attestOpenEnclave
- attestTpm
建構函式
| Attestation |
建立 AttestationClient 的實例。 使用方式範例： |
| Attestation |
使用選項和認證建立 AttestationClient 的實例。 使用方式範例： 請注意，需要認證才能呼叫 |
方法
| attest |
證明使用 OpenEnclave SDK 從 SGX 記憶體保護區產生的 OpenEnclave 報表。 |
| attest |
使用 Intel SDK 證明從 SGX 記憶體保護區產生的引號。 |
| attest |
證明以 TPM 為基礎的記憶體保護區。 如需詳細資訊，請參閱 TPM 證明通訊協定參考 。 範例 例如，TPM 證明作業的初始呼叫為： 其中 stringToBytes 會將字串轉換為 UTF8。 請注意，證明Tpm 需要以驗證認證設定的證明用戶端。 |
| get |
傳回可用來簽署證明服務權杖的證明簽署者清單。 |
| get |
傳回證明服務實例的 OpenID 中繼資料探索檔。 |
建構函式詳細資料
AttestationClient(string, AttestationClientOptions)
建立 AttestationClient 的實例。
使用方式範例：
import { AttestationClient } from "@azure/attestation";
const client = new AttestationClient(
"<service endpoint>"
);
new AttestationClient(endpoint: string, options?: AttestationClientOptions)參數
- endpoint
-
string
證明實例基底 URI，例如 https://mytenant.attest.azure.net 。
- options
- AttestationClientOptions
用來設定證明用戶端的選項。
AttestationClient(string, TokenCredential, AttestationClientOptions)
使用選項和認證建立 AttestationClient 的實例。
使用方式範例：
import { AttestationClient } from "@azure/attestation";
const client = new AttestationClient(
"<service endpoint>",
new TokenCredential("<>"),
{ tokenValidationOptions: { validateToken: false } }
);
請注意，需要認證才能呼叫 attestTpm API。
new AttestationClient(endpoint: string, credentials: TokenCredential, options?: AttestationClientOptions)參數
- endpoint
-
string
證明實例基底 URI，例如 https://mytenant.attest.azure.net 。
- credentials
- TokenCredential
用來設定證明用戶端的認證。
- options
- AttestationClientOptions
方法詳細資料
attestOpenEnclave(Uint8Array | Buffer | Blob, AttestOpenEnclaveOptions)
證明使用 OpenEnclave SDK 從 SGX 記憶體保護區產生的 OpenEnclave 報表。
function attestOpenEnclave(report: Uint8Array | Buffer | Blob, options?: AttestOpenEnclaveOptions): Promise<AttestationResponse<AttestationResult>>參數
- report
-
Uint8Array | Buffer | Blob
SGX 記憶體保護區所產生的 OpenEnclave 報表。
- options
- AttestOpenEnclaveOptions
證明OpenEnclave API 呼叫的作業選項。
傳回
Promise<AttestationResponse<AttestationResult>>
會傳回 AttestationResponse，其主體為 AttestationResult，描述證明服務所傳回的宣告。
attestSgxEnclave(Uint8Array | Buffer | Blob, AttestSgxEnclaveOptions)
使用 Intel SDK 證明從 SGX 記憶體保護區產生的引號。
function attestSgxEnclave(quote: Uint8Array | Buffer | Blob, options?: AttestSgxEnclaveOptions): Promise<AttestationResponse<AttestationResult>>參數
- quote
-
Uint8Array | Buffer | Blob
SGX 記憶體保護區所產生的 SGX 引號。
- options
- AttestSgxEnclaveOptions
證明OpenEnclave API 呼叫的作業選項。
傳回
Promise<AttestationResponse<AttestationResult>>
會傳回 AttestationResponse，其主體為 AttestationResult，描述證明服務所傳回的宣告。
attestTpm(string, AttestTpmOptions)
證明以 TPM 為基礎的記憶體保護區。
如需詳細資訊，請參閱 TPM 證明通訊協定參考 。
範例
例如，TPM 證明作業的初始呼叫為：
const encodedPayload = JSON.stringify({ payload: { type: "aikcert" } });
const result = await client.attestTpm(encodedPayload);
其中 stringToBytes 會將字串轉換為 UTF8。
請注意，證明Tpm 需要以驗證認證設定的證明用戶端。
function attestTpm(request: string, options?: AttestTpmOptions): Promise<string>參數
- request
-
string
傳送至 TPM 證明服務的傳入要求，Utf8 編碼。
- options
- AttestTpmOptions
TPM 證明要求的管線選項。
傳回
Promise<string>
結構，包含 TPM 證明的回應，Utf8 編碼。
備註
TPM 證明 API 的傳入要求是字串化的 JSON 物件。
getAttestationSigners(AttestationClientOperationOptions)
傳回可用來簽署證明服務權杖的證明簽署者清單。
function getAttestationSigners(options?: AttestationClientOperationOptions): Promise<AttestationSigner[]>參數
用戶端作業選項。
傳回
Promise<AttestationSigner[]>
可用來簽署證明權杖的 AttestationSigners 集合。
getOpenIdMetadata(AttestationClientOperationOptions)
傳回證明服務實例的 OpenID 中繼資料探索檔。
function getOpenIdMetadata(options?: AttestationClientOperationOptions): Promise<Record<string, unknown>>參數
用戶端作業選項。
傳回
Promise<Record<string, unknown>>
證明服務的 OpenID 中繼資料探索檔。