IAuthenticatedEncryptorFactory.CreateEncryptorInstance(IKey) Method

Definition

Namespace:

Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption

Assembly:

Microsoft.AspNetCore.DataProtection.dll

Package:

Microsoft.AspNetCore.DataProtection v9.0.0

Source:

IAuthenticatedEncryptorFactory.cs

Creates an IAuthenticatedEncryptor instance based on the given Descriptor.

public:
 Microsoft::AspNetCore::DataProtection::AuthenticatedEncryption::IAuthenticatedEncryptor ^ CreateEncryptorInstance(Microsoft::AspNetCore::DataProtection::KeyManagement::IKey ^ key);

public Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.IAuthenticatedEncryptor? CreateEncryptorInstance (Microsoft.AspNetCore.DataProtection.KeyManagement.IKey key);

abstract member CreateEncryptorInstance : Microsoft.AspNetCore.DataProtection.KeyManagement.IKey -> Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.IAuthenticatedEncryptor

Public Function CreateEncryptorInstance (key As IKey) As IAuthenticatedEncryptor

Parameters

key

IKey

Returns

IAuthenticatedEncryptor

An IAuthenticatedEncryptor instance.

Remarks

For a given Descriptor, any two instances returned by this method should be considered equivalent, e.g., the payload returned by one's Encrypt(ArraySegment<Byte>, ArraySegment<Byte>) method should be consumable by the other's Decrypt(ArraySegment<Byte>, ArraySegment<Byte>) method.