https://github.com/joshiemoore/vocafs
Using the Vocaroo voice recording service as a free cloud file system
https://github.com/joshiemoore/vocafs
filesystem libfuse linux pyfuse vocaroo
Last synced: 9 months ago
JSON representation
Using the Vocaroo voice recording service as a free cloud file system
- Host: GitHub
- URL: https://github.com/joshiemoore/vocafs
- Owner: joshiemoore
- License: gpl-3.0
- Created: 2023-03-06T07:06:23.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T07:41:51.000Z (almost 3 years ago)
- Last Synced: 2025-02-16T13:54:21.227Z (11 months ago)
- Topics: filesystem, libfuse, linux, pyfuse, vocaroo
- Language: Python
- Homepage: https://vocaroo.com
- Size: 20.5 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# vocaFS
This project implements a virtual filesystem based on libfuse which streams files to Vocaroo as "audio" instead of saving
them to a block device. As a result, we can use Vocaroo as our own free cloud storage!
vocaFS is an experimental work-in-progress prototype and should not be used for anything that actually matters. Also,
this is mostly intended as an academic exercise, not for actually abusing Vocaroo in this way.
vocaFS is Free Software, licensed under the terms of GNU GPLv3.
### Usage
vocaFS will only work on a GNU/Linux operating system with FUSE available.
1. Clone this repository
2. Install requirements: `$ python3 -m pip install requirements.txt`
3. Create an empty directory to mount vocaFS to, e.g. `$ mkdir voca`
4. Run vocaFS to mount the virtual filesystem: `$ ./vocafs.py voca`
Now, when you write files into the `voca` directory, they will be streamed to Vocaroo. When you go back and read these
files later, they will be streamed from Vocaroo. Vocaroo is cloud storage!
When you are done, unmount vocaFS: `$ fusermount -u voca`
### How does it work?
This project uses pyfuse, the Python bindings for libfuse, to implement the meat of the virtual filesystem operations.
Metadata about inodes in the filesystem will be saved to `inodes.json` in the source directory. This file mostly contains
information about directory structures and where vocaFS can find your files on Vocaroo. These files are interchangeable,
so if you send your `inodes.json` to someone else and they save it into their `vocaFS` directory, they will be able to
mount the filesystem and access all the files you have saved.
In order to get the streams to Vocaroo to work, all I had to do was append a 4-byte mp3 segment header to the beginning
of the file, and this was all it took to make Vocaroo believe we are uploading legitimate mp3 audio. But the playback
doesn't work if you try to play your uploaded file on the actual website :)
### Limitations
vocaFS is incomplete, and there are likely many features missing that you would expect from a normal filesystem. For example,
vocaFS does not currently support links, either hard or symbolic. Overall, you should expect instability and bugs to the
point where you should not actually try to use this as your real cloud storage solution.
### Why Python?
Rapid prototyping