Skip to main content

EncryptionPlugin

Struct EncryptionPlugin 

Source
pub struct EncryptionPlugin { /* private fields */ }
Expand description

A plugin that provides end-to-end encryption for messages.

This plugin uses AES-256-GCM to encrypt message payloads before they are published and decrypt them after they are received, ensuring message confidentiality.

Implementations§

Source§

impl EncryptionPlugin

Source

pub fn new(key: [u8; 32]) -> Self

Creates a new EncryptionPlugin with the given encryption key.

§Arguments
  • key - A 32-byte array representing the AES-256 key.

Trait Implementations§

Source§

impl Plugin for EncryptionPlugin

Source§

fn on_publish<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _topic: &'life1 str, payload: &'life2 mut Vec<u8>, headers: &'life3 mut HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Encrypts the message payload using AES-256-GCM before publishing.

It generates a random nonce for each message, encrypts the payload, and then adds X-Encryption: aes256-gcm and X-Nonce headers to the message.

Source§

fn on_message_received<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _topic: &'life1 str, payload: &'life2 mut Vec<u8>, headers: &'life3 HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Decrypts the message payload if it has the appropriate encryption headers.

It looks for the X-Encryption: aes256-gcm and X-Nonce headers to correctly decrypt the payload.

Source§

fn name(&self) -> &str

Returns the name of the plugin.
Source§

fn on_init<'life0, 'life1, 'async_trait>( &'life0 mut self, _broker: &'life1 Broker, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called when the plugin is initialized. Read more
Source§

fn on_before_recieved<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, topic: &'life1 str, _payload: &'life2 mut Vec<u8>, _headers: &'life3 mut HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Called before a message is received by the broker. Read more
Source§

fn on_subscribe<'life0, 'life1, 'async_trait>( &'life0 self, _topic: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called when a new subscription is made. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more