km-keybind 1.0.0__tar.gz

km_keybind-1.0.0/LICENSE

@@ -0,0 +1,170 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or
+Object form, that is based on (or derived from) the Work and for
+which the editorial revisions, annotations, elaborations, or other
+modifications represent, as a whole, an original work of authorship.
+For the purposes of this License, Derivative Works shall not include
+works that remain separable from, or merely link (or bind by name)
+to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publish, distribute, sublicense, and/or sell copies of the Work, and
+to permit persons to whom the Work is furnished to do so.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with the exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character including
+without limitation damages for loss of goodwill, work stoppage,
+computer failure or malfunction, or any and all other commercial
+damages or losses, arising out of or related to the Work or the use or
+other dealings in the Work, neither in tort nor contract, or otherwise,
+except as agreed by the Contributor in writing.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of, or arising out of, your accepting any such warranty or
+additional liability.
+
+END OF TERMS AND CONDITIONS

km_keybind-1.0.0/PKG-INFO

@@ -0,0 +1,241 @@
+Metadata-Version: 2.4
+Name: km-keybind
+Version: 1.0.0
+Summary: Stateless encrypted identity-bound token library
+Author: Pravanjan Roy
+Project-URL: Homepage, https://github.com/kingmon6996/keybind
+Project-URL: Repository, https://github.com/kingmon6996/keybind
+Project-URL: Issues, https://github.com/kingmon6996/keybind/issues
+Keywords: km-keybind,keybind,encrypted-token,identity-bound,stateless-token,cryptography
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cryptography
+Requires-Dist: PyNaCl
+Requires-Dist: zstandard
+Requires-Dist: blake3
+Requires-Dist: orjson
+Requires-Dist: typing-extensions
+Dynamic: license-file
+
+# Keybind
+
+Keybind is a Python library for turning JSON-compatible data and files into compact, encrypted, identity-bound tokens. It is useful when you want to send or store structured data or file payloads in a self-contained form without keeping server-side state.
+
+## What Keybind is for
+
+You can use Keybind when you need to:
+
+- create a compact token from a dictionary or other JSON-compatible object
+- bind that token to a specific user or application context
+- keep the payload encrypted and self-contained
+- safely pass the token across systems or store it for later use
+
+Typical use cases include:
+
+- temporary session payloads
+- encrypted user profile fragments
+- backend-to-backend message transport
+- short-lived access tokens with embedded data
+- compact state handoff between services
+
+## The master key
+
+The master key is the secret value that unlocks and protects the token. It is supplied when you create a Keybind instance:
+
+```python
+from keybind import Keybind
+
+chain = Keybind(b"master-key")
+```
+
+In real projects, use a strong secret instead of a sample string. A good master key should be:
+
+- long enough to be unpredictable
+- stored securely
+- kept private
+- reused consistently for the same application context
+
+### How to generate a master key
+
+A simple and safe approach is to generate a random 32-byte key:
+
+```python
+import os
+
+master_key = os.urandom(32)
+chain = Keybind(master_key)
+```
+
+You can also store it in an environment variable:
+
+```python
+import os
+
+master_key = os.environ["KEYBIND_MASTER_KEY"].encode("utf-8")
+chain = Keybind(master_key)
+```
+
+### Why the master key matters
+
+- It is the root secret used to derive the encryption key.
+- The same key must be used later when decoding the token.
+- If the master key changes, the token cannot be decrypted correctly.
+
+## Identities
+
+Keybind also takes two identity values during encoding and decoding:
+
+```python
+from keybind.keybind import DICT
+
+token = chain.encode("user123", "app", DICT, {"hello": "world"})
+chain.decode("user123", "app", token)
+```
+
+These identities bind the token to a specific context. In practice:
+
+- the first identity is often a user, account, or subject
+- the second identity is often an app, service, or environment
+
+This means the token is not only encrypted, but also tied to the identities used when it was created.
+
+## Full example
+
+Here is a complete example from start to finish:
+
+```python
+from keybind import Keybind
+from keybind.keybind import DICT
+
+master_key = b"example-master-key"
+chain = Keybind(master_key)
+
+payload = {
+    "user": "alice",
+    "role": "admin",
+    "permissions": ["read", "write"],
+    "active": True,
+}
+
+token = chain.encode("alice", "dashboard", DICT, payload)
+print("Token:", token)
+
+decoded, decoded_type = chain.decode("alice", "dashboard", token)
+print("Decoded:", decoded)
+print("Decoded type:", decoded_type)
+```
+
+### What happens in this example
+
+1. A Keybind instance is created with a master key.
+2. A JSON-compatible payload is prepared.
+3. The payload is turned into an encrypted token.
+4. The token is later decoded back into the original object.
+
+## How the library works internally
+
+Keybind now supports file payloads via the `FILE` payload type. When you encode a file path, the raw file contents are encrypted and later decoded to a saved file path under `decoded_files/`, preserving the original filename.
+
+```python
+from keybind import Keybind
+from keybind.keybind import FILE
+
+chain = Keybind(b"example-master-key")
+
+token = chain.encode("alice", "dashboard", FILE, "summary.txt")
+file_path, decoded_type = chain.decode("alice", "dashboard", token)
+print("Decoded file saved to:", file_path)
+print("Decoded type:", decoded_type)
+```
+
+When you call encode, Keybind performs these steps:
+
+1. Normalizes the two identities.
+2. Serializes the payload into bytes.
+3. Applies optional compression.
+4. Derives an encryption key from the master key and identities.
+5. Encrypts the payload.
+6. Produces a compact token string.
+
+When you call decode, it reverses this process:
+
+1. Validates the token format.
+2. Re-derives the key using the same master key and identities.
+3. Decrypts the payload.
+4. Reconstructs the original JSON-compatible object.
+
+## Example use cases
+
+### 1. Temporary user session payload
+
+```python
+import os
+from keybind import Keybind
+from keybind.keybind import DICT
+
+chain = Keybind(os.urandom(32))
+
+session_data = {"user_id": 42, "plan": "pro", "expires_in": 3600}
+token = chain.encode("42", "web-app", DICT, session_data)
+```
+
+### 2. Cross-service message transport
+
+```python
+from keybind import Keybind
+from keybind.keybind import DICT
+
+chain = Keybind(b"shared-secret")
+
+message = {"event": "user.created", "id": 101}
+token = chain.encode("service-a", "service-b", DICT, message)
+```
+
+### 3. Compact state handoff
+
+```python
+from keybind import Keybind
+from keybind.keybind import DICT
+
+chain = Keybind(b"state-secret")
+
+state = {"step": 3, "status": "pending", "retry": False}
+token = chain.encode("job-17", "worker", DICT, state)
+```
+
+## Important security notes
+
+- Keep the master key secret.
+- Do not hard-code production secrets in source files.
+- Use a secure secret store or environment variable in production.
+- Reuse the same master key consistently for the same application context.
+- Keep the identities meaningful and consistent with your system design.
+
+## Installation
+
+Install the package from PyPI with:
+
+```bash
+pip install km-keybind
+```
+
+Install it directly from GitHub as a package with:
+
+```bash
+pip install git+https://github.com/kingmon6996/keybind.git
+```
+
+## Summary
+
+Keybind gives you a simple way to turn JSON-compatible data into a compact, encrypted, identity-bound token. The core idea is straightforward:
+
+- provide a master key
+- provide two identities
+- encode data into a token
+- decode later with the same key and identities
+
+Thank you for using Keybind.

