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
|
from unittest import TestCase
from joserfc.jwe import (
JWERegistry,
encrypt_compact,
decrypt_compact,
CompactEncryption,
)
from joserfc.jwa import JWE_ENC_MODELS
from joserfc.jwk import RSAKey, ECKey, OctKey, OKPKey, KeySet
from joserfc.errors import (
SecurityWarning,
InvalidKeyLengthError,
MissingAlgorithmError,
MissingEncryptionError,
DecodeError,
ExceededSizeError,
InvalidHeaderValueError,
)
from joserfc.util import json_b64encode, urlsafe_b64encode
from tests.base import load_key
class TestJWECompact(TestCase):
def run_case(self, alg: str, enc: str, private_key, public_key):
protected = {"alg": alg, "enc": enc}
payload = b"hello"
result = encrypt_compact(
protected,
payload,
public_key,
algorithms=[alg, enc],
)
self.assertEqual(result.count("."), 4)
obj = decrypt_compact(
result,
private_key,
algorithms=[alg, enc],
)
self.assertEqual(obj.plaintext, payload)
def run_cases(self, names, private_key, public_key):
for alg in names:
for enc in JWE_ENC_MODELS:
self.run_case(alg, enc.name, private_key, public_key)
def test_RSA_alg(self):
private_key: RSAKey = load_key("rsa-openssl-private.pem")
public_key: RSAKey = load_key("rsa-openssl-public.pem")
algs = ["RSA1_5", "RSA-OAEP", "RSA-OAEP-256"]
self.run_cases(algs, private_key, public_key)
protected = {"alg": "RSA-OAEP", "enc": "A128CBC-HS256"}
value = encrypt_compact(protected, "i", private_key)
key2 = RSAKey.generate_key()
self.assertRaises(DecodeError, decrypt_compact, value, key2)
def test_ECDH_ES_with_EC_key(self):
algs = ["ECDH-ES", "ECDH-ES+A128KW", "ECDH-ES+A192KW", "ECDH-ES+A256KW"]
for size in [256, 384, 512]:
private_key: ECKey = load_key(f"ec-p{size}-private.pem")
public_key: ECKey = load_key(f"ec-p{size}-public.pem")
self.run_cases(algs, private_key, public_key)
key1 = ECKey.generate_key("P-256")
key2 = ECKey.generate_key("P-256")
key3 = ECKey.generate_key("P-521")
for alg in ["ECDH-ES", "ECDH-ES+A128KW"]:
for enc in ["A128CBC-HS256", "A128GCM"]:
protected = {"alg": alg, "enc": enc}
value = encrypt_compact(protected, "i", key1)
self.assertRaises(
DecodeError,
decrypt_compact,
value,
key2,
)
self.assertRaises(
DecodeError,
decrypt_compact,
value,
key3,
)
def test_ECDH_ES_with_OKP_key(self):
key1 = OKPKey.generate_key("X25519")
key2 = OKPKey.generate_key("X448")
for alg in ["ECDH-ES", "ECDH-ES+A128KW"]:
for enc in ["A128CBC-HS256", "A128GCM"]:
protected = {"alg": alg, "enc": enc}
value = encrypt_compact(protected, "i", key1)
obj = decrypt_compact(value, key1)
self.assertEqual(obj.protected, protected)
self.assertRaises(
DecodeError,
decrypt_compact,
value,
key2,
)
value = encrypt_compact(protected, "i", key2)
obj = decrypt_compact(value, key2)
self.assertEqual(obj.protected, protected)
self.assertRaises(
DecodeError,
decrypt_compact,
value,
key1,
)
def test_dir_alg(self):
key = OctKey.import_key("secret")
self.assertRaises(InvalidKeyLengthError, encrypt_compact, {"alg": "dir", "enc": "A128GCM"}, b"j", key)
for enc in JWE_ENC_MODELS:
key = OctKey.generate_key(enc.cek_size)
self.run_case("dir", enc.name, key, key)
def test_AESGCM_alg(self):
for size in [128, 192, 256]:
key = OctKey.generate_key(size)
self.run_cases([f"A{size}GCMKW"], key, key)
key1 = OctKey.generate_key(128)
key2 = OctKey.generate_key(128)
protected = {"alg": "A128GCMKW", "enc": "A128CBC-HS256"}
algorithms = ["A128GCMKW", "A128CBC-HS256"]
value = encrypt_compact(protected, "i", key1, algorithms=algorithms)
self.assertRaises(
DecodeError,
decrypt_compact,
value,
key2,
algorithms=algorithms,
)
def test_PBES2HS_alg(self):
algs = {
"PBES2-HS256+A128KW": 128,
"PBES2-HS384+A192KW": 192,
"PBES2-HS512+A256KW": 256,
}
for alg in algs:
key = OctKey.generate_key(algs[alg])
self.run_cases([alg], key, key)
key1 = OctKey.generate_key(128)
key2 = OctKey.generate_key(128)
protected = {"alg": "PBES2-HS256+A128KW", "enc": "A128CBC-HS256"}
algorithms = ["PBES2-HS256+A128KW", "A128CBC-HS256"]
value = encrypt_compact(protected, "i", key1, algorithms=algorithms)
self.assertRaises(
DecodeError,
decrypt_compact,
value,
key2,
algorithms=algorithms,
)
def test_PBES2HS_with_header(self):
key = OctKey.generate_key(128)
protected = {
"alg": "PBES2-HS256+A128KW",
"enc": "A128CBC-HS256",
"p2s": "QoGrcBpns_cLWCQPEVuA-g",
"p2c": 1024,
}
registry = JWERegistry(algorithms=["PBES2-HS256+A128KW", "A128CBC-HS256"])
value1 = encrypt_compact(protected, b"i", key, registry=registry)
obj1 = decrypt_compact(value1, key, registry=registry)
self.assertIn("p2c", obj1.headers())
self.assertEqual(obj1.headers()["p2c"], 1024)
# invalid type
protected["p2c"] = "1024"
self.assertRaises(
InvalidHeaderValueError,
encrypt_compact,
protected,
b"i",
key,
registry=registry,
)
def test_PBES2HS_with_small_p2c(self):
key = OctKey.generate_key(128)
protected = {
"alg": "PBES2-HS256+A128KW",
"enc": "A128CBC-HS256",
"p2s": "QoGrcBpns_cLWCQPEVuA-g",
"p2c": 500,
}
registry = JWERegistry(algorithms=["PBES2-HS256+A128KW", "A128CBC-HS256"])
self.assertWarns(
SecurityWarning,
encrypt_compact,
protected,
b"i",
key,
registry=registry,
)
def test_PBES2HS_with_large_p2c(self):
key = OctKey.import_key({"k": "pyL42ncDFSYnenl-GiZjRw", "kty": "oct"})
protected = {
"alg": "PBES2-HS256+A128KW",
"enc": "A128CBC-HS256",
"p2s": "QoGrcBpns_cLWCQPEVuA-g",
"p2c": 500000,
}
registry = JWERegistry(algorithms=["PBES2-HS256+A128KW", "A128CBC-HS256"])
self.assertRaises(
InvalidHeaderValueError,
encrypt_compact,
protected,
b"i",
key,
registry=registry,
)
encrypted = "eyJhbGciOiJQQkVTMi1IUzI1NitBMTI4S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwicDJzIjoiUW9HcmNCcG5zX2NMV0NRUEVWdUEtZyIsInAyYyI6NTAwMDAwfQ.qdtshVQlPM-fW57DRVUnmwMyvBVzUZCm58zn7j5W7IP9S2-cBVTh_w.mMUagTUTRi7fLQ3VUi6g4w.Hi0-8_MusxEwRtW6dkjXzw.Ktm1FmBA9rPe0Vv8w0kZ2g"
self.assertRaises(
InvalidHeaderValueError,
decrypt_compact,
encrypted,
key,
registry=registry,
)
def test_with_zip_header(self):
private_key: RSAKey = load_key("rsa-openssl-private.pem")
public_key: RSAKey = load_key("rsa-openssl-public.pem")
protected = {"alg": "RSA-OAEP", "enc": "A128CBC-HS256", "zip": "DEF"}
plaintext = b"hello"
result = encrypt_compact(protected, plaintext, public_key)
obj = decrypt_compact(result, private_key)
self.assertEqual(obj.plaintext, plaintext)
def test_decompress_zip_with_gzip_head(self):
key = OctKey.import_key({"k": "pyL42ncDFSYnenl-GiZjRw", "kty": "oct"})
s = (
"eyJhbGciOiJkaXIiLCJlbmMiOiJBMTI4R0NNIiwiemlwIjoiREVGIn0.."
"YbDfdYa6p-wAEFul.YK7j0MsH-Dko6ifsEg.wES6-QAOEbErZqXiS0JHRw"
)
result = decrypt_compact(s, key)
self.assertEqual(result.plaintext, b"hello")
self.assertEqual(result.headers().get("zip"), "DEF")
def test_decompress_zip_exceeds_size(self):
key = OctKey.import_key({"k": "pyL42ncDFSYnenl-GiZjRw", "kty": "oct"})
result = encrypt_compact({"alg": "dir", "enc": "A128GCM", "zip": "DEF"}, b"h" * 300000, key)
self.assertRaises(ExceededSizeError, decrypt_compact, result, key)
def test_header_exceeds_size(self):
header = json_b64encode({f"a{i}": "a" * i for i in range(1000)}).decode("utf-8")
s = header + "..YbDfdYa6p-wAEFul.YK7j0MsH-Dko6ifsEg.wES6-QAOEbErZqXiS0JHRw"
self.assertRaises(ExceededSizeError, decrypt_compact, s, OctKey.import_key("secret"))
def test_encrypted_key_exceeds_size(self):
header = json_b64encode({"alg": "dir", "enc": "A128GCM"}).decode("utf-8")
ek = urlsafe_b64encode(("a" * 1000).encode("utf-8")).decode("utf-8")
s = header + "." + ek + ".YbDfdYa6p-wAEFul.YK7j0MsH-Dko6ifsEg.wES6-QAOEbErZqXiS0JHRw"
key = OctKey.import_key({"k": "pyL42ncDFSYnenl-GiZjRw", "kty": "oct"})
self.assertRaises(ExceededSizeError, decrypt_compact, s, key)
def test_initialization_vector_size(self):
header = json_b64encode({"alg": "dir", "enc": "A128GCM"}).decode("utf-8")
iv = urlsafe_b64encode(("a" * 1000).encode("utf-8")).decode("utf-8")
s = header + ".." + iv + ".YK7j0MsH-Dko6ifsEg.wES6-QAOEbErZqXiS0JHRw"
key = OctKey.import_key({"k": "pyL42ncDFSYnenl-GiZjRw", "kty": "oct"})
self.assertRaises(ExceededSizeError, decrypt_compact, s, key)
def test_ciphertext_exceeds_size(self):
header = json_b64encode({"alg": "dir", "enc": "A128GCM"}).decode("utf-8")
ciphertext = urlsafe_b64encode(("a" * 70000).encode("utf-8")).decode("utf-8")
s = header + "..YbDfdYa6p-wAEFul." + ciphertext + ".wES6-QAOEbErZqXiS0JHRw"
self.assertRaises(ExceededSizeError, decrypt_compact, s, OctKey.import_key("secret"))
def test_auth_tag_exceeds_size(self):
header = json_b64encode({"alg": "dir", "enc": "A128GCM"}).decode("utf-8")
tag = urlsafe_b64encode(("a" * 80).encode("utf-8")).decode("utf-8")
s = header + "..YbDfdYa6p-wAEFul.YK7j0MsH-Dko6ifsEg." + tag
self.assertRaises(ExceededSizeError, decrypt_compact, s, OctKey.import_key("secret"))
def test_invalid_compact_data(self):
private_key: RSAKey = load_key("rsa-openssl-private.pem")
value = b"a.b.c.d.e.f.g"
self.assertRaises(ValueError, decrypt_compact, value, private_key)
value = b"a.b.c.d.e"
self.assertRaises(DecodeError, decrypt_compact, value, private_key)
value = json_b64encode({"enc": "A128CBC-HS256"}) + b".b.c.d.e"
self.assertRaises(MissingAlgorithmError, decrypt_compact, value, private_key)
value = json_b64encode({"alg": "RSA-OAEP"}) + b".b.c.d.e"
self.assertRaises(MissingEncryptionError, decrypt_compact, value, private_key)
def test_with_key_set(self):
keys = KeySet(
[
OctKey.generate_key(),
OctKey.generate_key(),
RSAKey.generate_key(),
]
)
protected = {"alg": "RSA-OAEP", "enc": "A128CBC-HS256"}
value = encrypt_compact(protected, b"foo", keys)
obj = decrypt_compact(value, keys)
self.assertEqual(obj.plaintext, b"foo")
def test_compact_encryption(self):
key: RSAKey = load_key("rsa-openssl-private.pem")
protected = {"alg": "RSA-OAEP", "enc": "A128CBC-HS256"}
obj = CompactEncryption(protected, b"")
self.assertEqual(obj.recipients, [])
obj.attach_recipient(key, {"kid": "foo"})
self.assertEqual(obj.protected["kid"], "foo")
|