IKey Interface

The basic interface for representing an authenticated encryption key.

Namespace
Microsoft.AspNetCore.DataProtection.KeyManagement
Assemblies
  • Microsoft.AspNetCore.DataProtection

Syntax

public interface IKey
interface Microsoft.AspNetCore.DataProtection.KeyManagement.IKey

Properties

Microsoft.AspNetCore.DataProtection.KeyManagement.IKey.ActivationDate

The date at which encryptions with this key can begin taking place.

Return type:System.DateTimeOffset
DateTimeOffset ActivationDate { get; }
Microsoft.AspNetCore.DataProtection.KeyManagement.IKey.CreationDate

The date on which this key was created.

Return type:System.DateTimeOffset
DateTimeOffset CreationDate { get; }
Microsoft.AspNetCore.DataProtection.KeyManagement.IKey.ExpirationDate

The date after which encryptions with this key may no longer take place.

Return type:System.DateTimeOffset
DateTimeOffset ExpirationDate { get; }
Microsoft.AspNetCore.DataProtection.KeyManagement.IKey.IsRevoked

Returns a value stating whether this key was revoked.

Return type:System.Boolean
bool IsRevoked { get; }
Microsoft.AspNetCore.DataProtection.KeyManagement.IKey.KeyId

The id of the key.

Return type:System.Guid
Guid KeyId { get; }

Methods

CreateEncryptorInstance()

Creates an IAuthenticatedEncryptor instance that can be used to encrypt data to and decrypt data from this key.

Return type:Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.IAuthenticatedEncryptor
Returns:An IAuthenticatedEncryptor.
IAuthenticatedEncryptor CreateEncryptorInstance()