jentic-openapi-common 1.0.0a15__tar.gz

jentic_openapi_common-1.0.0a15/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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,
+      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 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.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in 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.
+      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 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 consequential 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 any and 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 such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

jentic_openapi_common-1.0.0a15/NOTICE

@@ -0,0 +1,4 @@
+Jentic OpenAPI Tools
+Copyright (c) 2025 Jentic
+Jentic OpenAPI Tools is licensed under Apache 2.0 license.
+Copy of the Apache 2.0 license can be found in `LICENSE` file.

jentic_openapi_common-1.0.0a15/PKG-INFO

@@ -0,0 +1,224 @@
+Metadata-Version: 2.4
+Name: jentic-openapi-common
+Version: 1.0.0a15
+Summary: Jentic OpenAPI Common
+Author: Jentic
+Author-email: Jentic <hello@jentic.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/jentic/jentic-openapi-tools
+Description-Content-Type: text/markdown
+
+# jentic-openapi-common
+
+Common utilities for OpenAPI tools packages. This package provides shared functionality using PEP 420 namespace packages as contribution points.
+
+## Installation
+
+```bash
+uv add jentic-openapi-common
+```
+
+## Modules
+
+### uri
+
+URI/URL/path utilities for working with OpenAPI document references.
+
+**Available functions:**
+
+- `is_uri_like(s: str | None) -> bool` - Check if a string looks like a URI/URL/path
+- `is_http_https_url(s: str | None) -> bool` - Check if string is an HTTP(S) URL
+- `is_file_uri(s: str | None) -> bool` - Check if string is a file:// URI
+- `is_path(s: str | None) -> bool` - Check if string is a filesystem path (not a URL)
+- `resolve_to_absolute(uri: str, base_uri: str | None = None) -> str` - Resolve relative URIs to absolute
+
+**Exceptions:**
+
+- `URIResolutionError` - Raised when URI resolution fails
+
+### path_security
+
+Path security utilities for validating and securing filesystem access. Provides defense-in-depth protection against path traversal attacks, directory escapes, and unauthorized file access.
+
+**Available functions:**
+
+- `validate_path(path, *, allowed_base=None, allowed_extensions=None, resolve_symlinks=True, as_string=True) -> str | Path` - Validate and canonicalize a filesystem path with security checks. Returns `str` by default, or `Path` when `as_string=False`
+
+**Exceptions:**
+
+- `PathSecurityError` - Base exception for path security violations
+- `PathTraversalError` - Path attempts to escape allowed base directory
+- `InvalidExtensionError` - Path has disallowed file extension
+- `SymlinkSecurityError` - Path contains symlinks when not allowed or symlink escapes boundary
+
+### subproc
+
+Subprocess execution utilities with enhanced error handling and cross-platform support.
+
+## Usage Examples
+
+### URI Utilities
+
+```python
+from jentic.apitools.openapi.common.uri import (
+    is_uri_like,
+    is_http_https_url,
+    is_file_uri,
+    is_path,
+    resolve_to_absolute,
+    URIResolutionError,
+)
+
+# Check URI types
+is_uri_like("https://example.com/spec.yaml")  # True
+is_http_https_url("https://example.com/spec.yaml")  # True
+is_file_uri("file:///home/user/spec.yaml")  # True
+is_path("/home/user/spec.yaml")  # True
+is_path("https://example.com/spec.yaml")  # False
+
+# Resolve relative URIs
+absolute = resolve_to_absolute("../spec.yaml", "/home/user/project/docs/")
+# Returns: "/home/user/project/spec.yaml"
+
+absolute = resolve_to_absolute("spec.yaml")  # Resolves against current working directory
+```
+
+### Path Security
+
+```python
+from pathlib import Path
+from jentic.apitools.openapi.common.path_security import (
+    validate_path,
+    PathSecurityError,
+    PathTraversalError,
+    InvalidExtensionError,
+    SymlinkSecurityError,
+)
+
+# Basic validation - converts to absolute path (returns string by default)
+safe_path = validate_path("./specs/openapi.yaml")
+print(safe_path)  # '/current/working/dir/specs/openapi.yaml'
+print(type(safe_path))  # <class 'str'>
+
+# Request Path object with as_string=False
+safe_path_obj = validate_path("./specs/openapi.yaml", as_string=False)
+print(safe_path_obj)  # Path('/current/working/dir/specs/openapi.yaml')
+print(type(safe_path_obj))  # <class 'pathlib.Path'>
+
+# Return type control with as_string parameter
+# - as_string=True (default): Returns str - best for subprocess commands
+# - as_string=False: Returns Path - best for file operations with pathlib
+
+# Example: Using with subprocess commands (default string return)
+import subprocess
+doc_path = validate_path("./specs/openapi.yaml")
+subprocess.run(["cat", doc_path])  # Works directly, no str() conversion needed
+
+# Example: Using with pathlib operations (Path return)
+from pathlib import Path
+doc_path = validate_path("./specs/openapi.yaml", as_string=False)
+if doc_path.exists():
+    content = doc_path.read_text()  # Path methods available
+
+# Boundary enforcement - restrict access to specific directory
+try:
+    safe_path = validate_path(
+        "/var/app/data/spec.yaml",
+        allowed_base="/var/app",
+    )
+    print(f"Access granted: {safe_path}")
+except PathTraversalError as e:
+    print(f"Access denied: {e}")
+
+# Block directory traversal attacks
+try:
+    safe_path = validate_path(
+        "/var/app/../../../etc/passwd",
+        allowed_base="/var/app",
+    )
+except PathTraversalError:
+    print("Path traversal attack blocked!")
+
+# Extension validation - whitelist approach
+try:
+    safe_path = validate_path(
+        "spec.yaml",
+        allowed_extensions=(".yaml", ".yml", ".json"),
+    )
+    print(f"Valid extension: {safe_path}")
+except InvalidExtensionError:
+    print("Invalid file extension")
+
+# Combined security checks (recommended for web services)
+try:
+    safe_path = validate_path(
+        user_provided_path,
+        allowed_base="/var/app/uploads",
+        allowed_extensions=(".yaml", ".yml", ".json"),
+        resolve_symlinks=True,  # Default: resolve and check symlinks
+    )
+    # Safe to use safe_path for file operations
+    with open(safe_path) as f:
+        content = f.read()
+except PathSecurityError as e:
+    print(f"Security validation failed: {e}")
+```
+
+### Subprocess Execution
+
+#### Basic Command Execution
+
+```python
+from jentic.apitools.openapi.common.subproc import run_subprocess
+
+# Simple command
+result = run_subprocess(["echo", "hello"])
+print(result.stdout)  # "hello\n"
+print(result.returncode)  # 0
+
+# Command with working directory
+result = run_subprocess(["pwd"], cwd="/tmp")
+print(result.stdout.strip())  # "/tmp"
+```
+
+### Error Handling
+
+```python
+from jentic.apitools.openapi.common.subproc import (
+    run_subprocess,
+    SubprocessExecutionError
+)
+
+# Handle errors manually
+result = run_subprocess(["false"])  # Command that exits with code 1
+if result.returncode != 0:
+    print(f"Command failed with code {result.returncode}")
+
+# Automatic error handling
+try:
+    result = run_subprocess(["false"], fail_on_error=True)
+except SubprocessExecutionError as e:
+    print(f"Command {e.cmd} failed: {e}")
+```
+
+### Advanced Usage
+
+```python
+from jentic.apitools.openapi.common.subproc import (
+    run_subprocess,
+    SubprocessExecutionError
+)
+
+# Timeout handling
+try:
+    result = run_subprocess(["sleep", "10"], timeout=1)
+except SubprocessExecutionError as e:
+    print("Command timed out")
+
+# Custom encoding
+result = run_subprocess(["python", "-c", "print('ñ')"], encoding="utf-8")
+print(result.stdout)  # "ñ\n"
+```

