Struct Encrypted 

pub struct Encrypted(pub String);

A column encrypted with a random nonce: reads decrypt, writes encrypt.

Use it as the type of an encrypted column in the row struct: reading a row decrypts the stored text with the installed keys (a failure is a deserialization error, so the query fails with a 500). Input structs (New/Changes, forms, JSON bodies) keep a plain String and the model binds Encrypted::from(value), which stores a new ciphertext. Serializing (JSON responses, templates) writes the plain value; Debug hides it.

Examples

use ocre::{IntoParam, encryption::{self, Encrypted, Encryptor}};

encryption::install(Encryptor::new(&"t".repeat(64), &[]).unwrap());
let ssn = Encrypted::from("123-45-6789");
assert_eq!(serde_json::to_string(&ssn).unwrap(), r#""123-45-6789""#);
assert_ne!(ssn.clone().into_param(), "123-45-6789".into_param());
assert_eq!(format!("{ssn:?}"), "Encrypted(..)");

Tuple Fields

0: String

Implementations

impl Encrypted

pub fn as_str(&self) -> &str

The plain value.

Examples

assert_eq!(ocre::encryption::Encrypted::from("x").as_str(), "x");

Trait Implementations

impl Clone for Encrypted

fn clone(&self) -> Encrypted

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Encrypted

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Encrypted

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Encrypted

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Encrypted

impl From<&str> for Encrypted

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for Encrypted

fn from(value: String) -> Self

Converts to this type from the input type.

impl IntoParam for Encrypted

Binds the encrypted text. Without installed keys (no valid SECRET_KEY_BASE) it binds NULL, which a NOT NULL column refuses; the error is logged.

fn into_param(self) -> Param

Converts the value into a bound parameter.

impl PartialEq for Encrypted

fn eq(&self, other: &Encrypted) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Encrypted

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Encrypted