scopie 0.1.0__tar.gz

scopie-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ronnie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

scopie-0.1.0/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: scopie
+Version: 0.1.0
+Summary: Authorization engine providing fine grained access while you control the data. Aimed at being easy to use and implement without overtaking other parts of your system.
+Author-email: Ronnie Smith <miniscruff@hey.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/miniscruff/scopie-py
+Project-URL: Documentation, https://github.com/miniscruff/scopie-py
+Project-URL: Repository, https://github.com/miniscruff/scopie-py.git
+Project-URL: Issues, https://github.com/miniscruff/scopie-py/issues
+Project-URL: Changelog, https://github.com/miniscruff/scopie-py/blob/main/CHANGELOG.md
+Keywords: authorization
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# scopie-py
+Python implementation of scopie

scopie-0.1.0/README.md

@@ -0,0 +1,2 @@
+# scopie-py
+Python implementation of scopie

scopie-0.1.0/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools >= 61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "scopie"
+version = "v0.1.0"
+authors = [
+  {name = "Ronnie Smith", email = "miniscruff@hey.com"},
+]
+description = "Authorization engine providing fine grained access while you control the data. Aimed at being easy to use and implement without overtaking other parts of your system."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.9"
+keywords = ["authorization"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+]
+[project.urls]
+Homepage = "https://github.com/miniscruff/scopie-py"
+Documentation = "https://github.com/miniscruff/scopie-py"
+Repository = "https://github.com/miniscruff/scopie-py.git"
+Issues = "https://github.com/miniscruff/scopie-py/issues"
+Changelog = "https://github.com/miniscruff/scopie-py/blob/main/CHANGELOG.md"
+
+[tool.setuptools.packages.find]
+where = ["src"]

scopie-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

scopie-0.1.0/src/scopie/scopie.py

@@ -0,0 +1,124 @@
+from typing import List, Dict
+from itertools import zip_longest
+
+array_seperator = "|"
+block_seperator = "/"
+wildcard = "*"
+var_prefix = "@"
+
+allow_permission = "allow"
+deny_permission = "deny"
+
+allowed_extra_chars = {"_", "-", var_prefix, wildcard}
+
+
+class ScopieError(Exception):
+    def __init__(self, msg: str):
+        self.msg = msg
+
+    def __eq__(self, other) -> bool:
+        return isinstance(other, ScopieError) and self.msg == other.msg
+
+
+def is_valid_char(char: str) -> bool:
+    if char >= "a" and char <= "z":
+        return True
+
+    if char >= "A" and char <= "Z":
+        return True
+
+    if char >= "0" and char <= "9":
+        return True
+
+    return char in allowed_extra_chars
+
+
+def compare_rule_to_scope(rule: str, scope: str, vars: dict) -> bool:
+    rule_blocks = rule.split(block_seperator)
+    scope_blocks = scope.split(block_seperator)
+    for i, (rule_block, scope_block) in enumerate(
+        zip_longest(rule_blocks[1:], scope_blocks)
+    ):
+        if scope_block == "":
+            raise ScopieError("scopie-106 in scope: scope was empty")
+
+        if rule_block == "":
+            raise ScopieError("scopie-106 in rule: rule was empty")
+
+        if not scope_block or not rule_block:
+            return False
+
+        if rule_block == wildcard:
+            continue
+
+        if len(rule_block) == 2 and rule_block == wildcard + wildcard:
+            if i < len(rule_blocks) - 2:
+                raise ScopieError("scopie-105: super wildcard not in the last block")
+
+            return rule_blocks[0] == allow_permission
+
+        if rule_block[0] == var_prefix:
+            var_name = rule_block[1:]
+            if var_name not in vars:
+                raise ScopieError(f"scopie-104: variable '{var_name}' not found")
+            if vars[var_name] != scope_block:
+                return False
+        else:
+            rules_split = rule_block.split(array_seperator)
+
+            for rule_split in rules_split:
+                if rule_split[0] == var_prefix:
+                    raise ScopieError(
+                        f"scopie-101: variable '{rule_split[1:]}' found in array block"
+                    )
+
+                if (
+                    rule_split[0] == wildcard
+                    and len(rule_split) > 1
+                    and rule_split[1] == wildcard
+                ):
+                    raise ScopieError("scopie-103: super wildcard found in array block")
+
+                if rule_split[0] == wildcard:
+                    raise ScopieError("scopie-102: wildcard found in array block")
+
+                for c in rule_split:
+                    if not is_valid_char(c):
+                        raise ScopieError(
+                            f"scopie-100 in rule: invalid character '{c}'"
+                        )
+
+            for c in scope_block:
+                if not is_valid_char(c):
+                    raise ScopieError(f"scopie-100 in scope: invalid character '{c}'")
+
+            if scope_block not in rules_split:
+                return False
+
+    return True
+
+
+def is_allowed(
+    scopes: List[str],
+    rules: List[str],
+    **vars: Dict[str, str],
+) -> bool:
+    has_been_allowed = False
+    if not rules:
+        return False
+
+    if rules[0] == "":
+        raise ScopieError("scopie-106 in rule: rule was empty")
+
+    if len(scopes) == 0:
+        raise ScopieError("scopie-106 in scope: scopes was empty")
+
+    for rule in rules:
+        for scope in scopes:
+            match = compare_rule_to_scope(rule, scope, vars)
+            if match and rule.startswith(deny_permission):
+                return False
+            elif match:
+                has_been_allowed = True
+
+    return has_been_allowed

scopie-0.1.0/src/scopie.egg-info/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: scopie
+Version: 0.1.0
+Summary: Authorization engine providing fine grained access while you control the data. Aimed at being easy to use and implement without overtaking other parts of your system.
+Author-email: Ronnie Smith <miniscruff@hey.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/miniscruff/scopie-py
+Project-URL: Documentation, https://github.com/miniscruff/scopie-py
+Project-URL: Repository, https://github.com/miniscruff/scopie-py.git
+Project-URL: Issues, https://github.com/miniscruff/scopie-py/issues
+Project-URL: Changelog, https://github.com/miniscruff/scopie-py/blob/main/CHANGELOG.md
+Keywords: authorization
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# scopie-py
+Python implementation of scopie

scopie-0.1.0/src/scopie.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+LICENSE
+README.md
+pyproject.toml
+src/scopie/__init__.py
+src/scopie/scopie.py
+src/scopie.egg-info/PKG-INFO
+src/scopie.egg-info/SOURCES.txt
+src/scopie.egg-info/dependency_links.txt
+src/scopie.egg-info/top_level.txt

scopie-0.1.0/src/scopie.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

scopie-0.1.0/src/scopie.egg-info/top_level.txt

@@ -0,0 +1 @@
+scopie