zrok2-build-debugging 22.0.2000008__py3-none-any.whl

test/test_update_share_name_request.py

@@ -0,0 +1,53 @@
+# coding: utf-8
+
+"""
+    zrok
+
+    zrok client access
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from zrok_api.models.update_share_name_request import UpdateShareNameRequest
+
+class TestUpdateShareNameRequest(unittest.TestCase):
+    """UpdateShareNameRequest unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> UpdateShareNameRequest:
+        """Test UpdateShareNameRequest
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `UpdateShareNameRequest`
+        """
+        model = UpdateShareNameRequest()
+        if include_optional:
+            return UpdateShareNameRequest(
+                namespace_token = '',
+                name = '',
+                reserved = True
+            )
+        else:
+            return UpdateShareNameRequest(
+        )
+        """
+
+    def testUpdateShareNameRequest(self):
+        """Test UpdateShareNameRequest"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

test/test_update_share_request.py

@@ -0,0 +1,57 @@
+# coding: utf-8
+
+"""
+    zrok
+
+    zrok client access
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from zrok_api.models.update_share_request import UpdateShareRequest
+
+class TestUpdateShareRequest(unittest.TestCase):
+    """UpdateShareRequest unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> UpdateShareRequest:
+        """Test UpdateShareRequest
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `UpdateShareRequest`
+        """
+        model = UpdateShareRequest()
+        if include_optional:
+            return UpdateShareRequest(
+                share_token = '',
+                add_access_grants = [
+                    ''
+                    ],
+                remove_access_grants = [
+                    ''
+                    ]
+            )
+        else:
+            return UpdateShareRequest(
+        )
+        """
+
+    def testUpdateShareRequest(self):
+        """Test UpdateShareRequest"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

test/test_verify200_response.py

@@ -0,0 +1,51 @@
+# coding: utf-8
+
+"""
+    zrok
+
+    zrok client access
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from zrok_api.models.verify200_response import Verify200Response
+
+class TestVerify200Response(unittest.TestCase):
+    """Verify200Response unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> Verify200Response:
+        """Test Verify200Response
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `Verify200Response`
+        """
+        model = Verify200Response()
+        if include_optional:
+            return Verify200Response(
+                email = ''
+            )
+        else:
+            return Verify200Response(
+        )
+        """
+
+    def testVerify200Response(self):
+        """Test Verify200Response"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

test/test_verify_request.py

@@ -0,0 +1,51 @@
+# coding: utf-8
+
+"""
+    zrok
+
+    zrok client access
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from zrok_api.models.verify_request import VerifyRequest
+
+class TestVerifyRequest(unittest.TestCase):
+    """VerifyRequest unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> VerifyRequest:
+        """Test VerifyRequest
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `VerifyRequest`
+        """
+        model = VerifyRequest()
+        if include_optional:
+            return VerifyRequest(
+                register_token = ''
+            )
+        else:
+            return VerifyRequest(
+        )
+        """
+
+    def testVerifyRequest(self):
+        """Test VerifyRequest"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

test/test_version_inventory200_response.py

@@ -0,0 +1,51 @@
+# coding: utf-8
+
+"""
+    zrok
+
+    zrok client access
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from zrok_api.models.version_inventory200_response import VersionInventory200Response
+
+class TestVersionInventory200Response(unittest.TestCase):
+    """VersionInventory200Response unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> VersionInventory200Response:
+        """Test VersionInventory200Response
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `VersionInventory200Response`
+        """
+        model = VersionInventory200Response()
+        if include_optional:
+            return VersionInventory200Response(
+                controller_version = ''
+            )
+        else:
+            return VersionInventory200Response(
+        )
+        """
+
+    def testVersionInventory200Response(self):
+        """Test VersionInventory200Response"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

zrok/__init__.py

@@ -0,0 +1,4 @@
+from . import environment # noqa
+from . import access, decor, model, share, overview # noqa
+from . import _version
+__version__ = _version.get_versions()['version']

zrok/_version.py

@@ -0,0 +1,21 @@
+
+# This file was generated by 'versioneer.py' (0.29) from
+# revision-control system data, or from the parent directory name of an
+# unpacked source archive. Distribution tarballs contain a pre-generated copy
+# of this file.
+
+import json
+
+version_json = '''
+{
+ "date": "2026-02-03T14:19:30-0500",
+ "dirty": false,
+ "error": null,
+ "full-revisionid": "645ebc9de7858f7e800eb86cf0090f4fdae85f7c",
+ "version": "22.0.2000008"
+}
+'''  # END VERSION_JSON
+
+
+def get_versions():
+    return json.loads(version_json)

zrok/access.py

