| Name | securelock JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | None |
| Summary | A simple library for secure text encryption and decryption using salted password-based encryption. |
| upload_time | 2024-12-16 08:59:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2024 umittadelen 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 |
encryption
decryption
security
password-protection
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# SecureLock
SecureLock is a lightweight Python library for securely encrypting and decrypting text using a password. It utilizes salted key derivation and XOR-based encryption to ensure the integrity and security of your data.
## Features
- Compact design: Only two functions, `lock()` and `unlock()`.
- Salted encryption: Each encryption is unique due to a randomly generated salt.
- Key stretching: Uses SHA-256 hashing to derive a secure encryption key from the password.
- Supports all Unicode characters.
## Installation
```bash
pip install securelock
```
## Usage
### Encrypting Text
```python
from securelock import lock
password = "strongpassword"
text = "This is a secret message!"
# Encrypt the text
locked_text = lock(text, password)
print("Locked Text:", locked_text)
```
### Decrypting Text
```python
from securelock import unlock
# Decrypt the text
unlocked_text = unlock(locked_text, password)
print("Unlocked Text:", unlocked_text)
```
### Example Output
```plaintext
Locked Text: 4a6f1c2b... (encrypted hex string)
Unlocked Text: This is a secret message!
```
## Security Notes
- **Strong Passwords**: Always use strong and unpredictable passwords for maximum security.
- **Key Derivation**: SecureLock uses SHA-256 with a randomly generated 32-byte salt, ensuring each encryption is unique.
- **Brute-Force Resistance**: The implementation is designed to make brute-forcing computationally expensive.
## License
This project is licensed under the MIT License. See [LICENSE](./package/LICENSE.txt) for details.
## Contributing
Feel free to submit issues or feature requests. Contributions are welcome!
Raw data
{
"_id": null,
"home_page": null,
"name": "securelock",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "encryption, decryption, security, password-protection",
"author": null,
"author_email": "Umit Tasdelen <umittadelen1277@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e8/db/39247d47bfd8f1ce02c6f05d8b5aee3c0a8d7262ecc9674bfb6f5b982ae0/securelock-1.0.1.tar.gz",
"platform": null,
"description": "# SecureLock\r\n\r\nSecureLock is a lightweight Python library for securely encrypting and decrypting text using a password. It utilizes salted key derivation and XOR-based encryption to ensure the integrity and security of your data.\r\n\r\n## Features\r\n- Compact design: Only two functions, `lock()` and `unlock()`.\r\n- Salted encryption: Each encryption is unique due to a randomly generated salt.\r\n- Key stretching: Uses SHA-256 hashing to derive a secure encryption key from the password.\r\n- Supports all Unicode characters.\r\n\r\n## Installation\r\n```bash\r\npip install securelock\r\n```\r\n\r\n## Usage\r\n### Encrypting Text\r\n```python\r\nfrom securelock import lock\r\n\r\npassword = \"strongpassword\"\r\ntext = \"This is a secret message!\"\r\n\r\n# Encrypt the text\r\nlocked_text = lock(text, password)\r\nprint(\"Locked Text:\", locked_text)\r\n```\r\n\r\n### Decrypting Text\r\n```python\r\nfrom securelock import unlock\r\n\r\n# Decrypt the text\r\nunlocked_text = unlock(locked_text, password)\r\nprint(\"Unlocked Text:\", unlocked_text)\r\n```\r\n\r\n### Example Output\r\n```plaintext\r\nLocked Text: 4a6f1c2b... (encrypted hex string)\r\nUnlocked Text: This is a secret message!\r\n```\r\n\r\n## Security Notes\r\n- **Strong Passwords**: Always use strong and unpredictable passwords for maximum security.\r\n- **Key Derivation**: SecureLock uses SHA-256 with a randomly generated 32-byte salt, ensuring each encryption is unique.\r\n- **Brute-Force Resistance**: The implementation is designed to make brute-forcing computationally expensive.\r\n\r\n## License\r\nThis project is licensed under the MIT License. See [LICENSE](./package/LICENSE.txt) for details.\r\n\r\n## Contributing\r\nFeel free to submit issues or feature requests. Contributions are welcome!\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 umittadelen 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": "A simple library for secure text encryption and decryption using salted password-based encryption.",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/umittadelen/securelock/issues",
"Documentation": "https://github.com/umittadelen/securelock#readme",
"Homepage": "https://github.com/umittadelen/securelock"
},
"split_keywords": [
"encryption",
" decryption",
" security",
" password-protection"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9b0d74d40ef92e4e43c8521b3b2349fe3180075b2bc03bedadcedd70b30c0cde",
"md5": "dfd146f7dd18042c3478db455903c5d8",
"sha256": "6368f0fb24a7dff9f915bdb20cb23c695e18e5c5ce56e611e7e673f82d2b4087"
},
"downloads": -1,
"filename": "securelock-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dfd146f7dd18042c3478db455903c5d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4164,
"upload_time": "2024-12-16T08:59:53",
"upload_time_iso_8601": "2024-12-16T08:59:53.918834Z",
"url": "https://files.pythonhosted.org/packages/9b/0d/74d40ef92e4e43c8521b3b2349fe3180075b2bc03bedadcedd70b30c0cde/securelock-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e8db39247d47bfd8f1ce02c6f05d8b5aee3c0a8d7262ecc9674bfb6f5b982ae0",
"md5": "303fc659bff89e17b594741311d216f0",
"sha256": "0a2839f1fdc421058e329aa9e50c7d561448f1fb66ec9766131e4a35ba8b3503"
},
"downloads": -1,
"filename": "securelock-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "303fc659bff89e17b594741311d216f0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3339,
"upload_time": "2024-12-16T08:59:54",
"upload_time_iso_8601": "2024-12-16T08:59:54.938540Z",
"url": "https://files.pythonhosted.org/packages/e8/db/39247d47bfd8f1ce02c6f05d8b5aee3c0a8d7262ecc9674bfb6f5b982ae0/securelock-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 08:59:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "umittadelen",
"github_project": "securelock",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "securelock"
}
