AttestationClient class

Classe Client di attestazione.

La classe AttestationClient consente l'accesso alle API correlate all'attestazione:

  • getOpenIdMetadata
  • getAttestationSigners
  • attestaSgxEnclave
  • attestaOpenEnclave
  • attestaTpm

Costruttori

AttestationClient(string, AttestationClientOptions)

Crea un'istanza di AttestationClient.

Esempio di utilizzo:

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

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

Crea un'istanza di AttestationClient con opzioni e credenziali.

Esempio di utilizzo:

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

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

Si noti che le credenziali sono necessarie per chiamare l'API attestTpm.

Metodi

attestOpenEnclave(Uint8Array | Buffer | Blob, AttestOpenEnclaveOptions)

Attesta un report OpenEnclave generato da un enclave SGX usando OpenEnclave SDK.

attestSgxEnclave(Uint8Array | Buffer | Blob, AttestSgxEnclaveOptions)

Attesta un'offerta generata dall'enclave SGX usando Intel SDK.

attestTpm(string, AttestTpmOptions)

Attestare un enclave basato su TPM.

Per altre informazioni, vedere la di riferimento al protocollo di attestazione TPM.

esempio di

Ad esempio, la chiamata iniziale per un'operazione di attestazione TPM è:

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

dove stringToBytes converte la stringa in UTF8.

Si noti che attestaTpm richiede un client di attestazione configurato con le credenziali di autenticazione.

getAttestationSigners(AttestationClientOperationOptions)

Restituisce l'elenco dei firmatari di attestazione che possono essere usati per firmare i token del servizio di attestazione.

getOpenIdMetadata(AttestationClientOperationOptions)

Restituisce il documento di individuazione dei metadati OpenID per l'istanza del servizio di attestazione.

Dettagli costruttore

AttestationClient(string, AttestationClientOptions)

Crea un'istanza di AttestationClient.

Esempio di utilizzo:

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

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

Parametri

endpoint

string

URI di base dell'istanza di attestazione, ad esempio https://mytenant.attest.azure.net.

options
AttestationClientOptions

Opzioni usate per configurare il client di attestazione.

AttestationClient(string, TokenCredential, AttestationClientOptions)

Crea un'istanza di AttestationClient con opzioni e credenziali.

Esempio di utilizzo:

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

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

Si noti che le credenziali sono necessarie per chiamare l'API attestTpm.

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

Parametri

endpoint

string

URI di base dell'istanza di attestazione, ad esempio https://mytenant.attest.azure.net.

credentials
TokenCredential

Credenziali usate per configurare il client di attestazione.

Dettagli metodo

attestOpenEnclave(Uint8Array | Buffer | Blob, AttestOpenEnclaveOptions)

Attesta un report OpenEnclave generato da un enclave SGX usando OpenEnclave SDK.

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

Parametri

report

Uint8Array | Buffer | Blob

Report OpenEnclave generato da un enclave SGX.

options
AttestOpenEnclaveOptions

Opzioni di operazione per la chiamata API attestaOpenEnclave.

Restituisce

Restituisce un'attestazioneResponse il cui corpo è un oggetto AttestationResult che descrive le attestazioni restituite dal servizio di attestazione.

attestSgxEnclave(Uint8Array | Buffer | Blob, AttestSgxEnclaveOptions)

Attesta un'offerta generata dall'enclave SGX usando Intel SDK.

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

Parametri

quote

Uint8Array | Buffer | Blob

Virgolette SGX generate da un enclave SGX.

options
AttestSgxEnclaveOptions

Opzioni di operazione per la chiamata API attestaOpenEnclave.

Restituisce

Restituisce un'attestazioneResponse il cui corpo è un oggetto AttestationResult che descrive le attestazioni restituite dal servizio di attestazione.

attestTpm(string, AttestTpmOptions)

Attestare un enclave basato su TPM.

Per altre informazioni, vedere la di riferimento al protocollo di attestazione TPM.

esempio di

Ad esempio, la chiamata iniziale per un'operazione di attestazione TPM è:

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

dove stringToBytes converte la stringa in UTF8.

Si noti che attestaTpm richiede un client di attestazione configurato con le credenziali di autenticazione.

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

Parametri

request

string

Richiesta in ingresso da inviare al servizio di attestazione TPM, con codifica Utf8.

options
AttestTpmOptions

Opzioni della pipeline per la richiesta di attestazione TPM.

Restituisce

Promise<string>

Struttura contenente la risposta dall'attestazione TPM, con codifica Utf8.

Commenti

Le richieste in ingresso all'API di attestazione TPM sono oggetti JSON stringati.

getAttestationSigners(AttestationClientOperationOptions)

Restituisce l'elenco dei firmatari di attestazione che possono essere usati per firmare i token del servizio di attestazione.

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

Parametri

options
AttestationClientOperationOptions

Opzioni dell'operazione client.

Restituisce

Promise<AttestationSigner[]>

set di AttestationSigners che possono essere usati per firmare i token di attestazione.

getOpenIdMetadata(AttestationClientOperationOptions)

Restituisce il documento di individuazione dei metadati OpenID per l'istanza del servizio di attestazione.

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

Parametri

options
AttestationClientOperationOptions

Opzioni dell'operazione client.

Restituisce

Promise<Record<string, unknown>>

Documento di individuazione dei metadati OpenID per il servizio di attestazione.