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
|
"""RDS tests covering integrations with other service backends."""
import json
import uuid
import boto3
import pytest
from botocore import waiter, xform_name
from botocore.exceptions import ClientError
from tests import aws_verified
from . import DEFAULT_REGION
@aws_verified
@pytest.mark.aws_verified
def test_db_cluster_managed_master_user_password_lifecycle():
# Clients
kms = boto3.client("kms", region_name=DEFAULT_REGION)
rds = boto3.client("rds", region_name=DEFAULT_REGION)
secretsmanager = boto3.client("secretsmanager", region_name=DEFAULT_REGION)
# Waiters
db_cluster_modifications_complete = get_custom_waiter(
"db_cluster_modifications_complete", rds
)
db_cluster_available = rds.get_waiter("db_cluster_available")
db_cluster_deleted = rds.get_waiter("db_cluster_deleted")
master_user_secret_available = get_custom_waiter(
"db_cluster_master_user_secret_available", rds
)
master_user_secret_deleted = get_custom_waiter("secret_deleted", secretsmanager)
# KMS keys
resp = kms.describe_key(KeyId="alias/aws/secretsmanager")
default_kms_key_arn = resp["KeyMetadata"]["Arn"]
resp = kms.create_key(KeyUsage="ENCRYPT_DECRYPT", KeySpec="SYMMETRIC_DEFAULT")
custom_kms_key_arn = resp["KeyMetadata"]["Arn"]
custom_kms_key_id = resp["KeyMetadata"]["KeyId"]
# Create DBCluster with managed master user password
db_cluster_identifier = "test-" + str(uuid.uuid4())
resp = rds.create_db_cluster(
DBClusterIdentifier=db_cluster_identifier,
Engine="aurora-postgresql",
MasterUsername="root",
ManageMasterUserPassword=True,
)
db_cluster = resp["DBCluster"]
master_user_secret = db_cluster["MasterUserSecret"]
assert master_user_secret["KmsKeyId"] == default_kms_key_arn
assert master_user_secret["SecretStatus"] == "creating"
# Check the secret in SecretsManager
secret_arn = master_user_secret["SecretArn"]
master_user_secret_available.wait(DBClusterIdentifier=db_cluster_identifier)
secret = secretsmanager.describe_secret(SecretId=secret_arn)
assert str(secret["Name"]).startswith("rds!cluster")
assert secret["OwningService"] == "rds"
# Check that RDS sees the secret as active
db_cluster_available.wait(DBClusterIdentifier=db_cluster_identifier)
resp = rds.describe_db_clusters(DBClusterIdentifier=db_cluster_identifier)
db_cluster = resp["DBClusters"][0]
master_user_secret = db_cluster["MasterUserSecret"]
assert master_user_secret["SecretStatus"] == "active"
# Check that managed secret has correct structure
resp = secretsmanager.get_secret_value(SecretId=secret_arn)
secret = json.loads(resp["SecretString"])
assert "username" in secret
assert "password" in secret
# Disable password management
resp = rds.modify_db_cluster(
DBClusterIdentifier=db_cluster_identifier,
ManageMasterUserPassword=False,
MasterUserPassword="Non-Managed-Pa55word!",
ApplyImmediately=True,
)
db_cluster = resp["DBCluster"]
# TODO: This passes on AWS but is not implemented yet in moto
# assert "MasterUserPassword" in db_cluster["PendingModifiedValues"]
db_cluster_modifications_complete.wait(DBClusterIdentifier=db_cluster_identifier)
resp = rds.describe_db_clusters(DBClusterIdentifier=db_cluster_identifier)
db_cluster = resp["DBClusters"][0]
assert "MasterUserSecret" not in db_cluster
# Secret should be deleted
master_user_secret_deleted.wait(SecretId=secret_arn)
with pytest.raises(ClientError) as exc:
secretsmanager.describe_secret(SecretId=secret_arn)
assert exc.value.response["Error"]["Code"] == "ResourceNotFoundException"
# Re-enable password management, this time with a custom KMS key
resp = rds.modify_db_cluster(
DBClusterIdentifier=db_cluster_identifier,
ManageMasterUserPassword=True,
MasterUserSecretKmsKeyId=custom_kms_key_arn,
ApplyImmediately=True,
)
db_cluster = resp["DBCluster"]
# TODO: This passes on AWS but is not implemented yet in moto
# assert "MasterUserPassword" in db_cluster["PendingModifiedValues"]
master_user_secret = db_cluster["MasterUserSecret"]
assert master_user_secret["KmsKeyId"] == custom_kms_key_arn
assert master_user_secret["SecretStatus"] == "creating"
# Check the secret in SecretsManager
secret_arn = master_user_secret["SecretArn"]
master_user_secret_available.wait(DBClusterIdentifier=db_cluster_identifier)
secret = secretsmanager.describe_secret(SecretId=secret_arn)
assert str(secret["Name"]).startswith("rds!cluster")
assert secret["OwningService"] == "rds"
# Check that RDS sees the secret as active
db_cluster_modifications_complete.wait(DBClusterIdentifier=db_cluster_identifier)
resp = rds.describe_db_clusters(DBClusterIdentifier=db_cluster_identifier)
db_cluster = resp["DBClusters"][0]
master_user_secret = db_cluster["MasterUserSecret"]
assert master_user_secret["SecretStatus"] == "active"
# Rotate managed password
resp = rds.modify_db_cluster(
DBClusterIdentifier=db_cluster_identifier,
RotateMasterUserPassword=True,
ApplyImmediately=True,
)
db_cluster = resp["DBCluster"]
master_user_secret = db_cluster["MasterUserSecret"]
assert master_user_secret["SecretStatus"] == "rotating"
# Check that RDS sees the secret as active after rotation
master_user_secret_available.wait(DBClusterIdentifier=db_cluster_identifier)
resp = rds.describe_db_clusters(DBClusterIdentifier=db_cluster_identifier)
db_cluster = resp["DBClusters"][0]
master_user_secret = db_cluster["MasterUserSecret"]
assert master_user_secret["SecretStatus"] == "active"
# Delete the cluster
resp = rds.delete_db_cluster(
DBClusterIdentifier=db_cluster_identifier,
SkipFinalSnapshot=True,
DeleteAutomatedBackups=True,
)
db_cluster = resp["DBCluster"]
assert "MasterUserSecret" in db_cluster
# Deleting the cluster should delete the secret
db_cluster_deleted.wait(DBClusterIdentifier=db_cluster_identifier)
master_user_secret_deleted.wait(SecretId=secret_arn)
with pytest.raises(ClientError) as exc:
secretsmanager.describe_secret(SecretId=secret_arn)
assert exc.value.response["Error"]["Code"] == "ResourceNotFoundException"
# Delete the custom KMS key we created
kms.schedule_key_deletion(KeyId=custom_kms_key_id, PendingWindowInDays=7)
@aws_verified
@pytest.mark.aws_verified
def test_db_instance_managed_master_user_password_lifecycle():
# Clients
kms = boto3.client("kms", region_name=DEFAULT_REGION)
rds = boto3.client("rds", region_name=DEFAULT_REGION)
secretsmanager = boto3.client("secretsmanager", region_name=DEFAULT_REGION)
# Waiters
db_instance_modifications_complete = get_custom_waiter(
"db_instance_modifications_complete", rds
)
db_instance_available = rds.get_waiter("db_instance_available")
db_instance_deleted = rds.get_waiter("db_instance_deleted")
master_user_secret_available = get_custom_waiter(
"db_instance_master_user_secret_available", rds
)
master_user_secret_deleted = get_custom_waiter("secret_deleted", secretsmanager)
# KMS keys
resp = kms.describe_key(KeyId="alias/aws/secretsmanager")
default_kms_key_arn = resp["KeyMetadata"]["Arn"]
resp = kms.create_key(KeyUsage="ENCRYPT_DECRYPT", KeySpec="SYMMETRIC_DEFAULT")
custom_kms_key_arn = resp["KeyMetadata"]["Arn"]
custom_kms_key_id = resp["KeyMetadata"]["KeyId"]
# Create DBInstance with managed master user password
db_instance_identifier = "test-" + str(uuid.uuid4())
resp = rds.create_db_instance(
AllocatedStorage=200,
DBInstanceIdentifier=db_instance_identifier,
DBInstanceClass="db.m7g.large",
Engine="postgres",
MasterUsername="root",
ManageMasterUserPassword=True,
)
db_instance = resp["DBInstance"]
master_user_secret = db_instance["MasterUserSecret"]
assert master_user_secret["KmsKeyId"] == default_kms_key_arn
assert master_user_secret["SecretStatus"] == "creating"
# Check the secret in SecretsManager
secret_arn = master_user_secret["SecretArn"]
master_user_secret_available.wait(DBInstanceIdentifier=db_instance_identifier)
secret = secretsmanager.describe_secret(SecretId=secret_arn)
assert str(secret["Name"]).startswith("rds!db")
assert secret["OwningService"] == "rds"
# Check that RDS sees the secret as active
db_instance_available.wait(DBInstanceIdentifier=db_instance_identifier)
resp = rds.describe_db_instances(DBInstanceIdentifier=db_instance_identifier)
db_instance = resp["DBInstances"][0]
master_user_secret = db_instance["MasterUserSecret"]
assert master_user_secret["SecretStatus"] == "active"
# Check that managed secret has correct structure
resp = secretsmanager.get_secret_value(SecretId=secret_arn)
secret = json.loads(resp["SecretString"])
assert "username" in secret
assert "password" in secret
# Disable password management
resp = rds.modify_db_instance(
DBInstanceIdentifier=db_instance_identifier,
ManageMasterUserPassword=False,
MasterUserPassword="Non-Managed-Pa55word!",
ApplyImmediately=True,
)
db_instance = resp["DBInstance"]
# TODO: This passes on AWS but is not implemented yet in moto
# assert "MasterUserPassword" in db_cluster["PendingModifiedValues"]
db_instance_modifications_complete.wait(DBInstanceIdentifier=db_instance_identifier)
resp = rds.describe_db_instances(DBInstanceIdentifier=db_instance_identifier)
db_instance = resp["DBInstances"][0]
assert "MasterUserSecret" not in db_instance
# Secret should be deleted
master_user_secret_deleted.wait(SecretId=secret_arn)
with pytest.raises(ClientError) as exc:
secretsmanager.describe_secret(SecretId=secret_arn)
assert exc.value.response["Error"]["Code"] == "ResourceNotFoundException"
# Re-enable password management, this time with a custom KMS key
resp = rds.modify_db_instance(
DBInstanceIdentifier=db_instance_identifier,
ManageMasterUserPassword=True,
MasterUserSecretKmsKeyId=custom_kms_key_arn,
ApplyImmediately=True,
)
db_instance = resp["DBInstance"]
# TODO: This passes on AWS but not implemented yet in moto
# assert "MasterUserPassword" in db_cluster["PendingModifiedValues"]
master_user_secret = db_instance["MasterUserSecret"]
assert master_user_secret["KmsKeyId"] == custom_kms_key_arn
assert master_user_secret["SecretStatus"] == "creating"
# Check the secret in SecretsManager
secret_arn = master_user_secret["SecretArn"]
master_user_secret_available.wait(DBInstanceIdentifier=db_instance_identifier)
secret = secretsmanager.describe_secret(SecretId=secret_arn)
assert str(secret["Name"]).startswith("rds!db")
assert secret["OwningService"] == "rds"
# Check that RDS sees the secret as active
db_instance_modifications_complete.wait(DBInstanceIdentifier=db_instance_identifier)
resp = rds.describe_db_instances(DBInstanceIdentifier=db_instance_identifier)
db_instance = resp["DBInstances"][0]
master_user_secret = db_instance["MasterUserSecret"]
assert master_user_secret["SecretStatus"] == "active"
# Rotate managed password
resp = rds.modify_db_instance(
DBInstanceIdentifier=db_instance_identifier,
RotateMasterUserPassword=True,
ApplyImmediately=True,
)
db_instance = resp["DBInstance"]
master_user_secret = db_instance["MasterUserSecret"]
assert master_user_secret["SecretStatus"] == "rotating"
# Check that RDS sees the secret as active after rotation
master_user_secret_available.wait(DBInstanceIdentifier=db_instance_identifier)
resp = rds.describe_db_instances(DBInstanceIdentifier=db_instance_identifier)
db_instance = resp["DBInstances"][0]
master_user_secret = db_instance["MasterUserSecret"]
assert master_user_secret["SecretStatus"] == "active"
# Delete the instance
resp = rds.delete_db_instance(
DBInstanceIdentifier=db_instance_identifier,
SkipFinalSnapshot=True,
DeleteAutomatedBackups=True,
)
db_instance = resp["DBInstance"]
assert "MasterUserSecret" in db_instance
# Deleting the instance should delete the secret
db_instance_deleted.wait(DBInstanceIdentifier=db_instance_identifier)
master_user_secret_deleted.wait(SecretId=secret_arn)
with pytest.raises(ClientError) as exc:
secretsmanager.describe_secret(SecretId=secret_arn)
assert exc.value.response["Error"]["Code"] == "ResourceNotFoundException"
# Delete the custom KMS key we created
kms.schedule_key_deletion(KeyId=custom_kms_key_id, PendingWindowInDays=7)
def get_custom_waiter(waiter_name, client):
"""Some useful waiters that are not present in botocore."""
config = {
"version": 2,
"waiters": {
"DBClusterModificationsComplete": {
"delay": 15,
"operation": "DescribeDBClusters",
"maxAttempts": 60,
"acceptors": [
{
"state": "success",
"matcher": "path",
"argument": "contains(keys(DBClusters[0]), 'PendingModifiedValues') && length(DBClusters[0].PendingModifiedValues) == `0`",
"expected": True,
},
{
"state": "success",
"matcher": "path",
"argument": "contains(keys(DBClusters[0]), 'PendingModifiedValues')",
"expected": False,
},
],
},
"DBClusterMasterUserSecretAvailable": {
"delay": 15,
"operation": "DescribeDBClusters",
"maxAttempts": 60,
"acceptors": [
{
"expected": "active",
"matcher": "pathAll",
"state": "success",
"argument": "DBClusters[].MasterUserSecret.SecretStatus",
},
],
},
"DBInstanceModificationsComplete": {
"delay": 15,
"operation": "DescribeDBInstances",
"maxAttempts": 60,
"acceptors": [
{
"state": "success",
"matcher": "path",
"argument": "contains(keys(DBInstances[0]), 'PendingModifiedValues') && length(DBInstances[0].PendingModifiedValues) == `0`",
"expected": True,
},
{
"state": "success",
"matcher": "path",
"argument": "contains(keys(DBInstances[0]), 'PendingModifiedValues')",
"expected": False,
},
],
},
"DBInstanceMasterUserSecretAvailable": {
"delay": 15,
"operation": "DescribeDBInstances",
"maxAttempts": 60,
"acceptors": [
{
"expected": "active",
"matcher": "pathAll",
"state": "success",
"argument": "DBInstances[].MasterUserSecret.SecretStatus",
},
],
},
"SecretDeleted": {
"delay": 15,
"operation": "DescribeSecret",
"maxAttempts": 60,
"acceptors": [
{
"expected": "ResourceNotFoundException",
"matcher": "error",
"state": "success",
},
],
},
},
}
model = waiter.WaiterModel(config)
mapping = {}
for name in model.waiter_names:
mapping[xform_name(name)] = name
return waiter.create_waiter_with_client(mapping[waiter_name], model, client)
|
