laforge submitted this change.
personalization: add param_source.py, add batch.py
Implement pySim.esim.saip.batch.BatchPersonalization,
generating N eSIM profiles from a preset configuration.
Batch parameters can be fed by a constant, incrementing, random or from
CSV rows: add pySim.esim.saip.param_source.* classes to feed such input
to each of the BatchPersonalization's ConfigurableParameter instances.
Related: SYS#6768
Change-Id: I01ae40a06605eb205bfb409189fcd2b3a128855a
Jenkins: skip-card-test
---
A pySim/esim/saip/batch.py
A pySim/esim/saip/param_source.py
2 files changed, 323 insertions(+), 0 deletions(-)
diff --git a/pySim/esim/saip/batch.py b/pySim/esim/saip/batch.py
new file mode 100644
index 0000000..92e8b1e
--- /dev/null
+++ b/pySim/esim/saip/batch.py
@@ -0,0 +1,120 @@
+"""Implementation of Personalization of eSIM profiles in SimAlliance/TCA Interoperable Profile:
+ Run a batch of N personalizations"""
+
+# (C) 2025-2026 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
+#
+# Author: nhofmeyr@sysmocom.de
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import copy
+from typing import Generator
+from pySim.esim.saip.personalization import ConfigurableParameter
+from pySim.esim.saip import param_source
+from pySim.esim.saip import ProfileElementSequence
+
+class BatchPersonalization:
+ """Produce a series of eSIM profiles from predefined parameters.
+ Personalization parameters are derived from pysim.esim.saip.param_source.ParamSource.
+
+ Usage example:
+
+ der_input = open('some_file', 'rb').read()
+ pes = ProfileElementSequence.from_der(der_input)
+ p = BatchPersonalization(
+ n=10,
+ src_pes=pes,
+ csv_rows=get_csv_reader())
+
+ p.add_param_and_src(
+ personalization.Iccid(),
+ param_source.IncDigitSource(
+ num_digits=18,
+ first_value=123456789012340001,
+ last_value=123456789012340010))
+
+ # add more parameters here, using ConfigurableParameter and ParamSource subclass instances to define the profile
+ # ...
+
+ # generate all 10 profiles (from n=10 above)
+ for result_pes in p.generate_profiles():
+ upp = result_pes.to_der()
+ store_upp(upp)
+ """
+
+ class ParamAndSrc:
+ """tie a ConfigurableParameter to a source of actual values"""
+ def __init__(self, param: ConfigurableParameter, src: param_source.ParamSource):
+ if isinstance(param, type):
+ self.param_cls = param
+ else:
+ self.param_cls = param.__class__
+ self.src = src
+
+ def __init__(self,
+ n: int,
+ src_pes: ProfileElementSequence,
+ params: list[ParamAndSrc]=None,
+ csv_rows: Generator=None,
+ ):
+ """
+ n: number of eSIM profiles to generate.
+ src_pes: a decoded eSIM profile as ProfileElementSequence, to serve as template. This is not modified, only
+ copied.
+ params: list of ParamAndSrc instances, defining a ConfigurableParameter and corresponding ParamSource to fill in
+ profile values.
+ csv_rows: A generator (e.g. iter(list_of_rows)) producing all CSV rows one at a time, starting with a row
+ containing the column headers. This is compatible with the python csv.reader. Each row gets passed to
+ ParamSource.get_next(), such that ParamSource implementations can access the row items. See
+ param_source.CsvSource.
+ """
+ self.n = n
+ self.params = params or []
+ self.src_pes = src_pes
+ self.csv_rows = csv_rows
+
+ def add_param_and_src(self, param:ConfigurableParameter, src:param_source.ParamSource):
+ self.params.append(BatchPersonalization.ParamAndSrc(param, src))
+
+ def generate_profiles(self):
+ # get first row of CSV: column names
+ csv_columns = None
+ if self.csv_rows:
+ try:
+ csv_columns = next(self.csv_rows)
+ except StopIteration as e:
+ raise ValueError('the input CSV file appears to be empty') from e
+
+ for i in range(self.n):
+ csv_row = None
+ if self.csv_rows and csv_columns:
+ try:
+ csv_row_list = next(self.csv_rows)
+ except StopIteration as e:
+ raise ValueError(f'not enough rows in the input CSV for eSIM nr {i+1} of {self.n}') from e
+
+ csv_row = dict(zip(csv_columns, csv_row_list))
+
+ pes = copy.deepcopy(self.src_pes)
+
+ for p in self.params:
+ try:
+ input_value = p.src.get_next(csv_row=csv_row)
+ assert input_value is not None
+ value = p.param_cls.validate_val(input_value)
+ p.param_cls.apply_val(pes, value)
+ except Exception as e:
+ raise ValueError(f'{p.param_cls.get_name()} fed by {p.src.name}: {e}') from e
+
+ yield pes
diff --git a/pySim/esim/saip/param_source.py b/pySim/esim/saip/param_source.py
new file mode 100644
index 0000000..2083f98
--- /dev/null
+++ b/pySim/esim/saip/param_source.py
@@ -0,0 +1,203 @@
+# Implementation of SimAlliance/TCA Interoperable Profile handling: parameter sources for batch personalization.
+#
+# (C) 2025 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
+#
+# Author: nhofmeyr@sysmocom.de
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import random
+import re
+from osmocom.utils import b2h
+
+class ParamSourceExn(Exception):
+ pass
+
+class ParamSourceExhaustedExn(ParamSourceExn):
+ pass
+
+class ParamSourceUndefinedExn(ParamSourceExn):
+ pass
+
+class ParamSource:
+ """abstract parameter source. For usage, see personalization.BatchPersonalization."""
+
+ # This name should be short but descriptive, useful for a user interface, like 'random decimal digits'.
+ name = "none"
+ numeric_base = None # or 10 or 16
+
+ def __init__(self, input_str:str):
+ """Subclasses should call super().__init__(input_str) before evaluating self.input_str. Each subclass __init__()
+ may in turn manipulate self.input_str to apply expansions or decodings."""
+ self.input_str = input_str
+
+ def get_next(self, csv_row:dict=None):
+ """Subclasses implement this: return the next value from the parameter source.
+ When there are no more values from the source, raise a ParamSourceExhaustedExn.
+ This default implementation is an empty source."""
+ raise ParamSourceExhaustedExn()
+
+ @classmethod
+ def from_str(cls, input_str:str):
+ """compatibility with earlier version of ParamSource. Just use the constructor."""
+ return cls(input_str)
+
+class ConstantSource(ParamSource):
+ """one value for all"""
+ name = "constant"
+
+ def get_next(self, csv_row:dict=None):
+ return self.input_str
+
+class InputExpandingParamSource(ParamSource):
+
+ def __init__(self, input_str:str):
+ super().__init__(input_str)
+ self.input_str = self.expand_input_str(self.input_str)
+
+ @classmethod
+ def expand_input_str(cls, input_str:str):
+ # user convenience syntax '0*32' becomes '00000000000000000000000000000000'
+ if "*" not in input_str:
+ return input_str
+ # re: "XX * 123" with optional spaces
+ tokens = re.split(r"([^ \t]+)[ \t]*\*[ \t]*([0-9]+)", input_str)
+ if len(tokens) < 3:
+ return input_str
+ parts = []
+ for unchanged, snippet, repeat_str in zip(tokens[0::3], tokens[1::3], tokens[2::3]):
+ parts.append(unchanged)
+ repeat = int(repeat_str)
+ parts.append(snippet * repeat)
+
+ return "".join(parts)
+
+class DecimalRangeSource(InputExpandingParamSource):
+ """abstract: decimal numbers with a value range"""
+
+ numeric_base = 10
+
+ def __init__(self, input_str:str=None, num_digits:int=None, first_value:int=None, last_value:int=None):
+ """Constructor to set up values from a (user entered) string: DecimalRangeSource(input_str).
+ Constructor to set up values directly: DecimalRangeSource(num_digits=3, first_value=123, last_value=456)
+
+ num_digits produces leading zeros when first_value..last_value are shorter.
+ """
+ assert ((input_str is not None and (num_digits, first_value, last_value) == (None, None, None))
+ or (input_str is None and None not in (num_digits, first_value, last_value)))
+
+ if input_str is not None:
+ super().__init__(input_str)
+
+ input_str = self.input_str
+
+ if ".." in input_str:
+ first_str, last_str = input_str.split('..')
+ first_str = first_str.strip()
+ last_str = last_str.strip()
+ else:
+ first_str = input_str.strip()
+ last_str = None
+
+ num_digits = len(first_str)
+ first_value = int(first_str)
+ last_value = int(last_str if last_str is not None else "9" * num_digits)
+
+ assert num_digits > 0
+ assert first_value <= last_value
+ self.num_digits = num_digits
+ self.first_value = first_value
+ self.last_value = last_value
+
+ def val_to_digit(self, val:int):
+ return "%0*d" % (self.num_digits, val) # pylint: disable=consider-using-f-string
+
+class RandomDigitSource(DecimalRangeSource):
+ """return a different sequence of random decimal digits each"""
+ name = "random decimal digits"
+
+ def get_next(self, csv_row:dict=None):
+ val = random.randint(self.first_value, self.last_value) # TODO secure random source?
+ return self.val_to_digit(val)
+
+class RandomHexDigitSource(InputExpandingParamSource):
+ """return a different sequence of random hexadecimal digits each"""
+ name = "random hexadecimal digits"
+ numeric_base = 16
+
+ def __init__(self, input_str:str):
+ super().__init__(input_str)
+ input_str = self.input_str
+
+ num_digits = len(input_str.strip())
+ if num_digits < 1:
+ raise ValueError("zero number of digits")
+ # hex digits always come in two
+ if (num_digits & 1) != 0:
+ raise ValueError(f"hexadecimal value should have even number of digits, not {num_digits}")
+ self.num_digits = num_digits
+
+ def get_next(self, csv_row:dict=None):
+ val = random.randbytes(self.num_digits // 2) # TODO secure random source?
+ return b2h(val)
+
+class IncDigitSource(DecimalRangeSource):
+ """incrementing sequence of digits"""
+ name = "incrementing decimal digits"
+
+ def __init__(self, input_str:str=None, num_digits:int=None, first_value:int=None, last_value:int=None):
+ """input_str: the range of values to iterate. Format: 'FIRST..LAST' (e.g. '0001..9999') or
+ just 'FIRST' (iterates to the maximum value for the given digit width). Leading zeros in
+ FIRST determine the digit width and are preserved in returned values."""
+ super().__init__(input_str, num_digits, first_value, last_value)
+ self.next_val = None
+ self.reset()
+
+ def reset(self):
+ """Restart from the first value of the defined range passed to __init__()."""
+ self.next_val = self.first_value
+
+ def get_next(self, csv_row:dict=None):
+ val = self.next_val
+ if val is None:
+ raise ParamSourceExhaustedExn()
+
+ returnval = self.val_to_digit(val)
+
+ val += 1
+ if val > self.last_value:
+ self.next_val = None
+ else:
+ self.next_val = val
+
+ return returnval
+
+class CsvSource(ParamSource):
+ """apply a column from a CSV row, as passed in to ParamSource.get_next(csv_row)"""
+ name = "from CSV"
+
+ def __init__(self, input_str:str):
+ """input_str: the CSV column name to read values from.
+ The caller passes the current CSV row to get_next(), from which CsvSource picks the column matching
+ this name."""
+ super().__init__(input_str)
+ self.csv_column = self.input_str
+
+ def get_next(self, csv_row:dict=None):
+ val = None
+ if csv_row:
+ val = csv_row.get(self.csv_column)
+ if val is None:
+ raise ParamSourceUndefinedExn(f"no value for CSV column {self.csv_column!r}")
+ return val
To view, visit change 41845. To unsubscribe, or for help writing mail filters, visit settings.