@@ -0,0 +1,58 @@
+from zrok.environment.root import Root
+from zrok_api.models.access_request import AccessRequest
+from zrok_api.models.unaccess_request import UnaccessRequest
+from zrok_api.api import ShareApi
+from zrok import model
+
+
+class Access():
+    root: Root
+    request: model.AccessRequest
+    access: model.Access
+
+    def __init__(self, root: Root, request: model.AccessRequest):
+        self.root = root
+        self.request = request
+
+    def __enter__(self) -> model.Access:
+        self.access = CreateAccess(root=self.root, request=self.request)
+        return self.access
+
+    def __exit__(self, exception_type, exception_value, exception_traceback):
+        DeleteAccess(root=self.root, acc=self.access)
+
+
+def CreateAccess(root: Root, request: model.AccessRequest) -> model.Access:
+    if not root.IsEnabled():
+        raise Exception("environment is not enabled; enable with 'zrok enable' first!")
+
+    out = AccessRequest(share_token=request.ShareToken,
+                        env_zid=root.env.ZitiIdentity)
+
+    try:
+        zrok = root.Client()
+    except Exception as e:
+        raise Exception("error getting zrok client", e)
+    try:
+        res = ShareApi(zrok).access(body=out)
+    except Exception as e:
+        raise Exception("unable to create access", e)
+    return model.Access(Token=res.frontend_token,
+                        ShareToken=request.ShareToken,
+                        BackendMode=res.backend_mode)
+
+
+def DeleteAccess(root: Root, acc: model.Access):
+    req = UnaccessRequest(frontend_token=acc.Token,
+                          share_token=acc.ShareToken,
+                          env_zid=root.env.ZitiIdentity)
+
+    try:
+        zrok = root.Client()
+    except Exception as e:
+        raise Exception("error getting zrok client", e)
+
+    try:
+        ShareApi(zrok).unaccess(body=req)
+    except Exception as e:
+        raise Exception("error deleting access", e)

zrok/decor.py

@@ -0,0 +1,33 @@
+from dataclasses import dataclass
+import openziti
+from zrok.environment.root import Root
+
+
+@dataclass
+class Opts:
+    root: Root
+    shrToken: str
+    bindPort: int
+    bindHost: str = ""
+
+
+class MonkeyPatch(openziti.monkeypatch):
+    def __init__(self, opts: {}, *args, **kwargs):
+        zif = opts['cfg'].root.ZitiIdentityNamed(opts['cfg'].root.EnvironmentIdentityName())
+        cfg = dict(ztx=openziti.load(zif), service=opts['cfg'].shrToken)
+        super(MonkeyPatch, self).__init__(bindings={(opts['cfg'].bindHost, opts['cfg'].bindPort): cfg}, *args, **kwargs)
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        super(MonkeyPatch, self).__exit__(exc_type, exc_val, exc_tb)
+
+
+def zrok(opts: {}, *zargs, **zkwargs):
+    def zrockify_func(func):
+        def zrockified(*args, **kwargs):
+            with MonkeyPatch(opts=opts, *zargs, **zkwargs):
+                func(*args, **kwargs)
+        return zrockified
+    return zrockify_func

zrok/dialer.py

@@ -0,0 +1,10 @@
+from zrok.environment.root import Root
+import openziti
+from socket import SOCK_STREAM
+
+
+def Dialer(shrToken: str, root: Root) -> openziti.zitisock.ZitiSocket:
+    openziti.load(root.ZitiIdentityNamed(root.EnvironmentIdentityName()))
+    client = openziti.socket(type=SOCK_STREAM)
+    client.connect((shrToken, 1))
+    return client

zrok/environment/__init__.py

@@ -0,0 +1 @@
+from . import dirs, root # noqa

zrok/environment/dirs.py

@@ -0,0 +1,32 @@
+from pathlib import Path
+import os
+
+
+def rootDir() -> str:
+    home = str(Path.home())
+    return os.path.join(home, ".zrok")
+
+
+def metadataFile() -> str:
+    zrd = rootDir()
+    return os.path.join(zrd, "metadata.json")
+
+
+def configFile() -> str:
+    zrd = rootDir()
+    return os.path.join(zrd, "config.json")
+
+
+def environmentFile() -> str:
+    zrd = rootDir()
+    return os.path.join(zrd, "environment.json")
+
+
+def identitiesDir() -> str:
+    zrd = rootDir()
+    return os.path.join(zrd, "identities")
+
+
+def identityFile(name: str) -> str:
+    idd = identitiesDir()
+    return os.path.join(idd, name + ".json")

zrok/environment/root.py

