MOD-7864: Obfuscation API by kei-nan · Pull Request #5060 · RediSearch/RediSearch

kei-nan · 2024-09-30T09:36:28Z

Introduce an obfuscation api

A clear and concise description of what the PR is solving, including:

No obfuscation when outputting data
Add an API to be used for obfuscating user data
Having an obfuscation API

Which issues this PR fixes

MOD-7864

Mark if applicable

This PR introduces API changes
This PR introduces serialization changes

codecov · 2024-09-30T10:18:46Z

Codecov Report

Attention: Patch coverage is 98.41270% with 1 line in your changes missing coverage. Please review.

Project coverage is 86.31%. Comparing base (3e07eff) to head (364ee9c).
Report is 88 commits behind head on master.

Files with missing lines	Patch %	Lines
src/obfuscation/obfuscation_api.c	98.41%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5060      +/-   ##
==========================================
+ Coverage   86.30%   86.31%   +0.01%     
==========================================
  Files         190      191       +1     
  Lines       34604    34667      +63     
==========================================
+ Hits        29864    29924      +60     
- Misses       4740     4743       +3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

tests/ctests/test_obfuscation.c

* update tests

tests/ctests/test_obfuscation.c

src/obfuscation/obfuscation_api.c

…of t_uniqueId

nafraf

I think it's ok, only two simple questions.

src/redisearch.h

src/obfuscation/obfuscation_api.h

kei-nan · 2024-11-06T15:24:38Z

/backport

* MOD-7864: initial commit * * modify object obfuscate api * * compilation fixes * * fix tests * * add query node obfuscation test * * Code Review - Round #1 * * add field path obfuscation * update tests * * Code Review - Round #2 * * Code Review - Round #3 * * Code Review - Round #4 * * add MAX_UNIQUE_ID_TEXT_LENGTH_UPPER_BOUND, compute it based on sizeof t_uniqueId * * add copyright (cherry picked from commit 9235579)

redisearch-backport-pull-request · 2024-11-06T15:24:56Z

Successfully created backport PR for 8.0:

[8.0] MOD-7864: Obfuscation API #5176

