aixand-lib-filesystem 0.1.0b0__tar.gz

aixand_lib_filesystem-0.1.0b0/.python-version

@@ -0,0 +1 @@
+3.11

aixand_lib_filesystem-0.1.0b0/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.

aixand_lib_filesystem-0.1.0b0/MANIFEST.in

@@ -0,0 +1,6 @@
+include dev.py dev.sh dev.ps1 development.toml requirements-dev.lock .python-version
+recursive-include docs *
+recursive-include tests *
+recursive-include examples *
+global-exclude __pycache__ *.py[cod]
+include development-constraints.txt

aixand_lib_filesystem-0.1.0b0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: aixand-lib-filesystem
+Version: 0.1.0b0
+Summary: Standalone file locks, private permissions, and Windows pinned-path access
+License-Expression: Apache-2.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Filesystem primitives
+
+Independently installable Python 3.11+ library: `aixand-lib-filesystem`, import
+`aixand_filesystem`. No runtime dependencies, services, network,
+process management, or repository-layout assumptions.
+
+It owns shared file locks, private file/directory permissions, and Windows pinned
+paths. Applications and other libraries can import its public API directly.
+
+## File locks
+
+```python
+from aixand_filesystem import file_lock, lock_file, unlock_file
+
+with open("state.lock", "a+b") as stream:
+    with file_lock(stream):  # blocking=True by default
+        # Read, compare the observed revision, and publish a guarded update here.
+        pass
+
+with open("state.lock", "a+b") as stream:
+    lock_file(stream, blocking=False)  # Raises BlockingIOError on contention.
+    try:
+        pass
+    finally:
+        unlock_file(stream)
+```
+
+`lock_file(stream, blocking=False, shared=False)` acquires an exclusive lock.
+`shared=True` uses a shared POSIX lock; Windows retains the exclusive byte-zero
+protocol for both modes. Closing the stream
+or calling `unlock_file(stream)` releases it. `file_lock(stream, blocking=True)`
+releases in `finally` but leaves the caller-owned stream open. Locks are not
+reentrant and do not coordinate writes by processes ignoring the protocol.
+
+POSIX uses `fcntl.flock`. Windows initializes an empty file once, seeks to byte
+zero, and uses `msvcrt.LK_NBLCK` over one byte. Blocking acquisition retries
+contention every 50 ms instead of relying on LK_LOCK's finite retry period.
+Unexpected OS errors propagate; contention becomes `BlockingIOError`.
+
+Callers own lock-file placement, safe path opening, stream lifetime, permissions,
+store identifiers, and transaction boundaries. During adoption, retain existing
+lock files and range conventions: changing the filename or replacing its inode
+can allow old and new processes to write concurrently. Windows and POSIX use
+different native protocols; this is not a distributed/network-filesystem lock.
+
+## Windows pinned paths
+
+```python
+from aixand_filesystem import PinnedPath
+
+with PinnedPath(root, ["references", "guide.md"]) as selected:
+    data = selected.file.read()  # Original binary bytes.
+
+with PinnedPath(root, directory=True) as selected:
+    directory = selected.path
+    # Keep the context open while using the protected directory.
+```
+
+`root` is an existing caller-selected path; `parts` contains single relative path
+components. Every ancestor and the leaf are opened with OPEN_REPARSE_POINT,
+checked for reparse points, and held without FILE_SHARE_DELETE. Linked/junction
+paths are rejected and ancestors cannot be renamed/replaced while held. Directory
+handles close in reverse order; file descriptors own transferred leaf handles.
+Exceptions release retained handles. Drive, UNC, and long-path forms are supported;
+device namespace traversal and escaping components are rejected.
+
+This is a Windows read/traversal primitive, not a general secure-write API. It
+does not freeze file bytes, enforce private ACLs, or prevent allowed concurrent
+content writes. Callers still validate regular files, size limits, containment,
+content stability, and publication. Constructing/importing the API is safe on POSIX, where
+entering a pinned-path context raises `OSError(ENOTSUP)`.
+
+## Verification
+
+```sh
+python -m pip install -e .
+python -m unittest discover -s tests -v
+python -m pip wheel --no-deps .
+```
+
+Tests cover real-process lock contention/release, process termination, exception
+cleanup, Windows byte-zero/retry behavior using mocks, isolated import/use with
+site packages disabled, and Windows kernel tests for pinning, junction rejection,
+and handle cleanup. Real Windows tests are skipped outside Windows; Linux/mocked
+checks do not establish full Windows runtime qualification.
+
+## Private files and directories
+
+`private_directory(path)` creates/protects a directory and rejects a linked or
+junction leaf. `private_path(path)` protects an existing application-owned file
+or directory. POSIX uses modes 0600/0700; Windows uses a protected DACL granting
+the current account full access (with inheritance for path-based protection).
+`verify_private(path)` verifies private ownership/access, including Windows ACLs.
+`is_private(stat_result)` is a POSIX metadata check; on Windows it cannot validate
+ACLs and callers needing that guarantee must use `verify_private`.
+
+`secure_file(stream)` protects an already-open file by handle, avoiding a path
+reopen race if its parent is renamed. POSIX uses `fchmod(0600)`; Windows reopens
+the original OS handle to apply the current-account owner and protected DACL.
+These helpers do not provide a general safe path traversal or atomic write API;
+callers retain responsibility for path selection and publication.
+
+## Local developer commands
+
+Inside the aixand-libraries source checkout, run from this directory with
+Python 3.11+ and uv:
+
+```sh
+./dev.sh develop --local
+./dev.sh check
+./dev.sh test
+./dev.sh build
+```
+
+Use `.\dev.ps1` on Windows. Each package owns its development environment and
+helper. Commands run within this package. See the
+[development guide](docs/development.md) for wheel-based setup without sibling
+sources, lock updates, and build outputs.
+
+## Windows authentication storage
+
+`current_user_sid()` returns the current Windows account SID. Other systems
+raise `OSError(ENOTSUP)`. Import this function from `aixand_filesystem`.
+
+The `aixand_filesystem.auth_directory` module provides `create(path)`,
+`check(path)`, and `secure_file(path)` on Windows. Creation verifies existing
+directories without changing their permissions. File protection requires a
+regular file inside a verified private directory. Pinned paths reject links
+and junctions. This module's path function differs from the package's
+`secure_file(stream)` function, which protects an open file handle.
+
+After installing the package, run these commands in PowerShell. Replace the
+example path with your authentication directory:
+
+```powershell
+python -m aixand_filesystem.auth_directory create C:\Users\you\private-auth
+python -m aixand_filesystem.auth_directory check C:\Users\you\private-auth
+```
+
+`check` exits zero for a private directory. It reports an error for invalid
+permissions or links. These commands require Windows. Linux checks do not
+establish native Windows qualification.
+
+## Documentation and support
+
+See the [documentation index](docs/README.md) for usage, API reference, and runnable
+starter examples. Report ordinary problems through the integrating product's
+support channel or issue tracker. External contributions are not currently
+accepted due to limited maintainer capacity; see [reporting guidance](../docs/reporting.md).
+Report vulnerabilities [privately](../SECURITY.md).