jentic_openapi_common-1.0.0a15/README.md

@@ -0,0 +1,211 @@
+# jentic-openapi-common
+
+Common utilities for OpenAPI tools packages. This package provides shared functionality using PEP 420 namespace packages as contribution points.
+
+## Installation
+
+```bash
+uv add jentic-openapi-common
+```
+
+## Modules
+
+### uri
+
+URI/URL/path utilities for working with OpenAPI document references.
+
+**Available functions:**
+
+- `is_uri_like(s: str | None) -> bool` - Check if a string looks like a URI/URL/path
+- `is_http_https_url(s: str | None) -> bool` - Check if string is an HTTP(S) URL
+- `is_file_uri(s: str | None) -> bool` - Check if string is a file:// URI
+- `is_path(s: str | None) -> bool` - Check if string is a filesystem path (not a URL)
+- `resolve_to_absolute(uri: str, base_uri: str | None = None) -> str` - Resolve relative URIs to absolute
+
+**Exceptions:**
+
+- `URIResolutionError` - Raised when URI resolution fails
+
+### path_security
+
+Path security utilities for validating and securing filesystem access. Provides defense-in-depth protection against path traversal attacks, directory escapes, and unauthorized file access.
+
+**Available functions:**
+
+- `validate_path(path, *, allowed_base=None, allowed_extensions=None, resolve_symlinks=True, as_string=True) -> str | Path` - Validate and canonicalize a filesystem path with security checks. Returns `str` by default, or `Path` when `as_string=False`
+
+**Exceptions:**
+
+- `PathSecurityError` - Base exception for path security violations
+- `PathTraversalError` - Path attempts to escape allowed base directory
+- `InvalidExtensionError` - Path has disallowed file extension
+- `SymlinkSecurityError` - Path contains symlinks when not allowed or symlink escapes boundary
+
+### subproc
+
+Subprocess execution utilities with enhanced error handling and cross-platform support.
+
+## Usage Examples
+
+### URI Utilities
+
+```python
+from jentic.apitools.openapi.common.uri import (
+    is_uri_like,
+    is_http_https_url,
+    is_file_uri,
+    is_path,
+    resolve_to_absolute,
+    URIResolutionError,
+)
+
+# Check URI types
+is_uri_like("https://example.com/spec.yaml")  # True
+is_http_https_url("https://example.com/spec.yaml")  # True
+is_file_uri("file:///home/user/spec.yaml")  # True
+is_path("/home/user/spec.yaml")  # True
+is_path("https://example.com/spec.yaml")  # False
+
+# Resolve relative URIs
+absolute = resolve_to_absolute("../spec.yaml", "/home/user/project/docs/")
+# Returns: "/home/user/project/spec.yaml"
+
+absolute = resolve_to_absolute("spec.yaml")  # Resolves against current working directory
+```
+
+### Path Security
+
+```python
+from pathlib import Path
+from jentic.apitools.openapi.common.path_security import (
+    validate_path,
+    PathSecurityError,
+    PathTraversalError,
+    InvalidExtensionError,
+    SymlinkSecurityError,
+)
+
+# Basic validation - converts to absolute path (returns string by default)
+safe_path = validate_path("./specs/openapi.yaml")
+print(safe_path)  # '/current/working/dir/specs/openapi.yaml'
+print(type(safe_path))  # <class 'str'>
+
+# Request Path object with as_string=False
+safe_path_obj = validate_path("./specs/openapi.yaml", as_string=False)
+print(safe_path_obj)  # Path('/current/working/dir/specs/openapi.yaml')
+print(type(safe_path_obj))  # <class 'pathlib.Path'>
+
+# Return type control with as_string parameter
+# - as_string=True (default): Returns str - best for subprocess commands
+# - as_string=False: Returns Path - best for file operations with pathlib
+
+# Example: Using with subprocess commands (default string return)
+import subprocess
+doc_path = validate_path("./specs/openapi.yaml")
+subprocess.run(["cat", doc_path])  # Works directly, no str() conversion needed
+
+# Example: Using with pathlib operations (Path return)
+from pathlib import Path
+doc_path = validate_path("./specs/openapi.yaml", as_string=False)
+if doc_path.exists():
+    content = doc_path.read_text()  # Path methods available
+
+# Boundary enforcement - restrict access to specific directory
+try:
+    safe_path = validate_path(
+        "/var/app/data/spec.yaml",
+        allowed_base="/var/app",
+    )
+    print(f"Access granted: {safe_path}")
+except PathTraversalError as e:
+    print(f"Access denied: {e}")
+
+# Block directory traversal attacks
+try:
+    safe_path = validate_path(
+        "/var/app/../../../etc/passwd",
+        allowed_base="/var/app",
+    )
+except PathTraversalError:
+    print("Path traversal attack blocked!")
+
+# Extension validation - whitelist approach
+try:
+    safe_path = validate_path(
+        "spec.yaml",
+        allowed_extensions=(".yaml", ".yml", ".json"),
+    )
+    print(f"Valid extension: {safe_path}")
+except InvalidExtensionError:
+    print("Invalid file extension")
+
+# Combined security checks (recommended for web services)
+try:
+    safe_path = validate_path(
+        user_provided_path,
+        allowed_base="/var/app/uploads",
+        allowed_extensions=(".yaml", ".yml", ".json"),
+        resolve_symlinks=True,  # Default: resolve and check symlinks
+    )
+    # Safe to use safe_path for file operations
+    with open(safe_path) as f:
+        content = f.read()
+except PathSecurityError as e:
+    print(f"Security validation failed: {e}")
+```
+
+### Subprocess Execution
+
+#### Basic Command Execution
+
+```python
+from jentic.apitools.openapi.common.subproc import run_subprocess
+
+# Simple command
+result = run_subprocess(["echo", "hello"])
+print(result.stdout)  # "hello\n"
+print(result.returncode)  # 0
+
+# Command with working directory
+result = run_subprocess(["pwd"], cwd="/tmp")
+print(result.stdout.strip())  # "/tmp"
+```
+
+### Error Handling
+
+```python
+from jentic.apitools.openapi.common.subproc import (
+    run_subprocess,
+    SubprocessExecutionError
+)
+
+# Handle errors manually
+result = run_subprocess(["false"])  # Command that exits with code 1
+if result.returncode != 0:
+    print(f"Command failed with code {result.returncode}")
+
+# Automatic error handling
+try:
+    result = run_subprocess(["false"], fail_on_error=True)
+except SubprocessExecutionError as e:
+    print(f"Command {e.cmd} failed: {e}")
+```
+
+### Advanced Usage
+
+```python
+from jentic.apitools.openapi.common.subproc import (
+    run_subprocess,
+    SubprocessExecutionError
+)
+
+# Timeout handling
+try:
+    result = run_subprocess(["sleep", "10"], timeout=1)
+except SubprocessExecutionError as e:
+    print("Command timed out")
+
+# Custom encoding
+result = run_subprocess(["python", "-c", "print('ñ')"], encoding="utf-8")
+print(result.stdout)  # "ñ\n"
+```

