AttestationClient class
Аттестация Класс Client.
Класс AttestationClient обеспечивает доступ к API, связанным с аттестацией:
- getOpenIdMetadata
- GetAttestationSigners
- attestSgxEnclave
- attestOpenEnclave
- attestTpm
Конструкторы
Attestation |
Создает экземпляр AttestationClient. Пример использования:
|
Attestation |
Создает экземпляр AttestationClient с параметрами и учетными данными. Пример использования:
Обратите внимание, что для вызова API требуются учетные |
Методы
attest |
Аттестация отчета OpenEnclave, созданного из анклава SGX с помощью пакета SDK OpenEnclave. |
attest |
Подтверждает цитату, созданную из анклава SGX с помощью пакета SDK Intel. |
attest |
Аттестация анклава на основе доверенного платформенного модуля. Дополнительные сведения см. в справочнике по протоколу аттестации TPM . Пример Например, начальный вызов для операции аттестации доверенного платформенного модуля:
где stringToBytes преобразует строку в UTF8. Обратите внимание, что для attestTpm требуется клиент аттестации, настроенный с учетными данными проверки подлинности. |
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 } }
);
Обратите внимание, что для вызова API требуются учетные attestTpm
данные.
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, созданного из анклава SGX с помощью пакета SDK OpenEnclave.
function attestOpenEnclave(report: Uint8Array | Buffer | Blob, options?: AttestOpenEnclaveOptions): Promise<AttestationResponse<AttestationResult>>
Параметры
- report
-
Uint8Array | Buffer | Blob
Отчет OpenEnclave, созданный анклавом SGX.
- options
- AttestOpenEnclaveOptions
Параметры операции для вызова API attestOpenEnclave.
Возвращаемое значение
Promise<AttestationResponse<AttestationResult>>
Возвращает атрибут AttestationResponse, тело которого является AttestationResult, описывающее утверждения, возвращенные службой аттестации.
attestSgxEnclave(Uint8Array | Buffer | Blob, AttestSgxEnclaveOptions)
Подтверждает цитату, созданную из анклава SGX с помощью пакета SDK Intel.
function attestSgxEnclave(quote: Uint8Array | Buffer | Blob, options?: AttestSgxEnclaveOptions): Promise<AttestationResponse<AttestationResult>>
Параметры
- quote
-
Uint8Array | Buffer | Blob
Цитата SGX, созданная анклавом SGX.
- options
- AttestSgxEnclaveOptions
Параметры операции для вызова API attestOpenEnclave.
Возвращаемое значение
Promise<AttestationResponse<AttestationResult>>
Возвращает атрибут AttestationResponse, тело которого является AttestationResult, описывающее утверждения, возвращенные службой аттестации.
attestTpm(string, AttestTpmOptions)
Аттестация анклава на основе доверенного платформенного модуля.
Дополнительные сведения см. в справочнике по протоколу аттестации TPM .
Пример
Например, начальный вызов для операции аттестации доверенного платформенного модуля:
const encodedPayload = JSON.stringify({ payload: { type: "aikcert" } });
const result = await client.attestTpm(encodedPayload);
где stringToBytes преобразует строку в UTF8.
Обратите внимание, что для attestTpm требуется клиент аттестации, настроенный с учетными данными проверки подлинности.
function attestTpm(request: string, options?: AttestTpmOptions): Promise<string>
Параметры
- request
-
string
Входящий запрос для отправки в службу аттестации доверенного платформенного модуля в кодировке Utf8.
- options
- AttestTpmOptions
Параметры конвейера для запроса аттестации доверенного платформенного модуля.
Возвращаемое значение
Promise<string>
Структура, содержащая ответ от аттестации доверенного платформенного модуля в кодировке Utf8.
Комментарии
Входящие запросы к 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 для службы аттестации.