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
|
"""
This module confirms that signing using KMS keys works.
The purpose is to do a smoke test, not to exhaustively test every possible
key and environment combination.
For Google Cloud (GCP), the requirements to successfully test are:
* Google Cloud authentication details have to be available in the environment
* The key defined in the test has to be available to the authenticated user
NOTE: the filename is purposefully check_ rather than test_ so that tests are
only run when explicitly invoked: The tests can only pass on Securesystemslib
GitHub Action environment because of the above requirements.
"""
import unittest
from securesystemslib.exceptions import UnverifiedSignatureError
from securesystemslib.signer import GCPSigner, Key, Signer
class TestKMSKeys(unittest.TestCase):
"""Test that KMS keys can be used to sign."""
pubkey = Key.from_dict(
"ab45d8d98992a4128efaea284c7ef0459557db199aeadf237ae41b915b9b5a1c",
{
"keytype": "ecdsa",
"scheme": "ecdsa-sha2-nistp256",
"keyval": {
"public": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE/ptvrXYuUc2ZaKssHhtg/IKNbO1X\ncDWlbKqLNpaK62MKdOwDz1qlp5AGHZkTY9tO09iq1F16SvVot1BQ9FJ2dw==\n-----END PUBLIC KEY-----\n"
},
},
)
gcp_id = "projects/python-tuf-kms/locations/global/keyRings/securesystemslib-tests/cryptoKeys/ecdsa-sha2-nistp256/cryptoKeyVersions/1"
def test_gcp_sign(self):
"""Test that GCP KMS key works for signing
NOTE: The KMS account is setup to only accept requests from the
Securesystemslib GitHub Action environment: test cannot pass elsewhere.
In case of problems with KMS account, please file an issue and
assign @jku.
"""
data = b"data"
signer = Signer.from_priv_key_uri(f"gcpkms:{self.gcp_id}", self.pubkey)
sig = signer.sign(data)
self.pubkey.verify_signature(sig, data)
with self.assertRaises(UnverifiedSignatureError):
self.pubkey.verify_signature(sig, b"NOT DATA")
def test_gcp_import(self):
"""Test that GCP KMS key can be imported
NOTE: The KMS account is setup to only accept requests from the
Securesystemslib GitHub Action environment: test cannot pass elsewhere.
In case of problems with KMS account, please file an issue and
assign @jku.
"""
uri, key = GCPSigner.import_(self.gcp_id)
self.assertEqual(key, self.pubkey)
self.assertEqual(uri, f"gcpkms:{self.gcp_id}")
if __name__ == "__main__":
unittest.main(verbosity=1, buffer=True)
|