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 544 545 546 547 548 549 550 551 552 553 554 555 556 557
|
from datetime import datetime
from uuid import uuid4
import boto3
import pytest
from botocore.exceptions import ClientError
from dateutil.tz import tzlocal
from moto import mock_aws
from moto.secretsmanager.list_secrets.filters import split_words
from tests import aws_verified
def boto_client():
return boto3.client("secretsmanager", region_name="us-west-2")
@mock_aws
def test_empty():
conn = boto_client()
secrets = conn.list_secrets()
assert secrets["SecretList"] == []
@mock_aws
def test_list_secrets():
conn = boto_client()
conn.create_secret(Name="test-secret", SecretString="foosecret")
conn.create_secret(
Name="test-secret-2",
SecretString="barsecret",
Tags=[{"Key": "a", "Value": "1"}],
)
secrets = conn.list_secrets()
assert secrets["SecretList"][0]["ARN"] is not None
assert secrets["SecretList"][0]["Name"] == "test-secret"
assert secrets["SecretList"][0]["SecretVersionsToStages"] is not None
assert secrets["SecretList"][1]["ARN"] is not None
assert secrets["SecretList"][1]["Name"] == "test-secret-2"
assert secrets["SecretList"][1]["Tags"] == [{"Key": "a", "Value": "1"}]
assert secrets["SecretList"][1]["SecretVersionsToStages"] is not None
assert secrets["SecretList"][0]["CreatedDate"] <= datetime.now(tz=tzlocal())
assert secrets["SecretList"][1]["CreatedDate"] <= datetime.now(tz=tzlocal())
assert secrets["SecretList"][0]["LastChangedDate"] <= datetime.now(tz=tzlocal())
assert secrets["SecretList"][1]["LastChangedDate"] <= datetime.now(tz=tzlocal())
@mock_aws
def test_with_name_filter():
conn = boto_client()
conn.create_secret(Name="foo", SecretString="secret")
conn.create_secret(Name="bar", SecretString="secret")
secrets = conn.list_secrets(Filters=[{"Key": "name", "Values": ["foo"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == ["foo"]
@mock_aws
def test_with_tag_key_filter():
conn = boto_client()
conn.create_secret(
Name="foo", SecretString="secret", Tags=[{"Key": "baz", "Value": "1"}]
)
conn.create_secret(Name="bar", SecretString="secret")
secrets = conn.list_secrets(Filters=[{"Key": "tag-key", "Values": ["baz"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == ["foo"]
@mock_aws
def test_with_tag_value_filter():
conn = boto_client()
conn.create_secret(
Name="foo", SecretString="secret", Tags=[{"Key": "1", "Value": "baz"}]
)
conn.create_secret(Name="bar", SecretString="secret")
secrets = conn.list_secrets(Filters=[{"Key": "tag-value", "Values": ["baz"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == ["foo"]
@mock_aws
def test_with_description_filter():
conn = boto_client()
conn.create_secret(Name="foo", SecretString="secret", Description="baz qux")
conn.create_secret(Name="bar", SecretString="secret")
secrets = conn.list_secrets(Filters=[{"Key": "description", "Values": ["baz"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == ["foo"]
@aws_verified
# Verified, but not marked because it's flaky - AWS can take up to 5 minutes before secrets are listed
def test_with_all_filter():
# The 'all' filter will match a secret that contains ANY field with
# the criteria. In other words an implicit OR.
unique_name = str(uuid4())[0:6]
first_secret = f"SecretOne{unique_name}"
second_secret = f"SecretTwo{unique_name}"
third_secret = f"Thirdsecret{unique_name}"
foo_tag_key = f"SecretFTag{unique_name}"
foo_tag_val = f"SecretFValue{unique_name}"
no_match = f"none{unique_name}"
conn = boto_client()
conn.create_secret(Name=first_secret, SecretString="s")
conn.create_secret(Name=second_secret, SecretString="s", Description="DescTwo")
conn.create_secret(Name=third_secret, SecretString="s")
conn.create_secret(
Name=foo_tag_key, SecretString="s", Tags=[{"Key": "1", "Value": "foo"}]
)
conn.create_secret(
Name=foo_tag_val, SecretString="s", Tags=[{"Key": "foo", "Value": "v"}]
)
conn.create_secret(Name=no_match, SecretString="s")
try:
# Full Match
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["SecretOne"]}])[
"SecretList"
]
secret_names = [s["Name"] for s in secrets]
assert secret_names == [first_secret]
# Search in tags
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["foo"]}])[
"SecretList"
]
secret_names = [s["Name"] for s in secrets]
assert secret_names == [foo_tag_key, foo_tag_val]
# StartsWith - full word
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["Secret"]}])[
"SecretList"
]
secret_names = [s["Name"] for s in secrets]
assert secret_names == [first_secret, second_secret, foo_tag_key, foo_tag_val]
# Partial Match - full word - lowercase
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["secret"]}])[
"SecretList"
]
secret_names = [s["Name"] for s in secrets]
assert secret_names == [first_secret, second_secret, foo_tag_key, foo_tag_val]
# Partial Match - partial word
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["ret"]}])[
"SecretList"
]
secret_names = [s["Name"] for s in secrets]
assert not secret_names
# Partial Match - partial word
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["sec"]}])[
"SecretList"
]
secret_names = [s["Name"] for s in secrets]
assert secret_names == [first_secret, second_secret, foo_tag_key, foo_tag_val]
# Unknown Match
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["SomeSecret"]}])[
"SecretList"
]
assert not secrets
# Single value
# Only matches description that contains a d
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["d"]}])[
"SecretList"
]
secret_names = [s["Name"] for s in secrets]
assert secret_names == [second_secret]
# Multiple values
# Only matches description that contains a d and t (DescTwo)
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["d t"]}])[
"SecretList"
]
secret_names = [s["Name"] for s in secrets]
assert secret_names == [second_secret]
# Name parts that start with a t (DescTwo)
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["t"]}])[
"SecretList"
]
secret_names = [s["Name"] for s in secrets]
assert secret_names == [second_secret, third_secret, foo_tag_key]
finally:
conn.delete_secret(SecretId=first_secret, ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId=second_secret, ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId=third_secret, ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId=foo_tag_key, ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId=foo_tag_val, ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId=no_match, ForceDeleteWithoutRecovery=True)
@aws_verified
# Verified, but not marked because it's flaky - AWS can take up to 5 minutes before secrets are listed
def test_with_all_filter_special_characters():
unique_name = str(uuid4())[0:6]
secret_with_slash = f"prod/AppBeta/{unique_name}"
secret_with_under = f"prod_AppBeta_{unique_name}"
secret_with_plus = f"prod+AppBeta+{unique_name}"
secret_with_equal = f"prod=AppBeta={unique_name}"
secret_with_dot = f"prod.AppBeta.{unique_name}"
secret_with_at = f"prod@AppBeta@{unique_name}"
secret_with_dash = f"prod-AppBeta-{unique_name}"
# Note that this secret is never found, because the pattern is unknown
secret_with_dash_and_slash = f"prod-AppBeta/{unique_name}"
full_uppercase = f"uat/COMPANY/{unique_name}"
partial_uppercase = f"uat/COMPANYthings/{unique_name}"
all_special_char_names = [
secret_with_slash,
secret_with_under,
secret_with_plus,
secret_with_equal,
secret_with_dot,
secret_with_at,
secret_with_dash,
]
conn = boto_client()
conn.create_secret(Name=secret_with_slash, SecretString="s")
conn.create_secret(Name=secret_with_under, SecretString="s")
conn.create_secret(Name=secret_with_plus, SecretString="s")
conn.create_secret(Name=secret_with_equal, SecretString="s")
conn.create_secret(Name=secret_with_dot, SecretString="s")
conn.create_secret(Name=secret_with_at, SecretString="s")
conn.create_secret(Name=secret_with_dash, SecretString="s")
conn.create_secret(Name=full_uppercase, SecretString="s")
conn.create_secret(Name=partial_uppercase, SecretString="s")
try:
# Partial Match
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["AppBeta"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == all_special_char_names
# Partial Match
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["Beta"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == all_special_char_names
secrets = conn.list_secrets(
Filters=[{"Key": "all", "Values": ["AppBeta", "prod"]}]
)["SecretList"]
secret_names = [s["Name"] for s in secrets]
assert secret_names == all_special_char_names
# Search for special character itself
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["+"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert not secret_names
# Search for unique postfix
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": [unique_name]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == (
all_special_char_names + [full_uppercase, partial_uppercase]
)
# Search for unique postfix
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["company"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == [full_uppercase]
# This on it's own is not a word
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["things"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == []
# This is valid, because it's split as COMPAN + Ythings
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["Ythings"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == [partial_uppercase]
# Note that individual letters from COMPANY are not searchable,
# indicating that AWS splits by terms, rather than each individual upper case
# COMPANYThings --> COMPAN, YThings
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["N"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == []
#
secrets = conn.list_secrets(Filters=[{"Key": "all", "Values": ["pany"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == []
finally:
conn.delete_secret(SecretId=secret_with_slash, ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId=secret_with_under, ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId=secret_with_plus, ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId=secret_with_equal, ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId=secret_with_dot, ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId=secret_with_dash, ForceDeleteWithoutRecovery=True)
conn.delete_secret(
SecretId=secret_with_dash_and_slash, ForceDeleteWithoutRecovery=True
)
conn.delete_secret(SecretId=secret_with_at, ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId=full_uppercase, ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId=partial_uppercase, ForceDeleteWithoutRecovery=True)
@mock_aws
def test_with_no_filter_key():
conn = boto_client()
with pytest.raises(ClientError) as ire:
conn.list_secrets(Filters=[{"Values": ["foo"]}])
assert ire.value.response["Error"]["Code"] == "InvalidParameterException"
assert ire.value.response["Error"]["Message"] == "Invalid filter key"
@mock_aws
def test_with_no_filter_values():
conn = boto_client()
conn.create_secret(Name="foo", SecretString="secret", Description="hello")
with pytest.raises(ClientError) as ire:
conn.list_secrets(Filters=[{"Key": "description"}])
assert ire.value.response["Error"]["Code"] == "InvalidParameterException"
assert ire.value.response["Error"]["Message"] == (
"Invalid filter values for key: description"
)
@mock_aws
def test_with_invalid_filter_key():
conn = boto_client()
with pytest.raises(ClientError) as ire:
conn.list_secrets(Filters=[{"Key": "invalid", "Values": ["foo"]}])
assert ire.value.response["Error"]["Code"] == "ValidationException"
assert ire.value.response["Error"]["Message"] == (
"1 validation error detected: Value 'invalid' at "
"'filters.1.member.key' failed to satisfy constraint: Member "
"must satisfy enum value set: [all, name, tag-key, description, tag-value]"
)
@aws_verified
# Verified, but not marked because it's flaky - AWS can take up to 5 minutes before secrets are listed
def test_with_duplicate_filter_keys():
# Multiple filters with the same key combine with an implicit AND operator
conn = boto_client()
conn.create_secret(Name="foo", SecretString="secret", Description="one two")
conn.create_secret(Name="bar", SecretString="secret", Description="one")
conn.create_secret(Name="baz", SecretString="secret", Description="two")
conn.create_secret(Name="qux", SecretString="secret", Description="unrelated")
try:
secrets = conn.list_secrets(
Filters=[
{"Key": "description", "Values": ["one"]},
{"Key": "description", "Values": ["two"]},
]
)
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == ["foo"]
finally:
conn.delete_secret(SecretId="foo", ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId="bar", ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId="baz", ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId="qux", ForceDeleteWithoutRecovery=True)
@mock_aws
def test_with_multiple_filters():
# Multiple filters combine with an implicit AND operator
conn = boto_client()
conn.create_secret(
Name="foo", SecretString="secret", Tags=[{"Key": "right", "Value": "right"}]
)
conn.create_secret(
Name="bar", SecretString="secret", Tags=[{"Key": "right", "Value": "wrong"}]
)
conn.create_secret(
Name="baz", SecretString="secret", Tags=[{"Key": "wrong", "Value": "right"}]
)
conn.create_secret(
Name="qux", SecretString="secret", Tags=[{"Key": "wrong", "Value": "wrong"}]
)
secrets = conn.list_secrets(
Filters=[
{"Key": "tag-key", "Values": ["right"]},
{"Key": "tag-value", "Values": ["right"]},
]
)
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == ["foo"]
@mock_aws
def test_with_filter_with_multiple_values():
conn = boto_client()
conn.create_secret(Name="foo", SecretString="secret")
conn.create_secret(Name="bar", SecretString="secret")
conn.create_secret(Name="baz", SecretString="secret")
secrets = conn.list_secrets(Filters=[{"Key": "name", "Values": ["foo", "bar"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == ["foo", "bar"]
@aws_verified
# Verified, but not marked because it's flaky - AWS can take up to 5 minutes before secrets are listed
def test_with_filter_with_value_with_multiple_words():
conn = boto_client()
conn.create_secret(Name="foo", SecretString="secret", Description="one two")
conn.create_secret(Name="bar", SecretString="secret", Description="one and two")
conn.create_secret(Name="baz", SecretString="secret", Description="one")
conn.create_secret(Name="qux", SecretString="secret", Description="two")
conn.create_secret(Name="none", SecretString="secret", Description="unrelated")
try:
# All values that contain one and two
secrets = conn.list_secrets(
Filters=[{"Key": "description", "Values": ["one two"]}]
)
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == ["foo", "bar"]
# All values that start with o and t
secrets = conn.list_secrets(Filters=[{"Key": "description", "Values": ["o t"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == ["foo", "bar"]
# All values that contain t
secrets = conn.list_secrets(Filters=[{"Key": "description", "Values": ["t"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
assert secret_names == ["foo", "bar", "qux"]
finally:
conn.delete_secret(SecretId="foo", ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId="bar", ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId="baz", ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId="qux", ForceDeleteWithoutRecovery=True)
conn.delete_secret(SecretId="none", ForceDeleteWithoutRecovery=True)
@mock_aws
def test_with_filter_with_negation():
conn = boto_client()
conn.create_secret(Name="foo", SecretString="secret", Description="one two")
conn.create_secret(Name="bar", SecretString="secret", Description="one and two")
conn.create_secret(Name="baz", SecretString="secret", Description="one")
conn.create_secret(Name="qux", SecretString="secret", Description="two")
conn.create_secret(Name="none", SecretString="secret", Description="unrelated")
secrets = conn.list_secrets(
Filters=[{"Key": "description", "Values": ["one", "!two"]}]
)
secret_names = [s["Name"] for s in secrets["SecretList"]]
for secret_name in ["foo", "bar", "baz"]:
assert secret_name in secret_names
secrets = conn.list_secrets(Filters=[{"Key": "description", "Values": ["!o"]}])
secret_names = [s["Name"] for s in secrets["SecretList"]]
for secret_name in ["qux", "none"]:
assert secret_name in secret_names
@mock_aws
def test_filter_with_owning_service():
conn = boto3.client("secretsmanager", region_name="us-west-2")
conn.create_secret(Name="foo", SecretString="secret")
resp = conn.list_secrets(Filters=[{"Key": "owning-service", "Values": ["n/a"]}])
assert resp["SecretList"] == []
@mock_aws
def test_with_include_planned_deleted_secrets():
conn = boto_client()
conn.create_secret(Name="foo", SecretString="secret")
conn.create_secret(Name="bar", SecretString="secret")
secrets = conn.list_secrets()
assert len(secrets["SecretList"]) == 2
conn.delete_secret(SecretId="foo")
# By default list secrets doesn't include deleted secrets
secrets = conn.list_secrets()
assert len(secrets["SecretList"]) == 1
assert secrets["SecretList"][0]["ARN"] is not None
assert secrets["SecretList"][0]["Name"] == "bar"
assert secrets["SecretList"][0]["SecretVersionsToStages"] is not None
# list secrets when IncludePlannedDeletion param included
secrets = conn.list_secrets(IncludePlannedDeletion=True)
assert len(secrets["SecretList"]) == 2
# list secret with filter and IncludePlannedDeletion params
secrets = conn.list_secrets(
IncludePlannedDeletion=True, Filters=[{"Key": "name", "Values": ["foo"]}]
)
assert len(secrets["SecretList"]) == 1
assert secrets["SecretList"][0]["ARN"] is not None
assert secrets["SecretList"][0]["Name"] == "foo"
assert secrets["SecretList"][0]["SecretVersionsToStages"] is not None
@pytest.mark.parametrize(
"input,output",
[
("test", ["test"]),
("my test", ["my", "test"]),
("Mytest", ["Mytest"]),
("MyTest", ["My", "Test"]),
("MyTestPhrase", ["My", "Test", "Phrase"]),
("myTest", ["my", "Test"]),
("my test", ["my", "test"]),
("my/test", ["my", "test"]),
],
)
def test_word_splitter(input, output):
assert split_words(input) == output
|