jentic_openapi_common-1.0.0a15/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "jentic-openapi-common"
+version = "1.0.0-alpha.15"
+description = "Jentic OpenAPI Common"
+readme = "README.md"
+authors = [{ name = "Jentic", email = "hello@jentic.com" }]
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+requires-python = ">=3.11"
+dependencies = []
+
+[tool.uv]
+package = true
+
+[tool.uv.build-backend]
+namespace = true
+module-name = "jentic.apitools.openapi.common"
+module-root = "src/"
+
+[project.urls]
+Homepage = "https://github.com/jentic/jentic-openapi-tools"
+
+[build-system]
+requires = ["uv_build~=0.8.15"]
+build-backend = "uv_build"
+
+

jentic_openapi_common-1.0.0a15/src/jentic/apitools/openapi/common/path_security.py

@@ -0,0 +1,176 @@
+"""Path security utilities for safe filesystem access."""
+
+from pathlib import Path
+from typing import Literal, overload
+
+
+__all__ = [
+    "PathSecurityError",
+    "PathTraversalError",
+    "InvalidExtensionError",
+    "SymlinkSecurityError",
+    "validate_path",
+]
+
+
+class PathSecurityError(Exception):
+    """Base exception for path security violations."""
+
+    pass
+
+
+class PathTraversalError(PathSecurityError):
+    """Raised when a path attempts to escape the allowed base directory."""
+
+    pass
+
+
+class InvalidExtensionError(PathSecurityError):
+    """Raised when a file has a disallowed extension."""
+
+    pass
+
+
+class SymlinkSecurityError(PathSecurityError):
+    """Raised when a path contains symlinks when not allowed or symlink escapes boundary."""
+
+    pass
+
+
+@overload
+def validate_path(
+    path: str | Path,
+    *,
+    allowed_base: str | Path | None = None,
+    allowed_extensions: tuple[str, ...] | None = None,
+    resolve_symlinks: bool = True,
+    as_string: Literal[True] = True,
+) -> str: ...
+
+
+@overload
+def validate_path(
+    path: str | Path,
+    *,
+    allowed_base: str | Path | None = None,
+    allowed_extensions: tuple[str, ...] | None = None,
+    resolve_symlinks: bool = True,
+    as_string: Literal[False],
+) -> Path: ...
+
+
+def validate_path(
+    path: str | Path,
+    *,
+    allowed_base: str | Path | None = None,
+    allowed_extensions: tuple[str, ...] | None = None,
+    resolve_symlinks: bool = True,
+    as_string: bool = True,
+) -> str | Path:
+    """
+    Validate and canonicalize a filesystem path with security checks.
+
+    This function provides defense-in-depth security for filesystem access by:
+    1. Converting to absolute path and resolving `.` and `..` components
+    2. Optionally resolving symlinks and checking they don't escape boundaries
+    3. Enforcing boundary restrictions (path must be within allowed_base)
+    4. Validating file extensions against a whitelist
+
+    Args:
+        path: The filesystem path to validate (string or Path object)
+        allowed_base: Optional base directory that path must be within.
+            If None, no boundary checking is performed.
+        allowed_extensions: Optional tuple of allowed file extensions (e.g., ('.yaml', '.json')).
+            Extensions are case-sensitive. If None, no extension checking is performed.
+        resolve_symlinks: If True (default), resolve symlinks using Path.resolve().
+            If False, use Path.absolute() to preserve symlinks.
+        as_string: If True (default), return str. If False, return Path object.
+
+    Returns:
+        Canonicalized path (str by default, or Path if as_string=False) that has passed all security checks.
+
+    Raises:
+        PathTraversalError: If the path attempts to escape the allowed_base directory
+        InvalidExtensionError: If the file extension is not in allowed_extensions
+        SymlinkSecurityError: If symlink resolution reveals a security issue
+
+    Examples:
+        >>> # Basic validation with boundary enforcement (returns str by default)
+        >>> validate_path("/var/app/data/file.yaml", allowed_base="/var/app")
+        '/var/app/data/file.yaml'
+
+        >>> # Return Path object when needed
+        >>> validate_path("/var/app/data/file.yaml", allowed_base="/var/app", as_string=False)
+        Path('/var/app/data/file.yaml')
+
+        >>> # Prevent directory traversal
+        >>> validate_path("/var/app/../etc/passwd", allowed_base="/var/app")
+        PathTraversalError: Path '/etc/passwd' is outside allowed base '/var/app'
+
+        >>> # Extension validation
+        >>> validate_path("file.txt", allowed_extensions=('.yaml', '.json'))
+        InvalidExtensionError: Path 'file.txt' has disallowed extension '.txt'
+    """
+    if not path:
+        raise PathSecurityError("Path cannot be empty or None")
+
+    # Convert to Path object
+    path_obj = Path(path)
+
+    # Canonicalize path (resolve . and ..)
+    if resolve_symlinks:
+        # Fully resolve including symlinks
+        try:
+            canonical_path = path_obj.resolve(strict=False)
+        except (OSError, RuntimeError) as e:
+            raise PathSecurityError(f"Failed to resolve path '{path}': {e}") from e
+    else:
+        # Convert to absolute but preserve symlinks
+        canonical_path = path_obj.absolute()
+
+    # Boundary enforcement
+    if allowed_base is not None:
+        allowed_base_path = Path(allowed_base)
+        if resolve_symlinks:
+            try:
+                canonical_base = allowed_base_path.resolve(strict=False)
+            except (OSError, RuntimeError) as e:
+                raise PathSecurityError(
+                    f"Failed to resolve allowed_base '{allowed_base}': {e}"
+                ) from e
+        else:
+            canonical_base = allowed_base_path.absolute()
+
+        # Check if canonical_path is within canonical_base
+        try:
+            canonical_path.relative_to(canonical_base)
+        except ValueError:
+            raise PathTraversalError(
+                f"Path '{canonical_path}' is outside allowed base '{canonical_base}'"
+            ) from None
+
+        # Additional check: if resolve_symlinks is True, verify that no symlink in the path
+        # escapes the boundary. This is already handled by resolve() above, but we add
+        # an explicit check for symlinks that might have been followed
+        if resolve_symlinks and path_obj.is_symlink():
+            # If the original path was a symlink, verify the resolved target is still in bounds
+            try:
+                canonical_path.relative_to(canonical_base)
+            except ValueError:
+                raise SymlinkSecurityError(
+                    f"Symlink '{path}' resolves to '{canonical_path}' which is outside allowed base '{canonical_base}'"
+                ) from None
+
+    # Extension validation
+    if allowed_extensions is not None:
+        if not canonical_path.suffix:
+            raise InvalidExtensionError(
+                f"Path '{canonical_path}' has no file extension. Allowed extensions: {allowed_extensions}"
+            )
+        if canonical_path.suffix not in allowed_extensions:
+            raise InvalidExtensionError(
+                f"Path '{canonical_path}' has disallowed extension '{canonical_path.suffix}'. "
+                f"Allowed extensions: {allowed_extensions}"
+            )
+
+    return str(canonical_path) if as_string else canonical_path

