sibna 1.0.0__tar.gz → 1.4.0__tar.gz

sibna-1.4.0/LICENSE

@@ -0,0 +1,176 @@
+                                 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 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, as submitted to the 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 developing the
+      Work, 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 Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      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,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   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 the 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 any other
+      Contribution embodied in the Work constitutes patent 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 a part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, 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 in addition to the
+          NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+   You may add Your own license statement for Your Contribution(s)
+   and may provide additional grant of rights not granted by this 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.
+
+   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 reproducing the Work and assume any
+      risks associated with Your 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 exemplary damages of any character arising as a result
+      of this License or out of the use or inability to use the Work
+      (including but not limited to damages for loss of goodwill, work
+      stoppage, computer failure or malfunction, or all other commercial
+      damages or losses), even if such Contributor has been advised of the
+      possibility of such damages.
+
+   9. Accepting Warranty or 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 charge a fee on behalf of the
+      Licensor or on behalf of such obligated party, 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 your accepting any warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 Sibna Security Team
+
+   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.

sibna-1.4.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+include pyproject.toml
+recursive-include sibna *.dll *.so *.dylib

sibna-1.4.0/PKG-INFO

@@ -0,0 +1,396 @@
+Metadata-Version: 2.4
+Name: sibna
+Version: 1.4.0
+Summary: Standalone Ultra-Secure Communication Protocol - Python SDK
+Author-email: Sibna Security Team <security@sibna.dev>
+License:                                  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 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, as submitted to the 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 developing the
+              Work, 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 Legal Entity on behalf of
+              whom a Contribution has been received by the Licensor and included
+              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,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           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 the 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 any other
+              Contribution embodied in the Work constitutes patent 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 a part of its
+                  distribution, You must include a readable copy of the
+                  attribution notices contained within such NOTICE file, 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 in addition to the
+                  NOTICE text from the Work, provided that such additional
+                  attribution notices cannot be construed as modifying the License.
+        
+           You may add Your own license statement for Your Contribution(s)
+           and may provide additional grant of rights not granted by this 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.
+        
+           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 reproducing the Work and assume any
+              risks associated with Your 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 exemplary damages of any character arising as a result
+              of this License or out of the use or inability to use the Work
+              (including but not limited to damages for loss of goodwill, work
+              stoppage, computer failure or malfunction, or all other commercial
+              damages or losses), even if such Contributor has been advised of the
+              possibility of such damages.
+        
+           9. Accepting Warranty or 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 charge a fee on behalf of the
+              Licensor or on behalf of such obligated party, 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 your accepting any warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           Copyright 2024 Sibna Security Team
+        
+           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.
+        
+Project-URL: Homepage, https://github.com/SibnaOfficial/libsa
+Project-URL: Repository, https://github.com/SibnaOfficial/libsa
+Project-URL: Bug Tracker, https://github.com/SibnaOfficial/libsa/issues
+Project-URL: Changelog, https://github.com/SibnaOfficial/libsa/releases
+Keywords: cryptography,encryption,signal-protocol,secure-messaging,e2ee,end-to-end-encryption,x3dh,double-ratchet,chacha20
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: Communications
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Sibna Protocol — Python SDK
+
+Python SDK for the Sibna encrypted communication protocol.
+
+---
+
+## Before You Start — What You Need
+
+This SDK **does not work standalone**. It requires a compiled native library built from the `sibna-protc` Rust project:
+
+| OS      | Required File          |
+|---------|------------------------|
+| Windows | `sibna_core.dll`       |
+| Linux   | `libsibna_core.so`     |
+| macOS   | `libsibna_core.dylib`  |
+
+**To build the library:**
+```bash
+cd sibna-protc/core
+cargo build --release --features ffi
+# Output is in: target/release/
+```
+Then copy the resulting file into the same `sibna/` folder as this SDK.
+
+---
+
+## Installation
+
+```bash
+# External dependencies (this SDK is NOT zero-dependencies)
+pip install cryptography          # For Identity + signature verification
+pip install requests              # For the sync HTTP client
+pip install aiohttp               # For async + WebSocket
+```
+
+---
+
+## What This SDK Does
+
+### `sibna` (core — requires the compiled native library)
+
+| Function / Class | What it does |
+|------------------|--------------|
+| `is_available()` | Checks if the native library is loaded |
+| `generate_key()` | Generates a random 32-byte key |
+| `encrypt(key, data)` | Encrypts data (ChaCha20-Poly1305) |
+| `decrypt(key, data)` | Decrypts data |
+| `random_bytes(n)` | Generates cryptographically secure random bytes |
+| `Context()` | Manages identity and encrypted sessions |
+| `Context.generate_identity()` | Generates an identity keypair (Ed25519 + X25519) |
+| `Context.generate_prekey_bundle()` | Generates a bundle to upload to the prekey server |
+| `Context.perform_handshake(...)` | Runs X3DH and creates a Double Ratchet session |
+| `Context.session_encrypt(...)` | Encrypts a message over an existing session |
+| `Context.session_decrypt(...)` | Decrypts a message |
+
+### `sibna.client` (networking — requires `requests` / `aiohttp`)
+
+| Class | What it does |
+|-------|--------------|
+| `Identity` | Ed25519 keypair for server authentication |
+| `SibnaClient` | Synchronous HTTP client |
+| `AsyncSibnaClient` | Async + WebSocket client |
+
+---
+
+## Basic Example — Simple Encryption
+
+```python
+import sibna
+
+# Check the library is available
+if not sibna.is_available():
+    raise RuntimeError("Native library not found. Build it from sibna-protc first.")
+
+# Encrypt and decrypt
+key = sibna.generate_key()          # Random 32-byte key
+ct  = sibna.encrypt(key, b"Hello")
+pt  = sibna.decrypt(key, ct)
+assert pt == b"Hello"
+
+# With associated data (authenticated but not encrypted)
+ct  = sibna.encrypt(key, b"Secret", associated_data=b"context-header")
+pt  = sibna.decrypt(key, ct, associated_data=b"context-header")
+```
+
+---
+
+## Advanced Example — Double Ratchet Session
+
+```python
+import sibna
+
+# On Alice's device
+alice_ctx = sibna.Context(password=b"AlicePass1!")
+alice_ed, alice_x = alice_ctx.generate_identity()
+alice_bundle = alice_ctx.generate_prekey_bundle()
+
+# On Bob's device
+bob_ctx = sibna.Context(password=b"BobPass1!")
+bob_ed, bob_x = bob_ctx.generate_identity()
+bob_bundle = bob_ctx.generate_prekey_bundle()
+
+# Alice initiates the handshake with Bob
+alice_ctx.perform_handshake(
+    peer_id=bob_ed,          # Bob's identity key (used as session ID)
+    peer_bundle=bob_bundle,  # Bob's bundle (fetched from prekey server)
+    initiator=True,
+)
+
+# Bob accepts the handshake from Alice
+bob_ctx.perform_handshake(
+    peer_id=alice_ed,
+    peer_bundle=alice_bundle,
+    initiator=False,
+)
+
+# Alice encrypts
+ciphertext = alice_ctx.session_encrypt(bob_ed, b"Hello Bob!")
+
+# Bob decrypts
+plaintext = bob_ctx.session_decrypt(alice_ed, ciphertext)
+assert plaintext == b"Hello Bob!"
+```
+
+---
+
+## Example — HTTP Client
+
+```python
+from sibna.client import SibnaClient
+import sibna
+
+# Set up encryption context
+ctx = sibna.Context()
+ctx.generate_identity()
+bundle = ctx.generate_prekey_bundle()
+
+# Connect to server
+client = SibnaClient(server="http://localhost:8080")
+client.generate_identity()   # Separate identity for server auth
+client.authenticate()         # JWT challenge-response flow
+client.upload_prekey(bundle.hex())
+
+# Send an encrypted message (payload is pre-encrypted by Context)
+ciphertext = ctx.session_encrypt(b"peer_id_here", b"Hello!")
+client.send_message(
+    recipient_id="peer_identity_hex",
+    payload_hex=ciphertext.hex(),
+)
+
+# Receive messages
+messages = client.fetch_inbox()
+for msg in messages:
+    plaintext = ctx.session_decrypt(
+        bytes.fromhex(msg["sender_id"]),
+        bytes.fromhex(msg["payload_hex"]),
+    )
+    print(plaintext.decode())
+```
+
+---
+
+## Common Errors
+
+| Error | Cause | Fix |
+|-------|-------|-----|
+| `LibraryNotFoundError` | Native library not found | Build `sibna-protc` with Rust |
+| `SibnaError(13)` | Tampered data or wrong key | Check key and `associated_data` |
+| `SibnaError(7)` | Session does not exist | Call `perform_handshake()` first |
+| `SibnaError(10)` | Weak password | Use a password with uppercase, lowercase, and digits |
+| `MissingDependencyError` | Python package not installed | `pip install cryptography requests aiohttp` |
+
+---
+
+## A Note on Dependencies
+
+This SDK is **not** zero-dependencies:
+- `__init__.py` requires the compiled Rust native library
+- `client.py` requires `cryptography`, `requests`, and `aiohttp`
+
+The Rust core itself has no runtime dependencies once compiled.
+
+---
+
+## License
+
+Apache-2.0