1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
|
# Copyright 2013-2023 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)
import base64
import email.message
import hashlib
import io
import json
import re
import urllib.error
import urllib.parse
import urllib.request
import uuid
from typing import Callable, Dict, List, Optional, Pattern, Tuple
from urllib.request import Request
from spack.oci.image import Digest
from spack.oci.opener import OCIAuthHandler
class MockHTTPResponse(io.IOBase):
"""This is a mock HTTP response, which implements part of http.client.HTTPResponse"""
def __init__(self, status, reason, headers=None, body=None):
self.msg = None
self.version = 11
self.url = None
self.headers = email.message.EmailMessage()
self.status = status
self.code = status
self.reason = reason
self.debuglevel = 0
self._body = body
if headers is not None:
for key, value in headers.items():
self.headers[key] = value
@classmethod
def with_json(cls, status, reason, headers=None, body=None):
"""Create a mock HTTP response with JSON string as body"""
body = io.BytesIO(json.dumps(body).encode("utf-8"))
return cls(status, reason, headers, body)
def read(self, *args, **kwargs):
return self._body.read(*args, **kwargs)
def getheader(self, name, default=None):
self.headers.get(name, default)
def getheaders(self):
return self.headers.items()
def fileno(self):
return 0
def getcode(self):
return self.status
def info(self):
return self.headers
class MiddlewareError(Exception):
"""Thrown in a handler to return a response early."""
def __init__(self, response: MockHTTPResponse):
self.response = response
class Router:
"""This class is a small router for requests to the OCI registry.
It is used to dispatch requests to a handler, and middleware can be
used to transform requests, as well as return responses early
(e.g. for authentication)."""
def __init__(self) -> None:
self.routes: List[Tuple[str, Pattern, Callable]] = []
self.middleware: List[Callable[[Request], Request]] = []
def handle(self, req: Request) -> MockHTTPResponse:
"""Dispatch a request to a handler."""
result = urllib.parse.urlparse(req.full_url)
# Apply middleware
try:
for handler in self.middleware:
req = handler(req)
except MiddlewareError as e:
return e.response
for method, path_regex, handler in self.routes:
if method != req.get_method():
continue
match = re.fullmatch(path_regex, result.path)
if not match:
continue
return handler(req, **match.groupdict())
return MockHTTPResponse(404, "Not found")
def register(self, method, path: str, handler: Callable):
self.routes.append((method, re.compile(path), handler))
def add_middleware(self, handler: Callable[[Request], Request]):
self.middleware.append(handler)
class DummyServer:
def __init__(self, domain: str) -> None:
# The domain of the server, e.g. "registry.example.com"
self.domain = domain
# List of (method, url) tuples
self.requests: List[Tuple[str, str]] = []
# Dispatches requests to handlers
self.router = Router()
# Always install a request logger
self.router.add_middleware(self.log_request)
def handle(self, req: Request) -> MockHTTPResponse:
return self.router.handle(req)
def log_request(self, req: Request):
path = urllib.parse.urlparse(req.full_url).path
self.requests.append((req.get_method(), path))
return req
def clear_log(self):
self.requests = []
class InMemoryOCIRegistry(DummyServer):
"""This implements the basic OCI registry API, but in memory.
It supports two types of blob uploads:
1. POST + PUT: the client first starts a session with POST, then does a large PUT request
2. POST: the client does a single POST request with the whole blob
Option 2 is not supported by all registries, so we allow to disable it,
with allow_single_post=False.
A third option is to use the chunked upload, but this is not implemented here, because
it's typically a major performance hit in upload speed, so we're not using it in Spack."""
def __init__(self, domain: str, allow_single_post: bool = True) -> None:
super().__init__(domain)
self.router.register("GET", r"/v2/", self.index)
self.router.register("HEAD", r"/v2/(?P<name>.+)/blobs/(?P<digest>.+)", self.head_blob)
self.router.register("POST", r"/v2/(?P<name>.+)/blobs/uploads/", self.start_session)
self.router.register("PUT", r"/upload", self.put_session)
self.router.register("PUT", r"/v2/(?P<name>.+)/manifests/(?P<ref>.+)", self.put_manifest)
self.router.register("GET", r"/v2/(?P<name>.+)/manifests/(?P<ref>.+)", self.get_manifest)
self.router.register("GET", r"/v2/(?P<name>.+)/blobs/(?P<digest>.+)", self.get_blob)
self.router.register("GET", r"/v2/(?P<name>.+)/tags/list", self.list_tags)
# If True, allow single POST upload, not all registries support this
self.allow_single_post = allow_single_post
# Used for POST + PUT upload. This is a map from session ID to image name
self.sessions: Dict[str, str] = {}
# Set of sha256:... digests that are known to the registry
self.blobs: Dict[str, bytes] = {}
# Map from (name, tag) to manifest
self.manifests: Dict[Tuple[str, str], Dict] = {}
def index(self, req: Request):
return MockHTTPResponse.with_json(200, "OK", body={})
def head_blob(self, req: Request, name: str, digest: str):
if digest in self.blobs:
return MockHTTPResponse(200, "OK", headers={"Content-Length": "1234"})
return MockHTTPResponse(404, "Not found")
def get_blob(self, req: Request, name: str, digest: str):
if digest in self.blobs:
return MockHTTPResponse(200, "OK", body=io.BytesIO(self.blobs[digest]))
return MockHTTPResponse(404, "Not found")
def start_session(self, req: Request, name: str):
id = str(uuid.uuid4())
self.sessions[id] = name
# Check if digest is present (single monolithic upload)
result = urllib.parse.urlparse(req.full_url)
query = urllib.parse.parse_qs(result.query)
if self.allow_single_post and "digest" in query:
return self.handle_upload(
req, name=name, digest=Digest.from_string(query["digest"][0])
)
return MockHTTPResponse(202, "Accepted", headers={"Location": f"/upload?uuid={id}"})
def put_session(self, req: Request):
# Do the upload.
result = urllib.parse.urlparse(req.full_url)
query = urllib.parse.parse_qs(result.query)
# uuid param should be preserved, and digest should be present
assert "uuid" in query and len(query["uuid"]) == 1
assert "digest" in query and len(query["digest"]) == 1
id = query["uuid"][0]
assert id in self.sessions
name, digest = self.sessions[id], Digest.from_string(query["digest"][0])
response = self.handle_upload(req, name=name, digest=digest)
# End the session
del self.sessions[id]
return response
def put_manifest(self, req: Request, name: str, ref: str):
# In requests, Python runs header.capitalize().
content_type = req.get_header("Content-type")
assert content_type in (
"application/vnd.oci.image.manifest.v1+json",
"application/vnd.oci.image.index.v1+json",
)
index_or_manifest = json.loads(self._require_data(req))
# Verify that we have all blobs (layers for manifest, manifests for index)
if content_type == "application/vnd.oci.image.manifest.v1+json":
for layer in index_or_manifest["layers"]:
assert layer["digest"] in self.blobs, "Missing blob while uploading manifest"
else:
for manifest in index_or_manifest["manifests"]:
assert (
name,
manifest["digest"],
) in self.manifests, "Missing manifest while uploading index"
self.manifests[(name, ref)] = index_or_manifest
return MockHTTPResponse(
201, "Created", headers={"Location": f"/v2/{name}/manifests/{ref}"}
)
def get_manifest(self, req: Request, name: str, ref: str):
if (name, ref) not in self.manifests:
return MockHTTPResponse(404, "Not found")
manifest_or_index = self.manifests[(name, ref)]
return MockHTTPResponse.with_json(
200,
"OK",
headers={"Content-type": manifest_or_index["mediaType"]},
body=manifest_or_index,
)
def _require_data(self, req: Request) -> bytes:
"""Extract request.data, it's type remains a mystery"""
assert req.data is not None
if hasattr(req.data, "read"):
return req.data.read()
elif isinstance(req.data, bytes):
return req.data
raise ValueError("req.data should be bytes or have a read() method")
def handle_upload(self, req: Request, name: str, digest: Digest):
"""Verify the digest, save the blob, return created status"""
data = self._require_data(req)
assert hashlib.sha256(data).hexdigest() == digest.digest
self.blobs[str(digest)] = data
return MockHTTPResponse(201, "Created", headers={"Location": f"/v2/{name}/blobs/{digest}"})
def list_tags(self, req: Request, name: str):
# List all tags, exclude digests.
tags = [_tag for _name, _tag in self.manifests.keys() if _name == name and ":" not in _tag]
tags.sort()
return MockHTTPResponse.with_json(200, "OK", body={"tags": tags})
class DummyServerUrllibHandler(urllib.request.BaseHandler):
"""Glue between urllib and DummyServer, routing requests to
the correct mock server for a given domain."""
def __init__(self) -> None:
self.servers: Dict[str, DummyServer] = {}
def add_server(self, domain: str, api: DummyServer):
self.servers[domain] = api
return self
def https_open(self, req: Request):
domain = urllib.parse.urlparse(req.full_url).netloc
if domain not in self.servers:
return MockHTTPResponse(404, "Not found")
return self.servers[domain].handle(req)
class InMemoryOCIRegistryWithAuth(InMemoryOCIRegistry):
"""This is another in-memory OCI registry, but it requires authentication."""
def __init__(
self, domain, token: Optional[str], realm: str, allow_single_post: bool = True
) -> None:
super().__init__(domain, allow_single_post)
self.token = token # token to accept
self.realm = realm # url to the authorization server
self.router.add_middleware(self.authenticate)
def authenticate(self, req: Request):
# Any request needs an Authorization header
authorization = req.get_header("Authorization")
if authorization is None:
raise MiddlewareError(self.unauthorized())
# Ensure that the token is correct
assert authorization.startswith("Bearer ")
token = authorization[7:]
if token != self.token:
raise MiddlewareError(self.unauthorized())
return req
def unauthorized(self):
return MockHTTPResponse(
401,
"Unauthorized",
{
"www-authenticate": f'Bearer realm="{self.realm}",'
f'service="{self.domain}",'
'scope="repository:spack-registry:pull,push"'
},
)
class MockBearerTokenServer(DummyServer):
"""Simulates a basic server that hands out bearer tokens
at the /login endpoint for the following services:
public.example.com, which doesn't require Basic Auth
private.example.com, which requires Basic Auth, with user:pass
"""
def __init__(self, domain: str) -> None:
super().__init__(domain)
self.router.register("GET", "/login", self.login)
def login(self, req: Request):
url = urllib.parse.urlparse(req.full_url)
query_params = urllib.parse.parse_qs(url.query)
# Verify query params, from the www-authenticate header
assert query_params["client_id"] == ["spack"]
assert len(query_params["service"]) == 1
assert query_params["scope"] == ["repository:spack-registry:pull,push"]
service = query_params["service"][0]
if service == "public.example.com":
return self.public_auth(req)
elif service == "private.example.com":
return self.private_auth(req)
return MockHTTPResponse(404, "Not found")
def public_auth(self, req: Request):
# No need to login with username and password for the public registry
assert req.get_header("Authorization") is None
return MockHTTPResponse.with_json(200, "OK", body={"token": "public_token"})
def private_auth(self, req: Request):
# For the private registry we need to login with username and password
auth_value = req.get_header("Authorization")
if (
auth_value is None
or not auth_value.startswith("Basic ")
or base64.b64decode(auth_value[6:]) != b"user:pass"
):
return MockHTTPResponse(401, "Unauthorized")
return MockHTTPResponse.with_json(200, "OK", body={"token": "private_token"})
def create_opener(*servers: DummyServer, credentials_provider=None):
"""Creates a mock opener, that can be used to fake requests to a list
of servers."""
opener = urllib.request.OpenerDirector()
handler = DummyServerUrllibHandler()
for server in servers:
handler.add_server(server.domain, server)
opener.add_handler(handler)
opener.add_handler(urllib.request.HTTPDefaultErrorHandler())
opener.add_handler(urllib.request.HTTPErrorProcessor())
if credentials_provider is not None:
opener.add_handler(OCIAuthHandler(credentials_provider))
return opener
|