|
5 | 5 | import subprocess |
6 | 6 | import sys |
7 | 7 | import traceback |
| 8 | +from email.message import Message |
8 | 9 | from unittest.mock import Mock |
9 | 10 | from urllib.error import HTTPError |
10 | 11 | from urllib.parse import urlsplit |
@@ -70,6 +71,138 @@ def test_only_allowlisted_metadata_is_retained(monkeypatch): |
70 | 71 | assert "Authorization" not in text and "Set-Cookie" not in text |
71 | 72 |
|
72 | 73 |
|
| 74 | +def accepted_permissions(text): |
| 75 | + return json.loads(text.split(" accepted_permissions=", 1)[1]) |
| 76 | + |
| 77 | + |
| 78 | +@pytest.mark.parametrize("method,path", [ |
| 79 | + ("POST", "/issues/7/comments"), ("PATCH", "/issues/comments/9"), |
| 80 | +]) |
| 81 | +@pytest.mark.parametrize("value,sets", [ |
| 82 | + ("issues=write", [{"issues": "write"}]), |
| 83 | + ("pull_requests=write", [{"pull_requests": "write"}]), |
| 84 | + ("issues=write; pull_requests=write", [{"issues": "write"}, {"pull_requests": "write"}]), |
| 85 | + ("\tissues \t= write, contents=read ; metadata=read\t", |
| 86 | + [{"issues": "write", "contents": "read"}, {"metadata": "read"}]), |
| 87 | + ("issues=read;issues=write;pull_requests=read;pull_requests=write", |
| 88 | + [{"issues": "read"}, {"issues": "write"}, |
| 89 | + {"pull_requests": "read"}, {"pull_requests": "write"}]), |
| 90 | + ("issues=write,pull_requests=read,contents=write,metadata=read", |
| 91 | + [{"issues": "write", "pull_requests": "read", "contents": "write", "metadata": "read"}]), |
| 92 | + (";".join(("issues=write,pull_requests=write,contents=write,metadata=read", |
| 93 | + "issues=read,pull_requests=write,contents=write,metadata=read", |
| 94 | + "issues=write,pull_requests=read,contents=write,metadata=read", |
| 95 | + "issues=write,pull_requests=write,contents=read,metadata=read")), |
| 96 | + [{"issues": "write", "pull_requests": "write", "contents": "write", "metadata": "read"}, |
| 97 | + {"issues": "read", "pull_requests": "write", "contents": "write", "metadata": "read"}, |
| 98 | + {"issues": "write", "pull_requests": "read", "contents": "write", "metadata": "read"}, |
| 99 | + {"issues": "write", "pull_requests": "write", "contents": "read", "metadata": "read"}]), |
| 100 | + ("issues=write".ljust(256), [{"issues": "write"}]), |
| 101 | +]) |
| 102 | +def test_accepted_permissions_preserve_bounded_and_or_requirements( |
| 103 | + monkeypatch, method, path, value, sets, |
| 104 | +): |
| 105 | + headers = Message() |
| 106 | + headers["x-accepted-github-permissions"] = value |
| 107 | + body = b'{"message":"Resource not accessible by integration"}' |
| 108 | + text = request_failure(monkeypatch, http_error(body=body, headers=headers), |
| 109 | + method=method, path=path) |
| 110 | + assert accepted_permissions(text) == {"status": "available", "sets": sets} |
| 111 | + assert '"category": "permission"' in text and '"http_status": 403' in text |
| 112 | + assert headers["X-Accepted-GitHub-Permissions"] == value |
| 113 | + |
| 114 | + |
| 115 | +@pytest.mark.parametrize("value", [ |
| 116 | + "", " \t", "Issues=write", "issues=WRITE", "issues=none", "metadata=write", |
| 117 | + "checks=write", "issues=write;authorization=write", "issues=write,", |
| 118 | + ";issues=write", "issues=write;", "issues=write,,contents=read", |
| 119 | + "issues=write;;contents=read", "issues:write", 'issues="write"', "issues==write", |
| 120 | + "issues=write,issues=write", "issues=read,issues=write", "issues=write;issues=write", |
| 121 | + "issues=write,contents=read;contents=read,issues=write", |
| 122 | + "issues=read;issues=write;pull_requests=read;pull_requests=write;metadata=read", |
| 123 | + "issues=write,pull_requests=write,contents=read,metadata=read,issues=read", |
| 124 | + "issues=write".ljust(257), "issues=write;" + SECRET * 30, |
| 125 | + "issues=write\r\nAuthorization: " + SECRET, "issues=write\n", "issues=write\x00", |
| 126 | + "issues=write\x7f", "issues=write\v", "issues=write;\u00e9=read", |
| 127 | + "issues=write\uff1bcontents=read", "https://example.invalid/" + SECRET, |
| 128 | + None, 0, b"issues=write", ["issues=write"], {"issues": "write"}, |
| 129 | +]) |
| 130 | +def test_invalid_accepted_permissions_are_wholly_unavailable_without_leaks(monkeypatch, value): |
| 131 | + text = request_failure(monkeypatch, http_error(headers={ |
| 132 | + "X-Accepted-GitHub-Permissions": value})) |
| 133 | + assert accepted_permissions(text) == {"status": "unavailable"} |
| 134 | + assert '"category": "unknown"' in text |
| 135 | + |
| 136 | + |
| 137 | +def test_duplicate_accepted_permission_headers_are_unavailable(monkeypatch): |
| 138 | + headers = Message() |
| 139 | + headers["X-Accepted-GitHub-Permissions"] = "issues=write" |
| 140 | + headers["x-accepted-github-permissions"] = "pull_requests=write" |
| 141 | + text = request_failure(monkeypatch, http_error(headers=headers)) |
| 142 | + assert accepted_permissions(text) == {"status": "unavailable"} |
| 143 | + |
| 144 | + |
| 145 | +@pytest.mark.parametrize("mode", ["raise", "wrong-type", "multiple", "attribute", "get"]) |
| 146 | +def test_hostile_accepted_permission_headers_do_not_mask_http_failure(monkeypatch, mode): |
| 147 | + class Headers(dict): |
| 148 | + @property |
| 149 | + def get_all(self): |
| 150 | + if mode == "attribute": |
| 151 | + raise RuntimeError(SECRET) |
| 152 | + if mode == "get": |
| 153 | + return None |
| 154 | + if mode == "raise": |
| 155 | + return Mock(side_effect=RuntimeError(SECRET)) |
| 156 | + return Mock(return_value="issues=write" if mode == "wrong-type" |
| 157 | + else ["issues=write", SECRET]) |
| 158 | + |
| 159 | + def get(self, name, default=""): |
| 160 | + if mode == "get": |
| 161 | + raise RuntimeError(SECRET) |
| 162 | + return super().get(name, default) |
| 163 | + |
| 164 | + text = request_failure(monkeypatch, http_error(headers=Headers({"present": True}))) |
| 165 | + assert accepted_permissions(text) == {"status": "unavailable"} |
| 166 | + assert '"http_status": 403' in text |
| 167 | + |
| 168 | + |
| 169 | +@pytest.mark.parametrize("failure", ["parser", "serialization"]) |
| 170 | +def test_permission_diagnostic_failure_preserves_original_http_error(monkeypatch, failure): |
| 171 | + replacement = (Mock(side_effect=RuntimeError(SECRET)) if failure == "parser" |
| 172 | + else Mock(return_value={"unexpected": object()})) |
| 173 | + monkeypatch.setattr(integration, "comment_permission_requirements", replacement) |
| 174 | + text = request_failure(monkeypatch, http_error( |
| 175 | + body=b'{"message":"Resource not accessible by integration"}')) |
| 176 | + assert accepted_permissions(text) == {"status": "unavailable"} |
| 177 | + assert '"category": "permission"' in text and '"http_status": 403' in text |
| 178 | + |
| 179 | + |
| 180 | +@pytest.mark.parametrize("method,path", [ |
| 181 | + ("GET", "/issues/7/comments"), ("GET", "/issues/comments/9"), |
| 182 | + ("POST", "/actions/runs/7"), ("PATCH", "/pulls/7"), |
| 183 | + ("PATCH", "/issues/7/comments"), ("POST", "/issues/comments/9"), |
| 184 | + ("POST", "/private/" + SECRET), |
| 185 | +]) |
| 186 | +def test_accepted_permission_header_is_only_read_for_comment_writes(monkeypatch, method, path): |
| 187 | + headers = Message() |
| 188 | + headers["X-GitHub-Request-Id"] = "ABCD:1234" |
| 189 | + headers.get_all = Mock(side_effect=AssertionError(SECRET)) |
| 190 | + text = request_failure(monkeypatch, http_error(headers=headers), method=method, path=path) |
| 191 | + assert " accepted_permissions=" not in text |
| 192 | + headers.get_all.assert_not_called() |
| 193 | + |
| 194 | + |
| 195 | +@pytest.mark.parametrize("status,category", [(403, "unknown"), (429, "rate-limit"), |
| 196 | + (503, "unknown")]) |
| 197 | +def test_accepted_requirements_do_not_establish_granted_access_or_failure_cause( |
| 198 | + monkeypatch, status, category, |
| 199 | +): |
| 200 | + text = request_failure(monkeypatch, http_error(status, headers={ |
| 201 | + "X-Accepted-GitHub-Permissions": "issues=write"})) |
| 202 | + assert accepted_permissions(text) == {"status": "available", "sets": [{"issues": "write"}]} |
| 203 | + assert f'"category": "{category}"' in text |
| 204 | + |
| 205 | + |
73 | 206 | @pytest.mark.parametrize("value", [SECRET, "9" * 81, "-1", "3\n" + SECRET, None, 0]) |
74 | 207 | def test_hostile_metadata_is_not_echoed_or_used_as_rate_evidence(monkeypatch, value): |
75 | 208 | headers = {name: value for name in ( |
@@ -129,6 +262,7 @@ def test_endpoint_is_a_template_without_queries_or_private_path(monkeypatch, pat |
129 | 262 | def test_missing_body_and_headers_do_not_mask_failure(monkeypatch): |
130 | 263 | error = HTTPError("https://example.invalid/?token=" + SECRET, 403, SECRET, None, None) |
131 | 264 | text = request_failure(monkeypatch, error) |
| 265 | + assert accepted_permissions(text) == {"status": "absent"} |
132 | 266 | assert '"category": "unknown"' in text |
133 | 267 |
|
134 | 268 |
|
|
0 commit comments