diff --git a/README.md b/README.md index 1c1636a..d0fcb73 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,114 @@ -# filevault +# FileVault +[![pipeline status](https://git.unturf.com/engineering/unturf/filevault/badges/main/pipeline.svg)](https://git.unturf.com/engineering/unturf/filevault/-/commits/main) +[![license](https://img.shields.io/badge/license-Public%20Domain-blue.svg)](https://en.wikipedia.org/wiki/Public_domain) +FileVault is a class for managing a hash directory tree of files on a filesystem. -## Getting started +A Vault will: -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +* Create a hash directory tree of custom depth +* Spread out files to keep CLI snappy when traversing the tree +* Scale to hundreds of thousands of files +* Obfuscate directory paths and filenames -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +## How to Install -## Add your files - -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: - -``` -cd existing_repo -git remote add origin https://git.unturf.com/engineering/unturf/filevault.git -git branch -M main -git push -uf origin main +### From GitLab +```bash +pip install git+https://git.unturf.com/engineering/unturf/filevault.git ``` -## Integrate with your tools +### From Source +```bash +git clone https://git.unturf.com/engineering/unturf/filevault.git +cd filevault +pip install . +``` -- [ ] [Set up project integrations](https://git.unturf.com/engineering/unturf/filevault/-/settings/integrations) +## How to Use -## Collaborate with your team +### Creating a Vault -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) +```python +from filevault import Vault -## Test and Deploy +# Default vault (creates a 'vault' directory in current working directory) +v = Vault() -Use the built-in continuous integration in GitLab. +# Custom vault +v = Vault( + vaultpath="/tmp/for-test", # Directory to store files + depth=2, # Depth of directory structure + salt="your-secret-salt" # Change this for production! +) +``` -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) +### Vault Parameters -*** +- **vaultpath**: Where should the tree be created? (default: 'vault' in current directory) +- **depth**: How deep should the tree span? (default: 3 directories deep) +- **salt**: Custom salt for unique and secure hashing (default: 'changeme') -# Editing this README +### Examples -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. +#### Create a hashed filename +```python +# Create a consistent filename +filename = v.create_filename("my-document", ".pdf") +# Example: "3/9/3993817d4f9b3867c6db29b23c9d2ff9bb8a87d89426002adbb6ed34289d9e32.pdf" -## Suggestions for a good README +# Get absolute path +abs_path = v.create_filename("my-document", ".pdf", absolute=True) +# Example: "/tmp/for-test/3/9/39938...e32.pdf" +``` -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. +#### Create a random filename +```python +# Random filename +random_file = v.create_random_filename(".png") +# Example: "6/1/6169d6ee0ac0bc63ab667fb94d9cc747df0c03596ac43e24a51b3517d74bdc42.png" +``` -## Name -Choose a self-explaining name for your project. +## Full Example -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. +```python +from filevault import Vault -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. +# Create vault instance +v = Vault(vaultpath="/tmp/for-test", depth=2, salt="sugar") -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. +# Create and print a filename +print(v.create_filename("my-first-file", ".png")) +# Output: 3/9/3993817d4f9b3867c6db29b23c9d2ff9bb8a87d89426002adbb6ed34289d9e32.png -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. +# Same input produces same output +print(v.create_filename("my-first-file", ".png")) +# Output: 3/9/3993817d4f9b3867c6db29b23c9d2ff9bb8a87d89426002adbb6ed34289d9e32.png -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. +# Get absolute path +print(v.create_filename("my-first-file", ".png", absolute=True)) +# Output: /tmp/for-test/3/9/3993817d4f9b3867c6db29b23c9d2ff9bb8a87d89426002adbb6ed34289d9e32.png -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. +# Generate a random filename +print(v.create_random_filename()) +# Output: 6/1/6169d6ee0ac0bc63ab667fb94d9cc747df0c03596ac43e24a51b3517d74bdc42 +``` -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. +## About the Salt -## Contributing -State if you are open to contributions and what your requirements are for accepting them. +The `salt` parameter is used to add uniqueness and security to the generated file paths: -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. +- Prevents easy guessing of file paths +- Makes directory traversal attacks more difficult +- Ensures different applications generate different paths for the same filenames -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +**Important**: Always change the default salt value in production environments. ## License -For open source projects, say how it is licensed. -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +This project is released into the [Public Domain](https://en.wikipedia.org/wiki/Public_domain). + +## Original Author + +Russell Ballestrini ([russell@ballestrini.net](mailto:russell@ballestrini.net))