Skip to main content

An encrypted filesystem for python using PYFilesystem2

Project description

FS-Encrypted

Introduction

The EncryptedFS is a file system implementation that provides encryption and decryption functionalities for files. It is built using PyFilesystem and AES encryption. This allows minimal modification for existing applications to use Example:

from fs_encrypted.encrypted_fs import EncryptedFS
import base64

#Generate and Store your keys securely !!!
key = base64.urlsafe_b64encode(b"Hello I'm a 32bit encoded string") 

# Create a directory called secure_data 
file_system = EncryptedFS("./secure_data", key)

# create a file called my_secrets.txt and encrypt as it's written to
with file_system.open("my_secrets.txt", "w") as file : 
   file.write(b"Top Secret Data!!")

# read and decrypt my_secrets
with file_system.open("my_secrets.txt", "r") as file : 
   file.read()

Installation

Use pip or poetry to install

pip install fs-encrypted

or

poetry add fs-encrypted

Usages

Applications that may require sensitive data storage should use an encrypted file system. By providing a layer of abstraction on top of the encryption our hope is to make it easier to store this data.

  • PII / PHI
    • Print Billing systems
    • Insurance services / Identity cards
  • Data Transfer
  • Secure distributed configuration

Fernet is used as the encryption method (v0.1), this may become a configurable option in future revisions

Development

Clone the fs-encrypted repository https://github.com/thevgergroup/fs-encrypted

Development is done using poetry

Tests are run as

poetry run python -m unittest tests/*.py

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fs_encrypted-1.0.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

fs_encrypted-1.0-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file fs_encrypted-1.0.tar.gz.

File metadata

  • Download URL: fs_encrypted-1.0.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for fs_encrypted-1.0.tar.gz
Algorithm Hash digest
SHA256 189174d0d19d6d7123da04ccb074472496849443ab2a0ebe9db43f533c6aa404
MD5 e26ac6b59b8da1a5f1ac9048723932ed
BLAKE2b-256 5b128bbc67f3b6b590c6e98293791d6d8bac42f54741cb53d7e9716da3606313

See more details on using hashes here.

File details

Details for the file fs_encrypted-1.0-py3-none-any.whl.

File metadata

  • Download URL: fs_encrypted-1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for fs_encrypted-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0dba6e74b910150d83895ce76b4ecd25956451d48709fadf3923a61ddeca4389
MD5 055ab9dc8fa4736e0a69bda2d491992a
BLAKE2b-256 cc9db3e9921e1086c21bbac420ec00f057d42f96e643efe21c3b8a8a931f0ab2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page