Class SymmetricEncryptionSettingsBase
The base class for symmetric encryption settings used to encrypt or decrypt the messages being sent through the message broker.
Inheritance
Implements
Inherited Members
Namespace: Silverback.Messaging.Encryption
Assembly: Silverback.Integration.dll
Syntax
public abstract class SymmetricEncryptionSettingsBase : EncryptionSettings, IValidatableEndpointSettings
Properties
| Improve this doc View sourceAlgorithmName
Gets or sets the name of the specific implementation of the SymmetricAlgorithm class to use to encrypt or decrypt the messages.
Declaration
public string AlgorithmName { get; set; }
Property Value
Type | Description |
---|---|
string |
BlockSize
Gets or sets the block size, in bits, of the cryptographic operation.
If null
, the default value for the specified algorithm will be used.
Declaration
public int? BlockSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
CipherMode
Gets or sets the mode for operation of the symmetric algorithm.
If null
, the default value for the specified algorithm will be used.
Declaration
public CipherMode? CipherMode { get; set; }
Property Value
Type | Description |
---|---|
CipherMode? |
FeedbackSize
Gets or sets the feedback size, in bits, of the cryptographic operation for the Cipher Feedback (CFB) and Output Feedback (OFB) cipher modes.
If null
, the default value for the specified algorithm will be used.
Declaration
public int? FeedbackSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
InitializationVector
Gets or sets the optional initialization vector (IV) for the symmetric algorithm.
Important: If null
no fixed IV is provided and the producer will automatically
generate a random one for each message that will also be prepended to the actual encrypted message
to be available to the
consumer.
Declaration
public byte[]? InitializationVector { get; set; }
Property Value
Type | Description |
---|---|
byte[] |
Key
Gets or sets the secret key for the symmetric algorithm.
Declaration
public byte[]? Key { get; set; }
Property Value
Type | Description |
---|---|
byte[] |
PaddingMode
Gets or sets the padding mode used in the symmetric algorithm.
If null
, the default value for the specified algorithm will be used.
Declaration
public PaddingMode? PaddingMode { get; set; }
Property Value
Type | Description |
---|---|
PaddingMode? |
Methods
| Improve this doc View sourceValidate()
Throws an EndpointConfigurationException if the current configuration is not valid.
Declaration
public override void Validate()