Udostępnij za pośrednictwem

AttestationClient class

  • Odwołanie
Pakiet:
@azure/attestation

Zaświadczania, klasa klienta.

Klasa AttestationClient umożliwia dostęp do interfejsów API powiązanych z zaświadczeniem:

  • getOpenIdMetadata
  • getAttestationSigners
  • attestSgxEnclave
  • zaświadczanie OpenEnclave
  • attestTpm

Konstruktory

AttestationClient(string, AttestationClientOptions)

Tworzy wystąpienie klasy AttestationClient.

Przykład użycia: 

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

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

Tworzy wystąpienie klasy AttestationClient z opcjami i poświadczeniami.

Przykład użycia: 

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

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

Należy pamiętać, że poświadczenia są wymagane do wywołania interfejsu attestTpm API.

Metody

attestOpenEnclave(Uint8Array | Buffer | Blob, AttestOpenEnclaveOptions)

Potwierdza raport OpenEnclave wygenerowany na podstawie enklawy SGX przy użyciu zestawu SDK OpenEnclave.
attestSgxEnclave(Uint8Array | Buffer | Blob, AttestSgxEnclaveOptions)

Potwierdza cudzysłów wygenerowany na podstawie enklawy SGX przy użyciu zestawu SDK firmy Intel.
attestTpm(string, AttestTpmOptions)

Zaświadczaj enklawę opartą na module TPM.

Aby uzyskać więcej informacji , zobacz dokumentację protokołu zaświadczania modułu TPM .

Przykład

Na przykład początkowe wywołanie operacji zaświadczania modułu TPM to:

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

gdzie stringToBytes konwertuje ciąg na UTF8.

Należy pamiętać, że element attestTpm wymaga klienta zaświadczania skonfigurowanego przy użyciu poświadczeń uwierzytelniania.
getAttestationSigners(AttestationClientOperationOptions)

Zwraca listę osób podpisujących zaświadczania, których można użyć do podpisywania tokenów usługi zaświadczania.
getOpenIdMetadata(AttestationClientOperationOptions)

Zwraca dokument odnajdywania metadanych OpenID dla wystąpienia usługi zaświadczania.

Szczegóły konstruktora

AttestationClient(string, AttestationClientOptions)

Tworzy wystąpienie klasy AttestationClient.

Przykład użycia: 

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

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

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

Parametry

endpoint

string

Podstawowy identyfikator URI wystąpienia zaświadczania, na przykład https://mytenant.attest.azure.net.

options
AttestationClientOptions

Opcje używane do konfigurowania klienta zaświadczania.

AttestationClient(string, TokenCredential, AttestationClientOptions)

Tworzy wystąpienie klasy AttestationClient z opcjami i poświadczeniami.

Przykład użycia: 

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

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

Należy pamiętać, że poświadczenia są wymagane do wywołania interfejsu attestTpm API.

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

Parametry

endpoint

string

Podstawowy identyfikator URI wystąpienia zaświadczania, na przykład https://mytenant.attest.azure.net.

credentials
TokenCredential

Poświadczenia używane do konfigurowania klienta zaświadczania.

options
AttestationClientOptions

Szczegóły metody

attestOpenEnclave(Uint8Array | Buffer | Blob, AttestOpenEnclaveOptions)

Potwierdza raport OpenEnclave wygenerowany na podstawie enklawy SGX przy użyciu zestawu SDK OpenEnclave.

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

Parametry

report

Uint8Array | Buffer | Blob

Raport OpenEnclave wygenerowany przez enklawę SGX.

options
AttestOpenEnclaveOptions

Opcje operacji dla wywołania interfejsu API attestOpenEnclave.

Zwraca

Promise<AttestationResponse<AttestationResult>>

Zwraca element AttestationResponse, którego treść jest zaświadczaniemResult opisującym oświadczenia zwrócone przez usługę zaświadczania.

attestSgxEnclave(Uint8Array | Buffer | Blob, AttestSgxEnclaveOptions)

Potwierdza cudzysłów wygenerowany na podstawie enklawy SGX przy użyciu zestawu SDK firmy Intel.

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

Parametry

quote

Uint8Array | Buffer | Blob

Cytat SGX wygenerowany przez enklawę SGX.

options
AttestSgxEnclaveOptions

Opcje operacji dla wywołania interfejsu API attestOpenEnclave.

Zwraca

Promise<AttestationResponse<AttestationResult>>

Zwraca element AttestationResponse, którego treść jest zaświadczaniemResult opisującym oświadczenia zwrócone przez usługę zaświadczania.

attestTpm(string, AttestTpmOptions)

Zaświadczaj enklawę opartą na module TPM.

Aby uzyskać więcej informacji , zobacz dokumentację protokołu zaświadczania modułu TPM .

Przykład

Na przykład początkowe wywołanie operacji zaświadczania modułu TPM to:

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

gdzie stringToBytes konwertuje ciąg na UTF8.

Należy pamiętać, że element attestTpm wymaga klienta zaświadczania skonfigurowanego przy użyciu poświadczeń uwierzytelniania.

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

Parametry

request

string

Przychodzące żądanie wysłania do usługi zaświadczania TPM zakodowane w formacie Utf8.

options
AttestTpmOptions

Opcje potoku dla żądania zaświadczania modułu TPM.

Zwraca

Promise<string>

Struktura zawierająca odpowiedź z zaświadczania modułu TPM zakodowana w formacie Utf8.

Uwagi

Żądania przychodzące do interfejsu API zaświadczania modułu TPM są ciągami obiektów JSON.

getAttestationSigners(AttestationClientOperationOptions)

Zwraca listę osób podpisujących zaświadczania, których można użyć do podpisywania tokenów usługi zaświadczania.

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

Parametry

options
AttestationClientOperationOptions

Opcje operacji klienta.

Zwraca

Promise<AttestationSigner[]>

zestaw attestationSigners, który może służyć do podpisywania tokenów zaświadczania.

getOpenIdMetadata(AttestationClientOperationOptions)

Zwraca dokument odnajdywania metadanych OpenID dla wystąpienia usługi zaświadczania.

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

Parametry

options
AttestationClientOperationOptions

Opcje operacji klienta.

Zwraca

Promise<Record<string, unknown>>

Dokument odnajdywania metadanych OpenID dla usługi zaświadczania.