Partilhar via


AttestationClient class

Atestado Classe Cliente.

A classe AttestationClient permite o acesso às APIs relacionadas a Attestation:

  • getOpenIdMetadata
  • getAttestationSigners
  • attestSgxEnclave
  • attestOpenEnclave
  • attestTpm

Construtores

AttestationClient(string, AttestationClientOptions)

Cria uma instância de AttestationClient.

Exemplo de uso:

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

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

Cria uma instância de AttestationClient com opções e credenciais.

Exemplo de uso:

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

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

Observe que as credenciais são necessárias para chamar a API attestTpm.

Métodos

attestOpenEnclave(Uint8Array | Buffer | Blob, AttestOpenEnclaveOptions)

Atesta um relatório OpenEnclave gerado a partir de um Enclave SGX usando o OpenEnclave SDK.

attestSgxEnclave(Uint8Array | Buffer | Blob, AttestSgxEnclaveOptions)

Atesta uma cotação gerada a partir do SGX Enclave usando o SDK da Intel.

attestTpm(string, AttestTpmOptions)

Atestar um enclave baseado em TPM.

Consulte o de referência do protocolo de atestado TPM para obter mais informações.

Exemplo

Por exemplo, a chamada inicial para uma operação de atestado TPM é:

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

onde stringToBytes converte a cadeia de caracteres em UTF8.

Observe que o attestTpm requer um cliente de atestado configurado com credenciais de autenticação.

getAttestationSigners(AttestationClientOperationOptions)

Retorna a lista de signatários de atestado que podem ser usados para assinar tokens de serviço de atestado.

getOpenIdMetadata(AttestationClientOperationOptions)

Retorna o documento de descoberta de metadados OpenID para a instância de serviço de atestado.

Detalhes do Construtor

AttestationClient(string, AttestationClientOptions)

Cria uma instância de AttestationClient.

Exemplo de uso:

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

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

Parâmetros

endpoint

string

O URI de base da instância de atestado, por exemplo, https://mytenant.attest.azure.net.

options
AttestationClientOptions

Opções usadas para configurar o cliente de atestado.

AttestationClient(string, TokenCredential, AttestationClientOptions)

Cria uma instância de AttestationClient com opções e credenciais.

Exemplo de uso:

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

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

Observe que as credenciais são necessárias para chamar a API attestTpm.

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

Parâmetros

endpoint

string

O URI de base da instância de atestado, por exemplo, https://mytenant.attest.azure.net.

credentials
TokenCredential

Credenciais usadas para configurar o cliente de atestado.

Detalhes de Método

attestOpenEnclave(Uint8Array | Buffer | Blob, AttestOpenEnclaveOptions)

Atesta um relatório OpenEnclave gerado a partir de um Enclave SGX usando o OpenEnclave SDK.

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

Parâmetros

report

Uint8Array | Buffer | Blob

Um relatório OpenEnclave gerado por um enclave SGX.

options
AttestOpenEnclaveOptions

Opções de operação para a chamada da API attestOpenEnclave.

Devoluções

Retorna um AttestationResponse cujo corpo é um AttestationResult descrevendo as declarações retornadas pelo serviço de atestado.

attestSgxEnclave(Uint8Array | Buffer | Blob, AttestSgxEnclaveOptions)

Atesta uma cotação gerada a partir do SGX Enclave usando o SDK da Intel.

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

Parâmetros

quote

Uint8Array | Buffer | Blob

Uma cotação SGX gerada por um enclave SGX.

options
AttestSgxEnclaveOptions

Opções de operação para a chamada da API attestOpenEnclave.

Devoluções

Retorna um AttestationResponse cujo corpo é um AttestationResult descrevendo as declarações retornadas pelo serviço de atestado.

attestTpm(string, AttestTpmOptions)

Atestar um enclave baseado em TPM.

Consulte o de referência do protocolo de atestado TPM para obter mais informações.

Exemplo

Por exemplo, a chamada inicial para uma operação de atestado TPM é:

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

onde stringToBytes converte a cadeia de caracteres em UTF8.

Observe que o attestTpm requer um cliente de atestado configurado com credenciais de autenticação.

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

Parâmetros

request

string

Solicitação de entrada para enviar ao serviço de atestado TPM, codificado em Utf8.

options
AttestTpmOptions

Opções de pipeline para solicitação de atestado TPM.

Devoluções

Promise<string>

Uma estrutura contendo a resposta do atestado TPM, codificado Utf8.

Observações

As solicitações de entrada para a API de atestado do TPM são objetos JSON stringificados.

getAttestationSigners(AttestationClientOperationOptions)

Retorna a lista de signatários de atestado que podem ser usados para assinar tokens de serviço de atestado.

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

Parâmetros

options
AttestationClientOperationOptions

Opções de operação do cliente.

Devoluções

Promise<AttestationSigner[]>

o conjunto de AttestationSigners que pode ser usado para assinar tokens de atestado.

getOpenIdMetadata(AttestationClientOperationOptions)

Retorna o documento de descoberta de metadados OpenID para a instância de serviço de atestado.

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

Parâmetros

options
AttestationClientOperationOptions

Opções de operação do cliente.

Devoluções

Promise<Record<string, unknown>>

O documento de descoberta de metadados OpenID para o serviço de atestado.