AttestationClient class
Attestation Client-Klasse.
Die AttestationClient-Klasse ermöglicht den Zugriff auf die attestation-bezogenen APIs:
- getOpenIdMetadata
- getAttestationSigners
- attestSgxEnclave
- attestOpenEnclave
- attestTpm
Konstruktoren
| Attestation |
Erstellt eine Instanz von AttestationClient. Beispielverwendung:
|
| Attestation |
Erstellt eine Instanz von AttestationClient mit Optionen und Anmeldeinformationen. Beispielverwendung:
Beachten Sie, dass Anmeldeinformationen erforderlich sind, um die |
Methoden
| attest |
Attestiert einen OpenEnclave-Bericht, der aus einer SGX-Enklave mithilfe des OpenEnclave SDK generiert wurde. |
| attest |
Attestiert ein von SGX Enclave generiertes Angebot mit dem Intel SDK. |
| attest |
Attestieren Sie eine TPM-basierte Enklave. Weitere Informationen finden Sie im TPM Attestation Protocol Reference. Beispiel Beispielsweise lautet der anfängliche Aufruf eines TPM-Nachweisvorgangs:
wobei stringToBytes die Zeichenfolge in UTF8 konvertiert. Beachten Sie, dass für das attestTpm ein Nachweisclient erforderlich ist, der mit Authentifizierungsanmeldeinformationen konfiguriert ist. |
| get |
Gibt die Liste der Nachweis signierer zurück, die zum Signieren von Nachweisdiensttoken verwendet werden können. |
| get |
Gibt das OpenID Metadata Discovery-Dokument für die Instanz des Nachweisdiensts zurück. |
Details zum Konstruktor
AttestationClient(string, AttestationClientOptions)
Erstellt eine Instanz von AttestationClient.
Beispielverwendung:
import { AttestationClient } from "@azure/attestation";
const client = new AttestationClient(
"<service endpoint>"
);
new AttestationClient(endpoint: string, options?: AttestationClientOptions)
Parameter
- endpoint
-
string
Der Basis-URI der Nachweisinstanz, z. B. https://mytenant.attest.azure.net.
- options
- AttestationClientOptions
Optionen zum Konfigurieren des Nachweisclients.
AttestationClient(string, TokenCredential, AttestationClientOptions)
Erstellt eine Instanz von AttestationClient mit Optionen und Anmeldeinformationen.
Beispielverwendung:
import { AttestationClient } from "@azure/attestation";
const client = new AttestationClient(
"<service endpoint>",
new TokenCredential("<>"),
{ tokenValidationOptions: { validateToken: false } }
);
Beachten Sie, dass Anmeldeinformationen erforderlich sind, um die attestTpm-API aufzurufen.
new AttestationClient(endpoint: string, credentials: TokenCredential, options?: AttestationClientOptions)
Parameter
- endpoint
-
string
Der Basis-URI der Nachweisinstanz, z. B. https://mytenant.attest.azure.net.
- credentials
- TokenCredential
Zum Konfigurieren des Nachweisclients verwendete Anmeldeinformationen.
- options
- AttestationClientOptions
Details zur Methode
attestOpenEnclave(Uint8Array | Buffer | Blob, AttestOpenEnclaveOptions)
Attestiert einen OpenEnclave-Bericht, der aus einer SGX-Enklave mithilfe des OpenEnclave SDK generiert wurde.
function attestOpenEnclave(report: Uint8Array | Buffer | Blob, options?: AttestOpenEnclaveOptions): Promise<AttestationResponse<AttestationResult>>
Parameter
- report
-
Uint8Array | Buffer | Blob
Ein OpenEnclave-Bericht, der von einer SGX-Enklave generiert wird.
- options
- AttestOpenEnclaveOptions
Vorgangsoptionen für den attestOpenEnclave-API-Aufruf.
Gibt zurück
Promise<AttestationResponse<AttestationResult>>
Gibt einen AttestationResponse zurück, dessen Textkörper ein AttestationResult ist, der die vom Nachweisdienst zurückgegebenen Ansprüche beschreibt.
attestSgxEnclave(Uint8Array | Buffer | Blob, AttestSgxEnclaveOptions)
Attestiert ein von SGX Enclave generiertes Angebot mit dem Intel SDK.
function attestSgxEnclave(quote: Uint8Array | Buffer | Blob, options?: AttestSgxEnclaveOptions): Promise<AttestationResponse<AttestationResult>>
Parameter
- quote
-
Uint8Array | Buffer | Blob
Ein SGX-Angebot, das von einer SGX-Enklave generiert wird.
- options
- AttestSgxEnclaveOptions
Vorgangsoptionen für den attestOpenEnclave-API-Aufruf.
Gibt zurück
Promise<AttestationResponse<AttestationResult>>
Gibt einen AttestationResponse zurück, dessen Textkörper ein AttestationResult ist, der die vom Nachweisdienst zurückgegebenen Ansprüche beschreibt.
attestTpm(string, AttestTpmOptions)
Attestieren Sie eine TPM-basierte Enklave.
Weitere Informationen finden Sie im TPM Attestation Protocol Reference.
Beispiel
Beispielsweise lautet der anfängliche Aufruf eines TPM-Nachweisvorgangs:
const encodedPayload = JSON.stringify({ payload: { type: "aikcert" } });
const result = await client.attestTpm(encodedPayload);
wobei stringToBytes die Zeichenfolge in UTF8 konvertiert.
Beachten Sie, dass für das attestTpm ein Nachweisclient erforderlich ist, der mit Authentifizierungsanmeldeinformationen konfiguriert ist.
function attestTpm(request: string, options?: AttestTpmOptions): Promise<string>
Parameter
- request
-
string
Eingehende Anforderung zum Senden an den TPM-Nachweisdienst, Utf8-codiert.
- options
- AttestTpmOptions
Pipelineoptionen für TPM-Nachweisanforderung.
Gibt zurück
Promise<string>
Eine Struktur, die die Antwort des TPM-Nachweises enthält, utf8-codiert.
Hinweise
Die eingehenden Anforderungen an die TPM-Nachweis-API sind Zeichenfolgen-JSON-Objekte.
getAttestationSigners(AttestationClientOperationOptions)
Gibt die Liste der Nachweis signierer zurück, die zum Signieren von Nachweisdiensttoken verwendet werden können.
function getAttestationSigners(options?: AttestationClientOperationOptions): Promise<AttestationSigner[]>
Parameter
Clientoperationsoptionen.
Gibt zurück
Promise<AttestationSigner[]>
die Gruppe von AttestationSigners, die zum Signieren von Nachweistoken verwendet werden können.
getOpenIdMetadata(AttestationClientOperationOptions)
Gibt das OpenID Metadata Discovery-Dokument für die Instanz des Nachweisdiensts zurück.
function getOpenIdMetadata(options?: AttestationClientOperationOptions): Promise<Record<string, unknown>>
Parameter
Clientoperationsoptionen.
Gibt zurück
Promise<Record<string, unknown>>
Das OpenID-Metadatenermittlungsdokument für den Nachweisdienst.