Skip to main content

Key

Struct Key 

pub struct Key(/* private fields */);
Expand description

A 256-bit encryption key for CLLW Order-Revealing Encryption.

The key is used to encrypt and decrypt values while preserving their ordering. All encryption operations are deterministic for a given key.

§Examples

use cllw_ore::Key;

// Create a key from a 32-byte array
let key = Key::from([0u8; 32]);

// Encrypt an integer
let plaintext: u32 = 42;
let ciphertext = key.encrypt(plaintext).unwrap();

// Decrypt back to the original value
let decrypted = key.decrypt(ciphertext).unwrap();
assert_eq!(plaintext, decrypted);

Implementations§

§

impl Key

pub fn encrypt<T>( &self, input: T, ) -> Result<<T as CllwOreEncrypt>::Output, Error>
where T: CllwOreEncrypt,

Encrypts a value using CLLW Order-Revealing Encryption.

The encryption is deterministic and preserves the ordering of values. Supported types: u16, u32, u64, u128, &str, &[u8]

§Examples
use cllw_ore::Key;
use std::cmp::Ordering;

let key = Key::from([0u8; 32]);

// Order is preserved
let a = key.encrypt(10u32).unwrap();
let b = key.encrypt(20u32).unwrap();
assert_eq!(a.cmp(&b), Ordering::Less);

// Encryption is deterministic
let c = key.encrypt(10u32).unwrap();
assert_eq!(a, c);

pub fn decrypt<T>( &self, input: T, ) -> Result<<T as CllwOreDecrypt>::Output, Error>
where T: CllwOreDecrypt,

Decrypts a ciphertext back to its original value.

§Examples
use cllw_ore::Key;

let key = Key::from([0u8; 32]);
let plaintext = 12345u64;

let ciphertext = key.encrypt(plaintext).unwrap();
let decrypted = key.decrypt(ciphertext).unwrap();

assert_eq!(plaintext, decrypted);

Trait Implementations§

§

impl From<[u8; 32]> for Key

§

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

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Key

§

impl RefUnwindSafe for Key

§

impl Send for Key

§

impl Sync for Key

§

impl Unpin for Key

§

impl UnwindSafe for Key

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, 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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