km_keybind-1.0.0/README.md

@@ -0,0 +1,218 @@
+# Keybind
+
+Keybind is a Python library for turning JSON-compatible data and files into compact, encrypted, identity-bound tokens. It is useful when you want to send or store structured data or file payloads in a self-contained form without keeping server-side state.
+
+## What Keybind is for
+
+You can use Keybind when you need to:
+
+- create a compact token from a dictionary or other JSON-compatible object
+- bind that token to a specific user or application context
+- keep the payload encrypted and self-contained
+- safely pass the token across systems or store it for later use
+
+Typical use cases include:
+
+- temporary session payloads
+- encrypted user profile fragments
+- backend-to-backend message transport
+- short-lived access tokens with embedded data
+- compact state handoff between services
+
+## The master key
+
+The master key is the secret value that unlocks and protects the token. It is supplied when you create a Keybind instance:
+
+```python
+from keybind import Keybind
+
+chain = Keybind(b"master-key")
+```
+
+In real projects, use a strong secret instead of a sample string. A good master key should be:
+
+- long enough to be unpredictable
+- stored securely
+- kept private
+- reused consistently for the same application context
+
+### How to generate a master key
+
+A simple and safe approach is to generate a random 32-byte key:
+
+```python
+import os
+
+master_key = os.urandom(32)
+chain = Keybind(master_key)
+```
+
+You can also store it in an environment variable:
+
+```python
+import os
+
+master_key = os.environ["KEYBIND_MASTER_KEY"].encode("utf-8")
+chain = Keybind(master_key)
+```
+
+### Why the master key matters
+
+- It is the root secret used to derive the encryption key.
+- The same key must be used later when decoding the token.
+- If the master key changes, the token cannot be decrypted correctly.
+
+## Identities
+
+Keybind also takes two identity values during encoding and decoding:
+
+```python
+from keybind.keybind import DICT
+
+token = chain.encode("user123", "app", DICT, {"hello": "world"})
+chain.decode("user123", "app", token)
+```
+
+These identities bind the token to a specific context. In practice:
+
+- the first identity is often a user, account, or subject
+- the second identity is often an app, service, or environment
+
+This means the token is not only encrypted, but also tied to the identities used when it was created.
+
+## Full example
+
+Here is a complete example from start to finish:
+
+```python
+from keybind import Keybind
+from keybind.keybind import DICT
+
+master_key = b"example-master-key"
+chain = Keybind(master_key)
+
+payload = {
+    "user": "alice",
+    "role": "admin",
+    "permissions": ["read", "write"],
+    "active": True,
+}
+
+token = chain.encode("alice", "dashboard", DICT, payload)
+print("Token:", token)
+
+decoded, decoded_type = chain.decode("alice", "dashboard", token)
+print("Decoded:", decoded)
+print("Decoded type:", decoded_type)
+```
+
+### What happens in this example
+
+1. A Keybind instance is created with a master key.
+2. A JSON-compatible payload is prepared.
+3. The payload is turned into an encrypted token.
+4. The token is later decoded back into the original object.
+
+## How the library works internally
+
+Keybind now supports file payloads via the `FILE` payload type. When you encode a file path, the raw file contents are encrypted and later decoded to a saved file path under `decoded_files/`, preserving the original filename.
+
+```python
+from keybind import Keybind
+from keybind.keybind import FILE
+
+chain = Keybind(b"example-master-key")
+
+token = chain.encode("alice", "dashboard", FILE, "summary.txt")
+file_path, decoded_type = chain.decode("alice", "dashboard", token)
+print("Decoded file saved to:", file_path)
+print("Decoded type:", decoded_type)
+```
+
+When you call encode, Keybind performs these steps:
+
+1. Normalizes the two identities.
+2. Serializes the payload into bytes.
+3. Applies optional compression.
+4. Derives an encryption key from the master key and identities.
+5. Encrypts the payload.
+6. Produces a compact token string.
+
+When you call decode, it reverses this process:
+
+1. Validates the token format.
+2. Re-derives the key using the same master key and identities.
+3. Decrypts the payload.
+4. Reconstructs the original JSON-compatible object.
+
+## Example use cases
+
+### 1. Temporary user session payload
+
+```python
+import os
+from keybind import Keybind
+from keybind.keybind import DICT
+
+chain = Keybind(os.urandom(32))
+
+session_data = {"user_id": 42, "plan": "pro", "expires_in": 3600}
+token = chain.encode("42", "web-app", DICT, session_data)
+```
+
+### 2. Cross-service message transport
+
+```python
+from keybind import Keybind
+from keybind.keybind import DICT
+
+chain = Keybind(b"shared-secret")
+
+message = {"event": "user.created", "id": 101}
+token = chain.encode("service-a", "service-b", DICT, message)
+```
+
+### 3. Compact state handoff
+
+```python
+from keybind import Keybind
+from keybind.keybind import DICT
+
+chain = Keybind(b"state-secret")
+
+state = {"step": 3, "status": "pending", "retry": False}
+token = chain.encode("job-17", "worker", DICT, state)
+```
+
+## Important security notes
+
+- Keep the master key secret.
+- Do not hard-code production secrets in source files.
+- Use a secure secret store or environment variable in production.
+- Reuse the same master key consistently for the same application context.
+- Keep the identities meaningful and consistent with your system design.
+
+## Installation
+
+Install the package from PyPI with:
+
+```bash
+pip install km-keybind
+```
+
+Install it directly from GitHub as a package with:
+
+```bash
+pip install git+https://github.com/kingmon6996/keybind.git
+```
+
+## Summary
+
+Keybind gives you a simple way to turn JSON-compatible data into a compact, encrypted, identity-bound token. The core idea is straightforward:
+
+- provide a master key
+- provide two identities
+- encode data into a token
+- decode later with the same key and identities
+
+Thank you for using Keybind.

km_keybind-1.0.0/keybind/__init__.py

@@ -0,0 +1,19 @@
+# Copyright 2026 Pravanjan Roy
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from .keybind import Keybind
+
+__all__ = ["Keybind"]
+
+

km_keybind-1.0.0/keybind/chunker.py

@@ -0,0 +1,30 @@
+# Copyright 2026 Pravanjan Roy
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import annotations
+
+
+class ChunkManager:
+
+    def __init__(self, chunk_size: int = 1024 * 1024) -> None:
+        self.chunk_size = chunk_size
+
+    def split(self, payload: bytes) -> list[bytes]:
+        if payload is None:
+            return []
+        if len(payload) == 0:
+            return [b""]
+        return [payload[i : i + self.chunk_size] for i in range(0, len(payload), self.chunk_size)]
+
+