Add secure_file_reader utility and tests#36
Open
Mwessc wants to merge 1 commit intogoogle-labs-code:mainfrom
Open
Add secure_file_reader utility and tests#36Mwessc wants to merge 1 commit intogoogle-labs-code:mainfrom
Mwessc wants to merge 1 commit intogoogle-labs-code:mainfrom
Conversation
This commit introduces a new Python utility function, `secure_file_reader`, located in `src/secure_file_utils.py`. This function demonstrates secure coding principles for reading files, including: - Robust input sanitization (stripping whitespace, checking for empty filenames). - Prohibition of dangerous characters and sequences (e.g., '../', absolute paths, null bytes). - Enforcement of allowed file extensions. - Path whitelisting by ensuring the resolved absolute path of a requested file is within a defined secure base directory. The function is designed for simulation and educational purposes, showing how to build file handling logic with security in mind. It includes detailed comments explaining each security principle. Comprehensive unit tests have been added in `tests/test_secure_file_utils.py` using the `unittest` framework. These tests cover various scenarios, including valid access, attempted exploits (path traversal, null byte injection, etc.), and handling of disallowed extensions. A `.gitignore` file has also been added to exclude common Python cache files from the repository.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit introduces a new Python utility function,
secure_file_reader, located insrc/secure_file_utils.py. This function demonstrates secure coding principles for reading files, including:The function is designed for simulation and educational purposes, showing how to build file handling logic with security in mind. It includes detailed comments explaining each security principle.
Comprehensive unit tests have been added in
tests/test_secure_file_utils.pyusing theunittestframework. These tests cover various scenarios, including valid access, attempted exploits (path traversal, null byte injection, etc.), and handling of disallowed extensions.A
.gitignorefile has also been added to exclude common Python cache files from the repository.Description
Please provide a brief description of your addition or change.
Checklist