AuthenticatedEncryptionProvider.Encrypt Method

Definition

Namespace:

Microsoft.IdentityModel.Tokens

Assembly:

Microsoft.IdentityModel.Tokens.dll

Package:

Microsoft.IdentityModel.Tokens v8.2.1

Overloads

Encrypt(Byte[], Byte[])	Encrypts the specified plaintext.
Encrypt(Byte[], Byte[], Byte[])	Encrypts the specified plaintext.

Encrypt(Byte[], Byte[])

Encrypts the specified plaintext.

public virtual Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult Encrypt (byte[] plaintext, byte[] authenticatedData);

abstract member Encrypt : byte[] * byte[] -> Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult
override this.Encrypt : byte[] * byte[] -> Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult

Public Overridable Function Encrypt (plaintext As Byte(), authenticatedData As Byte()) As AuthenticatedEncryptionResult

Parameters

plaintext

Byte[]

The data to be encrypted.

authenticatedData

Byte[]

Will be combined with the initialization vector and ciphertext to create an authentication tag.

Returns

AuthenticatedEncryptionResult

A AuthenticatedEncryptionResult the containing ciphertext, initialization vector, the and authentication tag.

Exceptions

ArgumentNullException

Thrown if authenticatedData is null or empty.

SecurityTokenEncryptionFailedException

Thrown if AES crypto operation threw. See inner exception for details.

ObjectDisposedException

Thrown if the internal SignatureProvider is disposed.

Encrypt(Byte[], Byte[], Byte[])

Encrypts the specified plaintext.

public virtual Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult Encrypt (byte[] plaintext, byte[] authenticatedData, byte[] iv);

abstract member Encrypt : byte[] * byte[] * byte[] -> Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult
override this.Encrypt : byte[] * byte[] * byte[] -> Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult

Public Overridable Function Encrypt (plaintext As Byte(), authenticatedData As Byte(), iv As Byte()) As AuthenticatedEncryptionResult

Parameters

plaintext

Byte[]

The data to be encrypted.

authenticatedData

Byte[]

Will be combined with the initialization vector and ciphertext to create an authentication tag.

iv

Byte[]

The initialization vector to be used with the encryption algorithm.

Returns

AuthenticatedEncryptionResult

A AuthenticatedEncryptionResult containing the ciphertext, initialization vector, and the authentication tag.

Exceptions

ArgumentNullException

Thrown if authenticatedData is null or empty.

SecurityTokenEncryptionFailedException

Thrown if AES crypto operation threw. See inner exception for details.

ObjectDisposedException

Thrown if the internal SignatureProvider is disposed.