CodeTransparencyClient Class

Definition

Namespace:: Azure.Security.CodeTransparency

Assembly:: Azure.Security.CodeTransparency.dll

Package:: Azure.Security.CodeTransparency v1.0.0

Package:: Azure.Security.CodeTransparency v1.0.0-beta.12

Source:: CodeTransparencyClient.cs

Source:: CodeTransparencyClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The CodeTransparencyClient.

public class CodeTransparencyClient

type CodeTransparencyClient = class

Public Class CodeTransparencyClient

Inheritance: Object
CodeTransparencyClient

Constructors

Name	Description
CodeTransparencyClient()	Initializes a new instance of CodeTransparencyClient for mocking.
CodeTransparencyClient(CodeTransparencyClientSettings)	Initializes a new instance of CodeTransparencyClient from a CodeTransparencyClientSettings.
CodeTransparencyClient(Uri, AzureKeyCredential, CodeTransparencyClientOptions)	Initializes a new instance of CodeTransparencyClient. The client will download its own TLS CA cert to perform server cert authentication. If the CA changes then there is a TTL which will help healing the long lived clients.
CodeTransparencyClient(Uri, AzureKeyCredential)	Initializes a new instance of CodeTransparencyClient.
CodeTransparencyClient(Uri, CodeTransparencyClientOptions)	Initializes a new instance of CodeTransparencyClient. The client will download its own TLS CA cert to perform server cert authentication. If the CA changes then there is a TTL which will help healing the long lived clients.
CodeTransparencyClient(Uri)	Initializes a new instance of CodeTransparencyClient. The client will download its own TLS CA cert to perform server cert authentication. If the CA changes then there is a TTL which will help healing the long lived clients.

Fields

Name	Description
UnknownIssuerPrefix	Prefix for receipts with unknown/unrecognized issuers.

Properties

Name	Description
Pipeline	The HTTP pipeline for sending and receiving REST requests and responses.

Methods

