Add guided native Steam Frame VR installer and repair workflow

This commit is contained in:
ClassicWasTaken committed 2026-10-05 14:15:51 -07:00
commit 231c29084e
80 files changed
+10325

No files matched your search

+7
View File
@@ -0,0 +1,7 @@
* text=auto
*.sh text eol=lf
*.patch text eol=lf -whitespace
*.py text eol=lf
*.yml text eol=lf
resources/licenses/** -text -whitespace
*.tar.gz binary
+54
View File
@@ -0,0 +1,54 @@
name: Test and build installer
on:
push:
branches: [main]
tags: ['v*']
pull_request:
workflow_dispatch:
permissions:
contents: read
jobs:
test:
strategy:
matrix:
os: [ubuntu-latest, windows-latest]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
with:
persist-credentials: false
- uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: '3.12'
- run: python -m pip install -e ".[dev]"
- run: python -m pytest -q
windows-executable:
needs: test
runs-on: windows-latest
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
with:
persist-credentials: false
- uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: '3.12'
- run: python -m pip install -e ".[dev]"
- run: python scripts/build_release.py
- name: Smoke test the frozen executable
shell: pwsh
run: |
$reportPath = Join-Path $env:RUNNER_TEMP 'halo-installer-smoke.json'
$exePath = (Resolve-Path -LiteralPath 'dist/HaloFrameSetup.exe').Path
$process = Start-Process -FilePath $exePath -ArgumentList @('--self-test-report', ('"' + $reportPath + '"')) -WindowStyle Hidden -Wait -PassThru
if ($process.ExitCode -ne 0) { throw 'Executable smoke test failed' }
$report = Get-Content -LiteralPath $reportPath -Raw | ConvertFrom-Json
if (-not $report.ok) { throw 'Executable did not report success' }
- uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: HaloFrameSetup-windows
path: dist/*
if-no-files-found: error
+22
View File
@@ -0,0 +1,22 @@
__pycache__/
*.py[cod]
.pytest_cache/
.venv/
build/
dist/
*.egg-info/
*.spec
*.iso
*.xiso
*.map
*.tar
*.tar.gz
!resources/licenses/sources/paramiko-4.0.0.tar.gz
*.log
hosts.json
.env
*.key
*.pem
*.reg
halo
libSDL3.so*
+25
View File
@@ -0,0 +1,25 @@
MIT License
Copyright (c) 2026 Halo Steam Frame Installer contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
This license covers original installer code. Refer to docs/THIRD_PARTY.md
and resources/licenses for upstream code, patch, dependencies, and notices.
Commercial Halo game data is not included or licensed by this project.
+91
View File
@@ -0,0 +1,91 @@
# Halo on Steam Frame — guided native VR setup
A Windows setup app for installing the native ARM64/OpenXR Halo: Combat Evolved port on Steam Frame. It guides you through SSH, copies your own original Xbox game data, builds the native VR executable on the Frame, applies Xbox-style controls, and adds a VR shortcut to Steam.
**Experimental preview.** The underlying VR implementation is an open upstream pull request. The pinned build and controller changes ran on a real Steam Frame, with the menu and controllers confirmed by its user. This installer has automated component tests; its complete first-install wizard still needs a fresh-device hardware test. Performance varies by scene and device. This is an independent community project, unaffiliated with Microsoft, Bungie, or Valve.
## Download and run
Download **[HaloFrameSetup.exe](https://github.com/ClassicWasTaken/halo-steam-frame-installer/releases/tag/v0.1.0)** and its checksum from this repository's Releases page. Windows 10/11 x64 is supported; Python and an SSH library are included in the executable. You do not need administrator rights.
1. **Choose game data.** Select an original **Xbox** Halo CE `.iso` / `.xiso`, or its extracted `maps` folder, that you are authorized to use. Setup validates the retail Xbox map format and extracts only the required maps. Halo PC, Xbox 360 Anniversary, MCC, and Quest packages are not inputs for this build. The repository and executable contain no commercial game data or download links for it.
2. **Connect your Frame.** Follow the app's instructions: enable Developer Mode, set the Frame's user password, keep both devices on the same network, and enter its hostname/IP. The login is `steamos`, normally at `frame`, port 22. Test the connection and approve the displayed host fingerprint only after identifying your device. Your password is used in memory and is never saved or logged.
3. **Install or repair.** Save and close games, confirm that setup may briefly restart Steam to add the library entry, then click **Install native Halo VR**. Leave the Frame awake and connected. The app uploads maps, creates a rootless build container, compiles the pinned VR source, applies the controls patch, and registers **Halo: Combat Evolved VR (Native)**. It requests a normal Steam shutdown for library registration and restores the Steam session afterward; it does not force-kill the client or a game. The first build may take tens of minutes.
### Already have Halo installed?
Click **Repair installed game** to detect the standard native folder `~/Games/HaloCENativeVR`. Setup reinstalls the native executable, SDL library, controls/tutorial patch, and notices; it restores the required VR/control settings while preserving saves and unrelated settings. Valid original Xbox maps already on the Frame can be reused without selecting another ISO. If maps are missing or damaged, select a valid local image/maps folder and retry. Previous installs made by this installer or the original guided native setup are recognized. A hand-installed native game in the same folder can be adopted only through the explicit Repair action, after its native executable and original Xbox maps validate. Unknown folders and other install locations are not overwritten.
The old PC installation at `~/Games/HaloCEVR` is detected and explained separately. Its PC maps cannot be used for this native Xbox build. Setup installs the native version separately and does not automatically remove the PC version. Close the native game before repair. Program-file backups are retained in the owned build workspace, and a failed repair rolls back the affected files. **Add to Steam again** only repairs library registration; it does not rebuild the game.
The Frame needs ARM64 SteamOS, SteamVR/OpenXR, rootless Podman, internet access, and **12 GiB of free internal storage**. Setup checks these before installing. Your Windows computer needs about 2.5 GB of temporary space for maps. The SteamOS root filesystem stays read-only; dependencies are installed inside a user-owned container.
If Steam cannot close normally, setup reports the remaining step rather than editing a running client's library. Quit Steam and click **Add to Steam again** without rebuilding, or add `~/Games/HaloCENativeVR/halo` as a non-Steam game yourself and use the launch option shown below. Restart Steam after setup if it was already closed.
## Xbox-style controls
| Frame control | Action |
| --- | --- |
| A | Jump / accept |
| B | Melee / back |
| X | Reload / use |
| Y | Change weapon |
| Right trigger / left trigger | Fire / throw grenade |
| Left stick / click | Move / crouch |
| Right stick / click | Turn / zoom |
| Left bumper / right bumper | Change grenade / flashlight |
| Menu / View | Pause / scoreboard |
| Both grips held | Recenter |
Motion aiming stays enabled. Smooth turning defaults to 90 degrees/second, refresh rate to 72 Hz, and render scale to 1.0. Repairs refresh the VR/control defaults and keep unrelated settings and saves. Head movement also satisfies the first-level look tutorial. The patch does not skip the campaign or increase combat difficulty.
The native shortcut uses this **per-game** launch option to prevent the same physical controller from being read through both OpenXR and Steam's virtual gamepad:
```text
SDL_GAMECONTROLLER_ALLOW_STEAM_VIRTUAL_GAMEPAD=0 %command%
```
See [controls and patch details](docs/CONTROLS.md).
## What gets installed
Game: `~/Games/HaloCENativeVR`, including `halo`, bundled SDL3, your maps, config, notices, and an ownership/provenance manifest. New-install saves are in that game's separate `save` folder; repairs preserve existing save locations. Build workspace: `~/.cache/halo-frame-installer`. Source is fetched at the fixed commit below, not a moving branch. Build cache is retained for troubleshooting. Setup does not remove another Halo installation or touch unrelated games.
The renderer uses the Xbox game's data and translated Xbox shaders. Native OpenXR VR and competitive multiplayer come from the port. The PC-only Chimera, PC Restored maps, and HaloCEVR DLLs do not belong in this native build. Multiplayer requires compatible native/OpenCE protocol builds; Halo PC/Custom Edition/MCC servers and PC save files are incompatible.
## Sources and credits
- [OpenCE Steam Frame VR PR #85](https://github.com/OpenCommunityEdition/OpenCE/pull/85), by startupfoundry.
- [Exact VR source commit `88142798513ebd99fc7c6224023e8b44c05d0106`](https://github.com/startupfoundry/halo-ce-universal/tree/88142798513ebd99fc7c6224023e8b44c05d0106), with a documented local controller/tutorial patch.
- [Upstream native Linux/VR build instructions](https://github.com/startupfoundry/halo-ce-universal/blob/88142798513ebd99fc7c6224023e8b44c05d0106/port/linux/README.md#vr).
- [Valve's official Frame setup](https://partner.steamgames.com/doc/steamhardware/steamframe/setup) and [SSH/debugging instructions](https://partner.steamgames.com/doc/steamhardware/steamframe/debugging).
Full source attribution, decompilation lineage, multiplayer references, and third-party licenses are in [SOURCES.md](docs/SOURCES.md) and [THIRD_PARTY.md](docs/THIRD_PARTY.md). Original installer code is MIT licensed. Upstream notices apply separately; no license here grants rights to commercial game data.
## Troubleshooting
- **Cannot resolve `frame`:** use the Frame's IP address from its network settings. Both devices must be on a network that permits connections between clients.
- **Connection refused:** enable Developer Mode and verify the address and SSH port. [Valve guide](https://partner.steamgames.com/doc/steamhardware/steamframe/debugging).
- **Authentication fails:** enter the password set in the Frame's Developer settings; your Steam account password is unrelated.
- **Host key changed:** setup refuses the connection. Verify the new device/key independently before removing its old public fingerprint from `%LOCALAPPDATA%/HaloFrameInstaller/hosts.json`.
- **Insufficient disk space or Podman missing:** resolve the failed preflight check and retry. Setup does not disable SteamOS protections or install system packages as root.
- **Build/download fails:** save the setup log, keep the Frame's build log, and retry. A failed staging build does not replace an existing game or save.
- **Flat window instead of VR:** wake the headset and start SteamVR before launching. The port falls back to a flat window if no usable OpenXR session is available.
- **Controls doubled:** check the native shortcut's launch option above. Steam Input may otherwise add a second virtual controller stream.
- **Library entry absent:** fully quit Steam and retry registration, or use Add a Non-Steam Game with the executable and launch option above. Enable “Include in VR Library” in its Steam properties.
The release executable is unsigned. Verify its SHA256 against the release checksum; this project does not ask you to disable antivirus or other security protections. Review logs for private information before posting an issue.
## Develop and rebuild the executable
```powershell
python -m venv .venv
.\.venv\Scripts\python -m pip install -e ".[dev]"
.\.venv\Scripts\python -m pytest
.\.venv\Scripts\python -m halo_frame_installer
.\.venv\Scripts\python scripts/build_release.py
```
The Windows release includes the installer source and applicable third-party source/notices so you can modify and rebuild it, including its LGPL Paramiko dependency. The build script packages only installer code/resources; no game binary, user ISO, maps, SSH password, or private key is included. GitHub Actions runs tests and builds the Windows setup executable. Releases publish checksums and the corresponding source bundle.
Before reporting a hardware test, record the SteamOS/SteamVR version, source commit, install status, and whether menu, campaign, Xbox controls, tutorial, and compatible multiplayer worked. Do not attach game data or credentials.
+11
View File
@@ -0,0 +1,11 @@
# Reporting security problems
Do not include passwords, private keys, game data, or personal setup logs in a public issue. Report security problems through the repository's private vulnerability reporting feature if enabled, or contact the maintainer privately through an available profile contact.
The installer uses encrypted SSH and explicit SHA256 host-key approval. A changed saved host key is refused. Only public host fingerprints are persisted. Passwords are never stored in project files or passed in command-line arguments.
The Xbox image parser treats selected files as untrusted, bounds directory/file ranges, rejects unsafe paths and symlinks, and only extracts known retail maps. Remote writes are limited to owned per-user directories. The installer never disables SteamOS read-only mode or uses sudo to install packages.
The source revision is fixed, but the native build still downloads an Ubuntu container and toolchain/dependencies from their upstream distributors. This is not an offline or completely hermetic build. Updates to the fixed source and controller patch must be reviewed and tested together.
Cancellation stops the installer-owned build container; an already completed installation may remain. Repairs back up program files and roll back a failed transaction, preserving saves and unrelated settings. Supplied valid Xbox maps may replace existing maps with backups; no-image repairs reuse existing verified maps. Unknown native folders are adopted only through an explicit Repair request and strict native/data validation. Library registration edits Steam shortcuts only while the Steam client is closed, with a backup and unrelated entries preserved.
+42
View File
@@ -0,0 +1,42 @@
# Steam Frame controls
The default installation uses tracked controller aiming with Xbox-style buttons. Point the right controller to aim; move your head to look around. These controls assume the game's default profile button layout.
| Frame input | Action |
| --- | --- |
| Left stick | Move |
| Left stick click | Crouch |
| Right stick left/right | Turn |
| Right stick click | Zoom |
| Right trigger | Fire |
| Left trigger | Throw grenade |
| A | Jump; accept a menu selection |
| B | Melee; go back in menus |
| X | Reload/use; hold for context actions such as exchanging a weapon |
| Y | Change weapon |
| Left bumper | Change grenade type |
| Right bumper | Toggle flashlight |
| Left controller's d-pad | Navigate menus |
| View | Scoreboard/back |
| Menu | Pause |
| Both grips held | Recenter the headset view; release a held foregrip first |
| Left grip near a long gun's foregrip | Aim the gun with both hands |
The installer defaults to controller aiming, seated height, 72 Hz, resolution scale 1.0, smooth turning at 90 degrees per second, and two-handed aiming. Gesture melee is disabled so **B** remains the predictable melee input. These are installer preferences, not the upstream defaults. You can change supported options in **Settings > VR Setup** or the game's `config.toml`. Choose snap turning in VR Setup if you prefer turning in steps. Some display changes require restarting the game.
## Local changes to upstream
The [included patch](../resources/frame-controls.patch) makes two changes:
1. It sets **LB = change grenade** and **RB = flashlight**. The pinned upstream branch assigns those two bumpers the other way around.
2. Physical headset movement counts toward the campaign's look-direction tutorial while motion-controller aiming is active. Follow the technician's instructions and physically look up, down, left or right as requested. The patch ignores small tracking jitter and does not add head rotation to the weapon's aim. It lets the tutorial complete at the selected difficulty; it does not skip the campaign or raise its difficulty.
The game's Steam shortcut also suppresses Steam's duplicate virtual Xbox gamepad with `SDL_GAMECONTROLLER_ALLOW_STEAM_VIRTUAL_GAMEPAD=0`. Frame controller poses, buttons and haptics still use OpenXR. This setting applies only to this Halo shortcut.
## First launch
Keep Steam Home and the headset runtime awake during setup. Launch **Halo: Combat Evolved VR (Native)** from the Frame's library and create a profile. Use the d-pad to select menu items and **A** to accept. Keep the headset on and hold both grips if the menu appears outside your view.
For a control issue, first check **Settings > Gamepads** for a changed profile layout. Then check **Settings > VR Setup**: this layout uses controller aiming. Upstream also offers gamepad aiming, which moves aim with the right stick and has different camera behavior.
The original controls and all VR configuration options are documented in the [pinned upstream VR guide](https://github.com/startupfoundry/halo-ce-universal/blob/88142798513ebd99fc7c6224023e8b44c05d0106/port/linux/README.md#vr). The [SDL hint source](https://github.com/libsdl-org/SDL/blob/release-3.4.16/include/SDL3/SDL_hints.h) documents virtual-gamepad filtering.
+13
View File
@@ -0,0 +1,13 @@
Guided Windows setup for the experimental native ARM64/OpenXR Halo CE Steam Frame port.
- Accepts an original Xbox Halo CE ISO/XISO or extracted retail maps supplied by the user.
- Guides Developer Mode/SSH setup, verifies the host fingerprint, and keeps passwords in memory.
- Builds pinned VR source in a rootless Frame container, applies Xbox-style controls and the tutorial head-look fix, and adds the VR game to Steam.
- Prevents duplicate controller input; repairs existing native program files and controls while preserving saves and unrelated settings. Explicit Repair can adopt a validated manual native install in the standard folder.
- Includes source references, third-party notices/source, and SHA256 checksums.
Download **HaloFrameSetup.exe** to run setup. **HaloFrameSetup-0.1.0-source.zip** contains corresponding installer source and notices for rebuilding.
Preview limitation: the native game was tested on a Frame, and installer components have automated tests. The complete first-install executable still needs fresh-device hardware validation. The executable is unsigned. No game ISO, commercial maps, keys, or game binary is included. Compatible native/OpenCE multiplayer is separate from legacy Halo PC/MCC servers.
See the repository README for requirements, SSH steps, controls, and troubleshooting.
+56
View File
@@ -0,0 +1,56 @@
# Sources and acknowledgements
The installer builds the experimental native ARM64 Linux VR port of **Halo: Combat Evolved** from the revision below. It provides a guided installation; the decompilation, renderer, OpenXR implementation and networking are the work of the credited upstream contributors.
Sources were checked on 2026-10-05. Links to pinned files describe the build used here; moving documentation may describe newer behavior.
## Native game and VR
| Source | Contribution or verified requirement |
| --- | --- |
| [startupfoundry's native Steam Frame VR work, OpenCE PR #85](https://github.com/OpenCommunityEdition/OpenCE/pull/85) | OpenXR stereo, tracked head and controllers, native ARM64 host, desktop OpenGL and stereo multiview. This is experimental work in an open pull request. The normal upstream CI builds do not enable `--vr`. |
| [Pinned fork revision `88142798513ebd99fc7c6224023e8b44c05d0106`](https://github.com/startupfoundry/halo-ce-universal/tree/88142798513ebd99fc7c6224023e8b44c05d0106) | Exact source revision selected for this installer, rather than a moving branch. |
| [Upstream build instructions](https://github.com/startupfoundry/halo-ce-universal/blob/88142798513ebd99fc7c6224023e8b44c05d0106/port/linux/README.md#64-bit-arm) | Native ARM64 compiler requirements, SDL 3.4.16, musl 1.2.5, and the `linux_arm64` target. |
| [Upstream VR documentation](https://github.com/startupfoundry/halo-ce-universal/blob/88142798513ebd99fc7c6224023e8b44c05d0106/port/linux/README.md#vr) | `configure.py --vr`, OpenXR runtime requirements, motion aiming, gamepad mode, comfort options, and experimental limitations. |
| [OpenCommunityEdition/OpenCE](https://github.com/OpenCommunityEdition/OpenCE) | Community port and integration work from which the VR fork descends. |
| [bnunu/halo-1](https://github.com/bnunu/halo-1) and [punpckhdq/halo](https://github.com/punpckhdq/halo) | Decompilation lineage identified by the upstream README. |
| [Upstream XDK declarations](https://github.com/startupfoundry/halo-ce-universal/blob/88142798513ebd99fc7c6224023e8b44c05d0106/port/include/xdk/README.md) | The port supplies its own declarations; installing the proprietary Xbox SDK is unnecessary. |
The installer applies [its documented controller and tutorial patch](../resources/frame-controls.patch) to that pinned revision. [Controls and defaults](CONTROLS.md) distinguish these changes from upstream behavior. Performance depends on game scene, headset software and settings; native ARM64 does not imply unlimited performance.
## Game data and compatibility
[Upstream game-data instructions](https://github.com/startupfoundry/halo-ce-universal/blob/88142798513ebd99fc7c6224023e8b44c05d0106/README.md#game-data) require an **original Xbox Halo: Combat Evolved** disc image (`.iso` or `.xiso`) or its extracted maps. Upstream supports the original Xbox revisions and regions, including conversion of PAL map timing for play with NTSC maps.
Select a local disc image or maps that you are authorized to use. The installer checks original Xbox map headers and extracts the required data locally. The repository and downloadable installer contain no game disc image or commercial map data and provide no unauthorized game-download links.
Halo PC, Custom Edition, Xbox 360 Anniversary and MCC data are different formats. This is the native **Steam Frame** Linux VR port; the Android port in the upstream repository is not a promise of a Quest VR installation. PC Chimera, PC Restored map replacements and HaloCEVR DLLs are not loaded by this ARM64 build. Its native renderer and VR implementation supply the relevant graphics and headset support. PC Halo saves and profiles also differ from the native port's Xbox formats.
[Upstream multiplayer](https://github.com/startupfoundry/halo-ce-universal/blob/88142798513ebd99fc7c6224023e8b44c05d0106/README.md#multiplayer) supports LAN and internet play among compatible builds of this port. The [netcode design](https://github.com/startupfoundry/halo-ce-universal/blob/88142798513ebd99fc7c6224023e8b44c05d0106/port/linux/NETCODE.md) describes its replacement networking. Use matching native/OpenCE protocol versions; compatibility with legacy Halo PC, Custom Edition, MCC or retail Xbox servers is not established by this project.
## Steam Frame setup and connection
| Primary reference | Installer guidance |
| --- | --- |
| [Valve: Setting up your Steam Frame for development](https://partner.steamgames.com/doc/steamhardware/steamframe/setup) | In the headset, open **Steam Settings > System > Enable Developer Mode**. Open **Developer > Set User Password** and choose a password. The hostname is under **Steam Settings > System > Hostname**. |
| [Valve: Steam Frame Debugging](https://partner.steamgames.com/doc/steamhardware/steamframe/debugging) | Developer Mode enables SSH. Valve's default login is `ssh steamos@frame`, using the password you set. |
| [OpenSSH manuals](https://www.openssh.org/manual.html) and [Paramiko host-key policies](https://docs.paramiko.org/en/stable/api/client.html#paramiko.client.MissingHostKeyPolicy) | SSH host keys identify the destination device. Review the first-connection fingerprint; an unexpected changed key should stop the connection. |
SteamOS has a read-only system filesystem. This installer uses a user-owned game folder and an unprivileged build container; its process does not require disabling that protection or changing system packages.
## Build and installer dependencies
- [LLVM's signed Ubuntu package repository](https://apt.llvm.org/) supplies LLVM 22 inside the build container for the upstream `arm64_32` guest compiler target.
- [Podman's rootless operation](https://docs.podman.io/en/latest/markdown/podman.1.html#rootless-mode) isolates compiler dependencies from the headset's system installation.
- [SDL](https://github.com/libsdl-org/SDL/tree/release-3.4.16) provides native windowing, audio and gamepad support. [Its Steam virtual-gamepad hint](https://github.com/libsdl-org/SDL/blob/release-3.4.16/include/SDL3/SDL_hints.h) supports suppressing duplicate virtual-pad input for this game's shortcut.
- [Khronos OpenXR](https://github.com/KhronosGroup/OpenXR-SDK) supplies the OpenXR API headers used by the upstream VR implementation. The Frame's installed runtime supplies the active headset session.
- [Paramiko](https://www.paramiko.org/) provides SSH/SFTP for the Windows installer, using [cryptography](https://cryptography.io/), [bcrypt](https://github.com/pyca/bcrypt) and [PyNaCl](https://github.com/pyca/pynacl).
- [CPython](https://www.python.org/) and [Tcl/Tk](https://www.tcl.tk/) provide the installer runtime and guided desktop interface. [PyInstaller](https://pyinstaller.org/) creates the Windows executable.
Actual package versions, original license notices and source references are recorded in [third-party notices](THIRD_PARTY.md) and the [generated license manifest](../resources/licenses/manifest.json). The installer code's license does not replace the upstream or dependency licenses.
This product includes software developed by in <in@fishtank.com> (the upstream `extract-xiso` component).
## General preservation resources
User-suggested background links: [Vimm's Lair](https://vimm.net/) and [Internet Archive's about page](https://archive.org/about/). These are general references, not Halo file-download links, software dependencies, or assurances of game-data permissions. The installer selects a local original Xbox image/maps supplied by the user; it does not fetch commercial game files. The PC edition is not an input to the native Frame build.
+65
View File
@@ -0,0 +1,65 @@
# Third-party software notices
The installer code has its own [MIT license](../LICENSE). Each dependency keeps its own license. Original notice text is included under [resources/licenses](../resources/licenses); [manifest.json](../resources/licenses/manifest.json) records package versions, notice hashes and source URLs from the environment used to build the Windows executable.
The manifest includes build and test dependencies as well as runtime dependencies, so an entry does not imply that every file of that package is embedded in the executable. It records no machine paths, passwords, private SSH keys or game data.
## Windows installer
| Component | Initial build version | License and use |
| --- | --- | --- |
| [CPython](https://www.python.org/) | 3.12.14 | PSF license and retained component notices. Python runtime for the guided installer. Original text: [Python-LICENSE.txt](../resources/licenses/runtime/Python-LICENSE.txt). |
| [Tcl/Tk](https://www.tcl.tk/) | Tcl/Tk 8.6 | Tcl/Tk permissive notices. Desktop interface through `tkinter`. Retained [Tcl terms](../resources/licenses/runtime/tcl-LICENSE.terms) and [installed Tk terms](../resources/licenses/runtime/tcl-tk/tk8.6/license.terms). |
| [Paramiko](https://github.com/paramiko/paramiko/tree/4.0.0) | 4.0.0 | LGPL-2.1. SSH and SFTP. Full [license](../resources/licenses/packages/paramiko/paramiko-4.0.0.dist-info/licenses/LICENSE) and [source archive](../resources/licenses/sources/paramiko-4.0.0.tar.gz) are included. |
| [cryptography](https://github.com/pyca/cryptography) | 50.0.2 | Apache-2.0 OR BSD-3-Clause. Cryptographic primitives used by SSH. Both notices are retained in the package's license folder. |
| [bcrypt](https://github.com/pyca/bcrypt) | 5.0.0 | Apache-2.0. Password/key derivation support. |
| [PyNaCl](https://github.com/pyca/pynacl) | 1.6.2 | Apache-2.0, with retained ISC notice for bundled libsodium. SSH cryptographic support. |
| [CFFI](https://github.com/python-cffi/cffi) | 2.1.1 | MIT-0. Foreign-function support for native dependencies. |
| [pycparser](https://github.com/eliben/pycparser) | 3.0 | BSD-3-Clause. CFFI parsing dependency. |
| [Invoke](https://github.com/pyinvoke/invoke) | 3.0.3 | BSD-2-Clause. Paramiko dependency. |
| [OpenSSL](https://github.com/openssl/openssl) | 3.5.8 / 4.0.3 | Apache-2.0. The Python `ssl` runtime and cryptography wheel use different builds. Exact-version [3.5.8](../resources/licenses/runtime/openssl-3.5.8-LICENSE.txt) and [4.0.3](../resources/licenses/runtime/openssl-4.0.3-LICENSE.txt) license texts are retained. |
| [PyInstaller](https://github.com/pyinstaller/pyinstaller) | 6.22.3 | GPL-2.0-or-later with its bootloader exception; certain runtime modules/hooks use Apache-2.0. Used to freeze the installer. The complete [COPYING text](../resources/licenses/packages/pyinstaller/pyinstaller-6.22.3.dist-info/licenses/COPYING.txt) preserves these distinctions. |
| [PyInstaller community hooks](https://github.com/pyinstaller/pyinstaller-hooks-contrib) | 2026.8 | GPL-2.0-or-later for ordinary build hooks, Apache-2.0 for bundled runtime hooks. Complete notice retained. |
The generated inventory also retains notices for altgraph, colorama, packaging, pefile, pywin32-ctypes, setuptools and its vendored components, pip, pytest, iniconfig, pluggy and Pygments when installed in the build environment. These packages keep the terms recorded in their original notice files. Future builds should use their own generated manifest rather than treating this initial version table as a dependency lock file.
### Paramiko source and modification
Paramiko remains unmodified by this installer. Its complete official 4.0.0 source distribution is supplied alongside its LGPL notice. The included source archive is verified against the SHA-256 published in [PyPI's version metadata](https://pypi.org/pypi/paramiko/4.0.0/json); its digest and source URL are recorded in the manifest.
You may modify Paramiko and rebuild the installer with that modified library. This project imposes no restriction on reverse engineering for debugging such library modifications. Obtain the installer source for the matching release and follow the [source build instructions](../README.md). After installing the build dependencies, replace Paramiko in that environment with your modified source before the executable-freezing step, for example:
```powershell
python -m pip install --no-deps --force-reinstall C:\path\to\modified-paramiko
```
Then rebuild using the provided packaging script. The installer source, resources and build scripts are available in this repository; the ordinary GitHub source download contains them. The separate library retains its LGPL terms.
## Native game built on the Frame
The Windows download contains the installer and build instructions, not the commercial game's maps or disc image. The native program is built from pinned upstream source on the Frame. Its upstream license and component notices remain applicable to that build.
| Upstream component | Notice/reference |
| --- | --- |
| [Halo native port / decompilation](https://github.com/startupfoundry/halo-ce-universal/blob/88142798513ebd99fc7c6224023e8b44c05d0106/LICENSE.md) | CC0-1.0 for the upstream source. This does not grant rights in the commercial game data or third parties' rights. |
| [Local controller/tutorial patch](../resources/frame-controls.patch) | A documented modification of the pinned upstream source; see [CONTROLS.md](CONTROLS.md). |
| [SDL 3.4.16](https://github.com/libsdl-org/SDL/blob/release-3.4.16/LICENSE.txt) | zlib license; retain the original notice with the native library. |
| [musl 1.2.5](https://git.musl-libc.org/cgit/musl/tree/COPYRIGHT?h=v1.2.5) | MIT and notices identified in its COPYRIGHT file. Used for the upstream ILP32 guest. |
| [Khronos OpenXR SDK headers](https://github.com/startupfoundry/halo-ce-universal/blob/88142798513ebd99fc7c6224023e8b44c05d0106/port/third_party/openxr/README.md) | OpenXR SDK 1.1.63, Apache-2.0 OR MIT. Header provenance is documented upstream. |
| [mbedTLS, expat, miniupnpc, KCP, tomlc17 and stb](https://github.com/startupfoundry/halo-ce-universal/tree/88142798513ebd99fc7c6224023e8b44c05d0106/port/third_party) | Their individual upstream license files apply. Preserve the actual files when producing the native installation. |
| [extract-xiso](https://github.com/startupfoundry/halo-ce-universal/blob/88142798513ebd99fc7c6224023e8b44c05d0106/port/third_party/extract-xiso/LICENSE.TXT) | Custom BSD-style notice with acknowledgement and attribution conditions. This product includes software developed by in <in@fishtank.com>. |
| [Upstream font resources](https://github.com/startupfoundry/halo-ce-universal/tree/88142798513ebd99fc7c6224023e8b44c05d0106/port/assets/fonts) | Retain Overpass's SIL Open Font License and Newtown's public-domain notice when using those upstream resources. |
The rootless build environment installs [Ubuntu packages](https://ubuntu.com/legal/open-source) and [LLVM](https://llvm.org/docs/DeveloperPolicy.html#license) under their own licenses inside its container. The installer does not relicense those tools or SteamOS/SteamVR. Game artwork, names and data remain the property of their respective rights holders.
## Regenerating notices
Run the following in the same Python environment used for packaging:
```powershell
python scripts/gather_notices.py --download-sources
```
The script copies actual installed license files, the Python runtime's license and available Tcl/Tk terms. With `--download-sources`, it retrieves the checksum-verified official Paramiko source archive and the exact-version OpenSSL and Tcl license texts from their primary repositories. All generated paths are relative to `resources/licenses`. Regenerate these resources for every new dependency/runtime build and include the directory with its source and executable release.
See [SOURCES.md](SOURCES.md) for the game, VR, Steam Frame and SSH primary references.
+24
View File
@@ -0,0 +1,24 @@
[build-system]
requires = ["setuptools>=77"]
build-backend = "setuptools.build_meta"
[project]
name = "halo-steam-frame-installer"
version = "0.1.0"
description = "Guided SSH installer for the native ARM64 Halo CE Steam Frame VR port"
requires-python = ">=3.11"
license = "MIT"
dependencies = ["paramiko==4.0.0"]
[project.optional-dependencies]
dev = ["pytest==9.1.1", "pyinstaller==6.22.3"]
[project.gui-scripts]
halo-frame-setup = "halo_frame_installer.gui:main"
[tool.setuptools.packages.find]
where = ["src"]
[tool.pytest.ini_options]
pythonpath = ["src"]
testpaths = ["tests"]
+34
View File
@@ -0,0 +1,34 @@
#!/bin/bash
# Runs as root ONLY inside an unprivileged, rootless Podman container.
set -euo pipefail
cd /build
export DEBIAN_FRONTEND=noninteractive
echo 'Installing the isolated ARM64 compiler and build dependencies...'
apt-get update
apt-get install -y --no-install-recommends ca-certificates curl gnupg git python3 \
ninja-build cmake make pkg-config ccache file \
libx11-dev libxext-dev libxrandr-dev libxcursor-dev libxi-dev libxss-dev libxfixes-dev \
libxtst-dev libxkbcommon-dev libwayland-dev wayland-protocols libegl-dev libgles-dev \
libgl-dev libdrm-dev libgbm-dev libpulse-dev libpipewire-0.3-dev libasound2-dev \
libudev-dev libdbus-1-dev libdecor-0-dev
# The upstream ARM64 ILP32 guest needs recent LLVM. Use LLVM's signed apt repository.
curl --fail --silent --show-error --location https://apt.llvm.org/llvm-snapshot.gpg.key \
-o /build/llvm-archive-key.asc
gpg --batch --yes --dearmor --output /usr/share/keyrings/llvm-archive-keyring.gpg \
/build/llvm-archive-key.asc
printf '%s\n' 'deb [arch=arm64 signed-by=/usr/share/keyrings/llvm-archive-keyring.gpg] https://apt.llvm.org/jammy/ llvm-toolchain-jammy-22 main' \
> /etc/apt/sources.list.d/llvm22.list
apt-get update
apt-get install -y --no-install-recommends clang-22 lld-22 llvm-22
for tool in clang ld.lld llvm-ar; do
ln -sf "/usr/bin/$tool-22" "/usr/local/bin/$tool"
done
clang --version
cd /build/src
python3 configure.py --release --vr --linux-arm64-cc clang
export CMAKE_BUILD_PARALLEL_LEVEL=4
export NINJAFLAGS=-j4
echo 'Building the native Steam Frame OpenXR game. This can take several minutes...'
ninja -j4 linux_arm64
file build/linux_arm64/halo
echo 'Native ARM64 VR build completed.'
+124
View File
@@ -0,0 +1,124 @@
diff --git a/port/linux/src/vr.c b/port/linux/src/vr.c
index 89cfb6f..30c5787 100644
--- a/port/linux/src/vr.c
+++ b/port/linux/src/vr.c
@@ -99,6 +99,10 @@ static struct
int aiming;
int aimed;
int aim_synced;
+ /* the tutorial's look tests observe head motion independently of the
+ controller's aim, without feeding it into the game's facing */
+ int tutorial_head_valid;
+ float tutorial_head_yaw, tutorial_head_pitch;
int snap_latched;
float recentre_time;
/* a gamepad's Back held (halo_vr_gamepad_back), and for how long */
@@ -1044,6 +1048,47 @@ int halo_vr_view(struct halo_vr_view *view)
/* ---------- aiming */
+int halo_vr_tutorial_look(float *yaw, float *pitch)
+{
+ static const float forwards[3] = { 0.0f, 0.0f, -1.0f };
+ const float threshold = 0.01f; /* about half a degree; ignore tracking jitter */
+ float pointing[3], facing[3], head_yaw, head_pitch;
+
+ *yaw = *pitch = 0.0f;
+ if (!vr.initialized || !(vr.frame || vr.pending) || !vr.views.should_render ||
+ !vr.views.focused || !vr.views.head.valid || vr.menus || !settings.controller_aim)
+ {
+ vr.tutorial_head_valid = 0;
+ return 0;
+ }
+ /* Use the tracking space, rather than body_yaw or the recentred origin:
+ stick turns and recentring must not count as physical head movement. */
+ quaternion_rotate(vr.views.head.orientation, forwards, pointing);
+ game_axes(pointing, 0.0f, facing);
+ head_yaw = atan2f(facing[1], facing[0]);
+ head_pitch = asinf(facing[2] < -1.0f ? -1.0f : facing[2] > 1.0f ? 1.0f : facing[2]);
+ if (!vr.tutorial_head_valid)
+ {
+ vr.tutorial_head_valid = 1;
+ vr.tutorial_head_yaw = head_yaw;
+ vr.tutorial_head_pitch = head_pitch;
+ return 0;
+ }
+ *yaw = remainderf(head_yaw - vr.tutorial_head_yaw, 2.0f * (float)M_PI);
+ *pitch = head_pitch - vr.tutorial_head_pitch;
+ /* Keep each anchor until movement crosses the threshold, so a slow
+ look still counts and sub-threshold jitter does not. */
+ if (fabsf(*yaw) >= threshold)
+ vr.tutorial_head_yaw = head_yaw;
+ else
+ *yaw = 0.0f;
+ if (fabsf(*pitch) >= threshold)
+ vr.tutorial_head_pitch = head_pitch;
+ else
+ *pitch = 0.0f;
+ return *yaw != 0.0f || *pitch != 0.0f;
+}
+
int halo_vr_aim(float current_yaw, int long_gun, float *yaw, float *pitch)
{
static const float backwards[3] = { 0.0f, 0.0f, -1.0f };
@@ -1161,10 +1206,10 @@ void halo_vr_gamepad(void *gamepad)
analog(pad, XINPUT_GAMEPAD_B, (buttons & VR_BUTTON_B) || vr.melee_frames > 0);
analog(pad, XINPUT_GAMEPAD_X, buttons & VR_BUTTON_X);
analog(pad, XINPUT_GAMEPAD_Y, buttons & VR_BUTTON_Y);
- /* the bumpers where the Xbox's white and black buttons were: the
- flashlight and the grenade switch */
- analog(pad, XINPUT_GAMEPAD_WHITE, buttons & VR_BUTTON_LEFT_BUMPER);
- analog(pad, XINPUT_GAMEPAD_BLACK, buttons & VR_BUTTON_RIGHT_BUMPER);
+ /* Keep the user's Xbox layout: left bumper changes grenade, and the
+ right bumper toggles the flashlight. */
+ analog(pad, XINPUT_GAMEPAD_WHITE, buttons & VR_BUTTON_RIGHT_BUMPER);
+ analog(pad, XINPUT_GAMEPAD_BLACK, buttons & VR_BUTTON_LEFT_BUMPER);
trigger = (BYTE)(vr.input.left_trigger * 255.0f);
if (trigger > pad->bAnalogButtons[XINPUT_GAMEPAD_LEFT_TRIGGER])
pad->bAnalogButtons[XINPUT_GAMEPAD_LEFT_TRIGGER] = trigger;
diff --git a/port/linux/src/vr.h b/port/linux/src/vr.h
index 9f78308..8acbb8f 100644
--- a/port/linux/src/vr.h
+++ b/port/linux/src/vr.h
@@ -106,6 +106,9 @@ stays the game's (vr.aim = "gamepad"); 0 when it does not (no VR frame, a
cinematic). With a long gun, the left hand on its foregrip aims it along
both hands (vr.two_handed). */
int halo_vr_aim(float current_yaw, int long_gun, float *yaw, float *pitch);
+/* Physical head movement for the campaign's tutorial look-direction tests;
+does not change controller aiming or the player's facing. */
+int halo_vr_tutorial_look(float *yaw, float *pitch);
/* the aim no longer follows the head (a cinematic, a vehicle's camera
taking over): the next halo_vr_aim starts again from the player's facing */
void halo_vr_aim_release(void);
diff --git a/source/game/player_control.c b/source/game/player_control.c
index 71ed135..5d1f506 100644
--- a/source/game/player_control.c
+++ b/source/game/player_control.c
@@ -1771,6 +1771,27 @@ static void player_control_action_test_check_reset_input_blob(
{
globals->action_flags |= FLAG(_player_control_look_relative_right_bit);
}
+#ifdef HALO_VR
+ {
+ /* Controller aiming bypasses the game's relative look input. Let
+ physical head movement satisfy the tutorial's look tests as well,
+ without adding head motion to the controller's weapon aim. */
+ extern int halo_vr_tutorial_look(float *yaw, float *pitch);
+ float yaw, pitch;
+
+ if (halo_vr_tutorial_look(&yaw, &pitch))
+ {
+ if (pitch > 0.f)
+ globals->action_flags |= FLAG(_player_control_look_relative_up_bit);
+ else if (pitch < 0.f)
+ globals->action_flags |= FLAG(_player_control_look_relative_down_bit);
+ if (yaw > 0.f)
+ globals->action_flags |= FLAG(_player_control_look_relative_left_bit);
+ else if (yaw < 0.f)
+ globals->action_flags |= FLAG(_player_control_look_relative_right_bit);
+ }
+ }
+#endif
if (input->throttle.i > 0.f)
{
globals->action_flags |= FLAG(_player_control_move_relative_forward_bit);
+526
View File
@@ -0,0 +1,526 @@
{
"schema": 1,
"python_version": "3.12.14",
"scope": "Installed build-environment notices; includes build/test packages that may not be present in the frozen installer.",
"packages": [
{
"name": "altgraph",
"version": "0.17.5",
"license_expression": null,
"declared_license": "MIT",
"project_urls": [
"Documentation, https://altgraph.readthedocs.io/en/latest/",
"Issue tracker, https://github.com/ronaldoussoren/altgraph/issues",
"Repository, https://github.com/ronaldoussoren/altgraph"
],
"notices": [
{
"path": "packages/altgraph/altgraph-0.17.5.dist-info/LICENSE",
"sha256": "6c194d6db0c64d45535d10c95142b9b0cda7b7dcc7f1ddee302b3d536f3dbe46",
"bytes": 1002
}
]
},
{
"name": "bcrypt",
"version": "5.0.0",
"license_expression": null,
"declared_license": "Apache-2.0",
"project_urls": [
"homepage, https://github.com/pyca/bcrypt/"
],
"notices": [
{
"path": "packages/bcrypt/bcrypt-5.0.0.dist-info/LICENSE",
"sha256": "8173d5c29b4f956d532781d2b86e4e30f83e6b7878dce18c919451d6ba707c90",
"bytes": 10850
}
]
},
{
"name": "cffi",
"version": "2.1.1",
"license_expression": "MIT-0",
"declared_license": null,
"project_urls": [
"Documentation, https://cffi.readthedocs.io/",
"Changelog, https://cffi.readthedocs.io/en/latest/whatsnew.html",
"Download, https://github.com/python-cffi/cffi/releases",
"Contact, https://groups.google.com/forum/#!forum/python-cffi",
"Source Code, https://github.com/python-cffi/cffi",
"Issue Tracker, https://github.com/python-cffi/cffi/issues"
],
"notices": [
{
"path": "packages/cffi/cffi-2.1.1.dist-info/licenses/LICENSE",
"sha256": "5ba24ddc57067f9249add644c3afc41a5d6dc37e23433ef759d95df370b0af63",
"bytes": 1123
}
]
},
{
"name": "colorama",
"version": "0.4.6",
"license_expression": null,
"declared_license": null,
"project_urls": [
"Homepage, https://github.com/tartley/colorama"
],
"notices": [
{
"path": "packages/colorama/colorama-0.4.6.dist-info/licenses/LICENSE.txt",
"sha256": "cac35c02686e5d04a5a7140bfb3b36e73aed496656e891102e428886d7930318",
"bytes": 1491
}
]
},
{
"name": "cryptography",
"version": "50.0.2",
"license_expression": "Apache-2.0 OR BSD-3-Clause",
"declared_license": null,
"project_urls": [
"changelog, https://cryptography.io/en/latest/changelog/",
"documentation, https://cryptography.io/",
"homepage, https://github.com/pyca/cryptography",
"issues, https://github.com/pyca/cryptography/issues",
"source, https://github.com/pyca/cryptography/"
],
"notices": [
{
"path": "packages/cryptography/cryptography-50.0.2.dist-info/licenses/LICENSE",
"sha256": "3e0c7c091a948b82533ba98fd7cbb40432d6f1a9acbf85f5922d2f99a93ae6bb",
"bytes": 197
},
{
"path": "packages/cryptography/cryptography-50.0.2.dist-info/licenses/LICENSE.APACHE",
"sha256": "aac73b3148f6d1d7111dbca32099f68d26c644c6813ae1e4f05f6579aa2663fe",
"bytes": 11360
},
{
"path": "packages/cryptography/cryptography-50.0.2.dist-info/licenses/LICENSE.BSD",
"sha256": "602c4c7482de6479dd2e9793cda275e5e63d773dacd1eca689232ab7008fb4fb",
"bytes": 1532
}
]
},
{
"name": "halo-steam-frame-installer",
"version": "0.1.0",
"license_expression": "MIT",
"declared_license": null,
"project_urls": [],
"notices": [
{
"path": "packages/halo-steam-frame-installer/halo_steam_frame_installer-0.1.0.dist-info/licenses/LICENSE",
"sha256": "b19db6d1e8942380f6a0dc3b9ec39cec802606c9d1c08a6050eae2990568afbb",
"bytes": 1318
}
]
},
{
"name": "iniconfig",
"version": "2.3.0",
"license_expression": "MIT",
"declared_license": null,
"project_urls": [
"Homepage, https://github.com/pytest-dev/iniconfig"
],
"notices": [
{
"path": "packages/iniconfig/iniconfig-2.3.0.dist-info/licenses/LICENSE",
"sha256": "3409fa91f7ace557894632676656e32264fe5ef7581535725dc9a23774551bd4",
"bytes": 1098
}
]
},
{
"name": "invoke",
"version": "3.0.3",
"license_expression": "BSD-2-Clause",
"declared_license": null,
"project_urls": [
"Docs, https://docs.pyinvoke.org",
"Source, https://github.com/pyinvoke/invoke",
"Changelog, https://www.pyinvoke.org/changelog.html",
"CI, https://app.circleci.com/pipelines/github/pyinvoke/invoke",
"Issues, https://github.com/pyinvoke/invoke/issues"
],
"notices": [
{
"path": "packages/invoke/invoke-3.0.3.dist-info/licenses/LICENSE",
"sha256": "7922f97f896f1d161e1ebf47083e304a23638361b255c6902b5e4f34eeda0dad",
"bytes": 1314
}
]
},
{
"name": "packaging",
"version": "26.3",
"license_expression": "Apache-2.0 OR BSD-2-Clause",
"declared_license": null,
"project_urls": [
"Documentation, https://packaging.pypa.io/",
"Source, https://github.com/pypa/packaging"
],
"notices": [
{
"path": "packages/packaging/packaging-26.3.dist-info/licenses/LICENSE",
"sha256": "cad1ef5bd340d73e074ba614d26f7deaca5c7940c3d8c34852e65c4909686c48",
"bytes": 197
},
{
"path": "packages/packaging/packaging-26.3.dist-info/licenses/LICENSE.APACHE",
"sha256": "0d542e0c8804e39aa7f37eb00da5a762149dc682d7829451287e11b938e94594",
"bytes": 10174
},
{
"path": "packages/packaging/packaging-26.3.dist-info/licenses/LICENSE.BSD",
"sha256": "b70e7e9b742f1cc6f948b34c16aa39ffece94196364bc88ff0d2180f0028fac5",
"bytes": 1344
}
]
},
{
"name": "paramiko",
"version": "4.0.0",
"license_expression": "LGPL-2.1",
"declared_license": null,
"project_urls": [
"Docs, https://docs.paramiko.org",
"Source, https://github.com/paramiko/paramiko",
"Changelog, https://www.paramiko.org/changelog.html",
"CI, https://app.circleci.com/pipelines/github/paramiko/paramiko",
"Issues, https://github.com/paramiko/paramiko/issues"
],
"notices": [
{
"path": "packages/paramiko/paramiko-4.0.0.dist-info/licenses/LICENSE",
"sha256": "5fa25bf5f395fd26e701c2e1de4ca7d162816986dc791c22f8f4226857ad1bb2",
"bytes": 26436
}
]
},
{
"name": "pefile",
"version": "2024.8.26",
"license_expression": null,
"declared_license": "MIT",
"project_urls": [],
"notices": [
{
"path": "packages/pefile/pefile-2024.8.26.dist-info/LICENSE",
"sha256": "b44409c067c6da52bfb54bb6624fb11a7b52157c3a13ae1400232f8196e86ad3",
"bytes": 1083
}
]
},
{
"name": "pip",
"version": "25.0.1",
"license_expression": null,
"declared_license": "MIT",
"project_urls": [
"Homepage, https://pip.pypa.io/",
"Documentation, https://pip.pypa.io",
"Source, https://github.com/pypa/pip",
"Changelog, https://pip.pypa.io/en/stable/news/"
],
"notices": [
{
"path": "packages/pip/pip-25.0.1.dist-info/AUTHORS.txt",
"sha256": "1eace90552df4f5941b61a907e20e555e16483ae6127b650bef5a1a2af8102c0",
"bytes": 11018
},
{
"path": "packages/pip/pip-25.0.1.dist-info/LICENSE.txt",
"sha256": "634300a669d49aeae65b12c6c48c924c51a4cdf3d1ff086dc3456dc8bcaa2104",
"bytes": 1093
}
]
},
{
"name": "pluggy",
"version": "1.6.0",
"license_expression": null,
"declared_license": "MIT",
"project_urls": [],
"notices": [
{
"path": "packages/pluggy/pluggy-1.6.0.dist-info/licenses/LICENSE",
"sha256": "d6b65e6c213a5d0b577911d34d6e5949b9f59d76c238c5071a2f3fc16cfb2606",
"bytes": 1110
}
]
},
{
"name": "pycparser",
"version": "3.0",
"license_expression": "BSD-3-Clause",
"declared_license": null,
"project_urls": [
"Homepage, https://github.com/eliben/pycparser"
],
"notices": [
{
"path": "packages/pycparser/pycparser-3.0.dist-info/licenses/LICENSE",
"sha256": "0c846399369ea76ddd7b5c44fe6d16497415fcf015f5cbb508c24bf98b81c5b1",
"bytes": 1543
}
]
},
{
"name": "Pygments",
"version": "2.21.0",
"license_expression": "BSD-2-Clause",
"declared_license": null,
"project_urls": [
"Homepage, https://pygments.org",
"Documentation, https://pygments.org/docs",
"Source, https://github.com/pygments/pygments",
"Bug Tracker, https://github.com/pygments/pygments/issues",
"Changelog, https://github.com/pygments/pygments/blob/master/CHANGES"
],
"notices": [
{
"path": "packages/Pygments/pygments-2.21.0.dist-info/licenses/AUTHORS",
"sha256": "71a83872ad82f57be692cf827e048e2cd51d45169cfa1ea3f28706d97a872c0f",
"bytes": 11048
},
{
"path": "packages/Pygments/pygments-2.21.0.dist-info/licenses/LICENSE",
"sha256": "a9d66f1d526df02e29dce73436d34e56e8632f46c275bbdffc70569e882f9f17",
"bytes": 1331
}
]
},
{
"name": "pyinstaller",
"version": "6.22.3",
"license_expression": null,
"declared_license": "GPLv2-or-later with a special exception which allows to use PyInstaller to build and distribute non-free programs (including commercial ones)",
"project_urls": [
"Homepage, https://pyinstaller.org",
"Documentation, https://pyinstaller.org",
"Source Code, https://github.com/pyinstaller/pyinstaller",
"Release Notes, https://pyinstaller.org/en/stable/CHANGES.html"
],
"notices": [
{
"path": "packages/pyinstaller/pyinstaller-6.22.3.dist-info/licenses/COPYING.txt",
"sha256": "0598064c7d2718e38d7914a7d08343b2fa008e3bea9ebba2aa7a6ffa5900dd64",
"bytes": 32604
}
]
},
{
"name": "pyinstaller-hooks-contrib",
"version": "2026.8",
"license_expression": null,
"declared_license": null,
"project_urls": [],
"notices": [
{
"path": "packages/pyinstaller-hooks-contrib/pyinstaller_hooks_contrib-2026.8.dist-info/licenses/LICENSE",
"sha256": "91d0baaff00773038e72c0a1fc9d5d2d38706b7a2b9c04f34296608f931b9cd0",
"bytes": 27666
}
]
},
{
"name": "PyNaCl",
"version": "1.6.2",
"license_expression": null,
"declared_license": "Apache-2.0",
"project_urls": [
"Homepage, https://github.com/pyca/pynacl",
"Bug Tracker, https://github.com/pyca/pynacl/issues",
"Documentation, https://pynacl.readthedocs.io"
],
"notices": [
{
"path": "packages/PyNaCl/pynacl-1.6.2.dist-info/licenses/LICENSE",
"sha256": "77af5bbded959114b6d7a5eea518b2be364e04f4f4a95f9e87d9870c27713d24",
"bytes": 9868
},
{
"path": "packages/PyNaCl/pynacl-1.6.2.dist-info/licenses/licenses/LICENSE.libsodium.txt",
"sha256": "93e7cac854d71cdafc9d9e4e9f8fd28d87ae541b3dda224d7c8fe23d37875704",
"bytes": 841
}
]
},
{
"name": "pytest",
"version": "9.1.1",
"license_expression": "MIT",
"declared_license": null,
"project_urls": [
"Changelog, https://docs.pytest.org/en/stable/changelog.html",
"Contact, https://docs.pytest.org/en/stable/contact.html",
"Funding, https://docs.pytest.org/en/stable/sponsor.html",
"Homepage, https://docs.pytest.org/en/latest/",
"Source, https://github.com/pytest-dev/pytest",
"Tracker, https://github.com/pytest-dev/pytest/issues"
],
"notices": [
{
"path": "packages/pytest/pytest-9.1.1.dist-info/licenses/LICENSE",
"sha256": "ca836a5f9ecca3b2f350230faa20a48fb8b145653b5568d784862df864706b9b",
"bytes": 1091
}
]
},
{
"name": "pywin32-ctypes",
"version": "0.2.3",
"license_expression": null,
"declared_license": "BSD-3-Clause",
"project_urls": [],
"notices": [
{
"path": "packages/pywin32-ctypes/pywin32_ctypes-0.2.3.dist-info/LICENSE.txt",
"sha256": "dfa83b3e2709adfcdb838d9ad55823ca674abb780e60563d9dd9544ccbf785e9",
"bytes": 1644
}
]
},
{
"name": "setuptools",
"version": "84.0.0",
"license_expression": "MIT",
"declared_license": null,
"project_urls": [
"Source, https://github.com/pypa/setuptools",
"Documentation, https://setuptools.pypa.io/",
"Changelog, https://setuptools.pypa.io/en/stable/history.html"
],
"notices": [
{
"path": "packages/setuptools/setuptools-84.0.0.dist-info/licenses/LICENSE",
"sha256": "86da0f01aeae46348a3c3d465195dc1ceccde79f79e87769a64b8da04b2a4741",
"bytes": 1023
},
{
"path": "packages/setuptools/setuptools/_vendor/autocommand-2.2.2.dist-info/LICENSE",
"sha256": "ade78d04982d69972d444a8e14a94f87a2334dd3855cc80348ea8e240aa0df2d",
"bytes": 7634
},
{
"path": "packages/setuptools/setuptools/_vendor/backports.tarfile-1.2.0.dist-info/LICENSE",
"sha256": "86da0f01aeae46348a3c3d465195dc1ceccde79f79e87769a64b8da04b2a4741",
"bytes": 1023
},
{
"path": "packages/setuptools/setuptools/_vendor/importlib_metadata-8.7.1.dist-info/licenses/LICENSE",
"sha256": "458502e12d97bbf64438606a20044aa85eb05fb0a8a807bb35dbec253fd1fc04",
"bytes": 10278
},
{
"path": "packages/setuptools/setuptools/_vendor/jaraco.text-4.0.0.dist-info/LICENSE",
"sha256": "86da0f01aeae46348a3c3d465195dc1ceccde79f79e87769a64b8da04b2a4741",
"bytes": 1023
},
{
"path": "packages/setuptools/setuptools/_vendor/jaraco_context-6.1.0.dist-info/licenses/LICENSE",
"sha256": "9755a18519666e5f0f4cae3daad3d7012bcae48a600b31237d75e9fe134e6683",
"bytes": 1076
},
{
"path": "packages/setuptools/setuptools/_vendor/jaraco_functools-4.4.0.dist-info/licenses/LICENSE",
"sha256": "5a57cb4db85e2a2dd88c290628908add57e3451449e0a9a71fdfb38776fd759d",
"bytes": 1076
},
{
"path": "packages/setuptools/setuptools/_vendor/more_itertools-10.8.0.dist-info/licenses/LICENSE",
"sha256": "09f1c8c9e941af3e584d59641ea9b87d83c0cb0fd007eb5ef391a7e2643c1a46",
"bytes": 1053
},
{
"path": "packages/setuptools/setuptools/_vendor/packaging-26.0.dist-info/licenses/LICENSE",
"sha256": "cad1ef5bd340d73e074ba614d26f7deaca5c7940c3d8c34852e65c4909686c48",
"bytes": 197
},
{
"path": "packages/setuptools/setuptools/_vendor/packaging-26.0.dist-info/licenses/LICENSE.APACHE",
"sha256": "0d542e0c8804e39aa7f37eb00da5a762149dc682d7829451287e11b938e94594",
"bytes": 10174
},
{
"path": "packages/setuptools/setuptools/_vendor/packaging-26.0.dist-info/licenses/LICENSE.BSD",
"sha256": "b70e7e9b742f1cc6f948b34c16aa39ffece94196364bc88ff0d2180f0028fac5",
"bytes": 1344
},
{
"path": "packages/setuptools/setuptools/_vendor/platformdirs-4.4.0.dist-info/licenses/LICENSE",
"sha256": "29e0fd62e929850e86eb28c3fdccf0cefdf4fa94879011cffb3d0d4bed6d4db6",
"bytes": 1089
},
{
"path": "packages/setuptools/setuptools/_vendor/tomli-2.4.0.dist-info/licenses/LICENSE",
"sha256": "b80816b0d530b8accb4c2211783790984a6e3b61922c2b5ee92f3372ab2742fe",
"bytes": 1072
},
{
"path": "packages/setuptools/setuptools/_vendor/wheel-0.46.3.dist-info/licenses/LICENSE.txt",
"sha256": "30c23618679108f3e8ea1d2a658c7ca417bdfc891c98ef1a89fa4ff0c9828654",
"bytes": 1107
},
{
"path": "packages/setuptools/setuptools/_vendor/zipp-3.23.0.dist-info/licenses/LICENSE",
"sha256": "5a57cb4db85e2a2dd88c290628908add57e3451449e0a9a71fdfb38776fd759d",
"bytes": 1076
},
{
"path": "packages/setuptools/setuptools/config/NOTICE",
"sha256": "2dddf08818297a3b89d43d95ff659d8da85741108c9136dfa3a4d856c0623bd8",
"bytes": 493
},
{
"path": "packages/setuptools/setuptools/config/_validate_pyproject/NOTICE",
"sha256": "09c9bcea95ca086f8bc5bed174e40bc835b297d40fb5f86bbbb570fe0a5581a7",
"bytes": 18737
}
]
}
],
"runtime_notices": [
{
"path": "runtime/Python-LICENSE.txt",
"sha256": "886a0ead2d89030ee62dbff52b04e47ab91998341295bb9c56fb952b4e081c7a",
"bytes": 25066
},
{
"path": "runtime/tcl-tk/tk8.6/license.terms",
"sha256": "0d1e4405f6273f091732764ed89b57066be63ce64869be6c71ea337dc4f2f9b5",
"bytes": 2307
}
],
"additional_sources_and_notices": [
{
"path": "sources/paramiko-4.0.0.tar.gz",
"sha256": "6a25f07b380cc9c9a88d2b920ad37167ac4667f8d9886ccebd8f90f654b5d69f",
"bytes": 1630743,
"source": "https://files.pythonhosted.org/packages/1f/e7/81fdcbc7f190cdb058cffc9431587eb289833bdd633e2002455ca9bb13d4/paramiko-4.0.0.tar.gz",
"metadata_source": "https://pypi.org/pypi/paramiko/4.0.0/json"
},
{
"path": "runtime/openssl-3.5.8-LICENSE.txt",
"sha256": "7d5450cb2d142651b8afa315b5f238efc805dad827d91ba367d8516bc9d49e7a",
"bytes": 10175,
"source": "https://raw.githubusercontent.com/openssl/openssl/openssl-3.5.8/LICENSE.txt"
},
{
"path": "runtime/openssl-4.0.3-LICENSE.txt",
"sha256": "7d5450cb2d142651b8afa315b5f238efc805dad827d91ba367d8516bc9d49e7a",
"bytes": 10175,
"source": "https://raw.githubusercontent.com/openssl/openssl/openssl-4.0.3/LICENSE.txt"
},
{
"path": "runtime/tcl-LICENSE.terms",
"sha256": "c0a69a2bfd757361ec7e6143973b103c90409316b49e9c88db26ad6388e79f16",
"bytes": 2255,
"source": "https://raw.githubusercontent.com/tcltk/tcl/core-8-6-12/license.terms"
}
]
}
@@ -0,0 +1,174 @@
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.
@@ -0,0 +1,18 @@
/*
* ISC License
*
* Copyright (c) 2013-2026
* Frank Denis <j at pureftpd dot org>
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
@@ -0,0 +1,296 @@
Pygments is written and maintained by Georg Brandl <georg@python.org>.
Major developers are Tim Hatch <tim@timhatch.com> and Armin Ronacher
<armin.ronacher@active-4.com>.
Other contributors, listed alphabetically, are:
* Sam Aaron -- Ioke lexer
* Jean Abou Samra -- LilyPond lexer
* João Abecasis -- JSLT lexer
* Ali Afshar -- image formatter
* Thomas Aglassinger -- Easytrieve, JCL, Rexx, Transact-SQL and VBScript
lexers
* Maxence Ahlouche -- PostgreSQL Explain lexer
* Muthiah Annamalai -- Ezhil lexer
* Nikolay Antipov -- OpenSCAD lexer
* Kumar Appaiah -- Debian control lexer
* Andreas Amann -- AppleScript lexer
* Timothy Armstrong -- Dart lexer fixes
* Jeffrey Arnold -- R/S, Rd, BUGS, Jags, and Stan lexers
* Eiríkr Åsheim -- Uxntal lexer
* Jeremy Ashkenas -- CoffeeScript lexer
* José Joaquín Atria -- Praat lexer
* Stefan Matthias Aust -- Smalltalk lexer
* Lucas Bajolet -- Nit lexer
* Ben Bangert -- Mako lexers
* Max Battcher -- Darcs patch lexer
* Thomas Baruchel -- APL lexer
* Tim Baumann -- (Literate) Agda lexer
* Paul Baumgart, 280 North, Inc. -- Objective-J lexer
* Michael Bayer -- Myghty lexers
* Thomas Beale -- Archetype lexers
* John Benediktsson -- Factor lexer
* David Benjamin, Google LLC -- TLS lexer
* Trevor Bergeron -- mIRC formatter
* Vincent Bernat -- LessCSS lexer
* Christopher Bertels -- Fancy lexer
* Sébastien Bigaret -- QVT Operational lexer
* Jarrett Billingsley -- MiniD lexer
* Adam Blinkinsop -- Haskell, Redcode lexers
* Stéphane Blondon -- Procfile, SGF and Sieve lexers
* Frits van Bommel -- assembler lexers
* Pierre Bourdon -- bugfixes
* Martijn Braam -- Kernel log lexer, BARE lexer
* JD Browne, Google LLC -- GoogleSQL lexer
* Matthias Bussonnier -- ANSI style handling for terminal-256 formatter
* chebee7i -- Python traceback lexer improvements
* Hiram Chirino -- Scaml and Jade lexers
* Mauricio Caceres -- SAS and Stata lexers.
* Michael Camilleri, John Gabriele, sogaiu -- Janet lexer
* Daren Chandisingh -- Gleam lexer
* Ian Cooper -- VGL lexer
* David Corbett -- Inform, Jasmin, JSGF, Snowball, and TADS 3 lexers
* Leaf Corcoran -- MoonScript lexer
* Fraser Cormack -- TableGen lexer
* Gabriel Corona -- ASN.1 lexer
* Radu Costache -- Boogie and Civl Verifier lexer improvements
* Christopher Creutzig -- MuPAD lexer
* Daniël W. Crompton -- Pike lexer
* Pete Curry -- bugfixes
* Bryan Davis -- EBNF lexer
* Bruno Deferrari -- Shen lexer
* Walter Dörwald -- UL4 lexer
* Luke Drummond -- Meson lexer
* Giedrius Dubinskas -- HTML formatter improvements
* Owen Durni -- Haxe lexer
* Alexander Dutton, Oxford University Computing Services -- SPARQL lexer
* James Edwards -- Terraform lexer
* Nick Efford -- Python 3 lexer
* Sven Efftinge -- Xtend lexer
* Artem Egorkine -- terminal256 formatter
* Matthew Fernandez -- CAmkES lexer
* Paweł Fertyk -- GDScript lexer, HTML formatter improvements
* Michael Ficarra -- CPSA lexer
* James H. Fisher -- PostScript lexer
* Amanda Fitch, Google LLC -- GoogleSQL lexer
* William S. Fulton -- SWIG lexer
* Carlos Galdino -- Elixir and Elixir Console lexers
* Michael Galloy -- IDL lexer
* Naveen Garg -- Autohotkey lexer
* Simon Garnotel -- FreeFem++ lexer
* Laurent Gautier -- R/S lexer
* Alex Gaynor -- PyPy log lexer
* Richard Gerkin -- Igor Pro lexer
* Alain Gilbert -- TypeScript lexer
* Alex Gilding -- BlitzBasic lexer
* GitHub, Inc -- DASM16, Augeas, TOML, and Slash lexers
* Bertrand Goetzmann -- Groovy lexer
* Krzysiek Goj -- Scala lexer
* Rostyslav Golda -- FloScript lexer
* Andrey Golovizin -- BibTeX lexers
* Matt Good -- Genshi, Cheetah lexers
* Michał Górny -- vim modeline support
* Alex Gosse -- TrafficScript lexer
* Patrick Gotthardt -- PHP namespaces support
* Hubert Gruniaux -- C and C++ lexer improvements
* Olivier Guibe -- Asymptote lexer
* Armin Günther -- Go lexer improvements
* Phil Hagelberg -- Fennel lexer
* Florian Hahn -- Boogie lexer
* Martin Harriman -- SNOBOL lexer
* Matthew Harrison -- SVG formatter
* Steven Hazel -- Tcl lexer
* Dan Michael Heggø -- Turtle lexer
* Aslak Hellesøy -- Gherkin lexer
* Greg Hendershott -- Racket lexer
* Justin Hendrick -- ParaSail lexer
* Jordi Gutiérrez Hermoso -- Octave lexer
* David Hess, Fish Software, Inc. -- Objective-J lexer
* Ken Hilton -- Typographic Number Theory and Arrow lexers
* Varun Hiremath -- Debian control lexer
* Rob Hoelz -- Perl 6 lexer
* Doug Hogan -- Mscgen lexer
* Ben Hollis -- Mason lexer
* Max Horn -- GAP lexer
* Fred Hornsey -- OMG IDL Lexer
* Alastair Houghton -- Lexer inheritance facility
* Tim Howard -- BlitzMax lexer
* Dustin Howett -- Logos lexer
* Ivan Inozemtsev -- Fantom lexer
* Hiroaki Itoh -- Shell console rewrite, Lexers for PowerShell session,
MSDOS session, BC, WDiff
* Brian R. Jackson -- Tea lexer
* Alex Jeffery, ChromaWay AB -- Rell lexer
* Christian Jann -- ShellSession lexer
* Jonas Camillus Jeppesen -- Line numbers and line highlighting for
RTF-formatter
* Dennis Kaarsemaker -- sources.list lexer
* Dmitri Kabak -- Inferno Limbo lexer
* Igor Kalnitsky -- vhdl lexer
* Colin Kennedy - USD lexer
* Alexander Kit -- MaskJS lexer
* Pekka Klärck -- Robot Framework lexer
* Gerwin Klein -- Isabelle lexer
* Eric Knibbe -- Lasso lexer
* Stepan Koltsov -- Clay lexer
* Oliver Kopp - Friendly grayscale style
* Adam Koprowski -- Opa lexer
* Benjamin Kowarsch -- Modula-2 lexer
* Domen Kožar -- Nix lexer
* Oleh Krekel -- Emacs Lisp lexer
* Alexander Kriegisch -- Kconfig and AspectJ lexers
* Marek Kubica -- Scheme lexer
* Jochen Kupperschmidt -- Markdown processor
* Gerd Kurzbach -- Modelica lexer
* Jon Larimer, Google Inc. -- Smali lexer
* Olov Lassus -- Dart lexer
* Matt Layman -- TAP lexer
* Dan Lazin, Google LLC -- GoogleSQL lexer
* Kristian Lyngstøl -- Varnish lexers
* Sylvestre Ledru -- Scilab lexer
* Chee Sing Lee -- Flatline lexer
* Mark Lee -- Vala lexer
* Thomas Linder Puls -- Visual Prolog lexer
* Pete Lomax -- Phix lexer
* Valentin Lorentz -- C++ lexer improvements
* Ben Mabey -- Gherkin lexer
* Angus MacArthur -- QML lexer
* Louis Mandel -- X10 lexer
* Louis Marchand -- Eiffel lexer
* Simone Margaritelli -- Hybris lexer
* Tim Martin - World of Warcraft TOC lexer
* Kirk McDonald -- D lexer
* Gordon McGregor -- SystemVerilog lexer
* Stephen McKamey -- Duel/JBST lexer
* Brian McKenna -- F# lexer
* Charles McLaughlin -- Puppet lexer
* Kurt McKee -- Tera Term macro lexer, PostgreSQL updates, MySQL overhaul, JSON lexer
* Joe Eli McIlvain -- Savi lexer
* Lukas Meuser -- BBCode formatter, Lua lexer
* Bruno Mesquita -- Night Owl style
* Cat Miller -- Pig lexer
* Paul Miller -- LiveScript lexer
* Hong Minhee -- HTTP lexer
* Michael Mior -- Awk lexer
* Bruce Mitchener -- Dylan lexer rewrite
* Reuben Morais -- SourcePawn lexer
* Jon Morton -- Rust lexer
* Paulo Moura -- Logtalk lexer
* Mher Movsisyan -- DTD lexer
* Dejan Muhamedagic -- Crmsh lexer
* Adrien Nayrat -- PostgreSQL Explain lexer
* Ana Nelson -- Ragel, ANTLR, R console lexers
* David Neto, Google LLC -- WebGPU Shading Language lexer
* Kurt Neufeld -- Markdown lexer
* Nam T. Nguyen -- Monokai style
* Jesper Noehr -- HTML formatter "anchorlinenos"
* Mike Nolta -- Julia lexer
* Avery Nortonsmith -- Pointless lexer
* Jonas Obrist -- BBCode lexer
* Edward O'Callaghan -- Cryptol lexer
* David Oliva -- Rebol lexer
* Pat Pannuto -- nesC lexer
* Jon Parise -- Protocol buffers and Thrift lexers
* Benjamin Peterson -- Test suite refactoring
* Ronny Pfannschmidt -- BBCode lexer
* Dominik Picheta -- Nimrod lexer
* Andrew Pinkham -- RTF Formatter Refactoring
* Clément Prévost -- UrbiScript lexer
* Tanner Prynn -- cmdline -x option and loading lexers from files
* Oleh Prypin -- Crystal lexer (based on Ruby lexer)
* Nick Psaris -- K and Q lexers
* Xidorn Quan -- Web IDL lexer
* Elias Rabel -- Fortran fixed form lexer
* raichoo -- Idris lexer
* Daniel Ramirez -- GDScript lexer
* Kashif Rasul -- CUDA lexer
* Nathan Reed -- HLSL lexer
* Justin Reidy -- MXML lexer
* Jonathon Reinhart, Google LLC -- Soong lexer
* Norman Richards -- JSON lexer
* Corey Richardson -- Rust lexer updates
* Fabrizio Riguzzi -- cplint leder
* Lubomir Rintel -- GoodData MAQL and CL lexers
* Andre Roberge -- Tango style
* Georg Rollinger -- HSAIL lexer
* Michiel Roos -- TypoScript lexer
* Konrad Rudolph -- LaTeX formatter enhancements
* Mario Ruggier -- Evoque lexers
* Miikka Salminen -- Lovelace style, Hexdump lexer, lexer enhancements
* Stou Sandalski -- NumPy, FORTRAN, tcsh and XSLT lexers
* Matteo Sasso -- Common Lisp lexer
* Joe Schafer -- Ada lexer
* Max Schillinger -- TiddlyWiki5 lexer
* Andrew Schmidt -- X++ lexer
* Ken Schutte -- Matlab lexers
* René Schwaiger -- Rainbow Dash style
* Sebastian Schweizer -- Whiley lexer
* Tassilo Schweyer -- Io, MOOCode lexers
* Pablo Seminario -- PromQL lexer
* Ted Shaw -- AutoIt lexer
* Joerg Sieker -- ABAP lexer
* Robert Simmons -- Standard ML lexer
* Kirill Simonov -- YAML lexer
* Corbin Simpson -- Monte lexer
* Ville Skyttä -- ASCII armored lexer
* Alexander Smishlajev -- Visual FoxPro lexer
* Steve Spigarelli -- XQuery lexer
* Jerome St-Louis -- eC lexer
* Camil Staps -- Clean and NuSMV lexers; Solarized style
* James Strachan -- Kotlin lexer
* Tom Stuart -- Treetop lexer
* Colin Sullivan -- SuperCollider lexer
* Ben Swift -- Extempore lexer
* tatt61880 -- Kuin lexer
* Edoardo Tenani -- Arduino lexer
* Tiberius Teng -- default style overhaul
* Jeremy Thurgood -- Erlang, Squid config lexers
* Brian Tiffin -- OpenCOBOL lexer
* Bob Tolbert -- Hy lexer
* Doug Torrance -- Macaulay2 lexer
* Matthias Trute -- Forth lexer
* Tuoa Spi T4 -- Bdd lexer
* Erick Tryzelaar -- Felix lexer
* Alexander Udalov -- Kotlin lexer improvements
* Thomas Van Doren -- Chapel lexer
* Dave Van Ee -- Uxntal lexer updates
* Daniele Varrazzo -- PostgreSQL lexers
* Abe Voelker -- OpenEdge ABL lexer
* Pepijn de Vos -- HTML formatter CTags support
* Matthias Vallentin -- Bro lexer
* Benoît Vinot -- AMPL lexer
* Linh Vu Hong -- RSL lexer
* Taavi Väänänen -- Debian control, PHP lexers
* Immanuel Washington -- Smithy lexer
* Nathan Weizenbaum -- Haml and Sass lexers
* Nathan Whetsell -- Csound lexers
* Dietmar Winkler -- Modelica lexer
* Nils Winter -- Smalltalk lexer
* Trevor Woerner -- BitBake lexer
* Davy Wybiral -- Clojure lexer
* Whitney Young -- ObjectiveC lexer
* Diego Zamboni -- CFengine3 lexer
* Enrique Zamudio -- Ceylon lexer
* Alex Zimin -- Nemerle lexer
* Rob Zimmerman -- Kal lexer
* Evgenii Zheltonozhskii -- Maple lexer
* Vincent Zurczak -- Roboconf lexer
* Hubert Gruniaux -- C and C++ lexer improvements
* Thomas Symalla -- AMDGPU Lexer
* 15b3 -- Image Formatter improvements
* Fabian Neumann -- CDDL lexer
* Thomas Duboucher -- CDDL lexer
* Philipp Imhof -- Pango Markup formatter
* Thomas Voss -- Sed lexer
* Martin Fischer -- WCAG contrast testing
* Marc Auberer -- Spice lexer
* Amr Hesham -- Carbon lexer
* diskdance -- Wikitext lexer
* vanillajonathan -- PRQL lexer
* Nikolay Antipov -- OpenSCAD lexer
* Markus Meyer, Nextron Systems -- YARA lexer
* Hannes Römer -- Mojo lexer
* Jan Frederik Schaefer -- PDDL lexer
Many thanks for all contributions!
@@ -0,0 +1,25 @@
Copyright (c) 2006-2022 by the respective authors (see AUTHORS file).
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,18 @@
Copyright (c) 2004 Istvan Albert unless otherwise noted.
Copyright (c) 2006-2010 Bob Ippolito
Copyright (2) 2010-2020 Ronald Oussoren, et. al.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
@@ -0,0 +1,201 @@
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.
@@ -0,0 +1,23 @@
Except when otherwise stated (look for LICENSE files in directories or
information at the beginning of each file) all software and
documentation is licensed as follows:
MIT No Attribution
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the
Software is furnished to do so.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,27 @@
Copyright (c) 2010 Jonathan Hartley
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holders, nor those of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,3 @@
This software is made available under the terms of *either* of the licenses
found in LICENSE.APACHE or LICENSE.BSD. Contributions to cryptography are made
under the terms of *both* these licenses.
@@ -0,0 +1,202 @@
Apache License
Version 2.0, January 2004
https://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
https://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.
@@ -0,0 +1,27 @@
Copyright (c) Individual contributors.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of PyCA Cryptography nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,25 @@
MIT License
Copyright (c) 2026 Halo Steam Frame Installer contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
This license covers original installer code. Refer to docs/THIRD_PARTY.md
and resources/licenses for upstream code, patch, dependencies, and notices.
Commercial Halo game data is not included or licensed by this project.
@@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2010 - 2023 Holger Krekel and others
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@@ -0,0 +1,22 @@
Copyright (c) 2020 Jeff Forcier.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,3 @@
This software is made available under the terms of *either* of the licenses
found in LICENSE.APACHE or LICENSE.BSD. Contributions to this software is made
under the terms of *both* these licenses.
@@ -0,0 +1,177 @@
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
@@ -0,0 +1,23 @@
Copyright (c) Donald Stufft and individual contributors.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,504 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 2.1, February 1999
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
51 Franklin Street, Suite 500, Boston, MA 02110-1335 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
[This is the first released version of the Lesser GPL. It also counts
as the successor of the GNU Library Public License, version 2, hence
the version number 2.1.]
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
free software--to make sure the software is free for all its users.
This license, the Lesser General Public License, applies to some
specially designated software packages--typically libraries--of the
Free Software Foundation and other authors who decide to use it. You
can use it too, but we suggest you first think carefully about whether
this license or the ordinary General Public License is the better
strategy to use in any particular case, based on the explanations below.
When we speak of free software, we are referring to freedom of use,
not price. Our General Public Licenses are designed to make sure that
you have the freedom to distribute copies of free software (and charge
for this service if you wish); that you receive source code or can get
it if you want it; that you can change the software and use pieces of
it in new free programs; and that you are informed that you can do
these things.
To protect your rights, we need to make restrictions that forbid
distributors to deny you these rights or to ask you to surrender these
rights. These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it.
For example, if you distribute copies of the library, whether gratis
or for a fee, you must give the recipients all the rights that we gave
you. You must make sure that they, too, receive or can get the source
code. If you link other code with the library, you must provide
complete object files to the recipients, so that they can relink them
with the library after making changes to the library and recompiling
it. And you must show them these terms so they know their rights.
We protect your rights with a two-step method: (1) we copyright the
library, and (2) we offer you this license, which gives you legal
permission to copy, distribute and/or modify the library.
To protect each distributor, we want to make it very clear that
there is no warranty for the free library. Also, if the library is
modified by someone else and passed on, the recipients should know
that what they have is not the original version, so that the original
author's reputation will not be affected by problems that might be
introduced by others.
Finally, software patents pose a constant threat to the existence of
any free program. We wish to make sure that a company cannot
effectively restrict the users of a free program by obtaining a
restrictive license from a patent holder. Therefore, we insist that
any patent license obtained for a version of the library must be
consistent with the full freedom of use specified in this license.
Most GNU software, including some libraries, is covered by the
ordinary GNU General Public License. This license, the GNU Lesser
General Public License, applies to certain designated libraries, and
is quite different from the ordinary General Public License. We use
this license for certain libraries in order to permit linking those
libraries into non-free programs.
When a program is linked with a library, whether statically or using
a shared library, the combination of the two is legally speaking a
combined work, a derivative of the original library. The ordinary
General Public License therefore permits such linking only if the
entire combination fits its criteria of freedom. The Lesser General
Public License permits more lax criteria for linking other code with
the library.
We call this license the "Lesser" General Public License because it
does Less to protect the user's freedom than the ordinary General
Public License. It also provides other free software developers Less
of an advantage over competing non-free programs. These disadvantages
are the reason we use the ordinary General Public License for many
libraries. However, the Lesser license provides advantages in certain
special circumstances.
For example, on rare occasions, there may be a special need to
encourage the widest possible use of a certain library, so that it becomes
a de-facto standard. To achieve this, non-free programs must be
allowed to use the library. A more frequent case is that a free
library does the same job as widely used non-free libraries. In this
case, there is little to gain by limiting the free library to free
software only, so we use the Lesser General Public License.
In other cases, permission to use a particular library in non-free
programs enables a greater number of people to use a large body of
free software. For example, permission to use the GNU C Library in
non-free programs enables many more people to use the whole GNU
operating system, as well as its variant, the GNU/Linux operating
system.
Although the Lesser General Public License is Less protective of the
users' freedom, it does ensure that the user of a program that is
linked with the Library has the freedom and the wherewithal to run
that program using a modified version of the Library.
The precise terms and conditions for copying, distribution and
modification follow. Pay close attention to the difference between a
"work based on the library" and a "work that uses the library". The
former contains code derived from the library, whereas the latter must
be combined with the library in order to run.
GNU LESSER GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any software library or other
program which contains a notice placed by the copyright holder or
other authorized party saying it may be distributed under the terms of
this Lesser General Public License (also called "this License").
Each licensee is addressed as "you".
A "library" means a collection of software functions and/or data
prepared so as to be conveniently linked with application programs
(which use some of those functions and data) to form executables.
The "Library", below, refers to any such software library or work
which has been distributed under these terms. A "work based on the
Library" means either the Library or any derivative work under
copyright law: that is to say, a work containing the Library or a
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language. (Hereinafter, translation is
included without limitation in the term "modification".)
"Source code" for a work means the preferred form of the work for
making modifications to it. For a library, complete source code means
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation
and installation of the library.
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does
and what the program that uses the Library does.
1. You may copy and distribute verbatim copies of the Library's
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an
appropriate copyright notice and disclaimer of warranty; keep intact
all the notices that refer to this License and to the absence of any
warranty; and distribute a copy of this License along with the
Library.
You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.
2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) The modified work must itself be a software library.
b) You must cause the files modified to carry prominent notices
stating that you changed the files and the date of any change.
c) You must cause the whole of the work to be licensed at no
charge to all third parties under the terms of this License.
d) If a facility in the modified Library refers to a function or a
table of data to be supplied by an application program that uses
the facility, other than as an argument passed when the facility
is invoked, then you must make a good faith effort to ensure that,
in the event an application does not supply such function or
table, the facility still operates, and performs whatever part of
its purpose remains meaningful.
(For example, a function in a library to compute square roots has
a purpose that is entirely well-defined independent of the
application. Therefore, Subsection 2d requires that any
application-supplied function or table used by this function must
be optional: if the application does not supply it, the square
root function must still compute square roots.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Library, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote
it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Library.
In addition, mere aggregation of another work not based on the Library
with the Library (or with a work based on the Library) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may opt to apply the terms of the ordinary GNU General Public
License instead of this License to a given copy of the Library. To do
this, you must alter all the notices that refer to this License, so
that they refer to the ordinary GNU General Public License, version 2,
instead of to this License. (If a newer version than version 2 of the
ordinary GNU General Public License has appeared, then you can specify
that version instead if you wish.) Do not make any other change in
these notices.
Once this change is made in a given copy, it is irreversible for
that copy, so the ordinary GNU General Public License applies to all
subsequent copies and derivative works made from that copy.
This option is useful when you wish to copy part of the code of
the Library into a program that is not a library.
4. You may copy and distribute the Library (or a portion or
derivative of it, under Section 2) in object code or executable form
under the terms of Sections 1 and 2 above provided that you accompany
it with the complete corresponding machine-readable source code, which
must be distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange.
If distribution of object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the
source code from the same place satisfies the requirement to
distribute the source code, even though third parties are not
compelled to copy the source along with the object code.
5. A program that contains no derivative of any portion of the
Library, but is designed to work with the Library by being compiled or
linked with it, is called a "work that uses the Library". Such a
work, in isolation, is not a derivative work of the Library, and
therefore falls outside the scope of this License.
However, linking a "work that uses the Library" with the Library
creates an executable that is a derivative of the Library (because it
contains portions of the Library), rather than a "work that uses the
library". The executable is therefore covered by this License.
Section 6 states terms for distribution of such executables.
When a "work that uses the Library" uses material from a header file
that is part of the Library, the object code for the work may be a
derivative work of the Library even though the source code is not.
Whether this is true is especially significant if the work can be
linked without the Library, or if the work is itself a library. The
threshold for this to be true is not precisely defined by law.
If such an object file uses only numerical parameters, data
structure layouts and accessors, and small macros and small inline
functions (ten lines or less in length), then the use of the object
file is unrestricted, regardless of whether it is legally a derivative
work. (Executables containing this object code plus portions of the
Library will still fall under Section 6.)
Otherwise, if the work is a derivative of the Library, you may
distribute the object code for the work under the terms of Section 6.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself.
6. As an exception to the Sections above, you may also combine or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse
engineering for debugging such modifications.
You must give prominent notice with each copy of the work that the
Library is used in it and that the Library and its use are covered by
this License. You must supply a copy of this License. If the work
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License. Also, you must do one
of these things:
a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever
changes were used in the work (which must be distributed under
Sections 1 and 2 above); and, if the work is an executable linked
with the Library, with the complete machine-readable "work that
uses the Library", as object code and/or source code, so that the
user can modify the Library and then relink to produce a modified
executable containing the modified Library. (It is understood
that the user who changes the contents of definitions files in the
Library will not necessarily be able to recompile the application
to use the modified definitions.)
b) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (1) uses at run time a
copy of the library already present on the user's computer system,
rather than copying library functions into the executable, and (2)
will operate properly with a modified version of the library, if
the user installs one, as long as the modified version is
interface-compatible with the version that the work was made with.
c) Accompany the work with a written offer, valid for at
least three years, to give the same user the materials
specified in Subsection 6a, above, for a charge no more
than the cost of performing this distribution.
d) If distribution of the work is made by offering access to copy
from a designated place, offer equivalent access to copy the above
specified materials from the same place.
e) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy.
For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it. However, as a special exception,
the materials to be distributed need not include anything that is
normally distributed (in either source or binary form) with the major
components (compiler, kernel, and so on) of the operating system on
which the executable runs, unless that component itself accompanies
the executable.
It may happen that this requirement contradicts the license
restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.
7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
library, provided that the separate distribution of the work based on
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:
a) Accompany the combined library with a copy of the same work
based on the Library, uncombined with any other library
facilities. This must be distributed under the terms of the
Sections above.
b) Give prominent notice with the combined library of the fact
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
8. You may not copy, modify, sublicense, link with, or distribute
the Library except as expressly provided under this License. Any
attempt otherwise to copy, modify, sublicense, link with, or
distribute the Library is void, and will automatically terminate your
rights under this License. However, parties who have received copies,
or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
9. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Library or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Library (or any work based on the
Library), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Library or works based on it.
10. Each time you redistribute the Library (or any work based on the
Library), the recipient automatically receives a license from the
original licensor to copy, distribute, link with or modify the Library
subject to these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties with
this License.
11. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Library at all. For example, if a patent
license would not permit royalty-free redistribution of the Library by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Library.
If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply,
and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
12. If the distribution and/or use of the Library is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Library under this License may add
an explicit geographical distribution limitation excluding those countries,
so that distribution is permitted only in or among countries not thus
excluded. In such case, this License incorporates the limitation as if
written in the body of this License.
13. The Free Software Foundation may publish revised and/or new
versions of the Lesser General Public License from time to time.
Such new versions will be similar in spirit to the present version,
but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Library
specifies a version number of this License which applies to it and
"any later version", you have the option of following the terms and
conditions either of that version or of any later version published by
the Free Software Foundation. If the Library does not specify a
license version number, you may choose any version ever published by
the Free Software Foundation.
14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these,
write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this. Our
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change. You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of the
ordinary General Public License).
To apply these terms, attach the following notices to the library. It is
safest to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
<one line to give the library's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335 USA
Also add information on how to contact you by electronic and paper mail.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the library, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
<signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!
@@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2004-2024 Ero Carrera
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@@ -0,0 +1,806 @@
@Switch01
A_Rog
Aakanksha Agrawal
Abhinav Sagar
ABHYUDAY PRATAP SINGH
abs51295
AceGentile
Adam Chainz
Adam Tse
Adam Wentz
admin
Adolfo Ochagavía
Adrien Morison
Agus
ahayrapetyan
Ahilya
AinsworthK
Akash Srivastava
Alan Yee
Albert Tugushev
Albert-Guan
albertg
Alberto Sottile
Aleks Bunin
Ales Erjavec
Alethea Flowers
Alex Gaynor
Alex Grönholm
Alex Hedges
Alex Loosley
Alex Morega
Alex Stachowiak
Alexander Shtyrov
Alexandre Conrad
Alexey Popravka
Aleš Erjavec
Alli
Ami Fischman
Ananya Maiti
Anatoly Techtonik
Anders Kaseorg
Andre Aguiar
Andreas Lutro
Andrei Geacar
Andrew Gaul
Andrew Shymanel
Andrey Bienkowski
Andrey Bulgakov
Andrés Delfino
Andy Freeland
Andy Kluger
Ani Hayrapetyan
Aniruddha Basak
Anish Tambe
Anrs Hu
Anthony Sottile
Antoine Musso
Anton Ovchinnikov
Anton Patrushev
Anton Zelenov
Antonio Alvarado Hernandez
Antony Lee
Antti Kaihola
Anubhav Patel
Anudit Nagar
Anuj Godase
AQNOUCH Mohammed
AraHaan
arena
arenasys
Arindam Choudhury
Armin Ronacher
Arnon Yaari
Artem
Arun Babu Neelicattu
Ashley Manton
Ashwin Ramaswami
atse
Atsushi Odagiri
Avinash Karhana
Avner Cohen
Awit (Ah-Wit) Ghirmai
Baptiste Mispelon
Barney Gale
barneygale
Bartek Ogryczak
Bastian Venthur
Ben Bodenmiller
Ben Darnell
Ben Hoyt
Ben Mares
Ben Rosser
Bence Nagy
Benjamin Peterson
Benjamin VanEvery
Benoit Pierre
Berker Peksag
Bernard
Bernard Tyers
Bernardo B. Marques
Bernhard M. Wiedemann
Bertil Hatt
Bhavam Vidyarthi
Blazej Michalik
Bogdan Opanchuk
BorisZZZ
Brad Erickson
Bradley Ayers
Branch Vincent
Brandon L. Reiss
Brandt Bucher
Brannon Dorsey
Brett Randall
Brett Rosen
Brian Cristante
Brian Rosner
briantracy
BrownTruck
Bruno Oliveira
Bruno Renié
Bruno S
Bstrdsmkr
Buck Golemon
burrows
Bussonnier Matthias
bwoodsend
c22
Caleb Brown
Caleb Martinez
Calvin Smith
Carl Meyer
Carlos Liam
Carol Willing
Carter Thayer
Cass
Chandrasekhar Atina
Charlie Marsh
charwick
Chih-Hsuan Yen
Chris Brinker
Chris Hunt
Chris Jerdonek
Chris Kuehl
Chris Markiewicz
Chris McDonough
Chris Pawley
Chris Pryer
Chris Wolfe
Christian Clauss
Christian Heimes
Christian Oudard
Christoph Reiter
Christopher Hunt
Christopher Snyder
chrysle
cjc7373
Clark Boylan
Claudio Jolowicz
Clay McClure
Cody
Cody Soyland
Colin Watson
Collin Anderson
Connor Osborn
Cooper Lees
Cooper Ry Lees
Cory Benfield
Cory Wright
Craig Kerstiens
Cristian Sorinel
Cristina
Cristina Muñoz
ctg123
Curtis Doty
cytolentino
Daan De Meyer
Dale
Damian
Damian Quiroga
Damian Shaw
Dan Black
Dan Savilonis
Dan Sully
Dane Hillard
daniel
Daniel Collins
Daniel Hahler
Daniel Holth
Daniel Jost
Daniel Katz
Daniel Shaulov
Daniele Esposti
Daniele Nicolodi
Daniele Procida
Daniil Konovalenko
Danny Hermes
Danny McClanahan
Darren Kavanagh
Dav Clark
Dave Abrahams
Dave Jones
David Aguilar
David Black
David Bordeynik
David Caro
David D Lowe
David Evans
David Hewitt
David Linke
David Poggi
David Poznik
David Pursehouse
David Runge
David Tucker
David Wales
Davidovich
ddelange
Deepak Sharma
Deepyaman Datta
Denise Yu
dependabot[bot]
derwolfe
Desetude
Devesh Kumar Singh
devsagul
Diego Caraballo
Diego Ramirez
DiegoCaraballo
Dimitri Merejkowsky
Dimitri Papadopoulos
Dimitri Papadopoulos Orfanos
Dirk Stolle
Dmitry Gladkov
Dmitry Volodin
Domen Kožar
Dominic Davis-Foster
Donald Stufft
Dongweiming
doron zarhi
Dos Moonen
Douglas Thor
DrFeathers
Dustin Ingram
Dustin Rodrigues
Dwayne Bailey
Ed Morley
Edgar Ramírez
Edgar Ramírez Mondragón
Ee Durbin
Efflam Lemaillet
efflamlemaillet
Eitan Adler
ekristina
elainechan
Eli Schwartz
Elisha Hollander
Ellen Marie Dash
Emil Burzo
Emil Styrke
Emmanuel Arias
Endoh Takanao
enoch
Erdinc Mutlu
Eric Cousineau
Eric Gillingham
Eric Hanchrow
Eric Hopper
Erik M. Bray
Erik Rose
Erwin Janssen
Eugene Vereshchagin
everdimension
Federico
Felipe Peter
Felix Yan
fiber-space
Filip Kokosiński
Filipe Laíns
Finn Womack
finnagin
Flavio Amurrio
Florian Briand
Florian Rathgeber
Francesco
Francesco Montesano
Fredrik Orderud
Frost Ming
Gabriel Curio
Gabriel de Perthuis
Garry Polley
gavin
gdanielson
Geoffrey Sneddon
George Song
Georgi Valkov
Georgy Pchelkin
ghost
Giftlin Rajaiah
gizmoguy1
gkdoc
Godefroid Chapelle
Gopinath M
GOTO Hayato
gousaiyang
gpiks
Greg Roodt
Greg Ward
Guilherme Espada
Guillaume Seguin
gutsytechster
Guy Rozendorn
Guy Tuval
gzpan123
Hanjun Kim
Hari Charan
Harsh Vardhan
harupy
Harutaka Kawamura
hauntsaninja
Henrich Hartzer
Henry Schreiner
Herbert Pfennig
Holly Stotelmyer
Honnix
Hsiaoming Yang
Hugo Lopes Tavares
Hugo van Kemenade
Hugues Bruant
Hynek Schlawack
Ian Bicking
Ian Cordasco
Ian Lee
Ian Stapleton Cordasco
Ian Wienand
Igor Kuzmitshov
Igor Sobreira
Ikko Ashimine
Ilan Schnell
Illia Volochii
Ilya Baryshev
Inada Naoki
Ionel Cristian Mărieș
Ionel Maries Cristian
Itamar Turner-Trauring
Ivan Pozdeev
J. Nick Koston
Jacob Kim
Jacob Walls
Jaime Sanz
jakirkham
Jakub Kuczys
Jakub Stasiak
Jakub Vysoky
Jakub Wilk
James Cleveland
James Curtin
James Firth
James Gerity
James Polley
Jan Pokorný
Jannis Leidel
Jarek Potiuk
jarondl
Jason Curtis
Jason R. Coombs
JasonMo
JasonMo1
Jay Graves
Jean Abou Samra
Jean-Christophe Fillion-Robin
Jeff Barber
Jeff Dairiki
Jeff Widman
Jelmer Vernooij
jenix21
Jeremy Fleischman
Jeremy Stanley
Jeremy Zafran
Jesse Rittner
Jiashuo Li
Jim Fisher
Jim Garrison
Jinzhe Zeng
Jiun Bae
Jivan Amara
Joe Bylund
Joe Michelini
John Paton
John Sirois
John T. Wodder II
John-Scott Atlakson
johnthagen
Jon Banafato
Jon Dufresne
Jon Parise
Jonas Nockert
Jonathan Herbert
Joonatan Partanen
Joost Molenaar
Jorge Niedbalski
Joseph Bylund
Joseph Long
Josh Bronson
Josh Cannon
Josh Hansen
Josh Schneier
Joshua
JoshuaPerdue
Juan Luis Cano Rodríguez
Juanjo Bazán
Judah Rand
Julian Berman
Julian Gethmann
Julien Demoor
July Tikhonov
Jussi Kukkonen
Justin van Heek
jwg4
Jyrki Pulliainen
Kai Chen
Kai Mueller
Kamal Bin Mustafa
Karolina Surma
kasium
kaustav haldar
keanemind
Keith Maxwell
Kelsey Hightower
Kenneth Belitzky
Kenneth Reitz
Kevin Burke
Kevin Carter
Kevin Frommelt
Kevin R Patterson
Kexuan Sun
Kit Randel
Klaas van Schelven
KOLANICH
konstin
kpinc
Krishna Oza
Kumar McMillan
Kuntal Majumder
Kurt McKee
Kyle Persohn
lakshmanaram
Laszlo Kiss-Kollar
Laurent Bristiel
Laurent LAPORTE
Laurie O
Laurie Opperman
layday
Leon Sasson
Lev Givon
Lincoln de Sousa
Lipis
lorddavidiii
Loren Carvalho
Lucas Cimon
Ludovic Gasc
Luis Medel
Lukas Geiger
Lukas Juhrich
Luke Macken
Luo Jiebin
luojiebin
luz.paz
László Kiss Kollár
M00nL1ght
Marc Abramowitz
Marc Tamlyn
Marcus Smith
Mariatta
Mark Kohler
Mark McLoughlin
Mark Williams
Markus Hametner
Martey Dodoo
Martin Fischer
Martin Häcker
Martin Pavlasek
Masaki
Masklinn
Matej Stuchlik
Mathew Jennings
Mathieu Bridon
Mathieu Kniewallner
Matt Bacchi
Matt Good
Matt Maker
Matt Robenolt
Matt Wozniski
matthew
Matthew Einhorn
Matthew Feickert
Matthew Gilliard
Matthew Hughes
Matthew Iversen
Matthew Treinish
Matthew Trumbell
Matthew Willson
Matthias Bussonnier
mattip
Maurits van Rees
Max W Chase
Maxim Kurnikov
Maxime Rouyrre
mayeut
mbaluna
mdebi
memoselyk
meowmeowcat
Michael
Michael Aquilina
Michael E. Karpeles
Michael Klich
Michael Mintz
Michael Williamson
michaelpacer
Michał Górny
Mickaël Schoentgen
Miguel Araujo Perez
Mihir Singh
Mike
Mike Hendricks
Min RK
MinRK
Miro Hrončok
Monica Baluna
montefra
Monty Taylor
morotti
mrKazzila
Muha Ajjan
Nadav Wexler
Nahuel Ambrosini
Nate Coraor
Nate Prewitt
Nathan Houghton
Nathaniel J. Smith
Nehal J Wani
Neil Botelho
Nguyễn Gia Phong
Nicholas Serra
Nick Coghlan
Nick Stenning
Nick Timkovich
Nicolas Bock
Nicole Harris
Nikhil Benesch
Nikhil Ladha
Nikita Chepanov
Nikolay Korolev
Nipunn Koorapati
Nitesh Sharma
Niyas Sait
Noah
Noah Gorny
Nowell Strite
NtaleGrey
nvdv
OBITORASU
Ofek Lev
ofrinevo
Oliver Freund
Oliver Jeeves
Oliver Mannion
Oliver Tonnhofer
Olivier Girardot
Olivier Grisel
Ollie Rutherfurd
OMOTO Kenji
Omry Yadan
onlinejudge95
Oren Held
Oscar Benjamin
Oz N Tiram
Pachwenko
Patrick Dubroy
Patrick Jenkins
Patrick Lawson
patricktokeeffe
Patrik Kopkan
Paul Ganssle
Paul Kehrer
Paul Moore
Paul Nasrat
Paul Oswald
Paul van der Linden
Paulus Schoutsen
Pavel Safronov
Pavithra Eswaramoorthy
Pawel Jasinski
Paweł Szramowski
Pekka Klärck
Peter Gessler
Peter Lisák
Peter Shen
Peter Waller
Petr Viktorin
petr-tik
Phaneendra Chiruvella
Phil Elson
Phil Freo
Phil Pennock
Phil Whelan
Philip Jägenstedt
Philip Molloy
Philippe Ombredanne
Pi Delport
Pierre-Yves Rofes
Pieter Degroote
pip
Prabakaran Kumaresshan
Prabhjyotsing Surjit Singh Sodhi
Prabhu Marappan
Pradyun Gedam
Prashant Sharma
Pratik Mallya
pre-commit-ci[bot]
Preet Thakkar
Preston Holmes
Przemek Wrzos
Pulkit Goyal
q0w
Qiangning Hong
Qiming Xu
Quentin Lee
Quentin Pradet
R. David Murray
Rafael Caricio
Ralf Schmitt
Ran Benita
Randy Döring
Razzi Abuissa
rdb
Reece Dunham
Remi Rampin
Rene Dudfield
Riccardo Magliocchetti
Riccardo Schirone
Richard Jones
Richard Si
Ricky Ng-Adam
Rishi
rmorotti
RobberPhex
Robert Collins
Robert McGibbon
Robert Pollak
Robert T. McGibbon
robin elisha robinson
Roey Berman
Rohan Jain
Roman Bogorodskiy
Roman Donchenko
Romuald Brunet
ronaudinho
Ronny Pfannschmidt
Rory McCann
Ross Brattain
Roy Wellington Ⅳ
Ruairidh MacLeod
Russell Keith-Magee
Ryan Shepherd
Ryan Wooden
ryneeverett
S. Guliaev
Sachi King
Salvatore Rinchiera
sandeepkiran-js
Sander Van Balen
Savio Jomton
schlamar
Scott Kitterman
Sean
seanj
Sebastian Jordan
Sebastian Schaetz
Segev Finer
SeongSoo Cho
Sergey Vasilyev
Seth Michael Larson
Seth Woodworth
Shahar Epstein
Shantanu
shenxianpeng
shireenrao
Shivansh-007
Shixian Sheng
Shlomi Fish
Shovan Maity
Simeon Visser
Simon Cross
Simon Pichugin
sinoroc
sinscary
snook92
socketubs
Sorin Sbarnea
Srinivas Nyayapati
Srishti Hegde
Stavros Korokithakis
Stefan Scherfke
Stefano Rivera
Stephan Erb
Stephen Rosen
stepshal
Steve (Gadget) Barnes
Steve Barnes
Steve Dower
Steve Kowalik
Steven Myint
Steven Silvester
stonebig
studioj
Stéphane Bidoul
Stéphane Bidoul (ACSONE)
Stéphane Klein
Sumana Harihareswara
Surbhi Sharma
Sviatoslav Sydorenko
Sviatoslav Sydorenko (Святослав Сидоренко)
Swat009
Sylvain
Takayuki SHIMIZUKAWA
Taneli Hukkinen
tbeswick
Thiago
Thijs Triemstra
Thomas Fenzl
Thomas Grainger
Thomas Guettler
Thomas Johansson
Thomas Kluyver
Thomas Smith
Thomas VINCENT
Tim D. Smith
Tim Gates
Tim Harder
Tim Heap
tim smith
tinruufu
Tobias Hermann
Tom Forbes
Tom Freudenheim
Tom V
Tomas Hrnciar
Tomas Orsava
Tomer Chachamu
Tommi Enenkel | AnB
Tomáš Hrnčiar
Tony Beswick
Tony Narlock
Tony Zhaocheng Tan
TonyBeswick
toonarmycaptain
Toshio Kuratomi
toxinu
Travis Swicegood
Tushar Sadhwani
Tzu-ping Chung
Valentin Haenel
Victor Stinner
victorvpaulo
Vikram - Google
Viktor Szépe
Ville Skyttä
Vinay Sajip
Vincent Philippon
Vinicyus Macedo
Vipul Kumar
Vitaly Babiy
Vladimir Fokow
Vladimir Rutsky
W. Trevor King
Wil Tan
Wilfred Hughes
William Edwards
William ML Leslie
William T Olson
William Woodruff
Wilson Mo
wim glenn
Winson Luk
Wolfgang Maier
Wu Zhenyu
XAMES3
Xavier Fernandez
Xianpeng Shen
xoviat
xtreak
YAMAMOTO Takashi
Yen Chi Hsuan
Yeray Diaz Diaz
Yoval P
Yu Jian
Yuan Jing Vincent Yan
Yusuke Hayashi
Zearin
Zhiping Deng
ziebam
Zvezdan Petkovic
Łukasz Langa
Роман Донченко
Семён Марьясин
@@ -0,0 +1,20 @@
Copyright (c) 2008-present The pip developers (see AUTHORS.txt file)
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2015 holger krekel (rather uses bitbucket/hpk42)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@@ -0,0 +1,27 @@
pycparser -- A C parser in Python
Copyright (c) 2008-2022, Eli Bendersky
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its contributors may
be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,521 @@
============================================
PyInstaller Community Hooks: License details
============================================
This software is made available under the terms of the licenses found below.
Contributions to the Community Hooks are made under the terms of the license
that covers that type of hook/file. (See below)
Standard hooks and files
------------------------
The PyInstaller Community Hooks are licensed under the terms of the GNU General
Public License as published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version (SPDX GPL-2.0-or-later).
These are all hooks/files except runtime hooks (see below). The terms of GPL 2.0
are found in the section titled *GNU General Public License* below.
Runtime hooks
-------------
These are runtime hooks, bundled with complete pyinstaller executables. These
files are licensed under the Apache-2.0 whose terms are found in the section
titled *Apache License 2.0*.
These reside in "_pyinstaller_hooks_contrib/rthooks".
GNU General Public License
--------------------------
https://gnu.org/licenses/gpl-2.0.html
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
Apache License 2.0
++++++++++++++++++
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.
@@ -0,0 +1,648 @@
================================
The PyInstaller licensing terms
================================
Copyright (c) 2010-2023, PyInstaller Development Team
Copyright (c) 2005-2009, Giovanni Bajo
Based on previous work under copyright (c) 2002 McMillan Enterprises, Inc.
PyInstaller is licensed under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2 of the License,
or (at your option) any later version.
Bootloader Exception
--------------------
In addition to the permissions in the GNU General Public License, the
authors give you unlimited permission to link or embed compiled bootloader
and related files into combinations with other programs, and to distribute
those combinations without any restriction coming from the use of those
files. (The General Public License restrictions do apply in other respects;
for example, they cover modification of the files, and distribution when
not linked into a combined executable.)
Bootloader and Related Files
----------------------------
Bootloader and related files are files which are embedded within the
final executable. This includes files in directories:
./bootloader/
./PyInstaller/loader
Run-time Hooks
----------------------------
Run-time Hooks are a different kind of files embedded within the final
executable. To ease moving them into a separate repository, or into the
respective project, these files are now licensed under the Apache License,
Version 2.0.
Run-time Hooks are in the directory
./PyInstaller/hooks/rthooks
Additional Run-time Modules
----------------------------------
In addition to run-time hooks, PyInstaller may embed additional run-time
modules in the final executable. At the time of writing, these include
the splash-screen module (``pyi_splash``) and modules from utility package
for run-time hooks (``_pyi_rth_utils``). All these files are licensed under
the Apache License, Version 2.0, and are located in the following directory:
./PyInstaller/fake-modules
The PyInstaller.isolated submodule
----------------------------------
By request, the PyInstaller.isolated submodule and its corresponding tests are
additionally licensed with the MIT license so that it may be reused outside of
PyInstaller under GPL 2.0 or MIT terms and conditions -- whichever is the most
suitable to the recipient downstream project. Affected files/directories are:
./PyInstaller/isolated/
./tests/unit/test_isolation.py
About the PyInstaller Development Team
--------------------------------------
The PyInstaller Development Team is the set of contributors
to the PyInstaller project. A full list with details is kept
in the documentation directory, in the file
``doc/CREDITS.rst``.
The core team that coordinates development on GitHub can be found here:
https://github.com/pyinstaller/pyinstaller. As of 2021, it consists of:
* Hartmut Goebel
* Jasper Harrison
* Bryan Jones
* Brenainn Woodsend
* Rok Mandeljc
Our Copyright Policy
--------------------
PyInstaller uses a shared copyright model. Each contributor maintains copyright
over their contributions to PyInstaller. But, it is important to note that these
contributions are typically only changes to the repositories. Thus,
the PyInstaller source code, in its entirety is not the copyright of any single
person or institution. Instead, it is the collective copyright of the entire
PyInstaller Development Team. If individual contributors want to maintain
a record of what changes/contributions they have specific copyright on, they
should indicate their copyright in the commit message of the change, when they
commit the change to the PyInstaller repository.
With this in mind, the following banner should be used in any source code file
to indicate the copyright and license terms:
#-----------------------------------------------------------------------------
# Copyright (c) 2005-2023, PyInstaller Development Team.
#
# Distributed under the terms of the GNU General Public License (version 2
# or later) with exception for distributing the bootloader.
#
# The full license is in the file COPYING.txt, distributed with this software.
#
# SPDX-License-Identifier: (GPL-2.0-or-later WITH Bootloader-exception)
#-----------------------------------------------------------------------------
For run-time hooks, the following banner should be used:
#-----------------------------------------------------------------------------
# Copyright (c) 2005-2023, PyInstaller Development Team.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
#
# The full license is in the file COPYING.txt, distributed with this software.
#
# SPDX-License-Identifier: Apache-2.0
#-----------------------------------------------------------------------------
================================
GNU General Public License
================================
https://gnu.org/licenses/gpl-2.0.html
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
================================
Apache License 2.0
================================
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.
===========
MIT License
===========
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2004 Holger Krekel and others
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@@ -0,0 +1,28 @@
This software is OSI Certified Open Source Software.
OSI Certified is a certification mark of the Open Source Initiative.
Copyright (c) 2014, Enthought, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of Enthought, Inc. nor the names of its contributors may
be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,17 @@
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
@@ -0,0 +1,166 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
@@ -0,0 +1,17 @@
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
@@ -0,0 +1,73 @@
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 2025 [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.
@@ -0,0 +1,17 @@
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
@@ -0,0 +1,18 @@
MIT License
Copyright (c) 2026 <copyright holders>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,18 @@
MIT License
Copyright (c) 2025 <copyright holders>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,19 @@
Copyright (c) 2012 Erik Rose
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@@ -0,0 +1,3 @@
This software is made available under the terms of *either* of the licenses
found in LICENSE.APACHE or LICENSE.BSD. Contributions to this software is made
under the terms of *both* these licenses.
@@ -0,0 +1,177 @@
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
@@ -0,0 +1,23 @@
Copyright (c) Donald Stufft and individual contributors.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2010-202x The platformdirs developers
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2021 Taneli Hukkinen
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2012 Daniel Holth <dholth@fastmail.fm> and contributors
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,18 @@
MIT License
Copyright (c) 2025 <copyright holders>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,10 @@
The following files include code from opensource projects
(either as direct copies or modified versions):
- `setuptools.schema.json`, `distutils.schema.json`:
- project: `validate-pyproject` - licensed under MPL-2.0
(https://github.com/abravalheri/validate-pyproject):
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this file,
You can obtain one at https://mozilla.org/MPL/2.0/.
@@ -0,0 +1,438 @@
The code contained in this directory was automatically generated using the
following command:
python -m validate_pyproject.pre_compile --output-dir=setuptools/config/_validate_pyproject --enable-plugins setuptools distutils --very-verbose -t distutils=setuptools/config/distutils.schema.json -t setuptools=setuptools/config/setuptools.schema.json
Please avoid changing it manually.
You can report issues or suggest changes directly to `validate-pyproject`
(or to the relevant plugin repository)
- https://github.com/abravalheri/validate-pyproject/issues
***
The following files include code from opensource projects
(either as direct copies or modified versions):
- `fastjsonschema_exceptions.py`:
- project: `fastjsonschema` - licensed under BSD-3-Clause
(https://github.com/horejsek/python-fastjsonschema)
- `extra_validations.py` and `format.py`, `error_reporting.py`:
- project: `validate-pyproject` - licensed under MPL-2.0
(https://github.com/abravalheri/validate-pyproject)
Additionally the following files are automatically generated by tools provided
by the same projects:
- `__init__.py`
- `fastjsonschema_validations.py`
The relevant copyright notes and licenses are included below.
***
`fastjsonschema`
================
Copyright (c) 2018, Michal Horejsek
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
Neither the name of the {organization} nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
***
`validate-pyproject`
====================
Mozilla Public License, version 2.0
1. Definitions
1.1. "Contributor"
means each individual or legal entity that creates, contributes to the
creation of, or owns Covered Software.
1.2. "Contributor Version"
means the combination of the Contributions of others (if any) used by a
Contributor and that particular Contributor's Contribution.
1.3. "Contribution"
means Covered Software of a particular Contributor.
1.4. "Covered Software"
means Source Code Form to which the initial Contributor has attached the
notice in Exhibit A, the Executable Form of such Source Code Form, and
Modifications of such Source Code Form, in each case including portions
thereof.
1.5. "Incompatible With Secondary Licenses"
means
a. that the initial Contributor has attached the notice described in
Exhibit B to the Covered Software; or
b. that the Covered Software was made available under the terms of
version 1.1 or earlier of the License, but not also under the terms of
a Secondary License.
1.6. "Executable Form"
means any form of the work other than Source Code Form.
1.7. "Larger Work"
means a work that combines Covered Software with other material, in a
separate file or files, that is not Covered Software.
1.8. "License"
means this document.
1.9. "Licensable"
means having the right to grant, to the maximum extent possible, whether
at the time of the initial grant or subsequently, any and all of the
rights conveyed by this License.
1.10. "Modifications"
means any of the following:
a. any file in Source Code Form that results from an addition to,
deletion from, or modification of the contents of Covered Software; or
b. any new file in Source Code Form that contains any Covered Software.
1.11. "Patent Claims" of a Contributor
means any patent claim(s), including without limitation, method,
process, and apparatus claims, in any patent Licensable by such
Contributor that would be infringed, but for the grant of the License,
by the making, using, selling, offering for sale, having made, import,
or transfer of either its Contributions or its Contributor Version.
1.12. "Secondary License"
means either the GNU General Public License, Version 2.0, the GNU Lesser
General Public License, Version 2.1, the GNU Affero General Public
License, Version 3.0, or any later versions of those licenses.
1.13. "Source Code Form"
means the form of the work preferred for making modifications.
1.14. "You" (or "Your")
means an individual or a legal entity exercising rights under this
License. For legal entities, "You" includes any entity that controls, is
controlled by, or is under common control with You. For purposes of this
definition, "control" means (a) the power, direct or indirect, to cause
the direction or management of such entity, whether by contract or
otherwise, or (b) ownership of more than fifty percent (50%) of the
outstanding shares or beneficial ownership of such entity.
2. License Grants and Conditions
2.1. Grants
Each Contributor hereby grants You a world-wide, royalty-free,
non-exclusive license:
a. under intellectual property rights (other than patent or trademark)
Licensable by such Contributor to use, reproduce, make available,
modify, display, perform, distribute, and otherwise exploit its
Contributions, either on an unmodified basis, with Modifications, or
as part of a Larger Work; and
b. under Patent Claims of such Contributor to make, use, sell, offer for
sale, have made, import, and otherwise transfer either its
Contributions or its Contributor Version.
2.2. Effective Date
The licenses granted in Section 2.1 with respect to any Contribution
become effective for each Contribution on the date the Contributor first
distributes such Contribution.
2.3. Limitations on Grant Scope
The licenses granted in this Section 2 are the only rights granted under
this License. No additional rights or licenses will be implied from the
distribution or licensing of Covered Software under this License.
Notwithstanding Section 2.1(b) above, no patent license is granted by a
Contributor:
a. for any code that a Contributor has removed from Covered Software; or
b. for infringements caused by: (i) Your and any other third party's
modifications of Covered Software, or (ii) the combination of its
Contributions with other software (except as part of its Contributor
Version); or
c. under Patent Claims infringed by Covered Software in the absence of
its Contributions.
This License does not grant any rights in the trademarks, service marks,
or logos of any Contributor (except as may be necessary to comply with
the notice requirements in Section 3.4).
2.4. Subsequent Licenses
No Contributor makes additional grants as a result of Your choice to
distribute the Covered Software under a subsequent version of this
License (see Section 10.2) or under the terms of a Secondary License (if
permitted under the terms of Section 3.3).
2.5. Representation
Each Contributor represents that the Contributor believes its
Contributions are its original creation(s) or it has sufficient rights to
grant the rights to its Contributions conveyed by this License.
2.6. Fair Use
This License is not intended to limit any rights You have under
applicable copyright doctrines of fair use, fair dealing, or other
equivalents.
2.7. Conditions
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in
Section 2.1.
3. Responsibilities
3.1. Distribution of Source Form
All distribution of Covered Software in Source Code Form, including any
Modifications that You create or to which You contribute, must be under
the terms of this License. You must inform recipients that the Source
Code Form of the Covered Software is governed by the terms of this
License, and how they can obtain a copy of this License. You may not
attempt to alter or restrict the recipients' rights in the Source Code
Form.
3.2. Distribution of Executable Form
If You distribute Covered Software in Executable Form then:
a. such Covered Software must also be made available in Source Code Form,
as described in Section 3.1, and You must inform recipients of the
Executable Form how they can obtain a copy of such Source Code Form by
reasonable means in a timely manner, at a charge no more than the cost
of distribution to the recipient; and
b. You may distribute such Executable Form under the terms of this
License, or sublicense it under different terms, provided that the
license for the Executable Form does not attempt to limit or alter the
recipients' rights in the Source Code Form under this License.
3.3. Distribution of a Larger Work
You may create and distribute a Larger Work under terms of Your choice,
provided that You also comply with the requirements of this License for
the Covered Software. If the Larger Work is a combination of Covered
Software with a work governed by one or more Secondary Licenses, and the
Covered Software is not Incompatible With Secondary Licenses, this
License permits You to additionally distribute such Covered Software
under the terms of such Secondary License(s), so that the recipient of
the Larger Work may, at their option, further distribute the Covered
Software under the terms of either this License or such Secondary
License(s).
3.4. Notices
You may not remove or alter the substance of any license notices
(including copyright notices, patent notices, disclaimers of warranty, or
limitations of liability) contained within the Source Code Form of the
Covered Software, except that You may alter any license notices to the
extent required to remedy known factual inaccuracies.
3.5. Application of Additional Terms
You may choose to offer, and to charge a fee for, warranty, support,
indemnity or liability obligations to one or more recipients of Covered
Software. However, You may do so only on Your own behalf, and not on
behalf of any Contributor. You must make it absolutely clear that any
such warranty, support, indemnity, or liability obligation is offered by
You alone, and You hereby agree to indemnify every Contributor for any
liability incurred by such Contributor as a result of warranty, support,
indemnity or liability terms You offer. You may include additional
disclaimers of warranty and limitations of liability specific to any
jurisdiction.
4. Inability to Comply Due to Statute or Regulation
If it is impossible for You to comply with any of the terms of this License
with respect to some or all of the Covered Software due to statute,
judicial order, or regulation then You must: (a) comply with the terms of
this License to the maximum extent possible; and (b) describe the
limitations and the code they affect. Such description must be placed in a
text file included with all distributions of the Covered Software under
this License. Except to the extent prohibited by statute or regulation,
such description must be sufficiently detailed for a recipient of ordinary
skill to be able to understand it.
5. Termination
5.1. The rights granted under this License will terminate automatically if You
fail to comply with any of its terms. However, if You become compliant,
then the rights granted under this License from a particular Contributor
are reinstated (a) provisionally, unless and until such Contributor
explicitly and finally terminates Your grants, and (b) on an ongoing
basis, if such Contributor fails to notify You of the non-compliance by
some reasonable means prior to 60 days after You have come back into
compliance. Moreover, Your grants from a particular Contributor are
reinstated on an ongoing basis if such Contributor notifies You of the
non-compliance by some reasonable means, this is the first time You have
received notice of non-compliance with this License from such
Contributor, and You become compliant prior to 30 days after Your receipt
of the notice.
5.2. If You initiate litigation against any entity by asserting a patent
infringement claim (excluding declaratory judgment actions,
counter-claims, and cross-claims) alleging that a Contributor Version
directly or indirectly infringes any patent, then the rights granted to
You by any and all Contributors for the Covered Software under Section
2.1 of this License shall terminate.
5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user
license agreements (excluding distributors and resellers) which have been
validly granted by You or Your distributors under this License prior to
termination shall survive termination.
6. Disclaimer of Warranty
Covered Software is provided under this License on an "as is" basis,
without warranty of any kind, either expressed, implied, or statutory,
including, without limitation, warranties that the Covered Software is free
of defects, merchantable, fit for a particular purpose or non-infringing.
The entire risk as to the quality and performance of the Covered Software
is with You. Should any Covered Software prove defective in any respect,
You (not any Contributor) assume the cost of any necessary servicing,
repair, or correction. This disclaimer of warranty constitutes an essential
part of this License. No use of any Covered Software is authorized under
this License except under this disclaimer.
7. Limitation of Liability
Under no circumstances and under no legal theory, whether tort (including
negligence), contract, or otherwise, shall any Contributor, or anyone who
distributes Covered Software as permitted above, be liable to You for any
direct, indirect, special, incidental, or consequential damages of any
character including, without limitation, damages for lost profits, loss of
goodwill, work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses, even if such party shall have been
informed of the possibility of such damages. This limitation of liability
shall not apply to liability for death or personal injury resulting from
such party's negligence to the extent applicable law prohibits such
limitation. Some jurisdictions do not allow the exclusion or limitation of
incidental or consequential damages, so this exclusion and limitation may
not apply to You.
8. Litigation
Any litigation relating to this License may be brought only in the courts
of a jurisdiction where the defendant maintains its principal place of
business and such litigation shall be governed by laws of that
jurisdiction, without reference to its conflict-of-law provisions. Nothing
in this Section shall prevent a party's ability to bring cross-claims or
counter-claims.
9. Miscellaneous
This License represents the complete agreement concerning the subject
matter hereof. If any provision of this License is held to be
unenforceable, such provision shall be reformed only to the extent
necessary to make it enforceable. Any law or regulation which provides that
the language of a contract shall be construed against the drafter shall not
be used to construe this License against a Contributor.
10. Versions of the License
10.1. New Versions
Mozilla Foundation is the license steward. Except as provided in Section
10.3, no one other than the license steward has the right to modify or
publish new versions of this License. Each version will be given a
distinguishing version number.
10.2. Effect of New Versions
You may distribute the Covered Software under the terms of the version
of the License under which You originally received the Covered Software,
or under the terms of any subsequent version published by the license
steward.
10.3. Modified Versions
If you create software not governed by this License, and you want to
create a new license for such software, you may create and use a
modified version of this License if you rename the license and remove
any references to the name of the license steward (except to note that
such modified license differs from this License).
10.4. Distributing Source Code Form that is Incompatible With Secondary
Licenses If You choose to distribute Source Code Form that is
Incompatible With Secondary Licenses under the terms of this version of
the License, the notice described in Exhibit B of this License must be
attached.
Exhibit A - Source Code Form License Notice
This Source Code Form is subject to the
terms of the Mozilla Public License, v.
2.0. If a copy of the MPL was not
distributed with this file, You can
obtain one at
https://mozilla.org/MPL/2.0/.
If it is not possible or desirable to put the notice in a particular file,
then You may include the notice in a location (such as a LICENSE file in a
relevant directory) where a recipient would be likely to look for such a
notice.
You may add additional accurate notices of copyright ownership.
Exhibit B - "Incompatible With Secondary Licenses" Notice
This Source Code Form is "Incompatible
With Secondary Licenses", as defined by
the Mozilla Public License, v. 2.0.
@@ -0,0 +1,502 @@
A. HISTORY OF THE SOFTWARE
==========================
Python was created in the early 1990s by Guido van Rossum at Stichting
Mathematisch Centrum (CWI, see https://www.cwi.nl) in the Netherlands
as a successor of a language called ABC. Guido remains Python's
principal author, although it includes many contributions from others.
In 1995, Guido continued his work on Python at the Corporation for
National Research Initiatives (CNRI, see https://www.cnri.reston.va.us)
in Reston, Virginia where he released several versions of the
software.
In May 2000, Guido and the Python core development team moved to
BeOpen.com to form the BeOpen PythonLabs team. In October of the same
year, the PythonLabs team moved to Digital Creations, which became
Zope Corporation. In 2001, the Python Software Foundation (PSF, see
https://www.python.org/psf/) was formed, a non-profit organization
created specifically to own Python-related Intellectual Property.
Zope Corporation was a sponsoring member of the PSF.
All Python releases are Open Source (see https://opensource.org for
the Open Source Definition). Historically, most, but not all, Python
releases have also been GPL-compatible; the table below summarizes
the various releases.
Release Derived Year Owner GPL-
from compatible? (1)
0.9.0 thru 1.2 1991-1995 CWI yes
1.3 thru 1.5.2 1.2 1995-1999 CNRI yes
1.6 1.5.2 2000 CNRI no
2.0 1.6 2000 BeOpen.com no
1.6.1 1.6 2001 CNRI yes (2)
2.1 2.0+1.6.1 2001 PSF no
2.0.1 2.0+1.6.1 2001 PSF yes
2.1.1 2.1+2.0.1 2001 PSF yes
2.1.2 2.1.1 2002 PSF yes
2.1.3 2.1.2 2002 PSF yes
2.2 and above 2.1.1 2001-now PSF yes
Footnotes:
(1) GPL-compatible doesn't mean that we're distributing Python under
the GPL. All Python licenses, unlike the GPL, let you distribute
a modified version without making your changes open source. The
GPL-compatible licenses make it possible to combine Python with
other software that is released under the GPL; the others don't.
(2) According to Richard Stallman, 1.6.1 is not GPL-compatible,
because its license has a choice of law clause. According to
CNRI, however, Stallman's lawyer has told CNRI's lawyer that 1.6.1
is "not incompatible" with the GPL.
Thanks to the many outside volunteers who have worked under Guido's
direction to make these releases possible.
B. TERMS AND CONDITIONS FOR ACCESSING OR OTHERWISE USING PYTHON
===============================================================
Python software and documentation are licensed under the
Python Software Foundation License Version 2.
Starting with Python 3.8.6, examples, recipes, and other code in
the documentation are dual licensed under the PSF License Version 2
and the Zero-Clause BSD license.
Some software incorporated into Python is under different licenses.
The licenses are listed with code falling under that license.
PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
--------------------------------------------
1. This LICENSE AGREEMENT is between the Python Software Foundation
("PSF"), and the Individual or Organization ("Licensee") accessing and
otherwise using this software ("Python") in source or binary form and
its associated documentation.
2. Subject to the terms and conditions of this License Agreement, PSF hereby
grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
analyze, test, perform and/or display publicly, prepare derivative works,
distribute, and otherwise use Python alone or in any derivative version,
provided, however, that PSF's License Agreement and PSF's notice of copyright,
i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Python Software Foundation;
All Rights Reserved" are retained in Python alone or in any derivative version
prepared by Licensee.
3. In the event Licensee prepares a derivative work that is based on
or incorporates Python or any part thereof, and wants to make
the derivative work available to others as provided herein, then
Licensee hereby agrees to include in any such work a brief summary of
the changes made to Python.
4. PSF is making Python available to Licensee on an "AS IS"
basis. PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
INFRINGE ANY THIRD PARTY RIGHTS.
5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
6. This License Agreement will automatically terminate upon a material
breach of its terms and conditions.
7. Nothing in this License Agreement shall be deemed to create any
relationship of agency, partnership, or joint venture between PSF and
Licensee. This License Agreement does not grant permission to use PSF
trademarks or trade name in a trademark sense to endorse or promote
products or services of Licensee, or any third party.
8. By copying, installing or otherwise using Python, Licensee
agrees to be bound by the terms and conditions of this License
Agreement.
BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0
-------------------------------------------
BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1
1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an
office at 160 Saratoga Avenue, Santa Clara, CA 95051, and the
Individual or Organization ("Licensee") accessing and otherwise using
this software in source or binary form and its associated
documentation ("the Software").
2. Subject to the terms and conditions of this BeOpen Python License
Agreement, BeOpen hereby grants Licensee a non-exclusive,
royalty-free, world-wide license to reproduce, analyze, test, perform
and/or display publicly, prepare derivative works, distribute, and
otherwise use the Software alone or in any derivative version,
provided, however, that the BeOpen Python License is retained in the
Software, alone or in any derivative version prepared by Licensee.
3. BeOpen is making the Software available to Licensee on an "AS IS"
basis. BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND
DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE WILL NOT
INFRINGE ANY THIRD PARTY RIGHTS.
4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE
SOFTWARE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS
AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY
DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
5. This License Agreement will automatically terminate upon a material
breach of its terms and conditions.
6. This License Agreement shall be governed by and interpreted in all
respects by the law of the State of California, excluding conflict of
law provisions. Nothing in this License Agreement shall be deemed to
create any relationship of agency, partnership, or joint venture
between BeOpen and Licensee. This License Agreement does not grant
permission to use BeOpen trademarks or trade names in a trademark
sense to endorse or promote products or services of Licensee, or any
third party. As an exception, the "BeOpen Python" logos available at
http://www.pythonlabs.com/logos.html may be used according to the
permissions granted on that web page.
7. By copying, installing or otherwise using the software, Licensee
agrees to be bound by the terms and conditions of this License
Agreement.
CNRI LICENSE AGREEMENT FOR PYTHON 1.6.1
---------------------------------------
1. This LICENSE AGREEMENT is between the Corporation for National
Research Initiatives, having an office at 1895 Preston White Drive,
Reston, VA 20191 ("CNRI"), and the Individual or Organization
("Licensee") accessing and otherwise using Python 1.6.1 software in
source or binary form and its associated documentation.
2. Subject to the terms and conditions of this License Agreement, CNRI
hereby grants Licensee a nonexclusive, royalty-free, world-wide
license to reproduce, analyze, test, perform and/or display publicly,
prepare derivative works, distribute, and otherwise use Python 1.6.1
alone or in any derivative version, provided, however, that CNRI's
License Agreement and CNRI's notice of copyright, i.e., "Copyright (c)
1995-2001 Corporation for National Research Initiatives; All Rights
Reserved" are retained in Python 1.6.1 alone or in any derivative
version prepared by Licensee. Alternately, in lieu of CNRI's License
Agreement, Licensee may substitute the following text (omitting the
quotes): "Python 1.6.1 is made available subject to the terms and
conditions in CNRI's License Agreement. This Agreement together with
Python 1.6.1 may be located on the internet using the following
unique, persistent identifier (known as a handle): 1895.22/1013. This
Agreement may also be obtained from a proxy server on the internet
using the following URL: http://hdl.handle.net/1895.22/1013".
3. In the event Licensee prepares a derivative work that is based on
or incorporates Python 1.6.1 or any part thereof, and wants to make
the derivative work available to others as provided herein, then
Licensee hereby agrees to include in any such work a brief summary of
the changes made to Python 1.6.1.
4. CNRI is making Python 1.6.1 available to Licensee on an "AS IS"
basis. CNRI MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, CNRI MAKES NO AND
DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON 1.6.1 WILL NOT
INFRINGE ANY THIRD PARTY RIGHTS.
5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
1.6.1 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 1.6.1,
OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
6. This License Agreement will automatically terminate upon a material
breach of its terms and conditions.
7. This License Agreement shall be governed by the federal
intellectual property law of the United States, including without
limitation the federal copyright law, and, to the extent such
U.S. federal law does not apply, by the law of the Commonwealth of
Virginia, excluding Virginia's conflict of law provisions.
Notwithstanding the foregoing, with regard to derivative works based
on Python 1.6.1 that incorporate non-separable material that was
previously distributed under the GNU General Public License (GPL), the
law of the Commonwealth of Virginia shall govern this License
Agreement only as to issues arising under or with respect to
Paragraphs 4, 5, and 7 of this License Agreement. Nothing in this
License Agreement shall be deemed to create any relationship of
agency, partnership, or joint venture between CNRI and Licensee. This
License Agreement does not grant permission to use CNRI trademarks or
trade name in a trademark sense to endorse or promote products or
services of Licensee, or any third party.
8. By clicking on the "ACCEPT" button where indicated, or by copying,
installing or otherwise using Python 1.6.1, Licensee agrees to be
bound by the terms and conditions of this License Agreement.
ACCEPT
CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2
--------------------------------------------------
Copyright (c) 1991 - 1995, Stichting Mathematisch Centrum Amsterdam,
The Netherlands. All rights reserved.
Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted,
provided that the above copyright notice appear in all copies and that
both that copyright notice and this permission notice appear in
supporting documentation, and that the name of Stichting Mathematisch
Centrum or CWI not be used in advertising or publicity pertaining to
distribution of the software without specific, written prior
permission.
STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON DOCUMENTATION
----------------------------------------------------------------------
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
Additional Conditions for this Windows binary build
---------------------------------------------------
This program is linked with and uses Microsoft Distributable Code,
copyrighted by Microsoft Corporation. The Microsoft Distributable Code
is embedded in each .exe, .dll and .pyd file as a result of running
the code through a linker.
If you further distribute programs that include the Microsoft
Distributable Code, you must comply with the restrictions on
distribution specified by Microsoft. In particular, you must require
distributors and external end users to agree to terms that protect the
Microsoft Distributable Code at least as much as Microsoft's own
requirements for the Distributable Code. See Microsoft's documentation
(included in its developer tools and on its website at microsoft.com)
for specific details.
Redistribution of the Windows binary build of the Python interpreter
complies with this agreement, provided that you do not:
- alter any copyright, trademark or patent notice in Microsoft's
Distributable Code;
- use Microsoft's trademarks in your programs' names or in a way that
suggests your programs come from or are endorsed by Microsoft;
- distribute Microsoft's Distributable Code to run on a platform other
than Microsoft operating systems, run-time technologies or application
platforms; or
- include Microsoft Distributable Code in malicious, deceptive or
unlawful programs.
These restrictions apply only to the Microsoft Distributable Code as
defined above, not to Python itself or any programs running on the
Python interpreter. The redistribution of the Python interpreter and
libraries is governed by the Python Software License included with this
file, or by other licenses as marked.
--------------------------------------------------------------------------
This program, "bzip2", the associated library "libbzip2", and all
documentation, are copyright (C) 1996-2019 Julian R Seward. All
rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. The origin of this software must not be misrepresented; you must
not claim that you wrote the original software. If you use this
software in a product, an acknowledgment in the product
documentation would be appreciated but is not required.
3. Altered source versions must be plainly marked as such, and must
not be misrepresented as being the original software.
4. The name of the author may not be used to endorse or promote
products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Julian Seward, jseward@acm.org
bzip2/libbzip2 version 1.0.8 of 13 July 2019
--------------------------------------------------------------------------
This software is copyrighted by the Regents of the University of
California, Sun Microsystems, Inc., Scriptics Corporation, ActiveState
Corporation and other parties. The following terms apply to all files
associated with the software unless explicitly disclaimed in
individual files.
The authors hereby grant permission to use, copy, modify, distribute,
and license this software and its documentation for any purpose, provided
that existing copyright notices are retained in all copies and that this
notice is included verbatim in any distributions. No written agreement,
license, or royalty fee is required for any of the authorized uses.
Modifications to this software may be copyrighted by their authors
and need not follow the licensing terms described here, provided that
the new terms are clearly indicated on the first page of each file where
they apply.
IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY
DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE
IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE
NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
MODIFICATIONS.
GOVERNMENT USE: If you are acquiring this software on behalf of the
U.S. government, the Government shall have only "Restricted Rights"
in the software and related documentation as defined in the Federal
Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you
are acquiring the software on behalf of the Department of Defense, the
software shall be classified as "Commercial Computer Software" and the
Government shall have only "Restricted Rights" as defined in Clause
252.227-7014 (b) (3) of DFARs. Notwithstanding the foregoing, the
authors grant the U.S. Government and others acting in its behalf
permission to use and distribute the software in accordance with the
terms specified in this license.
This software is copyrighted by the Regents of the University of
California, Sun Microsystems, Inc., Scriptics Corporation, ActiveState
Corporation, Apple Inc. and other parties. The following terms apply to
all files associated with the software unless explicitly disclaimed in
individual files.
The authors hereby grant permission to use, copy, modify, distribute,
and license this software and its documentation for any purpose, provided
that existing copyright notices are retained in all copies and that this
notice is included verbatim in any distributions. No written agreement,
license, or royalty fee is required for any of the authorized uses.
Modifications to this software may be copyrighted by their authors
and need not follow the licensing terms described here, provided that
the new terms are clearly indicated on the first page of each file where
they apply.
IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY
DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE
IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE
NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
MODIFICATIONS.
GOVERNMENT USE: If you are acquiring this software on behalf of the
U.S. government, the Government shall have only "Restricted Rights"
in the software and related documentation as defined in the Federal
Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you
are acquiring the software on behalf of the Department of Defense, the
software shall be classified as "Commercial Computer Software" and the
Government shall have only "Restricted Rights" as defined in Clause
252.227-7013 (b) (3) of DFARs. Notwithstanding the foregoing, the
authors grant the U.S. Government and others acting in its behalf
permission to use and distribute the software in accordance with the
terms specified in this license.
Copyright (c) 1993-1999 Ioi Kim Lam.
Copyright (c) 2000-2001 Tix Project Group.
Copyright (c) 2004 ActiveState
This software is copyrighted by the above entities
and other parties. The following terms apply to all files associated
with the software unless explicitly disclaimed in individual files.
The authors hereby grant permission to use, copy, modify, distribute,
and license this software and its documentation for any purpose, provided
that existing copyright notices are retained in all copies and that this
notice is included verbatim in any distributions. No written agreement,
license, or royalty fee is required for any of the authorized uses.
Modifications to this software may be copyrighted by their authors
and need not follow the licensing terms described here, provided that
the new terms are clearly indicated on the first page of each file where
they apply.
IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY
DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE
IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE
NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
MODIFICATIONS.
GOVERNMENT USE: If you are acquiring this software on behalf of the
U.S. government, the Government shall have only "Restricted Rights"
in the software and related documentation as defined in the Federal
Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you
are acquiring the software on behalf of the Department of Defense, the
software shall be classified as "Commercial Computer Software" and the
Government shall have only "Restricted Rights" as defined in Clause
252.227-7013 (c) (1) of DFARs. Notwithstanding the foregoing, the
authors grant the U.S. Government and others acting in its behalf
permission to use and distribute the software in accordance with the
terms specified in this license.
----------------------------------------------------------------------
Parts of this software are based on the Tcl/Tk software copyrighted by
the Regents of the University of California, Sun Microsystems, Inc.,
and other parties. The original license terms of the Tcl/Tk software
distribution is included in the file docs/license.tcltk.
Parts of this software are based on the HTML Library software
copyrighted by Sun Microsystems, Inc. The original license terms of
the HTML Library software distribution is included in the file
docs/license.html_lib.
@@ -0,0 +1,177 @@
Apache License
Version 2.0, January 2004
https://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
@@ -0,0 +1,177 @@
Apache License
Version 2.0, January 2004
https://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
@@ -0,0 +1,40 @@
This software is copyrighted by the Regents of the University of
California, Sun Microsystems, Inc., Scriptics Corporation, ActiveState
Corporation and other parties. The following terms apply to all files
associated with the software unless explicitly disclaimed in
individual files.
The authors hereby grant permission to use, copy, modify, distribute,
and license this software and its documentation for any purpose, provided
that existing copyright notices are retained in all copies and that this
notice is included verbatim in any distributions. No written agreement,
license, or royalty fee is required for any of the authorized uses.
Modifications to this software may be copyrighted by their authors
and need not follow the licensing terms described here, provided that
the new terms are clearly indicated on the first page of each file where
they apply.
IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY
DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE
IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE
NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
MODIFICATIONS.
GOVERNMENT USE: If you are acquiring this software on behalf of the
U.S. government, the Government shall have only "Restricted Rights"
in the software and related documentation as defined in the Federal
Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you
are acquiring the software on behalf of the Department of Defense, the
software shall be classified as "Commercial Computer Software" and the
Government shall have only "Restricted Rights" as defined in Clause
252.227-7014 (b) (3) of DFARs. Notwithstanding the foregoing, the
authors grant the U.S. Government and others acting in its behalf
permission to use and distribute the software in accordance with the
terms specified in this license.
@@ -0,0 +1,40 @@
This software is copyrighted by the Regents of the University of
California, Sun Microsystems, Inc., Scriptics Corporation, ActiveState
Corporation, Apple Inc. and other parties. The following terms apply to
all files associated with the software unless explicitly disclaimed in
individual files.
The authors hereby grant permission to use, copy, modify, distribute,
and license this software and its documentation for any purpose, provided
that existing copyright notices are retained in all copies and that this
notice is included verbatim in any distributions. No written agreement,
license, or royalty fee is required for any of the authorized uses.
Modifications to this software may be copyrighted by their authors
and need not follow the licensing terms described here, provided that
the new terms are clearly indicated on the first page of each file where
they apply.
IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY
DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE
IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE
NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
MODIFICATIONS.
GOVERNMENT USE: If you are acquiring this software on behalf of the
U.S. government, the Government shall have only "Restricted Rights"
in the software and related documentation as defined in the Federal
Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you
are acquiring the software on behalf of the Department of Defense, the
software shall be classified as "Commercial Computer Software" and the
Government shall have only "Restricted Rights" as defined in Clause
252.227-7013 (b) (3) of DFARs. Notwithstanding the foregoing, the
authors grant the U.S. Government and others acting in its behalf
permission to use and distribute the software in accordance with the
terms specified in this license.
Binary file not shown.
+710
View File
@@ -0,0 +1,710 @@
#!/usr/bin/env python3
"""Installer helper executed on the Frame; no host-side elevated commands."""
from __future__ import annotations
import argparse
import ctypes
import hashlib
import json
import os
import pathlib
import platform
import pwd
import re
import signal
import shutil
import struct
import subprocess
import sys
import time
import tomllib
OWNER = "halo-frame-installer"
SOURCE_URL = "https://github.com/startupfoundry/halo-ce-universal.git"
SOURCE_COMMIT = "88142798513ebd99fc7c6224023e8b44c05d0106"
MIN_FREE_BYTES = 12 * 1024 ** 3
EXPECTED_MAPS = frozenset("maps/" + name + ".map" for name in (
"a10", "a30", "a50", "b30", "b40", "c10", "c20", "c40", "d20", "d40",
"beavercreek", "bloodgulch", "boardingaction", "carousel", "chillout", "damnation",
"hangemhigh", "longest", "prisoner", "putput", "ratrace", "sidewinder", "ui", "wizard"))
SUPPORTED_BUILDS = frozenset(("01.01.14.2342", "01.10.12.2276", "01.08.15.1749"))
MAX_MAP_BYTES = 0x11600000
MAX_TOTAL_BYTES = 4 * 1024 ** 3
HOME = pathlib.Path("/home/steamos")
CACHE = HOME / ".cache/halo-frame-installer"
GAME = HOME / "Games/HaloCENativeVR"
MARKER = ".halo-frame-installer.json"
def progress(stage, message):
print("HFI_PROGRESS " + json.dumps({"stage": stage, "message": message}), flush=True)
def result(value):
print("HFI_RESULT " + json.dumps(value), flush=True)
def digest(path):
h = hashlib.sha256()
with path.open("rb") as stream:
for block in iter(lambda: stream.read(1024 * 1024), b""):
h.update(block)
return h.hexdigest()
def ordinary(path):
if path.is_symlink() or not path.is_file():
raise ValueError("Expected an ordinary file: " + str(path))
return path
def beneath(path, parent):
# Reject any symlink component, including symlinks that point back inside.
if parent.is_symlink() or parent.resolve() != parent:
raise ValueError("Installation parent must not be a symbolic link.")
try:
relative = path.relative_to(parent)
except ValueError:
raise ValueError("Installation path is outside its owned directory.") from None
if ".." in relative.parts:
raise ValueError("Parent traversal is not accepted in installation paths.")
cursor = parent
for component in relative.parts:
cursor = cursor / component
if cursor.is_symlink():
raise ValueError("Symbolic links are not accepted in installation paths.")
return path
def read_marker(path, owner=OWNER):
value = json.loads(ordinary(path).read_text())
if value.get("owner") != owner:
raise ValueError("The existing directory belongs to another application.")
return value
def owned(directory):
beneath(directory, HOME)
directory.mkdir(parents=True, exist_ok=True)
marker = directory / MARKER
if marker.exists():
return read_marker(marker)
if any(directory.iterdir()):
raise ValueError("The destination is not empty and has no installer ownership marker: " + str(directory))
value = {"owner": OWNER, "sourceCommit": SOURCE_COMMIT}
marker.write_text(json.dumps(value, indent=2) + "\n")
return value
def run_id(value):
if not re.fullmatch(r"[a-f0-9]{32}", value):
raise ValueError("Invalid installation run identifier.")
return value
def run_dir(value):
read_marker(CACHE / MARKER)
directory = beneath(CACHE / "runs" / run_id(value), CACHE)
return directory
def command(argv, cwd=None, cancel_check=None, timeout=120):
process = subprocess.Popen(argv, cwd=cwd, text=True, stdout=subprocess.PIPE,
stderr=subprocess.STDOUT, start_new_session=True)
started = time.monotonic()
try:
while True:
if cancel_check is not None:
cancel_check()
try:
output, _ = process.communicate(timeout=0.25)
break
except subprocess.TimeoutExpired:
if time.monotonic() - started > timeout:
raise RuntimeError("Remote command timed out: " + argv[0])
except BaseException:
stop_build_process(process)
raise
if process.returncode:
raise RuntimeError(output[-10000:].strip() or f"Command failed: {argv[0]}")
return output.strip()
def elf_arm64(path):
with ordinary(path).open("rb") as stream:
header = stream.read(64)
if len(header) < 64 or header[:6] != b"\x7fELF\x02\x01" or struct.unpack_from("<H", header, 18)[0] != 183:
raise ValueError("The game executable is not a native little-endian ARM64 ELF.")
def game_closed():
for item in pathlib.Path("/proc").iterdir():
if not item.name.isdecimal():
continue
try:
executable = os.readlink(item / "exe").removesuffix(" (deleted)")
if executable == str(GAME / "halo"):
raise ValueError("Halo is still running. Save and close the game before installing or repairing it.")
except (FileNotFoundError, PermissionError, ProcessLookupError):
continue
def installed_maps_manifest():
path = GAME / "xbox-data-manifest.json"
if path.exists():
value = json.loads(ordinary(path).read_text())
else:
maps = beneath(GAME / "maps", GAME)
if not maps.is_dir():
raise ValueError("The existing game has no Xbox maps directory.")
entries = []
for relative in sorted(EXPECTED_MAPS):
target = ordinary(beneath(GAME / relative, GAME))
entries.append({"path": relative, "size": target.stat().st_size, "sha256": digest(target)})
value = {"files": entries, "totalBytes": sum(item["size"] for item in entries)}
verify_maps(GAME, value, allow_extra=True)
return value
def existing_install(repair=False, adopt=False):
beneath(GAME, HOME)
if not GAME.exists():
return None
if not GAME.is_dir():
raise ValueError("The game destination is not a directory.")
own = GAME / MARKER
codex = GAME / ".codex-halo-native-install.json"
if own.exists():
value = read_marker(own)
source = value.get("sourceCommit")
elif codex.exists():
value = read_marker(codex, "codex-halo-native-frame-20261005")
source = value.get("build", {}).get("sourceCommit", value.get("sourceCommit"))
else:
if not repair or not adopt:
raise ValueError("An existing HaloCENativeVR folder has no recognized native-install marker. Use Repair installed game to explicitly adopt a verified manual native installation.")
elf_arm64(GAME / "halo")
elf_arm64(GAME / "libSDL3.so.0")
installed_maps_manifest()
value = {"owner": "manual-native-adoption", "files": {}}
source = None
if source != SOURCE_COMMIT and not repair:
raise ValueError("An existing native game uses a different source revision. It was not modified.")
if repair:
game_closed()
else:
elf_arm64(GAME / "halo")
ordinary(GAME / "libSDL3.so.0")
if (GAME / "config.toml").exists():
ordinary(GAME / "config.toml")
if repair:
merge_config((GAME / "config.toml").read_text())
# Validate all hashes recorded by either supported installer before reusing it.
files = value.get("files", {})
if not isinstance(files, dict):
raise ValueError("The existing native ownership marker has an invalid file record.")
if not repair and (not isinstance(files, dict) or any(not re.fullmatch("[a-f0-9]{64}", str(files.get(name, "")))
for name in ("halo", "libSDL3.so.0"))):
raise ValueError("The existing native marker lacks executable/library verification hashes.")
issues = []
for relative, expected in files.items():
if isinstance(expected, str):
path = beneath(GAME / relative, GAME)
if not path.exists() or digest(ordinary(path)) != expected:
# Runtime rewrites config comments/defaults, so its stored hash can differ.
if relative != "config.toml" and not repair:
raise ValueError("An existing native game file failed verification: " + relative)
issues.append(relative)
try:
installed_maps_manifest()
maps_verified = True
except (OSError, ValueError, KeyError):
if not repair:
raise
maps_verified = False
return {"gamePath": str(GAME), "reused": True, "owner": value["owner"], "sourceCommit": source,
"mapsVerified": maps_verified, "needsImage": not maps_verified, "programIssues": issues}
def os_release():
values = {}
for line in pathlib.Path("/etc/os-release").read_text().splitlines():
if "=" in line:
key, val = line.split("=", 1)
values[key] = val.strip('"')
return values
def preflight(repair=False, adopt=False):
if pwd.getpwuid(os.getuid()).pw_name != "steamos" or pathlib.Path.home() != HOME:
raise ValueError("Connect using the Frame's steamos account.")
if platform.machine().lower() not in ("aarch64", "arm64"):
raise ValueError("This is not an ARM64 Steam Frame. Desktop/Quest installs are not supported.")
system = os_release()
if system.get("ID") != "steamos":
raise ValueError("This installer requires SteamOS on Steam Frame.")
for executable in ("python3", "git", "podman", "ldd"):
if shutil.which(executable) is None:
raise ValueError("Required SteamOS tool is missing: " + executable + ". This installer does not modify SteamOS system packages.")
vr_manifest = HOME / ".config/openxr/1/active_runtime.json"
candidates = [vr_manifest, pathlib.Path("/opt/steamvr/steamxr_linuxarm64.json")]
supported_runtime = False
for candidate in candidates:
if candidate.is_file():
try:
info = json.loads(candidate.read_text())
library = pathlib.Path(info["runtime"]["library_path"])
if not library.is_absolute():
library = candidate.resolve().parent / library
if library.is_file() and "linuxarm64" in str(library):
supported_runtime = True
break
except (OSError, ValueError, KeyError, TypeError):
continue
if not supported_runtime:
raise ValueError("SteamVR's ARM64 OpenXR runtime was not found. Run SteamVR on the Frame once, then retry.")
owned(CACHE)
beneath(CACHE / "resources", CACHE).mkdir(exist_ok=True)
beneath(CACHE / "runs", CACHE).mkdir(exist_ok=True)
for name in ("remote_install.py", "build-native.sh", "steam_shortcut.py", "frame-controls.patch"):
candidate = beneath(CACHE / "resources" / name, CACHE)
if candidate.exists() and (not candidate.is_file() or candidate.stat().st_nlink != 1 or candidate.stat().st_uid != os.getuid()):
raise ValueError("An installer resource path is not a private ordinary file.")
existing = existing_install(repair, adopt)
free = shutil.disk_usage(HOME).free
if (existing is None or repair) and free < MIN_FREE_BYTES:
raise ValueError("At least 12 GiB of free space is needed for the Xbox data and isolated build. Free space and retry.")
# Podman itself is unprivileged. Never use sudo or disable SteamOS read-only protection.
podman = json.loads(command(["podman", "info", "--format", "json"]))
if not podman.get("host", {}).get("security", {}).get("rootless", False):
raise ValueError("Podman must run rootless as steamos.")
return {"home": str(HOME), "cachePath": str(CACHE), "gamePath": str(GAME),
"architecture": platform.machine(), "freeBytes": free, "existing": existing,
"pcVersionDetected": (HOME / "Games/HaloCEVR").is_dir(),
"steamOSVersion": system.get("VERSION_ID", "unknown")}
def prepare(value, use_existing_maps=False, repair=False, adopt=False):
directory = run_dir(value)
owned(directory)
for relative in ("upload", "upload/maps", "stage"):
path = beneath(directory / relative, directory)
path.mkdir(exist_ok=True)
metadata = read_marker(directory / MARKER)
if use_existing_maps:
current = existing_install(repair, adopt)
if not current or not current["mapsVerified"]:
raise ValueError("The existing native Xbox maps must verify before reuse.")
manifest = installed_maps_manifest()
(directory / "upload/xbox-data-manifest.json").write_text(json.dumps(manifest, indent=2) + "\n")
metadata["mapsOrigin"] = "existing" if use_existing_maps else "upload"
metadata["repair"] = repair
metadata["adopt"] = adopt
(directory / MARKER).write_text(json.dumps(metadata, indent=2) + "\n")
return {"runPath": str(directory), "uploadPath": str(directory / "upload")}
def verify_maps(directory, manifest, check_cancelled=lambda: None, allow_extra=False):
files = manifest.get("files")
if not isinstance(files, list) or len(files) != 24:
raise ValueError("The Xbox data manifest must contain exactly 24 supported map files.")
if {entry.get("path") for entry in files} != EXPECTED_MAPS:
raise ValueError("The Xbox data manifest does not contain the 24 expected original Xbox maps.")
map_dir = beneath(directory / "maps", directory)
actual_paths = {"maps/" + item.name for item in map_dir.iterdir()} if map_dir.is_dir() else set()
if not map_dir.is_dir() or (not EXPECTED_MAPS.issubset(actual_paths) if allow_extra else actual_paths != EXPECTED_MAPS):
raise ValueError("The Xbox maps directory contains extra or missing files.")
seen = set()
builds = set()
total = 0
for entry in files:
check_cancelled()
relative = entry.get("path", "")
parts = pathlib.PurePosixPath(relative)
if parts.is_absolute() or ".." in parts.parts or str(parts) != relative or relative not in EXPECTED_MAPS or relative in seen:
raise ValueError("Invalid or duplicate Xbox map path.")
expected = entry.get("sha256", "")
if not re.fullmatch("[a-f0-9]{64}", expected):
raise ValueError("Invalid Xbox map SHA256.")
target = beneath(directory / relative, directory)
ordinary(target)
if not 2048 <= target.stat().st_size <= MAX_MAP_BYTES:
raise ValueError("Xbox cache file is outside supported bounds: " + relative)
with target.open("rb") as stream:
header = stream.read(2048)
if len(header) != 2048 or header[:4] != b"daeh" or header[-4:] != b"toof" or struct.unpack_from("<I", header, 4)[0] != 5:
raise ValueError("Xbox cache header verification failed: " + relative)
if not 2048 <= struct.unpack_from("<I", header, 8)[0] <= MAX_MAP_BYTES:
raise ValueError("Xbox declared cache length is outside supported bounds: " + relative)
build_string = header[64:96].split(b"\0", 1)[0].decode("ascii")
if build_string not in SUPPORTED_BUILDS:
raise ValueError("Unsupported original Xbox Halo build: " + build_string)
builds.add(build_string)
if target.stat().st_size != entry["size"] or digest(target) != expected:
raise ValueError("Xbox data verification failed: " + relative)
seen.add(relative)
total += entry["size"]
check_cancelled()
if len(builds) != 1:
raise ValueError("Xbox maps mix multiple retail builds.")
if manifest.get("totalBytes") != total or not 0 < total <= MAX_TOTAL_BYTES:
raise ValueError("Xbox data total does not match the manifest.")
return total
def build(value, repair=False, adopt=False):
directory = run_dir(value)
metadata = read_marker(directory / MARKER)
if existing_install(repair, adopt) and not repair:
return {"reused": True}
upload = directory / "upload"
def check_cancelled():
if (directory / "cancelled").exists():
raise RuntimeError("Build cancelled. Existing games and saves were kept.")
check_cancelled()
manifest = json.loads(ordinary(upload / "xbox-data-manifest.json").read_text())
progress("verify", "Verifying the uploaded Xbox maps...")
verify_maps(GAME if metadata.get("mapsOrigin") == "existing" else upload, manifest, check_cancelled,
allow_extra=metadata.get("mapsOrigin") == "existing")
source = directory / "src"
if source.exists():
raise ValueError("A source checkout already exists for this run. Retry with a fresh run.")
progress("source", "Fetching the pinned native VR source from GitHub...")
command(["git", "init", str(source)], cancel_check=check_cancelled)
check_cancelled()
command(["git", "-C", str(source), "remote", "add", "origin", SOURCE_URL], cancel_check=check_cancelled)
check_cancelled()
command(["git", "-C", str(source), "fetch", "--depth", "1", "origin", SOURCE_COMMIT], cancel_check=check_cancelled, timeout=300)
check_cancelled()
command(["git", "-C", str(source), "checkout", "--detach", "FETCH_HEAD"], cancel_check=check_cancelled)
check_cancelled()
if command(["git", "-C", str(source), "rev-parse", "HEAD"], cancel_check=check_cancelled) != SOURCE_COMMIT:
raise ValueError("Source pin verification failed.")
patch = ordinary(CACHE / "resources/frame-controls.patch")
command(["git", "-C", str(source), "apply", "--check", str(patch)], cancel_check=check_cancelled)
command(["git", "-C", str(source), "apply", str(patch)], cancel_check=check_cancelled)
check_cancelled()
script = ordinary(CACHE / "resources/build-native.sh")
shutil.copy2(script, directory / "build-native.sh")
container = "halo-frame-installer-" + value
progress("build", "Preparing and compiling the native ARM64 VR game in an isolated container. This may take 10–30 minutes...")
log = directory / "native-build.log"
args = ["podman", "run", "--rm", "--name", container,
"--label", "org.halo-frame-installer.owner=" + OWNER,
"--label", "org.halo-frame-installer.run=" + value,
"--userns=keep-id:uid=0,gid=0", "--security-opt=no-new-privileges",
"--volume", str(directory) + ":/build:rw", "--workdir", "/build",
"docker.io/library/ubuntu:22.04", "/bin/bash", "/build/build-native.sh"]
with log.open("wb") as output:
check_cancelled()
process = subprocess.Popen(args, stdout=output, stderr=subprocess.STDOUT, start_new_session=True)
last_status = time.monotonic()
try:
while process.poll() is None:
if (directory / "cancelled").exists():
cancel(value)
stop_build_process(process)
raise RuntimeError("Build cancelled. Existing games and saves were kept.")
if time.monotonic() - last_status > 15:
# User sees steady status; detailed dependency/compiler output stays on the Frame.
progress("build", "Native build is running. Detailed log: " + str(log))
last_status = time.monotonic()
time.sleep(1)
except BaseException:
try:
cancel(value)
finally:
stop_build_process(process)
raise
if process.returncode:
tail = log.read_text(errors="replace")[-12000:]
raise RuntimeError("Native build failed. The existing game was kept.\n" + tail)
binary = source / "build/linux_arm64/halo"
elf_arm64(binary)
ordinary(source / "build/linux_arm64/libSDL3.so.0")
return {"built": True, "binarySha256": digest(binary), "logPath": str(log)}
def stop_build_process(process):
"""Reap this helper's supervised Podman process, including a pre-container pull."""
if process.poll() is not None:
return
# start_new_session established a private process group for this child only.
try:
group = os.getpgid(process.pid)
except ProcessLookupError:
process.wait(timeout=10)
return
if group != process.pid:
raise ValueError("Build process is no longer in its owned private process group.")
try:
os.killpg(process.pid, signal.SIGTERM)
except ProcessLookupError:
process.wait(timeout=10)
return
try:
process.wait(timeout=10)
except subprocess.TimeoutExpired:
if os.getpgid(process.pid) != process.pid:
raise ValueError("Build process group changed during cancellation.")
os.killpg(process.pid, signal.SIGKILL)
process.wait(timeout=10)
def cancel(value):
directory = run_dir(value)
read_marker(directory / MARKER)
(directory / "cancelled").touch()
container = "halo-frame-installer-" + value
check = subprocess.run(["podman", "container", "inspect", container],
text=True, stdout=subprocess.PIPE, stderr=subprocess.DEVNULL, timeout=15)
if check.returncode == 0:
info = json.loads(check.stdout)[0]
labels = info.get("Config", {}).get("Labels", {})
if labels.get("org.halo-frame-installer.owner") != OWNER or labels.get("org.halo-frame-installer.run") != value:
raise ValueError("Refusing to stop an unowned container.")
command(["podman", "stop", "--time", "10", container])
return {"cancelled": True}
def merge_config(original):
"""Restore required native controls while preserving unrelated TOML settings."""
settings = tomllib.loads(original) if original.strip() else {}
required = {"vr": {"enabled": True, "aim": "controller", "melee_gesture": False},
"update": {"auto": False}}
defaults = {"refresh_rate": 72.0, "resolution_scale": 1.0, "turn": "smooth",
"smooth_turn_speed": 90.0, "two_handed": True, "height": "seated", "depth": False}
vr = settings.get("vr", {})
for key, default in defaults.items():
if key not in vr:
required["vr"][key] = default
lines = original.splitlines()
for section, changes in required.items():
headers = [(i, match.group(1).strip()) for i, line in enumerate(lines)
if (match := re.match(r"^\s*\[([^\]]+)\]\s*(?:#.*)?$", line))]
start = next((i for i, name in headers if name == section), None)
if start is None:
if lines and lines[-1]:
lines.append("")
lines.append("[" + section + "]")
start = len(lines) - 1
boundaries = [i for i, line in enumerate(lines) if re.match(r"^\s*\[.+\]", line)]
end = next((i for i in boundaries if i > start), len(lines))
remaining = dict(changes)
for i in range(start + 1, end):
match = re.match(r"^\s*([A-Za-z0-9_-]+)\s*=", lines[i])
if match and match.group(1) in remaining:
key = match.group(1)
lines[i] = key + " = " + json.dumps(remaining.pop(key))
lines[end:end] = [key + " = " + json.dumps(val) for key, val in remaining.items()]
combined = "\n".join(lines) + "\n"
updated = tomllib.loads(combined)
if any(updated.get(section, {}).get(key) != value for section, changes in required.items() for key, value in changes.items()):
raise ValueError("This TOML formatting cannot be safely updated automatically. Your original configuration was kept.")
for section, value in settings.items():
if section not in required:
if updated.get(section) != value:
raise ValueError("Configuration update would change unrelated settings. Your original configuration was kept.")
else:
for key, original_value in value.items():
if key not in required[section] and updated[section].get(key) != original_value:
raise ValueError("Configuration update would change unrelated settings. Your original configuration was kept.")
return combined
def repair_program_files(stage, directory, names, check_cancelled):
"""Back up then atomically replace each selected file; roll back on any failure."""
game_closed()
backup = beneath(directory / "previous-program-files", directory)
backup.mkdir(exist_ok=False)
(backup / ".backup-owner.json").write_text(json.dumps({"owner": OWNER, "sourceCommit": SOURCE_COMMIT}) + "\n")
snapshot = []
for relative in names:
check_cancelled()
target = beneath(GAME / relative, GAME)
fresh = beneath(stage / relative, stage)
ordinary(fresh)
saved = beneath(backup / relative, backup)
saved.parent.mkdir(parents=True, exist_ok=True)
old_hash = None
if target.exists():
ordinary(target)
old_hash = digest(target)
shutil.copy2(target, saved)
if digest(saved) != old_hash:
raise ValueError("The existing game changed while backing up: " + relative)
snapshot.append((relative, old_hash, digest(fresh)))
applied = []
try:
for relative, old_hash, new_hash in snapshot:
check_cancelled()
game_closed()
target = beneath(GAME / relative, GAME)
actual = digest(ordinary(target)) if target.exists() else None
if actual != old_hash:
raise ValueError("The existing game changed during repair: " + relative)
target.parent.mkdir(parents=True, exist_ok=True)
os.replace(stage / relative, target)
applied.append((relative, old_hash, new_hash))
for relative, _, expected in snapshot:
if digest(GAME / relative) != expected:
raise ValueError("A repaired program file failed verification: " + relative)
check_cancelled()
except BaseException as error:
failures = []
for relative, old_hash, _ in reversed(applied):
target = GAME / relative
try:
if old_hash is None:
target.unlink()
else:
os.replace(backup / relative, target)
except OSError:
failures.append(relative)
if failures:
raise RuntimeError("Repair failed and some files could not be restored: " + ", ".join(failures) + ". Original files remain in " + str(backup)) from error
raise
return str(backup)
def finalize(value, repair=False, adopt=False):
directory = run_dir(value)
run_metadata = read_marker(directory / MARKER)
def check_cancelled():
if (directory / "cancelled").exists():
raise ValueError("This run was cancelled. Existing games and saves were kept.")
check_cancelled()
existing = existing_install(repair, adopt)
if existing and not repair:
return existing
source = directory / "src"
binary = source / "build/linux_arm64/halo"
elf_arm64(binary)
stage = beneath(directory / "stage", directory)
if any(stage.iterdir()):
raise ValueError("Staging contains unfinished files. Start a fresh installation.")
progress("install", "Staging and verifying the game before adding it to your library...")
shutil.copy2(binary, stage / "halo")
(stage / "halo").chmod(0o755)
shutil.copy2(ordinary(source / "build/linux_arm64/libSDL3.so.0"), stage / "libSDL3.so.0")
upload = directory / "upload"
manifest = json.loads(ordinary(upload / "xbox-data-manifest.json").read_text())
reuse_maps = run_metadata.get("mapsOrigin") == "existing"
verify_maps(GAME if reuse_maps else upload, manifest, check_cancelled, allow_extra=reuse_maps)
if not existing or not reuse_maps:
(stage / "maps").mkdir()
for entry in manifest["files"]:
check_cancelled()
path = beneath(upload / entry["path"], upload)
shutil.copy2(ordinary(path), stage / entry["path"])
shutil.copy2(upload / "xbox-data-manifest.json", stage / "xbox-data-manifest.json")
if not existing or not reuse_maps:
verify_maps(stage, manifest, check_cancelled)
if not existing:
(stage / "save").mkdir()
config = ('[paths]\ndata = "' + str(GAME) + '"\nsaves = "' + str(GAME / "save") + '"\n\n'
'[update]\nauto = false\n\n[network]\nonline = true\n\n'
'[vr]\nenabled = true\nrefresh_rate = 72.0\nresolution_scale = 1.0\n'
'aim = "controller"\nturn = "smooth"\nsmooth_turn_speed = 90.0\n'
'melee_gesture = false\ntwo_handed = true\nheight = "seated"\ndepth = false\n')
if existing:
original = ordinary(GAME / "config.toml").read_text() if (GAME / "config.toml").exists() else ""
config = merge_config(original)
(stage / "config.toml").write_text(config)
shutil.copy2(CACHE / "resources/frame-controls.patch", stage / "frame-controls.patch")
notices = {
"LICENSE.md": "UPSTREAM-LICENSE.md",
"port/third_party/mbedtls/LICENSE": "mbedtls-LICENSE.txt",
"port/third_party/miniupnpc/LICENSE": "miniupnpc-LICENSE.txt",
"port/third_party/expat/COPYING": "expat-COPYING.txt",
"port/third_party/extract-xiso/LICENSE.TXT": "extract-xiso-LICENSE.txt",
"port/assets/fonts/Overpass-OFL.txt": "Overpass-OFL.txt",
"build/linux_arm64/third_party/SDL3/LICENSE.txt": "SDL3-LICENSE.txt",
"build/linux_arm64/third_party/musl-1.2.5/COPYRIGHT": "musl-COPYRIGHT.txt",
"port/third_party/tomlc17/LICENSE": "tomlc17-LICENSE.txt",
"port/third_party/stb/LICENSE": "stb-LICENSE.txt",
"port/third_party/musl-math/COPYRIGHT": "musl-math-COPYRIGHT.txt",
"port/third_party/monocypher/LICENCE.md": "monocypher-LICENCE.md",
"port/third_party/kcp/LICENSE": "kcp-LICENSE.txt",
}
for relative, name in notices.items():
notice = source / relative
if notice.is_file():
shutil.copy2(notice, stage / name)
libs = command(["ldd", str(stage / "halo")])
if "not found" in libs:
raise ValueError("A required native runtime library is missing:\n" + libs)
metadata = {"owner": OWNER, "version": 1, "sourceCommit": SOURCE_COMMIT,
"sourceUrl": SOURCE_URL, "architecture": "native ARM64 ELF64 / ILP32 AArch64 guest",
"files": {name: digest(stage / name) for name in ("halo", "libSDL3.so.0", "frame-controls.patch")},
"maps": {"files": 24, "bytes": manifest["totalBytes"]},
"controls": "Xbox buttons, motion aim, LB grenade change, RB flashlight",
"buildLog": str(directory / "native-build.log")}
(stage / MARKER).write_text(json.dumps(metadata, indent=2) + "\n")
if existing:
names = [item.name for item in stage.iterdir() if item.is_file() and item.name != MARKER]
if not reuse_maps:
names += [item["path"] for item in manifest["files"]]
# Publish the ownership/provenance marker last; saves and all other files stay put.
names.append(MARKER)
backup = repair_program_files(stage, directory, names, check_cancelled)
return {"gamePath": str(GAME), "reused": False, "repaired": True,
"sourceCommit": SOURCE_COMMIT, "backupPath": backup, "mapsReinstalled": not reuse_maps}
beneath(GAME.parent, HOME).mkdir(exist_ok=True)
if GAME.exists() or GAME.is_symlink():
raise ValueError("The game destination appeared during installation. It was not modified.")
if stage.stat().st_dev != GAME.parent.stat().st_dev:
raise ValueError("Game and staging must be on the same filesystem for atomic installation.")
check_cancelled()
rename_noreplace(stage, GAME)
return {"gamePath": str(GAME), "reused": False, "sourceCommit": SOURCE_COMMIT}
def rename_noreplace(source, target):
"""Publish atomically without replacing even a concurrently created empty folder."""
libc = ctypes.CDLL(None, use_errno=True)
try:
rename = libc.renameat2
except AttributeError:
raise RuntimeError("This SteamOS libc has no renameat2; atomic no-overwrite installation is unavailable.") from None
rename.argtypes = (ctypes.c_int, ctypes.c_char_p, ctypes.c_int, ctypes.c_char_p, ctypes.c_uint)
rename.restype = ctypes.c_int
if rename(-100, os.fsencode(source), -100, os.fsencode(target), 1) != 0:
code = ctypes.get_errno()
raise OSError(code, os.strerror(code), str(target))
def shortcut(close_steam=False):
current = existing_install()
if current is None:
raise ValueError("Install and verify the native game before adding it to Steam.")
sys.path.insert(0, str(CACHE / "resources"))
from steam_shortcut import add_native_shortcut
return add_native_shortcut(HOME, GAME, close_steam=close_steam)
def main():
parser = argparse.ArgumentParser()
parser.add_argument("step", choices=("preflight", "prepare", "build", "finalize", "cancel", "shortcut"))
parser.add_argument("--run-id")
parser.add_argument("--close-steam", action="store_true")
parser.add_argument("--repair", action="store_true")
parser.add_argument("--adopt-existing", action="store_true")
parser.add_argument("--use-existing-maps", action="store_true")
args = parser.parse_args()
if args.step in ("prepare", "build", "finalize", "cancel") and args.run_id is None:
parser.error("--run-id is required")
functions = {"preflight": lambda: preflight(args.repair, args.adopt_existing),
"prepare": lambda: prepare(args.run_id, args.use_existing_maps, args.repair, args.adopt_existing),
"build": lambda: build(args.run_id, args.repair, args.adopt_existing),
"finalize": lambda: finalize(args.run_id, args.repair, args.adopt_existing),
"cancel": lambda: cancel(args.run_id), "shortcut": lambda: shortcut(args.close_steam)}
result(functions[args.step]())
if __name__ == "__main__":
try:
main()
except (OSError, ValueError, RuntimeError, KeyError, subprocess.SubprocessError) as error:
print("HFI_ERROR " + str(error), file=sys.stderr, flush=True)
sys.exit(1)
+413
View File
@@ -0,0 +1,413 @@
"""Add the native game to the most recent Steam account while Steam is closed.
Steam's binary shortcuts format is undocumented. Unknown types are rejected,
existing entries retain their type/value structure, and an exact backup is kept.
"""
from __future__ import annotations
import json
import os
import re
import struct
import tempfile
import time
import zlib
from collections import OrderedDict
from dataclasses import dataclass
from pathlib import Path
NAME = "Halo: Combat Evolved VR (Native)"
LAUNCH_OPTIONS = "SDL_GAMECONTROLLER_ALLOW_STEAM_VIRTUAL_GAMEPAD=0 %command%"
@dataclass
class Value:
kind: int
value: object
def loads(data: bytes) -> OrderedDict:
cursor = 0
def read(n):
nonlocal cursor
if n < 0 or cursor + n > len(data):
raise ValueError("Steam shortcuts file is truncated.")
result = data[cursor:cursor + n]
cursor += n
return result
def string():
nonlocal cursor
end = data.find(b"\0", cursor)
if end < 0:
raise ValueError("Steam shortcuts string is truncated.")
result = data[cursor:end].decode("utf-8", "surrogateescape")
cursor = end + 1
return result
def obj(depth=0):
if depth > 20:
raise ValueError("Steam shortcuts file is too deeply nested.")
result = OrderedDict()
while True:
kind = read(1)[0]
if kind == 8:
return result
key = string()
if key in result:
raise ValueError("Steam shortcuts has duplicate fields; no changes were made.")
if kind == 0:
value = obj(depth + 1)
elif kind == 1:
value = string()
elif kind == 2:
value = struct.unpack("<I", read(4))[0]
elif kind in (3, 4, 6):
value = read(4)
elif kind == 5:
count = read(2)
value = count + read(struct.unpack("<H", count)[0] * 2)
elif kind in (7, 10):
value = read(8)
else:
raise ValueError(f"Unsupported Steam shortcuts field type {kind}; no changes were made.")
result[key] = Value(kind, value)
root = obj()
if cursor != len(data):
raise ValueError("Unexpected data after the Steam shortcuts root.")
return root
def dumps(root: OrderedDict) -> bytes:
def text(value):
encoded = str(value).encode("utf-8", "surrogateescape")
if b"\0" in encoded:
raise ValueError("Steam shortcut fields cannot contain NUL.")
return encoded + b"\0"
def obj(fields):
result = bytearray()
for key, field in fields.items():
result.extend(bytes([field.kind]) + text(key))
if field.kind == 0:
result.extend(obj(field.value))
elif field.kind == 1:
result.extend(text(field.value))
elif field.kind == 2:
result.extend(struct.pack("<I", field.value))
elif field.kind in (3, 4, 5, 6, 7, 10):
result.extend(field.value)
else:
raise ValueError("Unsupported field type.")
result.append(8)
return bytes(result)
return obj(root)
def steam_running(proc: Path = Path("/proc")) -> bool:
for item in proc.iterdir():
if not item.name.isdecimal():
continue
try:
name = (item / "comm").read_text().strip()
exe = Path(os.readlink(item / "exe")).name
if name == "steam" or exe == "steam":
return True
except (FileNotFoundError, PermissionError, ProcessLookupError):
continue
return False
def _active_account(steam: Path) -> str:
users = steam / "config/loginusers.vdf"
if users.is_file() and not users.is_symlink():
text = users.read_text(encoding="utf-8")
matches = []
# loginusers has one flat quoted block per SteamID64; tolerate escaped names.
for match in re.finditer(r'"(\d{17})"\s*\{([^{}]*)\}', text):
if re.search(r'"MostRecent"\s*"1"', match.group(2), flags=re.I):
value = int(match.group(1)) - 76561197960265728
if 0 < value < 2 ** 32:
matches.append(str(value))
if len(matches) == 1:
return matches[0]
userdata = steam / "userdata"
accounts = [p.name for p in userdata.iterdir()
if p.is_dir() and not p.is_symlink() and p.name.isdecimal() and 0 < int(p.name) < 2 ** 32] if userdata.exists() else []
if len(accounts) != 1:
raise ValueError("Could not identify one Steam account. Add the game manually after signing in.")
return accounts[0]
def _text_vdf(text: str) -> dict:
tokens = []
i = 0
while i < len(text):
if text[i].isspace() or text[i] == "\ufeff":
i += 1
elif text.startswith("//", i):
end = text.find("\n", i)
i = len(text) if end < 0 else end + 1
elif text[i] in "{}":
tokens.append(text[i])
i += 1
elif text[i] == '"':
i += 1
value = []
while i < len(text) and text[i] != '"':
if text[i] == "\\" and i + 1 < len(text):
i += 1
value.append(text[i])
i += 1
if i >= len(text):
raise ValueError("Steam config has an unterminated string.")
tokens.append(("string", "".join(value)))
i += 1
else:
raise ValueError("Steam config has unsupported text fields.")
cursor = 0
def obj(depth=0):
nonlocal cursor
if depth > 30:
raise ValueError("Steam config is too deeply nested.")
fields = {}
while cursor < len(tokens):
key = tokens[cursor]
cursor += 1
if key == "}":
if depth == 0:
raise ValueError("Steam config has an unexpected closing brace.")
return fields
if not isinstance(key, tuple) or cursor >= len(tokens):
raise ValueError("Steam config has invalid key/value fields.")
value = tokens[cursor]
cursor += 1
if value == "{":
value = obj(depth + 1)
elif isinstance(value, tuple):
value = value[1]
else:
raise ValueError("Steam config has an invalid value.")
fields[key[1]] = value
if depth:
raise ValueError("Steam config has an unterminated object.")
return fields
return obj()
def _compatibility_warning(steam: Path, appid: int) -> str | None:
config = steam / "config/config.vdf"
if not config.exists():
return None
if config.is_symlink() or not config.is_file() or config.stat().st_size > 8 * 1024 * 1024:
return "Steam's compatibility setting could not be checked. In Halo's Properties > Compatibility, leave Force the use of a specific Steam Play compatibility tool disabled."
try:
fields = _text_vdf(config.read_text(encoding="utf-8"))
except (OSError, ValueError, UnicodeError):
return "Steam's compatibility setting could not be checked. In Halo's Properties > Compatibility, leave Force the use of a specific Steam Play compatibility tool disabled."
def find(value):
for key, nested in value.items():
if key.casefold() == "compattoolmapping" and isinstance(nested, dict):
selected = nested.get(str(appid), {})
if isinstance(selected, dict) and selected.get("name"):
return str(selected["name"])
if isinstance(nested, dict):
match = find(nested)
if match:
return match
return None
tool = find(fields)
if tool:
return "The native Halo shortcut has a forced compatibility tool (" + tool + "). Open Halo's Properties > Compatibility and turn off Force the use of a specific Steam Play compatibility tool."
return None
def _added_result(steam: Path, appid: int, **extra) -> dict:
warning = _compatibility_warning(steam, appid)
if warning:
return {"status": "manual", "libraryAdded": True, "appid": appid, "name": NAME,
"reason": warning, "instructions": warning, **extra}
return {"status": "added", "appid": appid, "name": NAME, **extra}
def update_shortcut(data: bytes | None, executable: str, directory: str) -> tuple[bytes, int]:
root = loads(data) if data is not None else OrderedDict([("shortcuts", Value(0, OrderedDict()))])
if set(root) != {"shortcuts"} or root["shortcuts"].kind != 0:
raise ValueError("Unexpected Steam shortcuts root; no changes were made.")
shortcuts = root["shortcuts"].value
exe = f'"{executable}"'
start = f'"{directory}"'
matches = []
for index, entry in shortcuts.items():
if entry.kind != 0:
raise ValueError("Unexpected Steam shortcut record; no changes were made.")
fields = entry.value
title = fields.get("AppName", fields.get("appname"))
path = fields.get("Exe", fields.get("exe"))
if title and title.value == NAME:
if path is None or str(path.value).strip('"') != executable:
raise ValueError("A different game already uses this Steam shortcut name. Add this game manually.")
matches.append((index, fields))
if len(matches) > 1:
raise ValueError("Multiple native Halo shortcuts exist. No changes were made.")
if matches:
_, fields = matches[0]
app = fields.get("appid")
if app is None or app.kind != 2 or not 2 ** 31 <= app.value < 2 ** 32:
raise ValueError("The existing native Halo shortcut has an invalid app ID.")
appid = app.value
else:
appid = zlib.crc32((exe + NAME).encode("utf-8")) | 0x80000000
used = {entry.value.get("appid").value for entry in shortcuts.values() if entry.value.get("appid")}
if appid in used:
raise ValueError("Steam shortcut app ID collision. Add the game manually.")
indices = [int(key) for key in shortcuts if key.isdecimal()]
key = str(max(indices, default=-1) + 1)
fields = OrderedDict()
shortcuts[key] = Value(0, fields)
fields["appid"] = Value(2, appid)
# Preserve tags, artwork, playtime and all other fields on an existing entry.
for key, value in {"AppName": NAME, "Exe": exe, "StartDir": start,
"LaunchOptions": LAUNCH_OPTIONS}.items():
# Remove only an alternative case spelling of fields we are writing.
for old in list(fields):
if old.lower() == key.lower() and old != key:
del fields[old]
fields[key] = Value(1, value)
for key in ("icon", "ShortcutPath"):
if key not in fields:
fields[key] = Value(1, "")
for key, value in {"IsHidden": 0, "AllowDesktopConfig": 1, "AllowOverlay": 1,
"OpenVR": 1, "Devkit": 0, "DevkitOverrideAppID": 0}.items():
fields[key] = Value(2, value)
if "LastPlayTime" not in fields:
fields["LastPlayTime"] = Value(2, 0)
if "tags" not in fields:
fields["tags"] = Value(0, OrderedDict())
result = dumps(root)
# Ensure the generated bytes can be parsed before writing anything.
loads(result)
return result, appid
def _session_environment(proc: Path = Path("/proc")) -> tuple[dict | None, bool]:
allowed = {"DISPLAY", "WAYLAND_DISPLAY", "XAUTHORITY", "XDG_RUNTIME_DIR",
"DBUS_SESSION_BUS_ADDRESS", "XDG_SESSION_TYPE"}
session = None
game_running = False
for item in proc.iterdir():
if not item.name.isdecimal():
continue
try:
if item.stat().st_uid != os.getuid():
continue
name = (item / "comm").read_text().strip()
entries = {}
for raw in (item / "environ").read_bytes().split(b"\0"):
key, separator, value = raw.partition(b"=")
if separator:
entries[key.decode("utf-8", "replace")] = value.decode("utf-8", "replace")
if name == "steam":
env = dict(os.environ)
env.update({key: entries[key] for key in allowed if key in entries})
if "DISPLAY" in env or "WAYLAND_DISPLAY" in env:
session = env
elif name != "steamwebhelper":
appid = entries.get("SteamAppId", "0")
if appid.isdecimal() and int(appid) not in (0, 250820):
game_running = True
if Path(os.readlink(item / "exe")) == Path("/home/steamos/Games/HaloCENativeVR/halo"):
game_running = True
except (FileNotFoundError, PermissionError, ProcessLookupError):
continue
return session, game_running
def add_native_shortcut(home: Path, game: Path, close_steam: bool = False) -> dict:
"""Optionally request Steam's normal shutdown, then restore its GUI session.
The GUI must obtain explicit saved/closed-game acknowledgement for close_steam.
No signals are sent to Steam, SteamVR, a game or another user's process.
"""
import subprocess
if not close_steam or not steam_running():
return _write_native_shortcut(home, game)
session, game_running = _session_environment()
if game_running:
return _manual(game, "A game is still running. Save and close games, then click Add to Steam again.")
if session is None or not Path("/usr/bin/steam").is_file():
return _manual(game, "Steam's desktop session could not be verified. Quit Steam and click Add to Steam again.")
try:
subprocess.run(["/usr/bin/steam", "-shutdown"], env=session,
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, timeout=20)
except (OSError, subprocess.TimeoutExpired):
return _manual(game, "Steam did not complete a normal shutdown. Quit it and click Add to Steam again.")
deadline = time.monotonic() + 45
while steam_running() and time.monotonic() < deadline:
time.sleep(0.5)
if steam_running():
return _manual(game, "Steam is still running after its normal shutdown request. Its library files were left unchanged.")
try:
return _write_native_shortcut(home, game)
finally:
# Only restart a client this operation observed running and normally closed.
subprocess.Popen(["/usr/bin/steam"], env=session, stdin=subprocess.DEVNULL,
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL,
start_new_session=True)
def _manual(game: Path, reason: str | None = None) -> dict:
manual = {"status": "manual", "name": NAME, "executable": str(game / "halo"),
"directory": str(game), "launchOptions": LAUNCH_OPTIONS,
"instructions": "Quit Steam and click Add to Steam again, or use Steam > Add a Game > Add a Non-Steam Game and browse to the executable. Set the displayed launch options and leave compatibility tools disabled."}
if reason is not None:
manual["reason"] = reason
return manual
def _write_native_shortcut(home: Path, game: Path) -> dict:
manual = _manual(game)
if steam_running():
return {**manual, "reason": "Steam is still running; its library files were left unchanged."}
steam = home / ".local/share/Steam"
if not steam.is_dir() or steam.resolve() != steam:
return {**manual, "reason": "Steam's standard user-data folder was not found."}
try:
account = _active_account(steam)
config = steam / "userdata" / account / "config"
if config.is_symlink() or (config.exists() and config.resolve() != config):
raise ValueError("Steam account config is a symbolic link; add the game manually.")
config.mkdir(parents=True, exist_ok=True)
path = config / "shortcuts.vdf"
if path.is_symlink() or (path.exists() and (not path.is_file() or path.stat().st_size > 8 * 1024 * 1024)):
raise ValueError("Steam shortcuts file is not a supported ordinary file.")
before = path.read_bytes() if path.exists() else None
after, appid = update_shortcut(before, str(game / "halo"), str(game))
# A second guard prevents overwriting Steam's live view if it opened during work.
if steam_running():
return {**manual, "reason": "Steam reopened during setup; its library files were left unchanged."}
if (path.read_bytes() if path.exists() else None) != before:
return {**manual, "reason": "Steam's shortcuts changed during setup; no changes were made."}
if before == after:
return _added_result(steam, appid, unchanged=True)
backup = None
if before is not None:
backup = config / ("shortcuts.vdf.halo-frame-installer-" + str(time.time_ns()) + ".bak")
with backup.open("xb") as stream:
stream.write(before)
backup.chmod(0o600)
fd, temp = tempfile.mkstemp(prefix=".halo-shortcuts-", dir=config)
try:
with os.fdopen(fd, "wb") as stream:
stream.write(after)
stream.flush()
os.fsync(stream.fileno())
os.chmod(temp, path.stat().st_mode & 0o777 if path.exists() else 0o600)
os.replace(temp, path)
finally:
if os.path.exists(temp):
os.unlink(temp)
return _added_result(steam, appid, backup=str(backup) if backup else None)
except (OSError, ValueError, UnicodeError) as error:
return {**manual, "reason": str(error)}
+57
View File
@@ -0,0 +1,57 @@
"""Build only the installer executable/source, never commercial game files."""
from __future__ import annotations
import hashlib
import json
from pathlib import Path
import subprocess
import sys
import zipfile
ROOT = Path(__file__).resolve().parents[1]
DIST = ROOT / "dist"
VERSION = "0.1.0"
def allowed_source_files():
roots = [ROOT / name for name in ("src", "resources", "docs", "scripts", "tests", ".github")]
files = [ROOT / name for name in ("README.md", "LICENSE", "SECURITY.md", "pyproject.toml", ".gitignore", ".gitattributes")]
for directory in roots:
if directory.exists():
for path in directory.rglob("*"):
if path.is_file() and not any(part in ("__pycache__", ".pytest_cache") or part.endswith(".egg-info") for part in path.parts):
files.append(path)
for path in files:
if path.is_symlink() or not path.resolve().is_relative_to(ROOT.resolve()):
raise RuntimeError("Unexpected release source path")
if path.suffix.lower() in (".iso", ".xiso", ".map", ".reg", ".key", ".pem") or path.name in ("halo", "hosts.json"):
raise RuntimeError("Private or commercial files must never be packaged")
return sorted(files)
def main():
if sys.platform != "win32":
raise SystemExit("Build the Windows executable on Windows.")
DIST.mkdir(exist_ok=True)
subprocess.run([sys.executable, str(ROOT / "scripts/gather_notices.py"), "--download-sources"], cwd=ROOT, check=True)
source_files = allowed_source_files()
snapshots = {path:hashlib.sha256(path.read_bytes()).hexdigest() for path in source_files}
subprocess.run([sys.executable,"-m","PyInstaller","--noconfirm","--clean","--onefile","--windowed",
"--name","HaloFrameSetup","--paths",str(ROOT / "src"),
"--add-data",str(ROOT / "resources") + ";resources",
"--add-data",str(ROOT / "docs") + ";docs",
"--add-data",str(ROOT / "LICENSE") + ";.",
"--distpath",str(DIST),"--workpath",str(ROOT / "build/pyinstaller"),
"--specpath",str(ROOT / "build"),str(ROOT / "scripts/launch.py")], cwd=ROOT, check=True)
source = DIST / f"HaloFrameSetup-{VERSION}-source.zip"
if source_files != allowed_source_files() or any(hashlib.sha256(path.read_bytes()).hexdigest() != expected for path,expected in snapshots.items()):
raise RuntimeError('Source changed during the executable build. Rebuild the release from a stable checkout.')
with zipfile.ZipFile(source, "w", zipfile.ZIP_DEFLATED) as archive:
for path in source_files:
archive.write(path, f"halo-steam-frame-installer-{VERSION}/" + path.relative_to(ROOT).as_posix())
files = [DIST / "HaloFrameSetup.exe", source]
checksums = []
for path in files:
checksums.append(hashlib.sha256(path.read_bytes()).hexdigest() + " " + path.name)
(DIST / "SHA256SUMS.txt").write_text("\n".join(checksums) + "\n", encoding="utf-8")
print(json.dumps({'releaseFiles':[path.name for path in files] + ['SHA256SUMS.txt'], 'version':VERSION}))
if __name__ == "__main__":
main()
+171
View File
@@ -0,0 +1,171 @@
#!/usr/bin/env python3
"""Copy installed dependency notices and source metadata into release resources.
Run with the same Python environment that freezes the installer. No local paths,
environment values, credentials, game files or game binaries are exported.
Only --download-sources enables the primary-source network fetches below.
"""
from __future__ import annotations
import argparse
import hashlib
import importlib.metadata as metadata
import json
import platform
import re
import sys
from pathlib import Path, PurePosixPath
from urllib.parse import urlparse
from urllib.request import Request, urlopen
def digest(data: bytes) -> str:
return hashlib.sha256(data).hexdigest()
def slug(name: str) -> str:
value = re.sub(r"[^a-zA-Z0-9_.-]", "-", name)
if value in {"", ".", ".."}:
raise ValueError("Invalid distribution name")
return value
def notice_name(path: PurePosixPath) -> bool:
name = path.name.lower()
return name.startswith(("license", "copying", "copyright", "notice", "authors")) and path.suffix.lower() in {"", ".txt", ".md", ".terms", ".apache", ".bsd"}
def write_notice(output: Path, relative: str, data: bytes, source: str | None = None) -> dict:
path = PurePosixPath(relative)
if path.is_absolute() or ".." in path.parts:
raise ValueError("Unsafe notice destination")
target = output.joinpath(*path.parts)
target.parent.mkdir(parents=True, exist_ok=True)
target.write_bytes(data)
result = {"path": path.as_posix(), "sha256": digest(data), "bytes": len(data)}
if source is not None:
result["source"] = source
return result
def get_https(url: str, limit: int = 32 * 1024 * 1024) -> bytes:
allowed = {"pypi.org", "files.pythonhosted.org", "raw.githubusercontent.com"}
parsed = urlparse(url)
if parsed.scheme != "https" or parsed.hostname not in allowed or parsed.username or parsed.password:
raise ValueError("Unsupported notice/source URL")
request = Request(url, headers={"User-Agent": "halo-steam-frame-installer-notices/1"})
with urlopen(request, timeout=30) as response:
final = urlparse(response.url)
if final.scheme != "https" or final.hostname not in allowed:
raise ValueError("Unsupported source redirect")
data = response.read(limit + 1)
if len(data) > limit:
raise ValueError("Source archive exceeds limit")
return data
def installed_notices(output: Path) -> list[dict]:
result = []
for distribution in sorted(metadata.distributions(), key=lambda d: d.metadata["Name"].lower()):
name = distribution.metadata["Name"]
entry = {
"name": name,
"version": distribution.version,
"license_expression": distribution.metadata.get("License-Expression"),
"declared_license": distribution.metadata.get("License"),
"project_urls": distribution.metadata.get_all("Project-URL") or [],
"notices": [],
}
for record in sorted(distribution.files or [], key=str):
path = PurePosixPath(str(record).replace("\\", "/"))
if ".." in path.parts or not notice_name(path):
continue
source = Path(distribution.locate_file(record))
if source.is_file():
entry["notices"].append(write_notice(output, f"packages/{slug(name)}/{path.as_posix()}", source.read_bytes()))
if entry["notices"]:
result.append(entry)
elif name.lower() in {"paramiko", "cryptography", "bcrypt", "pynacl", "pyinstaller", "cffi"}:
raise RuntimeError(f"Installed {name} has no original license notice")
return result
def python_notices(output: Path) -> list[dict]:
base = Path(sys.base_prefix)
license_file = base / "LICENSE.txt"
if not license_file.is_file():
license_file = base / "LICENSE"
if not license_file.is_file():
raise RuntimeError("Python runtime LICENSE is missing; supply a licensed Python distribution")
notices = [write_notice(output, "runtime/Python-LICENSE.txt", license_file.read_bytes())]
tcl_root = base / "tcl"
if tcl_root.is_dir():
for candidate in sorted(tcl_root.rglob("license.terms")):
if "demos" not in candidate.relative_to(tcl_root).parts:
notices.append(write_notice(output, "runtime/tcl-tk/" + candidate.relative_to(tcl_root).as_posix(), candidate.read_bytes()))
return notices
def download_sources(output: Path, entries: list[dict]) -> list[dict]:
paramiko = next((p for p in entries if p["name"].lower() == "paramiko"), None)
if not paramiko:
raise RuntimeError("Paramiko is not installed in the build environment")
api = f"https://pypi.org/pypi/paramiko/{paramiko['version']}/json"
info = json.loads(get_https(api, 4 * 1024 * 1024))
files = [p for p in info["urls"] if p["packagetype"] == "sdist"]
if len(files) != 1:
raise RuntimeError("Expected one official Paramiko source archive")
archive = files[0]
filename = archive["filename"]
if PurePosixPath(filename).name != filename or not filename.endswith(".tar.gz"):
raise ValueError("Unsafe Paramiko archive filename")
data = get_https(archive["url"])
if digest(data) != archive["digests"]["sha256"]:
raise RuntimeError("Paramiko source checksum mismatch")
notices = [write_notice(output, "sources/" + filename, data, archive["url"])]
notices[0]["metadata_source"] = api
# cryptography statically links its own OpenSSL; Python ssl may use another.
import ssl
from cryptography.hazmat.backends.openssl.backend import backend
versions = {ssl.OPENSSL_VERSION, backend.openssl_version_text()}
for description in sorted(versions):
match = re.match(r"OpenSSL (\d+\.\d+\.\d+)\b", description)
if not match:
raise RuntimeError("Cannot determine bundled OpenSSL version")
version = match.group(1)
url = f"https://raw.githubusercontent.com/openssl/openssl/openssl-{version}/LICENSE.txt"
notices.append(write_notice(output, f"runtime/openssl-{version}-LICENSE.txt", get_https(url, 1024 * 1024), url))
import tkinter
version = str(tkinter.Tcl().call("info", "patchlevel"))
tag = "core-" + version.replace(".", "-")
url = f"https://raw.githubusercontent.com/tcltk/tcl/{tag}/license.terms"
notices.append(write_notice(output, "runtime/tcl-LICENSE.terms", get_https(url, 1024 * 1024), url))
return notices
def main() -> None:
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument("--output", type=Path, default=Path(__file__).resolve().parent.parent / "resources" / "licenses")
parser.add_argument("--download-sources", action="store_true", help="Include checksum-verified Paramiko source and exact OpenSSL/Tcl license notices")
args = parser.parse_args()
output = args.output.resolve()
output.mkdir(parents=True, exist_ok=True)
entries = installed_notices(output)
notices = python_notices(output)
sources = download_sources(output, entries) if args.download_sources else []
manifest = {
"schema": 1,
"python_version": platform.python_version(),
"scope": "Installed build-environment notices; includes build/test packages that may not be present in the frozen installer.",
"packages": entries,
"runtime_notices": notices,
"additional_sources_and_notices": sources,
}
(output / "manifest.json").write_text(json.dumps(manifest, indent=2, ensure_ascii=False) + "\n", encoding="utf-8")
print(f"Collected notices for {len(entries)} packages; Python {manifest['python_version']}; {len(sources)} additional source/notice files.")
if __name__ == "__main__":
main()
+4
View File
@@ -0,0 +1,4 @@
from halo_frame_installer.gui import main
if __name__ == "__main__":
main()
+2
View File
@@ -0,0 +1,2 @@
"""Guided installer for the native ARM64 Halo CE Steam Frame VR port."""
__version__ = "0.1.0"
+4
View File
@@ -0,0 +1,4 @@
from .gui import main
if __name__ == "__main__":
main()
+391
View File
@@ -0,0 +1,391 @@
"""Bounded extraction of user-supplied original Xbox Halo map caches.
No game assets are bundled or downloaded. XDVDFS offsets and directory records
are described by https://github.com/XboxDev/extract-xiso. Cache header fields
and supported retail builds come from the pinned native port's cache_files.c.
"""
from __future__ import annotations
from dataclasses import dataclass
import hashlib
import json
import os
from pathlib import Path
import shutil
import stat
import struct
import tempfile
from typing import BinaryIO, Callable
SECTOR_SIZE = 2048
PARTITION_OFFSETS = (0, 0x0FD90000, 0x02080000, 0x18300000)
XBOX_MAGIC = b"MICROSOFT*XBOX*MEDIA"
SUPPORTED_BUILDS = frozenset(("01.01.14.2342", "01.10.12.2276", "01.08.15.1749"))
REQUIRED_MAPS = tuple(sorted((
"a10.map", "a30.map", "a50.map", "b30.map", "b40.map", "c10.map",
"c20.map", "c40.map", "d20.map", "d40.map", "ui.map",
"beavercreek.map", "bloodgulch.map", "boardingaction.map", "carousel.map",
"chillout.map", "damnation.map", "hangemhigh.map", "longest.map",
"prisoner.map", "putput.map", "ratrace.map", "sidewinder.map", "wizard.map",
)))
MAX_DIRECTORY_BYTES = 16 * 1024 * 1024
MAX_DIRECTORY_ENTRIES = 1024
MAX_MAP_BYTES = 0x11600000
MAX_TOTAL_BYTES = 4 * 1024 * 1024 * 1024
CHUNK_BYTES = 4 * 1024 * 1024
Progress = Callable[[str, int, int], None]
class AssetError(ValueError):
"""The selected asset source is unsupported, incomplete, or malformed."""
class ExtractionCancelled(AssetError):
"""Extraction was cancelled; its staging directory has been removed."""
@dataclass(frozen=True)
class ImageInfo:
kind: str
build: str
estimated_bytes: int
map_count: int
partition_offset: int | None = None
@dataclass(frozen=True)
class _Entry:
name: str
start: int
size: int
attributes: int
def _cancel(event) -> None:
if event is not None and event.is_set():
raise ExtractionCancelled("Installation cancelled while preparing game data.")
def _is_link(path: Path) -> bool:
# Windows junctions are reparse points even when is_symlink() is false.
data = path.lstat()
return stat.S_ISLNK(data.st_mode) or bool(
getattr(data, "st_file_attributes", 0)
& getattr(stat, "FILE_ATTRIBUTE_REPARSE_POINT", 0x400)
)
def _regular_file(path: Path) -> None:
try:
if _is_link(path) or not stat.S_ISREG(path.lstat().st_mode):
raise AssetError(f"Select a regular file, not a link or device: {path.name}")
except FileNotFoundError as exc:
raise AssetError(f"File not found: {path.name}") from exc
def _safe_name(name: str) -> None:
stem = name.split(".", 1)[0].upper()
reserved = {"CON", "PRN", "AUX", "NUL", "CLOCK$"}
reserved.update(f"{prefix}{n}" for prefix in ("COM", "LPT") for n in range(1, 10))
reserved.update(f"{prefix}{n}" for prefix in ("COM", "LPT") for n in "¹²³")
if (not name or name in (".", "..") or name.endswith((".", " "))
or any(ord(c) < 32 or ord(c) == 127 or c in '<>:"/\\|?*' for c in name)
or stem in reserved):
raise AssetError("The image contains an unsafe or non-portable filename.")
def _cache_header(header: bytes, name: str, actual_size: int) -> str:
if len(header) != SECTOR_SIZE or not SECTOR_SIZE <= actual_size <= MAX_MAP_BYTES:
raise AssetError(f"Invalid or truncated map: {name}")
if header[:4] != b"daeh" or header[-4:] != b"toof":
raise AssetError(f"{name} is not an original Xbox Halo map cache.")
version, declared_size = struct.unpack_from("<II", header, 4)
if version != 5:
label = "Halo PC data" if version == 7 else f"cache version {version}"
raise AssetError(f"{name} uses {label}. Select original Xbox Halo: Combat Evolved data.")
# Xbox caches may be compressed: the embedded length is the uncompressed
# length, and is intentionally not compared with the on-disc file size.
if not SECTOR_SIZE <= declared_size <= MAX_MAP_BYTES:
raise AssetError(f"Invalid declared cache length in {name}.")
raw_build = header[64:96].split(b"\0", 1)[0]
try:
build = raw_build.decode("ascii")
except UnicodeDecodeError as exc:
raise AssetError(f"Invalid retail build string in {name}.") from exc
if build not in SUPPORTED_BUILDS:
raise AssetError(f"Unsupported Xbox Halo build in {name}: {build!r}.")
return build
class _XboxImage:
def __init__(self, path: Path, cancel_event=None):
_regular_file(path)
self.path = path
self.image: BinaryIO = path.open("rb")
self.size = os.fstat(self.image.fileno()).st_size
self.cancel_event = cancel_event
self.directories: list[tuple[int, int]] = []
try:
for partition in PARTITION_OFFSETS:
_cancel(cancel_event)
self.image.seek(partition + 0x10000)
descriptor = self.image.read(SECTOR_SIZE)
if (len(descriptor) == SECTOR_SIZE and descriptor[:20] == XBOX_MAGIC
and descriptor[0x7EC:0x800] == XBOX_MAGIC):
self.partition = partition
root_sector, root_size = struct.unpack_from("<II", descriptor, 20)
break
else:
raise AssetError("No original Xbox XDVDFS filesystem found. Use an original Xbox "
"Halo: Combat Evolved ISO/XISO, not Halo PC or Xbox 360 Anniversary.")
root = self.entries(root_sector, root_size)
maps = next((entry for entry in root if entry.name.casefold() == "maps"), None)
if maps is None or not maps.attributes & 0x10:
raise AssetError("The image has no original Xbox Halo maps directory.")
all_maps = self.entries(maps.start, maps.size)
by_name = {entry.name.casefold(): entry for entry in all_maps}
missing = set(REQUIRED_MAPS) - by_name.keys()
if missing:
raise AssetError("Incomplete Halo disc: missing " + ", ".join(sorted(missing)))
self.maps = [by_name[name] for name in REQUIRED_MAPS]
builds = set()
ranges = []
for entry in self.maps:
_cancel(cancel_event)
if entry.attributes & 0x10:
raise AssetError(f"Expected a map file, found a directory: {entry.name}")
offset = self.partition + entry.start * SECTOR_SIZE
end = offset + entry.size
if any(offset < b and a < end for a, b in self.directories + ranges):
raise AssetError("Map contents overlap a directory or another map.")
ranges.append((offset, end))
self.image.seek(offset)
builds.add(_cache_header(self.image.read(SECTOR_SIZE), entry.name, entry.size))
self.info = _info(builds, sum(entry.size for entry in self.maps), self.partition)
except BaseException:
self.image.close()
raise
def close(self) -> None:
self.image.close()
def entries(self, sector: int, length: int) -> list[_Entry]:
if not 0 < length <= MAX_DIRECTORY_BYTES:
raise AssetError("Invalid Xbox directory length.")
offset = self.partition + sector * SECTOR_SIZE
end = offset + length
if offset < self.partition or end > self.size:
raise AssetError("An Xbox directory points outside the image.")
if any(offset < b and a < end for a, b in self.directories):
raise AssetError("Cyclic or overlapping Xbox directories.")
self.directories.append((offset, end))
self.image.seek(offset)
table = self.image.read(length)
if len(table) != length:
raise AssetError("Truncated Xbox directory.")
pending = [0]
seen: set[int] = set()
occupied: list[tuple[int, int]] = []
names: set[str] = set()
result = []
while pending:
_cancel(self.cancel_event)
node = pending.pop()
if node in seen or node < 0 or node + 14 > len(table):
raise AssetError("Invalid or cyclic Xbox directory tree.")
seen.add(node)
if len(seen) > MAX_DIRECTORY_ENTRIES:
raise AssetError("Xbox directory has too many entries.")
left, right, start, count, attributes, name_length = struct.unpack_from("<HHIIBB", table, node)
node_end = node + 14 + name_length
if node_end > len(table) or any(node < b and a < node_end for a, b in occupied):
raise AssetError("Overlapping or truncated Xbox directory records.")
occupied.append((node, node_end))
name = table[node + 14:node_end].decode("latin-1")
_safe_name(name)
folded = name.casefold()
if folded in names:
raise AssetError("Case-insensitive duplicate filenames in the Xbox image.")
names.add(folded)
if self.partition + start * SECTOR_SIZE + count > self.size:
raise AssetError(f"{name} points outside the Xbox image.")
result.append(_Entry(name, start, count, attributes))
for child in (left, right):
if child:
pending.append(child * 4)
return result
def _info(builds: set[str], total: int, partition: int | None) -> ImageInfo:
if len(builds) != 1:
raise AssetError("The maps are from different Xbox Halo releases; use one complete retail disc.")
if not 0 < total <= MAX_TOTAL_BYTES:
raise AssetError("Game data exceeds the extraction size limit.")
return ImageInfo("original-xbox", next(iter(builds)), total, len(REQUIRED_MAPS), partition)
def inspect_image(path: str | Path) -> ImageInfo:
image = _XboxImage(Path(path))
try:
return image.info
finally:
image.close()
def _maps_source(path: Path) -> tuple[Path, list[Path], ImageInfo]:
if not path.is_dir() or _is_link(path):
raise AssetError("Select a real maps directory, not a link.")
candidate = path / "maps"
if candidate.is_dir():
if _is_link(candidate):
raise AssetError("The maps directory must not be a link.")
path = candidate
names: dict[str, Path] = {}
for count, entry in enumerate(path.iterdir(), 1):
if count > MAX_DIRECTORY_ENTRIES:
raise AssetError("The maps directory has too many entries.")
_safe_name(entry.name)
if _is_link(entry):
raise AssetError(f"Links are not accepted in the maps directory: {entry.name}")
folded = entry.name.casefold()
if folded in names:
raise AssetError("Case-insensitive duplicate filenames in the maps directory.")
names[folded] = entry
missing = set(REQUIRED_MAPS) - names.keys()
if missing:
raise AssetError("Incomplete maps directory: missing " + ", ".join(sorted(missing)))
files = [names[name] for name in REQUIRED_MAPS]
builds, total = set(), 0
for file in files:
_regular_file(file)
with file.open("rb") as source:
size = os.fstat(source.fileno()).st_size
builds.add(_cache_header(source.read(SECTOR_SIZE), file.name, size))
total += size
return path, files, _info(builds, total, None)
def inspect_maps(path: str | Path) -> ImageInfo:
return _maps_source(Path(path))[2]
def _new_staging(dest: Path) -> Path:
dest = dest.absolute()
parent = dest.parent
if dest.exists() or dest.is_symlink():
raise AssetError("The extraction destination already exists; choose a new empty location.")
if not parent.is_dir():
raise AssetError("The extraction destination's parent directory does not exist.")
for component in (parent, *parent.parents):
if _is_link(component):
raise AssetError("Extraction destinations must not pass through links or junctions.")
return Path(tempfile.mkdtemp(prefix=".halo-assets-", dir=parent))
def _copy_stream(source: BinaryIO, target: Path, size: int, done: int,
total: int, progress: Progress | None, cancel_event) -> dict:
temporary = target.with_name(target.name + ".partial")
digest = hashlib.sha256()
remaining = size
header = bytearray()
with temporary.open("xb") as output:
while remaining:
_cancel(cancel_event)
chunk = source.read(min(remaining, CHUNK_BYTES))
if not chunk:
raise AssetError(f"Game data was truncated while copying {target.name}.")
if len(header) < SECTOR_SIZE:
header.extend(chunk[:SECTOR_SIZE - len(header)])
output.write(chunk)
digest.update(chunk)
remaining -= len(chunk)
if progress:
progress(f"Preparing {target.name}", done + size - remaining, total)
output.flush()
os.fsync(output.fileno())
build = _cache_header(bytes(header), target.name, size)
# Target lives only inside this operation's new private staging directory.
temporary.rename(target)
return {"path": "maps/" + target.name, "size": size,
"sha256": digest.hexdigest(), "cacheVersion": 5, "build": build}
def _commit(stage: Path, dest: Path, source_name: str, info: ImageInfo, files: list[dict]) -> dict:
manifest = {"schemaVersion": 1, "sourceImage": source_name,
"partitionOffset": info.partition_offset, "kind": info.kind,
"build": info.build, "files": files, "totalBytes": info.estimated_bytes}
manifest_file = stage / "xbox-data-manifest.json"
manifest_file.write_text(json.dumps(manifest, indent=2) + "\n", encoding="utf-8")
# mkdir reserves the destination without replacing even an empty directory
# created concurrently. Every installed file is complete before publication.
dest.mkdir(exist_ok=False)
try:
for child in stage.iterdir():
child.rename(dest / child.name)
except BaseException:
shutil.rmtree(dest)
raise
return manifest
def extract_image(path: str | Path, dest: str | Path, progress: Progress | None = None,
cancel_event=None) -> dict:
"""Extract only 24 validated retail map files into a previously absent dest.
Progress receives (message, bytes_prepared, total_bytes). Cancellation is a
threading.Event-compatible object. Any failure removes this call's staging.
"""
_cancel(cancel_event)
image = _XboxImage(Path(path), cancel_event)
stage = None
try:
dest = Path(dest).absolute()
stage = _new_staging(dest)
(stage / "maps").mkdir()
files, done = [], 0
if progress:
progress("Preparing original Xbox game data", 0, image.info.estimated_bytes)
for entry in image.maps:
_cancel(cancel_event)
image.image.seek(image.partition + entry.start * SECTOR_SIZE)
files.append(_copy_stream(image.image, stage / "maps" / entry.name.casefold(),
entry.size, done, image.info.estimated_bytes, progress, cancel_event))
done += entry.size
if {entry["build"] for entry in files} != {image.info.build}:
raise AssetError("Game data changed during preparation; please select it again.")
_cancel(cancel_event)
return _commit(stage, dest, image.path.name, image.info, files)
finally:
image.close()
if stage is not None:
shutil.rmtree(stage)
def copy_maps(source: str | Path, dest: str | Path, progress: Progress | None = None,
cancel_event=None) -> dict:
"""Prepare an already extracted retail maps folder using the same validation."""
_cancel(cancel_event)
source, source_files, info = _maps_source(Path(source))
dest = Path(dest).absolute()
stage = _new_staging(dest)
try:
(stage / "maps").mkdir()
files, done = [], 0
if progress:
progress("Preparing original Xbox game data", 0, info.estimated_bytes)
for file in source_files:
_cancel(cancel_event)
_regular_file(file)
with file.open("rb") as stream:
size = os.fstat(stream.fileno()).st_size
if size != file.stat().st_size:
raise AssetError(f"Game data changed while opening {file.name}.")
files.append(_copy_stream(stream, stage / "maps" / file.name.casefold(),
size, done, info.estimated_bytes, progress, cancel_event))
done += size
if done != info.estimated_bytes or {entry["build"] for entry in files} != {info.build}:
raise AssetError("Game data changed during preparation; please select it again.")
_cancel(cancel_event)
return _commit(stage, dest, source.name, info, files)
finally:
shutil.rmtree(stage)
+419
View File
@@ -0,0 +1,419 @@
"""Threaded Tk wizard. Passwords are used in memory, never saved or logged."""
from __future__ import annotations
import json
import os
from pathlib import Path
import queue
import shutil
import sys
import tempfile
import threading
import time
import tkinter as tk
from tkinter import filedialog, messagebox, ttk
import webbrowser
from . import __version__
from .assets import inspect_image, inspect_maps, extract_image, copy_maps
from .ssh import Settings, SSHConnection
SETUP_URL = "https://partner.steamgames.com/doc/steamhardware/steamframe/setup"
SOURCE_URL = "https://github.com/OpenCommunityEdition/OpenCE/pull/85"
CONTROLS = (
"A Jump / accept B Melee / back X Reload / use Y Change weapon\n"
"RT Fire LT Grenade LB Change grenade RB Flashlight\n"
"Left stick Move / click to crouch Right stick Turn / click to zoom\n"
"Menu Pause View Scoreboard Both grips Recenter"
)
class App(tk.Tk):
def __init__(self, state_dir: Path | None = None):
super().__init__()
self.title("Halo • Steam Frame Setup")
self.geometry(f"850x{min(960, max(650, self.winfo_screenheight()-120))}")
self.minsize(760, 620)
self.configure(bg="#101827")
self.state_dir = state_dir or Path(os.environ.get("LOCALAPPDATA", str(Path.home() / ".config"))) / "HaloFrameInstaller"
self.state_file = self.state_dir / "hosts.json"
self.fingerprints = self._load_fingerprints()
self.events: queue.Queue = queue.Queue()
self.cancel = threading.Event()
self.busy = False
self.password_to_redact = ""
self.host = tk.StringVar(value="frame")
self.port = tk.StringVar(value="22")
self.password = tk.StringVar()
self.source = tk.StringVar()
self.authorized = tk.BooleanVar()
self.steam_closed = tk.BooleanVar()
self.status = tk.StringVar(value="Choose Xbox game data, or repair the installed native game.")
self.asset_status = tk.StringVar(value="Original Xbox Halo CE .iso / .xiso, or an extracted maps folder")
self.log_lines: list[str] = []
self.buttons = []
self.entries = []
self.last_result = None
self._build()
self.protocol("WM_DELETE_WINDOW", self._close)
self.after(80, self._drain)
def _load_fingerprints(self):
try:
value = json.loads(self.state_file.read_text(encoding="utf-8"))
return value if isinstance(value, dict) else {}
except (OSError, ValueError):
return {}
def _build(self):
style = ttk.Style(self)
style.theme_use("clam")
style.configure("TFrame", background="#101827")
style.configure("Card.TFrame", background="#1b2638")
style.configure("TLabel", background="#1b2638", foreground="#ecf2fc", font=("Segoe UI", 10))
style.configure("Title.TLabel", background="#101827", font=("Segoe UI", 24, "bold"))
style.configure("Sub.TLabel", background="#101827", foreground="#a8b8ce")
style.configure("Heading.TLabel", font=("Segoe UI", 12, "bold"))
style.configure("TButton", font=("Segoe UI", 10), padding=(12, 7))
style.configure("TCheckbutton", background="#1b2638", foreground="#ecf2fc", font=("Segoe UI", 10))
style.map("TCheckbutton", background=[("active", "#1b2638")])
style.configure("Horizontal.TProgressbar", troughcolor="#1b2638", background="#64d4ad")
outer = ttk.Frame(self)
outer.pack(fill="both", expand=True)
canvas = tk.Canvas(outer, bg="#101827", highlightthickness=0)
scrollbar = ttk.Scrollbar(outer, orient="vertical", command=canvas.yview)
canvas.configure(yscrollcommand=scrollbar.set)
scrollbar.pack(side="right", fill="y")
canvas.pack(side="left", fill="both", expand=True)
body = ttk.Frame(canvas, padding=24)
window = canvas.create_window((0, 0), window=body, anchor="nw")
body.bind("<Configure>", lambda event:canvas.configure(scrollregion=canvas.bbox("all")))
canvas.bind("<Configure>", lambda event:canvas.itemconfigure(window, width=event.width))
self.bind("<MouseWheel>", lambda event:canvas.yview_scroll(-int(event.delta/120), "units"))
self.canvas = canvas
ttk.Label(body, text="Halo on Steam Frame", style="Title.TLabel").pack(anchor="w")
ttk.Label(body, text=f"Native ARM64 VR • Xbox-style controls • Setup {__version__}", style="Sub.TLabel").pack(anchor="w", pady=(5, 15))
first = self._card(body, "1 Choose your game data")
row = ttk.Frame(first, style="Card.TFrame")
row.pack(fill="x", pady=5)
ttk.Entry(row, textvariable=self.source, state="readonly").pack(side="left", fill="x", expand=True)
self._button(row, "Choose ISO", self._choose_iso).pack(side="left", padx=(8, 0))
self._button(row, "Maps folder", self._choose_maps).pack(side="left", padx=(8, 0))
ttk.Label(first, textvariable=self.asset_status, wraplength=730).pack(anchor="w", pady=4)
ttk.Checkbutton(first, text="I am authorized to use this original Xbox game data.", variable=self.authorized).pack(anchor="w", pady=2)
second = self._card(body, "2 Connect your Frame")
ttk.Label(second, text="On your Frame: Settings → System → Enable Developer Mode.\nThen Developer → Set User Password. Keep both devices on the same network.", wraplength=730).pack(anchor="w")
row = ttk.Frame(second, style="Card.TFrame")
row.pack(fill="x", pady=(10, 4))
ttk.Label(row, text="Address").pack(side="left")
self._entry(row, textvariable=self.host, width=20).pack(side="left", padx=(6, 12))
ttk.Label(row, text="Port").pack(side="left")
self._entry(row, textvariable=self.port, width=5).pack(side="left", padx=(6, 12))
ttk.Label(row, text="Password").pack(side="left")
self._entry(row, textvariable=self.password, show="•", width=20).pack(side="left", padx=6, fill="x", expand=True)
self._button(row, "Test connection", self._test_connection).pack(side="left", padx=(6, 0))
ttk.Label(second, text="Login: steamos. Your password stays in memory and is never saved.", foreground="#a8b8ce").pack(anchor="w")
ttk.Checkbutton(second, text="I have saved and closed games. Setup may briefly restart Steam to add the library entry.", variable=self.steam_closed).pack(anchor="w", pady=(8, 2))
third = self._card(body, "3 Install and play")
ttk.Label(third, text="Setup copies your maps, builds the native VR game, applies the controller layout,\nand adds it to Steam. Allow at least 12 GB free on the Frame. The first build can take a while.", wraplength=730).pack(anchor="w")
ttk.Label(third, text=CONTROLS, foreground="#a8b8ce", font=("Segoe UI", 9)).pack(anchor="w", pady=7)
row = ttk.Frame(third, style="Card.TFrame")
row.pack(fill="x")
self._button(row, "Install native Halo VR", self._install).pack(side="left")
self._button(row, "Repair installed game", lambda:self._install(repair=True)).pack(side="left", padx=(8, 0))
self.retry_button = self._button(row, "Add to Steam again", self._retry_steam)
self.retry_button.pack(side="left", padx=8)
self.retry_button.configure(state="disabled")
self.cancel_button = ttk.Button(row, text="Cancel", command=self.cancel.set, state="disabled")
self.cancel_button.pack(side="left", padx=8)
self.progress = ttk.Progressbar(third, maximum=100)
self.progress.pack(fill="x", pady=(12, 5))
ttk.Label(third, textvariable=self.status, wraplength=730).pack(anchor="w")
bottom = ttk.Frame(body)
bottom.pack(fill="x", pady=(10, 4))
ttk.Button(bottom, text="Valve SSH guide", command=lambda:webbrowser.open(SETUP_URL)).pack(side="left")
ttk.Button(bottom, text="Native VR source", command=lambda:webbrowser.open(SOURCE_URL)).pack(side="left", padx=6)
ttk.Button(bottom, text="Save setup log", command=self._save_log).pack(side="right")
self.log = tk.Text(body, height=5, bg="#0b1220", fg="#a8b8ce", relief="flat", font=("Consolas", 9), state="disabled", wrap="word")
self.log.pack(fill="both", expand=True, pady=(5, 0))
def _card(self, parent, title):
frame = ttk.Frame(parent, style="Card.TFrame", padding=14)
frame.pack(fill="x", pady=(0, 10))
ttk.Label(frame, text=title, style="Heading.TLabel").pack(anchor="w", pady=(0, 7))
return frame
def _button(self, parent, text, command):
button = ttk.Button(parent, text=text, command=command)
self.buttons.append(button)
return button
def _entry(self, parent, **kwargs):
entry = ttk.Entry(parent, **kwargs)
self.entries.append(entry)
return entry
def _choose_iso(self):
selected = filedialog.askopenfilename(title="Select your original Xbox Halo CE image", filetypes=[("Xbox disc image", "*.iso *.xiso"), ("All files", "*.*")])
if selected:
self._inspect(Path(selected))
def _choose_maps(self):
selected = filedialog.askdirectory(title="Select your original Xbox Halo CE maps folder")
if selected:
self._inspect(Path(selected))
def _inspect(self, selected):
if self.busy:
return
self._set_busy(True)
def worker():
try:
info = inspect_maps(selected) if selected.is_dir() else inspect_image(selected)
self.events.put(("asset", str(selected), f"Validated {info.map_count} original Xbox maps • {info.estimated_bytes / 1e9:.2f} GB • {info.build}"))
except Exception as exc:
self.events.put(("error", str(exc)))
finally:
self.events.put(("idle",))
threading.Thread(target=worker, daemon=True).start()
def _settings(self):
try:
port = int(self.port.get())
except ValueError:
raise ValueError("Enter a numeric SSH port.") from None
host = self.host.get().strip()
return Settings(host=host, password=self.password.get(), port=port,
known_host_fingerprint=self.fingerprints.get(f"{host}:{port}"),
accept_host_key=lambda h,a,v:self._approve_host(h,a,v,port),
close_steam_for_shortcut=self.steam_closed.get())
def _approve_host(self, host, algorithm, value, port):
ready = threading.Event()
answer = []
self.events.put(("fingerprint", host, algorithm, value, port, ready, answer))
while not ready.wait(0.1):
if self.cancel.is_set():
return False
return bool(answer and answer[0])
def _set_busy(self, value):
self.busy = value
for button in self.buttons:
button.configure(state="disabled" if value else "normal")
for entry in self.entries:
entry.configure(state="disabled" if value else "normal")
self.retry_button.configure(state="normal" if not value and self.last_result is not None else "disabled")
self.cancel_button.configure(state="normal" if value else "disabled")
if value:
self.cancel.clear()
def _test_connection(self):
try:
settings = self._settings()
except ValueError as exc:
messagebox.showerror("Connection details", str(exc), parent=self)
return
self.password_to_redact = settings.password
self._set_busy(True)
self.status.set("Connecting to your Frame…")
def worker():
connection = SSHConnection(settings)
try:
connection.connect()
arch = connection.run(["uname", "-m"], cancel_event=self.cancel).strip()
if arch not in ("aarch64", "arm64"):
raise ValueError("This device is not an ARM64 Steam Frame.")
self.events.put(("connected", settings.host, settings.port, connection.host_fingerprint))
except Exception as exc:
self.events.put(("error", str(exc)))
finally:
connection.close()
settings.password = ""
self.events.put(("idle",))
threading.Thread(target=worker, daemon=True).start()
def _install(self, repair=False):
if (not repair and not self.source.get()) or not self.authorized.get():
messagebox.showinfo("Choose game data", "Confirm that you are authorized to use the installed Xbox game data." if repair else "Choose your original Xbox Halo CE image or maps, and confirm you are authorized to use them.", parent=self)
return
if not self.steam_closed.get():
messagebox.showinfo("Close games first", "Save and close games, then confirm that setup may briefly restart Steam to add the library entry.", parent=self)
return
try:
settings = self._settings()
except ValueError as exc:
messagebox.showerror("Connection details", str(exc), parent=self)
return
self.password_to_redact = settings.password
source = Path(self.source.get()) if self.source.get() else None
if repair:
data_note = "Your selected Xbox data may replace the installed maps." if source else "Valid installed Xbox maps are kept. If maps are damaged, choose an original Xbox image and retry."
if not messagebox.askyesno("Repair existing native game", "Setup will check ~/Games/HaloCENativeVR on your Frame and reinstall its native program files and Xbox controls. Saves and unrelated settings are preserved.\n\n" + data_note + "\n\nRepair this installation?", parent=self):
return
settings.adopt_existing_native = True
self._set_busy(True)
self.status.set("Preparing installation…")
last_progress = [None, 0.0]
def report(stage, message, percent=None):
now = time.monotonic()
if stage == last_progress[0] and now - last_progress[1] < 0.2 and percent != 100:
return
last_progress[:] = [stage, now]
self.events.put(("progress", stage, str(message), percent))
def worker():
from .install import run
try:
if source is None:
result = run(settings, None, report, self.cancel)
self.events.put(("complete", result))
return
info = inspect_maps(source) if source.is_dir() else inspect_image(source)
if shutil.disk_usage(tempfile.gettempdir()).free < info.estimated_bytes + 512 * 1024**2:
raise ValueError("Not enough free temporary space on this computer to prepare the maps.")
with tempfile.TemporaryDirectory(prefix="halo-frame-") as temporary:
extracted = Path(temporary) / "data"
progress = lambda message,current,total:report("Preparing maps", message, current * 100 / total if total else None)
if source.is_dir():
copy_maps(source, extracted, progress=progress, cancel_event=self.cancel)
else:
extract_image(source, extracted, progress=progress, cancel_event=self.cancel)
result = run(settings, extracted / "maps", report, self.cancel)
self.events.put(("complete", result))
except Exception as exc:
self.events.put(("error", str(exc)))
finally:
settings.password = ""
self.events.put(("clear_password",))
self.events.put(("idle",))
threading.Thread(target=worker, daemon=True).start()
def _retry_steam(self):
if not self.steam_closed.get():
messagebox.showinfo("Close games first", "Save and close games, then confirm that setup may restart Steam.", parent=self)
return
try:
settings = self._settings()
except ValueError as exc:
messagebox.showerror("Connection details", str(exc), parent=self)
return
self.password_to_redact = settings.password
self._set_busy(True)
def worker():
from .install import Installer
try:
result = Installer().add_to_steam(settings,
lambda s,m,p=None:self.events.put(("progress",s,str(m),p)), self.cancel)
self.events.put(("complete",result))
except Exception as exc:
self.events.put(("error",str(exc)))
finally:
settings.password = ""
self.events.put(("clear_password",)); self.events.put(("idle",))
threading.Thread(target=worker, daemon=True).start()
def _append(self, text):
text = str(text)
if self.password_to_redact:
text = text.replace(self.password_to_redact, "[redacted]")
self.log_lines.append(text)
self.log.configure(state="normal")
self.log.insert("end", text + "\n")
self.log.see("end")
self.log.configure(state="disabled")
def _drain(self):
try:
while True:
event = self.events.get_nowait()
kind = event[0]
if kind == "asset":
self.source.set(event[1]); self.asset_status.set(event[2])
self.status.set("Game data validated. Connect your Frame next.")
elif kind == "fingerprint":
_, host, algorithm, value, port, ready, answer = event
accepted = messagebox.askyesno("Verify your Frame", f"First connection to {host}.\n\nSSH host key ({algorithm}):\n{value}\n\nCompare this with your Frame's host fingerprint on a trusted connection. Trust this device?", parent=self)
answer.append(accepted)
if accepted:
self._remember(host, port, value)
ready.set()
elif kind == "connected":
_, host, port, value = event
if value:
self._remember(host, port, value)
self.status.set("Connected to an ARM64 device. Ready to install.")
self._append("SSH connection verified. No password was saved.")
elif kind == "progress":
_, stage, message, percent = event
self.status.set(f"{stage}: {message}"[:500])
if percent is None:
self.progress.configure(mode="indeterminate"); self.progress.start(20)
else:
self.progress.stop(); self.progress.configure(mode="determinate", value=max(0,min(100,percent)))
self._append(f"{stage}: {message}")
elif kind == "complete":
result = event[1]
self.last_result = result
self.progress.stop(); self.progress.configure(mode="determinate", value=100)
action = "repaired" if getattr(result, "repaired", False) else "installed"
done = f"Native Halo VR is {action}. Open Steam and launch Halo: Combat Evolved VR (Native)."
if getattr(result, "backup_path", None):
self._append("Program-file backup: " + result.backup_path)
if result.requires_manual_steam_step:
done = "Native Halo VR is installed; its Steam entry needs one more step.\n" + result.steam.get("reason", "") + "\n" + result.steam.get("instructions", "Quit Steam, then click Add to Steam again.")
self._append("Executable: " + result.game_path + "/halo")
self._append("Launch options: " + result.steam.get("launchOptions", "SDL_GAMECONTROLLER_ALLOW_STEAM_VIRTUAL_GAMEPAD=0 %command%"))
self.status.set(done)
self._append(done)
messagebox.showinfo("Setup complete", done + "\n\nXbox controls and motion aiming are enabled. The native port uses its own multiplayer protocol; legacy PC servers and PC saves are incompatible.", parent=self)
elif kind == "error":
text = event[1].replace(self.password_to_redact, "[redacted]") if self.password_to_redact else event[1]
self.status.set("Setup stopped. See the message below; you can retry.")
self._append(text)
messagebox.showerror("Setup needs attention", text[-4000:], parent=self)
elif kind == "clear_password":
self.password.set(""); self.password_to_redact = ""
elif kind == "idle":
self.progress.stop(); self._set_busy(False)
except queue.Empty:
pass
self.after(80, self._drain)
def _remember(self, host, port, value):
self.fingerprints[f"{host}:{port}"] = value
try:
self.state_dir.mkdir(parents=True, exist_ok=True)
self.state_file.write_text(json.dumps(self.fingerprints, indent=2), encoding="utf-8")
except OSError:
self._append("Could not save the public host fingerprint; it will be requested next time.")
def _save_log(self):
path = filedialog.asksaveasfilename(title="Save setup log", defaultextension=".txt", initialfile="halo-frame-setup-log.txt", filetypes=[("Text", "*.txt")])
if path:
try:
Path(path).write_text("\n".join(self.log_lines) + "\n", encoding="utf-8")
except OSError as exc:
messagebox.showerror("Could not save log", str(exc), parent=self)
def _close(self):
if self.busy:
if messagebox.askyesno("Cancel setup?", "Cancel the current setup? Existing games and saves will be kept.", parent=self):
self.cancel.set()
self.status.set("Cancelling… Keep this window open until setup stops.")
return
self.password.set("")
self.destroy()
def main():
if len(sys.argv) == 3 and sys.argv[1] == "--self-test-report":
from .install import resources_path
from .selftest import smoke_test
report = smoke_test(resources_path())
Path(sys.argv[2]).write_text(json.dumps(report, indent=2), encoding="utf-8")
return
App().mainloop()
+214
View File
@@ -0,0 +1,214 @@
"""Coordinate an owned, atomic Steam Frame native VR installation."""
from __future__ import annotations
import hashlib
import json
import sys
import tempfile
import threading
import uuid
from dataclasses import dataclass
from pathlib import Path
from typing import Callable
from .ssh import CancelledError, Settings, SSHConnection, SSHError
SOURCE_COMMIT = "88142798513ebd99fc7c6224023e8b44c05d0106"
EXPECTED_MAPS = frozenset(name + ".map" for name in (
"a10", "a30", "a50", "b30", "b40", "c10", "c20", "c40", "d20", "d40",
"beavercreek", "bloodgulch", "boardingaction", "carousel", "chillout", "damnation",
"hangemhigh", "longest", "prisoner", "putput", "ratrace", "sidewinder", "ui", "wizard"))
ProgressCallback = Callable[[str, str, float | None], None]
def resources_path() -> Path:
if getattr(sys, "frozen", False):
return Path(sys._MEIPASS) / "resources"
return Path(__file__).resolve().parents[2] / "resources"
def map_manifest(maps_dir: Path) -> tuple[Path, dict]:
maps_dir = Path(maps_dir)
if (maps_dir / "maps").is_dir():
maps_dir = maps_dir / "maps"
if maps_dir.is_symlink() or not maps_dir.is_dir():
raise ValueError("Select a directory containing the extracted Xbox maps.")
actual = list(maps_dir.iterdir())
if {path.name for path in actual} != EXPECTED_MAPS:
raise ValueError("Extraction must contain the 24 original Xbox Halo map files.")
files = []
for path in sorted(actual):
if path.is_symlink() or not path.is_file():
raise ValueError("Only ordinary map files may be uploaded.")
h = hashlib.sha256()
with path.open("rb") as stream:
for chunk in iter(lambda: stream.read(1024 * 1024), b""):
h.update(chunk)
files.append({"path": "maps/" + path.name, "size": path.stat().st_size,
"sha256": h.hexdigest()})
return maps_dir, {"files": files, "totalBytes": sum(item["size"] for item in files),
"format": "original Xbox Halo maps; user-provided data"}
def parse_result(output: str) -> dict:
lines = [line[len("HFI_RESULT "):] for line in output.splitlines() if line.startswith("HFI_RESULT ")]
if len(lines) != 1:
raise SSHError("The Frame returned an unexpected installer response.")
result = json.loads(lines[0])
if not isinstance(result, dict):
raise SSHError("The Frame returned an invalid installer result.")
return result
@dataclass(frozen=True)
class InstallResult:
game_path: str
reused: bool
steam: dict
host_fingerprint: str | None
source_commit: str = SOURCE_COMMIT
repaired: bool = False
backup_path: str | None = None
@property
def steam_appid(self) -> int | None:
return self.steam.get("appid")
@property
def requires_manual_steam_step(self) -> bool:
return self.steam.get("status") != "added"
class Installer:
def __init__(self, connection_factory=SSHConnection, resource_dir: Path | None = None):
self.connection_factory = connection_factory
self.resource_dir = resource_dir or resources_path()
def run(self, settings: Settings, maps_dir: Path | None,
progress_callback: ProgressCallback | None = None,
cancel_event: threading.Event | None = None, *, registration_only=False) -> InstallResult:
"""Install or reuse the pinned native game, then safely add its Steam shortcut."""
progress = progress_callback or (lambda stage, message, percent=None: None)
cancel_event = cancel_event or threading.Event()
connection = self.connection_factory(settings)
run_identifier = uuid.uuid4().hex
remote_helper: str | None = None
prepared = False
def check_cancel():
if cancel_event.is_set():
raise CancelledError("Installation cancelled. Existing games and saves were kept.")
def remote_progress(line):
if line.startswith("HFI_PROGRESS "):
data = json.loads(line[len("HFI_PROGRESS "):])
progress(data["stage"], data["message"], None)
def cancel_remote():
if remote_helper is not None and prepared:
connection.run(["python3", remote_helper, "cancel", "--run-id", run_identifier], timeout=45)
repair = settings.reinstall_existing and not registration_only
def step(name, *, run_id=False, timeout=3600, extras=()):
argv = ["python3", remote_helper, name]
if run_id:
argv += ["--run-id", run_identifier]
if repair:
argv.append("--repair")
if repair and settings.adopt_existing_native:
argv.append("--adopt-existing")
argv += list(extras)
if name == "shortcut" and settings.close_steam_for_shortcut:
argv.append("--close-steam")
return parse_result(connection.run(argv, progress=remote_progress,
cancel_event=cancel_event, timeout=timeout,
on_cancel=cancel_remote if prepared else None))
try:
check_cancel()
progress("connect", "Connecting securely to your Steam Frame...", None)
connection.connect()
check_cancel()
progress("preflight", "Checking ARM64 SteamOS, SteamVR, Podman and free space...", None)
source = (self.resource_dir / "remote_install.py").read_text(encoding="utf-8")
preflight_args = ["python3", "-c", source, "preflight"]
if repair:
preflight_args.append("--repair")
if repair and settings.adopt_existing_native:
preflight_args.append("--adopt-existing")
info = parse_result(connection.run(preflight_args,
progress=remote_progress, cancel_event=cancel_event, timeout=90))
if info.get("home") != "/home/steamos" or info.get("cachePath") != "/home/steamos/.cache/halo-frame-installer" or info.get("gamePath") != "/home/steamos/Games/HaloCENativeVR":
raise SSHError("The Frame reported an unexpected installation location.")
if info.get("pcVersionDetected"):
progress("detect", "Found an older Halo PC installation. The native VR build requires original Xbox maps.", None)
remote_resources = info["cachePath"] + "/resources"
for name in ("remote_install.py", "build-native.sh", "steam_shortcut.py", "frame-controls.patch"):
check_cancel()
connection.put(self.resource_dir / name, remote_resources + "/" + name, cancel_event=cancel_event)
remote_helper = remote_resources + "/remote_install.py"
existing = info.get("existing")
if existing is not None and not repair:
progress("reuse", "Verified the existing native game. Keeping its files, settings and saves...", 95)
installed = existing
else:
use_existing = maps_dir is None and existing is not None and existing.get("mapsVerified", False)
if maps_dir is None and not use_existing:
raise ValueError("The existing Xbox maps are missing or damaged. Select your legally obtained original Xbox Halo disc image to reinstall them." if existing else "Select your legally obtained original Xbox Halo disc image first.")
if use_existing:
progress("repair", "Reinstalling the native program and controls while keeping your verified Xbox maps and saves...", None)
else:
progress("verify", "Checking the extracted Xbox map files...", None)
maps, manifest = map_manifest(Path(maps_dir))
prepared_info = step("prepare", run_id=True, timeout=120,
extras=("--use-existing-maps",) if use_existing else ())
prepared = True
expected_upload = info["cachePath"] + "/runs/" + run_identifier + "/upload"
if prepared_info.get("uploadPath") != expected_upload:
raise SSHError("The Frame returned an unexpected upload path.")
if not use_existing:
transferred = 0
total = manifest["totalBytes"]
progress("upload", "Sending your Xbox maps to the Frame over encrypted SSH...", 0)
for entry in manifest["files"]:
check_cancel()
path = maps / Path(entry["path"]).name
def uploaded(done, file_total):
percent = 100 * (transferred + done) / total if total else 100
progress("upload", "Uploading " + path.name, percent)
connection.put(path, expected_upload + "/" + entry["path"],
callback=uploaded, cancel_event=cancel_event)
transferred += entry["size"]
with tempfile.TemporaryDirectory(prefix="halo-frame-manifest-") as scratch:
manifest_path = Path(scratch) / "xbox-data-manifest.json"
manifest_path.write_text(json.dumps(manifest, indent=2) + "\n", encoding="utf-8")
connection.put(manifest_path, expected_upload + "/xbox-data-manifest.json", cancel_event=cancel_event)
step("build", run_id=True, timeout=7200)
check_cancel()
installed = step("finalize", run_id=True, timeout=600)
check_cancel()
progress("steam", "Adding the native VR game to your Steam account while Steam is closed...", None)
steam = step("shortcut", timeout=90)
progress("complete", "Native VR game is ready. Start Steam and launch Halo: Combat Evolved VR (Native)." if steam.get("status") == "added" else "Native VR game is installed. One Steam library step remains.", 100)
return InstallResult(installed["gamePath"], bool(installed.get("reused")),
steam, connection.host_fingerprint, repaired=bool(installed.get("repaired")),
backup_path=installed.get("backupPath"))
except CancelledError:
try:
cancel_remote()
except (SSHError, OSError):
pass
raise
finally:
connection.close()
def add_to_steam(self, settings: Settings, progress_callback: ProgressCallback | None = None,
cancel_event: threading.Event | None = None) -> InstallResult:
"""Retry library registration without extraction, upload or rebuilding."""
return self.run(settings, None, progress_callback, cancel_event, registration_only=True)
def run(settings: Settings, maps_dir: Path | None, progress_callback=None,
cancel_event: threading.Event | None = None) -> InstallResult:
return Installer().run(settings, maps_dir, progress_callback, cancel_event)
+30
View File
@@ -0,0 +1,30 @@
"""Offline packaging smoke test; never connects to a device or uses game data."""
import hashlib
from pathlib import Path
import tempfile
def smoke_test(resources: Path) -> dict:
from .gui import App
from .install import SOURCE_COMMIT
from .ssh import Settings
names = ('remote_install.py', 'steam_shortcut.py', 'build-native.sh', 'frame-controls.patch')
hashes = {}
for name in names:
path = resources / name
if not path.is_file():
raise RuntimeError('Packaged resource missing: ' + name)
hashes[name] = hashlib.sha256(path.read_bytes()).hexdigest()
if not (resources / 'licenses').is_dir():
raise RuntimeError('Packaged dependency notices missing')
if 'smoke-secret' in repr(Settings('frame', 'smoke-secret')):
raise RuntimeError('Password exposed in Settings repr')
with tempfile.TemporaryDirectory(prefix='halo-frame-smoke-') as tmp:
app = App(Path(tmp) / 'state')
app.withdraw()
app.update_idletasks()
valid = app.asset_status.get().startswith('Original Xbox') and app.log.winfo_reqheight() > 1
app.destroy()
if not valid:
raise RuntimeError('Installer window did not initialize')
return {'ok': True, 'sourceCommit': SOURCE_COMMIT, 'resources':hashes,
'guiInitialized':True, 'passwordReprRedacted':True, 'networkConnections':0}
+183
View File
@@ -0,0 +1,183 @@
"""Password-only SSH with explicit host-key verification and redacted errors."""
from __future__ import annotations
import base64
import hashlib
import ipaddress
import re
import shlex
import socket
import threading
import time
from dataclasses import dataclass, field
from pathlib import Path
from typing import Callable
import paramiko
class SSHError(RuntimeError):
pass
class CancelledError(RuntimeError):
pass
def validate_host(host: str) -> str:
"""Accept an IP address or a simple DNS name, never shell/URL syntax."""
host = host.strip()
if not host or len(host) > 253 or any(c.isspace() for c in host):
raise ValueError("Enter the Frame's IP address or hostname, without a URL.")
try:
ipaddress.ip_address(host)
return host
except ValueError:
pass
if not re.fullmatch(r"[A-Za-z0-9](?:[A-Za-z0-9.-]*[A-Za-z0-9])?", host):
raise ValueError("Enter a valid IP address or hostname.")
if any(not label or len(label) > 63 or label.startswith("-") or label.endswith("-")
for label in host.split(".")):
raise ValueError("Enter a valid hostname.")
return host
def fingerprint(key: paramiko.PKey) -> str:
digest = hashlib.sha256(key.asbytes()).digest()
return "SHA256:" + base64.b64encode(digest).decode("ascii").rstrip("=")
@dataclass
class Settings:
host: str
password: str = field(repr=False)
username: str = "steamos"
port: int = 22
known_host_fingerprint: str | None = None
accept_host_key: Callable[[str, str, str], bool] | None = field(default=None, repr=False)
close_steam_for_shortcut: bool = False
reinstall_existing: bool = True
adopt_existing_native: bool = False
def __post_init__(self) -> None:
self.host = validate_host(self.host)
if self.username != "steamos":
raise ValueError("This installer supports the Steam Frame's steamos account.")
if isinstance(self.port, bool) or not isinstance(self.port, int) or not 1 <= self.port <= 65535:
raise ValueError("SSH port must be between 1 and 65535.")
if not self.password:
raise ValueError("Enter the Frame's SSH password.")
class _VerifyHost(paramiko.MissingHostKeyPolicy):
def __init__(self, settings: Settings):
self.settings = settings
self.accepted_fingerprint: str | None = None
def missing_host_key(self, client, hostname, key):
value = fingerprint(key)
expected = self.settings.known_host_fingerprint
if expected is not None and value != expected:
raise SSHError("The Frame's SSH host key has changed. Connection refused. Verify the device before updating its saved fingerprint.")
if expected is None:
confirm = self.settings.accept_host_key
if confirm is None or not confirm(self.settings.host, key.get_name(), value):
raise SSHError("SSH host fingerprint was not approved.")
self.accepted_fingerprint = value
# Store only in this connection's memory. The GUI may persist the public fingerprint.
client.get_host_keys().add(hostname, key.get_name(), key)
class SSHConnection:
def __init__(self, settings: Settings):
self.settings = settings
self.client = paramiko.SSHClient()
self.policy = _VerifyHost(settings)
self.client.set_missing_host_key_policy(self.policy)
@property
def host_fingerprint(self) -> str | None:
return self.policy.accepted_fingerprint
def connect(self) -> None:
try:
self.client.connect(self.settings.host, port=self.settings.port,
username="steamos", password=self.settings.password,
allow_agent=False, look_for_keys=False,
timeout=15, auth_timeout=20, banner_timeout=20)
except (paramiko.AuthenticationException, paramiko.PasswordRequiredException) as exc:
raise SSHError("SSH authentication failed. Check the Frame's steamos password.") from None
except SSHError:
raise
except (paramiko.SSHException, OSError, socket.timeout) as exc:
# Avoid displaying a library error that might include submitted credentials.
raise SSHError("Could not connect to the Frame over SSH. Check its address, Wi-Fi connection, and SSH service.") from None
transport = self.client.get_transport()
if transport is not None:
transport.set_keepalive(15)
def close(self) -> None:
self.client.close()
def run(self, argv: list[str], *, progress: Callable[[str], None] | None = None,
cancel_event: threading.Event | None = None, timeout: float = 3600,
on_cancel: Callable[[], None] | None = None) -> str:
"""Run an argument vector; no secrets are put into a remote command."""
command = shlex.join([str(arg) for arg in argv])
_, stdout, _ = self.client.exec_command(command, timeout=30)
channel = stdout.channel
channel.set_combine_stderr(True)
chunks: list[bytes] = []
pending = bytearray()
started = time.monotonic()
try:
while True:
if cancel_event is not None and cancel_event.is_set():
if on_cancel is not None:
on_cancel()
raise CancelledError("Installation cancelled. Existing games and saves were kept.")
if time.monotonic() - started > timeout:
if on_cancel is not None:
on_cancel()
raise SSHError("The remote step timed out. You can reconnect and retry; existing games and saves were kept.")
while channel.recv_ready():
data = channel.recv(65536)
if not data:
break
chunks.append(data)
pending.extend(data)
while b"\n" in pending:
line, _, rest = pending.partition(b"\n")
pending[:] = rest
if progress is not None:
progress(line.decode("utf-8", "replace"))
if channel.exit_status_ready() and not channel.recv_ready():
break
time.sleep(0.08)
if pending and progress is not None:
progress(pending.decode("utf-8", "replace"))
result = b"".join(chunks).decode("utf-8", "replace")
status = channel.recv_exit_status()
if status:
# Remote helper emits bounded, user-readable diagnostics. Redact defensively.
safe = result.replace(self.settings.password, "[redacted]")
raise SSHError(safe[-12000:].strip() or f"Remote step failed (exit {status}).")
return result
finally:
channel.close()
def put(self, local: Path, remote: str, *, callback=None,
cancel_event: threading.Event | None = None) -> None:
def update(done: int, total: int):
if cancel_event is not None and cancel_event.is_set():
raise CancelledError("Installation cancelled. Existing games and saves were kept.")
if callback:
callback(done, total)
with self.client.open_sftp() as sftp:
sftp.get_channel().settimeout(20)
try:
sftp.put(str(local), remote, callback=update, confirm=True)
except (OSError, EOFError, paramiko.SSHException):
if cancel_event is not None and cancel_event.is_set():
raise CancelledError("Installation cancelled. Existing games and saves were kept.") from None
raise SSHError("The encrypted file transfer stopped. Check the Frame's connection and retry.") from None
+247
View File
@@ -0,0 +1,247 @@
"""Synthetic filesystem/cache metadata only: these fixtures contain no game data."""
import hashlib
import json
from pathlib import Path
import struct
import tempfile
import threading
import unittest
from unittest.mock import patch
from halo_frame_installer import assets
def cache_header(build="01.10.12.2276", version=5):
data = bytearray(2048)
data[:4] = b"daeh"
# Deliberately larger than the on-disc file to exercise compressed caches.
struct.pack_into("<II", data, 4, version, 4096)
data[32:36] = b"test"
encoded = build.encode("ascii")
data[64:64 + len(encoded)] = encoded
data[-4:] = b"toof"
return bytes(data)
def directory(records):
"""Produce a legal right-linked XDVDFS tree with padded 4-byte nodes."""
result = bytearray()
offsets = []
for name, start, size, attributes in records:
encoded = name.encode("latin-1")
offsets.append(len(result))
result.extend(struct.pack("<HHIIBB", 0, 0, start, size, attributes, len(encoded)))
result.extend(encoded)
result.extend(b"\0" * (-len(result) % 4))
for index, offset in enumerate(offsets[:-1]):
struct.pack_into("<H", result, offset + 2, offsets[index + 1] // 4)
return result
def make_image(path, names=None, partition=0, version=5, build="01.10.12.2276"):
names = list(assets.REQUIRED_MAPS) if names is None else names
map_table = directory([(name, 50 + index, 2048, 0x20) for index, name in enumerate(names)])
root_table = directory([("maps", 40, len(map_table), 0x10), ("default.xbe", 90, 16, 0x20)])
descriptor = bytearray(2048)
descriptor[:20] = assets.XBOX_MAGIC
descriptor[0x7EC:0x800] = assets.XBOX_MAGIC
struct.pack_into("<II", descriptor, 20, 36, len(root_table))
with path.open("wb") as image:
image.seek(partition + 100 * 2048 - 1)
image.write(b"\0")
for offset, data in ((0x10000, descriptor), (36 * 2048, root_table),
(40 * 2048, map_table)):
image.seek(partition + offset)
image.write(data)
for index in range(len(names)):
image.seek(partition + (50 + index) * 2048)
image.write(cache_header(build, version))
image.seek(partition + 90 * 2048)
image.write(b"FAKE EXECUTABLE!")
return path
def change(path, offset, data):
with path.open("r+b") as stream:
stream.seek(offset)
stream.write(data)
class AssetTests(unittest.TestCase):
def setUp(self):
self.directory = tempfile.TemporaryDirectory()
self.root = Path(self.directory.name)
self.image = make_image(self.root / "synthetic.iso")
def tearDown(self):
self.directory.cleanup()
def test_extracts_only_required_maps_and_hashes_every_file(self):
progress = []
info = assets.inspect_image(self.image)
self.assertEqual((info.kind, info.map_count, info.estimated_bytes),
("original-xbox", 24, 24 * 2048))
dest = self.root / "prepared"
manifest = assets.extract_image(self.image, dest, lambda *args: progress.append(args))
self.assertEqual(set(p.name for p in (dest / "maps").iterdir()), set(assets.REQUIRED_MAPS))
self.assertFalse((dest / "default.xbe").exists())
self.assertEqual(manifest, json.loads((dest / "xbox-data-manifest.json").read_text()))
for entry in manifest["files"]:
self.assertEqual(entry["sha256"], hashlib.sha256((dest / entry["path"]).read_bytes()).hexdigest())
self.assertEqual(entry["cacheVersion"], 5)
self.assertEqual(progress[-1][1:], (24 * 2048, 24 * 2048))
self.assertFalse(list(self.root.glob(".halo-assets-*")))
def test_nonzero_partition_offset(self):
# Use the actual 34 MiB partition offset; no copyrighted contents.
path = make_image(self.root / "partitioned.iso", partition=0x02080000)
self.assertEqual(assets.inspect_image(path).partition_offset, 0x02080000)
def test_all_upstream_supported_retail_regions(self):
for build in assets.SUPPORTED_BUILDS:
with self.subTest(build=build):
make_image(self.image, build=build)
self.assertEqual(assets.inspect_image(self.image).build, build)
def test_rejects_pc_cache_and_unknown_build(self):
make_image(self.image, version=7)
with self.assertRaisesRegex(assets.AssetError, "Halo PC"):
assets.inspect_image(self.image)
make_image(self.image, build="09.99.fake")
with self.assertRaisesRegex(assets.AssetError, "Unsupported Xbox"):
assets.inspect_image(self.image)
def test_rejects_missing_campaign_or_multiplayer_map(self):
for missing in ("a10.map", "ui.map", "bloodgulch.map"):
with self.subTest(missing=missing):
make_image(self.image, names=[name for name in assets.REQUIRED_MAPS if name != missing])
with self.assertRaisesRegex(assets.AssetError, missing):
assets.inspect_image(self.image)
def test_rejects_invalid_filesystem_descriptor(self):
change(self.image, 0x107EC, b"x")
with self.assertRaisesRegex(assets.AssetError, "original Xbox XDVDFS"):
assets.inspect_image(self.image)
def test_rejects_truncated_header_and_bad_footer(self):
change(self.image, 50 * 2048 + 2044, b"bad!")
with self.assertRaisesRegex(assets.AssetError, "not an original Xbox"):
assets.inspect_image(self.image)
make_image(self.image)
change(self.image, 40 * 2048 + 8, struct.pack("<I", 1024))
with self.assertRaisesRegex(assets.AssetError, "truncated map"):
assets.inspect_image(self.image)
def test_rejects_unsafe_image_names(self):
for bad in ("../a10.map", "a/b.map", "C:bad.map", "CON.map", "nul.txt", "end.", "end "):
with self.subTest(bad=bad):
make_image(self.image, names=[*assets.REQUIRED_MAPS, bad])
with self.assertRaisesRegex(assets.AssetError, "unsafe"):
assets.inspect_image(self.image)
def test_rejects_case_duplicates(self):
make_image(self.image, names=[*assets.REQUIRED_MAPS, "A10.MAP"])
with self.assertRaisesRegex(assets.AssetError, "duplicate"):
assets.inspect_image(self.image)
def test_rejects_node_cycle_and_out_of_bounds_child(self):
# First maps node is padded to 24 bytes. Its successor points to itself.
change(self.image, 40 * 2048 + 24 + 2, struct.pack("<H", 24 // 4))
with self.assertRaisesRegex(assets.AssetError, "cyclic"):
assets.inspect_image(self.image)
make_image(self.image)
change(self.image, 40 * 2048 + 2, struct.pack("<H", 0xFFFF))
with self.assertRaisesRegex(assets.AssetError, "directory tree"):
assets.inspect_image(self.image)
def test_rejects_overlap_between_directory_records(self):
change(self.image, 40 * 2048 + 2, struct.pack("<H", 1))
with self.assertRaises(assets.AssetError):
assets.inspect_image(self.image)
def test_rejects_recursive_directory_sector_and_oversized_table(self):
# Root maps entry points back at the root table.
change(self.image, 36 * 2048 + 4, struct.pack("<I", 36))
with self.assertRaisesRegex(assets.AssetError, "overlapping Xbox directories"):
assets.inspect_image(self.image)
make_image(self.image)
change(self.image, 0x10000 + 24, struct.pack("<I", assets.MAX_DIRECTORY_BYTES + 1))
with self.assertRaisesRegex(assets.AssetError, "directory length"):
assets.inspect_image(self.image)
def test_rejects_file_extent_outside_image_or_aliasing_another_map(self):
change(self.image, 40 * 2048 + 4, struct.pack("<I", 10000))
with self.assertRaisesRegex(assets.AssetError, "outside"):
assets.inspect_image(self.image)
make_image(self.image)
change(self.image, 40 * 2048 + 24 + 4, struct.pack("<I", 50))
with self.assertRaisesRegex(assets.AssetError, "overlap"):
assets.inspect_image(self.image)
def test_existing_destination_is_never_modified(self):
dest = self.root / "existing"
dest.mkdir()
sentinel = dest / "keep.txt"
sentinel.write_text("keep")
with self.assertRaisesRegex(assets.AssetError, "already exists"):
assets.extract_image(self.image, dest)
self.assertEqual(sentinel.read_text(), "keep")
def test_cancellation_removes_partial_extraction(self):
event = threading.Event()
def progress(message, current, total):
if current:
event.set()
dest = self.root / "cancelled"
with self.assertRaises(assets.ExtractionCancelled):
assets.extract_image(self.image, dest, progress, event)
self.assertFalse(dest.exists())
self.assertFalse(list(self.root.glob(".halo-assets-*")))
def test_write_error_removes_owned_staging_and_does_not_publish(self):
dest = self.root / "failed"
with patch.object(assets.os, "fsync", side_effect=OSError("synthetic disk full")):
with self.assertRaisesRegex(OSError, "disk full"):
assets.extract_image(self.image, dest)
self.assertFalse(dest.exists())
self.assertFalse(list(self.root.glob(".halo-assets-*")))
def test_maps_folder_copy_and_validation(self):
first = self.root / "source"
assets.extract_image(self.image, first)
info = assets.inspect_maps(first)
self.assertEqual(info.partition_offset, None)
second = self.root / "copy"
manifest = assets.copy_maps(first / "maps", second)
self.assertEqual(manifest["totalBytes"], info.estimated_bytes)
self.assertEqual(len(manifest["files"]), 24)
(first / "maps" / "a10.map").unlink()
with self.assertRaisesRegex(assets.AssetError, "a10.map"):
assets.copy_maps(first, self.root / "incomplete")
def test_map_directory_links_are_rejected(self):
first = self.root / "source"
assets.extract_image(self.image, first)
link = first / "maps" / "extra.map"
try:
link.symlink_to(first / "maps" / "ui.map")
except (OSError, NotImplementedError):
self.skipTest("Host cannot create unprivileged symlinks")
with self.assertRaisesRegex(assets.AssetError, "Links are not accepted"):
assets.copy_maps(first, self.root / "linked")
def test_extract_does_not_publish_when_destination_appears_concurrently(self):
dest = self.root / "raced"
def progress(message, current, total):
if current == total:
dest.mkdir()
(dest / "keep.txt").write_text("keep")
with self.assertRaises(FileExistsError):
assets.extract_image(self.image, dest, progress)
self.assertEqual((dest / "keep.txt").read_text(), "keep")
self.assertFalse((dest / "maps").exists())
self.assertFalse(list(self.root.glob(".halo-assets-*")))
if __name__ == "__main__":
unittest.main()
+16
View File
@@ -0,0 +1,16 @@
import sys
from pathlib import Path
import pytest
def test_control_guide_matches_expected_layout():
from halo_frame_installer.gui import CONTROLS
for action in ('Jump', 'Melee', 'Reload / use', 'Change weapon',
'LB Change grenade', 'RB Flashlight', 'Both grips Recenter'):
assert action in CONTROLS
@pytest.mark.skipif(sys.platform != 'win32', reason='Windows Tk packaging smoke test')
def test_gui_offline_smoke():
from halo_frame_installer.selftest import smoke_test
result = smoke_test(Path(__file__).resolve().parents[1] / 'resources')
assert result['ok'] and result['guiInitialized']
assert result['networkConnections'] == 0
+376
View File
@@ -0,0 +1,376 @@
import importlib.util
import json
import sys
import struct
import threading
import types
from collections import OrderedDict
from pathlib import Path
from unittest.mock import Mock
import pytest
from halo_frame_installer.install import EXPECTED_MAPS, Installer, SOURCE_COMMIT, map_manifest, parse_result
from halo_frame_installer.ssh import CancelledError, Settings, SSHError
RESOURCES = Path(__file__).resolve().parents[1] / "resources"
def load_resource(name):
spec = importlib.util.spec_from_file_location("resource_" + name, RESOURCES / (name + ".py"))
module = importlib.util.module_from_spec(spec)
sys.modules[spec.name] = module
spec.loader.exec_module(module)
return module
def test_shortcut_roundtrip_preserves_foreign_entry_and_is_idempotent():
steam = load_resource("steam_shortcut")
other = OrderedDict([("appid", steam.Value(2, 2147483650)), ("AppName", steam.Value(1, "Other game")),
("Exe", steam.Value(1, '"/somewhere/game"')), ("custom", steam.Value(7, b"12345678"))])
root = OrderedDict([("shortcuts", steam.Value(0, OrderedDict([("0", steam.Value(0, other))])))])
before = steam.dumps(root)
first, appid = steam.update_shortcut(before, "/home/steamos/Games/HaloCENativeVR/halo", "/home/steamos/Games/HaloCENativeVR")
after = steam.loads(first)["shortcuts"].value
assert after["0"].value == other
assert len(after) == 2
assert after["1"].value["OpenVR"].value == 1
assert after["1"].value["LaunchOptions"].value == "SDL_GAMECONTROLLER_ALLOW_STEAM_VIRTUAL_GAMEPAD=0 %command%"
assert steam.update_shortcut(first, "/home/steamos/Games/HaloCENativeVR/halo", "/home/steamos/Games/HaloCENativeVR") == (first, appid)
def test_shortcut_rejects_unknown_types_or_duplicate_fields():
steam = load_resource("steam_shortcut")
with pytest.raises(ValueError, match="Unsupported"):
steam.loads(b"\x09unknown\0\x08")
with pytest.raises(ValueError, match="duplicate"):
steam.loads(b"\x01a\0b\0\x01a\0c\0\x08")
def test_shortcut_wont_change_live_steam_files(tmp_path, monkeypatch):
steam = load_resource("steam_shortcut")
monkeypatch.setattr(steam, "steam_running", lambda: True)
result = steam.add_native_shortcut(tmp_path, tmp_path / "game")
assert result["status"] == "manual"
assert list(tmp_path.iterdir()) == []
def test_forced_proton_mapping_reports_manual_step_without_rewriting_config(tmp_path):
steam = load_resource("steam_shortcut")
config = tmp_path / "config/config.vdf"
config.parent.mkdir()
before = '"InstallConfigStore" { "Software" { "Valve" { "Steam" { "CompatToolMapping" { "123" { "name" "proton_9" } "456" { "name" "" } } } } } }'
config.write_text(before)
warning = steam._compatibility_warning(tmp_path, 123)
assert "proton_9" in warning and "turn off" in warning
assert steam._compatibility_warning(tmp_path, 456) is None
assert config.read_text() == before
def test_normal_shutdown_does_not_kill_or_touch_running_games(tmp_path, monkeypatch):
steam = load_resource("steam_shortcut")
monkeypatch.setattr(steam, "steam_running", lambda: True)
monkeypatch.setattr(steam, "_session_environment", lambda: ({"DISPLAY": ":0"}, True))
result = steam.add_native_shortcut(tmp_path, tmp_path / "game", close_steam=True)
assert result["status"] == "manual" and "game is still running" in result["reason"]
def test_normal_shutdown_restarts_only_client_it_closed(tmp_path, monkeypatch):
import subprocess
steam = load_resource("steam_shortcut")
states = iter([True, False, False])
monkeypatch.setattr(steam, "steam_running", lambda: next(states))
monkeypatch.setattr(steam, "_session_environment", lambda: ({"DISPLAY": ":0"}, False))
monkeypatch.setattr(steam.Path, "is_file", lambda self: True)
monkeypatch.setattr(steam, "_write_native_shortcut", lambda home, game: {"status": "added", "appid": 42})
normal_shutdown = Mock()
restart = Mock()
monkeypatch.setattr(subprocess, "run", normal_shutdown)
monkeypatch.setattr(subprocess, "Popen", restart)
assert steam.add_native_shortcut(tmp_path, tmp_path / "game", close_steam=True)["status"] == "added"
assert normal_shutdown.call_args.args[0] == ["/usr/bin/steam", "-shutdown"]
assert restart.call_args.args[0] == ["/usr/bin/steam"]
assert restart.call_args.kwargs["start_new_session"] is True
def test_original_maps_manifest_never_includes_iso_or_symlinks(tmp_path):
maps = tmp_path / "maps"
maps.mkdir()
for name in EXPECTED_MAPS:
(maps / name).write_bytes(name.encode())
root, manifest = map_manifest(tmp_path)
assert root == maps and len(manifest["files"]) == 24
assert all(file["path"].startswith("maps/") for file in manifest["files"])
(maps / "game.iso").write_bytes(b"private")
with pytest.raises(ValueError, match="24 original Xbox"):
map_manifest(tmp_path)
class FakeConnection:
def __init__(self, settings, *, existing=True):
self.settings = settings
self.existing = existing
self.commands = []
self.uploads = []
self.closed = False
self.host_fingerprint = "SHA256:public"
def connect(self):
pass
def close(self):
self.closed = True
def put(self, local, remote, **kwargs):
self.uploads.append((str(local), remote))
def run(self, argv, **kwargs):
self.commands.append(argv)
if argv[1] == "-c":
return "HFI_RESULT " + json.dumps({"home": "/home/steamos", "cachePath": "/home/steamos/.cache/halo-frame-installer",
"gamePath": "/home/steamos/Games/HaloCENativeVR", "existing": {"gamePath": "/home/steamos/Games/HaloCENativeVR", "reused": True, "mapsVerified": True} if self.existing else None})
if argv[2] == "shortcut":
return 'HFI_RESULT {"status":"added","appid":3732925724}'
if argv[2] == "prepare":
return "HFI_RESULT " + json.dumps({"uploadPath": "/home/steamos/.cache/halo-frame-installer/runs/" + argv[argv.index("--run-id") + 1] + "/upload"})
if argv[2] == "build":
raise SSHError("Native build failed. The existing game was kept.")
raise AssertionError(argv)
def test_add_to_steam_retry_reuses_files_and_no_build_or_asset_upload():
fake = FakeConnection(Settings("frame", "private", close_steam_for_shortcut=True))
result = Installer(lambda settings: fake, RESOURCES).add_to_steam(fake.settings)
assert result.reused and result.steam_appid == 3732925724
assert fake.closed
assert all(not remote.endswith(".map") for _, remote in fake.uploads)
assert not any("build" in command[2:] for command in fake.commands)
assert fake.commands[-1][-1] == "--close-steam"
def test_default_existing_install_rebuilds_without_uploading_maps():
fake = FakeConnection(Settings("frame", "private"))
with pytest.raises(SSHError, match="build failed"):
Installer(lambda settings: fake, RESOURCES).run(fake.settings, None)
assert any("--use-existing-maps" in command for command in fake.commands)
assert any(command[2] == "build" and "--repair" in command for command in fake.commands if command[1] != "-c")
assert all(not remote.endswith(".map") for _, remote in fake.uploads)
def test_failed_build_does_not_finalize_or_modify_game(tmp_path):
maps = tmp_path / "maps"
maps.mkdir()
for name in EXPECTED_MAPS:
(maps / name).write_bytes(name.encode())
fake = FakeConnection(Settings("frame", "private"), existing=False)
with pytest.raises(SSHError, match="build failed"):
Installer(lambda settings: fake, RESOURCES).run(fake.settings, maps)
assert not any(command[2] in ("finalize", "shortcut") for command in fake.commands if len(command) > 2 and command[1] != "-c")
assert fake.closed
def test_cancelled_before_connect_has_no_remote_mutation():
event = threading.Event()
event.set()
fake = FakeConnection(Settings("frame", "private"))
with pytest.raises(CancelledError):
Installer(lambda settings: fake, RESOURCES).run(fake.settings, None, cancel_event=event)
assert not fake.commands and not fake.uploads
def test_result_protocol_requires_one_result():
with pytest.raises(SSHError):
parse_result("random text")
with pytest.raises(SSHError):
parse_result('HFI_RESULT {}\nHFI_RESULT {}')
@pytest.fixture
def remote(tmp_path, monkeypatch):
if "pwd" not in sys.modules:
monkeypatch.setitem(sys.modules, "pwd", types.SimpleNamespace(getpwuid=lambda uid: None))
module = load_resource("remote_install")
home = tmp_path / "home"
home.mkdir()
module.HOME = home
module.CACHE = home / "cache"
module.GAME = home / "Games/HaloCENativeVR"
monkeypatch.setattr(module, "game_closed", lambda: None)
return module
def xbox_maps(directory, remote):
(directory / "maps").mkdir(parents=True)
header = bytearray(2048)
header[:4] = b"daeh"
header[-4:] = b"toof"
struct.pack_into("<II", header, 4, 5, 2048)
header[64:64 + 13] = b"01.10.12.2276"
files = []
for relative in sorted(remote.EXPECTED_MAPS):
target = directory / relative
target.write_bytes(header)
files.append({"path": relative, "size": len(header), "sha256": remote.digest(target)})
return {"files": files, "totalBytes": len(header) * len(files)}
def test_remote_rejects_bogus_maps_and_traversal(remote, tmp_path):
manifest = xbox_maps(tmp_path / "data", remote)
assert remote.verify_maps(tmp_path / "data", manifest) == 24 * 2048
manifest["files"][0]["path"] = "maps/../maps/a10.map"
with pytest.raises(ValueError, match="24 expected"):
remote.verify_maps(tmp_path / "data", manifest)
def test_remote_path_guard_rejects_parent_traversal(remote):
with pytest.raises(ValueError, match="traversal"):
remote.beneath(remote.HOME / "../outside", remote.HOME)
def test_existing_custom_maps_preserved_but_never_uploaded(remote, tmp_path):
directory = tmp_path / "data"
manifest = xbox_maps(directory, remote)
(directory / "maps/custom.map").write_bytes(b"unrelated user mod")
with pytest.raises(ValueError, match="extra"):
remote.verify_maps(directory, manifest)
assert remote.verify_maps(directory, manifest, allow_extra=True) == 24 * 2048
def test_remote_detects_changed_original_xbox_header(remote, tmp_path):
directory = tmp_path / "data"
manifest = xbox_maps(directory, remote)
target = directory / manifest["files"][0]["path"]
data = bytearray(target.read_bytes())
struct.pack_into("<I", data, 4, 7)
target.write_bytes(data)
with pytest.raises(ValueError, match="header"):
remote.verify_maps(directory, manifest)
def test_config_repair_preserves_save_location_and_user_preferences(remote):
old = '[paths]\nsaves = "/another/save/location"\n\n[audio]\nvolume = 0.4\n\n[vr]\naim="head"\nturn="snap"\nrefresh_rate=90.0\n\n[[plugins]]\nname="custom"\n'
result = remote.tomllib.loads(remote.merge_config(old))
assert result["paths"]["saves"] == "/another/save/location"
assert result["audio"]["volume"] == 0.4
assert result["vr"]["aim"] == "controller"
assert result["vr"]["turn"] == "snap" and result["vr"]["refresh_rate"] == 90.0
assert result["plugins"] == [{"name": "custom"}]
def test_config_repair_refuses_semantic_changes_inside_multiline_string(remote):
old = '[vr]\nnote = """\n[other]\nexample text\n"""\naim = "head"\nenabled = false\nmelee_gesture = true\n'
with pytest.raises(ValueError, match="safely|unrelated"):
remote.merge_config(old)
def test_repair_backup_and_replacements_preserve_saves_and_unrelated_files(remote):
game = remote.GAME
game.mkdir(parents=True)
(game / "halo").write_bytes(b"old executable")
(game / "libSDL3.so.0").write_bytes(b"old library")
(game / "save").mkdir()
(game / "save/checkpoint").write_bytes(b"my campaign")
(game / "notes.txt").write_bytes(b"my notes")
directory = remote.CACHE / "runs" / ("a" * 32)
stage = directory / "stage"
stage.mkdir(parents=True)
(stage / "halo").write_bytes(b"new executable")
(stage / "libSDL3.so.0").write_bytes(b"new library")
backup = remote.repair_program_files(stage, directory, ["halo", "libSDL3.so.0"], lambda: None)
assert (game / "halo").read_bytes() == b"new executable"
assert (Path(backup) / "halo").read_bytes() == b"old executable"
assert (game / "save/checkpoint").read_bytes() == b"my campaign"
assert (game / "notes.txt").read_bytes() == b"my notes"
def test_repair_rolls_back_on_failed_second_replacement(remote, monkeypatch):
game = remote.GAME
game.mkdir(parents=True)
for name in ("halo", "libSDL3.so.0"):
(game / name).write_bytes(("old " + name).encode())
directory = remote.CACHE / "runs" / ("b" * 32)
stage = directory / "stage"
stage.mkdir(parents=True)
for name in ("halo", "libSDL3.so.0"):
(stage / name).write_bytes(("new " + name).encode())
replace = remote.os.replace
def fail_second(source, target):
if Path(source) == stage / "libSDL3.so.0":
raise OSError("simulated disk error")
replace(source, target)
monkeypatch.setattr(remote.os, "replace", fail_second)
with pytest.raises(OSError, match="simulated"):
remote.repair_program_files(stage, directory, ["halo", "libSDL3.so.0"], lambda: None)
for name in ("halo", "libSDL3.so.0"):
assert (game / name).read_bytes() == ("old " + name).encode()
def test_repair_rolls_back_if_cancel_arrives_after_first_file(remote, monkeypatch):
game = remote.GAME
game.mkdir(parents=True)
(game / "halo").write_bytes(b"old halo")
(game / "config.toml").write_bytes(b"old config")
directory = remote.CACHE / "runs" / ("c" * 32)
stage = directory / "stage"
stage.mkdir(parents=True)
(stage / "halo").write_bytes(b"new halo")
(stage / "config.toml").write_bytes(b"new config")
cancelled = False
replace = remote.os.replace
def after_first(source, target):
nonlocal cancelled
replace(source, target)
if Path(source) == stage / "halo":
cancelled = True
def cancel_check():
if cancelled:
raise ValueError("cancelled")
monkeypatch.setattr(remote.os, "replace", after_first)
with pytest.raises(ValueError, match="cancelled"):
remote.repair_program_files(stage, directory, ["halo", "config.toml"], cancel_check)
assert (game / "halo").read_bytes() == b"old halo"
assert (game / "config.toml").read_bytes() == b"old config"
def test_full_repair_rebuilds_damaged_native_files_preserves_maps_saves_and_config(remote, monkeypatch):
game = remote.GAME
game.mkdir(parents=True)
maps = xbox_maps(game, remote)
(game / "xbox-data-manifest.json").write_text(json.dumps(maps))
(game / "halo").write_bytes(b"damaged executable")
(game / "libSDL3.so.0").write_bytes(b"old library")
(game / "config.toml").write_text('[paths]\nsaves="/my/saves"\n[audio]\nvolume=0.3\n[vr]\naim="head"\nturn="snap"\n')
(game / "save").mkdir()
(game / "save/checkpoint").write_bytes(b"campaign progress")
(game / "maps/custom.map").write_bytes(b"user mod")
marker = {"owner": remote.OWNER, "sourceCommit": "previous-source-revision", "files": {
"halo": "0" * 64, "libSDL3.so.0": "0" * 64}}
(game / remote.MARKER).write_text(json.dumps(marker))
remote.owned(remote.CACHE)
resources = remote.CACHE / "resources"
resources.mkdir()
(resources / "frame-controls.patch").write_bytes(b"frame controls patch")
identifier = "d" * 32
directory = remote.CACHE / "runs" / identifier
remote.owned(directory)
run_marker = remote.read_marker(directory / remote.MARKER)
run_marker["mapsOrigin"] = "existing"
(directory / remote.MARKER).write_text(json.dumps(run_marker))
(directory / "stage").mkdir()
(directory / "upload").mkdir()
(directory / "upload/xbox-data-manifest.json").write_text(json.dumps(maps))
build = directory / "src/build/linux_arm64"
build.mkdir(parents=True)
header = bytearray(64)
header[:6] = b"\x7fELF\x02\x01"
struct.pack_into("<H", header, 18, 183)
(build / "halo").write_bytes(header + b"new native game")
(build / "libSDL3.so.0").write_bytes(header + b"new native library")
monkeypatch.setattr(remote, "command", lambda argv, **kwargs: "native libraries resolved")
response = remote.finalize(identifier, repair=True)
assert response["repaired"] is True and response["mapsReinstalled"] is False
assert (game / "halo").read_bytes() == header + b"new native game"
assert (game / "save/checkpoint").read_bytes() == b"campaign progress"
assert (game / "maps/custom.map").read_bytes() == b"user mod"
merged = remote.tomllib.loads((game / "config.toml").read_text())
assert merged["paths"]["saves"] == "/my/saves"
assert merged["audio"]["volume"] == 0.3
assert merged["vr"]["aim"] == "controller" and merged["vr"]["turn"] == "snap"
assert remote.read_marker(game / remote.MARKER)["sourceCommit"] == remote.SOURCE_COMMIT
assert remote.existing_install()["mapsVerified"] is True
+79
View File
@@ -0,0 +1,79 @@
import threading
from unittest.mock import Mock
import paramiko
import pytest
from halo_frame_installer.ssh import Settings, SSHConnection, SSHError, _VerifyHost, fingerprint, validate_host
@pytest.mark.parametrize("host", ["192.168.1.12", "frame.local", "frame", "::1"])
def test_host_accepts_network_addresses(host):
assert validate_host(host) == host
@pytest.mark.parametrize("host", ["", "ssh://frame", "frame;rm -rf /", "frame\nother", "-host", "user@frame", "a..b"])
def test_host_rejects_command_or_url_input(host):
with pytest.raises(ValueError):
validate_host(host)
def test_settings_does_not_display_password():
value = Settings("frame", "my-private-password")
assert "my-private-password" not in repr(value)
with pytest.raises(ValueError):
Settings("frame", "password", username="root")
def test_new_host_requires_approval_before_trust():
key = Mock()
key.asbytes.return_value = b"public key"
key.get_name.return_value = "ssh-ed25519"
client = Mock()
policy = _VerifyHost(Settings("frame", "password", accept_host_key=lambda host, kind, fp: False))
with pytest.raises(SSHError, match="not approved"):
policy.missing_host_key(client, "frame", key)
client.get_host_keys.assert_not_called()
def test_matching_saved_host_key_works_without_another_prompt():
key = Mock()
key.asbytes.return_value = b"public key"
key.get_name.return_value = "ssh-ed25519"
prompt = Mock(side_effect=AssertionError("must not prompt"))
policy = _VerifyHost(Settings("frame", "password", known_host_fingerprint=fingerprint(key), accept_host_key=prompt))
client = Mock()
policy.missing_host_key(client, "frame", key)
assert policy.accepted_fingerprint == fingerprint(key)
prompt.assert_not_called()
def test_changed_host_key_cannot_be_approved_over_a_saved_key():
key = Mock()
key.asbytes.return_value = b"different public key"
prompt = Mock(return_value=True)
policy = _VerifyHost(Settings("frame", "password", known_host_fingerprint="SHA256:old", accept_host_key=prompt))
with pytest.raises(SSHError, match="changed"):
policy.missing_host_key(Mock(), "frame", key)
prompt.assert_not_called()
def test_connect_uses_memory_password_no_agent_or_disk_keys(monkeypatch):
client = Mock()
monkeypatch.setattr(paramiko, "SSHClient", lambda: client)
connection = SSHConnection(Settings("frame", "private"))
connection.connect()
kwargs = client.connect.call_args.kwargs
assert kwargs["password"] == "private"
assert kwargs["allow_agent"] is False and kwargs["look_for_keys"] is False
client.load_system_host_keys.assert_not_called()
client.save_host_keys.assert_not_called()
def test_authentication_error_does_not_include_secret(monkeypatch):
client = Mock()
client.connect.side_effect = paramiko.AuthenticationException("private password text")
monkeypatch.setattr(paramiko, "SSHClient", lambda: client)
with pytest.raises(SSHError) as error:
SSHConnection(Settings("frame", "private password text")).connect()
assert "private password text" not in str(error.value)