jentic_openapi_common-1.0.0a15/src/jentic/apitools/openapi/common/subproc.py

@@ -0,0 +1,114 @@
+"""Subprocess execution utilities for OpenAPI tools."""
+
+import subprocess
+from collections.abc import Sequence
+from dataclasses import dataclass
+
+
+__all__ = ["run_subprocess", "SubprocessExecutionResult", "SubprocessExecutionError"]
+
+
+@dataclass
+class SubprocessExecutionResult:
+    """Returned by a subprocess."""
+
+    returncode: int
+    stdout: str = ""
+    stderr: str = ""
+
+    def __init__(
+        self,
+        returncode: int,
+        stdout: str | None = None,
+        stderr: str | None = None,
+    ):
+        self.returncode = returncode
+        self.stdout = stdout if isinstance(stdout, str) else ""
+        self.stderr = stderr if isinstance(stderr, str) else ""
+
+
+class SubprocessExecutionError(RuntimeError):
+    """Raised when a subprocess exits with non-zero return code."""
+
+    def __init__(
+        self,
+        cmd: Sequence[str],
+        returncode: int,
+        stdout: str | None = None,
+        stderr: str | None = None,
+    ):
+        self.cmd = list(cmd)
+        self.returncode = returncode
+        self.stdout = stdout if isinstance(stdout, str) else ""
+        self.stderr = stderr if isinstance(stderr, str) else ""
+        message = (
+            f"Command {self.cmd!r} failed with exit code {self.returncode}\n"
+            f"--- stdout ---\n{self.stdout}\n"
+            f"--- stderr ---\n{self.stderr}"
+        )
+        super().__init__(message)
+
+
+def run_subprocess(
+    cmd: Sequence[str],
+    *,
+    fail_on_error: bool = False,
+    timeout: float | None = None,
+    encoding: str = "utf-8",
+    errors: str = "strict",
+    cwd: str | None = None,
+) -> SubprocessExecutionResult:
+    """
+    Run a subprocess command and return (stdout, stderr) as text.
+    Raises SubprocessExecutionError if the command fails.
+
+    Parameters
+    ----------
+    cmd : sequence of str
+        The command and its arguments.
+    fail_on_error : bool
+        If True, raises SubprocessExecutionError for non-zero return codes.
+    timeout : float | None
+        Seconds before timing out.
+    encoding : str
+        Passed to subprocess.run so stdout/stderr are decoded as text.
+    errors : str
+        Error handler for text decoding.
+    cwd : str | None
+        Working directory for the subprocess.
+
+    Returns
+    -------
+    (stdout, stderr, returncode): SubprocessExecutionResult
+    """
+    try:
+        completed_process = subprocess.run(
+            cmd,
+            check=False,
+            capture_output=True,
+            text=True,
+            shell=False,
+            encoding=encoding,  # ensure the CompletedProcess has stdout/stderr
+            errors=errors,
+            timeout=timeout,
+            cwd=cwd,
+        )
+    except subprocess.TimeoutExpired as e:
+        stdout = e.stdout.decode(encoding, errors) if isinstance(e.stdout, bytes) else e.stdout
+        stderr = e.stderr.decode(encoding, errors) if isinstance(e.stderr, bytes) else e.stderr
+        raise SubprocessExecutionError(cmd, -1, stdout, stderr) from e
+    except OSError as e:  # e.g., executable not found, permission denied
+        raise SubprocessExecutionError(cmd, -1, None, str(e)) from e
+
+    if completed_process.returncode != 0 and fail_on_error:
+        raise SubprocessExecutionError(
+            cmd,
+            completed_process.returncode,
+            completed_process.stdout,
+            completed_process.stderr,
+        )
+
+    # At this point CompletedProcess stdout/stderr are str due to text=True + encoding
+    return SubprocessExecutionResult(
+        completed_process.returncode, completed_process.stdout, completed_process.stderr
+    )

