Package version:
Creates an instance of AttestationClient.
Example usage:
import { AttestationClient } from "@azure/attestation";
const endpoint = "https://<attestation-instance>.<region>.attest.azure.net";
const client = new AttestationClient(endpoint);
The attestation instance base URI, for example https://mytenant.attest.azure.net.
Optionaloptions: AttestationClientOptions
Options used to configure the Attestation Client.
Creates an instance of AttestationClient with options and credentials.
Example usage:
import { DefaultAzureCredential } from "@azure/identity";
import { AttestationClient } from "@azure/attestation";
const endpoint = "https://<attestation-instance>.<region>.attest.azure.net";
const credentials = new DefaultAzureCredential();
const client = new AttestationClient(endpoint, credentials);
Note that credentials are required to call the attestTpm API.
The attestation instance base URI, for example https://mytenant.attest.azure.net.
Credentials used to configure the attestation client.
Optionaloptions: AttestationClientOptionsAttests an OpenEnclave report generated from an SGX Enclave using the OpenEnclave SDK.
An OpenEnclave report generated by an SGX enclave.
Operation options for the attestOpenEnclave API call.
Returns an AttestationResponse whose body is an AttestationResult describing the claims returned by the attestation service.
Attests a quote generated from SGX Enclave using the Intel SDK.
An SGX quote generated by an SGX enclave.
Operation options for the attestOpenEnclave API call.
Returns an AttestationResponse whose body is an AttestationResult describing the claims returned by the attestation service.
Attest a TPM based enclave.
See the TPM Attestation Protocol Reference for more information.
Incoming request to send to the TPM attestation service, Utf8 encoded.
Pipeline options for TPM attestation request.
A structure containing the response from the TPM attestation, Utf8 encoded.
For example, the initial call for a TPM attestation operation is:
const encodedPayload = JSON.stringify({ payload: { type: "aikcert" } });
const result = await client.attestTpm(encodedPayload);
where stringToBytes converts the string to UTF8.
Note that the attestTpm requires an attestation client which is configured with authentication credentials.
Returns the list of attestation signers which can be used to sign attestation service tokens.
Client operation options.
the set of AttestationSigners which may be used to sign attestation tokens.
Returns the OpenID Metadata discovery document for the attestation service instance.
Client operation options.
The OpenID metadata discovery document for the attestation service.
Attestation Client class.
The AttestationClient class enables access to the Attestation related APIs: