public sealed class HmacBlobSigner : UrlSigner.IBlobSignerReference documentation and code samples for the Google Cloud Storage v1 API class UrlSigner.HmacBlobSigner.
Blob signer to implement signing using an HMAC secret.
Implements
UrlSigner.IBlobSignerNamespace
Google.Cloud.Storage.V1Assembly
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 | StringThe HMAC key ID. Must not be null or empty. |
secret | StringThe HMAC key secret. Must not be null or empty. |
| Returns | |
|---|---|
| Type | Description |
UrlSigner.HmacBlobSigner | |
CreateSignature(Byte[], UrlSigner.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 | UrlSigner.BlobSignerParametersParameters 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[], UrlSigner.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 | UrlSigner.BlobSignerParametersParameters to use when deriving the signing key. Concrete implementations may allow a null value if no parameters are required. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<String> | A task representing the asynchronous operation, with a result returning the blob signature as base64 text. |