AttestationClient class

Pakket:: @azure/attestation

Attestation Client-klasse.

De attestationClient-klasse maakt toegang tot de attestation-gerelateerde API's mogelijk:

getOpenIdMetadata
getAttestationSigners
attestSgxEnclave
attestOpenEnclave
attestTpm

Constructors

AttestationClient(string, AttestationClientOptions)

Hiermee maakt u een exemplaar van AttestationClient.

Voorbeeldgebruik:

import { AttestationClient } from "@azure/attestation";

const client = new AttestationClient(
   "<service endpoint>"
);

AttestationClient(string, TokenCredential, AttestationClientOptions)

Hiermee maakt u een exemplaar van AttestationClient met opties en referenties.

Voorbeeldgebruik:

import { AttestationClient } from "@azure/attestation";

const client = new AttestationClient(
   "<service endpoint>",
   new TokenCredential("<>"),
   { tokenValidationOptions: { validateToken: false } }
);

Houd er rekening mee dat referenties vereist zijn om de attestTpm-API aan te roepen.

Methoden

attestOpenEnclave(Uint8Array \| Buffer \| Blob, AttestOpenEnclaveOptions)	Bevestigt een OpenEnclave-rapport dat is gegenereerd op basis van een SGX-enclave met behulp van de OpenEnclave-SDK.
attestSgxEnclave(Uint8Array \| Buffer \| Blob, AttestSgxEnclaveOptions)	Attests een offerte die is gegenereerd op basis van SGX Enclave met behulp van de Intel SDK.
attestTpm(string, AttestTpmOptions)	Getuig van een op TPM gebaseerde enclave. Zie de TPM Attestation Protocol Reference voor meer informatie. voorbeeld van De eerste aanroep voor een TPM-attestation-bewerking is bijvoorbeeld: `const encodedPayload = JSON.stringify({ payload: { type: "aikcert" } }); const result = await client.attestTpm(encodedPayload);` waarbij stringToBytes de tekenreeks converteert naar UTF8. Houd er rekening mee dat voor attestTpm een attestation-client is vereist die is geconfigureerd met verificatiereferenties.
getAttestationSigners(AttestationClientOperationOptions)	Retourneert de lijst met attestation-ondertekenaars die kunnen worden gebruikt voor het ondertekenen van attestation-servicetokens.
getOpenIdMetadata(AttestationClientOperationOptions)	Retourneert het OpenID Metadata Discovery-document voor het attestation-service-exemplaar.

Constructordetails

AttestationClient(string, AttestationClientOptions)

Hiermee maakt u een exemplaar van AttestationClient.

Voorbeeldgebruik:

import { AttestationClient } from "@azure/attestation";

const client = new AttestationClient(
   "<service endpoint>"
);

new AttestationClient(endpoint: string, options?: AttestationClientOptions)

Parameters

endpoint: string

De basis-URI van het Attestation-exemplaar, bijvoorbeeld https://mytenant.attest.azure.net.

options: AttestationClientOptions

Opties die worden gebruikt om de Attestation-client te configureren.

AttestationClient(string, TokenCredential, AttestationClientOptions)

Hiermee maakt u een exemplaar van AttestationClient met opties en referenties.

Voorbeeldgebruik:

import { AttestationClient } from "@azure/attestation";

const client = new AttestationClient(
   "<service endpoint>",
   new TokenCredential("<>"),
   { tokenValidationOptions: { validateToken: false } }
);

Houd er rekening mee dat referenties vereist zijn om de attestTpm-API aan te roepen.

new AttestationClient(endpoint: string, credentials: TokenCredential, options?: AttestationClientOptions)

Parameters

endpoint: string

De basis-URI van het Attestation-exemplaar, bijvoorbeeld https://mytenant.attest.azure.net.

credentials: TokenCredential

Referenties die worden gebruikt om de Attestation-client te configureren.

options: AttestationClientOptions

Methodedetails

