hampushellsberg has uploaded this change for review.
esim.bsp: keep encrypted segments within 1020 bytes
SGP.22 limits a segment to 1020 bytes including tag, length field and
MAC, which leaves 1008 bytes for the ciphertext. encrypt_and_mac() cut
the plaintext at 1008 bytes; the mandatory '80' padding then added a
whole block and the segment got 1036 bytes long. An eUICC that enforces
the limit can refuse the first such segment of a profile. Cut encrypted
plaintext at 1007 bytes; MAC-only segments keep 1008.
The folder osmocom-pysim-bsp-segment-size of
hampushellsberg-dev/PySIM-upstream-patches on GitHub has the analysis
and a repro.
Change-Id: Ie59a8fb3d6cefc079e4e065d8ab9bd9cec886513
---
M pySim/esim/bsp.py
M tests/unittests/test_esim_bsp.py
2 files changed, 37 insertions(+), 3 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/pysim refs/changes/53/44153/1
diff --git a/pySim/esim/bsp.py b/pySim/esim/bsp.py
index cd4114f..b08e94c 100644
--- a/pySim/esim/bsp.py
+++ b/pySim/esim/bsp.py
@@ -235,6 +235,9 @@
TAG_LEN = 1
length_len = len(bertlv_encode_len(MAX_SEGMENT_SIZE))
self.max_payload_size = MAX_SEGMENT_SIZE - TAG_LEN - length_len - self.m_algo.l_mac
+ # SGP.22 v3.1 2.5.3 NOTE: the '80' padding takes at least one byte of the ciphertext
+ blocksize = self.c_algo.blocksize
+ self.max_encrypted_payload_size = self.max_payload_size // blocksize * blocksize - 1
@classmethod
def from_kdf(cls, shared_secret: bytes, key_type: int, key_length: int, host_id: bytes, eid: bytes):
@@ -245,7 +248,7 @@
def encrypt_and_mac_one(self, tag: int, plaintext:bytes) -> bytes:
"""Encrypt + MAC a single plaintext TLV. Returns the protected ciphertext."""
assert tag <= 255
- assert len(plaintext) <= self.max_payload_size
+ assert len(plaintext) <= self.max_encrypted_payload_size
# DEBUG: Show what we're processing
logger.debug(f"BSP_DEBUG: encrypt_and_mac_one(tag=0x{tag:02x}, plaintext_len={len(plaintext)})")
@@ -268,12 +271,12 @@
result = []
while len(remainder):
remaining_len = len(remainder)
- if remaining_len < self.max_payload_size:
+ if remaining_len < self.max_encrypted_payload_size:
segment_len = remaining_len
segment = remainder
remainder = b''
else:
- segment_len = self.max_payload_size
+ segment_len = self.max_encrypted_payload_size
segment = remainder[0:segment_len]
remainder = remainder[segment_len:]
result.append(self.encrypt_and_mac_one(tag, segment))
diff --git a/tests/unittests/test_esim_bsp.py b/tests/unittests/test_esim_bsp.py
index e8e8131..4580630 100755
--- a/tests/unittests/test_esim_bsp.py
+++ b/tests/unittests/test_esim_bsp.py
@@ -94,5 +94,36 @@
self.assertEqual(plain_upp, base64.b64decode(original_upp))
+class TestBSPsegmentSize(unittest.TestCase):
+ """SGP.22 v3.1 2.5.3: a segment has at most 1020 bytes, including tag, length field and MAC."""
+
+ @staticmethod
+ def _pair():
+ keys = (h2b('00112233445566778899aabbccddeeff'), h2b('ffeeddccbbaa99887766554433221100'), bytes(16))
+ return BspInstance(*keys), BspInstance(*keys)
+
+ def test_encrypted_segments(self):
+ for length in (1, 1006, 1007, 1008, 1009, 2014, 2015, 5000):
+ tx, rx = self._pair()
+ plaintext = bytes(i % 251 for i in range(length))
+ segments = tx.encrypt_and_mac(0x86, plaintext)
+ self.assertEqual(len(segments), -(-length // 1007))
+ for segment in segments:
+ self.assertLessEqual(len(segment), MAX_SEGMENT_SIZE)
+ self.assertEqual(rx.demac_and_decrypt(segments), plaintext)
+
+ def test_full_encrypted_segment(self):
+ tx, _ = self._pair()
+ self.assertEqual(tx.max_encrypted_payload_size, 1007)
+ self.assertEqual(len(tx.encrypt_and_mac_one(0x86, bytes(1007))), MAX_SEGMENT_SIZE)
+
+ def test_mac_only_segments(self):
+ tx, rx = self._pair()
+ plaintext = bytes(i % 251 for i in range(2500))
+ segments = tx.mac_only(0x88, plaintext)
+ self.assertEqual([len(x) for x in segments], [MAX_SEGMENT_SIZE, MAX_SEGMENT_SIZE, 496])
+ self.assertEqual(rx.demac_only(segments), plaintext)
+
+
if __name__ == "__main__":
unittest.main()
To view, visit change 44153. To unsubscribe, or for help writing mail filters, visit settings.