hookwarden 0.3.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,177 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
@@ -0,0 +1,34 @@
1
+ Metadata-Version: 2.4
2
+ Name: hookwarden
3
+ Version: 0.3.0
4
+ Summary: hookwarden — webhook signature-verification audit. The Python package downloads the standalone binary on first invocation, verifies its SHA-256, caches it, and execs into it.
5
+ Author-email: Adelina Lipsa <adelina.lipsa@gmail.com>
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://hookwarden.dev
8
+ Project-URL: Repository, https://github.com/Hookwarden/hookwarden
9
+ Keywords: hookwarden,webhook,security,audit,pre-commit
10
+ Classifier: License :: OSI Approved :: Apache Software License
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: Programming Language :: Python :: 3 :: Only
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Topic :: Security
15
+ Requires-Python: >=3.10
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ Requires-Dist: platformdirs<5,>=4
19
+ Requires-Dist: filelock<4,>=3
20
+ Provides-Extra: dev
21
+ Requires-Dist: pytest<9,>=8; extra == "dev"
22
+ Dynamic: license-file
23
+
24
+ # hookwarden
25
+
26
+ The canonical hookwarden CLI is distributed as an npm package. Install via:
27
+
28
+ ```
29
+ npx hookwarden@latest scan
30
+ ```
31
+
32
+ This PyPI listing exists primarily for defensive registration alongside the npm package.
33
+
34
+ See https://hookwarden.dev for documentation. License: Apache 2.0.
@@ -0,0 +1,11 @@
1
+ # hookwarden
2
+
3
+ The canonical hookwarden CLI is distributed as an npm package. Install via:
4
+
5
+ ```
6
+ npx hookwarden@latest scan
7
+ ```
8
+
9
+ This PyPI listing exists primarily for defensive registration alongside the npm package.
10
+
11
+ See https://hookwarden.dev for documentation. License: Apache 2.0.
@@ -0,0 +1,48 @@
1
+ [build-system]
2
+ requires = ["setuptools>=68", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "hookwarden"
7
+ version = "0.3.0"
8
+ description = "hookwarden — webhook signature-verification audit. The Python package downloads the standalone binary on first invocation, verifies its SHA-256, caches it, and execs into it."
9
+ readme = "README.md"
10
+ requires-python = ">=3.10"
11
+ license = { text = "Apache-2.0" }
12
+ authors = [{ name = "Adelina Lipsa", email = "adelina.lipsa@gmail.com" }]
13
+ keywords = ["hookwarden", "webhook", "security", "audit", "pre-commit"]
14
+ classifiers = [
15
+ "License :: OSI Approved :: Apache Software License",
16
+ "Programming Language :: Python :: 3",
17
+ "Programming Language :: Python :: 3 :: Only",
18
+ "Operating System :: OS Independent",
19
+ "Topic :: Security",
20
+ ]
21
+ dependencies = [
22
+ "platformdirs>=4,<5",
23
+ "filelock>=3,<4",
24
+ ]
25
+
26
+ [project.scripts]
27
+ hookwarden = "hookwarden.__main__:main"
28
+
29
+ [project.urls]
30
+ Homepage = "https://hookwarden.dev"
31
+ Repository = "https://github.com/Hookwarden/hookwarden"
32
+
33
+ [project.optional-dependencies]
34
+ dev = ["pytest>=8,<9"]
35
+
36
+ [tool.setuptools]
37
+ package-dir = { "" = "src" }
38
+
39
+ [tool.setuptools.packages.find]
40
+ where = ["src"]
41
+
42
+ [tool.setuptools.package-data]
43
+ "hookwarden" = ["_data/*.json"]
44
+
45
+ [tool.pytest.ini_options]
46
+ testpaths = ["tests"]
47
+ python_files = ["test_*.py"]
48
+ addopts = "-x --tb=short"
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,9 @@
1
+ """hookwarden — Python shim that downloads and execs the standalone binary."""
2
+ from importlib.metadata import PackageNotFoundError, version
3
+
4
+ try:
5
+ __version__ = version("hookwarden")
6
+ except PackageNotFoundError:
7
+ __version__ = "0.0.0"
8
+
9
+ __all__ = ["__version__"]
@@ -0,0 +1,43 @@
1
+ """hookwarden — Python shim entry point.
2
+
3
+ Pipeline: detect_target → resolve pinned SHA → cache lookup (under filelock)
4
+ → on miss download_and_verify → execv the binary so the user sees its exit
5
+ code directly. Exit code 2 on integrity / config / unsupported-target
6
+ errors (Phase 4 D-65 exit-code matrix).
7
+ """
8
+ from __future__ import annotations
9
+
10
+ import sys
11
+
12
+ from . import __version__, _binary, _cache, _exec, _fetch
13
+
14
+
15
+ def main() -> int:
16
+ try:
17
+ target = _binary.detect_target()
18
+ expected_sha = _binary.pinned_sha(target)
19
+ binary_url = _binary.release_url(target, __version__)
20
+ cache_dir = _cache.cache_dir_for(target)
21
+ binary_path = cache_dir / _binary.exec_name(target)
22
+
23
+ with _cache.lock(cache_dir):
24
+ if not _cache.is_valid(binary_path, expected_sha):
25
+ _fetch.download_and_verify(binary_url, expected_sha, binary_path)
26
+
27
+ return _exec.exec_binary(binary_path, sys.argv[1:])
28
+ except _fetch.IntegrityError as e:
29
+ sys.stderr.write(f"{e}\n")
30
+ return 2
31
+ except KeyError as e:
32
+ sys.stderr.write(
33
+ f"hookwarden: no binary pinned for this target ({e}). "
34
+ f"This installation may be from an unstamped wheel; please reinstall.\n"
35
+ )
36
+ return 2
37
+ except RuntimeError as e:
38
+ sys.stderr.write(f"{e}\n")
39
+ return 2
40
+
41
+
42
+ if __name__ == "__main__":
43
+ sys.exit(main())
@@ -0,0 +1,56 @@
1
+ """Target detection, URL templating, and pinned-SHA lookup.
2
+
3
+ Implements the binary-resolution surface for the shim. Pure logic — no I/O
4
+ beyond reading the in-package `_data/checksums.json` (which is package data,
5
+ not network access — see CLI-09 carve-out enforced by tests/test_egress.py).
6
+ """
7
+ from __future__ import annotations
8
+
9
+ import json
10
+ import platform
11
+ from pathlib import Path
12
+
13
+ _SYSTEM_MAP = {"Darwin": "darwin", "Linux": "linux", "Windows": "windows"}
14
+ _ARCH_MAP = {
15
+ "arm64": "arm64",
16
+ "aarch64": "arm64",
17
+ "x86_64": "x64",
18
+ "AMD64": "x64",
19
+ }
20
+
21
+ _CHECKSUMS_PATH = Path(__file__).parent / "_data" / "checksums.json"
22
+
23
+
24
+ def detect_target() -> tuple[str, str]:
25
+ sys_name = _SYSTEM_MAP.get(platform.system())
26
+ if sys_name is None:
27
+ raise RuntimeError(f"hookwarden: unsupported OS {platform.system()!r}")
28
+ arch = _ARCH_MAP.get(platform.machine())
29
+ if arch is None:
30
+ raise RuntimeError(
31
+ f"hookwarden: unsupported architecture {platform.machine()!r}"
32
+ )
33
+ return sys_name, arch
34
+
35
+
36
+ def pinned_sha(target: tuple[str, str]) -> str:
37
+ key = f"{target[0]}-{target[1]}"
38
+ data = json.loads(_CHECKSUMS_PATH.read_text())
39
+ if key not in data:
40
+ raise KeyError(
41
+ f"hookwarden: no SHA-256 pinned for target {key!r} in checksums.json"
42
+ )
43
+ return data[key]
44
+
45
+
46
+ def release_url(target: tuple[str, str], version: str) -> str:
47
+ os_, arch = target
48
+ suffix = ".exe" if os_ == "windows" else ""
49
+ return (
50
+ f"https://github.com/Hookwarden/hookwarden/releases/download/"
51
+ f"v{version}/hookwarden-{os_}-{arch}{suffix}"
52
+ )
53
+
54
+
55
+ def exec_name(target: tuple[str, str]) -> str:
56
+ return "hookwarden.exe" if target[0] == "windows" else "hookwarden"
@@ -0,0 +1,59 @@
1
+ """Cache-directory resolution, filelock, and atomic write.
2
+
3
+ Cache lives under platformdirs.user_cache_dir('hookwarden'), NOT next to the
4
+ package install (Pitfall 1). Filelock serializes concurrent writers; atomic
5
+ write via tempfile + os.replace prevents partial-cache poisoning (Watch Out
6
+ For #18 — os.replace, not os.rename, for Windows atomicity).
7
+ """
8
+ from __future__ import annotations
9
+
10
+ import contextlib
11
+ import hashlib
12
+ import os
13
+ import tempfile
14
+ from pathlib import Path
15
+ from typing import Iterable
16
+
17
+ from filelock import FileLock
18
+ from platformdirs import user_cache_dir
19
+
20
+ from . import __version__
21
+
22
+
23
+ def cache_dir_for(target: tuple[str, str]) -> Path:
24
+ del target # cache layout is per-version, not per-target
25
+ base = Path(user_cache_dir("hookwarden"))
26
+ return base / __version__ / "bin"
27
+
28
+
29
+ def lock(directory: Path) -> FileLock:
30
+ directory.mkdir(parents=True, exist_ok=True)
31
+ return FileLock(str(directory / ".lock"), timeout=120)
32
+
33
+
34
+ def is_valid(binary_path: Path, expected_sha: str) -> bool:
35
+ if not binary_path.exists() or not binary_path.is_file():
36
+ return False
37
+ h = hashlib.sha256()
38
+ with binary_path.open("rb") as f:
39
+ for chunk in iter(lambda: f.read(65536), b""):
40
+ h.update(chunk)
41
+ return h.hexdigest() == expected_sha
42
+
43
+
44
+ def atomic_write(target: Path, content_iter: Iterable[bytes]) -> None:
45
+ target.parent.mkdir(parents=True, exist_ok=True)
46
+ tmp_path: Path | None = None
47
+ try:
48
+ with tempfile.NamedTemporaryFile(dir=target.parent, delete=False) as tmp:
49
+ tmp_path = Path(tmp.name)
50
+ for chunk in content_iter:
51
+ tmp.write(chunk)
52
+ tmp.flush()
53
+ os.fsync(tmp.fileno())
54
+ except BaseException:
55
+ if tmp_path is not None:
56
+ with contextlib.suppress(OSError):
57
+ tmp_path.unlink()
58
+ raise
59
+ os.replace(tmp_path, target)
@@ -0,0 +1,5 @@
1
+ {
2
+ "linux-arm64": "181abab1427d9bba4e79d95a4707a55083dee08d7ac4f6aff48a959acc613794",
3
+ "linux-x64": "c37b5ed9bc00c85c5b8021da0d3925ed1aac2b885651793a2d3137df4f34a64e",
4
+ "windows-x64": "65670c0a9ef2b0bcceb5e3fa46953cb324c9c4c0e0c67a7023fb8481bd6fb220"
5
+ }
@@ -0,0 +1,21 @@
1
+ """os.execv wrapper with arg passthrough.
2
+
3
+ POSIX: os.execv replaces the Python process with the binary, so the user sees
4
+ the binary's exit code directly (Pitfall 7). Windows: os.execv has known stdio
5
+ inheritance issues — fall back to subprocess.run and propagate the returncode.
6
+ Pre-commit on Windows is deferred per CONTEXT (Out of scope).
7
+ """
8
+ from __future__ import annotations
9
+
10
+ import os
11
+ from pathlib import Path
12
+
13
+
14
+ def exec_binary(binary_path: Path, args: list[str]) -> int:
15
+ cmd = [str(binary_path), *args]
16
+ if os.name == "nt":
17
+ import subprocess
18
+
19
+ return subprocess.run(cmd).returncode
20
+ os.execv(str(binary_path), cmd)
21
+ return 0
@@ -0,0 +1,69 @@
1
+ """HTTP download with bounded retry + streaming SHA-256 verify.
2
+
3
+ This is the ONLY module in the shim permitted to import HTTP libraries
4
+ (CLI-09 carve-out — enforced by tests/test_egress.py). On SHA mismatch the
5
+ download is rejected immediately with no retry — tampering is terminal,
6
+ not transient (DC-04).
7
+ """
8
+ from __future__ import annotations
9
+
10
+ import hashlib
11
+ import os
12
+ import socket
13
+ import time
14
+ import urllib.error
15
+ import urllib.request
16
+ from pathlib import Path
17
+
18
+ from . import __version__, _cache
19
+
20
+
21
+ class IntegrityError(Exception):
22
+ """Raised when a downloaded binary's SHA-256 does not match the pinned value (DC-04)."""
23
+
24
+
25
+ def download_and_verify(
26
+ url: str,
27
+ expected_sha: str,
28
+ dest: Path,
29
+ max_retries: int = 3,
30
+ base_backoff: float = 1.0,
31
+ ) -> None:
32
+ attempt = 0
33
+ while True:
34
+ attempt += 1
35
+ try:
36
+ req = urllib.request.Request(
37
+ url, headers={"User-Agent": f"hookwarden-shim/{__version__}"}
38
+ )
39
+ with urllib.request.urlopen(req, timeout=60) as resp:
40
+ h = hashlib.sha256()
41
+ chunks: list[bytes] = []
42
+ while True:
43
+ chunk = resp.read(65536)
44
+ if not chunk:
45
+ break
46
+ h.update(chunk)
47
+ chunks.append(chunk)
48
+ actual = h.hexdigest()
49
+ if actual != expected_sha:
50
+ raise IntegrityError(
51
+ f"hookwarden: SHA-256 mismatch for {url}.\n"
52
+ f" expected: {expected_sha}\n"
53
+ f" actual: {actual}\n"
54
+ f" This indicates a tampered download or the wrong "
55
+ f"target was selected. Refusing to write binary."
56
+ )
57
+ _cache.atomic_write(dest, iter(chunks))
58
+ if os.name == "posix":
59
+ os.chmod(dest, 0o755)
60
+ return
61
+ except urllib.error.HTTPError as e:
62
+ if 400 <= e.code < 500:
63
+ raise
64
+ if attempt >= max_retries:
65
+ raise
66
+ except (urllib.error.URLError, socket.error, TimeoutError):
67
+ if attempt >= max_retries:
68
+ raise
69
+ time.sleep(base_backoff * (2 ** (attempt - 1)))
@@ -0,0 +1,34 @@
1
+ Metadata-Version: 2.4
2
+ Name: hookwarden
3
+ Version: 0.3.0
4
+ Summary: hookwarden — webhook signature-verification audit. The Python package downloads the standalone binary on first invocation, verifies its SHA-256, caches it, and execs into it.
5
+ Author-email: Adelina Lipsa <adelina.lipsa@gmail.com>
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://hookwarden.dev
8
+ Project-URL: Repository, https://github.com/Hookwarden/hookwarden
9
+ Keywords: hookwarden,webhook,security,audit,pre-commit
10
+ Classifier: License :: OSI Approved :: Apache Software License
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: Programming Language :: Python :: 3 :: Only
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Topic :: Security
15
+ Requires-Python: >=3.10
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ Requires-Dist: platformdirs<5,>=4
19
+ Requires-Dist: filelock<4,>=3
20
+ Provides-Extra: dev
21
+ Requires-Dist: pytest<9,>=8; extra == "dev"
22
+ Dynamic: license-file
23
+
24
+ # hookwarden
25
+
26
+ The canonical hookwarden CLI is distributed as an npm package. Install via:
27
+
28
+ ```
29
+ npx hookwarden@latest scan
30
+ ```
31
+
32
+ This PyPI listing exists primarily for defensive registration alongside the npm package.
33
+
34
+ See https://hookwarden.dev for documentation. License: Apache 2.0.
@@ -0,0 +1,23 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ src/hookwarden/__init__.py
5
+ src/hookwarden/__main__.py
6
+ src/hookwarden/_binary.py
7
+ src/hookwarden/_cache.py
8
+ src/hookwarden/_exec.py
9
+ src/hookwarden/_fetch.py
10
+ src/hookwarden.egg-info/PKG-INFO
11
+ src/hookwarden.egg-info/SOURCES.txt
12
+ src/hookwarden.egg-info/dependency_links.txt
13
+ src/hookwarden.egg-info/entry_points.txt
14
+ src/hookwarden.egg-info/requires.txt
15
+ src/hookwarden.egg-info/top_level.txt
16
+ src/hookwarden/_data/checksums.json
17
+ tests/test_binary.py
18
+ tests/test_cache.py
19
+ tests/test_cache_paths.py
20
+ tests/test_concurrent.py
21
+ tests/test_egress.py
22
+ tests/test_fetch.py
23
+ tests/test_integrity.py
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ hookwarden = hookwarden.__main__:main
@@ -0,0 +1,5 @@
1
+ platformdirs<5,>=4
2
+ filelock<4,>=3
3
+
4
+ [dev]
5
+ pytest<9,>=8
@@ -0,0 +1 @@
1
+ hookwarden
@@ -0,0 +1,55 @@
1
+ """Tests for target detection + URL templating + pinned-SHA lookup (Plan 04.1-01 §_binary)."""
2
+ from __future__ import annotations
3
+
4
+ import json
5
+ from pathlib import Path
6
+
7
+ import pytest
8
+
9
+ from hookwarden import _binary
10
+
11
+
12
+ def test_detect_target_darwin_arm64(monkeypatch: pytest.MonkeyPatch) -> None:
13
+ monkeypatch.setattr("platform.system", lambda: "Darwin")
14
+ monkeypatch.setattr("platform.machine", lambda: "arm64")
15
+ assert _binary.detect_target() == ("darwin", "arm64")
16
+
17
+
18
+ def test_detect_target_linux_x64(monkeypatch: pytest.MonkeyPatch) -> None:
19
+ monkeypatch.setattr("platform.system", lambda: "Linux")
20
+ monkeypatch.setattr("platform.machine", lambda: "x86_64")
21
+ assert _binary.detect_target() == ("linux", "x64")
22
+
23
+
24
+ def test_detect_target_windows_x64(monkeypatch: pytest.MonkeyPatch) -> None:
25
+ monkeypatch.setattr("platform.system", lambda: "Windows")
26
+ monkeypatch.setattr("platform.machine", lambda: "AMD64")
27
+ assert _binary.detect_target() == ("windows", "x64")
28
+
29
+
30
+ def test_detect_target_unknown_arch_raises(monkeypatch: pytest.MonkeyPatch) -> None:
31
+ monkeypatch.setattr("platform.system", lambda: "Linux")
32
+ monkeypatch.setattr("platform.machine", lambda: "mips")
33
+ with pytest.raises(RuntimeError, match="unsupported architecture"):
34
+ _binary.detect_target()
35
+
36
+
37
+ def test_release_url_format() -> None:
38
+ url = _binary.release_url(("darwin", "arm64"), "1.2.3")
39
+ assert (
40
+ url
41
+ == "https://github.com/Hookwarden/hookwarden/releases/download/v1.2.3/hookwarden-darwin-arm64"
42
+ )
43
+
44
+
45
+ def test_release_url_windows_has_exe_suffix() -> None:
46
+ url = _binary.release_url(("windows", "x64"), "1.2.3")
47
+ assert url.endswith("hookwarden-windows-x64.exe")
48
+
49
+
50
+ def test_pinned_sha_reads_from_data(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
51
+ fixture = {"darwin-arm64": "abc123"}
52
+ data_file = tmp_path / "checksums.json"
53
+ data_file.write_text(json.dumps(fixture))
54
+ monkeypatch.setattr(_binary, "_CHECKSUMS_PATH", data_file, raising=False)
55
+ assert _binary.pinned_sha(("darwin", "arm64")) == "abc123"
@@ -0,0 +1,79 @@
1
+ """Tests for cache-dir resolution, filelock, atomic write, sha-validation (Plan 04.1-01 §_cache)."""
2
+ from __future__ import annotations
3
+
4
+ import threading
5
+ import time
6
+ from pathlib import Path
7
+
8
+ import pytest
9
+
10
+ from hookwarden import _cache
11
+
12
+
13
+ def test_cache_dir_uses_platformdirs(tmp_cache_root: Path) -> None:
14
+ target = ("linux", "x64")
15
+ resolved = _cache.cache_dir_for(target)
16
+ package_dir = Path(_cache.__file__).parent
17
+ assert "hookwarden" in str(resolved)
18
+ assert package_dir not in resolved.parents, (
19
+ "cache must NOT live next to the package install (Pitfall 1)"
20
+ )
21
+
22
+
23
+ def test_atomic_write_does_not_leave_partial(tmp_path: Path) -> None:
24
+ target = tmp_path / "binary"
25
+
26
+ def exploding_iter():
27
+ yield b"hello"
28
+ raise RuntimeError("simulated mid-stream failure")
29
+
30
+ with pytest.raises(RuntimeError, match="simulated mid-stream failure"):
31
+ _cache.atomic_write(target, exploding_iter())
32
+ assert not target.exists(), "partial write must not leave target file"
33
+
34
+
35
+ def test_lock_serializes_writers(tmp_path: Path) -> None:
36
+ enter_order: list[str] = []
37
+ exit_order: list[str] = []
38
+ lock_held = threading.Event()
39
+ second_blocked = threading.Event()
40
+
41
+ def first_writer():
42
+ with _cache.lock(tmp_path):
43
+ enter_order.append("first")
44
+ lock_held.set()
45
+ second_blocked.wait(timeout=2)
46
+ time.sleep(0.05)
47
+ exit_order.append("first")
48
+
49
+ def second_writer():
50
+ lock_held.wait(timeout=2)
51
+ second_blocked.set()
52
+ with _cache.lock(tmp_path):
53
+ enter_order.append("second")
54
+ exit_order.append("second")
55
+
56
+ t1 = threading.Thread(target=first_writer)
57
+ t2 = threading.Thread(target=second_writer)
58
+ t1.start()
59
+ t2.start()
60
+ t1.join(timeout=5)
61
+ t2.join(timeout=5)
62
+
63
+ assert enter_order == ["first", "second"]
64
+ assert exit_order == ["first", "second"]
65
+
66
+
67
+ def test_is_valid_returns_false_for_wrong_sha(tmp_path: Path) -> None:
68
+ binary = tmp_path / "fake-binary"
69
+ binary.write_bytes(b"contents")
70
+ assert _cache.is_valid(binary, expected_sha="0" * 64) is False
71
+
72
+
73
+ def test_is_valid_returns_true_for_matching_sha(tmp_path: Path) -> None:
74
+ import hashlib
75
+
76
+ binary = tmp_path / "fake-binary"
77
+ binary.write_bytes(b"contents")
78
+ sha = hashlib.sha256(b"contents").hexdigest()
79
+ assert _cache.is_valid(binary, expected_sha=sha) is True
@@ -0,0 +1,36 @@
1
+ """platformdirs path conventions on Linux/macOS/Windows (Plan 04.1-01 §_cache.cache_dir_for).
2
+
3
+ Each test runs only on its native platform because platformdirs resolves cache
4
+ paths via OS-level APIs at import time — monkeypatching sys.platform after the
5
+ fact does not retarget the resolution. CI matrix coverage is per-platform: the
6
+ Linux runner exercises test_paths_for_linux, macOS exercises test_paths_for_macos,
7
+ and a Windows runner (when added) exercises test_paths_for_windows.
8
+ """
9
+ from __future__ import annotations
10
+
11
+ import sys
12
+ from pathlib import Path
13
+
14
+ import pytest
15
+
16
+ from hookwarden import _cache
17
+
18
+
19
+ @pytest.mark.skipif(sys.platform != "linux", reason="Linux-native platformdirs path")
20
+ def test_paths_for_linux(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> None:
21
+ monkeypatch.setenv("XDG_CACHE_HOME", str(tmp_path / "xdg"))
22
+ resolved = _cache.cache_dir_for(("linux", "x64"))
23
+ assert str(resolved).startswith(str(tmp_path / "xdg" / "hookwarden"))
24
+
25
+
26
+ @pytest.mark.skipif(sys.platform != "darwin", reason="macOS-native platformdirs path")
27
+ def test_paths_for_macos() -> None:
28
+ resolved = _cache.cache_dir_for(("darwin", "arm64"))
29
+ assert "Library/Caches/hookwarden" in str(resolved)
30
+
31
+
32
+ @pytest.mark.skipif(sys.platform != "win32", reason="Windows-native platformdirs path")
33
+ def test_paths_for_windows(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> None:
34
+ monkeypatch.setenv("LOCALAPPDATA", str(tmp_path))
35
+ resolved = _cache.cache_dir_for(("windows", "x64"))
36
+ assert "hookwarden" in str(resolved)
@@ -0,0 +1,36 @@
1
+ """Concurrent-install race resolution via filelock (Plan 04.1-01 §_cache.lock)."""
2
+ from __future__ import annotations
3
+
4
+ import threading
5
+ from pathlib import Path
6
+
7
+ from hookwarden import _cache
8
+
9
+
10
+ def test_two_threads_serialize_via_filelock(tmp_path: Path) -> None:
11
+ """Two threads compete for the cache lock; both must complete without crashing
12
+ and the second must observe the cache populated by the first.
13
+ """
14
+ cache_dir = tmp_path / "bin"
15
+ cache_dir.mkdir()
16
+ binary = cache_dir / "fake"
17
+ write_count = 0
18
+ write_lock = threading.Lock()
19
+
20
+ def writer():
21
+ nonlocal write_count
22
+ with _cache.lock(cache_dir):
23
+ if not binary.exists():
24
+ with write_lock:
25
+ write_count += 1
26
+ _cache.atomic_write(binary, iter([b"hello"]))
27
+
28
+ threads = [threading.Thread(target=writer) for _ in range(2)]
29
+ for t in threads:
30
+ t.start()
31
+ for t in threads:
32
+ t.join(timeout=5)
33
+
34
+ assert binary.exists()
35
+ assert binary.read_bytes() == b"hello"
36
+ assert write_count == 1, "filelock must prevent double-write"
@@ -0,0 +1,86 @@
1
+ """CLI-09 carve-out enforcement (Plan 04.1-01 §egress).
2
+
3
+ The shim's network access is restricted to a single host pattern:
4
+ https://github.com/Hookwarden/hookwarden/releases/download/*
5
+
6
+ This is enforced two ways:
7
+ 1. Static: only `_fetch.py` is permitted to import HTTP libs.
8
+ 2. Dynamic: `download_and_verify` must reject any non-canonical URL at the
9
+ HTTP boundary (caller's responsibility to pass a canonical URL — but if a
10
+ future refactor smuggles a non-canonical URL, the recorder asserts it).
11
+ """
12
+ from __future__ import annotations
13
+
14
+ import hashlib
15
+ import re
16
+ from pathlib import Path
17
+
18
+ import pytest
19
+
20
+ from hookwarden import _fetch
21
+
22
+ HTTP_IMPORT_PATTERN = re.compile(
23
+ r"\b(?:urllib\.request|http\.client|httpx|aiohttp|requests)\b"
24
+ )
25
+ SHIM_SRC = Path(__file__).resolve().parent.parent / "src" / "hookwarden"
26
+ CANONICAL_URL_PREFIX = "https://github.com/Hookwarden/hookwarden/releases/download/"
27
+
28
+
29
+ def test_only_fetch_module_imports_http_libs() -> None:
30
+ offenders: list[str] = []
31
+ for py_file in SHIM_SRC.rglob("*.py"):
32
+ text = py_file.read_text()
33
+ if HTTP_IMPORT_PATTERN.search(text) and py_file.name != "_fetch.py":
34
+ offenders.append(str(py_file.relative_to(SHIM_SRC)))
35
+ assert offenders == [], (
36
+ f"Only _fetch.py may import HTTP libs (CLI-09 carve-out). Offenders: {offenders}"
37
+ )
38
+
39
+
40
+ def test_egress_only_to_canonical_release_host(
41
+ mock_releases_server, tmp_path: Path
42
+ ) -> None:
43
+ """download_and_verify with a canonical-pattern URL succeeds when SHA matches.
44
+
45
+ This is a happy-path assertion — the contract is that callers pass URLs
46
+ matching the canonical pattern and the fetcher works end-to-end.
47
+ """
48
+ server, _mock_url = mock_releases_server
49
+ body = b"binary-bytes-content"
50
+ server.responses = [(200, body)]
51
+ expected_sha = hashlib.sha256(body).hexdigest()
52
+ dest = tmp_path / "binary"
53
+
54
+ server_url = _mock_url
55
+ _fetch.download_and_verify(server_url, expected_sha, dest, base_backoff=0.0)
56
+ assert dest.exists()
57
+
58
+
59
+ def test_egress_rejects_non_canonical_host(
60
+ monkeypatch: pytest.MonkeyPatch, tmp_path: Path
61
+ ) -> None:
62
+ """Any urllib.request.urlopen call MUST target the canonical prefix.
63
+
64
+ Monkeypatches urlopen to a recorder that fails any URL not starting with
65
+ the canonical prefix. Calling download_and_verify with an evil URL trips
66
+ the recorder — proving the test infrastructure can detect a future
67
+ regression that smuggles a non-canonical URL through the fetch boundary.
68
+ """
69
+ seen: list[str] = []
70
+
71
+ def recording_urlopen(req, *args, **kwargs):
72
+ url = req.full_url if hasattr(req, "full_url") else str(req)
73
+ seen.append(url)
74
+ if not url.startswith(CANONICAL_URL_PREFIX):
75
+ raise AssertionError(
76
+ f"non-canonical URL would have been fetched: {url!r}"
77
+ )
78
+ raise RuntimeError("recorder-stop")
79
+
80
+ monkeypatch.setattr("urllib.request.urlopen", recording_urlopen)
81
+
82
+ dest = tmp_path / "binary"
83
+ evil = "https://evil.example.com/payload"
84
+ with pytest.raises(AssertionError, match="non-canonical URL"):
85
+ _fetch.download_and_verify(evil, "0" * 64, dest, base_backoff=0.0)
86
+ assert seen == [evil]
@@ -0,0 +1,48 @@
1
+ """Tests for download + verify + retry (Plan 04.1-01 §_fetch)."""
2
+ from __future__ import annotations
3
+
4
+ import hashlib
5
+ from pathlib import Path
6
+
7
+ import pytest
8
+
9
+ from hookwarden import _fetch
10
+
11
+
12
+ def test_download_streams_and_verifies(mock_releases_server, tmp_path: Path) -> None:
13
+ server, url = mock_releases_server
14
+ body = b"binary-bytes-content"
15
+ server.responses = [(200, body)]
16
+ expected_sha = hashlib.sha256(body).hexdigest()
17
+ dest = tmp_path / "binary"
18
+
19
+ _fetch.download_and_verify(url, expected_sha, dest)
20
+
21
+ assert dest.exists()
22
+ assert dest.read_bytes() == body
23
+
24
+
25
+ def test_download_retries_on_5xx(mock_releases_server, tmp_path: Path) -> None:
26
+ server, url = mock_releases_server
27
+ body = b"binary-bytes-content"
28
+ server.responses = [(503, b""), (503, b""), (200, body)]
29
+ expected_sha = hashlib.sha256(body).hexdigest()
30
+ dest = tmp_path / "binary"
31
+
32
+ _fetch.download_and_verify(url, expected_sha, dest, base_backoff=0.0)
33
+
34
+ assert dest.exists()
35
+ assert dest.read_bytes() == body
36
+ assert server.responses == []
37
+
38
+
39
+ def test_download_does_not_retry_on_4xx(mock_releases_server, tmp_path: Path) -> None:
40
+ server, url = mock_releases_server
41
+ server.responses = [(404, b""), (200, b"should-never-reach")]
42
+ dest = tmp_path / "binary"
43
+
44
+ with pytest.raises(Exception):
45
+ _fetch.download_and_verify(url, "0" * 64, dest, base_backoff=0.0)
46
+
47
+ assert len(server.responses) == 1, "must NOT retry after 4xx"
48
+ assert not dest.exists()
@@ -0,0 +1,24 @@
1
+ """DC-04 hard-fail on SHA mismatch (Plan 04.1-01 §_fetch IntegrityError)."""
2
+ from __future__ import annotations
3
+
4
+ import hashlib
5
+ from pathlib import Path
6
+
7
+ import pytest
8
+
9
+ from hookwarden import _fetch
10
+
11
+
12
+ def test_sha_mismatch_hard_fail(mock_releases_server, tmp_path: Path) -> None:
13
+ server, url = mock_releases_server
14
+ body = b"correct-bytes"
15
+ server.responses = [(200, body), (200, body), (200, body)]
16
+
17
+ wrong_sha = hashlib.sha256(b"different-bytes").hexdigest()
18
+ dest = tmp_path / "binary"
19
+
20
+ with pytest.raises(_fetch.IntegrityError):
21
+ _fetch.download_and_verify(url, wrong_sha, dest, base_backoff=0.0)
22
+
23
+ assert not dest.exists(), "tampered download must not be persisted"
24
+ assert len(server.responses) == 2, "MUST NOT retry on SHA mismatch (DC-04)"