Skip to content

Commit 5168ed0

Browse files
ProgrammerKRProgrammerKR
authored
Add files via upload
0 parents  commit 5168ed0

File tree

9 files changed

+522
-0
lines changed

9 files changed

+522
-0
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎Contributing.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributing to Hashium
2+
3+
Thank you for your interest in contributing to Hashium! We welcome all kinds of contributions — bug reports, feature requests, documentation improvements, and code contributions.
4+
5+
## Getting Started
6+
7+
1. **Fork the Repository**: Click the "Fork" button on the top right of the GitHub page.
8+
2. **Clone Your Fork**: Use the following command to clone your fork:
9+
```bash
10+
git clone https://github.com/your-username/Hashium.git
11+
cd Hashium
12+
```
13+
3. **Set Up a Virtual Environment** (optional but recommended):
14+
```bash
15+
python -m venv venv
16+
source venv/bin/activate # On Windows use: venv\Scripts\activate
17+
pip install -r requirements.txt
18+
```
19+
20+
## Making Changes
21+
22+
- Follow the [PEP8](https://peps.python.org/pep-0008/) style guide for Python code.
23+
- Write clear, concise commit messages.
24+
- Add or update tests for your code if applicable.
25+
- Test your changes locally before pushing.
26+
27+
## Submitting a Pull Request
28+
29+
1. Create a new branch for your changes:
30+
```bash
31+
git checkout -b your-branch-name
32+
```
33+
2. Make your changes and commit them.
34+
3. Push the branch to your fork:
35+
```bash
36+
git push origin your-branch-name
37+
```
38+
4. Open a pull request against the `main` branch of [Hashium](https://github.com/ProgrammerKR/Hashium).
39+
40+
## Code of Conduct
41+
42+
Be respectful, inclusive, and considerate in all interactions.
43+
44+
## Need Help?
45+
46+
If you have questions, feel free to open an issue or reach out via discussions.

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Prog. Kanishk Raj (ProgrammerKR)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
# Hashium
2+
3+
**Hashium** is a powerful and highly secure Python hashing and encryption library. It combines traditional and modern cryptographic algorithms including SHA, HMAC, PBKDF2, Argon2, AES, RSA, and a custom ultra-secure hybrid algorithm developed specifically for enhanced protection.
4+
5+
---
6+
7+
## Features
8+
9+
- **Basic & Salted SHA-256 Hashing**
10+
- **PBKDF2 with HMAC-SHA256**
11+
- **Argon2 Hashing and Verification**
12+
- **HMAC using SHA-256**
13+
- **AES-256 Encryption and Decryption (EAX Mode)**
14+
- **RSA Key Generation, Signing, and Verification**
15+
- **File Hashing with SHA-256**
16+
- **Ultra-Secure 768+ Bit Custom Hash Algorithm**
17+
- Clean and readable code
18+
- Python 3.8+ compatible
19+
20+
---
21+
22+
## Installation
23+
24+
```bash
25+
pip install hashium
26+
```
27+
28+
Or clone the repository manually:
29+
30+
```bash
31+
git clone https://github.com/DeveloperKR123/Hashium.git
32+
cd Hashium
33+
pip install -r requirements.txt
34+
```
35+
36+
---
37+
38+
## Requirements
39+
40+
- Python 3.8+
41+
- [argon2-cffi](https://pypi.org/project/argon2-cffi/)
42+
- [pycryptodome](https://pypi.org/project/pycryptodome/)
43+
44+
Install dependencies:
45+
46+
```bash
47+
pip install argon2-cffi pycryptodome
48+
```
49+
50+
---
51+
52+
## Basic Usage
53+
54+
```python
55+
from hashium import Hashium
56+
57+
hashium = Hashium()
58+
59+
# Basic SHA-256 Hash
60+
print(hashium.hashium_basic("mypassword"))
61+
62+
# Salted Hash
63+
print(hashium.hashium_salted("mypassword"))
64+
65+
# PBKDF2 Hash and Verification
66+
hashed = hashium.hashium_pbkdf2("mypassword")
67+
print(hashium.verify_pbkdf2("mypassword", hashed))
68+
69+
# Argon2 Hash and Verify
70+
argon_hash = hashium.hashium_argon2("mypassword")
71+
print(hashium.verify_argon2("mypassword", argon_hash))
72+
73+
# AES Encryption / Decryption
74+
encrypted = hashium.encrypt_data("mypassword")
75+
print(hashium.decrypt_data(encrypted))
76+
77+
# RSA Key Pair
78+
private_key, public_key = hashium.generate_rsa_keys()
79+
signature = hashium.sign_data("secure message", private_key)
80+
print(hashium.verify_signature("secure message", signature, public_key))
81+
82+
# Ultra Secure Hash
83+
print(hashium.hashium_ultra_secure("mypassword"))
84+
```
85+
86+
---
87+
88+
## Modules and Functionalities
89+
90+
### 1. SHA-256 Hashing
91+
92+
- `hashium_basic(data)`
93+
- `hashium_salted(data)`
94+
95+
### 2. PBKDF2-HMAC-SHA256
96+
97+
- `hashium_pbkdf2(password)`
98+
- `verify_pbkdf2(password, stored_hash)`
99+
100+
### 3. HMAC-SHA256
101+
102+
- `hashium_hmac(key, data)`
103+
104+
### 4. Argon2
105+
106+
- `hashium_argon2(password)`
107+
- `verify_argon2(password, stored_hash)`
108+
109+
### 5. AES Encryption (EAX Mode)
110+
111+
- `encrypt_data(data)`
112+
- `decrypt_data(encrypted_data)`
113+
114+
### 6. File Hashing
115+
116+
- `hash_file(file_path)`
117+
118+
### 7. RSA & Digital Signature
119+
120+
- `generate_rsa_keys()`
121+
- `sign_data(data, private_key)`
122+
- `verify_signature(data, signature, public_key)`
123+
124+
### 8. Ultra Secure Hash
125+
126+
- `hashium_ultra_secure(data, pepper='Hashium2025Ultra')`
127+
128+
---
129+
130+
## Example Script
131+
132+
See `example.py` in the repository to test all functionalities.
133+
134+
---
135+
136+
## Contributing
137+
138+
We welcome contributions! Please read [CONTRIBUTING.md](CONTRIBUTING.md) before submitting a pull request.
139+
140+
---
141+
142+
## License
143+
144+
This project is licensed under the **MIT License** – see the [LICENSE](LICENSE) file for details.
145+
146+
---
147+
148+
## Author
149+
150+
**Prog. Kanishk Raj (ProgrammerKR)**
151+
[GitHub](https://github.com/DeveloperKR123) | Creator of [Hashium](https://github.com/DeveloperKR123/Hashium), [Hashium](https://github.com/ProgrammerKR/Hashium)
152+
153+
---
154+
155+
## Disclaimer
156+
157+
Hashium is intended for educational and research purposes. For mission-critical systems, it's advised to follow vetted industry cryptographic standards and seek professional security audits.

‎SECURITY.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Use this section to tell people about which versions of your project are
6+
currently being supported with security updates.
7+
8+
| Version | Supported |
9+
| ------- | ------------------ |
10+
| 5.1.x | :white_check_mark: |
11+
| 5.0.x | :x: |
12+
| 4.0.x | :white_check_mark: |
13+
| < 4.0 | :x: |
14+
15+
## Reporting a Vulnerability
16+
17+
Use this section to tell people how to report a vulnerability.
18+
19+
Tell them where to go, how often they can expect to get an update on a
20+
reported vulnerability, what to expect if the vulnerability is accepted or
21+
declined, etc.

0 commit comments

Comments
 (0)