feat: rename unique to hmac_256

Author: tobyhede

DEVELOPMENT.md

@@ -318,7 +318,7 @@ Each type of encrypted index (`unique`, `match`, `ore`) has an associated type,
 These are transient runtime types, used internally by EQL functions and operators:
 
 - `eql_v2.blake3`
-- `eql_v2.unique_index`
+- `eql_v2.hmac_256`
 - `eql_v2.bloom_filter`
 - `eql_v2.ore_cllw_u64_8`
 - `eql_v2.ore_cllw_var_8`

README.md

@@ -231,7 +231,7 @@ In order to use the specialized functions, you must first configure the correspo
 
 ### Equality search
 
-Enable equality search on encrypted data using the `eql_v2.unique` function.
+Enable equality search on encrypted data using the `eql_v2.hmac_256` function.
 
 **Index configuration example:**
 
@@ -248,8 +248,8 @@ SELECT eql_v2.add_search_config(
 
 ```sql
 SELECT * FROM users
-WHERE eql_v2.unique(encrypted_email) = eql_v2.unique(
-  '{"v":1,"k":"pt","p":"[email protected]","i":{"t":"users","c":"encrypted_email"},"q":"unique"}'
+WHERE eql_v2.hmac_256(encrypted_email) = eql_v2.hmac_256(
+  '{"v":1,"k":"pt","p":"[email protected]","i":{"t":"users","c":"encrypted_email"},"q":"hmac_256"}'
 );
 ```
 

SUPABASE.md

@@ -28,7 +28,7 @@ In EQL, PostgreSQL operators are an alias for a function, so the implementation
 | --------------------------------- | --------------------------------------------------------- | ----------------------------------------------- |
 | `eql_v2.ciphertext(val)`          | Extract ciphertext from encrypted value              | `SELECT eql_v2.ciphertext     (encrypted_field)`     |
 | `eql_v2.blake3(val)`              | Extract blake3 hash from encrypted value             | `SELECT eql_v2.blake3(     encrypted_field)`         |
-| `eql_v2.unique(val)`              | Extract unique index from encrypted value            | `SELECT eql_v2.unique(encrypted_fie     ld)`         |
+| `eql_v2.hmac_256(val)`            | Extract hmac_256 index from encrypted value            | `SELECT eql_v2.hmac_256(encrypted_fie     ld)`         |
 | `eql_v2.bloom_filter(val)`        | Extract match index from encrypted value             | `SELECT eql_v2.bloom_filter(encrypted_field)`               |
 | `eql_v2.ore_block_u64_8_256(val)` | Extract ORE index from encrypted value               | `SELECT eql_v2.ore_block_u64_8_256(encrypted_field)`   |
 | `eql_v2.ore_cllw_u64_8(val)`      | Extract CLLW ORE index from encrypted value          | `SELECT eql_v2.ore_cllw_u64_8(encrypted_fie     ld)` |

src/encrypted/functions.sql

@@ -1,5 +1,5 @@
 -- REQUIRE: src/encrypted/types.sql
--- REQUIRE: src/match/types.sql
+-- REQUIRE: src/bloom_filter/types.sql
 -- REQUIRE: src/ore/types.sql
 -- REQUIRE: src/unique/types.sql
 

src/unique/functions.sql src/hmac_256/functions.sqlsrc/unique/functions.sql renamed to src/hmac_256/functions.sql

@@ -3,8 +3,8 @@
 
 -- extracts unique index from an encrypted column
 
-CREATE FUNCTION eql_v2.unique(val jsonb)
-  RETURNS eql_v2.unique_index
+CREATE FUNCTION eql_v2.hmac_256(val jsonb)
+  RETURNS eql_v2.hmac_256
   IMMUTABLE STRICT PARALLEL SAFE
 AS $$
 	BEGIN
@@ -18,12 +18,12 @@ $$ LANGUAGE plpgsql;
 
 -- extracts unique index from an encrypted column
 
-CREATE FUNCTION eql_v2.unique(val eql_v2_encrypted)
-  RETURNS eql_v2.unique_index
+CREATE FUNCTION eql_v2.hmac_256(val eql_v2_encrypted)
+  RETURNS eql_v2.hmac_256
   IMMUTABLE STRICT PARALLEL SAFE
 AS $$
   BEGIN
-    RETURN (SELECT eql_v2.unique(val.data));
+    RETURN (SELECT eql_v2.hmac_256(val.data));
   END;
 $$ LANGUAGE plpgsql;
 

src/hmac_256/functions_test.sql

@@ -0,0 +1,14 @@
+\set ON_ERROR_STOP on
+
+DO $$
+  BEGIN
+    PERFORM assert_result(
+        'Extract hmac_256 index term from encrypted',
+        'SELECT eql_v2.hmac_256(''{"u": "u"}''::jsonb)');
+
+    PERFORM assert_exception(
+        'Missing hmac_256 index term in encrypted raises exception',
+        'SELECT eql_v2.hmac_256(''{}''::jsonb)');
+
+  END;
+$$ LANGUAGE plpgsql;

src/hmac_256/types.sql

@@ -0,0 +1,3 @@
+-- REQUIRE: src/schema.sql
+
+CREATE DOMAIN eql_v2.hmac_256 AS text;

src/operators/<.sql

@@ -28,7 +28,6 @@ AS $$
 
     BEGIN
       RETURN eql_v2.ore_cllw_u64_8(a) < eql_v2.ore_cllw_u64_8(b);
-      -- RETURN (eql_v2.unique(a) = eql_v2.unique(b));
     EXCEPTION WHEN OTHERS THEN
       -- PERFORM eql_v2.log('eql_v2.lt no ore_cllw_u64_8 index');
     END;

src/operators/=.sql

@@ -19,8 +19,6 @@
 --      jsonb = eql_v2_encrypted
 --
 -- There are multiple index terms that provide equality comparisons
---   - unique
---   - ore_64_8_v2
 --
 --
 -- We check these index terms in this order and use the first one that exists for both parameters
@@ -35,7 +33,7 @@ AS $$
   BEGIN
 
     BEGIN
-      RETURN eql_v2.unique(a) = eql_v2.unique(b);
+      RETURN eql_v2.hmac_256(a) = eql_v2.hmac_256(b);
     EXCEPTION WHEN OTHERS THEN
       -- PERFORM eql_v2.log('No unique index');
     END;

src/operators/~~.sql

@@ -1,7 +1,7 @@
 -- REQUIRE: src/schema.sql
 -- REQUIRE: src/encrypted/types.sql
--- REQUIRE: src/match/types.sql
--- REQUIRE: src/match/functions.sql
+-- REQUIRE: src/bloom_filter/types.sql
+-- REQUIRE: src/bloom_filter/functions.sql
 
 -- Operators for match comparisons of eql_v2_encrypted types
 --