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 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
|
import string
from collections.abc import Iterable
from typing import Any, Optional
from moto.core.base_backend import BackendDict, BaseBackend
from moto.core.common_models import BaseModel
from moto.core.utils import iso_8601_datetime_with_milliseconds
from moto.moto_api._internal import mock_random as random
from moto.moto_api._internal.managed_state_model import ManagedState
from moto.utilities.tagging_service import TaggingService
from moto.utilities.utils import PARTITION_NAMES, get_partition
from .exceptions import (
DistributionAlreadyExists,
DomainNameNotAnS3Bucket,
InvalidIfMatchVersion,
NoSuchDistribution,
NoSuchInvalidation,
NoSuchOriginAccessControl,
OriginDoesNotExist,
)
def random_id(uppercase: bool = True, length: int = 13) -> str:
ascii_set = string.ascii_uppercase if uppercase else string.ascii_lowercase
chars = list(range(10)) + list(ascii_set)
resource_id = random.choice(ascii_set) + "".join(
str(random.choice(chars)) for _ in range(length - 1)
)
return resource_id
class ActiveTrustedSigners:
def __init__(self) -> None:
self.enabled = False
self.quantity = 0
self.signers: list[Any] = []
class ActiveTrustedKeyGroups:
def __init__(self) -> None:
self.enabled = False
self.quantity = 0
self.kg_key_pair_ids: list[Any] = []
class LambdaFunctionAssociation:
def __init__(self) -> None:
self.arn = ""
self.event_type = ""
self.include_body = False
class ForwardedValues:
def __init__(self, config: dict[str, Any]):
self.query_string = config.get("QueryString", "false")
self.cookie_forward = config.get("Cookies", {}).get("Forward") or "none"
self.whitelisted_names = (
config.get("Cookies", {}).get("WhitelistedNames", {}).get("Items") or {}
)
self.whitelisted_names = self.whitelisted_names.get("Name") or []
if isinstance(self.whitelisted_names, str):
self.whitelisted_names = [self.whitelisted_names]
self.headers: list[Any] = []
self.query_string_cache_keys: list[Any] = []
self.cookies: list[dict[str, Any]] = config.get("Cookies") or []
class TrustedSigners:
def __init__(self, config: dict[str, Any]):
items = config.get("Items") or {}
self.acct_nums = items.get("AwsAccountNumber") or []
if isinstance(self.acct_nums, str):
self.acct_nums = [self.acct_nums]
class TrustedKeyGroups:
def __init__(self, config: dict[str, Any]):
items = config.get("Items") or {}
self.group_ids = items.get("KeyGroup") or []
if isinstance(self.group_ids, str):
self.group_ids = [self.group_ids]
class DefaultCacheBehaviour:
def __init__(self, config: dict[str, Any]):
self.target_origin_id = config["TargetOriginId"]
self.trusted_signers_enabled = False
self.trusted_signers = TrustedSigners(config.get("TrustedSigners") or {})
self.trusted_key_groups = TrustedKeyGroups(config.get("TrustedKeyGroups") or {})
self.viewer_protocol_policy = config["ViewerProtocolPolicy"]
methods = config.get("AllowedMethods", {})
self.allowed_methods = methods.get("Items", {}).get("Method", ["HEAD", "GET"])
self.cached_methods = (
methods.get("CachedMethods", {})
.get("Items", {})
.get("Method", ["GET", "HEAD"])
)
self.smooth_streaming = config.get("SmoothStreaming") or True
self.compress = config.get("Compress", "true").lower() == "true"
self.lambda_function_associations: list[Any] = []
self.function_associations: list[Any] = []
self.field_level_encryption_id = config.get("FieldLevelEncryptionId") or ""
self.forwarded_values = ForwardedValues(config.get("ForwardedValues", {}))
self.min_ttl = config.get("MinTTL") or 0
self.default_ttl = config.get("DefaultTTL") or 0
self.max_ttl = config.get("MaxTTL") or 0
self.realtime_log_config_arn = config.get("RealtimeLogConfigArn") or ""
class CacheBehaviour(DefaultCacheBehaviour):
def __init__(self, config: dict[str, Any]):
super().__init__(config)
self.path_pattern: str = config.get("PathPattern", "")
methods = config.get("AllowedMethods", {})
self.cached_methods: list[str] = (
methods.get("CachedMethods", {}).get("Items", {}).get("Method", [])
)
self.allowed_methods: list[str] = methods.get("Items", {}).get("Method", [])
self.cache_policy_id = config.get("CachePolicyId", "")
self.origin_request_policy_id = config.get("OriginRequestPolicyId", "")
class Logging:
def __init__(self, config: dict[str, Any]) -> None:
self.enabled = config.get("Enabled") or False
self.include_cookies = config.get("IncludeCookies") or False
self.bucket = config.get("Bucket") or ""
self.prefix = config.get("Prefix") or ""
class ViewerCertificate:
def __init__(self, config: dict[str, Any]) -> None:
self.cloud_front_default_certificate = config.get(
"CloudFrontDefaultCertificate", True
)
if isinstance(self.cloud_front_default_certificate, str):
self.cloud_front_default_certificate = (
self.cloud_front_default_certificate.lower() == "true"
)
self.iam_certificate_id = config.get("IAMCertificateId") or ""
self.acm_certificate_arn = config.get("ACMCertificateArn") or ""
self.ssl_support_method = config.get("SSLSupportMethod") or "sni-only"
self.min_protocol_version = config.get("MinimumProtocolVersion") or "TLSv1"
self.certificate_source = "cloudfront"
class CustomOriginConfig:
def __init__(self, config: dict[str, Any]):
self.http_port = config.get("HTTPPort")
self.https_port = config.get("HTTPSPort")
self.keep_alive = config.get("OriginKeepaliveTimeout") or 5
self.protocol_policy = config.get("OriginProtocolPolicy")
self.read_timeout = config.get("OriginReadTimeout") or 30
protocols = config.get("OriginSslProtocols", {}).get("Items") or {}
self.ssl_protocols = protocols.get("SslProtocol") or []
if isinstance(self.ssl_protocols, str):
self.ssl_protocols = [self.ssl_protocols]
class Origin:
def __init__(self, origin: dict[str, Any]):
self.id = origin["Id"]
self.domain_name = origin["DomainName"]
self.origin_path = origin.get("OriginPath") or ""
self.s3_access_identity = ""
self.custom_origin = None
self.origin_shield = origin.get("OriginShield")
self.connection_attempts = origin.get("ConnectionAttempts") or 3
self.connection_timeout = origin.get("ConnectionTimeout") or 10
if "S3OriginConfig" in origin:
# Very rough validation
if not self.domain_name.endswith("amazonaws.com"):
raise DomainNameNotAnS3Bucket
self.s3_access_identity = origin["S3OriginConfig"]["OriginAccessIdentity"]
if "CustomOriginConfig" in origin:
self.custom_origin = CustomOriginConfig(origin["CustomOriginConfig"])
custom_headers = origin.get("CustomHeaders") or {}
custom_headers = custom_headers.get("Items") or {}
custom_headers = custom_headers.get("OriginCustomHeader") or []
if isinstance(custom_headers, dict):
# Happens if user only sends a single header
custom_headers = [custom_headers]
self.custom_headers = custom_headers
class GeoRestrictions:
def __init__(self, config: dict[str, Any]):
config = config.get("GeoRestriction") or {}
self._type = config.get("RestrictionType", "none")
self.restrictions = (config.get("Items") or {}).get("Location") or []
class DistributionConfig:
def __init__(self, config: dict[str, Any]):
self.config = config
self.aliases = ((config.get("Aliases") or {}).get("Items") or {}).get(
"CNAME"
) or []
if isinstance(self.aliases, str):
self.aliases = [self.aliases]
self.comment = config.get("Comment") or ""
self.default_cache_behavior = DefaultCacheBehaviour(
config["DefaultCacheBehavior"]
)
self.cache_behaviors: list[Any] = []
if config.get("CacheBehaviors", {}).get("Items"):
for _, v in config.get("CacheBehaviors", {}).get("Items").items():
self.cache_behaviors.append(CacheBehaviour(v))
self.custom_error_responses: list[Any] = []
self.logging = Logging(config.get("Logging") or {})
self.enabled = config.get("Enabled") or False
self.viewer_certificate = ViewerCertificate(
config.get("ViewerCertificate") or {}
)
self.geo_restriction = GeoRestrictions(config.get("Restrictions") or {})
self.caller_reference = config.get("CallerReference", str(random.uuid4()))
self.origins = config["Origins"]["Items"]["Origin"]
if not isinstance(self.origins, list):
self.origins = [self.origins]
# This check happens before any other Origins-validation
if self.default_cache_behavior.target_origin_id not in [
o["Id"] for o in self.origins
]:
raise OriginDoesNotExist
self.origins = [Origin(o) for o in self.origins]
self.price_class = config.get("PriceClass", "PriceClass_All")
self.http_version = config.get("HttpVersion", "http2")
self.is_ipv6_enabled = config.get("IsIPV6Enabled", "true").lower() == "true"
self.default_root_object = config.get("DefaultRootObject") or ""
self.web_acl_id = config.get("WebACLId") or ""
class Distribution(BaseModel, ManagedState):
def __init__(self, account_id: str, region_name: str, config: dict[str, Any]):
# Configured ManagedState
super().__init__(
"cloudfront::distribution", transitions=[("InProgress", "Deployed")]
)
# Configure internal properties
self.distribution_id = random_id()
self.arn = f"arn:{get_partition(region_name)}:cloudfront:{account_id}:distribution/{self.distribution_id}"
self.distribution_config = DistributionConfig(config)
self.active_trusted_signers = ActiveTrustedSigners()
self.active_trusted_key_groups = ActiveTrustedKeyGroups()
self.origin_groups: list[Any] = []
self.alias_icp_recordals: list[Any] = []
self.last_modified_time = "2021-11-27T10:34:26.802Z"
self.in_progress_invalidation_batches = 0
self.has_active_trusted_key_groups = False
self.domain_name = f"{random_id(uppercase=False)}.cloudfront.net"
self.etag = random_id()
@property
def location(self) -> str:
return f"https://cloudfront.amazonaws.com/2020-05-31/distribution/{self.distribution_id}"
class OriginAccessControl(BaseModel):
def __init__(self, config_dict: dict[str, str]):
self.id = random_id()
self.name = config_dict.get("Name")
self.description = config_dict.get("Description")
self.signing_protocol = config_dict.get("SigningProtocol")
self.signing_behaviour = config_dict.get("SigningBehavior")
self.origin_type = config_dict.get("OriginAccessControlOriginType")
self.etag = random_id()
def update(self, config: dict[str, str]) -> None:
if "Name" in config:
self.name = config["Name"]
if "Description" in config:
self.description = config["Description"]
if "SigningProtocol" in config:
self.signing_protocol = config["SigningProtocol"]
if "SigningBehavior" in config:
self.signing_behaviour = config["SigningBehavior"]
if "OriginAccessControlOriginType" in config:
self.origin_type = config["OriginAccessControlOriginType"]
class Invalidation(BaseModel):
def __init__(
self, distribution: Distribution, paths: dict[str, Any], caller_ref: str
):
self.invalidation_id = random_id()
self.create_time = iso_8601_datetime_with_milliseconds()
self.distribution = distribution
self.status = "COMPLETED"
self.paths = paths
self.caller_ref = caller_ref
@property
def location(self) -> str:
return self.distribution.location + f"/invalidation/{self.invalidation_id}"
class PublicKey(BaseModel):
def __init__(self, caller_ref: str, name: str, encoded_key: str):
self.id = random_id(length=14)
self.caller_ref = caller_ref
self.name = name
self.encoded_key = encoded_key
self.created = iso_8601_datetime_with_milliseconds()
self.etag = random_id(length=14)
self.location = (
f"https://cloudfront.amazonaws.com/2020-05-31/public-key/{self.id}"
)
# Last newline-separator is lost in the XML->Python transformation, but should exist
if not self.encoded_key.endswith("\n"):
self.encoded_key += "\n"
class KeyGroup(BaseModel):
def __init__(self, name: str, items: list[str]):
self.id = random_id(length=14)
self.name = name
self.items = items
self.etag = random_id(length=14)
self.location = (
f"https://cloudfront.amazonaws.com/2020-05-31/key-group/{self.id}"
)
class CloudFrontBackend(BaseBackend):
def __init__(self, region_name: str, account_id: str):
super().__init__(region_name, account_id)
self.distributions: dict[str, Distribution] = {}
self.invalidations: dict[str, list[Invalidation]] = {}
self.origin_access_controls: dict[str, OriginAccessControl] = {}
self.public_keys: dict[str, PublicKey] = {}
self.key_groups: dict[str, KeyGroup] = {}
self.tagger = TaggingService()
def create_distribution(
self, distribution_config: dict[str, Any], tags: list[dict[str, str]]
) -> tuple[Distribution, str, str]:
"""
Not all configuration options are supported yet. Please raise an issue if
we're not persisting/returning the correct attributes for your
use-case.
"""
# We'll always call dist_with_tags, as the incoming request is the same
return self.create_distribution_with_tags(distribution_config, tags)
def create_distribution_with_tags(
self, distribution_config: dict[str, Any], tags: list[dict[str, str]]
) -> tuple[Distribution, str, str]:
dist = Distribution(self.account_id, self.region_name, distribution_config)
caller_reference = dist.distribution_config.caller_reference
existing_dist = self._distribution_with_caller_reference(caller_reference)
if existing_dist is not None:
raise DistributionAlreadyExists(existing_dist.distribution_id)
self.distributions[dist.distribution_id] = dist
self.tagger.tag_resource(dist.arn, tags)
return dist, dist.location, dist.etag
def get_distribution(self, distribution_id: str) -> tuple[Distribution, str]:
if distribution_id not in self.distributions:
raise NoSuchDistribution
dist = self.distributions[distribution_id]
dist.advance()
return dist, dist.etag
def get_distribution_config(self, distribution_id: str) -> tuple[Distribution, str]:
if distribution_id not in self.distributions:
raise NoSuchDistribution
dist = self.distributions[distribution_id]
dist.advance()
return dist, dist.etag
def delete_distribution(self, distribution_id: str, if_match: bool) -> None:
"""
The IfMatch-value is ignored - any value is considered valid.
Calling this function without a value is invalid, per AWS' behaviour
"""
if not if_match:
raise InvalidIfMatchVersion
if distribution_id not in self.distributions:
raise NoSuchDistribution
del self.distributions[distribution_id]
def list_distributions(self) -> Iterable[Distribution]:
"""
Pagination is not supported yet.
"""
for dist in self.distributions.values():
dist.advance()
return self.distributions.values()
def _distribution_with_caller_reference(
self, reference: str
) -> Optional[Distribution]:
for dist in self.distributions.values():
config = dist.distribution_config
if config.caller_reference == reference:
return dist
return None
def update_distribution(
self, dist_config: dict[str, Any], _id: str, if_match: bool
) -> tuple[Distribution, str, str]:
"""
The IfMatch-value is ignored - any value is considered valid.
Calling this function without a value is invalid, per AWS' behaviour
"""
if _id not in self.distributions or _id is None:
raise NoSuchDistribution
if not if_match:
raise InvalidIfMatchVersion
if not dist_config:
raise NoSuchDistribution
dist = self.distributions[_id]
dist.distribution_config = DistributionConfig(dist_config)
self.distributions[_id] = dist
dist.advance()
return dist, dist.location, dist.etag
def create_invalidation(
self, dist_id: str, paths: dict[str, Any], caller_ref: str
) -> Invalidation:
dist, _ = self.get_distribution(dist_id)
invalidation = Invalidation(dist, paths, caller_ref)
try:
self.invalidations[dist_id].append(invalidation)
except KeyError:
self.invalidations[dist_id] = [invalidation]
return invalidation
def list_invalidations(self, dist_id: str) -> Iterable[Invalidation]:
"""
Pagination is not yet implemented
"""
return self.invalidations.get(dist_id) or []
def get_invalidation(self, dist_id: str, id: str) -> Invalidation:
if dist_id not in self.distributions:
raise NoSuchDistribution
try:
invalidations = self.invalidations[dist_id]
if invalidations:
for invalidation in invalidations:
if invalidation.invalidation_id == id:
return invalidation
except KeyError:
pass
raise NoSuchInvalidation
def list_tags_for_resource(self, resource: str) -> dict[str, list[dict[str, str]]]:
return self.tagger.list_tags_for_resource(resource)
def tag_resource(self, resource: str, tags: list[dict[str, str]]) -> None:
self.tagger.tag_resource(resource, tags)
def untag_resource(self, resource: str, tag_keys: list[str]) -> None:
self.tagger.untag_resource_using_names(resource, tag_keys)
def create_origin_access_control(
self, config_dict: dict[str, str]
) -> OriginAccessControl:
control = OriginAccessControl(config_dict)
self.origin_access_controls[control.id] = control
return control
def get_origin_access_control(self, control_id: str) -> OriginAccessControl:
if control_id not in self.origin_access_controls:
raise NoSuchOriginAccessControl
return self.origin_access_controls[control_id]
def update_origin_access_control(
self, control_id: str, config: dict[str, str]
) -> OriginAccessControl:
"""
The IfMatch-parameter is not yet implemented
"""
control = self.get_origin_access_control(control_id)
control.update(config)
return control
def list_origin_access_controls(self) -> Iterable[OriginAccessControl]:
"""
Pagination is not yet implemented
"""
return self.origin_access_controls.values()
def delete_origin_access_control(self, control_id: str) -> None:
"""
The IfMatch-parameter is not yet implemented
"""
self.origin_access_controls.pop(control_id)
def create_public_key(
self, caller_ref: str, name: str, encoded_key: str
) -> PublicKey:
key = PublicKey(name=name, caller_ref=caller_ref, encoded_key=encoded_key)
self.public_keys[key.id] = key
return key
def get_public_key(self, key_id: str) -> PublicKey:
return self.public_keys[key_id]
def delete_public_key(self, key_id: str) -> None:
"""
IfMatch is not yet implemented - deletion always succeeds
"""
self.public_keys.pop(key_id, None)
def list_public_keys(self) -> list[PublicKey]:
"""
Pagination is not yet implemented
"""
return list(self.public_keys.values())
def create_key_group(self, name: str, items: list[str]) -> KeyGroup:
key_group = KeyGroup(name=name, items=items)
self.key_groups[key_group.id] = key_group
return key_group
def get_key_group(self, group_id: str) -> KeyGroup:
return self.key_groups[group_id]
def list_key_groups(self) -> list[KeyGroup]:
"""
Pagination is not yet implemented
"""
return list(self.key_groups.values())
cloudfront_backends = BackendDict(
CloudFrontBackend,
"cloudfront",
use_boto3_regions=False,
additional_regions=PARTITION_NAMES,
)
|