aixand_lib_filesystem-0.1.0b0/README.md

@@ -0,0 +1,150 @@
+# Filesystem primitives
+
+Independently installable Python 3.11+ library: `aixand-lib-filesystem`, import
+`aixand_filesystem`. No runtime dependencies, services, network,
+process management, or repository-layout assumptions.
+
+It owns shared file locks, private file/directory permissions, and Windows pinned
+paths. Applications and other libraries can import its public API directly.
+
+## File locks
+
+```python
+from aixand_filesystem import file_lock, lock_file, unlock_file
+
+with open("state.lock", "a+b") as stream:
+    with file_lock(stream):  # blocking=True by default
+        # Read, compare the observed revision, and publish a guarded update here.
+        pass
+
+with open("state.lock", "a+b") as stream:
+    lock_file(stream, blocking=False)  # Raises BlockingIOError on contention.
+    try:
+        pass
+    finally:
+        unlock_file(stream)
+```
+
+`lock_file(stream, blocking=False, shared=False)` acquires an exclusive lock.
+`shared=True` uses a shared POSIX lock; Windows retains the exclusive byte-zero
+protocol for both modes. Closing the stream
+or calling `unlock_file(stream)` releases it. `file_lock(stream, blocking=True)`
+releases in `finally` but leaves the caller-owned stream open. Locks are not
+reentrant and do not coordinate writes by processes ignoring the protocol.
+
+POSIX uses `fcntl.flock`. Windows initializes an empty file once, seeks to byte
+zero, and uses `msvcrt.LK_NBLCK` over one byte. Blocking acquisition retries
+contention every 50 ms instead of relying on LK_LOCK's finite retry period.
+Unexpected OS errors propagate; contention becomes `BlockingIOError`.
+
+Callers own lock-file placement, safe path opening, stream lifetime, permissions,
+store identifiers, and transaction boundaries. During adoption, retain existing
+lock files and range conventions: changing the filename or replacing its inode
+can allow old and new processes to write concurrently. Windows and POSIX use
+different native protocols; this is not a distributed/network-filesystem lock.
+
+## Windows pinned paths
+
+```python
+from aixand_filesystem import PinnedPath
+
+with PinnedPath(root, ["references", "guide.md"]) as selected:
+    data = selected.file.read()  # Original binary bytes.
+
+with PinnedPath(root, directory=True) as selected:
+    directory = selected.path
+    # Keep the context open while using the protected directory.
+```
+
+`root` is an existing caller-selected path; `parts` contains single relative path
+components. Every ancestor and the leaf are opened with OPEN_REPARSE_POINT,
+checked for reparse points, and held without FILE_SHARE_DELETE. Linked/junction
+paths are rejected and ancestors cannot be renamed/replaced while held. Directory
+handles close in reverse order; file descriptors own transferred leaf handles.
+Exceptions release retained handles. Drive, UNC, and long-path forms are supported;
+device namespace traversal and escaping components are rejected.
+
+This is a Windows read/traversal primitive, not a general secure-write API. It
+does not freeze file bytes, enforce private ACLs, or prevent allowed concurrent
+content writes. Callers still validate regular files, size limits, containment,
+content stability, and publication. Constructing/importing the API is safe on POSIX, where
+entering a pinned-path context raises `OSError(ENOTSUP)`.
+
+## Verification
+
+```sh
+python -m pip install -e .
+python -m unittest discover -s tests -v
+python -m pip wheel --no-deps .
+```
+
+Tests cover real-process lock contention/release, process termination, exception
+cleanup, Windows byte-zero/retry behavior using mocks, isolated import/use with
+site packages disabled, and Windows kernel tests for pinning, junction rejection,
+and handle cleanup. Real Windows tests are skipped outside Windows; Linux/mocked
+checks do not establish full Windows runtime qualification.
+
+## Private files and directories
+
+`private_directory(path)` creates/protects a directory and rejects a linked or
+junction leaf. `private_path(path)` protects an existing application-owned file
+or directory. POSIX uses modes 0600/0700; Windows uses a protected DACL granting
+the current account full access (with inheritance for path-based protection).
+`verify_private(path)` verifies private ownership/access, including Windows ACLs.
+`is_private(stat_result)` is a POSIX metadata check; on Windows it cannot validate
+ACLs and callers needing that guarantee must use `verify_private`.
+
+`secure_file(stream)` protects an already-open file by handle, avoiding a path
+reopen race if its parent is renamed. POSIX uses `fchmod(0600)`; Windows reopens
+the original OS handle to apply the current-account owner and protected DACL.
+These helpers do not provide a general safe path traversal or atomic write API;
+callers retain responsibility for path selection and publication.
+
+## Local developer commands
+
+Inside the aixand-libraries source checkout, run from this directory with
+Python 3.11+ and uv:
+
+```sh
+./dev.sh develop --local
+./dev.sh check
+./dev.sh test
+./dev.sh build
+```
+
+Use `.\dev.ps1` on Windows. Each package owns its development environment and
+helper. Commands run within this package. See the
+[development guide](docs/development.md) for wheel-based setup without sibling
+sources, lock updates, and build outputs.
+
+## Windows authentication storage
+
+`current_user_sid()` returns the current Windows account SID. Other systems
+raise `OSError(ENOTSUP)`. Import this function from `aixand_filesystem`.
+
+The `aixand_filesystem.auth_directory` module provides `create(path)`,
+`check(path)`, and `secure_file(path)` on Windows. Creation verifies existing
+directories without changing their permissions. File protection requires a
+regular file inside a verified private directory. Pinned paths reject links
+and junctions. This module's path function differs from the package's
+`secure_file(stream)` function, which protects an open file handle.
+
+After installing the package, run these commands in PowerShell. Replace the
+example path with your authentication directory:
+
+```powershell
+python -m aixand_filesystem.auth_directory create C:\Users\you\private-auth
+python -m aixand_filesystem.auth_directory check C:\Users\you\private-auth
+```
+
+`check` exits zero for a private directory. It reports an error for invalid
+permissions or links. These commands require Windows. Linux checks do not
+establish native Windows qualification.
+
+## Documentation and support
+
+See the [documentation index](docs/README.md) for usage, API reference, and runnable
+starter examples. Report ordinary problems through the integrating product's
+support channel or issue tracker. External contributions are not currently
+accepted due to limited maintainer capacity; see [reporting guidance](../docs/reporting.md).
+Report vulnerabilities [privately](../SECURITY.md).

aixand_lib_filesystem-0.1.0b0/dev.ps1

@@ -0,0 +1,19 @@
+#requires -Version 5.1
+Set-StrictMode -Version Latest
+$ErrorActionPreference = 'Stop'
+$interpreter = $env:AIXAND_DEV_PYTHON
+$prefixArgs = @()
+if (-not $interpreter) {
+    if (Get-Command python -ErrorAction SilentlyContinue) { $interpreter = 'python' }
+    elseif (Get-Command py -ErrorAction SilentlyContinue) { $interpreter = 'py'; $prefixArgs = @('-3') }
+    else {
+        if ($args.Count -eq 0 -or $args[0] -in @('help', '--help', '-h')) {
+            Write-Output 'Commands: help doctor develop lock check test build'
+            exit 0
+        }
+        Write-Error 'This developer helper requires Python 3.11+. Set AIXAND_DEV_PYTHON to its executable.'
+        exit 2
+    }
+}
+& $interpreter @prefixArgs -B (Join-Path $PSScriptRoot 'dev.py') @args
+exit $LASTEXITCODE