AttestationClient | @azure/attestation

Attestation Client class.

The AttestationClient class enables access to the Attestation related APIs:

getOpenIdMetadata
getAttestationSigners
attestSgxEnclave
attestOpenEnclave
attestTpm

Hierarchy

AttestationClient

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in mnt/vss/_work/1/s/sdk/attestation/attestation/src/attestationClient.ts:139
Creates an instance of AttestationClient.

Example usage:
```
import { AttestationClient } from "@azure/attestation";

const client = new AttestationClient(
   "<service endpoint>"
);
```
Parameters
- endpoint: string
  
  The attestation instance base URI, for example https://mytenant.attest.azure.net.
- Optional options: AttestationClientOptions
  
  Options used to configure the Attestation Client.
Returns AttestationClient
- Defined in mnt/vss/_work/1/s/sdk/attestation/attestation/src/attestationClient.ts:156
Creates an instance of AttestationClient with options and credentials.

Example usage:
```
import { AttestationClient } from "@azure/attestation";

const client = new AttestationClient(
   "<service endpoint>",
   new TokenCredential("<>"),
   { tokenValidationOptions: { validateToken: false } }
);
```
Note that credentials are required to call the attestTpm API.
Parameters
- endpoint: string
  
  The attestation instance base URI, for example https://mytenant.attest.azure.net.
- credentials: TokenCredential
  
  Credentials used to configure the attestation client.
- Optional options: AttestationClientOptions
  
  Options used to configure the Attestation Client.
Returns AttestationClient

Methods

attestOpenEnclave

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

- Defined in mnt/vss/_work/1/s/sdk/attestation/attestation/src/attestationClient.ts:232
Attests an OpenEnclave report generated from an SGX Enclave using the OpenEnclave SDK.

throws

{@link Error} if the initTimeData option and initTimeJson option is provided.

throws

{@link Error} if the runTimeData option and runTimeJson option is provided.

throws

{@link Error} if the initTimeJson option is provided and the value of initTimeJson is not JSON.

throws

{@link Error} if the runTimeJson option is provided and the value of runTimeJson is not JSON.

Parameters
- report: Uint8Array | Buffer | Blob
  
  An OpenEnclave report generated by an SGX enclave.
- Default value options: AttestOpenEnclaveOptions = {}
  
  Operation options for the attestOpenEnclave API call.
Returns Promise<AttestationResponse<AttestationResult>>

Returns an AttestationResponse whose body is an AttestationResult describing the claims returned by the attestation service.

attestSgxEnclave

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

- Defined in mnt/vss/_work/1/s/sdk/attestation/attestation/src/attestationClient.ts:314
Attests a quote generated from SGX Enclave using the Intel SDK.

throws

{@link Error} if the initTimeData option and initTimeJson option is provided.

throws

{@link Error} if the runTimeData option and runTimeJson option is provided.

Parameters
- quote: Uint8Array | Buffer | Blob
  
  An SGX quote generated by an SGX enclave.
- Default value options: AttestSgxEnclaveOptions = {}
  
  Operation options for the attestOpenEnclave API call.
Returns Promise<AttestationResponse<AttestationResult>>

Returns an AttestationResponse whose body is an AttestationResult describing the claims returned by the attestation service.

attestTpm

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

- Defined in mnt/vss/_work/1/s/sdk/attestation/attestation/src/attestationClient.ts:411
Attest a TPM based enclave.

See the TPM Attestation Protocol Reference for more information.
remarks

The incoming requests to the TPM attestation API are stringified JSON objects.

example
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.
Parameters
- request: string
  
  Incoming request to send to the TPM attestation service, Utf8 encoded.
- Default value options: AttestTpmOptions = {}
  
  Pipeline options for TPM attestation request.
Returns Promise<string>

A structure containing the response from the TPM attestation, Utf8 encoded.

getAttestationSigners

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

- Defined in mnt/vss/_work/1/s/sdk/attestation/attestation/src/attestationClient.ts:438
Returns the list of attestation signers which can be used to sign attestation service tokens.

Parameters
- Default value options: AttestationClientOperationOptions = {}
  
  Client operation options.
Returns Promise<AttestationSigner[]>

the set of AttestationSigners which may be used to sign attestation tokens.

getOpenIdMetadata

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

- Defined in mnt/vss/_work/1/s/sdk/attestation/attestation/src/attestationClient.ts:462
Returns the OpenID Metadata discovery document for the attestation service instance.

Parameters
- Default value options: AttestationClientOperationOptions = {}
  
  Client operation options.
Returns Promise<Record<string, unknown>>

The OpenID metadata discovery document for the attestation service.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

endpoint: string

Optional options: AttestationClientOptions

Returns AttestationClient

Parameters

endpoint: string

credentials: TokenCredential

Optional options: AttestationClientOptions

Returns AttestationClient

Methods

attestOpenEnclave

Parameters

report: Uint8Array | Buffer | Blob

Default value options: AttestOpenEnclaveOptions = {}

Returns Promise<AttestationResponse<AttestationResult>>

attestSgxEnclave

Parameters

quote: Uint8Array | Buffer | Blob

Default value options: AttestSgxEnclaveOptions = {}

Returns Promise<AttestationResponse<AttestationResult>>

attestTpm

Parameters

request: string

Default value options: AttestTpmOptions = {}

Returns Promise<string>

getAttestationSigners

Parameters

Default value options: AttestationClientOperationOptions = {}

Returns Promise<AttestationSigner[]>

getOpenIdMetadata

Parameters

Default value options: AttestationClientOperationOptions = {}

Returns Promise<Record<string, unknown>>