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
|
import json
import re
from collections.abc import Iterable
from typing import Any, Callable, Optional, Union
from moto.moto_api._internal import mock_random
from moto.utilities.utils import get_partition
E164_REGEX = re.compile(r"^\+?[1-9]\d{1,14}$")
def make_arn_for_topic(account_id: str, name: str, region_name: str) -> str:
return f"arn:{get_partition(region_name)}:sns:{region_name}:{account_id}:{name}"
def make_arn_for_subscription(topic_arn: str) -> str:
subscription_id = mock_random.uuid4()
return f"{topic_arn}:{subscription_id}"
def is_e164(number: str) -> bool:
return E164_REGEX.match(number) is not None
class FilterPolicyMatcher:
class CheckException(Exception):
pass
def __init__(
self, filter_policy: dict[str, Any], filter_policy_scope: Optional[str]
):
self.filter_policy = filter_policy
self.filter_policy_scope = (
filter_policy_scope
if filter_policy_scope is not None
else "MessageAttributes"
)
if self.filter_policy_scope not in ("MessageAttributes", "MessageBody"):
raise FilterPolicyMatcher.CheckException(
f"Unsupported filter_policy_scope: {filter_policy_scope}"
)
def matches(
self, message_attributes: Optional[dict[str, Any]], message: str
) -> bool:
if not self.filter_policy:
return True
if self.filter_policy_scope == "MessageAttributes":
if message_attributes is None:
message_attributes = {}
return FilterPolicyMatcher._attributes_based_match(
message_attributes, source=self.filter_policy
)
else:
try:
message_dict = json.loads(message)
except ValueError:
return False
return self._body_based_match(message_dict)
@staticmethod
def _attributes_based_match( # type: ignore[misc]
message_attributes: dict[str, Any], source: dict[str, Any]
) -> bool:
return all(
FilterPolicyMatcher._field_match(field, rules, message_attributes)
for field, rules in source.items()
)
def _body_based_match(self, message_dict: dict[str, Any]) -> bool:
try:
checks = self._compute_body_checks(self.filter_policy, message_dict)
except FilterPolicyMatcher.CheckException:
return False
return self._perform_body_checks(checks)
def _perform_body_checks(self, check: Any) -> bool:
# If the checks are a list, only a single elem has to pass
# otherwise all the entries have to pass
if isinstance(check, tuple):
if len(check) == 2:
# (any|all, checks)
aggregate_func, checks = check
return aggregate_func(
self._perform_body_checks(single_check) for single_check in checks
)
elif len(check) == 3:
field, rules, dict_body = check
return FilterPolicyMatcher._field_match(field, rules, dict_body, False)
raise FilterPolicyMatcher.CheckException(f"Check is not a tuple: {str(check)}")
def _compute_body_checks(
self,
filter_policy: dict[str, Union[dict[str, Any], list[Any]]],
message_body: Union[dict[str, Any], list[Any]],
) -> tuple[Callable[[Iterable[Any]], bool], Any]:
"""
Generate (possibly nested) list of checks to be performed based on the filter policy
Returned list is of format (any|all, checks), where first elem defines what aggregation should be used in checking
and the second argument is a list containing sublists of the same format or concrete checks (field, rule, body): Tuple[str, List[Any], Dict[str, Any]]
All the checks returned by this function will only require one-level-deep entry into dict in _field_match function
This is done this way to simplify the actual check logic and keep it as close as possible between MessageAttributes and MessageBody
Given message_body:
{"Records": [
{
"eventName": "ObjectCreated:Put",
},
{
"eventName": "ObjectCreated:Delete",
},
]}
and filter policy:
{"Records": {
"eventName": [{"prefix": "ObjectCreated:"}],
}}
the following check list would be computed:
(<built-in function all>, (
(<built-in function all>, (
(<built-in function any>, (
('eventName', [{'prefix': 'ObjectCreated:'}], {'eventName': 'ObjectCreated:Put'}),
('eventName', [{'prefix': 'ObjectCreated:'}], {'eventName': 'ObjectCreated:Delete'}))
),
)
),))
"""
rules = []
for filter_key, filter_value in filter_policy.items():
if isinstance(filter_value, dict):
if isinstance(message_body, dict):
message_value = message_body.get(filter_key)
if message_value is not None:
rules.append(
self._compute_body_checks(filter_value, message_value)
)
else:
raise FilterPolicyMatcher.CheckException
elif isinstance(message_body, list):
subchecks = []
for entry in message_body:
subchecks.append(
self._compute_body_checks(filter_policy, entry)
)
rules.append((any, tuple(subchecks)))
else:
raise FilterPolicyMatcher.CheckException
elif isinstance(filter_value, list):
# These are the real rules, same as in MessageAttributes case
concrete_checks = []
if isinstance(message_body, dict):
if message_body is not None:
concrete_checks.append((filter_key, filter_value, message_body))
else:
raise FilterPolicyMatcher.CheckException
elif isinstance(message_body, list):
# Apply policy to each element of the list, pass if at list one element matches
for list_elem in message_body:
concrete_checks.append((filter_key, filter_value, list_elem))
else:
raise FilterPolicyMatcher.CheckException
rules.append((any, tuple(concrete_checks)))
else:
raise FilterPolicyMatcher.CheckException
return (all, tuple(rules))
@staticmethod
def _field_match( # type: ignore # decorated function contains type Any
field: str,
rules: list[Any],
dict_body: dict[str, Any],
attributes_based_check: bool = True,
) -> bool:
# dict_body = MessageAttributes if attributes_based_check is True
# otherwise it's the cut-out part of the MessageBody (so only single-level nesting must be supported)
# Iterate over every rule from the list of rules
# At least one rule has to match the field for the function to return a match
def _str_exact_match(value: str, rule: Union[str, list[str]]) -> bool:
if value == rule:
return True
if isinstance(value, list):
if rule in value:
return True
try:
json_data = json.loads(value)
if rule in json_data:
return True
except (ValueError, TypeError):
pass
return False
def _number_match(values: list[float], rule: float) -> bool:
for value in values:
# Even the official documentation states a 5 digits of accuracy after the decimal point for numerics, in reality it is 6
# https://docs.aws.amazon.com/sns/latest/dg/sns-subscription-filter-policies.html#subscription-filter-policy-constraints
if int(value * 1000000) == int(rule * 1000000):
return True
return False
def _exists_match(
should_exist: bool, field: str, dict_body: dict[str, Any]
) -> bool:
if should_exist and field in dict_body:
return True
elif not should_exist and field not in dict_body:
return True
return False
def _prefix_match(prefix: str, value: str) -> bool:
return value.startswith(prefix)
def _suffix_match(prefix: str, value: str) -> bool:
return value.endswith(prefix)
def _anything_but_match(
filter_value: Union[dict[str, Any], list[str], str],
actual_values: list[str],
) -> bool:
if isinstance(filter_value, dict):
# We can combine anything-but with the prefix-filter
anything_but_key = list(filter_value.keys())[0]
anything_but_val = list(filter_value.values())[0]
if anything_but_key != "prefix":
return False
if all(not v.startswith(anything_but_val) for v in actual_values):
return True
else:
undesired_values = (
[filter_value] if isinstance(filter_value, str) else filter_value
)
if all(v not in undesired_values for v in actual_values):
return True
return False
def _numeric_match(
numeric_ranges: Iterable[tuple[str, float]], numeric_value: float
) -> bool:
# numeric_ranges' format:
# [(< x), (=, y), (>=, z)]
msg_value = numeric_value
matches = []
for operator, test_value in numeric_ranges:
if operator == ">":
matches.append(msg_value > test_value)
if operator == ">=":
matches.append(msg_value >= test_value)
if operator == "=":
matches.append(msg_value == test_value)
if operator == "<":
matches.append(msg_value < test_value)
if operator == "<=":
matches.append(msg_value <= test_value)
return all(matches)
for rule in rules:
# TODO: boolean value matching is not supported, SNS behavior unknown
if isinstance(rule, str):
if attributes_based_check:
if field not in dict_body:
return False
if _str_exact_match(dict_body[field]["Value"], rule):
return True
else:
if field not in dict_body:
return False
if _str_exact_match(dict_body[field], rule):
return True
if isinstance(rule, (int, float)):
if attributes_based_check:
if field not in dict_body:
return False
if dict_body[field]["Type"] == "Number":
attribute_values = [dict_body[field]["Value"]]
elif dict_body[field]["Type"] == "String.Array":
try:
attribute_values = json.loads(dict_body[field]["Value"])
if not isinstance(attribute_values, list):
attribute_values = [attribute_values]
except (ValueError, TypeError):
return False
else:
return False
values = [float(value) for value in attribute_values]
if _number_match(values, rule):
return True
else:
if field not in dict_body:
return False
if isinstance(dict_body[field], (int, float)):
values = [dict_body[field]]
elif isinstance(dict_body[field], list):
values = [float(value) for value in dict_body[field]]
else:
return False
if _number_match(values, rule):
return True
if isinstance(rule, dict):
keyword = list(rule.keys())[0]
value = list(rule.values())[0]
if keyword == "exists":
if attributes_based_check:
if _exists_match(value, field, dict_body):
return True
else:
if _exists_match(value, field, dict_body):
return True
elif keyword == "equals-ignore-case" and isinstance(value, str):
if attributes_based_check:
if field not in dict_body:
return False
if _str_exact_match(dict_body[field]["Value"].lower(), value):
return True
else:
if field not in dict_body:
return False
if _str_exact_match(dict_body[field].lower(), value):
return True
elif keyword == "prefix" and isinstance(value, str):
if attributes_based_check:
if field in dict_body:
attr = dict_body[field]
if attr["Type"] == "String":
if _prefix_match(value, attr["Value"]):
return True
else:
if field in dict_body:
if _prefix_match(value, dict_body[field]):
return True
elif keyword == "suffix" and isinstance(value, str):
if attributes_based_check:
if field in dict_body:
attr = dict_body[field]
if attr["Type"] == "String":
if _suffix_match(value, attr["Value"]):
return True
else:
if field in dict_body:
if _suffix_match(value, dict_body[field]):
return True
elif keyword == "anything-but":
if attributes_based_check:
if field not in dict_body:
return False
attr = dict_body[field]
if isinstance(value, dict):
# We can combine anything-but with the prefix-filter
if attr["Type"] == "String":
actual_values = [attr["Value"]]
else:
actual_values = list(attr["Value"])
else:
if attr["Type"] == "Number":
actual_values = [float(attr["Value"])]
elif attr["Type"] == "String":
actual_values = [attr["Value"]]
else:
actual_values = list(attr["Value"])
if _anything_but_match(value, actual_values):
return True
else:
if field not in dict_body:
return False
attr = dict_body[field]
if isinstance(value, dict):
if isinstance(attr, str):
actual_values = [attr]
elif isinstance(attr, list):
actual_values = attr
else:
return False
else:
if isinstance(attr, (int, float, str)):
actual_values = [attr]
elif isinstance(attr, list):
actual_values = attr
else:
return False
if _anything_but_match(value, actual_values):
return True
elif keyword == "numeric" and isinstance(value, list):
if attributes_based_check:
if dict_body.get(field, {}).get("Type", "") == "Number":
checks = value
numeric_ranges = zip(checks[0::2], checks[1::2])
if _numeric_match(
numeric_ranges, float(dict_body[field]["Value"])
):
return True
else:
if field not in dict_body:
return False
checks = value
numeric_ranges = zip(checks[0::2], checks[1::2])
if _numeric_match(numeric_ranges, dict_body[field]):
return True
if field == "$or" and isinstance(rules, list):
return any(
FilterPolicyMatcher._attributes_based_match(dict_body, rule)
for rule in rules
)
return False
|