Name	Description
CreateEntry(BinaryData, Nullable<Boolean>, CancellationToken)	Post an entry to be registered on the CodeTransparency instance, mandatory in IETF SCITT draft.
CreateEntry(RequestContent, Nullable<Boolean>, RequestContext)	[Protocol Method] Post an entry to be registered on the CodeTransparency instance, mandatory in IETF SCITT draft This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateEntry(WaitUntil, BinaryData, CancellationToken)	Obsolete. Post an entry to be registered on the CodeTransparency instance, mandatory in IETF SCITT draft.
CreateEntryAsync(BinaryData, Nullable<Boolean>, CancellationToken)	Post an entry to be registered on the CodeTransparency instance, mandatory in IETF SCITT draft.
CreateEntryAsync(RequestContent, Nullable<Boolean>, RequestContext)	[Protocol Method] Post an entry to be registered on the CodeTransparency instance, mandatory in IETF SCITT draft This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateEntryAsync(WaitUntil, BinaryData, CancellationToken)	Obsolete. Post an entry to be registered on the CodeTransparency instance, mandatory in IETF SCITT draft.
CreateEntryV09(BinaryData, Nullable<Boolean>, CancellationToken)	Post an entry to be registered on the CodeTransparency instance, mandatory in IETF SCITT draft.
CreateEntryV09(RequestContent, Nullable<Boolean>, RequestContext)	[Protocol Method] Post an entry to be registered on the CodeTransparency instance, mandatory in IETF SCITT draft This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateEntryV09Async(BinaryData, Nullable<Boolean>, CancellationToken)	Post an entry to be registered on the CodeTransparency instance, mandatory in IETF SCITT draft.
CreateEntryV09Async(RequestContent, Nullable<Boolean>, RequestContext)	[Protocol Method] Post an entry to be registered on the CodeTransparency instance, mandatory in IETF SCITT draft This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetEntry(String, CancellationToken)	Get receipt.
GetEntry(String, RequestContext)	[Protocol Method] Get receipt This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetEntryAsync(String, CancellationToken)	Get receipt.
GetEntryAsync(String, RequestContext)	[Protocol Method] Get receipt This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetEntryIdFromLocation(Response)	Extracts the entry id from the Location header of a response.
GetEntryStatement(String, CancellationToken)	Get the transparent statement consisting of the signed statement and the receipt embedded in the header.
GetEntryStatement(String, RequestContext)	[Protocol Method] Get the transparent statement consisting of the signed statement and the receipt embedded in the header This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetEntryStatementAsync(String, CancellationToken)	Get the transparent statement consisting of the signed statement and the receipt embedded in the header.
GetEntryStatementAsync(String, RequestContext)	[Protocol Method] Get the transparent statement consisting of the signed statement and the receipt embedded in the header This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetEntryStatementV09(String, CancellationToken)	Get the transparent statement consisting of the signed statement and the receipt embedded in the header.
GetEntryStatementV09(String, RequestContext)	[Protocol Method] Get the transparent statement consisting of the signed statement and the receipt embedded in the header This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetEntryStatementV09Async(String, CancellationToken)	Get the transparent statement consisting of the signed statement and the receipt embedded in the header.
GetEntryStatementV09Async(String, RequestContext)	[Protocol Method] Get the transparent statement consisting of the signed statement and the receipt embedded in the header This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetEntryV09(String, CancellationToken)	Get receipt.
GetEntryV09(String, RequestContext)	[Protocol Method] Get receipt This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetEntryV09Async(String, CancellationToken)	Get receipt.
GetEntryV09Async(String, RequestContext)	[Protocol Method] Get receipt This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetOperation(String, CancellationToken)	Obsolete. Get operation status.
GetOperation(String, RequestContext)	Obsolete. Get operation status.
GetOperationAsync(String, CancellationToken)	Obsolete. Get operation status.
GetOperationAsync(String, RequestContext)	Obsolete. Get operation status.
GetOperationV09(String, CancellationToken)	Get status of the long running registration operation. Deprecated in SCRAPI v09 but retained unchanged for backward compatibility; clients should poll /entries/{entryId} directly.
GetOperationV09(String, RequestContext)	[Protocol Method] Get status of the long running registration operation. Deprecated in SCRAPI v09 but retained unchanged for backward compatibility; clients should poll /entries/{entryId} directly. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetOperationV09Async(String, CancellationToken)	Get status of the long running registration operation. Deprecated in SCRAPI v09 but retained unchanged for backward compatibility; clients should poll /entries/{entryId} directly.
GetOperationV09Async(String, RequestContext)	[Protocol Method] Get status of the long running registration operation. Deprecated in SCRAPI v09 but retained unchanged for backward compatibility; clients should poll /entries/{entryId} directly. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetPublicKeys(CancellationToken)	Get the public keys used by the service to verify receipts, normalized to a key set.
GetPublicKeys(RequestContext)	Get the public keys used by the service to verify receipts.
GetPublicKeysAsync(CancellationToken)	Get the public keys used by the service to verify receipts, normalized to a key set.
GetPublicKeysAsync(RequestContext)	Get the public keys used by the service to verify receipts.
GetScittKey(String, CancellationToken)	Get a single service key by kid, normalized to a verification key.
GetScittKey(String, RequestContext)	Get a single service key by kid.
GetScittKeyAsync(String, CancellationToken)	Get a single service key by kid, normalized to a verification key.
GetScittKeyAsync(String, RequestContext)	Get a single service key by kid.
GetScittKeys(CancellationToken)	List all service keys, normalized to a key set.
GetScittKeys(RequestContext)	List all service keys in COSE_Key_Set format.
GetScittKeysAsync(CancellationToken)	List all service keys, normalized to a key set.
GetScittKeysAsync(RequestContext)	List all service keys in COSE_Key_Set format.
GetTransparencyConfigCbor(CancellationToken)	Get the transparency service configuration, mandatory in IETF SCITT draft.
GetTransparencyConfigCbor(RequestContext)	[Protocol Method] Get the transparency service configuration, mandatory in IETF SCITT draft This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTransparencyConfigCborAsync(CancellationToken)	Get the transparency service configuration, mandatory in IETF SCITT draft.
GetTransparencyConfigCborAsync(RequestContext)	[Protocol Method] Get the transparency service configuration, mandatory in IETF SCITT draft This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
RunTransparentStatementVerification(Byte[], Byte[])	Verify the receipt integrity against the COSE_Sign1 envelope and check if receipt was endorsed by the service public keys. This method expects the issuer in the receipt to match the CodeTransparencyClient client endpoint. Calls Verify(Byte[], Byte[], CodeTransparencyVerificationKey) for each receipt found in the transparent statement.
RunTransparentStatementVerification(Byte[])	Obsolete. Verify the receipt integrity against the COSE_Sign1 envelope and check if receipt was endorsed by the given service certificate. In the case of multiple receipts being embedded in the signature then verify all of them.
VerifyTransparentStatement(Byte[], CodeTransparencyVerificationOptions, CodeTransparencyClientOptions)	Verify the receipt integrity against the COSE_Sign1 envelope and (optionally) enforce issuer domain authorized-list rules. It will create an instance of CodeTransparencyClient for each issuer domain encountered in the verification process.

Applies to

フィードバック

このページはお役に立ちましたか?