MOD-7872: Add Types To Hide User Input by kei-nan · Pull Request #5123 · RediSearch/RediSearch

kei-nan · 2024-10-20T13:26:44Z

Add types that can be used to hide user input.
We want to avoid outputting user data outside the module.

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

Before: there are no types to hide user data
Change: Add types and functions to hide user data
After: Having types that can hide user data

Which issues this PR fixes

MOD-7872

Main objects this PR modified

Obfuscation

Mark if applicable

This PR introduces API changes
This PR introduces serialization changes

codecov · 2024-10-21T12:39:08Z

Codecov Report

Attention: Patch coverage is 94.28571% with 4 lines in your changes missing coverage. Please review.

Project coverage is 86.52%. Comparing base (85a5415) to head (9f6b1c6).
Report is 76 commits behind head on master.

Files with missing lines	Patch %	Lines
src/obfuscation/hidden.c	94.28%	4 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5123      +/-   ##
==========================================
+ Coverage   86.36%   86.52%   +0.15%     
==========================================
  Files         190      193       +3     
  Lines       34701    34756      +55     
==========================================
+ Hits        29971    30071     +100     
+ Misses       4730     4685      -45

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

nafraf

In the PR description, I know that you are using the template, but maybe we should show that 1. is the current state, 2. is the change done, 3. is the outcome. WDYT?
This is part of a bigger feature, then tests will be added later, right?

src/obfuscation/hidden.h

src/obfuscation/hidden.c

src/obfuscation/hidden.h

src/obfuscation/hidden.c

tests/cpptests/redismock/internal.h

Apply suggestions Co-authored-by: nafraf <[email protected]>

* move obfuscated types to their own header

* update length on clone

* implemented missing mock functions to support the new test

* MOD-7872: initial commit * * modify hidden types * * compilation fixes * * get recent updates * * update hidden * Apply suggestions from code review Apply suggestions Co-authored-by: nafraf <[email protected]> * * add tests * * fix hidden test * move obfuscated types to their own header * * add coverage * update length on clone * * remove obfuscated types * * add more testing for more coverage * * add testHiddenDropFromKeySpace for more coverage * implemented missing mock functions to support the new test * * remove obfuscate redundant function * * set correct reply type * * add missing code to get the cpp tests to pass * * free ctx in test * * Code Review - Round #1 --------- Co-authored-by: nafraf <[email protected]> (cherry picked from commit d63f42a)

redisearch-backport-pull-request · 2024-11-11T15:04:13Z

Successfully created backport PR for 8.0:

[8.0] MOD-7872: Add Types To Hide User Input #5197