@@ -0,0 +1,182 @@
+from dataclasses import dataclass, field
+from typing import NamedTuple
+from .dirs import identityFile, rootDir, configFile, environmentFile, metadataFile
+import os
+import json
+import zrok_api as zrok
+from zrok_api.configuration import Configuration
+from zrok_api.models.client_version_check_request import ClientVersionCheckRequest
+
+V = "v1.0"
+
+
+@dataclass
+class Metadata:
+    V: str = ""
+    RootPath: str = ""
+
+
+@dataclass
+class Config:
+    ApiEndpoint: str = ""
+    DefaultFrontend: str = ""
+
+
+@dataclass
+class Environment:
+    Token: str = ""
+    ZitiIdentity: str = ""
+    ApiEndpoint: str = ""
+
+
+class ApiEndpoint(NamedTuple):
+    endpoint: str
+    frm: str
+
+
+@dataclass
+class Root:
+    meta: Metadata = field(default_factory=Metadata)
+    cfg: Config = field(default_factory=Config)
+    env: Environment = field(default_factory=Environment)
+
+    def HasConfig(self) -> bool:
+        return self.cfg != Config()
+
+    def Client(self) -> zrok.ApiClient:
+        apiEndpoint = self.ApiEndpoint()
+
+        cfg = Configuration()
+        cfg.host = apiEndpoint[0] + "/api/v2"
+
+        # Update: Configure authentication token
+        # The token needs to be set with 'key' instead of 'x-token'
+        # This matches the securityDefinitions in the OpenAPI spec
+        cfg.api_key["key"] = self.env.Token
+
+        # Create the API client with the configured authentication
+        auth_client = zrok.ApiClient(configuration=cfg)
+        self.client_version_check(auth_client)
+
+        return auth_client
+
+    def ApiEndpoint(self) -> ApiEndpoint:
+        apiEndpoint = "https://api-v2.zrok.io"
+        frm = "binary"
+
+        if self.cfg.ApiEndpoint != "":
+            apiEndpoint = self.cfg.ApiEndpoint
+            frm = "config"
+
+        env = os.getenv("ZROK_API_ENDPOINT")
+        if env != "":
+            apiEndpoint = env
+            frm = "ZROK_API_ENDPOINT"
+
+        if self.IsEnabled():
+            apiEndpoint = self.env.ApiEndpoint
+            frm = "env"
+
+        return ApiEndpoint(apiEndpoint.rstrip("/"), frm)
+
+    def IsEnabled(self) -> bool:
+        return self.env != Environment()
+
+    def PublicIdentityName(self) -> str:
+        return "public"
+
+    def EnvironmentIdentityName(self) -> str:
+        return "environment"
+
+    def ZitiIdentityNamed(self, name: str) -> str:
+        return identityFile(name)
+
+    def client_version_check(self, zrock_client):
+        """Check if the client version is compatible with the API."""
+        metadata_api = zrok.MetadataApi(zrock_client)
+        try:
+            # Perform version check using the client_version_check method
+            request = ClientVersionCheckRequest(client_version=V)
+            response = metadata_api.client_version_check_with_http_info(
+                body=request,
+            )
+
+            # Check if the response status code is 200 OK
+            if response.status_code != 200:
+                raise Exception(f"Client version check failed: Unexpected status code {response.status_code}")
+
+            # Success case - status code is 200 and empty response body is expected
+            return
+
+        except Exception as e:
+            raise Exception(f"Client version check failed: {str(e)}")
+
+
+def Default() -> Root:
+    r = Root()
+    root = rootDir()
+    r.meta = Metadata(V=V, RootPath=root)
+    return r
+
+
+def Assert() -> bool:
+    exists = __rootExists()
+    if exists:
+        meta = __loadMetadata()
+        return meta.V == V
+    return False
+
+
+def Load() -> Root:
+    r = Root()
+    if __rootExists():
+        r.meta = __loadMetadata()
+        r.cfg = __loadConfig()
+        r.env = __loadEnvironment()
+    else:
+        r = Default()
+    return r
+
+
+def __rootExists() -> bool:
+    mf = metadataFile()
+    return os.path.isfile(mf)
+
+
+def __assertMetadata():
+    pass
+
+
+def __loadMetadata() -> Metadata:
+    mf = metadataFile()
+    with open(mf) as f:
+        data = json.load(f)
+        return Metadata(V=data["v"])
+
+
+def __loadConfig() -> Config:
+    cf = configFile()
+    try:
+        with open(cf) as f:
+            data = json.load(f)
+            return Config(
+                ApiEndpoint=data.get("api_endpoint", ""),
+                DefaultFrontend=data.get("default_frontend", "")
+            )
+    except (FileNotFoundError, json.JSONDecodeError):
+        return Config(ApiEndpoint="", DefaultFrontend="")
+
+
+def isEnabled() -> bool:
+    ef = environmentFile()
+    return os.path.isfile(ef)
+
+
+def __loadEnvironment() -> Environment:
+    ef = environmentFile()
+    with open(ef) as f:
+        data = json.load(f)
+        return Environment(
+            Token=data["zrok_token"],
+            ZitiIdentity=data["ziti_identity"],
+            ApiEndpoint=data["api_endpoint"])

zrok/listener.py

@@ -0,0 +1,29 @@
+import openziti
+from zrok.environment.root import Root
+
+
+class Listener():
+    shrToken: str
+    root: Root
+    __server: openziti.zitisock.ZitiSocket
+
+    def __init__(self, shrToken: str, root: Root):
+        self.shrToken = shrToken
+        self.root = root
+        ztx = openziti.load(
+            self.root.ZitiIdentityNamed(
+                self.root.EnvironmentIdentityName()))
+        self.__server = ztx.bind(self.shrToken)
+
+    def __enter__(self) -> openziti.zitisock.ZitiSocket:
+        self.listen()
+        return self.__server
+
+    def __exit__(self, exception_type, exception_value, exception_traceback):
+        self.close()
+
+    def listen(self):
+        self.__server.listen()
+
+    def close(self):
+        self.__server.close()