release-drift 0.1.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.
- release_drift-0.1.0/LICENSE +202 -0
- release_drift-0.1.0/MANIFEST.in +2 -0
- release_drift-0.1.0/PKG-INFO +151 -0
- release_drift-0.1.0/README.md +129 -0
- release_drift-0.1.0/pyproject.toml +36 -0
- release_drift-0.1.0/release_drift/__init__.py +4 -0
- release_drift-0.1.0/release_drift/__main__.py +6 -0
- release_drift-0.1.0/release_drift/archive.py +188 -0
- release_drift-0.1.0/release_drift/cli.py +89 -0
- release_drift-0.1.0/release_drift/compare.py +274 -0
- release_drift-0.1.0/release_drift/fetch.py +135 -0
- release_drift-0.1.0/release_drift/scan.py +169 -0
- release_drift-0.1.0/release_drift.egg-info/PKG-INFO +151 -0
- release_drift-0.1.0/release_drift.egg-info/SOURCES.txt +21 -0
- release_drift-0.1.0/release_drift.egg-info/dependency_links.txt +1 -0
- release_drift-0.1.0/release_drift.egg-info/entry_points.txt +2 -0
- release_drift-0.1.0/release_drift.egg-info/top_level.txt +1 -0
- release_drift-0.1.0/setup.cfg +4 -0
- release_drift-0.1.0/tests/fixtures.py +87 -0
- release_drift-0.1.0/tests/test_archive.py +157 -0
- release_drift-0.1.0/tests/test_compare.py +270 -0
- release_drift-0.1.0/tests/test_fetch.py +39 -0
- release_drift-0.1.0/tests/test_scan.py +107 -0
|
@@ -0,0 +1,202 @@
|
|
|
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
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: release-drift
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Report what a package release adds: changed files, new install and startup code, files not in the tagged source.
|
|
5
|
+
License-Expression: Apache-2.0
|
|
6
|
+
Project-URL: Homepage, https://github.com/jacob-adm/release-drift
|
|
7
|
+
Project-URL: Documentation, https://github.com/jacob-adm/release-drift/tree/main/docs
|
|
8
|
+
Project-URL: Source, https://github.com/jacob-adm/release-drift
|
|
9
|
+
Project-URL: Issues, https://github.com/jacob-adm/release-drift/issues
|
|
10
|
+
Keywords: supply-chain,security,pypi,npm,wheel,sdist,cli
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Operating System :: OS Independent
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
16
|
+
Classifier: Topic :: Security
|
|
17
|
+
Classifier: Topic :: Software Development :: Build Tools
|
|
18
|
+
Requires-Python: >=3.9
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
Dynamic: license-file
|
|
22
|
+
|
|
23
|
+
# release-drift
|
|
24
|
+
|
|
25
|
+
release-drift compares two releases of a package, and a release with the git tag it was built
|
|
26
|
+
from, before you install it. It reports which files changed, which new code runs at install or
|
|
27
|
+
interpreter start-up, and which files of the release are not in the project's tagged source.
|
|
28
|
+
|
|
29
|
+
Recent supply-chain attacks used these places: a `.pth` file in a PyPI wheel that Python runs at
|
|
30
|
+
every start, an npm release published from a stolen account instead of the project's CI, and
|
|
31
|
+
npm `preinstall` scripts. A new `.pth` file or install script is a record in release-drift's
|
|
32
|
+
output, and so is a file in a release that is not in the project's tag.
|
|
33
|
+
|
|
34
|
+
release-drift only reports. It does not decide whether a package is malicious, and it does not
|
|
35
|
+
block or quarantine anything; what to do with a record is up to you, for example a required
|
|
36
|
+
check in CI. There is no AI and no scoring: the same inputs always give byte-identical output.
|
|
37
|
+
|
|
38
|
+
## Requirements
|
|
39
|
+
|
|
40
|
+
- Python 3.9 or later, standard library only.
|
|
41
|
+
- git, for `release-drift source`.
|
|
42
|
+
- No platform-specific code; tested on macOS.
|
|
43
|
+
- Network access only for the optional `fetch` command.
|
|
44
|
+
|
|
45
|
+
## Install
|
|
46
|
+
|
|
47
|
+
From a clone:
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
git clone https://github.com/jacob-adm/release-drift
|
|
51
|
+
cd release-drift
|
|
52
|
+
pip install .
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
pip installs `release-drift` as a console script. Without installing, it runs from a clone as
|
|
56
|
+
`python3 -m release_drift`.
|
|
57
|
+
|
|
58
|
+
## How it works
|
|
59
|
+
|
|
60
|
+
1. **Get the artifacts.** Download the wheel, sdist or npm tarball of each version, or let
|
|
61
|
+
`release-drift fetch` download them from PyPI or npm and check them against the registry's
|
|
62
|
+
digests.
|
|
63
|
+
2. **Read them without unpacking.** Each artifact is read into memory. Absolute paths, `..`,
|
|
64
|
+
links leading outside the archive, device files and oversized members are refused; nothing
|
|
65
|
+
from the artifact is written to disk and nothing is run.
|
|
66
|
+
3. **Find the execution surfaces.** `.pth` files, `sitecustomize.py`, `setup.py` and build
|
|
67
|
+
backends, npm `preinstall`, `install`, `postinstall` and `prepare` scripts, `.pyc` files
|
|
68
|
+
without source, native binaries (ELF, Mach-O, PE, WebAssembly) and links; also URL hosts and
|
|
69
|
+
long base64 or hex strings.
|
|
70
|
+
4. **Compare.** `diff` lists the files added, removed or changed between two releases, and the
|
|
71
|
+
surfaces, hosts and strings that are new. `source` lists the files of a release that are not,
|
|
72
|
+
as they are, in git at a tag, apart from a documented list of files packaging tools generate.
|
|
73
|
+
5. **Act on the result.** release-drift exits 1 when it finds something, 0 when it finds nothing
|
|
74
|
+
and 2 on an error, like `grep`. A finding is a new or changed execution surface, a new URL host
|
|
75
|
+
or encoded string, or, for `source`, a file not in the tag. Files that merely changed between
|
|
76
|
+
two releases are listed but are not findings.
|
|
77
|
+
|
|
78
|
+
## Commands
|
|
79
|
+
|
|
80
|
+
```
|
|
81
|
+
release-drift diff OLD NEW [--json] compare two artifacts
|
|
82
|
+
release-drift source ARTIFACT --repo DIR --ref REF files not in git at REF
|
|
83
|
+
[--prefix PATH] [--json]
|
|
84
|
+
release-drift fetch {pypi,npm} NAME VERSION DIR download one version; no install
|
|
85
|
+
[--type {sdist,wheel,all}]
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Output is one TAB-separated record per line: `CATEGORY`, `STATUS`, `PATH`, `DETAIL`, sorted.
|
|
89
|
+
`--json` prints a JSON array instead. `fetch` downloads only the sdist from PyPI unless `--type`
|
|
90
|
+
says otherwise.
|
|
91
|
+
|
|
92
|
+
## Quick start
|
|
93
|
+
|
|
94
|
+
Compare two releases of `six`:
|
|
95
|
+
|
|
96
|
+
```sh
|
|
97
|
+
mkdir old new
|
|
98
|
+
release-drift fetch pypi six 1.16.0 old
|
|
99
|
+
release-drift fetch pypi six 1.17.0 new
|
|
100
|
+
release-drift diff old/six-1.16.0.tar.gz new/six-1.17.0.tar.gz
|
|
101
|
+
echo $?
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
```text
|
|
105
|
+
build changed setup.py setup.py
|
|
106
|
+
file changed CHANGES -
|
|
107
|
+
file changed LICENSE -
|
|
108
|
+
file changed PKG-INFO -
|
|
109
|
+
file changed README.rst -
|
|
110
|
+
file changed documentation/conf.py -
|
|
111
|
+
file changed documentation/index.rst -
|
|
112
|
+
file changed setup.cfg -
|
|
113
|
+
file changed setup.py -
|
|
114
|
+
file changed six.egg-info/PKG-INFO -
|
|
115
|
+
file changed six.py -
|
|
116
|
+
file changed test_six.py -
|
|
117
|
+
1
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
`fetch` downloads the sdist and prints the path it saves. In the diff, no file was added and no new
|
|
121
|
+
start-up hook, install script, binary or URL host appeared. The exit status is 1 because
|
|
122
|
+
`setup.py`, which runs when the sdist is built, changed: `build changed setup.py` is a finding.
|
|
123
|
+
The `file changed` records are listed but are not findings; the two wheels of the same versions,
|
|
124
|
+
in which no build script runs, give exit 0. Then check the release against its tag:
|
|
125
|
+
|
|
126
|
+
```sh
|
|
127
|
+
git clone https://github.com/benjaminp/six
|
|
128
|
+
release-drift source new/six-1.17.0.tar.gz --repo six --ref 1.17.0
|
|
129
|
+
echo $?
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
```text
|
|
133
|
+
0
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
Every file of the sdist is in the tag `1.17.0`, apart from the files setuptools generates.
|
|
137
|
+
|
|
138
|
+
## Documentation
|
|
139
|
+
|
|
140
|
+
- [Commands](https://github.com/jacob-adm/release-drift/blob/main/docs/commands.md): each command's input, records, options and exit status.
|
|
141
|
+
- [Source comparison](https://github.com/jacob-adm/release-drift/blob/main/docs/source-comparison.md): which generated files `source` accepts, and why.
|
|
142
|
+
- [Limitations and security](https://github.com/jacob-adm/release-drift/blob/main/docs/limitations-and-security.md): what release-drift reads, refuses
|
|
143
|
+
and does not detect.
|
|
144
|
+
- [Using it with other tools](https://github.com/jacob-adm/release-drift/blob/main/docs/other-tools.md): tested stacks for releases
|
|
145
|
+
and dependency bumps, and GuardDog and Socket, and what release-drift adds.
|
|
146
|
+
- [Contributing](https://github.com/jacob-adm/release-drift/blob/main/CONTRIBUTING.md): running the tests and contributing a change.
|
|
147
|
+
- [Reporting a vulnerability](https://github.com/jacob-adm/release-drift/blob/main/SECURITY.md)
|
|
148
|
+
|
|
149
|
+
## License
|
|
150
|
+
|
|
151
|
+
Apache License 2.0; see [LICENSE](https://github.com/jacob-adm/release-drift/blob/main/LICENSE).
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# release-drift
|
|
2
|
+
|
|
3
|
+
release-drift compares two releases of a package, and a release with the git tag it was built
|
|
4
|
+
from, before you install it. It reports which files changed, which new code runs at install or
|
|
5
|
+
interpreter start-up, and which files of the release are not in the project's tagged source.
|
|
6
|
+
|
|
7
|
+
Recent supply-chain attacks used these places: a `.pth` file in a PyPI wheel that Python runs at
|
|
8
|
+
every start, an npm release published from a stolen account instead of the project's CI, and
|
|
9
|
+
npm `preinstall` scripts. A new `.pth` file or install script is a record in release-drift's
|
|
10
|
+
output, and so is a file in a release that is not in the project's tag.
|
|
11
|
+
|
|
12
|
+
release-drift only reports. It does not decide whether a package is malicious, and it does not
|
|
13
|
+
block or quarantine anything; what to do with a record is up to you, for example a required
|
|
14
|
+
check in CI. There is no AI and no scoring: the same inputs always give byte-identical output.
|
|
15
|
+
|
|
16
|
+
## Requirements
|
|
17
|
+
|
|
18
|
+
- Python 3.9 or later, standard library only.
|
|
19
|
+
- git, for `release-drift source`.
|
|
20
|
+
- No platform-specific code; tested on macOS.
|
|
21
|
+
- Network access only for the optional `fetch` command.
|
|
22
|
+
|
|
23
|
+
## Install
|
|
24
|
+
|
|
25
|
+
From a clone:
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
git clone https://github.com/jacob-adm/release-drift
|
|
29
|
+
cd release-drift
|
|
30
|
+
pip install .
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
pip installs `release-drift` as a console script. Without installing, it runs from a clone as
|
|
34
|
+
`python3 -m release_drift`.
|
|
35
|
+
|
|
36
|
+
## How it works
|
|
37
|
+
|
|
38
|
+
1. **Get the artifacts.** Download the wheel, sdist or npm tarball of each version, or let
|
|
39
|
+
`release-drift fetch` download them from PyPI or npm and check them against the registry's
|
|
40
|
+
digests.
|
|
41
|
+
2. **Read them without unpacking.** Each artifact is read into memory. Absolute paths, `..`,
|
|
42
|
+
links leading outside the archive, device files and oversized members are refused; nothing
|
|
43
|
+
from the artifact is written to disk and nothing is run.
|
|
44
|
+
3. **Find the execution surfaces.** `.pth` files, `sitecustomize.py`, `setup.py` and build
|
|
45
|
+
backends, npm `preinstall`, `install`, `postinstall` and `prepare` scripts, `.pyc` files
|
|
46
|
+
without source, native binaries (ELF, Mach-O, PE, WebAssembly) and links; also URL hosts and
|
|
47
|
+
long base64 or hex strings.
|
|
48
|
+
4. **Compare.** `diff` lists the files added, removed or changed between two releases, and the
|
|
49
|
+
surfaces, hosts and strings that are new. `source` lists the files of a release that are not,
|
|
50
|
+
as they are, in git at a tag, apart from a documented list of files packaging tools generate.
|
|
51
|
+
5. **Act on the result.** release-drift exits 1 when it finds something, 0 when it finds nothing
|
|
52
|
+
and 2 on an error, like `grep`. A finding is a new or changed execution surface, a new URL host
|
|
53
|
+
or encoded string, or, for `source`, a file not in the tag. Files that merely changed between
|
|
54
|
+
two releases are listed but are not findings.
|
|
55
|
+
|
|
56
|
+
## Commands
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
release-drift diff OLD NEW [--json] compare two artifacts
|
|
60
|
+
release-drift source ARTIFACT --repo DIR --ref REF files not in git at REF
|
|
61
|
+
[--prefix PATH] [--json]
|
|
62
|
+
release-drift fetch {pypi,npm} NAME VERSION DIR download one version; no install
|
|
63
|
+
[--type {sdist,wheel,all}]
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Output is one TAB-separated record per line: `CATEGORY`, `STATUS`, `PATH`, `DETAIL`, sorted.
|
|
67
|
+
`--json` prints a JSON array instead. `fetch` downloads only the sdist from PyPI unless `--type`
|
|
68
|
+
says otherwise.
|
|
69
|
+
|
|
70
|
+
## Quick start
|
|
71
|
+
|
|
72
|
+
Compare two releases of `six`:
|
|
73
|
+
|
|
74
|
+
```sh
|
|
75
|
+
mkdir old new
|
|
76
|
+
release-drift fetch pypi six 1.16.0 old
|
|
77
|
+
release-drift fetch pypi six 1.17.0 new
|
|
78
|
+
release-drift diff old/six-1.16.0.tar.gz new/six-1.17.0.tar.gz
|
|
79
|
+
echo $?
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
```text
|
|
83
|
+
build changed setup.py setup.py
|
|
84
|
+
file changed CHANGES -
|
|
85
|
+
file changed LICENSE -
|
|
86
|
+
file changed PKG-INFO -
|
|
87
|
+
file changed README.rst -
|
|
88
|
+
file changed documentation/conf.py -
|
|
89
|
+
file changed documentation/index.rst -
|
|
90
|
+
file changed setup.cfg -
|
|
91
|
+
file changed setup.py -
|
|
92
|
+
file changed six.egg-info/PKG-INFO -
|
|
93
|
+
file changed six.py -
|
|
94
|
+
file changed test_six.py -
|
|
95
|
+
1
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
`fetch` downloads the sdist and prints the path it saves. In the diff, no file was added and no new
|
|
99
|
+
start-up hook, install script, binary or URL host appeared. The exit status is 1 because
|
|
100
|
+
`setup.py`, which runs when the sdist is built, changed: `build changed setup.py` is a finding.
|
|
101
|
+
The `file changed` records are listed but are not findings; the two wheels of the same versions,
|
|
102
|
+
in which no build script runs, give exit 0. Then check the release against its tag:
|
|
103
|
+
|
|
104
|
+
```sh
|
|
105
|
+
git clone https://github.com/benjaminp/six
|
|
106
|
+
release-drift source new/six-1.17.0.tar.gz --repo six --ref 1.17.0
|
|
107
|
+
echo $?
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
```text
|
|
111
|
+
0
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Every file of the sdist is in the tag `1.17.0`, apart from the files setuptools generates.
|
|
115
|
+
|
|
116
|
+
## Documentation
|
|
117
|
+
|
|
118
|
+
- [Commands](https://github.com/jacob-adm/release-drift/blob/main/docs/commands.md): each command's input, records, options and exit status.
|
|
119
|
+
- [Source comparison](https://github.com/jacob-adm/release-drift/blob/main/docs/source-comparison.md): which generated files `source` accepts, and why.
|
|
120
|
+
- [Limitations and security](https://github.com/jacob-adm/release-drift/blob/main/docs/limitations-and-security.md): what release-drift reads, refuses
|
|
121
|
+
and does not detect.
|
|
122
|
+
- [Using it with other tools](https://github.com/jacob-adm/release-drift/blob/main/docs/other-tools.md): tested stacks for releases
|
|
123
|
+
and dependency bumps, and GuardDog and Socket, and what release-drift adds.
|
|
124
|
+
- [Contributing](https://github.com/jacob-adm/release-drift/blob/main/CONTRIBUTING.md): running the tests and contributing a change.
|
|
125
|
+
- [Reporting a vulnerability](https://github.com/jacob-adm/release-drift/blob/main/SECURITY.md)
|
|
126
|
+
|
|
127
|
+
## License
|
|
128
|
+
|
|
129
|
+
Apache License 2.0; see [LICENSE](https://github.com/jacob-adm/release-drift/blob/main/LICENSE).
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
2
|
+
[build-system]
|
|
3
|
+
requires = ["setuptools>=77"]
|
|
4
|
+
build-backend = "setuptools.build_meta"
|
|
5
|
+
|
|
6
|
+
[project]
|
|
7
|
+
name = "release-drift"
|
|
8
|
+
version = "0.1.0"
|
|
9
|
+
description = "Report what a package release adds: changed files, new install and startup code, files not in the tagged source."
|
|
10
|
+
readme = "README.md"
|
|
11
|
+
requires-python = ">=3.9"
|
|
12
|
+
license = "Apache-2.0"
|
|
13
|
+
license-files = ["LICENSE"]
|
|
14
|
+
dependencies = []
|
|
15
|
+
keywords = ["supply-chain", "security", "pypi", "npm", "wheel", "sdist", "cli"]
|
|
16
|
+
classifiers = [
|
|
17
|
+
"Environment :: Console",
|
|
18
|
+
"Intended Audience :: Developers",
|
|
19
|
+
"Operating System :: OS Independent",
|
|
20
|
+
"Programming Language :: Python :: 3",
|
|
21
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
22
|
+
"Topic :: Security",
|
|
23
|
+
"Topic :: Software Development :: Build Tools",
|
|
24
|
+
]
|
|
25
|
+
|
|
26
|
+
[project.urls]
|
|
27
|
+
Homepage = "https://github.com/jacob-adm/release-drift"
|
|
28
|
+
Documentation = "https://github.com/jacob-adm/release-drift/tree/main/docs"
|
|
29
|
+
Source = "https://github.com/jacob-adm/release-drift"
|
|
30
|
+
Issues = "https://github.com/jacob-adm/release-drift/issues"
|
|
31
|
+
|
|
32
|
+
[project.scripts]
|
|
33
|
+
release-drift = "release_drift.cli:main"
|
|
34
|
+
|
|
35
|
+
[tool.setuptools]
|
|
36
|
+
packages = ["release_drift"]
|