Google Cloud Storage v1 API - Class UrlSigner.HmacBlobSigner (4.10.0)

Version latest

• 4.10.0 (latest)
• 4.9.0
• 4.8.0
• 4.7.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0

public sealed class UrlSigner.HmacBlobSigner : UrlSigner.IBlobSigner

Reference documentation and code samples for the Google Cloud Storage v1 API class UrlSigner.HmacBlobSigner.

Blob signer to implement signing using an HMAC secret.

Inheritance

object > UrlSigner.HmacBlobSigner

Implements

UrlSignerIBlobSigner

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Storage.V1

Assembly

Google.Cloud.Storage.V1.dll

Properties

Algorithm

public string Algorithm { get; }

The signing algorithm used by this blob signer.

Property Value
Type	Description
string

Id

public string Id { get; }

The identity of the signer, typically an email address.

Property Value
Type	Description
string

Methods

Create(string, string)

public static UrlSigner.HmacBlobSigner Create(string keyId, string secret)

Creates a new HMAC Blob Signer from an HMAC Key ID and Secret.

Parameters
Name	Description
keyId	string The HMAC key ID. Must not be null or empty.
secret	string The HMAC key secret. Must not be null or empty.

Returns
Type	Description
UrlSignerHmacBlobSigner

CreateSignature(byte[], BlobSignerParameters)

public string CreateSignature(byte[] data, UrlSigner.BlobSignerParameters parameters)

Synchronously signs the given blob.

Parameters
Name	Description
data	byte The data to sign. Must not be null.
parameters	UrlSignerBlobSignerParameters Parameters to use when deriving the signing key. Concrete implementations may allow a null value if no parameters are required.

Returns
Type	Description
string	The blob signature as base64 text.

CreateSignatureAsync(byte[], BlobSignerParameters, CancellationToken)

public Task<string> CreateSignatureAsync(byte[] data, UrlSigner.BlobSignerParameters parameters, CancellationToken cancellationToken)

Asynchronously signs the given blob.

Parameters
Name	Description
data	byte The data to sign. Must not be null.
parameters	UrlSignerBlobSignerParameters Parameters to use when deriving the signing key. Concrete implementations may allow a null value if no parameters are required.
cancellationToken	CancellationToken The token to monitor for cancellation requests.

Returns
Type	Description
Taskstring	A task representing the asynchronous operation, with a result returning the blob signature as base64 text.