Skip to content

Cast literals and params to eql_v1_encrypted #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion packages/cipherstash-proxy-integration/src/map_concat.rs
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
#[cfg(test)]
mod tests {
use crate::common::{connect_with_tls, PROXY};
use crate::common::{clear, connect_with_tls, id, PROXY};

#[tokio::test]
async fn map_concat_regression() {
let client = connect_with_tls(PROXY).await;

clear().await;

let id = id();
let encrypted_text = "[email protected]";

let sql = "INSERT INTO encrypted (id, encrypted_text) VALUES ($1, $2)";
client.query(sql, &[&id, &encrypted_text]).await.unwrap();

let sql = "UPDATE encrypted SET encrypted_text = encrypted_text || 'suffix';";

client
Expand Down
1 change: 0 additions & 1 deletion packages/cipherstash-proxy/src/encrypt/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ impl Encrypt {
let rows = client
.query("SELECT eql_v1.version() AS version;", &[])
.await;
// let rows = client.query("SELECT 'WAT' AS version;", &[]).await;

match rows {
Ok(rows) => rows.first().map(|row| row.get("version")),
Expand Down
16 changes: 8 additions & 8 deletions packages/cipherstash-proxy/src/eql/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -84,25 +84,25 @@ pub struct EqlEncryptedBody {

#[derive(Debug, Deserialize, Serialize, Default)]
pub struct EqlEncryptedIndexes {
#[serde(rename = "o")]
#[serde(rename = "o", skip_serializing_if = "Option::is_none")]
pub(crate) ore_index: Option<Vec<String>>,
#[serde(rename = "m")]
#[serde(rename = "m", skip_serializing_if = "Option::is_none")]
pub(crate) match_index: Option<Vec<u16>>,
#[serde(rename = "u")]
#[serde(rename = "u", skip_serializing_if = "Option::is_none")]
pub(crate) unique_index: Option<String>,

#[serde(rename = "s")]
#[serde(rename = "s", skip_serializing_if = "Option::is_none")]
pub(crate) selector: Option<String>,

#[serde(rename = "b")]
#[serde(rename = "b", skip_serializing_if = "Option::is_none")]
pub(crate) blake3_index: Option<String>,

#[serde(rename = "ocf")]
#[serde(rename = "ocf", skip_serializing_if = "Option::is_none")]
pub(crate) ore_cclw_fixed_index: Option<String>,
#[serde(rename = "ocv")]
#[serde(rename = "ocv", skip_serializing_if = "Option::is_none")]
pub(crate) ore_cclw_var_index: Option<String>,

#[serde(rename = "sv")]
#[serde(rename = "sv", skip_serializing_if = "Option::is_none")]
pub(crate) ste_vec_index: Option<Vec<EqlEncryptedBody>>,
}

Expand Down
2 changes: 1 addition & 1 deletion packages/cipherstash-proxy/src/postgresql/backend.rs
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ where
// Each row is converted into Vec<Option<CipherText>>
let ciphertexts: Vec<Option<EqlEncrypted>> = rows
.iter_mut()
.flat_map(|row| row.to_ciphertext(projection_columns))
.flat_map(|row| row.as_ciphertext(projection_columns))
.collect::<Vec<_>>();

let start = Instant::now();
Expand Down
12 changes: 6 additions & 6 deletions packages/cipherstash-proxy/src/postgresql/messages/data_row.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ pub struct DataColumn {
}

impl DataRow {
pub fn to_ciphertext(
pub fn as_ciphertext(
&mut self,
column_configuration: &Vec<Option<Column>>,
) -> Vec<Option<eql::EqlEncrypted>> {
Expand Down Expand Up @@ -240,7 +240,7 @@ mod tests {
use crate::{
config::{LogConfig, LogLevel},
log,
postgresql::{data, messages::data_row::DataColumn, Column},
postgresql::{messages::data_row::DataColumn, Column},
};
use bytes::BytesMut;
use cipherstash_client::schema::{ColumnConfig, ColumnType};
Expand Down Expand Up @@ -270,7 +270,7 @@ mod tests {
let mut data_row = DataRow::try_from(&bytes).unwrap();

let column_config = column_config_with_id("encrypted_text");
let encrypted = data_row.to_ciphertext(&column_config);
let encrypted = data_row.as_ciphertext(&column_config);

assert_eq!(encrypted.len(), 2);

Expand Down Expand Up @@ -299,7 +299,7 @@ mod tests {
assert!(data_row.columns[1].bytes.is_some());

let column_config = column_config_with_id("encrypted_text");
let encrypted = data_row.to_ciphertext(&column_config);
let encrypted = data_row.as_ciphertext(&column_config);

assert_eq!(encrypted.len(), 2);

Expand All @@ -322,7 +322,7 @@ mod tests {
assert!(data_row.columns[0].bytes.is_some());

let column_config = vec![column_config("encrypted_jsonb")];
let encrypted = data_row.to_ciphertext(&column_config);
let encrypted = data_row.as_ciphertext(&column_config);

assert_eq!(encrypted.len(), 1);
assert!(encrypted[0].is_some());
Expand Down Expand Up @@ -358,7 +358,7 @@ mod tests {
column_config("encrypted_jsonb"),
];

let encrypted = data_row.to_ciphertext(&column_config);
let encrypted = data_row.as_ciphertext(&column_config);

assert_eq!(encrypted.len(), 10);

Expand Down
18 changes: 9 additions & 9 deletions packages/eql-mapper/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -983,7 +983,7 @@ mod test {
}

#[test]
fn select_with_literal_subsitution() {
fn select_with_literal_cast_as_encrypted() {
// init_tracing();

let schema = resolver(schema! {
Expand Down Expand Up @@ -1026,14 +1026,14 @@ mod test {
)])) {
Ok(transformed_statement) => assert_eq!(
transformed_statement.to_string(),
"SELECT * FROM employees WHERE salary > ROW('ENCRYPTED'::JSONB)"
"SELECT * FROM employees WHERE salary > 'ENCRYPTED'::JSONB::eql_v1_encrypted"
),
Err(err) => panic!("statement transformation failed: {}", err),
};
}

#[test]
fn insert_with_literal_subsitution() {
fn insert_with_literal_cast_as_encrypted() {
// init_tracing();

let schema = resolver(schema! {
Expand Down Expand Up @@ -1073,7 +1073,7 @@ mod test {
)])) {
Ok(transformed_statement) => assert_eq!(
transformed_statement.to_string(),
"INSERT INTO employees (salary) VALUES (ROW('ENCRYPTED'::JSONB))"
"INSERT INTO employees (salary) VALUES ('ENCRYPTED'::JSONB::eql_v1_encrypted)"
),
Err(err) => panic!("statement transformation failed: {}", err),
};
Expand Down Expand Up @@ -1392,7 +1392,7 @@ mod test {
}

#[test]
fn eql_params_are_wrapped_in_row() {
fn select_with_params_cast_as_encrypted() {
// init_tracing();
let schema = resolver(schema! {
tables: {
Expand All @@ -1415,7 +1415,7 @@ mod test {
Ok(statement) => {
assert_eq!(
statement.to_string(),
"SELECT * FROM employees WHERE eql_col = ROW($1::JSONB) AND native_col = $2"
"SELECT * FROM employees WHERE eql_col = $1::JSONB::eql_v1_encrypted AND native_col = $2"
);
}
Err(err) => panic!("transformation failed: {err}"),
Expand Down Expand Up @@ -1450,7 +1450,7 @@ mod test {
Ok(statement) => {
assert_eq!(
statement.to_string(),
"SELECT eql_v1.jsonb_path_query(eql_col, ROW('<encrypted-selector($.secret)>'::JSONB)), jsonb_path_query(native_col, '$.not-secret') FROM employees"
"SELECT eql_v1.jsonb_path_query(eql_col, '<encrypted-selector($.secret)>'::JSONB::eql_v1_encrypted), jsonb_path_query(native_col, '$.not-secret') FROM employees"
);
}
Err(err) => panic!("transformation failed: {err}"),
Expand Down Expand Up @@ -1567,7 +1567,7 @@ mod test {
.map(|expr| match expr {
ast::Expr::Identifier(ident) => ident.to_string(),
ast::Expr::Value(ast::Value::SingleQuotedString(s)) => {
format!("ROW('<encrypted-selector({})>'::JSONB)", s)
format!("'<encrypted-selector({})>'::JSONB::eql_v1_encrypted", s)
}
_ => panic!("unsupported expr type in test util"),
})
Expand Down Expand Up @@ -1623,7 +1623,7 @@ mod test {
match typed.transform(test_helpers::dummy_encrypted_json_selector(&statement, ast::Value::SingleQuotedString("medications".to_owned()))) {
Ok(statement) => assert_eq!(
statement.to_string(),
format!("SELECT id, notes {} ROW('<encrypted-selector(medications)>'::JSONB) AS meds FROM patients", op)
format!("SELECT id, notes {} '<encrypted-selector(medications)>'::JSONB::eql_v1_encrypted AS meds FROM patients", op)
),
Err(err) => panic!("transformation failed: {err}"),
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,27 +1,25 @@
use std::{any::type_name, collections::HashMap};

use sqltk::parser::ast::{
CastKind, DataType, Expr, Function, FunctionArg, FunctionArgExpr, FunctionArgumentList,
FunctionArguments, Ident, ObjectName, Value,
};
use sqltk::parser::ast::{Expr, Value};
use sqltk::{NodeKey, NodePath, Visitable};

use crate::EqlMapperError;

use super::helpers::cast_as_encrypted;
use super::TransformationRule;

#[derive(Debug)]
pub struct ReplacePlaintextEqlLiterals<'ast> {
pub struct CastLiteralsAsEncrypted<'ast> {
encrypted_literals: HashMap<NodeKey<'ast>, Value>,
}

impl<'ast> ReplacePlaintextEqlLiterals<'ast> {
impl<'ast> CastLiteralsAsEncrypted<'ast> {
pub fn new(encrypted_literals: HashMap<NodeKey<'ast>, Value>) -> Self {
Self { encrypted_literals }
}
}

impl<'ast> TransformationRule<'ast> for ReplacePlaintextEqlLiterals<'ast> {
impl<'ast> TransformationRule<'ast> for CastLiteralsAsEncrypted<'ast> {
fn apply<N: Visitable>(
&mut self,
node_path: &NodePath<'ast>,
Expand All @@ -31,7 +29,7 @@ impl<'ast> TransformationRule<'ast> for ReplacePlaintextEqlLiterals<'ast> {
if let Some((Expr::Value(value),)) = node_path.last_1_as::<Expr>() {
if let Some(replacement) = self.encrypted_literals.remove(&NodeKey::new(value)) {
let target_node = target_node.downcast_mut::<Expr>().unwrap();
*target_node = make_row_expression(replacement);
*target_node = cast_as_encrypted(replacement);
return Ok(true);
}
}
Expand All @@ -58,25 +56,3 @@ impl<'ast> TransformationRule<'ast> for ReplacePlaintextEqlLiterals<'ast> {
}
}
}

fn make_row_expression(replacement: Value) -> Expr {
Expr::Function(Function {
name: ObjectName(vec![Ident::new("ROW")]),
uses_odbc_syntax: false,
parameters: FunctionArguments::None,
args: FunctionArguments::List(FunctionArgumentList {
duplicate_treatment: None,
clauses: vec![],
args: vec![FunctionArg::Unnamed(FunctionArgExpr::Expr(Expr::Cast {
kind: CastKind::DoubleColon,
expr: Box::new(Expr::Value(replacement)),
data_type: DataType::JSONB,
format: None,
}))],
}),
filter: None,
null_treatment: None,
over: None,
within_group: vec![],
})
}
Original file line number Diff line number Diff line change
@@ -1,26 +1,23 @@
use std::collections::HashMap;
use std::sync::Arc;

use super::helpers::cast_as_encrypted;
use super::TransformationRule;
use crate::{EqlMapperError, Type};
use sqltk::parser::ast::{Expr, Value};
use sqltk::{NodeKey, NodePath, Visitable};

use crate::{EqlMapperError, Type};

use super::helpers::make_row_expression;
use super::TransformationRule;
use std::collections::HashMap;
use std::sync::Arc;

#[derive(Debug)]
pub struct WrapEqlParamsInRow<'ast> {
pub struct CastParamsAsEncrypted<'ast> {
node_types: Arc<HashMap<NodeKey<'ast>, Type>>,
}

impl<'ast> WrapEqlParamsInRow<'ast> {
impl<'ast> CastParamsAsEncrypted<'ast> {
pub fn new(node_types: Arc<HashMap<NodeKey<'ast>, Type>>) -> Self {
Self { node_types }
}
}

impl<'ast> TransformationRule<'ast> for WrapEqlParamsInRow<'ast> {
impl<'ast> TransformationRule<'ast> for CastParamsAsEncrypted<'ast> {
fn apply<N: Visitable>(
&mut self,
node_path: &NodePath<'ast>,
Expand All @@ -33,7 +30,7 @@ impl<'ast> TransformationRule<'ast> for WrapEqlParamsInRow<'ast> {
unreachable!("the Expr is known to be Expr::Value(Value::Placeholder(_))")
};

*expr = make_row_expression(value);
*expr = cast_as_encrypted(value);
return Ok(true);
}
}
Expand Down
36 changes: 16 additions & 20 deletions packages/eql-mapper/src/transformation_rules/helpers.rs
Original file line number Diff line number Diff line change
Expand Up @@ -48,26 +48,22 @@ pub(crate) fn wrap_in_1_arg_function(expr: Expr, name: ObjectName) -> Expr {
})
}

pub(crate) fn make_row_expression(wrapped: sqltk::parser::ast::Value) -> Expr {
Expr::Function(Function {
name: ObjectName(vec![Ident::new("ROW")]),
uses_odbc_syntax: false,
parameters: FunctionArguments::None,
args: FunctionArguments::List(FunctionArgumentList {
duplicate_treatment: None,
clauses: vec![],
args: vec![FunctionArg::Unnamed(FunctionArgExpr::Expr(Expr::Cast {
kind: CastKind::DoubleColon,
expr: Box::new(Expr::Value(wrapped)),
data_type: DataType::JSONB,
format: None,
}))],
}),
filter: None,
null_treatment: None,
over: None,
within_group: vec![],
})
pub(crate) fn cast_as_encrypted(wrapped: sqltk::parser::ast::Value) -> Expr {
let cast_jsonb = Expr::Cast {
kind: CastKind::DoubleColon,
expr: Box::new(Expr::Value(wrapped)),
data_type: DataType::JSONB,
format: None,
};

let encrypted_type = ObjectName(vec![Ident::new("eql_v1_encrypted")]);

Expr::Cast {
kind: CastKind::DoubleColon,
expr: Box::new(cast_jsonb),
data_type: DataType::Custom(encrypted_type, vec![]),
format: None,
}
}

struct ContainsExprWithType<'ast, 't> {
Expand Down
8 changes: 4 additions & 4 deletions packages/eql-mapper/src/transformation_rules/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,24 @@

mod helpers;

mod cast_literals_as_encrypted;
mod cast_params_as_encrypted;
mod fail_on_placeholder_change;
mod group_by_eql_col;
mod preserve_effective_aliases;
mod replace_plaintext_eql_literals;
mod rewrite_standard_sql_fns_on_eql_types;
mod wrap_eql_cols_in_order_by_with_ore_fn;
mod wrap_eql_params_in_row;
mod wrap_grouped_eql_col_in_aggregate_fn;

use std::marker::PhantomData;

pub(crate) use cast_literals_as_encrypted::*;
pub(crate) use cast_params_as_encrypted::*;
pub(crate) use fail_on_placeholder_change::*;
pub(crate) use group_by_eql_col::*;
pub(crate) use preserve_effective_aliases::*;
pub(crate) use replace_plaintext_eql_literals::*;
pub(crate) use rewrite_standard_sql_fns_on_eql_types::*;
pub(crate) use wrap_eql_cols_in_order_by_with_ore_fn::*;
pub(crate) use wrap_eql_params_in_row::*;
pub(crate) use wrap_grouped_eql_col_in_aggregate_fn::*;

use crate::EqlMapperError;
Expand Down
Loading
Loading