| Name | pycryptomator JSON |
| Version |
1.7
JSON |
| download |
| home_page | None |
| Summary | Access a Cryptomator V8 vault with pure Python |
| upload_time | 2024-10-23 15:37:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.0 |
| license | MIT License Copyright (c) 2024 maxpat78 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
cryptomator
python
crypto
encryption
security
privacy
cryptography
vault
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pycryptomator
A Python 3 package to access a Cryptomator V8 vault and carry on some useful operations.
```
usage: pycryptomator [-h] [--init] [--print-keys [{a85,b64,words}]] [--master-keys PRIMARY_KEY HMAC_KEY]
[--password PASSWORD] [--change-password]
vault_name
Access to a Cryptomator V8 vault
positional arguments:
vault_name Location of the existing Cryptomator V8 vault to open
options:
-h, --help show this help message and exit
--init Initialize a new vault in an empty directory
--print-keys [{a85,b64,words}]
Print the raw master keys as a list of English words for Cryptomator (default), in ASCII85
(a85) or BASE64 (b64) format
--master-keys PRIMARY_KEY HMAC_KEY
Primary and HMAC master keys in ASCII85 or BASE64 format, or - - to read a words list from
standard input
--password PASSWORD Password to unlock master keys stored in config file
--change-password Change the password required to open the vault
```
Passing a couple options, you can show you master keys or recover them in case
configuration files are corrupted:
`--print-keys` shows the decrypted primary and hmac master key in ASCII85
or BASE64 form, or as a list of English words like Cryptomator itself, to
annotate them in a safe place for recovering purposes.
`--master-keys` grants access to the vault even in case of lost configuration
files `vault.cryptomator` and/or `masterkey.cryptomator`, provided the master
keys as ASCII85 or BASE64 strings; `- -` can be used to read the words list
from standard input.
After the `vault_name`, you can specify some useful operations like:
```
ls list unecrypted vault contents (with size and time)
mkdir create a new directory/tree in the vault
mv move or rename files and directories
ln create a symbolic link
rm erase files or directories
decrypt decrypt a file or directory from the vault's virtual filesystem into a given destination
encrypt encrypt a file or directory
alias show the real pathname linked to a virtual one
backup backup the Directory IDs (required to decrypt names) in a ZIP file
```
If no operation is specified, an interactive shell is launched on open vault.
Functionality was tested in Windows 11 and Ubuntu 22.04 LTS Linux (under Windows WSL).
It's pure Python 3, with pycryptodome addon.
MIT licensed.
Absolutely no warranty!
Raw data
{
"_id": null,
"home_page": null,
"name": "pycryptomator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.0",
"maintainer_email": null,
"keywords": "cryptomator, python, crypto, encryption, security, privacy, cryptography, vault",
"author": null,
"author_email": "maxpat78 <maxpat78@yahoo.it>",
"download_url": "https://files.pythonhosted.org/packages/ea/d8/dde6caac6683e37cbd2b81225a9e19408d3e80320f28c4c3c51e31ee0057/pycryptomator-1.7.tar.gz",
"platform": null,
"description": "# pycryptomator\n\nA Python 3 package to access a Cryptomator V8 vault and carry on some useful operations.\n\n```\nusage: pycryptomator [-h] [--init] [--print-keys [{a85,b64,words}]] [--master-keys PRIMARY_KEY HMAC_KEY]\n [--password PASSWORD] [--change-password]\n vault_name\n\nAccess to a Cryptomator V8 vault\n\npositional arguments:\n vault_name Location of the existing Cryptomator V8 vault to open\n\noptions:\n -h, --help show this help message and exit\n --init Initialize a new vault in an empty directory\n --print-keys [{a85,b64,words}]\n Print the raw master keys as a list of English words for Cryptomator (default), in ASCII85\n (a85) or BASE64 (b64) format\n --master-keys PRIMARY_KEY HMAC_KEY\n Primary and HMAC master keys in ASCII85 or BASE64 format, or - - to read a words list from\n standard input\n --password PASSWORD Password to unlock master keys stored in config file\n --change-password Change the password required to open the vault\n```\n\nPassing a couple options, you can show you master keys or recover them in case\nconfiguration files are corrupted:\n\n`--print-keys` shows the decrypted primary and hmac master key in ASCII85\nor BASE64 form, or as a list of English words like Cryptomator itself, to\nannotate them in a safe place for recovering purposes.\n\n`--master-keys` grants access to the vault even in case of lost configuration\nfiles `vault.cryptomator` and/or `masterkey.cryptomator`, provided the master\nkeys as ASCII85 or BASE64 strings; `- -` can be used to read the words list\nfrom standard input.\n\n\nAfter the `vault_name`, you can specify some useful operations like:\n\n```\nls list unecrypted vault contents (with size and time)\nmkdir create a new directory/tree in the vault\nmv move or rename files and directories\nln create a symbolic link\nrm erase files or directories\ndecrypt decrypt a file or directory from the vault's virtual filesystem into a given destination\nencrypt encrypt a file or directory\nalias show the real pathname linked to a virtual one\nbackup backup the Directory IDs (required to decrypt names) in a ZIP file\n```\n\nIf no operation is specified, an interactive shell is launched on open vault.\n\nFunctionality was tested in Windows 11 and Ubuntu 22.04 LTS Linux (under Windows WSL).\n\nIt's pure Python 3, with pycryptodome addon.\n\nMIT licensed.\nAbsolutely no warranty!\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 maxpat78 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Access a Cryptomator V8 vault with pure Python",
"version": "1.7",
"project_urls": {
"Homepage": "https://github.com/maxpat78/pycryptomator",
"Source": "https://github.com/maxpat78/pycryptomator"
},
"split_keywords": [
"cryptomator",
" python",
" crypto",
" encryption",
" security",
" privacy",
" cryptography",
" vault"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "991545b03f96d02ecf2ebb26b76315d161aef17329f25905e39c3cd4287647b9",
"md5": "ff623c8ecec45c6933cc99b8314b82b2",
"sha256": "f0d998d820f688a7f1caa0af6e1282d1180ed10d11a7acdf9fa4018e1dca8c42"
},
"downloads": -1,
"filename": "pycryptomator-1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ff623c8ecec45c6933cc99b8314b82b2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.0",
"size": 35899,
"upload_time": "2024-10-23T15:37:18",
"upload_time_iso_8601": "2024-10-23T15:37:18.554226Z",
"url": "https://files.pythonhosted.org/packages/99/15/45b03f96d02ecf2ebb26b76315d161aef17329f25905e39c3cd4287647b9/pycryptomator-1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ead8dde6caac6683e37cbd2b81225a9e19408d3e80320f28c4c3c51e31ee0057",
"md5": "f112b82d3e8833acf32cf2dd21c9507d",
"sha256": "fdf7c3762154dd275cd8b74bf1630f4b8a89a6a49021a6f46c3cf5be89ba8e86"
},
"downloads": -1,
"filename": "pycryptomator-1.7.tar.gz",
"has_sig": false,
"md5_digest": "f112b82d3e8833acf32cf2dd21c9507d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.0",
"size": 36207,
"upload_time": "2024-10-23T15:37:19",
"upload_time_iso_8601": "2024-10-23T15:37:19.751486Z",
"url": "https://files.pythonhosted.org/packages/ea/d8/dde6caac6683e37cbd2b81225a9e19408d3e80320f28c4c3c51e31ee0057/pycryptomator-1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-23 15:37:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maxpat78",
"github_project": "pycryptomator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pycryptomator"
}
