Class ProducerEndpointBuilderEncryptUsingExtensions

Adds the EncryptUsingAes method to the ProducerEndpointBuilder<TEndpoint, TBuilder>.

Inheritance

object

ProducerEndpointBuilderEncryptUsingExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Silverback.Messaging.Configuration

Assembly: Silverback.Integration.dll

Syntax

public static class ProducerEndpointBuilderEncryptUsingExtensions

Methods

EncryptUsingAes<TBuilder>(IProducerEndpointBuilder<TBuilder>, byte[], byte[]?)

Specifies that the AES algorithm has to be used to encrypt the messages.

Declaration

public static TBuilder EncryptUsingAes<TBuilder>(this IProducerEndpointBuilder<TBuilder> endpointBuilder, byte[] key, byte[]? initializationVector = null) where TBuilder : IProducerEndpointBuilder<TBuilder>

Parameters

Type	Name	Description
IProducerEndpointBuilder<TBuilder>	endpointBuilder	The endpoint builder.
byte[]	key	The secret key for the symmetric algorithm.
byte[]	initializationVector	The optional initialization vector (IV) for the symmetric algorithm. If null a different IV will be generated for each message and prepended to the actual message payload.

Returns

Type	Description
TBuilder	The endpoint builder so that additional calls can be chained.

Type Parameters

Name	Description
TBuilder	The actual builder type.

EncryptUsingAes<TBuilder>(IProducerEndpointBuilder<TBuilder>, byte[], string, byte[]?)

Specifies that the AES algorithm has to be used to encrypt the messages.

Declaration

public static TBuilder EncryptUsingAes<TBuilder>(this IProducerEndpointBuilder<TBuilder> endpointBuilder, byte[] key, string keyIdentifier, byte[]? initializationVector = null) where TBuilder : IProducerEndpointBuilder<TBuilder>

Parameters

Type	Name	Description
IProducerEndpointBuilder<TBuilder>	endpointBuilder	The endpoint builder.
byte[]	key	The secret key for the symmetric algorithm.
string	keyIdentifier	The key identifier to be sent in the header (see EncryptionKeyId). When rotating keys, it will be used on the consumer side to determine the correct key to be used to decrypt the message.
byte[]	initializationVector	The optional initialization vector (IV) for the symmetric algorithm. If null a different IV will be generated for each message and prepended to the actual message payload.

Returns

Type	Description
TBuilder	The endpoint builder so that additional calls can be chained.

Type Parameters

Name	Description
TBuilder	The actual builder type.