AttestationClient class
Classe cliente de atestado.
A classe AttestationClient permite o acesso às APIs relacionadas ao Atestado:
- getOpenIdMetadata
- getAttestationSigners
- attestSgxEnclave
- atestarOpenEnclave
- attestTpm
Construtores
| Attestation |
Cria uma instância de AttestationClient. Uso de exemplo: |
| Attestation |
Cria uma instância de AttestationClient com opções e credenciais. Uso de exemplo: Observe que as credenciais são necessárias para chamar a API |
Métodos
| attest |
Atesta um relatório OpenEnclave gerado a partir de um Enclave SGX usando o SDK OpenEnclave. |
| attest |
Atesta uma cotação gerada do Enclave SGX usando o SDK da Intel. |
| attest |
Atestar um enclave baseado em TPM. Consulte o de Referência do Protocolo de Atestado do TPM para obter mais informações. exemplo Por exemplo, a chamada inicial para uma operação de atestado do TPM é: em que stringToBytes converte a cadeia de caracteres em UTF8. Observe que o attestTpm requer um cliente de atestado configurado com credenciais de autenticação. |
| get |
Retorna a lista de signatários de atestado que podem ser usados para assinar tokens de serviço de atestado. |
| get |
Retorna o documento de descoberta de metadados OpenID para a instância do serviço de atestado. |
Detalhes do construtor
AttestationClient(string, AttestationClientOptions)
Cria uma instância de AttestationClient.
Uso de exemplo:
import { AttestationClient } from "@azure/attestation";
const client = new AttestationClient(
"<service endpoint>"
);
new AttestationClient(endpoint: string, options?: AttestationClientOptions)Parâmetros
- endpoint
-
string
O URI base da instância de atestado, por exemplo, https://mytenant.attest.azure.net.
- options
- AttestationClientOptions
Opções usadas para configurar o Cliente de Atestado.
AttestationClient(string, TokenCredential, AttestationClientOptions)
Cria uma instância de AttestationClient com opções e credenciais.
Uso de exemplo:
import { AttestationClient } from "@azure/attestation";
const client = new AttestationClient(
"<service endpoint>",
new TokenCredential("<>"),
{ tokenValidationOptions: { validateToken: false } }
);
Observe que as credenciais são necessárias para chamar a API attestTpm.
new AttestationClient(endpoint: string, credentials: TokenCredential, options?: AttestationClientOptions)Parâmetros
- endpoint
-
string
O URI base da instância de atestado, por exemplo, https://mytenant.attest.azure.net.
- credentials
- TokenCredential
Credenciais usadas para configurar o cliente de atestado.
- options
- AttestationClientOptions
Detalhes do método
attestOpenEnclave(Uint8Array | Buffer | Blob, AttestOpenEnclaveOptions)
Atesta um relatório OpenEnclave gerado a partir de um Enclave SGX usando o SDK OpenEnclave.
function attestOpenEnclave(report: Uint8Array | Buffer | Blob, options?: AttestOpenEnclaveOptions): Promise<AttestationResponse<AttestationResult>>Parâmetros
- report
-
Uint8Array | Buffer | Blob
Um relatório OpenEnclave gerado por um enclave SGX.
- options
- AttestOpenEnclaveOptions
Opções de operação para a chamada à API attestOpenEnclave.
Retornos
Promise<AttestationResponse<AttestationResult>>
Retorna um AttestationResponse cujo corpo é um AttestationResult que descreve as declarações retornadas pelo serviço de atestado.
attestSgxEnclave(Uint8Array | Buffer | Blob, AttestSgxEnclaveOptions)
Atesta uma cotação gerada do Enclave SGX usando o SDK da Intel.
function attestSgxEnclave(quote: Uint8Array | Buffer | Blob, options?: AttestSgxEnclaveOptions): Promise<AttestationResponse<AttestationResult>>Parâmetros
- quote
-
Uint8Array | Buffer | Blob
Uma aspa SGX gerada por um enclave SGX.
- options
- AttestSgxEnclaveOptions
Opções de operação para a chamada à API attestOpenEnclave.
Retornos
Promise<AttestationResponse<AttestationResult>>
Retorna um AttestationResponse cujo corpo é um AttestationResult que descreve as declarações retornadas pelo serviço de atestado.
attestTpm(string, AttestTpmOptions)
Atestar um enclave baseado em TPM.
Consulte o de Referência do Protocolo de Atestado do TPM para obter mais informações.
exemplo
Por exemplo, a chamada inicial para uma operação de atestado do TPM é:
const encodedPayload = JSON.stringify({ payload: { type: "aikcert" } });
const result = await client.attestTpm(encodedPayload);
em que stringToBytes converte a cadeia de caracteres em UTF8.
Observe que o attestTpm requer um cliente de atestado configurado com credenciais de autenticação.
function attestTpm(request: string, options?: AttestTpmOptions): Promise<string>Parâmetros
- request
-
string
Solicitação de entrada para enviar para o serviço de atestado do TPM, codificado em Utf8.
- options
- AttestTpmOptions
Opções de pipeline para solicitação de atestado do TPM.
Retornos
Promise<string>
Uma estrutura que contém a resposta do atestado do TPM, codificado em Utf8.
Comentários
As solicitações de entrada para a API de atestado do TPM são objetos JSON em cadeia de caracteres.
getAttestationSigners(AttestationClientOperationOptions)
Retorna a lista de signatários de atestado que podem ser usados para assinar tokens de serviço de atestado.
function getAttestationSigners(options?: AttestationClientOperationOptions): Promise<AttestationSigner[]>Parâmetros
Opções de operação do cliente.
Retornos
Promise<AttestationSigner[]>
o conjunto de AtestadoSigners que podem ser usados para assinar tokens de atestado.
getOpenIdMetadata(AttestationClientOperationOptions)
Retorna o documento de descoberta de metadados OpenID para a instância do serviço de atestado.
function getOpenIdMetadata(options?: AttestationClientOperationOptions): Promise<Record<string, unknown>>Parâmetros
Opções de operação do cliente.
Retornos
Promise<Record<string, unknown>>
O documento de descoberta de metadados OpenID para o serviço de atestado.