flask-enciphers 0.1.0__tar.gz

flask_enciphers-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: Any
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - run: pip install hatchling
+      - run: python -m hatchling build
+      - uses: pypa/gh-action-pypi-publish@release/v1

flask_enciphers-0.1.0/LICENSE

@@ -0,0 +1,184 @@
+                                 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 any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works of the Work, that is intentionally
+      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 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 Legal Entity on behalf of
+      whom a Contribution has been received by the 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,
+      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 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, 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 provided 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.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Contribution, and to permit persons to whom the Contribution is
+      furnished to do so.
+
+   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 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 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 your accepting any warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Mejlad Alsubaie
+
+   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.

flask_enciphers-0.1.0/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: flask-enciphers
+Version: 0.1.0
+Summary: Encrypted session interface for Flask using enciphers
+Project-URL: Homepage, https://github.com/mjlad/flask-enciphers
+Author: Mejlad Alsubaie
+License: Apache-2.0
+License-File: LICENSE
+Keywords: enciphers,encryption,flask,session
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Flask
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security :: Cryptography
+Requires-Python: >=3.11
+Requires-Dist: enciphers
+Requires-Dist: flask>=2.0
+Requires-Dist: orjson
+Description-Content-Type: text/markdown
+
+# quart-enciphers
+
+Encrypted session interface for Quart using [enciphers](https://pypi.org/project/enciphers/).
+
+Replaces Quart's default signed cookie session with a fully encrypted one.
+
+## Installation
+
+```bash
+pip install quart-enciphers
+```
+
+## Usage
+
+```python
+from quart import Quart, session
+from quart_enciphers import EnciphersSession
+
+app = Quart(__name__)
+EnciphersSession(app)
+
+@app.route("/login")
+async def login():
+    session["user_id"] = 1
+    return "logged in"
+```
+
+### Application Factory Pattern
+
+```python
+from quart_enciphers import EnciphersSession
+
+es = EnciphersSession()
+
+def create_app():
+    app = Quart(__name__)
+    es.init_app(app)
+    return app
+```
+
+## Configuration
+
+| Key | Type | Default | Description |
+|---|---|---|---|
+| `ENCIPHERS_STEP` | `int` | random | Encryption step |
+| `ENCIPHERS_KEY` | `int` | random | Secret key |
+| `ENCIPHERS_KEY_ENV` | `str` | None | Environment variable for key |
+
+> If no configuration is provided, random values are generated at startup.
+
+## License
+
+Apache-2.0 — Copyright 2026 Mejlad Alsubaie

flask_enciphers-0.1.0/README.md

@@ -0,0 +1,53 @@
+# quart-enciphers
+
+Encrypted session interface for Quart using [enciphers](https://pypi.org/project/enciphers/).
+
+Replaces Quart's default signed cookie session with a fully encrypted one.
+
+## Installation
+
+```bash
+pip install quart-enciphers
+```
+
+## Usage
+
+```python
+from quart import Quart, session
+from quart_enciphers import EnciphersSession
+
+app = Quart(__name__)
+EnciphersSession(app)
+
+@app.route("/login")
+async def login():
+    session["user_id"] = 1
+    return "logged in"
+```
+
+### Application Factory Pattern
+
+```python
+from quart_enciphers import EnciphersSession
+
+es = EnciphersSession()
+
+def create_app():
+    app = Quart(__name__)
+    es.init_app(app)
+    return app
+```
+
+## Configuration
+
+| Key | Type | Default | Description |
+|---|---|---|---|
+| `ENCIPHERS_STEP` | `int` | random | Encryption step |
+| `ENCIPHERS_KEY` | `int` | random | Secret key |
+| `ENCIPHERS_KEY_ENV` | `str` | None | Environment variable for key |
+
+> If no configuration is provided, random values are generated at startup.
+
+## License
+
+Apache-2.0 — Copyright 2026 Mejlad Alsubaie

flask_enciphers-0.1.0/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires      = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name            = "flask-enciphers"
+version         = "0.1.0"
+description     = "Encrypted session interface for Flask using enciphers"
+readme          = "README.md"
+license         = { text = "Apache-2.0" }
+authors         = [{ name = "Mejlad Alsubaie" }]
+keywords        = ["flask", "session", "encryption", "enciphers"]
+requires-python = ">=3.11"
+dependencies = ["flask >= 2.0", "enciphers", "orjson"]
+
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Security :: Cryptography",
+    "Framework :: Flask",
+]
+
+[project.urls]
+Homepage = "https://github.com/mjlad/flask-enciphers"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/flask_enciphers"]

flask_enciphers-0.1.0/src/flask_enciphers/__init__.py

@@ -0,0 +1,3 @@
+from .sessions import EnciphersSession
+
+__all__ = ["EnciphersSession"]

flask_enciphers-0.1.0/src/flask_enciphers/sessions.py

@@ -0,0 +1,118 @@
+from __future__ import annotations
+import secrets
+import orjson
+from flask import Flask
+from enciphers import Encipher
+from flask.sessions import SecureCookieSessionInterface, SecureCookieSession
+from flask.sessions import SessionMixin
+from werkzeug.wrappers import Request, Response
+
+
+class EnciphersSession(SecureCookieSessionInterface):
+    """A Flask session interface that uses enciphers for encryption.
+
+    Replaces the default signing with full encryption using enciphers.
+    All cookie settings are inherited from SecureCookieSessionInterface.
+
+    Usage::
+
+        app = Flask(__name__)
+        EnciphersSession(app)
+
+        # or with application factory pattern
+        es = EnciphersSession()
+
+        def create_app():
+            app = Flask(__name__)
+            es.init_app(app)
+            return app
+
+    Configuration::
+
+        app.config["ENCIPHERS_STEP"]    = 7         # optional
+        app.config["ENCIPHERS_KEY"]     = 42        # optional
+        app.config["ENCIPHERS_KEY_ENV"] = "MY_KEY"  # optional
+    """
+
+    session_class = SecureCookieSession
+
+    def __init__(self, app: Flask | None = None) -> None:
+        self.app = app
+        if self.app is not None:
+            self.init_app(self.app)
+
+    @staticmethod
+    def _setup(app: Flask) -> Encipher:
+        step: int | None = app.config.get("ENCIPHERS_STEP")
+        key: int | None = app.config.get("ENCIPHERS_KEY")
+        key_env : str | None = app.config.get("ENCIPHERS_KEY_ENV")
+
+        if not step:
+            step = secrets.randbelow(255) + 1
+
+        if not key and not key_env:
+            key = secrets.randbits(64)
+
+        return Encipher(step=step, key=key, key_env=key_env)
+
+    def init_app(self, app: Flask) -> None:
+        self.cipher = self._setup(app)
+        app.session_interface = self
+
+    def open_session(
+        self, app: Flask, request: Request
+    ) -> SecureCookieSession | None:
+
+        cookie = request.cookies.get(self.get_cookie_name(app))
+
+        if cookie is None:
+            return self.session_class()
+
+        try:
+            data = orjson.loads(self.cipher.decrypt(cookie))
+            return self.session_class(data)
+        except Exception:
+            return self.session_class()
+
+    def save_session(
+        self,
+        app: Flask,
+        session: SessionMixin,
+        response: Response,
+    ) -> None:
+
+        name = self.get_cookie_name(app)
+        domain = self.get_cookie_domain(app)
+        path = self.get_cookie_path(app)
+        secure = self.get_cookie_secure(app)
+        samesite = self.get_cookie_samesite(app)
+        httponly = self.get_cookie_httponly(app)
+
+        if not session:
+            if session.modified:
+                response.delete_cookie(
+                    name,
+                    domain = domain,
+                    path = path,
+                    secure = secure,
+                    samesite = samesite,
+                    httponly = httponly,
+                )
+            return
+
+        if not self.should_set_cookie(app, session):
+            return
+
+        expires = self.get_expiration_time(app, session)
+        token   = self.cipher.encrypt(orjson.dumps(dict(session)))
+
+        response.set_cookie(
+            name,
+            token,
+            expires = expires,
+            httponly = httponly,
+            domain = domain,
+            path = path,
+            secure = secure,
+            samesite = samesite,
+        )