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
|
from unittest import TestCase
from joserfc import jws
from joserfc.jwk import (
guess_key,
import_key,
generate_key,
thumbprint_uri,
)
from joserfc.jwk import KeySet, OctKey, RSAKey, ECKey, OKPKey
from joserfc.errors import (
UnsupportedKeyAlgorithmError,
UnsupportedKeyUseError,
UnsupportedKeyOperationError,
InvalidKeyTypeError,
MissingKeyTypeError,
InvalidKeyIdError,
)
from tests.keys import read_key
class Guest:
def __init__(self):
self._headers = {"alg": "HS256"}
def headers(self):
return self._headers
def set_kid(self, kid):
self._headers["kid"] = kid
class TestKeyMethods(TestCase):
def test_guess_callable_key(self):
oct_key = OctKey.generate_key(parameters={"kid": "1"})
rsa_key = RSAKey.generate_key(parameters={"kid": "2"})
def rsa_key_func(obj):
return rsa_key
def key_set_func(obj):
return KeySet([oct_key, rsa_key])
key = guess_key(rsa_key_func, Guest())
self.assertIsInstance(key, RSAKey)
guest = Guest()
guest.set_kid("2")
key = guess_key(key_set_func, guest)
self.assertIsInstance(key, RSAKey)
def test_guess_key_set(self):
key_set = KeySet([OctKey.generate_key(), RSAKey.generate_key()])
guest = Guest()
guest._headers["alg"] = "HS256"
self.assertRaises(InvalidKeyIdError, guess_key, key_set, guest)
key1 = guess_key(key_set, guest, True)
self.assertIsInstance(key1, OctKey)
guess_key(key_set, guest)
guest = Guest()
guest._headers["alg"] = "RS256"
self.assertRaises(InvalidKeyIdError, guess_key, key_set, guest)
key2 = guess_key(key_set, guest, True)
self.assertIsInstance(key2, RSAKey)
guest = Guest()
guest._headers["alg"] = "ES256"
self.assertRaises(ValueError, guess_key, key_set, guest, True)
def test_invalid_key(self):
self.assertRaises(ValueError, guess_key, {}, Guest())
def test_import_key(self):
# test bytes
key = import_key(b"secret", "oct")
self.assertIsInstance(key, OctKey)
# test string
key = import_key("secret", "oct")
self.assertIsInstance(key, OctKey)
# test dict
data = key.as_dict()
key = import_key(data)
self.assertIsInstance(key, OctKey)
self.assertRaises(InvalidKeyTypeError, import_key, "secret", "invalid")
def test_generate_key(self):
key = generate_key("oct")
self.assertIsInstance(key, OctKey)
key = generate_key("RSA")
self.assertIsInstance(key, RSAKey)
key = generate_key("EC")
self.assertIsInstance(key, ECKey)
key = generate_key("OKP")
self.assertIsInstance(key, OKPKey)
self.assertRaises(InvalidKeyTypeError, generate_key, "invalid", 8)
def test_check_use(self):
key = OctKey.import_key("secret", {"use": "sig"})
key.check_use("sig")
self.assertRaises(UnsupportedKeyUseError, key.check_use, "enc")
self.assertRaises(UnsupportedKeyUseError, key.check_use, "invalid")
def test_check_alg(self):
key = OctKey.import_key("secret", {"alg": "HS256"})
key.check_alg("HS256")
self.assertRaises(UnsupportedKeyAlgorithmError, key.check_alg, "RS256")
def test_alg_property(self):
key = OctKey.import_key("secret")
self.assertIsNone(key.alg)
key = OctKey.import_key("secret", {"alg": "HS256"})
self.assertEqual(key.alg, "HS256")
def test_check_ops(self):
key = OctKey.import_key("secret", {"key_ops": ["sign", "verify"]})
key.check_key_op("sign")
self.assertRaises(UnsupportedKeyOperationError, key.check_key_op, "wrapKey")
self.assertRaises(UnsupportedKeyOperationError, key.check_key_op, "invalid")
key = RSAKey.generate_key(private=False)
self.assertRaises(UnsupportedKeyOperationError, key.check_key_op, "sign")
def test_import_without_kty(self):
self.assertRaises(MissingKeyTypeError, import_key, {})
def test_thumbprint_uri(self):
value = thumbprint_uri(
{
"kty": "EC",
"crv": "P-256",
"x": "jJ6Flys3zK9jUhnOHf6G49Dyp5hah6CNP84-gY-n9eo",
"y": "nhI6iD5eFXgBTLt_1p3aip-5VbZeMhxeFSpjfEAf7Ww",
}
)
expected = "urn:ietf:params:oauth:jwk-thumbprint:sha-256:w9eYdC6_s_tLQ8lH6PUpc0mddazaqtPgeC2IgWDiqY8"
self.assertEqual(value, expected)
def test_find_correct_key_with_use(self):
key = OctKey.generate_key()
dict_key = key.as_dict()
key1 = OctKey.import_key(dict_key, {"use": "enc"})
key2 = OctKey.import_key(dict_key, {"use": "sig"})
self.assertEqual(key1.kid, key2.kid)
key_set = KeySet([key1, key2])
# pick randomly
jws.serialize_compact({"alg": "HS256"}, "foo", key_set)
# get by kid
jws.serialize_compact({"alg": "HS256", "kid": key2.kid}, "foo", key_set)
key_set = KeySet([key1, key2, key2])
# return the first found key
jws.serialize_compact({"alg": "HS256", "kid": key2.kid}, "foo", key_set)
def test_find_correct_key_with_alg(self):
key = OctKey.generate_key()
dict_key = key.as_dict()
key1 = OctKey.import_key(dict_key, {"alg": "HS256"})
key2 = OctKey.import_key(dict_key, {"alg": "dir"})
self.assertEqual(key1.kid, key2.kid)
key_set = KeySet([key1, key2])
# pick randomly
jws.serialize_compact({"alg": "HS256"}, "foo", key_set)
# get by kid
jws.serialize_compact({"alg": "HS256", "kid": key2.kid}, "foo", key_set)
def test_import_bytes_keys(self):
# check by ssh types
key = import_key(read_key("ssh-rsa-public.pem"))
self.assertEqual(key.key_type, "RSA")
key = import_key(read_key("ssh-ecdsa-public.pem"))
self.assertEqual(key.key_type, "EC")
key = import_key(read_key("ssh-ed25519-public.pem"))
self.assertEqual(key.key_type, "OKP")
key = import_key("ssh-rsa-oct")
self.assertEqual(key.key_type, "oct")
# check by pem types
key = import_key(read_key("rsa-openssl-public.pem"))
self.assertEqual(key.key_type, "RSA")
key = import_key(read_key("ec-p256-public.pem"))
self.assertEqual(key.key_type, "EC")
key = import_key(read_key("okp-ed448-public.pem"))
self.assertEqual(key.key_type, "OKP")
key = import_key(b"oct-key")
self.assertEqual(key.key_type, "oct")
|