Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arunanshub/pyflocker
Python Cryptographic (File Locking) Library
https://github.com/arunanshub/pyflocker
cryptographic-library cryptography encryption file-encryption python3
Last synced: about 2 months ago
JSON representation
Python Cryptographic (File Locking) Library
- Host: GitHub
- URL: https://github.com/arunanshub/pyflocker
- Owner: arunanshub
- License: mit
- Created: 2020-04-23T09:38:21.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T21:26:51.000Z (2 months ago)
- Last Synced: 2024-11-01T16:51:39.690Z (2 months ago)
- Topics: cryptographic-library, cryptography, encryption, file-encryption, python3
- Language: Python
- Homepage: https://pyflocker.readthedocs.io
- Size: 1.95 MB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# PyFLocker
[](https://github.com/arunanshub/pyflocker/actions/workflows/ci.yml)
[](https://coveralls.io/github/arunanshub/pyflocker?branch=master)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
[](https://pypi.org/project/PyFLocker)
[](https://pyflocker.readthedocs.io/en/latest/?badge=latest)
Python Cryptographic (File Locking) Library
> Lock as in Lock and Key.
## Installation
Use `pip` or `pip3` to install PyFLocker
pip install pyflocker
or
pip3 install pyflocker
## Introduction
PyFLocker aims to be a highly stable and easy to use cryptographic library.
Before you read on, check if you agree to at least one of these points:
- [`PyCryptodome(x)`][pycrypto] and [`pyca/cryptography`][pyca] have
**very different** public interfaces, which makes remembering all the imports
very difficult, and leaves you reading docs under deadline.
- The interface of `pyca/cryptography` is very difficult to use, let alone
remember the import:
```python
from cryptography.hazmat.primitives.ciphers.algorithms import AES
from cryptography.hazmat.primitives.ciphers import Modes
...
from cryptography.hazmat.backends import default_backend
# and so on...
```
- You wish that only if `pyca/cryptography` had been as easy to use as
`Pycryptodome(x)`, it would have made life more easy.
- You sometimes think that the file encryption script you wrote were somehow
faster and played with both backends very well, but you weren't sure what to do.
- And all the other solutions (and nonsolutions!) on the internet just confuses
you more!
PyFLocker uses well established libraries as its backends and expands upon them.
This gives you the ultimate ability to cherry-pick the primitives from a specific
backend without having to worry about backend itself, as PyFLocker handles it
for you.
You can find more information in the [documentation][docs].
## Features
### Not a "Yet Another Cryptographic Library"
PyFLocker provides you a seamless interface to both the backends, and switching
is very easy:
```python
import os
from pyflocker.ciphers import AES, RSA, ECC
from pyflocker.ciphers.backends import Backends
key, nonce = os.urandom(32), os.urandom(16)
# Multiple backends - same API
enc = AES.new(True, key, AES.MODE_EAX, nonce, backend=Backends.CRYPTOGRAPHY)
rpriv = RSA.generate(2048, backend=Backends.CRYPTODOME)
epriv = ECC.generate("x25519", backend=Backends.CRYPTOGRAPHY)
```
Backend loading is done internally, and if a backend is explicitly specified,
that is used as the default.
### Ease of Use
PyFLocker provides reasonable defaults wherever possible:
```python
from pyflocker.ciphers import RSA
priv = RSA.generate(2048)
with open("private_key.pem", "xb") as f:
key = priv.serialize(passphrase=b"random-chimp-event")
f.write(key)
```
Don't believe me, try to do the [same operation with `pyca/cryptography`][pyca_vs_self],
or just any other initialization.
In short, the API is very stable, clear and easy on developer's mind.
### Writing into file or file-like objects
This is often a related problem when it comes to encryption, but think no more!
```python
import os
from pyflocker.ciphers import AES
from pyflocker.ciphers.backends import Backends
key, nonce = os.urandom(32), os.urandom(16)
f1 = open("MySecretData.txt", "rb")
f2 = open("MySecretData.txt.enc", "xb")
enc = AES.new(
True,
key,
AES.MODE_EAX,
nonce,
backend=Backends.CRYPTOGRAPHY,
file=f1,
)
enc.update_into(f2)
tag = enc.calculate_tag()
```
You can also use `BytesIO` in place of file objects.
### Directly encrypting files
Just want to encrypt your file with AES, and even with various available modes?
```python
from pyflocker.locker import locker
from pyflocker.ciphers import AES
password = b"no not this"
locker(
"./MySuperSecretFile.txt",
password,
aes_mode=AES.MODE_CTR, # default is AES-GCM-256
)
# file stored as MySuperSecretFile.txt.pyflk
```
Find more examples [here][examples].
## License
[MIT](https://choosealicense.com/licenses/mit/)
[docs]: https://pyflocker.readthedocs.io/en/latest/
[examples]: https://pyflocker.readthedocs.io/en/latest/examples
[pycrypto]: https://github.com/Legrandin/pycryptodome
[pyca]: https://github.com/pyca/cryptography
[pyca_vs_self]: https://cryptography.io/en/latest/hazmat/primitives/asymmetric/rsa.html#key-serialization