IKeyManager Interface

Definition

Namespace:

Microsoft.AspNetCore.DataProtection.KeyManagement

Assembly:

Microsoft.AspNetCore.DataProtection.dll

Package:

Microsoft.AspNetCore.DataProtection v8.0.0

Source:

IKeyManager.cs

The basic interface for performing key management operations.

public interface class IKeyManager

public interface IKeyManager

type IKeyManager = interface

Public Interface IKeyManager

Derived

Microsoft.AspNetCore.DataProtection.KeyManagement.IDeletableKeyManager

Microsoft.AspNetCore.DataProtection.KeyManagement.XmlKeyManager

Remarks

Instantiations of this interface are expected to be thread-safe.

Methods

CreateNewKey(DateTimeOffset, DateTimeOffset)	Creates a new key with the specified activation and expiration dates and persists the new key to the underlying repository.
GetAllKeys()	Fetches all keys from the underlying repository.
GetCacheExpirationToken()	Retrieves a token that signals that callers who have cached the return value of GetAllKeys should clear their caches. This could be in response to a call to CreateNewKey or RevokeKey, or it could be in response to some other external notification. Callers who are interested in observing this token should call this method before the corresponding call to GetAllKeys.
RevokeAllKeys(DateTimeOffset, String)	Revokes all keys created before a specified date and persists the revocation to the underlying repository.
RevokeKey(Guid, String)	Revokes a specific key and persists the revocation to the underlying repository.