MOD-7864: Obfuscation API (#5060) * MOD-7864: initial commit * * modify object obfuscate api * * compilation fixes * * fix tests * * add query node obfuscation test * * Code Review - Round #1 * * add field path obfuscation * update tests * * Code Review - Round #2 * * Code Review - Round #3 * * Code Review - Round #4 * * add MAX_UNIQUE_ID_TEXT_LENGTH_UPPER_BOUND, compute it based on sizeof t_uniqueId * * add copyright (cherry picked from commit 9235579) Co-authored-by: kei-nan <[email protected]>

kei-nan · 2025-01-08T17:21:36Z

/backport

redisearch-backport-pull-request · 2025-01-08T17:21:52Z

Backport failed for 2.8, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.8
git worktree add -d .worktree/backport-5060-to-2.8 origin/2.8
cd .worktree/backport-5060-to-2.8
git switch --create backport-5060-to-2.8
git cherry-pick -x 9235579a58d0cd02ff81a8f9fc471cd67b32d6a2

redisearch-backport-pull-request · 2025-01-08T17:21:53Z

Backport failed for 2.6, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.6
git worktree add -d .worktree/backport-5060-to-2.6 origin/2.6
cd .worktree/backport-5060-to-2.6
git switch --create backport-5060-to-2.6
git cherry-pick -x 9235579a58d0cd02ff81a8f9fc471cd67b32d6a2

redisearch-backport-pull-request · 2025-01-08T17:21:54Z

Backport failed for 2.10, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.10
git worktree add -d .worktree/backport-5060-to-2.10 origin/2.10
cd .worktree/backport-5060-to-2.10
git switch --create backport-5060-to-2.10
git cherry-pick -x 9235579a58d0cd02ff81a8f9fc471cd67b32d6a2

redisearch-backport-pull-request · 2025-01-08T17:21:55Z

Backport failed for 8.0, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 8.0
git worktree add -d .worktree/backport-5060-to-8.0 origin/8.0
cd .worktree/backport-5060-to-8.0
git switch --create backport-5060-to-8.0
git cherry-pick -x 9235579a58d0cd02ff81a8f9fc471cd67b32d6a2

* MOD-7864: initial commit * * modify object obfuscate api * * compilation fixes * * fix tests * * add query node obfuscation test * * Code Review - Round #1 * * add field path obfuscation * update tests * * Code Review - Round #2 * * Code Review - Round #3 * * Code Review - Round #4 * * add MAX_UNIQUE_ID_TEXT_LENGTH_UPPER_BOUND, compute it based on sizeof t_uniqueId * * add copyright (cherry picked from commit 9235579)

MOD-7864: Obfuscation API (#5060) * MOD-7864: initial commit * * modify object obfuscate api * * compilation fixes * * fix tests * * add query node obfuscation test * * Code Review - Round #1 * * add field path obfuscation * update tests * * Code Review - Round #2 * * Code Review - Round #3 * * Code Review - Round #4 * * add MAX_UNIQUE_ID_TEXT_LENGTH_UPPER_BOUND, compute it based on sizeof t_uniqueId * * add copyright (cherry picked from commit 9235579)

* MOD-7864: Obfuscation API (#5060) * MOD-7864: initial commit * * modify object obfuscate api * * compilation fixes * * fix tests * * add query node obfuscation test * * Code Review - Round #1 * * add field path obfuscation * update tests * * Code Review - Round #2 * * Code Review - Round #3 * * Code Review - Round #4 * * add MAX_UNIQUE_ID_TEXT_LENGTH_UPPER_BOUND, compute it based on sizeof t_uniqueId * * add copyright (cherry picked from commit 9235579) * * fix compilation * * forward declare index spec in query_node.h * * fix test

* MOD-7864: Obfuscation API (#5060) * MOD-7864: initial commit * * modify object obfuscate api * * compilation fixes * * fix tests * * add query node obfuscation test * * Code Review - Round #1 * * add field path obfuscation * update tests * * Code Review - Round #2 * * Code Review - Round #3 * * Code Review - Round #4 * * add MAX_UNIQUE_ID_TEXT_LENGTH_UPPER_BOUND, compute it based on sizeof t_uniqueId * * add copyright (cherry picked from commit 9235579) * * fix compilation * * forward declare index spec in query_node.h * * compilation fix * * fix test

kei-nan requested a review from nafraf September 30, 2024 09:36

kei-nan self-assigned this Sep 30, 2024

nafraf reviewed Sep 30, 2024

View reviewed changes

tests/ctests/test_obfuscation.c Show resolved Hide resolved

kei-nan requested a review from nafraf October 6, 2024 06:23

kei-nan added 6 commits October 13, 2024 11:34

MOD-7864: initial commit

05352e1

* modify object obfuscate api

a0ce82e

* compilation fixes

fe80eb6

* fix tests

89970c8

* add query node obfuscation test

31884fd

* Code Review - Round #1

f3284ea

kei-nan force-pushed the master_jk_obfuscation_api branch from d4f29ef to f3284ea Compare October 13, 2024 08:35

* add field path obfuscation

f43a224

* update tests

nafraf reviewed Oct 21, 2024

View reviewed changes

tests/ctests/test_obfuscation.c Outdated Show resolved Hide resolved

* Code Review - Round #2

a6f4147

nafraf reviewed Oct 21, 2024

View reviewed changes

src/obfuscation/obfuscation_api.c Show resolved Hide resolved

* Code Review - Round #3

8d6053d

kei-nan requested a review from nafraf October 21, 2024 14:03

nafraf reviewed Oct 21, 2024

View reviewed changes

src/obfuscation/obfuscation_api.c Outdated Show resolved Hide resolved

* Code Review - Round #4

76e3867

kei-nan requested a review from nafraf October 22, 2024 11:34

kei-nan added 2 commits October 27, 2024 16:45

* add MAX_UNIQUE_ID_TEXT_LENGTH_UPPER_BOUND, compute it based on size…

8f352b0

…of t_uniqueId

* add copyright

364ee9c

nafraf reviewed Nov 5, 2024

View reviewed changes

src/redisearch.h Show resolved Hide resolved

nafraf reviewed Nov 5, 2024

View reviewed changes

src/obfuscation/obfuscation_api.h Show resolved Hide resolved

kei-nan requested a review from nafraf November 6, 2024 08:05

kei-nan enabled auto-merge November 6, 2024 08:06

nafraf approved these changes Nov 6, 2024

View reviewed changes

kei-nan added this pull request to the merge queue Nov 6, 2024

Merged via the queue into master with commit 9235579 Nov 6, 2024

kei-nan deleted the master_jk_obfuscation_api branch November 6, 2024 13:03

kei-nan added the backport 8.0 label Nov 6, 2024

redisearch-backport-pull-request bot mentioned this pull request Nov 6, 2024

[8.0] MOD-7864: Obfuscation API #5176

Merged

kei-nan added backport 2.8 backport 2.6 backport 2.10 labels Jan 8, 2025

kei-nan mentioned this pull request Jan 8, 2025

[2.6] MOD-7864: Obfuscation API #5486

Merged

This was referenced Jan 8, 2025

[2.10] MOD-7864: Obfuscation API #5487

Merged

[2.8] MOD-7864: Obfuscation API #5488

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MOD-7864: Obfuscation API#5060

MOD-7864: Obfuscation API#5060
kei-nan merged 12 commits intomasterfrom
master_jk_obfuscation_api

kei-nan commented Sep 30, 2024

Uh oh!

codecov bot commented Sep 30, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nafraf left a comment

Uh oh!

Uh oh!

Uh oh!

kei-nan commented Nov 6, 2024

Uh oh!

redisearch-backport-pull-request bot commented Nov 6, 2024

Uh oh!

kei-nan commented Jan 8, 2025

Uh oh!

redisearch-backport-pull-request bot commented Jan 8, 2025

Uh oh!

redisearch-backport-pull-request bot commented Jan 8, 2025

Uh oh!

redisearch-backport-pull-request bot commented Jan 8, 2025

Uh oh!

redisearch-backport-pull-request bot commented Jan 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

kei-nan commented Sep 30, 2024

Uh oh!

codecov bot commented Sep 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nafraf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kei-nan commented Nov 6, 2024

Uh oh!

redisearch-backport-pull-request bot commented Nov 6, 2024

Uh oh!

kei-nan commented Jan 8, 2025

Uh oh!

redisearch-backport-pull-request bot commented Jan 8, 2025

Uh oh!

redisearch-backport-pull-request bot commented Jan 8, 2025

Uh oh!

redisearch-backport-pull-request bot commented Jan 8, 2025

Uh oh!

redisearch-backport-pull-request bot commented Jan 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Sep 30, 2024 •

edited

Loading