jentic_openapi_common-1.0.0a15/src/jentic/apitools/openapi/common/uri.py

@@ -0,0 +1,341 @@
+import os
+import re
+from pathlib import Path
+from urllib.parse import urljoin, urlparse, urlsplit, urlunsplit
+from urllib.request import url2pathname
+
+
+__all__ = [
+    "URIResolutionError",
+    "is_uri_like",
+    "is_http_https_url",
+    "is_file_uri",
+    "is_scheme_relative_uri",
+    "is_absolute_uri",
+    "is_fragment_only_uri",
+    "is_path",
+    "resolve_to_absolute",
+    "file_uri_to_path",
+]
+
+
+_WINDOWS_DRIVE_RE = re.compile(r"^[A-Za-z]:[\\/]")
+_WINDOWS_UNC_RE = re.compile(r"^(?:\\\\|//)[^\\/]+[\\/][^\\/]+")
+
+# Matches:
+# - http://... or https://...
+# - file://...
+# - POSIX absolute: /path or just "/"
+# - Windows UNC: \\server\share\...
+# - Windows root-relative: \path\to (current drive root)
+# - Windows drive-absolute: C:\path\to or C:/path/to
+# - Relative paths: ./path, ../path, .\path, ..\path, or plain relative paths
+_URI_LIKE_RE = re.compile(
+    r"""^(?:
+            https?://[^\r\n]+ |
+            file://[^\r\n]+   |
+            /[^\r\n]*         |
+            \\\\[^\r\n]+      |
+            \\[^\r\n]+        |
+            [A-Za-z]:\\[^\r\n]+ |
+            [A-Za-z]:/[^\r\n]+ |
+            \./[^\r\n]*       |
+            \.\\/[^\r\n]*     |
+            \.\.[/\\][^\r\n]* |
+            \.\.\\[^\r\n]*    |
+            [a-zA-Z_][a-zA-Z0-9_.-]*(?:[/\\][a-zA-Z0-9_.-]+)+ |
+            [a-zA-Z_][a-zA-Z0-9_.-]*\.[a-zA-Z0-9]+(?![}\])])
+        )$""",
+    re.VERBOSE,
+)
+
+
+class URIResolutionError(ValueError):
+    pass
+
+
+def is_uri_like(uri: str | None) -> bool:
+    r"""
+    Heuristic check: is `s` a URI-like reference or absolute/relative path?
+    - Accepts http(s)://, file://
+    - Accepts absolute POSIX (/...) and Windows (\\..., \..., C:\..., C:/...) paths
+    - Accepts relative paths (./..., ../..., .\..., ..\...)
+    - Must be a single line (no '\\n' or '\\r').
+    Leading/trailing whitespace is ignored.
+    """
+    if not uri:
+        return False
+    uri = uri.strip()
+    # Enforce single line
+    if "\n" in uri or "\r" in uri:
+        return False
+    return bool(_URI_LIKE_RE.match(uri))
+
+
+def is_path(s: str | None) -> bool:
+    """
+    Check if `s` is a filesystem path (not a URL or URI).
+
+    Returns True for:
+    - Absolute POSIX paths: /home/file.txt
+    - Absolute Windows paths: C:\\Windows\\file.txt, \\\\server\\share\\path
+    - Relative paths: ./config.yaml, ../parent/file.txt
+
+    Returns False for:
+    - HTTP(S) URLs: http://example.com
+    - File URIs: file:///home/file.txt
+    - Other URIs: mailto:test@example.com, data:text/plain, ftp://ftp.example.com
+    - Empty or None strings
+    """
+    if not s:
+        return False
+
+    s = s.strip()
+
+    # Must match the URI-like pattern first
+    if not is_uri_like(s):
+        return False
+
+    # Exclude HTTP(S) URLs
+    if is_http_https_url(s):
+        return False
+
+    # Exclude file:// URIs
+    if is_file_uri(s):
+        return False
+
+    # Exclude any other URI schemes (mailto:, data:, ftp:, etc.)
+    parsed = urlparse(s)
+    if parsed.scheme:  # Has a scheme
+        return False
+
+    # It's a path!
+    return True
+
+
+def is_http_https_url(url: str) -> bool:
+    p = urlparse(url)
+    return p.scheme in ("http", "https") and bool(p.netloc)
+
+
+def is_file_uri(uri: str) -> bool:
+    return urlparse(uri).scheme == "file"
+
+
+def is_scheme_relative_uri(uri: str) -> bool:
+    """
+    Check if `uri` is a scheme-relative URI (also called protocol-relative URI).
+
+    A scheme-relative URI starts with "//" followed by an authority component (netloc),
+    inheriting the scheme from the context (e.g., "//cdn.example.com/path").
+
+    This is defined in RFC 3986 section 4.2 as a network-path reference.
+    Per RFC 3986, a valid network-path reference must have an authority component.
+
+    Examples:
+        - "//cdn.example.com/x.yaml" -> True
+        - "//example.com/api" -> True
+        - "http://example.com" -> False (has scheme)
+        - "/path/to/file" -> False (single slash)
+        - "./relative" -> False (relative path)
+        - "//" -> False (no authority component)
+        - "///path" -> False (no authority component)
+
+    Args:
+        uri: The string to check
+
+    Returns:
+        True if the string is a valid scheme-relative URI with authority, False otherwise
+    """
+    if not uri.startswith("//"):
+        return False
+    p = urlparse(uri)
+    return bool(p.netloc)
+
+
+def is_absolute_uri(uri: str) -> bool:
+    """
+    Check if `uri` is an absolute URI according to RFC 3986.
+
+    An absolute URI is defined as having a scheme (e.g., "http:", "https:", "ftp:", "file:").
+
+    Note: Scheme-relative URIs (starting with "//") are NOT considered absolute URIs.
+    According to RFC 3986 section 4.2, scheme-relative URIs are classified as
+    "relative references" (specifically, "network-path references").
+    Use `is_scheme_relative_uri()` to check for those separately.
+
+    Examples:
+        - "http://example.com" -> True
+        - "https://example.com/path" -> True
+        - "ftp://ftp.example.com" -> True
+        - "file:///path/to/file" -> True
+        - "//cdn.example.com/x.yaml" -> False (scheme-relative, use is_scheme_relative_uri)
+        - "/path/to/file" -> False (absolute path, not URI)
+        - "./relative" -> False
+        - "#fragment" -> False
+
+    Args:
+        uri: The string to check
+
+    Returns:
+        True if the string is an absolute URI (has a scheme), False otherwise
+    """
+    p = urlparse(uri)
+    return bool(p.scheme)
+
+
+def is_fragment_only_uri(uri: str) -> bool:
+    """
+    Check if `uri` is a fragment-only reference.
+
+    A fragment-only reference consists solely of a fragment identifier (starts with "#").
+    These are used in JSON References and OpenAPI to refer to parts within the same document.
+
+    Note: This checks if the ENTIRE string is a fragment reference, not whether
+    a URI contains a fragment. For example, "http://example.com#section" would
+    return False because it's a full URI with a fragment, not fragment-only.
+
+    Examples:
+        - "#/definitions/User" -> True
+        - "#fragment" -> True
+        - "#" -> True (empty fragment identifier)
+        - "##" -> True (fragment identifier is "#")
+        - "http://example.com#section" -> False (full URI with fragment)
+        - "/path/to/file" -> False
+        - "./relative" -> False
+        - "" -> False
+
+    Args:
+        uri: The string to check
+
+    Returns:
+        True if the string is a fragment-only reference, False otherwise
+    """
+    return uri.startswith("#")
+
+
+def resolve_to_absolute(value: str, base_uri: str | None = None) -> str:
+    """
+    Resolve `value` to either:
+      - an absolute URL (with scheme), OR
+      - an absolute filesystem path (no scheme)
+
+    • If `base_uri` is None AND `value` has no scheme (i.e., relative URI or path),
+    return an **absolute filesystem path** resolved against CWD.
+
+    Other rules:
+      • Absolute http(s) URLs ⇒ return absolute URL.
+      • file:// URIs ⇒ return absolute filesystem path.
+      • If `base_uri` is an http(s) URL, relative inputs resolve to absolute URLs.
+      • If `base_uri` is a path or file://, relative inputs resolve to absolute paths.
+      • Mixing a path-like `value` with an http(s) `base_uri` raises (ambiguous).
+      • Scheme-relative (“//host/path”) without a URL base ⇒ raises.
+    """
+    _guard_single_line(value)
+
+    if is_http_https_url(value):
+        return _normalize_url(value)
+
+    if is_file_uri(value):
+        return file_uri_to_path(value)
+
+    if _looks_like_windows_path(value):
+        return _resolve_path_like(value, base_uri)
+
+    parsed = urlparse(value)
+    # Scheme-relative without URL base is ambiguous
+    if value.startswith("//"):
+        if base_uri and is_http_https_url(base_uri):
+            return _normalize_url(urljoin(base_uri, value))
+        raise URIResolutionError("Scheme-relative URLs require a URL base_uri.")
+
+    # Any other explicit scheme (mailto:, data:, ftp:, etc.) → accept as-is
+    if parsed.scheme:
+        if parsed.scheme in ("http", "https"):
+            if not parsed.netloc:
+                raise URIResolutionError(f"Malformed URL (missing host): {value!r}")
+            return _normalize_url(value)
+        if parsed.scheme == "file":
+            # handled above
+            raise AssertionError("unreachable")
+        return value  # leave non-file, non-http schemes untouched
+
+    # --- No scheme: relative URI or path ---
+    if base_uri:
+        if is_http_https_url(base_uri):
+            # Relative URI against URL base → absolute URL
+            return _normalize_url(urljoin(base_uri, value))
+        # base is file path or file:// → absolute path
+        return _resolve_path_like(value, base_uri)
+
+    # **Your rule**: no base + no scheme ⇒ absolute filesystem path
+    return _resolve_path_like(value, None)
+
+
+def file_uri_to_path(file_uri: str) -> str:
+    """
+    Convert a file:// URI to an absolute filesystem path.
+
+    Args:
+        file_uri: A file:// URI string (e.g., "file:///path/to/file" or "file://server/share/path")
+
+    Returns:
+        Absolute filesystem path as a string
+
+    Raises:
+        URIResolutionError: If the input is not a valid file:// URI
+
+    Examples:
+        >>> file_uri_to_path("file:///home/user/doc.yaml")
+        '/home/user/doc.yaml'
+        >>> file_uri_to_path("file://localhost/etc/config.yaml")
+        '/etc/config.yaml'
+    """
+    parsed_uri = urlparse(file_uri)
+    if parsed_uri.scheme != "file":
+        raise URIResolutionError(f"Not a file URI: {file_uri!r}")
+    if parsed_uri.netloc and parsed_uri.netloc not in ("", "localhost"):
+        # UNC: \\server\share\path
+        unc = f"//{parsed_uri.netloc}{parsed_uri.path}"
+        return str(Path(url2pathname(unc)).resolve())
+    path = url2pathname(parsed_uri.path)
+    return str(Path(path).resolve())
+
+
+def _guard_single_line(s: str) -> None:
+    if not isinstance(s, str) or ("\n" in s or "\r" in s):
+        raise URIResolutionError("Input must be a single-line string.")
+
+
+def _looks_like_windows_path(s: str) -> bool:
+    return bool(_WINDOWS_DRIVE_RE.match(s) or _WINDOWS_UNC_RE.match(s))
+
+
+def _normalize_url(s: str) -> str:
+    import posixpath
+
+    parts = urlsplit(s)
+    # Normalize the path component using posixpath (URLs always use forward slashes)
+    normalized_path = posixpath.normpath(parts.path) if parts.path else "/"
+    # Ensure root path is "/"
+    if normalized_path == ".":
+        normalized_path = "/"
+    return urlunsplit((parts.scheme, parts.netloc, normalized_path, parts.query, parts.fragment))
+
+
+def _resolve_path_like(value: str, base_uri: str | None) -> str:
+    value = os.path.expandvars(os.path.expanduser(value))
+
+    if base_uri:
+        if is_file_uri(base_uri):
+            base_path = Path(url2pathname(urlparse(base_uri).path))
+        elif is_http_https_url(base_uri):
+            # Don't silently combine a local path with a URL base
+            raise URIResolutionError("Cannot resolve a local path against an HTTP(S) base_uri.")
+        else:
+            base_path = Path(os.path.expandvars(os.path.expanduser(base_uri)))
+    else:
+        base_path = Path.cwd()
+
+    p = Path(value)
+    return str(p.resolve() if p.is_absolute() else (base_path / p).resolve())