ciph 0.0.0__tar.gz → 0.1.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ciph-0.1.1/LICENSE +201 -0
- ciph-0.1.1/MANIFEST.in +6 -0
- ciph-0.1.1/Makefile +11 -0
- ciph-0.1.1/PKG-INFO +244 -0
- ciph-0.1.1/README.md +217 -0
- ciph-0.1.1/ciph/__init__.py +1 -0
- ciph-0.1.1/ciph/cli.py +119 -0
- ciph-0.1.1/ciph.c +241 -0
- ciph-0.1.1/ciph.egg-info/PKG-INFO +244 -0
- ciph-0.1.1/ciph.egg-info/SOURCES.txt +16 -0
- ciph-0.1.1/ciph.egg-info/entry_points.txt +2 -0
- ciph-0.1.1/ciph.egg-info/requires.txt +1 -0
- ciph-0.1.1/ciph.h +36 -0
- ciph-0.1.1/pyproject.toml +45 -0
- ciph-0.1.1/setup.py +17 -0
- ciph-0.0.0/PKG-INFO +0 -15
- ciph-0.0.0/ciph/__init__.py +0 -1
- ciph-0.0.0/ciph.egg-info/PKG-INFO +0 -15
- ciph-0.0.0/ciph.egg-info/SOURCES.txt +0 -6
- ciph-0.0.0/pyproject.toml +0 -27
- {ciph-0.0.0 → ciph-0.1.1}/ciph.egg-info/dependency_links.txt +0 -0
- {ciph-0.0.0 → ciph-0.1.1}/ciph.egg-info/top_level.txt +0 -0
- {ciph-0.0.0 → ciph-0.1.1}/setup.cfg +0 -0
ciph-0.1.1/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Ankit Chaubey
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
ciph-0.1.1/MANIFEST.in
ADDED
ciph-0.1.1/Makefile
ADDED
ciph-0.1.1/PKG-INFO
ADDED
|
@@ -0,0 +1,244 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ciph
|
|
3
|
+
Version: 0.1.1
|
|
4
|
+
Summary: Fast, streaming file encryption for large media files and cloud uploads
|
|
5
|
+
Author-email: Ankit Chaubey <m.ankitchaubey@gmail.com>
|
|
6
|
+
License: Apache License 2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/ankit-chaubey/ciph
|
|
8
|
+
Project-URL: Source, https://github.com/ankit-chaubey/ciph
|
|
9
|
+
Project-URL: Issues, https://github.com/ankit-chaubey/ciph/issues
|
|
10
|
+
Keywords: encryption,cryptography,security,aes,chacha20,argon2,streaming,files,privacy
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Topic :: Security :: Cryptography
|
|
14
|
+
Classifier: Topic :: System :: Archiving :: Backup
|
|
15
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
16
|
+
Classifier: Programming Language :: C
|
|
17
|
+
Classifier: Programming Language :: Python :: 3
|
|
18
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
19
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
20
|
+
Classifier: Operating System :: Unix
|
|
21
|
+
Requires-Python: >=3.8
|
|
22
|
+
Description-Content-Type: text/markdown
|
|
23
|
+
License-File: LICENSE
|
|
24
|
+
Requires-Dist: tqdm>=4.60.0
|
|
25
|
+
Dynamic: license-file
|
|
26
|
+
Dynamic: requires-python
|
|
27
|
+
|
|
28
|
+
# ciph
|
|
29
|
+
|
|
30
|
+
[](https://pypi.org/project/ciph/)
|
|
31
|
+
[](https://pypi.org/project/ciph/)
|
|
32
|
+
[](https://pypi.org/project/ciph/)
|
|
33
|
+
[](https://github.com/ankit-chaubey/ciph/actions/workflows/ciph-test.yml)
|
|
34
|
+
[](https://github.com/ankit-chaubey/ciph/blob/main/LICENSE)
|
|
35
|
+
[](https://github.com/ankit-chaubey/ciph/releases)
|
|
36
|
+
[](#)
|
|
37
|
+
[](#)
|
|
38
|
+
|
|
39
|
+
**ciph** is a fast, streaming file‑encryption tool built for **large media files** and **cloud uploads**. It uses modern, industry‑standard cryptography and is designed to safely encrypt files **larger than your system RAM**.
|
|
40
|
+
|
|
41
|
+
> Encrypt locally. Upload anywhere. Decrypt only when you trust the environment.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## ❓ Why ciph?
|
|
46
|
+
|
|
47
|
+
Most encryption tools load the entire file into memory before encrypting it. **ciph streams data in fixed-size chunks**, which means you can encrypt a **50 GB 4K video on a machine with only 2 GB of RAM**—smoothly and safely.
|
|
48
|
+
|
|
49
|
+
## ✨ Features
|
|
50
|
+
|
|
51
|
+
* 🔐 **Strong encryption** — AES‑256‑GCM or ChaCha20‑Poly1305
|
|
52
|
+
* 🔑 **Password protection** — Argon2id (memory‑hard key derivation)
|
|
53
|
+
* 🚀 **High performance** — streaming C core (1 MB chunks)
|
|
54
|
+
* 🧠 **Constant memory usage** — works with 10 GB+ files
|
|
55
|
+
* ⚙️ **Hardware‑aware** — AES‑NI when available, ChaCha fallback
|
|
56
|
+
* 🧪 **Integrity protected** — AEAD authentication on every chunk
|
|
57
|
+
* ☁️ **Cloud / Telegram safe** — encrypt before upload
|
|
58
|
+
* 🏷️ **Filename preserved** — original filename & extension are stored and restored on decryption
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## 🔐 Cryptographic Design
|
|
63
|
+
|
|
64
|
+
`ciph` uses a **hybrid (envelope) encryption model**, similar to what is used in modern secure storage systems:
|
|
65
|
+
|
|
66
|
+
1. A random **data key** encrypts the file in streaming mode.
|
|
67
|
+
2. Your password is hardened using **Argon2id**.
|
|
68
|
+
3. The data key is encrypted using the derived password key.
|
|
69
|
+
4. Every chunk is authenticated to detect tampering.
|
|
70
|
+
|
|
71
|
+
No custom crypto. No weak primitives.
|
|
72
|
+
|
|
73
|
+
5. The **original filename (without path)** is stored as encrypted metadata and automatically restored on decryption.
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## 🔒 Security Strength
|
|
78
|
+
|
|
79
|
+
| Component | Algorithm | Strength |
|
|
80
|
+
| -------------------------- | ---------------------------------------- | ------------ |
|
|
81
|
+
| File encryption | AES‑256‑GCM | 256‑bit |
|
|
82
|
+
| File encryption (fallback) | ChaCha20‑Poly1305 | 256‑bit |
|
|
83
|
+
| Password KDF | Argon2id | Memory‑hard |
|
|
84
|
+
| Integrity | AEAD | Tamper‑proof |
|
|
85
|
+
| Nonces | Key-derived per chunk (unique, no reuse) | No reuse |
|
|
86
|
+
|
|
87
|
+
### What this means
|
|
88
|
+
|
|
89
|
+
* Brute‑force attacks are **computationally infeasible**
|
|
90
|
+
* File corruption or tampering is **always detected**
|
|
91
|
+
* Encrypted files are safe on **any cloud platform**
|
|
92
|
+
* Losing the password means **data is unrecoverable**
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
## 🚀 Quick Start (Build from Source)
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
git clone https://github.com/ankit-chaubey/ciph
|
|
100
|
+
cd ciph
|
|
101
|
+
make
|
|
102
|
+
pip install .
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## 📦 Installation
|
|
106
|
+
|
|
107
|
+
### Requirements
|
|
108
|
+
|
|
109
|
+
* Linux / Termux
|
|
110
|
+
* Python ≥ 3.8
|
|
111
|
+
* libsodium
|
|
112
|
+
|
|
113
|
+
### Install from PyPI
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
pip install ciph
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## 🚀 Usage
|
|
122
|
+
|
|
123
|
+
### Encrypt a file
|
|
124
|
+
|
|
125
|
+
```bash
|
|
126
|
+
ciph encrypt video.mp4
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Output:
|
|
130
|
+
|
|
131
|
+
```
|
|
132
|
+
video.mp4.ciph
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Decrypt a file
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
ciph decrypt video.mp4.ciph
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Output:
|
|
142
|
+
|
|
143
|
+
```
|
|
144
|
+
video.mp4
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
> The original filename and extension are automatically restored, even if the encrypted file was renamed.
|
|
148
|
+
|
|
149
|
+
### Example workflow (Cloud / Telegram)
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
ciph encrypt movie.mkv
|
|
153
|
+
# upload movie.mkv.ciph anywhere
|
|
154
|
+
# share the password securely
|
|
155
|
+
|
|
156
|
+
ciph decrypt movie.mkv.ciph
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
---
|
|
160
|
+
|
|
161
|
+
## 📝 File Format
|
|
162
|
+
|
|
163
|
+
| Offset | Size | Description |
|
|
164
|
+
| ------ | ---- | -------------------------------------- |
|
|
165
|
+
| 0 | 4 | Magic bytes (`CIPH`) |
|
|
166
|
+
| 4 | 1 | Format version |
|
|
167
|
+
| 5 | 1 | Cipher mode (1 = AES, 2 = ChaCha) |
|
|
168
|
+
| 6 | 16 | Argon2 salt |
|
|
169
|
+
| 22 | 12 | Key nonce |
|
|
170
|
+
| 34 | 1 | Filename length (N) |
|
|
171
|
+
| 35 | N | Original filename (UTF‑8) |
|
|
172
|
+
| 35+N | 2 | Encrypted data‑key length |
|
|
173
|
+
| … | … | Encrypted data key + encrypted payload |
|
|
174
|
+
|
|
175
|
+
## 📊 Performance
|
|
176
|
+
|
|
177
|
+
* Processes data in **1 MB chunks**
|
|
178
|
+
* Cryptography handled in **C (libsodium)**
|
|
179
|
+
* Python used only for CLI orchestration
|
|
180
|
+
* Typical throughput: **hundreds of MB/s** (CPU‑bound)
|
|
181
|
+
|
|
182
|
+
Encryption is usually faster than your internet upload speed.
|
|
183
|
+
|
|
184
|
+
---
|
|
185
|
+
|
|
186
|
+
## ⚠️ Limitations (v0.1.0)
|
|
187
|
+
|
|
188
|
+
* Linux / Termux only
|
|
189
|
+
* No resume support yet
|
|
190
|
+
* Progress bar shows start → finish (stream handled in C)
|
|
191
|
+
* Password‑based encryption only (public‑key mode planned)
|
|
192
|
+
* Filename metadata is visible (content remains fully encrypted)
|
|
193
|
+
|
|
194
|
+
---
|
|
195
|
+
|
|
196
|
+
## 🧑💻 Author & Project
|
|
197
|
+
|
|
198
|
+
**ciph** is **designed, developed, and maintained** by
|
|
199
|
+
|
|
200
|
+
[**Ankit Chaubey (@ankit‑chaubey)**](https://github.com/ankit-chaubey)
|
|
201
|
+
|
|
202
|
+
GitHub Repository:
|
|
203
|
+
👉 **[https://github.com/ankit-chaubey/ciph](https://github.com/ankit-chaubey/ciph)**
|
|
204
|
+
|
|
205
|
+
The project focuses on building **secure, efficient, and practical cryptographic tools** for real‑world usage, especially for media files and cloud storage.
|
|
206
|
+
|
|
207
|
+
---
|
|
208
|
+
|
|
209
|
+
## 📜 License
|
|
210
|
+
|
|
211
|
+
Apache License 2.0
|
|
212
|
+
|
|
213
|
+
Copyright © 2026 Ankit Chaubey
|
|
214
|
+
|
|
215
|
+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
|
|
216
|
+
You may obtain a copy of the License at:
|
|
217
|
+
|
|
218
|
+
[https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)
|
|
219
|
+
|
|
220
|
+
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
|
|
221
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
222
|
+
See the License for the specific language governing permissions and limitations under the License.
|
|
223
|
+
|
|
224
|
+
---
|
|
225
|
+
|
|
226
|
+
## 🔮 Roadmap
|
|
227
|
+
|
|
228
|
+
Planned future improvements:
|
|
229
|
+
|
|
230
|
+
* Parallel chunk encryption
|
|
231
|
+
* Resume / partial decryption
|
|
232
|
+
* Public‑key encryption mode
|
|
233
|
+
* Real‑time progress callbacks
|
|
234
|
+
* Prebuilt wheels (manylinux)
|
|
235
|
+
|
|
236
|
+
---
|
|
237
|
+
|
|
238
|
+
## ⚠️ Disclaimer
|
|
239
|
+
|
|
240
|
+
This tool uses strong cryptography.
|
|
241
|
+
|
|
242
|
+
If you forget your password, **your data cannot be recovered**.
|
|
243
|
+
|
|
244
|
+
Use responsibly.
|
ciph-0.1.1/README.md
ADDED
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
# ciph
|
|
2
|
+
|
|
3
|
+
[](https://pypi.org/project/ciph/)
|
|
4
|
+
[](https://pypi.org/project/ciph/)
|
|
5
|
+
[](https://pypi.org/project/ciph/)
|
|
6
|
+
[](https://github.com/ankit-chaubey/ciph/actions/workflows/ciph-test.yml)
|
|
7
|
+
[](https://github.com/ankit-chaubey/ciph/blob/main/LICENSE)
|
|
8
|
+
[](https://github.com/ankit-chaubey/ciph/releases)
|
|
9
|
+
[](#)
|
|
10
|
+
[](#)
|
|
11
|
+
|
|
12
|
+
**ciph** is a fast, streaming file‑encryption tool built for **large media files** and **cloud uploads**. It uses modern, industry‑standard cryptography and is designed to safely encrypt files **larger than your system RAM**.
|
|
13
|
+
|
|
14
|
+
> Encrypt locally. Upload anywhere. Decrypt only when you trust the environment.
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## ❓ Why ciph?
|
|
19
|
+
|
|
20
|
+
Most encryption tools load the entire file into memory before encrypting it. **ciph streams data in fixed-size chunks**, which means you can encrypt a **50 GB 4K video on a machine with only 2 GB of RAM**—smoothly and safely.
|
|
21
|
+
|
|
22
|
+
## ✨ Features
|
|
23
|
+
|
|
24
|
+
* 🔐 **Strong encryption** — AES‑256‑GCM or ChaCha20‑Poly1305
|
|
25
|
+
* 🔑 **Password protection** — Argon2id (memory‑hard key derivation)
|
|
26
|
+
* 🚀 **High performance** — streaming C core (1 MB chunks)
|
|
27
|
+
* 🧠 **Constant memory usage** — works with 10 GB+ files
|
|
28
|
+
* ⚙️ **Hardware‑aware** — AES‑NI when available, ChaCha fallback
|
|
29
|
+
* 🧪 **Integrity protected** — AEAD authentication on every chunk
|
|
30
|
+
* ☁️ **Cloud / Telegram safe** — encrypt before upload
|
|
31
|
+
* 🏷️ **Filename preserved** — original filename & extension are stored and restored on decryption
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## 🔐 Cryptographic Design
|
|
36
|
+
|
|
37
|
+
`ciph` uses a **hybrid (envelope) encryption model**, similar to what is used in modern secure storage systems:
|
|
38
|
+
|
|
39
|
+
1. A random **data key** encrypts the file in streaming mode.
|
|
40
|
+
2. Your password is hardened using **Argon2id**.
|
|
41
|
+
3. The data key is encrypted using the derived password key.
|
|
42
|
+
4. Every chunk is authenticated to detect tampering.
|
|
43
|
+
|
|
44
|
+
No custom crypto. No weak primitives.
|
|
45
|
+
|
|
46
|
+
5. The **original filename (without path)** is stored as encrypted metadata and automatically restored on decryption.
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## 🔒 Security Strength
|
|
51
|
+
|
|
52
|
+
| Component | Algorithm | Strength |
|
|
53
|
+
| -------------------------- | ---------------------------------------- | ------------ |
|
|
54
|
+
| File encryption | AES‑256‑GCM | 256‑bit |
|
|
55
|
+
| File encryption (fallback) | ChaCha20‑Poly1305 | 256‑bit |
|
|
56
|
+
| Password KDF | Argon2id | Memory‑hard |
|
|
57
|
+
| Integrity | AEAD | Tamper‑proof |
|
|
58
|
+
| Nonces | Key-derived per chunk (unique, no reuse) | No reuse |
|
|
59
|
+
|
|
60
|
+
### What this means
|
|
61
|
+
|
|
62
|
+
* Brute‑force attacks are **computationally infeasible**
|
|
63
|
+
* File corruption or tampering is **always detected**
|
|
64
|
+
* Encrypted files are safe on **any cloud platform**
|
|
65
|
+
* Losing the password means **data is unrecoverable**
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## 🚀 Quick Start (Build from Source)
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
git clone https://github.com/ankit-chaubey/ciph
|
|
73
|
+
cd ciph
|
|
74
|
+
make
|
|
75
|
+
pip install .
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## 📦 Installation
|
|
79
|
+
|
|
80
|
+
### Requirements
|
|
81
|
+
|
|
82
|
+
* Linux / Termux
|
|
83
|
+
* Python ≥ 3.8
|
|
84
|
+
* libsodium
|
|
85
|
+
|
|
86
|
+
### Install from PyPI
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
pip install ciph
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## 🚀 Usage
|
|
95
|
+
|
|
96
|
+
### Encrypt a file
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
ciph encrypt video.mp4
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Output:
|
|
103
|
+
|
|
104
|
+
```
|
|
105
|
+
video.mp4.ciph
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Decrypt a file
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
ciph decrypt video.mp4.ciph
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Output:
|
|
115
|
+
|
|
116
|
+
```
|
|
117
|
+
video.mp4
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
> The original filename and extension are automatically restored, even if the encrypted file was renamed.
|
|
121
|
+
|
|
122
|
+
### Example workflow (Cloud / Telegram)
|
|
123
|
+
|
|
124
|
+
```bash
|
|
125
|
+
ciph encrypt movie.mkv
|
|
126
|
+
# upload movie.mkv.ciph anywhere
|
|
127
|
+
# share the password securely
|
|
128
|
+
|
|
129
|
+
ciph decrypt movie.mkv.ciph
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
## 📝 File Format
|
|
135
|
+
|
|
136
|
+
| Offset | Size | Description |
|
|
137
|
+
| ------ | ---- | -------------------------------------- |
|
|
138
|
+
| 0 | 4 | Magic bytes (`CIPH`) |
|
|
139
|
+
| 4 | 1 | Format version |
|
|
140
|
+
| 5 | 1 | Cipher mode (1 = AES, 2 = ChaCha) |
|
|
141
|
+
| 6 | 16 | Argon2 salt |
|
|
142
|
+
| 22 | 12 | Key nonce |
|
|
143
|
+
| 34 | 1 | Filename length (N) |
|
|
144
|
+
| 35 | N | Original filename (UTF‑8) |
|
|
145
|
+
| 35+N | 2 | Encrypted data‑key length |
|
|
146
|
+
| … | … | Encrypted data key + encrypted payload |
|
|
147
|
+
|
|
148
|
+
## 📊 Performance
|
|
149
|
+
|
|
150
|
+
* Processes data in **1 MB chunks**
|
|
151
|
+
* Cryptography handled in **C (libsodium)**
|
|
152
|
+
* Python used only for CLI orchestration
|
|
153
|
+
* Typical throughput: **hundreds of MB/s** (CPU‑bound)
|
|
154
|
+
|
|
155
|
+
Encryption is usually faster than your internet upload speed.
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
## ⚠️ Limitations (v0.1.0)
|
|
160
|
+
|
|
161
|
+
* Linux / Termux only
|
|
162
|
+
* No resume support yet
|
|
163
|
+
* Progress bar shows start → finish (stream handled in C)
|
|
164
|
+
* Password‑based encryption only (public‑key mode planned)
|
|
165
|
+
* Filename metadata is visible (content remains fully encrypted)
|
|
166
|
+
|
|
167
|
+
---
|
|
168
|
+
|
|
169
|
+
## 🧑💻 Author & Project
|
|
170
|
+
|
|
171
|
+
**ciph** is **designed, developed, and maintained** by
|
|
172
|
+
|
|
173
|
+
[**Ankit Chaubey (@ankit‑chaubey)**](https://github.com/ankit-chaubey)
|
|
174
|
+
|
|
175
|
+
GitHub Repository:
|
|
176
|
+
👉 **[https://github.com/ankit-chaubey/ciph](https://github.com/ankit-chaubey/ciph)**
|
|
177
|
+
|
|
178
|
+
The project focuses on building **secure, efficient, and practical cryptographic tools** for real‑world usage, especially for media files and cloud storage.
|
|
179
|
+
|
|
180
|
+
---
|
|
181
|
+
|
|
182
|
+
## 📜 License
|
|
183
|
+
|
|
184
|
+
Apache License 2.0
|
|
185
|
+
|
|
186
|
+
Copyright © 2026 Ankit Chaubey
|
|
187
|
+
|
|
188
|
+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
|
|
189
|
+
You may obtain a copy of the License at:
|
|
190
|
+
|
|
191
|
+
[https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)
|
|
192
|
+
|
|
193
|
+
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
|
|
194
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
195
|
+
See the License for the specific language governing permissions and limitations under the License.
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
|
|
199
|
+
## 🔮 Roadmap
|
|
200
|
+
|
|
201
|
+
Planned future improvements:
|
|
202
|
+
|
|
203
|
+
* Parallel chunk encryption
|
|
204
|
+
* Resume / partial decryption
|
|
205
|
+
* Public‑key encryption mode
|
|
206
|
+
* Real‑time progress callbacks
|
|
207
|
+
* Prebuilt wheels (manylinux)
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
211
|
+
## ⚠️ Disclaimer
|
|
212
|
+
|
|
213
|
+
This tool uses strong cryptography.
|
|
214
|
+
|
|
215
|
+
If you forget your password, **your data cannot be recovered**.
|
|
216
|
+
|
|
217
|
+
Use responsibly.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = "0.1.0"
|