Metadata-Version: 2.1
Name: securecredentials
Version: 2.1.0
Summary: SecureCredentials is a lightweight Python package that encrypts and securely stores key-value pairs on disk, enabling easy and secure retrieval.
Project-URL: Homepage, https://github.com/rohitlal125555/securecredentials
Project-URL: Issues, https://github.com/rohitlal125555/securecredentials/issues
Author-email: Rohit Lal <rohitlal.125555@gmail.com>
License-File: LICENSE
Keywords: authentication,credential encryption,credential manager,cryptography,data security,encrypted credentials,encrypted store,encryption,key-value store,local encryption,password encryption,password store,python security,secure environment,secure key store,secure password management,secure storage,securecredentials,security
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Security
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.7
Requires-Dist: cryptography
Description-Content-Type: text/markdown

# SecureCredentials

SecureCredentials is a lightweight Python package designed to securely store key-value pairs, such as passwords 
or other sensitive information, on disk. By leveraging modern AES-GCM 256-bit encryption and a dual encryption scheme, 
the package ensures that your sensitive data and encryption keys remain safe, while still providing convenient access 
for everyday use.

## Why SecureCredentials Was Created
This package was created to address two common challenges faced by developers:

1. **Avoid storing sensitive credentials in plaintext:** It is unsafe for developers to store credentials such as 
database passwords, Active Directory passwords, and API keys in plaintext within their scripts or configuration files.
2. **Eliminate the need to repeatedly enter passwords:** Developers often have to enter their credentials every 
time they run a script, which can be cumbersome and error-prone. SecureCredentials allows for automatic retrieval 
of encrypted credentials, eliminating the need to type them each time.

## Key Features

- **Dual Encryption Scheme**: Your actual credentials are encrypted with a strong master key, and that master key is 
itself encrypted using a deterministic AES-GCM 256-bit key derived from your local system environment—ensuring 
multi-layered protection.
- **AES-256 Encryption (GCM mode)**: Uses modern AES-GCM encryption with a 256-bit key for both speed and strong 
cryptographic security.
- **Local Security**: All keys and encrypted data are stored locally, ensuring that no sensitive data leaves your system.
- **Convenience**: Automates secure access to stored credentials, removing the need to retype passwords or store 
them in plaintext.
- **Cross-Platform**: Works seamlessly across different operating systems, including Windows, Linux and macOS.

## Installation

To install SecureCredentials, run:

```bash
pip install securecredentials
```

## Dependencies

SecureCredentials requires the following Python libraries:

- **cryptography:** For encryption and decryption.


## Release Notes

For detailed version history, see the [CHANGELOG.md](https://github.com/rohitlal125555/securecredentials/blob/main/CHANGELOG.md) file.


## License

SecureCredentials is licensed under the Apache License Version 2.0. See the 
[LICENSE](https://github.com/rohitlal125555/securecredentials/blob/main/LICENSE) file for details.


## Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request for improvements or feature requests.


## Support

If you encounter issues or have questions, please open an issue in the 
[GitHub repository](https://github.com/rohitlal125555/securecredentials/issues).


### Full Documentation:  
Full documentation and usage examples are available in the
[GitHub repository](https://github.com/rohitlal125555/securecredentials)
