andy-maier / easy-vault Goto Github PK

View Code? Open in Web Editor NEW

1.0 1.0 0.0 171 KB

Secure vault files that are easy to use

License: Apache License 2.0

Makefile 17.74% Python 82.26%

easy-vault's People

Contributors

Stargazers

Watchers

easy-vault's Issues

Support in easy-vault command to disable use of keyring

Testcases for verbose output of password functions

The set_password() and get_password() functions have a verbose and echo parameter for controlling whether verbose messages are printed and which function is used to print them.

Fix issue that easy-vault command not packaged in 0.6.0

Docs: Add info how to set up and deal with keyring

Expand the existing keyring section somewhat. Karl says Ubuntu works out of the box. Explain how to disable the use of keyring

Testcases for password prompting

The get_password() function has the ability to prompt for password, but there are no testcases for it yet.

More consistent verbosity of easy-vault command

Rename KeyRingLib to Keyring

KeyRingLib is not used by the other projects so the name can be cleaned up.

Use random salt for key generation

This improves security, but requires a redesign. We now need to store the key in the keyring, and the key generation cannot be invoked multiple times as it is done now, but needs to be under control of the user.

Complete the testcases for easy_vault

Without CLI.

easy-vault command for removing keyring entry

The encrypt and decrypt commands automatically keep the password stored for a vault file in the keyring service up to date, and can also override it if needed.

What is not supported yet, is to remove the keyring item for a vault file, utilizing the KeyRingLib function provided in issue #35 .

A functionality to update the password in the keyring item separately is not needed, because that is done automatically when encrypting or decrypting the fault file.

easy-vault command for checking availability

There should be an easy-vault command that checks for the availability of the keyring service, utilizing the function provided by issue #34

0.7.0: pytest is failing

I'm trying to package your module as an rpm package. So I'm using the typical build, install and test cycle used on building packages from non-root account.

"setup.py build"
"setup.py install --root </install/prefix>"
"pytest with PYTHONPATH pointing to sitearch and sitelib inside </install/prefix>

Looks like pytest is failing on collecting units

+ PYTHONPATH=/home/tkloczko/rpmbuild/BUILDROOT/python-easy-vault-0.7.0-2.fc35.x86_64/usr/lib64/python3.8/site-packages:/home/tkloczko/rpmbuild/BUILDROOT/python-easy-vault-0.7.0-2.fc35.x86_64/usr/lib/python3.8/site-packages
+ /usr/bin/pytest -ra
=========================================================================== test session starts ============================================================================
platform linux -- Python 3.8.12, pytest-6.2.5, py-1.11.0, pluggy-1.0.0
benchmark: 3.4.1 (defaults: timer=time.perf_counter disable_gc=False min_rounds=5 min_time=0.000005 max_time=1.0 calibration_precision=10 warmup=False warmup_iterations=100000)
Using --randomly-seed=3901611956
rootdir: /home/tkloczko/rpmbuild/BUILD/easy-vault-0.7.0
plugins: shutil-1.7.0, virtualenv-1.7.0, mock-3.6.1, cov-2.12.1, anyio-3.3.4, forked-1.3.0, xdist-2.3.0, flaky-3.7.0, tornasync-0.6.0.post2, console-scripts-1.2.0, trio-0.7.0, timeout-2.0.1, asyncio-0.16.0, freezegun-0.4.2, flake8-1.0.7, pyfakefs-4.5.3, hypothesis-6.29.3, benchmark-3.4.1, profiling-1.7.0, datadir-1.3.1, regressions-2.2.0, randomly-3.8.0, rerunfailures-9.1.1, yagot-0.5.0, requests-mock-1.9.3, django-4.5.1
collected 79 items / 2 errors / 77 selected

================================================================================== ERRORS ==================================================================================
_____________________________________________________________ ERROR collecting tests/unittest/test_keyring.py ______________________________________________________________
tests/unittest/test_keyring.py:34: in <module>
    not is_keyring_available(), reason="No keyring service available")
tests/utils/keyring_utils.py:43: in is_keyring_available
    return kr.is_available()
easy_vault/_keyring.py:203: in is_available
    self.check_available()
easy_vault/_keyring.py:256: in check_available
    raise new_exc  # KeyringError
E   easy_vault._keyring.KeyringError: Failed to create the collection: Prompt dismissed..
_____________________________________________________________ ERROR collecting tests/unittest/test_password.py _____________________________________________________________
tests/unittest/test_password.py:28: in <module>
    not is_keyring_available(), reason="No keyring service available")
tests/utils/keyring_utils.py:43: in is_keyring_available
    return kr.is_available()
easy_vault/_keyring.py:203: in is_available
    self.check_available()
easy_vault/_keyring.py:256: in check_available
    raise new_exc  # KeyringError
E   easy_vault._keyring.KeyringError: Failed to create the collection: Prompt dismissed..
========================================================================= short test summary info ==========================================================================
ERROR tests/unittest/test_keyring.py - easy_vault._keyring.KeyringError: Failed to create the collection: Prompt dismissed..
ERROR tests/unittest/test_password.py - easy_vault._keyring.KeyringError: Failed to create the collection: Prompt dismissed..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Interrupted: 2 errors during collection !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
============================================================================ 2 errors in 0.79s =============================================================================

Testcases for the easy-vault CLI commands

Testcases for errors from user-plugged encryption package

The encryption implementation methods that can be replaced by a user are checked for correct results, and the testcases should implement user-defined methods for them and trigger these checks.

More control on password handling

The EasyVault class currently requires that a password is specified. However, it is perfectly valid to operate on unencrypted vault files without having a password.

The get_password() function currently always prompts for a password if the keyring service did not find the password. For use in headless systems, there should be a way to disable the prompting. (Note: The use of the keyring service can already be disabled.)

andy-maier / easy-vault Goto Github PK

easy-vault's People

Contributors

Stargazers

Watchers

easy-vault's Issues

Recommend Projects

Recommend Topics

Recommend Org