attestOpenEnclave(Uint8Array | Buffer | Blob, AttestOpenEnclaveOptions)

Bevestigt een OpenEnclave-rapport dat is gegenereerd op basis van een SGX-enclave met behulp van de OpenEnclave-SDK.

function attestOpenEnclave(report: Uint8Array | Buffer | Blob, options?: AttestOpenEnclaveOptions): Promise<AttestationResponse<AttestationResult>>

Parameters

report: Uint8Array | Buffer | Blob

Een OpenEnclave-rapport gegenereerd door een SGX-enclave.

options: AttestOpenEnclaveOptions

Bewerkingsopties voor de attestOpenEnclave API-aanroep.

Retouren

Promise<AttestationResponse<AttestationResult>>

Hiermee wordt een AttestationResponse geretourneerd waarvan de hoofdtekst een AttestationResult is waarin de claims worden beschreven die door de Attestation-service worden geretourneerd.

attestSgxEnclave(Uint8Array | Buffer | Blob, AttestSgxEnclaveOptions)

Attests een offerte die is gegenereerd op basis van SGX Enclave met behulp van de Intel SDK.

function attestSgxEnclave(quote: Uint8Array | Buffer | Blob, options?: AttestSgxEnclaveOptions): Promise<AttestationResponse<AttestationResult>>

Parameters

quote: Uint8Array | Buffer | Blob

Een SGX-offerte gegenereerd door een SGX-enclave.

options: AttestSgxEnclaveOptions

Bewerkingsopties voor de attestOpenEnclave API-aanroep.

Retouren

Promise<AttestationResponse<AttestationResult>>

Hiermee wordt een AttestationResponse geretourneerd waarvan de hoofdtekst een AttestationResult is waarin de claims worden beschreven die door de Attestation-service worden geretourneerd.

attestTpm(string, AttestTpmOptions)

Getuig van een op TPM gebaseerde enclave.

Zie de TPM Attestation Protocol Reference voor meer informatie.

voorbeeld van

De eerste aanroep voor een TPM-attestation-bewerking is bijvoorbeeld:

const encodedPayload = JSON.stringify({ payload: { type: "aikcert" } });
const result = await client.attestTpm(encodedPayload);

waarbij stringToBytes de tekenreeks converteert naar UTF8.

Houd er rekening mee dat voor attestTpm een attestation-client is vereist die is geconfigureerd met verificatiereferenties.

function attestTpm(request: string, options?: AttestTpmOptions): Promise<string>

Parameters

request: string

Binnenkomende aanvraag voor verzenden naar de TPM-attestation-service, gecodeerd met Utf8.

options: AttestTpmOptions

Pijplijnopties voor TPM-attestation-aanvraag.

Retouren

Promise<string>

Een structuur met het antwoord van de TPM-attestation, Utf8 gecodeerd.

Opmerkingen

De binnenkomende aanvragen voor de TPM-attestation-API zijn getekende JSON-objecten.

getAttestationSigners(AttestationClientOperationOptions)

Retourneert de lijst met attestation-ondertekenaars die kunnen worden gebruikt voor het ondertekenen van attestation-servicetokens.

function getAttestationSigners(options?: AttestationClientOperationOptions): Promise<AttestationSigner[]>

Parameters

options: AttestationClientOperationOptions

Opties voor clientbewerkingen.

Retouren

Promise<AttestationSigner[]>

de set AttestationSigners die kunnen worden gebruikt om attestation-tokens te ondertekenen.

getOpenIdMetadata(AttestationClientOperationOptions)

Retourneert het OpenID Metadata Discovery-document voor het attestation-service-exemplaar.

function getOpenIdMetadata(options?: AttestationClientOperationOptions): Promise<Record<string, unknown>>

Parameters

options: AttestationClientOperationOptions

Opties voor clientbewerkingen.

Retouren

Promise<Record<string, unknown>>

Het OpenID-document voor metagegevensdetectie voor de Attestation-service.