IKeyRing Interface¶
The basic interface for accessing a read-only keyring.
- Namespace
Microsoft.AspNetCore.DataProtection.KeyManagement.Internal
- Assemblies
- Microsoft.AspNetCore.DataProtection
Syntax¶
public interface IKeyRing
-
interface
Microsoft.AspNetCore.DataProtection.KeyManagement.Internal.
IKeyRing
Properties¶
-
Microsoft.AspNetCore.DataProtection.KeyManagement.Internal.IKeyRing.
DefaultAuthenticatedEncryptor
¶ The authenticated encryptor that shall be used for new encryption operations.
Return type: Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.IAuthenticatedEncryptor IAuthenticatedEncryptor DefaultAuthenticatedEncryptor { get; }
-
Microsoft.AspNetCore.DataProtection.KeyManagement.Internal.IKeyRing.
DefaultKeyId
¶ The id of the key associated with
Microsoft.AspNetCore.DataProtection.KeyManagement.Internal.IKeyRing.DefaultAuthenticatedEncryptor
.Return type: System.Guid Guid DefaultKeyId { get; }
-
Methods¶
-
GetAuthenticatedEncryptorByKeyId
(System.Guid, out System.Boolean)¶ Returns an encryptor instance for the given key, or ‘null’ if the key with the specified id cannot be found in the keyring.
Return type: Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.IAuthenticatedEncryptor IAuthenticatedEncryptor GetAuthenticatedEncryptorByKeyId(Guid keyId, out bool isRevoked)
-