AttestationClient class

Clase client de atestación.

La clase AttestationClient permite el acceso a las API relacionadas con la atestación:

  • getOpenIdMetadata
  • getAttestationSigners
  • attestSgxEnclave
  • attestOpenEnclave
  • attestTpm

Constructores

AttestationClient(string, AttestationClientOptions)

Crea una instancia de AttestationClient.

Uso de ejemplo:

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

const client = new AttestationClient(
   "<service endpoint>"
);
AttestationClient(string, TokenCredential, AttestationClientOptions)

Crea una instancia de AttestationClient con opciones y credenciales.

Uso de ejemplo:

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

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

Tenga en cuenta que se requieren credenciales para llamar a la attestTpm API.

Métodos

attestOpenEnclave(Uint8Array | Buffer | Blob, AttestOpenEnclaveOptions)

Atestigua un informe de OpenEnclave generado a partir de un enclave SGX mediante el SDK de OpenEnclave.

attestSgxEnclave(Uint8Array | Buffer | Blob, AttestSgxEnclaveOptions)

Atestigua una cotización generada a partir de SGX Enclave utilizando el SDK de Intel.

attestTpm(string, AttestTpmOptions)

Atestigüe un enclave basado en TPM.

Consulte la Referencia del protocolo de atestación de TPM para obtener más información.

Ejemplo

Por ejemplo, la llamada inicial para una operación de atestación de TPM es:

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

donde stringToBytes convierte la cadena en UTF8.

Tenga en cuenta que attestTpm requiere un cliente de atestación que esté configurado con credenciales de autenticación.

getAttestationSigners(AttestationClientOperationOptions)

Devuelve la lista de firmantes de atestación que se pueden usar para firmar tokens de servicio de atestación.

getOpenIdMetadata(AttestationClientOperationOptions)

Devuelve el documento de detección de metadatos de OpenID para la instancia del servicio de atestación.

Detalles del constructor

AttestationClient(string, AttestationClientOptions)

Crea una instancia de AttestationClient.

Uso de ejemplo:

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

const client = new AttestationClient(
   "<service endpoint>"
);
new AttestationClient(endpoint: string, options?: AttestationClientOptions)

Parámetros

endpoint

string

URI base de la instancia de atestación, por ejemplo, https://mytenant.attest.azure.net.

options
AttestationClientOptions

Opciones utilizadas para configurar el cliente de atestación.

AttestationClient(string, TokenCredential, AttestationClientOptions)

Crea una instancia de AttestationClient con opciones y credenciales.

Uso de ejemplo:

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

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

Tenga en cuenta que se requieren credenciales para llamar a la attestTpm API.

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

Parámetros

endpoint

string

URI base de la instancia de atestación, por ejemplo, https://mytenant.attest.azure.net.

credentials
TokenCredential

Credenciales usadas para configurar el cliente de atestación.

Detalles del método

attestOpenEnclave(Uint8Array | Buffer | Blob, AttestOpenEnclaveOptions)

Atestigua un informe de OpenEnclave generado a partir de un enclave SGX mediante el SDK de OpenEnclave.

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

Parámetros

report

Uint8Array | Buffer | Blob

Un informe de OpenEnclave generado por un enclave SGX.

options
AttestOpenEnclaveOptions

Opciones de operación para la llamada a la API attestOpenEnclave.

Devoluciones

Devuelve un AttestationResponse cuyo cuerpo es un AttestationResult que describe las notificaciones devueltas por el servicio de atestación.

attestSgxEnclave(Uint8Array | Buffer | Blob, AttestSgxEnclaveOptions)

Atestigua una cotización generada a partir de SGX Enclave utilizando el SDK de Intel.

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

Parámetros

quote

Uint8Array | Buffer | Blob

Una cotización SGX generada por un enclave SGX.

options
AttestSgxEnclaveOptions

Opciones de operación para la llamada a la API attestOpenEnclave.

Devoluciones

Devuelve un AttestationResponse cuyo cuerpo es un AttestationResult que describe las notificaciones devueltas por el servicio de atestación.

attestTpm(string, AttestTpmOptions)

Atestigüe un enclave basado en TPM.

Consulte la Referencia del protocolo de atestación de TPM para obtener más información.

Ejemplo

Por ejemplo, la llamada inicial para una operación de atestación de TPM es:

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

donde stringToBytes convierte la cadena en UTF8.

Tenga en cuenta que attestTpm requiere un cliente de atestación que esté configurado con credenciales de autenticación.

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

Parámetros

request

string

Solicitud entrante para enviar al servicio de atestación de TPM, codificada en Utf8.

options
AttestTpmOptions

Opciones de canalización para la solicitud de atestación de TPM.

Devoluciones

Promise<string>

Estructura que contiene la respuesta de la atestación de TPM, codificada en Utf8.

Comentarios

Las solicitudes entrantes a la API de atestación de TPM son objetos JSON con cadenas.

getAttestationSigners(AttestationClientOperationOptions)

Devuelve la lista de firmantes de atestación que se pueden usar para firmar tokens de servicio de atestación.

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

Parámetros

options
AttestationClientOperationOptions

Opciones de operación del cliente.

Devoluciones

Promise<AttestationSigner[]>

el conjunto de AttestationSigners que se pueden usar para firmar tokens de atestación.

getOpenIdMetadata(AttestationClientOperationOptions)

Devuelve el documento de detección de metadatos de OpenID para la instancia del servicio de atestación.

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

Parámetros

options
AttestationClientOperationOptions

Opciones de operación del cliente.

Devoluciones

Promise<Record<string, unknown>>

El documento de detección de metadatos de OpenID para el servicio de atestación.