Comcast / xGitGuard

AI based Secrets Detection Python Framework
Apache License 2.0
59 stars 27 forks source link

File Scanner #32

Open radhi1991 opened 4 months ago

radhi1991 commented 4 months ago

Feature request

We propose adding a feature to xGitGuard that allows scanning of a local file system. Currently, xGitGuard supports scanning GitHub repositories, but we aim to extend this capability to local directories.

The solution

The feature would involve specifying a local path as input instead of a GitHub repository. xGitGuard would recursively retrieve a list of all files within the directory. It would then check each file's extension against a predefined list of supported extensions. Files matching these extensions would be logged into a new file (e.g., searchpath.csv). Subsequently, the scanner would be triggered to analyze these files for security issues.

Describe alternatives you've considered

No alternatives have been considered at this stage, but we are open to community suggestions and feedback.

Additional context

Users would initiate the local file system scan via the command-line interface by providing the path to the directory. Upon completion of the scan, users would be able to view any security detections identified by xGitGuard.

Chadyshack commented 1 month ago

Hi, I am interested in working on this issue. Could you please assign to me? Thank you!

radhi1991 commented 1 month ago

Hi @Chadyshack -> Assigned it to you

nishabalamurugan commented 1 month ago

@Chadyshack Lets collaborate -> Here is my email nishameenab@gmail.com

Chadyshack commented 1 month ago

Hi @nishabalamurugan I just sent you an email from my email c.schwenke@cablelabs.com.