MOD-7872: Add Types To Hide User Input (#5123) * MOD-7872: initial commit * * modify hidden types * * compilation fixes * * get recent updates * * update hidden * Apply suggestions from code review Apply suggestions Co-authored-by: nafraf <[email protected]> * * add tests * * fix hidden test * move obfuscated types to their own header * * add coverage * update length on clone * * remove obfuscated types * * add more testing for more coverage * * add testHiddenDropFromKeySpace for more coverage * implemented missing mock functions to support the new test * * remove obfuscate redundant function * * set correct reply type * * add missing code to get the cpp tests to pass * * free ctx in test * * Code Review - Round #1 --------- Co-authored-by: nafraf <[email protected]> (cherry picked from commit d63f42a) Co-authored-by: kei-nan <[email protected]>

kei-nan · 2025-01-08T17:23:30Z

/backport

redisearch-backport-pull-request · 2025-01-08T17:23:46Z

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-5123-to-2.8 origin/2.8
cd .worktree/backport-5123-to-2.8
git switch --create backport-5123-to-2.8
git cherry-pick -x d63f42af36fc201d38903715786f9df06b94023d

redisearch-backport-pull-request · 2025-01-08T17:23:47Z

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-5123-to-2.6 origin/2.6
cd .worktree/backport-5123-to-2.6
git switch --create backport-5123-to-2.6
git cherry-pick -x d63f42af36fc201d38903715786f9df06b94023d

* MOD-7872: initial commit * * modify hidden types * * compilation fixes * * get recent updates * * update hidden * Apply suggestions from code review Apply suggestions Co-authored-by: nafraf <[email protected]> * * add tests * * fix hidden test * move obfuscated types to their own header * * add coverage * update length on clone * * remove obfuscated types * * add more testing for more coverage * * add testHiddenDropFromKeySpace for more coverage * implemented missing mock functions to support the new test * * remove obfuscate redundant function * * set correct reply type * * add missing code to get the cpp tests to pass * * free ctx in test * * Code Review - Round #1 --------- Co-authored-by: nafraf <[email protected]> (cherry picked from commit d63f42a)

redisearch-backport-pull-request · 2025-01-08T17:23:51Z

Successfully created backport PR for 2.10:

[2.10] MOD-7872: Add Types To Hide User Input #5485

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

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-5123-to-8.0 origin/8.0
cd .worktree/backport-5123-to-8.0
git switch --create backport-5123-to-8.0
git cherry-pick -x d63f42af36fc201d38903715786f9df06b94023d

* MOD-7872: initial commit * * modify hidden types * * compilation fixes * * get recent updates * * update hidden * Apply suggestions from code review Apply suggestions Co-authored-by: nafraf <[email protected]> * * add tests * * fix hidden test * move obfuscated types to their own header * * add coverage * update length on clone * * remove obfuscated types * * add more testing for more coverage * * add testHiddenDropFromKeySpace for more coverage * implemented missing mock functions to support the new test * * remove obfuscate redundant function * * set correct reply type * * add missing code to get the cpp tests to pass * * free ctx in test * * Code Review - Round #1 --------- Co-authored-by: nafraf <[email protected]> (cherry picked from commit d63f42a)

MOD-7872: Add Types To Hide User Input (#5123) * MOD-7872: initial commit * * modify hidden types * * compilation fixes * * get recent updates * * update hidden * Apply suggestions from code review Apply suggestions Co-authored-by: nafraf <[email protected]> * * add tests * * fix hidden test * move obfuscated types to their own header * * add coverage * update length on clone * * remove obfuscated types * * add more testing for more coverage * * add testHiddenDropFromKeySpace for more coverage * implemented missing mock functions to support the new test * * remove obfuscate redundant function * * set correct reply type * * add missing code to get the cpp tests to pass * * free ctx in test * * Code Review - Round #1 --------- Co-authored-by: nafraf <[email protected]> (cherry picked from commit d63f42a) Co-authored-by: kei-nan <[email protected]>

* MOD-7872: initial commit * * modify hidden types * * compilation fixes * * get recent updates * * update hidden * Apply suggestions from code review Apply suggestions Co-authored-by: nafraf <[email protected]> * * add tests * * fix hidden test * move obfuscated types to their own header * * add coverage * update length on clone * * remove obfuscated types * * add more testing for more coverage * * add testHiddenDropFromKeySpace for more coverage * implemented missing mock functions to support the new test * * remove obfuscate redundant function * * set correct reply type * * add missing code to get the cpp tests to pass * * free ctx in test * * Code Review - Round #1 --------- Co-authored-by: nafraf <[email protected]> (cherry picked from commit d63f42a)

MOD-7872: Add Types To Hide User Input (#5123) * MOD-7872: initial commit * * modify hidden types * * compilation fixes * * get recent updates * * update hidden * Apply suggestions from code review Apply suggestions Co-authored-by: nafraf <[email protected]> * * add tests * * fix hidden test * move obfuscated types to their own header * * add coverage * update length on clone * * remove obfuscated types * * add more testing for more coverage * * add testHiddenDropFromKeySpace for more coverage * implemented missing mock functions to support the new test * * remove obfuscate redundant function * * set correct reply type * * add missing code to get the cpp tests to pass * * free ctx in test * * Code Review - Round #1 --------- Co-authored-by: nafraf <[email protected]> (cherry picked from commit d63f42a)

* MOD-7872: Add Types To Hide User Input (#5123) * MOD-7872: initial commit * * modify hidden types * * compilation fixes * * get recent updates * * update hidden * Apply suggestions from code review Apply suggestions Co-authored-by: nafraf <[email protected]> * * add tests * * fix hidden test * move obfuscated types to their own header * * add coverage * update length on clone * * remove obfuscated types * * add more testing for more coverage * * add testHiddenDropFromKeySpace for more coverage * implemented missing mock functions to support the new test * * remove obfuscate redundant function * * set correct reply type * * add missing code to get the cpp tests to pass * * free ctx in test * * Code Review - Round #1 --------- Co-authored-by: nafraf <[email protected]> (cherry picked from commit d63f42a) * * fix compilation * * add bool include * * wrong function name

kei-nan self-assigned this Oct 20, 2024

kei-nan force-pushed the master_jk_create_types_to_hide_user_input branch from aad1ecf to 15c38ce Compare October 21, 2024 12:16

kei-nan force-pushed the master_jk_create_types_to_hide_user_input branch from 15c38ce to d3ff8c4 Compare October 21, 2024 12:42

nafraf reviewed Oct 21, 2024

View reviewed changes

src/obfuscation/hidden.h Outdated Show resolved Hide resolved

src/obfuscation/hidden.c Show resolved Hide resolved

nafraf reviewed Oct 21, 2024

View reviewed changes

src/obfuscation/hidden.h Outdated Show resolved Hide resolved

kei-nan requested a review from nafraf October 23, 2024 07:43

kei-nan force-pushed the master_jk_create_types_to_hide_user_input branch 2 times, most recently from 21e90e6 to 2ff2a11 Compare October 27, 2024 16:27

Base automatically changed from master_jk_obfuscation_api to master November 6, 2024 13:03

nafraf reviewed Nov 6, 2024

View reviewed changes

src/obfuscation/hidden.c Show resolved Hide resolved

tests/cpptests/redismock/internal.h Outdated Show resolved Hide resolved

nafraf previously approved these changes Nov 7, 2024

View reviewed changes

kei-nan and others added 16 commits November 10, 2024 09:23

MOD-7872: initial commit

11b208f

* modify hidden types

acafcfd

* compilation fixes

053f118

* get recent updates

1cea716

* update hidden

e12e3da

Apply suggestions from code review

7a920be

Apply suggestions Co-authored-by: nafraf <[email protected]>

* add tests

efac997

* fix hidden test

48ae533

* move obfuscated types to their own header

* add coverage

9f36b95

* update length on clone

* remove obfuscated types

2b1c5b9

* add more testing for more coverage

21d46e5

* add testHiddenDropFromKeySpace for more coverage

5477921

* implemented missing mock functions to support the new test

* remove obfuscate redundant function

655eb65

* set correct reply type

9051154

* add missing code to get the cpp tests to pass

2ee44a0

* free ctx in test

ca2494d

kei-nan dismissed nafraf’s stale review via ca2494d November 10, 2024 07:23

kei-nan force-pushed the master_jk_create_types_to_hide_user_input branch from 97290f7 to ca2494d Compare November 10, 2024 07:23

kei-nan enabled auto-merge November 11, 2024 11:50

nafraf approved these changes Nov 11, 2024

View reviewed changes

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

Merged via the queue into master with commit d63f42a Nov 11, 2024

kei-nan deleted the master_jk_create_types_to_hide_user_input branch November 11, 2024 15:03

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

[8.0] MOD-7872: Add Types To Hide User Input #5197

Merged

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

redisearch-backport-pull-request bot mentioned this pull request Jan 8, 2025

[2.10] MOD-7872: Add Types To Hide User Input #5485

Merged

This was referenced Jan 8, 2025

[2.8] MOD-7872: Add Types To Hide User Input #5489

Merged

[2.6] MOD-7872: Add Types To Hide User Input #5490

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MOD-7872: Add Types To Hide User Input#5123

MOD-7872: Add Types To Hide User Input#5123
kei-nan merged 17 commits intomasterfrom
master_jk_create_types_to_hide_user_input

kei-nan commented Oct 20, 2024 •

edited

Loading

Uh oh!

codecov bot commented Oct 21, 2024 •

edited

Loading

Uh oh!

nafraf left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

redisearch-backport-pull-request bot commented Nov 11, 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!

3 participants

Conversation

kei-nan commented Oct 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

nafraf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

redisearch-backport-pull-request bot commented Nov 11, 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!

3 participants

kei-nan commented Oct 20, 2024 •

edited

Loading

codecov bot commented Oct 21, 2024 •

edited

Loading