Skip to content
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

CLI: Expose a function to scan JSON objects for secrets #502

Open
rajdip-b opened this issue Oct 18, 2024 · 8 comments
Open

CLI: Expose a function to scan JSON objects for secrets #502

rajdip-b opened this issue Oct 18, 2024 · 8 comments
Assignees
Labels
difficulty: 3 good first issue Good for newcomers hacktoberfest Hacktoberfest is on! help wanted Extra attention is needed priority: high scope: cli Everything related to the CLI type: feature Release drafter tag for tagging PRs related to adding new features

Comments

@rajdip-b
Copy link
Member

rajdip-b commented Oct 18, 2024

Description

In the secret-scan package, we would like to have a function that would take in an object and then do the following:

  • The object would be of type Record<string, string>
  • It would scan through these key-value pairs, and flag if a key's value is secret or not.
  • After the scan is completed, the function will return back a JSON object like this:
    {
      "secrets": [],
      "variables": []
    }
    This will return the keys.

Solution

@Sambit003 please drop the tech stuff in here.

@rajdip-b rajdip-b added good first issue Good for newcomers help wanted Extra attention is needed type: feature Release drafter tag for tagging PRs related to adding new features priority: high difficulty: 3 hacktoberfest Hacktoberfest is on! scope: secret-scan labels Oct 18, 2024
@diya-kishore
Copy link

Can i work on this please?

@rajdip-b
Copy link
Member Author

Sure!

@rajdip-b
Copy link
Member Author

rajdip-b commented Nov 5, 2024

@diya-kishore Unassigning due to inactivity

@rajdip-b rajdip-b added scope: cli Everything related to the CLI and removed scope: secret-scan labels Nov 5, 2024
@rajdip-b rajdip-b changed the title SECRET-SCAN: Expose a function to scan JSON objects for secrets CLI: Expose a function to scan JSON objects for secrets Nov 5, 2024
@superiorsd10
Copy link

Hello @rajdip-b,

I would like to work on this issue, so can you please assign it to me?

Thank you,

@rajdip-b
Copy link
Member Author

cool!

@rajdip-b
Copy link
Member Author

rajdip-b commented Dec 9, 2024

@superiorsd10 hey, any updates on this?

@rajdip-b rajdip-b assigned muntaxir4 and unassigned superiorsd10 Dec 14, 2024
@muntaxir4
Copy link
Contributor

@rajdip-b what's the tech stuff you mentioned?
And I think detecting variables might not be implemented yet in the secret scanning.

@rajdip-b
Copy link
Member Author

I did not create the secret scan package, so i'm not entirely sure what all things might be needed. thats why i mentioned it as "tech stuff"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: 3 good first issue Good for newcomers hacktoberfest Hacktoberfest is on! help wanted Extra attention is needed priority: high scope: cli Everything related to the CLI type: feature Release drafter tag for tagging PRs related to adding new features
Projects
None yet
Development

No branches or pull requests

4 participants