Repository navigation
refactor(stack-encrypt)!: remove target::legacy #1613
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
Changes from all commits
e23510d
2e668b1
962f20c
92cde8e
3dbc8ed
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -116,6 +116,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 | |
|
|
||
| ### Breaking | ||
|
|
||
| - **`target::legacy` is removed** (#1488). It held two traits, | ||
| implemented for every type, that gave the structural API a second | ||
| call syntax: `value.encrypt_into(&keyset)`, | ||
| `value.encrypt_into_with_context(&keyset, context)`, | ||
| `Target::encrypt_from(&value, &keyset, context)`, | ||
| `stored.decrypt_into(&cipher, context)`, `P::decrypt_from(stored, &cipher)` | ||
| and `P::decrypt_from_with_context(stored, &cipher, context)`. Their | ||
| names were the same as the owned traits' `EncryptInto` and | ||
| `DecryptFrom`, but they borrowed the plaintext. | ||
| - To upgrade a type that implements `EncryptTarget` or | ||
| `DecryptSource`, use the owned traits. They take the plaintext by | ||
| value. | ||
| - To upgrade a type that implements only `EncryptFrom` or | ||
| `DecryptInto`, call the cipher. The context is `T::Context`, so | ||
| convert it with `into()`: | ||
|
|
||
| | Removed call | Replacement | | ||
| | --- | --- | | ||
| | `value.encrypt_into(&keyset)` | `keyset.encrypt_as(&value, Default::default())` | | ||
| | `value.encrypt_into_with_context(&keyset, context)` | `keyset.encrypt_as(&value, context.into())` | | ||
| | `Target::encrypt_from(&value, &keyset, context)` | `keyset.encrypt_as::<_, Target>(&value, context.into())` | | ||
| | `stored.decrypt_into(&cipher, context)` | `cipher.decrypt_as(stored, context.into())` | | ||
| | `P::decrypt_from(stored, &cipher)` | `cipher.decrypt_as::<P, _>(stored, Default::default())` | | ||
| | `P::decrypt_from_with_context(stored, &cipher, context)` | `cipher.decrypt_as::<P, _>(stored, context.into())` | | ||
|
Comment on lines
+140
to
+142
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note the The removed
|
||
|
|
||
| `encrypt_as` does not name the target, so name it with a type | ||
| annotation on the result or with the turbofish shown. | ||
| - If `value` is already a reference, pass it as it is: | ||
| `keyset.encrypt_as(value, ..)`. The removed methods took the value | ||
| through method-call autoref, so a `&String` receiver encrypted a | ||
| `String`. `encrypt_as(&value, ..)` on a `&String` encrypts a | ||
| `&String` instead. Into a derived record that is a compile error. | ||
| Into `StackCipherText` it compiles, because that target accepts any | ||
| `Encrypt` source. | ||
|
|
||
| - **`target::ExpectedContext` is no longer part of the API** (#1488). It | ||
| is the check that a `#[stash(context_field)]` record runs on decrypt: | ||
| the stored context must equal the one the caller expects, if the caller | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| //! Searchable Encrypted Metadata, leaf by leaf. | ||
| //! | ||
| //! Shows each index-term primitive on its own through the target-directed | ||
| //! `encrypt_into` API: equality terms (exact match), match terms (full-text | ||
| //! owned `encrypt_into` API: equality terms (exact match), match terms (full-text | ||
| //! containment), and ORE/OPE terms (range queries) — all generated locally | ||
| //! from a deterministic per-keyset index key, then compared the way a server | ||
| //! would compare them: without ever seeing a plaintext. | ||
|
|
@@ -20,8 +20,8 @@ | |
|
|
||
| use stack_encrypt::sem::{EqualityTerm, MatchTerms, OreTerm}; | ||
|
|
||
| use stack_encrypt::target::legacy::EncryptInto; | ||
| use stack_encrypt::{nonempty, EncryptFrom, StackCipher, StackCipherText}; | ||
| use stack_encrypt::target::EncryptTarget; | ||
| use stack_encrypt::{nonempty, EncryptInto, StackCipher, StackCipherText}; | ||
|
|
||
| #[tokio::main(flavor = "current_thread")] | ||
| async fn main() -> Result<(), Box<dyn std::error::Error>> { | ||
|
|
@@ -44,17 +44,17 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { | |
| // field: the same | ||
| // value indexed under another field can never produce a colliding term. | ||
|
|
||
| let stored: EqualityTerm = "alice@example.com" | ||
| let stored: EqualityTerm = String::from("alice@example.com") | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is &str no longer implemented?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not on the owned path. |
||
| .encrypt_into_with_context(&terms, nonempty!("users").with("email")) | ||
| .await?; | ||
|
|
||
| let hit: EqualityTerm = "alice@example.com" | ||
| let hit: EqualityTerm = String::from("alice@example.com") | ||
| .encrypt_into_with_context(&terms, nonempty!("users").with("email")) | ||
| .await?; | ||
| let miss: EqualityTerm = "bob@example.com" | ||
| let miss: EqualityTerm = String::from("bob@example.com") | ||
| .encrypt_into_with_context(&terms, nonempty!("users").with("email")) | ||
| .await?; | ||
| let wrong_field: EqualityTerm = "alice@example.com" | ||
| let wrong_field: EqualityTerm = String::from("alice@example.com") | ||
| .encrypt_into_with_context(&terms, nonempty!("users").with("name")) | ||
| .await?; | ||
|
|
||
|
|
@@ -127,10 +127,10 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { | |
| // | ||
| // Leaf by leaf is the query side. On the write side a field is stored | ||
| // as *every* term it needs beside its ciphertext, in one shape: derive | ||
| // `EncryptFrom` for that shape and each field of it is derived from the | ||
| // `EncryptTarget` for that shape and each field of it is derived from the | ||
| // one value under the one context — byte-identical to the leaves above, | ||
| // so a probe built leaf by leaf finds what the record stored. | ||
| #[derive(EncryptFrom)] | ||
| #[derive(EncryptTarget)] | ||
| #[stash(plaintext = String)] | ||
| struct SearchableEmail { | ||
| c: StackCipherText, | ||
|
|
@@ -164,7 +164,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { | |
| .encrypt_into_with_context(&terms, nonempty!("users").with("email")) | ||
| .await? | ||
| ); | ||
| let _ = record.c; // the ciphertext, opened with `decrypt_into` under the same context | ||
| let _ = record.c; // the ciphertext, opened with `decrypt_from_with_context` under the same context | ||
|
|
||
| Ok(()) | ||
| } | ||
Uh oh!
There was an error while loading. Please reload this page.