Skip to content

Fix KeyId return value as ARN for "generate_data_key*" methods #8302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 11, 2023
Merged

Fix KeyId return value as ARN for "generate_data_key*" methods #8302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions localstack/services/kms/provider.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -536,7 +536,7 @@ def _generate_data_key_pair(self, key_id: str, key_pair_spec: str, context: Requ
self._validate_key_for_encryption_decryption(context, key)
crypto_key = KmsCryptoKey(key_pair_spec)
return {
"KeyId": key_id,
"KeyId": key.metadata["Arn"],
"KeyPairSpec": key_pair_spec,
"PrivateKeyCiphertextBlob": key.encrypt(crypto_key.private_key),
"PrivateKeyPlaintext": crypto_key.private_key,
Expand Down Expand Up @@ -598,7 +598,7 @@ def _generate_data_key(self, key_id: str, context: RequestContext):
self._validate_key_for_encryption_decryption(context, key)
crypto_key = KmsCryptoKey("SYMMETRIC_DEFAULT")
return {
"KeyId": key_id,
"KeyId": key.metadata["Arn"],
"Plaintext": crypto_key.key_material,
"CiphertextBlob": key.encrypt(crypto_key.key_material),
}
Expand Down
126 changes: 75 additions & 51 deletions tests/integration/test_kms.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@
from localstack.utils.strings import short_uid, to_str


@pytest.fixture(autouse=True)
def kms_api_snapshot_transformer(snapshot):
snapshot.add_transformer(snapshot.transform.kms_api())


@pytest.fixture(scope="class")
def kms_client_for_region(aws_client_factory):
def _kms_client(
Expand Down Expand Up @@ -66,6 +61,10 @@ def _get_alias(kms_client, alias_name, key_id=None):


class TestKMS:
@pytest.fixture(autouse=True)
def kms_api_snapshot_transformer(self, snapshot):
snapshot.add_transformer(snapshot.transform.kms_api())

@pytest.fixture(scope="class")
def user_arn(self, aws_client):
return aws_client.sts.get_caller_identity()["Arn"]
Expand Down Expand Up @@ -367,30 +366,6 @@ def test_list_retirable_grants(self, kms_create_key, kms_create_grant, aws_clien
assert right_grant_found
assert not wrong_grant_found

@pytest.mark.aws_validated
def test_generate_data_key_pair_without_plaintext(self, kms_key, aws_client):
key_id = kms_key["KeyId"]
result = aws_client.kms.generate_data_key_pair_without_plaintext(
KeyId=key_id, KeyPairSpec="RSA_2048"
)
assert result.get("PrivateKeyCiphertextBlob")
assert "PrivateKeyPlaintext" not in result
assert result.get("PublicKey")

@pytest.mark.aws_validated
def test_generate_data_key_pair(self, kms_key, aws_client):
key_id = kms_key["KeyId"]
result = aws_client.kms.generate_data_key_pair(KeyId=key_id, KeyPairSpec="RSA_2048")
assert result.get("PrivateKeyCiphertextBlob")
assert result.get("PrivateKeyPlaintext")
assert result.get("PublicKey")

# assert correct value of encrypted key
decrypted = aws_client.kms.decrypt(
CiphertextBlob=result["PrivateKeyCiphertextBlob"], KeyId=key_id
)
assert decrypted["Plaintext"] == result["PrivateKeyPlaintext"]

@pytest.mark.parametrize("number_of_bytes", [12, 44, 91, 1, 1024])
@pytest.mark.aws_validated
def test_generate_random(self, snapshot, number_of_bytes, aws_client):
Expand All @@ -415,28 +390,6 @@ def test_generate_random_invalid_number_of_bytes(

snapshot.match("generate-random-exc", e.value.response)

@pytest.mark.aws_validated
def test_generate_data_key(self, kms_key, aws_client):
key_id = kms_key["KeyId"]
# LocalStack currently doesn't act on KeySpec or on NumberOfBytes params, but one of them has to be set.
result = aws_client.kms.generate_data_key(KeyId=key_id, KeySpec="AES_256")
assert result.get("CiphertextBlob")
assert result.get("Plaintext")
assert result.get("KeyId")

# assert correct value of encrypted key
decrypted = aws_client.kms.decrypt(CiphertextBlob=result["CiphertextBlob"], KeyId=key_id)
assert decrypted["Plaintext"] == result["Plaintext"]

@pytest.mark.aws_validated
def test_generate_data_key_without_plaintext(self, kms_key, aws_client):
key_id = kms_key["KeyId"]
# LocalStack currently doesn't act on KeySpec or on NumberOfBytes params, but one of them has to be set.
result = aws_client.kms.generate_data_key_without_plaintext(KeyId=key_id, KeySpec="AES_256")
assert result.get("CiphertextBlob")
assert "Plaintext" not in result
assert result.get("KeyId")

@pytest.mark.aws_validated
@pytest.mark.skip_snapshot_verify(
paths=[
Expand Down Expand Up @@ -1222,3 +1175,74 @@ def test_cross_accounts_access(self, aws_client, aws_client_factory, kms_create_
assert client.verify_mac(
KeyId=key_arn_3, Message=message, MacAlgorithm="HMAC_SHA_512", Mac=mac
)["MacValid"]


class TestKMSGenerateKeys:
@pytest.fixture(autouse=True)
def generate_key_transformers(self, snapshot):
snapshot.add_transformer(snapshot.transform.resource_name())

@pytest.mark.aws_validated
def test_generate_data_key_pair_without_plaintext(self, kms_key, aws_client, snapshot):
snapshot.add_transformer(
snapshot.transform.key_value("PrivateKeyCiphertextBlob", reference_replacement=False)
)
snapshot.add_transformer(
snapshot.transform.key_value("PublicKey", reference_replacement=False)
)

key_id = kms_key["KeyId"]
result = aws_client.kms.generate_data_key_pair_without_plaintext(
KeyId=key_id, KeyPairSpec="RSA_2048"
)
snapshot.match("generate-data-key-pair-without-plaintext", result)

@pytest.mark.aws_validated
def test_generate_data_key_pair(self, kms_key, aws_client, snapshot):
snapshot.add_transformer(
snapshot.transform.key_value("PrivateKeyCiphertextBlob", reference_replacement=False)
)
snapshot.add_transformer(
snapshot.transform.key_value("PrivateKeyPlaintext", reference_replacement=False)
)
snapshot.add_transformer(
snapshot.transform.key_value("PublicKey", reference_replacement=False)
)

key_id = kms_key["KeyId"]
result = aws_client.kms.generate_data_key_pair(KeyId=key_id, KeyPairSpec="RSA_2048")
snapshot.match("generate-data-key-pair", result)

# assert correct value of encrypted key
decrypted = aws_client.kms.decrypt(
CiphertextBlob=result["PrivateKeyCiphertextBlob"], KeyId=key_id
)
assert decrypted["Plaintext"] == result["PrivateKeyPlaintext"]

@pytest.mark.aws_validated
def test_generate_data_key(self, kms_key, aws_client, snapshot):
snapshot.add_transformer(
snapshot.transform.key_value("CiphertextBlob", reference_replacement=False)
)
snapshot.add_transformer(
snapshot.transform.key_value("Plaintext", reference_replacement=False)
)

key_id = kms_key["KeyId"]
# LocalStack currently doesn't act on KeySpec or on NumberOfBytes params, but one of them has to be set.
result = aws_client.kms.generate_data_key(KeyId=key_id, KeySpec="AES_256")
snapshot.match("generate-data-key-result", result)

# assert correct value of encrypted key
decrypted = aws_client.kms.decrypt(CiphertextBlob=result["CiphertextBlob"], KeyId=key_id)
assert decrypted["Plaintext"] == result["Plaintext"]

@pytest.mark.aws_validated
def test_generate_data_key_without_plaintext(self, kms_key, aws_client, snapshot):
snapshot.add_transformer(
snapshot.transform.key_value("CiphertextBlob", reference_replacement=False)
)
key_id = kms_key["KeyId"]
# LocalStack currently doesn't act on KeySpec or on NumberOfBytes params, but one of them has to be set.
result = aws_client.kms.generate_data_key_without_plaintext(KeyId=key_id, KeySpec="AES_256")
snapshot.match("generate-data-key-without-plaintext", result)
58 changes: 58 additions & 0 deletions tests/integration/test_kms.snapshot.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1409,5 +1409,63 @@
}
}
}
},
"tests/integration/test_kms.py::TestKMSGenerateKeys::test_generate_data_key_pair_without_plaintext": {
"recorded-date": "11-05-2023, 14:40:23",
"recorded-content": {
"generate-data-key-pair-without-plaintext": {
"KeyId": "arn:aws:kms:<region>:111111111111:key/<resource:1>",
"KeyPairSpec": "RSA_2048",
"PrivateKeyCiphertextBlob": "private-key-ciphertext-blob",
"PublicKey": "public-key",
"ResponseMetadata": {
"HTTPHeaders": {},
"HTTPStatusCode": 200
}
}
}
},
"tests/integration/test_kms.py::TestKMSGenerateKeys::test_generate_data_key_pair": {
"recorded-date": "11-05-2023, 14:40:23",
"recorded-content": {
"generate-data-key-pair": {
"KeyId": "arn:aws:kms:<region>:111111111111:key/<resource:1>",
"KeyPairSpec": "RSA_2048",
"PrivateKeyCiphertextBlob": "private-key-ciphertext-blob",
"PrivateKeyPlaintext": "private-key-plaintext",
"PublicKey": "public-key",
"ResponseMetadata": {
"HTTPHeaders": {},
"HTTPStatusCode": 200
}
}
}
},
"tests/integration/test_kms.py::TestKMSGenerateKeys::test_generate_data_key": {
"recorded-date": "11-05-2023, 14:40:24",
"recorded-content": {
"generate-data-key-result": {
"CiphertextBlob": "ciphertext-blob",
"KeyId": "arn:aws:kms:<region>:111111111111:key/<resource:1>",
"Plaintext": "plaintext",
"ResponseMetadata": {
"HTTPHeaders": {},
"HTTPStatusCode": 200
}
}
}
},
"tests/integration/test_kms.py::TestKMSGenerateKeys::test_generate_data_key_without_plaintext": {
"recorded-date": "11-05-2023, 14:40:24",
"recorded-content": {
"generate-data-key-without-plaintext": {
"CiphertextBlob": "ciphertext-blob",
"KeyId": "arn:aws:kms:<region>:111111111111:key/<resource:1>",
"ResponseMetadata": {
"HTTPHeaders": {},
"HTTPStatusCode": 200
}
}
}
}
}